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>

Collaboration diagram for node::BlockManager:

[legend]

Public Types
using	Options = kernel::BlockManagerOpts

Public Member Functions
	BlockManager (Options opts)

BlockMap m_block_index	GUARDED_BY (cs_main)

std::unique_ptr< CBlockTreeDB > m_block_tree_db	GUARDED_BY (::cs_main)

CBlockIndex *	InsertBlockIndex (const BlockHash &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 BlockHash &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)

const CBlockIndex *	LookupBlockIndex (const BlockHash &hash) const EXCLUSIVE_LOCKS_REQUIRED(cs_main)

CBlockFileInfo *	GetBlockFileInfo (size_t n)
	Get block file info entry for one block file. 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...

const CBlockIndex *	GetLastCheckpoint (const CCheckpointData &data) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
	Returns last CBlockIndex* that is a checkpoint. More...

Public Attributes
std::atomic< bool >	m_importing {false}

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...

bool WriteUndoDataForBlock(const CBlockUndo &blockundo, BlockValidationState &state, CBlockIndex &block) EXCLUSIVE_LOCKS_REQUIRED(FlatFilePos	SaveBlockToDisk (const CBlock &block, int nHeight, CChain &active_chain, const FlatFilePos *dbp)
	Store block on disk. More...

bool	m_have_pruned = false
	True if any block files have ever been pruned. More...

Static Public Attributes
static constexpr auto	PRUNE_TARGET_MANUAL

Private Member Functions
const CChainParams &	GetParams () const

const Consensus::Params &	GetConsensus () const

bool	LoadBlockIndex () EXCLUSIVE_LOCKS_REQUIRED(cs_main)
	Load the blocktree off disk and into memory. More...

void	FlushBlockFile (bool fFinalize=false, bool finalize_undo=false)

void	FlushUndoFile (int block_file, bool finalize=false)

bool	FindBlockPos (FlatFilePos &pos, unsigned int nAddSize, unsigned int nHeight, CChain &active_chain, uint64_t nTime, bool fKnown)

bool	FindUndoPos (BlockValidationState &state, int nFile, FlatFilePos &pos, unsigned int nAddSize)

void	FindFilesToPruneManual (std::set< int > &setFilesToPrune, int nManualPruneHeight, int chain_tip_height)
	Calculate the block/rev files to delete based on height specified by user with RPC command pruneblockchain. More...

void	FindFilesToPrune (std::set< int > &setFilesToPrune, uint64_t nPruneAfterHeight, int chain_tip_height, int prune_height, bool is_ibd)
	Prune block and undo files (blk???.dat and undo???.dat) so that the disk space used is less than a user-defined target. More...

Private Attributes
friend	Chainstate

friend	ChainstateManager

RecursiveMutex	cs_LastBlockFile

std::vector< CBlockFileInfo >	m_blockfile_info

int	m_last_blockfile = 0

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

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

Detailed Description

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 67 of file blockstorage.h.

Member Typedef Documentation

◆ Options

using node::BlockManager::Options = kernel::BlockManagerOpts

Definition at line 143 of file blockstorage.h.

Constructor & Destructor Documentation

◆ BlockManager()

node::BlockManager::BlockManager ( Options opts )

inlineexplicit

Definition at line 145 of file blockstorage.h.

Member Function Documentation

◆ CalculateCurrentUsage()

uint64_t node::BlockManager::CalculateCurrentUsage ( )

Calculate the amount of disk space the block & undo files currently use.

Definition at line 546 of file blockstorage.cpp.

Here is the caller graph for this function:

◆ FindBlockPos()

bool node::BlockManager::FindBlockPos	(	FlatFilePos &	pos,
		unsigned int	nAddSize,
		unsigned int	nHeight,
		CChain &	active_chain,
		uint64_t	nTime,
		bool	fKnown
	)

private

Definition at line 591 of file blockstorage.cpp.

Here is the call graph for this function:

◆ FindFilesToPrune()

void node::BlockManager::FindFilesToPrune	(	std::set< int > &	setFilesToPrune,
		uint64_t	nPruneAfterHeight,
		int	chain_tip_height,
		int	prune_height,
		bool	is_ibd
	)

private

Prune block and undo files (blk???.dat and undo???.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.

Parameters

[out] setFilesToPrune The set of file indices that can be unlinked will be returned

Definition at line 158 of file blockstorage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindFilesToPruneManual()

void node::BlockManager::FindFilesToPruneManual	(	std::set< int > &	setFilesToPrune,
		int	nManualPruneHeight,
		int	chain_tip_height
	)

private

Calculate the block/rev files to delete based on height specified by user with RPC command pruneblockchain.

Definition at line 130 of file blockstorage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindUndoPos()

bool node::BlockManager::FindUndoPos	(	BlockValidationState &	state,
		int	nFile,
		FlatFilePos &	pos,
		unsigned int	nAddSize
	)

private

Definition at line 669 of file blockstorage.cpp.

Here is the call graph for this function:

◆ FlushBlockFile()

void node::BlockManager::FlushBlockFile	(	bool	fFinalize = `false`,
		bool	finalize_undo = `false`
	)

private

Definition at line 519 of file blockstorage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FlushUndoFile()

void node::BlockManager::FlushUndoFile	(	int	block_file,
		bool	finalize = `false`
	)

private

Definition at line 510 of file blockstorage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlockFileInfo()

CBlockFileInfo * node::BlockManager::GetBlockFileInfo ( size_t n )

Get block file info entry for one block file.

Definition at line 441 of file blockstorage.cpp.

◆ GetConsensus()

const Consensus::Params& node::BlockManager::GetConsensus ( ) const

inlineprivate

Definition at line 73 of file blockstorage.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLastCheckpoint()

const CBlockIndex * node::BlockManager::GetLastCheckpoint ( const CCheckpointData & data )

Returns last CBlockIndex* that is a checkpoint.

Definition at line 370 of file blockstorage.cpp.

Here is the call graph for this function:

◆ GetParams()

const CChainParams& node::BlockManager::GetParams ( ) const

inlineprivate

Definition at line 72 of file blockstorage.h.

◆ GetPruneTarget()

uint64_t node::BlockManager::GetPruneTarget ( ) const

inline

Attempt to stay below this number of bytes of block files.

Definition at line 201 of file blockstorage.h.

Here is the caller graph for this function:

◆ GUARDED_BY() [1/2]

std::unique_ptr<CBlockTreeDB> m_block_tree_db node::BlockManager::GUARDED_BY ( ::cs_main )

◆ GUARDED_BY() [2/2]

BlockMap m_block_index node::BlockManager::GUARDED_BY ( cs_main )

◆ InsertBlockIndex()

CBlockIndex * node::BlockManager::InsertBlockIndex ( const BlockHash & hash )

Create a new block index entry for a given block hash.

Definition at line 227 of file blockstorage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsPruneMode()

bool node::BlockManager::IsPruneMode ( ) const

inline

Whether running in -prune mode.

Definition at line 198 of file blockstorage.h.

Here is the caller graph for this function:

◆ LoadBlockIndex()

bool node::BlockManager::LoadBlockIndex ( )

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 242 of file blockstorage.cpp.

Here is the call graph for this function:

◆ LoadingBlocks()

bool node::BlockManager::LoadingBlocks ( ) const

inline

Definition at line 207 of file blockstorage.h.

Here is the caller graph for this function:

◆ LookupBlockIndex() [1/2]

const CBlockIndex * node::BlockManager::LookupBlockIndex ( const BlockHash & hash ) const

Definition at line 50 of file blockstorage.cpp.

Here is the call graph for this function:

◆ LookupBlockIndex() [2/2]

CBlockIndex * node::BlockManager::LookupBlockIndex ( const BlockHash & hash )

Definition at line 44 of file blockstorage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PruneOneBlockFile()

void node::BlockManager::PruneOneBlockFile ( const int fileNumber )

Mark one block file as pruned (modify associated database entries)

Definition at line 97 of file blockstorage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ Chainstate

friend node::BlockManager::Chainstate

private

Definition at line 68 of file blockstorage.h.

◆ ChainstateManager

friend node::BlockManager::ChainstateManager

private

Definition at line 69 of file blockstorage.h.

◆ cs_LastBlockFile

RecursiveMutex node::BlockManager::cs_LastBlockFile

private

Definition at line 122 of file blockstorage.h.

◆ m_blockfile_info

std::vector<CBlockFileInfo> node::BlockManager::m_blockfile_info

private

Definition at line 123 of file blockstorage.h.

◆ m_blocks_unlinked

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 160 of file blockstorage.h.

◆ m_check_for_pruning

bool node::BlockManager::m_check_for_pruning = false

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 130 of file blockstorage.h.

◆ m_dirty_blockindex

std::set<CBlockIndex *> node::BlockManager::m_dirty_blockindex

private

Dirty block index entries.

Definition at line 135 of file blockstorage.h.

◆ m_dirty_fileinfo

std::set<int> node::BlockManager::m_dirty_fileinfo

private

Dirty block file entries.

Definition at line 138 of file blockstorage.h.

◆ m_have_pruned

bool node::BlockManager::m_have_pruned = false

True if any block files have ever been pruned.

Definition at line 219 of file blockstorage.h.

◆ m_importing

std::atomic<bool> node::BlockManager::m_importing {false}

Definition at line 148 of file blockstorage.h.

◆ m_last_blockfile

int node::BlockManager::m_last_blockfile = 0

private

Definition at line 124 of file blockstorage.h.

◆ m_opts

const kernel::BlockManagerOpts node::BlockManager::m_opts

private

Definition at line 140 of file blockstorage.h.

◆ m_prune_mode

const bool node::BlockManager::m_prune_mode

private

Definition at line 132 of file blockstorage.h.

◆ PRUNE_TARGET_MANUAL

constexpr auto node::BlockManager::PRUNE_TARGET_MANUAL

staticconstexpr

Initial value:

{

std::numeric_limits<uint64_t>::max()}

Definition at line 204 of file blockstorage.h.

◆ SaveBlockToDisk

FlatFilePos node::BlockManager::SaveBlockToDisk

Store block on disk.

If dbp is not nullptr, then it provides the known position of the block within a block file on disk.

Definition at line 194 of file blockstorage.h.

The documentation for this class was generated from the following files:

/work/src/node/blockstorage.h
/work/src/node/blockstorage.cpp

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Options

Constructor & Destructor Documentation

◆ BlockManager()

Member Function Documentation

◆ CalculateCurrentUsage()

◆ FindBlockPos()

◆ FindFilesToPrune()

◆ FindFilesToPruneManual()

◆ FindUndoPos()

◆ FlushBlockFile()

◆ FlushUndoFile()

◆ GetBlockFileInfo()

◆ GetConsensus()

◆ GetLastCheckpoint()

◆ GetParams()

◆ GetPruneTarget()

◆ GUARDED_BY() [1/2]

◆ GUARDED_BY() [2/2]

◆ InsertBlockIndex()

◆ IsPruneMode()

◆ LoadBlockIndex()

◆ LoadingBlocks()

◆ LookupBlockIndex() [1/2]

◆ LookupBlockIndex() [2/2]

◆ PruneOneBlockFile()

Member Data Documentation

◆ Chainstate

◆ ChainstateManager

◆ cs_LastBlockFile

◆ m_blockfile_info

◆ m_blocks_unlinked

◆ m_check_for_pruning

◆ m_dirty_blockindex

◆ m_dirty_fileinfo

◆ m_have_pruned

◆ m_importing

◆ m_last_blockfile

◆ m_opts

◆ m_prune_mode

◆ PRUNE_TARGET_MANUAL

◆ SaveBlockToDisk