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