ripple::SHAMapStoreImp Class Reference

Inheritance diagram for ripple::SHAMapStoreImp:

Collaboration diagram for ripple::SHAMapStoreImp:

Classes
struct	SavedState
class	SavedStateDB

Public Member Functions
	SHAMapStoreImp (Application &app, Stoppable &parent, NodeStore::Scheduler &scheduler, beast::Journal journal)
	~SHAMapStoreImp ()
std::uint32_t	clampFetchDepth (std::uint32_t fetch_depth) const override
std::unique_ptr< NodeStore::Database >	makeNodeStore (std::string const &name, std::int32_t readThreads) override
LedgerIndex	setCanDelete (LedgerIndex seq) override
	Highest ledger that may be deleted. More...
bool	advisoryDelete () const override
	Whether advisory delete is enabled. More...
LedgerIndex	getLastRotated () override
	Maximum ledger that has been deleted, or will be deleted if currently in the act of online deletion. More...
LedgerIndex	getCanDelete () override
	Highest ledger that may be deleted. More...
void	onLedgerClosed (std::shared_ptr< Ledger const > const &ledger) override
	Called by LedgerMaster every time a ledger validates. More...
void	rendezvous () const override
int	fdRequired () const override
	Returns the number of file descriptors that are needed. More...
boost::optional< LedgerIndex >	minimumOnline () const override
	The minimum ledger to try and maintain in our database. More...
RootStoppable &	getRoot ()
void	setParent (Stoppable &parent)
	Set the parent of this Stoppable. More...
bool	isStopping () const
	Returns true if the stoppable should stop. More...
bool	isStopped () const
	Returns true if the requested stop has completed. More...
bool	areChildrenStopped () const
	Returns true if all children have stopped. More...
JobCounter &	jobCounter ()
bool	alertable_sleep_until (std::chrono::system_clock::time_point const &t)
	Sleep or wake up on stop. More...

Protected Member Functions
void	stopped ()
	Called by derived classes to indicate that the stoppable has stopped. More...

Private Types
enum	Health : std::uint8_t { ok = 0, stopping, unhealthy }
using	Children = beast::LockFreeStack< Child >

Private Member Functions
bool	copyNode (std::uint64_t &nodeCount, SHAMapTreeNode const &node)
void	run ()
void	dbPaths ()
std::unique_ptr< NodeStore::Backend >	makeBackendRotating (std::string path=std::string())
template<class CacheInstance >
bool	freshenCache (CacheInstance &cache)
void	clearSql (DatabaseCon &database, LedgerIndex lastRotated, std::string const &minQuery, std::string const &deleteQuery)
	delete from sqlite table in batches to not lock the db excessively. More...
void	clearCaches (LedgerIndex validatedSeq)
void	freshenCaches ()
void	clearPrior (LedgerIndex lastRotated)
Health	health ()
void	onPrepare () override
	Override called during preparation. More...
void	onStart () override
	Override called during start. More...
void	onStop () override
	Override called when the stop notification is issued. More...
void	onChildrenStopped () override
	Override called when all children have stopped. More...
void	prepareRecursive ()
void	startRecursive ()
void	stopAsyncRecursive (beast::Journal j)
void	stopRecursive (beast::Journal j)

Private Attributes
Application &	app_
const std::string	dbName_ = "state"
const std::string	dbPrefix_ = "rippledb"
const std::uint64_t	checkHealthInterval_ = 1000
std::atomic< LedgerIndex >	minimumOnline_ {}
NodeStore::Scheduler &	scheduler_
const beast::Journal	journal_
NodeStore::DatabaseRotating *	dbRotating_ = nullptr
SavedStateDB	state_db_
std::thread	thread_
bool	stop_ = false
bool	healthy_ = true
std::condition_variable	cond_
std::condition_variable	rendezvous_
std::mutex	mutex_
std::shared_ptr< Ledger const >	newLedger_
std::atomic< bool >	working_
std::atomic< LedgerIndex >	canDelete_
int	fdRequired_ = 0
std::uint32_t	deleteInterval_ = 0
bool	advisoryDelete_ = false
std::uint32_t	deleteBatch_ = 100
std::chrono::milliseconds	backOff_ {100}
std::chrono::seconds	ageThreshold_ {60}
boost::optional< std::chrono::seconds >	recoveryWaitTime_
	If set, and the node is out of sync during an online_delete health check, sleep the thread for this time and check again so the node can recover. More...
