#include <DatabaseNodeImp.h>

Inheritance diagram for ripple::NodeStore::DatabaseNodeImp:

Collaboration diagram for ripple::NodeStore::DatabaseNodeImp:

[legend]

Public Member Functions
	DatabaseNodeImp ()=delete

	DatabaseNodeImp (DatabaseNodeImp const &)=delete

DatabaseNodeImp &	operator= (DatabaseNodeImp const &)=delete

	DatabaseNodeImp (Scheduler &scheduler, int readThreads, std::shared_ptr< Backend > backend, Section const &config, beast::Journal j)

	~DatabaseNodeImp ()

std::string	getName () const override
	Retrieve the name associated with this backend.

std::int32_t	getWriteLoad () const override
	Retrieve the estimated number of pending write operations.

void	importDatabase (Database &source) override
	Import objects from another database.

void	store (NodeObjectType type, Blob &&data, uint256 const &hash, std::uint32_t) override
	Store the object.

bool	isSameDB (std::uint32_t, std::uint32_t) override

void	sync () override

std::vector< std::shared_ptr< NodeObject > >	fetchBatch (std::vector< uint256 > const &hashes)

void	asyncFetch (uint256 const &hash, std::uint32_t ledgerSeq, std::function< void(std::shared_ptr< NodeObject > const &)> &&callback) override
	Fetch an object without waiting.

void	sweep () override
	Remove expired entries from the positive and negative caches.

std::shared_ptr< NodeObject >	fetchNodeObject (uint256 const &hash, std::uint32_t ledgerSeq=0, FetchType fetchType=FetchType::synchronous, bool duplicate=false)
	Fetch a node object.

std::uint64_t	getStoreCount () const
	Gather statistics pertaining to read and write activities.

std::uint32_t	getFetchTotalCount () const

std::uint32_t	getFetchHitCount () const

std::uint64_t	getStoreSize () const

std::uint32_t	getFetchSize () const

void	getCountsJson (Json::Value &obj)

int	fdRequired () const
	Returns the number of file descriptors the database expects to need.

virtual void	stop ()

bool	isStopping () const

std::uint32_t	earliestLedgerSeq () const noexcept

Protected Member Functions
void	storeStats (std::uint64_t count, std::uint64_t sz)

void	importInternal (Backend &dstBackend, Database &srcDB)

void	updateFetchMetrics (uint64_t fetches, uint64_t hits, uint64_t duration)

Protected Attributes
beast::Journal const	j_

Scheduler &	scheduler_

int	fdRequired_ {0}

std::atomic< std::uint32_t >	fetchHitCount_ {0}

std::atomic< std::uint32_t >	fetchSz_ {0}

std::uint32_t const	earliestLedgerSeq_

int const	requestBundle_

Private Member Functions
std::shared_ptr< NodeObject >	fetchNodeObject (uint256 const &hash, std::uint32_t, FetchReport &fetchReport, bool duplicate) override

void	for_each (std::function< void(std::shared_ptr< NodeObject >)> f) override
	Visit every object in the database This is usually called during import.

void	threadEntry ()

Private Attributes
std::shared_ptr< TaggedCache< uint256, NodeObject > >	cache_

std::shared_ptr< Backend >	backend_

std::atomic< std::uint64_t >	storeCount_ {0}

std::atomic< std::uint64_t >	storeSz_ {0}

std::atomic< std::uint64_t >	fetchTotalCount_ {0}

std::atomic< std::uint64_t >	fetchDurationUs_ {0}

std::atomic< std::uint64_t >	storeDurationUs_ {0}

std::mutex	readLock_

std::condition_variable	readCondVar_

std::map< uint256, std::vector< std::pair< std::uint32_t, std::function< void(std::shared_ptr< NodeObject > const &)> > > >	read_

std::atomic< bool >	readStopping_ = false

std::atomic< int >	readThreads_ = 0

std::atomic< int >	runningThreads_ = 0

Detailed Description

Definition at line 31 of file DatabaseNodeImp.h.

Constructor & Destructor Documentation

◆ DatabaseNodeImp() [1/3]

ripple::NodeStore::DatabaseNodeImp::DatabaseNodeImp ( )

delete

◆ DatabaseNodeImp() [2/3]

ripple::NodeStore::DatabaseNodeImp::DatabaseNodeImp ( DatabaseNodeImp const & )

delete

