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