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