◆ DatabaseNodeImp() [3/3]

ripple::NodeStore::DatabaseNodeImp::DatabaseNodeImp	(	Scheduler &	scheduler,
		int	readThreads,
		std::shared_ptr< Backend >	backend,
		Section const &	config,
		beast::Journal	j
	)

Definition at line 39 of file DatabaseNodeImp.h.

◆ ~DatabaseNodeImp()

ripple::NodeStore::DatabaseNodeImp::~DatabaseNodeImp ( )

Definition at line 86 of file DatabaseNodeImp.h.

Member Function Documentation

◆ operator=()

DatabaseNodeImp & ripple::NodeStore::DatabaseNodeImp::operator= ( DatabaseNodeImp const & )

delete

◆ getName()

std::string ripple::NodeStore::DatabaseNodeImp::getName ( ) const

overridevirtual

Retrieve the name associated with this backend.

This is used for diagnostics and may not reflect the actual path or paths used by the underlying backend.

Implements ripple::NodeStore::Database.

Definition at line 92 of file DatabaseNodeImp.h.

◆ getWriteLoad()

std::int32_t ripple::NodeStore::DatabaseNodeImp::getWriteLoad ( ) const

overridevirtual

Retrieve the estimated number of pending write operations.

This is used for diagnostics.

Implements ripple::NodeStore::Database.

Definition at line 98 of file DatabaseNodeImp.h.

◆ importDatabase()

void ripple::NodeStore::DatabaseNodeImp::importDatabase ( Database & source )

overridevirtual

Import objects from another database.

Implements ripple::NodeStore::Database.

Definition at line 104 of file DatabaseNodeImp.h.

◆ store()

void ripple::NodeStore::DatabaseNodeImp::store	(	NodeObjectType	type,
		Blob &&	data,
		uint256 const &	hash,
		std::uint32_t	ledgerSeq
	)

overridevirtual

Store the object.

The caller's Blob parameter is overwritten.

Parameters

type	The type of object.
data	The payload of the object. The caller's variable is overwritten.
hash	The 256-bit hash of the payload data.
ledgerSeq	The sequence of the ledger the object belongs to.

Returns: true if the object was stored?

Implements ripple::NodeStore::Database.

Definition at line 26 of file DatabaseNodeImp.cpp.

◆ isSameDB()

bool ripple::NodeStore::DatabaseNodeImp::isSameDB	(	std::uint32_t	,
		std::uint32_t
	)

overridevirtual

Implements ripple::NodeStore::Database.

Definition at line 114 of file DatabaseNodeImp.h.

◆ sync()

void ripple::NodeStore::DatabaseNodeImp::sync ( )

overridevirtual

Implements ripple::NodeStore::Database.

Definition at line 121 of file DatabaseNodeImp.h.

◆ fetchBatch()

std::vector< std::shared_ptr< NodeObject > > ripple::NodeStore::DatabaseNodeImp::fetchBatch ( std::vector< uint256 > const & hashes )

Definition at line 145 of file DatabaseNodeImp.cpp.

◆ asyncFetch()

void ripple::NodeStore::DatabaseNodeImp::asyncFetch	(	uint256 const &	hash,
		std::uint32_t	ledgerSeq,
		std::function< void(std::shared_ptr< NodeObject > const &)> &&	callback
	)

overridevirtual

Fetch an object without waiting.

If I/O is required to determine whether or not the object is present, false is returned. Otherwise, true is returned and object is set to refer to the object, or nullptr if the object is not present. If I/O is required, the I/O is scheduled and true is returned

Note: This can be called concurrently.

Parameters

hash	The key of the object to retrieve
ledgerSeq	The sequence of the ledger where the object is stored.
callback	Callback function when read completes

Reimplemented from ripple::NodeStore::Database.

Definition at line 47 of file DatabaseNodeImp.cpp.

◆ sweep()

void ripple::NodeStore::DatabaseNodeImp::sweep ( )

overridevirtual

Remove expired entries from the positive and negative caches.

Implements ripple::NodeStore::Database.

Definition at line 65 of file DatabaseNodeImp.cpp.

◆ fetchNodeObject() [1/2]

std::shared_ptr< NodeObject > ripple::NodeStore::DatabaseNodeImp::fetchNodeObject	(	uint256 const &	hash,
		std::uint32_t	,
		FetchReport &	fetchReport,
		bool	duplicate
	)