NetworkOPs *	netOPs_ = nullptr
LedgerMaster *	ledgerMaster_ = nullptr
FullBelowCache *	fullBelowCache_ = nullptr
TreeNodeCache *	treeNodeCache_ = nullptr
DatabaseCon *	transactionDb_ = nullptr
DatabaseCon *	ledgerDb_ = nullptr
std::string	m_name
RootStoppable &	m_root
Child	m_child
std::atomic< bool >	m_stopped {false}
std::atomic< bool >	m_childrenStopped {false}
Children	m_children
std::condition_variable	m_cv
std::mutex	m_mut
bool	m_is_stopping = false
bool	hasParent_ {false}

Static Private Attributes
static const std::uint32_t	minimumDeletionInterval_ = 256
static const std::uint32_t	minimumDeletionIntervalSA_ = 8
static constexpr auto	nodeStoreName_ = "NodeStore"

Detailed Description

Definition at line 36 of file SHAMapStoreImp.h.

Member Typedef Documentation

Children

using ripple::Stoppable::Children = beast::LockFreeStack<Child>

privateinherited

Definition at line 319 of file Stoppable.h.

Member Enumeration Documentation

Health

enum ripple::SHAMapStoreImp::Health : std::uint8_t

private

Enumerator
ok
stopping
unhealthy

Definition at line 46 of file SHAMapStoreImp.h.

Constructor & Destructor Documentation

SHAMapStoreImp()

ripple::SHAMapStoreImp::SHAMapStoreImp	(	Application &	app,
		Stoppable &	parent,
		NodeStore::Scheduler &	scheduler,
		beast::Journal	journal
	)

Definition at line 148 of file SHAMapStoreImp.cpp.

~SHAMapStoreImp()

ripple::SHAMapStoreImp::~SHAMapStoreImp

(

)

Definition at line 137 of file SHAMapStoreImp.h.

Member Function Documentation

clampFetchDepth()

std::uint32_t ripple::SHAMapStoreImp::clampFetchDepth ( std::uint32_t  fetch_depth ) const

overridevirtual

Implements ripple::SHAMapStore.

Definition at line 144 of file SHAMapStoreImp.h.

makeNodeStore()

std::unique_ptr< NodeStore::Database > ripple::SHAMapStoreImp::makeNodeStore ( std::string const &  name, std::int32_t  readThreads  )

overridevirtual

Implements ripple::SHAMapStore.

Definition at line 227 of file SHAMapStoreImp.cpp.

setCanDelete()

LedgerIndex ripple::SHAMapStoreImp::setCanDelete ( LedgerIndex  canDelete )

overridevirtual

Highest ledger that may be deleted.

Implements ripple::SHAMapStore.

Definition at line 154 of file SHAMapStoreImp.h.

advisoryDelete()

bool ripple::SHAMapStoreImp::advisoryDelete ( ) const

overridevirtual

Whether advisory delete is enabled.

Implements ripple::SHAMapStore.

Definition at line 162 of file SHAMapStoreImp.h.

getLastRotated()

LedgerIndex ripple::SHAMapStoreImp::getLastRotated ( )

overridevirtual

Maximum ledger that has been deleted, or will be deleted if currently in the act of online deletion.

Implements ripple::SHAMapStore.

Definition at line 170 of file SHAMapStoreImp.h.

getCanDelete()

LedgerIndex ripple::SHAMapStoreImp::getCanDelete ( )

overridevirtual

Highest ledger that may be deleted.

Implements ripple::SHAMapStore.

Definition at line 178 of file SHAMapStoreImp.h.

onLedgerClosed()

void ripple::SHAMapStoreImp::onLedgerClosed ( std::shared_ptr< Ledger const > const &  ledger )

overridevirtual

Called by LedgerMaster every time a ledger validates.

Implements ripple::SHAMapStore.

Definition at line 275 of file SHAMapStoreImp.cpp.

rendezvous()

void ripple::SHAMapStoreImp::rendezvous ( ) const

overridevirtual

Implements ripple::SHAMapStore.

Definition at line 286 of file SHAMapStoreImp.cpp.

fdRequired()

int ripple::SHAMapStoreImp::fdRequired ( ) const

overridevirtual

Returns the number of file descriptors that are needed.

Implements ripple::SHAMapStore.

Definition at line 296 of file SHAMapStoreImp.cpp.

minimumOnline()

boost::optional< LedgerIndex > ripple::SHAMapStoreImp::minimumOnline ( ) const

overridevirtual

The minimum ledger to try and maintain in our database.

This defines the lower bound for attempting to acquire historical ledgers over the peer to peer network.

