A leaf node for a transaction. More...

#include <SHAMapTxLeafNode.h>

Inheritance diagram for xrpl::SHAMapTxLeafNode:

[legend]

Collaboration diagram for xrpl::SHAMapTxLeafNode:

[legend]

Public Member Functions
	SHAMapTxLeafNode (boost::intrusive_ptr< SHAMapItem const > item, std::uint32_t cowid)
	SHAMapTxLeafNode (boost::intrusive_ptr< SHAMapItem const > item, std::uint32_t cowid, SHAMapHash const &hash)
SHAMapTreeNodePtr	clone (std::uint32_t cowid) const final
	Make a copy of this node, setting the owner.
SHAMapNodeType	getType () const final
	Determines the type of node.
void	updateHash () final
	Recalculate the hash of this node.
void	serializeForWire (Serializer &s) const final
	Serialize the node in a format appropriate for sending over the wire.
void	serializeWithPrefix (Serializer &s) const final
	Serialize the node in a format appropriate for hashing.
bool	isLeaf () const final
	Determines if this is a leaf node.
bool	isInner () const final
	Determines if this is an inner node.
void	invariants (bool isRoot=false) const final
boost::intrusive_ptr< SHAMapItem const > const &	peekItem () const
bool	setItem (boost::intrusive_ptr< SHAMapItem const > i)
	Set the item that this node points to and update the node's hash.
std::string	getString (SHAMapNodeID const &) const final
virtual void	partialDestructor ()
std::uint32_t	cowid () const
	Returns the SHAMap that owns this node.
void	unshare ()
	If this node is shared with another map, mark it as no longer shared.
SHAMapHash const &	getHash () const
	Return the hash of this node.
void	addStrongRef () const noexcept
void	addWeakRef () const noexcept
ReleaseStrongRefAction	releaseStrongRef () const
ReleaseStrongRefAction	addWeakReleaseStrongRef () const
ReleaseWeakRefAction	releaseWeakRef () const
bool	checkoutStrongRefFromWeak () const noexcept
bool	expired () const noexcept
std::size_t	useCount () const noexcept

Static Public Member Functions
static SHAMapTreeNodePtr	makeFromPrefix (Slice rawNode, SHAMapHash const &hash)
static SHAMapTreeNodePtr	makeFromWire (Slice rawNode)

Public Attributes
friend	Object

Protected Attributes
boost::intrusive_ptr< SHAMapItem const >	item_
SHAMapHash	hash_
std::uint32_t	cowid_
	Determines the owning SHAMap, if any.

Private Types
using	CountType = std::uint16_t
using	FieldType = std::uint32_t

Static Private Member Functions
static SHAMapTreeNodePtr	makeTransaction (Slice data, SHAMapHash const &hash, bool hashValid)
static SHAMapTreeNodePtr	makeAccountState (Slice data, SHAMapHash const &hash, bool hashValid)
static SHAMapTreeNodePtr	makeTransactionWithMeta (Slice data, SHAMapHash const &hash, bool hashValid)
static auto &	getCounter () noexcept

Private Attributes
std::atomic< FieldType >	refCounts_ {kStrongDelta}
	refCounts consists of four fields that are treated atomically:

Static Private Attributes
static constexpr size_t	kStrongCountNumBits = sizeof(CountType) * 8
static constexpr size_t	kWeakCountNumBits = kStrongCountNumBits - 2
static constexpr size_t	kFieldTypeBits = sizeof(FieldType) * 8
static constexpr FieldType	kOne = 1
static constexpr FieldType	kStrongDelta = 1
	Amount to change the strong count when adding or releasing a reference.
static constexpr FieldType	kWeakDelta = (kOne << kStrongCountNumBits)
	Amount to change the weak count when adding or releasing a reference.
static constexpr FieldType	kPartialDestroyStartedMask = (kOne << (kFieldTypeBits - 1))
	Flag that is set when the partialDestroy function has started running (or is about to start running).
static constexpr FieldType	kPartialDestroyFinishedMask = (kOne << (kFieldTypeBits - 2))
	Flag that is set when the partialDestroy function has finished running.
