Bitcoin Core  27.99.0
P2P Digital Currency
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
CCoinsViewCache Class Reference

CCoinsView that adds a memory cache for transactions to another CCoinsView. More...

#include <coins.h>

Inheritance diagram for CCoinsViewCache:
[legend]
Collaboration diagram for CCoinsViewCache:
[legend]

Public Member Functions

 CCoinsViewCache (CCoinsView *baseIn, bool deterministic=false)
 
 CCoinsViewCache (const CCoinsViewCache &)=delete
 By deleting the copy constructor, we prevent accidentally using it when one intends to create a cache on top of a base cache. More...
 
bool GetCoin (const COutPoint &outpoint, Coin &coin) const override
 Retrieve the Coin (unspent transaction output) for a given outpoint. 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...
 
void SetBestBlock (const uint256 &hashBlock)
 
bool BatchWrite (CCoinsMap &mapCoins, const uint256 &hashBlock, bool erase=true) override
 Do a bulk modification (multiple Coin changes + BestBlock change). More...
 
std::unique_ptr< CCoinsViewCursorCursor () const override
 Get a cursor to iterate over the whole state. More...
 
bool HaveCoinInCache (const COutPoint &outpoint) const
 Check if we have the given utxo already loaded in this cache. More...
 
const CoinAccessCoin (const COutPoint &output) const
 Return a reference to Coin in the cache, or coinEmpty if not found. More...
 
void AddCoin (const COutPoint &outpoint, Coin &&coin, bool possible_overwrite)
 Add a coin. More...
 
void EmplaceCoinInternalDANGER (COutPoint &&outpoint, Coin &&coin)
 Emplace a coin into cacheCoins without performing any checks, marking the emplaced coin as dirty. More...
 
bool SpendCoin (const COutPoint &outpoint, Coin *moveto=nullptr)
 Spend a coin. More...
 
bool Flush ()
 Push the modifications applied to this cache to its base and wipe local state. More...
 
bool Sync ()
 Push the modifications applied to this cache to its base while retaining the contents of this cache (except for spent coins, which we erase). More...
 
void Uncache (const COutPoint &outpoint)
 Removes the UTXO with the given outpoint from the cache, if it is not modified. More...
 
unsigned int GetCacheSize () const
 Calculate the size of the cache (in number of transaction outputs) More...
 
size_t DynamicMemoryUsage () const
 Calculate the size of the cache (in bytes) More...
 
bool HaveInputs (const CTransaction &tx) const
 Check whether all prevouts of the transaction are present in the UTXO set represented by this view. More...
 
void ReallocateCache ()
 Force a reallocation of the cache map. More...
 
void SanityCheck () const
 Run an internal sanity check on the cache data structure. *‍/. More...
 
- Public Member Functions inherited from CCoinsViewBacked
 CCoinsViewBacked (CCoinsView *viewIn)
 
std::vector< uint256GetHeadBlocks () const override
 Retrieve the range of blocks that may have been only partially written. More...
 
void SetBackend (CCoinsView &viewIn)
 
size_t EstimateSize () const override
 Estimate database size (0 if not implemented) More...
 
- Public Member Functions inherited from CCoinsView
virtual ~CCoinsView ()=default
 As we use CCoinsViews polymorphically, have a virtual destructor. More...
 

Protected Attributes

uint256 hashBlock
 Make mutable so that we can "fill the cache" even from Get-methods declared as "const". More...
 
CCoinsMapMemoryResource m_cache_coins_memory_resource {}
 
CCoinsMap cacheCoins
 
size_t cachedCoinsUsage {0}
 
- Protected Attributes inherited from CCoinsViewBacked
CCoinsViewbase
 

Private Member Functions

CCoinsMap::iterator FetchCoin (const COutPoint &outpoint) const
 

Private Attributes

const bool m_deterministic
 

Detailed Description

CCoinsView that adds a memory cache for transactions to another CCoinsView.

Definition at line 228 of file coins.h.

Constructor & Destructor Documentation

◆ CCoinsViewCache() [1/2]

CCoinsViewCache::CCoinsViewCache ( CCoinsView baseIn,
bool  deterministic = false 
)

Definition at line 34 of file coins.cpp.

◆ CCoinsViewCache() [2/2]

CCoinsViewCache::CCoinsViewCache ( const CCoinsViewCache )
delete

By deleting the copy constructor, we prevent accidentally using it when one intends to create a cache on top of a base cache.

Member Function Documentation

◆ AccessCoin()

const Coin & CCoinsViewCache::AccessCoin ( const COutPoint output) const

Return a reference to Coin in the cache, or coinEmpty if not found.

This is more efficient than GetCoin.

Generally, do not hold the reference returned for more than a short scope. While the current implementation allows for modifications to the contents of the cache while holding the reference, this behavior should not be relied on! To be safe, best to not hold the returned reference through any other calls to this cache.

Definition at line 152 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ AddCoin()

void CCoinsViewCache::AddCoin ( const COutPoint outpoint,
Coin &&  coin,
bool  possible_overwrite 
)

Add a coin.

Set possible_overwrite to true if an unspent version may already exist in the cache.

Definition at line 69 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ BatchWrite()

bool CCoinsViewCache::BatchWrite ( CCoinsMap mapCoins,
const uint256 hashBlock,
bool  erase = true 
)
overridevirtual

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

The passed mapCoins can be modified.

Reimplemented from CCoinsViewBacked.

Definition at line 181 of file coins.cpp.

