![]() |
Bitcoin Core 30.99.0
P2P Digital Currency
|
Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-work tip is.
More...
#include <blockstorage.h>
Public Types | |
| using | Options = kernel::BlockManagerOpts |
Public Member Functions | |
| BlockManager (const util::SignalInterrupt &interrupt, Options opts) | |
| BlockMap m_block_index | GUARDED_BY (cs_main) |
| std::unique_ptr< BlockTreeDB > m_block_tree_db | GUARDED_BY (::cs_main) |
| CBlockIndex * | InsertBlockIndex (const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main) |
| Create a new block index entry for a given block hash. More... | |
| void | PruneOneBlockFile (const int fileNumber) EXCLUSIVE_LOCKS_REQUIRED(cs_main) |
| Mark one block file as pruned (modify associated database entries) More... | |
| CBlockIndex * | LookupBlockIndex (const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main) |
| const CBlockIndex * | LookupBlockIndex (const uint256 &hash) const EXCLUSIVE_LOCKS_REQUIRED(cs_main) |
| CBlockFileInfo * | GetBlockFileInfo (size_t n) |
| Get block file info entry for one block file. More... | |
| void | UpdateBlockInfo (const CBlock &block, unsigned int nHeight, const FlatFilePos &pos) |
| Update blockfile info while processing a block during reindex. More... | |
| bool | IsPruneMode () const |
| Whether running in -prune mode. More... | |
| uint64_t | GetPruneTarget () const |
| Attempt to stay below this number of bytes of block files. More... | |
| bool | LoadingBlocks () const |
| uint64_t | CalculateCurrentUsage () |
| Calculate the amount of disk space the block & undo files currently use. More... | |
| fs::path | GetBlockPosFilename (const FlatFilePos &pos) const |
| Translation to a filesystem path. More... | |
| void | UnlinkPrunedFiles (const std::set< int > &setFilesToPrune) const |
| Actually unlink the specified files. More... | |
| bool | ReadBlock (CBlock &block, const FlatFilePos &pos, const std::optional< uint256 > &expected_hash) const |
| Functions for disk access for blocks. More... | |
| bool | ReadBlock (CBlock &block, const CBlockIndex &index) const |
| bool | ReadRawBlock (std::vector< std::byte > &block, const FlatFilePos &pos) const |
| bool | ReadBlockUndo (CBlockUndo &blockundo, const CBlockIndex &index) const |
| void | CleanupBlockRevFiles () const |
Public Attributes | |
| const util::SignalInterrupt & | m_interrupt |
| std::atomic< bool > | m_importing {false} |
| std::atomic_bool | m_blockfiles_indexed {true} |
| Whether all blockfiles have been added to the block tree database. More... | |
| std::optional< int > | m_snapshot_height |
| The height of the base block of an assumeutxo snapshot, if one is in use. More... | |
| std::vector< CBlockIndex * > GetAllBlockIndices() EXCLUSIVE_LOCKS_REQUIRED(std::multimap< CBlockIndex *, CBlockIndex * > | m_blocks_unlinked |
| All pairs A->B, where A (or one of its ancestors) misses transactions, but B has transactions. More... | |
| void WriteBlockIndexDB() EXCLUSIVE_LOCKS_REQUIRED(bool LoadBlockIndexDB(const std::optional< uint256 > &snapshot_blockhash) EXCLUSIVE_LOCKS_REQUIRED(void ScanAndUnlinkAlreadyPrunedFiles() EXCLUSIVE_LOCKS_REQUIRED(CBlockIndex * | AddToBlockIndex (const CBlockHeader &block, CBlockIndex *&best_header) EXCLUSIVE_LOCKS_REQUIRED(cs_main) |
| Remove any pruned block & undo files that are still on disk. More... | |
| bool WriteBlockUndo(const CBlockUndo &blockundo, BlockValidationState &state, CBlockIndex &block) EXCLUSIVE_LOCKS_REQUIRED(FlatFilePos | WriteBlock (const CBlock &block, int nHeight) |
| Store block on disk and update block file statistics. More... | |
| bool CheckBlockDataAvailability(const CBlockIndex &upper_block, const CBlockIndex &lower_block) EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex &GetFirstBlock(const CBlockIndex &upper_block LIFETIMEBOUND, uint32_t status_mask, const CBlockIndex *lower_block LIFETIMEBOUND=nullptr) const EXCLUSIVE_LOCKS_REQUIRED(boo | m_have_pruned ) = false |
| Check if all blocks in the [upper_block, lower_block] range have data available. More... | |
| bool IsBlockPruned(const CBlockIndex &block) const EXCLUSIVE_LOCKS_REQUIRED(void UpdatePruneLock(const std::string &name, const PruneLockInfo &lock_info) EXCLUSIVE_LOCKS_REQUIRED(AutoFile | OpenBlockFile (const FlatFilePos &pos, bool fReadOnly) const |
| Check whether the block associated with this index entry is pruned or not. More... | |
Static Public Attributes | |
| static constexpr auto | PRUNE_TARGET_MANUAL {std::numeric_limits<uint64_t>::max()} |
Private Member Functions | |
| const CChainParams & | GetParams () const |
| const Consensus::Params & | GetConsensus () const |
| bool | LoadBlockIndex (const std::optional< uint256 > &snapshot_blockhash) EXCLUSIVE_LOCKS_REQUIRED(cs_main) |
| Load the blocktree off disk and into memory. More... | |
| bool | FlushBlockFile (int blockfile_num, bool fFinalize, bool finalize_undo) |
| Return false if block file or undo file flushing fails. More... | |
| bool | FlushUndoFile (int block_file, bool finalize=false) |
| Return false if undo file flushing fails. More... | |
| FlatFilePos | FindNextBlockPos (unsigned int nAddSize, unsigned int nHeight, uint64_t nTime) |
| Helper function performing various preparations before a block can be saved to disk: Returns the correct position for the block to be saved, which may be in the current or a new block file depending on nAddSize. More... | |
| bool | FlushChainstateBlockFile (int tip_height) |
| bool | FindUndoPos (BlockValidationState &state, int nFile, FlatFilePos &pos, unsigned int nAddSize) |
| AutoFile | OpenUndoFile (const FlatFilePos &pos, bool fReadOnly=false) const |
| Open an undo file (rev?????.dat) More... | |
| void | FindFilesToPruneManual (std::set< int > &setFilesToPrune, int nManualPruneHeight, const Chainstate &chain, ChainstateManager &chainman) |
| void | FindFilesToPrune (std::set< int > &setFilesToPrune, int last_prune, const Chainstate &chain, ChainstateManager &chainman) |
| Prune block and undo files (blk???.dat and rev???.dat) so that the disk space used is less than a user-defined target. More... | |
| std::array< std::optional< BlockfileCursor >, BlockfileType::NUM_TYPES > m_blockfile_cursors | GUARDED_BY (cs_LastBlockFile) |
| Since assumedvalid chainstates may be syncing a range of the chain that is very far away from the normal/background validation process, we should segment blockfiles for assumed chainstates. More... | |
| int | MaxBlockfileNum () const EXCLUSIVE_LOCKS_REQUIRED(cs_LastBlockFile) |
| std::unordered_map< std::string, PruneLockInfo > m_prune_locks | GUARDED_BY (::cs_main) |
| Map from external index name to oldest block that must not be pruned. More... | |
| BlockfileType | BlockfileTypeForHeight (int height) |
Private Attributes | |
| friend | Chainstate |
| friend | ChainstateManager |
| RecursiveMutex | cs_LastBlockFile |
| std::vector< CBlockFileInfo > | m_blockfile_info |
| bool | m_check_for_pruning = false |
| Global flag to indicate we should check to see if there are block/undo files that should be deleted. More... | |
| const bool | m_prune_mode |
| const Obfuscation | m_obfuscation |
| std::set< CBlockIndex * > | m_dirty_blockindex |
| Dirty block index entries. More... | |
| std::set< int > | m_dirty_fileinfo |
| Dirty block file entries. More... | |
| const kernel::BlockManagerOpts | m_opts |
| const FlatFileSeq | m_block_file_seq |
| const FlatFileSeq | m_undo_file_seq |
Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-work tip is.
This data is used mostly in Chainstate - information about, e.g., candidate tips is not maintained here.
Definition at line 180 of file blockstorage.h.
Definition at line 304 of file blockstorage.h.
|
explicit |
|
private |
| uint64_t node::BlockManager::CalculateCurrentUsage | ( | ) |
Calculate the amount of disk space the block & undo files currently use.
Definition at line 761 of file blockstorage.cpp.
| void node::BlockManager::CleanupBlockRevFiles | ( | ) | const |
Definition at line 622 of file blockstorage.cpp.
|
private |
Prune block and undo files (blk???.dat and rev???.dat) so that the disk space used is less than a user-defined target.
The user sets the target (in MB) on the command line or in config file. This will be run on startup and whenever new space is allocated in a block or undo file, staying below the target. Changing back to unpruned requires a reindex (which in this case means the blockchain must be re-downloaded.)
Pruning functions are called from FlushStateToDisk when the m_check_for_pruning flag has been set. Block and undo files are deleted in lock-step (when blk00003.dat is deleted, so is rev00003.dat.) Pruning cannot take place until the longest chain is at least a certain length (CChainParams::nPruneAfterHeight). Pruning will never delete a block within a defined distance (currently 288) from the active chain's tip. The block index is updated by unsetting HAVE_DATA and HAVE_UNDO for any blocks that were stored in the deleted files. A db flag records the fact that at least some block files have been pruned.
| [out] | setFilesToPrune | The set of file indices that can be unlinked will be returned |
| last_prune | The last height we're able to prune, according to the prune locks |
Definition at line 312 of file blockstorage.cpp.
|
private |
Definition at line 282 of file blockstorage.cpp.
|
private |
Helper function performing various preparations before a block can be saved to disk: Returns the correct position for the block to be saved, which may be in the current or a new block file depending on nAddSize.
May flush the previous blockfile to disk if full, updates blockfile info, and checks if there is enough disk space to save the block.
The nAddSize argument passed to this function should include not just the size of the serialized CBlock, but also the size of separator fields (STORAGE_HEADER_BYTES).
Definition at line 801 of file blockstorage.cpp.
|
private |
|
private |
Return false if block file or undo file flushing fails.
Definition at line 710 of file blockstorage.cpp.
|
private |
Definition at line 747 of file blockstorage.cpp.
|
private |
Return false if undo file flushing fails.
Definition at line 700 of file blockstorage.cpp.
| CBlockFileInfo * node::BlockManager::GetBlockFileInfo | ( | size_t | n | ) |
Get block file info entry for one block file.
Definition at line 658 of file blockstorage.cpp.
| fs::path node::BlockManager::GetBlockPosFilename | ( | const FlatFilePos & | pos | ) | const |
Translation to a filesystem path.
Definition at line 796 of file blockstorage.cpp.
|
inlineprivate |
Definition at line 187 of file blockstorage.h.
|
inlineprivate |
|
inline |
Attempt to stay below this number of bytes of block files.
Definition at line 394 of file blockstorage.h.
|
private |
Map from external index name to oldest block that must not be pruned.
| std::unique_ptr< BlockTreeDB > m_block_tree_db node::BlockManager::GUARDED_BY | ( | ::cs_main | ) |
|
private |
Since assumedvalid chainstates may be syncing a range of the chain that is very far away from the normal/background validation process, we should segment blockfiles for assumed chainstates.
Otherwise, we might have wildly different height ranges mixed into the same block files, which would impair our ability to prune effectively.
This data structure maintains separate blockfile number cursors for each BlockfileType. The ASSUMED state is initialized, when necessary, in FindNextBlockPos().
The first element is the NORMAL cursor, second is ASSUMED.
| CBlockIndex * node::BlockManager::InsertBlockIndex | ( | const uint256 & | hash | ) |
Create a new block index entry for a given block hash.
Definition at line 391 of file blockstorage.cpp.
|
inline |
Whether running in -prune mode.
Definition at line 391 of file blockstorage.h.
|
private |
Load the blocktree off disk and into memory.
Populate certain metadata per index entry (nStatus, nChainWork, nTimeMax, etc.) as well as peripheral collections like m_dirty_blockindex.
Definition at line 407 of file blockstorage.cpp.
|
inline |
| const CBlockIndex * node::BlockManager::LookupBlockIndex | ( | const uint256 & | hash | ) | const |
| CBlockIndex * node::BlockManager::LookupBlockIndex | ( | const uint256 & | hash | ) |
Definition at line 200 of file blockstorage.cpp.
|
inlineprivate |
|
private |
Open an undo file (rev?????.dat)
Definition at line 791 of file blockstorage.cpp.
| void node::BlockManager::PruneOneBlockFile | ( | const int | fileNumber | ) |
Mark one block file as pruned (modify associated database entries)
Definition at line 248 of file blockstorage.cpp.
| bool node::BlockManager::ReadBlock | ( | CBlock & | block, |
| const CBlockIndex & | index | ||
| ) | const |
| bool node::BlockManager::ReadBlock | ( | CBlock & | block, |
| const FlatFilePos & | pos, | ||
| const std::optional< uint256 > & | expected_hash | ||
| ) | const |
Functions for disk access for blocks.
Definition at line 1004 of file blockstorage.cpp.
| bool node::BlockManager::ReadBlockUndo | ( | CBlockUndo & | blockundo, |
| const CBlockIndex & | index | ||
| ) | const |
Definition at line 665 of file blockstorage.cpp.
| bool node::BlockManager::ReadRawBlock | ( | std::vector< std::byte > & | block, |
| const FlatFilePos & | pos | ||
| ) | const |
Definition at line 1051 of file blockstorage.cpp.
| void node::BlockManager::UnlinkPrunedFiles | ( | const std::set< int > & | setFilesToPrune | ) | const |
Actually unlink the specified files.
Definition at line 772 of file blockstorage.cpp.
| void node::BlockManager::UpdateBlockInfo | ( | const CBlock & | block, |
| unsigned int | nHeight, | ||
| const FlatFilePos & | pos | ||
| ) |
Update blockfile info while processing a block during reindex.
The block must be available on disk.
| [in] | block | the block being processed |
| [in] | nHeight | the height of the block |
| [in] | pos | the position of the serialized CBlock on disk |
Definition at line 891 of file blockstorage.cpp.
| CBlockIndex * node::BlockManager::AddToBlockIndex |
Remove any pruned block & undo files that are still on disk.
This could happen on some systems if the file was still being read while unlinked, or if we crash before unlinking.
Definition at line 356 of file blockstorage.h.
|
private |
Definition at line 182 of file blockstorage.h.
|
private |
Definition at line 183 of file blockstorage.h.
|
private |
Definition at line 246 of file blockstorage.h.
|
private |
Definition at line 300 of file blockstorage.h.
|
private |
Definition at line 247 of file blockstorage.h.
| std::atomic_bool node::BlockManager::m_blockfiles_indexed {true} |
Whether all blockfiles have been added to the block tree database.
Normally true, but set to false when a reindex is requested and the database is wiped. The value is persisted in the database across restarts and will be false until reindexing completes.
Definition at line 317 of file blockstorage.h.
| std::vector<CBlockIndex*> GetAllBlockIndices () EXCLUSIVE_LOCKS_REQUIRED( std::multimap<CBlockIndex*, CBlockIndex*> node::BlockManager::m_blocks_unlinked |
All pairs A->B, where A (or one of its ancestors) misses transactions, but B has transactions.
Pruned nodes may have entries where B is missing data.
Definition at line 341 of file blockstorage.h.
|
private |
Global flag to indicate we should check to see if there are block/undo files that should be deleted.
Set on startup or if we allocate more file space when we're in prune mode
Definition at line 276 of file blockstorage.h.
|
private |
Dirty block index entries.
Definition at line 283 of file blockstorage.h.
|
private |
Dirty block file entries.
Definition at line 286 of file blockstorage.h.
| bool CheckBlockDataAvailability (const CBlockIndex& upper_block, const CBlockIndex& lower_block) EXCLUSIVE_LOCKS_REQUIRED( const CBlockIndex& GetFirstBlock ( const CBlockIndex& upper_block LIFETIMEBOUND, uint32_t status_mask, const CBlockIndex* lower_block LIFETIMEBOUND = nullptr ) const EXCLUSIVE_LOCKS_REQUIRED( boo node::BlockManager::m_have_pruned) = false |
Check if all blocks in the [upper_block, lower_block] range have data available.
The caller is responsible for ensuring that lower_block is an ancestor of upper_block (part of the same chain).
Returns the earliest block with specified status_mask flags set after the latest block not having those flags.
This function starts from upper_block, which must have all status_mask flags set, and iterates backwards through its ancestors. It continues as long as each block has all status_mask flags set, until reaching the oldest ancestor or lower_block.
upper_block must have all status_mask flags set. lower_block must be null or an ancestor of upper_block| upper_block | The starting block for the search, which must have all status_mask flags set. |
| status_mask | Bitmask specifying required status flags. |
| lower_block | The earliest possible block to return. If null, the search can extend to the genesis block. |
upper_block and lower_block, inclusive, such that every block between the returned block and upper_block has status_mask flags set. True if any block files have ever been pruned. Definition at line 436 of file blockstorage.h.
| std::atomic<bool> node::BlockManager::m_importing {false} |
Definition at line 309 of file blockstorage.h.
| const util::SignalInterrupt& node::BlockManager::m_interrupt |
Definition at line 308 of file blockstorage.h.
|
private |
Definition at line 280 of file blockstorage.h.
|
private |
Definition at line 298 of file blockstorage.h.
|
private |
Definition at line 278 of file blockstorage.h.
| std::optional<int> node::BlockManager::m_snapshot_height |
The height of the base block of an assumeutxo snapshot, if one is in use.
This controls how blockfiles are segmented by chainstate type to avoid comingling different height regions of the chain when an assumedvalid chainstate is in use. If heights are drastically different in the same blockfile, pruning suffers.
This is set during ActivateSnapshot() or upon LoadBlockIndex() if a snapshot had been previously loaded. After the snapshot is validated, this is unset to restore normal LoadBlockIndex behavior.
Definition at line 333 of file blockstorage.h.
|
private |
Definition at line 301 of file blockstorage.h.
| AutoFile node::BlockManager::OpenBlockFile |
Check whether the block associated with this index entry is pruned or not.
Create or update a prune lock identified by its name Open a block file (blk?????.dat)
Definition at line 445 of file blockstorage.h.
|
staticconstexpr |
Definition at line 395 of file blockstorage.h.
| FlatFilePos node::BlockManager::WriteBlock |
Store block on disk and update block file statistics.
| [in] | block | the block to be stored |
| [in] | nHeight | the height of the block |
Definition at line 380 of file blockstorage.h.