static constexpr FieldType	kTagMask = kPartialDestroyStartedMask \| kPartialDestroyFinishedMask
	Mask that will zero out all the count bits and leave the tag bits unchanged.
static constexpr FieldType	kValueMask = ~kTagMask
	Mask that will zero out the tag bits and leave the count bits unchanged.
static constexpr FieldType	kStrongMask = ((kOne << kStrongCountNumBits) - 1) & kValueMask
	Mask that will zero out everything except the strong count.
static constexpr FieldType	kWeakMask
	Mask that will zero out everything except the weak count.

Detailed Description

A leaf node for a transaction.

No metadata is included.

Definition at line 12 of file SHAMapTxLeafNode.h.

Member Typedef Documentation

◆ CountType

using xrpl::IntrusiveRefCounts::CountType = std::uint16_t

privateinherited

Definition at line 100 of file IntrusiveRefCounts.h.

◆ FieldType

using xrpl::IntrusiveRefCounts::FieldType = std::uint32_t

privateinherited

Definition at line 103 of file IntrusiveRefCounts.h.

Constructor & Destructor Documentation

◆ SHAMapTxLeafNode() [1/2]

xrpl::SHAMapTxLeafNode::SHAMapTxLeafNode	(	boost::intrusive_ptr< SHAMapItem const >	item,
		std::uint32_t	cowid )

Definition at line 15 of file SHAMapTxLeafNode.h.

◆ SHAMapTxLeafNode() [2/2]

xrpl::SHAMapTxLeafNode::SHAMapTxLeafNode	(	boost::intrusive_ptr< SHAMapItem const >	item,
		std::uint32_t	cowid,
		SHAMapHash const &	hash )

Definition at line 21 of file SHAMapTxLeafNode.h.

Member Function Documentation

◆ clone()

SHAMapTreeNodePtr xrpl::SHAMapTxLeafNode::clone ( std::uint32_t cowid ) const

finalvirtual

Make a copy of this node, setting the owner.

Implements xrpl::SHAMapTreeNode.

Definition at line 30 of file SHAMapTxLeafNode.h.

◆ getType()

SHAMapNodeType xrpl::SHAMapTxLeafNode::getType ( ) const

finalvirtual

Determines the type of node.

Implements xrpl::SHAMapTreeNode.

Definition at line 36 of file SHAMapTxLeafNode.h.

◆ updateHash()

void xrpl::SHAMapTxLeafNode::updateHash ( )

finalvirtual

Recalculate the hash of this node.

Implements xrpl::SHAMapTreeNode.

Definition at line 42 of file SHAMapTxLeafNode.h.

◆ serializeForWire()

void xrpl::SHAMapTxLeafNode::serializeForWire ( Serializer & ) const

finalvirtual

Serialize the node in a format appropriate for sending over the wire.

Implements xrpl::SHAMapTreeNode.

Definition at line 48 of file SHAMapTxLeafNode.h.

◆ serializeWithPrefix()

void xrpl::SHAMapTxLeafNode::serializeWithPrefix ( Serializer & ) const

finalvirtual

Serialize the node in a format appropriate for hashing.

Implements xrpl::SHAMapTreeNode.

Definition at line 55 of file SHAMapTxLeafNode.h.

◆ isLeaf()

bool xrpl::SHAMapLeafNode::isLeaf ( ) const

finalvirtualinherited

Determines if this is a leaf node.

Implements xrpl::SHAMapTreeNode.

Definition at line 28 of file SHAMapLeafNode.h.

◆ isInner()

bool xrpl::SHAMapLeafNode::isInner ( ) const

finalvirtualinherited

Determines if this is an inner node.

Implements xrpl::SHAMapTreeNode.

Definition at line 34 of file SHAMapLeafNode.h.

◆ invariants()

void xrpl::SHAMapLeafNode::invariants ( bool isRoot = false ) const

finalvirtualinherited

Implements xrpl::SHAMapTreeNode.

Definition at line 93 of file SHAMapLeafNode.cpp.

◆ peekItem()

boost::intrusive_ptr< SHAMapItem const > const & xrpl::SHAMapLeafNode::peekItem ( ) const

inherited

