Coverage Report

Created: 2026-05-30 09:47

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 <primitives/transaction.h>
10
#include <random.h>
11
#include <serialize.h>
12
#include <streams.h>
13
#include <sync.h>
14
#include <txmempool.h>
15
#include <uint256.h>
16
#include <util/fs.h>
17
#include <util/fs_helpers.h>
18
#include <util/log.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.01k
{
45
1.01k
    if (load_path.empty()) return false;
46
47
940
    AutoFile file{opts.mockable_fopen_function(load_path, "rb")};
48
940
    if (file.IsNull()) {
49
491
        LogInfo("Failed to open mempool file. Continuing anyway.\n");
50
491
        return false;
51
491
    }
52
53
449
    int64_t count = 0;
54
449
    int64_t expired = 0;
55
449
    int64_t failed = 0;
56
449
    int64_t already_there = 0;
57
449
    int64_t unbroadcast = 0;
58
449
    const auto now{NodeClock::now()};
59
60
449
    try {
61
449
        uint64_t version;
62
449
        file >> version;
63
64
449
        if (version == MEMPOOL_DUMP_VERSION_NO_XOR_KEY) {
65
1
            file.SetObfuscation({});
66
448
        } else if (version == MEMPOOL_DUMP_VERSION) {
67
448
            Obfuscation obfuscation;
68
448
            file >> obfuscation;
69
448
            file.SetObfuscation(obfuscation);
70
448
        } else {
71
0
            return false;
72
0
        }
73
74
449
        uint64_t total_txns_to_load;
75
449
        file >> total_txns_to_load;
76
449
        uint64_t txns_tried = 0;
77
449
        LogInfo("Loading %u mempool transactions from file...\n", total_txns_to_load);
78
449
        int next_tenth_to_report = 0;
79
749
        while (txns_tried < total_txns_to_load) {
80
300
            const int percentage_done(100.0 * txns_tried / total_txns_to_load);
81
300
            if (next_tenth_to_report < percentage_done / 10) {
82
148
                LogInfo("Progress loading mempool transactions from file: %d%% (tried %u, %u remaining)\n",
83
148
                        percentage_done, txns_tried, total_txns_to_load - txns_tried);
84
148
                next_tenth_to_report = percentage_done / 10;
85
148
            }
86
300
            ++txns_tried;
87
88
300
            CTransactionRef tx;
89
300
            int64_t nTime;
90
300
            int64_t nFeeDelta;
91
300
            file >> TX_WITH_WITNESS(tx);
92
300
            file >> nTime;
93
300
            file >> nFeeDelta;
94
95
300
            if (opts.use_current_time) {
96
23
                nTime = TicksSinceEpoch<std::chrono::seconds>(now);
97
23
            }
98
99
300
            CAmount amountdelta = nFeeDelta;
100
300
            if (amountdelta && opts.apply_fee_delta_priority) {
101
16
                pool.PrioritiseTransaction(tx->GetHash(), amountdelta);
102
16
            }
103
300
            if (nTime > TicksSinceEpoch<std::chrono::seconds>(now - pool.m_opts.expiry)) {
104
299
                LOCK(cs_main);
105
299
                const auto& accepted = AcceptToMemoryPool(active_chainstate, tx, nTime, /*bypass_limits=*/false, /*test_accept=*/false);
106
299
                if (accepted.m_result_type == MempoolAcceptResult::ResultType::VALID) {
107
241
                    ++count;
108
241
                } 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
58
                    if (pool.exists(tx->GetHash())) {
114
39
                        ++already_there;
115
39
                    } else {
116
19
                        ++failed;
117
19
                    }
118
58
                }
119
299
            } else {
120
1
                ++expired;
121
1
            }
122
300
            if (active_chainstate.m_chainman.m_interrupt)
123
0
                return false;
124
300
        }
125
449
        std::map<Txid, CAmount> mapDeltas;
126
449
        file >> mapDeltas;
127
128
449
        if (opts.apply_fee_delta_priority) {
129
448
            for (const auto& i : mapDeltas) {
130
21
                pool.PrioritiseTransaction(i.first, i.second);
131
21
            }
132
448
        }
133
134
449
        std::set<Txid> unbroadcast_txids;
135
449
        file >> unbroadcast_txids;
136
449
        if (opts.apply_unbroadcast_set) {
137
446
            unbroadcast = unbroadcast_txids.size();
138
446
            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
446
        }
144
449
    } 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