If online_delete is enabled, then each time online_delete executes and just prior to clearing SQL databases of historical ledgers, move the value forward to one past the greatest ledger being deleted. This minimizes fetching of ledgers that are in the process of being deleted. Without online_delete or before online_delete is executed, this value is always the minimum value persisted in the ledger database, if any.

Returns

The minimum ledger sequence to keep online based on the description above. If not set, then an unseated optional.

Implements ripple::SHAMapStore.

Definition at line 768 of file SHAMapStoreImp.cpp.

copyNode()

bool ripple::SHAMapStoreImp::copyNode ( std::uint64_t &  nodeCount, SHAMapTreeNode const &  node  )

private

Definition at line 302 of file SHAMapStoreImp.cpp.

run()

void ripple::SHAMapStoreImp::run ( )

private

Definition at line 316 of file SHAMapStoreImp.cpp.

dbPaths()

void ripple::SHAMapStoreImp::dbPaths ( )

private

Definition at line 457 of file SHAMapStoreImp.cpp.

makeBackendRotating()

std::unique_ptr< NodeStore::Backend > ripple::SHAMapStoreImp::makeBackendRotating ( std::string  path = std::string() )

private

Definition at line 545 of file SHAMapStoreImp.cpp.

freshenCache()

template<class CacheInstance >

bool ripple::SHAMapStoreImp::freshenCache ( CacheInstance &  cache )

private

Definition at line 208 of file SHAMapStoreImp.h.

clearSql()

void ripple::SHAMapStoreImp::clearSql ( DatabaseCon &  database, LedgerIndex  lastRotated, std::string const &  minQuery, std::string const &  deleteQuery  )

private

delete from sqlite table in batches to not lock the db excessively.

Pause briefly to extend access time to other users. Call with mutex object unlocked.

Definition at line 573 of file SHAMapStoreImp.cpp.

clearCaches()

void ripple::SHAMapStoreImp::clearCaches ( LedgerIndex  validatedSeq )

private

Definition at line 633 of file SHAMapStoreImp.cpp.

freshenCaches()

void ripple::SHAMapStoreImp::freshenCaches ( )

private

Definition at line 640 of file SHAMapStoreImp.cpp.

clearPrior()

void ripple::SHAMapStoreImp::clearPrior ( LedgerIndex  lastRotated )

private

Definition at line 651 of file SHAMapStoreImp.cpp.

health()

SHAMapStoreImp::Health ripple::SHAMapStoreImp::health ( )

private

Definition at line 690 of file SHAMapStoreImp.cpp.

onPrepare()

void ripple::SHAMapStoreImp::onPrepare ( )

overrideprivatevirtual

Override called during preparation.

Since all other Stoppable objects in the tree have already been constructed, this provides an opportunity to perform initialization which depends on calling into other Stoppable objects. This call is made on the same thread that called prepare(). The default implementation does nothing. Guaranteed to only be called once.

Reimplemented from ripple::Stoppable.

Definition at line 253 of file SHAMapStoreImp.h.

onStart()

void ripple::SHAMapStoreImp::onStart ( )

overrideprivatevirtual

Override called during start.

Reimplemented from ripple::Stoppable.

Definition at line 258 of file SHAMapStoreImp.h.

onStop()

void ripple::SHAMapStoreImp::onStop ( )

overrideprivatevirtual

Override called when the stop notification is issued.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation simply calls stopped(). This is applicable when the Stoppable has a trivial stop operation (or no stop operation), and we are merely using the Stoppable API to position it as a dependency of some parent service.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Reimplemented from ripple::Stoppable.

Definition at line 734 of file SHAMapStoreImp.cpp.

onChildrenStopped()

void ripple::SHAMapStoreImp::onChildrenStopped ( )

overrideprivatevirtual

Override called when all children have stopped.

The call is made on an unspecified, implementation-specific thread. onStop and onChildrenStopped will never be called concurrently, across all Stoppable objects descended from the same root, inclusive of the root.

It is safe to call isStopping, isStopped, and areChildrenStopped from within this function; The values returned will always be valid and never change during the callback.

The default implementation does nothing.

Thread safety: May not block for long periods. Guaranteed only to be called once. Must be safe to call from any thread at any time.

Reimplemented from ripple::Stoppable.

Definition at line 751 of file SHAMapStoreImp.cpp.

getRoot()

RootStoppable& ripple::Stoppable::getRoot ( )

inherited

Definition at line 214 of file Stoppable.h.

setParent()

void ripple::Stoppable::setParent ( Stoppable &  parent )

inherited

Set the parent of this Stoppable.

Note

