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