448
    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
448
    return true;
151
449
}
152
153
bool DumpMempool(const CTxMemPool& pool, const fs::path& dump_path, FopenFn mockable_fopen_function, bool skip_file_commit)
154
936
{
155
936
    auto start = SteadyClock::now();
156
157
936
    std::map<Txid, CAmount> mapDeltas;
158
936
    std::vector<TxMempoolInfo> vinfo;
159
936
    std::set<Txid> unbroadcast_txids;
160
161
936
    static Mutex dump_mutex;
162
936
    LOCK(dump_mutex);
163
164
936
    {
165
936
        LOCK(pool.cs);
166
936
        for (const auto &i : pool.mapDeltas) {
167
275
            mapDeltas[i.first] = i.second;
168
275
        }
169
936
        vinfo = pool.infoAll();
170
936
        unbroadcast_txids = pool.GetUnbroadcastTxs();
171
936
    }
172
173
936
    auto mid = SteadyClock::now();
174
175
936
    const fs::path file_fspath{dump_path + ".new"};
176
936
    AutoFile file{mockable_fopen_function(file_fspath, "wb")};
177
936
    if (file.IsNull()) {
178
1
        return false;
179
1
    }
180
181
935
    try {
182
935
        const uint64_t version{pool.m_opts.persist_v1_dat ? MEMPOOL_DUMP_VERSION_NO_XOR_KEY : MEMPOOL_DUMP_VERSION};
183
935
        file << version;
184
185
935
        if (!pool.m_opts.persist_v1_dat) {
186
934
            const Obfuscation obfuscation{FastRandomContext{}.randbytes<Obfuscation::KEY_SIZE>()};
187
934
            file << obfuscation;
188
934
            file.SetObfuscation(obfuscation);
189
934
        } else {
190
1
            file.SetObfuscation({});
191
1
        }
192
193
935
        uint64_t mempool_transactions_to_write(vinfo.size());
194
935
        file << mempool_transactions_to_write;
195
935
        LogInfo("Writing %u mempool transactions to file...\n", mempool_transactions_to_write);
196
1.22k
        for (const auto& i : vinfo) {
197
1.22k
            file << TX_WITH_WITNESS(*(i.tx));
198
1.22k
            file << int64_t{count_seconds(i.m_time)};
199
1.22k
            file << int64_t{i.nFeeDelta};
200
1.22k
            mapDeltas.erase(i.tx->GetHash());
201
1.22k
        }
202
203
935
        file << mapDeltas;
204
205
935
        LogInfo("Writing %d unbroadcast transactions to file.\n", unbroadcast_txids.size());
206
935
        file << unbroadcast_txids;
207
208
935
        if (!skip_file_commit && !file.Commit()) {
209
0
            (void)file.fclose();
210
0
            throw std::runtime_error("Commit failed");
211
0
        }
212
935
        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
935
        if (!RenameOver(dump_path + ".new", dump_path)) {
217
0
            throw std::runtime_error("Rename failed");
218
0
        }
219
935
        auto last = SteadyClock::now();
220
221
935
        LogInfo("Dumped mempool: %.3fs to copy, %.3fs to dump, %d bytes dumped to file\n",
222
935
                  Ticks<SecondsDouble>(mid - start),
223
935
                  Ticks<SecondsDouble>(last - mid),
224
935
                  fs::file_size(dump_path));
225
935
    } 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
935
    return true;
231
935
}
232
233
} // namespace node