The Stoppable must not already have a parent. The parent to be set cannot not be stopping. Both roots must match.

Definition at line 43 of file Stoppable.cpp.

isStopping()

bool ripple::Stoppable::isStopping ( ) const

inherited

Returns true if the stoppable should stop.

Definition at line 54 of file Stoppable.cpp.

isStopped()

bool ripple::Stoppable::isStopped ( ) const

inherited

Returns true if the requested stop has completed.

Definition at line 60 of file Stoppable.cpp.

areChildrenStopped()

bool ripple::Stoppable::areChildrenStopped ( ) const

inherited

Returns true if all children have stopped.

Definition at line 66 of file Stoppable.cpp.

jobCounter()

JobCounter & ripple::Stoppable::jobCounter ( )

inherited

Definition at line 437 of file Stoppable.h.

alertable_sleep_until()

bool ripple::Stoppable::alertable_sleep_until ( std::chrono::system_clock::time_point const &  t )

inherited

Sleep or wake up on stop.

Returns

true if we are stopping

Definition at line 455 of file Stoppable.h.

stopped()

void ripple::Stoppable::stopped ( )

protectedinherited

Called by derived classes to indicate that the stoppable has stopped.

Definition at line 72 of file Stoppable.cpp.

prepareRecursive()

void ripple::Stoppable::prepareRecursive ( )

privateinherited

Definition at line 103 of file Stoppable.cpp.

startRecursive()

void ripple::Stoppable::startRecursive ( )

privateinherited

Definition at line 113 of file Stoppable.cpp.

stopAsyncRecursive()

void ripple::Stoppable::stopAsyncRecursive ( beast::Journal  j )

privateinherited

Definition at line 123 of file Stoppable.cpp.

stopRecursive()

void ripple::Stoppable::stopRecursive ( beast::Journal  j )

privateinherited

Definition at line 134 of file Stoppable.cpp.

Member Data Documentation

app_

Application& ripple::SHAMapStoreImp::app_

private

Definition at line 77 of file SHAMapStoreImp.h.

dbName_

const std::string ripple::SHAMapStoreImp::dbName_ = "state"

private

Definition at line 80 of file SHAMapStoreImp.h.

dbPrefix_

const std::string ripple::SHAMapStoreImp::dbPrefix_ = "rippledb"

private

Definition at line 82 of file SHAMapStoreImp.h.

checkHealthInterval_

const std::uint64_t ripple::SHAMapStoreImp::checkHealthInterval_ = 1000

private

Definition at line 84 of file SHAMapStoreImp.h.

minimumDeletionInterval_

const std::uint32_t ripple::SHAMapStoreImp::minimumDeletionInterval_ = 256

staticprivate

Definition at line 86 of file SHAMapStoreImp.h.

minimumDeletionIntervalSA_

const std::uint32_t ripple::SHAMapStoreImp::minimumDeletionIntervalSA_ = 8

staticprivate

Definition at line 88 of file SHAMapStoreImp.h.

minimumOnline_

std::atomic<LedgerIndex> ripple::SHAMapStoreImp::minimumOnline_ {}

private

Definition at line 90 of file SHAMapStoreImp.h.

scheduler_

NodeStore::Scheduler& ripple::SHAMapStoreImp::scheduler_

private

Definition at line 92 of file SHAMapStoreImp.h.

journal_

const beast::Journal ripple::SHAMapStoreImp::journal_

private

Definition at line 93 of file SHAMapStoreImp.h.

dbRotating_

NodeStore::DatabaseRotating* ripple::SHAMapStoreImp::dbRotating_ = nullptr

private

Definition at line 94 of file SHAMapStoreImp.h.

state_db_

SavedStateDB ripple::SHAMapStoreImp::state_db_

private

Definition at line 95 of file SHAMapStoreImp.h.

thread_

std::thread ripple::SHAMapStoreImp::thread_

private

Definition at line 96 of file SHAMapStoreImp.h.

stop_

bool ripple::SHAMapStoreImp::stop_ = false

private

Definition at line 97 of file SHAMapStoreImp.h.

healthy_

bool ripple::SHAMapStoreImp::healthy_ = true

private

Definition at line 98 of file SHAMapStoreImp.h.

cond_

std::condition_variable ripple::SHAMapStoreImp::cond_

mutableprivate

Definition at line 99 of file SHAMapStoreImp.h.

rendezvous_

std::condition_variable ripple::SHAMapStoreImp::rendezvous_

mutableprivate

Definition at line 100 of file SHAMapStoreImp.h.

mutex_

