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