This is a base class of nodes which carries data sets for itself (Payload) and for subnodes.
See Brief introduction of software transactional memory using the class Node for basic ideas of this STM and code examples. More...

#include <transaction.h>

Inheritance diagram for Transactional::Node< XN >:

[legend]

Classes
struct	CASInfo

struct	Linkage

struct	NegotiationCounter

struct	Packet

struct	PacketList

struct	PacketWrapper

struct	Payload

struct	PayloadWrapper

struct	ProcessCounter

struct	SerialGenerator

Public Types
using	NodeNotFoundError = std::domain_error

using	NodeList = fast_vector< shared_ptr< XN >, 2 >

using	iterator = typename NodeList::iterator

using	const_iterator = typename NodeList::const_iterator

Public Member Functions
bool	insert (Transaction< XN > &tr, const shared_ptr< XN > &var, bool online_after_insertion=false)

void	insert (const shared_ptr< XN > &var)

bool	release (Transaction< XN > &tr, const shared_ptr< XN > &var)

void	release (const shared_ptr< XN > &var)

void	releaseAll ()

bool	swap (Transaction< XN > &tr, const shared_ptr< XN > &x, const shared_ptr< XN > &y)

void	swap (const shared_ptr< XN > &x, const shared_ptr< XN > &y)

XN *	upperNode (Snapshot< XN > &shot)
	Finds the parent node in shot.

template<typename Closure >
Snapshot< XN >	iterate_commit (Closure)

template<typename Closure >
Snapshot< XN >	iterate_commit_if (Closure)

template<typename Closure >
void	iterate_commit_while (Closure)

void	print_ () const

	Node (const Node &)=delete

Node &	operator= (const Node &)=delete

Static Public Member Functions
template<class T , typename... Args>
static T *	create (Args &&...args)

Protected Member Functions
	Node ()
	Use create().

Private Types
enum	SnapshotStatus { SNAPSHOT_SUCCESS = 0, SNAPSHOT_DISTURBED = 1, SNAPSHOT_VOID_PACKET = 2, SNAPSHOT_NODE_MISSING = 4, SNAPSHOT_COLLIDED = 8, SNAPSHOT_NODE_MISSING_AND_COLLIDED = 12 }

enum	SnapshotMode { SNAPSHOT_FOR_UNBUNDLE, SNAPSHOT_FOR_BUNDLE }

enum	BundledStatus { BUNDLE_SUCCESS, BUNDLE_DISTURBED }

enum	UnbundledStatus { UNBUNDLE_W_NEW_SUBVALUE, UNBUNDLE_SUBVALUE_HAS_CHANGED, UNBUNDLE_COLLIDED, UNBUNDLE_DISTURBED }

using	CASInfoList = fast_vector< CASInfo, 16 >

using	FuncPayloadCreator = Payload ()(XN &)

Private Member Functions
void	snapshot (Snapshot< XN > &target, bool multi_nodal, typename NegotiationCounter::cnt_t started_time) const

void	snapshot (Transaction< XN > &target, bool multi_nodal) const

bool	commit (Transaction< XN > &tr)

BundledStatus	bundle (local_shared_ptr< PacketWrapper > &target, typename NegotiationCounter::cnt_t &started_time, int64_t bundle_serial, bool is_bundle_root)

BundledStatus	bundle_subpacket (local_shared_ptr< PacketWrapper > *superwrapper, const shared_ptr< Node > &subnode, local_shared_ptr< PacketWrapper > &subwrapper, local_shared_ptr< Packet > &subpacket_new, typename NegotiationCounter::cnt_t &started_time, int64_t bundle_serial)

local_shared_ptr< Packet > *	reverseLookup (local_shared_ptr< Packet > &superpacket, bool copy_branch, int64_t tr_serial, bool set_missing, XN **uppernode)

local_shared_ptr< Packet > &	reverseLookup (local_shared_ptr< Packet > &superpacket, bool copy_branch, int64_t tr_serial=0, bool set_missing=false)

const local_shared_ptr< Packet > &	reverseLookup (const local_shared_ptr< Packet > &superpacket) const

local_shared_ptr< Packet > *	forwardLookup (local_shared_ptr< Packet > &superpacket, bool copy_branch, int64_t tr_serial, bool set_missing, local_shared_ptr< Packet > upperpacket, int index) const
	finds this node and a corresponding packet in the (un)bundled packet.

void	lookupFailure () const

local_shared_ptr< typename Node< XN >::Packet > *	lookupFromChild (local_shared_ptr< Packet > &superpacket, bool copy_branch, int64_t tr_serial, bool set_missing, XN **uppernode)

