#include <DatabaseRotating.h>

Inheritance diagram for xrpl::node_store::DatabaseRotating:

[legend]

Collaboration diagram for xrpl::node_store::DatabaseRotating:

[legend]

Public Member Functions
	DatabaseRotating (Scheduler &scheduler, int readThreads, Section const &config, beast::Journal journal)
virtual void	rotate (std::unique_ptr< node_store::Backend > &&newBackend, std::function< void(std::string const &writableName, std::string const &archiveName)> const &f)=0
	Rotates the backends.
virtual void	setRotationInFlight (bool inFlight)=0
	Marks an online-delete rotation as in progress (or completed).
virtual std::string	getName () const =0
	Retrieve the name associated with this backend.
virtual void	importDatabase (Database &source)=0
	Import objects from another database.
virtual std::int32_t	getWriteLoad () const =0
	Retrieve the estimated number of pending write operations.
virtual void	store (NodeObjectType type, Blob &&data, uint256 const &hash, std::uint32_t ledgerSeq)=0
	Store the object.
virtual bool	isSameDB (std::uint32_t s1, std::uint32_t s2)=0
	Check if two ledgers are in the same database.
virtual void	sync ()=0
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.
virtual void	sweep ()=0
	Remove expired entries from the positive and negative caches.
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
virtual std::shared_ptr< NodeObject >	fetchNodeObject (uint256 const &hash, std::uint32_t ledgerSeq, FetchReport &fetchReport, bool duplicate)=0
virtual void	forEach (std::function< void(std::shared_ptr< NodeObject >)> f)=0
	Visit every object in the database This is usually called during import.
void	threadEntry ()

Private Attributes
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 19 of file DatabaseRotating.h.

Constructor & Destructor Documentation

◆ DatabaseRotating()

xrpl::node_store::DatabaseRotating::DatabaseRotating	(	Scheduler &	scheduler,
		int	readThreads,
		Section const &	config,
		beast::Journal	journal )

Definition at line 22 of file DatabaseRotating.h.

Member Function Documentation

◆ rotate()

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

pure virtual

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.

Implemented in xrpl::node_store::DatabaseRotatingImp.

◆ setRotationInFlight()

virtual void xrpl::node_store::DatabaseRotating::setRotationInFlight ( bool inFlight )

pure virtual

Marks an online-delete rotation as in progress (or completed).

While in flight, a read served by the archive backend is copied forward into the writable backend even for ordinary (duplicate == false) fetches: the archive is about to be deleted, and a node body canonicalized into caches during the rotation window would otherwise survive only in RAM once the archive is dropped.

Implemented in xrpl::node_store::DatabaseRotatingImp.

◆ getName()

virtual std::string xrpl::node_store::Database::getName ( ) const

pure virtualinherited

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.

Implemented in xrpl::node_store::DatabaseNodeImp, and xrpl::node_store::DatabaseRotatingImp.

◆ importDatabase()

virtual void xrpl::node_store::Database::importDatabase ( Database & source )

pure virtualinherited

Import objects from another database.

Implemented in xrpl::node_store::DatabaseNodeImp, and xrpl::node_store::DatabaseRotatingImp.

◆ getWriteLoad()

virtual std::int32_t xrpl::node_store::Database::getWriteLoad ( ) const

pure virtualinherited

Retrieve the estimated number of pending write operations.

This is used for diagnostics.

Implemented in xrpl::node_store::DatabaseNodeImp, and xrpl::node_store::DatabaseRotatingImp.

◆ store()

virtual void xrpl::node_store::Database::store	(	NodeObjectType	type,
		Blob &&	data,
		uint256 const &	hash,
		std::uint32_t	ledgerSeq )

pure virtualinherited

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?

Implemented in xrpl::node_store::DatabaseNodeImp, and xrpl::node_store::DatabaseRotatingImp.

◆ isSameDB()

virtual bool xrpl::node_store::Database::isSameDB	(	std::uint32_t	s1,
		std::uint32_t	s2 )

pure virtualinherited

Check if two ledgers are in the same database.

If these two sequence numbers map to the same database, the result of a fetch with either sequence number would be identical.

Parameters

s1	The first sequence number
s2	The second sequence number

Returns: 'true' if both ledgers would be in the same DB

Implemented in xrpl::node_store::DatabaseNodeImp, and xrpl::node_store::DatabaseRotatingImp.

◆ sync()

virtual void xrpl::node_store::Database::sync ( )

pure virtualinherited

Implemented in xrpl::node_store::DatabaseNodeImp, and xrpl::node_store::DatabaseRotatingImp.

◆ fetchNodeObject() [1/2]

std::shared_ptr< NodeObject > xrpl::node_store::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 libxrpl/nodestore/Database.cpp.

◆ fetchNodeObject() [2/2]

virtual std::shared_ptr< NodeObject > xrpl::node_store::Database::fetchNodeObject	(	uint256 const &	hash,
		std::uint32_t	ledgerSeq,
		FetchReport &	fetchReport,
		bool	duplicate )

privatepure virtualinherited

Implemented in xrpl::node_store::DatabaseNodeImp, and xrpl::node_store::DatabaseRotatingImp.

◆ asyncFetch()

void xrpl::node_store::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::node_store::DatabaseNodeImp.

