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