std::mutex ripple::SHAMapStoreImp::mutex_

mutableprivate

Definition at line 101 of file SHAMapStoreImp.h.

newLedger_

std::shared_ptr<Ledger const> ripple::SHAMapStoreImp::newLedger_

private

Definition at line 102 of file SHAMapStoreImp.h.

working_

std::atomic<bool> ripple::SHAMapStoreImp::working_

private

Definition at line 103 of file SHAMapStoreImp.h.

canDelete_

std::atomic<LedgerIndex> ripple::SHAMapStoreImp::canDelete_

private

Definition at line 104 of file SHAMapStoreImp.h.

fdRequired_

int ripple::SHAMapStoreImp::fdRequired_ = 0

private

Definition at line 105 of file SHAMapStoreImp.h.

deleteInterval_

std::uint32_t ripple::SHAMapStoreImp::deleteInterval_ = 0

private

Definition at line 107 of file SHAMapStoreImp.h.

advisoryDelete_

bool ripple::SHAMapStoreImp::advisoryDelete_ = false

private

Definition at line 108 of file SHAMapStoreImp.h.

deleteBatch_

std::uint32_t ripple::SHAMapStoreImp::deleteBatch_ = 100

private

Definition at line 109 of file SHAMapStoreImp.h.

backOff_

std::chrono::milliseconds ripple::SHAMapStoreImp::backOff_ {100}

private

Definition at line 110 of file SHAMapStoreImp.h.

ageThreshold_

std::chrono::seconds ripple::SHAMapStoreImp::ageThreshold_ {60}

private

Definition at line 111 of file SHAMapStoreImp.h.

recoveryWaitTime_

boost::optional<std::chrono::seconds> ripple::SHAMapStoreImp::recoveryWaitTime_

private

If set, and the node is out of sync during an online_delete health check, sleep the thread for this time and check again so the node can recover.

See also: "recovery_wait_seconds" in rippled-example.cfg

Definition at line 117 of file SHAMapStoreImp.h.

netOPs_

NetworkOPs* ripple::SHAMapStoreImp::netOPs_ = nullptr

private

Definition at line 121 of file SHAMapStoreImp.h.

ledgerMaster_

LedgerMaster* ripple::SHAMapStoreImp::ledgerMaster_ = nullptr

private

Definition at line 122 of file SHAMapStoreImp.h.

fullBelowCache_

FullBelowCache* ripple::SHAMapStoreImp::fullBelowCache_ = nullptr

private

Definition at line 123 of file SHAMapStoreImp.h.

treeNodeCache_

TreeNodeCache* ripple::SHAMapStoreImp::treeNodeCache_ = nullptr

private

Definition at line 124 of file SHAMapStoreImp.h.

transactionDb_

DatabaseCon* ripple::SHAMapStoreImp::transactionDb_ = nullptr

private

Definition at line 125 of file SHAMapStoreImp.h.

ledgerDb_

DatabaseCon* ripple::SHAMapStoreImp::ledgerDb_ = nullptr

private

Definition at line 126 of file SHAMapStoreImp.h.

nodeStoreName_

constexpr auto ripple::SHAMapStoreImp::nodeStoreName_ = "NodeStore"

staticconstexprprivate

Definition at line 128 of file SHAMapStoreImp.h.

m_name

std::string ripple::Stoppable::m_name

privateinherited

Definition at line 339 of file Stoppable.h.

m_root

RootStoppable& ripple::Stoppable::m_root

privateinherited

Definition at line 340 of file Stoppable.h.

m_child

Child ripple::Stoppable::m_child

privateinherited

Definition at line 341 of file Stoppable.h.

m_stopped

std::atomic<bool> ripple::Stoppable::m_stopped {false}

privateinherited

Definition at line 342 of file Stoppable.h.

m_childrenStopped

std::atomic<bool> ripple::Stoppable::m_childrenStopped {false}

privateinherited

Definition at line 343 of file Stoppable.h.

m_children

Children ripple::Stoppable::m_children

privateinherited

Definition at line 344 of file Stoppable.h.

m_cv

std::condition_variable ripple::Stoppable::m_cv

privateinherited

Definition at line 345 of file Stoppable.h.

m_mut

std::mutex ripple::Stoppable::m_mut

privateinherited

Definition at line 346 of file Stoppable.h.

m_is_stopping

bool ripple::Stoppable::m_is_stopping = false

privateinherited

Definition at line 347 of file Stoppable.h.

hasParent_

bool ripple::Stoppable::hasParent_ {false}

privateinherited

Definition at line 348 of file Stoppable.h.