Definition at line 41 of file SHAMapLeafNode.cpp.

◆ setItem()

bool xrpl::SHAMapLeafNode::setItem ( boost::intrusive_ptr< SHAMapItem const > i )

inherited

Set the item that this node points to and update the node's hash.

Parameters

i	the new item

Returns: false if the change was, effectively, a noop (that is, if the hash was unchanged); true otherwise.

Definition at line 47 of file SHAMapLeafNode.cpp.

◆ getString()

std::string xrpl::SHAMapLeafNode::getString ( SHAMapNodeID const & id ) const

finalvirtualinherited

Reimplemented from xrpl::SHAMapTreeNode.

Definition at line 60 of file SHAMapLeafNode.cpp.

◆ partialDestructor()

virtual void xrpl::SHAMapTreeNode::partialDestructor ( )

virtualinherited

Reimplemented in xrpl::SHAMapInnerNode.

Definition at line 75 of file SHAMapTreeNode.h.

◆ getHash()

SHAMapHash const & xrpl::SHAMapTreeNode::getHash ( ) const

inherited

Return the hash of this node.

Definition at line 128 of file SHAMapTreeNode.h.

◆ makeFromPrefix()

SHAMapTreeNodePtr xrpl::SHAMapTreeNode::makeFromPrefix	(	Slice	rawNode,
		SHAMapHash const &	hash )

staticinherited

Definition at line 159 of file SHAMapTreeNode.cpp.

◆ makeFromWire()

SHAMapTreeNodePtr xrpl::SHAMapTreeNode::makeFromWire ( Slice rawNode )

staticinherited

Definition at line 128 of file SHAMapTreeNode.cpp.

◆ makeTransaction()

SHAMapTreeNodePtr xrpl::SHAMapTreeNode::makeTransaction	(	Slice	data,
		SHAMapHash const &	hash,
		bool	hashValid )

staticprivateinherited

Definition at line 29 of file SHAMapTreeNode.cpp.

◆ makeAccountState()

SHAMapTreeNodePtr xrpl::SHAMapTreeNode::makeAccountState	(	Slice	data,
		SHAMapHash const &	hash,
		bool	hashValid )

staticprivateinherited

Definition at line 87 of file SHAMapTreeNode.cpp.

◆ makeTransactionWithMeta()

SHAMapTreeNodePtr xrpl::SHAMapTreeNode::makeTransactionWithMeta	(	Slice	data,
		SHAMapHash const &	hash,
		bool	hashValid )

staticprivateinherited

Definition at line 47 of file SHAMapTreeNode.cpp.

◆ addStrongRef()

void xrpl::IntrusiveRefCounts::addStrongRef ( ) const

noexceptinherited

Definition at line 227 of file IntrusiveRefCounts.h.

◆ addWeakRef()

void xrpl::IntrusiveRefCounts::addWeakRef ( ) const

noexceptinherited

Definition at line 233 of file IntrusiveRefCounts.h.

◆ releaseStrongRef()

ReleaseStrongRefAction xrpl::IntrusiveRefCounts::releaseStrongRef ( ) const

inherited

Definition at line 239 of file IntrusiveRefCounts.h.

◆ addWeakReleaseStrongRef()

ReleaseStrongRefAction xrpl::IntrusiveRefCounts::addWeakReleaseStrongRef ( ) const

inherited

Definition at line 287 of file IntrusiveRefCounts.h.

◆ releaseWeakRef()

ReleaseWeakRefAction xrpl::IntrusiveRefCounts::releaseWeakRef ( ) const

inherited

Definition at line 340 of file IntrusiveRefCounts.h.

◆ checkoutStrongRefFromWeak()

bool xrpl::IntrusiveRefCounts::checkoutStrongRefFromWeak ( ) const

noexceptinherited

Definition at line 367 of file IntrusiveRefCounts.h.

◆ expired()

bool xrpl::IntrusiveRefCounts::expired ( ) const

noexceptinherited

Definition at line 384 of file IntrusiveRefCounts.h.

◆ useCount()

std::size_t xrpl::IntrusiveRefCounts::useCount ( ) const

noexceptinherited

Definition at line 391 of file IntrusiveRefCounts.h.

