xrpld
Loading...
Searching...
No Matches
xrpl::node_store::DatabaseRotatingImp Class Reference

#include <DatabaseRotatingImp.h>

Inheritance diagram for xrpl::node_store::DatabaseRotatingImp:
Collaboration diagram for xrpl::node_store::DatabaseRotatingImp:

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< node_store::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
 Check if two ledgers are in the same database.
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.
void setRotationInFlight (bool inFlight) override
 Marks an online-delete rotation as in progress (or completed).
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 ()
 Close the read queue and wait for the read threads to exit.
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< bool > rotationInFlight_ {false}
std::atomic< std::uint64_t > copyForwardCount_ {0}
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 21 of file DatabaseRotatingImp.h.

Constructor & Destructor Documentation

◆ DatabaseRotatingImp() [1/3]

xrpl::node_store::DatabaseRotatingImp::DatabaseRotatingImp ( )
delete

◆ DatabaseRotatingImp() [2/3]

xrpl::node_store::DatabaseRotatingImp::DatabaseRotatingImp ( DatabaseRotatingImp const & )
delete

◆ DatabaseRotatingImp() [3/3]

xrpl::node_store::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 27 of file DatabaseRotatingImp.cpp.

◆ ~DatabaseRotatingImp()

xrpl::node_store::DatabaseRotatingImp::~DatabaseRotatingImp ( )
override

Definition at line 37 of file DatabaseRotatingImp.h.

Member Function Documentation

◆ operator=()

DatabaseRotatingImp & xrpl::node_store::DatabaseRotatingImp::operator= ( DatabaseRotatingImp const & )
delete

◆ rotate()

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

Rotates the backends.

Parameters
newBackendNew writable backend
fA function executed after the rotation outside of lock. The values passed to f will be the new backend database names after rotation.

Implements xrpl::node_store::DatabaseRotating.

Definition at line 45 of file DatabaseRotatingImp.cpp.

◆ getName()

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

Definition at line 90 of file DatabaseRotatingImp.cpp.

◆ getWriteLoad()

std::int32_t xrpl::node_store::DatabaseRotatingImp::getWriteLoad ( ) const
overridevirtual

Retrieve the estimated number of pending write operations.

This is used for diagnostics.

Implements xrpl::node_store::Database.

Definition at line 97 of file DatabaseRotatingImp.cpp.

◆ importDatabase()

void xrpl::node_store::DatabaseRotatingImp::importDatabase ( Database & source)
overridevirtual

Import objects from another database.

Implements xrpl::node_store::Database.

Definition at line 104 of file DatabaseRotatingImp.cpp.

◆ isSameDB()

bool xrpl::node_store::DatabaseRotatingImp::isSameDB ( std::uint32_t s1,
std::uint32_t s2 )
overridevirtual

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
s1The first sequence number
s2The second sequence number
Returns
'true' if both ledgers would be in the same DB

Implements xrpl::node_store::Database.

Definition at line 58 of file DatabaseRotatingImp.h.

◆ store()

void xrpl::node_store::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
typeThe type of object.
dataThe payload of the object. The caller's variable is overwritten.
hashThe 256-bit hash of the payload data.
ledgerSeqThe sequence of the ledger the object belongs to.
Returns
true if the object was stored?

Implements xrpl::node_store::Database.

Definition at line 122 of file DatabaseRotatingImp.cpp.

◆ sync()

void xrpl::node_store::DatabaseRotatingImp::sync ( )
overridevirtual

Implements xrpl::node_store::Database.

Definition at line 115 of file DatabaseRotatingImp.cpp.

◆ sweep()

void xrpl::node_store::DatabaseRotatingImp::sweep ( )
overridevirtual

Remove expired entries from the positive and negative caches.

Implements xrpl::node_store::Database.

Definition at line 136 of file DatabaseRotatingImp.cpp.

◆ setRotationInFlight()

void xrpl::node_store::DatabaseRotatingImp::setRotationInFlight ( bool inFlight)
overridevirtual

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.

Implements xrpl::node_store::DatabaseRotating.

Definition at line 82 of file DatabaseRotatingImp.cpp.

◆ fetchNodeObject() [1/2]

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

Implements xrpl::node_store::Database.

Definition at line 142 of file DatabaseRotatingImp.cpp.

◆ forEach()

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

Definition at line 221 of file DatabaseRotatingImp.cpp.