Definition at line 178 of file libxrpl/nodestore/Database.cpp.

◆ sweep()

virtual void xrpl::node_store::Database::sweep ( )

pure virtualinherited

Remove expired entries from the positive and negative caches.

Implemented in xrpl::node_store::DatabaseNodeImp, and xrpl::node_store::DatabaseRotatingImp.

◆ getStoreCount()

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

◆ getFetchTotalCount()

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

inherited

Definition at line 177 of file Database.h.

◆ getFetchHitCount()

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

inherited

Definition at line 183 of file Database.h.

◆ getStoreSize()

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

inherited

Definition at line 189 of file Database.h.

◆ getFetchSize()

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

inherited

Definition at line 195 of file Database.h.

◆ getCountsJson()

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

inherited

Definition at line 258 of file libxrpl/nodestore/Database.cpp.

◆ fdRequired()

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

inherited

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

Definition at line 207 of file Database.h.

◆ stop()

void xrpl::node_store::Database::stop ( )

virtualinherited

Definition at line 144 of file libxrpl/nodestore/Database.cpp.

◆ isStopping()

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

inherited

Definition at line 138 of file libxrpl/nodestore/Database.cpp.

◆ earliestLedgerSeq()

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

nodiscardnoexceptinherited

Returns: The earliest ledger sequence allowed

Definition at line 222 of file Database.h.

◆ storeStats()

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

protectedinherited

Definition at line 249 of file Database.h.

◆ importInternal()

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

protectedinherited

Definition at line 193 of file libxrpl/nodestore/Database.cpp.

◆ updateFetchMetrics()

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

protectedinherited

Definition at line 261 of file Database.h.

◆ forEach()

virtual void xrpl::node_store::Database::forEach ( std::function< void(std::shared_ptr< NodeObject >)> f )

privatepure virtualinherited

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

Implemented in xrpl::node_store::DatabaseNodeImp, and xrpl::node_store::DatabaseRotatingImp.

◆ threadEntry()

void xrpl::node_store::Database::threadEntry ( )

privateinherited

Member Data Documentation

◆ j_

beast::Journal const xrpl::node_store::Database::j_

protectedinherited

Definition at line 228 of file Database.h.

◆ scheduler_

Scheduler& xrpl::node_store::Database::scheduler_

protectedinherited

Definition at line 229 of file Database.h.

◆ fdRequired_

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

protectedinherited

Definition at line 230 of file Database.h.

◆ fetchHitCount_

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

protectedinherited

Definition at line 232 of file Database.h.

◆ fetchSz_

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

protectedinherited

Definition at line 233 of file Database.h.

◆ earliestLedgerSeq_

std::uint32_t const xrpl::node_store::Database::earliestLedgerSeq_

protectedinherited

Definition at line 241 of file Database.h.

◆ requestBundle_

int const xrpl::node_store::Database::requestBundle_

protectedinherited

Definition at line 246 of file Database.h.

◆ storeCount_

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

privateinherited

Definition at line 269 of file Database.h.

◆ storeSz_

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

privateinherited

Definition at line 270 of file Database.h.

◆ fetchTotalCount_

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

privateinherited

Definition at line 271 of file Database.h.

◆ fetchDurationUs_

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

privateinherited

Definition at line 272 of file Database.h.

◆ storeDurationUs_

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

privateinherited

Definition at line 273 of file Database.h.

◆ readLock_

std::mutex xrpl::node_store::Database::readLock_

mutableprivateinherited

Definition at line 275 of file Database.h.

◆ readCondVar_

std::condition_variable xrpl::node_store::Database::readCondVar_

privateinherited

Definition at line 276 of file Database.h.

◆ read_

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

privateinherited

Definition at line 283 of file Database.h.

◆ readStopping_

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

privateinherited

Definition at line 285 of file Database.h.

◆ readThreads_

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

privateinherited

Definition at line 286 of file Database.h.

◆ runningThreads_

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

privateinherited

Definition at line 287 of file Database.h.

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DatabaseRotating()

Member Function Documentation

◆ rotate()

◆ setRotationInFlight()

◆ getName()

◆ importDatabase()

◆ getWriteLoad()

◆ store()

◆ isSameDB()

◆ sync()

◆ fetchNodeObject() [1/2]

◆ fetchNodeObject() [2/2]

◆ asyncFetch()

◆ sweep()

◆ getStoreCount()

◆ getFetchTotalCount()

◆ getFetchHitCount()

◆ getStoreSize()

◆ getFetchSize()

◆ getCountsJson()

◆ fdRequired()

◆ stop()

◆ isStopping()

◆ earliestLedgerSeq()

◆ storeStats()

◆ importInternal()

◆ updateFetchMetrics()

◆ forEach()

◆ threadEntry()

Member Data Documentation

◆ j_

◆ scheduler_

◆ fdRequired_

◆ fetchHitCount_

◆ fetchSz_

◆ earliestLedgerSeq_

◆ requestBundle_

◆ storeCount_

◆ storeSz_

◆ fetchTotalCount_

◆ fetchDurationUs_

◆ storeDurationUs_

◆ readLock_

◆ readCondVar_

◆ read_

◆ readStopping_

◆ readThreads_

◆ runningThreads_