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