/bitcoin/src/node/mempool_persist.cpp

Source
// Copyright (c) 2022-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include <node/mempool_persist.h>

#include <clientversion.h>
#include <consensus/amount.h>
#include <primitives/transaction.h>
#include <random.h>
#include <serialize.h>
#include <streams.h>
#include <sync.h>
#include <txmempool.h>
#include <uint256.h>
#include <util/fs.h>
#include <util/fs_helpers.h>
#include <util/log.h>
#include <util/obfuscation.h>
#include <util/signalinterrupt.h>
#include <util/syserror.h>
#include <util/time.h>
#include <validation.h>

#include <cstdint>
#include <cstdio>
#include <exception>
#include <functional>
#include <map>
#include <memory>
#include <set>
#include <stdexcept>
#include <utility>
#include <vector>

using fsbridge::FopenFn;

namespace node {

static const uint64_t MEMPOOL_DUMP_VERSION_NO_XOR_KEY{1};
static const uint64_t MEMPOOL_DUMP_VERSION{2};

bool LoadMempool(CTxMemPool& pool, const fs::path& load_path, Chainstate& active_chainstate, ImportMempoolOptions&& opts)
{
    if (load_path.empty()) return false;

    AutoFile file{opts.mockable_fopen_function(load_path, "rb")};
    if (file.IsNull()) {
        LogInfo("Failed to open mempool file. Continuing anyway.\n");
        return false;
    }

    int64_t count = 0;
    int64_t expired = 0;
    int64_t failed = 0;
    int64_t already_there = 0;
    int64_t unbroadcast = 0;
    const auto now{NodeClock::now()};

    try {
        uint64_t version;
        file >> version;

        if (version == MEMPOOL_DUMP_VERSION_NO_XOR_KEY) {
            file.SetObfuscation({});
        } else if (version == MEMPOOL_DUMP_VERSION) {
            Obfuscation obfuscation;
            file >> obfuscation;
            file.SetObfuscation(obfuscation);
        } else {
            return false;
        }

        uint64_t total_txns_to_load;
        file >> total_txns_to_load;
        uint64_t txns_tried = 0;
        LogInfo("Loading %u mempool transactions from file...\n", total_txns_to_load);
        int next_tenth_to_report = 0;
        while (txns_tried < total_txns_to_load) {
            const int percentage_done(100.0 * txns_tried / total_txns_to_load);
            if (next_tenth_to_report < percentage_done / 10) {
                LogInfo("Progress loading mempool transactions from file: %d%% (tried %u, %u remaining)\n",
                        percentage_done, txns_tried, total_txns_to_load - txns_tried);
                next_tenth_to_report = percentage_done / 10;
            }
            ++txns_tried;

            CTransactionRef tx;
            int64_t nTime;
            int64_t nFeeDelta;
            file >> TX_WITH_WITNESS(tx);
            file >> nTime;
            file >> nFeeDelta;

            if (opts.use_current_time) {
                nTime = TicksSinceEpoch<std::chrono::seconds>(now);
            }

            CAmount amountdelta = nFeeDelta;
            if (amountdelta && opts.apply_fee_delta_priority) {
                pool.PrioritiseTransaction(tx->GetHash(), amountdelta);
            }
            if (nTime > TicksSinceEpoch<std::chrono::seconds>(now - pool.m_opts.expiry)) {
                LOCK(cs_main);
                const auto& accepted = AcceptToMemoryPool(active_chainstate, tx, nTime, /*bypass_limits=*/false, /*test_accept=*/false);
                if (accepted.m_result_type == MempoolAcceptResult::ResultType::VALID) {
                    ++count;
                } else {
                    // mempool may contain the transaction already, e.g. from
                    // wallet(s) having loaded it while we were processing
                    // mempool transactions; consider these as valid, instead of
                    // failed, but mark them as 'already there'
                    if (pool.exists(tx->GetHash())) {
                        ++already_there;
                    } else {
                        ++failed;
                    }
                }
            } else {
                ++expired;
            }
            if (active_chainstate.m_chainman.m_interrupt)
                return false;
        }
        std::map<Txid, CAmount> mapDeltas;
        file >> mapDeltas;

        if (opts.apply_fee_delta_priority) {
            for (const auto& i : mapDeltas) {
                pool.PrioritiseTransaction(i.first, i.second);
            }
        }

        std::set<Txid> unbroadcast_txids;
        file >> unbroadcast_txids;
        if (opts.apply_unbroadcast_set) {
            unbroadcast = unbroadcast_txids.size();
            for (const auto& txid : unbroadcast_txids) {
                // Ensure transactions were accepted to mempool then add to
                // unbroadcast set.
                if (pool.get(txid) != nullptr) pool.AddUnbroadcastTx(txid);
            }
        }
    } catch (const std::exception& e) {
        LogInfo("Failed to deserialize mempool data on file: %s. Continuing anyway.\n", e.what());
        return false;
    }

    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);
    return true;
}