Static Private Member Functions
static SnapshotStatus	snapshotSupernode (const shared_ptr< Linkage > &linkage, shared_ptr< Linkage > &linkage_super, local_shared_ptr< PacketWrapper > &shot, local_shared_ptr< Packet > *subpacket, SnapshotMode mode, int64_t serial=SerialGenerator::SERIAL_NULL, CASInfoList cas_infos=nullptr)

static UnbundledStatus	unbundle (const int64_t bundle_serial, typename NegotiationCounter::cnt_t &time_started, const shared_ptr< Linkage > &sublinkage, const local_shared_ptr< PacketWrapper > &null_linkage, const local_shared_ptr< Packet > oldsubpacket=NULL, local_shared_ptr< PacketWrapper > newsubwrapper=NULL, local_shared_ptr< PacketWrapper > superwrapper=NULL)

static local_shared_ptr< Packet > *	reverseLookupWithHint (shared_ptr< Linkage > &linkage, local_shared_ptr< Packet > &superpacket, bool copy_branch, int64_t tr_serial, bool set_missing, local_shared_ptr< Packet > upperpacket, int index)

static void	eraseSerials (local_shared_ptr< Packet > &packet, int64_t serial)

Private Attributes
shared_ptr< Linkage >	m_link
	The point where the packet is held.

allocator< Payload >	m_allocatorPayload
	Allocators for memory pools in the Linkage.

allocator< Packet >	m_allocatorPacket

allocator< PacketList >	m_allocatorPacketList

allocator< PacketWrapper >	m_allocatorPacketWrapper

Static Private Attributes
static XThreadLocal < ProcessCounter >	stl_processID
	Holds the current porcess(thread) internal ID. Taking non-zero value.

static XThreadLocal < FuncPayloadCreator >	stl_funcPayloadCreator

Friends
class	Snapshot< XN >

class	Transaction< XN >

Detailed Description

template<class XN>
class Transactional::Node< XN >

This is a base class of nodes which carries data sets for itself (Payload) and for subnodes.
See Brief introduction of software transactional memory using the class Node for basic ideas of this STM and code examples.

Template Parameters

XN	a class type used in the smart pointers of NodeList. XN must be a derived class of Node<XN> itself.

See Also: Snapshot, Transaction.; XNode.

Definition at line 83 of file transaction.h.

Member Function Documentation

template<class XN >

Node< XN >::BundledStatus Transactional::Node< XN >::bundle	(	local_shared_ptr< PacketWrapper > &	target,
		typename NegotiationCounter::cnt_t &	started_time,
		int64_t	bundle_serial,
		bool	is_bundle_root
	)

private

Bundles all the subpackets so that the whole packet can be treated atomically. Namely this function takes a snapshot. All the subpackets held by m_link at the subnodes will be cleared and each PacketWrapper::bundledBy() will point to its upper node.

See Also: snapshot().

Definition at line 845 of file transaction_impl.h.

template<class XN>

bool Transactional::Node< XN >::commit ( Transaction< XN > & tr )

private

Updates a packet to tr.m_packet if the current packet is unchanged (== tr.m_oldpacket). If this node has been bundled at the super node, unbundle() will be called.

See Also: Transaction<XN>::commit().

Definition at line 1029 of file transaction_impl.h.

References Transactional::Snapshot< XN >::m_packet.

template<class XN>

bool Transactional::Node< XN >::insert	(	Transaction< XN > &	tr,
		const shared_ptr< XN > &	var,
		bool	online_after_insertion = `false`
	)

Adds a hard link to var. The subnode var will be storaged in the list of shared_ptr<XN>, NodeList.

Parameters

[in] online_after_insertion If true, var can be accessed through tr (not appropriate for a shared object).

Returns: True if succeeded.

See Also: release(), releaseAll(), swap().

Definition at line 212 of file transaction_impl.h.

References Transactional::Snapshot< XN >::m_packet.

template<class XN>

void Transactional::Node< XN >::insert ( const shared_ptr< XN > & var )

Adds a hard link to var. The subnode var will be storaged in the list of shared_ptr<XN>, NodeList.

See Also: release(), releaseAll(), swap().

Definition at line 205 of file transaction_impl.h.

template<class XN >

template<typename Closure >

Snapshot< XN > Transactional::Node< XN >::iterate_commit ( Closure closure )

inline

Iterates a transaction covering the node and children.

Parameters

Closure Typical: [=](Transaction<Node1> &tr){ somecode...}

Definition at line 715 of file transaction.h.

References Transactional::Transaction< XN >::commit().

template<class XN >

template<typename Closure >

Snapshot< XN > Transactional::Node< XN >::iterate_commit_if ( Closure closure )

