Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #ifndef BITCOIN_VALIDATION_H
7 : : #define BITCOIN_VALIDATION_H
8 : :
9 : : #include <arith_uint256.h>
10 : : #include <attributes.h>
11 : : #include <chain.h>
12 : : #include <checkqueue.h>
13 : : #include <consensus/amount.h>
14 : : #include <cuckoocache.h>
15 : : #include <deploymentstatus.h>
16 : : #include <kernel/chain.h>
17 : : #include <kernel/chainparams.h>
18 : : #include <kernel/chainstatemanager_opts.h>
19 : : #include <kernel/cs_main.h> // IWYU pragma: export
20 : : #include <node/blockstorage.h>
21 : : #include <policy/feerate.h>
22 : : #include <policy/packages.h>
23 : : #include <policy/policy.h>
24 : : #include <script/script_error.h>
25 : : #include <script/sigcache.h>
26 : : #include <sync.h>
27 : : #include <txdb.h>
28 : : #include <txmempool.h>
29 : : #include <uint256.h>
30 : : #include <util/check.h>
31 : : #include <util/fs.h>
32 : : #include <util/hasher.h>
33 : : #include <util/result.h>
34 : : #include <util/time.h>
35 : : #include <util/translation.h>
36 : : #include <versionbits.h>
37 : :
38 : : #include <atomic>
39 : : #include <map>
40 : : #include <memory>
41 : : #include <optional>
42 : : #include <set>
43 : : #include <span>
44 : : #include <stdint.h>
45 : : #include <string>
46 : : #include <type_traits>
47 : : #include <utility>
48 : : #include <vector>
49 : :
50 : : class Chainstate;
51 : : class CTxMemPool;
52 : : class ChainstateManager;
53 : : struct ChainTxData;
54 : : class DisconnectedBlockTransactions;
55 : : struct PrecomputedTransactionData;
56 : : struct LockPoints;
57 : : struct AssumeutxoData;
58 : : namespace node {
59 : : class SnapshotMetadata;
60 : : } // namespace node
61 : : namespace Consensus {
62 : : struct Params;
63 : : } // namespace Consensus
64 : : namespace util {
65 : : class SignalInterrupt;
66 : : } // namespace util
67 : :
68 : : /** Block files containing a block-height within MIN_BLOCKS_TO_KEEP of ActiveChain().Tip() will not be pruned. */
69 : : static const unsigned int MIN_BLOCKS_TO_KEEP = 288;
70 : : static const signed int DEFAULT_CHECKBLOCKS = 6;
71 : : static constexpr int DEFAULT_CHECKLEVEL{3};
72 : : // Require that user allocate at least 550 MiB for block & undo files (blk???.dat and rev???.dat)
73 : : // At 1MB per block, 288 blocks = 288MB.
74 : : // Add 15% for Undo data = 331MB
75 : : // Add 20% for Orphan block rate = 397MB
76 : : // We want the low water mark after pruning to be at least 397 MB and since we prune in
77 : : // full block file chunks, we need the high water mark which triggers the prune to be
78 : : // one 128MB block file + added 15% undo data = 147MB greater for a total of 545MB
79 : : // Setting the target to >= 550 MiB will make it likely we can respect the target.
80 : : static const uint64_t MIN_DISK_SPACE_FOR_BLOCK_FILES = 550 * 1024 * 1024;
81 : :
82 : : /** Maximum number of dedicated script-checking threads allowed */
83 : : static constexpr int MAX_SCRIPTCHECK_THREADS{15};
84 : :
85 : : /** Current sync state passed to tip changed callbacks. */
86 : : enum class SynchronizationState {
87 : : INIT_REINDEX,
88 : : INIT_DOWNLOAD,
89 : : POST_INIT
90 : : };
91 : :
92 : : /** Documentation for argument 'checklevel'. */
93 : : extern const std::vector<std::string> CHECKLEVEL_DOC;
94 : :
95 : : CAmount GetBlockSubsidy(int nHeight, const Consensus::Params& consensusParams);
96 : :
97 : : bool FatalError(kernel::Notifications& notifications, BlockValidationState& state, const bilingual_str& message);
98 : :
99 : : /** Prune block files up to a given height */
100 : : void PruneBlockFilesManual(Chainstate& active_chainstate, int nManualPruneHeight);
101 : :
102 : : /**
103 : : * Validation result for a transaction evaluated by MemPoolAccept (single or package).
104 : : * Here are the expected fields and properties of a result depending on its ResultType, applicable to
105 : : * results returned from package evaluation:
106 : : *+---------------------------+----------------+-------------------+------------------+----------------+-------------------+
107 : : *| Field or property | VALID | INVALID | MEMPOOL_ENTRY | DIFFERENT_WITNESS |
108 : : *| | |--------------------------------------| | |
109 : : *| | | TX_RECONSIDERABLE | Other | | |
110 : : *+---------------------------+----------------+-------------------+------------------+----------------+-------------------+
111 : : *| txid in mempool? | yes | no | no* | yes | yes |
112 : : *| wtxid in mempool? | yes | no | no* | yes | no |
113 : : *| m_state | yes, IsValid() | yes, IsInvalid() | yes, IsInvalid() | yes, IsValid() | yes, IsValid() |
114 : : *| m_vsize | yes | no | no | yes | no |
115 : : *| m_base_fees | yes | no | no | yes | no |
116 : : *| m_effective_feerate | yes | yes | no | no | no |
117 : : *| m_wtxids_fee_calculations | yes | yes | no | no | no |
118 : : *| m_other_wtxid | no | no | no | no | yes |
119 : : *+---------------------------+----------------+-------------------+------------------+----------------+-------------------+
120 : : * (*) Individual transaction acceptance doesn't return MEMPOOL_ENTRY and DIFFERENT_WITNESS. It returns
121 : : * INVALID, with the errors txn-already-in-mempool and txn-same-nonwitness-data-in-mempool
122 : : * respectively. In those cases, the txid or wtxid may be in the mempool for a TX_CONFLICT.
123 : : */
124 : : struct MempoolAcceptResult {
125 : : /** Used to indicate the results of mempool validation. */
126 : : enum class ResultType {
127 : : VALID, //!> Fully validated, valid.
128 : : INVALID, //!> Invalid.
129 : : MEMPOOL_ENTRY, //!> Valid, transaction was already in the mempool.
130 : : DIFFERENT_WITNESS, //!> Not validated. A same-txid-different-witness tx (see m_other_wtxid) already exists in the mempool and was not replaced.
131 : : };
132 : : /** Result type. Present in all MempoolAcceptResults. */
133 : : const ResultType m_result_type;
134 : :
135 : : /** Contains information about why the transaction failed. */
136 : : const TxValidationState m_state;
137 : :
138 : : /** Mempool transactions replaced by the tx. */
139 : : const std::list<CTransactionRef> m_replaced_transactions;
140 : : /** Virtual size as used by the mempool, calculated using serialized size and sigops. */
141 : : const std::optional<int64_t> m_vsize;
142 : : /** Raw base fees in satoshis. */
143 : : const std::optional<CAmount> m_base_fees;
144 : : /** The feerate at which this transaction was considered. This includes any fee delta added
145 : : * using prioritisetransaction (i.e. modified fees). If this transaction was submitted as a
146 : : * package, this is the package feerate, which may also include its descendants and/or
147 : : * ancestors (see m_wtxids_fee_calculations below).
148 : : */
149 : : const std::optional<CFeeRate> m_effective_feerate;
150 : : /** Contains the wtxids of the transactions used for fee-related checks. Includes this
151 : : * transaction's wtxid and may include others if this transaction was validated as part of a
152 : : * package. This is not necessarily equivalent to the list of transactions passed to
153 : : * ProcessNewPackage().
154 : : * Only present when m_result_type = ResultType::VALID. */
155 : : const std::optional<std::vector<Wtxid>> m_wtxids_fee_calculations;
156 : :
157 : : /** The wtxid of the transaction in the mempool which has the same txid but different witness. */
158 : : const std::optional<Wtxid> m_other_wtxid;
159 : :
160 : 8748 : static MempoolAcceptResult Failure(TxValidationState state) {
161 [ + - ]: 17496 : return MempoolAcceptResult(state);
162 : : }
163 : :
164 : 130 : static MempoolAcceptResult FeeFailure(TxValidationState state,
165 : : CFeeRate effective_feerate,
166 : : const std::vector<Wtxid>& wtxids_fee_calculations) {
167 [ + - ]: 260 : return MempoolAcceptResult(state, effective_feerate, wtxids_fee_calculations);
168 : : }
169 : :
170 : 28663 : static MempoolAcceptResult Success(std::list<CTransactionRef>&& replaced_txns,
171 : : int64_t vsize,
172 : : CAmount fees,
173 : : CFeeRate effective_feerate,
174 : : const std::vector<Wtxid>& wtxids_fee_calculations) {
175 : 28663 : return MempoolAcceptResult(std::move(replaced_txns), vsize, fees,
176 [ + - + - : 28663 : effective_feerate, wtxids_fee_calculations);
+ - + - ]
177 : : }
178 : :
179 : 94 : static MempoolAcceptResult MempoolTx(int64_t vsize, CAmount fees) {
180 : 94 : return MempoolAcceptResult(vsize, fees);
181 : : }
182 : :
183 : 3 : static MempoolAcceptResult MempoolTxDifferentWitness(const Wtxid& other_wtxid) {
184 : 3 : return MempoolAcceptResult(other_wtxid);
185 : : }
186 : :
187 : : // Private constructors. Use static methods MempoolAcceptResult::Success, etc. to construct.
188 : : private:
189 : : /** Constructor for failure case */
190 : 8748 : explicit MempoolAcceptResult(TxValidationState state)
191 : 8748 : : m_result_type(ResultType::INVALID), m_state(state) {
192 : 8748 : Assume(!state.IsValid()); // Can be invalid or error
193 : 8748 : }
194 : :
195 : : /** Constructor for success case */
196 : 28663 : explicit MempoolAcceptResult(std::list<CTransactionRef>&& replaced_txns,
197 : : int64_t vsize,
198 : : CAmount fees,
199 : : CFeeRate effective_feerate,
200 : : const std::vector<Wtxid>& wtxids_fee_calculations)
201 : 28663 : : m_result_type(ResultType::VALID),
202 : 28663 : m_replaced_transactions(std::move(replaced_txns)),
203 [ + - ]: 28663 : m_vsize{vsize},
204 : 28663 : m_base_fees(fees),
205 : 28663 : m_effective_feerate(effective_feerate),
206 [ + - ]: 28663 : m_wtxids_fee_calculations(wtxids_fee_calculations) {}
207 : :
208 : : /** Constructor for fee-related failure case */
209 : 130 : explicit MempoolAcceptResult(TxValidationState state,
210 : : CFeeRate effective_feerate,
211 : : const std::vector<Wtxid>& wtxids_fee_calculations)
212 : 130 : : m_result_type(ResultType::INVALID),
213 : 130 : m_state(state),
214 [ + - ]: 130 : m_effective_feerate(effective_feerate),
215 [ + - ]: 130 : m_wtxids_fee_calculations(wtxids_fee_calculations) {}
216 : :
217 : : /** Constructor for already-in-mempool case. It wouldn't replace any transactions. */
218 : 94 : explicit MempoolAcceptResult(int64_t vsize, CAmount fees)
219 [ + - ]: 94 : : m_result_type(ResultType::MEMPOOL_ENTRY), m_vsize{vsize}, m_base_fees(fees) {}
220 : :
221 : : /** Constructor for witness-swapped case. */
222 : 3 : explicit MempoolAcceptResult(const Wtxid& other_wtxid)
223 : 3 : : m_result_type(ResultType::DIFFERENT_WITNESS), m_other_wtxid(other_wtxid) {}
224 : : };
225 : :
226 : : /**
227 : : * Validation result for package mempool acceptance.
228 : : */
229 : : struct PackageMempoolAcceptResult
230 : : {
231 : : PackageValidationState m_state;
232 : : /**
233 : : * Map from wtxid to finished MempoolAcceptResults. The client is responsible
234 : : * for keeping track of the transaction objects themselves. If a result is not
235 : : * present, it means validation was unfinished for that transaction. If there
236 : : * was a package-wide error (see result in m_state), m_tx_results will be empty.
237 : : */
238 : : std::map<Wtxid, MempoolAcceptResult> m_tx_results;
239 : :
240 : 659 : explicit PackageMempoolAcceptResult(PackageValidationState state,
241 : : std::map<Wtxid, MempoolAcceptResult>&& results)
242 [ + - + - : 659 : : m_state{state}, m_tx_results(std::move(results)) {}
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- - - +
- ]
243 : :
244 : : explicit PackageMempoolAcceptResult(PackageValidationState state, CFeeRate feerate,
245 : : std::map<Wtxid, MempoolAcceptResult>&& results)
246 : : : m_state{state}, m_tx_results(std::move(results)) {}
247 : :
248 : : /** Constructor to create a PackageMempoolAcceptResult from a single MempoolAcceptResult */
249 : 1381 : explicit PackageMempoolAcceptResult(const Wtxid& wtxid, const MempoolAcceptResult& result)
250 [ + - + - : 5524 : : m_tx_results{ {wtxid, result} } {}
+ + - - ]
251 : : };
252 : :
253 : : /**
254 : : * Try to add a transaction to the mempool. This is an internal function and is exposed only for testing.
255 : : * Client code should use ChainstateManager::ProcessTransaction()
256 : : *
257 : : * @param[in] active_chainstate Reference to the active chainstate.
258 : : * @param[in] tx The transaction to submit for mempool acceptance.
259 : : * @param[in] accept_time The timestamp for adding the transaction to the mempool.
260 : : * It is also used to determine when the entry expires.
261 : : * @param[in] bypass_limits When true, don't enforce mempool fee and capacity limits,
262 : : * and set entry_sequence to zero.
263 : : * @param[in] test_accept When true, run validation checks but don't submit to mempool.
264 : : *
265 : : * @returns a MempoolAcceptResult indicating whether the transaction was accepted/rejected with reason.
266 : : */
267 : : MempoolAcceptResult AcceptToMemoryPool(Chainstate& active_chainstate, const CTransactionRef& tx,
268 : : int64_t accept_time, bool bypass_limits, bool test_accept)
269 : : EXCLUSIVE_LOCKS_REQUIRED(cs_main);
270 : :
271 : : /**
272 : : * Validate (and maybe submit) a package to the mempool. See doc/policy/packages.md for full details
273 : : * on package validation rules.
274 : : * @param[in] test_accept When true, run validation checks but don't submit to mempool.
275 : : * @param[in] client_maxfeerate If exceeded by an individual transaction, rest of (sub)package evaluation is aborted.
276 : : * Only for sanity checks against local submission of transactions.
277 : : * @returns a PackageMempoolAcceptResult which includes a MempoolAcceptResult for each transaction.
278 : : * If a transaction fails, validation will exit early and some results may be missing. It is also
279 : : * possible for the package to be partially submitted.
280 : : */
281 : : PackageMempoolAcceptResult ProcessNewPackage(Chainstate& active_chainstate, CTxMemPool& pool,
282 : : const Package& txns, bool test_accept, const std::optional<CFeeRate>& client_maxfeerate)
283 : : EXCLUSIVE_LOCKS_REQUIRED(cs_main);
284 : :
285 : : /* Mempool validation helper functions */
286 : :
287 : : /**
288 : : * Check if transaction will be final in the next block to be created.
289 : : */
290 : : bool CheckFinalTxAtTip(const CBlockIndex& active_chain_tip, const CTransaction& tx) EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
291 : :
292 : : /**
293 : : * Calculate LockPoints required to check if transaction will be BIP68 final in the next block
294 : : * to be created on top of tip.
295 : : *
296 : : * @param[in] tip Chain tip for which tx sequence locks are calculated. For
297 : : * example, the tip of the current active chain.
298 : : * @param[in] coins_view Any CCoinsView that provides access to the relevant coins for
299 : : * checking sequence locks. For example, it can be a CCoinsViewCache
300 : : * that isn't connected to anything but contains all the relevant
301 : : * coins, or a CCoinsViewMemPool that is connected to the
302 : : * mempool and chainstate UTXO set. In the latter case, the caller
303 : : * is responsible for holding the appropriate locks to ensure that
304 : : * calls to GetCoin() return correct coins.
305 : : * @param[in] tx The transaction being evaluated.
306 : : *
307 : : * @returns The resulting height and time calculated and the hash of the block needed for
308 : : * calculation, or std::nullopt if there is an error.
309 : : */
310 : : std::optional<LockPoints> CalculateLockPointsAtTip(
311 : : CBlockIndex* tip,
312 : : const CCoinsView& coins_view,
313 : : const CTransaction& tx);
314 : :
315 : : /**
316 : : * Check if transaction will be BIP68 final in the next block to be created on top of tip.
317 : : * @param[in] tip Chain tip to check tx sequence locks against. For example,
318 : : * the tip of the current active chain.
319 : : * @param[in] lock_points LockPoints containing the height and time at which this
320 : : * transaction is final.
321 : : * Simulates calling SequenceLocks() with data from the tip passed in.
322 : : * The LockPoints should not be considered valid if CheckSequenceLocksAtTip returns false.
323 : : */
324 : : bool CheckSequenceLocksAtTip(CBlockIndex* tip,
325 : : const LockPoints& lock_points);
326 : :
327 : : /**
328 : : * Closure representing one script verification
329 : : * Note that this stores references to the spending transaction
330 : : */
331 : 498840 : class CScriptCheck
332 : : {
333 : : private:
334 : : CTxOut m_tx_out;
335 : : const CTransaction *ptxTo;
336 : : unsigned int nIn;
337 : : unsigned int nFlags;
338 : : bool cacheStore;
339 : : PrecomputedTransactionData *txdata;
340 : : SignatureCache* m_signature_cache;
341 : :
342 : : public:
343 : 295013 : CScriptCheck(const CTxOut& outIn, const CTransaction& txToIn, SignatureCache& signature_cache, unsigned int nInIn, unsigned int nFlagsIn, bool cacheIn, PrecomputedTransactionData* txdataIn) :
344 [ + + + - ]: 295013 : m_tx_out(outIn), ptxTo(&txToIn), nIn(nInIn), nFlags(nFlagsIn), cacheStore(cacheIn), txdata(txdataIn), m_signature_cache(&signature_cache) { }
[ + + + - ]
345 : :
346 : : CScriptCheck(const CScriptCheck&) = delete;
347 : : CScriptCheck& operator=(const CScriptCheck&) = delete;
348 : 203827 : CScriptCheck(CScriptCheck&&) = default;
349 : 0 : CScriptCheck& operator=(CScriptCheck&&) = default;
350 : :
351 : : std::optional<std::pair<ScriptError, std::string>> operator()();
352 : : };
353 : :
354 : : // CScriptCheck is used a lot in std::vector, make sure that's efficient
355 : : static_assert(std::is_nothrow_move_assignable_v<CScriptCheck>);
356 : : static_assert(std::is_nothrow_move_constructible_v<CScriptCheck>);
357 : : static_assert(std::is_nothrow_destructible_v<CScriptCheck>);
358 : :
359 : : /**
360 : : * Convenience class for initializing and passing the script execution cache
361 : : * and signature cache.
362 : : */
363 : 1138 : class ValidationCache
364 : : {
365 : : private:
366 : : //! Pre-initialized hasher to avoid having to recreate it for every hash calculation.
367 : : CSHA256 m_script_execution_cache_hasher;
368 : :
369 : : public:
370 : : CuckooCache::cache<uint256, SignatureCacheHasher> m_script_execution_cache;
371 : : SignatureCache m_signature_cache;
372 : :
373 : : ValidationCache(size_t script_execution_cache_bytes, size_t signature_cache_bytes);
374 : :
375 : : ValidationCache(const ValidationCache&) = delete;
376 : : ValidationCache& operator=(const ValidationCache&) = delete;
377 : :
378 : : //! Return a copy of the pre-initialized hasher.
379 : 258538 : CSHA256 ScriptExecutionCacheHasher() const { return m_script_execution_cache_hasher; }
380 : : };
381 : :
382 : : /** Functions for validating blocks and updating the block tree */
383 : :
384 : : /** Context-independent validity checks */
385 : : bool CheckBlock(const CBlock& block, BlockValidationState& state, const Consensus::Params& consensusParams, bool fCheckPOW = true, bool fCheckMerkleRoot = true);
386 : :
387 : : /** Check a block is completely valid from start to finish (only works on top of our current best block) */
388 : : bool TestBlockValidity(BlockValidationState& state,
389 : : const CChainParams& chainparams,
390 : : Chainstate& chainstate,
391 : : const CBlock& block,
392 : : CBlockIndex* pindexPrev,
393 : : bool fCheckPOW = true,
394 : : bool fCheckMerkleRoot = true) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
395 : :
396 : : /** Check with the proof of work on each blockheader matches the value in nBits */
397 : : bool HasValidProofOfWork(const std::vector<CBlockHeader>& headers, const Consensus::Params& consensusParams);
398 : :
399 : : /** Check if a block has been mutated (with respect to its merkle root and witness commitments). */
400 : : bool IsBlockMutated(const CBlock& block, bool check_witness_root);
401 : :
402 : : /** Return the sum of the claimed work on a given set of headers. No verification of PoW is done. */
403 : : arith_uint256 CalculateClaimedHeadersWork(std::span<const CBlockHeader> headers);
404 : :
405 : : enum class VerifyDBResult {
406 : : SUCCESS,
407 : : CORRUPTED_BLOCK_DB,
408 : : INTERRUPTED,
409 : : SKIPPED_L3_CHECKS,
410 : : SKIPPED_MISSING_BLOCKS,
411 : : };
412 : :
413 : : /** RAII wrapper for VerifyDB: Verify consistency of the block and coin databases */
414 : : class CVerifyDB
415 : : {
416 : : private:
417 : : kernel::Notifications& m_notifications;
418 : :
419 : : public:
420 : : explicit CVerifyDB(kernel::Notifications& notifications);
421 : : ~CVerifyDB();
422 : : [[nodiscard]] VerifyDBResult VerifyDB(
423 : : Chainstate& chainstate,
424 : : const Consensus::Params& consensus_params,
425 : : CCoinsView& coinsview,
426 : : int nCheckLevel,
427 : : int nCheckDepth) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
428 : : };
429 : :
430 : : enum DisconnectResult
431 : : {
432 : : DISCONNECT_OK, // All good.
433 : : DISCONNECT_UNCLEAN, // Rolled back, but UTXO set was inconsistent with block.
434 : : DISCONNECT_FAILED // Something else went wrong.
435 : : };
436 : :
437 : : class ConnectTrace;
438 : :
439 : : /** @see Chainstate::FlushStateToDisk */
440 : : inline constexpr std::array FlushStateModeNames{"NONE", "IF_NEEDED", "PERIODIC", "ALWAYS"};
441 : : enum class FlushStateMode: uint8_t {
442 : : NONE,
443 : : IF_NEEDED,
444 : : PERIODIC,
445 : : ALWAYS
446 : : };
447 : :
448 : : /**
449 : : * A convenience class for constructing the CCoinsView* hierarchy used
450 : : * to facilitate access to the UTXO set.
451 : : *
452 : : * This class consists of an arrangement of layered CCoinsView objects,
453 : : * preferring to store and retrieve coins in memory via `m_cacheview` but
454 : : * ultimately falling back on cache misses to the canonical store of UTXOs on
455 : : * disk, `m_dbview`.
456 : : */
457 : : class CoinsViews {
458 : :
459 : : public:
460 : : //! The lowest level of the CoinsViews cache hierarchy sits in a leveldb database on disk.
461 : : //! All unspent coins reside in this store.
462 : : CCoinsViewDB m_dbview GUARDED_BY(cs_main);
463 : :
464 : : //! This view wraps access to the leveldb instance and handles read errors gracefully.
465 : : CCoinsViewErrorCatcher m_catcherview GUARDED_BY(cs_main);
466 : :
467 : : //! This is the top layer of the cache hierarchy - it keeps as many coins in memory as
468 : : //! can fit per the dbcache setting.
469 : : std::unique_ptr<CCoinsViewCache> m_cacheview GUARDED_BY(cs_main);
470 : :
471 : : //! This constructor initializes CCoinsViewDB and CCoinsViewErrorCatcher instances, but it
472 : : //! *does not* create a CCoinsViewCache instance by default. This is done separately because the
473 : : //! presence of the cache has implications on whether or not we're allowed to flush the cache's
474 : : //! state to disk, which should not be done until the health of the database is verified.
475 : : //!
476 : : //! All arguments forwarded onto CCoinsViewDB.
477 : : CoinsViews(DBParams db_params, CoinsViewOptions options);
478 : :
479 : : //! Initialize the CCoinsViewCache member.
480 : : void InitCache() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
481 : : };
482 : :
483 : : enum class CoinsCacheSizeState
484 : : {
485 : : //! The coins cache is in immediate need of a flush.
486 : : CRITICAL = 2,
487 : : //! The cache is at >= 90% capacity.
488 : : LARGE = 1,
489 : : OK = 0
490 : : };
491 : :
492 : : /**
493 : : * Chainstate stores and provides an API to update our local knowledge of the
494 : : * current best chain.
495 : : *
496 : : * Eventually, the API here is targeted at being exposed externally as a
497 : : * consumable library, so any functions added must only call
498 : : * other class member functions, pure functions in other parts of the consensus
499 : : * library, callbacks via the validation interface, or read/write-to-disk
500 : : * functions (eventually this will also be via callbacks).
501 : : *
502 : : * Anything that is contingent on the current tip of the chain is stored here,
503 : : * whereas block information and metadata independent of the current tip is
504 : : * kept in `BlockManager`.
505 : : */
506 : : class Chainstate
507 : : {
508 : : protected:
509 : : /**
510 : : * The ChainState Mutex
511 : : * A lock that must be held when modifying this ChainState - held in ActivateBestChain() and
512 : : * InvalidateBlock()
513 : : */
514 : : Mutex m_chainstate_mutex;
515 : :
516 : : //! Optional mempool that is kept in sync with the chain.
517 : : //! Only the active chainstate has a mempool.
518 : : CTxMemPool* m_mempool;
519 : :
520 : : //! Manages the UTXO set, which is a reflection of the contents of `m_chain`.
521 : : std::unique_ptr<CoinsViews> m_coins_views;
522 : :
523 : : //! This toggle exists for use when doing background validation for UTXO
524 : : //! snapshots.
525 : : //!
526 : : //! In the expected case, it is set once the background validation chain reaches the
527 : : //! same height as the base of the snapshot and its UTXO set is found to hash to
528 : : //! the expected assumeutxo value. It signals that we should no longer connect
529 : : //! blocks to the background chainstate. When set on the background validation
530 : : //! chainstate, it signifies that we have fully validated the snapshot chainstate.
531 : : //!
532 : : //! In the unlikely case that the snapshot chainstate is found to be invalid, this
533 : : //! is set to true on the snapshot chainstate.
534 : : bool m_disabled GUARDED_BY(::cs_main) {false};
535 : :
536 : : //! Cached result of LookupBlockIndex(*m_from_snapshot_blockhash)
537 : : mutable const CBlockIndex* m_cached_snapshot_base GUARDED_BY(::cs_main){nullptr};
538 : :
539 : : public:
540 : : //! Reference to a BlockManager instance which itself is shared across all
541 : : //! Chainstate instances.
542 : : node::BlockManager& m_blockman;
543 : :
544 : : //! The chainstate manager that owns this chainstate. The reference is
545 : : //! necessary so that this instance can check whether it is the active
546 : : //! chainstate within deeply nested method calls.
547 : : ChainstateManager& m_chainman;
548 : :
549 : : explicit Chainstate(
550 : : CTxMemPool* mempool,
551 : : node::BlockManager& blockman,
552 : : ChainstateManager& chainman,
553 [ + - ]: 1134 : std::optional<uint256> from_snapshot_blockhash = std::nullopt);
554 : :
555 : : //! Return the current role of the chainstate. See `ChainstateManager`
556 : : //! documentation for a description of the different types of chainstates.
557 : : //!
558 : : //! @sa ChainstateRole
559 : : ChainstateRole GetRole() const EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
560 : :
561 : : /**
562 : : * Initialize the CoinsViews UTXO set database management data structures. The in-memory
563 : : * cache is initialized separately.
564 : : *
565 : : * All parameters forwarded to CoinsViews.
566 : : */
567 : : void InitCoinsDB(
568 : : size_t cache_size_bytes,
569 : : bool in_memory,
570 : : bool should_wipe,
571 [ + + + - ]: 2276 : fs::path leveldb_name = "chainstate");
[ + - + -
+ - + - ]
[ + - - + ]
572 : :
573 : : //! Initialize the in-memory coins cache (to be done after the health of the on-disk database
574 : : //! is verified).
575 : : void InitCoinsCache(size_t cache_size_bytes) EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
576 : :
577 : : //! @returns whether or not the CoinsViews object has been fully initialized and we can
578 : : //! safely flush this object to disk.
579 : 426409 : bool CanFlushToDisk() const EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
580 : : {
581 : 426409 : AssertLockHeld(::cs_main);
582 [ + - + - ]: 426409 : return m_coins_views && m_coins_views->m_cacheview;
[ + + + +
+ + + + ]
583 : : }
584 : :
585 : : //! The current chain of blockheaders we consult and build on.
586 : : //! @see CChain, CBlockIndex.
587 : : CChain m_chain;
588 : :
589 : : /**
590 : : * The blockhash which is the base of the snapshot this chainstate was created from.
591 : : *
592 : : * std::nullopt if this chainstate was not created from a snapshot.
593 : : */
594 : : const std::optional<uint256> m_from_snapshot_blockhash;
595 : :
596 : : /**
597 : : * The base of the snapshot this chainstate was created from.
598 : : *
599 : : * nullptr if this chainstate was not created from a snapshot.
600 : : */
601 : : const CBlockIndex* SnapshotBase() const EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
602 : :
603 : : /**
604 : : * The set of all CBlockIndex entries that have as much work as our current
605 : : * tip or more, and transaction data needed to be validated (with
606 : : * BLOCK_VALID_TRANSACTIONS for each block and its parents back to the
607 : : * genesis block or an assumeutxo snapshot block). Entries may be failed,
608 : : * though, and pruning nodes may be missing the data for the block.
609 : : */
610 : : std::set<CBlockIndex*, node::CBlockIndexWorkComparator> setBlockIndexCandidates;
611 : :
612 : : //! @returns A reference to the in-memory cache of the UTXO set.
613 : 2355392 : CCoinsViewCache& CoinsTip() EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
614 : : {
615 : 2355392 : AssertLockHeld(::cs_main);
616 : 2355392 : Assert(m_coins_views);
617 : 2355392 : return *Assert(m_coins_views->m_cacheview);
618 : : }
619 : :
620 : : //! @returns A reference to the on-disk UTXO set database.
621 : 4294 : CCoinsViewDB& CoinsDB() EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
622 : : {
623 : 4294 : AssertLockHeld(::cs_main);
624 : 4294 : return Assert(m_coins_views)->m_dbview;
625 : : }
626 : :
627 : : //! @returns A pointer to the mempool.
628 : 101290 : CTxMemPool* GetMempool()
629 : : {
630 [ + - - + : 101290 : return m_mempool;
+ - - + ]
[ + - ]
631 : : }
632 : :
633 : : //! @returns A reference to a wrapped view of the in-memory UTXO set that
634 : : //! handles disk read errors gracefully.
635 : 954 : CCoinsViewErrorCatcher& CoinsErrorCatcher() EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
636 : : {
637 : 954 : AssertLockHeld(::cs_main);
638 : 954 : return Assert(m_coins_views)->m_catcherview;
639 : : }
640 : :
641 : : //! Destructs all objects related to accessing the UTXO set.
642 [ + - ]: 951 : void ResetCoinsViews() { m_coins_views.reset(); }
643 : :
644 : : //! Does this chainstate have a UTXO set attached?
645 [ - + ]: 6 : bool HasCoinsViews() const { return (bool)m_coins_views; }
646 : :
647 : : //! The cache size of the on-disk coins view.
648 : : size_t m_coinsdb_cache_size_bytes{0};
649 : :
650 : : //! The cache size of the in-memory coins view.
651 : : size_t m_coinstip_cache_size_bytes{0};
652 : :
653 : : //! Resize the CoinsViews caches dynamically and flush state to disk.
654 : : //! @returns true unless an error occurred during the flush.
655 : : bool ResizeCoinsCaches(size_t coinstip_size, size_t coinsdb_size)
656 : : EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
657 : :
658 : : /**
659 : : * Update the on-disk chain state.
660 : : * The caches and indexes are flushed depending on the mode we're called with
661 : : * if they're too large, if it's been a while since the last write,
662 : : * or always and in all cases if we're in prune mode and are deleting files.
663 : : *
664 : : * If FlushStateMode::NONE is used, then FlushStateToDisk(...) won't do anything
665 : : * besides checking if we need to prune.
666 : : *
667 : : * @returns true unless a system error occurred
668 : : */
669 : : bool FlushStateToDisk(
670 : : BlockValidationState& state,
671 : : FlushStateMode mode,
672 : : int nManualPruneHeight = 0);
673 : :
674 : : //! Unconditionally flush all changes to disk.
675 : : void ForceFlushStateToDisk();
676 : :
677 : : //! Prune blockfiles from the disk if necessary and then flush chainstate changes
678 : : //! if we pruned.
679 : : void PruneAndFlush();
680 : :
681 : : /**
682 : : * Find the best known block, and make it the tip of the block chain. The
683 : : * result is either failure or an activated best chain. pblock is either
684 : : * nullptr or a pointer to a block that is already loaded (to avoid loading
685 : : * it again from disk).
686 : : *
687 : : * ActivateBestChain is split into steps (see ActivateBestChainStep) so that
688 : : * we avoid holding cs_main for an extended period of time; the length of this
689 : : * call may be quite long during reindexing or a substantial reorg.
690 : : *
691 : : * May not be called with cs_main held. May not be called in a
692 : : * validationinterface callback.
693 : : *
694 : : * Note that if this is called while a snapshot chainstate is active, and if
695 : : * it is called on a background chainstate whose tip has reached the base block
696 : : * of the snapshot, its execution will take *MINUTES* while it hashes the
697 : : * background UTXO set to verify the assumeutxo value the snapshot was activated
698 : : * with. `cs_main` will be held during this time.
699 : : *
700 : : * @returns true unless a system error occurred
701 : : */
702 : : bool ActivateBestChain(
703 : : BlockValidationState& state,
704 : : std::shared_ptr<const CBlock> pblock = nullptr)
705 : : EXCLUSIVE_LOCKS_REQUIRED(!m_chainstate_mutex)
706 : : LOCKS_EXCLUDED(::cs_main);
707 : :
708 : : // Block (dis)connection on a given view:
709 : : DisconnectResult DisconnectBlock(const CBlock& block, const CBlockIndex* pindex, CCoinsViewCache& view)
710 : : EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
711 : : bool ConnectBlock(const CBlock& block, BlockValidationState& state, CBlockIndex* pindex,
712 : : CCoinsViewCache& view, bool fJustCheck = false) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
713 : :
714 : : // Apply the effects of a block disconnection on the UTXO set.
715 : : bool DisconnectTip(BlockValidationState& state, DisconnectedBlockTransactions* disconnectpool) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_mempool->cs);
716 : :
717 : : // Manual block validity manipulation:
718 : : /** Mark a block as precious and reorganize.
719 : : *
720 : : * May not be called in a validationinterface callback.
721 : : */
722 : : bool PreciousBlock(BlockValidationState& state, CBlockIndex* pindex)
723 : : EXCLUSIVE_LOCKS_REQUIRED(!m_chainstate_mutex)
724 : : LOCKS_EXCLUDED(::cs_main);
725 : :
726 : : /** Mark a block as invalid. */
727 : : bool InvalidateBlock(BlockValidationState& state, CBlockIndex* pindex)
728 : : EXCLUSIVE_LOCKS_REQUIRED(!m_chainstate_mutex)
729 : : LOCKS_EXCLUDED(::cs_main);
730 : :
731 : : /** Set invalidity status to all descendants of a block */
732 : : void SetBlockFailureFlags(CBlockIndex* pindex) EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
733 : :
734 : : /** Remove invalidity status from a block and its descendants. */
735 : : void ResetBlockFailureFlags(CBlockIndex* pindex) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
736 : :
737 : : /** Replay blocks that aren't fully applied to the database. */
738 : : bool ReplayBlocks();
739 : :
740 : : /** Whether the chain state needs to be redownloaded due to lack of witness data */
741 : : [[nodiscard]] bool NeedsRedownload() const EXCLUSIVE_LOCKS_REQUIRED(cs_main);
742 : : /** Ensures we have a genesis block in the block tree, possibly writing one to disk. */
743 : : bool LoadGenesisBlock();
744 : :
745 : : void TryAddBlockIndexCandidate(CBlockIndex* pindex) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
746 : :
747 : : void PruneBlockIndexCandidates();
748 : :
749 : : void ClearBlockIndexCandidates() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
750 : :
751 : : /** Find the last common block of this chain and a locator. */
752 : : const CBlockIndex* FindForkInGlobalIndex(const CBlockLocator& locator) const EXCLUSIVE_LOCKS_REQUIRED(cs_main);
753 : :
754 : : /** Update the chain tip based on database information, i.e. CoinsTip()'s best block. */
755 : : bool LoadChainTip() EXCLUSIVE_LOCKS_REQUIRED(cs_main);
756 : :
757 : : //! Dictates whether we need to flush the cache to disk or not.
758 : : //!
759 : : //! @return the state of the size of the coins cache.
760 : : CoinsCacheSizeState GetCoinsCacheSizeState() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
761 : :
762 : : CoinsCacheSizeState GetCoinsCacheSizeState(
763 : : size_t max_coins_cache_size_bytes,
764 : : size_t max_mempool_size_bytes) EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
765 : :
766 : : std::string ToString() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
767 : :
768 : : //! Indirection necessary to make lock annotations work with an optional mempool.
769 : 157449 : RecursiveMutex* MempoolMutex() const LOCK_RETURNED(m_mempool->cs)
770 : : {
771 [ + + + + ]: 157449 : return m_mempool ? &m_mempool->cs : nullptr;
[ + - + + ]
772 : : }
773 : :
774 : : private:
775 : : bool ActivateBestChainStep(BlockValidationState& state, CBlockIndex* pindexMostWork, const std::shared_ptr<const CBlock>& pblock, bool& fInvalidFound, ConnectTrace& connectTrace) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_mempool->cs);
776 : : bool ConnectTip(BlockValidationState& state, CBlockIndex* pindexNew, const std::shared_ptr<const CBlock>& pblock, ConnectTrace& connectTrace, DisconnectedBlockTransactions& disconnectpool) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_mempool->cs);
777 : :
778 : : void InvalidBlockFound(CBlockIndex* pindex, const BlockValidationState& state) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
779 : : CBlockIndex* FindMostWorkChain() EXCLUSIVE_LOCKS_REQUIRED(cs_main);
780 : :
781 : : bool RollforwardBlock(const CBlockIndex* pindex, CCoinsViewCache& inputs) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
782 : :
783 : : void CheckForkWarningConditions() EXCLUSIVE_LOCKS_REQUIRED(cs_main);
784 : : void InvalidChainFound(CBlockIndex* pindexNew) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
785 : :
786 : : /**
787 : : * Make mempool consistent after a reorg, by re-adding or recursively erasing
788 : : * disconnected block transactions from the mempool, and also removing any
789 : : * other transactions from the mempool that are no longer valid given the new
790 : : * tip/height.
791 : : *
792 : : * Note: we assume that disconnectpool only contains transactions that are NOT
793 : : * confirmed in the current chain nor already in the mempool (otherwise,
794 : : * in-mempool descendants of such transactions would be removed).
795 : : *
796 : : * Passing fAddToMempool=false will skip trying to add the transactions back,
797 : : * and instead just erase from the mempool as needed.
798 : : */
799 : : void MaybeUpdateMempoolForReorg(
800 : : DisconnectedBlockTransactions& disconnectpool,
801 : : bool fAddToMempool) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_mempool->cs);
802 : :
803 : : /** Check warning conditions and do some notifications on new chain tip set. */
804 : : void UpdateTip(const CBlockIndex* pindexNew)
805 : : EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
806 : :
807 : : NodeClock::time_point m_next_write{NodeClock::time_point::max()};
808 : :
809 : : /**
810 : : * In case of an invalid snapshot, rename the coins leveldb directory so
811 : : * that it can be examined for issue diagnosis.
812 : : */
813 : : [[nodiscard]] util::Result<void> InvalidateCoinsDBOnDisk() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
814 : :
815 : : friend ChainstateManager;
816 : : };
817 : :
818 : : enum class SnapshotCompletionResult {
819 : : SUCCESS,
820 : : SKIPPED,
821 : :
822 : : // Expected assumeutxo configuration data is not found for the height of the
823 : : // base block.
824 : : MISSING_CHAINPARAMS,
825 : :
826 : : // Failed to generate UTXO statistics (to check UTXO set hash) for the background
827 : : // chainstate.
828 : : STATS_FAILED,
829 : :
830 : : // The UTXO set hash of the background validation chainstate does not match
831 : : // the one expected by assumeutxo chainparams.
832 : : HASH_MISMATCH,
833 : :
834 : : // The blockhash of the current tip of the background validation chainstate does
835 : : // not match the one expected by the snapshot chainstate.
836 : : BASE_BLOCKHASH_MISMATCH,
837 : : };
838 : :
839 : : /**
840 : : * Provides an interface for creating and interacting with one or two
841 : : * chainstates: an IBD chainstate generated by downloading blocks, and
842 : : * an optional snapshot chainstate loaded from a UTXO snapshot. Managed
843 : : * chainstates can be maintained at different heights simultaneously.
844 : : *
845 : : * This class provides abstractions that allow the retrieval of the current
846 : : * most-work chainstate ("Active") as well as chainstates which may be in
847 : : * background use to validate UTXO snapshots.
848 : : *
849 : : * Definitions:
850 : : *
851 : : * *IBD chainstate*: a chainstate whose current state has been "fully"
852 : : * validated by the initial block download process.
853 : : *
854 : : * *Snapshot chainstate*: a chainstate populated by loading in an
855 : : * assumeutxo UTXO snapshot.
856 : : *
857 : : * *Active chainstate*: the chainstate containing the current most-work
858 : : * chain. Consulted by most parts of the system (net_processing,
859 : : * wallet) as a reflection of the current chain and UTXO set.
860 : : * This may either be an IBD chainstate or a snapshot chainstate.
861 : : *
862 : : * *Background IBD chainstate*: an IBD chainstate for which the
863 : : * IBD process is happening in the background while use of the
864 : : * active (snapshot) chainstate allows the rest of the system to function.
865 : : */
866 : : class ChainstateManager
867 : : {
868 : : private:
869 : : //! The chainstate used under normal operation (i.e. "regular" IBD) or, if
870 : : //! a snapshot is in use, for background validation.
871 : : //!
872 : : //! Its contents (including on-disk data) will be deleted *upon shutdown*
873 : : //! after background validation of the snapshot has completed. We do not
874 : : //! free the chainstate contents immediately after it finishes validation
875 : : //! to cautiously avoid a case where some other part of the system is still
876 : : //! using this pointer (e.g. net_processing).
877 : : //!
878 : : //! Once this pointer is set to a corresponding chainstate, it will not
879 : : //! be reset until init.cpp:Shutdown().
880 : : //!
881 : : //! It is important for the pointer to not be deleted until shutdown,
882 : : //! because cs_main is not always held when the pointer is accessed, for
883 : : //! example when calling ActivateBestChain, so there's no way you could
884 : : //! prevent code from using the pointer while deleting it.
885 : : std::unique_ptr<Chainstate> m_ibd_chainstate GUARDED_BY(::cs_main);
886 : :
887 : : //! A chainstate initialized on the basis of a UTXO snapshot. If this is
888 : : //! non-null, it is always our active chainstate.
889 : : //!
890 : : //! Once this pointer is set to a corresponding chainstate, it will not
891 : : //! be reset until init.cpp:Shutdown().
892 : : //!
893 : : //! It is important for the pointer to not be deleted until shutdown,
894 : : //! because cs_main is not always held when the pointer is accessed, for
895 : : //! example when calling ActivateBestChain, so there's no way you could
896 : : //! prevent code from using the pointer while deleting it.
897 : : std::unique_ptr<Chainstate> m_snapshot_chainstate GUARDED_BY(::cs_main);
898 : :
899 : : //! Points to either the ibd or snapshot chainstate; indicates our
900 : : //! most-work chain.
901 : : Chainstate* m_active_chainstate GUARDED_BY(::cs_main) {nullptr};
902 : :
903 : : CBlockIndex* m_best_invalid GUARDED_BY(::cs_main){nullptr};
904 : :
905 : : /** The last header for which a headerTip notification was issued. */
906 : : CBlockIndex* m_last_notified_header GUARDED_BY(GetMutex()){nullptr};
907 : :
908 : : bool NotifyHeaderTip() LOCKS_EXCLUDED(GetMutex());
909 : :
910 : : //! Internal helper for ActivateSnapshot().
911 : : //!
912 : : //! De-serialization of a snapshot that is created with
913 : : //! the dumptxoutset RPC.
914 : : //! To reduce space the serialization format of the snapshot avoids
915 : : //! duplication of tx hashes. The code takes advantage of the guarantee by
916 : : //! leveldb that keys are lexicographically sorted.
917 : : [[nodiscard]] util::Result<void> PopulateAndValidateSnapshot(
918 : : Chainstate& snapshot_chainstate,
919 : : AutoFile& coins_file,
920 : : const node::SnapshotMetadata& metadata);
921 : :
922 : : /**
923 : : * If a block header hasn't already been seen, call CheckBlockHeader on it, ensure
924 : : * that it doesn't descend from an invalid block, and then add it to m_block_index.
925 : : * Caller must set min_pow_checked=true in order to add a new header to the
926 : : * block index (permanent memory storage), indicating that the header is
927 : : * known to be part of a sufficiently high-work chain (anti-dos check).
928 : : */
929 : : bool AcceptBlockHeader(
930 : : const CBlockHeader& block,
931 : : BlockValidationState& state,
932 : : CBlockIndex** ppindex,
933 : : bool min_pow_checked) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
934 : : friend Chainstate;
935 : :
936 : : /** Most recent headers presync progress update, for rate-limiting. */
937 : : MockableSteadyClock::time_point m_last_presync_update GUARDED_BY(GetMutex()){};
938 : :
939 : : //! Return true if a chainstate is considered usable.
940 : : //!
941 : : //! This is false when a background validation chainstate has completed its
942 : : //! validation of an assumed-valid chainstate, or when a snapshot
943 : : //! chainstate has been found to be invalid.
944 : 1598814 : bool IsUsable(const Chainstate* const cs) const EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
945 [ + + + - : 1590693 : return cs && !cs->m_disabled;
+ - + + ]
[ + - + +
+ + - + +
- + - + -
+ + + - -
+ + - - +
+ - - + +
+ + + - -
- - - - -
- ]
946 : : }
947 : :
948 : : //! A queue for script verifications that have to be performed by worker threads.
949 : : CCheckQueue<CScriptCheck> m_script_check_queue;
950 : :
951 : : //! Timers and counters used for benchmarking validation in both background
952 : : //! and active chainstates.
953 : : SteadyClock::duration GUARDED_BY(::cs_main) time_check{};
954 : : SteadyClock::duration GUARDED_BY(::cs_main) time_forks{};
955 : : SteadyClock::duration GUARDED_BY(::cs_main) time_connect{};
956 : : SteadyClock::duration GUARDED_BY(::cs_main) time_verify{};
957 : : SteadyClock::duration GUARDED_BY(::cs_main) time_undo{};
958 : : SteadyClock::duration GUARDED_BY(::cs_main) time_index{};
959 : : SteadyClock::duration GUARDED_BY(::cs_main) time_total{};
960 : : int64_t GUARDED_BY(::cs_main) num_blocks_total{0};
961 : : SteadyClock::duration GUARDED_BY(::cs_main) time_connect_total{};
962 : : SteadyClock::duration GUARDED_BY(::cs_main) time_flush{};
963 : : SteadyClock::duration GUARDED_BY(::cs_main) time_chainstate{};
964 : : SteadyClock::duration GUARDED_BY(::cs_main) time_post_connect{};
965 : :
966 : : public:
967 : : using Options = kernel::ChainstateManagerOpts;
968 : :
969 : : explicit ChainstateManager(const util::SignalInterrupt& interrupt, Options options, node::BlockManager::Options blockman_options);
970 : :
971 : : //! Function to restart active indexes; set dynamically to avoid a circular
972 : : //! dependency on `base/index.cpp`.
973 : : std::function<void()> snapshot_download_completed = std::function<void()>();
974 : :
975 [ + + ][ + + : 913136 : const CChainParams& GetParams() const { return m_options.chainparams; }
+ - + - +
- + - +
+ ][ + - +
- + - + -
+ + + - +
+ ][ + - +
+ + - + +
+ - ]
976 [ + - + - ]: 4762137 : const Consensus::Params& GetConsensus() const { return m_options.chainparams.GetConsensus(); }
[ + - + -
+ + ][ + -
+ - + + +
+ + - +
+ ][ + - +
- + - + -
# # # # ]
[ # # # #
# # # # ]
977 : : bool ShouldCheckBlockIndex() const;
978 : 408898 : const arith_uint256& MinimumChainWork() const { return *Assert(m_options.minimum_chain_work); }
979 : 185793 : const uint256& AssumedValidBlock() const { return *Assert(m_options.assumed_valid_block); }
980 [ + - ][ + - : 322162 : kernel::Notifications& GetNotifications() const { return m_options.notifications; };
- - - - -
- - - - -
+ - + - +
- - - + -
- - - - -
- - - - -
- - ]
981 : :
982 : : /**
983 : : * Make various assertions about the state of the block index.
984 : : *
985 : : * By default this only executes fully when using the Regtest chain; see: m_options.check_block_index.
986 : : */
987 : : void CheckBlockIndex() const;
988 : :
989 : : /**
990 : : * Alias for ::cs_main.
991 : : * Should be used in new code to make it easier to make ::cs_main a member
992 : : * of this class.
993 : : * Generally, methods of this class should be annotated to require this
994 : : * mutex. This will make calling code more verbose, but also help to:
995 : : * - Clarify that the method will acquire a mutex that heavily affects
996 : : * overall performance.
997 : : * - Force call sites to think how long they need to acquire the mutex to
998 : : * get consistent results.
999 : : */
1000 [ + - + - : 287524 : RecursiveMutex& GetMutex() const LOCK_RETURNED(::cs_main) { return ::cs_main; }
+ - + - +
- + - +
- ][ + - +
- + - +
- ][ # # #
# # # ][ #
# # # #
# ]
1001 : :
1002 : : const util::SignalInterrupt& m_interrupt;
1003 : : const Options m_options;
1004 : : //! A single BlockManager instance is shared across each constructed
1005 : : //! chainstate to avoid duplicating block metadata.
1006 : : node::BlockManager m_blockman;
1007 : :
1008 : : ValidationCache m_validation_cache;
1009 : :
1010 : : /**
1011 : : * Whether initial block download has ended and IsInitialBlockDownload
1012 : : * should return false from now on.
1013 : : *
1014 : : * Mutable because we need to be able to mark IsInitialBlockDownload()
1015 : : * const, which latches this for caching purposes.
1016 : : */
1017 : : mutable std::atomic<bool> m_cached_finished_ibd{false};
1018 : :
1019 : : /**
1020 : : * Every received block is assigned a unique and increasing identifier, so we
1021 : : * know which one to give priority in case of a fork.
1022 : : */
1023 : : /** Blocks loaded from disk are assigned id 0, so start the counter at 1. */
1024 : : int32_t nBlockSequenceId GUARDED_BY(::cs_main) = 1;
1025 : : /** Decreasing counter (used by subsequent preciousblock calls). */
1026 : : int32_t nBlockReverseSequenceId = -1;
1027 : : /** chainwork for the last block that preciousblock has been applied to. */
1028 : : arith_uint256 nLastPreciousChainwork = 0;
1029 : :
1030 : : // Reset the memory-only sequence counters we use to track block arrival
1031 : : // (used by tests to reset state)
1032 : 2 : void ResetBlockSequenceCounters() EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
1033 : : {
1034 : 2 : AssertLockHeld(::cs_main);
1035 : 2 : nBlockSequenceId = 1;
1036 [ + - ]: 2 : nBlockReverseSequenceId = -1;
1037 : : }
1038 : :
1039 : :
1040 : : /**
1041 : : * In order to efficiently track invalidity of headers, we keep the set of
1042 : : * blocks which we tried to connect and found to be invalid here (ie which
1043 : : * were set to BLOCK_FAILED_VALID since the last restart). We can then
1044 : : * walk this set and check if a new header is a descendant of something in
1045 : : * this set, preventing us from having to walk m_block_index when we try
1046 : : * to connect a bad block and fail.
1047 : : *
1048 : : * While this is more complicated than marking everything which descends
1049 : : * from an invalid block as invalid at the time we discover it to be
1050 : : * invalid, doing so would require walking all of m_block_index to find all
1051 : : * descendants. Since this case should be very rare, keeping track of all
1052 : : * BLOCK_FAILED_VALID blocks in a set should be just fine and work just as
1053 : : * well.
1054 : : *
1055 : : * Because we already walk m_block_index in height-order at startup, we go
1056 : : * ahead and mark descendants of invalid blocks as FAILED_CHILD at that time,
1057 : : * instead of putting things in this set.
1058 : : */
1059 : : std::set<CBlockIndex*> m_failed_blocks;
1060 : :
1061 : : /** Best header we've seen so far (used for getheaders queries' starting points). */
1062 : : CBlockIndex* m_best_header GUARDED_BY(::cs_main){nullptr};
1063 : :
1064 : : //! The total number of bytes available for us to use across all in-memory
1065 : : //! coins caches. This will be split somehow across chainstates.
1066 : : size_t m_total_coinstip_cache{0};
1067 : : //
1068 : : //! The total number of bytes available for us to use across all leveldb
1069 : : //! coins databases. This will be split somehow across chainstates.
1070 : : size_t m_total_coinsdb_cache{0};
1071 : :
1072 : : //! Instantiate a new chainstate.
1073 : : //!
1074 : : //! @param[in] mempool The mempool to pass to the chainstate
1075 : : // constructor
1076 : : Chainstate& InitializeChainstate(CTxMemPool* mempool) EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1077 : :
1078 : : //! Get all chainstates currently being used.
1079 : : std::vector<Chainstate*> GetAll();
1080 : :
1081 : : //! Construct and activate a Chainstate on the basis of UTXO snapshot data.
1082 : : //!
1083 : : //! Steps:
1084 : : //!
1085 : : //! - Initialize an unused Chainstate.
1086 : : //! - Load its `CoinsViews` contents from `coins_file`.
1087 : : //! - Verify that the hash of the resulting coinsdb matches the expected hash
1088 : : //! per assumeutxo chain parameters.
1089 : : //! - Wait for our headers chain to include the base block of the snapshot.
1090 : : //! - "Fast forward" the tip of the new chainstate to the base of the snapshot.
1091 : : //! - Move the new chainstate to `m_snapshot_chainstate` and make it our
1092 : : //! ChainstateActive().
1093 : : [[nodiscard]] util::Result<CBlockIndex*> ActivateSnapshot(
1094 : : AutoFile& coins_file, const node::SnapshotMetadata& metadata, bool in_memory);
1095 : :
1096 : : //! Once the background validation chainstate has reached the height which
1097 : : //! is the base of the UTXO snapshot in use, compare its coins to ensure
1098 : : //! they match those expected by the snapshot.
1099 : : //!
1100 : : //! If the coins match (expected), then mark the validation chainstate for
1101 : : //! deletion and continue using the snapshot chainstate as active.
1102 : : //! Otherwise, revert to using the ibd chainstate and shutdown.
1103 : : SnapshotCompletionResult MaybeCompleteSnapshotValidation() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1104 : :
1105 : : //! Returns nullptr if no snapshot has been loaded.
1106 : : const CBlockIndex* GetSnapshotBaseBlock() const EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1107 : :
1108 : : //! The most-work chain.
1109 : : Chainstate& ActiveChainstate() const;
1110 [ + - + - : 2801387 : CChain& ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex()) { return ActiveChainstate().m_chain; }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - -
- - - + -
+ - + - +
- + - + -
- - - - -
- - - - -
- - - - -
- ][ + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ][ + - +
- - + + -
+ + # # #
# # # ][ #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ + - + -
+ - + - +
- + - + -
+ - + - +
- + - - -
- - + - +
- + + + -
+ - + - +
- + - + -
+ - + - +
- + + + -
+ - + - +
- + - + -
+ - + + +
- + + - +
+ - + - +
- + - + -
+ - + + +
- + + +
- ][ + - +
- + + + -
+ - + - #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ][ + -
+ - + - +
- ][ + - +
- + - + -
+ - + - +
- + + + -
+ - + - +
- + - + -
+ - + + +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + + +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - ]
[ + - + +
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ][ + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - +
- ][ + - +
- + - + -
+ - + - +
- + - + -
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ - - - -
- - - - -
- - - - -
- - - - +
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - +
- ]
1111 : 145455 : int ActiveHeight() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex()) { return ActiveChain().Height(); }
1112 [ + + ]: 403591 : CBlockIndex* ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex()) { return ActiveChain().Tip(); }
1113 : :
1114 : : //! The state of a background sync (for net processing)
1115 : 552758 : bool BackgroundSyncInProgress() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex()) {
1116 [ + + + - ]: 558456 : return IsUsable(m_snapshot_chainstate.get()) && IsUsable(m_ibd_chainstate.get());
1117 : : }
1118 : :
1119 : : //! The tip of the background sync chain
1120 : 1492 : const CBlockIndex* GetBackgroundSyncTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex()) {
1121 [ + - + - ]: 1492 : return BackgroundSyncInProgress() ? m_ibd_chainstate->m_chain.Tip() : nullptr;
1122 : : }
1123 : :
1124 : : node::BlockMap& BlockIndex() EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
1125 : : {
1126 : : AssertLockHeld(::cs_main);
1127 [ + + ]: 2114 : return m_blockman.m_block_index;
1128 : : }
1129 : :
1130 : : /**
1131 : : * Track versionbit status
1132 : : */
1133 : : mutable VersionBitsCache m_versionbitscache;
1134 : :
1135 : : //! @returns true if a snapshot-based chainstate is in use. Also implies
1136 : : //! that a background validation chainstate is also in use.
1137 : : bool IsSnapshotActive() const;
1138 : :
1139 : : std::optional<uint256> SnapshotBlockhash() const;
1140 : :
1141 : : //! Is there a snapshot in use and has it been fully validated?
1142 : 16 : bool IsSnapshotValidated() const EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
1143 : : {
1144 [ + + + - : 16 : return m_snapshot_chainstate && m_ibd_chainstate && m_ibd_chainstate->m_disabled;
+ - - + -
- - - + -
+ - - + +
- + - + -
- + - - -
- + - + -
+ - - + -
- - - ][ +
+ + - +
- ]
1145 : : }
1146 : :
1147 : : /** Check whether we are doing an initial block download (synchronizing from disk or network) */
1148 : : bool IsInitialBlockDownload() const;
1149 : :
1150 : : /** Guess verification progress (as a fraction between 0.0=genesis and 1.0=current tip). */
1151 : : double GuessVerificationProgress(const CBlockIndex* pindex) const EXCLUSIVE_LOCKS_REQUIRED(GetMutex());
1152 : :
1153 : : /**
1154 : : * Import blocks from an external file
1155 : : *
1156 : : * During reindexing, this function is called for each block file (datadir/blocks/blk?????.dat).
1157 : : * It reads all blocks contained in the given file and attempts to process them (add them to the
1158 : : * block index). The blocks may be out of order within each file and across files. Often this
1159 : : * function reads a block but finds that its parent hasn't been read yet, so the block can't be
1160 : : * processed yet. The function will add an entry to the blocks_with_unknown_parent map (which is
1161 : : * passed as an argument), so that when the block's parent is later read and processed, this
1162 : : * function can re-read the child block from disk and process it.
1163 : : *
1164 : : * Because a block's parent may be in a later file, not just later in the same file, the
1165 : : * blocks_with_unknown_parent map must be passed in and out with each call. It's a multimap,
1166 : : * rather than just a map, because multiple blocks may have the same parent (when chain splits
1167 : : * or stale blocks exist). It maps from parent-hash to child-disk-position.
1168 : : *
1169 : : * This function can also be used to read blocks from user-specified block files using the
1170 : : * -loadblock= option. There's no unknown-parent tracking, so the last two arguments are omitted.
1171 : : *
1172 : : *
1173 : : * @param[in] file_in File containing blocks to read
1174 : : * @param[in] dbp (optional) Disk block position (only for reindex)
1175 : : * @param[in,out] blocks_with_unknown_parent (optional) Map of disk positions for blocks with
1176 : : * unknown parent, key is parent block hash
1177 : : * (only used for reindex)
1178 : : * */
1179 : : void LoadExternalBlockFile(
1180 : : AutoFile& file_in,
1181 : : FlatFilePos* dbp = nullptr,
1182 : : std::multimap<uint256, FlatFilePos>* blocks_with_unknown_parent = nullptr);
1183 : :
1184 : : /**
1185 : : * Process an incoming block. This only returns after the best known valid
1186 : : * block is made active. Note that it does not, however, guarantee that the
1187 : : * specific block passed to it has been checked for validity!
1188 : : *
1189 : : * If you want to *possibly* get feedback on whether block is valid, you must
1190 : : * install a CValidationInterface (see validationinterface.h) - this will have
1191 : : * its BlockChecked method called whenever *any* block completes validation.
1192 : : *
1193 : : * Note that we guarantee that either the proof-of-work is valid on block, or
1194 : : * (and possibly also) BlockChecked will have been called.
1195 : : *
1196 : : * May not be called in a validationinterface callback.
1197 : : *
1198 : : * @param[in] block The block we want to process.
1199 : : * @param[in] force_processing Process this block even if unrequested; used for non-network block sources.
1200 : : * @param[in] min_pow_checked True if proof-of-work anti-DoS checks have
1201 : : * been done by caller for headers chain
1202 : : * (note: only affects headers acceptance; if
1203 : : * block header is already present in block
1204 : : * index then this parameter has no effect)
1205 : : * @param[out] new_block A boolean which is set to indicate if the block was first received via this call
1206 : : * @returns If the block was processed, independently of block validity
1207 : : */
1208 : : bool ProcessNewBlock(const std::shared_ptr<const CBlock>& block, bool force_processing, bool min_pow_checked, bool* new_block) LOCKS_EXCLUDED(cs_main);
1209 : :
1210 : : /**
1211 : : * Process incoming block headers.
1212 : : *
1213 : : * May not be called in a
1214 : : * validationinterface callback.
1215 : : *
1216 : : * @param[in] headers The block headers themselves
1217 : : * @param[in] min_pow_checked True if proof-of-work anti-DoS checks have been done by caller for headers chain
1218 : : * @param[out] state This may be set to an Error state if any error occurred processing them
1219 : : * @param[out] ppindex If set, the pointer will be set to point to the last new block index object for the given headers
1220 : : * @returns false if AcceptBlockHeader fails on any of the headers, true otherwise (including if headers were already known)
1221 : : */
1222 : : bool ProcessNewBlockHeaders(std::span<const CBlockHeader> headers, bool min_pow_checked, BlockValidationState& state, const CBlockIndex** ppindex = nullptr) LOCKS_EXCLUDED(cs_main);
1223 : :
1224 : : /**
1225 : : * Sufficiently validate a block for disk storage (and store on disk).
1226 : : *
1227 : : * @param[in] pblock The block we want to process.
1228 : : * @param[in] fRequested Whether we requested this block from a
1229 : : * peer.
1230 : : * @param[in] dbp The location on disk, if we are importing
1231 : : * this block from prior storage.
1232 : : * @param[in] min_pow_checked True if proof-of-work anti-DoS checks have
1233 : : * been done by caller for headers chain
1234 : : *
1235 : : * @param[out] state The state of the block validation.
1236 : : * @param[out] ppindex Optional return parameter to get the
1237 : : * CBlockIndex pointer for this block.
1238 : : * @param[out] fNewBlock Optional return parameter to indicate if the
1239 : : * block is new to our storage.
1240 : : *
1241 : : * @returns False if the block or header is invalid, or if saving to disk fails (likely a fatal error); true otherwise.
1242 : : */
1243 : : bool AcceptBlock(const std::shared_ptr<const CBlock>& pblock, BlockValidationState& state, CBlockIndex** ppindex, bool fRequested, const FlatFilePos* dbp, bool* fNewBlock, bool min_pow_checked) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
1244 : :
1245 : : void ReceivedBlockTransactions(const CBlock& block, CBlockIndex* pindexNew, const FlatFilePos& pos) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
1246 : :
1247 : : /**
1248 : : * Try to add a transaction to the memory pool.
1249 : : *
1250 : : * @param[in] tx The transaction to submit for mempool acceptance.
1251 : : * @param[in] test_accept When true, run validation checks but don't submit to mempool.
1252 : : */
1253 : : [[nodiscard]] MempoolAcceptResult ProcessTransaction(const CTransactionRef& tx, bool test_accept=false)
1254 : : EXCLUSIVE_LOCKS_REQUIRED(cs_main);
1255 : :
1256 : : //! Load the block tree and coins database from disk, initializing state if we're running with -reindex
1257 : : bool LoadBlockIndex() EXCLUSIVE_LOCKS_REQUIRED(cs_main);
1258 : :
1259 : : //! Check to see if caches are out of balance and if so, call
1260 : : //! ResizeCoinsCaches() as needed.
1261 : : void MaybeRebalanceCaches() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1262 : :
1263 : : /** Update uncommitted block structures (currently: only the witness reserved value). This is safe for submitted blocks. */
1264 : : void UpdateUncommittedBlockStructures(CBlock& block, const CBlockIndex* pindexPrev) const;
1265 : :
1266 : : /** Produce the necessary coinbase commitment for a block (modifies the hash, don't call for mined blocks). */
1267 : : std::vector<unsigned char> GenerateCoinbaseCommitment(CBlock& block, const CBlockIndex* pindexPrev) const;
1268 : :
1269 : : /** This is used by net_processing to report pre-synchronization progress of headers, as
1270 : : * headers are not yet fed to validation during that time, but validation is (for now)
1271 : : * responsible for logging and signalling through NotifyHeaderTip, so it needs this
1272 : : * information. */
1273 : : void ReportHeadersPresync(const arith_uint256& work, int64_t height, int64_t timestamp);
1274 : :
1275 : : //! When starting up, search the datadir for a chainstate based on a UTXO
1276 : : //! snapshot that is in the process of being validated.
1277 : : bool DetectSnapshotChainstate() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1278 : :
1279 : : void ResetChainstates() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1280 : :
1281 : : //! Remove the snapshot-based chainstate and all on-disk artifacts.
1282 : : //! Used when reindex{-chainstate} is called during snapshot use.
1283 : : [[nodiscard]] bool DeleteSnapshotChainstate() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1284 : :
1285 : : //! Switch the active chainstate to one based on a UTXO snapshot that was loaded
1286 : : //! previously.
1287 : : Chainstate& ActivateExistingSnapshot(uint256 base_blockhash) EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1288 : :
1289 : : //! If we have validated a snapshot chain during this runtime, copy its
1290 : : //! chainstate directory over to the main `chainstate` location, completing
1291 : : //! validation of the snapshot.
1292 : : //!
1293 : : //! If the cleanup succeeds, the caller will need to ensure chainstates are
1294 : : //! reinitialized, since ResetChainstates() will be called before leveldb
1295 : : //! directories are moved or deleted.
1296 : : //!
1297 : : //! @sa node/chainstate:LoadChainstate()
1298 : : bool ValidatedSnapshotCleanup() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1299 : :
1300 : : //! @returns the chainstate that indexes should consult when ensuring that an
1301 : : //! index is synced with a chain where we can expect block index entries to have
1302 : : //! BLOCK_HAVE_DATA beneath the tip.
1303 : : //!
1304 : : //! In other words, give us the chainstate for which we can reasonably expect
1305 : : //! that all blocks beneath the tip have been indexed. In practice this means
1306 : : //! when using an assumed-valid chainstate based upon a snapshot, return only the
1307 : : //! fully validated chain.
1308 : : Chainstate& GetChainstateForIndexing() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1309 : :
1310 : : //! Return the [start, end] (inclusive) of block heights we can prune.
1311 : : //!
1312 : : //! start > end is possible, meaning no blocks can be pruned.
1313 : : std::pair<int, int> GetPruneRange(
1314 : : const Chainstate& chainstate, int last_height_can_prune) EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1315 : :
1316 : : //! Return the height of the base block of the snapshot in use, if one exists, else
1317 : : //! nullopt.
1318 : : std::optional<int> GetSnapshotBaseHeight() const EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1319 : :
1320 : : //! If, due to invalidation / reconsideration of blocks, the previous
1321 : : //! best header is no longer valid / guaranteed to be the most-work
1322 : : //! header in our block-index not known to be invalid, recalculate it.
1323 : : void RecalculateBestHeader() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
1324 : :
1325 [ + + ]: 179998 : CCheckQueue<CScriptCheck>& GetCheckQueue() { return m_script_check_queue; }
1326 : :
1327 : : ~ChainstateManager();
1328 : : };
1329 : :
1330 : : /** Deployment* info via ChainstateManager */
1331 : : template<typename DEP>
1332 : 647113 : bool DeploymentActiveAfter(const CBlockIndex* pindexPrev, const ChainstateManager& chainman, DEP dep)
1333 : : {
1334 : 647113 : return DeploymentActiveAfter(pindexPrev, chainman.GetConsensus(), dep, chainman.m_versionbitscache);
1335 : : }
1336 : :
1337 : : template<typename DEP>
1338 : 1397625 : bool DeploymentActiveAt(const CBlockIndex& index, const ChainstateManager& chainman, DEP dep)
1339 : : {
1340 : 1397625 : return DeploymentActiveAt(index, chainman.GetConsensus(), dep, chainman.m_versionbitscache);
1341 : : }
1342 : :
1343 : : template<typename DEP>
1344 : 637 : bool DeploymentEnabled(const ChainstateManager& chainman, DEP dep)
1345 : : {
1346 : 637 : return DeploymentEnabled(chainman.GetConsensus(), dep);
1347 : : }
1348 : :
1349 : : /** Identifies blocks that overwrote an existing coinbase output in the UTXO set (see BIP30) */
1350 : : bool IsBIP30Repeat(const CBlockIndex& block_index);
1351 : :
1352 : : /** Identifies blocks which coinbase output was subsequently overwritten in the UTXO set (see BIP30) */
1353 : : bool IsBIP30Unspendable(const CBlockIndex& block_index);
1354 : :
1355 : : #endif // BITCOIN_VALIDATION_H
|