bool DumpMempool(const CTxMemPool& pool, const fs::path& dump_path, FopenFn mockable_fopen_function, bool skip_file_commit)
{
    auto start = SteadyClock::now();

    std::map<Txid, CAmount> mapDeltas;
    std::vector<TxMempoolInfo> vinfo;
    std::set<Txid> unbroadcast_txids;

    static Mutex dump_mutex;
    LOCK(dump_mutex);

    {
        LOCK(pool.cs);
        for (const auto &i : pool.mapDeltas) {
            mapDeltas[i.first] = i.second;
        }
        vinfo = pool.infoAll();
        unbroadcast_txids = pool.GetUnbroadcastTxs();
    }

    auto mid = SteadyClock::now();

    const fs::path file_fspath{dump_path + ".new"};
    AutoFile file{mockable_fopen_function(file_fspath, "wb")};
    if (file.IsNull()) {
        return false;
    }

    try {
        const uint64_t version{pool.m_opts.persist_v1_dat ? MEMPOOL_DUMP_VERSION_NO_XOR_KEY : MEMPOOL_DUMP_VERSION};
        file << version;

        if (!pool.m_opts.persist_v1_dat) {
            const Obfuscation obfuscation{FastRandomContext{}.randbytes<Obfuscation::KEY_SIZE>()};
            file << obfuscation;
            file.SetObfuscation(obfuscation);
        } else {
            file.SetObfuscation({});
        }

        uint64_t mempool_transactions_to_write(vinfo.size());
        file << mempool_transactions_to_write;
        LogInfo("Writing %u mempool transactions to file...\n", mempool_transactions_to_write);
        for (const auto& i : vinfo) {
            file << TX_WITH_WITNESS(*(i.tx));
            file << int64_t{count_seconds(i.m_time)};
            file << int64_t{i.nFeeDelta};
            mapDeltas.erase(i.tx->GetHash());
        }

        file << mapDeltas;

        LogInfo("Writing %d unbroadcast transactions to file.\n", unbroadcast_txids.size());
        file << unbroadcast_txids;

        if (!skip_file_commit && !file.Commit()) {
            (void)file.fclose();
            throw std::runtime_error("Commit failed");
        }
        if (file.fclose() != 0) {
            throw std::runtime_error(
                strprintf("Error closing %s: %s", fs::PathToString(file_fspath), SysErrorString(errno)));
        }
        if (!RenameOver(dump_path + ".new", dump_path)) {
            throw std::runtime_error("Rename failed");
        }
        auto last = SteadyClock::now();

        LogInfo("Dumped mempool: %.3fs to copy, %.3fs to dump, %d bytes dumped to file\n",
                  Ticks<SecondsDouble>(mid - start),
                  Ticks<SecondsDouble>(last - mid),
                  fs::file_size(dump_path));
    } catch (const std::exception& e) {
        LogInfo("Failed to dump mempool: %s. Continuing anyway.\n", e.what());
        (void)file.fclose();
        return false;
    }
    return true;
}

} // namespace node

Coverage Report

Created: 2026-06-01 18:35

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