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