◆ fetchNodeObject() [2/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
hashThe key of the object to retrieve.
ledgerSeqThe sequence of the ledger where the object is stored.
fetchTypethe type of fetch, synchronous or asynchronous.
Returns
The object, or nullptr if it couldn't be retrieved.

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

◆ asyncFetch()

void xrpl::node_store::Database::asyncFetch ( UInt256 const & hash,
std::uint32_t ledgerSeq,
std::function< void(std::shared_ptr< NodeObject > const &)> && cb )
virtualinherited

Fetch an object without waiting.

Queue a read for the read threads, or complete it at once with no object when the queue is closed, so the caller always gets exactly one callback.

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.
The callback must not throw. It runs on a read thread, or on the caller's thread once the queue is closed, which includes the stop() call made from the destructor.
Parameters
hashThe key of the object to retrieve
ledgerSeqThe sequence of the ledger where the object is stored.
callbackCallback function when read completes
hashThe key of the object to read.
ledgerSeqThe sequence of the ledger the object belongs to.
cbThe callback that receives the object, or nullptr if the object is not present or the database is stopping.

Reimplemented in xrpl::node_store::DatabaseNodeImp.

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

◆ getStoreCount()

std::uint64_t xrpl::node_store::Database::getStoreCount ( ) const
inherited

Gather statistics pertaining to read and write activities.

Parameters
objJson object reference into which to place counters.

Definition at line 174 of file Database.h.

◆ getFetchTotalCount()

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

Definition at line 180 of file Database.h.

◆ getFetchHitCount()

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

Definition at line 186 of file Database.h.

◆ getStoreSize()

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

Definition at line 192 of file Database.h.

◆ getFetchSize()

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

Definition at line 198 of file Database.h.

◆ getCountsJson()

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

Definition at line 290 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 210 of file Database.h.

◆ stop()

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

Close the read queue and wait for the read threads to exit.

The call that closes the queue completes every read still queued with no object before it returns, so every caller gets exactly one callback. The callbacks run on the calling thread with readLock_ released, since a callback may post or wait on other reads. A concurrent second call waits only for the read threads, so it may return while the first call is still delivering those callbacks.

Definition at line 154 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 225 of file Database.h.

◆ storeStats()

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

Definition at line 252 of file Database.h.

◆ importInternal()

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

Definition at line 225 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 264 of file Database.h.

◆ threadEntry()

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

Member Data Documentation

◆ writableBackend_

std::shared_ptr<Backend> xrpl::node_store::DatabaseRotatingImp::writableBackend_
private

Definition at line 77 of file DatabaseRotatingImp.h.

◆ archiveBackend_

std::shared_ptr<Backend> xrpl::node_store::DatabaseRotatingImp::archiveBackend_
private

Definition at line 78 of file DatabaseRotatingImp.h.

◆ mutex_

std::mutex xrpl::node_store::DatabaseRotatingImp::mutex_
mutableprivate

Definition at line 79 of file DatabaseRotatingImp.h.

◆ rotationInFlight_

std::atomic<bool> xrpl::node_store::DatabaseRotatingImp::rotationInFlight_ {false}
private

Definition at line 86 of file DatabaseRotatingImp.h.

◆ copyForwardCount_

std::atomic<std::uint64_t> xrpl::node_store::DatabaseRotatingImp::copyForwardCount_ {0}
private

Definition at line 87 of file DatabaseRotatingImp.h.

◆ j_

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

Definition at line 231 of file Database.h.

◆ scheduler_

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

Definition at line 232 of file Database.h.

◆ fdRequired_

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

Definition at line 233 of file Database.h.

◆ fetchHitCount_

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

Definition at line 235 of file Database.h.

◆ fetchSz_

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

Definition at line 236 of file Database.h.

◆ earliestLedgerSeq_

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

Definition at line 244 of file Database.h.

◆ requestBundle_

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

Definition at line 249 of file Database.h.

◆ storeCount_

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

Definition at line 272 of file Database.h.

◆ storeSz_

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

Definition at line 273 of file Database.h.

◆ fetchTotalCount_

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

Definition at line 274 of file Database.h.

◆ fetchDurationUs_

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

Definition at line 275 of file Database.h.

◆ storeDurationUs_

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

Definition at line 276 of file Database.h.

◆ readLock_

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

Definition at line 278 of file Database.h.

◆ readCondVar_

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

Definition at line 279 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 286 of file Database.h.

◆ readStopping_

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

Definition at line 288 of file Database.h.

◆ readThreads_

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

Definition at line 289 of file Database.h.

◆ runningThreads_

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

Definition at line 290 of file Database.h.