overrideprivatevirtual

Implements ripple::NodeStore::Database.

Definition at line 72 of file DatabaseNodeImp.cpp.

◆ for_each()

void ripple::NodeStore::DatabaseNodeImp::for_each ( std::function< void(std::shared_ptr< NodeObject >)> f )

overrideprivatevirtual

Visit every object in the database This is usually called during import.

Note: This routine will not be called concurrently with itself or other methods.

See also: import

Implements ripple::NodeStore::Database.

Definition at line 154 of file DatabaseNodeImp.h.

◆ fetchNodeObject() [2/2]

std::shared_ptr< NodeObject > ripple::NodeStore::Database::fetchNodeObject	(	uint256 const &	hash,
		std::uint32_t	ledgerSeq = `0`,
		FetchType	fetchType = `FetchType::synchronous`,
		bool	duplicate = `false`
	)

inherited

Fetch a node object.

If the object is known to be not in the database, isn't found in the database during the fetch, or failed to load correctly during the fetch, nullptr is returned.

Note: This can be called concurrently.

Parameters

hash	The key of the object to retrieve.
ledgerSeq	The sequence of the ledger where the object is stored.
fetchType	the type of fetch, synchronous or asynchronous.

Returns: The object, or nullptr if it couldn't be retrieved.

Definition at line 241 of file Database.cpp.

◆ getStoreCount()

std::uint64_t ripple::NodeStore::Database::getStoreCount ( ) const

inherited

Gather statistics pertaining to read and write activities.

Parameters

obj	Json object reference into which to place counters.

Definition at line 174 of file Database.h.

◆ getFetchTotalCount()

std::uint32_t ripple::NodeStore::Database::getFetchTotalCount ( ) const

inherited

Definition at line 180 of file Database.h.

◆ getFetchHitCount()

std::uint32_t ripple::NodeStore::Database::getFetchHitCount ( ) const

inherited

Definition at line 186 of file Database.h.

◆ getStoreSize()

std::uint64_t ripple::NodeStore::Database::getStoreSize ( ) const

inherited

Definition at line 192 of file Database.h.

◆ getFetchSize()

std::uint32_t ripple::NodeStore::Database::getFetchSize ( ) const

inherited

Definition at line 198 of file Database.h.

◆ getCountsJson()

void ripple::NodeStore::Database::getCountsJson ( Json::Value & obj )

inherited

Definition at line 268 of file Database.cpp.

◆ fdRequired()

int ripple::NodeStore::Database::fdRequired ( ) const

inherited

Returns the number of file descriptors the database expects to need.

Definition at line 208 of file Database.h.

◆ stop()

void ripple::NodeStore::Database::stop ( )

virtualinherited

Definition at line 150 of file Database.cpp.

◆ isStopping()

bool ripple::NodeStore::Database::isStopping ( ) const

inherited

Definition at line 144 of file Database.cpp.

◆ earliestLedgerSeq()

std::uint32_t ripple::NodeStore::Database::earliestLedgerSeq ( ) const

noexceptinherited

Returns: The earliest ledger sequence allowed

Definition at line 222 of file Database.h.

◆ storeStats()

void ripple::NodeStore::Database::storeStats	(	std::uint64_t	count,
		std::uint64_t	sz
	)

protectedinherited

Definition at line 249 of file Database.h.

◆ importInternal()

void ripple::NodeStore::Database::importInternal	(	Backend &	dstBackend,
		Database &	srcDB
	)

protectedinherited

Definition at line 200 of file Database.cpp.

◆ updateFetchMetrics()

void ripple::NodeStore::Database::updateFetchMetrics	(	uint64_t	fetches,
		uint64_t	hits,
		uint64_t	duration
	)

protectedinherited

Definition at line 263 of file Database.h.

◆ threadEntry()

void ripple::NodeStore::Database::threadEntry ( )

privateinherited

Member Data Documentation

◆ cache_

std::shared_ptr<TaggedCache<uint256, NodeObject> > ripple::NodeStore::DatabaseNodeImp::cache_

private

Definition at line 142 of file DatabaseNodeImp.h.

◆ backend_

std::shared_ptr<Backend> ripple::NodeStore::DatabaseNodeImp::backend_

private

Definition at line 144 of file DatabaseNodeImp.h.

◆ j_

beast::Journal const ripple::NodeStore::Database::j_

protectedinherited