◆ getCounter()

auto & xrpl::CountedObject< SHAMapTxLeafNode >::getCounter ( )

staticprivatenoexceptinherited

Definition at line 109 of file CountedObject.h.

Member Data Documentation

◆ item_

boost::intrusive_ptr<SHAMapItem const> xrpl::SHAMapLeafNode::item_

protectedinherited

Definition at line 13 of file SHAMapLeafNode.h.

◆ hash_

SHAMapHash xrpl::SHAMapTreeNode::hash_

protectedinherited

Definition at line 40 of file SHAMapTreeNode.h.

◆ cowid_

std::uint32_t xrpl::SHAMapTreeNode::cowid_

protectedinherited

Determines the owning SHAMap, if any.

Used for copy-on-write semantics.

If this value is 0, the node is not dirty and does not need to be flushed. It is eligible for sharing and may be included multiple SHAMap instances.

Definition at line 48 of file SHAMapTreeNode.h.

◆ kStrongCountNumBits

size_t xrpl::IntrusiveRefCounts::kStrongCountNumBits = sizeof(CountType) * 8

staticconstexprprivateinherited

Definition at line 101 of file IntrusiveRefCounts.h.

◆ kWeakCountNumBits

size_t xrpl::IntrusiveRefCounts::kWeakCountNumBits = kStrongCountNumBits - 2

staticconstexprprivateinherited

Definition at line 102 of file IntrusiveRefCounts.h.

◆ kFieldTypeBits

size_t xrpl::IntrusiveRefCounts::kFieldTypeBits = sizeof(FieldType) * 8

staticconstexprprivateinherited

Definition at line 104 of file IntrusiveRefCounts.h.

◆ kOne

FieldType xrpl::IntrusiveRefCounts::kOne = 1

staticconstexprprivateinherited

Definition at line 105 of file IntrusiveRefCounts.h.

◆ refCounts_

std::atomic<FieldType> xrpl::IntrusiveRefCounts::refCounts_ {kStrongDelta}

mutableprivateinherited

refCounts consists of four fields that are treated atomically:

Strong count. This is a count of the number of shared pointers that hold a reference to this object. When the strong counts goes to zero, if the weak count is zero, the destructor is run. If the weak count is non-zero when the strong count goes to zero then the partialDestructor is run.
Weak count. This is a count of the number of weak pointer that hold a reference to this object. When the weak count goes to zero and the strong count is also zero, then the destructor is run.
Partial destroy started bit. This bit is set if the partialDestructor function has been started (or is about to be started). This is used to prevent the destructor from running concurrently with the partial destructor. This can easily happen when the last strong pointer release its reference in one thread and starts the partialDestructor, while in another thread the last weak pointer goes out of scope and starts the destructor while the partialDestructor is still running. Both a start and finished bit is needed to handle a corner-case where the last strong pointer goes out of scope, then then last weakPointer goes out of scope, but this happens before the partialDestructor bit is set. It would be possible to use a single bit if it could also be set atomically when the strong count goes to zero and the weak count is non-zero, but that would add complexity (and likely slow down common cases as well).
Partial destroy finished bit. This bit is set when the partialDestructor has finished running. See (3) above for more information.

Definition at line 140 of file IntrusiveRefCounts.h.

◆ kStrongDelta

FieldType xrpl::IntrusiveRefCounts::kStrongDelta = 1

staticconstexprprivateinherited

Amount to change the strong count when adding or releasing a reference.

Note: The strong count is stored in the low StrongCountNumBits bits of refCounts

Definition at line 147 of file IntrusiveRefCounts.h.

◆ kWeakDelta

FieldType xrpl::IntrusiveRefCounts::kWeakDelta = (kOne << kStrongCountNumBits)

staticconstexprprivateinherited

Amount to change the weak count when adding or releasing a reference.

Note: The weak count is stored in the high WeakCountNumBits bits of refCounts

Definition at line 154 of file IntrusiveRefCounts.h.

◆ kPartialDestroyStartedMask

FieldType xrpl::IntrusiveRefCounts::kPartialDestroyStartedMask = (kOne << (kFieldTypeBits - 1))