Here is the call graph for this function:

◆ Cursor()

std::unique_ptr<CCoinsViewCursor> CCoinsViewCache::Cursor ( ) const
inlineoverridevirtual

Get a cursor to iterate over the whole state.

Reimplemented from CCoinsViewBacked.

Definition at line 259 of file coins.h.

◆ DynamicMemoryUsage()

size_t CCoinsViewCache::DynamicMemoryUsage ( ) const

Calculate the size of the cache (in bytes)

Definition at line 39 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EmplaceCoinInternalDANGER()

void CCoinsViewCache::EmplaceCoinInternalDANGER ( COutPoint &&  outpoint,
Coin &&  coin 
)

Emplace a coin into cacheCoins without performing any checks, marking the emplaced coin as dirty.

NOT FOR GENERAL USE. Used only when loading coins from a UTXO snapshot.

See also
ChainstateManager::PopulateAndValidateSnapshot()

Definition at line 109 of file coins.cpp.

Here is the caller graph for this function:

◆ FetchCoin()

CCoinsMap::iterator CCoinsViewCache::FetchCoin ( const COutPoint outpoint) const
private
Note
this is marked const, but may actually append to cacheCoins, increasing memory usage.

Definition at line 43 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Flush()

bool CCoinsViewCache::Flush ( )

Push the modifications applied to this cache to its base and wipe local state.

Failure to call this method or Sync() before destruction will cause the changes to be forgotten. If false is returned, the state of this cache (and its backing view) will be undefined.

Definition at line 253 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetBestBlock()

uint256 CCoinsViewCache::GetBestBlock ( ) const
overridevirtual

Retrieve the block hash whose state this CCoinsView currently represents.

Reimplemented from CCoinsViewBacked.

Definition at line 171 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetCacheSize()

unsigned int CCoinsViewCache::GetCacheSize ( ) const

Calculate the size of the cache (in number of transaction outputs)

Definition at line 298 of file coins.cpp.

Here is the caller graph for this function:

◆ GetCoin()

bool CCoinsViewCache::GetCoin ( const COutPoint outpoint,
Coin coin 
) const
overridevirtual

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

Returns true only when an unspent coin was found, which is returned in coin. When false is returned, coin's value is unspecified.

Reimplemented from CCoinsViewBacked.

Definition at line 60 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HaveCoin()

bool CCoinsViewCache::HaveCoin ( const COutPoint outpoint) const
overridevirtual

Just check whether a given outpoint is unspent.

Reimplemented from CCoinsViewBacked.

Definition at line 161 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HaveCoinInCache()

bool CCoinsViewCache::HaveCoinInCache ( const COutPoint outpoint) const

Check if we have the given utxo already loaded in this cache.

The semantics are the same as HaveCoin(), but no calls to the backing CCoinsView are made.

Definition at line 166 of file coins.cpp.

◆ HaveInputs()

bool CCoinsViewCache::HaveInputs ( const CTransaction tx) const

Check whether all prevouts of the transaction are present in the UTXO set represented by this view.

Definition at line 302 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReallocateCache()

void CCoinsViewCache::ReallocateCache ( )

Force a reallocation of the cache map.

This is required when downsizing the cache because the map's allocator may be hanging onto a lot of memory despite having called .clear().

See: https://stackoverflow.com/questions/42114044/how-to-release-unordered-map-memory

Definition at line 314 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SanityCheck()

void CCoinsViewCache::SanityCheck ( ) const

Run an internal sanity check on the cache data structure. *‍/.

Definition at line 324 of file coins.cpp.

Here is the call graph for this function:

◆ SetBestBlock()

void CCoinsViewCache::SetBestBlock ( const uint256 hashBlock)

Definition at line 177 of file coins.cpp.

Here is the caller graph for this function:

◆ SpendCoin()

bool CCoinsViewCache::SpendCoin ( const COutPoint outpoint,
Coin moveto = nullptr 
)

Spend a coin.

Pass moveto in order to get the deleted data. If no unspent output exists for the passed outpoint, this call has no effect.

Definition at line 128 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Sync()

bool CCoinsViewCache::Sync ( )

Push the modifications applied to this cache to its base while retaining the contents of this cache (except for spent coins, which we erase).

Failure to call this method or Flush() before destruction will cause the changes to be forgotten. If false is returned, the state of this cache (and its backing view) will be undefined.

Definition at line 266 of file coins.cpp.

Here is the call graph for this function:

◆ Uncache()

void CCoinsViewCache::Uncache ( const COutPoint outpoint)

Removes the UTXO with the given outpoint from the cache, if it is not modified.

Definition at line 283 of file coins.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ cacheCoins

CCoinsMap CCoinsViewCache::cacheCoins
mutableprotected

Definition at line 240 of file coins.h.

◆ cachedCoinsUsage

size_t CCoinsViewCache::cachedCoinsUsage {0}
mutableprotected

Definition at line 243 of file coins.h.

◆ hashBlock

uint256 CCoinsViewCache::hashBlock
mutableprotected

Make mutable so that we can "fill the cache" even from Get-methods declared as "const".

Definition at line 238 of file coins.h.

◆ m_cache_coins_memory_resource

CCoinsMapMemoryResource CCoinsViewCache::m_cache_coins_memory_resource {}
mutableprotected

Definition at line 239 of file coins.h.

◆ m_deterministic

const bool CCoinsViewCache::m_deterministic
private

Definition at line 231 of file coins.h.


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