Definition at line 228 of file Database.h.

◆ scheduler_

Scheduler& ripple::NodeStore::Database::scheduler_

protectedinherited

Definition at line 229 of file Database.h.

◆ fdRequired_

int ripple::NodeStore::Database::fdRequired_ {0}

protectedinherited

Definition at line 230 of file Database.h.

◆ fetchHitCount_

std::atomic<std::uint32_t> ripple::NodeStore::Database::fetchHitCount_ {0}

protectedinherited

Definition at line 232 of file Database.h.

◆ fetchSz_

std::atomic<std::uint32_t> ripple::NodeStore::Database::fetchSz_ {0}

protectedinherited

Definition at line 233 of file Database.h.

◆ earliestLedgerSeq_

std::uint32_t const ripple::NodeStore::Database::earliestLedgerSeq_

protectedinherited

Definition at line 241 of file Database.h.

◆ requestBundle_

int const ripple::NodeStore::Database::requestBundle_

protectedinherited

Definition at line 246 of file Database.h.

◆ storeCount_

std::atomic<std::uint64_t> ripple::NodeStore::Database::storeCount_ {0}

privateinherited

Definition at line 271 of file Database.h.

◆ storeSz_

std::atomic<std::uint64_t> ripple::NodeStore::Database::storeSz_ {0}

privateinherited

Definition at line 272 of file Database.h.

◆ fetchTotalCount_

std::atomic<std::uint64_t> ripple::NodeStore::Database::fetchTotalCount_ {0}

privateinherited

Definition at line 273 of file Database.h.

◆ fetchDurationUs_

std::atomic<std::uint64_t> ripple::NodeStore::Database::fetchDurationUs_ {0}

privateinherited

Definition at line 274 of file Database.h.

◆ storeDurationUs_

std::atomic<std::uint64_t> ripple::NodeStore::Database::storeDurationUs_ {0}

privateinherited

Definition at line 275 of file Database.h.

◆ readLock_

std::mutex ripple::NodeStore::Database::readLock_

mutableprivateinherited

Definition at line 277 of file Database.h.

◆ readCondVar_

std::condition_variable ripple::NodeStore::Database::readCondVar_

privateinherited

Definition at line 278 of file Database.h.

◆ read_

std::map< uint256, std::vector<std::pair< std::uint32_t, std::function<void(std::shared_ptr<NodeObject> const&)> > > > ripple::NodeStore::Database::read_

privateinherited

Definition at line 286 of file Database.h.

◆ readStopping_

std::atomic<bool> ripple::NodeStore::Database::readStopping_ = false

privateinherited

Definition at line 288 of file Database.h.

◆ readThreads_

std::atomic<int> ripple::NodeStore::Database::readThreads_ = 0

privateinherited

Definition at line 289 of file Database.h.

◆ runningThreads_

std::atomic<int> ripple::NodeStore::Database::runningThreads_ = 0

privateinherited

Definition at line 290 of file Database.h.

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DatabaseNodeImp() [1/3]

◆ DatabaseNodeImp() [2/3]

◆ DatabaseNodeImp() [3/3]

◆ ~DatabaseNodeImp()

Member Function Documentation

◆ operator=()

◆ getName()

◆ getWriteLoad()

◆ importDatabase()

◆ store()

◆ isSameDB()

◆ sync()

◆ fetchBatch()

◆ asyncFetch()

◆ sweep()

◆ fetchNodeObject() [1/2]

◆ for_each()

◆ fetchNodeObject() [2/2]

◆ getStoreCount()

◆ getFetchTotalCount()

◆ getFetchHitCount()

◆ getStoreSize()

◆ getFetchSize()

◆ getCountsJson()

◆ fdRequired()

◆ stop()

◆ isStopping()

◆ earliestLedgerSeq()

◆ storeStats()

◆ importInternal()

◆ updateFetchMetrics()

◆ threadEntry()

Member Data Documentation

◆ cache_

◆ backend_

◆ j_

◆ scheduler_

◆ fdRequired_

◆ fetchHitCount_

◆ fetchSz_

◆ earliestLedgerSeq_

◆ requestBundle_

◆ storeCount_

◆ storeSz_

◆ fetchTotalCount_

◆ fetchDurationUs_

◆ storeDurationUs_

◆ readLock_

◆ readCondVar_

◆ read_

◆ readStopping_

◆ readThreads_

◆ runningThreads_