CCoinsView backed by the coin database (chainstate/) More...

#include <txdb.h>

Inheritance diagram for CCoinsViewDB:

Collaboration diagram for CCoinsViewDB:

Public Member Functions
	CCoinsViewDB (DBParams db_params, CoinsViewOptions options)

	~CCoinsViewDB () override

std::optional< Coin >	GetCoin (const COutPoint &outpoint) const override
	Retrieve the Coin (unspent transaction output) for a given outpoint. More...

std::optional< Coin >	PeekCoin (const COutPoint &outpoint) const override
	Retrieve the Coin (unspent transaction output) for a given outpoint, without caching results. More...

bool	HaveCoin (const COutPoint &outpoint) const override
	Just check whether a given outpoint is unspent. More...

uint256	GetBestBlock () const override
	Retrieve the block hash whose state this CCoinsView currently represents. More...

std::vector< uint256 >	GetHeadBlocks () const override
	Retrieve the range of blocks that may have been only partially written. More...

void	BatchWrite (CoinsViewCacheCursor &cursor, const uint256 &block_hash) override
	Do a bulk modification (multiple Coin changes + BestBlock change). More...

std::unique_ptr< CCoinsViewCursor >	Cursor () const override
	Get a cursor to iterate over the whole state. Implementations may return nullptr. More...

bool	NeedsUpgrade ()
	Whether an unsupported database format is used. More...

size_t	EstimateSize () const override
	Estimate database size. More...

