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