BlockManager Class Reference

Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-work tip is. More...

#include <validation.h>

Public Member Functions
BlockMap m_block_index	GUARDED_BY (cs_main)
bool	LoadBlockIndex (const Consensus::Params &consensus_params, CBlockTreeDB &blocktree, std::set< CBlockIndex *, CBlockIndexWorkComparator > &block_index_candidates) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
	Load the blocktree off disk and into memory. More...
void	Unload () EXCLUSIVE_LOCKS_REQUIRED(cs_main)
	Clear all data members. More...
CBlockIndex *	AddToBlockIndex (const CBlockHeader &block) EXCLUSIVE_LOCKS_REQUIRED(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...
bool	AcceptBlockHeader (const CBlockHeader &block, BlockValidationState &state, const CChainParams &chainparams, CBlockIndex **ppindex) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
	If a block header hasn't already been seen, call CheckBlockHeader on it, ensure that it doesn't descend from an invalid block, and then add it to m_block_index. More...
CBlockIndex *	LookupBlockIndex (const uint256 &hash) const EXCLUSIVE_LOCKS_REQUIRED(cs_main)
CBlockIndex *	FindForkInGlobalIndex (const CChain &chain, const CBlockLocator &locator) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
	Find the last common block between the parameter chain and a locator. More...
CBlockIndex *	GetLastCheckpoint (const CCheckpointData &data) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
	Returns last CBlockIndex* that is a checkpoint. More...
int	GetSpendHeight (const CCoinsViewCache &inputs) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
	Return the spend height, which is one more than the inputs.GetBestBlock(). More...
	~BlockManager ()

Public Attributes
std::set< CBlockIndex * >	m_failed_blocks
	In order to efficiently track invalidity of headers, we keep the set of blocks which we tried to connect and found to be invalid here (ie which were set to BLOCK_FAILED_VALID since the last restart). More...
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...

Private Member Functions
void	FindFilesToPruneManual (std::set< int > &setFilesToPrune, int nManualPruneHeight, int chain_tip_height)
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	CChainState

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 CChainState - information about, e.g., candidate tips is not maintained here.

Definition at line 364 of file validation.h.

Constructor & Destructor Documentation

~BlockManager()

BlockManager::~BlockManager ( )

inline

Definition at line 467 of file validation.h.

Here is the call graph for this function:

Member Function Documentation

AcceptBlockHeader()

bool BlockManager::AcceptBlockHeader	(	const CBlockHeader &	block,
		BlockValidationState &	state,
		const CChainParams &	chainparams,
		CBlockIndex **	ppindex
	)

If a block header hasn't already been seen, call CheckBlockHeader on it, ensure that it doesn't descend from an invalid block, and then add it to m_block_index.

Definition at line 3468 of file validation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

AddToBlockIndex()

CBlockIndex * BlockManager::AddToBlockIndex

(

const CBlockHeader &

block

)

Definition at line 3022 of file validation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

FindFilesToPrune()

void 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 global fCheckForPruning 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 (100000 on mainnet, 1000 on testnet, 1000 on regtest). 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 3832 of file validation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

FindFilesToPruneManual()

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

private

Definition at line 3797 of file validation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

FindForkInGlobalIndex()

CBlockIndex * BlockManager::FindForkInGlobalIndex	(	const CChain &	chain,
		const CBlockLocator &	locator
	)

Find the last common block between the parameter chain and a locator.

Definition at line 181 of file validation.cpp.

Here is the call graph for this function:

GetLastCheckpoint()

CBlockIndex * BlockManager::GetLastCheckpoint

(

const CCheckpointData &

data

)

Returns last CBlockIndex* that is a checkpoint.

Definition at line 3313 of file validation.cpp.

Here is the call graph for this function:

GetSpendHeight()

int BlockManager::GetSpendHeight

(

const CCoinsViewCache &

inputs

)

Return the spend height, which is one more than the inputs.GetBestBlock().

While checking, GetBestBlock() refers to the parent block. (protected by cs_main) This is also true for mempool checks.

Definition at line 1330 of file validation.cpp.

Here is the call graph for this function:

GUARDED_BY()

BlockMap m_block_index BlockManager::GUARDED_BY

(

cs_main

)

InsertBlockIndex()

CBlockIndex * BlockManager::InsertBlockIndex

(

const uint256 &

hash

)

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

Definition at line 3915 of file validation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadBlockIndex()

bool BlockManager::LoadBlockIndex	(	const Consensus::Params &	consensus_params,
		CBlockTreeDB &	blocktree,
		std::set< CBlockIndex *, CBlockIndexWorkComparator > &	block_index_candidates
	)

Load the blocktree off disk and into memory.

Populate certain metadata per index entry (nStatus, nChainWork, nTimeMax, etc.) as well as peripheral collections like setDirtyBlockIndex.

Parameters

[out]

block_index_candidates

Fill this set with any valid blocks for which we've downloaded all transactions.

Definition at line 3935 of file validation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

LookupBlockIndex()

CBlockIndex * BlockManager::LookupBlockIndex

(

const uint256 &

hash

)

const

Definition at line 173 of file validation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

PruneOneBlockFile()

void BlockManager::PruneOneBlockFile

(

const int

fileNumber

)

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

Definition at line 3752 of file validation.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Unload()

void BlockManager::Unload

(

)

Clear all data members.

Definition at line 3990 of file validation.cpp.

Here is the caller graph for this function:

Member Data Documentation

CChainState

friend BlockManager::CChainState

private

Definition at line 366 of file validation.h.

m_blocks_unlinked

std::multimap<CBlockIndex*, CBlockIndex*> 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 416 of file validation.h.

m_failed_blocks

std::set<CBlockIndex*> BlockManager::m_failed_blocks

In order to efficiently track invalidity of headers, we keep the set of blocks which we tried to connect and found to be invalid here (ie which were set to BLOCK_FAILED_VALID since the last restart).

We can then walk this set and check if a new header is a descendant of something in this set, preventing us from having to walk m_block_index when we try to connect a bad block and fail.

While this is more complicated than marking everything which descends from an invalid block as invalid at the time we discover it to be invalid, doing so would require walking all of m_block_index to find all descendants. Since this case should be very rare, keeping track of all BLOCK_FAILED_VALID blocks in a set should be just fine and work just as well.

Because we already walk m_block_index in height-order at startup, we go ahead and mark descendants of invalid blocks as FAILED_CHILD at that time, instead of putting things in this set.

Definition at line 410 of file validation.h.

---

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

• src/validation.h
• src/validation.cpp