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