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