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