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