Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #include <bitcoin-build-config.h> // IWYU pragma: keep
7 : :
8 : : #include <validation.h>
9 : :
10 : : #include <arith_uint256.h>
11 : : #include <chain.h>
12 : : #include <checkqueue.h>
13 : : #include <clientversion.h>
14 : : #include <consensus/amount.h>
15 : : #include <consensus/consensus.h>
16 : : #include <consensus/merkle.h>
17 : : #include <consensus/tx_check.h>
18 : : #include <consensus/tx_verify.h>
19 : : #include <consensus/validation.h>
20 : : #include <cuckoocache.h>
21 : : #include <flatfile.h>
22 : : #include <hash.h>
23 : : #include <kernel/chainparams.h>
24 : : #include <kernel/coinstats.h>
25 : : #include <kernel/disconnected_transactions.h>
26 : : #include <kernel/mempool_entry.h>
27 : : #include <kernel/messagestartchars.h>
28 : : #include <kernel/notifications_interface.h>
29 : : #include <kernel/types.h>
30 : : #include <kernel/warning.h>
31 : : #include <logging.h>
32 : : #include <logging/timer.h>
33 : : #include <node/blockstorage.h>
34 : : #include <node/utxo_snapshot.h>
35 : : #include <policy/ephemeral_policy.h>
36 : : #include <policy/policy.h>
37 : : #include <policy/rbf.h>
38 : : #include <policy/settings.h>
39 : : #include <policy/truc_policy.h>
40 : : #include <pow.h>
41 : : #include <primitives/block.h>
42 : : #include <primitives/transaction.h>
43 : : #include <random.h>
44 : : #include <script/script.h>
45 : : #include <script/sigcache.h>
46 : : #include <signet.h>
47 : : #include <tinyformat.h>
48 : : #include <txdb.h>
49 : : #include <txmempool.h>
50 : : #include <uint256.h>
51 : : #include <undo.h>
52 : : #include <util/check.h>
53 : : #include <util/fs.h>
54 : : #include <util/fs_helpers.h>
55 : : #include <util/hasher.h>
56 : : #include <util/moneystr.h>
57 : : #include <util/rbf.h>
58 : : #include <util/result.h>
59 : : #include <util/signalinterrupt.h>
60 : : #include <util/strencodings.h>
61 : : #include <util/string.h>
62 : : #include <util/time.h>
63 : : #include <util/trace.h>
64 : : #include <util/translation.h>
65 : : #include <validationinterface.h>
66 : :
67 : : #include <algorithm>
68 : : #include <cassert>
69 : : #include <chrono>
70 : : #include <deque>
71 : : #include <numeric>
72 : : #include <optional>
73 : : #include <ranges>
74 : : #include <span>
75 : : #include <string>
76 : : #include <tuple>
77 : : #include <utility>
78 : :
79 : : using kernel::CCoinsStats;
80 : : using kernel::ChainstateRole;
81 : : using kernel::CoinStatsHashType;
82 : : using kernel::ComputeUTXOStats;
83 : : using kernel::Notifications;
84 : :
85 : : using fsbridge::FopenFn;
86 : : using node::BlockManager;
87 : : using node::BlockMap;
88 : : using node::CBlockIndexHeightOnlyComparator;
89 : : using node::CBlockIndexWorkComparator;
90 : : using node::SnapshotMetadata;
91 : :
92 : : /** Size threshold for warning about slow UTXO set flush to disk. */
93 : : static constexpr size_t WARN_FLUSH_COINS_SIZE = 1 << 30; // 1 GiB
94 : : /** Time window to wait between writing blocks/block index and chainstate to disk.
95 : : * Randomize writing time inside the window to prevent a situation where the
96 : : * network over time settles into a few cohorts of synchronized writers.
97 : : */
98 : : static constexpr auto DATABASE_WRITE_INTERVAL_MIN{50min};
99 : : static constexpr auto DATABASE_WRITE_INTERVAL_MAX{70min};
100 : : /** Maximum age of our tip for us to be considered current for fee estimation */
101 : : static constexpr std::chrono::hours MAX_FEE_ESTIMATION_TIP_AGE{3};
102 : : const std::vector<std::string> CHECKLEVEL_DOC {
103 : : "level 0 reads the blocks from disk",
104 : : "level 1 verifies block validity",
105 : : "level 2 verifies undo data",
106 : : "level 3 checks disconnection of tip blocks",
107 : : "level 4 tries to reconnect the blocks",
108 : : "each level includes the checks of the previous levels",
109 : : };
110 : : /** The number of blocks to keep below the deepest prune lock.
111 : : * There is nothing special about this number. It is higher than what we
112 : : * expect to see in regular mainnet reorgs, but not so high that it would
113 : : * noticeably interfere with the pruning mechanism.
114 : : * */
115 : : static constexpr int PRUNE_LOCK_BUFFER{10};
116 : :
117 : : TRACEPOINT_SEMAPHORE(validation, block_connected);
118 : : TRACEPOINT_SEMAPHORE(utxocache, flush);
119 : : TRACEPOINT_SEMAPHORE(mempool, replaced);
120 : : TRACEPOINT_SEMAPHORE(mempool, rejected);
121 : :
122 : 1142 : const CBlockIndex* Chainstate::FindForkInGlobalIndex(const CBlockLocator& locator) const
123 : : {
124 : 1142 : AssertLockHeld(cs_main);
125 : :
126 : : // Find the latest block common to locator and chain - we expect that
127 : : // locator.vHave is sorted descending by height.
128 [ + + ]: 7567 : for (const uint256& hash : locator.vHave) {
129 : 6541 : const CBlockIndex* pindex{m_blockman.LookupBlockIndex(hash)};
130 [ + + ]: 6541 : if (pindex) {
131 [ - + ]: 116 : if (m_chain.Contains(pindex)) {
132 : : return pindex;
133 : : }
134 [ # # # # : 0 : if (pindex->GetAncestor(m_chain.Height()) == m_chain.Tip()) {
# # ]
135 : 1142 : return m_chain.Tip();
136 : : }
137 : : }
138 : : }
139 [ - + ]: 1026 : return m_chain.Genesis();
140 : : }
141 : :
142 : : bool CheckInputScripts(const CTransaction& tx, TxValidationState& state,
143 : : const CCoinsViewCache& inputs, script_verify_flags flags, bool cacheSigStore,
144 : : bool cacheFullScriptStore, PrecomputedTransactionData& txdata,
145 : : ValidationCache& validation_cache,
146 : : std::vector<CScriptCheck>* pvChecks = nullptr)
147 : : EXCLUSIVE_LOCKS_REQUIRED(cs_main);
148 : :
149 : 1560624 : bool CheckFinalTxAtTip(const CBlockIndex& active_chain_tip, const CTransaction& tx)
150 : : {
151 : 1560624 : AssertLockHeld(cs_main);
152 : :
153 : : // CheckFinalTxAtTip() uses active_chain_tip.Height()+1 to evaluate
154 : : // nLockTime because when IsFinalTx() is called within
155 : : // AcceptBlock(), the height of the block *being*
156 : : // evaluated is what is used. Thus if we want to know if a
157 : : // transaction can be part of the *next* block, we need to call
158 : : // IsFinalTx() with one more than active_chain_tip.Height().
159 : 1560624 : const int nBlockHeight = active_chain_tip.nHeight + 1;
160 : :
161 : : // BIP113 requires that time-locked transactions have nLockTime set to
162 : : // less than the median time of the previous block they're contained in.
163 : : // When the next block is created its previous block will be the current
164 : : // chain tip, so we use that to calculate the median time passed to
165 : : // IsFinalTx().
166 : 1560624 : const int64_t nBlockTime{active_chain_tip.GetMedianTimePast()};
167 : :
168 : 1560624 : return IsFinalTx(tx, nBlockHeight, nBlockTime);
169 : : }
170 : :
171 : : namespace {
172 : : /**
173 : : * A helper which calculates heights of inputs of a given transaction.
174 : : *
175 : : * @param[in] tip The current chain tip. If an input belongs to a mempool
176 : : * transaction, we assume it will be confirmed in the next block.
177 : : * @param[in] coins Any CCoinsView that provides access to the relevant coins.
178 : : * @param[in] tx The transaction being evaluated.
179 : : *
180 : : * @returns A vector of input heights or nullopt, in case of an error.
181 : : */
182 : 877643 : std::optional<std::vector<int>> CalculatePrevHeights(
183 : : const CBlockIndex& tip,
184 : : const CCoinsView& coins,
185 : : const CTransaction& tx)
186 : : {
187 : 877643 : std::vector<int> prev_heights;
188 [ - + + - ]: 877643 : prev_heights.resize(tx.vin.size());
189 [ - + + + ]: 3460482 : for (size_t i = 0; i < tx.vin.size(); ++i) {
190 [ + - + - ]: 2582839 : if (auto coin{coins.GetCoin(tx.vin[i].prevout)}) {
191 [ + + ]: 5165678 : prev_heights[i] = coin->nHeight == MEMPOOL_HEIGHT
192 [ + + ]: 2582839 : ? tip.nHeight + 1 // Assume all mempool transaction confirm in the next block.
193 : 1530862 : : coin->nHeight;
194 : : } else {
195 [ # # # # ]: 0 : LogInfo("ERROR: %s: Missing input %d in transaction \'%s\'\n", __func__, i, tx.GetHash().GetHex());
196 : 0 : return std::nullopt;
197 : 2582839 : }
198 : : }
199 : 877643 : return prev_heights;
200 : 877643 : }
201 : : } // namespace
202 : :
203 : 877643 : std::optional<LockPoints> CalculateLockPointsAtTip(
204 : : CBlockIndex* tip,
205 : : const CCoinsView& coins_view,
206 : : const CTransaction& tx)
207 : : {
208 [ - + ]: 877643 : assert(tip);
209 : :
210 : 877643 : auto prev_heights{CalculatePrevHeights(*tip, coins_view, tx)};
211 [ - + ]: 877643 : if (!prev_heights.has_value()) return std::nullopt;
212 : :
213 : 877643 : CBlockIndex next_tip;
214 : 877643 : next_tip.pprev = tip;
215 : : // When SequenceLocks() is called within ConnectBlock(), the height
216 : : // of the block *being* evaluated is what is used.
217 : : // Thus if we want to know if a transaction can be part of the
218 : : // *next* block, we need to use one more than active_chainstate.m_chain.Height()
219 : 877643 : next_tip.nHeight = tip->nHeight + 1;
220 [ + - + - ]: 877643 : const auto [min_height, min_time] = CalculateSequenceLocks(tx, STANDARD_LOCKTIME_VERIFY_FLAGS, prev_heights.value(), next_tip);
221 : :
222 : : // Also store the hash of the block with the highest height of
223 : : // all the blocks which have sequence locked prevouts.
224 : : // This hash needs to still be on the chain
225 : : // for these LockPoint calculations to be valid
226 : : // Note: It is impossible to correctly calculate a maxInputBlock
227 : : // if any of the sequence locked inputs depend on unconfirmed txs,
228 : : // except in the special case where the relative lock time/height
229 : : // is 0, which is equivalent to no sequence lock. Since we assume
230 : : // input height of tip+1 for mempool txs and test the resulting
231 : : // min_height and min_time from CalculateSequenceLocks against tip+1.
232 : 877643 : int max_input_height{0};
233 [ + - + + ]: 3460482 : for (const int height : prev_heights.value()) {
234 : : // Can ignore mempool inputs since we'll fail if they had non-zero locks
235 [ + + ]: 2582839 : if (height != next_tip.nHeight) {
236 [ + + ]: 4913570 : max_input_height = std::max(max_input_height, height);
237 : : }
238 : : }
239 : :
240 : : // tip->GetAncestor(max_input_height) should never return a nullptr
241 : : // because max_input_height is always less than the tip height.
242 : : // It would, however, be a bad bug to continue execution, since a
243 : : // LockPoints object with the maxInputBlock member set to nullptr
244 : : // signifies no relative lock time.
245 [ + - - + ]: 877643 : return LockPoints{min_height, min_time, Assert(tip->GetAncestor(max_input_height))};
246 : 877643 : }
247 : :
248 : 877643 : bool CheckSequenceLocksAtTip(CBlockIndex* tip,
249 : : const LockPoints& lock_points)
250 : : {
251 [ - + ]: 877643 : assert(tip != nullptr);
252 : :
253 : 877643 : CBlockIndex index;
254 : 877643 : index.pprev = tip;
255 : : // CheckSequenceLocksAtTip() uses active_chainstate.m_chain.Height()+1 to evaluate
256 : : // height based locks because when SequenceLocks() is called within
257 : : // ConnectBlock(), the height of the block *being*
258 : : // evaluated is what is used.
259 : : // Thus if we want to know if a transaction can be part of the
260 : : // *next* block, we need to use one more than active_chainstate.m_chain.Height()
261 : 877643 : index.nHeight = tip->nHeight + 1;
262 : :
263 : 877643 : return EvaluateSequenceLocks(index, {lock_points.height, lock_points.time});
264 : : }
265 : :
266 : 333626 : static void LimitMempoolSize(CTxMemPool& pool, CCoinsViewCache& coins_cache)
267 : : EXCLUSIVE_LOCKS_REQUIRED(::cs_main, pool.cs)
268 : : {
269 : 333626 : AssertLockHeld(::cs_main);
270 : 333626 : AssertLockHeld(pool.cs);
271 : 333626 : int expired = pool.Expire(GetTime<std::chrono::seconds>() - pool.m_opts.expiry);
272 [ + + ]: 333626 : if (expired != 0) {
273 [ - + ]: 4241 : LogDebug(BCLog::MEMPOOL, "Expired %i transactions from the memory pool\n", expired);
274 : : }
275 : :
276 : 333626 : std::vector<COutPoint> vNoSpendsRemaining;
277 [ + - ]: 333626 : pool.TrimToSize(pool.m_opts.max_size_bytes, &vNoSpendsRemaining);
278 [ + + ]: 340991 : for (const COutPoint& removed : vNoSpendsRemaining)
279 [ + - ]: 7365 : coins_cache.Uncache(removed);
280 : 333626 : }
281 : :
282 : 183312 : static bool IsCurrentForFeeEstimation(Chainstate& active_chainstate) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
283 : : {
284 : 183312 : AssertLockHeld(cs_main);
285 [ + - ]: 183312 : if (active_chainstate.m_chainman.IsInitialBlockDownload()) {
286 : : return false;
287 : : }
288 [ - + + + ]: 366624 : if (active_chainstate.m_chain.Tip()->GetBlockTime() < count_seconds(GetTime<std::chrono::seconds>() - MAX_FEE_ESTIMATION_TIP_AGE))
289 : : return false;
290 [ - + - + ]: 19964 : if (active_chainstate.m_chain.Height() < active_chainstate.m_chainman.m_best_header->nHeight - 1) {
291 : 0 : return false;
292 : : }
293 : : return true;
294 : : }
295 : :
296 : 0 : void Chainstate::MaybeUpdateMempoolForReorg(
297 : : DisconnectedBlockTransactions& disconnectpool,
298 : : bool fAddToMempool)
299 : : {
300 [ # # ]: 0 : if (!m_mempool) return;
301 : :
302 : 0 : AssertLockHeld(cs_main);
303 : 0 : AssertLockHeld(m_mempool->cs);
304 : 0 : std::vector<Txid> vHashUpdate;
305 : 0 : {
306 : : // disconnectpool is ordered so that the front is the most recently-confirmed
307 : : // transaction (the last tx of the block at the tip) in the disconnected chain.
308 : : // Iterate disconnectpool in reverse, so that we add transactions
309 : : // back to the mempool starting with the earliest transaction that had
310 : : // been previously seen in a block.
311 [ # # ]: 0 : const auto queuedTx = disconnectpool.take();
312 : 0 : auto it = queuedTx.rbegin();
313 [ # # ]: 0 : while (it != queuedTx.rend()) {
314 : : // ignore validation errors in resurrected transactions
315 [ # # # # : 0 : if (!fAddToMempool || (*it)->IsCoinBase() ||
# # ]
316 [ # # # # ]: 0 : AcceptToMemoryPool(*this, *it, GetTime(),
317 [ # # ]: 0 : /*bypass_limits=*/true, /*test_accept=*/false).m_result_type !=
318 : : MempoolAcceptResult::ResultType::VALID) {
319 : : // If the transaction doesn't make it in to the mempool, remove any
320 : : // transactions that depend on it (which would now be orphans).
321 [ # # ]: 0 : m_mempool->removeRecursive(**it, MemPoolRemovalReason::REORG);
322 [ # # # # ]: 0 : } else if (m_mempool->exists((*it)->GetHash())) {
323 [ # # ]: 0 : vHashUpdate.push_back((*it)->GetHash());
324 : : }
325 : 0 : ++it;
326 : : }
327 : 0 : }
328 : :
329 : : // AcceptToMemoryPool/addNewTransaction all assume that new mempool entries have
330 : : // no in-mempool children, which is generally not true when adding
331 : : // previously-confirmed transactions back to the mempool.
332 : : // UpdateTransactionsFromBlock finds descendants of any transactions in
333 : : // the disconnectpool that were added back and cleans up the mempool state.
334 [ # # ]: 0 : m_mempool->UpdateTransactionsFromBlock(vHashUpdate);
335 : :
336 : : // Predicate to use for filtering transactions in removeForReorg.
337 : : // Checks whether the transaction is still final and, if it spends a coinbase output, mature.
338 : : // Also updates valid entries' cached LockPoints if needed.
339 : : // If false, the tx is still valid and its lockpoints are updated.
340 : : // If true, the tx would be invalid in the next block; remove this entry and all of its descendants.
341 : : // Note that TRUC rules are not applied here, so reorgs may cause violations of TRUC inheritance or
342 : : // topology restrictions.
343 : 0 : const auto filter_final_and_mature = [&](CTxMemPool::txiter it)
344 : : EXCLUSIVE_LOCKS_REQUIRED(m_mempool->cs, ::cs_main) {
345 : 0 : AssertLockHeld(m_mempool->cs);
346 : 0 : AssertLockHeld(::cs_main);
347 [ # # ]: 0 : const CTransaction& tx = it->GetTx();
348 : :
349 : : // The transaction must be final.
350 [ # # # # : 0 : if (!CheckFinalTxAtTip(*Assert(m_chain.Tip()), tx)) return true;
# # ]
351 : :
352 : 0 : const LockPoints& lp = it->GetLockPoints();
353 : : // CheckSequenceLocksAtTip checks if the transaction will be final in the next block to be
354 : : // created on top of the new chain.
355 [ # # ]: 0 : if (TestLockPointValidity(m_chain, lp)) {
356 [ # # # # ]: 0 : if (!CheckSequenceLocksAtTip(m_chain.Tip(), lp)) {
357 : : return true;
358 : : }
359 : : } else {
360 : 0 : const CCoinsViewMemPool view_mempool{&CoinsTip(), *m_mempool};
361 [ # # # # ]: 0 : const std::optional<LockPoints> new_lock_points{CalculateLockPointsAtTip(m_chain.Tip(), view_mempool, tx)};
362 [ # # # # : 0 : if (new_lock_points.has_value() && CheckSequenceLocksAtTip(m_chain.Tip(), *new_lock_points)) {
# # # # ]
363 : : // Now update the mempool entry lockpoints as well.
364 : 0 : it->UpdateLockPoints(*new_lock_points);
365 : : } else {
366 : 0 : return true;
367 : : }
368 : 0 : }
369 : :
370 : : // If the transaction spends any coinbase outputs, it must be mature.
371 [ # # ]: 0 : if (it->GetSpendsCoinbase()) {
372 [ # # ]: 0 : for (const CTxIn& txin : tx.vin) {
373 [ # # ]: 0 : if (m_mempool->exists(txin.prevout.hash)) continue;
374 : 0 : const Coin& coin{CoinsTip().AccessCoin(txin.prevout)};
375 [ # # ]: 0 : assert(!coin.IsSpent());
376 [ # # ]: 0 : const auto mempool_spend_height{m_chain.Tip()->nHeight + 1};
377 [ # # # # ]: 0 : if (coin.IsCoinBase() && mempool_spend_height - coin.nHeight < COINBASE_MATURITY) {
378 : : return true;
379 : : }
380 : : }
381 : : }
382 : : // Transaction is still valid and cached LockPoints are updated.
383 : : return false;
384 : 0 : };
385 : :
386 : : // We also need to remove any now-immature transactions
387 [ # # ]: 0 : m_mempool->removeForReorg(m_chain, filter_final_and_mature);
388 : : // Re-limit mempool size, in case we added any transactions
389 [ # # # # ]: 0 : LimitMempoolSize(*m_mempool, this->CoinsTip());
390 : 0 : }
391 : :
392 : : /**
393 : : * Checks to avoid mempool polluting consensus critical paths since cached
394 : : * signature and script validity results will be reused if we validate this
395 : : * transaction again during block validation.
396 : : * */
397 : 188125 : static bool CheckInputsFromMempoolAndCache(const CTransaction& tx, TxValidationState& state,
398 : : const CCoinsViewCache& view, const CTxMemPool& pool,
399 : : script_verify_flags flags, PrecomputedTransactionData& txdata, CCoinsViewCache& coins_tip,
400 : : ValidationCache& validation_cache)
401 : : EXCLUSIVE_LOCKS_REQUIRED(cs_main, pool.cs)
402 : : {
403 : 188125 : AssertLockHeld(cs_main);
404 : 188125 : AssertLockHeld(pool.cs);
405 : :
406 [ - + ]: 188125 : assert(!tx.IsCoinBase());
407 [ + + ]: 498089 : for (const CTxIn& txin : tx.vin) {
408 : 309964 : const Coin& coin = view.AccessCoin(txin.prevout);
409 : :
410 : : // This coin was checked in PreChecks and MemPoolAccept
411 : : // has been holding cs_main since then.
412 [ - + ]: 309964 : Assume(!coin.IsSpent());
413 [ + - ]: 309964 : if (coin.IsSpent()) return false;
414 : :
415 : : // If the Coin is available, there are 2 possibilities:
416 : : // it is available in our current ChainstateActive UTXO set,
417 : : // or it's a UTXO provided by a transaction in our mempool.
418 : : // Ensure the scriptPubKeys in Coins from CoinsView are correct.
419 : 309964 : const CTransactionRef& txFrom = pool.get(txin.prevout.hash);
420 [ + + ]: 309964 : if (txFrom) {
421 [ - + ]: 126291 : assert(txFrom->GetHash() == txin.prevout.hash);
422 [ - + - + ]: 126291 : assert(txFrom->vout.size() > txin.prevout.n);
423 [ - + ]: 126291 : assert(txFrom->vout[txin.prevout.n] == coin.out);
424 : : } else {
425 [ + - ]: 183673 : const Coin& coinFromUTXOSet = coins_tip.AccessCoin(txin.prevout);
426 [ - + ]: 183673 : assert(!coinFromUTXOSet.IsSpent());
427 [ - + ]: 183673 : assert(coinFromUTXOSet.out == coin.out);
428 : : }
429 : 309964 : }
430 : :
431 : : // Call CheckInputScripts() to cache signature and script validity against current tip consensus rules.
432 : 188125 : return CheckInputScripts(tx, state, view, flags, /* cacheSigStore= */ true, /* cacheFullScriptStore= */ true, txdata, validation_cache);
433 : : }
434 : :
435 : : namespace {
436 : :
437 : : class MemPoolAccept
438 : : {
439 : : public:
440 : 1720819 : explicit MemPoolAccept(CTxMemPool& mempool, Chainstate& active_chainstate) :
441 : 1720819 : m_pool(mempool),
442 : 1720819 : m_view(&m_dummy),
443 [ + - + - ]: 1720819 : m_viewmempool(&active_chainstate.CoinsTip(), m_pool),
444 : 1720819 : m_active_chainstate(active_chainstate)
445 : : {
446 : 1720819 : }
447 : :
448 : : // We put the arguments we're handed into a struct, so we can pass them
449 : : // around easier.
450 : : struct ATMPArgs {
451 : : const CChainParams& m_chainparams;
452 : : const int64_t m_accept_time;
453 : : const bool m_bypass_limits;
454 : : /*
455 : : * Return any outpoints which were not previously present in the coins
456 : : * cache, but were added as a result of validating the tx for mempool
457 : : * acceptance. This allows the caller to optionally remove the cache
458 : : * additions if the associated transaction ends up being rejected by
459 : : * the mempool.
460 : : */
461 : : std::vector<COutPoint>& m_coins_to_uncache;
462 : : /** When true, the transaction or package will not be submitted to the mempool. */
463 : : const bool m_test_accept;
464 : : /** Whether we allow transactions to replace mempool transactions. If false,
465 : : * any transaction spending the same inputs as a transaction in the mempool is considered
466 : : * a conflict. */
467 : : const bool m_allow_replacement;
468 : : /** When true, allow sibling eviction. This only occurs in single transaction package settings. */
469 : : const bool m_allow_sibling_eviction;
470 : : /** Used to skip the LimitMempoolSize() call within AcceptSingleTransaction(). This should be used when multiple
471 : : * AcceptSubPackage calls are expected and the mempool will be trimmed at the end of AcceptPackage(). */
472 : : const bool m_package_submission;
473 : : /** When true, use package feerates instead of individual transaction feerates for fee-based
474 : : * policies such as mempool min fee and min relay fee.
475 : : */
476 : : const bool m_package_feerates;
477 : : /** Used for local submission of transactions to catch "absurd" fees
478 : : * due to fee miscalculation by wallets. std:nullopt implies unset, allowing any feerates.
479 : : * Any individual transaction failing this check causes immediate failure.
480 : : */
481 : : const std::optional<CFeeRate> m_client_maxfeerate;
482 : :
483 : : /** Parameters for single transaction mempool validation. */
484 : 1174206 : static ATMPArgs SingleAccept(const CChainParams& chainparams, int64_t accept_time,
485 : : bool bypass_limits, std::vector<COutPoint>& coins_to_uncache,
486 : : bool test_accept) {
487 : 1174206 : return ATMPArgs{/* m_chainparams */ chainparams,
488 : : /* m_accept_time */ accept_time,
489 : : /* m_bypass_limits */ bypass_limits,
490 : : /* m_coins_to_uncache */ coins_to_uncache,
491 : : /* m_test_accept */ test_accept,
492 : : /* m_allow_replacement */ true,
493 : : /* m_allow_sibling_eviction */ true,
494 : : /* m_package_submission */ false,
495 : : /* m_package_feerates */ false,
496 : : /* m_client_maxfeerate */ {}, // checked by caller
497 : 1174206 : };
498 : : }
499 : :
500 : : /** Parameters for test package mempool validation through testmempoolaccept. */
501 : 164602 : static ATMPArgs PackageTestAccept(const CChainParams& chainparams, int64_t accept_time,
502 : : std::vector<COutPoint>& coins_to_uncache) {
503 : 164602 : return ATMPArgs{/* m_chainparams */ chainparams,
504 : : /* m_accept_time */ accept_time,
505 : : /* m_bypass_limits */ false,
506 : : /* m_coins_to_uncache */ coins_to_uncache,
507 : : /* m_test_accept */ true,
508 : : /* m_allow_replacement */ false,
509 : : /* m_allow_sibling_eviction */ false,
510 : : /* m_package_submission */ false, // not submitting to mempool
511 : : /* m_package_feerates */ false,
512 : : /* m_client_maxfeerate */ {}, // checked by caller
513 : 164602 : };
514 : : }
515 : :
516 : : /** Parameters for child-with-parents package validation. */
517 : 382011 : static ATMPArgs PackageChildWithParents(const CChainParams& chainparams, int64_t accept_time,
518 : : std::vector<COutPoint>& coins_to_uncache, const std::optional<CFeeRate>& client_maxfeerate) {
519 : 382011 : return ATMPArgs{/* m_chainparams */ chainparams,
520 : : /* m_accept_time */ accept_time,
521 : : /* m_bypass_limits */ false,
522 : : /* m_coins_to_uncache */ coins_to_uncache,
523 : : /* m_test_accept */ false,
524 : : /* m_allow_replacement */ true,
525 : : /* m_allow_sibling_eviction */ false,
526 : : /* m_package_submission */ true,
527 : : /* m_package_feerates */ true,
528 : : /* m_client_maxfeerate */ client_maxfeerate,
529 : 382011 : };
530 : : }
531 : :
532 : : /** Parameters for a single transaction within a package. */
533 : 618421 : static ATMPArgs SingleInPackageAccept(const ATMPArgs& package_args) {
534 : 618421 : return ATMPArgs{/* m_chainparams */ package_args.m_chainparams,
535 : 618421 : /* m_accept_time */ package_args.m_accept_time,
536 : : /* m_bypass_limits */ false,
537 : : /* m_coins_to_uncache */ package_args.m_coins_to_uncache,
538 : 618421 : /* m_test_accept */ package_args.m_test_accept,
539 : : /* m_allow_replacement */ true,
540 : : /* m_allow_sibling_eviction */ true,
541 : : /* m_package_submission */ true, // trim at the end of AcceptPackage()
542 : : /* m_package_feerates */ false, // only 1 transaction
543 : : /* m_client_maxfeerate */ package_args.m_client_maxfeerate,
544 : 618421 : };
545 : : }
546 : :
547 : : private:
548 : : // Private ctor to avoid exposing details to clients and allowing the possibility of
549 : : // mixing up the order of the arguments. Use static functions above instead.
550 : 2339240 : ATMPArgs(const CChainParams& chainparams,
551 : : int64_t accept_time,
552 : : bool bypass_limits,
553 : : std::vector<COutPoint>& coins_to_uncache,
554 : : bool test_accept,
555 : : bool allow_replacement,
556 : : bool allow_sibling_eviction,
557 : : bool package_submission,
558 : : bool package_feerates,
559 : : std::optional<CFeeRate> client_maxfeerate)
560 : 2339240 : : m_chainparams{chainparams},
561 : 2339240 : m_accept_time{accept_time},
562 : 2339240 : m_bypass_limits{bypass_limits},
563 : 2339240 : m_coins_to_uncache{coins_to_uncache},
564 : 2339240 : m_test_accept{test_accept},
565 : 2339240 : m_allow_replacement{allow_replacement},
566 : 2339240 : m_allow_sibling_eviction{allow_sibling_eviction},
567 : 2339240 : m_package_submission{package_submission},
568 : 2339240 : m_package_feerates{package_feerates},
569 : 2339240 : m_client_maxfeerate{client_maxfeerate}
570 : : {
571 : : // If we are using package feerates, we must be doing package submission.
572 : : // It also means sibling eviction is not permitted.
573 [ + + ]: 2339240 : if (m_package_feerates) {
574 [ - + ]: 382011 : Assume(m_package_submission);
575 [ - + ]: 382011 : Assume(!m_allow_sibling_eviction);
576 : : }
577 [ + + - + ]: 2339240 : if (m_allow_sibling_eviction) Assume(m_allow_replacement);
578 : 2339240 : }
579 : : };
580 : :
581 : : /** Clean up all non-chainstate coins from m_view and m_viewmempool. */
582 : : void CleanupTemporaryCoins() EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
583 : :
584 : : // Single transaction acceptance
585 : 1174206 : MempoolAcceptResult AcceptSingleTransactionAndCleanup(const CTransactionRef& ptx, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
586 : 1174206 : LOCK(m_pool.cs);
587 [ + - ]: 1174206 : MempoolAcceptResult result = AcceptSingleTransactionInternal(ptx, args);
588 [ + - ]: 1174206 : ClearSubPackageState();
589 [ + - ]: 1174206 : return result;
590 : 1174206 : }
591 : : MempoolAcceptResult AcceptSingleTransactionInternal(const CTransactionRef& ptx, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
592 : :
593 : : /**
594 : : * Multiple transaction acceptance. Transactions may or may not be interdependent, but must not
595 : : * conflict with each other, and the transactions cannot already be in the mempool. Parents must
596 : : * come before children if any dependencies exist.
597 : : */
598 : 164602 : PackageMempoolAcceptResult AcceptMultipleTransactionsAndCleanup(const std::vector<CTransactionRef>& txns, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
599 : 164602 : LOCK(m_pool.cs);
600 [ + - ]: 164602 : PackageMempoolAcceptResult result = AcceptMultipleTransactionsInternal(txns, args);
601 [ + - ]: 164602 : ClearSubPackageState();
602 [ + - ]: 164602 : return result;
603 : 164602 : }
604 : : PackageMempoolAcceptResult AcceptMultipleTransactionsInternal(const std::vector<CTransactionRef>& txns, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
605 : :
606 : : /**
607 : : * Submission of a subpackage.
608 : : * If subpackage size == 1, calls AcceptSingleTransaction() with adjusted ATMPArgs to
609 : : * enable sibling eviction and creates a PackageMempoolAcceptResult
610 : : * wrapping the result.
611 : : *
612 : : * If subpackage size > 1, calls AcceptMultipleTransactions() with the provided ATMPArgs.
613 : : *
614 : : * Also cleans up all non-chainstate coins from m_view at the end.
615 : : */
616 : : PackageMempoolAcceptResult AcceptSubPackage(const std::vector<CTransactionRef>& subpackage, ATMPArgs& args)
617 : : EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
618 : :
619 : : /**
620 : : * Package (more specific than just multiple transactions) acceptance. Package must be a child
621 : : * with all of its unconfirmed parents, and topologically sorted.
622 : : */
623 : : PackageMempoolAcceptResult AcceptPackage(const Package& package, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
624 : :
625 : : private:
626 : : // All the intermediate state that gets passed between the various levels
627 : : // of checking a given transaction.
628 : : struct Workspace {
629 : 2122759 : explicit Workspace(const CTransactionRef& ptx) : m_ptx(ptx), m_hash(ptx->GetHash()) {}
630 : : /** Txids of mempool transactions that this transaction directly conflicts with or may
631 : : * replace via sibling eviction. */
632 : : std::set<Txid> m_conflicts;
633 : : /** Iterators to mempool entries that this transaction directly conflicts with or may
634 : : * replace via sibling eviction. */
635 : : CTxMemPool::setEntries m_iters_conflicting;
636 : : /** All mempool parents of this transaction. */
637 : : std::vector<CTxMemPoolEntry::CTxMemPoolEntryRef> m_parents;
638 : : /* Handle to the tx in the changeset */
639 : : CTxMemPool::ChangeSet::TxHandle m_tx_handle;
640 : : /** Whether RBF-related data structures (m_conflicts, m_iters_conflicting,
641 : : * m_replaced_transactions) include a sibling in addition to txns with conflicting inputs. */
642 : : bool m_sibling_eviction{false};
643 : :
644 : : /** Virtual size of the transaction as used by the mempool, calculated using serialized size
645 : : * of the transaction and sigops. */
646 : : int64_t m_vsize;
647 : : /** Fees paid by this transaction: total input amounts subtracted by total output amounts. */
648 : : CAmount m_base_fees;
649 : : /** Base fees + any fee delta set by the user with prioritisetransaction. */
650 : : CAmount m_modified_fees;
651 : :
652 : : /** If we're doing package validation (i.e. m_package_feerates=true), the "effective"
653 : : * package feerate of this transaction is the total fees divided by the total size of
654 : : * transactions (which may include its ancestors and/or descendants). */
655 : : CFeeRate m_package_feerate{0};
656 : :
657 : : const CTransactionRef& m_ptx;
658 : : /** Txid. */
659 : : const Txid& m_hash;
660 : : TxValidationState m_state;
661 : : /** A temporary cache containing serialized transaction data for signature verification.
662 : : * Reused across PolicyScriptChecks and ConsensusScriptChecks. */
663 : : PrecomputedTransactionData m_precomputed_txdata;
664 : : };
665 : :
666 : : // Run the policy checks on a given transaction, excluding any script checks.
667 : : // Looks up inputs, calculates feerate, considers replacement, evaluates
668 : : // package limits, etc. As this function can be invoked for "free" by a peer,
669 : : // only tests that are fast should be done here (to avoid CPU DoS).
670 : : bool PreChecks(ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
671 : :
672 : : // Run checks for mempool replace-by-fee, only used in AcceptSingleTransaction.
673 : : bool ReplacementChecks(Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
674 : :
675 : : // Enforce package mempool ancestor/descendant limits (distinct from individual
676 : : // ancestor/descendant limits done in PreChecks) and run Package RBF checks.
677 : : bool PackageMempoolChecks(const std::vector<CTransactionRef>& txns,
678 : : std::vector<Workspace>& workspaces,
679 : : int64_t total_vsize,
680 : : PackageValidationState& package_state) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
681 : :
682 : : // Run the script checks using our policy flags. As this can be slow, we should
683 : : // only invoke this on transactions that have otherwise passed policy checks.
684 : : bool PolicyScriptChecks(const ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
685 : :
686 : : // Re-run the script checks, using consensus flags, and try to cache the
687 : : // result in the scriptcache. This should be done after
688 : : // PolicyScriptChecks(). This requires that all inputs either be in our
689 : : // utxo set or in the mempool.
690 : : bool ConsensusScriptChecks(const ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
691 : :
692 : : // Try to add the transaction to the mempool, removing any conflicts first.
693 : : void FinalizeSubpackage(const ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
694 : :
695 : : // Submit all transactions to the mempool and call ConsensusScriptChecks to add to the script
696 : : // cache - should only be called after successful validation of all transactions in the package.
697 : : // Does not call LimitMempoolSize(), so mempool max_size_bytes may be temporarily exceeded.
698 : : bool SubmitPackage(const ATMPArgs& args, std::vector<Workspace>& workspaces, PackageValidationState& package_state,
699 : : std::map<Wtxid, MempoolAcceptResult>& results)
700 : : EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
701 : :
702 : : // Compare a package's feerate against minimum allowed.
703 : 512675 : bool CheckFeeRate(size_t package_size, CAmount package_fee, TxValidationState& state) EXCLUSIVE_LOCKS_REQUIRED(::cs_main, m_pool.cs)
704 : : {
705 : 512675 : AssertLockHeld(::cs_main);
706 : 512675 : AssertLockHeld(m_pool.cs);
707 : 512675 : CAmount mempoolRejectFee = m_pool.GetMinFee().GetFee(package_size);
708 [ + + + + ]: 512675 : if (mempoolRejectFee > 0 && package_fee < mempoolRejectFee) {
709 [ + - + - ]: 17122 : return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "mempool min fee not met", strprintf("%d < %d", package_fee, mempoolRejectFee));
710 : : }
711 : :
712 [ + + ]: 495553 : if (package_fee < m_pool.m_opts.min_relay_feerate.GetFee(package_size)) {
713 [ + - + - ]: 49064 : return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "min relay fee not met",
714 : 98128 : strprintf("%d < %d", package_fee, m_pool.m_opts.min_relay_feerate.GetFee(package_size)));
715 : : }
716 : : return true;
717 : : }
718 : :
719 : 417962 : ValidationCache& GetValidationCache()
720 : : {
721 : 417962 : return m_active_chainstate.m_chainman.m_validation_cache;
722 : : }
723 : :
724 : : private:
725 : : CTxMemPool& m_pool;
726 : :
727 : : /** Holds a cached view of available coins from the UTXO set, mempool, and artificial temporary coins (to enable package validation).
728 : : * The view doesn't track whether a coin previously existed but has now been spent. We detect conflicts in other ways:
729 : : * - conflicts within a transaction are checked in CheckTransaction (bad-txns-inputs-duplicate)
730 : : * - conflicts within a package are checked in IsWellFormedPackage (conflict-in-package)
731 : : * - conflicts with an existing mempool transaction are found in CTxMemPool::GetConflictTx and replacements are allowed
732 : : * The temporary coins should persist between individual transaction checks so that package validation is possible,
733 : : * but must be cleaned up when we finish validating a subpackage, whether accepted or rejected. The cache must also
734 : : * be cleared when mempool contents change (when a changeset is applied or when the mempool trims itself) because it
735 : : * can return cached coins that no longer exist in the backend. Use CleanupTemporaryCoins() anytime you are finished
736 : : * with a SubPackageState or call LimitMempoolSize().
737 : : */
738 : : CCoinsViewCache m_view;
739 : :
740 : : // These are the two possible backends for m_view.
741 : : /** When m_view is connected to m_viewmempool as its backend, it can pull coins from the mempool and from the UTXO
742 : : * set. This is also where temporary coins are stored. */
743 : : CCoinsViewMemPool m_viewmempool;
744 : : /** When m_view is connected to m_dummy, it can no longer look up coins from the mempool or UTXO set (meaning no disk
745 : : * operations happen), but can still return coins it accessed previously. Useful for keeping track of which coins
746 : : * were pulled from disk. */
747 : : CCoinsView m_dummy;
748 : :
749 : : Chainstate& m_active_chainstate;
750 : :
751 : : // Fields below are per *sub*package state and must be reset prior to subsequent
752 : : // AcceptSingleTransaction and AcceptMultipleTransactions invocations
753 : 4040376 : struct SubPackageState {
754 : : /** Aggregated modified fees of all transactions, used to calculate package feerate. */
755 : : CAmount m_total_modified_fees{0};
756 : : /** Aggregated virtual size of all transactions, used to calculate package feerate. */
757 : : int64_t m_total_vsize{0};
758 : :
759 : : // RBF-related members
760 : : /** Whether the transaction(s) would replace any mempool transactions and/or evict any siblings.
761 : : * If so, RBF rules apply. */
762 : : bool m_rbf{false};
763 : : /** Mempool transactions that were replaced. */
764 : : std::list<CTransactionRef> m_replaced_transactions;
765 : : /* Changeset representing adding transactions and removing their conflicts. */
766 : : std::unique_ptr<CTxMemPool::ChangeSet> m_changeset;
767 : :
768 : : /** Total modified fees of mempool transactions being replaced. */
769 : : CAmount m_conflicting_fees{0};
770 : : /** Total size (in virtual bytes) of mempool transactions being replaced. */
771 : : size_t m_conflicting_size{0};
772 : : };
773 : :
774 : : struct SubPackageState m_subpackage;
775 : :
776 : : /** Re-set sub-package state to not leak between evaluations */
777 : 2319557 : void ClearSubPackageState() EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs)
778 : : {
779 : 2319557 : m_subpackage = SubPackageState{};
780 : :
781 : : // And clean coins while at it
782 : 2319557 : CleanupTemporaryCoins();
783 : 2319557 : }
784 : : };
785 : :
786 : 2114537 : bool MemPoolAccept::PreChecks(ATMPArgs& args, Workspace& ws)
787 : : {
788 : 2114537 : AssertLockHeld(cs_main);
789 : 2114537 : AssertLockHeld(m_pool.cs);
790 : 2114537 : const CTransactionRef& ptx = ws.m_ptx;
791 : 2114537 : const CTransaction& tx = *ws.m_ptx;
792 : 2114537 : const Txid& hash = ws.m_hash;
793 : :
794 : : // Copy/alias what we need out of args
795 : 2114537 : const int64_t nAcceptTime = args.m_accept_time;
796 : 2114537 : const bool bypass_limits = args.m_bypass_limits;
797 : 2114537 : std::vector<COutPoint>& coins_to_uncache = args.m_coins_to_uncache;
798 : :
799 : : // Alias what we need out of ws
800 : 2114537 : TxValidationState& state = ws.m_state;
801 : :
802 [ + + ]: 2114537 : if (!CheckTransaction(tx, state)) {
803 : : return false; // state filled in by CheckTransaction
804 : : }
805 : :
806 : : // Coinbase is only valid in a block, not as a loose transaction
807 [ + + ]: 1633953 : if (tx.IsCoinBase())
808 [ + - + - ]: 8692 : return state.Invalid(TxValidationResult::TX_CONSENSUS, "coinbase");
809 : :
810 : : // Rather not work on nonstandard transactions (unless -testnet/-regtest)
811 [ + + ]: 1625261 : std::string reason;
812 [ + + + - : 1625261 : if (m_pool.m_opts.require_standard && !IsStandardTx(tx, m_pool.m_opts.max_datacarrier_bytes, m_pool.m_opts.permit_bare_multisig, m_pool.m_opts.dust_relay_feerate, reason)) {
+ + ]
813 [ + - + - ]: 60803 : return state.Invalid(TxValidationResult::TX_NOT_STANDARD, reason);
814 : : }
815 : :
816 : : // Transactions smaller than 65 non-witness bytes are not relayed to mitigate CVE-2017-12842.
817 [ + + ]: 1564458 : if (::GetSerializeSize(TX_NO_WITNESS(tx)) < MIN_STANDARD_TX_NONWITNESS_SIZE)
818 [ + - + - : 3834 : return state.Invalid(TxValidationResult::TX_NOT_STANDARD, "tx-size-small");
+ - ]
819 : :
820 : : // Only accept nLockTime-using transactions that can be mined in the next
821 : : // block; we don't want our mempool filled up with transactions that can't
822 : : // be mined yet.
823 [ - + - + : 3121248 : if (!CheckFinalTxAtTip(*Assert(m_active_chainstate.m_chain.Tip()), tx)) {
+ - + + ]
824 [ + - + - : 67507 : return state.Invalid(TxValidationResult::TX_PREMATURE_SPEND, "non-final");
+ - ]
825 : : }
826 : :
827 [ + - + + ]: 1493117 : if (m_pool.exists(tx.GetWitnessHash())) {
828 : : // Exact transaction already exists in the mempool.
829 [ + - + - : 59182 : return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-already-in-mempool");
+ - ]
830 [ + - + + ]: 1433935 : } else if (m_pool.exists(tx.GetHash())) {
831 : : // Transaction with the same non-witness data but different witness (same txid, different
832 : : // wtxid) already exists in the mempool.
833 [ + - + - : 153 : return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-same-nonwitness-data-in-mempool");
+ - ]
834 : : }
835 : :
836 : : // Check for conflicts with in-memory transactions
837 [ + + ]: 7271986 : for (const CTxIn &txin : tx.vin)
838 : : {
839 [ + - ]: 5938097 : const CTransaction* ptxConflicting = m_pool.GetConflictTx(txin.prevout);
840 [ + + ]: 5938097 : if (ptxConflicting) {
841 [ + + ]: 831619 : if (!args.m_allow_replacement) {
842 : : // Transaction conflicts with a mempool tx, but we're not allowing replacements in this context.
843 [ + - + - : 99893 : return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "bip125-replacement-disallowed");
+ - ]
844 : : }
845 [ + - ]: 731726 : ws.m_conflicts.insert(ptxConflicting->GetHash());
846 : : }
847 : : }
848 : :
849 [ + - ]: 1333889 : m_view.SetBackend(m_viewmempool);
850 : :
851 [ + - ]: 1333889 : const CCoinsViewCache& coins_cache = m_active_chainstate.CoinsTip();
852 : : // do all inputs exist?
853 [ + + ]: 4019170 : for (const CTxIn& txin : tx.vin) {
854 [ + - + + ]: 3141527 : if (!coins_cache.HaveCoinInCache(txin.prevout)) {
855 [ + - ]: 1625636 : coins_to_uncache.push_back(txin.prevout);
856 : : }
857 : :
858 : : // Note: this call may add txin.prevout to the coins cache
859 : : // (coins_cache.cacheCoins) by way of FetchCoin(). It should be removed
860 : : // later (via coins_to_uncache) if this tx turns out to be invalid.
861 [ + - + + ]: 3141527 : if (!m_view.HaveCoin(txin.prevout)) {
862 : : // Are inputs missing because we already have the tx?
863 [ - + + + ]: 2123067 : for (size_t out = 0; out < tx.vout.size(); out++) {
864 : : // Optimistically just do efficient check of cache for outputs
865 [ + - - + ]: 1666821 : if (coins_cache.HaveCoinInCache(COutPoint(hash, out))) {
866 [ # # # # : 0 : return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-already-known");
# # ]
867 : : }
868 : : }
869 : : // Otherwise assume this might be an orphan tx for which we just haven't seen parents yet
870 [ + - + - : 456246 : return state.Invalid(TxValidationResult::TX_MISSING_INPUTS, "bad-txns-inputs-missingorspent");
+ - ]
871 : : }
872 : : }
873 : :
874 : : // This is const, but calls into the back end CoinsViews. The CCoinsViewDB at the bottom of the
875 : : // hierarchy brings the best block into scope. See CCoinsViewDB::GetBestBlock().
876 [ + - ]: 877643 : m_view.GetBestBlock();
877 : :
878 : : // we have all inputs cached now, so switch back to dummy (to protect
879 : : // against bugs where we pull more inputs from disk that miss being added
880 : : // to coins_to_uncache)
881 [ + - ]: 877643 : m_view.SetBackend(m_dummy);
882 : :
883 [ + - + - : 1755286 : assert(m_active_chainstate.m_blockman.LookupBlockIndex(m_view.GetBestBlock()) == m_active_chainstate.m_chain.Tip());
- + - + ]
884 : :
885 : : // Only accept BIP68 sequence locked transactions that can be mined in the next
886 : : // block; we don't want our mempool filled up with transactions that can't
887 : : // be mined yet.
888 : : // Pass in m_view which has all of the relevant inputs cached. Note that, since m_view's
889 : : // backend was removed, it no longer pulls coins from the mempool.
890 [ + - ]: 877643 : const std::optional<LockPoints> lock_points{CalculateLockPointsAtTip(m_active_chainstate.m_chain.Tip(), m_view, tx)};
891 [ + - - + : 1755286 : if (!lock_points.has_value() || !CheckSequenceLocksAtTip(m_active_chainstate.m_chain.Tip(), *lock_points)) {
+ - + + ]
892 [ + - + - : 29133 : return state.Invalid(TxValidationResult::TX_PREMATURE_SPEND, "non-BIP68-final");
+ - ]
893 : : }
894 : :
895 : : // The mempool holds txs for the next block, so pass height+1 to CheckTxInputs
896 [ - + + - : 848510 : if (!Consensus::CheckTxInputs(tx, state, m_view, m_active_chainstate.m_chain.Height() + 1, ws.m_base_fees)) {
+ + ]
897 : : return false; // state filled in by CheckTxInputs
898 : : }
899 : :
900 [ + + + - : 842870 : if (m_pool.m_opts.require_standard && !AreInputsStandard(tx, m_view)) {
+ + ]
901 [ + - + - : 96 : return state.Invalid(TxValidationResult::TX_INPUTS_NOT_STANDARD, "bad-txns-nonstandard-inputs");
+ - ]
902 : : }
903 : :
904 : : // Check for non-standard witnesses.
905 [ + + + + : 842774 : if (tx.HasWitness() && m_pool.m_opts.require_standard && !IsWitnessStandard(tx, m_view)) {
+ - + + ]
906 [ + - + - : 1919 : return state.Invalid(TxValidationResult::TX_WITNESS_MUTATED, "bad-witness-nonstandard");
+ - ]
907 : : }
908 : :
909 [ + - ]: 840855 : int64_t nSigOpsCost = GetTransactionSigOpCost(tx, m_view, STANDARD_SCRIPT_VERIFY_FLAGS);
910 : :
911 : : // Keep track of transactions that spend a coinbase, which we re-scan
912 : : // during reorgs to ensure COINBASE_MATURITY is still met.
913 : 840855 : bool fSpendsCoinbase = false;
914 [ + + ]: 1597681 : for (const CTxIn &txin : tx.vin) {
915 [ + - ]: 1305302 : const Coin &coin = m_view.AccessCoin(txin.prevout);
916 [ + + ]: 1305302 : if (coin.IsCoinBase()) {
917 : : fSpendsCoinbase = true;
918 : : break;
919 : : }
920 : : }
921 : :
922 : : // Set entry_sequence to 0 when bypass_limits is used; this allows txs from a block
923 : : // reorg to be marked earlier than any child txs that were already in the mempool.
924 [ + + ]: 840855 : const uint64_t entry_sequence = bypass_limits ? 0 : m_pool.GetSequence();
925 [ + + ]: 840855 : if (!m_subpackage.m_changeset) {
926 [ + - ]: 758699 : m_subpackage.m_changeset = m_pool.GetChangeSet();
927 : : }
928 [ + - - + : 840855 : ws.m_tx_handle = m_subpackage.m_changeset->StageAddition(ptx, ws.m_base_fees, nAcceptTime, m_active_chainstate.m_chain.Height(), entry_sequence, fSpendsCoinbase, nSigOpsCost, lock_points.value());
+ - ]
929 : :
930 : : // ws.m_modified_fees includes any fee deltas from PrioritiseTransaction
931 [ + - ]: 840855 : ws.m_modified_fees = ws.m_tx_handle->GetModifiedFee();
932 : :
933 [ + - ]: 840855 : ws.m_vsize = ws.m_tx_handle->GetTxSize();
934 : :
935 : : // Enforces 0-fee for dust transactions, no incentive to be mined alone
936 [ + + ]: 840855 : if (m_pool.m_opts.require_standard) {
937 [ + - + + ]: 732238 : if (!PreCheckEphemeralTx(*ptx, m_pool.m_opts.dust_relay_feerate, ws.m_base_fees, ws.m_modified_fees, state)) {
938 : : return false; // state filled in by PreCheckEphemeralTx
939 : : }
940 : : }
941 : :
942 [ + + ]: 658226 : if (nSigOpsCost > MAX_STANDARD_TX_SIGOPS_COST)
943 [ + - + - ]: 23 : return state.Invalid(TxValidationResult::TX_NOT_STANDARD, "bad-txns-too-many-sigops",
944 [ + - ]: 46 : strprintf("%d", nSigOpsCost));
945 : :
946 : : // No individual transactions are allowed below the mempool min feerate except from disconnected
947 : : // blocks and transactions in a package. Package transactions will be checked using package
948 : : // feerate later.
949 [ + + + + : 658203 : if (!bypass_limits && !args.m_package_feerates && !CheckFeeRate(ws.m_vsize, ws.m_modified_fees, state)) return false;
+ - + + ]
950 : :
951 [ + - ]: 593778 : ws.m_iters_conflicting = m_pool.GetIterSet(ws.m_conflicts);
952 : :
953 [ + - ]: 593778 : ws.m_parents = m_pool.GetParents(*ws.m_tx_handle);
954 : :
955 [ + + ]: 593778 : if (!args.m_bypass_limits) {
956 : : // Perform the TRUC checks, using the in-mempool parents.
957 [ + - + + ]: 533238 : if (const auto err{SingleTRUCChecks(m_pool, ws.m_ptx, ws.m_parents, ws.m_conflicts, ws.m_vsize)}) {
958 : : // Single transaction contexts only.
959 [ + + + + ]: 7532 : if (args.m_allow_sibling_eviction && err->second != nullptr) {
960 : : // We should only be considering where replacement is considered valid as well.
961 [ - + ]: 277 : Assume(args.m_allow_replacement);
962 : : // Potential sibling eviction. Add the sibling to our list of mempool conflicts to be
963 : : // included in RBF checks.
964 [ + - ]: 277 : ws.m_conflicts.insert(err->second->GetHash());
965 : : // Adding the sibling to m_iters_conflicting here means that it doesn't count towards
966 : : // RBF Carve Out above. This is correct, since removing to-be-replaced transactions from
967 : : // the descendant count is done separately in SingleTRUCChecks for TRUC transactions.
968 [ + - + - ]: 554 : ws.m_iters_conflicting.insert(m_pool.GetIter(err->second->GetHash()).value());
969 : 277 : ws.m_sibling_eviction = true;
970 : : // The sibling will be treated as part of the to-be-replaced set in ReplacementChecks.
971 : : // Note that we are not checking whether it opts in to replaceability via BIP125 or TRUC
972 : : // (which is normally done in PreChecks). However, the only way a TRUC transaction can
973 : : // have a non-TRUC and non-BIP125 descendant is due to a reorg.
974 : : } else {
975 [ + - + - ]: 7255 : return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "TRUC-violation", err->first);
976 : : }
977 : 533238 : }
978 : : }
979 : :
980 : : // We want to detect conflicts in any tx in a package to trigger package RBF logic
981 : 586523 : m_subpackage.m_rbf |= !ws.m_conflicts.empty();
982 : 586523 : return true;
983 : 1625261 : }
984 : :
985 : 242329 : bool MemPoolAccept::ReplacementChecks(Workspace& ws)
986 : : {
987 : 242329 : AssertLockHeld(cs_main);
988 : 242329 : AssertLockHeld(m_pool.cs);
989 : :
990 : 242329 : const CTransaction& tx = *ws.m_ptx;
991 : 242329 : const Txid& hash = ws.m_hash;
992 : 242329 : TxValidationState& state = ws.m_state;
993 : :
994 : 242329 : CFeeRate newFeeRate(ws.m_modified_fees, ws.m_vsize);
995 : :
996 [ + - ]: 242329 : CTxMemPool::setEntries all_conflicts;
997 : :
998 : : // Calculate all conflicting entries and enforce Rule #5.
999 [ + - - + ]: 242329 : if (const auto err_string{GetEntriesForConflicts(tx, m_pool, ws.m_iters_conflicting, all_conflicts)}) {
1000 [ # # # # ]: 0 : return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY,
1001 [ # # # # ]: 0 : strprintf("too many potential replacements%s", ws.m_sibling_eviction ? " (including sibling eviction)" : ""), *err_string);
1002 : 0 : }
1003 : :
1004 : : // Check if it's economically rational to mine this transaction rather than the ones it
1005 : : // replaces and pays for its own relay fees. Enforce Rules #3 and #4.
1006 [ + + ]: 876122 : for (CTxMemPool::txiter it : all_conflicts) {
1007 [ + - ]: 633793 : m_subpackage.m_conflicting_fees += it->GetModifiedFee();
1008 [ + - ]: 633793 : m_subpackage.m_conflicting_size += it->GetTxSize();
1009 : : }
1010 : :
1011 : 484658 : if (const auto err_string{PaysForRBF(m_subpackage.m_conflicting_fees, ws.m_modified_fees, ws.m_vsize,
1012 [ + - + + ]: 242329 : m_pool.m_opts.incremental_relay_feerate, hash)}) {
1013 : : // Result may change in a package context
1014 [ + + + - ]: 392354 : return state.Invalid(TxValidationResult::TX_RECONSIDERABLE,
1015 [ + + + - ]: 588290 : strprintf("insufficient fee%s", ws.m_sibling_eviction ? " (including sibling eviction)" : ""), *err_string);
1016 : 196177 : }
1017 : :
1018 : : // Add all the to-be-removed transactions to the changeset.
1019 [ + + ]: 140791 : for (auto it : all_conflicts) {
1020 [ + - ]: 94639 : m_subpackage.m_changeset->StageRemoval(it);
1021 : : }
1022 : :
1023 : : // Run cluster size limit checks and fail if we exceed them.
1024 [ + - + + ]: 46152 : if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1025 [ + - + - : 1129 : return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "too-large-cluster", "");
+ - ]
1026 : : }
1027 : :
1028 [ + - + + ]: 45023 : if (const auto err_string{ImprovesFeerateDiagram(*m_subpackage.m_changeset)}) {
1029 : : // We checked above for the cluster size limits being respected, so a
1030 : : // failure here can only be due to an insufficient fee.
1031 [ - + ]: 16356 : Assume(err_string->first == DiagramCheckError::FAILURE);
1032 [ + - + - ]: 16356 : return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "replacement-failed", err_string->second);
1033 : 16356 : }
1034 : :
1035 : 28667 : return true;
1036 : 242329 : }
1037 : :
1038 : 69985 : bool MemPoolAccept::PackageMempoolChecks(const std::vector<CTransactionRef>& txns,
1039 : : std::vector<Workspace>& workspaces,
1040 : : const int64_t total_vsize,
1041 : : PackageValidationState& package_state)
1042 : : {
1043 : 69985 : AssertLockHeld(cs_main);
1044 : 69985 : AssertLockHeld(m_pool.cs);
1045 : :
1046 [ - + ]: 190109 : assert(std::all_of(txns.cbegin(), txns.cend(), [this](const auto& tx)
1047 : : { return !m_pool.exists(tx->GetHash());}));
1048 : :
1049 [ - + - + : 69985 : assert(txns.size() == workspaces.size());
- + ]
1050 : :
1051 : : // No conflicts means we're finished. Further checks are all RBF-only.
1052 [ + + ]: 69985 : if (!m_subpackage.m_rbf) return true;
1053 : :
1054 : : // We're in package RBF context; replacement proposal must be size 2
1055 [ + + + - ]: 40232 : if (workspaces.size() != 2 || !Assume(IsChildWithParents(txns))) {
1056 [ + - + - ]: 7686 : return package_state.Invalid(PackageValidationResult::PCKG_POLICY, "package RBF failed: package must be 1-parent-1-child");
1057 : : }
1058 : :
1059 : : // If the package has in-mempool parents, we won't consider a package RBF
1060 : : // since it would result in a cluster larger than 2.
1061 : : // N.B. To relax this constraint we will need to revisit how CCoinsViewMemPool::PackageAddTransaction
1062 : : // is being used inside AcceptMultipleTransactions to track available inputs while processing a package.
1063 : : // Specifically we would need to check that the ancestors of the new
1064 : : // transactions don't intersect with the set of transactions to be removed
1065 : : // due to RBF, which is not checked at all in the package acceptance
1066 : : // context.
1067 [ + + ]: 54945 : for (const auto& ws : workspaces) {
1068 [ + + ]: 45271 : if (!ws.m_parents.empty()) {
1069 [ + - + - ]: 22872 : return package_state.Invalid(PackageValidationResult::PCKG_POLICY, "package RBF failed: new transaction cannot have mempool ancestors");
1070 : : }
1071 : : }
1072 : :
1073 : : // Aggregate all conflicts into one set.
1074 : 9674 : CTxMemPool::setEntries direct_conflict_iters;
1075 [ + + ]: 29022 : for (Workspace& ws : workspaces) {
1076 : : // Aggregate all conflicts into one set.
1077 : 19348 : direct_conflict_iters.merge(ws.m_iters_conflicting);
1078 : : }
1079 : :
1080 [ + - ]: 9674 : const auto& parent_ws = workspaces[0];
1081 : 9674 : const auto& child_ws = workspaces[1];
1082 : :
1083 : : // Don't consider replacements that would cause us to remove a large number of mempool entries.
1084 : : // This limit is not increased in a package RBF. Use the aggregate number of transactions.
1085 [ + - ]: 9674 : CTxMemPool::setEntries all_conflicts;
1086 : 19348 : if (const auto err_string{GetEntriesForConflicts(*child_ws.m_ptx, m_pool, direct_conflict_iters,
1087 [ + - - + ]: 9674 : all_conflicts)}) {
1088 [ # # # # ]: 0 : return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1089 [ # # ]: 0 : "package RBF failed: too many potential replacements", *err_string);
1090 : 0 : }
1091 : :
1092 [ + + ]: 30048 : for (CTxMemPool::txiter it : all_conflicts) {
1093 [ + - ]: 20374 : m_subpackage.m_changeset->StageRemoval(it);
1094 [ + - ]: 20374 : m_subpackage.m_conflicting_fees += it->GetModifiedFee();
1095 [ + - ]: 20374 : m_subpackage.m_conflicting_size += it->GetTxSize();
1096 : : }
1097 : :
1098 : : // Use the child as the transaction for attributing errors to.
1099 [ + - ]: 9674 : const Txid& child_hash = child_ws.m_ptx->GetHash();
1100 : 19348 : if (const auto err_string{PaysForRBF(/*original_fees=*/m_subpackage.m_conflicting_fees,
1101 : : /*replacement_fees=*/m_subpackage.m_total_modified_fees,
1102 : 9674 : /*replacement_vsize=*/m_subpackage.m_total_vsize,
1103 [ + - + + ]: 9674 : m_pool.m_opts.incremental_relay_feerate, child_hash)}) {
1104 [ + - + - ]: 7091 : return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1105 [ + - ]: 14182 : "package RBF failed: insufficient anti-DoS fees", *err_string);
1106 : 7091 : }
1107 : :
1108 : : // Ensure this two transaction package is a "chunk" on its own; we don't want the child
1109 : : // to be only paying anti-DoS fees
1110 [ + - ]: 2583 : const CFeeRate parent_feerate(parent_ws.m_modified_fees, parent_ws.m_vsize);
1111 [ + - ]: 2583 : const CFeeRate package_feerate(m_subpackage.m_total_modified_fees, m_subpackage.m_total_vsize);
1112 [ + + ]: 2583 : if (package_feerate <= parent_feerate) {
1113 [ + - + - ]: 892 : return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1114 [ + - ]: 892 : "package RBF failed: package feerate is less than or equal to parent feerate",
1115 [ + - + - : 892 : strprintf("package feerate %s <= parent feerate is %s", package_feerate.ToString(), parent_feerate.ToString()));
+ - ]
1116 : : }
1117 : :
1118 : : // Run cluster size limit checks and fail if we exceed them.
1119 [ + - - + ]: 2137 : if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1120 [ # # # # : 0 : return package_state.Invalid(PackageValidationResult::PCKG_POLICY, "too-large-cluster", "");
# # ]
1121 : : }
1122 : :
1123 : : // Check if it's economically rational to mine this package rather than the ones it replaces.
1124 [ + - + + ]: 2137 : if (const auto err_tup{ImprovesFeerateDiagram(*m_subpackage.m_changeset)}) {
1125 [ - + ]: 1420 : Assume(err_tup->first == DiagramCheckError::FAILURE);
1126 [ + - ]: 1420 : return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1127 [ + - + - ]: 4260 : "package RBF failed: " + err_tup.value().second, "");
1128 : 1420 : }
1129 : :
1130 [ + - - + : 717 : LogDebug(BCLog::TXPACKAGES, "package RBF checks passed: parent %s (wtxid=%s), child %s (wtxid=%s), package hash (%s)\n",
- - - - -
- - - - -
- - - - ]
1131 : : txns.front()->GetHash().ToString(), txns.front()->GetWitnessHash().ToString(),
1132 : : txns.back()->GetHash().ToString(), txns.back()->GetWitnessHash().ToString(),
1133 : : GetPackageHash(txns).ToString());
1134 : :
1135 : :
1136 : : return true;
1137 : 9674 : }
1138 : :
1139 : 229837 : bool MemPoolAccept::PolicyScriptChecks(const ATMPArgs& args, Workspace& ws)
1140 : : {
1141 : 229837 : AssertLockHeld(cs_main);
1142 : 229837 : AssertLockHeld(m_pool.cs);
1143 : 229837 : const CTransaction& tx = *ws.m_ptx;
1144 : 229837 : TxValidationState& state = ws.m_state;
1145 : :
1146 : 229837 : constexpr script_verify_flags scriptVerifyFlags = STANDARD_SCRIPT_VERIFY_FLAGS;
1147 : :
1148 : : // Check input scripts and signatures.
1149 : : // This is done last to help prevent CPU exhaustion denial-of-service attacks.
1150 [ + + ]: 229837 : if (!CheckInputScripts(tx, state, m_view, scriptVerifyFlags, true, false, ws.m_precomputed_txdata, GetValidationCache())) {
1151 : : // Detect a failure due to a missing witness so that p2p code can handle rejection caching appropriately.
1152 [ + + + + ]: 14579 : if (!tx.HasWitness() && SpendsNonAnchorWitnessProg(tx, m_view)) {
1153 : 12190 : state.Invalid(TxValidationResult::TX_WITNESS_STRIPPED,
1154 [ - + - + : 24380 : state.GetRejectReason(), state.GetDebugMessage());
+ - ]
1155 : : }
1156 : 14579 : return false; // state filled in by CheckInputScripts
1157 : : }
1158 : :
1159 : : return true;
1160 : : }
1161 : :
1162 : 188125 : bool MemPoolAccept::ConsensusScriptChecks(const ATMPArgs& args, Workspace& ws)
1163 : : {
1164 : 188125 : AssertLockHeld(cs_main);
1165 : 188125 : AssertLockHeld(m_pool.cs);
1166 [ - + ]: 188125 : const CTransaction& tx = *ws.m_ptx;
1167 : 188125 : const Txid& hash = ws.m_hash;
1168 : 188125 : TxValidationState& state = ws.m_state;
1169 : :
1170 : : // Check again against the current block tip's script verification
1171 : : // flags to cache our script execution flags. This is, of course,
1172 : : // useless if the next block has different script flags from the
1173 : : // previous one, but because the cache tracks script flags for us it
1174 : : // will auto-invalidate and we'll just have a few blocks of extra
1175 : : // misses on soft-fork activation.
1176 : : //
1177 : : // This is also useful in case of bugs in the standard flags that cause
1178 : : // transactions to pass as valid when they're actually invalid. For
1179 : : // instance the STRICTENC flag was incorrectly allowing certain
1180 : : // CHECKSIG NOT scripts to pass, even though they were invalid.
1181 : : //
1182 : : // There is a similar check in CreateNewBlock() to prevent creating
1183 : : // invalid blocks (using TestBlockValidity), however allowing such
1184 : : // transactions into the mempool can be exploited as a DoS attack.
1185 [ - + ]: 376250 : script_verify_flags currentBlockScriptVerifyFlags{GetBlockScriptFlags(*m_active_chainstate.m_chain.Tip(), m_active_chainstate.m_chainman)};
1186 [ - + ]: 376250 : if (!CheckInputsFromMempoolAndCache(tx, state, m_view, m_pool, currentBlockScriptVerifyFlags,
1187 : 188125 : ws.m_precomputed_txdata, m_active_chainstate.CoinsTip(), GetValidationCache())) {
1188 [ # # # # ]: 0 : LogError("BUG! PLEASE REPORT THIS! CheckInputScripts failed against latest-block but not STANDARD flags %s, %s", hash.ToString(), state.ToString());
1189 : 0 : return Assume(false);
1190 : : }
1191 : :
1192 : : return true;
1193 : : }
1194 : :
1195 : 183124 : void MemPoolAccept::FinalizeSubpackage(const ATMPArgs& args)
1196 : : {
1197 : 183124 : AssertLockHeld(cs_main);
1198 : 183124 : AssertLockHeld(m_pool.cs);
1199 : :
1200 [ + + - + ]: 183124 : if (!m_subpackage.m_changeset->GetRemovals().empty()) Assume(args.m_allow_replacement);
1201 : : // Remove conflicting transactions from the mempool
1202 [ + + ]: 213675 : for (CTxMemPool::txiter it : m_subpackage.m_changeset->GetRemovals())
1203 : : {
1204 : 30551 : std::string log_string = strprintf("replacing mempool tx %s (wtxid=%s, fees=%s, vsize=%s). ",
1205 [ + - ]: 61102 : it->GetTx().GetHash().ToString(),
1206 [ + - ]: 30551 : it->GetTx().GetWitnessHash().ToString(),
1207 : 30551 : it->GetFee(),
1208 [ + - ]: 61102 : it->GetTxSize());
1209 [ - + ]: 30551 : FeeFrac feerate{m_subpackage.m_total_modified_fees, int32_t(m_subpackage.m_total_vsize)};
1210 : 30551 : uint256 tx_or_package_hash{};
1211 [ - + ]: 30551 : const bool replaced_with_tx{m_subpackage.m_changeset->GetTxCount() == 1};
1212 [ + + ]: 30551 : if (replaced_with_tx) {
1213 [ + - ]: 29036 : const CTransaction& tx = m_subpackage.m_changeset->GetAddedTxn(0);
1214 : 29036 : tx_or_package_hash = tx.GetHash().ToUint256();
1215 : 29036 : log_string += strprintf("New tx %s (wtxid=%s, fees=%s, vsize=%s)",
1216 [ + - ]: 58072 : tx.GetHash().ToString(),
1217 [ + - + - ]: 58072 : tx.GetWitnessHash().ToString(),
1218 : : feerate.fee,
1219 : 29036 : feerate.size);
1220 : : } else {
1221 [ + - + - ]: 1515 : tx_or_package_hash = GetPackageHash(m_subpackage.m_changeset->GetAddedTxns());
1222 [ + - ]: 3030 : log_string += strprintf("New package %s with %lu txs, fees=%s, vsize=%s",
1223 : 1515 : tx_or_package_hash.ToString(),
1224 [ - + + - ]: 1515 : m_subpackage.m_changeset->GetTxCount(),
1225 : : feerate.fee,
1226 : 1515 : feerate.size);
1227 : :
1228 : : }
1229 [ + - - + : 30551 : LogDebug(BCLog::MEMPOOL, "%s\n", log_string);
- - ]
1230 : : TRACEPOINT(mempool, replaced,
1231 : : it->GetTx().GetHash().data(),
1232 : : it->GetTxSize(),
1233 : : it->GetFee(),
1234 : : std::chrono::duration_cast<std::chrono::duration<std::uint64_t>>(it->GetTime()).count(),
1235 : : tx_or_package_hash.data(),
1236 : : feerate.size,
1237 : : feerate.fee,
1238 : : replaced_with_tx
1239 : 30551 : );
1240 [ + - + - ]: 91653 : m_subpackage.m_replaced_transactions.push_back(it->GetSharedTx());
1241 : 30551 : }
1242 : 183124 : m_subpackage.m_changeset->Apply();
1243 [ + - ]: 183124 : m_subpackage.m_changeset.reset();
1244 : 183124 : }
1245 : :
1246 : 1029 : bool MemPoolAccept::SubmitPackage(const ATMPArgs& args, std::vector<Workspace>& workspaces,
1247 : : PackageValidationState& package_state,
1248 : : std::map<Wtxid, MempoolAcceptResult>& results)
1249 : : {
1250 : 1029 : AssertLockHeld(cs_main);
1251 : 1029 : AssertLockHeld(m_pool.cs);
1252 : : // Sanity check: none of the transactions should be in the mempool, and none of the transactions
1253 : : // should have a same-txid-different-witness equivalent in the mempool.
1254 [ - + ]: 3409 : assert(std::all_of(workspaces.cbegin(), workspaces.cend(), [this](const auto& ws) { return !m_pool.exists(ws.m_ptx->GetHash()); }));
1255 : :
1256 : 1029 : bool all_submitted = true;
1257 : 1029 : FinalizeSubpackage(args);
1258 : : // ConsensusScriptChecks adds to the script cache and is therefore consensus-critical;
1259 : : // CheckInputsFromMempoolAndCache asserts that transactions only spend coins available from the
1260 : : // mempool or UTXO set. Submit each transaction to the mempool immediately after calling
1261 : : // ConsensusScriptChecks to make the outputs available for subsequent transactions.
1262 [ + + ]: 3409 : for (Workspace& ws : workspaces) {
1263 [ - + ]: 2380 : if (!ConsensusScriptChecks(args, ws)) {
1264 [ # # # # ]: 0 : results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
1265 : : // Since PolicyScriptChecks() passed, this should never fail.
1266 : 0 : Assume(false);
1267 : 0 : all_submitted = false;
1268 [ # # ]: 0 : package_state.Invalid(PackageValidationResult::PCKG_MEMPOOL_ERROR,
1269 : 0 : strprintf("BUG! PolicyScriptChecks succeeded but ConsensusScriptChecks failed: %s",
1270 [ # # # # ]: 0 : ws.m_ptx->GetHash().ToString()));
1271 : : // Remove the transaction from the mempool.
1272 [ # # ]: 0 : if (!m_subpackage.m_changeset) m_subpackage.m_changeset = m_pool.GetChangeSet();
1273 [ # # ]: 0 : m_subpackage.m_changeset->StageRemoval(m_pool.GetIter(ws.m_ptx->GetHash()).value());
1274 : : }
1275 : : }
1276 [ - + ]: 1029 : if (!all_submitted) {
1277 [ # # ]: 0 : Assume(m_subpackage.m_changeset);
1278 : : // This code should be unreachable; it's here as belt-and-suspenders
1279 : : // to try to ensure we have no consensus-invalid transactions in the
1280 : : // mempool.
1281 : 0 : m_subpackage.m_changeset->Apply();
1282 [ # # ]: 0 : m_subpackage.m_changeset.reset();
1283 : 0 : return false;
1284 : : }
1285 : :
1286 : 1029 : std::vector<Wtxid> all_package_wtxids;
1287 [ - + + - ]: 1029 : all_package_wtxids.reserve(workspaces.size());
1288 [ + - ]: 1029 : std::transform(workspaces.cbegin(), workspaces.cend(), std::back_inserter(all_package_wtxids),
1289 : 2380 : [](const auto& ws) { return ws.m_ptx->GetWitnessHash(); });
1290 : :
1291 [ + + ]: 1029 : if (!m_subpackage.m_replaced_transactions.empty()) {
1292 [ + - - + : 716 : LogDebug(BCLog::MEMPOOL, "replaced %u mempool transactions with %u new one(s) for %s additional fees, %d delta bytes\n",
- - - - ]
1293 : : m_subpackage.m_replaced_transactions.size(), workspaces.size(),
1294 : : m_subpackage.m_total_modified_fees - m_subpackage.m_conflicting_fees,
1295 : : m_subpackage.m_total_vsize - static_cast<int>(m_subpackage.m_conflicting_size));
1296 : : }
1297 : :
1298 : : // Add successful results. The returned results may change later if LimitMempoolSize() evicts them.
1299 [ + + ]: 3409 : for (Workspace& ws : workspaces) {
1300 [ + - ]: 2380 : auto iter = m_pool.GetIter(ws.m_ptx->GetHash());
1301 [ - + ]: 2380 : Assume(iter.has_value());
1302 [ + - ]: 2380 : const auto effective_feerate = args.m_package_feerates ? ws.m_package_feerate :
1303 [ - - ]: 2380 : CFeeRate{ws.m_modified_fees, static_cast<int32_t>(ws.m_vsize)};
1304 [ + - ]: 2380 : const auto effective_feerate_wtxids = args.m_package_feerates ? all_package_wtxids :
1305 [ + - - - ]: 2380 : std::vector<Wtxid>{ws.m_ptx->GetWitnessHash()};
1306 : 4760 : results.emplace(ws.m_ptx->GetWitnessHash(),
1307 [ + - + - ]: 2380 : MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions), ws.m_vsize,
1308 : : ws.m_base_fees, effective_feerate, effective_feerate_wtxids));
1309 [ - + ]: 2380 : if (!m_pool.m_opts.signals) continue;
1310 [ + - ]: 2380 : const CTransaction& tx = *ws.m_ptx;
1311 [ + - ]: 2380 : const auto tx_info = NewMempoolTransactionInfo(ws.m_ptx, ws.m_base_fees,
1312 [ + - ]: 2380 : ws.m_vsize, (*iter)->GetHeight(),
1313 : 2380 : args.m_bypass_limits, args.m_package_submission,
1314 [ + - ]: 2380 : IsCurrentForFeeEstimation(m_active_chainstate),
1315 [ + - + - ]: 4760 : m_pool.HasNoInputsOf(tx));
1316 [ + - ]: 2380 : m_pool.m_opts.signals->TransactionAddedToMempool(tx_info, m_pool.GetAndIncrementSequence());
1317 : 2380 : }
1318 : 1029 : return all_submitted;
1319 : 1029 : }
1320 : :
1321 : 1792627 : MempoolAcceptResult MemPoolAccept::AcceptSingleTransactionInternal(const CTransactionRef& ptx, ATMPArgs& args)
1322 : : {
1323 : 1792627 : AssertLockHeld(cs_main);
1324 : 1792627 : AssertLockHeld(m_pool.cs);
1325 : :
1326 : 1792627 : Workspace ws(ptx);
1327 [ + - ]: 1792627 : const std::vector<Wtxid> single_wtxid{ws.m_ptx->GetWitnessHash()};
1328 : :
1329 [ + - + + ]: 1792627 : if (!PreChecks(args, ws)) {
1330 [ + + ]: 1362769 : if (ws.m_state.GetResult() == TxValidationResult::TX_RECONSIDERABLE) {
1331 : : // Failed for fee reasons. Provide the effective feerate and which tx was included.
1332 [ + - + - ]: 186363 : return MempoolAcceptResult::FeeFailure(ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), single_wtxid);
1333 : : }
1334 [ + - + - ]: 2601296 : return MempoolAcceptResult::Failure(ws.m_state);
1335 : : }
1336 : :
1337 [ + + + - : 429858 : if (m_subpackage.m_rbf && !ReplacementChecks(ws)) {
+ + ]
1338 [ + + ]: 213662 : if (ws.m_state.GetResult() == TxValidationResult::TX_RECONSIDERABLE) {
1339 : : // Failed for incentives-based fee reasons. Provide the effective feerate and which tx was included.
1340 [ + - + - ]: 637599 : return MempoolAcceptResult::FeeFailure(ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), single_wtxid);
1341 : : }
1342 [ + - + - ]: 2258 : return MempoolAcceptResult::Failure(ws.m_state);
1343 : : }
1344 : :
1345 : : // Check if the transaction would exceed the cluster size limit.
1346 [ + - + + ]: 216196 : if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1347 [ + - + - : 15716 : ws.m_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "too-large-cluster", "");
+ - ]
1348 [ + - + - ]: 15716 : return MempoolAcceptResult::Failure(ws.m_state);
1349 : : }
1350 : :
1351 : : // Now that we've verified the cluster limit is respected, we can perform
1352 : : // calculations involving the full ancestors of the tx.
1353 [ + + ]: 208338 : if (ws.m_conflicts.size()) {
1354 [ + - ]: 28667 : auto ancestors = m_subpackage.m_changeset->CalculateMemPoolAncestors(ws.m_tx_handle);
1355 : :
1356 : : // A transaction that spends outputs that would be replaced by it is invalid. Now
1357 : : // that we have the set of all ancestors we can detect this
1358 : : // pathological case by making sure ws.m_conflicts and this tx's ancestors don't
1359 : : // intersect.
1360 [ + - + + ]: 28667 : if (const auto err_string{EntriesAndTxidsDisjoint(ancestors, ws.m_conflicts, ptx->GetHash())}) {
1361 : : // We classify this as a consensus error because a transaction depending on something it
1362 : : // conflicts with would be inconsistent.
1363 [ + - + - ]: 2986 : ws.m_state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-txns-spends-conflicting-tx", *err_string);
1364 [ + - + - ]: 5972 : return MempoolAcceptResult::Failure(ws.m_state);
1365 : 28667 : }
1366 : 28667 : }
1367 : :
1368 : 205352 : m_subpackage.m_total_vsize = ws.m_vsize;
1369 : 205352 : m_subpackage.m_total_modified_fees = ws.m_modified_fees;
1370 : :
1371 : : // Individual modified feerate exceeded caller-defined max; abort
1372 [ + + + - : 205352 : if (args.m_client_maxfeerate && CFeeRate(ws.m_modified_fees, ws.m_vsize) > args.m_client_maxfeerate.value()) {
+ + ]
1373 [ + - + - : 2432 : ws.m_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "max feerate exceeded", "");
+ - ]
1374 [ + - + - ]: 2432 : return MempoolAcceptResult::Failure(ws.m_state);
1375 : : }
1376 : :
1377 [ + + ]: 204136 : if (m_pool.m_opts.require_standard) {
1378 [ + - ]: 158628 : Wtxid dummy_wtxid;
1379 [ + - + + : 317256 : if (!CheckEphemeralSpends(/*package=*/{ptx}, m_pool.m_opts.dust_relay_feerate, m_pool, ws.m_state, dummy_wtxid)) {
+ - + + -
- - - ]
1380 [ + - + - ]: 7710 : return MempoolAcceptResult::Failure(ws.m_state);
1381 : : }
1382 : : }
1383 : :
1384 : : // Perform the inexpensive checks first and avoid hashing and signature verification unless
1385 : : // those checks pass, to mitigate CPU exhaustion denial-of-service attacks.
1386 [ + - + + : 214817 : if (!PolicyScriptChecks(args, ws)) return MempoolAcceptResult::Failure(ws.m_state);
+ - + - ]
1387 : :
1388 [ + - - + : 185745 : if (!ConsensusScriptChecks(args, ws)) return MempoolAcceptResult::Failure(ws.m_state);
- - - - ]
1389 : :
1390 [ + - ]: 185745 : const CFeeRate effective_feerate{ws.m_modified_fees, static_cast<int32_t>(ws.m_vsize)};
1391 : : // Tx was accepted, but not added
1392 [ + + ]: 185745 : if (args.m_test_accept) {
1393 : 3650 : return MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions), ws.m_vsize,
1394 [ + - ]: 3650 : ws.m_base_fees, effective_feerate, single_wtxid);
1395 : : }
1396 : :
1397 [ + - ]: 182095 : FinalizeSubpackage(args);
1398 : :
1399 : : // Limit the mempool, if appropriate.
1400 [ + + + + ]: 182095 : if (!args.m_package_submission && !args.m_bypass_limits) {
1401 [ + - + - ]: 44377 : LimitMempoolSize(m_pool, m_active_chainstate.CoinsTip());
1402 : : // If mempool contents change, then the m_view cache is dirty. Given this isn't a package
1403 : : // submission, we won't be using the cache anymore, but clear it anyway for clarity.
1404 [ + - ]: 44377 : CleanupTemporaryCoins();
1405 : :
1406 [ + - + + ]: 44377 : if (!m_pool.exists(ws.m_hash)) {
1407 : : // The tx no longer meets our (new) mempool minimum feerate but could be reconsidered in a package.
1408 [ + - + - : 2326 : ws.m_state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "mempool full");
+ - ]
1409 [ + - + - : 3489 : return MempoolAcceptResult::FeeFailure(ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), {ws.m_ptx->GetWitnessHash()});
+ - ]
1410 : : }
1411 : : }
1412 : :
1413 [ + - ]: 180932 : if (m_pool.m_opts.signals) {
1414 [ + - ]: 180932 : const CTransaction& tx = *ws.m_ptx;
1415 [ + - ]: 180932 : auto iter = m_pool.GetIter(tx.GetHash());
1416 [ - + ]: 180932 : Assume(iter.has_value());
1417 : 180932 : const auto tx_info = NewMempoolTransactionInfo(ws.m_ptx, ws.m_base_fees,
1418 [ + - ]: 180932 : ws.m_vsize, (*iter)->GetHeight(),
1419 : 180932 : args.m_bypass_limits, args.m_package_submission,
1420 [ + - ]: 180932 : IsCurrentForFeeEstimation(m_active_chainstate),
1421 [ + - + - ]: 361864 : m_pool.HasNoInputsOf(tx));
1422 [ + - ]: 180932 : m_pool.m_opts.signals->TransactionAddedToMempool(tx_info, m_pool.GetAndIncrementSequence());
1423 : 180932 : }
1424 : :
1425 [ + + ]: 180932 : if (!m_subpackage.m_replaced_transactions.empty()) {
1426 [ + - - + : 20369 : LogDebug(BCLog::MEMPOOL, "replaced %u mempool transactions with 1 new transaction for %s additional fees, %d delta bytes\n",
- - ]
1427 : : m_subpackage.m_replaced_transactions.size(),
1428 : : ws.m_modified_fees - m_subpackage.m_conflicting_fees,
1429 : : ws.m_vsize - static_cast<int>(m_subpackage.m_conflicting_size));
1430 : : }
1431 : :
1432 : 180932 : return MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions), ws.m_vsize, ws.m_base_fees,
1433 [ + - ]: 1792627 : effective_feerate, single_wtxid);
1434 [ + - + - ]: 2109883 : }
1435 : :
1436 : 237681 : PackageMempoolAcceptResult MemPoolAccept::AcceptMultipleTransactionsInternal(const std::vector<CTransactionRef>& txns, ATMPArgs& args)
1437 : : {
1438 : 237681 : AssertLockHeld(cs_main);
1439 : 237681 : AssertLockHeld(m_pool.cs);
1440 : :
1441 : : // These context-free package limits can be done before taking the mempool lock.
1442 [ + - ]: 237681 : PackageValidationState package_state;
1443 [ + - + + : 237929 : if (!IsWellFormedPackage(txns, package_state)) return PackageMempoolAcceptResult(package_state, {});
+ - + - ]
1444 : :
1445 : 237557 : std::vector<Workspace> workspaces{};
1446 [ - + + - ]: 237557 : workspaces.reserve(txns.size());
1447 [ + - ]: 237557 : std::transform(txns.cbegin(), txns.cend(), std::back_inserter(workspaces),
1448 : 330132 : [](const auto& tx) { return Workspace(tx); });
1449 : 237557 : std::map<Wtxid, MempoolAcceptResult> results;
1450 : :
1451 : : // Do all PreChecks first and fail fast to avoid running expensive script checks when unnecessary.
1452 [ + + ]: 393971 : for (Workspace& ws : workspaces) {
1453 [ + - + + ]: 321910 : if (!PreChecks(args, ws)) {
1454 [ + - + - : 330490 : package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
+ - ]
1455 : : // Exit early to avoid doing pointless work. Update the failed tx result; the rest are unfinished.
1456 [ + - + - : 165245 : results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
+ - ]
1457 [ + - + - ]: 495735 : return PackageMempoolAcceptResult(package_state, std::move(results));
1458 : : }
1459 : :
1460 : : // Individual modified feerate exceeded caller-defined max; abort
1461 : : // N.B. this doesn't take into account CPFPs. Chunk-aware validation may be more robust.
1462 [ + + + - : 156665 : if (args.m_client_maxfeerate && CFeeRate(ws.m_modified_fees, ws.m_vsize) > args.m_client_maxfeerate.value()) {
+ + ]
1463 : : // Need to set failure here both individually and at package level
1464 [ + - + - : 502 : ws.m_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "max feerate exceeded", "");
+ - ]
1465 [ + - + - : 502 : package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
+ - ]
1466 : : // Exit early to avoid doing pointless work. Update the failed tx result; the rest are unfinished.
1467 [ + - + - : 251 : results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
+ - ]
1468 [ + - + - ]: 753 : return PackageMempoolAcceptResult(package_state, std::move(results));
1469 : : }
1470 : :
1471 : : // Make the coins created by this transaction available for subsequent transactions in the
1472 : : // package to spend. If there are no conflicts within the package, no transaction can spend a coin
1473 : : // needed by another transaction in the package. We also need to make sure that no package
1474 : : // tx replaces (or replaces the ancestor of) the parent of another package tx. As long as we
1475 : : // check these two things, we don't need to track the coins spent.
1476 : : // If a package tx conflicts with a mempool tx, PackageMempoolChecks() ensures later that any package RBF attempt
1477 : : // has *no* in-mempool ancestors, so we don't have to worry about subsequent transactions in
1478 : : // same package spending the same in-mempool outpoints. This needs to be revisited for general
1479 : : // package RBF.
1480 [ + - ]: 156414 : m_viewmempool.PackageAddTransaction(ws.m_ptx);
1481 : : }
1482 : :
1483 : : // At this point we have all in-mempool parents, and we know every transaction's vsize.
1484 : : // Run the TRUC checks on the package.
1485 [ + + ]: 196259 : for (Workspace& ws : workspaces) {
1486 [ + - + + ]: 124513 : if (auto err{PackageTRUCChecks(m_pool, ws.m_ptx, ws.m_vsize, txns, ws.m_parents)}) {
1487 [ + - + - ]: 315 : package_state.Invalid(PackageValidationResult::PCKG_POLICY, "TRUC-violation", err.value());
1488 [ + - + - ]: 945 : return PackageMempoolAcceptResult(package_state, {});
1489 : 124513 : }
1490 : : }
1491 : :
1492 : : // Transactions must meet two minimum feerates: the mempool minimum fee and min relay fee.
1493 : : // For transactions consisting of exactly one child and its parents, it suffices to use the
1494 : : // package feerate (total modified fees / total virtual size) to check this requirement.
1495 : : // Note that this is an aggregate feerate; this function has not checked that there are transactions
1496 : : // too low feerate to pay for themselves, or that the child transactions are higher feerate than
1497 : : // their parents. Using aggregate feerate may allow "parents pay for child" behavior and permit
1498 : : // a child that is below mempool minimum feerate. To avoid these behaviors, callers of
1499 : : // AcceptMultipleTransactions need to restrict txns topology (e.g. to ancestor sets) and check
1500 : : // the feerates of individuals and subsets.
1501 : 71746 : m_subpackage.m_total_vsize = std::accumulate(workspaces.cbegin(), workspaces.cend(), int64_t{0},
1502 : 123898 : [](int64_t sum, auto& ws) { return sum + ws.m_vsize; });
1503 : 71746 : m_subpackage.m_total_modified_fees = std::accumulate(workspaces.cbegin(), workspaces.cend(), CAmount{0},
1504 : 123898 : [](CAmount sum, auto& ws) { return sum + ws.m_modified_fees; });
1505 [ + - ]: 71746 : const CFeeRate package_feerate(m_subpackage.m_total_modified_fees, m_subpackage.m_total_vsize);
1506 : 71746 : std::vector<Wtxid> all_package_wtxids;
1507 [ - + + - ]: 71746 : all_package_wtxids.reserve(workspaces.size());
1508 [ + - ]: 71746 : std::transform(workspaces.cbegin(), workspaces.cend(), std::back_inserter(all_package_wtxids),
1509 : 123898 : [](const auto& ws) { return ws.m_ptx->GetWitnessHash(); });
1510 [ + + ]: 71746 : TxValidationState placeholder_state;
1511 [ + + + + ]: 114052 : if (args.m_package_feerates &&
1512 [ + - ]: 42306 : !CheckFeeRate(m_subpackage.m_total_vsize, m_subpackage.m_total_modified_fees, placeholder_state)) {
1513 [ + - + - : 3522 : package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
+ - ]
1514 [ + - ]: 1761 : return PackageMempoolAcceptResult(package_state, {{workspaces.back().m_ptx->GetWitnessHash(),
1515 [ + - + - : 12327 : MempoolAcceptResult::FeeFailure(placeholder_state, CFeeRate(m_subpackage.m_total_modified_fees, m_subpackage.m_total_vsize), all_package_wtxids)}});
+ - + + -
- ]
1516 : : }
1517 : :
1518 : : // Apply package mempool RBF checks.
1519 [ + - + + ]: 69985 : if (!PackageMempoolChecks(txns, workspaces, m_subpackage.m_total_vsize, package_state)) {
1520 [ + - + - ]: 118545 : return PackageMempoolAcceptResult(package_state, std::move(results));
1521 : : }
1522 : :
1523 : : // Check if the transactions would exceed the cluster size limit.
1524 [ + - + + ]: 30470 : if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1525 [ + - + - : 1986 : package_state.Invalid(PackageValidationResult::PCKG_POLICY, "too-large-cluster", "");
+ - ]
1526 [ + - + - ]: 2979 : return PackageMempoolAcceptResult(package_state, std::move(results));
1527 : : }
1528 : :
1529 : : // Now that we've bounded the resulting possible ancestry count, check package for dust spends
1530 [ + + ]: 29477 : if (m_pool.m_opts.require_standard) {
1531 [ + - ]: 27790 : TxValidationState child_state;
1532 [ + - ]: 27790 : Wtxid child_wtxid;
1533 [ + - + + ]: 27790 : if (!CheckEphemeralSpends(txns, m_pool.m_opts.dust_relay_feerate, m_pool, child_state, child_wtxid)) {
1534 [ + - + - : 2544 : package_state.Invalid(PackageValidationResult::PCKG_TX, "unspent-dust");
+ - ]
1535 [ + - + - : 1272 : results.emplace(child_wtxid, MempoolAcceptResult::Failure(child_state));
+ - ]
1536 [ + - + - ]: 3816 : return PackageMempoolAcceptResult(package_state, std::move(results));
1537 : : }
1538 : 27790 : }
1539 : :
1540 [ + + ]: 57718 : for (Workspace& ws : workspaces) {
1541 : 29556 : ws.m_package_feerate = package_feerate;
1542 [ + - + + ]: 29556 : if (!PolicyScriptChecks(args, ws)) {
1543 : : // Exit early to avoid doing pointless work. Update the failed tx result; the rest are unfinished.
1544 [ + - + - : 86 : package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
+ - ]
1545 [ + - + - : 43 : results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
+ - ]
1546 [ + - + - ]: 129 : return PackageMempoolAcceptResult(package_state, std::move(results));
1547 : : }
1548 [ + + ]: 29513 : if (args.m_test_accept) {
1549 [ - + ]: 27133 : const auto effective_feerate = args.m_package_feerates ? ws.m_package_feerate :
1550 [ + - ]: 27133 : CFeeRate{ws.m_modified_fees, static_cast<int32_t>(ws.m_vsize)};
1551 [ - + ]: 27133 : const auto effective_feerate_wtxids = args.m_package_feerates ? all_package_wtxids :
1552 [ - - + - ]: 27133 : std::vector<Wtxid>{ws.m_ptx->GetWitnessHash()};
1553 : 54266 : results.emplace(ws.m_ptx->GetWitnessHash(),
1554 [ + - + - ]: 27133 : MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions),
1555 : : ws.m_vsize, ws.m_base_fees, effective_feerate,
1556 : : effective_feerate_wtxids));
1557 : 27133 : }
1558 : : }
1559 : :
1560 [ + + + - : 82428 : if (args.m_test_accept) return PackageMempoolAcceptResult(package_state, std::move(results));
+ - ]
1561 : :
1562 [ + - - + ]: 1029 : if (!SubmitPackage(args, workspaces, package_state, results)) {
1563 : : // PackageValidationState filled in by SubmitPackage().
1564 [ # # # # ]: 0 : return PackageMempoolAcceptResult(package_state, std::move(results));
1565 : : }
1566 : :
1567 [ + - + - ]: 3087 : return PackageMempoolAcceptResult(package_state, std::move(results));
1568 [ + - ]: 548745 : }
1569 : :
1570 : 2363934 : void MemPoolAccept::CleanupTemporaryCoins()
1571 : : {
1572 : : // There are 3 kinds of coins in m_view:
1573 : : // (1) Temporary coins from the transactions in subpackage, constructed by m_viewmempool.
1574 : : // (2) Mempool coins from transactions in the mempool, constructed by m_viewmempool.
1575 : : // (3) Confirmed coins fetched from our current UTXO set.
1576 : : //
1577 : : // (1) Temporary coins need to be removed, regardless of whether the transaction was submitted.
1578 : : // If the transaction was submitted to the mempool, m_viewmempool will be able to fetch them from
1579 : : // there. If it wasn't submitted to mempool, it is incorrect to keep them - future calls may try
1580 : : // to spend those coins that don't actually exist.
1581 : : // (2) Mempool coins also need to be removed. If the mempool contents have changed as a result
1582 : : // of submitting or replacing transactions, coins previously fetched from mempool may now be
1583 : : // spent or nonexistent. Those coins need to be deleted from m_view.
1584 : : // (3) Confirmed coins don't need to be removed. The chainstate has not changed (we are
1585 : : // holding cs_main and no blocks have been processed) so the confirmed tx cannot disappear like
1586 : : // a mempool tx can. The coin may now be spent after we submitted a tx to mempool, but
1587 : : // we have already checked that the package does not have 2 transactions spending the same coin
1588 : : // and we check whether a mempool transaction spends conflicting coins (CTxMemPool::GetConflictTx).
1589 : : // Keeping them in m_view is an optimization to not re-fetch confirmed coins if we later look up
1590 : : // inputs for this transaction again.
1591 [ + + ]: 3759446 : for (const auto& outpoint : m_viewmempool.GetNonBaseCoins()) {
1592 : : // In addition to resetting m_viewmempool, we also need to manually delete these coins from
1593 : : // m_view because it caches copies of the coins it fetched from m_viewmempool previously.
1594 : 1395512 : m_view.Uncache(outpoint);
1595 : : }
1596 : : // This deletes the temporary and mempool coins.
1597 : 2363934 : m_viewmempool.Reset();
1598 : 2363934 : }
1599 : :
1600 : 691500 : PackageMempoolAcceptResult MemPoolAccept::AcceptSubPackage(const std::vector<CTransactionRef>& subpackage, ATMPArgs& args)
1601 : : {
1602 : 691500 : AssertLockHeld(::cs_main);
1603 : 691500 : AssertLockHeld(m_pool.cs);
1604 : 1383000 : auto result = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main, m_pool.cs) {
1605 [ - + + + ]: 691500 : if (subpackage.size() > 1) {
1606 : 73079 : return AcceptMultipleTransactionsInternal(subpackage, args);
1607 : : }
1608 : 618421 : const auto& tx = subpackage.front();
1609 : 618421 : ATMPArgs single_args = ATMPArgs::SingleInPackageAccept(args);
1610 : 618421 : const auto single_res = AcceptSingleTransactionInternal(tx, single_args);
1611 [ + + ]: 618421 : PackageValidationState package_state_wrapped;
1612 [ + + ]: 618421 : if (single_res.m_result_type != MempoolAcceptResult::ResultType::VALID) {
1613 [ + - + - : 1044322 : package_state_wrapped.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
+ - ]
1614 : : }
1615 [ + - + + : 2473684 : return PackageMempoolAcceptResult(package_state_wrapped, {{tx->GetWitnessHash(), single_res}});
- - ]
1616 [ + - + - ]: 2546763 : }();
1617 : :
1618 : : // Clean up m_view and m_viewmempool so that other subpackage evaluations don't have access to
1619 : : // coins they shouldn't. Keep some coins in order to minimize re-fetching coins from the UTXO set.
1620 : : // Clean up package feerate and rbf calculations
1621 [ + - ]: 691500 : ClearSubPackageState();
1622 : :
1623 : 691500 : return result;
1624 : 0 : }
1625 : :
1626 : 382011 : PackageMempoolAcceptResult MemPoolAccept::AcceptPackage(const Package& package, ATMPArgs& args)
1627 : : {
1628 [ - + ]: 382011 : Assert(!package.empty());
1629 : 382011 : AssertLockHeld(cs_main);
1630 : : // Used if returning a PackageMempoolAcceptResult directly from this function.
1631 [ + - ]: 382011 : PackageValidationState package_state_quit_early;
1632 : :
1633 : : // There are two topologies we are able to handle through this function:
1634 : : // (1) A single transaction
1635 : : // (2) A child-with-parents package.
1636 : : // Check that the package is well-formed. If it isn't, we won't try to validate any of the
1637 : : // transactions and thus won't return any MempoolAcceptResults, just a package-wide error.
1638 : :
1639 : : // Context-free package checks.
1640 [ + - + + ]: 382011 : if (!IsWellFormedPackage(package, package_state_quit_early)) {
1641 [ + - + - ]: 244356 : return PackageMempoolAcceptResult(package_state_quit_early, {});
1642 : : }
1643 : :
1644 [ - + + + : 300559 : if (package.size() > 1 && !IsChildWithParents(package)) {
+ - + + ]
1645 : : // All transactions in the package must be a parent of the last transaction. This is just an
1646 : : // opportunity for us to fail fast on a context-free check without taking the mempool lock.
1647 [ + - + - : 22620 : package_state_quit_early.Invalid(PackageValidationResult::PCKG_POLICY, "package-not-child-with-parents");
+ - ]
1648 [ + - + - ]: 33930 : return PackageMempoolAcceptResult(package_state_quit_early, {});
1649 : : }
1650 : :
1651 [ + - ]: 289249 : LOCK(m_pool.cs);
1652 : : // Stores results from which we will create the returned PackageMempoolAcceptResult.
1653 : : // A result may be changed if a mempool transaction is evicted later due to LimitMempoolSize().
1654 : 289249 : std::map<Wtxid, MempoolAcceptResult> results_final;
1655 : : // Results from individual validation which will be returned if no other result is available for
1656 : : // this transaction. "Nonfinal" because if a transaction fails by itself but succeeds later
1657 : : // (i.e. when evaluated with a fee-bumping child), the result in this map may be discarded.
1658 : 289249 : std::map<Wtxid, MempoolAcceptResult> individual_results_nonfinal;
1659 : : // Tracks whether we think package submission could result in successful entry to the mempool
1660 : 289249 : bool quit_early{false};
1661 : 289249 : std::vector<CTransactionRef> txns_package_eval;
1662 [ + + ]: 921700 : for (const auto& tx : package) {
1663 [ + - ]: 632451 : const auto& wtxid = tx->GetWitnessHash();
1664 [ + - ]: 632451 : const auto& txid = tx->GetHash();
1665 : : // There are 3 possibilities: already in mempool, same-txid-diff-wtxid already in mempool,
1666 : : // or not in mempool. An already confirmed tx is treated as one not in mempool, because all
1667 : : // we know is that the inputs aren't available.
1668 [ + - + + ]: 632451 : if (m_pool.exists(wtxid)) {
1669 : : // Exact transaction already exists in the mempool.
1670 : : // Node operators are free to set their mempool policies however they please, nodes may receive
1671 : : // transactions in different orders, and malicious counterparties may try to take advantage of
1672 : : // policy differences to pin or delay propagation of transactions. As such, it's possible for
1673 : : // some package transaction(s) to already be in the mempool, and we don't want to reject the
1674 : : // entire package in that case (as that could be a censorship vector). De-duplicate the
1675 : : // transactions that are already in the mempool, and only call AcceptMultipleTransactions() with
1676 : : // the new transactions. This ensures we don't double-count transaction counts and sizes when
1677 : : // checking ancestor/descendant limits, or double-count transaction fees for fee-related policy.
1678 [ + - - + ]: 15224 : const auto& entry{*Assert(m_pool.GetEntry(txid))};
1679 [ + - + - ]: 15224 : results_final.emplace(wtxid, MempoolAcceptResult::MempoolTx(entry.GetTxSize(), entry.GetFee()));
1680 [ + - + + ]: 617227 : } else if (m_pool.exists(txid)) {
1681 : : // Transaction with the same non-witness data but different witness (same txid,
1682 : : // different wtxid) already exists in the mempool.
1683 : : //
1684 : : // We don't allow replacement transactions right now, so just swap the package
1685 : : // transaction for the mempool one. Note that we are ignoring the validity of the
1686 : : // package transaction passed in.
1687 : : // TODO: allow witness replacement in packages.
1688 [ + - - + ]: 47 : const auto& entry{*Assert(m_pool.GetEntry(txid))};
1689 : : // Provide the wtxid of the mempool tx so that the caller can look it up in the mempool.
1690 [ + - ]: 47 : results_final.emplace(wtxid, MempoolAcceptResult::MempoolTxDifferentWitness(entry.GetTx().GetWitnessHash()));
1691 : : } else {
1692 : : // Transaction does not already exist in the mempool.
1693 : : // Try submitting the transaction on its own.
1694 [ + - + + : 1234360 : const auto single_package_res = AcceptSubPackage({tx}, args);
+ - - - -
- ]
1695 [ + - ]: 617180 : const auto& single_res = single_package_res.m_tx_results.at(wtxid);
1696 [ + + ]: 617180 : if (single_res.m_result_type == MempoolAcceptResult::ResultType::VALID) {
1697 : : // The transaction succeeded on its own and is now in the mempool. Don't include it
1698 : : // in package validation, because its fees should only be "used" once.
1699 [ + - - + ]: 96260 : assert(m_pool.exists(wtxid));
1700 [ + - ]: 96260 : results_final.emplace(wtxid, single_res);
1701 [ - + + + : 520920 : } else if (package.size() == 1 || // If there is only one transaction, no need to retry it "as a package"
+ + ]
1702 [ + + ]: 456634 : (single_res.m_state.GetResult() != TxValidationResult::TX_RECONSIDERABLE &&
1703 [ + + ]: 330406 : single_res.m_state.GetResult() != TxValidationResult::TX_MISSING_INPUTS)) {
1704 : : // Package validation policy only differs from individual policy in its evaluation
1705 : : // of feerate. For example, if a transaction fails here due to violation of a
1706 : : // consensus rule, the result will not change when it is submitted as part of a
1707 : : // package. To minimize the amount of repeated work, unless the transaction fails
1708 : : // due to feerate or missing inputs (its parent is a previous transaction in the
1709 : : // package that failed due to feerate), don't run package validation. Note that this
1710 : : // decision might not make sense if different types of packages are allowed in the
1711 : : // future. Continue individually validating the rest of the transactions, because
1712 : : // some of them may still be valid.
1713 : 222119 : quit_early = true;
1714 [ + - + - : 444238 : package_state_quit_early.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
+ - ]
1715 [ + - ]: 222119 : individual_results_nonfinal.emplace(wtxid, single_res);
1716 : : } else {
1717 [ + - ]: 298801 : individual_results_nonfinal.emplace(wtxid, single_res);
1718 [ + - ]: 298801 : txns_package_eval.push_back(tx);
1719 : : }
1720 : 617180 : }
1721 : : }
1722 : :
1723 [ + + + + : 793427 : auto multi_submission_result = quit_early || txns_package_eval.empty() ? PackageMempoolAcceptResult(package_state_quit_early, {}) :
+ - + + -
- ]
1724 [ + - + - : 504178 : AcceptSubPackage(txns_package_eval, args);
+ - ]
1725 : 289249 : PackageValidationState& package_state_final = multi_submission_result.m_state;
1726 : :
1727 : : // This is invoked by AcceptSubPackage() already, so this is just here for
1728 : : // clarity (since it's not permitted to invoke LimitMempoolSize() while a
1729 : : // changeset is outstanding).
1730 [ + - ]: 289249 : ClearSubPackageState();
1731 : :
1732 : : // Make sure we haven't exceeded max mempool size.
1733 : : // Package transactions that were submitted to mempool or already in mempool may be evicted.
1734 : : // If mempool contents change, then the m_view cache is dirty. It has already been cleared above.
1735 [ + - + - ]: 289249 : LimitMempoolSize(m_pool, m_active_chainstate.CoinsTip());
1736 : :
1737 [ + + ]: 921700 : for (const auto& tx : package) {
1738 : 632451 : const auto& wtxid = tx->GetWitnessHash();
1739 [ + + ]: 632451 : if (multi_submission_result.m_tx_results.contains(wtxid)) {
1740 : : // We shouldn't have re-submitted if the tx result was already in results_final.
1741 [ - + ]: 35841 : Assume(!results_final.contains(wtxid));
1742 : : // If it was submitted, check to see if the tx is still in the mempool. It could have
1743 : : // been evicted due to LimitMempoolSize() above.
1744 [ + - ]: 35841 : const auto& txresult = multi_submission_result.m_tx_results.at(wtxid);
1745 [ + + + - : 35841 : if (txresult.m_result_type == MempoolAcceptResult::ResultType::VALID && !m_pool.exists(wtxid)) {
+ + ]
1746 [ + - + - : 1670 : package_state_final.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
+ - ]
1747 [ + - ]: 835 : TxValidationState mempool_full_state;
1748 [ + - + - : 1670 : mempool_full_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "mempool full");
+ - ]
1749 [ + - + - : 1670 : results_final.emplace(wtxid, MempoolAcceptResult::Failure(mempool_full_state));
+ - ]
1750 : 835 : } else {
1751 [ + - ]: 35006 : results_final.emplace(wtxid, txresult);
1752 : : }
1753 [ + + ]: 596610 : } else if (const auto it{results_final.find(wtxid)}; it != results_final.end()) {
1754 : : // Already-in-mempool transaction. Check to see if it's still there, as it could have
1755 : : // been evicted when LimitMempoolSize() was called.
1756 [ - + ]: 111531 : Assume(it->second.m_result_type != MempoolAcceptResult::ResultType::INVALID);
1757 [ - + ]: 111531 : Assume(!individual_results_nonfinal.contains(wtxid));
1758 : : // Query by txid to include the same-txid-different-witness ones.
1759 [ + - + + ]: 111531 : if (!m_pool.exists(tx->GetHash())) {
1760 [ + - + - : 3440 : package_state_final.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
+ - ]
1761 [ + - ]: 1720 : TxValidationState mempool_full_state;
1762 [ + - + - : 3440 : mempool_full_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "mempool full");
+ - ]
1763 : : // Replace the previous result.
1764 : 1720 : results_final.erase(wtxid);
1765 [ + - + - : 3440 : results_final.emplace(wtxid, MempoolAcceptResult::Failure(mempool_full_state));
+ - ]
1766 : 1720 : }
1767 [ + - ]: 485079 : } else if (const auto it{individual_results_nonfinal.find(wtxid)}; it != individual_results_nonfinal.end()) {
1768 [ - + ]: 485079 : Assume(it->second.m_result_type == MempoolAcceptResult::ResultType::INVALID);
1769 : : // Interesting result from previous processing.
1770 [ + - ]: 485079 : results_final.emplace(wtxid, it->second);
1771 : : }
1772 : : }
1773 [ - + - + ]: 289249 : Assume(results_final.size() == package.size());
1774 [ + - + - ]: 578498 : return PackageMempoolAcceptResult(package_state_final, std::move(results_final));
1775 [ + - + - : 2194869 : }
+ - ]
1776 : :
1777 : : } // anon namespace
1778 : :
1779 : 1174206 : MempoolAcceptResult AcceptToMemoryPool(Chainstate& active_chainstate, const CTransactionRef& tx,
1780 : : int64_t accept_time, bool bypass_limits, bool test_accept)
1781 : : {
1782 : 1174206 : AssertLockHeld(::cs_main);
1783 [ - + ]: 1174206 : const CChainParams& chainparams{active_chainstate.m_chainman.GetParams()};
1784 [ - + ]: 1174206 : assert(active_chainstate.GetMempool() != nullptr);
1785 : 1174206 : CTxMemPool& pool{*active_chainstate.GetMempool()};
1786 : :
1787 : 1174206 : std::vector<COutPoint> coins_to_uncache;
1788 : :
1789 [ + - ]: 1174206 : auto args = MemPoolAccept::ATMPArgs::SingleAccept(chainparams, accept_time, bypass_limits, coins_to_uncache, test_accept);
1790 [ + - + - ]: 1174206 : MempoolAcceptResult result = MemPoolAccept(pool, active_chainstate).AcceptSingleTransactionAndCleanup(tx, args);
1791 : :
1792 [ + + ]: 1174206 : if (result.m_result_type != MempoolAcceptResult::ResultType::VALID) {
1793 : : // Remove coins that were not present in the coins cache before calling
1794 : : // AcceptSingleTransaction(); this is to prevent memory DoS in case we receive a large
1795 : : // number of invalid transactions that attempt to overrun the in-memory coins cache
1796 : : // (`CCoinsViewCache::cacheCoins`).
1797 : :
1798 [ + + ]: 1688555 : for (const COutPoint& hashTx : coins_to_uncache)
1799 [ + - + - ]: 602671 : active_chainstate.CoinsTip().Uncache(hashTx);
1800 : : TRACEPOINT(mempool, rejected,
1801 : : tx->GetHash().data(),
1802 : : result.m_state.GetRejectReason().c_str()
1803 : : );
1804 : : }
1805 : : // After we've (potentially) uncached entries, ensure our coins cache is still within its size limits
1806 [ + - ]: 1174206 : BlockValidationState state_dummy;
1807 [ + - ]: 1174206 : active_chainstate.FlushStateToDisk(state_dummy, FlushStateMode::PERIODIC);
1808 : 1174206 : return result;
1809 : 1174206 : }
1810 : :
1811 : 546613 : PackageMempoolAcceptResult ProcessNewPackage(Chainstate& active_chainstate, CTxMemPool& pool,
1812 : : const Package& package, bool test_accept, const std::optional<CFeeRate>& client_maxfeerate)
1813 : : {
1814 : 546613 : AssertLockHeld(cs_main);
1815 [ - + ]: 546613 : assert(!package.empty());
1816 [ + - - + ]: 1963101 : assert(std::all_of(package.cbegin(), package.cend(), [](const auto& tx){return tx != nullptr;}));
1817 : :
1818 : 546613 : std::vector<COutPoint> coins_to_uncache;
1819 [ + - ]: 546613 : const CChainParams& chainparams = active_chainstate.m_chainman.GetParams();
1820 : 1093226 : auto result = [&]() EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
1821 : 546613 : AssertLockHeld(cs_main);
1822 [ + + ]: 546613 : if (test_accept) {
1823 : 164602 : auto args = MemPoolAccept::ATMPArgs::PackageTestAccept(chainparams, GetTime(), coins_to_uncache);
1824 [ + - ]: 164602 : return MemPoolAccept(pool, active_chainstate).AcceptMultipleTransactionsAndCleanup(package, args);
1825 : : } else {
1826 : 382011 : auto args = MemPoolAccept::ATMPArgs::PackageChildWithParents(chainparams, GetTime(), coins_to_uncache, client_maxfeerate);
1827 [ + - ]: 382011 : return MemPoolAccept(pool, active_chainstate).AcceptPackage(package, args);
1828 : : }
1829 [ + - ]: 546613 : }();
1830 : :
1831 : : // Uncache coins pertaining to transactions that were not submitted to the mempool.
1832 [ + + + + ]: 546613 : if (test_accept || result.m_state.IsInvalid()) {
1833 [ + + ]: 1454198 : for (const COutPoint& hashTx : coins_to_uncache) {
1834 [ + - + - ]: 935455 : active_chainstate.CoinsTip().Uncache(hashTx);
1835 : : }
1836 : : }
1837 : : // Ensure the coins cache is still within limits.
1838 [ + - ]: 546613 : BlockValidationState state_dummy;
1839 [ + - ]: 546613 : active_chainstate.FlushStateToDisk(state_dummy, FlushStateMode::PERIODIC);
1840 : 546613 : return result;
1841 : 546613 : }
1842 : :
1843 : 649395 : CAmount GetBlockSubsidy(int nHeight, const Consensus::Params& consensusParams)
1844 : : {
1845 : 649395 : int halvings = nHeight / consensusParams.nSubsidyHalvingInterval;
1846 : : // Force block reward to zero when right shift is undefined.
1847 [ + - ]: 649395 : if (halvings >= 64)
1848 : : return 0;
1849 : :
1850 : 649395 : CAmount nSubsidy = 50 * COIN;
1851 : : // Subsidy is cut in half every 210,000 blocks which will occur approximately every 4 years.
1852 : 649395 : nSubsidy >>= halvings;
1853 : 649395 : return nSubsidy;
1854 : : }
1855 : :
1856 : 4446 : CoinsViews::CoinsViews(DBParams db_params, CoinsViewOptions options)
1857 [ + - ]: 4446 : : m_dbview{std::move(db_params), std::move(options)},
1858 [ + - ]: 4446 : m_catcherview(&m_dbview) {}
1859 : :
1860 : 4446 : void CoinsViews::InitCache()
1861 : : {
1862 : 4446 : AssertLockHeld(::cs_main);
1863 : 4446 : m_cacheview = std::make_unique<CCoinsViewCache>(&m_catcherview);
1864 : 4446 : }
1865 : :
1866 : 4446 : Chainstate::Chainstate(
1867 : : CTxMemPool* mempool,
1868 : : BlockManager& blockman,
1869 : : ChainstateManager& chainman,
1870 : 4446 : std::optional<uint256> from_snapshot_blockhash)
1871 [ + + ]: 4446 : : m_mempool(mempool),
1872 : 4446 : m_blockman(blockman),
1873 [ + + ]: 4446 : m_chainman(chainman),
1874 [ + + ]: 4446 : m_assumeutxo(from_snapshot_blockhash ? Assumeutxo::UNVALIDATED : Assumeutxo::VALIDATED),
1875 [ + + ]: 4446 : m_from_snapshot_blockhash(from_snapshot_blockhash) {}
1876 : :
1877 : 4446 : fs::path Chainstate::StoragePath() const
1878 : : {
1879 [ + - ]: 8892 : fs::path path{m_chainman.m_options.datadir / "chainstate"};
1880 [ + + ]: 4446 : if (m_from_snapshot_blockhash) {
1881 [ + - ]: 2203 : path += node::SNAPSHOT_CHAINSTATE_SUFFIX;
1882 : : }
1883 : 4446 : return path;
1884 : 0 : }
1885 : :
1886 : 737756 : const CBlockIndex* Chainstate::SnapshotBase() const
1887 : : {
1888 [ + + ]: 737756 : if (!m_from_snapshot_blockhash) return nullptr;
1889 [ + + - + ]: 10251 : if (!m_cached_snapshot_base) m_cached_snapshot_base = Assert(m_chainman.m_blockman.LookupBlockIndex(*m_from_snapshot_blockhash));
1890 : 10251 : return m_cached_snapshot_base;
1891 : : }
1892 : :
1893 : 1420610 : const CBlockIndex* Chainstate::TargetBlock() const
1894 : : {
1895 [ - + ]: 1420610 : if (!m_target_blockhash) return nullptr;
1896 [ # # # # ]: 0 : if (!m_cached_target_block) m_cached_target_block = Assert(m_chainman.m_blockman.LookupBlockIndex(*m_target_blockhash));
1897 : 0 : return m_cached_target_block;
1898 : : }
1899 : :
1900 : 0 : void Chainstate::SetTargetBlock(CBlockIndex* block)
1901 : : {
1902 [ # # ]: 0 : if (block) {
1903 [ # # ]: 0 : m_target_blockhash = block->GetBlockHash();
1904 : : } else {
1905 [ # # ]: 0 : m_target_blockhash.reset();
1906 : : }
1907 : 0 : m_cached_target_block = block;
1908 : 0 : }
1909 : :
1910 : 0 : void Chainstate::SetTargetBlockHash(uint256 block_hash)
1911 : : {
1912 [ # # ]: 0 : m_target_blockhash = block_hash;
1913 : 0 : m_cached_target_block = nullptr;
1914 : 0 : }
1915 : :
1916 : 4446 : void Chainstate::InitCoinsDB(
1917 : : size_t cache_size_bytes,
1918 : : bool in_memory,
1919 : : bool should_wipe)
1920 : : {
1921 : 4446 : m_coins_views = std::make_unique<CoinsViews>(
1922 : 13338 : DBParams{
1923 : : .path = StoragePath(),
1924 : : .cache_bytes = cache_size_bytes,
1925 : : .memory_only = in_memory,
1926 : : .wipe_data = should_wipe,
1927 : : .obfuscate = true,
1928 [ + - ]: 4446 : .options = m_chainman.m_options.coins_db},
1929 : 8892 : m_chainman.m_options.coins_view);
1930 : :
1931 : 4446 : m_coinsdb_cache_size_bytes = cache_size_bytes;
1932 : 4446 : }
1933 : :
1934 : 4446 : void Chainstate::InitCoinsCache(size_t cache_size_bytes)
1935 : : {
1936 : 4446 : AssertLockHeld(::cs_main);
1937 [ - + ]: 4446 : assert(m_coins_views != nullptr);
1938 : 4446 : m_coinstip_cache_size_bytes = cache_size_bytes;
1939 : 4446 : m_coins_views->InitCache();
1940 : 4446 : }
1941 : :
1942 : : // Note that though this is marked const, we may end up modifying `m_cached_finished_ibd`, which
1943 : : // is a performance-related implementation detail. This function must be marked
1944 : : // `const` so that `CValidationInterface` clients (which are given a `const Chainstate*`)
1945 : : // can call it.
1946 : : //
1947 : 1677853 : bool ChainstateManager::IsInitialBlockDownload() const
1948 : : {
1949 : : // Optimization: pre-test latch before taking the lock.
1950 [ + + ]: 1677853 : if (m_cached_finished_ibd.load(std::memory_order_relaxed))
1951 : : return false;
1952 : :
1953 : 757079 : LOCK(cs_main);
1954 [ + - ]: 757079 : if (m_cached_finished_ibd.load(std::memory_order_relaxed))
1955 : : return false;
1956 [ + - ]: 757079 : if (m_blockman.LoadingBlocks()) {
1957 : : return true;
1958 : : }
1959 [ + - ]: 757079 : CChain& chain{ActiveChain()};
1960 [ - + + - : 2268994 : if (chain.Tip() == nullptr) {
+ - ]
1961 : : return true;
1962 : : }
1963 [ + - - + : 1509672 : if (chain.Tip()->nChainWork < MinimumChainWork()) {
+ - + + ]
1964 : : return true;
1965 : : }
1966 [ - + + + ]: 1476510 : if (chain.Tip()->Time() < Now<NodeSeconds>() - m_options.max_tip_age) {
1967 : : return true;
1968 : : }
1969 [ + - ]: 3259 : LogInfo("Leaving InitialBlockDownload (latching to false)");
1970 : 3259 : m_cached_finished_ibd.store(true, std::memory_order_relaxed);
1971 : 3259 : return false;
1972 : 757079 : }
1973 : :
1974 : 197875 : void Chainstate::CheckForkWarningConditions()
1975 : : {
1976 : 197875 : AssertLockHeld(cs_main);
1977 : :
1978 [ + - ]: 197875 : if (this->GetRole().historical) {
1979 : : return;
1980 : : }
1981 : :
1982 [ + + - + : 355293 : if (m_chainman.m_best_invalid && m_chainman.m_best_invalid->nChainWork > m_chain.Tip()->nChainWork + (GetBlockProof(*m_chain.Tip()) * 6)) {
- + + + ]
1983 : 510 : LogWarning("Found invalid chain more than 6 blocks longer than our best chain. This could be due to database corruption or consensus incompatibility with peers.");
1984 [ + - ]: 510 : m_chainman.GetNotifications().warningSet(
1985 : : kernel::Warning::LARGE_WORK_INVALID_CHAIN,
1986 : 1020 : _("Warning: Found invalid chain more than 6 blocks longer than our best chain. This could be due to database corruption or consensus incompatibility with peers."));
1987 : : } else {
1988 : 197365 : m_chainman.GetNotifications().warningUnset(kernel::Warning::LARGE_WORK_INVALID_CHAIN);
1989 : : }
1990 : : }
1991 : :
1992 : : // Called both upon regular invalid block discovery *and* InvalidateBlock
1993 : 24451 : void Chainstate::InvalidChainFound(CBlockIndex* pindexNew)
1994 : : {
1995 : 24451 : AssertLockHeld(cs_main);
1996 [ + + + + ]: 24451 : if (!m_chainman.m_best_invalid || pindexNew->nChainWork > m_chainman.m_best_invalid->nChainWork) {
1997 : 6187 : m_chainman.m_best_invalid = pindexNew;
1998 : : }
1999 : 24451 : SetBlockFailureFlags(pindexNew);
2000 [ + - + + ]: 24451 : if (m_chainman.m_best_header != nullptr && m_chainman.m_best_header->GetAncestor(pindexNew->nHeight) == pindexNew) {
2001 : 10997 : m_chainman.RecalculateBestHeader();
2002 : : }
2003 : :
2004 [ + - + - : 48902 : LogInfo("%s: invalid block=%s height=%d log2_work=%f date=%s\n", __func__,
+ - ]
2005 : : pindexNew->GetBlockHash().ToString(), pindexNew->nHeight,
2006 : : log(pindexNew->nChainWork.getdouble())/log(2.0), FormatISO8601DateTime(pindexNew->GetBlockTime()));
2007 [ - + ]: 24451 : CBlockIndex *tip = m_chain.Tip();
2008 [ - + ]: 24451 : assert (tip);
2009 [ + - - + : 48902 : LogInfo("%s: current best=%s height=%d log2_work=%f date=%s\n", __func__,
+ - + - ]
2010 : : tip->GetBlockHash().ToString(), m_chain.Height(), log(tip->nChainWork.getdouble())/log(2.0),
2011 : : FormatISO8601DateTime(tip->GetBlockTime()));
2012 : 24451 : CheckForkWarningConditions();
2013 : 24451 : }
2014 : :
2015 : : // Same as InvalidChainFound, above, except not called directly from InvalidateBlock,
2016 : : // which does its own setBlockIndexCandidates management.
2017 : 29451 : void Chainstate::InvalidBlockFound(CBlockIndex* pindex, const BlockValidationState& state)
2018 : : {
2019 : 29451 : AssertLockHeld(cs_main);
2020 [ + + ]: 29451 : if (state.GetResult() != BlockValidationResult::BLOCK_MUTATED) {
2021 : 13109 : pindex->nStatus |= BLOCK_FAILED_VALID;
2022 : 13109 : m_blockman.m_dirty_blockindex.insert(pindex);
2023 : 13109 : setBlockIndexCandidates.erase(pindex);
2024 : 13109 : InvalidChainFound(pindex);
2025 : : }
2026 : 29451 : }
2027 : :
2028 : 385519 : void UpdateCoins(const CTransaction& tx, CCoinsViewCache& inputs, CTxUndo &txundo, int nHeight)
2029 : : {
2030 : : // mark inputs spent
2031 [ + + ]: 385519 : if (!tx.IsCoinBase()) {
2032 [ - + ]: 17165 : txundo.vprevout.reserve(tx.vin.size());
2033 [ + + ]: 39630 : for (const CTxIn &txin : tx.vin) {
2034 : 22465 : txundo.vprevout.emplace_back();
2035 : 22465 : bool is_spent = inputs.SpendCoin(txin.prevout, &txundo.vprevout.back());
2036 [ - + ]: 22465 : assert(is_spent);
2037 : : }
2038 : : }
2039 : : // add outputs
2040 : 385519 : AddCoins(inputs, tx, nHeight);
2041 : 385519 : }
2042 : :
2043 : 491893 : std::optional<std::pair<ScriptError, std::string>> CScriptCheck::operator()() {
2044 [ + - ]: 491893 : const CScript &scriptSig = ptxTo->vin[nIn].scriptSig;
2045 : 491893 : const CScriptWitness *witness = &ptxTo->vin[nIn].scriptWitness;
2046 : 491893 : ScriptError error{SCRIPT_ERR_UNKNOWN_ERROR};
2047 [ + - + + ]: 491893 : if (VerifyScript(scriptSig, m_tx_out.scriptPubKey, witness, m_flags, CachingTransactionSignatureChecker(ptxTo, nIn, m_tx_out.nValue, cacheStore, *m_signature_cache, *txdata), &error)) {
2048 : 477314 : return std::nullopt;
2049 : : } else {
2050 [ + - + - : 29158 : auto debug_str = strprintf("input %i of %s (wtxid %s), spending %s:%i", nIn, ptxTo->GetHash().ToString(), ptxTo->GetWitnessHash().ToString(), ptxTo->vin[nIn].prevout.hash.ToString(), ptxTo->vin[nIn].prevout.n);
+ - ]
2051 : 14579 : return std::make_pair(error, std::move(debug_str));
2052 : 14579 : }
2053 : : }
2054 : :
2055 : 2243 : ValidationCache::ValidationCache(const size_t script_execution_cache_bytes, const size_t signature_cache_bytes)
2056 [ + - ]: 2243 : : m_signature_cache{signature_cache_bytes}
2057 : : {
2058 : : // Setup the salted hasher
2059 : 2243 : uint256 nonce = GetRandHash();
2060 : : // We want the nonce to be 64 bytes long to force the hasher to process
2061 : : // this chunk, which makes later hash computations more efficient. We
2062 : : // just write our 32-byte entropy twice to fill the 64 bytes.
2063 [ + - ]: 2243 : m_script_execution_cache_hasher.Write(nonce.begin(), 32);
2064 [ + - ]: 2243 : m_script_execution_cache_hasher.Write(nonce.begin(), 32);
2065 : :
2066 [ + - + - ]: 2243 : const auto [num_elems, approx_size_bytes] = m_script_execution_cache.setup_bytes(script_execution_cache_bytes);
2067 [ + - ]: 2243 : LogInfo("Using %zu MiB out of %zu MiB requested for script execution cache, able to store %zu elements",
2068 : : approx_size_bytes >> 20, script_execution_cache_bytes >> 20, num_elems);
2069 : 2243 : }
2070 : :
2071 : : /**
2072 : : * Check whether all of this transaction's input scripts succeed.
2073 : : *
2074 : : * This involves ECDSA signature checks so can be computationally intensive. This function should
2075 : : * only be called after the cheap sanity checks in CheckTxInputs passed.
2076 : : *
2077 : : * If pvChecks is not nullptr, script checks are pushed onto it instead of being performed inline. Any
2078 : : * script checks which are not necessary (eg due to script execution cache hits) are, obviously,
2079 : : * not pushed onto pvChecks/run.
2080 : : *
2081 : : * Setting cacheSigStore/cacheFullScriptStore to false will remove elements from the corresponding cache
2082 : : * which are matched. This is useful for checking blocks where we will likely never need the cache
2083 : : * entry again.
2084 : : *
2085 : : * Note that we may set state.reason to NOT_STANDARD for extra soft-fork flags in flags, block-checking
2086 : : * callers should probably reset it to CONSENSUS in such cases.
2087 : : *
2088 : : * Non-static (and redeclared) in src/test/txvalidationcache_tests.cpp
2089 : : */
2090 : 435127 : bool CheckInputScripts(const CTransaction& tx, TxValidationState& state,
2091 : : const CCoinsViewCache& inputs, script_verify_flags flags, bool cacheSigStore,
2092 : : bool cacheFullScriptStore, PrecomputedTransactionData& txdata,
2093 : : ValidationCache& validation_cache,
2094 : : std::vector<CScriptCheck>* pvChecks)
2095 : : {
2096 [ + - ]: 435127 : if (tx.IsCoinBase()) return true;
2097 : :
2098 [ - + ]: 435127 : if (pvChecks) {
2099 [ # # ]: 0 : pvChecks->reserve(tx.vin.size());
2100 : : }
2101 : :
2102 : : // First check if script executions have been cached with the same
2103 : : // flags. Note that this assumes that the inputs provided are
2104 : : // correct (ie that the transaction hash which is in tx's prevouts
2105 : : // properly commits to the scriptPubKey in the inputs view of that
2106 : : // transaction).
2107 : 435127 : uint256 hashCacheEntry;
2108 : 435127 : CSHA256 hasher = validation_cache.ScriptExecutionCacheHasher();
2109 : 435127 : hasher.Write(UCharCast(tx.GetWitnessHash().begin()), 32).Write((unsigned char*)&flags, sizeof(flags)).Finalize(hashCacheEntry.begin());
2110 : 435127 : AssertLockHeld(cs_main); //TODO: Remove this requirement by making CuckooCache not require external locks
2111 [ + + ]: 435127 : if (validation_cache.m_script_execution_cache.contains(hashCacheEntry, !cacheFullScriptStore)) {
2112 : : return true;
2113 : : }
2114 : :
2115 [ + + ]: 295281 : if (!txdata.m_spent_outputs_ready) {
2116 : 230669 : std::vector<CTxOut> spent_outputs;
2117 [ - + + - ]: 230669 : spent_outputs.reserve(tx.vin.size());
2118 : :
2119 [ + + ]: 599076 : for (const auto& txin : tx.vin) {
2120 : 368407 : const COutPoint& prevout = txin.prevout;
2121 [ + - ]: 368407 : const Coin& coin = inputs.AccessCoin(prevout);
2122 [ - + ]: 368407 : assert(!coin.IsSpent());
2123 [ + - ]: 368407 : spent_outputs.emplace_back(coin.out);
2124 : : }
2125 [ + - ]: 230669 : txdata.Init(tx, std::move(spent_outputs));
2126 : 230669 : }
2127 [ - + - + : 295281 : assert(txdata.m_spent_outputs.size() == tx.vin.size());
- + ]
2128 : :
2129 [ - + + + ]: 772595 : for (unsigned int i = 0; i < tx.vin.size(); i++) {
2130 : :
2131 : : // We very carefully only pass in things to CScriptCheck which
2132 : : // are clearly committed to by tx' witness hash. This provides
2133 : : // a sanity check that our caching is not introducing consensus
2134 : : // failures through additional data in, eg, the coins being
2135 : : // spent being checked as a part of CScriptCheck.
2136 : :
2137 : : // Verify signature
2138 : 491893 : CScriptCheck check(txdata.m_spent_outputs[i], tx, validation_cache.m_signature_cache, i, flags, cacheSigStore, &txdata);
2139 [ - + ]: 491893 : if (pvChecks) {
2140 [ # # ]: 0 : pvChecks->emplace_back(std::move(check));
2141 [ + - + + ]: 491893 : } else if (auto result = check(); result.has_value()) {
2142 : : // Tx failures never trigger disconnections/bans.
2143 : : // This is so that network splits aren't triggered
2144 : : // either due to non-consensus relay policies (such as
2145 : : // non-standard DER encodings or non-null dummy
2146 : : // arguments) or due to new consensus rules introduced in
2147 : : // soft forks.
2148 [ + - ]: 14579 : if (flags & STANDARD_NOT_MANDATORY_VERIFY_FLAGS) {
2149 [ + - + - : 14579 : return state.Invalid(TxValidationResult::TX_NOT_STANDARD, strprintf("mempool-script-verify-flag-failed (%s)", ScriptErrorString(result->first)), result->second);
+ - ]
2150 : : } else {
2151 [ # # # # : 0 : return state.Invalid(TxValidationResult::TX_CONSENSUS, strprintf("block-script-verify-flag-failed (%s)", ScriptErrorString(result->first)), result->second);
# # ]
2152 : : }
2153 : 491893 : }
2154 : 491893 : }
2155 : :
2156 [ + + ]: 280702 : if (cacheFullScriptStore && !pvChecks) {
2157 : : // We executed all of the provided scripts, and were told to
2158 : : // cache the result. Do so now.
2159 : 64612 : validation_cache.m_script_execution_cache.insert(hashCacheEntry);
2160 : : }
2161 : :
2162 : : return true;
2163 : : }
2164 : :
2165 : 0 : bool FatalError(Notifications& notifications, BlockValidationState& state, const bilingual_str& message)
2166 : : {
2167 : 0 : notifications.fatalError(message);
2168 [ # # ]: 0 : return state.Error(message.original);
2169 : : }
2170 : :
2171 : : /**
2172 : : * Restore the UTXO in a Coin at a given COutPoint
2173 : : * @param undo The Coin to be restored.
2174 : : * @param view The coins view to which to apply the changes.
2175 : : * @param out The out point that corresponds to the tx input.
2176 : : * @return A DisconnectResult as an int
2177 : : */
2178 : 0 : int ApplyTxInUndo(Coin&& undo, CCoinsViewCache& view, const COutPoint& out)
2179 : : {
2180 : 0 : bool fClean = true;
2181 : :
2182 [ # # ]: 0 : if (view.HaveCoin(out)) fClean = false; // overwriting transaction output
2183 : :
2184 [ # # ]: 0 : if (undo.nHeight == 0) {
2185 : : // Missing undo metadata (height and coinbase). Older versions included this
2186 : : // information only in undo records for the last spend of a transactions'
2187 : : // outputs. This implies that it must be present for some other output of the same tx.
2188 : 0 : const Coin& alternate = AccessByTxid(view, out.hash);
2189 [ # # ]: 0 : if (!alternate.IsSpent()) {
2190 : 0 : undo.nHeight = alternate.nHeight;
2191 : 0 : undo.fCoinBase = alternate.fCoinBase;
2192 : : } else {
2193 : : return DISCONNECT_FAILED; // adding output for transaction without known metadata
2194 : : }
2195 : : }
2196 : : // If the coin already exists as an unspent coin in the cache, then the
2197 : : // possible_overwrite parameter to AddCoin must be set to true. We have
2198 : : // already checked whether an unspent coin exists above using HaveCoin, so
2199 : : // we don't need to guess. When fClean is false, an unspent coin already
2200 : : // existed and it is an overwrite.
2201 : 0 : view.AddCoin(out, std::move(undo), !fClean);
2202 : :
2203 [ # # ]: 0 : return fClean ? DISCONNECT_OK : DISCONNECT_UNCLEAN;
2204 : : }
2205 : :
2206 : : /** Undo the effects of this block (with given index) on the UTXO set represented by coins.
2207 : : * When FAILED is returned, view is left in an indeterminate state. */
2208 : 0 : DisconnectResult Chainstate::DisconnectBlock(const CBlock& block, const CBlockIndex* pindex, CCoinsViewCache& view)
2209 : : {
2210 : 0 : AssertLockHeld(::cs_main);
2211 : 0 : bool fClean = true;
2212 : :
2213 : 0 : CBlockUndo blockUndo;
2214 [ # # # # ]: 0 : if (!m_blockman.ReadBlockUndo(blockUndo, *pindex)) {
2215 [ # # ]: 0 : LogError("DisconnectBlock(): failure reading undo data\n");
2216 : : return DISCONNECT_FAILED;
2217 : : }
2218 : :
2219 [ # # # # : 0 : if (blockUndo.vtxundo.size() + 1 != block.vtx.size()) {
# # ]
2220 [ # # ]: 0 : LogError("DisconnectBlock(): block and undo data inconsistent\n");
2221 : : return DISCONNECT_FAILED;
2222 : : }
2223 : :
2224 : : // Ignore blocks that contain transactions which are 'overwritten' by later transactions,
2225 : : // unless those are already completely spent.
2226 : : // See https://github.com/bitcoin/bitcoin/issues/22596 for additional information.
2227 : : // Note: the blocks specified here are different than the ones used in ConnectBlock because DisconnectBlock
2228 : : // unwinds the blocks in reverse. As a result, the inconsistency is not discovered until the earlier
2229 : : // blocks with the duplicate coinbase transactions are disconnected.
2230 [ # # # # ]: 0 : bool fEnforceBIP30 = !((pindex->nHeight==91722 && pindex->GetBlockHash() == uint256{"00000000000271a2dc26e7667f8419f2e15416dc6955e5a6c6cdf3f2574dd08e"}) ||
2231 [ # # # # ]: 0 : (pindex->nHeight==91812 && pindex->GetBlockHash() == uint256{"00000000000af0aed4792b1acee3d966af36cf5def14935db8de83d6f9306f2f"}));
2232 : :
2233 : : // undo transactions in reverse order
2234 [ # # # # ]: 0 : for (int i = block.vtx.size() - 1; i >= 0; i--) {
2235 : 0 : const CTransaction &tx = *(block.vtx[i]);
2236 : 0 : Txid hash = tx.GetHash();
2237 : 0 : bool is_coinbase = tx.IsCoinBase();
2238 : 0 : bool is_bip30_exception = (is_coinbase && !fEnforceBIP30);
2239 : :
2240 : : // Check that all outputs are available and match the outputs in the block itself
2241 : : // exactly.
2242 [ # # # # ]: 0 : for (size_t o = 0; o < tx.vout.size(); o++) {
2243 [ # # ]: 0 : if (!tx.vout[o].scriptPubKey.IsUnspendable()) {
2244 : 0 : COutPoint out(hash, o);
2245 : 0 : Coin coin;
2246 [ # # ]: 0 : bool is_spent = view.SpendCoin(out, &coin);
2247 [ # # # # : 0 : if (!is_spent || tx.vout[o] != coin.out || pindex->nHeight != coin.nHeight || is_coinbase != coin.fCoinBase) {
# # # # ]
2248 [ # # ]: 0 : if (!is_bip30_exception) {
2249 : 0 : fClean = false; // transaction output mismatch
2250 : : }
2251 : : }
2252 : 0 : }
2253 : : }
2254 : :
2255 : : // restore inputs
2256 [ # # ]: 0 : if (i > 0) { // not coinbases
2257 [ # # ]: 0 : CTxUndo &txundo = blockUndo.vtxundo[i-1];
2258 [ # # # # : 0 : if (txundo.vprevout.size() != tx.vin.size()) {
# # ]
2259 [ # # ]: 0 : LogError("DisconnectBlock(): transaction and undo data inconsistent\n");
2260 : : return DISCONNECT_FAILED;
2261 : : }
2262 [ # # ]: 0 : for (unsigned int j = tx.vin.size(); j > 0;) {
2263 : 0 : --j;
2264 [ # # ]: 0 : const COutPoint& out = tx.vin[j].prevout;
2265 [ # # ]: 0 : int res = ApplyTxInUndo(std::move(txundo.vprevout[j]), view, out);
2266 [ # # ]: 0 : if (res == DISCONNECT_FAILED) return DISCONNECT_FAILED;
2267 : 0 : fClean = fClean && res != DISCONNECT_UNCLEAN;
2268 : : }
2269 : : // At this point, all of txundo.vprevout should have been moved out.
2270 : : }
2271 : : }
2272 : :
2273 : : // move best block pointer to prevout block
2274 [ # # ]: 0 : view.SetBestBlock(pindex->pprev->GetBlockHash());
2275 : :
2276 [ # # ]: 0 : return fClean ? DISCONNECT_OK : DISCONNECT_UNCLEAN;
2277 : 0 : }
2278 : :
2279 : 556792 : script_verify_flags GetBlockScriptFlags(const CBlockIndex& block_index, const ChainstateManager& chainman)
2280 : : {
2281 [ - + ]: 556792 : const Consensus::Params& consensusparams = chainman.GetConsensus();
2282 : :
2283 : : // BIP16 didn't become active until Apr 1 2012 (on mainnet, and
2284 : : // retroactively applied to testnet)
2285 : : // However, only one historical block violated the P2SH rules (on both
2286 : : // mainnet and testnet).
2287 : : // Similarly, only one historical block violated the TAPROOT rules on
2288 : : // mainnet.
2289 : : // For simplicity, always leave P2SH+WITNESS+TAPROOT on except for the two
2290 : : // violating blocks.
2291 : 556792 : script_verify_flags flags{SCRIPT_VERIFY_P2SH | SCRIPT_VERIFY_WITNESS | SCRIPT_VERIFY_TAPROOT};
2292 [ - + ]: 556792 : const auto it{consensusparams.script_flag_exceptions.find(*Assert(block_index.phashBlock))};
2293 [ - + ]: 556792 : if (it != consensusparams.script_flag_exceptions.end()) {
2294 : 0 : flags = it->second;
2295 : : }
2296 : :
2297 : : // Enforce the DERSIG (BIP66) rule
2298 [ + + ]: 556792 : if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_DERSIG)) {
2299 : 556788 : flags |= SCRIPT_VERIFY_DERSIG;
2300 : : }
2301 : :
2302 : : // Enforce CHECKLOCKTIMEVERIFY (BIP65)
2303 [ + + ]: 556792 : if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_CLTV)) {
2304 : 556788 : flags |= SCRIPT_VERIFY_CHECKLOCKTIMEVERIFY;
2305 : : }
2306 : :
2307 : : // Enforce CHECKSEQUENCEVERIFY (BIP112)
2308 [ + + ]: 556792 : if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_CSV)) {
2309 : 556788 : flags |= SCRIPT_VERIFY_CHECKSEQUENCEVERIFY;
2310 : : }
2311 : :
2312 : : // Enforce BIP147 NULLDUMMY (activated simultaneously with segwit)
2313 [ + - ]: 556792 : if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_SEGWIT)) {
2314 : 556792 : flags |= SCRIPT_VERIFY_NULLDUMMY;
2315 : : }
2316 : :
2317 : 556792 : return flags;
2318 : : }
2319 : :
2320 : :
2321 : : /** Apply the effects of this block (with given index) on the UTXO set represented by coins.
2322 : : * Validity checks that depend on the UTXO set are also done; ConnectBlock()
2323 : : * can fail if those validity checks fail (among other reasons). */
2324 : 370906 : bool Chainstate::ConnectBlock(const CBlock& block, BlockValidationState& state, CBlockIndex* pindex,
2325 : : CCoinsViewCache& view, bool fJustCheck)
2326 : : {
2327 : 370906 : AssertLockHeld(cs_main);
2328 [ - + ]: 370906 : assert(pindex);
2329 : :
2330 : 370906 : uint256 block_hash{block.GetHash()};
2331 [ - + ]: 370906 : assert(*pindex->phashBlock == block_hash);
2332 : :
2333 : 370906 : const auto time_start{SteadyClock::now()};
2334 : 370906 : const CChainParams& params{m_chainman.GetParams()};
2335 : :
2336 : : // Check it again in case a previous version let a bad block in
2337 : : // NOTE: We don't currently (re-)invoke ContextualCheckBlock() or
2338 : : // ContextualCheckBlockHeader() here. This means that if we add a new
2339 : : // consensus rule that is enforced in one of those two functions, then we
2340 : : // may have let in a block that violates the rule prior to updating the
2341 : : // software, and we would NOT be enforcing the rule here. Fully solving
2342 : : // upgrade from one software version to the next after a consensus rule
2343 : : // change is potentially tricky and issue-specific (see NeedsRedownload()
2344 : : // for one approach that was used for BIP 141 deployment).
2345 : : // Also, currently the rule against blocks more than 2 hours in the future
2346 : : // is enforced in ContextualCheckBlockHeader(); we wouldn't want to
2347 : : // re-enforce that rule here (at least until we make it impossible for
2348 : : // the clock to go backward).
2349 [ - + ]: 370906 : if (!CheckBlock(block, state, params.GetConsensus(), !fJustCheck, !fJustCheck)) {
2350 [ # # ]: 0 : if (state.GetResult() == BlockValidationResult::BLOCK_MUTATED) {
2351 : : // We don't write down blocks to disk if they may have been
2352 : : // corrupted, so this should be impossible unless we're having hardware
2353 : : // problems.
2354 [ # # ]: 0 : return FatalError(m_chainman.GetNotifications(), state, _("Corrupt block found indicating potential hardware failure."));
2355 : : }
2356 [ # # ]: 0 : LogError("%s: Consensus::CheckBlock: %s\n", __func__, state.ToString());
2357 : 0 : return false;
2358 : : }
2359 : :
2360 : : // verify that the view's current state corresponds to the previous block
2361 [ + + ]: 370906 : uint256 hashPrevBlock = pindex->pprev == nullptr ? uint256() : pindex->pprev->GetBlockHash();
2362 [ - + ]: 370906 : assert(hashPrevBlock == view.GetBestBlock());
2363 : :
2364 : 370906 : m_chainman.num_blocks_total++;
2365 : :
2366 : : // Special case for the genesis block, skipping connection of its transactions
2367 : : // (its coinbase is unspendable)
2368 [ + + ]: 370906 : if (block_hash == params.GetConsensus().hashGenesisBlock) {
2369 [ + - ]: 2243 : if (!fJustCheck)
2370 : 2243 : view.SetBestBlock(pindex->GetBlockHash());
2371 : 2243 : return true;
2372 : : }
2373 : :
2374 : 368663 : const char* script_check_reason;
2375 [ + - ]: 737326 : if (m_chainman.AssumedValidBlock().IsNull()) {
2376 : 368663 : script_check_reason = "assumevalid=0 (always verify)";
2377 : : } else {
2378 : 0 : constexpr int64_t TWO_WEEKS_IN_SECONDS{60 * 60 * 24 * 7 * 2};
2379 : : // We've been configured with the hash of a block which has been externally verified to have a valid history.
2380 : : // A suitable default value is included with the software and updated from time to time. Because validity
2381 : : // relative to a piece of software is an objective fact these defaults can be easily reviewed.
2382 : : // This setting doesn't force the selection of any particular chain but makes validating some faster by
2383 : : // effectively caching the result of part of the verification.
2384 [ # # ]: 0 : BlockMap::const_iterator it{m_blockman.m_block_index.find(m_chainman.AssumedValidBlock())};
2385 [ # # ]: 0 : if (it == m_blockman.m_block_index.end()) {
2386 : 0 : script_check_reason = "assumevalid hash not in headers";
2387 [ # # ]: 0 : } else if (it->second.GetAncestor(pindex->nHeight) != pindex) {
2388 [ # # ]: 0 : script_check_reason = (pindex->nHeight > it->second.nHeight) ? "block height above assumevalid height" : "block not in assumevalid chain";
2389 [ # # ]: 0 : } else if (m_chainman.m_best_header->GetAncestor(pindex->nHeight) != pindex) {
2390 : 0 : script_check_reason = "block not in best header chain";
2391 [ # # ]: 0 : } else if (m_chainman.m_best_header->nChainWork < m_chainman.MinimumChainWork()) {
2392 : 0 : script_check_reason = "best header chainwork below minimumchainwork";
2393 [ # # ]: 0 : } else if (GetBlockProofEquivalentTime(*m_chainman.m_best_header, *pindex, *m_chainman.m_best_header, params.GetConsensus()) <= TWO_WEEKS_IN_SECONDS) {
2394 : 0 : script_check_reason = "block too recent relative to best header";
2395 : : } else {
2396 : : // This block is a member of the assumed verified chain and an ancestor of the best header.
2397 : : // Script verification is skipped when connecting blocks under the
2398 : : // assumevalid block. Assuming the assumevalid block is valid this
2399 : : // is safe because block merkle hashes are still computed and checked,
2400 : : // Of course, if an assumed valid block is invalid due to false scriptSigs
2401 : : // this optimization would allow an invalid chain to be accepted.
2402 : : // The equivalent time check discourages hash power from extorting the network via DOS attack
2403 : : // into accepting an invalid block through telling users they must manually set assumevalid.
2404 : : // Requiring a software change or burying the invalid block, regardless of the setting, makes
2405 : : // it hard to hide the implication of the demand. This also avoids having release candidates
2406 : : // that are hardly doing any signature verification at all in testing without having to
2407 : : // artificially set the default assumed verified block further back.
2408 : : // The test against the minimum chain work prevents the skipping when denied access to any chain at
2409 : : // least as good as the expected chain.
2410 : 0 : script_check_reason = nullptr;
2411 : : }
2412 : : }
2413 : :
2414 : 368663 : const auto time_1{SteadyClock::now()};
2415 : 368663 : m_chainman.time_check += time_1 - time_start;
2416 [ + + ]: 368663 : LogDebug(BCLog::BENCH, " - Sanity checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2417 : : Ticks<MillisecondsDouble>(time_1 - time_start),
2418 : : Ticks<SecondsDouble>(m_chainman.time_check),
2419 : : Ticks<MillisecondsDouble>(m_chainman.time_check) / m_chainman.num_blocks_total);
2420 : :
2421 : : // Do not allow blocks that contain transactions which 'overwrite' older transactions,
2422 : : // unless those are already completely spent.
2423 : : // If such overwrites are allowed, coinbases and transactions depending upon those
2424 : : // can be duplicated to remove the ability to spend the first instance -- even after
2425 : : // being sent to another address.
2426 : : // See BIP30, CVE-2012-1909, and https://r6.ca/blog/20120206T005236Z.html for more information.
2427 : : // This rule was originally applied to all blocks with a timestamp after March 15, 2012, 0:00 UTC.
2428 : : // Now that the whole chain is irreversibly beyond that time it is applied to all blocks except the
2429 : : // two in the chain that violate it. This prevents exploiting the issue against nodes during their
2430 : : // initial block download.
2431 : 368663 : bool fEnforceBIP30 = !IsBIP30Repeat(*pindex);
2432 : :
2433 : : // Once BIP34 activated it was not possible to create new duplicate coinbases and thus other than starting
2434 : : // with the 2 existing duplicate coinbase pairs, not possible to create overwriting txs. But by the
2435 : : // time BIP34 activated, in each of the existing pairs the duplicate coinbase had overwritten the first
2436 : : // before the first had been spent. Since those coinbases are sufficiently buried it's no longer possible to create further
2437 : : // duplicate transactions descending from the known pairs either.
2438 : : // If we're on the known chain at height greater than where BIP34 activated, we can save the db accesses needed for the BIP30 check.
2439 : :
2440 : : // BIP34 requires that a block at height X (block X) has its coinbase
2441 : : // scriptSig start with a CScriptNum of X (indicated height X). The above
2442 : : // logic of no longer requiring BIP30 once BIP34 activates is flawed in the
2443 : : // case that there is a block X before the BIP34 height of 227,931 which has
2444 : : // an indicated height Y where Y is greater than X. The coinbase for block
2445 : : // X would also be a valid coinbase for block Y, which could be a BIP30
2446 : : // violation. An exhaustive search of all mainnet coinbases before the
2447 : : // BIP34 height which have an indicated height greater than the block height
2448 : : // reveals many occurrences. The 3 lowest indicated heights found are
2449 : : // 209,921, 490,897, and 1,983,702 and thus coinbases for blocks at these 3
2450 : : // heights would be the first opportunity for BIP30 to be violated.
2451 : :
2452 : : // The search reveals a great many blocks which have an indicated height
2453 : : // greater than 1,983,702, so we simply remove the optimization to skip
2454 : : // BIP30 checking for blocks at height 1,983,702 or higher. Before we reach
2455 : : // that block in another 25 years or so, we should take advantage of a
2456 : : // future consensus change to do a new and improved version of BIP34 that
2457 : : // will actually prevent ever creating any duplicate coinbases in the
2458 : : // future.
2459 : 368663 : static constexpr int BIP34_IMPLIES_BIP30_LIMIT = 1983702;
2460 : :
2461 : : // There is no potential to create a duplicate coinbase at block 209,921
2462 : : // because this is still before the BIP34 height and so explicit BIP30
2463 : : // checking is still active.
2464 : :
2465 : : // The final case is block 176,684 which has an indicated height of
2466 : : // 490,897. Unfortunately, this issue was not discovered until about 2 weeks
2467 : : // before block 490,897 so there was not much opportunity to address this
2468 : : // case other than to carefully analyze it and determine it would not be a
2469 : : // problem. Block 490,897 was, in fact, mined with a different coinbase than
2470 : : // block 176,684, but it is important to note that even if it hadn't been or
2471 : : // is remined on an alternate fork with a duplicate coinbase, we would still
2472 : : // not run into a BIP30 violation. This is because the coinbase for 176,684
2473 : : // is spent in block 185,956 in transaction
2474 : : // d4f7fbbf92f4a3014a230b2dc70b8058d02eb36ac06b4a0736d9d60eaa9e8781. This
2475 : : // spending transaction can't be duplicated because it also spends coinbase
2476 : : // 0328dd85c331237f18e781d692c92de57649529bd5edf1d01036daea32ffde29. This
2477 : : // coinbase has an indicated height of over 4.2 billion, and wouldn't be
2478 : : // duplicatable until that height, and it's currently impossible to create a
2479 : : // chain that long. Nevertheless we may wish to consider a future soft fork
2480 : : // which retroactively prevents block 490,897 from creating a duplicate
2481 : : // coinbase. The two historical BIP30 violations often provide a confusing
2482 : : // edge case when manipulating the UTXO and it would be simpler not to have
2483 : : // another edge case to deal with.
2484 : :
2485 : : // testnet3 has no blocks before the BIP34 height with indicated heights
2486 : : // post BIP34 before approximately height 486,000,000. After block
2487 : : // 1,983,702 testnet3 starts doing unnecessary BIP30 checking again.
2488 [ - + ]: 368663 : assert(pindex->pprev);
2489 : 368663 : CBlockIndex* pindexBIP34height = pindex->pprev->GetAncestor(params.GetConsensus().BIP34Height);
2490 : : //Only continue to enforce if we're below BIP34 activation height or the block hash at that height doesn't correspond.
2491 [ + - + + : 368663 : fEnforceBIP30 = fEnforceBIP30 && (!pindexBIP34height || !(pindexBIP34height->GetBlockHash() == params.GetConsensus().BIP34Hash));
- + ]
2492 : :
2493 : : // TODO: Remove BIP30 checking from block height 1,983,702 on, once we have a
2494 : : // consensus change that ensures coinbases at those heights cannot
2495 : : // duplicate earlier coinbases.
2496 [ # # ]: 0 : if (fEnforceBIP30 || pindex->nHeight >= BIP34_IMPLIES_BIP30_LIMIT) {
2497 [ + + ]: 769282 : for (const auto& tx : block.vtx) {
2498 [ - + + + ]: 1182064 : for (size_t o = 0; o < tx->vout.size(); o++) {
2499 [ + + ]: 781445 : if (view.HaveCoin(COutPoint(tx->GetHash(), o))) {
2500 [ + - + - ]: 644 : state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-BIP30",
2501 : 644 : "tried to overwrite transaction");
2502 : : }
2503 : : }
2504 : : }
2505 : : }
2506 : :
2507 : : // Enforce BIP68 (sequence locks)
2508 : 368663 : int nLockTimeFlags = 0;
2509 [ + - ]: 368663 : if (DeploymentActiveAt(*pindex, m_chainman, Consensus::DEPLOYMENT_CSV)) {
2510 : 368663 : nLockTimeFlags |= LOCKTIME_VERIFY_SEQUENCE;
2511 : : }
2512 : :
2513 : : // Get the script flags for this block
2514 : 368663 : script_verify_flags flags{GetBlockScriptFlags(*pindex, m_chainman)};
2515 : :
2516 : 368663 : const auto time_2{SteadyClock::now()};
2517 : 368663 : m_chainman.time_forks += time_2 - time_1;
2518 [ + + ]: 368663 : LogDebug(BCLog::BENCH, " - Fork checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2519 : : Ticks<MillisecondsDouble>(time_2 - time_1),
2520 : : Ticks<SecondsDouble>(m_chainman.time_forks),
2521 : : Ticks<MillisecondsDouble>(m_chainman.time_forks) / m_chainman.num_blocks_total);
2522 : :
2523 : 368663 : const bool fScriptChecks{!!script_check_reason};
2524 : 368663 : const kernel::ChainstateRole role{GetRole()};
2525 [ + + + - : 368663 : if (script_check_reason != m_last_script_check_reason_logged && role.validated && !role.historical) {
+ - ]
2526 [ + - ]: 1622 : if (fScriptChecks) {
2527 [ + - ]: 3244 : LogInfo("Enabling script verification at block #%d (%s): %s.",
2528 : : pindex->nHeight, block_hash.ToString(), script_check_reason);
2529 : : } else {
2530 [ # # ]: 0 : LogInfo("Disabling script verification at block #%d (%s).",
2531 : : pindex->nHeight, block_hash.ToString());
2532 : : }
2533 : 1622 : m_last_script_check_reason_logged = script_check_reason;
2534 : : }
2535 : :
2536 : 368663 : CBlockUndo blockundo;
2537 : :
2538 : : // Precomputed transaction data pointers must not be invalidated
2539 : : // until after `control` has run the script checks (potentially
2540 : : // in multiple threads). Preallocate the vector size so a new allocation
2541 : : // doesn't invalidate pointers into the vector, and keep txsdata in scope
2542 : : // for as long as `control`.
2543 : 368663 : std::optional<CCheckQueueControl<CScriptCheck>> control;
2544 [ - + - - : 368663 : if (auto& queue = m_chainman.GetCheckQueue(); queue.HasThreads() && fScriptChecks) control.emplace(queue);
- - ]
2545 : :
2546 [ - + + - ]: 368663 : std::vector<PrecomputedTransactionData> txsdata(block.vtx.size());
2547 : :
2548 : 368663 : std::vector<int> prevheights;
2549 : 368663 : CAmount nFees = 0;
2550 : 368663 : int nInputs = 0;
2551 : 368663 : int64_t nSigOpsCost = 0;
2552 [ - + + - ]: 368663 : blockundo.vtxundo.reserve(block.vtx.size() - 1);
2553 [ - + + + ]: 754182 : for (unsigned int i = 0; i < block.vtx.size(); i++)
2554 : : {
2555 [ + + ]: 396370 : if (!state.IsValid()) break;
2556 [ - + ]: 396061 : const CTransaction &tx = *(block.vtx[i]);
2557 : :
2558 [ - + ]: 396061 : nInputs += tx.vin.size();
2559 : :
2560 [ + + ]: 396061 : if (!tx.IsCoinBase())
2561 : : {
2562 : 27707 : CAmount txfee = 0;
2563 [ + - ]: 27707 : TxValidationState tx_state;
2564 [ + - + + ]: 27707 : if (!Consensus::CheckTxInputs(tx, tx_state, view, pindex->nHeight, txfee)) {
2565 : : // Any transaction validation failure in ConnectBlock is a block consensus failure
2566 : 21084 : state.Invalid(BlockValidationResult::BLOCK_CONSENSUS,
2567 [ + - ]: 21084 : tx_state.GetRejectReason(),
2568 [ + - - + : 42168 : tx_state.GetDebugMessage() + " in transaction " + tx.GetHash().ToString());
+ - + - ]
2569 : 10542 : break;
2570 : : }
2571 : 17165 : nFees += txfee;
2572 [ - + ]: 17165 : if (!MoneyRange(nFees)) {
2573 [ # # # # ]: 0 : state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-accumulated-fee-outofrange",
2574 [ # # ]: 0 : "accumulated fee in the block out of range");
2575 : 0 : break;
2576 : : }
2577 : :
2578 : : // Check that transaction is BIP68 final
2579 : : // BIP68 lock checks (as opposed to nLockTime checks) must
2580 : : // be in ConnectBlock because they require the UTXO set
2581 [ - + + - ]: 17165 : prevheights.resize(tx.vin.size());
2582 [ - + + + ]: 39630 : for (size_t j = 0; j < tx.vin.size(); j++) {
2583 [ + - ]: 22465 : prevheights[j] = view.AccessCoin(tx.vin[j].prevout).nHeight;
2584 : : }
2585 : :
2586 [ + - - + ]: 17165 : if (!SequenceLocks(tx, nLockTimeFlags, prevheights, *pindex)) {
2587 [ # # # # ]: 0 : state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-nonfinal",
2588 [ # # # # ]: 0 : "contains a non-BIP68-final transaction " + tx.GetHash().ToString());
2589 : 0 : break;
2590 : : }
2591 : 27707 : }
2592 : :
2593 : : // GetTransactionSigOpCost counts 3 types of sigops:
2594 : : // * legacy (always)
2595 : : // * p2sh (when P2SH enabled in flags and excludes coinbase)
2596 : : // * witness (when witness enabled in flags and excludes coinbase)
2597 [ + - ]: 385519 : nSigOpsCost += GetTransactionSigOpCost(tx, view, flags);
2598 [ - + ]: 385519 : if (nSigOpsCost > MAX_BLOCK_SIGOPS_COST) {
2599 [ # # # # : 0 : state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-sigops", "too many sigops");
# # ]
2600 : 0 : break;
2601 : : }
2602 : :
2603 [ + + + - ]: 385519 : if (!tx.IsCoinBase() && fScriptChecks)
2604 : : {
2605 : 17165 : bool fCacheResults = fJustCheck; /* Don't cache results if we're actually connecting blocks (still consult the cache, though) */
2606 : 17165 : bool tx_ok;
2607 [ - + ]: 17165 : TxValidationState tx_state;
2608 : : // If CheckInputScripts is called with a pointer to a checks vector, the resulting checks are appended to it. In that case
2609 : : // they need to be added to control which runs them asynchronously. Otherwise, CheckInputScripts runs the checks before returning.
2610 [ - + ]: 17165 : if (control) {
2611 : 0 : std::vector<CScriptCheck> vChecks;
2612 [ # # ]: 0 : tx_ok = CheckInputScripts(tx, tx_state, view, flags, fCacheResults, fCacheResults, txsdata[i], m_chainman.m_validation_cache, &vChecks);
2613 [ # # # # ]: 0 : if (tx_ok) control->Add(std::move(vChecks));
2614 : 0 : } else {
2615 [ + - ]: 17165 : tx_ok = CheckInputScripts(tx, tx_state, view, flags, fCacheResults, fCacheResults, txsdata[i], m_chainman.m_validation_cache);
2616 : : }
2617 [ - + ]: 17165 : if (!tx_ok) {
2618 : : // Any transaction validation failure in ConnectBlock is a block consensus failure
2619 [ # # ]: 0 : state.Invalid(BlockValidationResult::BLOCK_CONSENSUS,
2620 [ # # # # ]: 0 : tx_state.GetRejectReason(), tx_state.GetDebugMessage());
2621 : 0 : break;
2622 : : }
2623 : 17165 : }
2624 : :
2625 : 385519 : CTxUndo undoDummy;
2626 [ + + ]: 385519 : if (i > 0) {
2627 [ + - ]: 17165 : blockundo.vtxundo.emplace_back();
2628 : : }
2629 [ + + + - ]: 385519 : UpdateCoins(tx, view, i == 0 ? undoDummy : blockundo.vtxundo.back(), pindex->nHeight);
2630 : 385519 : }
2631 : 368663 : const auto time_3{SteadyClock::now()};
2632 [ + - ]: 368663 : m_chainman.time_connect += time_3 - time_2;
2633 [ + - + + : 368663 : LogDebug(BCLog::BENCH, " - Connect %u transactions: %.2fms (%.3fms/tx, %.3fms/txin) [%.2fs (%.2fms/blk)]\n", (unsigned)block.vtx.size(),
+ + - + +
- ]
2634 : : Ticks<MillisecondsDouble>(time_3 - time_2), Ticks<MillisecondsDouble>(time_3 - time_2) / block.vtx.size(),
2635 : : nInputs <= 1 ? 0 : Ticks<MillisecondsDouble>(time_3 - time_2) / (nInputs - 1),
2636 : : Ticks<SecondsDouble>(m_chainman.time_connect),
2637 : : Ticks<MillisecondsDouble>(m_chainman.time_connect) / m_chainman.num_blocks_total);
2638 : :
2639 [ + - ]: 368663 : CAmount blockReward = nFees + GetBlockSubsidy(pindex->nHeight, params.GetConsensus());
2640 [ + - - + : 368663 : if (block.vtx[0]->GetValueOut() > blockReward && state.IsValid()) {
- - ]
2641 [ # # # # ]: 0 : state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-amount",
2642 [ # # # # ]: 0 : strprintf("coinbase pays too much (actual=%d vs limit=%d)", block.vtx[0]->GetValueOut(), blockReward));
2643 : : }
2644 [ - + ]: 368663 : if (control) {
2645 [ # # ]: 0 : auto parallel_result = control->Complete();
2646 [ # # # # ]: 0 : if (parallel_result.has_value() && state.IsValid()) {
2647 [ # # # # : 0 : state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, strprintf("block-script-verify-flag-failed (%s)", ScriptErrorString(parallel_result->first)), parallel_result->second);
# # ]
2648 : : }
2649 : 0 : }
2650 [ + + ]: 368663 : if (!state.IsValid()) {
2651 [ + - + - ]: 10851 : LogInfo("Block validation error: %s", state.ToString());
2652 : 10851 : return false;
2653 : : }
2654 : 357812 : const auto time_4{SteadyClock::now()};
2655 [ + - ]: 357812 : m_chainman.time_verify += time_4 - time_2;
2656 [ + - + + : 357812 : LogDebug(BCLog::BENCH, " - Verify %u txins: %.2fms (%.3fms/txin) [%.2fs (%.2fms/blk)]\n", nInputs - 1,
+ + + - ]
2657 : : Ticks<MillisecondsDouble>(time_4 - time_2),
2658 : : nInputs <= 1 ? 0 : Ticks<MillisecondsDouble>(time_4 - time_2) / (nInputs - 1),
2659 : : Ticks<SecondsDouble>(m_chainman.time_verify),
2660 : : Ticks<MillisecondsDouble>(m_chainman.time_verify) / m_chainman.num_blocks_total);
2661 : :
2662 [ + + ]: 357812 : if (fJustCheck) {
2663 : : return true;
2664 : : }
2665 : :
2666 [ + - + - ]: 160330 : if (!m_blockman.WriteBlockUndo(blockundo, state, *pindex)) {
2667 : : return false;
2668 : : }
2669 : :
2670 : 160330 : const auto time_5{SteadyClock::now()};
2671 [ + - ]: 160330 : m_chainman.time_undo += time_5 - time_4;
2672 [ + - + + : 160330 : LogDebug(BCLog::BENCH, " - Write undo data: %.2fms [%.2fs (%.2fms/blk)]\n",
+ - ]
2673 : : Ticks<MillisecondsDouble>(time_5 - time_4),
2674 : : Ticks<SecondsDouble>(m_chainman.time_undo),
2675 : : Ticks<MillisecondsDouble>(m_chainman.time_undo) / m_chainman.num_blocks_total);
2676 : :
2677 [ + - + - ]: 160330 : if (!pindex->IsValid(BLOCK_VALID_SCRIPTS)) {
2678 : 160330 : pindex->RaiseValidity(BLOCK_VALID_SCRIPTS);
2679 [ + - ]: 160330 : m_blockman.m_dirty_blockindex.insert(pindex);
2680 : : }
2681 : :
2682 : : // add this block to the view's block chain
2683 [ + - ]: 160330 : view.SetBestBlock(pindex->GetBlockHash());
2684 : :
2685 : 160330 : const auto time_6{SteadyClock::now()};
2686 [ + - ]: 160330 : m_chainman.time_index += time_6 - time_5;
2687 [ + - + + : 160330 : LogDebug(BCLog::BENCH, " - Index writing: %.2fms [%.2fs (%.2fms/blk)]\n",
+ - ]
2688 : : Ticks<MillisecondsDouble>(time_6 - time_5),
2689 : : Ticks<SecondsDouble>(m_chainman.time_index),
2690 : : Ticks<MillisecondsDouble>(m_chainman.time_index) / m_chainman.num_blocks_total);
2691 : :
2692 : : TRACEPOINT(validation, block_connected,
2693 : : block_hash.data(),
2694 : : pindex->nHeight,
2695 : : block.vtx.size(),
2696 : : nInputs,
2697 : : nSigOpsCost,
2698 : : Ticks<std::chrono::nanoseconds>(time_5 - time_start)
2699 : : );
2700 : :
2701 : : return true;
2702 : 368663 : }
2703 : :
2704 : 2343300 : CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState()
2705 : : {
2706 : 2343300 : AssertLockHeld(::cs_main);
2707 : 2343300 : return this->GetCoinsCacheSizeState(
2708 : : m_coinstip_cache_size_bytes,
2709 [ + + ]: 2343300 : m_mempool ? m_mempool->m_opts.max_size_bytes : 0);
2710 : : }
2711 : :
2712 : 2343300 : CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState(
2713 : : size_t max_coins_cache_size_bytes,
2714 : : size_t max_mempool_size_bytes)
2715 : : {
2716 : 2343300 : AssertLockHeld(::cs_main);
2717 [ + + ]: 2343300 : const int64_t nMempoolUsage = m_mempool ? m_mempool->DynamicMemoryUsage() : 0;
2718 : 2343300 : int64_t cacheSize = CoinsTip().DynamicMemoryUsage();
2719 : 2343300 : int64_t nTotalSpace =
2720 [ + + ]: 2343300 : max_coins_cache_size_bytes + std::max<int64_t>(int64_t(max_mempool_size_bytes) - nMempoolUsage, 0);
2721 : :
2722 [ - + ]: 2343300 : if (cacheSize > nTotalSpace) {
2723 : 0 : LogInfo("Cache size (%s) exceeds total space (%s)\n", cacheSize, nTotalSpace);
2724 : 0 : return CoinsCacheSizeState::CRITICAL;
2725 [ + + - + ]: 2343334 : } else if (cacheSize > LargeCoinsCacheThreshold(nTotalSpace)) {
2726 : 0 : return CoinsCacheSizeState::LARGE;
2727 : : }
2728 : : return CoinsCacheSizeState::OK;
2729 : : }
2730 : :
2731 : 2343300 : bool Chainstate::FlushStateToDisk(
2732 : : BlockValidationState &state,
2733 : : FlushStateMode mode,
2734 : : int nManualPruneHeight)
2735 : : {
2736 : 2343300 : LOCK(cs_main);
2737 [ + - ]: 2343300 : assert(this->CanFlushToDisk());
2738 [ + - ]: 2343300 : std::set<int> setFilesToPrune;
2739 : 2343300 : bool full_flush_completed = false;
2740 : :
2741 [ + - + - ]: 2343300 : const size_t coins_count = CoinsTip().GetCacheSize();
2742 [ + - + - ]: 2343300 : const size_t coins_mem_usage = CoinsTip().DynamicMemoryUsage();
2743 : :
2744 : 2343300 : try {
2745 : 2343300 : {
2746 : 2343300 : bool fFlushForPrune = false;
2747 : :
2748 [ + - ]: 2343300 : CoinsCacheSizeState cache_state = GetCoinsCacheSizeState();
2749 [ + - ]: 2343300 : LOCK(m_blockman.cs_LastBlockFile);
2750 [ - + - - : 2343300 : if (m_blockman.IsPruneMode() && (m_blockman.m_check_for_pruning || nManualPruneHeight > 0) && m_chainman.m_blockman.m_blockfiles_indexed) {
- - - - ]
2751 : : // make sure we don't prune above any of the prune locks bestblocks
2752 : : // pruning is height-based
2753 [ # # ]: 0 : int last_prune{m_chain.Height()}; // last height we can prune
2754 : 0 : std::optional<std::string> limiting_lock; // prune lock that actually was the limiting factor, only used for logging
2755 : :
2756 [ # # # # ]: 0 : for (const auto& prune_lock : m_blockman.m_prune_locks) {
2757 [ # # ]: 0 : if (prune_lock.second.height_first == std::numeric_limits<int>::max()) continue;
2758 : : // Remove the buffer and one additional block here to get actual height that is outside of the buffer
2759 : 0 : const int lock_height{prune_lock.second.height_first - PRUNE_LOCK_BUFFER - 1};
2760 [ # # # # ]: 0 : last_prune = std::max(1, std::min(last_prune, lock_height));
2761 [ # # ]: 0 : if (last_prune == lock_height) {
2762 [ # # ]: 0 : limiting_lock = prune_lock.first;
2763 : : }
2764 : : }
2765 : :
2766 [ # # ]: 0 : if (limiting_lock) {
2767 [ # # # # : 0 : LogDebug(BCLog::PRUNE, "%s limited pruning to height %d\n", limiting_lock.value(), last_prune);
# # # # ]
2768 : : }
2769 : :
2770 [ # # ]: 0 : if (nManualPruneHeight > 0) {
2771 [ # # # # : 0 : LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune (manual)", BCLog::BENCH);
# # ]
2772 : :
2773 [ # # ]: 0 : m_blockman.FindFilesToPruneManual(
2774 : : setFilesToPrune,
2775 [ # # ]: 0 : std::min(last_prune, nManualPruneHeight),
2776 : : *this);
2777 : 0 : } else {
2778 [ # # # # : 0 : LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune", BCLog::BENCH);
# # ]
2779 : :
2780 [ # # ]: 0 : m_blockman.FindFilesToPrune(setFilesToPrune, last_prune, *this, m_chainman);
2781 : 0 : m_blockman.m_check_for_pruning = false;
2782 : 0 : }
2783 [ # # ]: 0 : if (!setFilesToPrune.empty()) {
2784 : 0 : fFlushForPrune = true;
2785 [ # # ]: 0 : if (!m_blockman.m_have_pruned) {
2786 [ # # # # ]: 0 : m_blockman.m_block_tree_db->WriteFlag("prunedblockfiles", true);
2787 : 0 : m_blockman.m_have_pruned = true;
2788 : : }
2789 : : }
2790 : 0 : }
2791 : 2343300 : const auto nNow{NodeClock::now()};
2792 : : // The cache is large and we're within 10% and 10 MiB of the limit, but we have time now (not in the middle of a block processing).
2793 : 2343300 : bool fCacheLarge = mode == FlushStateMode::PERIODIC && cache_state >= CoinsCacheSizeState::LARGE;
2794 : : // The cache is over the limit, we have to write now.
2795 : 2343300 : bool fCacheCritical = mode == FlushStateMode::IF_NEEDED && cache_state >= CoinsCacheSizeState::CRITICAL;
2796 : : // It's been a while since we wrote the block index and chain state to disk. Do this frequently, so we don't need to redownload or reindex after a crash.
2797 [ + + + + ]: 2343300 : bool fPeriodicWrite = mode == FlushStateMode::PERIODIC && nNow >= m_next_write;
2798 : : // Combine all conditions that result in a write to disk.
2799 [ + + + + : 2343300 : bool should_write = (mode == FlushStateMode::ALWAYS) || fCacheLarge || fCacheCritical || fPeriodicWrite || fFlushForPrune;
- + ]
2800 : : // Write blocks, block index and best chain related state to disk.
2801 : 2230090 : if (should_write) {
2802 [ + - + + : 113210 : LogDebug(BCLog::COINDB, "Writing chainstate to disk: flush mode=%s, prune=%d, large=%d, critical=%d, periodic=%d",
+ - ]
2803 : : FlushStateModeNames[size_t(mode)], fFlushForPrune, fCacheLarge, fCacheCritical, fPeriodicWrite);
2804 : :
2805 : : // Ensure we can write block index
2806 [ + - - + ]: 113210 : if (!CheckDiskSpace(m_blockman.m_opts.blocks_dir)) {
2807 [ # # # # ]: 0 : return FatalError(m_chainman.GetNotifications(), state, _("Disk space is too low!"));
2808 : : }
2809 : 113210 : {
2810 [ + - + - : 226420 : LOG_TIME_MILLIS_WITH_CATEGORY("write block and undo data to disk", BCLog::BENCH);
+ - ]
2811 : :
2812 : : // First make sure all block and undo data is flushed to disk.
2813 : : // TODO: Handle return error, or add detailed comment why it is
2814 : : // safe to not return an error upon failure.
2815 [ - + + - : 113210 : if (!m_blockman.FlushChainstateBlockFile(m_chain.Height())) {
- + ]
2816 [ # # ]: 0 : LogWarning("%s: Failed to flush block file.\n", __func__);
2817 : : }
2818 : 113210 : }
2819 : :
2820 : : // Then update all block file information (which may refer to block and undo files).
2821 : 113210 : {
2822 [ + - + - : 226420 : LOG_TIME_MILLIS_WITH_CATEGORY("write block index to disk", BCLog::BENCH);
+ - ]
2823 : :
2824 [ + - ]: 113210 : m_blockman.WriteBlockIndexDB();
2825 : 113210 : }
2826 : : // Finally remove any pruned files
2827 [ - + ]: 113210 : if (fFlushForPrune) {
2828 [ # # # # : 0 : LOG_TIME_MILLIS_WITH_CATEGORY("unlink pruned files", BCLog::BENCH);
# # ]
2829 : :
2830 [ # # ]: 0 : m_blockman.UnlinkPrunedFiles(setFilesToPrune);
2831 : 0 : }
2832 : :
2833 [ + - + - : 226420 : if (!CoinsTip().GetBestBlock().IsNull()) {
+ - ]
2834 [ - + - - ]: 113210 : if (coins_mem_usage >= WARN_FLUSH_COINS_SIZE) LogWarning("Flushing large (%d GiB) UTXO set to disk, it may take several minutes", coins_mem_usage >> 30);
2835 [ + - + - : 226420 : LOG_TIME_MILLIS_WITH_CATEGORY(strprintf("write coins cache to disk (%d coins, %.2fKiB)",
+ - ]
2836 : : coins_count, coins_mem_usage >> 10), BCLog::BENCH);
2837 : :
2838 : : // Typical Coin structures on disk are around 48 bytes in size.
2839 : : // Pushing a new one to the database can cause it to be written
2840 : : // twice (once in the log, and once in the tables). This is already
2841 : : // an overestimation, as most will delete an existing entry or
2842 : : // overwrite one. Still, use a conservative safety factor of 2.
2843 [ + - + - : 113210 : if (!CheckDiskSpace(m_chainman.m_options.datadir, 48 * 2 * 2 * CoinsTip().GetCacheSize())) {
+ - - + ]
2844 [ # # # # ]: 0 : return FatalError(m_chainman.GetNotifications(), state, _("Disk space is too low!"));
2845 : : }
2846 : : // Flush the chainstate (which may refer to block index entries).
2847 [ + + + - : 113210 : const auto empty_cache{(mode == FlushStateMode::ALWAYS) || fCacheLarge || fCacheCritical};
+ - ]
2848 [ + - + - : 113210 : empty_cache ? CoinsTip().Flush() : CoinsTip().Sync();
+ - + - ]
2849 : 113210 : full_flush_completed = true;
2850 : : TRACEPOINT(utxocache, flush,
2851 : : int64_t{Ticks<std::chrono::microseconds>(NodeClock::now() - nNow)},
2852 : : (uint32_t)mode,
2853 : : (uint64_t)coins_count,
2854 : : (uint64_t)coins_mem_usage,
2855 : 113210 : (bool)fFlushForPrune);
2856 : 113210 : }
2857 : : }
2858 : :
2859 [ + + ]: 2230090 : if (should_write || m_next_write == NodeClock::time_point::max()) {
2860 : 115453 : constexpr auto range{DATABASE_WRITE_INTERVAL_MAX - DATABASE_WRITE_INTERVAL_MIN};
2861 : 115453 : m_next_write = FastRandomContext().rand_uniform_delay(NodeClock::now() + DATABASE_WRITE_INTERVAL_MIN, range);
2862 : : }
2863 : 0 : }
2864 [ + + + + ]: 2343300 : if (full_flush_completed && m_chainman.m_options.signals) {
2865 : : // Update best block in wallet (so we can detect restored wallets).
2866 [ - + + - : 332868 : m_chainman.m_options.signals->ChainStateFlushed(this->GetRole(), GetLocator(m_chain.Tip()));
+ - + - ]
2867 : : }
2868 [ - - ]: 0 : } catch (const std::runtime_error& e) {
2869 [ - - - - ]: 0 : return FatalError(m_chainman.GetNotifications(), state, strprintf(_("System error while flushing: %s"), e.what()));
2870 : 0 : }
2871 : : return true;
2872 [ + - ]: 4686600 : }
2873 : :
2874 : 110846 : void Chainstate::ForceFlushStateToDisk()
2875 : : {
2876 [ + - ]: 110846 : BlockValidationState state;
2877 [ + - - + ]: 110846 : if (!this->FlushStateToDisk(state, FlushStateMode::ALWAYS)) {
2878 [ # # # # ]: 0 : LogWarning("Failed to force flush state (%s)", state.ToString());
2879 : : }
2880 : 110846 : }
2881 : :
2882 : 0 : void Chainstate::PruneAndFlush()
2883 : : {
2884 [ # # ]: 0 : BlockValidationState state;
2885 : 0 : m_blockman.m_check_for_pruning = true;
2886 [ # # # # ]: 0 : if (!this->FlushStateToDisk(state, FlushStateMode::NONE)) {
2887 [ # # # # ]: 0 : LogWarning("Failed to flush state (%s)", state.ToString());
2888 : : }
2889 : 0 : }
2890 : :
2891 : 162573 : static void UpdateTipLog(
2892 : : const ChainstateManager& chainman,
2893 : : const CCoinsViewCache& coins_tip,
2894 : : const CBlockIndex* tip,
2895 : : const std::string& func_name,
2896 : : const std::string& prefix,
2897 : : const std::string& warning_messages) EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
2898 : : {
2899 : :
2900 : 162573 : AssertLockHeld(::cs_main);
2901 : :
2902 : : // Disable rate limiting in LogPrintLevel_ so this source location may log during IBD.
2903 [ - + + - : 325146 : LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/false, "%s%s: new best=%s height=%d version=0x%08x log2_work=%f tx=%lu date='%s' progress=%f cache=%.1fMiB(%utxo)%s\n",
+ - + - +
- + - + -
+ - ]
2904 : : prefix, func_name,
2905 : : tip->GetBlockHash().ToString(), tip->nHeight, tip->nVersion,
2906 : : log(tip->nChainWork.getdouble()) / log(2.0), tip->m_chain_tx_count,
2907 : : FormatISO8601DateTime(tip->GetBlockTime()),
2908 : : chainman.GuessVerificationProgress(tip),
2909 : : coins_tip.DynamicMemoryUsage() * (1.0 / (1 << 20)),
2910 : : coins_tip.GetCacheSize(),
2911 : : !warning_messages.empty() ? strprintf(" warning='%s'", warning_messages) : "");
2912 : 162573 : }
2913 : :
2914 : 162573 : void Chainstate::UpdateTip(const CBlockIndex* pindexNew)
2915 : : {
2916 : 162573 : AssertLockHeld(::cs_main);
2917 : 162573 : const auto& coins_tip = this->CoinsTip();
2918 : :
2919 : : // The remainder of the function isn't relevant if we are not acting on
2920 : : // the active chainstate, so return if need be.
2921 [ - + ]: 162573 : if (this != &m_chainman.ActiveChainstate()) {
2922 : : // Only log every so often so that we don't bury log messages at the tip.
2923 : 0 : constexpr int BACKGROUND_LOG_INTERVAL = 2000;
2924 [ # # ]: 0 : if (pindexNew->nHeight % BACKGROUND_LOG_INTERVAL == 0) {
2925 [ # # # # : 0 : UpdateTipLog(m_chainman, coins_tip, pindexNew, __func__, "[background validation] ", "");
# # ]
2926 : : }
2927 : 0 : return;
2928 : : }
2929 : :
2930 : : // New best block
2931 [ + - ]: 162573 : if (m_mempool) {
2932 : 162573 : m_mempool->AddTransactionsUpdated(1);
2933 : : }
2934 : :
2935 : 162573 : std::vector<bilingual_str> warning_messages;
2936 [ + - + + ]: 162573 : if (!m_chainman.IsInitialBlockDownload()) {
2937 [ + - ]: 87503 : auto bits = m_chainman.m_versionbitscache.CheckUnknownActivations(pindexNew, m_chainman.GetParams());
2938 [ - - - + ]: 87503 : for (auto [bit, active] : bits) {
2939 [ # # ]: 0 : const bilingual_str warning = strprintf(_("Unknown new rules activated (versionbit %i)"), bit);
2940 [ # # ]: 0 : if (active) {
2941 [ # # ]: 0 : m_chainman.GetNotifications().warningSet(kernel::Warning::UNKNOWN_NEW_RULES_ACTIVATED, warning);
2942 : : } else {
2943 [ # # ]: 0 : warning_messages.push_back(warning);
2944 : : }
2945 : 0 : }
2946 : 87503 : }
2947 [ + - + - : 325146 : UpdateTipLog(m_chainman, coins_tip, pindexNew, __func__, "",
+ - ]
2948 [ + - + - : 487719 : util::Join(warning_messages, Untranslated(", ")).original);
+ - ]
2949 : 162573 : }
2950 : :
2951 : : /** Disconnect m_chain's tip.
2952 : : * After calling, the mempool will be in an inconsistent state, with
2953 : : * transactions from disconnected blocks being added to disconnectpool. You
2954 : : * should make the mempool consistent again by calling MaybeUpdateMempoolForReorg.
2955 : : * with cs_main held.
2956 : : *
2957 : : * If disconnectpool is nullptr, then no disconnected transactions are added to
2958 : : * disconnectpool (note that the caller is responsible for mempool consistency
2959 : : * in any case).
2960 : : */
2961 : 0 : bool Chainstate::DisconnectTip(BlockValidationState& state, DisconnectedBlockTransactions* disconnectpool)
2962 : : {
2963 : 0 : AssertLockHeld(cs_main);
2964 : 0 : if (m_mempool) AssertLockHeld(m_mempool->cs);
2965 : :
2966 [ # # ]: 0 : CBlockIndex *pindexDelete = m_chain.Tip();
2967 [ # # ]: 0 : assert(pindexDelete);
2968 [ # # ]: 0 : assert(pindexDelete->pprev);
2969 : : // Read block from disk.
2970 : 0 : std::shared_ptr<CBlock> pblock = std::make_shared<CBlock>();
2971 [ # # ]: 0 : CBlock& block = *pblock;
2972 [ # # # # ]: 0 : if (!m_blockman.ReadBlock(block, *pindexDelete)) {
2973 [ # # ]: 0 : LogError("DisconnectTip(): Failed to read block\n");
2974 : : return false;
2975 : : }
2976 : : // Apply the block atomically to the chain state.
2977 : 0 : const auto time_start{SteadyClock::now()};
2978 : 0 : {
2979 [ # # # # ]: 0 : CCoinsViewCache view(&CoinsTip());
2980 [ # # # # ]: 0 : assert(view.GetBestBlock() == pindexDelete->GetBlockHash());
2981 [ # # # # ]: 0 : if (DisconnectBlock(block, pindexDelete, view) != DISCONNECT_OK) {
2982 [ # # # # ]: 0 : LogError("DisconnectTip(): DisconnectBlock %s failed\n", pindexDelete->GetBlockHash().ToString());
2983 : 0 : return false;
2984 : : }
2985 [ # # ]: 0 : view.Flush(/*will_reuse_cache=*/false); // local CCoinsViewCache goes out of scope
2986 : 0 : }
2987 [ # # # # : 0 : LogDebug(BCLog::BENCH, "- Disconnect block: %.2fms\n",
# # ]
2988 : : Ticks<MillisecondsDouble>(SteadyClock::now() - time_start));
2989 : :
2990 : 0 : {
2991 : : // Prune locks that began at or after the tip should be moved backward so they get a chance to reorg
2992 : 0 : const int max_height_first{pindexDelete->nHeight - 1};
2993 [ # # # # ]: 0 : for (auto& prune_lock : m_blockman.m_prune_locks) {
2994 [ # # ]: 0 : if (prune_lock.second.height_first <= max_height_first) continue;
2995 : :
2996 : 0 : prune_lock.second.height_first = max_height_first;
2997 [ # # # # : 0 : LogDebug(BCLog::PRUNE, "%s prune lock moved back to %d\n", prune_lock.first, max_height_first);
# # ]
2998 : : }
2999 : : }
3000 : :
3001 : : // Write the chain state to disk, if necessary.
3002 [ # # # # ]: 0 : if (!FlushStateToDisk(state, FlushStateMode::IF_NEEDED)) {
3003 : : return false;
3004 : : }
3005 : :
3006 [ # # # # ]: 0 : if (disconnectpool && m_mempool) {
3007 : : // Save transactions to re-add to mempool at end of reorg. If any entries are evicted for
3008 : : // exceeding memory limits, remove them and their descendants from the mempool.
3009 [ # # # # ]: 0 : for (auto&& evicted_tx : disconnectpool->AddTransactionsFromBlock(block.vtx)) {
3010 [ # # ]: 0 : m_mempool->removeRecursive(*evicted_tx, MemPoolRemovalReason::REORG);
3011 : : }
3012 : : }
3013 : :
3014 [ # # ]: 0 : m_chain.SetTip(*pindexDelete->pprev);
3015 : :
3016 [ # # ]: 0 : UpdateTip(pindexDelete->pprev);
3017 : : // Let wallets know transactions went from 1-confirmed to
3018 : : // 0-confirmed or conflicted:
3019 [ # # ]: 0 : if (m_chainman.m_options.signals) {
3020 [ # # # # ]: 0 : m_chainman.m_options.signals->BlockDisconnected(pblock, pindexDelete);
3021 : : }
3022 : : return true;
3023 : 0 : }
3024 : :
3025 [ - + + + : 681805 : struct PerBlockConnectTrace {
- + ]
3026 : : CBlockIndex* pindex = nullptr;
3027 : : std::shared_ptr<const CBlock> pblock;
3028 : 356659 : PerBlockConnectTrace() = default;
3029 : : };
3030 : : /**
3031 : : * Used to track blocks whose transactions were applied to the UTXO state as a
3032 : : * part of a single ActivateBestChainStep call.
3033 : : *
3034 : : * This class is single-use, once you call GetBlocksConnected() you have to throw
3035 : : * it away and make a new one.
3036 : : */
3037 : 20662 : class ConnectTrace {
3038 : : private:
3039 : : std::vector<PerBlockConnectTrace> blocksConnected;
3040 : :
3041 : : public:
3042 : 194086 : explicit ConnectTrace() : blocksConnected(1) {}
3043 : :
3044 : 162573 : void BlockConnected(CBlockIndex* pindex, std::shared_ptr<const CBlock> pblock) {
3045 [ - + ]: 162573 : assert(!blocksConnected.back().pindex);
3046 [ - + ]: 162573 : assert(pindex);
3047 [ - + ]: 162573 : assert(pblock);
3048 : 162573 : blocksConnected.back().pindex = pindex;
3049 : 162573 : blocksConnected.back().pblock = std::move(pblock);
3050 : 162573 : blocksConnected.emplace_back();
3051 : 162573 : }
3052 : :
3053 : 173424 : std::vector<PerBlockConnectTrace>& GetBlocksConnected() {
3054 : : // We always keep one extra block at the end of our list because
3055 : : // blocks are added after all the conflicted transactions have
3056 : : // been filled in. Thus, the last entry should always be an empty
3057 : : // one waiting for the transactions from the next block. We pop
3058 : : // the last entry here to make sure the list we return is sane.
3059 [ - + ]: 173424 : assert(!blocksConnected.back().pindex);
3060 : 173424 : blocksConnected.pop_back();
3061 : 173424 : return blocksConnected;
3062 : : }
3063 : : };
3064 : :
3065 : : /**
3066 : : * Connect a new block to m_chain. block_to_connect is either nullptr or a pointer to a CBlock
3067 : : * corresponding to pindexNew, to bypass loading it again from disk.
3068 : : *
3069 : : * The block is added to connectTrace if connection succeeds.
3070 : : */
3071 : 173424 : bool Chainstate::ConnectTip(
3072 : : BlockValidationState& state,
3073 : : CBlockIndex* pindexNew,
3074 : : std::shared_ptr<const CBlock> block_to_connect,
3075 : : ConnectTrace& connectTrace,
3076 : : DisconnectedBlockTransactions& disconnectpool)
3077 : : {
3078 : 173424 : AssertLockHeld(cs_main);
3079 : 173424 : if (m_mempool) AssertLockHeld(m_mempool->cs);
3080 : :
3081 [ - + - + ]: 346848 : assert(pindexNew->pprev == m_chain.Tip());
3082 : : // Read block from disk.
3083 : 173424 : const auto time_1{SteadyClock::now()};
3084 [ + + ]: 173424 : if (!block_to_connect) {
3085 : 2243 : std::shared_ptr<CBlock> pblockNew = std::make_shared<CBlock>();
3086 [ + - - + ]: 2243 : if (!m_blockman.ReadBlock(*pblockNew, *pindexNew)) {
3087 [ # # # # : 0 : return FatalError(m_chainman.GetNotifications(), state, _("Failed to read block."));
# # ]
3088 : : }
3089 [ - + ]: 2243 : block_to_connect = std::move(pblockNew);
3090 : 2243 : } else {
3091 [ + + ]: 171181 : LogDebug(BCLog::BENCH, " - Using cached block\n");
3092 : : }
3093 : : // Apply the block atomically to the chain state.
3094 : 173424 : const auto time_2{SteadyClock::now()};
3095 : 173424 : SteadyClock::time_point time_3;
3096 : : // When adding aggregate statistics in the future, keep in mind that
3097 : : // num_blocks_total may be zero until the ConnectBlock() call below.
3098 [ + + ]: 173424 : LogDebug(BCLog::BENCH, " - Load block from disk: %.2fms\n",
3099 : : Ticks<MillisecondsDouble>(time_2 - time_1));
3100 : 173424 : {
3101 : 173424 : CCoinsViewCache view(&CoinsTip());
3102 [ + - ]: 173424 : bool rv = ConnectBlock(*block_to_connect, state, pindexNew, view);
3103 [ + + ]: 173424 : if (m_chainman.m_options.signals) {
3104 [ + - ]: 172821 : m_chainman.m_options.signals->BlockChecked(block_to_connect, state);
3105 : : }
3106 [ + + ]: 173424 : if (!rv) {
3107 [ + - ]: 10851 : if (state.IsInvalid())
3108 [ + - ]: 10851 : InvalidBlockFound(pindexNew, state);
3109 [ + - + - : 21702 : LogError("%s: ConnectBlock %s failed, %s\n", __func__, pindexNew->GetBlockHash().ToString(), state.ToString());
+ - ]
3110 : 10851 : return false;
3111 : : }
3112 : 162573 : time_3 = SteadyClock::now();
3113 [ - + ]: 162573 : m_chainman.time_connect_total += time_3 - time_2;
3114 [ - + ]: 162573 : assert(m_chainman.num_blocks_total > 0);
3115 [ + - + + : 162573 : LogDebug(BCLog::BENCH, " - Connect total: %.2fms [%.2fs (%.2fms/blk)]\n",
+ - ]
3116 : : Ticks<MillisecondsDouble>(time_3 - time_2),
3117 : : Ticks<SecondsDouble>(m_chainman.time_connect_total),
3118 : : Ticks<MillisecondsDouble>(m_chainman.time_connect_total) / m_chainman.num_blocks_total);
3119 [ + - ]: 162573 : view.Flush(/*will_reuse_cache=*/false); // local CCoinsViewCache goes out of scope
3120 : 173424 : }
3121 : 162573 : const auto time_4{SteadyClock::now()};
3122 : 162573 : m_chainman.time_flush += time_4 - time_3;
3123 [ + + ]: 162573 : LogDebug(BCLog::BENCH, " - Flush: %.2fms [%.2fs (%.2fms/blk)]\n",
3124 : : Ticks<MillisecondsDouble>(time_4 - time_3),
3125 : : Ticks<SecondsDouble>(m_chainman.time_flush),
3126 : : Ticks<MillisecondsDouble>(m_chainman.time_flush) / m_chainman.num_blocks_total);
3127 : : // Write the chain state to disk, if necessary.
3128 [ + - ]: 162573 : if (!FlushStateToDisk(state, FlushStateMode::IF_NEEDED)) {
3129 : : return false;
3130 : : }
3131 : 162573 : const auto time_5{SteadyClock::now()};
3132 : 162573 : m_chainman.time_chainstate += time_5 - time_4;
3133 [ + + ]: 162573 : LogDebug(BCLog::BENCH, " - Writing chainstate: %.2fms [%.2fs (%.2fms/blk)]\n",
3134 : : Ticks<MillisecondsDouble>(time_5 - time_4),
3135 : : Ticks<SecondsDouble>(m_chainman.time_chainstate),
3136 : : Ticks<MillisecondsDouble>(m_chainman.time_chainstate) / m_chainman.num_blocks_total);
3137 : : // Remove conflicting transactions from the mempool.;
3138 [ + - ]: 162573 : if (m_mempool) {
3139 : 162573 : m_mempool->removeForBlock(block_to_connect->vtx, pindexNew->nHeight);
3140 : 162573 : disconnectpool.removeForBlock(block_to_connect->vtx);
3141 : : }
3142 : : // Update m_chain & related variables.
3143 : 162573 : m_chain.SetTip(*pindexNew);
3144 : 162573 : UpdateTip(pindexNew);
3145 : :
3146 : 162573 : const auto time_6{SteadyClock::now()};
3147 : 162573 : m_chainman.time_post_connect += time_6 - time_5;
3148 : 162573 : m_chainman.time_total += time_6 - time_1;
3149 [ + + ]: 162573 : LogDebug(BCLog::BENCH, " - Connect postprocess: %.2fms [%.2fs (%.2fms/blk)]\n",
3150 : : Ticks<MillisecondsDouble>(time_6 - time_5),
3151 : : Ticks<SecondsDouble>(m_chainman.time_post_connect),
3152 : : Ticks<MillisecondsDouble>(m_chainman.time_post_connect) / m_chainman.num_blocks_total);
3153 [ + + ]: 162573 : LogDebug(BCLog::BENCH, "- Connect block: %.2fms [%.2fs (%.2fms/blk)]\n",
3154 : : Ticks<MillisecondsDouble>(time_6 - time_1),
3155 : : Ticks<SecondsDouble>(m_chainman.time_total),
3156 : : Ticks<MillisecondsDouble>(m_chainman.time_total) / m_chainman.num_blocks_total);
3157 : :
3158 : : // See if this chainstate has reached a target block and can be used to
3159 : : // validate an assumeutxo snapshot. If it can, hashing the UTXO database
3160 : : // will be slow, and cs_main could remain locked here for several minutes.
3161 : : // If the snapshot is validated, the UTXO hash will be saved to
3162 : : // this->m_target_utxohash, causing HistoricalChainstate() to return null
3163 : : // and this chainstate to no longer be used. ActivateBestChain() will also
3164 : : // stop connecting blocks to this chainstate because this->ReachedTarget()
3165 : : // will be true and this->setBlockIndexCandidates will not have additional
3166 : : // blocks.
3167 : 162573 : Chainstate& current_cs{m_chainman.CurrentChainstate()};
3168 : 162573 : m_chainman.MaybeValidateSnapshot(*this, current_cs);
3169 : :
3170 [ + - ]: 162573 : connectTrace.BlockConnected(pindexNew, std::move(block_to_connect));
3171 : 162573 : return true;
3172 : : }
3173 : :
3174 : : /**
3175 : : * Return the tip of the chain with the most work in it, that isn't
3176 : : * known to be invalid (it's however far from certain to be valid).
3177 : : */
3178 : 197865 : CBlockIndex* Chainstate::FindMostWorkChain()
3179 : : {
3180 : 197865 : AssertLockHeld(::cs_main);
3181 : 198069 : do {
3182 : 198069 : CBlockIndex *pindexNew = nullptr;
3183 : :
3184 : : // Find the best candidate header.
3185 : 198069 : {
3186 [ + - ]: 198069 : std::set<CBlockIndex*, CBlockIndexWorkComparator>::reverse_iterator it = setBlockIndexCandidates.rbegin();
3187 [ + - ]: 198069 : if (it == setBlockIndexCandidates.rend())
3188 : : return nullptr;
3189 : 198069 : pindexNew = *it;
3190 : : }
3191 : :
3192 : : // Check whether all blocks on the path between the currently active chain and the candidate are valid.
3193 : : // Just going until the active chain is an optimization, as we know all blocks in it are valid already.
3194 : 198069 : CBlockIndex *pindexTest = pindexNew;
3195 : 198069 : bool fInvalidAncestor = false;
3196 [ + + + + ]: 373472 : while (pindexTest && !m_chain.Contains(pindexTest)) {
3197 [ - - - + ]: 175607 : assert(pindexTest->HaveNumChainTxs() || pindexTest->nHeight == 0);
3198 : :
3199 : : // Pruned nodes may have entries in setBlockIndexCandidates for
3200 : : // which block files have been deleted. Remove those as candidates
3201 : : // for the most work chain if we come across them; we can't switch
3202 : : // to a chain unless we have all the non-active-chain parent blocks.
3203 : 175607 : bool fFailedChain = pindexTest->nStatus & BLOCK_FAILED_MASK;
3204 : 175607 : bool fMissingData = !(pindexTest->nStatus & BLOCK_HAVE_DATA);
3205 [ + + ]: 175607 : if (fFailedChain || fMissingData) {
3206 : : // Candidate chain is not usable (either invalid or missing data)
3207 [ + - + - : 204 : if (fFailedChain && (m_chainman.m_best_invalid == nullptr || pindexNew->nChainWork > m_chainman.m_best_invalid->nChainWork)) {
- + ]
3208 : 0 : m_chainman.m_best_invalid = pindexNew;
3209 : : }
3210 : 204 : CBlockIndex *pindexFailed = pindexNew;
3211 : : // Remove the entire chain from the set.
3212 [ - + ]: 204 : while (pindexTest != pindexFailed) {
3213 [ # # ]: 0 : if (fFailedChain) {
3214 : 0 : pindexFailed->nStatus |= BLOCK_FAILED_CHILD;
3215 : 0 : m_blockman.m_dirty_blockindex.insert(pindexFailed);
3216 [ # # ]: 0 : } else if (fMissingData) {
3217 : : // If we're missing data, then add back to m_blocks_unlinked,
3218 : : // so that if the block arrives in the future we can try adding
3219 : : // to setBlockIndexCandidates again.
3220 : 0 : m_blockman.m_blocks_unlinked.insert(
3221 : 0 : std::make_pair(pindexFailed->pprev, pindexFailed));
3222 : : }
3223 : 0 : setBlockIndexCandidates.erase(pindexFailed);
3224 : 0 : pindexFailed = pindexFailed->pprev;
3225 : : }
3226 : 204 : setBlockIndexCandidates.erase(pindexTest);
3227 : 204 : fInvalidAncestor = true;
3228 : 204 : break;
3229 : : }
3230 : 175403 : pindexTest = pindexTest->pprev;
3231 : : }
3232 [ + + ]: 198069 : if (!fInvalidAncestor)
3233 : : return pindexNew;
3234 : : } while(true);
3235 : : }
3236 : :
3237 : : /** Delete all entries in setBlockIndexCandidates that are worse than the current tip. */
3238 : 163710 : void Chainstate::PruneBlockIndexCandidates() {
3239 : : // Note that we can't delete the current block itself, as we may need to return to it later in case a
3240 : : // reorganization to a better block fails.
3241 : 163710 : std::set<CBlockIndex*, CBlockIndexWorkComparator>::iterator it = setBlockIndexCandidates.begin();
3242 [ + - - + : 649098 : while (it != setBlockIndexCandidates.end() && setBlockIndexCandidates.value_comp()(*it, m_chain.Tip())) {
+ + ]
3243 : 160839 : setBlockIndexCandidates.erase(it++);
3244 : : }
3245 : : // Either the current tip or a successor of it we're working towards is left in setBlockIndexCandidates.
3246 [ - + ]: 163710 : assert(!setBlockIndexCandidates.empty());
3247 : 163710 : }
3248 : :
3249 : : /**
3250 : : * Try to make some progress towards making pindexMostWork the active block.
3251 : : * pblock is either nullptr or a pointer to a CBlock corresponding to pindexMostWork.
3252 : : *
3253 : : * @returns true unless a system error occurred
3254 : : */
3255 : 173424 : bool Chainstate::ActivateBestChainStep(BlockValidationState& state, CBlockIndex* pindexMostWork, const std::shared_ptr<const CBlock>& pblock, bool& fInvalidFound, ConnectTrace& connectTrace)
3256 : : {
3257 : 173424 : AssertLockHeld(cs_main);
3258 : 173424 : if (m_mempool) AssertLockHeld(m_mempool->cs);
3259 : :
3260 [ - + ]: 173424 : const CBlockIndex* pindexOldTip = m_chain.Tip();
3261 : 173424 : const CBlockIndex* pindexFork = m_chain.FindFork(pindexMostWork);
3262 : :
3263 : : // Disconnect active blocks which are no longer in the best chain.
3264 : 173424 : bool fBlocksDisconnected = false;
3265 : 173424 : DisconnectedBlockTransactions disconnectpool{MAX_DISCONNECTED_TX_POOL_BYTES};
3266 [ - + + - : 518029 : while (m_chain.Tip() && m_chain.Tip() != pindexFork) {
+ - ]
3267 [ # # # # ]: 0 : if (!DisconnectTip(state, &disconnectpool)) {
3268 : : // This is likely a fatal error, but keep the mempool consistent,
3269 : : // just in case. Only remove from the mempool in this case.
3270 [ # # ]: 0 : MaybeUpdateMempoolForReorg(disconnectpool, false);
3271 : :
3272 : : // If we're unable to disconnect a block during normal operation,
3273 : : // then that is a failure of our local system -- we should abort
3274 : : // rather than stay on a less work chain.
3275 [ # # # # ]: 0 : FatalError(m_chainman.GetNotifications(), state, _("Failed to disconnect block."));
3276 : 0 : return false;
3277 : : }
3278 : : fBlocksDisconnected = true;
3279 : : }
3280 : :
3281 : : // Build list of new blocks to connect (in descending height order).
3282 : 173424 : std::vector<CBlockIndex*> vpindexToConnect;
3283 : 173424 : bool fContinue = true;
3284 [ + + ]: 173424 : int nHeight = pindexFork ? pindexFork->nHeight : -1;
3285 [ + + + - ]: 335997 : while (fContinue && nHeight != pindexMostWork->nHeight) {
3286 : : // Don't iterate the entire list of potential improvements toward the best tip, as we likely only need
3287 : : // a few blocks along the way.
3288 [ - + ]: 173424 : int nTargetHeight = std::min(nHeight + 32, pindexMostWork->nHeight);
3289 [ - + ]: 173424 : vpindexToConnect.clear();
3290 [ + - ]: 173424 : vpindexToConnect.reserve(nTargetHeight - nHeight);
3291 [ + - ]: 173424 : CBlockIndex* pindexIter = pindexMostWork->GetAncestor(nTargetHeight);
3292 [ + + + + ]: 346848 : while (pindexIter && pindexIter->nHeight != nHeight) {
3293 [ + - ]: 173424 : vpindexToConnect.push_back(pindexIter);
3294 : 173424 : pindexIter = pindexIter->pprev;
3295 : : }
3296 : 173424 : nHeight = nTargetHeight;
3297 : :
3298 : : // Connect new blocks.
3299 [ + - ]: 173424 : for (CBlockIndex* pindexConnect : vpindexToConnect | std::views::reverse) {
3300 [ + - + - : 357699 : if (!ConnectTip(state, pindexConnect, pindexConnect == pindexMostWork ? pblock : std::shared_ptr<const CBlock>(), connectTrace, disconnectpool)) {
+ + + + ]
3301 [ + - ]: 10851 : if (state.IsInvalid()) {
3302 : : // The block violates a consensus rule.
3303 [ + - ]: 10851 : if (state.GetResult() != BlockValidationResult::BLOCK_MUTATED) {
3304 [ + - ]: 10851 : InvalidChainFound(vpindexToConnect.front());
3305 : : }
3306 : 10851 : state = BlockValidationState();
3307 : 10851 : fInvalidFound = true;
3308 : 10851 : fContinue = false;
3309 : 10851 : break;
3310 : : } else {
3311 : : // A system error occurred (disk space, database error, ...).
3312 : : // Make the mempool consistent with the current tip, just in case
3313 : : // any observers try to use it before shutdown.
3314 [ # # ]: 0 : MaybeUpdateMempoolForReorg(disconnectpool, false);
3315 : : return false;
3316 : : }
3317 : : } else {
3318 [ + - ]: 162573 : PruneBlockIndexCandidates();
3319 [ + + - + : 322903 : if (!pindexOldTip || m_chain.Tip()->nChainWork > pindexOldTip->nChainWork) {
+ - - + ]
3320 : : // We're in a better position than we were. Return temporarily to release the lock.
3321 : : fContinue = false;
3322 : : break;
3323 : : }
3324 : : }
3325 : : }
3326 : : }
3327 : :
3328 [ - + ]: 173424 : if (fBlocksDisconnected) {
3329 : : // If any blocks were disconnected, disconnectpool may be non empty. Add
3330 : : // any disconnected transactions back to the mempool.
3331 [ # # ]: 0 : MaybeUpdateMempoolForReorg(disconnectpool, true);
3332 : : }
3333 [ + - - + : 173424 : if (m_mempool) m_mempool->check(this->CoinsTip(), this->m_chain.Height() + 1);
+ - + - ]
3334 : :
3335 [ + - ]: 173424 : CheckForkWarningConditions();
3336 : :
3337 : : return true;
3338 : 173424 : }
3339 : :
3340 : 453967 : static SynchronizationState GetSynchronizationState(bool init, bool blockfiles_indexed)
3341 : : {
3342 [ + + ]: 453967 : if (!init) return SynchronizationState::POST_INIT;
3343 [ - + ]: 249662 : if (!blockfiles_indexed) return SynchronizationState::INIT_REINDEX;
3344 : : return SynchronizationState::INIT_DOWNLOAD;
3345 : : }
3346 : :
3347 : 386631 : bool ChainstateManager::NotifyHeaderTip()
3348 : : {
3349 : 386631 : bool fNotify = false;
3350 : 386631 : bool fInitialBlockDownload = false;
3351 : 386631 : CBlockIndex* pindexHeader = nullptr;
3352 : 386631 : {
3353 : 386631 : LOCK(GetMutex());
3354 : 386631 : pindexHeader = m_best_header;
3355 : :
3356 [ + + ]: 386631 : if (pindexHeader != m_last_notified_header) {
3357 : 291394 : fNotify = true;
3358 [ + - ]: 291394 : fInitialBlockDownload = IsInitialBlockDownload();
3359 : 291394 : m_last_notified_header = pindexHeader;
3360 : : }
3361 : 386631 : }
3362 : : // Send block tip changed notifications without the lock held
3363 [ + + ]: 386631 : if (fNotify) {
3364 : 291394 : GetNotifications().headerTip(GetSynchronizationState(fInitialBlockDownload, m_blockman.m_blockfiles_indexed), pindexHeader->nHeight, pindexHeader->nTime, false);
3365 : : }
3366 : 386631 : return fNotify;
3367 : : }
3368 : :
3369 : 193483 : static void LimitValidationInterfaceQueue(ValidationSignals& signals) LOCKS_EXCLUDED(cs_main) {
3370 : 193483 : AssertLockNotHeld(cs_main);
3371 : :
3372 [ - + ]: 193483 : if (signals.CallbacksPending() > 10) {
3373 : 0 : signals.SyncWithValidationInterfaceQueue();
3374 : : }
3375 : 193483 : }
3376 : :
3377 : 183235 : bool Chainstate::ActivateBestChain(BlockValidationState& state, std::shared_ptr<const CBlock> pblock)
3378 : : {
3379 : 183235 : AssertLockNotHeld(m_chainstate_mutex);
3380 : :
3381 : : // Note that while we're often called here from ProcessNewBlock, this is
3382 : : // far from a guarantee. Things in the P2P/RPC will often end up calling
3383 : : // us in the middle of ProcessNewBlock - do not assume pblock is set
3384 : : // sanely for performance or correctness!
3385 : 183235 : AssertLockNotHeld(::cs_main);
3386 : :
3387 : : // ABC maintains a fair degree of expensive-to-calculate internal state
3388 : : // because this function periodically releases cs_main so that it does not lock up other threads for too long
3389 : : // during large connects - and to allow for e.g. the callback queue to drain
3390 : : // we use m_chainstate_mutex to enforce mutual exclusion so that only one caller may execute this function at a time
3391 : 183235 : LOCK(m_chainstate_mutex);
3392 : :
3393 : : // Belt-and-suspenders check that we aren't attempting to advance the
3394 : : // chainstate past the target block.
3395 [ + - - + : 366470 : if (WITH_LOCK(::cs_main, return m_target_utxohash)) {
+ - ]
3396 [ # # # # ]: 0 : LogError("%s", STR_INTERNAL_BUG("m_target_utxohash is set - this chainstate should not be in operation."));
3397 [ - - + - ]: 183235 : return Assume(false);
3398 : : }
3399 : :
3400 : : CBlockIndex *pindexMostWork = nullptr;
3401 : : CBlockIndex *pindexNewTip = nullptr;
3402 : : bool exited_ibd{false};
3403 : 194086 : do {
3404 : : // Block until the validation queue drains. This should largely
3405 : : // never happen in normal operation, however may happen during
3406 : : // reindex, causing memory blowup if we run too far ahead.
3407 : : // Note that if a validationinterface callback ends up calling
3408 : : // ActivateBestChain this may lead to a deadlock! We should
3409 : : // probably have a DEBUG_LOCKORDER test for this in the future.
3410 [ + + + - ]: 194086 : if (m_chainman.m_options.signals) LimitValidationInterfaceQueue(*m_chainman.m_options.signals);
3411 : :
3412 : 194086 : {
3413 [ + - ]: 194086 : LOCK(cs_main);
3414 : 194086 : {
3415 : : // Lock transaction pool for at least as long as it takes for connectTrace to be consumed
3416 [ + - + - ]: 388172 : LOCK(MempoolMutex());
3417 [ + - ]: 194086 : const bool was_in_ibd = m_chainman.IsInitialBlockDownload();
3418 [ - + ]: 194086 : CBlockIndex* starting_tip = m_chain.Tip();
3419 : 194086 : bool blocks_connected = false;
3420 : 194086 : do {
3421 : : // We absolutely may not unlock cs_main until we've made forward progress
3422 : : // (with the exception of shutdown due to hardware issues, low disk space, etc).
3423 [ + - ]: 194086 : ConnectTrace connectTrace; // Destructed before cs_main is unlocked
3424 : :
3425 [ + - ]: 194086 : if (pindexMostWork == nullptr) {
3426 [ + - ]: 194086 : pindexMostWork = FindMostWorkChain();
3427 : : }
3428 : :
3429 : : // Whether we have anything to do at all.
3430 [ + - - + : 388172 : if (pindexMostWork == nullptr || pindexMostWork == m_chain.Tip()) {
+ + ]
3431 : : break;
3432 : : }
3433 : :
3434 : 173424 : bool fInvalidFound = false;
3435 : 173424 : std::shared_ptr<const CBlock> nullBlockPtr;
3436 : : // BlockConnected signals must be sent for the original role;
3437 : : // in case snapshot validation is completed during ActivateBestChainStep, the
3438 : : // result of GetRole() changes from BACKGROUND to NORMAL.
3439 [ + - ]: 173424 : const ChainstateRole chainstate_role{this->GetRole()};
3440 [ + + + - : 173424 : if (!ActivateBestChainStep(state, pindexMostWork, pblock && pblock->GetHash() == pindexMostWork->GetBlockHash() ? pblock : nullBlockPtr, fInvalidFound, connectTrace)) {
- + + - -
+ ]
3441 : : // A system error occurred
3442 [ # # ]: 0 : return false;
3443 : : }
3444 : 173424 : blocks_connected = true;
3445 : :
3446 [ + + ]: 173424 : if (fInvalidFound) {
3447 : : // Wipe cache, we may need another branch now.
3448 : 10851 : pindexMostWork = nullptr;
3449 : : }
3450 [ - + ]: 173424 : pindexNewTip = m_chain.Tip();
3451 : :
3452 [ + + ]: 335997 : for (const PerBlockConnectTrace& trace : connectTrace.GetBlocksConnected()) {
3453 [ + - - + ]: 162573 : assert(trace.pblock && trace.pindex);
3454 [ + + ]: 162573 : if (m_chainman.m_options.signals) {
3455 [ + - ]: 161970 : m_chainman.m_options.signals->BlockConnected(chainstate_role, trace.pblock, trace.pindex);
3456 : : }
3457 : : }
3458 : :
3459 : : // Break this do-while to ensure we don't advance past the target block.
3460 [ + - + - ]: 173424 : if (ReachedTarget()) {
3461 : : break;
3462 : : }
3463 [ - + + - : 367510 : } while (!m_chain.Tip() || (starting_tip && CBlockIndexWorkComparator()(m_chain.Tip(), starting_tip)));
+ + + - -
+ - + ]
3464 [ + + ]: 194086 : if (!blocks_connected) return true;
3465 : :
3466 [ + - ]: 173424 : const CBlockIndex* pindexFork = m_chain.FindFork(starting_tip);
3467 [ + - ]: 173424 : bool still_in_ibd = m_chainman.IsInitialBlockDownload();
3468 : :
3469 [ + + ]: 173424 : if (was_in_ibd && !still_in_ibd) {
3470 : : // Active chainstate has exited IBD.
3471 : 659 : exited_ibd = true;
3472 : : }
3473 : :
3474 : : // Notify external listeners about the new tip.
3475 : : // Enqueue while holding cs_main to ensure that UpdatedBlockTip is called in the order in which blocks are connected
3476 [ + - + - : 173424 : if (this == &m_chainman.ActiveChainstate() && pindexFork != pindexNewTip) {
+ + ]
3477 : : // Notify ValidationInterface subscribers
3478 [ + + ]: 162573 : if (m_chainman.m_options.signals) {
3479 [ + - ]: 161970 : m_chainman.m_options.signals->UpdatedBlockTip(pindexNewTip, pindexFork, still_in_ibd);
3480 : : }
3481 : :
3482 [ + - + - : 162573 : if (kernel::IsInterrupted(m_chainman.GetNotifications().blockTip(
+ - ]
3483 [ + - ]: 162573 : /*state=*/GetSynchronizationState(still_in_ibd, m_chainman.m_blockman.m_blockfiles_indexed),
3484 : : /*index=*/*pindexNewTip,
3485 : : /*verification_progress=*/m_chainman.GuessVerificationProgress(pindexNewTip))))
3486 : : {
3487 : : // Just breaking and returning success for now. This could
3488 : : // be changed to bubble up the kernel::Interrupted value to
3489 : : // the caller so the caller could distinguish between
3490 : : // completed and interrupted operations.
3491 : : break;
3492 : : }
3493 : : }
3494 [ + - - - ]: 20662 : } // release MempoolMutex
3495 : : // Notify external listeners about the new tip, even if pindexFork == pindexNewTip.
3496 [ + + + - : 173424 : if (m_chainman.m_options.signals && this == &m_chainman.ActiveChainstate()) {
+ - ]
3497 [ + - - + : 172821 : m_chainman.m_options.signals->ActiveTipChange(*Assert(pindexNewTip), m_chainman.IsInitialBlockDownload());
+ - ]
3498 : : }
3499 : 20662 : } // release cs_main
3500 : : // When we reach this point, we switched to a new tip (stored in pindexNewTip).
3501 : :
3502 : 173424 : bool reached_target;
3503 : 173424 : {
3504 [ + - ]: 173424 : LOCK(m_chainman.GetMutex());
3505 [ + + ]: 173424 : if (exited_ibd) {
3506 : : // If a background chainstate is in use, we may need to rebalance our
3507 : : // allocation of caches once a chainstate exits initial block download.
3508 [ + - ]: 659 : m_chainman.MaybeRebalanceCaches();
3509 : : }
3510 : :
3511 : : // Write changes periodically to disk, after relay.
3512 [ + - - + ]: 173424 : if (!FlushStateToDisk(state, FlushStateMode::PERIODIC)) {
3513 [ # # ]: 0 : return false;
3514 : : }
3515 : :
3516 [ + - + - ]: 173424 : reached_target = ReachedTarget();
3517 : 0 : }
3518 : :
3519 [ - + ]: 173424 : if (reached_target) {
3520 : : // Chainstate has reached the target block, so exit.
3521 : : //
3522 : : // Restart indexes so indexes can resync and index new blocks after
3523 : : // the target block.
3524 : : //
3525 : : // This cannot be done while holding cs_main (within
3526 : : // MaybeValidateSnapshot) or a cs_main deadlock will occur.
3527 [ # # ]: 0 : if (m_chainman.snapshot_download_completed) {
3528 [ # # ]: 0 : m_chainman.snapshot_download_completed();
3529 : : }
3530 : : break;
3531 : : }
3532 : :
3533 : : // We check interrupt only after giving ActivateBestChainStep a chance to run once so that we
3534 : : // never interrupt before connecting the genesis block during LoadChainTip(). Previously this
3535 : : // caused an assert() failure during interrupt in such cases as the UTXO DB flushing checks
3536 : : // that the best block hash is non-null.
3537 [ + - + - ]: 173424 : if (m_chainman.m_interrupt) break;
3538 [ + + ]: 173424 : } while (pindexNewTip != pindexMostWork);
3539 : :
3540 [ + - ]: 162573 : m_chainman.CheckBlockIndex();
3541 : :
3542 : : return true;
3543 : 183235 : }
3544 : :
3545 : 3 : bool Chainstate::PreciousBlock(BlockValidationState& state, CBlockIndex* pindex)
3546 : : {
3547 : 3 : AssertLockNotHeld(m_chainstate_mutex);
3548 : 3 : AssertLockNotHeld(::cs_main);
3549 : 3 : {
3550 : 3 : LOCK(cs_main);
3551 [ - + + - : 6 : if (pindex->nChainWork < m_chain.Tip()->nChainWork) {
- + ]
3552 : : // Nothing to do, this block is not at the tip.
3553 [ # # ]: 0 : return true;
3554 : : }
3555 [ - + + - : 6 : if (m_chain.Tip()->nChainWork > m_chainman.nLastPreciousChainwork) {
+ + ]
3556 : : // The chain has been extended since the last call, reset the counter.
3557 : 1 : m_chainman.nBlockReverseSequenceId = -1;
3558 : : }
3559 [ - + ]: 3 : m_chainman.nLastPreciousChainwork = m_chain.Tip()->nChainWork;
3560 [ + - ]: 3 : setBlockIndexCandidates.erase(pindex);
3561 : 3 : pindex->nSequenceId = m_chainman.nBlockReverseSequenceId;
3562 [ + - ]: 3 : if (m_chainman.nBlockReverseSequenceId > std::numeric_limits<int32_t>::min()) {
3563 : : // We can't keep reducing the counter if somebody really wants to
3564 : : // call preciousblock 2**31-1 times on the same set of tips...
3565 : 3 : m_chainman.nBlockReverseSequenceId--;
3566 : : }
3567 [ + - + - : 6 : if (pindex->IsValid(BLOCK_VALID_TRANSACTIONS) && pindex->HaveNumChainTxs()) {
+ - + - ]
3568 [ + - ]: 3 : setBlockIndexCandidates.insert(pindex);
3569 [ + - ]: 3 : PruneBlockIndexCandidates();
3570 : : }
3571 : 0 : }
3572 : :
3573 [ + - - + ]: 3 : return ActivateBestChain(state, std::shared_ptr<const CBlock>());
3574 : : }
3575 : :
3576 : 2 : bool Chainstate::InvalidateBlock(BlockValidationState& state, CBlockIndex* pindex)
3577 : : {
3578 : 2 : AssertLockNotHeld(m_chainstate_mutex);
3579 : 2 : AssertLockNotHeld(::cs_main);
3580 : :
3581 : : // Genesis block can't be invalidated
3582 [ - + ]: 2 : assert(pindex);
3583 [ - + ]: 2 : if (pindex->nHeight == 0) return false;
3584 : :
3585 : 0 : CBlockIndex* to_mark_failed = pindex;
3586 : 0 : bool pindex_was_in_chain = false;
3587 : 0 : int disconnected = 0;
3588 : :
3589 : : // We do not allow ActivateBestChain() to run while InvalidateBlock() is
3590 : : // running, as that could cause the tip to change while we disconnect
3591 : : // blocks.
3592 : 0 : LOCK(m_chainstate_mutex);
3593 : :
3594 : : // We'll be acquiring and releasing cs_main below, to allow the validation
3595 : : // callbacks to run. However, we should keep the block index in a
3596 : : // consistent state as we disconnect blocks -- in particular we need to
3597 : : // add equal-work blocks to setBlockIndexCandidates as we disconnect.
3598 : : // To avoid walking the block index repeatedly in search of candidates,
3599 : : // build a map once so that we can look up candidate blocks by chain
3600 : : // work as we go.
3601 [ # # ]: 0 : std::multimap<const arith_uint256, CBlockIndex*> highpow_outofchain_headers;
3602 : :
3603 : 0 : {
3604 [ # # ]: 0 : LOCK(cs_main);
3605 [ # # # # : 0 : for (auto& entry : m_blockman.m_block_index) {
# # ]
3606 : 0 : CBlockIndex* candidate = &entry.second;
3607 : : // We don't need to put anything in our active chain into the
3608 : : // multimap, because those candidates will be found and considered
3609 : : // as we disconnect.
3610 : : // Instead, consider only non-active-chain blocks that score
3611 : : // at least as good with CBlockIndexWorkComparator as the new tip.
3612 [ # # ]: 0 : if (!m_chain.Contains(candidate) &&
3613 [ # # # # ]: 0 : !CBlockIndexWorkComparator()(candidate, pindex->pprev) &&
3614 [ # # ]: 0 : !(candidate->nStatus & BLOCK_FAILED_MASK)) {
3615 [ # # ]: 0 : highpow_outofchain_headers.insert({candidate->nChainWork, candidate});
3616 : : }
3617 : : }
3618 : 0 : }
3619 : :
3620 : : // Disconnect (descendants of) pindex, and mark them invalid.
3621 : 0 : while (true) {
3622 [ # # # # ]: 0 : if (m_chainman.m_interrupt) break;
3623 : :
3624 : : // Make sure the queue of validation callbacks doesn't grow unboundedly.
3625 [ # # # # ]: 0 : if (m_chainman.m_options.signals) LimitValidationInterfaceQueue(*m_chainman.m_options.signals);
3626 : :
3627 [ # # ]: 0 : LOCK(cs_main);
3628 : : // Lock for as long as disconnectpool is in scope to make sure MaybeUpdateMempoolForReorg is
3629 : : // called after DisconnectTip without unlocking in between
3630 [ # # # # ]: 0 : LOCK(MempoolMutex());
3631 [ # # ]: 0 : if (!m_chain.Contains(pindex)) break;
3632 : 0 : pindex_was_in_chain = true;
3633 [ # # ]: 0 : CBlockIndex *invalid_walk_tip = m_chain.Tip();
3634 : :
3635 : : // ActivateBestChain considers blocks already in m_chain
3636 : : // unconditionally valid already, so force disconnect away from it.
3637 [ # # ]: 0 : DisconnectedBlockTransactions disconnectpool{MAX_DISCONNECTED_TX_POOL_BYTES};
3638 [ # # ]: 0 : bool ret = DisconnectTip(state, &disconnectpool);
3639 : : // DisconnectTip will add transactions to disconnectpool.
3640 : : // Adjust the mempool to be consistent with the new tip, adding
3641 : : // transactions back to the mempool if disconnecting was successful,
3642 : : // and we're not doing a very deep invalidation (in which case
3643 : : // keeping the mempool up to date is probably futile anyway).
3644 [ # # # # : 0 : MaybeUpdateMempoolForReorg(disconnectpool, /* fAddToMempool = */ (++disconnected <= 10) && ret);
# # ]
3645 [ # # ]: 0 : if (!ret) return false;
3646 [ # # # # ]: 0 : assert(invalid_walk_tip->pprev == m_chain.Tip());
3647 : :
3648 : : // We immediately mark the disconnected blocks as invalid.
3649 : : // This prevents a case where pruned nodes may fail to invalidateblock
3650 : : // and be left unable to start as they have no tip candidates (as there
3651 : : // are no blocks that meet the "have data and are not invalid per
3652 : : // nStatus" criteria for inclusion in setBlockIndexCandidates).
3653 : 0 : invalid_walk_tip->nStatus |= BLOCK_FAILED_VALID;
3654 [ # # ]: 0 : m_blockman.m_dirty_blockindex.insert(invalid_walk_tip);
3655 [ # # ]: 0 : setBlockIndexCandidates.erase(invalid_walk_tip);
3656 [ # # ]: 0 : setBlockIndexCandidates.insert(invalid_walk_tip->pprev);
3657 [ # # # # ]: 0 : if (invalid_walk_tip == to_mark_failed->pprev && (to_mark_failed->nStatus & BLOCK_FAILED_VALID)) {
3658 : : // We only want to mark the last disconnected block as BLOCK_FAILED_VALID; its children
3659 : : // need to be BLOCK_FAILED_CHILD instead.
3660 : 0 : to_mark_failed->nStatus = (to_mark_failed->nStatus ^ BLOCK_FAILED_VALID) | BLOCK_FAILED_CHILD;
3661 [ # # ]: 0 : m_blockman.m_dirty_blockindex.insert(to_mark_failed);
3662 : : }
3663 : :
3664 : : // Mark out-of-chain descendants of the invalidated block as invalid
3665 : : // (possibly replacing a pre-existing BLOCK_FAILED_VALID with BLOCK_FAILED_CHILD)
3666 : : // Add any equal or more work headers that are not invalidated to setBlockIndexCandidates
3667 : : // Recalculate m_best_header if it became invalid.
3668 [ # # ]: 0 : auto candidate_it = highpow_outofchain_headers.lower_bound(invalid_walk_tip->pprev->nChainWork);
3669 : :
3670 [ # # ]: 0 : const bool best_header_needs_update{m_chainman.m_best_header->GetAncestor(invalid_walk_tip->nHeight) == invalid_walk_tip};
3671 [ # # ]: 0 : if (best_header_needs_update) {
3672 : : // pprev is definitely still valid at this point, but there may be better ones
3673 : 0 : m_chainman.m_best_header = invalid_walk_tip->pprev;
3674 : : }
3675 : :
3676 [ # # ]: 0 : while (candidate_it != highpow_outofchain_headers.end()) {
3677 [ # # ]: 0 : CBlockIndex* candidate{candidate_it->second};
3678 [ # # # # ]: 0 : if (candidate->GetAncestor(invalid_walk_tip->nHeight) == invalid_walk_tip) {
3679 : : // Children of failed blocks should be marked as BLOCK_FAILED_CHILD instead.
3680 : 0 : candidate->nStatus &= ~BLOCK_FAILED_VALID;
3681 : 0 : candidate->nStatus |= BLOCK_FAILED_CHILD;
3682 [ # # ]: 0 : m_blockman.m_dirty_blockindex.insert(candidate);
3683 : : // If invalidated, the block is irrelevant for setBlockIndexCandidates
3684 : : // and for m_best_header and can be removed from the cache.
3685 : 0 : candidate_it = highpow_outofchain_headers.erase(candidate_it);
3686 : 0 : continue;
3687 : : }
3688 [ # # ]: 0 : if (!CBlockIndexWorkComparator()(candidate, invalid_walk_tip->pprev) &&
3689 [ # # # # : 0 : candidate->IsValid(BLOCK_VALID_TRANSACTIONS) &&
# # # # ]
3690 [ # # ]: 0 : candidate->HaveNumChainTxs()) {
3691 [ # # ]: 0 : setBlockIndexCandidates.insert(candidate);
3692 : : // Do not remove candidate from the highpow_outofchain_headers cache, because it might be a descendant of the block being invalidated
3693 : : // which needs to be marked failed later.
3694 : : }
3695 [ # # # # ]: 0 : if (best_header_needs_update &&
3696 [ # # ]: 0 : m_chainman.m_best_header->nChainWork < candidate->nChainWork) {
3697 : 0 : m_chainman.m_best_header = candidate;
3698 : : }
3699 : 0 : ++candidate_it;
3700 : : }
3701 : :
3702 : : // Track the last disconnected block, so we can correct its BLOCK_FAILED_CHILD status in future
3703 : : // iterations, or, if it's the last one, call InvalidChainFound on it.
3704 : 0 : to_mark_failed = invalid_walk_tip;
3705 [ # # # # : 0 : }
# # # # #
# ]
3706 : :
3707 [ # # ]: 0 : m_chainman.CheckBlockIndex();
3708 : :
3709 : 0 : {
3710 [ # # ]: 0 : LOCK(cs_main);
3711 [ # # ]: 0 : if (m_chain.Contains(to_mark_failed)) {
3712 : : // If the to-be-marked invalid block is in the active chain, something is interfering and we can't proceed.
3713 [ # # ]: 0 : return false;
3714 : : }
3715 : :
3716 : : // Mark pindex as invalid if it never was in the main chain
3717 [ # # # # ]: 0 : if (!pindex_was_in_chain && !(pindex->nStatus & BLOCK_FAILED_MASK)) {
3718 : 0 : pindex->nStatus |= BLOCK_FAILED_VALID;
3719 [ # # ]: 0 : m_blockman.m_dirty_blockindex.insert(pindex);
3720 [ # # ]: 0 : setBlockIndexCandidates.erase(pindex);
3721 : : }
3722 : :
3723 : : // If any new blocks somehow arrived while we were disconnecting
3724 : : // (above), then the pre-calculation of what should go into
3725 : : // setBlockIndexCandidates may have missed entries. This would
3726 : : // technically be an inconsistency in the block index, but if we clean
3727 : : // it up here, this should be an essentially unobservable error.
3728 : : // Loop back over all block index entries and add any missing entries
3729 : : // to setBlockIndexCandidates.
3730 [ # # # # ]: 0 : for (auto& [_, block_index] : m_blockman.m_block_index) {
3731 [ # # # # : 0 : if (block_index.IsValid(BLOCK_VALID_TRANSACTIONS) && block_index.HaveNumChainTxs() && !setBlockIndexCandidates.value_comp()(&block_index, m_chain.Tip())) {
# # # # #
# # # ]
3732 [ # # ]: 0 : setBlockIndexCandidates.insert(&block_index);
3733 : : }
3734 : : }
3735 : :
3736 [ # # ]: 0 : InvalidChainFound(to_mark_failed);
3737 : 0 : }
3738 : :
3739 : : // Only notify about a new block tip if the active chain was modified.
3740 [ # # ]: 0 : if (pindex_was_in_chain) {
3741 : : // Ignoring return value for now, this could be changed to bubble up
3742 : : // kernel::Interrupted value to the caller so the caller could
3743 : : // distinguish between completed and interrupted operations. It might
3744 : : // also make sense for the blockTip notification to have an enum
3745 : : // parameter indicating the source of the tip change so hooks can
3746 : : // distinguish user-initiated invalidateblock changes from other
3747 : : // changes.
3748 [ # # # # ]: 0 : (void)m_chainman.GetNotifications().blockTip(
3749 : 0 : /*state=*/GetSynchronizationState(m_chainman.IsInitialBlockDownload(), m_chainman.m_blockman.m_blockfiles_indexed),
3750 [ # # ]: 0 : /*index=*/*to_mark_failed->pprev,
3751 [ # # # # : 0 : /*verification_progress=*/WITH_LOCK(m_chainman.GetMutex(), return m_chainman.GuessVerificationProgress(to_mark_failed->pprev)));
# # ]
3752 : :
3753 : : // Fire ActiveTipChange now for the current chain tip to make sure clients are notified.
3754 : : // ActivateBestChain may call this as well, but not necessarily.
3755 [ # # ]: 0 : if (m_chainman.m_options.signals) {
3756 [ # # # # : 0 : m_chainman.m_options.signals->ActiveTipChange(*Assert(m_chain.Tip()), m_chainman.IsInitialBlockDownload());
# # # # ]
3757 : : }
3758 : : }
3759 : : return true;
3760 [ # # ]: 0 : }
3761 : :
3762 : 24451 : void Chainstate::SetBlockFailureFlags(CBlockIndex* invalid_block)
3763 : : {
3764 : 24451 : AssertLockHeld(cs_main);
3765 : :
3766 [ + + + + ]: 1988022 : for (auto& [_, block_index] : m_blockman.m_block_index) {
3767 [ + + + + ]: 1963571 : if (invalid_block != &block_index && block_index.GetAncestor(invalid_block->nHeight) == invalid_block) {
3768 : 3895 : block_index.nStatus = (block_index.nStatus & ~BLOCK_FAILED_VALID) | BLOCK_FAILED_CHILD;
3769 : 3895 : m_blockman.m_dirty_blockindex.insert(&block_index);
3770 : : }
3771 : : }
3772 : 24451 : }
3773 : :
3774 : 17 : void Chainstate::ResetBlockFailureFlags(CBlockIndex *pindex) {
3775 : 17 : AssertLockHeld(cs_main);
3776 : :
3777 : 17 : int nHeight = pindex->nHeight;
3778 : :
3779 : : // Remove the invalidity flag from this block and all its descendants and ancestors.
3780 [ + + - + ]: 1068 : for (auto& [_, block_index] : m_blockman.m_block_index) {
3781 [ - - - - : 1051 : if ((block_index.nStatus & BLOCK_FAILED_MASK) && (block_index.GetAncestor(nHeight) == pindex || pindex->GetAncestor(block_index.nHeight) == &block_index)) {
- + ]
3782 : 0 : block_index.nStatus &= ~BLOCK_FAILED_MASK;
3783 : 0 : m_blockman.m_dirty_blockindex.insert(&block_index);
3784 [ # # # # : 0 : if (block_index.IsValid(BLOCK_VALID_TRANSACTIONS) && block_index.HaveNumChainTxs() && setBlockIndexCandidates.value_comp()(m_chain.Tip(), &block_index)) {
# # # # #
# ]
3785 : 0 : setBlockIndexCandidates.insert(&block_index);
3786 : : }
3787 [ # # ]: 0 : if (&block_index == m_chainman.m_best_invalid) {
3788 : : // Reset invalid block marker if it was pointing to one of those.
3789 : 0 : m_chainman.m_best_invalid = nullptr;
3790 : : }
3791 : : }
3792 : : }
3793 : 17 : }
3794 : :
3795 : 175919 : void Chainstate::TryAddBlockIndexCandidate(CBlockIndex* pindex)
3796 : : {
3797 : 175919 : AssertLockHeld(cs_main);
3798 : :
3799 : : // Do not continue building a chainstate that is based on an invalid
3800 : : // snapshot. This is a belt-and-suspenders type of check because if an
3801 : : // invalid snapshot is loaded, the node will shut down to force a manual
3802 : : // intervention. But it is good to handle this case correctly regardless.
3803 [ + - ]: 175919 : if (m_assumeutxo == Assumeutxo::INVALID) {
3804 : : return;
3805 : : }
3806 : :
3807 : : // The block only is a candidate for the most-work-chain if it has the same
3808 : : // or more work than our current tip.
3809 [ - + + - : 349595 : if (m_chain.Tip() != nullptr && setBlockIndexCandidates.value_comp()(pindex, m_chain.Tip())) {
+ + ]
3810 : : return;
3811 : : }
3812 : :
3813 : 175089 : const CBlockIndex* target_block{TargetBlock()};
3814 [ + - ]: 175089 : if (!target_block) {
3815 : : // If no specific target block, add all entries that have more
3816 : : // work than the tip.
3817 : 175089 : setBlockIndexCandidates.insert(pindex);
3818 : : } else {
3819 : : // If there is a target block, only consider connecting blocks
3820 : : // towards the target block.
3821 [ # # ]: 0 : if (target_block->GetAncestor(pindex->nHeight) == pindex) {
3822 : 0 : setBlockIndexCandidates.insert(pindex);
3823 : : }
3824 : : }
3825 : : }
3826 : :
3827 : : /** Mark a block as having its data received and checked (up to BLOCK_VALID_TRANSACTIONS). */
3828 : 175922 : void ChainstateManager::ReceivedBlockTransactions(const CBlock& block, CBlockIndex* pindexNew, const FlatFilePos& pos)
3829 : : {
3830 : 175922 : AssertLockHeld(cs_main);
3831 [ - + ]: 175922 : pindexNew->nTx = block.vtx.size();
3832 : : // Typically m_chain_tx_count will be 0 at this point, but it can be nonzero if this
3833 : : // is a pruned block which is being downloaded again, or if this is an
3834 : : // assumeutxo snapshot block which has a hardcoded m_chain_tx_count value from the
3835 : : // snapshot metadata. If the pindex is not the snapshot block and the
3836 : : // m_chain_tx_count value is not zero, assert that value is actually correct.
3837 : 173886 : auto prev_tx_sum = [](CBlockIndex& block) { return block.nTx + (block.pprev ? block.pprev->m_chain_tx_count : 0); };
3838 [ - - + + : 176301 : if (!Assume(pindexNew->m_chain_tx_count == 0 || pindexNew->m_chain_tx_count == prev_tx_sum(*pindexNew) ||
+ + - + -
- - + ]
3839 : : std::ranges::any_of(m_chainstates, [&](const auto& cs) EXCLUSIVE_LOCKS_REQUIRED(cs_main) { return cs->SnapshotBase() == pindexNew; }))) {
3840 [ # # # # ]: 0 : LogWarning("Internal bug detected: block %d has unexpected m_chain_tx_count %i that should be %i (%s %s). Please report this issue here: %s\n",
3841 : : pindexNew->nHeight, pindexNew->m_chain_tx_count, prev_tx_sum(*pindexNew), CLIENT_NAME, FormatFullVersion(), CLIENT_BUGREPORT);
3842 : 0 : pindexNew->m_chain_tx_count = 0;
3843 : : }
3844 : 175922 : pindexNew->nFile = pos.nFile;
3845 : 175922 : pindexNew->nDataPos = pos.nPos;
3846 : 175922 : pindexNew->nUndoPos = 0;
3847 : 175922 : pindexNew->nStatus |= BLOCK_HAVE_DATA;
3848 [ + + ]: 175922 : if (DeploymentActiveAt(*pindexNew, *this, Consensus::DEPLOYMENT_SEGWIT)) {
3849 : 175921 : pindexNew->nStatus |= BLOCK_OPT_WITNESS;
3850 : : }
3851 : 175922 : pindexNew->RaiseValidity(BLOCK_VALID_TRANSACTIONS);
3852 : 175922 : m_blockman.m_dirty_blockindex.insert(pindexNew);
3853 : :
3854 [ + + + + ]: 175922 : if (pindexNew->pprev == nullptr || pindexNew->pprev->HaveNumChainTxs()) {
3855 : : // If pindexNew is the genesis block or all parents are BLOCK_VALID_TRANSACTIONS.
3856 : 175237 : std::deque<CBlockIndex*> queue;
3857 [ + - ]: 175237 : queue.push_back(pindexNew);
3858 : :
3859 : : // Recursively process any descendant blocks that now may be eligible to be connected.
3860 [ + + ]: 350992 : while (!queue.empty()) {
3861 : 175755 : CBlockIndex *pindex = queue.front();
3862 : 175755 : queue.pop_front();
3863 : : // Before setting m_chain_tx_count, assert that it is 0 or already set to
3864 : : // the correct value. This assert will fail after receiving the
3865 : : // assumeutxo snapshot block if assumeutxo snapshot metadata has an
3866 : : // incorrect hardcoded AssumeutxoData::m_chain_tx_count value.
3867 [ + + + + : 176897 : if (!Assume(pindex->m_chain_tx_count == 0 || pindex->m_chain_tx_count == prev_tx_sum(*pindex))) {
+ - - + ]
3868 [ # # # # : 0 : LogWarning("Internal bug detected: block %d has unexpected m_chain_tx_count %i that should be %i (%s %s). Please report this issue here: %s\n",
# # ]
3869 : : pindex->nHeight, pindex->m_chain_tx_count, prev_tx_sum(*pindex), CLIENT_NAME, FormatFullVersion(), CLIENT_BUGREPORT);
3870 : : }
3871 [ + + ]: 175755 : pindex->m_chain_tx_count = prev_tx_sum(*pindex);
3872 : 175755 : pindex->nSequenceId = nBlockSequenceId++;
3873 [ + + ]: 351510 : for (const auto& c : m_chainstates) {
3874 [ + - ]: 175755 : c->TryAddBlockIndexCandidate(pindex);
3875 : : }
3876 : 175755 : std::pair<std::multimap<CBlockIndex*, CBlockIndex*>::iterator, std::multimap<CBlockIndex*, CBlockIndex*>::iterator> range = m_blockman.m_blocks_unlinked.equal_range(pindex);
3877 [ + + ]: 176273 : while (range.first != range.second) {
3878 : 518 : std::multimap<CBlockIndex*, CBlockIndex*>::iterator it = range.first;
3879 [ + - ]: 518 : queue.push_back(it->second);
3880 : 518 : range.first++;
3881 : 518 : m_blockman.m_blocks_unlinked.erase(it);
3882 : : }
3883 : : }
3884 : 175237 : } else {
3885 [ + - + - ]: 685 : if (pindexNew->pprev && pindexNew->pprev->IsValid(BLOCK_VALID_TREE)) {
3886 : 685 : m_blockman.m_blocks_unlinked.insert(std::make_pair(pindexNew->pprev, pindexNew));
3887 : : }
3888 : : }
3889 : 175922 : }
3890 : :
3891 : 982914 : static bool CheckBlockHeader(const CBlockHeader& block, BlockValidationState& state, const Consensus::Params& consensusParams, bool fCheckPOW = true)
3892 : : {
3893 : : // Check proof of work matches claimed amount
3894 [ + + + + ]: 982914 : if (fCheckPOW && !CheckProofOfWork(block.GetHash(), block.nBits, consensusParams))
3895 [ + - + - ]: 19343 : return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "high-hash", "proof of work failed");
3896 : :
3897 : : return true;
3898 : : }
3899 : :
3900 : 231254 : static bool CheckMerkleRoot(const CBlock& block, BlockValidationState& state)
3901 : : {
3902 [ + + ]: 231254 : if (block.m_checked_merkle_root) return true;
3903 : :
3904 : 223458 : bool mutated;
3905 : 223458 : uint256 merkle_root = BlockMerkleRoot(block, &mutated);
3906 [ + + ]: 223458 : if (block.hashMerkleRoot != merkle_root) {
3907 [ + - ]: 15327 : return state.Invalid(
3908 : : /*result=*/BlockValidationResult::BLOCK_MUTATED,
3909 [ + - ]: 30654 : /*reject_reason=*/"bad-txnmrklroot",
3910 : 30654 : /*debug_message=*/"hashMerkleRoot mismatch");
3911 : : }
3912 : :
3913 : : // Check for merkle tree malleability (CVE-2012-2459): repeating sequences
3914 : : // of transactions in a block without affecting the merkle root of a block,
3915 : : // while still invalidating it.
3916 [ + + ]: 208131 : if (mutated) {
3917 [ + - ]: 3154 : return state.Invalid(
3918 : : /*result=*/BlockValidationResult::BLOCK_MUTATED,
3919 [ + - ]: 6308 : /*reject_reason=*/"bad-txns-duplicate",
3920 : 6308 : /*debug_message=*/"duplicate transaction");
3921 : : }
3922 : :
3923 : 204977 : block.m_checked_merkle_root = true;
3924 : 204977 : return true;
3925 : : }
3926 : :
3927 : : /** CheckWitnessMalleation performs checks for block malleation with regard to
3928 : : * its witnesses.
3929 : : *
3930 : : * Note: If the witness commitment is expected (i.e. `expect_witness_commitment
3931 : : * = true`), then the block is required to have at least one transaction and the
3932 : : * first transaction needs to have at least one input. */
3933 : 375837 : static bool CheckWitnessMalleation(const CBlock& block, bool expect_witness_commitment, BlockValidationState& state)
3934 : : {
3935 [ + + ]: 375837 : if (expect_witness_commitment) {
3936 [ + + ]: 368680 : if (block.m_checked_witness_commitment) return true;
3937 : :
3938 : 197899 : int commitpos = GetWitnessCommitmentIndex(block);
3939 [ + + ]: 197899 : if (commitpos != NO_WITNESS_COMMITMENT) {
3940 [ + - - + ]: 197485 : assert(!block.vtx.empty() && !block.vtx[0]->vin.empty());
3941 [ - + ]: 197485 : const auto& witness_stack{block.vtx[0]->vin[0].scriptWitness.stack};
3942 : :
3943 [ - + + - : 197485 : if (witness_stack.size() != 1 || witness_stack[0].size() != 32) {
- + + + ]
3944 [ + - ]: 1 : return state.Invalid(
3945 : : /*result=*/BlockValidationResult::BLOCK_MUTATED,
3946 [ + - ]: 2 : /*reject_reason=*/"bad-witness-nonce-size",
3947 : 2 : /*debug_message=*/strprintf("%s : invalid witness reserved value size", __func__));
3948 : : }
3949 : :
3950 : : // The malleation check is ignored; as the transaction tree itself
3951 : : // already does not permit it, it is impossible to trigger in the
3952 : : // witness tree.
3953 : 197484 : uint256 hash_witness = BlockWitnessMerkleRoot(block);
3954 : :
3955 [ - + ]: 197484 : CHash256().Write(hash_witness).Write(witness_stack[0]).Finalize(hash_witness);
3956 [ - + + + ]: 394968 : if (memcmp(hash_witness.begin(), &block.vtx[0]->vout[commitpos].scriptPubKey[6], 32)) {
3957 [ + - ]: 2 : return state.Invalid(
3958 : : /*result=*/BlockValidationResult::BLOCK_MUTATED,
3959 [ + - ]: 4 : /*reject_reason=*/"bad-witness-merkle-match",
3960 : 4 : /*debug_message=*/strprintf("%s : witness merkle commitment mismatch", __func__));
3961 : : }
3962 : :
3963 : 197482 : block.m_checked_witness_commitment = true;
3964 : 197482 : return true;
3965 : : }
3966 : : }
3967 : :
3968 : : // No witness data is allowed in blocks that don't commit to witness data, as this would otherwise leave room for spam
3969 [ + + ]: 15138 : for (const auto& tx : block.vtx) {
3970 [ + + ]: 7571 : if (tx->HasWitness()) {
3971 [ + - ]: 4 : return state.Invalid(
3972 : : /*result=*/BlockValidationResult::BLOCK_MUTATED,
3973 [ + - ]: 8 : /*reject_reason=*/"unexpected-witness",
3974 : 8 : /*debug_message=*/strprintf("%s : unexpected witness data found", __func__));
3975 : : }
3976 : : }
3977 : :
3978 : : return true;
3979 : : }
3980 : :
3981 : 963178 : bool CheckBlock(const CBlock& block, BlockValidationState& state, const Consensus::Params& consensusParams, bool fCheckPOW, bool fCheckMerkleRoot)
3982 : : {
3983 : : // These are checks that are independent of context.
3984 : :
3985 [ + + ]: 963178 : if (block.fChecked)
3986 : : return true;
3987 : :
3988 : : // Check that the header is valid (particularly PoW). This is mostly
3989 : : // redundant with the call in AcceptBlockHeader.
3990 [ + + ]: 620792 : if (!CheckBlockHeader(block, state, consensusParams, fCheckPOW))
3991 : : return false;
3992 : :
3993 : : // Signet only: check block solution
3994 [ - + - - : 619248 : if (consensusParams.signet_blocks && fCheckPOW && !CheckSignetBlockSolution(block, consensusParams)) {
- - ]
3995 [ # # # # ]: 0 : return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-signet-blksig", "signet block signature validation failure");
3996 : : }
3997 : :
3998 : : // Check the merkle root.
3999 [ + + + + ]: 619248 : if (fCheckMerkleRoot && !CheckMerkleRoot(block, state)) {
4000 : : return false;
4001 : : }
4002 : :
4003 : : // All potential-corruption validation must be done before we do any
4004 : : // transaction validation, as otherwise we may mark the header as invalid
4005 : : // because we receive the wrong transactions for it.
4006 : : // Note that witness malleability is checked in ContextualCheckBlock, so no
4007 : : // checks that use witness data may be performed here.
4008 : :
4009 : : // Size limits
4010 [ + + - + : 600901 : if (block.vtx.empty() || block.vtx.size() * WITNESS_SCALE_FACTOR > MAX_BLOCK_WEIGHT || ::GetSerializeSize(TX_NO_WITNESS(block)) * WITNESS_SCALE_FACTOR > MAX_BLOCK_WEIGHT)
+ - + + ]
4011 [ + - + - ]: 468 : return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-length", "size limits failed");
4012 : :
4013 : : // First transaction must be coinbase, the rest must not be
4014 [ + - + + ]: 600433 : if (block.vtx.empty() || !block.vtx[0]->IsCoinBase())
4015 [ + - + - ]: 4443 : return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-missing", "first tx is not coinbase");
4016 [ - + + + ]: 843670 : for (unsigned int i = 1; i < block.vtx.size(); i++)
4017 [ + + ]: 247695 : if (block.vtx[i]->IsCoinBase())
4018 [ + - + - ]: 15 : return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-multiple", "more than one coinbase");
4019 : :
4020 : : // Check transactions
4021 : : // Must check for duplicate inputs (see CVE-2018-17144)
4022 [ + + ]: 1279233 : for (const auto& tx : block.vtx) {
4023 [ + - ]: 684256 : TxValidationState tx_state;
4024 [ + - + + ]: 684256 : if (!CheckTransaction(*tx, tx_state)) {
4025 : : // CheckBlock() does context-free validation checks. The only
4026 : : // possible failures are consensus failures.
4027 [ - + ]: 998 : assert(tx_state.GetResult() == TxValidationResult::TX_CONSENSUS);
4028 [ - + + - ]: 1996 : return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, tx_state.GetRejectReason(),
4029 [ + - + - ]: 1996 : strprintf("Transaction check failed (tx hash %s) %s", tx->GetHash().ToString(), tx_state.GetDebugMessage()));
4030 : : }
4031 : 684256 : }
4032 : : // This underestimates the number of sigops, because unlike ConnectBlock it
4033 : : // does not count witness and p2sh sigops.
4034 : 594977 : unsigned int nSigOps = 0;
4035 [ + + ]: 1268489 : for (const auto& tx : block.vtx)
4036 : : {
4037 : 673512 : nSigOps += GetLegacySigOpCount(*tx);
4038 : : }
4039 [ + + ]: 594977 : if (nSigOps * WITNESS_SCALE_FACTOR > MAX_BLOCK_SIGOPS_COST)
4040 [ + - + - ]: 18 : return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-sigops", "out-of-bounds SigOpCount");
4041 : :
4042 [ + + ]: 594959 : if (fCheckPOW && fCheckMerkleRoot)
4043 : 199789 : block.fChecked = true;
4044 : :
4045 : : return true;
4046 : : }
4047 : :
4048 : 305699 : void ChainstateManager::UpdateUncommittedBlockStructures(CBlock& block, const CBlockIndex* pindexPrev) const
4049 : : {
4050 : 305699 : int commitpos = GetWitnessCommitmentIndex(block);
4051 [ + + + - : 305699 : static const std::vector<unsigned char> nonce(32, 0x00);
+ - ]
4052 [ + + + - : 305699 : if (commitpos != NO_WITNESS_COMMITMENT && DeploymentActiveAfter(pindexPrev, *this, Consensus::DEPLOYMENT_SEGWIT) && !block.vtx[0]->HasWitness()) {
+ + ]
4053 : 197482 : CMutableTransaction tx(*block.vtx[0]);
4054 [ + - ]: 197482 : tx.vin[0].scriptWitness.stack.resize(1);
4055 [ + - ]: 197482 : tx.vin[0].scriptWitness.stack[0] = nonce;
4056 [ + - - + ]: 394964 : block.vtx[0] = MakeTransactionRef(std::move(tx));
4057 : 197482 : }
4058 : 305699 : }
4059 : :
4060 : 305645 : std::vector<unsigned char> ChainstateManager::GenerateCoinbaseCommitment(CBlock& block, const CBlockIndex* pindexPrev) const
4061 : : {
4062 : 305645 : std::vector<unsigned char> commitment;
4063 : 305645 : int commitpos = GetWitnessCommitmentIndex(block);
4064 [ + - ]: 305645 : std::vector<unsigned char> ret(32, 0x00);
4065 [ + + ]: 305645 : if (commitpos == NO_WITNESS_COMMITMENT) {
4066 [ + - ]: 303553 : uint256 witnessroot = BlockWitnessMerkleRoot(block);
4067 [ + - + - : 303553 : CHash256().Write(witnessroot).Write(ret).Finalize(witnessroot);
- + + - +
- ]
4068 : 303553 : CTxOut out;
4069 : 303553 : out.nValue = 0;
4070 : 303553 : out.scriptPubKey.resize(MINIMUM_WITNESS_COMMITMENT);
4071 [ + - ]: 303553 : out.scriptPubKey[0] = OP_RETURN;
4072 [ + - ]: 303553 : out.scriptPubKey[1] = 0x24;
4073 [ + - ]: 303553 : out.scriptPubKey[2] = 0xaa;
4074 [ + - ]: 303553 : out.scriptPubKey[3] = 0x21;
4075 [ + - ]: 303553 : out.scriptPubKey[4] = 0xa9;
4076 [ + - ]: 303553 : out.scriptPubKey[5] = 0xed;
4077 [ + - + - ]: 607106 : memcpy(&out.scriptPubKey[6], witnessroot.begin(), 32);
4078 [ + - + - : 910659 : commitment = std::vector<unsigned char>(out.scriptPubKey.begin(), out.scriptPubKey.end());
+ - ]
4079 [ + - ]: 303553 : CMutableTransaction tx(*block.vtx[0]);
4080 [ + - ]: 303553 : tx.vout.push_back(out);
4081 [ + - - + ]: 607106 : block.vtx[0] = MakeTransactionRef(std::move(tx));
4082 : 303553 : }
4083 [ + - ]: 305645 : UpdateUncommittedBlockStructures(block, pindexPrev);
4084 : 305645 : return commitment;
4085 : 305645 : }
4086 : :
4087 : 17779 : bool HasValidProofOfWork(const std::vector<CBlockHeader>& headers, const Consensus::Params& consensusParams)
4088 : : {
4089 : 17779 : return std::all_of(headers.cbegin(), headers.cend(),
4090 : 206474 : [&](const auto& header) { return CheckProofOfWork(header.GetHash(), header.nBits, consensusParams);});
4091 : : }
4092 : :
4093 : 8366 : bool IsBlockMutated(const CBlock& block, bool check_witness_root)
4094 : : {
4095 [ + - ]: 8366 : BlockValidationState state;
4096 [ + - + + ]: 8366 : if (!CheckMerkleRoot(block, state)) {
4097 [ + - - + : 134 : LogDebug(BCLog::VALIDATION, "Block mutated: %s\n", state.ToString());
- - - - ]
4098 : 134 : return true;
4099 : : }
4100 : :
4101 [ + + + + ]: 8232 : if (block.vtx.empty() || !block.vtx[0]->IsCoinBase()) {
4102 : : // Consider the block mutated if any transaction is 64 bytes in size (see 3.1
4103 : : // in "Weaknesses in Bitcoin’s Merkle Root Construction":
4104 : : // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/attachments/20190225/a27d8837/attachment-0001.pdf).
4105 : : //
4106 : : // Note: This is not a consensus change as this only applies to blocks that
4107 : : // don't have a coinbase transaction and would therefore already be invalid.
4108 : 1058 : return std::any_of(block.vtx.begin(), block.vtx.end(),
4109 : 1940 : [](auto& tx) { return GetSerializeSize(TX_NO_WITNESS(tx)) == 64; });
4110 : : } else {
4111 : : // Theoretically it is still possible for a block with a 64 byte
4112 : : // coinbase transaction to be mutated but we neglect that possibility
4113 : : // here as it requires at least 224 bits of work.
4114 : : }
4115 : :
4116 [ + - + + ]: 7174 : if (!CheckWitnessMalleation(block, check_witness_root, state)) {
4117 [ + - - + : 7 : LogDebug(BCLog::VALIDATION, "Block mutated: %s\n", state.ToString());
- - - - ]
4118 : 7 : return true;
4119 : : }
4120 : :
4121 : : return false;
4122 : 8366 : }
4123 : :
4124 : 15234 : arith_uint256 CalculateClaimedHeadersWork(std::span<const CBlockHeader> headers)
4125 : : {
4126 : 15234 : arith_uint256 total_work{0};
4127 [ + + ]: 257114 : for (const CBlockHeader& header : headers) {
4128 : 241880 : CBlockIndex dummy(header);
4129 : 241880 : total_work += GetBlockProof(dummy);
4130 : : }
4131 : 15234 : return total_work;
4132 : : }
4133 : :
4134 : : /** Context-dependent validity checks.
4135 : : * By "context", we mean only the previous block headers, but not the UTXO
4136 : : * set; UTXO-related validity checks are done in ConnectBlock().
4137 : : * NOTE: This function is not currently invoked by ConnectBlock(), so we
4138 : : * should consider upgrade issues if we change which consensus rules are
4139 : : * enforced in this function (eg by adding a new consensus rule). See comment
4140 : : * in ConnectBlock().
4141 : : * Note that -reindex-chainstate skips the validation that happens here!
4142 : : *
4143 : : * NOTE: failing to check the header's height against the last checkpoint's opened a DoS vector between
4144 : : * v0.12 and v0.15 (when no additional protection was in place) whereby an attacker could unboundedly
4145 : : * grow our in-memory block index. See https://bitcoincore.org/en/2024/07/03/disclose-header-spam.
4146 : : */
4147 : 531751 : static bool ContextualCheckBlockHeader(const CBlockHeader& block, BlockValidationState& state, BlockManager& blockman, const ChainstateManager& chainman, const CBlockIndex* pindexPrev) EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
4148 : : {
4149 : 531751 : AssertLockHeld(::cs_main);
4150 [ - + ]: 531751 : assert(pindexPrev != nullptr);
4151 : 531751 : const int nHeight = pindexPrev->nHeight + 1;
4152 : :
4153 : : // Check proof of work
4154 : 531751 : const Consensus::Params& consensusParams = chainman.GetConsensus();
4155 [ + + ]: 531751 : if (block.nBits != GetNextWorkRequired(pindexPrev, &block, consensusParams))
4156 [ + - + - ]: 10524 : return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "bad-diffbits", "incorrect proof of work");
4157 : :
4158 : : // Check timestamp against prev
4159 [ + + ]: 521227 : if (block.GetBlockTime() <= pindexPrev->GetMedianTimePast())
4160 [ + - + - ]: 3333 : return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "time-too-old", "block's timestamp is too early");
4161 : :
4162 : : // Testnet4 and regtest only: Check timestamp against prev for difficulty-adjustment
4163 : : // blocks to prevent timewarp attacks (see https://github.com/bitcoin/bitcoin/pull/15482).
4164 [ - + ]: 517894 : if (consensusParams.enforce_BIP94) {
4165 : : // Check timestamp for the first block of each difficulty adjustment
4166 : : // interval, except the genesis block.
4167 [ # # ]: 0 : if (nHeight % consensusParams.DifficultyAdjustmentInterval() == 0) {
4168 [ # # ]: 0 : if (block.GetBlockTime() < pindexPrev->GetBlockTime() - MAX_TIMEWARP) {
4169 [ # # # # ]: 0 : return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "time-timewarp-attack", "block's timestamp is too early on diff adjustment block");
4170 : : }
4171 : : }
4172 : : }
4173 : :
4174 : : // Check timestamp
4175 [ + + ]: 517894 : if (block.Time() > NodeClock::now() + std::chrono::seconds{MAX_FUTURE_BLOCK_TIME}) {
4176 [ + - + - ]: 17231 : return state.Invalid(BlockValidationResult::BLOCK_TIME_FUTURE, "time-too-new", "block timestamp too far in the future");
4177 : : }
4178 : :
4179 : : // Reject blocks with outdated version
4180 [ + + + + ]: 500663 : if ((block.nVersion < 2 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_HEIGHTINCB)) ||
4181 [ + + + + : 995018 : (block.nVersion < 3 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_DERSIG)) ||
+ + ]
4182 [ + + ]: 2479 : (block.nVersion < 4 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_CLTV))) {
4183 [ + - + - ]: 9395 : return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, strprintf("bad-version(0x%08x)", block.nVersion),
4184 : 18790 : strprintf("rejected nVersion=0x%08x block", block.nVersion));
4185 : : }
4186 : :
4187 : : return true;
4188 : : }
4189 : :
4190 : : /** NOTE: This function is not currently invoked by ConnectBlock(), so we
4191 : : * should consider upgrade issues if we change which consensus rules are
4192 : : * enforced in this function (eg by adding a new consensus rule). See comment
4193 : : * in ConnectBlock().
4194 : : * Note that -reindex-chainstate skips the validation that happens here!
4195 : : */
4196 : 368663 : static bool ContextualCheckBlock(const CBlock& block, BlockValidationState& state, const ChainstateManager& chainman, const CBlockIndex* pindexPrev)
4197 : : {
4198 [ + - ]: 368663 : const int nHeight = pindexPrev == nullptr ? 0 : pindexPrev->nHeight + 1;
4199 : :
4200 : : // Enforce BIP113 (Median Time Past).
4201 : 368663 : bool enforce_locktime_median_time_past{false};
4202 [ + - ]: 368663 : if (DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_CSV)) {
4203 [ - + ]: 368663 : assert(pindexPrev != nullptr);
4204 : : enforce_locktime_median_time_past = true;
4205 : : }
4206 : :
4207 : 368663 : const int64_t nLockTimeCutoff{enforce_locktime_median_time_past ?
4208 : 368663 : pindexPrev->GetMedianTimePast() :
4209 : 0 : block.GetBlockTime()};
4210 : :
4211 : : // Check that all transactions are finalized
4212 [ + + ]: 769282 : for (const auto& tx : block.vtx) {
4213 [ - + ]: 400619 : if (!IsFinalTx(*tx, nHeight, nLockTimeCutoff)) {
4214 [ # # # # ]: 0 : return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-nonfinal", "non-final transaction");
4215 : : }
4216 : : }
4217 : :
4218 : : // Enforce rule that the coinbase starts with serialized block height
4219 [ + + ]: 368663 : if (DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_HEIGHTINCB))
4220 : : {
4221 [ + - ]: 364961 : CScript expect = CScript() << nHeight;
4222 [ - + - + : 729922 : if (block.vtx[0]->vin[0].scriptSig.size() < expect.size() ||
+ - + - ]
4223 [ + - - + ]: 729922 : !std::equal(expect.begin(), expect.end(), block.vtx[0]->vin[0].scriptSig.begin())) {
4224 [ # # # # : 0 : return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-height", "block height mismatch in coinbase");
# # ]
4225 : : }
4226 : 364961 : }
4227 : :
4228 : : // Validation for witness commitments.
4229 : : // * We compute the witness hash (which is the hash including witnesses) of all the block's transactions, except the
4230 : : // coinbase (where 0x0000....0000 is used instead).
4231 : : // * The coinbase scriptWitness is a stack of a single 32-byte vector, containing a witness reserved value (unconstrained).
4232 : : // * We build a merkle tree with all those witness hashes as leaves (similar to the hashMerkleRoot in the block header).
4233 : : // * There must be at least one output whose scriptPubKey is a single 36-byte push, the first 4 bytes of which are
4234 : : // {0xaa, 0x21, 0xa9, 0xed}, and the following 32 bytes are SHA256^2(witness root, witness reserved value). In case there are
4235 : : // multiple, the last one is used.
4236 [ + - ]: 368663 : if (!CheckWitnessMalleation(block, DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_SEGWIT), state)) {
4237 : : return false;
4238 : : }
4239 : :
4240 : : // After the coinbase witness reserved value and commitment are verified,
4241 : : // we can check if the block weight passes (before we've checked the
4242 : : // coinbase witness, it would be possible for the weight to be too
4243 : : // large by filling up the coinbase witness, which doesn't change
4244 : : // the block hash, so we couldn't mark the block as permanently
4245 : : // failed).
4246 [ - + ]: 368663 : if (GetBlockWeight(block) > MAX_BLOCK_WEIGHT) {
4247 [ # # # # ]: 0 : return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-weight", strprintf("%s : weight limit failed", __func__));
4248 : : }
4249 : :
4250 : : return true;
4251 : : }
4252 : :
4253 : 393434 : bool ChainstateManager::AcceptBlockHeader(const CBlockHeader& block, BlockValidationState& state, CBlockIndex** ppindex, bool min_pow_checked)
4254 : : {
4255 : 393434 : AssertLockHeld(cs_main);
4256 : :
4257 : : // Check for duplicate
4258 : 393434 : uint256 hash = block.GetHash();
4259 : 393434 : BlockMap::iterator miSelf{m_blockman.m_block_index.find(hash)};
4260 [ + - ]: 393434 : if (hash != GetConsensus().hashGenesisBlock) {
4261 [ + + ]: 393434 : if (miSelf != m_blockman.m_block_index.end()) {
4262 : : // Block header is already known.
4263 [ + - ]: 31312 : CBlockIndex* pindex = &(miSelf->second);
4264 [ + - ]: 31312 : if (ppindex)
4265 : 31312 : *ppindex = pindex;
4266 [ + + ]: 31312 : if (pindex->nStatus & BLOCK_FAILED_MASK) {
4267 [ + + + - ]: 26169 : LogDebug(BCLog::VALIDATION, "%s: block %s is marked invalid\n", __func__, hash.ToString());
4268 [ + - + - ]: 14569 : return state.Invalid(BlockValidationResult::BLOCK_CACHED_INVALID, "duplicate-invalid",
4269 [ + - ]: 29138 : strprintf("block %s was previously marked invalid", hash.ToString()));
4270 : : }
4271 : : return true;
4272 : : }
4273 : :
4274 [ + + ]: 362122 : if (!CheckBlockHeader(block, state, GetConsensus())) {
4275 [ + + + - : 17802 : LogDebug(BCLog::VALIDATION, "%s: Consensus::CheckBlockHeader: %s, %s\n", __func__, hash.ToString(), state.ToString());
+ - ]
4276 : 17799 : return false;
4277 : : }
4278 : :
4279 : : // Get prev block index
4280 : 344323 : CBlockIndex* pindexPrev = nullptr;
4281 : 344323 : BlockMap::iterator mi{m_blockman.m_block_index.find(block.hashPrevBlock)};
4282 [ + + ]: 344323 : if (mi == m_blockman.m_block_index.end()) {
4283 [ - + - - : 7594 : LogDebug(BCLog::VALIDATION, "header %s has prev block not found: %s\n", hash.ToString(), block.hashPrevBlock.ToString());
- - ]
4284 [ + - + - ]: 7594 : return state.Invalid(BlockValidationResult::BLOCK_MISSING_PREV, "prev-blk-not-found");
4285 : : }
4286 [ + + ]: 336729 : pindexPrev = &((*mi).second);
4287 [ + + ]: 336729 : if (pindexPrev->nStatus & BLOCK_FAILED_MASK) {
4288 [ - + - - : 2460 : LogDebug(BCLog::VALIDATION, "header %s has prev block invalid: %s\n", hash.ToString(), block.hashPrevBlock.ToString());
- - ]
4289 [ + - + - ]: 2460 : return state.Invalid(BlockValidationResult::BLOCK_INVALID_PREV, "bad-prevblk");
4290 : : }
4291 [ + + ]: 334269 : if (!ContextualCheckBlockHeader(block, state, m_blockman, *this, pindexPrev)) {
4292 [ + + + - : 40493 : LogDebug(BCLog::VALIDATION, "%s: Consensus::ContextualCheckBlockHeader: %s, %s\n", __func__, hash.ToString(), state.ToString());
+ - ]
4293 : 40483 : return false;
4294 : : }
4295 : : }
4296 [ + + ]: 293786 : if (!min_pow_checked) {
4297 [ - + - - ]: 883 : LogDebug(BCLog::VALIDATION, "%s: not adding new block header %s, missing anti-dos proof-of-work validation\n", __func__, hash.ToString());
4298 [ + - + - ]: 883 : return state.Invalid(BlockValidationResult::BLOCK_HEADER_LOW_WORK, "too-little-chainwork");
4299 : : }
4300 : 292903 : CBlockIndex* pindex{m_blockman.AddToBlockIndex(block, m_best_header)};
4301 : :
4302 [ + - ]: 292903 : if (ppindex)
4303 : 292903 : *ppindex = pindex;
4304 : :
4305 : : return true;
4306 : : }
4307 : :
4308 : : // Exposed wrapper for AcceptBlockHeader
4309 : 123363 : bool ChainstateManager::ProcessNewBlockHeaders(std::span<const CBlockHeader> headers, bool min_pow_checked, BlockValidationState& state, const CBlockIndex** ppindex)
4310 : : {
4311 : 123363 : AssertLockNotHeld(cs_main);
4312 : 123363 : {
4313 : 123363 : LOCK(cs_main);
4314 [ + + ]: 245391 : for (const CBlockHeader& header : headers) {
4315 : 123422 : CBlockIndex *pindex = nullptr; // Use a temp pindex instead of ppindex to avoid a const_cast
4316 [ + - ]: 123422 : bool accepted{AcceptBlockHeader(header, state, &pindex, min_pow_checked)};
4317 [ + - ]: 123422 : CheckBlockIndex();
4318 : :
4319 [ + + ]: 123422 : if (!accepted) {
4320 [ + - ]: 1394 : return false;
4321 : : }
4322 [ + + ]: 122028 : if (ppindex) {
4323 : 1716 : *ppindex = pindex;
4324 : : }
4325 : : }
4326 : 1394 : }
4327 [ + + ]: 121969 : if (NotifyHeaderTip()) {
4328 [ + + - + : 120209 : if (IsInitialBlockDownload() && ppindex && *ppindex) {
- - ]
4329 : 0 : const CBlockIndex& last_accepted{**ppindex};
4330 : 0 : int64_t blocks_left{(NodeClock::now() - last_accepted.Time()) / GetConsensus().PowTargetSpacing()};
4331 [ # # ]: 0 : blocks_left = std::max<int64_t>(0, blocks_left);
4332 : 0 : const double progress{100.0 * last_accepted.nHeight / (last_accepted.nHeight + blocks_left)};
4333 : 0 : LogInfo("Synchronizing blockheaders, height: %d (~%.2f%%)\n", last_accepted.nHeight, progress);
4334 : : }
4335 : : }
4336 : : return true;
4337 : : }
4338 : :
4339 : 5593 : void ChainstateManager::ReportHeadersPresync(const arith_uint256& work, int64_t height, int64_t timestamp)
4340 : : {
4341 : 5593 : AssertLockNotHeld(GetMutex());
4342 : 5593 : {
4343 : 5593 : LOCK(GetMutex());
4344 : : // Don't report headers presync progress if we already have a post-minchainwork header chain.
4345 : : // This means we lose reporting for potentially legitimate, but unlikely, deep reorgs, but
4346 : : // prevent attackers that spam low-work headers from filling our logs.
4347 [ + - + - : 5593 : if (m_best_header->nChainWork >= UintToArith256(GetConsensus().nMinimumChainWork)) return;
+ - ]
4348 : : // Rate limit headers presync updates to 4 per second, as these are not subject to DoS
4349 : : // protection.
4350 : 5593 : auto now = MockableSteadyClock::now();
4351 [ - + ]: 5593 : if (now < m_last_presync_update + std::chrono::milliseconds{250}) return;
4352 [ # # ]: 0 : m_last_presync_update = now;
4353 : 5593 : }
4354 : 0 : bool initial_download = IsInitialBlockDownload();
4355 : 0 : GetNotifications().headerTip(GetSynchronizationState(initial_download, m_blockman.m_blockfiles_indexed), height, timestamp, /*presync=*/true);
4356 [ # # ]: 0 : if (initial_download) {
4357 : 0 : int64_t blocks_left{(NodeClock::now() - NodeSeconds{std::chrono::seconds{timestamp}}) / GetConsensus().PowTargetSpacing()};
4358 [ # # ]: 0 : blocks_left = std::max<int64_t>(0, blocks_left);
4359 : 0 : const double progress{100.0 * height / (height + blocks_left)};
4360 : 0 : LogInfo("Pre-synchronizing blockheaders, height: %d (~%.2f%%)\n", height, progress);
4361 : : }
4362 : : }
4363 : :
4364 : : /** Store block on disk. If dbp is non-nullptr, the file is known to already reside on disk */
4365 : 270012 : bool ChainstateManager::AcceptBlock(const std::shared_ptr<const CBlock>& pblock, BlockValidationState& state, CBlockIndex** ppindex, bool fRequested, const FlatFilePos* dbp, bool* fNewBlock, bool min_pow_checked)
4366 : : {
4367 [ + + ]: 270012 : const CBlock& block = *pblock;
4368 : :
4369 [ + + ]: 270012 : if (fNewBlock) *fNewBlock = false;
4370 : 270012 : AssertLockHeld(cs_main);
4371 : :
4372 : 270012 : CBlockIndex *pindexDummy = nullptr;
4373 [ + + ]: 270012 : CBlockIndex *&pindex = ppindex ? *ppindex : pindexDummy;
4374 : :
4375 : 270012 : bool accepted_header{AcceptBlockHeader(block, state, &pindex, min_pow_checked)};
4376 : 270012 : CheckBlockIndex();
4377 : :
4378 [ + + ]: 270012 : if (!accepted_header)
4379 : : return false;
4380 : :
4381 : : // Check all requested blocks that we do not already have for validity and
4382 : : // save them to disk. Skip processing of unrequested blocks as an anti-DoS
4383 : : // measure, unless the blocks have more work than the active chain tip, and
4384 : : // aren't too far ahead of it, so are likely to be attached soon.
4385 : 187618 : bool fAlreadyHave = pindex->nStatus & BLOCK_HAVE_DATA;
4386 [ + - + - ]: 187618 : bool fHasMoreOrSameWork = (ActiveTip() ? pindex->nChainWork >= ActiveTip()->nChainWork : true);
4387 : : // Blocks that are too out-of-order needlessly limit the effectiveness of
4388 : : // pruning, because pruning will not delete block files that contain any
4389 : : // blocks which are too close in height to the tip. Apply this test
4390 : : // regardless of whether pruning is enabled; it should generally be safe to
4391 : : // not process unrequested blocks.
4392 : 187618 : bool fTooFarAhead{pindex->nHeight > ActiveHeight() + int(MIN_BLOCKS_TO_KEEP)};
4393 : :
4394 : : // TODO: Decouple this function from the block download logic by removing fRequested
4395 : : // This requires some new chain data structure to efficiently look up if a
4396 : : // block is in a chain leading to a candidate for best tip, despite not
4397 : : // being such a candidate itself.
4398 : : // Note that this would break the getblockfrompeer RPC
4399 : :
4400 : : // TODO: deal better with return value and error conditions for duplicate
4401 : : // and unrequested blocks.
4402 [ + - ]: 187618 : if (fAlreadyHave) return true;
4403 [ - + ]: 187618 : if (!fRequested) { // If we didn't ask for it:
4404 [ # # ]: 0 : if (pindex->nTx != 0) return true; // This is a previously-processed block that was pruned
4405 [ # # ]: 0 : if (!fHasMoreOrSameWork) return true; // Don't process less-work chains
4406 [ # # ]: 0 : if (fTooFarAhead) return true; // Block height is too high
4407 : :
4408 : : // Protect against DoS attacks from low-work chains.
4409 : : // If our tip is behind, a peer could try to send us
4410 : : // low-work blocks on a fake chain that we would never
4411 : : // request; don't process these.
4412 [ # # ]: 0 : if (pindex->nChainWork < MinimumChainWork()) return true;
4413 : : }
4414 : :
4415 : 187618 : const CChainParams& params{GetParams()};
4416 : :
4417 [ + + - + ]: 358799 : if (!CheckBlock(block, state, params.GetConsensus()) ||
4418 : 171181 : !ContextualCheckBlock(block, state, *this, pindex->pprev)) {
4419 [ + - ]: 16437 : if (Assume(state.IsInvalid())) {
4420 : 16437 : ActiveChainstate().InvalidBlockFound(pindex, state);
4421 : : }
4422 [ + - ]: 16437 : LogError("%s: %s\n", __func__, state.ToString());
4423 : 16437 : return false;
4424 : : }
4425 : :
4426 : : // Header is valid/has work, merkle tree and segwit merkle tree are good...RELAY NOW
4427 : : // (but if it does not build on our best tip, let the SendMessages loop relay it)
4428 [ + + + - : 171181 : if (!IsInitialBlockDownload() && ActiveTip() == pindex->pprev && m_options.signals) {
+ - ]
4429 : 87789 : m_options.signals->NewPoWValidBlock(pindex, pblock);
4430 : : }
4431 : :
4432 : : // Write block to history file
4433 [ + - ]: 171181 : if (fNewBlock) *fNewBlock = true;
4434 : 171181 : try {
4435 : 171181 : FlatFilePos blockPos{};
4436 [ - + ]: 171181 : if (dbp) {
4437 : 0 : blockPos = *dbp;
4438 [ # # ]: 0 : m_blockman.UpdateBlockInfo(block, pindex->nHeight, blockPos);
4439 : : } else {
4440 [ + - ]: 171181 : blockPos = m_blockman.WriteBlock(block, pindex->nHeight);
4441 [ - + ]: 171181 : if (blockPos.IsNull()) {
4442 [ # # ]: 0 : state.Error(strprintf("%s: Failed to find position to write new block to disk", __func__));
4443 : 0 : return false;
4444 : : }
4445 : : }
4446 [ + - ]: 171181 : ReceivedBlockTransactions(block, pindex, blockPos);
4447 [ - - ]: 0 : } catch (const std::runtime_error& e) {
4448 [ - - - - ]: 0 : return FatalError(GetNotifications(), state, strprintf(_("System error while saving block to disk: %s"), e.what()));
4449 : 0 : }
4450 : :
4451 : : // TODO: FlushStateToDisk() handles flushing of both block and chainstate
4452 : : // data, so we should move this to ChainstateManager so that we can be more
4453 : : // intelligent about how we flush.
4454 : : // For now, since FlushStateMode::NONE is used, all that can happen is that
4455 : : // the block files may be pruned, so we can just call this on one
4456 : : // chainstate (particularly if we haven't implemented pruning with
4457 : : // background validation yet).
4458 : 171181 : ActiveChainstate().FlushStateToDisk(state, FlushStateMode::NONE);
4459 : :
4460 : 171181 : CheckBlockIndex();
4461 : :
4462 : 171181 : return true;
4463 : : }
4464 : :
4465 : 203388 : bool ChainstateManager::ProcessNewBlock(const std::shared_ptr<const CBlock>& block, bool force_processing, bool min_pow_checked, bool* new_block)
4466 : : {
4467 : 203388 : AssertLockNotHeld(cs_main);
4468 : :
4469 : 203388 : {
4470 : 203388 : CBlockIndex *pindex = nullptr;
4471 [ + - ]: 203388 : if (new_block) *new_block = false;
4472 [ + - ]: 203388 : BlockValidationState state;
4473 : :
4474 : : // CheckBlock() does not support multi-threaded block validation because CBlock::fChecked can cause data race.
4475 : : // Therefore, the following critical section must include the CheckBlock() call as well.
4476 [ + - ]: 203388 : LOCK(cs_main);
4477 : :
4478 : : // Skipping AcceptBlock() for CheckBlock() failures means that we will never mark a block as invalid if
4479 : : // CheckBlock() fails. This is protective against consensus failure if there are any unknown forms of block
4480 : : // malleability that cause CheckBlock() to fail; see e.g. CVE-2012-2459 and
4481 : : // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2019-February/016697.html. Because CheckBlock() is
4482 : : // not very expensive, the anti-DoS benefits of caching failure (of a definitely-invalid block) are not substantial.
4483 [ + - ]: 203388 : bool ret = CheckBlock(*block, state, GetConsensus());
4484 [ + + ]: 203388 : if (ret) {
4485 : : // Store to disk
4486 [ + - ]: 197538 : ret = AcceptBlock(block, state, &pindex, force_processing, nullptr, new_block, min_pow_checked);
4487 : : }
4488 [ + + ]: 197538 : if (!ret) {
4489 [ + + ]: 32207 : if (m_options.signals) {
4490 [ + - ]: 17464 : m_options.signals->BlockChecked(block, state);
4491 : : }
4492 [ + - + - ]: 32207 : LogError("%s: AcceptBlock FAILED (%s)\n", __func__, state.ToString());
4493 [ + - ]: 32207 : return false;
4494 : : }
4495 : 235595 : }
4496 : :
4497 : 171181 : NotifyHeaderTip();
4498 : :
4499 [ + - ]: 171181 : BlockValidationState state; // Only used to report errors, not invalidity - ignore it
4500 [ + - + - : 513543 : if (!ActiveChainstate().ActivateBestChain(state, block)) {
+ - + - -
+ ]
4501 [ # # # # ]: 0 : LogError("%s: ActivateBestChain failed (%s)\n", __func__, state.ToString());
4502 : 0 : return false;
4503 : : }
4504 : :
4505 [ + - + - ]: 342362 : Chainstate* bg_chain{WITH_LOCK(cs_main, return HistoricalChainstate())};
4506 [ - + ]: 171181 : BlockValidationState bg_state;
4507 [ - + - - : 171181 : if (bg_chain && !bg_chain->ActivateBestChain(bg_state, block)) {
- - - - -
+ ]
4508 [ # # # # ]: 0 : LogError("%s: [background] ActivateBestChain failed (%s)\n", __func__, bg_state.ToString());
4509 : 0 : return false;
4510 : : }
4511 : :
4512 : : return true;
4513 : 342362 : }
4514 : :
4515 : 6861 : MempoolAcceptResult ChainstateManager::ProcessTransaction(const CTransactionRef& tx, bool test_accept)
4516 : : {
4517 : 6861 : AssertLockHeld(cs_main);
4518 : 6861 : Chainstate& active_chainstate = ActiveChainstate();
4519 [ - + ]: 6861 : if (!active_chainstate.GetMempool()) {
4520 [ # # ]: 0 : TxValidationState state;
4521 [ # # # # : 0 : state.Invalid(TxValidationResult::TX_NO_MEMPOOL, "no-mempool");
# # ]
4522 [ # # # # ]: 0 : return MempoolAcceptResult::Failure(state);
4523 : 0 : }
4524 : 6861 : auto result = AcceptToMemoryPool(active_chainstate, tx, GetTime(), /*bypass_limits=*/ false, test_accept);
4525 [ - + + - : 6861 : active_chainstate.GetMempool()->check(active_chainstate.CoinsTip(), active_chainstate.m_chain.Height() + 1);
+ - ]
4526 [ + - ]: 6861 : return result;
4527 : 6861 : }
4528 : :
4529 : :
4530 : 197482 : BlockValidationState TestBlockValidity(
4531 : : Chainstate& chainstate,
4532 : : const CBlock& block,
4533 : : const bool check_pow,
4534 : : const bool check_merkle_root)
4535 : : {
4536 : : // Lock must be held throughout this function for two reasons:
4537 : : // 1. We don't want the tip to change during several of the validation steps
4538 : : // 2. To prevent a CheckBlock() race condition for fChecked, see ProcessNewBlock()
4539 : 197482 : AssertLockHeld(chainstate.m_chainman.GetMutex());
4540 : :
4541 [ - + ]: 197482 : BlockValidationState state;
4542 [ - + - + ]: 394964 : CBlockIndex* tip{Assert(chainstate.m_chain.Tip())};
4543 : :
4544 [ - + - + ]: 197482 : if (block.hashPrevBlock != *Assert(tip->phashBlock)) {
4545 [ # # # # : 0 : state.Invalid({}, "inconclusive-not-best-prevblk");
# # ]
4546 : 0 : return state;
4547 : : }
4548 : :
4549 : : // For signets CheckBlock() verifies the challenge iff fCheckPow is set.
4550 [ + - - + ]: 197482 : if (!CheckBlock(block, state, chainstate.m_chainman.GetConsensus(), /*fCheckPow=*/check_pow, /*fCheckMerkleRoot=*/check_merkle_root)) {
4551 : : // This should never happen, but belt-and-suspenders don't approve the
4552 : : // block if it does.
4553 [ # # # # ]: 0 : if (state.IsValid()) NONFATAL_UNREACHABLE();
4554 : : return state;
4555 : : }
4556 : :
4557 : : /**
4558 : : * At this point ProcessNewBlock would call AcceptBlock(), but we
4559 : : * don't want to store the block or its header. Run individual checks
4560 : : * instead:
4561 : : * - skip AcceptBlockHeader() because:
4562 : : * - we don't want to update the block index
4563 : : * - we do not care about duplicates
4564 : : * - we already ran CheckBlockHeader() via CheckBlock()
4565 : : * - we already checked for prev-blk-not-found
4566 : : * - we know the tip is valid, so no need to check bad-prevblk
4567 : : * - we already ran CheckBlock()
4568 : : * - do run ContextualCheckBlockHeader()
4569 : : * - do run ContextualCheckBlock()
4570 : : */
4571 : :
4572 [ + - - + ]: 197482 : if (!ContextualCheckBlockHeader(block, state, chainstate.m_blockman, chainstate.m_chainman, tip)) {
4573 [ # # # # ]: 0 : if (state.IsValid()) NONFATAL_UNREACHABLE();
4574 : : return state;
4575 : : }
4576 : :
4577 [ + - - + ]: 197482 : if (!ContextualCheckBlock(block, state, chainstate.m_chainman, tip)) {
4578 [ # # # # ]: 0 : if (state.IsValid()) NONFATAL_UNREACHABLE();
4579 : : return state;
4580 : : }
4581 : :
4582 : : // We don't want ConnectBlock to update the actual chainstate, so create
4583 : : // a cache on top of it, along with a dummy block index.
4584 : 197482 : CBlockIndex index_dummy{block};
4585 [ + - ]: 197482 : uint256 block_hash(block.GetHash());
4586 : 197482 : index_dummy.pprev = tip;
4587 : 197482 : index_dummy.nHeight = tip->nHeight + 1;
4588 : 197482 : index_dummy.phashBlock = &block_hash;
4589 [ + - + - ]: 197482 : CCoinsViewCache view_dummy(&chainstate.CoinsTip());
4590 : :
4591 : : // Set fJustCheck to true in order to update, and not clear, validation caches.
4592 [ + - - + ]: 197482 : if(!chainstate.ConnectBlock(block, state, &index_dummy, view_dummy, /*fJustCheck=*/true)) {
4593 [ # # # # ]: 0 : if (state.IsValid()) NONFATAL_UNREACHABLE();
4594 : : return state;
4595 : : }
4596 : :
4597 : : // Ensure no check returned successfully while also setting an invalid state.
4598 [ - + - - ]: 197482 : if (!state.IsValid()) NONFATAL_UNREACHABLE();
4599 : :
4600 : : return state;
4601 : 197482 : }
4602 : :
4603 : : /* This function is called from the RPC code for pruneblockchain */
4604 : 0 : void PruneBlockFilesManual(Chainstate& active_chainstate, int nManualPruneHeight)
4605 : : {
4606 [ # # ]: 0 : BlockValidationState state;
4607 [ # # # # ]: 0 : if (!active_chainstate.FlushStateToDisk(
4608 : : state, FlushStateMode::NONE, nManualPruneHeight)) {
4609 [ # # # # ]: 0 : LogWarning("Failed to flush state after manual prune (%s)", state.ToString());
4610 : : }
4611 : 0 : }
4612 : :
4613 : 51 : bool Chainstate::LoadChainTip()
4614 : : {
4615 : 51 : AssertLockHeld(cs_main);
4616 : 51 : const CCoinsViewCache& coins_cache = CoinsTip();
4617 [ - + ]: 102 : assert(!coins_cache.GetBestBlock().IsNull()); // Never called when the coins view is empty
4618 [ - + ]: 51 : CBlockIndex* tip = m_chain.Tip();
4619 : :
4620 [ + - - + ]: 51 : if (tip && tip->GetBlockHash() == coins_cache.GetBestBlock()) {
4621 : : return true;
4622 : : }
4623 : :
4624 : : // Load pointer to end of best chain
4625 : 0 : CBlockIndex* pindex = m_blockman.LookupBlockIndex(coins_cache.GetBestBlock());
4626 [ # # ]: 0 : if (!pindex) {
4627 : : return false;
4628 : : }
4629 : 0 : m_chain.SetTip(*pindex);
4630 [ # # ]: 0 : tip = m_chain.Tip();
4631 : :
4632 : : // Make sure our chain tip before shutting down scores better than any other candidate
4633 : : // to maintain a consistent best tip over reboots in case of a tie.
4634 : 0 : auto target = tip;
4635 [ # # ]: 0 : while (target) {
4636 : 0 : target->nSequenceId = SEQ_ID_BEST_CHAIN_FROM_DISK;
4637 : 0 : target = target->pprev;
4638 : : }
4639 : :
4640 : : // Block index candidates are loaded before the chain tip, so we need to replace this entry
4641 : : // Otherwise the scoring will be based on the memory address location instead of the nSequenceId
4642 : 0 : setBlockIndexCandidates.erase(tip);
4643 : 0 : TryAddBlockIndexCandidate(tip);
4644 : 0 : PruneBlockIndexCandidates();
4645 : :
4646 [ # # ]: 0 : tip = m_chain.Tip();
4647 [ # # # # : 0 : LogInfo("Loaded best chain: hashBestChain=%s height=%d date=%s progress=%f",
# # ]
4648 : : tip->GetBlockHash().ToString(),
4649 : : m_chain.Height(),
4650 : : FormatISO8601DateTime(tip->GetBlockTime()),
4651 : : m_chainman.GuessVerificationProgress(tip));
4652 : :
4653 : : // Ensure KernelNotifications m_tip_block is set even if no new block arrives.
4654 [ # # ]: 0 : if (!this->GetRole().historical) {
4655 : : // Ignoring return value for now.
4656 : 0 : (void)m_chainman.GetNotifications().blockTip(
4657 : 0 : /*state=*/GetSynchronizationState(/*init=*/true, m_chainman.m_blockman.m_blockfiles_indexed),
4658 : : /*index=*/*pindex,
4659 : : /*verification_progress=*/m_chainman.GuessVerificationProgress(tip));
4660 : : }
4661 : :
4662 : 0 : CheckForkWarningConditions();
4663 : :
4664 : 0 : return true;
4665 : : }
4666 : :
4667 : 3 : CVerifyDB::CVerifyDB(Notifications& notifications)
4668 : 3 : : m_notifications{notifications}
4669 : : {
4670 [ + - ]: 3 : m_notifications.progress(_("Verifying blocks…"), 0, false);
4671 : 3 : }
4672 : :
4673 : 3 : CVerifyDB::~CVerifyDB()
4674 : : {
4675 : 3 : m_notifications.progress(bilingual_str{}, 100, false);
4676 : 3 : }
4677 : :
4678 : 3 : VerifyDBResult CVerifyDB::VerifyDB(
4679 : : Chainstate& chainstate,
4680 : : const Consensus::Params& consensus_params,
4681 : : CCoinsView& coinsview,
4682 : : int nCheckLevel, int nCheckDepth)
4683 : : {
4684 : 3 : AssertLockHeld(cs_main);
4685 : :
4686 [ - + + - : 6 : if (chainstate.m_chain.Tip() == nullptr || chainstate.m_chain.Tip()->pprev == nullptr) {
- + ]
4687 : : return VerifyDBResult::SUCCESS;
4688 : : }
4689 : :
4690 : : // Verify blocks in the best chain
4691 [ # # # # ]: 0 : if (nCheckDepth <= 0 || nCheckDepth > chainstate.m_chain.Height()) {
4692 : 0 : nCheckDepth = chainstate.m_chain.Height();
4693 : : }
4694 [ # # # # ]: 0 : nCheckLevel = std::max(0, std::min(4, nCheckLevel));
4695 : 0 : LogInfo("Verifying last %i blocks at level %i", nCheckDepth, nCheckLevel);
4696 : 0 : CCoinsViewCache coins(&coinsview);
4697 : 0 : CBlockIndex* pindex;
4698 : 0 : CBlockIndex* pindexFailure = nullptr;
4699 : 0 : int nGoodTransactions = 0;
4700 [ # # ]: 0 : BlockValidationState state;
4701 : 0 : int reportDone = 0;
4702 : 0 : bool skipped_no_block_data{false};
4703 : 0 : bool skipped_l3_checks{false};
4704 [ # # ]: 0 : LogInfo("Verification progress: 0%%");
4705 : :
4706 [ # # ]: 0 : const bool is_snapshot_cs{chainstate.m_from_snapshot_blockhash};
4707 : :
4708 [ # # # # : 0 : for (pindex = chainstate.m_chain.Tip(); pindex && pindex->pprev; pindex = pindex->pprev) {
# # ]
4709 [ # # # # : 0 : const int percentageDone = std::max(1, std::min(99, (int)(((double)(chainstate.m_chain.Height() - pindex->nHeight)) / (double)nCheckDepth * (nCheckLevel >= 4 ? 50 : 100))));
# # # # ]
4710 [ # # ]: 0 : if (reportDone < percentageDone / 10) {
4711 : : // report every 10% step
4712 [ # # ]: 0 : LogInfo("Verification progress: %d%%", percentageDone);
4713 : 0 : reportDone = percentageDone / 10;
4714 : : }
4715 [ # # # # ]: 0 : m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
4716 [ # # # # ]: 0 : if (pindex->nHeight <= chainstate.m_chain.Height() - nCheckDepth) {
4717 : : break;
4718 : : }
4719 [ # # # # : 0 : if ((chainstate.m_blockman.IsPruneMode() || is_snapshot_cs) && !(pindex->nStatus & BLOCK_HAVE_DATA)) {
# # ]
4720 : : // If pruning or running under an assumeutxo snapshot, only go
4721 : : // back as far as we have data.
4722 [ # # ]: 0 : LogInfo("Block verification stopping at height %d (no data). This could be due to pruning or use of an assumeutxo snapshot.", pindex->nHeight);
4723 : : skipped_no_block_data = true;
4724 : : break;
4725 : : }
4726 : 0 : CBlock block;
4727 : : // check level 0: read from disk
4728 [ # # # # ]: 0 : if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
4729 [ # # # # ]: 0 : LogError("Verification error: ReadBlock failed at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4730 : 0 : return VerifyDBResult::CORRUPTED_BLOCK_DB;
4731 : : }
4732 : : // check level 1: verify block validity
4733 [ # # # # : 0 : if (nCheckLevel >= 1 && !CheckBlock(block, state, consensus_params)) {
# # ]
4734 [ # # # # : 0 : LogError("Verification error: found bad block at %d, hash=%s (%s)",
# # ]
4735 : : pindex->nHeight, pindex->GetBlockHash().ToString(), state.ToString());
4736 : 0 : return VerifyDBResult::CORRUPTED_BLOCK_DB;
4737 : : }
4738 : : // check level 2: verify undo validity
4739 [ # # ]: 0 : if (nCheckLevel >= 2 && pindex) {
4740 : 0 : CBlockUndo undo;
4741 [ # # ]: 0 : if (!pindex->GetUndoPos().IsNull()) {
4742 [ # # # # ]: 0 : if (!chainstate.m_blockman.ReadBlockUndo(undo, *pindex)) {
4743 [ # # # # ]: 0 : LogError("Verification error: found bad undo data at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4744 : 0 : return VerifyDBResult::CORRUPTED_BLOCK_DB;
4745 : : }
4746 : : }
4747 : 0 : }
4748 : : // check level 3: check for inconsistencies during memory-only disconnect of tip blocks
4749 [ # # # # : 0 : size_t curr_coins_usage = coins.DynamicMemoryUsage() + chainstate.CoinsTip().DynamicMemoryUsage();
# # ]
4750 : :
4751 [ # # ]: 0 : if (nCheckLevel >= 3) {
4752 [ # # ]: 0 : if (curr_coins_usage <= chainstate.m_coinstip_cache_size_bytes) {
4753 [ # # # # ]: 0 : assert(coins.GetBestBlock() == pindex->GetBlockHash());
4754 [ # # ]: 0 : DisconnectResult res = chainstate.DisconnectBlock(block, pindex, coins);
4755 [ # # ]: 0 : if (res == DISCONNECT_FAILED) {
4756 [ # # # # ]: 0 : LogError("Verification error: irrecoverable inconsistency in block data at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4757 : 0 : return VerifyDBResult::CORRUPTED_BLOCK_DB;
4758 : : }
4759 [ # # ]: 0 : if (res == DISCONNECT_UNCLEAN) {
4760 : 0 : nGoodTransactions = 0;
4761 : 0 : pindexFailure = pindex;
4762 : : } else {
4763 [ # # ]: 0 : nGoodTransactions += block.vtx.size();
4764 : : }
4765 : : } else {
4766 : : skipped_l3_checks = true;
4767 : : }
4768 : : }
4769 [ # # # # ]: 0 : if (chainstate.m_chainman.m_interrupt) return VerifyDBResult::INTERRUPTED;
4770 : 0 : }
4771 [ # # ]: 0 : if (pindexFailure) {
4772 [ # # # # ]: 0 : LogError("Verification error: coin database inconsistencies found (last %i blocks, %i good transactions before that)", chainstate.m_chain.Height() - pindexFailure->nHeight + 1, nGoodTransactions);
4773 : : return VerifyDBResult::CORRUPTED_BLOCK_DB;
4774 : : }
4775 [ # # ]: 0 : if (skipped_l3_checks) {
4776 [ # # ]: 0 : LogWarning("Skipped verification of level >=3 (insufficient database cache size). Consider increasing -dbcache.");
4777 : : }
4778 : :
4779 : : // store block count as we move pindex at check level >= 4
4780 [ # # ]: 0 : int block_count = chainstate.m_chain.Height() - pindex->nHeight;
4781 : :
4782 : : // check level 4: try reconnecting blocks
4783 [ # # # # ]: 0 : if (nCheckLevel >= 4 && !skipped_l3_checks) {
4784 [ # # # # ]: 0 : while (pindex != chainstate.m_chain.Tip()) {
4785 [ # # # # ]: 0 : const int percentageDone = std::max(1, std::min(99, 100 - (int)(((double)(chainstate.m_chain.Height() - pindex->nHeight)) / (double)nCheckDepth * 50)));
4786 [ # # ]: 0 : if (reportDone < percentageDone / 10) {
4787 : : // report every 10% step
4788 [ # # ]: 0 : LogInfo("Verification progress: %d%%", percentageDone);
4789 : 0 : reportDone = percentageDone / 10;
4790 : : }
4791 [ # # # # ]: 0 : m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
4792 : 0 : pindex = chainstate.m_chain.Next(pindex);
4793 : 0 : CBlock block;
4794 [ # # # # ]: 0 : if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
4795 [ # # # # ]: 0 : LogError("Verification error: ReadBlock failed at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4796 : 0 : return VerifyDBResult::CORRUPTED_BLOCK_DB;
4797 : : }
4798 [ # # # # ]: 0 : if (!chainstate.ConnectBlock(block, state, pindex, coins)) {
4799 [ # # # # : 0 : LogError("Verification error: found unconnectable block at %d, hash=%s (%s)", pindex->nHeight, pindex->GetBlockHash().ToString(), state.ToString());
# # ]
4800 : 0 : return VerifyDBResult::CORRUPTED_BLOCK_DB;
4801 : : }
4802 [ # # # # ]: 0 : if (chainstate.m_chainman.m_interrupt) return VerifyDBResult::INTERRUPTED;
4803 : 0 : }
4804 : : }
4805 : :
4806 [ # # ]: 0 : LogInfo("Verification: No coin database inconsistencies in last %i blocks (%i transactions)", block_count, nGoodTransactions);
4807 : :
4808 [ # # ]: 0 : if (skipped_l3_checks) {
4809 : : return VerifyDBResult::SKIPPED_L3_CHECKS;
4810 : : }
4811 [ # # ]: 0 : if (skipped_no_block_data) {
4812 : 0 : return VerifyDBResult::SKIPPED_MISSING_BLOCKS;
4813 : : }
4814 : : return VerifyDBResult::SUCCESS;
4815 : 0 : }
4816 : :
4817 : : /** Apply the effects of a block on the utxo cache, ignoring that it may already have been applied. */
4818 : 0 : bool Chainstate::RollforwardBlock(const CBlockIndex* pindex, CCoinsViewCache& inputs)
4819 : : {
4820 : 0 : AssertLockHeld(cs_main);
4821 : : // TODO: merge with ConnectBlock
4822 : 0 : CBlock block;
4823 [ # # # # ]: 0 : if (!m_blockman.ReadBlock(block, *pindex)) {
4824 [ # # # # ]: 0 : LogError("ReplayBlock(): ReadBlock failed at %d, hash=%s\n", pindex->nHeight, pindex->GetBlockHash().ToString());
4825 : 0 : return false;
4826 : : }
4827 : :
4828 [ # # ]: 0 : for (const CTransactionRef& tx : block.vtx) {
4829 [ # # ]: 0 : if (!tx->IsCoinBase()) {
4830 [ # # ]: 0 : for (const CTxIn &txin : tx->vin) {
4831 [ # # ]: 0 : inputs.SpendCoin(txin.prevout);
4832 : : }
4833 : : }
4834 : : // Pass check = true as every addition may be an overwrite.
4835 [ # # ]: 0 : AddCoins(inputs, *tx, pindex->nHeight, true);
4836 : : }
4837 : : return true;
4838 : 0 : }
4839 : :
4840 : 2243 : bool Chainstate::ReplayBlocks()
4841 : : {
4842 : 2243 : LOCK(cs_main);
4843 : :
4844 [ + - ]: 2243 : CCoinsView& db = this->CoinsDB();
4845 [ + - ]: 2243 : CCoinsViewCache cache(&db);
4846 : :
4847 [ + - ]: 2243 : std::vector<uint256> hashHeads = db.GetHeadBlocks();
4848 [ - + ]: 2243 : if (hashHeads.empty()) return true; // We're already in a consistent state.
4849 [ # # # # ]: 0 : if (hashHeads.size() != 2) {
4850 [ # # ]: 0 : LogError("ReplayBlocks(): unknown inconsistent state\n");
4851 : : return false;
4852 : : }
4853 : :
4854 [ # # # # ]: 0 : m_chainman.GetNotifications().progress(_("Replaying blocks…"), 0, false);
4855 [ # # ]: 0 : LogInfo("Replaying blocks");
4856 : :
4857 : 0 : const CBlockIndex* pindexOld = nullptr; // Old tip during the interrupted flush.
4858 : 0 : const CBlockIndex* pindexNew; // New tip during the interrupted flush.
4859 : 0 : const CBlockIndex* pindexFork = nullptr; // Latest block common to both the old and the new tip.
4860 : :
4861 [ # # ]: 0 : if (!m_blockman.m_block_index.contains(hashHeads[0])) {
4862 [ # # ]: 0 : LogError("ReplayBlocks(): reorganization to unknown block requested\n");
4863 : : return false;
4864 : : }
4865 [ # # ]: 0 : pindexNew = &(m_blockman.m_block_index[hashHeads[0]]);
4866 : :
4867 [ # # ]: 0 : if (!hashHeads[1].IsNull()) { // The old tip is allowed to be 0, indicating it's the first flush.
4868 [ # # ]: 0 : if (!m_blockman.m_block_index.contains(hashHeads[1])) {
4869 [ # # ]: 0 : LogError("ReplayBlocks(): reorganization from unknown block requested\n");
4870 : : return false;
4871 : : }
4872 [ # # ]: 0 : pindexOld = &(m_blockman.m_block_index[hashHeads[1]]);
4873 [ # # ]: 0 : pindexFork = LastCommonAncestor(pindexOld, pindexNew);
4874 [ # # ]: 0 : assert(pindexFork != nullptr);
4875 : : }
4876 : :
4877 : : // Rollback along the old branch.
4878 : 0 : const int nForkHeight{pindexFork ? pindexFork->nHeight : 0};
4879 [ # # ]: 0 : if (pindexOld != pindexFork) {
4880 [ # # # # ]: 0 : LogInfo("Rolling back from %s (%i to %i)", pindexOld->GetBlockHash().ToString(), pindexOld->nHeight, nForkHeight);
4881 [ # # ]: 0 : while (pindexOld != pindexFork) {
4882 [ # # ]: 0 : if (pindexOld->nHeight > 0) { // Never disconnect the genesis block.
4883 : 0 : CBlock block;
4884 [ # # # # ]: 0 : if (!m_blockman.ReadBlock(block, *pindexOld)) {
4885 [ # # # # ]: 0 : LogError("RollbackBlock(): ReadBlock() failed at %d, hash=%s\n", pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
4886 : 0 : return false;
4887 : : }
4888 [ # # ]: 0 : if (pindexOld->nHeight % 10'000 == 0) {
4889 [ # # # # ]: 0 : LogInfo("Rolling back %s (%i)", pindexOld->GetBlockHash().ToString(), pindexOld->nHeight);
4890 : : }
4891 [ # # ]: 0 : DisconnectResult res = DisconnectBlock(block, pindexOld, cache);
4892 [ # # ]: 0 : if (res == DISCONNECT_FAILED) {
4893 [ # # # # ]: 0 : LogError("RollbackBlock(): DisconnectBlock failed at %d, hash=%s\n", pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
4894 : 0 : return false;
4895 : : }
4896 : : // If DISCONNECT_UNCLEAN is returned, it means a non-existing UTXO was deleted, or an existing UTXO was
4897 : : // overwritten. It corresponds to cases where the block-to-be-disconnect never had all its operations
4898 : : // applied to the UTXO set. However, as both writing a UTXO and deleting a UTXO are idempotent operations,
4899 : : // the result is still a version of the UTXO set with the effects of that block undone.
4900 : 0 : }
4901 : 0 : pindexOld = pindexOld->pprev;
4902 : : }
4903 [ # # # # ]: 0 : LogInfo("Rolled back to %s", pindexFork->GetBlockHash().ToString());
4904 : : }
4905 : :
4906 : : // Roll forward from the forking point to the new tip.
4907 [ # # ]: 0 : if (nForkHeight < pindexNew->nHeight) {
4908 [ # # # # ]: 0 : LogInfo("Rolling forward to %s (%i to %i)", pindexNew->GetBlockHash().ToString(), nForkHeight, pindexNew->nHeight);
4909 [ # # ]: 0 : for (int nHeight = nForkHeight + 1; nHeight <= pindexNew->nHeight; ++nHeight) {
4910 [ # # # # ]: 0 : const CBlockIndex& pindex{*Assert(pindexNew->GetAncestor(nHeight))};
4911 : :
4912 [ # # ]: 0 : if (nHeight % 10'000 == 0) {
4913 [ # # # # ]: 0 : LogInfo("Rolling forward %s (%i)", pindex.GetBlockHash().ToString(), nHeight);
4914 : : }
4915 [ # # # # ]: 0 : m_chainman.GetNotifications().progress(_("Replaying blocks…"), (int)((nHeight - nForkHeight) * 100.0 / (pindexNew->nHeight - nForkHeight)), false);
4916 [ # # # # ]: 0 : if (!RollforwardBlock(&pindex, cache)) return false;
4917 : : }
4918 [ # # # # ]: 0 : LogInfo("Rolled forward to %s", pindexNew->GetBlockHash().ToString());
4919 : : }
4920 : :
4921 [ # # ]: 0 : cache.SetBestBlock(pindexNew->GetBlockHash());
4922 [ # # ]: 0 : cache.Flush(/*will_reuse_cache=*/false); // local CCoinsViewCache goes out of scope
4923 [ # # ]: 0 : m_chainman.GetNotifications().progress(bilingual_str{}, 100, false);
4924 : 0 : return true;
4925 [ + - ]: 4486 : }
4926 : :
4927 : 2243 : bool Chainstate::NeedsRedownload() const
4928 : : {
4929 : 2243 : AssertLockHeld(cs_main);
4930 : :
4931 : : // At and above m_params.SegwitHeight, segwit consensus rules must be validated
4932 [ - + ]: 2243 : CBlockIndex* block{m_chain.Tip()};
4933 : :
4934 [ - + - - ]: 2243 : while (block != nullptr && DeploymentActiveAt(*block, m_chainman, Consensus::DEPLOYMENT_SEGWIT)) {
4935 [ # # ]: 0 : if (!(block->nStatus & BLOCK_OPT_WITNESS)) {
4936 : : // block is insufficiently validated for a segwit client
4937 : : return true;
4938 : : }
4939 : 0 : block = block->pprev;
4940 : : }
4941 : :
4942 : : return false;
4943 : : }
4944 : :
4945 : 0 : void Chainstate::ClearBlockIndexCandidates()
4946 : : {
4947 : 0 : AssertLockHeld(::cs_main);
4948 : 0 : setBlockIndexCandidates.clear();
4949 : 0 : }
4950 : :
4951 : 2243 : bool ChainstateManager::LoadBlockIndex()
4952 : : {
4953 : 2243 : AssertLockHeld(cs_main);
4954 : : // Load block index from databases
4955 [ + - ]: 2243 : if (m_blockman.m_blockfiles_indexed) {
4956 : 2243 : bool ret{m_blockman.LoadBlockIndexDB(CurrentChainstate().m_from_snapshot_blockhash)};
4957 [ + - ]: 2243 : if (!ret) return false;
4958 : :
4959 : 2243 : m_blockman.ScanAndUnlinkAlreadyPrunedFiles();
4960 : :
4961 : 2243 : std::vector<CBlockIndex*> vSortedByHeight{m_blockman.GetAllBlockIndices()};
4962 [ + - ]: 2243 : std::sort(vSortedByHeight.begin(), vSortedByHeight.end(),
4963 : : CBlockIndexHeightOnlyComparator());
4964 : :
4965 [ - + ]: 2243 : for (CBlockIndex* pindex : vSortedByHeight) {
4966 [ # # # # ]: 0 : if (m_interrupt) return false;
4967 : : // If we have an assumeutxo-based chainstate, then the snapshot
4968 : : // block will be a candidate for the tip, but it may not be
4969 : : // VALID_TRANSACTIONS (eg if we haven't yet downloaded the block),
4970 : : // so we special-case the snapshot block as a potential candidate
4971 : : // here.
4972 [ # # # # ]: 0 : if (pindex == CurrentChainstate().SnapshotBase() ||
4973 [ # # ]: 0 : (pindex->IsValid(BLOCK_VALID_TRANSACTIONS) &&
4974 [ # # # # ]: 0 : (pindex->HaveNumChainTxs() || pindex->pprev == nullptr))) {
4975 : :
4976 [ # # ]: 0 : for (const auto& chainstate : m_chainstates) {
4977 [ # # ]: 0 : chainstate->TryAddBlockIndexCandidate(pindex);
4978 : : }
4979 : : }
4980 [ # # # # : 0 : if (pindex->nStatus & BLOCK_FAILED_MASK && (!m_best_invalid || pindex->nChainWork > m_best_invalid->nChainWork)) {
# # # # ]
4981 : 0 : m_best_invalid = pindex;
4982 : : }
4983 [ # # # # : 0 : if (pindex->IsValid(BLOCK_VALID_TREE) && (m_best_header == nullptr || CBlockIndexWorkComparator()(m_best_header, pindex)))
# # # # #
# ]
4984 : 0 : m_best_header = pindex;
4985 : : }
4986 : 2243 : }
4987 : : return true;
4988 : : }
4989 : :
4990 : 2243 : bool Chainstate::LoadGenesisBlock()
4991 : : {
4992 : 2243 : LOCK(cs_main);
4993 : :
4994 [ + - ]: 2243 : const CChainParams& params{m_chainman.GetParams()};
4995 : :
4996 : : // Check whether we're already initialized by checking for genesis in
4997 : : // m_blockman.m_block_index. Note that we can't use m_chain here, since it is
4998 : : // set based on the coins db, not the block index db, which is the only
4999 : : // thing loaded at this point.
5000 [ + - + - ]: 2243 : if (m_blockman.m_block_index.contains(params.GenesisBlock().GetHash()))
5001 : : return true;
5002 : :
5003 : 2243 : try {
5004 [ + - ]: 2243 : const CBlock& block = params.GenesisBlock();
5005 [ + - ]: 2243 : FlatFilePos blockPos{m_blockman.WriteBlock(block, 0)};
5006 [ - + ]: 2243 : if (blockPos.IsNull()) {
5007 [ # # ]: 0 : LogError("%s: writing genesis block to disk failed\n", __func__);
5008 : : return false;
5009 : : }
5010 [ + - ]: 2243 : CBlockIndex* pindex = m_blockman.AddToBlockIndex(block, m_chainman.m_best_header);
5011 [ + - ]: 2243 : m_chainman.ReceivedBlockTransactions(block, pindex, blockPos);
5012 [ - - ]: 0 : } catch (const std::runtime_error& e) {
5013 [ - - ]: 0 : LogError("%s: failed to write genesis block: %s\n", __func__, e.what());
5014 : 0 : return false;
5015 : 0 : }
5016 : :
5017 : : return true;
5018 : 2243 : }
5019 : :
5020 : 568 : void ChainstateManager::LoadExternalBlockFile(
5021 : : AutoFile& file_in,
5022 : : FlatFilePos* dbp,
5023 : : std::multimap<uint256, FlatFilePos>* blocks_with_unknown_parent)
5024 : : {
5025 : : // Either both should be specified (-reindex), or neither (-loadblock).
5026 [ - + ]: 568 : assert(!dbp == !blocks_with_unknown_parent);
5027 : :
5028 : 568 : const auto start{SteadyClock::now()};
5029 [ + - ]: 568 : const CChainParams& params{GetParams()};
5030 : :
5031 : 568 : int nLoaded = 0;
5032 : 568 : try {
5033 [ + - ]: 568 : BufferedFile blkdat{file_in, 2 * MAX_BLOCK_SERIALIZED_SIZE, MAX_BLOCK_SERIALIZED_SIZE + 8};
5034 : : // nRewind indicates where to resume scanning in case something goes wrong,
5035 : : // such as a block fails to deserialize.
5036 : 568 : uint64_t nRewind = blkdat.GetPos();
5037 [ + + ]: 2434468 : while (!blkdat.eof()) {
5038 [ + - - + ]: 2434250 : if (m_interrupt) return;
5039 : :
5040 : 2434250 : blkdat.SetPos(nRewind);
5041 : 2434250 : nRewind++; // start one byte further next time, in case of failure
5042 [ + + ]: 2434250 : blkdat.SetLimit(); // remove former limit
5043 : 2434250 : unsigned int nSize = 0;
5044 : 2434250 : try {
5045 : : // locate a header
5046 : 2434250 : MessageStartChars buf;
5047 [ + + ]: 2434250 : blkdat.FindByte(std::byte(params.MessageStart()[0]));
5048 [ + + ]: 2433935 : nRewind = blkdat.GetPos() + 1;
5049 [ + + ]: 2433935 : blkdat >> buf;
5050 [ + + ]: 2433916 : if (buf != params.MessageStart()) {
5051 : 2105856 : continue;
5052 : : }
5053 : : // read size
5054 [ + + ]: 328060 : blkdat >> nSize;
5055 [ + + ]: 328044 : if (nSize < 80 || nSize > MAX_BLOCK_SERIALIZED_SIZE)
5056 : 43067 : continue;
5057 [ - + ]: 350 : } catch (const std::exception&) {
5058 : : // no valid block header found; don't complain
5059 : : // (this happens at the end of every blk.dat file)
5060 : 350 : break;
5061 : 350 : }
5062 : 284977 : try {
5063 : : // read block header
5064 [ + + ]: 284977 : const uint64_t nBlockPos{blkdat.GetPos()};
5065 [ + + ]: 284977 : if (dbp)
5066 : 142889 : dbp->nPos = nBlockPos;
5067 [ + - ]: 284977 : blkdat.SetLimit(nBlockPos + nSize);
5068 : 284977 : CBlockHeader header;
5069 [ + + ]: 284977 : blkdat >> header;
5070 [ + - ]: 284172 : const uint256 hash{header.GetHash()};
5071 : : // Skip the rest of this block (this may read from disk into memory); position to the marker before the
5072 : : // next block, but it's still possible to rewind to the start of the current block (without a disk read).
5073 : 284172 : nRewind = nBlockPos + nSize;
5074 [ + + ]: 284172 : blkdat.SkipTo(nRewind);
5075 : :
5076 : 283106 : std::shared_ptr<CBlock> pblock{}; // needs to remain available after the cs_main lock is released to avoid duplicate reads from disk
5077 : :
5078 : 283106 : {
5079 [ + - ]: 283106 : LOCK(cs_main);
5080 : : // detect out of order blocks, and store them for later
5081 [ + - + - : 283106 : if (hash != params.GetConsensus().hashGenesisBlock && !m_blockman.LookupBlockIndex(header.hashPrevBlock)) {
+ + ]
5082 [ + - - + : 177599 : LogDebug(BCLog::REINDEX, "%s: Out of order block %s, parent %s not known\n", __func__, hash.ToString(),
- - - - -
- ]
5083 : : header.hashPrevBlock.ToString());
5084 [ + + ]: 177599 : if (dbp && blocks_with_unknown_parent) {
5085 [ + - ]: 104390 : blocks_with_unknown_parent->emplace(header.hashPrevBlock, *dbp);
5086 : : }
5087 : 177599 : continue;
5088 [ + - ]: 177599 : }
5089 : :
5090 : : // process in case the block isn't known yet
5091 [ + - ]: 105507 : const CBlockIndex* pindex = m_blockman.LookupBlockIndex(hash);
5092 [ + + + - ]: 105507 : if (!pindex || (pindex->nStatus & BLOCK_HAVE_DATA) == 0) {
5093 : : // This block can be processed immediately; rewind to its start, read and deserialize it.
5094 : 105507 : blkdat.SetPos(nBlockPos);
5095 [ + - - + ]: 211014 : pblock = std::make_shared<CBlock>();
5096 [ + + ]: 105507 : blkdat >> TX_WITH_WITNESS(*pblock);
5097 [ + - ]: 72474 : nRewind = blkdat.GetPos();
5098 : :
5099 [ + - ]: 72474 : BlockValidationState state;
5100 [ + - + - : 217422 : if (AcceptBlock(pblock, state, nullptr, true, dbp, nullptr, true)) {
+ - - + ]
5101 : 0 : nLoaded++;
5102 : : }
5103 [ + - ]: 72474 : if (state.IsError()) {
5104 : : break;
5105 : : }
5106 [ - - - - : 72474 : } else if (hash != params.GetConsensus().hashGenesisBlock && pindex->nHeight % 1000 == 0) {
- - ]
5107 [ # # # # : 0 : LogDebug(BCLog::REINDEX, "Block Import: already had block %s at height %d\n", hash.ToString(), pindex->nHeight);
# # # # ]
5108 : : }
5109 : 210632 : }
5110 : :
5111 : : // Activate the genesis block so normal node progress can continue
5112 : : // During first -reindex, this will only connect Genesis since
5113 : : // ActivateBestChain only connects blocks which are in the block tree db,
5114 : : // which only contains blocks whose parents are in it.
5115 : : // But do this only if genesis isn't activated yet, to avoid connecting many blocks
5116 : : // without assumevalid in the case of a continuation of a reindex that
5117 : : // was interrupted by the user.
5118 [ - + - - : 72474 : if (hash == params.GetConsensus().hashGenesisBlock && WITH_LOCK(::cs_main, return ActiveHeight()) == -1) {
- - - - -
- ]
5119 [ # # ]: 0 : BlockValidationState state;
5120 [ # # # # : 0 : if (!ActiveChainstate().ActivateBestChain(state, nullptr)) {
# # # # ]
5121 : : break;
5122 : : }
5123 : 0 : }
5124 : :
5125 [ - + - - : 72474 : if (m_blockman.IsPruneMode() && m_blockman.m_blockfiles_indexed && pblock) {
- - ]
5126 : : // must update the tip for pruning to work while importing with -loadblock.
5127 : : // this is a tradeoff to conserve disk space at the expense of time
5128 : : // spent updating the tip to be able to prune.
5129 : : // otherwise, ActivateBestChain won't be called by the import process
5130 : : // until after all of the block files are loaded. ActivateBestChain can be
5131 : : // called by concurrent network message processing. but, that is not
5132 : : // reliable for the purpose of pruning while importing.
5133 [ # # # # ]: 0 : if (auto result{ActivateBestChains()}; !result) {
5134 [ # # # # : 0 : LogDebug(BCLog::REINDEX, "%s\n", util::ErrorString(result).original);
# # # # ]
5135 : 0 : break;
5136 : 0 : }
5137 : : }
5138 : :
5139 [ + - ]: 72474 : NotifyHeaderTip();
5140 : :
5141 [ + + ]: 72474 : if (!blocks_with_unknown_parent) continue;
5142 : :
5143 : : // Recursively process earlier encountered successors of this block
5144 [ + - ]: 26961 : std::deque<uint256> queue;
5145 [ + - ]: 26961 : queue.push_back(hash);
5146 [ + + ]: 53922 : while (!queue.empty()) {
5147 : 26961 : uint256 head = queue.front();
5148 : 26961 : queue.pop_front();
5149 : 26961 : auto range = blocks_with_unknown_parent->equal_range(head);
5150 [ + + ]: 47968 : while (range.first != range.second) {
5151 : 21007 : std::multimap<uint256, FlatFilePos>::iterator it = range.first;
5152 [ + - ]: 21007 : std::shared_ptr<CBlock> pblockrecursive = std::make_shared<CBlock>();
5153 [ + - - + ]: 21007 : if (m_blockman.ReadBlock(*pblockrecursive, it->second, {})) {
5154 [ # # ]: 0 : const auto& block_hash{pblockrecursive->GetHash()};
5155 [ # # # # : 0 : LogDebug(BCLog::REINDEX, "%s: Processing out of order child %s of %s", __func__, block_hash.ToString(), head.ToString());
# # # # #
# ]
5156 [ # # ]: 0 : LOCK(cs_main);
5157 [ # # ]: 0 : BlockValidationState dummy;
5158 [ # # # # : 0 : if (AcceptBlock(pblockrecursive, dummy, nullptr, true, &it->second, nullptr, true)) {
# # # # ]
5159 : 0 : nLoaded++;
5160 [ # # ]: 0 : queue.push_back(block_hash);
5161 : : }
5162 [ # # ]: 0 : }
5163 : 21007 : range.first++;
5164 : 21007 : blocks_with_unknown_parent->erase(it);
5165 [ + - ]: 21007 : NotifyHeaderTip();
5166 : 21007 : }
5167 : : }
5168 [ + - - + ]: 311938 : } catch (const std::exception& e) {
5169 : : // historical bugs added extra data to the block files that does not deserialize cleanly.
5170 : : // commonly this data is between readable blocks, but it does not really matter. such data is not fatal to the import process.
5171 : : // the code that reads the block files deals with invalid data by simply ignoring it.
5172 : : // it continues to search for the next {4 byte magic message start bytes + 4 byte length + block} that does deserialize cleanly
5173 : : // and passes all of the other block validation checks dealing with POW and the merkle root, etc...
5174 : : // we merely note with this informational log message when unexpected data is encountered.
5175 : : // we could also be experiencing a storage system read error, or a read of a previous bad write. these are possible, but
5176 : : // less likely scenarios. we don't have enough information to tell a difference here.
5177 : : // the reindex process is not the place to attempt to clean and/or compact the block files. if so desired, a studious node operator
5178 : : // may use knowledge of the fact that the block files are not entirely pristine in order to prepare a set of pristine, and
5179 : : // perhaps ordered, block files for later reindexing.
5180 [ + - - + : 34904 : LogDebug(BCLog::REINDEX, "%s: unexpected data at file offset 0x%x - %s. continuing\n", __func__, (nRewind - 1), e.what());
- - ]
5181 : 34904 : }
5182 : : }
5183 [ - - ]: 568 : } catch (const std::runtime_error& e) {
5184 [ - - - - ]: 0 : GetNotifications().fatalError(strprintf(_("System error while loading external block file: %s"), e.what()));
5185 : 0 : }
5186 : 568 : LogInfo("Loaded %i blocks from external file in %dms", nLoaded, Ticks<std::chrono::milliseconds>(SteadyClock::now() - start));
5187 : : }
5188 : :
5189 : 727351 : bool ChainstateManager::ShouldCheckBlockIndex() const
5190 : : {
5191 : : // Assert to verify Flatten() has been called.
5192 [ - + + - ]: 727351 : if (!*Assert(m_options.check_block_index)) return false;
5193 [ - + ]: 727351 : if (FastRandomContext().randrange(*m_options.check_block_index) >= 1) return false;
5194 : : return true;
5195 : : }
5196 : :
5197 : 727351 : void ChainstateManager::CheckBlockIndex() const
5198 : : {
5199 [ + - ]: 727351 : if (!ShouldCheckBlockIndex()) {
5200 : : return;
5201 : : }
5202 : :
5203 : 727351 : LOCK(cs_main);
5204 : :
5205 : : // During a reindex, we read the genesis block and call CheckBlockIndex before ActivateBestChain,
5206 : : // so we have the genesis block in m_blockman.m_block_index but no active chain. (A few of the
5207 : : // tests when iterating the block tree require that m_chain has been initialized.)
5208 [ + - - + : 727351 : if (ActiveChain().Height() < 0) {
- + ]
5209 [ # # ]: 0 : assert(m_blockman.m_block_index.size() <= 1);
5210 [ # # ]: 0 : return;
5211 : : }
5212 : :
5213 : : // Build forward-pointing data structure for the entire block tree.
5214 : : // For performance reasons, indexes of the best header chain are stored in a vector (within CChain).
5215 : : // All remaining blocks are stored in a multimap.
5216 : : // The best header chain can differ from the active chain: E.g. its entries may belong to blocks that
5217 : : // are not yet validated.
5218 : 727351 : CChain best_hdr_chain;
5219 [ - + ]: 727351 : assert(m_best_header);
5220 [ - + ]: 727351 : assert(!(m_best_header->nStatus & BLOCK_FAILED_MASK));
5221 [ + - ]: 727351 : best_hdr_chain.SetTip(*m_best_header);
5222 : :
5223 : 727351 : std::multimap<const CBlockIndex*, const CBlockIndex*> forward;
5224 [ + + + + ]: 73848231 : for (auto& [_, block_index] : m_blockman.m_block_index) {
5225 : : // Only save indexes in forward that are not part of the best header chain.
5226 [ + + ]: 73120880 : if (!best_hdr_chain.Contains(&block_index)) {
5227 : : // Only genesis, which must be part of the best header chain, can have a nullptr parent.
5228 [ - + ]: 20088564 : assert(block_index.pprev);
5229 [ + - ]: 20088564 : forward.emplace(block_index.pprev, &block_index);
5230 : : }
5231 : : }
5232 [ - + - + ]: 727351 : assert(forward.size() + best_hdr_chain.Height() + 1 == m_blockman.m_block_index.size());
5233 : :
5234 [ + - ]: 727351 : const CBlockIndex* pindex = best_hdr_chain[0];
5235 [ - + ]: 727351 : assert(pindex);
5236 : : // Iterate over the entire block tree, using depth-first search.
5237 : : // Along the way, remember whether there are blocks on the path from genesis
5238 : : // block being explored which are the first to have certain properties.
5239 : 727351 : size_t nNodes = 0;
5240 : 727351 : int nHeight = 0;
5241 : 727351 : const CBlockIndex* pindexFirstInvalid = nullptr; // Oldest ancestor of pindex which is invalid.
5242 : 727351 : const CBlockIndex* pindexFirstMissing = nullptr; // Oldest ancestor of pindex which does not have BLOCK_HAVE_DATA, since assumeutxo snapshot if used.
5243 : 727351 : const CBlockIndex* pindexFirstNeverProcessed = nullptr; // Oldest ancestor of pindex for which nTx == 0, since assumeutxo snapshot if used.
5244 : 727351 : const CBlockIndex* pindexFirstNotTreeValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_TREE (regardless of being valid or not).
5245 : 727351 : const CBlockIndex* pindexFirstNotTransactionsValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_TRANSACTIONS (regardless of being valid or not), since assumeutxo snapshot if used.
5246 : 727351 : const CBlockIndex* pindexFirstNotChainValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_CHAIN (regardless of being valid or not), since assumeutxo snapshot if used.
5247 : 727351 : const CBlockIndex* pindexFirstNotScriptsValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_SCRIPTS (regardless of being valid or not), since assumeutxo snapshot if used.
5248 : :
5249 : : // After checking an assumeutxo snapshot block, reset pindexFirst pointers
5250 : : // to earlier blocks that have not been downloaded or validated yet, so
5251 : : // checks for later blocks can assume the earlier blocks were validated and
5252 : : // be stricter, testing for more requirements.
5253 [ + - ]: 727351 : const CBlockIndex* snap_base{CurrentChainstate().SnapshotBase()};
5254 : 727351 : const CBlockIndex *snap_first_missing{}, *snap_first_notx{}, *snap_first_notv{}, *snap_first_nocv{}, *snap_first_nosv{};
5255 : 93936795 : auto snap_update_firsts = [&] {
5256 [ - + ]: 93209444 : if (pindex == snap_base) {
5257 : 0 : std::swap(snap_first_missing, pindexFirstMissing);
5258 : 0 : std::swap(snap_first_notx, pindexFirstNeverProcessed);
5259 : 0 : std::swap(snap_first_notv, pindexFirstNotTransactionsValid);
5260 : 0 : std::swap(snap_first_nocv, pindexFirstNotChainValid);
5261 : 0 : std::swap(snap_first_nosv, pindexFirstNotScriptsValid);
5262 : : }
5263 : 93936795 : };
5264 : :
5265 [ + + ]: 73132494 : while (pindex != nullptr) {
5266 : 73120880 : nNodes++;
5267 [ + + + + ]: 73120880 : if (pindexFirstInvalid == nullptr && pindex->nStatus & BLOCK_FAILED_VALID) pindexFirstInvalid = pindex;
5268 [ + + + + ]: 73120880 : if (pindexFirstMissing == nullptr && !(pindex->nStatus & BLOCK_HAVE_DATA)) {
5269 : 18405371 : pindexFirstMissing = pindex;
5270 : : }
5271 [ + + + + ]: 73120880 : if (pindexFirstNeverProcessed == nullptr && pindex->nTx == 0) pindexFirstNeverProcessed = pindex;
5272 [ + + + - : 73120880 : if (pindex->pprev != nullptr && pindexFirstNotTreeValid == nullptr && (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_TREE) pindexFirstNotTreeValid = pindex;
- + ]
5273 : :
5274 [ + + ]: 73120880 : if (pindex->pprev != nullptr) {
5275 [ + + ]: 72393529 : if (pindexFirstNotTransactionsValid == nullptr &&
5276 [ + + ]: 59398355 : (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_TRANSACTIONS) {
5277 : 18408699 : pindexFirstNotTransactionsValid = pindex;
5278 : : }
5279 : :
5280 [ + + ]: 72393529 : if (pindexFirstNotChainValid == nullptr &&
5281 [ + + ]: 59395622 : (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_CHAIN) {
5282 : 19664847 : pindexFirstNotChainValid = pindex;
5283 : : }
5284 : :
5285 [ + + ]: 72393529 : if (pindexFirstNotScriptsValid == nullptr &&
5286 [ + + ]: 59395622 : (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_SCRIPTS) {
5287 : 19664847 : pindexFirstNotScriptsValid = pindex;
5288 : : }
5289 : : }
5290 : :
5291 : : // Begin: actual consistency checks.
5292 [ + + ]: 73120880 : if (pindex->pprev == nullptr) {
5293 : : // Genesis block checks.
5294 [ - + ]: 727351 : assert(pindex->GetBlockHash() == GetConsensus().hashGenesisBlock); // Genesis block's hash must match.
5295 [ + + ]: 1454702 : for (const auto& c : m_chainstates) {
5296 [ - + + - ]: 2182053 : if (c->m_chain.Genesis() != nullptr) {
5297 [ - + ]: 727351 : assert(pindex == c->m_chain.Genesis()); // The chain's genesis block must be this block.
5298 : : }
5299 : : }
5300 : : }
5301 : : // nSequenceId can't be set higher than SEQ_ID_INIT_FROM_DISK{1} for blocks that aren't linked
5302 : : // (negative is used for preciousblock, SEQ_ID_BEST_CHAIN_FROM_DISK{0} for active chain when loaded from disk)
5303 [ + + - + ]: 73120880 : if (!pindex->HaveNumChainTxs()) assert(pindex->nSequenceId <= SEQ_ID_INIT_FROM_DISK);
5304 : : // VALID_TRANSACTIONS is equivalent to nTx > 0 for all nodes (whether or not pruning has occurred).
5305 : : // HAVE_DATA is only equivalent to nTx > 0 (or VALID_TRANSACTIONS) if no pruning has occurred.
5306 [ + + ]: 73120880 : if (!m_blockman.m_have_pruned) {
5307 : : // If we've never pruned, then HAVE_DATA should be equivalent to nTx > 0
5308 [ - + ]: 73113329 : assert(!(pindex->nStatus & BLOCK_HAVE_DATA) == (pindex->nTx == 0));
5309 [ - + ]: 73113329 : assert(pindexFirstMissing == pindexFirstNeverProcessed);
5310 : : } else {
5311 : : // If we have pruned, then we can only say that HAVE_DATA implies nTx > 0
5312 [ + + - + ]: 7551 : if (pindex->nStatus & BLOCK_HAVE_DATA) assert(pindex->nTx > 0);
5313 : : }
5314 [ + + - + ]: 73120880 : if (pindex->nStatus & BLOCK_HAVE_UNDO) assert(pindex->nStatus & BLOCK_HAVE_DATA);
5315 [ - + - - : 73120880 : if (snap_base && snap_base->GetAncestor(pindex->nHeight) == pindex) {
- - ]
5316 : : // Assumed-valid blocks should connect to the main chain.
5317 [ # # ]: 0 : assert((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TREE);
5318 : : }
5319 : : // There should only be an nTx value if we have
5320 : : // actually seen a block's transactions.
5321 [ - + ]: 73120880 : assert(((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TRANSACTIONS) == (pindex->nTx > 0)); // This is pruning-independent.
5322 : : // All parents having had data (at some point) is equivalent to all parents being VALID_TRANSACTIONS, which is equivalent to HaveNumChainTxs().
5323 : : // HaveNumChainTxs will also be set in the assumeutxo snapshot block from snapshot metadata.
5324 [ + + + - : 104524753 : assert((pindexFirstNeverProcessed == nullptr || pindex == snap_base) == pindex->HaveNumChainTxs());
- + ]
5325 [ + + + - : 104524753 : assert((pindexFirstNotTransactionsValid == nullptr || pindex == snap_base) == pindex->HaveNumChainTxs());
- + ]
5326 [ - + ]: 73120880 : assert(pindex->nHeight == nHeight); // nHeight must be consistent.
5327 [ + + + - : 73120880 : assert(pindex->pprev == nullptr || pindex->nChainWork >= pindex->pprev->nChainWork); // For every block except the genesis block, the chainwork must be larger than the parent's.
- + ]
5328 [ + + + - : 73120880 : assert(nHeight < 2 || (pindex->pskip && (pindex->pskip->nHeight < nHeight))); // The pskip pointer must point back for all but the first 2 blocks.
- + ]
5329 [ - + ]: 73120880 : assert(pindexFirstNotTreeValid == nullptr); // All m_blockman.m_block_index entries must at least be TREE valid
5330 : 73120880 : if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TREE) assert(pindexFirstNotTreeValid == nullptr); // TREE valid implies all parents are TREE valid
5331 [ + + - + ]: 73120880 : if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_CHAIN) assert(pindexFirstNotChainValid == nullptr); // CHAIN valid implies all parents are CHAIN valid
5332 [ + + - + ]: 73120880 : if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_SCRIPTS) assert(pindexFirstNotScriptsValid == nullptr); // SCRIPTS valid implies all parents are SCRIPTS valid
5333 [ + + ]: 73120880 : if (pindexFirstInvalid == nullptr) {
5334 : : // Checks for not-invalid blocks.
5335 [ - + ]: 68216141 : assert((pindex->nStatus & BLOCK_FAILED_MASK) == 0); // The failed mask cannot be set for blocks without invalid parents.
5336 : : } else {
5337 [ - + ]: 4904739 : assert(pindex->nStatus & BLOCK_FAILED_MASK); // Invalid blocks and their descendants must be marked as invalid
5338 : : }
5339 : : // Make sure m_chain_tx_count sum is correctly computed.
5340 [ + + ]: 73120880 : if (!pindex->pprev) {
5341 : : // If no previous block, nTx and m_chain_tx_count must be the same.
5342 [ - + ]: 727351 : assert(pindex->m_chain_tx_count == pindex->nTx);
5343 [ + + + + ]: 72393529 : } else if (pindex->pprev->m_chain_tx_count > 0 && pindex->nTx > 0) {
5344 : : // If previous m_chain_tx_count is set and number of transactions in block is known, sum must be set.
5345 [ - + ]: 40989656 : assert(pindex->m_chain_tx_count == pindex->nTx + pindex->pprev->m_chain_tx_count);
5346 : : } else {
5347 : : // Otherwise m_chain_tx_count should only be set if this is a snapshot
5348 : : // block, and must be set if it is.
5349 [ - + ]: 31403873 : assert((pindex->m_chain_tx_count != 0) == (pindex == snap_base));
5350 : : }
5351 : : // There should be no block with more work than m_best_header, unless it's known to be invalid
5352 [ + + + - : 73120880 : assert((pindex->nStatus & BLOCK_FAILED_MASK) || pindex->nChainWork <= m_best_header->nChainWork);
- + ]
5353 : :
5354 : : // Chainstate-specific checks on setBlockIndexCandidates
5355 [ + + ]: 146241760 : for (const auto& c : m_chainstates) {
5356 [ - + - + ]: 146241760 : if (c->m_chain.Tip() == nullptr) continue;
5357 : : // Two main factors determine whether pindex is a candidate in
5358 : : // setBlockIndexCandidates:
5359 : : //
5360 : : // - If pindex has less work than the chain tip, it should not be a
5361 : : // candidate, and this will be asserted below. Otherwise it is a
5362 : : // potential candidate.
5363 : : //
5364 : : // - If pindex or one of its parent blocks back to the genesis block
5365 : : // or an assumeutxo snapshot never downloaded transactions
5366 : : // (pindexFirstNeverProcessed is non-null), it should not be a
5367 : : // candidate, and this will be asserted below. The only exception
5368 : : // is if pindex itself is an assumeutxo snapshot block. Then it is
5369 : : // also a potential candidate.
5370 [ + - + + : 73120880 : if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) && (pindexFirstNeverProcessed == nullptr || pindex == snap_base)) {
+ + + - ]
5371 : : // If pindex was detected as invalid (pindexFirstInvalid is
5372 : : // non-null), it is not required to be in
5373 : : // setBlockIndexCandidates.
5374 [ + + ]: 1033541 : if (pindexFirstInvalid == nullptr) {
5375 : : // If pindex and all its parents back to the genesis block
5376 : : // or an assumeutxo snapshot block downloaded transactions,
5377 : : // and the transactions were not pruned (pindexFirstMissing
5378 : : // is null), it is a potential candidate. The check
5379 : : // excludes pruned blocks, because if any blocks were
5380 : : // pruned between pindex and the current chain tip, pindex will
5381 : : // only temporarily be added to setBlockIndexCandidates,
5382 : : // before being moved to m_blocks_unlinked. This check
5383 : : // could be improved to verify that if all blocks between
5384 : : // the chain tip and pindex have data, pindex must be a
5385 : : // candidate.
5386 : : //
5387 : : // If pindex is the chain tip, it also is a potential
5388 : : // candidate.
5389 : : //
5390 : : // If the chainstate was loaded from a snapshot and pindex
5391 : : // is the base of the snapshot, pindex is also a potential
5392 : : // candidate.
5393 [ + + - + : 899030 : if (pindexFirstMissing == nullptr || pindex == c->m_chain.Tip() || pindex == c->SnapshotBase()) {
+ + + - -
+ ]
5394 : : // If this chainstate is not a historical chainstate
5395 : : // targeting a specific block, pindex must be in
5396 : : // setBlockIndexCandidates. Otherwise, pindex only
5397 : : // needs to be added if it is an ancestor of the target
5398 : : // block.
5399 [ + - - + : 898673 : if (!c->TargetBlock() || c->TargetBlock()->GetAncestor(pindex->nHeight) == pindex) {
- - - - -
- ]
5400 [ + - - + ]: 898673 : assert(c->setBlockIndexCandidates.contains(const_cast<CBlockIndex*>(pindex)));
5401 : : }
5402 : : }
5403 : : // If some parent is missing, then it could be that this block was in
5404 : : // setBlockIndexCandidates but had to be removed because of the missing data.
5405 : : // In this case it must be in m_blocks_unlinked -- see test below.
5406 : : }
5407 : : } else { // If this block sorts worse than the current tip or some ancestor's block has never been seen, it cannot be in setBlockIndexCandidates.
5408 [ + - - + ]: 72087339 : assert(!c->setBlockIndexCandidates.contains(const_cast<CBlockIndex*>(pindex)));
5409 : : }
5410 : : }
5411 : : // Check whether this block is in m_blocks_unlinked.
5412 : 73120880 : auto rangeUnlinked{m_blockman.m_blocks_unlinked.equal_range(pindex->pprev)};
5413 : 73120880 : bool foundInUnlinked = false;
5414 [ + + ]: 73126093 : while (rangeUnlinked.first != rangeUnlinked.second) {
5415 [ - + ]: 5380 : assert(rangeUnlinked.first->first == pindex->pprev);
5416 [ + + ]: 5380 : if (rangeUnlinked.first->second == pindex) {
5417 : : foundInUnlinked = true;
5418 : : break;
5419 : : }
5420 : 5213 : rangeUnlinked.first++;
5421 : : }
5422 [ + + + + : 73120880 : if (pindex->pprev && (pindex->nStatus & BLOCK_HAVE_DATA) && pindexFirstNeverProcessed != nullptr && pindexFirstInvalid == nullptr) {
+ + + + ]
5423 : : // If this block has block data available, some parent was never received, and has no invalid parents, it must be in m_blocks_unlinked.
5424 [ - + ]: 145 : assert(foundInUnlinked);
5425 : : }
5426 [ + + - + ]: 73120880 : if (!(pindex->nStatus & BLOCK_HAVE_DATA)) assert(!foundInUnlinked); // Can't be in m_blocks_unlinked if we don't HAVE_DATA
5427 [ + + - + ]: 73120880 : if (pindexFirstMissing == nullptr) assert(!foundInUnlinked); // We aren't missing data for any parent -- cannot be in m_blocks_unlinked.
5428 [ + + + + : 73120880 : if (pindex->pprev && (pindex->nStatus & BLOCK_HAVE_DATA) && pindexFirstNeverProcessed == nullptr && pindexFirstMissing != nullptr) {
+ + + + ]
5429 : : // We HAVE_DATA for this block, have received data for all parents at some point, but we're currently missing data for some parent.
5430 [ - + ]: 965 : assert(m_blockman.m_have_pruned);
5431 : : // This block may have entered m_blocks_unlinked if:
5432 : : // - it has a descendant that at some point had more work than the
5433 : : // tip, and
5434 : : // - we tried switching to that descendant but were missing
5435 : : // data for some intermediate block between m_chain and the
5436 : : // tip.
5437 : : // So if this block is itself better than any m_chain.Tip() and it wasn't in
5438 : : // setBlockIndexCandidates, then it must be in m_blocks_unlinked.
5439 [ + + ]: 1930 : for (const auto& c : m_chainstates) {
5440 [ - + + - : 1930 : if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) && !c->setBlockIndexCandidates.contains(const_cast<CBlockIndex*>(pindex))) {
+ + + - +
+ ]
5441 [ - + ]: 460 : if (pindexFirstInvalid == nullptr) {
5442 [ # # # # : 0 : if (!c->TargetBlock() || c->TargetBlock()->GetAncestor(pindex->nHeight) == pindex) {
# # # # #
# ]
5443 [ # # ]: 0 : assert(foundInUnlinked);
5444 : : }
5445 : : }
5446 : : }
5447 : : }
5448 : : }
5449 : : // assert(pindex->GetBlockHash() == pindex->GetBlockHeader().GetHash()); // Perhaps too slow
5450 : : // End: actual consistency checks.
5451 : :
5452 : :
5453 : : // Try descending into the first subnode. Always process forks first and the best header chain after.
5454 : 73120880 : snap_update_firsts();
5455 : 73120880 : auto range{forward.equal_range(pindex)};
5456 [ + + ]: 73120880 : if (range.first != range.second) {
5457 : : // A subnode not part of the best header chain was found.
5458 : 1162592 : pindex = range.first->second;
5459 : 1162592 : nHeight++;
5460 : 1162592 : continue;
5461 [ + + ]: 71958288 : } else if (best_hdr_chain.Contains(pindex)) {
5462 : : // Descend further into best header chain.
5463 : 52265588 : nHeight++;
5464 [ + - ]: 52265588 : pindex = best_hdr_chain[nHeight];
5465 [ + + ]: 52265588 : if (!pindex) break; // we are finished, since the best header chain is always processed last
5466 : 51549851 : continue;
5467 : : }
5468 : : // This is a leaf node.
5469 : : // Move upwards until we reach a node of which we have not yet visited the last child.
5470 [ + - ]: 20088564 : while (pindex) {
5471 : : // We are going to either move to a parent or a sibling of pindex.
5472 : 20088564 : snap_update_firsts();
5473 : : // If pindex was the first with a certain property, unset the corresponding variable.
5474 [ + + ]: 20088564 : if (pindex == pindexFirstInvalid) pindexFirstInvalid = nullptr;
5475 [ + + ]: 20088564 : if (pindex == pindexFirstMissing) pindexFirstMissing = nullptr;
5476 [ + + ]: 20088564 : if (pindex == pindexFirstNeverProcessed) pindexFirstNeverProcessed = nullptr;
5477 [ - + ]: 20088564 : if (pindex == pindexFirstNotTreeValid) pindexFirstNotTreeValid = nullptr;
5478 [ + + ]: 20088564 : if (pindex == pindexFirstNotTransactionsValid) pindexFirstNotTransactionsValid = nullptr;
5479 [ + + ]: 20088564 : if (pindex == pindexFirstNotChainValid) pindexFirstNotChainValid = nullptr;
5480 [ + + ]: 20088564 : if (pindex == pindexFirstNotScriptsValid) pindexFirstNotScriptsValid = nullptr;
5481 : : // Find our parent.
5482 : 20088564 : CBlockIndex* pindexPar = pindex->pprev;
5483 : : // Find which child we just visited.
5484 : 20088564 : auto rangePar{forward.equal_range(pindexPar)};
5485 [ + + ]: 2514482125 : while (rangePar.first->second != pindex) {
5486 [ - + ]: 2494393561 : assert(rangePar.first != rangePar.second); // Our parent must have at least the node we're coming from as child.
5487 : 2494393561 : rangePar.first++;
5488 : : }
5489 : : // Proceed to the next one.
5490 : 20088564 : rangePar.first++;
5491 [ + + ]: 20088564 : if (rangePar.first != rangePar.second) {
5492 : : // Move to a sibling not part of the best header chain.
5493 : 18925972 : pindex = rangePar.first->second;
5494 : 18925972 : break;
5495 [ + - + + ]: 2325184 : } else if (pindexPar == best_hdr_chain[nHeight - 1]) {
5496 : : // Move to pindex's sibling on the best-chain, if it has one.
5497 [ + - ]: 766728 : pindex = best_hdr_chain[nHeight];
5498 : : // There will not be a next block if (and only if) parent block is the best header.
5499 [ - + - + ]: 1533456 : assert((pindex == nullptr) == (pindexPar == best_hdr_chain.Tip()));
5500 : : break;
5501 : : } else {
5502 : : // Move up further.
5503 : 395864 : pindex = pindexPar;
5504 : 395864 : nHeight--;
5505 : 395864 : continue;
5506 : : }
5507 : : }
5508 : : }
5509 : :
5510 : : // Check that we actually traversed the entire block index.
5511 [ - + - + ]: 727351 : assert(nNodes == forward.size() + best_hdr_chain.Height() + 1);
5512 [ + - ]: 1454702 : }
5513 : :
5514 : 11157 : std::string Chainstate::ToString()
5515 : : {
5516 : 11157 : AssertLockHeld(::cs_main);
5517 [ - + ]: 11157 : CBlockIndex* tip = m_chain.Tip();
5518 : 8914 : return strprintf("Chainstate [%s] @ height %d (%s)",
5519 : 22314 : m_from_snapshot_blockhash ? "snapshot" : "ibd",
5520 [ + - - + : 33369 : tip ? tip->nHeight : -1, tip ? tip->GetBlockHash().ToString() : "null");
+ + + - ]
5521 : : }
5522 : :
5523 : 7359 : bool Chainstate::ResizeCoinsCaches(size_t coinstip_size, size_t coinsdb_size)
5524 : : {
5525 : 7359 : AssertLockHeld(::cs_main);
5526 [ + + ]: 7359 : if (coinstip_size == m_coinstip_cache_size_bytes &&
5527 [ - + ]: 2902 : coinsdb_size == m_coinsdb_cache_size_bytes) {
5528 : : // Cache sizes are unchanged, no need to continue.
5529 : : return true;
5530 : : }
5531 : 4457 : size_t old_coinstip_size = m_coinstip_cache_size_bytes;
5532 : 4457 : m_coinstip_cache_size_bytes = coinstip_size;
5533 : 4457 : m_coinsdb_cache_size_bytes = coinsdb_size;
5534 : 4457 : CoinsDB().ResizeCache(coinsdb_size);
5535 : :
5536 [ + - ]: 4457 : LogInfo("[%s] resized coinsdb cache to %.1f MiB",
5537 : : this->ToString(), coinsdb_size * (1.0 / 1024 / 1024));
5538 [ + - ]: 4457 : LogInfo("[%s] resized coinstip cache to %.1f MiB",
5539 : : this->ToString(), coinstip_size * (1.0 / 1024 / 1024));
5540 : :
5541 [ + + ]: 4457 : BlockValidationState state;
5542 : 4457 : bool ret;
5543 : :
5544 [ + + ]: 4457 : if (coinstip_size > old_coinstip_size) {
5545 : : // Likely no need to flush if cache sizes have grown.
5546 [ + - ]: 2203 : ret = FlushStateToDisk(state, FlushStateMode::IF_NEEDED);
5547 : : } else {
5548 : : // Otherwise, flush state to disk and deallocate the in-memory coins map.
5549 [ + - ]: 2254 : ret = FlushStateToDisk(state, FlushStateMode::ALWAYS);
5550 : : }
5551 : 4457 : return ret;
5552 : 4457 : }
5553 : :
5554 : 325150 : double ChainstateManager::GuessVerificationProgress(const CBlockIndex* pindex) const
5555 : : {
5556 : 325150 : AssertLockHeld(GetMutex());
5557 [ + - ]: 325150 : const ChainTxData& data{GetParams().TxData()};
5558 [ + - ]: 325150 : if (pindex == nullptr) {
5559 : : return 0.0;
5560 : : }
5561 : :
5562 [ - + ]: 325150 : if (pindex->m_chain_tx_count == 0) {
5563 [ # # ]: 0 : LogDebug(BCLog::VALIDATION, "Block %d has unset m_chain_tx_count. Unable to estimate verification progress.\n", pindex->nHeight);
5564 : 0 : return 0.0;
5565 : : }
5566 : :
5567 : 325150 : const int64_t nNow{TicksSinceEpoch<std::chrono::seconds>(NodeClock::now())};
5568 : 325150 : const auto block_time{
5569 [ - + + + ]: 650300 : (Assume(m_best_header) && std::abs(nNow - pindex->GetBlockTime()) <= Ticks<std::chrono::seconds>(2h) &&
5570 [ + - - + : 487297 : Assume(m_best_header->nHeight >= pindex->nHeight)) ?
+ - ]
5571 : : // When the header is known to be recent, switch to a height-based
5572 : : // approach. This ensures the returned value is quantized when
5573 : : // close to "1.0", because some users expect it to be. This also
5574 : : // avoids relying too much on the exact miner-set timestamp, which
5575 : : // may be off.
5576 : 162147 : nNow - (m_best_header->nHeight - pindex->nHeight) * GetConsensus().nPowTargetSpacing :
5577 : 163003 : pindex->GetBlockTime(),
5578 : 162147 : };
5579 : :
5580 : 325150 : double fTxTotal;
5581 : :
5582 [ + + ]: 325150 : if (pindex->m_chain_tx_count <= data.tx_count) {
5583 : 2 : fTxTotal = data.tx_count + (nNow - data.nTime) * data.dTxRate;
5584 : : } else {
5585 : 325148 : fTxTotal = pindex->m_chain_tx_count + (nNow - block_time) * data.dTxRate;
5586 : : }
5587 : :
5588 [ + - ]: 325150 : return std::min<double>(pindex->m_chain_tx_count / fTxTotal, 1.0);
5589 : : }
5590 : :
5591 : 2243 : Chainstate& ChainstateManager::InitializeChainstate(CTxMemPool* mempool)
5592 : : {
5593 : 2243 : AssertLockHeld(::cs_main);
5594 [ - + ]: 2243 : assert(m_chainstates.empty());
5595 [ + - ]: 2243 : m_chainstates.emplace_back(std::make_unique<Chainstate>(mempool, m_blockman, *this));
5596 : 2243 : return *m_chainstates.back();
5597 : : }
5598 : :
5599 : 0 : [[nodiscard]] static bool DeleteCoinsDBFromDisk(const fs::path db_path, bool is_snapshot)
5600 : : EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
5601 : : {
5602 : 0 : AssertLockHeld(::cs_main);
5603 : :
5604 [ # # ]: 0 : if (is_snapshot) {
5605 [ # # ]: 0 : fs::path base_blockhash_path = db_path / node::SNAPSHOT_BLOCKHASH_FILENAME;
5606 : :
5607 : 0 : try {
5608 [ # # ]: 0 : bool existed = fs::remove(base_blockhash_path);
5609 [ # # ]: 0 : if (!existed) {
5610 [ # # # # ]: 0 : LogWarning("[snapshot] snapshot chainstate dir being removed lacks %s file",
5611 : : fs::PathToString(node::SNAPSHOT_BLOCKHASH_FILENAME));
5612 : : }
5613 [ - - ]: 0 : } catch (const fs::filesystem_error& e) {
5614 [ - - - - : 0 : LogWarning("[snapshot] failed to remove file %s: %s\n",
- - ]
5615 : : fs::PathToString(base_blockhash_path), e.code().message());
5616 [ - - ]: 0 : }
5617 : 0 : }
5618 : :
5619 [ # # ]: 0 : std::string path_str = fs::PathToString(db_path);
5620 [ # # ]: 0 : LogInfo("Removing leveldb dir at %s\n", path_str);
5621 : :
5622 : : // We have to destruct before this call leveldb::DB in order to release the db
5623 : : // lock, otherwise `DestroyDB` will fail. See `leveldb::~DBImpl()`.
5624 [ # # ]: 0 : const bool destroyed = DestroyDB(path_str);
5625 : :
5626 [ # # ]: 0 : if (!destroyed) {
5627 [ # # ]: 0 : LogError("leveldb DestroyDB call failed on %s", path_str);
5628 : : }
5629 : :
5630 : : // Datadir should be removed from filesystem; otherwise initialization may detect
5631 : : // it on subsequent statups and get confused.
5632 : : //
5633 : : // If the base_blockhash_path removal above fails in the case of snapshot
5634 : : // chainstates, this will return false since leveldb won't remove a non-empty
5635 : : // directory.
5636 [ # # # # ]: 0 : return destroyed && !fs::exists(db_path);
5637 : 0 : }
5638 : :
5639 : 2528 : util::Result<CBlockIndex*> ChainstateManager::ActivateSnapshot(
5640 : : AutoFile& coins_file,
5641 : : const SnapshotMetadata& metadata,
5642 : : bool in_memory)
5643 : : {
5644 : 2528 : uint256 base_blockhash = metadata.m_base_blockhash;
5645 : :
5646 : 2528 : CBlockIndex* snapshot_start_block{};
5647 : :
5648 : 2528 : {
5649 : 2528 : LOCK(::cs_main);
5650 : :
5651 [ + + ]: 2528 : if (this->CurrentChainstate().m_from_snapshot_blockhash) {
5652 [ + - + - ]: 153 : return util::Error{Untranslated("Can't activate a snapshot-based chainstate more than once")};
5653 : : }
5654 [ + + ]: 2477 : if (!GetParams().AssumeutxoForBlockhash(base_blockhash).has_value()) {
5655 [ + - ]: 244 : auto available_heights = GetParams().GetAvailableSnapshotHeights();
5656 [ + - + - ]: 976 : std::string heights_formatted = util::Join(available_heights, ", ", [&](const auto& i) { return util::ToString(i); });
5657 [ + - + - ]: 488 : return util::Error{Untranslated(strprintf("assumeutxo block hash in snapshot metadata not recognized (hash: %s). The following snapshot heights are available: %s",
5658 [ + - ]: 488 : base_blockhash.ToString(),
5659 : 244 : heights_formatted))};
5660 : 244 : }
5661 : :
5662 [ + - ]: 2233 : snapshot_start_block = m_blockman.LookupBlockIndex(base_blockhash);
5663 [ + + ]: 2233 : if (!snapshot_start_block) {
5664 [ + - + - ]: 60 : return util::Error{Untranslated(strprintf("The base block header (%s) must appear in the headers chain. Make sure all headers are syncing, and call loadtxoutset again",
5665 [ + - ]: 90 : base_blockhash.ToString()))};
5666 : : }
5667 : :
5668 : 2203 : bool start_block_invalid = snapshot_start_block->nStatus & BLOCK_FAILED_MASK;
5669 [ - + ]: 2203 : if (start_block_invalid) {
5670 [ # # # # : 0 : return util::Error{Untranslated(strprintf("The base block header (%s) is part of an invalid chain", base_blockhash.ToString()))};
# # ]
5671 : : }
5672 : :
5673 [ + - + - : 2203 : if (!m_best_header || m_best_header->GetAncestor(snapshot_start_block->nHeight) != snapshot_start_block) {
- + ]
5674 [ # # # # ]: 0 : return util::Error{Untranslated("A forked headers-chain with more work than the chain with the snapshot base block header exists. Please proceed to sync without AssumeUtxo.")};
5675 : : }
5676 : :
5677 [ + - ]: 2203 : auto mempool{CurrentChainstate().GetMempool()};
5678 [ + - + - : 2203 : if (mempool && mempool->size() > 0) {
+ - ]
5679 [ # # # # ]: 0 : return util::Error{Untranslated("Can't activate a snapshot when mempool not empty")};
5680 : : }
5681 : 325 : }
5682 : :
5683 : 2203 : int64_t current_coinsdb_cache_size{0};
5684 : 2203 : int64_t current_coinstip_cache_size{0};
5685 : :
5686 : : // Cache percentages to allocate to each chainstate.
5687 : : //
5688 : : // These particular percentages don't matter so much since they will only be
5689 : : // relevant during snapshot activation; caches are rebalanced at the conclusion of
5690 : : // this function. We want to give (essentially) all available cache capacity to the
5691 : : // snapshot to aid the bulk load later in this function.
5692 : 2203 : static constexpr double IBD_CACHE_PERC = 0.01;
5693 : 2203 : static constexpr double SNAPSHOT_CACHE_PERC = 0.99;
5694 : :
5695 : 2203 : {
5696 : 2203 : LOCK(::cs_main);
5697 : : // Resize the coins caches to ensure we're not exceeding memory limits.
5698 : : //
5699 : : // Allocate the majority of the cache to the incoming snapshot chainstate, since
5700 : : // (optimistically) getting to its tip will be the top priority. We'll need to call
5701 : : // `MaybeRebalanceCaches()` once we're done with this function to ensure
5702 : : // the right allocation (including the possibility that no snapshot was activated
5703 : : // and that we should restore the active chainstate caches to their original size).
5704 : : //
5705 [ + - ]: 2203 : current_coinsdb_cache_size = this->ActiveChainstate().m_coinsdb_cache_size_bytes;
5706 [ + - ]: 2203 : current_coinstip_cache_size = this->ActiveChainstate().m_coinstip_cache_size_bytes;
5707 : :
5708 : : // Temporarily resize the active coins cache to make room for the newly-created
5709 : : // snapshot chain.
5710 [ + - ]: 2203 : this->ActiveChainstate().ResizeCoinsCaches(
5711 : 2203 : static_cast<size_t>(current_coinstip_cache_size * IBD_CACHE_PERC),
5712 [ + - ]: 2203 : static_cast<size_t>(current_coinsdb_cache_size * IBD_CACHE_PERC));
5713 : 0 : }
5714 : :
5715 [ + - ]: 6609 : auto snapshot_chainstate = WITH_LOCK(::cs_main,
5716 : : return std::make_unique<Chainstate>(
5717 : : /*mempool=*/nullptr, m_blockman, *this, base_blockhash));
5718 : :
5719 : 2203 : {
5720 [ + - ]: 2203 : LOCK(::cs_main);
5721 [ + - ]: 2203 : snapshot_chainstate->InitCoinsDB(
5722 [ + - ]: 2203 : static_cast<size_t>(current_coinsdb_cache_size * SNAPSHOT_CACHE_PERC),
5723 : : in_memory, /*should_wipe=*/false);
5724 [ + - ]: 2203 : snapshot_chainstate->InitCoinsCache(
5725 [ + - ]: 2203 : static_cast<size_t>(current_coinstip_cache_size * SNAPSHOT_CACHE_PERC));
5726 : 0 : }
5727 : :
5728 : 4355 : auto cleanup_bad_snapshot = [&](bilingual_str reason) EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
5729 : 2152 : this->MaybeRebalanceCaches();
5730 : :
5731 : : // PopulateAndValidateSnapshot can return (in error) before the leveldb datadir
5732 : : // has been created, so only attempt removal if we got that far.
5733 [ - + ]: 2152 : if (auto snapshot_datadir = node::FindAssumeutxoChainstateDir(m_options.datadir)) {
5734 : : // We have to destruct leveldb::DB in order to release the db lock, otherwise
5735 : : // DestroyDB() (in DeleteCoinsDBFromDisk()) will fail. See `leveldb::~DBImpl()`.
5736 : : // Destructing the chainstate (and so resetting the coinsviews object) does this.
5737 [ # # ]: 0 : snapshot_chainstate.reset();
5738 [ # # # # ]: 0 : bool removed = DeleteCoinsDBFromDisk(*snapshot_datadir, /*is_snapshot=*/true);
5739 [ # # ]: 0 : if (!removed) {
5740 [ # # # # ]: 0 : GetNotifications().fatalError(strprintf(_("Failed to remove snapshot chainstate dir (%s). "
5741 [ # # # # ]: 0 : "Manually remove it before restarting.\n"), fs::PathToString(*snapshot_datadir)));
5742 : : }
5743 : 2152 : }
5744 : 2152 : return util::Error{std::move(reason)};
5745 : 2203 : };
5746 : :
5747 [ + - + + ]: 2203 : if (auto res{this->PopulateAndValidateSnapshot(*snapshot_chainstate, coins_file, metadata)}; !res) {
5748 [ + - ]: 2152 : LOCK(::cs_main);
5749 [ + - + - : 10760 : return cleanup_bad_snapshot(Untranslated(strprintf("Population failed: %s", util::ErrorString(res).original)));
+ - + - +
- ]
5750 : 2152 : }
5751 : :
5752 [ + - ]: 51 : LOCK(::cs_main); // cs_main required for rest of snapshot activation.
5753 : :
5754 : : // Do a final check to ensure that the snapshot chainstate is actually a more
5755 : : // work chain than the active chainstate; a user could have loaded a snapshot
5756 : : // very late in the IBD process, and we wouldn't want to load a useless chainstate.
5757 [ - + + - : 102 : if (!CBlockIndexWorkComparator()(ActiveTip(), snapshot_chainstate->m_chain.Tip())) {
+ - - + ]
5758 [ # # # # : 0 : return cleanup_bad_snapshot(Untranslated("work does not exceed active chainstate"));
# # ]
5759 : : }
5760 : : // If not in-memory, persist the base blockhash for use during subsequent
5761 : : // initialization.
5762 [ - + ]: 51 : if (!in_memory) {
5763 [ # # # # ]: 0 : if (!node::WriteSnapshotBaseBlockhash(*snapshot_chainstate)) {
5764 [ # # # # : 0 : return cleanup_bad_snapshot(Untranslated("could not write base blockhash"));
# # ]
5765 : : }
5766 : : }
5767 : :
5768 [ + - ]: 51 : Chainstate& chainstate{AddChainstate(std::move(snapshot_chainstate))};
5769 [ + - ]: 51 : const bool chaintip_loaded{chainstate.LoadChainTip()};
5770 [ - + ]: 51 : assert(chaintip_loaded);
5771 [ + - - + : 51 : m_blockman.m_snapshot_height = Assert(chainstate.SnapshotBase())->nHeight;
+ - ]
5772 : :
5773 [ + - + - ]: 51 : LogInfo("[snapshot] successfully activated snapshot %s", base_blockhash.ToString());
5774 [ + - + - : 51 : LogInfo("[snapshot] (%.2f MB)",
+ - ]
5775 : : chainstate.CoinsTip().DynamicMemoryUsage() / (1000 * 1000));
5776 : :
5777 [ + - ]: 51 : this->MaybeRebalanceCaches();
5778 : 51 : return snapshot_start_block;
5779 : 2203 : }
5780 : :
5781 : 1227 : static void FlushSnapshotToDisk(CCoinsViewCache& coins_cache, bool snapshot_loaded)
5782 : : {
5783 [ - + + - : 2454 : LOG_TIME_MILLIS_WITH_CATEGORY_MSG_ONCE(
+ - ]
5784 : : strprintf("%s (%.2f MB)",
5785 : : snapshot_loaded ? "saving snapshot chainstate" : "flushing coins cache",
5786 : : coins_cache.DynamicMemoryUsage() / (1000 * 1000)),
5787 : : BCLog::LogFlags::ALL);
5788 : :
5789 [ + - ]: 1227 : coins_cache.Flush();
5790 : 1227 : }
5791 : :
5792 : 0 : struct StopHashingException : public std::exception
5793 : : {
5794 : 0 : const char* what() const noexcept override
5795 : : {
5796 : 0 : return "ComputeUTXOStats interrupted.";
5797 : : }
5798 : : };
5799 : :
5800 : 49184 : static void SnapshotUTXOHashBreakpoint(const util::SignalInterrupt& interrupt)
5801 : : {
5802 [ - + ]: 49184 : if (interrupt) throw StopHashingException();
5803 : 49184 : }
5804 : :
5805 : 2203 : util::Result<void> ChainstateManager::PopulateAndValidateSnapshot(
5806 : : Chainstate& snapshot_chainstate,
5807 : : AutoFile& coins_file,
5808 : : const SnapshotMetadata& metadata)
5809 : : {
5810 : : // It's okay to release cs_main before we're done using `coins_cache` because we know
5811 : : // that nothing else will be referencing the newly created snapshot_chainstate yet.
5812 [ + - + - ]: 6609 : CCoinsViewCache& coins_cache = *WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsTip());
5813 : :
5814 : 2203 : uint256 base_blockhash = metadata.m_base_blockhash;
5815 : :
5816 [ + - + - ]: 6609 : CBlockIndex* snapshot_start_block = WITH_LOCK(::cs_main, return m_blockman.LookupBlockIndex(base_blockhash));
5817 : :
5818 [ - + ]: 2203 : if (!snapshot_start_block) {
5819 : : // Needed for ComputeUTXOStats to determine the
5820 : : // height and to avoid a crash when base_blockhash.IsNull()
5821 [ # # # # ]: 0 : return util::Error{Untranslated(strprintf("Did not find snapshot start blockheader %s",
5822 : 0 : base_blockhash.ToString()))};
5823 : : }
5824 : :
5825 : 2203 : int base_height = snapshot_start_block->nHeight;
5826 : 2203 : const auto& maybe_au_data = GetParams().AssumeutxoForHeight(base_height);
5827 : :
5828 [ - + ]: 2203 : if (!maybe_au_data) {
5829 [ # # ]: 0 : return util::Error{Untranslated(strprintf("Assumeutxo height in snapshot metadata not recognized "
5830 : 0 : "(%d) - refusing to load snapshot", base_height))};
5831 : : }
5832 : :
5833 : 2203 : const AssumeutxoData& au_data = *maybe_au_data;
5834 : :
5835 : : // This work comparison is a duplicate check with the one performed later in
5836 : : // ActivateSnapshot(), but is done so that we avoid doing the long work of staging
5837 : : // a snapshot that isn't actually usable.
5838 [ - + + - : 6609 : if (WITH_LOCK(::cs_main, return !CBlockIndexWorkComparator()(ActiveTip(), snapshot_start_block))) {
+ - + - ]
5839 [ # # ]: 0 : return util::Error{Untranslated("Work does not exceed active chainstate")};
5840 : : }
5841 : :
5842 : 2203 : const uint64_t coins_count = metadata.m_coins_count;
5843 : 2203 : uint64_t coins_left = metadata.m_coins_count;
5844 : :
5845 [ + - ]: 2203 : LogInfo("[snapshot] loading %d coins from snapshot %s", coins_left, base_blockhash.ToString());
5846 : 2203 : int64_t coins_processed{0};
5847 : :
5848 [ + + ]: 63501 : while (coins_left > 0) {
5849 : 62178 : try {
5850 [ + + ]: 62178 : Txid txid;
5851 [ + + ]: 62178 : coins_file >> txid;
5852 : 62128 : size_t coins_per_txid{0};
5853 [ + + ]: 62128 : coins_per_txid = ReadCompactSize(coins_file);
5854 : :
5855 [ + + ]: 62068 : if (coins_per_txid > coins_left) {
5856 [ + - + - ]: 246 : return util::Error{Untranslated("Mismatch in coins count in snapshot metadata and actual snapshot data")};
5857 : : }
5858 : :
5859 [ + + ]: 558762 : for (size_t i = 0; i < coins_per_txid; i++) {
5860 : 497464 : COutPoint outpoint;
5861 : 497464 : Coin coin;
5862 [ + + ]: 497464 : outpoint.n = static_cast<uint32_t>(ReadCompactSize(coins_file));
5863 : 497362 : outpoint.hash = txid;
5864 [ + + ]: 497362 : coins_file >> coin;
5865 [ + + ]: 497002 : if (coin.nHeight > base_height ||
5866 [ - + ]: 496820 : outpoint.n >= std::numeric_limits<decltype(outpoint.n)>::max() // Avoid integer wrap-around in coinstats.cpp:ApplyHash
5867 : : ) {
5868 [ + - ]: 364 : return util::Error{Untranslated(strprintf("Bad snapshot data after deserializing %d coins",
5869 [ + - ]: 364 : coins_count - coins_left))};
5870 : : }
5871 [ + + ]: 496820 : if (!MoneyRange(coin.out.nValue)) {
5872 [ + - ]: 88 : return util::Error{Untranslated(strprintf("Bad snapshot data after deserializing %d coins - bad tx out value",
5873 [ + - ]: 88 : coins_count - coins_left))};
5874 : : }
5875 [ + - ]: 496776 : coins_cache.EmplaceCoinInternalDANGER(std::move(outpoint), std::move(coin));
5876 : :
5877 : 496776 : --coins_left;
5878 : 496776 : ++coins_processed;
5879 : :
5880 [ - + ]: 496776 : if (coins_processed % 1000000 == 0) {
5881 [ # # # # ]: 0 : LogInfo("[snapshot] %d coins loaded (%.2f%%, %.2f MB)",
5882 : : coins_processed,
5883 : : static_cast<float>(coins_processed) * 100 / static_cast<float>(coins_count),
5884 : : coins_cache.DynamicMemoryUsage() / (1000 * 1000));
5885 : : }
5886 : :
5887 : : // Batch write and flush (if we need to) every so often.
5888 : : //
5889 : : // If our average Coin size is roughly 41 bytes, checking every 120,000 coins
5890 : : // means <5MB of memory imprecision.
5891 [ - + ]: 496776 : if (coins_processed % 120000 == 0) {
5892 [ # # # # ]: 0 : if (m_interrupt) {
5893 [ # # # # ]: 0 : return util::Error{Untranslated("Aborting after an interrupt was requested")};
5894 : : }
5895 : :
5896 [ # # # # : 0 : const auto snapshot_cache_state = WITH_LOCK(::cs_main,
# # ]
5897 : : return snapshot_chainstate.GetCoinsCacheSizeState());
5898 : :
5899 [ # # ]: 0 : if (snapshot_cache_state >= CoinsCacheSizeState::CRITICAL) {
5900 : : // This is a hack - we don't know what the actual best block is, but that
5901 : : // doesn't matter for the purposes of flushing the cache here. We'll set this
5902 : : // to its correct value (`base_blockhash`) below after the coins are loaded.
5903 [ # # ]: 0 : coins_cache.SetBestBlock(GetRandHash());
5904 : :
5905 : : // No need to acquire cs_main since this chainstate isn't being used yet.
5906 [ # # ]: 0 : FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/false);
5907 : : }
5908 : : }
5909 : 497464 : }
5910 [ - + ]: 572 : } catch (const std::ios_base::failure&) {
5911 [ + - + - ]: 1144 : return util::Error{Untranslated(strprintf("Bad snapshot format or truncated snapshot after deserializing %d coins",
5912 : 572 : coins_processed))};
5913 : 572 : }
5914 : : }
5915 : :
5916 : : // Important that we set this. This and the coins_cache accesses above are
5917 : : // sort of a layer violation, but either we reach into the innards of
5918 : : // CCoinsViewCache here or we have to invert some of the Chainstate to
5919 : : // embed them in a snapshot-activation-specific CCoinsViewCache bulk load
5920 : : // method.
5921 : 1323 : coins_cache.SetBestBlock(base_blockhash);
5922 : :
5923 : 1323 : bool out_of_coins{false};
5924 : 1323 : try {
5925 : 1323 : std::byte left_over_byte;
5926 [ + + ]: 1323 : coins_file >> left_over_byte;
5927 [ - + ]: 1227 : } catch (const std::ios_base::failure&) {
5928 : : // We expect an exception since we should be out of coins.
5929 : 1227 : out_of_coins = true;
5930 : 1227 : }
5931 : 1323 : if (!out_of_coins) {
5932 [ + - ]: 192 : return util::Error{Untranslated(strprintf("Bad snapshot - coins left over after deserializing %d coins",
5933 : 96 : coins_count))};
5934 : : }
5935 : :
5936 [ + - + - ]: 1227 : LogInfo("[snapshot] loaded %d (%.2f MB) coins from snapshot %s",
5937 : : coins_count,
5938 : : coins_cache.DynamicMemoryUsage() / (1000 * 1000),
5939 : : base_blockhash.ToString());
5940 : :
5941 : : // No need to acquire cs_main since this chainstate isn't being used yet.
5942 : 1227 : FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/true);
5943 : :
5944 [ - + ]: 1227 : assert(coins_cache.GetBestBlock() == base_blockhash);
5945 : :
5946 : : // As above, okay to immediately release cs_main here since no other context knows
5947 : : // about the snapshot_chainstate.
5948 [ + - + - ]: 3681 : CCoinsViewDB* snapshot_coinsdb = WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsDB());
5949 : :
5950 : 1227 : std::optional<CCoinsStats> maybe_stats;
5951 : :
5952 : 1227 : try {
5953 : 1227 : maybe_stats = ComputeUTXOStats(
5954 [ + - ]: 50411 : CoinStatsHashType::HASH_SERIALIZED, snapshot_coinsdb, m_blockman, [&interrupt = m_interrupt] { SnapshotUTXOHashBreakpoint(interrupt); });
5955 [ - - ]: 0 : } catch (StopHashingException const&) {
5956 [ - - - - ]: 0 : return util::Error{Untranslated("Aborting after an interrupt was requested")};
5957 : 0 : }
5958 [ - + ]: 1227 : if (!maybe_stats.has_value()) {
5959 [ - - ]: 0 : return util::Error{Untranslated("Failed to generate coins stats")};
5960 : : }
5961 : :
5962 : : // Assert that the deserialized chainstate contents match the expected assumeutxo value.
5963 [ + + ]: 1227 : if (AssumeutxoHash{maybe_stats->hashSerialized} != au_data.hash_serialized) {
5964 [ + - ]: 3528 : return util::Error{Untranslated(strprintf("Bad snapshot content hash: expected %s, got %s",
5965 [ + - + - ]: 3528 : au_data.hash_serialized.ToString(), maybe_stats->hashSerialized.ToString()))};
5966 : : }
5967 : :
5968 : 51 : snapshot_chainstate.m_chain.SetTip(*snapshot_start_block);
5969 : :
5970 : : // The remainder of this function requires modifying data protected by cs_main.
5971 : 51 : LOCK(::cs_main);
5972 : :
5973 : : // Fake various pieces of CBlockIndex state:
5974 : 51 : CBlockIndex* index = nullptr;
5975 : :
5976 : : // Don't make any modifications to the genesis block since it shouldn't be
5977 : : // necessary, and since the genesis block doesn't have normal flags like
5978 : : // BLOCK_VALID_SCRIPTS set.
5979 : 51 : constexpr int AFTER_GENESIS_START{1};
5980 : :
5981 [ - + + + ]: 10251 : for (int i = AFTER_GENESIS_START; i <= snapshot_chainstate.m_chain.Height(); ++i) {
5982 [ + - ]: 10200 : index = snapshot_chainstate.m_chain[i];
5983 : :
5984 : : // Fake BLOCK_OPT_WITNESS so that Chainstate::NeedsRedownload()
5985 : : // won't ask for -reindex on startup.
5986 [ + - ]: 10200 : if (DeploymentActiveAt(*index, *this, Consensus::DEPLOYMENT_SEGWIT)) {
5987 : 10200 : index->nStatus |= BLOCK_OPT_WITNESS;
5988 : : }
5989 : :
5990 [ + - ]: 10200 : m_blockman.m_dirty_blockindex.insert(index);
5991 : : // Changes to the block index will be flushed to disk after this call
5992 : : // returns in `ActivateSnapshot()`, when `MaybeRebalanceCaches()` is
5993 : : // called, since we've added a snapshot chainstate and therefore will
5994 : : // have to downsize the IBD chainstate, which will result in a call to
5995 : : // `FlushStateToDisk(ALWAYS)`.
5996 : : }
5997 : :
5998 [ - + ]: 51 : assert(index);
5999 [ - + ]: 51 : assert(index == snapshot_start_block);
6000 : 51 : index->m_chain_tx_count = au_data.m_chain_tx_count;
6001 [ + - ]: 51 : snapshot_chainstate.setBlockIndexCandidates.insert(snapshot_start_block);
6002 : :
6003 [ + - + - ]: 51 : LogInfo("[snapshot] validated snapshot (%.2f MB)",
6004 : : coins_cache.DynamicMemoryUsage() / (1000 * 1000));
6005 [ + - ]: 51 : return {};
6006 : 51 : }
6007 : :
6008 : : // Currently, this function holds cs_main for its duration, which could be for
6009 : : // multiple minutes due to the ComputeUTXOStats call. Holding cs_main used to be
6010 : : // necessary (before d43a1f1a2fa3) to avoid advancing validated_cs farther than
6011 : : // its target block. Now it should be possible to avoid this, but simply
6012 : : // releasing cs_main here would not be possible because this function is invoked
6013 : : // by ConnectTip within ActivateBestChain.
6014 : : //
6015 : : // Eventually (TODO) it would be better to call this function outside of
6016 : : // ActivateBestChain, on a separate thread that should not require cs_main to
6017 : : // hash, because the UTXO set is only hashed after the historical chainstate
6018 : : // reaches its target block and is no longer changing.
6019 : 162573 : SnapshotCompletionResult ChainstateManager::MaybeValidateSnapshot(Chainstate& validated_cs, Chainstate& unvalidated_cs)
6020 : : {
6021 : 162573 : AssertLockHeld(cs_main);
6022 : :
6023 : : // If the snapshot does not need to be validated...
6024 [ # # ]: 0 : if (unvalidated_cs.m_assumeutxo != Assumeutxo::UNVALIDATED ||
6025 : : // Or if either chainstate is unusable...
6026 [ # # ]: 0 : !unvalidated_cs.m_from_snapshot_blockhash ||
6027 [ # # ]: 0 : validated_cs.m_assumeutxo != Assumeutxo::VALIDATED ||
6028 [ # # # # : 0 : !validated_cs.m_chain.Tip() ||
# # ]
6029 : : // Or the validated chainstate is not targeting the snapshot block...
6030 [ # # # # ]: 0 : !validated_cs.m_target_blockhash ||
6031 [ - + - - : 162573 : *validated_cs.m_target_blockhash != *unvalidated_cs.m_from_snapshot_blockhash ||
- - ]
6032 : : // Or the validated chainstate has not reached the snapshot block yet...
6033 : 0 : !validated_cs.ReachedTarget()) {
6034 : : // Then the snapshot cannot be validated and there is nothing to do.
6035 : 162573 : return SnapshotCompletionResult::SKIPPED;
6036 : : }
6037 [ # # # # ]: 0 : assert(validated_cs.TargetBlock() == validated_cs.m_chain.Tip());
6038 : :
6039 : 0 : auto handle_invalid_snapshot = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
6040 : 0 : bilingual_str user_error = strprintf(_(
6041 : : "%s failed to validate the -assumeutxo snapshot state. "
6042 : : "This indicates a hardware problem, or a bug in the software, or a "
6043 : : "bad software modification that allowed an invalid snapshot to be "
6044 : : "loaded. As a result of this, the node will shut down and stop using any "
6045 : : "state that was built on the snapshot, resetting the chain height "
6046 : : "from %d to %d. On the next "
6047 : : "restart, the node will resume syncing from %d "
6048 : : "without using any snapshot data. "
6049 : : "Please report this incident to %s, including how you obtained the snapshot. "
6050 : : "The invalid snapshot chainstate will be left on disk in case it is "
6051 : : "helpful in diagnosing the issue that caused this error."),
6052 : 0 : CLIENT_NAME, unvalidated_cs.m_chain.Height(),
6053 : 0 : validated_cs.m_chain.Height(),
6054 [ # # # # ]: 0 : validated_cs.m_chain.Height(), CLIENT_BUGREPORT);
6055 : :
6056 [ # # ]: 0 : LogError("[snapshot] !!! %s\n", user_error.original);
6057 [ # # ]: 0 : LogError("[snapshot] deleting snapshot, reverting to validated chain, and stopping node\n");
6058 : :
6059 : : // Reset chainstate target to network tip instead of snapshot block.
6060 [ # # ]: 0 : validated_cs.SetTargetBlock(nullptr);
6061 : :
6062 : 0 : unvalidated_cs.m_assumeutxo = Assumeutxo::INVALID;
6063 : :
6064 [ # # ]: 0 : auto rename_result = unvalidated_cs.InvalidateCoinsDBOnDisk();
6065 [ # # ]: 0 : if (!rename_result) {
6066 [ # # # # : 0 : user_error += Untranslated("\n") + util::ErrorString(rename_result);
# # # # ]
6067 : : }
6068 : :
6069 [ # # ]: 0 : GetNotifications().fatalError(user_error);
6070 : 0 : };
6071 : :
6072 : 0 : CCoinsViewDB& validated_coins_db = validated_cs.CoinsDB();
6073 : 0 : validated_cs.ForceFlushStateToDisk();
6074 : :
6075 [ # # ]: 0 : const auto& maybe_au_data = m_options.chainparams.AssumeutxoForHeight(validated_cs.m_chain.Height());
6076 [ # # ]: 0 : if (!maybe_au_data) {
6077 : 0 : LogWarning("[snapshot] assumeutxo data not found for height "
6078 : : "(%d) - refusing to validate snapshot", validated_cs.m_chain.Height());
6079 : 0 : handle_invalid_snapshot();
6080 : 0 : return SnapshotCompletionResult::MISSING_CHAINPARAMS;
6081 : : }
6082 : :
6083 : 0 : const AssumeutxoData& au_data = *maybe_au_data;
6084 : 0 : std::optional<CCoinsStats> validated_cs_stats;
6085 : 0 : LogInfo("[snapshot] computing UTXO stats for background chainstate to validate "
6086 : : "snapshot - this could take a few minutes");
6087 : 0 : try {
6088 : 0 : validated_cs_stats = ComputeUTXOStats(
6089 : : CoinStatsHashType::HASH_SERIALIZED,
6090 : : &validated_coins_db,
6091 [ # # ]: 0 : m_blockman,
6092 [ # # ]: 0 : [&interrupt = m_interrupt] { SnapshotUTXOHashBreakpoint(interrupt); });
6093 [ - - ]: 0 : } catch (StopHashingException const&) {
6094 : 0 : return SnapshotCompletionResult::STATS_FAILED;
6095 : 0 : }
6096 : :
6097 : : // XXX note that this function is slow and will hold cs_main for potentially minutes.
6098 [ # # ]: 0 : if (!validated_cs_stats) {
6099 : 0 : LogWarning("[snapshot] failed to generate stats for validation coins db");
6100 : : // While this isn't a problem with the snapshot per se, this condition
6101 : : // prevents us from validating the snapshot, so we should shut down and let the
6102 : : // user handle the issue manually.
6103 : 0 : handle_invalid_snapshot();
6104 : 0 : return SnapshotCompletionResult::STATS_FAILED;
6105 : : }
6106 : :
6107 : : // Compare the validated chainstate's UTXO set hash against the hard-coded
6108 : : // assumeutxo hash we expect.
6109 : : //
6110 : : // TODO: For belt-and-suspenders, we could cache the UTXO set
6111 : : // hash for the snapshot when it's loaded in its chainstate's leveldb. We could then
6112 : : // reference that here for an additional check.
6113 [ # # ]: 0 : if (AssumeutxoHash{validated_cs_stats->hashSerialized} != au_data.hash_serialized) {
6114 [ # # # # ]: 0 : LogWarning("[snapshot] hash mismatch: actual=%s, expected=%s",
6115 : : validated_cs_stats->hashSerialized.ToString(),
6116 : : au_data.hash_serialized.ToString());
6117 : 0 : handle_invalid_snapshot();
6118 : 0 : return SnapshotCompletionResult::HASH_MISMATCH;
6119 : : }
6120 : :
6121 [ # # ]: 0 : LogInfo("[snapshot] snapshot beginning at %s has been fully validated",
6122 : : unvalidated_cs.m_from_snapshot_blockhash->ToString());
6123 : :
6124 : 0 : unvalidated_cs.m_assumeutxo = Assumeutxo::VALIDATED;
6125 [ # # ]: 0 : validated_cs.m_target_utxohash = AssumeutxoHash{validated_cs_stats->hashSerialized};
6126 : 0 : this->MaybeRebalanceCaches();
6127 : :
6128 : 0 : return SnapshotCompletionResult::SUCCESS;
6129 : : }
6130 : :
6131 : 4525164 : Chainstate& ChainstateManager::ActiveChainstate() const
6132 : : {
6133 : 4525164 : LOCK(::cs_main);
6134 [ + - ]: 4525164 : return CurrentChainstate();
6135 : 4525164 : }
6136 : :
6137 : 5105 : void ChainstateManager::MaybeRebalanceCaches()
6138 : : {
6139 : 5105 : AssertLockHeld(::cs_main);
6140 : 5105 : Chainstate& current_cs{CurrentChainstate()};
6141 : 5105 : Chainstate* historical_cs{HistoricalChainstate()};
6142 [ + + + - ]: 5105 : if (!historical_cs && !current_cs.m_from_snapshot_blockhash) {
6143 : : // Allocate everything to the IBD chainstate. This will always happen
6144 : : // when we are not using a snapshot.
6145 : 5054 : current_cs.ResizeCoinsCaches(m_total_coinstip_cache, m_total_coinsdb_cache);
6146 [ - + ]: 51 : } else if (!historical_cs) {
6147 : : // If background validation has completed and snapshot is our active chain...
6148 : 0 : LogInfo("[snapshot] allocating all cache to the snapshot chainstate");
6149 : : // Allocate everything to the snapshot chainstate.
6150 : 0 : current_cs.ResizeCoinsCaches(m_total_coinstip_cache, m_total_coinsdb_cache);
6151 : : } else {
6152 : : // If both chainstates exist, determine who needs more cache based on IBD status.
6153 : : //
6154 : : // Note: shrink caches first so that we don't inadvertently overwhelm available memory.
6155 [ + + ]: 51 : if (IsInitialBlockDownload()) {
6156 : 34 : historical_cs->ResizeCoinsCaches(
6157 : 34 : m_total_coinstip_cache * 0.05, m_total_coinsdb_cache * 0.05);
6158 : 34 : current_cs.ResizeCoinsCaches(
6159 : 34 : m_total_coinstip_cache * 0.95, m_total_coinsdb_cache * 0.95);
6160 : : } else {
6161 : 17 : current_cs.ResizeCoinsCaches(
6162 : 17 : m_total_coinstip_cache * 0.05, m_total_coinsdb_cache * 0.05);
6163 : 17 : historical_cs->ResizeCoinsCaches(
6164 : 17 : m_total_coinstip_cache * 0.95, m_total_coinsdb_cache * 0.95);
6165 : : }
6166 : : }
6167 : 5105 : }
6168 : :
6169 : 0 : void ChainstateManager::ResetChainstates()
6170 : : {
6171 : 0 : m_chainstates.clear();
6172 : 0 : }
6173 : :
6174 : : /**
6175 : : * Apply default chain params to nullopt members.
6176 : : * This helps to avoid coding errors around the accidental use of the compare
6177 : : * operators that accept nullopt, thus ignoring the intended default value.
6178 : : */
6179 : 2243 : static ChainstateManager::Options&& Flatten(ChainstateManager::Options&& opts)
6180 : : {
6181 [ - + ]: 2243 : if (!opts.check_block_index.has_value()) opts.check_block_index = opts.chainparams.DefaultConsistencyChecks();
6182 [ + - - + ]: 2243 : if (!opts.minimum_chain_work.has_value()) opts.minimum_chain_work = UintToArith256(opts.chainparams.GetConsensus().nMinimumChainWork);
6183 [ + - ]: 2243 : if (!opts.assumed_valid_block.has_value()) opts.assumed_valid_block = opts.chainparams.GetConsensus().defaultAssumeValid;
6184 : 2243 : return std::move(opts);
6185 : : }
6186 : :
6187 : 2243 : ChainstateManager::ChainstateManager(const util::SignalInterrupt& interrupt, Options options, node::BlockManager::Options blockman_options)
6188 : 2243 : : m_script_check_queue{/*batch_size=*/128, std::clamp(options.worker_threads_num, 0, MAX_SCRIPTCHECK_THREADS)},
6189 : 2243 : m_interrupt{interrupt},
6190 [ + - ]: 2243 : m_options{Flatten(std::move(options))},
6191 [ + - + - ]: 2243 : m_blockman{interrupt, std::move(blockman_options)},
6192 [ + - + - : 6729 : m_validation_cache{m_options.script_execution_cache_bytes, m_options.signature_cache_bytes}
+ - ]
6193 : : {
6194 : 2243 : }
6195 : :
6196 : 2243 : ChainstateManager::~ChainstateManager()
6197 : : {
6198 : 2243 : LOCK(::cs_main);
6199 : :
6200 [ + - ]: 2243 : m_versionbitscache.Clear();
6201 : 8972 : }
6202 : :
6203 : 2243 : Chainstate* ChainstateManager::LoadAssumeutxoChainstate()
6204 : : {
6205 [ - + ]: 2243 : assert(!CurrentChainstate().m_from_snapshot_blockhash);
6206 : 2243 : std::optional<fs::path> path = node::FindAssumeutxoChainstateDir(m_options.datadir);
6207 [ - + ]: 2243 : if (!path) {
6208 : : return nullptr;
6209 : : }
6210 [ # # # # ]: 0 : std::optional<uint256> base_blockhash = node::ReadSnapshotBaseBlockhash(*path);
6211 [ # # ]: 0 : if (!base_blockhash) {
6212 : : return nullptr;
6213 : : }
6214 [ # # # # ]: 0 : LogInfo("[snapshot] detected active snapshot chainstate (%s) - loading",
6215 : : fs::PathToString(*path));
6216 : :
6217 [ # # ]: 0 : auto snapshot_chainstate{std::make_unique<Chainstate>(nullptr, m_blockman, *this, base_blockhash)};
6218 [ # # # # ]: 0 : LogInfo("[snapshot] switching active chainstate to %s", snapshot_chainstate->ToString());
6219 [ # # ]: 0 : return &this->AddChainstate(std::move(snapshot_chainstate));
6220 : 2243 : }
6221 : :
6222 : 51 : Chainstate& ChainstateManager::AddChainstate(std::unique_ptr<Chainstate> chainstate)
6223 : : {
6224 : 51 : Chainstate& prev_chainstate{CurrentChainstate()};
6225 [ - + ]: 51 : assert(prev_chainstate.m_assumeutxo == Assumeutxo::VALIDATED);
6226 : : // Set target block for historical chainstate to snapshot block.
6227 [ - + ]: 51 : assert(!prev_chainstate.m_target_blockhash);
6228 : 51 : prev_chainstate.m_target_blockhash = chainstate->m_from_snapshot_blockhash;
6229 : 51 : m_chainstates.push_back(std::move(chainstate));
6230 : 51 : Chainstate& curr_chainstate{CurrentChainstate()};
6231 [ - + ]: 51 : assert(&curr_chainstate == m_chainstates.back().get());
6232 : :
6233 : : // Transfer possession of the mempool to the chainstate.
6234 : : // Mempool is empty at this point because we're still in IBD.
6235 [ - + ]: 51 : assert(prev_chainstate.m_mempool->size() == 0);
6236 [ - + ]: 51 : assert(!curr_chainstate.m_mempool);
6237 : 51 : std::swap(curr_chainstate.m_mempool, prev_chainstate.m_mempool);
6238 : 51 : return curr_chainstate;
6239 : : }
6240 : :
6241 : 368663 : bool IsBIP30Repeat(const CBlockIndex& block_index)
6242 : : {
6243 [ - + - - ]: 368663 : return (block_index.nHeight==91842 && block_index.GetBlockHash() == uint256{"00000000000a4d0a398161ffc163c503763b1f4360639393e0e4c8e300e0caec"}) ||
6244 [ - + - - ]: 368663 : (block_index.nHeight==91880 && block_index.GetBlockHash() == uint256{"00000000000743f190a18c5577a3c2d2a1f610ae9601ac046a38084ccb7cd721"});
6245 : : }
6246 : :
6247 : 0 : bool IsBIP30Unspendable(const uint256& block_hash, int block_height)
6248 : : {
6249 [ # # # # : 0 : return (block_height==91722 && block_hash == uint256{"00000000000271a2dc26e7667f8419f2e15416dc6955e5a6c6cdf3f2574dd08e"}) ||
# # ]
6250 [ # # ]: 0 : (block_height==91812 && block_hash == uint256{"00000000000af0aed4792b1acee3d966af36cf5def14935db8de83d6f9306f2f"});
6251 : : }
6252 : :
6253 : 0 : util::Result<void> Chainstate::InvalidateCoinsDBOnDisk()
6254 : : {
6255 : : // Should never be called on a non-snapshot chainstate.
6256 [ # # ]: 0 : assert(m_from_snapshot_blockhash);
6257 : :
6258 : : // Coins views no longer usable.
6259 [ # # ]: 0 : m_coins_views.reset();
6260 : :
6261 : 0 : const fs::path db_path{StoragePath()};
6262 [ # # # # ]: 0 : const fs::path invalid_path{db_path + "_INVALID"};
6263 [ # # ]: 0 : const std::string db_path_str{fs::PathToString(db_path)};
6264 [ # # ]: 0 : const std::string invalid_path_str{fs::PathToString(invalid_path)};
6265 [ # # ]: 0 : LogInfo("[snapshot] renaming snapshot datadir %s to %s", db_path_str, invalid_path_str);
6266 : :
6267 : : // The invalid storage directory is simply moved and not deleted because we may
6268 : : // want to do forensics later during issue investigation. The user is instructed
6269 : : // accordingly in MaybeValidateSnapshot().
6270 : 0 : try {
6271 [ # # ]: 0 : fs::rename(db_path, invalid_path);
6272 [ - - ]: 0 : } catch (const fs::filesystem_error& e) {
6273 [ - - ]: 0 : LogError("While invalidating the coins db: Error renaming file '%s' -> '%s': %s",
6274 : : db_path_str, invalid_path_str, e.what());
6275 [ - - ]: 0 : return util::Error{strprintf(_(
6276 : : "Rename of '%s' -> '%s' failed. "
6277 : : "You should resolve this by manually moving or deleting the invalid "
6278 : : "snapshot directory %s, otherwise you will encounter the same error again "
6279 : : "on the next startup."),
6280 : 0 : db_path_str, invalid_path_str, db_path_str)};
6281 [ - - ]: 0 : }
6282 : 0 : return {};
6283 : 0 : }
6284 : :
6285 : 0 : bool ChainstateManager::DeleteChainstate(Chainstate& chainstate)
6286 : : {
6287 : 0 : AssertLockHeld(::cs_main);
6288 [ # # ]: 0 : assert(!chainstate.m_coins_views);
6289 : 0 : const fs::path db_path{chainstate.StoragePath()};
6290 [ # # # # : 0 : if (!DeleteCoinsDBFromDisk(db_path, /*is_snapshot=*/bool{chainstate.m_from_snapshot_blockhash})) {
# # ]
6291 [ # # # # ]: 0 : LogError("Deletion of %s failed. Please remove it manually to continue reindexing.",
6292 : : fs::PathToString(db_path));
6293 : 0 : return false;
6294 : : }
6295 [ # # ]: 0 : std::unique_ptr<Chainstate> prev_chainstate{Assert(RemoveChainstate(chainstate))};
6296 : 0 : Chainstate& curr_chainstate{CurrentChainstate()};
6297 [ # # # # ]: 0 : assert(prev_chainstate->m_mempool->size() == 0);
6298 [ # # ]: 0 : assert(!curr_chainstate.m_mempool);
6299 : 0 : std::swap(curr_chainstate.m_mempool, prev_chainstate->m_mempool);
6300 : 0 : return true;
6301 : 0 : }
6302 : :
6303 : 850918 : ChainstateRole Chainstate::GetRole() const
6304 : : {
6305 : 850918 : return ChainstateRole{.validated = m_assumeutxo == Assumeutxo::VALIDATED, .historical = bool{m_target_blockhash}};
6306 : : }
6307 : :
6308 : 11014 : void ChainstateManager::RecalculateBestHeader()
6309 : : {
6310 : 11014 : AssertLockHeld(cs_main);
6311 [ - + ]: 11014 : m_best_header = ActiveChain().Tip();
6312 [ + + + + ]: 606918 : for (auto& entry : m_blockman.m_block_index) {
6313 [ + + + + ]: 595904 : if (!(entry.second.nStatus & BLOCK_FAILED_MASK) && m_best_header->nChainWork < entry.second.nChainWork) {
6314 : 247 : m_best_header = &entry.second;
6315 : : }
6316 : : }
6317 : 11014 : }
6318 : :
6319 : 0 : bool ChainstateManager::ValidatedSnapshotCleanup(Chainstate& validated_cs, Chainstate& unvalidated_cs)
6320 : : {
6321 : 0 : AssertLockHeld(::cs_main);
6322 [ # # ]: 0 : if (unvalidated_cs.m_assumeutxo != Assumeutxo::VALIDATED) {
6323 : : // No need to clean up.
6324 : : return false;
6325 : : }
6326 : :
6327 : 0 : const fs::path validated_path{validated_cs.StoragePath()};
6328 [ # # ]: 0 : const fs::path assumed_valid_path{unvalidated_cs.StoragePath()};
6329 [ # # # # ]: 0 : const fs::path delete_path{validated_path + "_todelete"};
6330 : :
6331 : : // Since we're going to be moving around the underlying leveldb filesystem content
6332 : : // for each chainstate, make sure that the chainstates (and their constituent
6333 : : // CoinsViews members) have been destructed first.
6334 : : //
6335 : : // The caller of this method will be responsible for reinitializing chainstates
6336 : : // if they want to continue operation.
6337 [ # # ]: 0 : this->ResetChainstates();
6338 [ # # # # ]: 0 : assert(this->m_chainstates.size() == 0);
6339 : :
6340 [ # # # # ]: 0 : LogInfo("[snapshot] deleting background chainstate directory (now unnecessary) (%s)",
6341 : : fs::PathToString(validated_path));
6342 : :
6343 : 0 : auto rename_failed_abort = [this](
6344 : : fs::path p_old,
6345 : : fs::path p_new,
6346 : : const fs::filesystem_error& err) {
6347 [ # # # # : 0 : LogError("[snapshot] Error renaming path (%s) -> (%s): %s\n",
# # ]
6348 : : fs::PathToString(p_old), fs::PathToString(p_new), err.what());
6349 [ # # # # ]: 0 : GetNotifications().fatalError(strprintf(_(
6350 : : "Rename of '%s' -> '%s' failed. "
6351 : : "Cannot clean up the background chainstate leveldb directory."),
6352 [ # # # # ]: 0 : fs::PathToString(p_old), fs::PathToString(p_new)));
6353 : 0 : };
6354 : :
6355 : 0 : try {
6356 [ # # ]: 0 : fs::rename(validated_path, delete_path);
6357 [ - - ]: 0 : } catch (const fs::filesystem_error& e) {
6358 [ - - - - : 0 : rename_failed_abort(validated_path, delete_path, e);
- - ]
6359 : 0 : throw;
6360 : 0 : }
6361 : :
6362 [ # # # # : 0 : LogInfo("[snapshot] moving snapshot chainstate (%s) to "
# # ]
6363 : : "default chainstate directory (%s)",
6364 : : fs::PathToString(assumed_valid_path), fs::PathToString(validated_path));
6365 : :
6366 : 0 : try {
6367 [ # # ]: 0 : fs::rename(assumed_valid_path, validated_path);
6368 [ - - ]: 0 : } catch (const fs::filesystem_error& e) {
6369 [ - - - - : 0 : rename_failed_abort(assumed_valid_path, validated_path, e);
- - ]
6370 : 0 : throw;
6371 : 0 : }
6372 : :
6373 [ # # # # : 0 : if (!DeleteCoinsDBFromDisk(delete_path, /*is_snapshot=*/false)) {
# # ]
6374 : : // No need to FatalError because once the unneeded bg chainstate data is
6375 : : // moved, it will not interfere with subsequent initialization.
6376 [ # # # # ]: 0 : LogWarning("Deletion of %s failed. Please remove it manually, as the "
6377 : : "directory is now unnecessary.",
6378 : : fs::PathToString(delete_path));
6379 : : } else {
6380 [ # # # # ]: 0 : LogInfo("[snapshot] deleted background chainstate directory (%s)",
6381 : : fs::PathToString(validated_path));
6382 : : }
6383 : 0 : return true;
6384 : 0 : }
6385 : :
6386 : 0 : std::pair<int, int> Chainstate::GetPruneRange(int last_height_can_prune) const
6387 : : {
6388 [ # # # # ]: 0 : if (m_chain.Height() <= 0) {
6389 : 0 : return {0, 0};
6390 : : }
6391 : 0 : int prune_start{0};
6392 : :
6393 [ # # # # ]: 0 : if (m_from_snapshot_blockhash && m_assumeutxo != Assumeutxo::VALIDATED) {
6394 : : // Only prune blocks _after_ the snapshot if this is a snapshot chain
6395 : : // that has not been fully validated yet. The earlier blocks need to be
6396 : : // kept to validate the snapshot
6397 [ # # ]: 0 : prune_start = Assert(SnapshotBase())->nHeight + 1;
6398 : : }
6399 : :
6400 : 0 : int max_prune = std::max<int>(
6401 [ # # # # ]: 0 : 0, m_chain.Height() - static_cast<int>(MIN_BLOCKS_TO_KEEP));
6402 : :
6403 : : // last block to prune is the lesser of (caller-specified height, MIN_BLOCKS_TO_KEEP from the tip)
6404 : : //
6405 : : // While you might be tempted to prune the background chainstate more
6406 : : // aggressively (i.e. fewer MIN_BLOCKS_TO_KEEP), this won't work with index
6407 : : // building - specifically blockfilterindex requires undo data, and if
6408 : : // we don't maintain this trailing window, we hit indexing failures.
6409 [ # # ]: 0 : int prune_end = std::min(last_height_can_prune, max_prune);
6410 : :
6411 : 0 : return {prune_start, prune_end};
6412 : : }
6413 : :
6414 : 37063 : std::optional<std::pair<const CBlockIndex*, const CBlockIndex*>> ChainstateManager::GetHistoricalBlockRange() const
6415 : : {
6416 : 37063 : const Chainstate* chainstate{HistoricalChainstate()};
6417 [ + - ]: 37063 : if (!chainstate) return {};
6418 [ # # ]: 0 : return std::make_pair(chainstate->m_chain.Tip(), chainstate->TargetBlock());
6419 : : }
6420 : :
6421 : 0 : util::Result<void> ChainstateManager::ActivateBestChains()
6422 : : {
6423 : : // We can't hold cs_main during ActivateBestChain even though we're accessing
6424 : : // the chainman unique_ptrs since ABC requires us not to be holding cs_main, so retrieve
6425 : : // the relevant pointers before the ABC call.
6426 : 0 : AssertLockNotHeld(cs_main);
6427 : 0 : std::vector<Chainstate*> chainstates;
6428 : 0 : {
6429 [ # # ]: 0 : LOCK(GetMutex());
6430 [ # # # # ]: 0 : chainstates.reserve(m_chainstates.size());
6431 [ # # ]: 0 : for (const auto& chainstate : m_chainstates) {
6432 [ # # # # : 0 : if (chainstate && chainstate->m_assumeutxo != Assumeutxo::INVALID && !chainstate->m_target_utxohash) {
# # ]
6433 [ # # ]: 0 : chainstates.push_back(chainstate.get());
6434 : : }
6435 : : }
6436 : 0 : }
6437 [ # # ]: 0 : for (Chainstate* chainstate : chainstates) {
6438 [ # # ]: 0 : BlockValidationState state;
6439 [ # # # # : 0 : if (!chainstate->ActivateBestChain(state, nullptr)) {
# # ]
6440 [ # # ]: 0 : LOCK(GetMutex());
6441 [ # # # # : 0 : return util::Error{Untranslated(strprintf("%s Failed to connect best block (%s)", chainstate->ToString(), state.ToString()))};
# # # # #
# ]
6442 : 0 : }
6443 : 0 : }
6444 : 0 : return {};
6445 : 0 : }
|