staticconstexprprivateinherited

Flag that is set when the partialDestroy function has started running (or is about to start running).

See description of the refCounts field for a fuller description of this field.

Definition at line 162 of file IntrusiveRefCounts.h.

◆ kPartialDestroyFinishedMask

FieldType xrpl::IntrusiveRefCounts::kPartialDestroyFinishedMask = (kOne << (kFieldTypeBits - 2))

staticconstexprprivateinherited

Flag that is set when the partialDestroy function has finished running.

See description of the refCounts field for a fuller description of this field.

Definition at line 169 of file IntrusiveRefCounts.h.

◆ kTagMask

FieldType xrpl::IntrusiveRefCounts::kTagMask = kPartialDestroyStartedMask | kPartialDestroyFinishedMask

staticconstexprprivateinherited

Mask that will zero out all the count bits and leave the tag bits unchanged.

Definition at line 174 of file IntrusiveRefCounts.h.

◆ kValueMask

FieldType xrpl::IntrusiveRefCounts::kValueMask = ~kTagMask

staticconstexprprivateinherited

Mask that will zero out the tag bits and leave the count bits unchanged.

Definition at line 179 of file IntrusiveRefCounts.h.

◆ kStrongMask

FieldType xrpl::IntrusiveRefCounts::kStrongMask = ((kOne << kStrongCountNumBits) - 1) & kValueMask

staticconstexprprivateinherited

Mask that will zero out everything except the strong count.

Definition at line 183 of file IntrusiveRefCounts.h.

◆ kWeakMask

FieldType xrpl::IntrusiveRefCounts::kWeakMask

staticconstexprprivateinherited

Initial value:

=

(((kOne << kWeakCountNumBits) - 1) << kStrongCountNumBits) & kValueMask

xrpl::IntrusiveRefCounts::kWeakCountNumBits

static constexpr size_t kWeakCountNumBits

Definition IntrusiveRefCounts.h:102

xrpl::IntrusiveRefCounts::kValueMask

static constexpr FieldType kValueMask

Mask that will zero out the tag bits and leave the count bits unchanged.

Definition IntrusiveRefCounts.h:179

xrpl::IntrusiveRefCounts::kOne

static constexpr FieldType kOne

Definition IntrusiveRefCounts.h:105

xrpl::IntrusiveRefCounts::kStrongCountNumBits

static constexpr size_t kStrongCountNumBits

Definition IntrusiveRefCounts.h:101

Mask that will zero out everything except the weak count.

Definition at line 187 of file IntrusiveRefCounts.h.

◆ Object

friend xrpl::CountedObject< SHAMapTxLeafNode >::SHAMapTxLeafNode

inherited

Definition at line 134 of file CountedObject.h.

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Types

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ CountType

◆ FieldType

Constructor & Destructor Documentation

◆ SHAMapTxLeafNode() [1/2]

◆ SHAMapTxLeafNode() [2/2]

Member Function Documentation

◆ clone()

◆ getType()

◆ updateHash()

◆ serializeForWire()

◆ serializeWithPrefix()

◆ isLeaf()

◆ isInner()

◆ invariants()

◆ peekItem()

◆ setItem()

◆ getString()

◆ partialDestructor()

◆ getHash()

◆ makeFromPrefix()

◆ makeFromWire()

◆ makeTransaction()

◆ makeAccountState()

◆ makeTransactionWithMeta()

◆ addStrongRef()

◆ addWeakRef()

◆ releaseStrongRef()

◆ addWeakReleaseStrongRef()

◆ releaseWeakRef()

◆ checkoutStrongRefFromWeak()

◆ expired()

◆ useCount()

◆ getCounter()

Member Data Documentation

◆ item_

◆ hash_

◆ cowid_

◆ kStrongCountNumBits

◆ kWeakCountNumBits

◆ kFieldTypeBits

◆ kOne

◆ refCounts_

◆ kStrongDelta

◆ kWeakDelta

◆ kPartialDestroyStartedMask

◆ kPartialDestroyFinishedMask

◆ kTagMask

◆ kValueMask

◆ kStrongMask

◆ kWeakMask

◆ Object