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