![]() |
Bitcoin Core
21.99.0
P2P Digital Currency
|
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate generated by downloading blocks, and an optional snapshot chainstate loaded from a UTXO snapshot. More...
#include <validation.h>
Public Member Functions | |
BlockManager m_blockman | GUARDED_BY (::cs_main) |
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating block metadata. More... | |
bool | ActivateSnapshot (CAutoFile &coins_file, const SnapshotMetadata &metadata, bool in_memory) |
Construct and activate a Chainstate on the basis of UTXO snapshot data. More... | |
CChainState & | ActiveChainstate () const |
The most-work chain. More... | |
CChain & | ActiveChain () const |
int | ActiveHeight () const |
CBlockIndex * | ActiveTip () const |
BlockMap & | BlockIndex () EXCLUSIVE_LOCKS_REQUIRED( |
bool | IsSnapshotActive () const |
std::optional< uint256 > | SnapshotBlockhash () const |
bool | IsSnapshotValidated () const |
Is there a snapshot in use and has it been fully validated? More... | |
bool | IsBackgroundIBD (CChainState *chainstate) const |
CChainState & | ValidatedChainstate () const |
Return the most-work chainstate that has been fully validated. More... | |
CChain & | ValidatedChain () const |
CBlockIndex * | ValidatedTip () const |
bool | ProcessNewBlock (const CChainParams &chainparams, const std::shared_ptr< const CBlock > pblock, bool fForceProcessing, bool *fNewBlock) LOCKS_EXCLUDED(cs_main) |
Process an incoming block. More... | |
bool | ProcessNewBlockHeaders (const std::vector< CBlockHeader > &block, BlockValidationState &state, const CChainParams &chainparams, const CBlockIndex **ppindex=nullptr) LOCKS_EXCLUDED(cs_main) |
Process incoming block headers. More... | |
bool | LoadBlockIndex (const CChainParams &chainparams) EXCLUSIVE_LOCKS_REQUIRED(cs_main) |
Load the block tree and coins database from disk, initializing state if we're running with -reindex. More... | |
Public Attributes | |
std::thread | m_load_block |
int64_t | m_total_coinstip_cache {0} |
The total number of bytes available for us to use across all in-memory coins caches. More... | |
int64_t | m_total_coinsdb_cache {0} |
The total number of bytes available for us to use across all leveldb coins databases. More... | |
CChainState &InitializeChainstate(CTxMemPool &mempool, const uint256 &snapshot_blockhash=uint256()) EXCLUSIVE_LOCKS_REQUIRED(std::vector< CChainState * > | GetAll () |
Instantiate a new chainstate and assign it based upon whether it is from a snapshot. More... | |
Private Member Functions | |
std::unique_ptr< CChainState > m_ibd_chainstate | GUARDED_BY (::cs_main) |
The chainstate used under normal operation (i.e. More... | |
std::unique_ptr< CChainState > m_snapshot_chainstate | GUARDED_BY (::cs_main) |
A chainstate initialized on the basis of a UTXO snapshot. More... | |
CChainState *m_active_chainstate | GUARDED_BY (::cs_main) |
Points to either the ibd or snapshot chainstate; indicates our most-work chain. More... | |
bool | PopulateAndValidateSnapshot (CChainState &snapshot_chainstate, CAutoFile &coins_file, const SnapshotMetadata &metadata) |
Internal helper for ActivateSnapshot(). More... | |
Private Attributes | |
bool | m_snapshot_validated {false} |
If true, the assumed-valid chainstate has been fully validated by the background validation chainstate. More... | |
Friends | |
CChainState & | ChainstateActive () |
Please prefer the identical ChainstateManager::ActiveChainstate. More... | |
CChain & | ChainActive () |
Please prefer the identical ChainstateManager::ActiveChain. More... | |
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate generated by downloading blocks, and an optional snapshot chainstate loaded from a UTXO snapshot.
Managed chainstates can be maintained at different heights simultaneously.
This class provides abstractions that allow the retrieval of the current most-work chainstate ("Active") as well as chainstates which may be in background use to validate UTXO snapshots.
Definitions:
IBD chainstate: a chainstate whose current state has been "fully" validated by the initial block download process.
Snapshot chainstate: a chainstate populated by loading in an assumeutxo UTXO snapshot.
Active chainstate: the chainstate containing the current most-work chain. Consulted by most parts of the system (net_processing, wallet) as a reflection of the current chain and UTXO set. This may either be an IBD chainstate or a snapshot chainstate.
Background IBD chainstate: an IBD chainstate for which the IBD process is happening in the background while use of the active (snapshot) chainstate allows the rest of the system to function.
Validated chainstate: the most-work chainstate which has been validated locally via initial block download. This will be the snapshot chainstate if a snapshot was loaded and all blocks up to the snapshot starting point have been downloaded and validated (via background validation), otherwise it will be the IBD chainstate.
Definition at line 807 of file validation.h.
bool ChainstateManager::ActivateSnapshot | ( | CAutoFile & | coins_file, |
const SnapshotMetadata & | metadata, | ||
bool | in_memory | ||
) |
Construct and activate a Chainstate on the basis of UTXO snapshot data.
Steps:
CoinsViews
contents from coins_file
.m_snapshot_chainstate
and make it our ChainstateActive(). Definition at line 5096 of file validation.cpp.
|
inline |
CChainState & ChainstateManager::ActiveChainstate | ( | ) | const |
The most-work chain.
Definition at line 5357 of file validation.cpp.
|
inline |
Definition at line 909 of file validation.h.
|
inline |
Definition at line 910 of file validation.h.
|
inline |
|
private |
The chainstate used under normal operation (i.e.
"regular" IBD) or, if a snapshot is in use, for background validation.
Its contents (including on-disk data) will be deleted upon shutdown after background validation of the snapshot has completed. We do not free the chainstate contents immediately after it finishes validation to cautiously avoid a case where some other part of the system is still using this pointer (e.g. net_processing).
Once this pointer is set to a corresponding chainstate, it will not be reset until init.cpp:Shutdown().
This is especially important when, e.g., calling ActivateBestChain() on all chainstates because we are not able to hold cs_main going into that call.
|
private |
A chainstate initialized on the basis of a UTXO snapshot.
If this is non-null, it is always our active chainstate.
Once this pointer is set to a corresponding chainstate, it will not be reset until init.cpp:Shutdown().
This is especially important when, e.g., calling ActivateBestChain() on all chainstates because we are not able to hold cs_main going into that call.
|
inlineprivate |
Points to either the ibd or snapshot chainstate; indicates our most-work chain.
Once this pointer is set to a corresponding chainstate, it will not be reset until init.cpp:Shutdown().
This is especially important when, e.g., calling ActivateBestChain() on all chainstates because we are not able to hold cs_main going into that call.
Definition at line 847 of file validation.h.
BlockManager m_blockman ChainstateManager::GUARDED_BY | ( | ::cs_main | ) |
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating block metadata.
bool ChainstateManager::IsBackgroundIBD | ( | CChainState * | chainstate | ) | const |
Definition at line 5380 of file validation.cpp.
bool ChainstateManager::IsSnapshotActive | ( | ) | const |
Definition at line 5364 of file validation.cpp.
|
inline |
Is there a snapshot in use and has it been fully validated?
Definition at line 922 of file validation.h.
bool ChainstateManager::LoadBlockIndex | ( | const CChainParams & | chainparams | ) |
Load the block tree and coins database from disk, initializing state if we're running with -reindex.
Definition at line 4457 of file validation.cpp.
|
private |
Internal helper for ActivateSnapshot().
Definition at line 5178 of file validation.cpp.
bool ChainstateManager::ProcessNewBlock | ( | const CChainParams & | chainparams, |
const std::shared_ptr< const CBlock > | pblock, | ||
bool | fForceProcessing, | ||
bool * | fNewBlock | ||
) |
Process an incoming block.
This only returns after the best known valid block is made active. Note that it does not, however, guarantee that the specific block passed to it has been checked for validity!
If you want to possibly get feedback on whether pblock is valid, you must install a CValidationInterface (see validationinterface.h) - this will have its BlockChecked method called whenever any block completes validation.
Note that we guarantee that either the proof-of-work is valid on pblock, or (and possibly also) BlockChecked will have been called.
May not be called in a validationinterface callback.
[in] | pblock | The block we want to process. |
[in] | fForceProcessing | Process this block even if unrequested; used for non-network block sources. |
[out] | fNewBlock | A boolean which is set to indicate if the block was first received via this call |
Definition at line 3667 of file validation.cpp.
bool ChainstateManager::ProcessNewBlockHeaders | ( | const std::vector< CBlockHeader > & | block, |
BlockValidationState & | state, | ||
const CChainParams & | chainparams, | ||
const CBlockIndex ** | ppindex = nullptr |
||
) |
Process incoming block headers.
May not be called in a validationinterface callback.
[in] | block | The block headers themselves |
[out] | state | This may be set to an Error state if any error occurred processing them |
[in] | chainparams | The params for the chain we want to connect to |
[out] | ppindex | If set, the pointer will be set to point to the last new block index object for the given headers |
Definition at line 3555 of file validation.cpp.
std::optional< uint256 > ChainstateManager::SnapshotBlockhash | ( | ) | const |
|
inline |
Definition at line 934 of file validation.h.
CChainState & ChainstateManager::ValidatedChainstate | ( | ) | const |
Return the most-work chainstate that has been fully validated.
During background validation of a snapshot, this is the IBD chain. After background validation has completed, this is the snapshot chain.
Definition at line 5370 of file validation.cpp.
|
inline |
Definition at line 935 of file validation.h.
|
friend |
Please prefer the identical ChainstateManager::ActiveChain.
Definition at line 115 of file validation.cpp.
|
friend |
Please prefer the identical ChainstateManager::ActiveChainstate.
Definition at line 108 of file validation.cpp.
std::vector< CChainState * > ChainstateManager::GetAll |
Instantiate a new chainstate and assign it based upon whether it is from a snapshot.
[in] | mempool | The mempool to pass to the chainstate |
[in] | snapshot_blockhash | If given, signify that this chainstate is based on a snapshot. Get all chainstates currently being used. |
Definition at line 888 of file validation.h.
std::thread ChainstateManager::m_load_block |
Definition at line 864 of file validation.h.
|
private |
If true, the assumed-valid chainstate has been fully validated by the background validation chainstate.
Definition at line 851 of file validation.h.
int64_t ChainstateManager::m_total_coinsdb_cache {0} |
The total number of bytes available for us to use across all leveldb coins databases.
This will be split somehow across chainstates.
Definition at line 875 of file validation.h.
int64_t ChainstateManager::m_total_coinstip_cache {0} |
The total number of bytes available for us to use across all in-memory coins caches.
This will be split somehow across chainstates.
Definition at line 871 of file validation.h.