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