inline

Iterates a transaction covering the node and children. Skips the iteration when the closure returns false.

Parameters

Closure Typical: [=](Transaction<Node1> &tr){ somecode...; return ret; }

Definition at line 724 of file transaction.h.

References Transactional::Transaction< XN >::commit().

template<class XN >

template<typename Closure >

void Transactional::Node< XN >::iterate_commit_while ( Closure closure )

inline

Iterates a transaction covering the node and children, as long as the closure returns true.

Parameters

Closure Typical: [=](Transaction<Node1> &tr){ somecode...; return ret; }

Definition at line 735 of file transaction.h.

References Transactional::Transaction< XN >::commit().

template<class XN>

bool Transactional::Node< XN >::release	(	Transaction< XN > &	tr,
		const shared_ptr< XN > &	var
	)

Removes a hard link to var from the list, NodeList.

Returns: True if succeeded.

See Also: insert(), releaseAll(), swap().

Definition at line 319 of file transaction_impl.h.

References Transactional::Snapshot< XN >::m_packet, and local_shared_ptr< X, Y >::reset().

template<class XN>

void Transactional::Node< XN >::release ( const shared_ptr< XN > & var )

Removes a hard link to var from the list, NodeList.

See Also: insert(), releaseAll(), swap().

Definition at line 281 of file transaction_impl.h.

template<class XN >

void Transactional::Node< XN >::releaseAll ( )

Removes all links to the subnodes.

See Also: insert(), release(), swap().

Definition at line 410 of file transaction_impl.h.

References Transactional::Snapshot< XN >::list(), and Transactional::Snapshot< XN >::size().

template<class XN>

local_shared_ptr< typename Node< XN >::Packet > * Transactional::Node< XN >::reverseLookup	(	local_shared_ptr< Packet > &	superpacket,
		bool	copy_branch,
		int64_t	tr_serial,
		bool	set_missing,
		XN **	uppernode
	)

inlineprivate

finds the packet for this node in the (un)bundled packet.

Parameters

[in,out]	superpacket	The bundled packet.
[in]	copy_branch	If ture, new packets and packet lists will be copy-created for writing.
[in]	tr_serial	The serial number associated with the transaction.

Definition at line 746 of file transaction.h.

References local_shared_ptr< X, Y >::reset().

Referenced by Transactional::Snapshot< XNode >::list(), Transactional::Snapshot< XNode >::operator[](), and Transactional::Snapshot< XNode >::size().

template<class XN>

bool Transactional::Node< XN >::swap	(	Transaction< XN > &	tr,
		const shared_ptr< XN > &	x,
		const shared_ptr< XN > &	y
	)

Swaps orders in the subnode list.

Returns: True if succeeded.

See Also: insert(), release(), releaseAll().

Definition at line 429 of file transaction_impl.h.

References Transactional::Snapshot< XN >::m_packet, and local_shared_ptr< X, Y >::reset().

template<class XN>

void Transactional::Node< XN >::swap	(	const shared_ptr< XN > &	x,
		const shared_ptr< XN > &	y
	)

Swaps orders in the subnode list.

See Also: insert(), release(), releaseAll().

Definition at line 422 of file transaction_impl.h.

template<class XN >

Node< XN >::UnbundledStatus Transactional::Node< XN >::unbundle	(	const int64_t *	bundle_serial,
		typename NegotiationCounter::cnt_t &	time_started,
		const shared_ptr< Linkage > &	sublinkage,
		const local_shared_ptr< PacketWrapper > &	null_linkage,
		const local_shared_ptr< Packet > *	oldsubpacket = `NULL`,
		local_shared_ptr< PacketWrapper > *	newsubwrapper = `NULL`,
		local_shared_ptr< PacketWrapper > *	superwrapper = `NULL`
	)

staticprivate

Unbundles a subpacket to sublinkage from a snapshot. it performs unbundling for all the super nodes. The super nodes will lose priorities against their lower nodes.

Parameters

[in]	bundle_serial	If not zero, consistency/collision wil be checked.
[in]	null_linkage	The current value of sublinkage and should not contain packet().
[in]	oldsubpacket	If not zero, the packet will be compared with the packet inside the super packet.
[in,out]	newsubwrapper	If oldsubpacket and newsubwrapper are not zero, newsubwrapper will be a new value. If oldsubpacket is zero, unloaded value of sublinkage will be substituted to newsubwrapper.

Definition at line 1092 of file transaction_impl.h.

The documentation for this class was generated from the following files:

kame/transaction.h
kame/transaction_impl.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

template<class XN> class Transactional::Node< XN >

Member Function Documentation

template<class XN>
class Transactional::Node< XN >