Coverage Report

Created: 2026-04-29 19:21

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/node/mempool_persist.cpp
Line
Count
Source
1
// Copyright (c) 2022-present The Bitcoin Core developers
2
// Distributed under the MIT software license, see the accompanying
3
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5
#include <node/mempool_persist.h>
6
7
#include <clientversion.h>
8
#include <consensus/amount.h>
9
#include <logging.h>
10
#include <primitives/transaction.h>
11
#include <random.h>
12
#include <serialize.h>
13
#include <streams.h>
14
#include <sync.h>
15
#include <txmempool.h>
16
#include <uint256.h>
17
#include <util/fs.h>
18
#include <util/fs_helpers.h>
19
#include <util/obfuscation.h>
20
#include <util/signalinterrupt.h>
21
#include <util/syserror.h>
22
#include <util/time.h>
23
#include <validation.h>
24
25
#include <cstdint>
26
#include <cstdio>
27
#include <exception>
28
#include <functional>
29
#include <map>
30
#include <memory>
31
#include <set>
32
#include <stdexcept>
33
#include <utility>
34
#include <vector>
35
36
using fsbridge::FopenFn;
37
38
namespace node {
39
40
static const uint64_t MEMPOOL_DUMP_VERSION_NO_XOR_KEY{1};
41
static const uint64_t MEMPOOL_DUMP_VERSION{2};
42
43
bool LoadMempool(CTxMemPool& pool, const fs::path& load_path, Chainstate& active_chainstate, ImportMempoolOptions&& opts)
44
1.00k
{
45
1.00k
    if (load_path.empty()) return false;
46
47
923
    AutoFile file{opts.mockable_fopen_function(load_path, "rb")};
48
923
    if (file.IsNull()) {
49
475
        LogInfo("Failed to open mempool file. Continuing anyway.\n");
50
475
        return false;
51
475
    }
52
53
448
    int64_t count = 0;
54
448
    int64_t expired = 0;
55
448
    int64_t failed = 0;
56
448
    int64_t already_there = 0;
57
448
    int64_t unbroadcast = 0;
58
448
    const auto now{NodeClock::now()};
59
60
448
    try {
61
448
        uint64_t version;
62
448
        file >> version;
63
64
448
        if (version == MEMPOOL_DUMP_VERSION_NO_XOR_KEY) {
65
1
            file.SetObfuscation({});
66
447
        } else if (version == MEMPOOL_DUMP_VERSION) {
67
447
            Obfuscation obfuscation;
68
447
            file >> obfuscation;
69
447
            file.SetObfuscation(obfuscation);
70
447
        } else {
71
0
            return false;
72
0
        }
73
74
448
        uint64_t total_txns_to_load;
75
448
        file >> total_txns_to_load;
76
448
        uint64_t txns_tried = 0;
77
448
        LogInfo("Loading %u mempool transactions from file...\n", total_txns_to_load);
78
448
        int next_tenth_to_report = 0;
79
742
        while (txns_tried < total_txns_to_load) {
80
294
            const int percentage_done(100.0 * txns_tried / total_txns_to_load);
81
294
            if (next_tenth_to_report < percentage_done / 10) {
82
145
                LogInfo("Progress loading mempool transactions from file: %d%% (tried %u, %u remaining)\n",
83
145
                        percentage_done, txns_tried, total_txns_to_load - txns_tried);
84
145
                next_tenth_to_report = percentage_done / 10;
85
145
            }
86
294
            ++txns_tried;
87
88
294
            CTransactionRef tx;
89
294
            int64_t nTime;
90
294
            int64_t nFeeDelta;
91
294
            file >> TX_WITH_WITNESS(tx);
92
294
            file >> nTime;
93
294
            file >> nFeeDelta;
94
95
294
            if (opts.use_current_time) {
96
23
                nTime = TicksSinceEpoch<std::chrono::seconds>(now);
97
23
            }
98
99
294
            CAmount amountdelta = nFeeDelta;
100
294
            if (amountdelta && opts.apply_fee_delta_priority) {
101
16
                pool.PrioritiseTransaction(tx->GetHash(), amountdelta);
102
16
            }
103
294
            if (nTime > TicksSinceEpoch<std::chrono::seconds>(now - pool.m_opts.expiry)) {
104
293
                LOCK(cs_main);
105
293
                const auto& accepted = AcceptToMemoryPool(active_chainstate, tx, nTime, /*bypass_limits=*/false, /*test_accept=*/false);
106
293
                if (accepted.m_result_type == MempoolAcceptResult::ResultType::VALID) {
107
246
                    ++count;
108
246
                } else {
109
                    // mempool may contain the transaction already, e.g. from
110
                    // wallet(s) having loaded it while we were processing
111
                    // mempool transactions; consider these as valid, instead of
112
                    // failed, but mark them as 'already there'
113
47
                    if (pool.exists(tx->GetHash())) {
114
28
                        ++already_there;
115
28
                    } else {
116
19
                        ++failed;
117
19
                    }
118
47
                }
119
293
            } else {
120
1
                ++expired;
121
1
            }
122
294
            if (active_chainstate.m_chainman.m_interrupt)
123
0
                return false;
124
294
        }
125
448
        std::map<Txid, CAmount> mapDeltas;
126
448
        file >> mapDeltas;
127
128
448
        if (opts.apply_fee_delta_priority) {
129
447
            for (const auto& i : mapDeltas) {
130
21
                pool.PrioritiseTransaction(i.first, i.second);
131
21
            }
132
447
        }
133
134
448
        std::set<Txid> unbroadcast_txids;
135
448
        file >> unbroadcast_txids;
136
448
        if (opts.apply_unbroadcast_set) {
137
445
            unbroadcast = unbroadcast_txids.size();
138
445
            for (const auto& txid : unbroadcast_txids) {
139
                // Ensure transactions were accepted to mempool then add to
140
                // unbroadcast set.
141
177
                if (pool.get(txid) != nullptr) pool.AddUnbroadcastTx(txid);
142
177
            }
143
445
        }
144
448
    } catch (const std::exception& e) {
145
1
        LogInfo("Failed to deserialize mempool data on file: %s. Continuing anyway.\n", e.what());
146
1
        return false;
147
1
    }
148
149
447
    LogInfo("Imported mempool transactions from file: %i succeeded, %i failed, %i expired, %i already there, %i waiting for initial broadcast\n", count, failed, expired, already_there, unbroadcast);
150
447
    return true;
151
448
}
152
153
bool DumpMempool(const CTxMemPool& pool, const fs::path& dump_path, FopenFn mockable_fopen_function, bool skip_file_commit)
154
917
{
155
917
    auto start = SteadyClock::now();
156
157
917
    std::map<Txid, CAmount> mapDeltas;
158
917
    std::vector<TxMempoolInfo> vinfo;
159
917
    std::set<Txid> unbroadcast_txids;
160
161
917
    static Mutex dump_mutex;
162
917
    LOCK(dump_mutex);
163
164
917
    {
165
917
        LOCK(pool.cs);
166
917
        for (const auto &i : pool.mapDeltas) {
167
275
            mapDeltas[i.first] = i.second;
168
275
        }
169
917
        vinfo = pool.infoAll();
170
917
        unbroadcast_txids = pool.GetUnbroadcastTxs();
171
917
    }
172
173
917
    auto mid = SteadyClock::now();
174
175
917
    const fs::path file_fspath{dump_path + ".new"};
176
917
    AutoFile file{mockable_fopen_function(file_fspath, "wb")};
177
917
    if (file.IsNull()) {
178
1
        return false;
179
1
    }
180
181
916
    try {
182
916
        const uint64_t version{pool.m_opts.persist_v1_dat ? MEMPOOL_DUMP_VERSION_NO_XOR_KEY : MEMPOOL_DUMP_VERSION};
183
916
        file << version;
184
185
916
        if (!pool.m_opts.persist_v1_dat) {
186
915
            const Obfuscation obfuscation{FastRandomContext{}.randbytes<Obfuscation::KEY_SIZE>()};
187
915
            file << obfuscation;
188
915
            file.SetObfuscation(obfuscation);
189
915
        } else {
190
1
            file.SetObfuscation({});
191
1
        }
192
193
916
        uint64_t mempool_transactions_to_write(vinfo.size());
194
916
        file << mempool_transactions_to_write;
195
916
        LogInfo("Writing %u mempool transactions to file...\n", mempool_transactions_to_write);
196
1.21k
        for (const auto& i : vinfo) {
197
1.21k
            file << TX_WITH_WITNESS(*(i.tx));
198
1.21k
            file << int64_t{count_seconds(i.m_time)};
199
1.21k
            file << int64_t{i.nFeeDelta};
200
1.21k
            mapDeltas.erase(i.tx->GetHash());
201
1.21k
        }
202
203
916
        file << mapDeltas;
204
205
916
        LogInfo("Writing %d unbroadcast transactions to file.\n", unbroadcast_txids.size());
206
916
        file << unbroadcast_txids;
207
208
916
        if (!skip_file_commit && !file.Commit()) {
209
0
            (void)file.fclose();
210
0
            throw std::runtime_error("Commit failed");
211
0
        }
212
916
        if (file.fclose() != 0) {
213
0
            throw std::runtime_error(
214
0
                strprintf("Error closing %s: %s", fs::PathToString(file_fspath), SysErrorString(errno)));
215
0
        }
216
916
        if (!RenameOver(dump_path + ".new", dump_path)) {
217
0
            throw std::runtime_error("Rename failed");
218
0
        }
219
916
        auto last = SteadyClock::now();
220
221
916
        LogInfo("Dumped mempool: %.3fs to copy, %.3fs to dump, %d bytes dumped to file\n",
222
916
                  Ticks<SecondsDouble>(mid - start),
223
916
                  Ticks<SecondsDouble>(last - mid),
224
916
                  fs::file_size(dump_path));
225
916
    } catch (const std::exception& e) {
226
0
        LogInfo("Failed to dump mempool: %s. Continuing anyway.\n", e.what());
227
0
        (void)file.fclose();
228
0
        return false;
229
0
    }
230
916
    return true;
231
916
}
232
233
} // namespace node