void	ResizeCache (size_t new_cache_size) EXCLUSIVE_LOCKS_REQUIRED(cs_main
	Dynamically alter the underlying leveldb cache size. More...

std::shared_future< void >	CompactFullAsync () EXCLUSIVE_LOCKS_REQUIRED(cs_main
	Perform a full compaction of the underlying LevelDB on a one-shot background thread. More...

std::optional< std::string >	GetDBProperty (const std::string &property)
	Return an underlying LevelDB property value, if available. More...

Public Member Functions inherited from CCoinsView
virtual	~CCoinsView ()=default
	As we use CCoinsViews polymorphically, have a virtual destructor. More...

virtual std::optional< Coin >	GetCoin (const COutPoint &outpoint) const =0
	Retrieve the Coin (unspent transaction output) for a given outpoint. More...

virtual std::optional< Coin >	PeekCoin (const COutPoint &outpoint) const =0
	Retrieve the Coin (unspent transaction output) for a given outpoint, without caching results. More...

virtual bool	HaveCoin (const COutPoint &outpoint) const =0
	Just check whether a given outpoint is unspent. More...

virtual uint256	GetBestBlock () const =0
	Retrieve the block hash whose state this CCoinsView currently represents. More...

virtual std::vector< uint256 >	GetHeadBlocks () const =0
	Retrieve the range of blocks that may have been only partially written. More...

virtual void	BatchWrite (CoinsViewCacheCursor &cursor, const uint256 &block_hash)=0
	Do a bulk modification (multiple Coin changes + BestBlock change). More...

virtual std::unique_ptr< CCoinsViewCursor >	Cursor () const =0
	Get a cursor to iterate over the whole state. Implementations may return nullptr. More...

virtual size_t	EstimateSize () const =0
	Estimate database size. More...

Public Attributes
void	!m_db_mutex

std::shared_future< void >	!m_db_mutex

Protected Attributes
DBParams	m_db_params

CoinsViewOptions	m_options

Mutex	m_db_mutex
	Prevents CompactFull() from using m_db while ResizeCache() replaces it. More...

std::unique_ptr< CDBWrapper >	m_db

std::shared_future< void >	m_compaction

Detailed Description

CCoinsView backed by the coin database (chainstate/)

Definition at line 36 of file txdb.h.

Constructor & Destructor Documentation

◆ CCoinsViewDB()

CCoinsViewDB::CCoinsViewDB	(	DBParams	db_params,
		CoinsViewOptions	options
	)

explicit

Definition at line 58 of file txdb.cpp.

◆ ~CCoinsViewDB()

CCoinsViewDB::~CCoinsViewDB ( )

override

Definition at line 63 of file txdb.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ BatchWrite()

void CCoinsViewDB::BatchWrite	(	CoinsViewCacheCursor &	cursor,
		const uint256 &	block_hash
	)

overridevirtual

Do a bulk modification (multiple Coin changes + BestBlock change).

The passed cursor is used to iterate through the coins.

Implements CCoinsView.

Definition at line 122 of file txdb.cpp.

Here is the call graph for this function:

◆ CompactFullAsync()

std::shared_future< void > CCoinsViewDB::CompactFullAsync ( )

Perform a full compaction of the underlying LevelDB on a one-shot background thread.

Definition at line 198 of file txdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Cursor()

std::unique_ptr< CCoinsViewCursor > CCoinsViewDB::Cursor ( ) const

overridevirtual

Get a cursor to iterate over the whole state. Implementations may return nullptr.

Implements CCoinsView.

Definition at line 240 of file txdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EstimateSize()

size_t CCoinsViewDB::EstimateSize ( ) const

overridevirtual

Estimate database size.

Implements CCoinsView.

Definition at line 188 of file txdb.cpp.

◆ GetBestBlock()

uint256 CCoinsViewDB::GetBestBlock ( ) const

overridevirtual

Retrieve the block hash whose state this CCoinsView currently represents.

Implements CCoinsView.

Definition at line 107 of file txdb.cpp.

Here is the caller graph for this function:

◆ GetCoin()

std::optional< Coin > CCoinsViewDB::GetCoin ( const COutPoint & outpoint ) const

overridevirtual

Retrieve the Coin (unspent transaction output) for a given outpoint.

May populate the cache. Use PeekCoin() to perform a non-caching lookup.

Implements CCoinsView.

Definition at line 88 of file txdb.cpp.

Here is the caller graph for this function:

◆ GetDBProperty()

std::optional< std::string > CCoinsViewDB::GetDBProperty ( const std::string & property )

Return an underlying LevelDB property value, if available.

Definition at line 193 of file txdb.cpp.

◆ GetHeadBlocks()

std::vector< uint256 > CCoinsViewDB::GetHeadBlocks ( ) const

overridevirtual

Retrieve the range of blocks that may have been only partially written.

If the database is in a consistent state, the result is the empty vector. Otherwise, a two-element vector is returned consisting of the new and the old block hash, in that order.

Implements CCoinsView.

Definition at line 114 of file txdb.cpp.

Here is the caller graph for this function:

◆ HaveCoin()

bool CCoinsViewDB::HaveCoin ( const COutPoint & outpoint ) const

overridevirtual

Just check whether a given outpoint is unspent.

May populate the cache. Use PeekCoin() to perform a non-caching lookup.

Implements CCoinsView.

Definition at line 102 of file txdb.cpp.

Here is the caller graph for this function:

◆ NeedsUpgrade()

bool CCoinsViewDB::NeedsUpgrade ( )

Whether an unsupported database format is used.

Definition at line 37 of file txdb.cpp.

◆ PeekCoin()

std::optional< Coin > CCoinsViewDB::PeekCoin ( const COutPoint & outpoint ) const

overridevirtual

Retrieve the Coin (unspent transaction output) for a given outpoint, without caching results.

Does not populate the cache. Use GetCoin() to cache the result.

Implements CCoinsView.

Definition at line 97 of file txdb.cpp.

Here is the call graph for this function:

◆ ResizeCache()

void CCoinsViewDB::ResizeCache ( size_t new_cache_size )

Dynamically alter the underlying leveldb cache size.

Definition at line 73 of file txdb.cpp.

Member Data Documentation

◆ !m_db_mutex [1/2]

void CCoinsViewDB::!m_db_mutex

Definition at line 62 of file txdb.h.

◆ !m_db_mutex [2/2]

std::shared_future< void > CCoinsViewDB::!m_db_mutex

Definition at line 65 of file txdb.h.

◆ m_compaction

std::shared_future<void> CCoinsViewDB::m_compaction

protected

Definition at line 44 of file txdb.h.

◆ m_db

std::unique_ptr<CDBWrapper> CCoinsViewDB::m_db

protected

Definition at line 43 of file txdb.h.

◆ m_db_mutex

Mutex CCoinsViewDB::m_db_mutex

protected

Prevents CompactFull() from using m_db while ResizeCache() replaces it.

Definition at line 42 of file txdb.h.

◆ m_db_params

DBParams CCoinsViewDB::m_db_params

protected

Definition at line 39 of file txdb.h.

◆ m_options

CoinsViewOptions CCoinsViewDB::m_options

protected

Definition at line 40 of file txdb.h.

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

src/txdb.h
src/txdb.cpp

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CCoinsViewDB()

◆ ~CCoinsViewDB()

Member Function Documentation

◆ BatchWrite()

◆ CompactFullAsync()

◆ Cursor()

◆ EstimateSize()

◆ GetBestBlock()

◆ GetCoin()

◆ GetDBProperty()

◆ GetHeadBlocks()

◆ HaveCoin()

◆ NeedsUpgrade()

◆ PeekCoin()

◆ ResizeCache()

Member Data Documentation

◆ !m_db_mutex [1/2]

◆ !m_db_mutex [2/2]

◆ m_compaction

◆ m_db

◆ m_db_mutex

◆ m_db_params

◆ m_options