#include <DatabaseRotatingImp.h>

Inheritance diagram for xrpl::NodeStore::DatabaseRotatingImp:

[legend]

Collaboration diagram for xrpl::NodeStore::DatabaseRotatingImp:

[legend]

Public Member Functions
	DatabaseRotatingImp ()=delete
	DatabaseRotatingImp (DatabaseRotatingImp const &)=delete
DatabaseRotatingImp &	operator= (DatabaseRotatingImp const &)=delete
	DatabaseRotatingImp (Scheduler &scheduler, int readThreads, std::shared_ptr< Backend > writableBackend, std::shared_ptr< Backend > archiveBackend, Section const &config, beast::Journal j)
	~DatabaseRotatingImp () override
void	rotate (std::unique_ptr< NodeStore::Backend > &&newBackend, std::function< void(std::string const &writableName, std::string const &archiveName)> const &f) override
	Rotates the backends.
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.
bool	isSameDB (std::uint32_t, std::uint32_t) override
void	store (NodeObjectType type, Blob &&data, uint256 const &hash, std::uint32_t) override
	Store the object.
void	sync () override
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.
virtual void	asyncFetch (uint256 const &hash, std::uint32_t ledgerSeq, std::function< void(std::shared_ptr< NodeObject > const &)> &&callback)
	Fetch an object without waiting.
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	forEach (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< Backend >	writableBackend_
std::shared_ptr< Backend >	archiveBackend_
std::mutex	mutex_
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 9 of file DatabaseRotatingImp.h.

Constructor & Destructor Documentation

◆ DatabaseRotatingImp() [1/3]

xrpl::NodeStore::DatabaseRotatingImp::DatabaseRotatingImp ( )

delete

◆ DatabaseRotatingImp() [2/3]

xrpl::NodeStore::DatabaseRotatingImp::DatabaseRotatingImp ( DatabaseRotatingImp const & )

delete

◆ DatabaseRotatingImp() [3/3]

xrpl::NodeStore::DatabaseRotatingImp::DatabaseRotatingImp	(	Scheduler &	scheduler,
		int	readThreads,
		std::shared_ptr< Backend >	writableBackend,
		std::shared_ptr< Backend >	archiveBackend,
		Section const &	config,
		beast::Journal	j )

Definition at line 26 of file DatabaseRotatingImp.cpp.

◆ ~DatabaseRotatingImp()

xrpl::NodeStore::DatabaseRotatingImp::~DatabaseRotatingImp ( )

override

Definition at line 25 of file DatabaseRotatingImp.h.

Member Function Documentation

◆ operator=()

DatabaseRotatingImp & xrpl::NodeStore::DatabaseRotatingImp::operator= ( DatabaseRotatingImp const & )

delete

◆ rotate()

void xrpl::NodeStore::DatabaseRotatingImp::rotate	(	std::unique_ptr< NodeStore::Backend > &&	newBackend,
		std::function< void(std::string const &writableName, std::string const &archiveName)> const &	f )

overridevirtual

Rotates the backends.

Parameters

newBackend	New writable backend
f	A function executed after the rotation outside of lock. The values passed to f will be the new backend database names after rotation.

Implements xrpl::NodeStore::DatabaseRotating.

Definition at line 44 of file DatabaseRotatingImp.cpp.

◆ getName()

std::string xrpl::NodeStore::DatabaseRotatingImp::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 xrpl::NodeStore::Database.

Definition at line 71 of file DatabaseRotatingImp.cpp.

◆ getWriteLoad()

std::int32_t xrpl::NodeStore::DatabaseRotatingImp::getWriteLoad ( ) const

overridevirtual

Retrieve the estimated number of pending write operations.

This is used for diagnostics.

Implements xrpl::NodeStore::Database.

Definition at line 78 of file DatabaseRotatingImp.cpp.

◆ importDatabase()

void xrpl::NodeStore::DatabaseRotatingImp::importDatabase ( Database & source )

overridevirtual

Import objects from another database.

Implements xrpl::NodeStore::Database.

Definition at line 85 of file DatabaseRotatingImp.cpp.

◆ isSameDB()

bool xrpl::NodeStore::DatabaseRotatingImp::isSameDB	(	std::uint32_t	,
		std::uint32_t	)

overridevirtual

Implements xrpl::NodeStore::Database.

Definition at line 46 of file DatabaseRotatingImp.h.

◆ store()

void xrpl::NodeStore::DatabaseRotatingImp::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 xrpl::NodeStore::Database.

Definition at line 103 of file DatabaseRotatingImp.cpp.

◆ sync()

void xrpl::NodeStore::DatabaseRotatingImp::sync ( )

overridevirtual

Implements xrpl::NodeStore::Database.

Definition at line 96 of file DatabaseRotatingImp.cpp.

◆ sweep()

void xrpl::NodeStore::DatabaseRotatingImp::sweep ( )

overridevirtual

Remove expired entries from the positive and negative caches.

Implements xrpl::NodeStore::Database.

Definition at line 117 of file DatabaseRotatingImp.cpp.

◆ fetchNodeObject() [1/2]

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

overrideprivatevirtual

Implements xrpl::NodeStore::Database.

Definition at line 123 of file DatabaseRotatingImp.cpp.

◆ forEach()

void xrpl::NodeStore::DatabaseRotatingImp::forEach ( 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 xrpl::NodeStore::Database.

Definition at line 193 of file DatabaseRotatingImp.cpp.

◆ fetchNodeObject() [2/2]

std::shared_ptr< NodeObject > xrpl::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 231 of file Database.cpp.

◆ asyncFetch()

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

virtualinherited

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 in xrpl::NodeStore::DatabaseNodeImp.

Definition at line 178 of file Database.cpp.

◆ getStoreCount()

std::uint64_t xrpl::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 146 of file Database.h.

◆ getFetchTotalCount()

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

inherited

Definition at line 152 of file Database.h.

◆ getFetchHitCount()

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

inherited

Definition at line 158 of file Database.h.

◆ getStoreSize()

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

inherited

Definition at line 164 of file Database.h.

◆ getFetchSize()

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

inherited

Definition at line 170 of file Database.h.

◆ getCountsJson()

void xrpl::NodeStore::Database::getCountsJson ( json::Value & obj )

inherited

Definition at line 258 of file Database.cpp.

◆ fdRequired()

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

inherited

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

Definition at line 180 of file Database.h.

◆ stop()

void xrpl::NodeStore::Database::stop ( )

virtualinherited

Definition at line 144 of file Database.cpp.

◆ isStopping()

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

inherited

Definition at line 138 of file Database.cpp.

◆ earliestLedgerSeq()

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

nodiscardnoexceptinherited

Returns: The earliest ledger sequence allowed

Definition at line 194 of file Database.h.

◆ storeStats()

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

protectedinherited

Definition at line 221 of file Database.h.

◆ importInternal()

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

protectedinherited

Definition at line 193 of file Database.cpp.

◆ updateFetchMetrics()

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

protectedinherited

Definition at line 233 of file Database.h.

◆ threadEntry()

void xrpl::NodeStore::Database::threadEntry ( )

privateinherited

Member Data Documentation

◆ writableBackend_

std::shared_ptr<Backend> xrpl::NodeStore::DatabaseRotatingImp::writableBackend_

private

Definition at line 62 of file DatabaseRotatingImp.h.

◆ archiveBackend_

std::shared_ptr<Backend> xrpl::NodeStore::DatabaseRotatingImp::archiveBackend_

private

Definition at line 63 of file DatabaseRotatingImp.h.

◆ mutex_

std::mutex xrpl::NodeStore::DatabaseRotatingImp::mutex_

mutableprivate

Definition at line 64 of file DatabaseRotatingImp.h.

◆ j_

beast::Journal const xrpl::NodeStore::Database::j_

protectedinherited

Definition at line 200 of file Database.h.

◆ scheduler_

Scheduler& xrpl::NodeStore::Database::scheduler_

protectedinherited

Definition at line 201 of file Database.h.

◆ fdRequired_

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

protectedinherited

Definition at line 202 of file Database.h.

◆ fetchHitCount_

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

protectedinherited

Definition at line 204 of file Database.h.

◆ fetchSz_

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

protectedinherited

Definition at line 205 of file Database.h.

◆ earliestLedgerSeq_

std::uint32_t const xrpl::NodeStore::Database::earliestLedgerSeq_

protectedinherited

Definition at line 213 of file Database.h.

◆ requestBundle_

int const xrpl::NodeStore::Database::requestBundle_

protectedinherited

Definition at line 218 of file Database.h.

◆ storeCount_

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

privateinherited

Definition at line 241 of file Database.h.

◆ storeSz_

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

privateinherited

Definition at line 242 of file Database.h.

◆ fetchTotalCount_

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

privateinherited

Definition at line 243 of file Database.h.

◆ fetchDurationUs_

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

privateinherited

Definition at line 244 of file Database.h.

◆ storeDurationUs_

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

privateinherited

Definition at line 245 of file Database.h.

◆ readLock_

std::mutex xrpl::NodeStore::Database::readLock_

mutableprivateinherited

Definition at line 247 of file Database.h.

◆ readCondVar_

std::condition_variable xrpl::NodeStore::Database::readCondVar_

privateinherited

Definition at line 248 of file Database.h.

◆ read_

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

privateinherited

Definition at line 255 of file Database.h.

◆ readStopping_

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

privateinherited

Definition at line 257 of file Database.h.

◆ readThreads_

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

privateinherited

Definition at line 258 of file Database.h.

◆ runningThreads_

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

privateinherited

Definition at line 259 of file Database.h.

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DatabaseRotatingImp() [1/3]

◆ DatabaseRotatingImp() [2/3]

◆ DatabaseRotatingImp() [3/3]

◆ ~DatabaseRotatingImp()

Member Function Documentation

◆ operator=()

◆ rotate()

◆ getName()

◆ getWriteLoad()

◆ importDatabase()

◆ isSameDB()

◆ store()

◆ sync()

◆ sweep()

◆ fetchNodeObject() [1/2]

◆ forEach()

◆ fetchNodeObject() [2/2]

◆ asyncFetch()

◆ getStoreCount()

◆ getFetchTotalCount()

◆ getFetchHitCount()

◆ getStoreSize()

◆ getFetchSize()

◆ getCountsJson()

◆ fdRequired()

◆ stop()

◆ isStopping()

◆ earliestLedgerSeq()

◆ storeStats()

◆ importInternal()

◆ updateFetchMetrics()

◆ threadEntry()

Member Data Documentation

◆ writableBackend_

◆ archiveBackend_

◆ mutex_

◆ j_

◆ scheduler_

◆ fdRequired_

◆ fetchHitCount_

◆ fetchSz_

◆ earliestLedgerSeq_

◆ requestBundle_

◆ storeCount_

◆ storeSz_

◆ fetchTotalCount_

◆ fetchDurationUs_

◆ storeDurationUs_

◆ readLock_

◆ readCondVar_

◆ read_

◆ readStopping_

◆ readThreads_

◆ runningThreads_