This class implements global sync operations among gem5 peer processes. More...

Inheritance diagram for gem5::DistIface::Sync:

Public Member Functions
void	init (Tick start, Tick repeat)
	Initialize periodic sync params.

virtual bool	run (bool same_tick)=0
	Core method to perform a full dist sync.

virtual bool	progress (Tick send_tick, Tick next_repeat, ReqType do_ckpt, ReqType do_exit, ReqType do_stop_sync)=0
	Callback when the receiver thread gets a sync ack message.

void	abort ()
	Abort processing an on-going sync event (in case of an error, e.g.

virtual void	requestCkpt (ReqType req)=0

virtual void	requestExit (ReqType req)=0

virtual void	requestStopSync (ReqType req)=0

void	drainComplete ()

virtual void	serialize (CheckpointOut &cp) const override=0
	Serialize an object.

virtual void	unserialize (CheckpointIn &cp) override=0
	Unserialize an object.

Public Member Functions inherited from gem5::Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Protected Attributes
std::mutex	lock
	The lock to protect access to the Sync object.

std::condition_variable	cv
	Condition variable for the simulation thread to wait on until all receiver threads completes the current global synchronisation.

unsigned	waitNum
	Number of receiver threads that not yet completed the current global synchronisation.

bool	doExit
	Flag is set if exit is permitted upon sync completion.

bool	doCkpt
	Flag is set if taking a ckpt is permitted upon sync completion.

bool	doStopSync
	Flag is set if sync is to stop upon sync completion.

Tick	nextRepeat
	The repeat value for the next periodic sync.

Tick	nextAt
	Tick for the next periodic sync (if the event is not scheduled yet)

bool	isAbort
	Flag is set if the sync is aborted (e.g.

Friends
class	SyncEvent

Additional Inherited Members
Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Detailed Description

This class implements global sync operations among gem5 peer processes.

Note: This class is used as a singleton object (shared by all DistIface objects).

Definition at line 119 of file dist_iface.hh.

Member Function Documentation

◆ abort()

void gem5::DistIface::Sync::abort ( )

Abort processing an on-going sync event (in case of an error, e.g.

lost connection to a peer gem5)

Definition at line 87 of file dist_iface.cc.

References cv, isAbort, lock, and waitNum.

◆ drainComplete()

void gem5::DistIface::Sync::drainComplete ( )

Definition at line 292 of file dist_iface.cc.

References doCkpt, and run().

◆ init()

void gem5::DistIface::Sync::init	(	Tick	start,
		Tick	repeat )

Initialize periodic sync params.

Parameters

start	Start tick for dist synchronisation
repeat	Frequency of dist synchronisation

Definition at line 69 of file dist_iface.cc.

References inform, nextAt, nextRepeat, and panic.

◆ progress()

virtual bool gem5::DistIface::Sync::progress	(	Tick	send_tick,
		Tick	next_repeat,
		ReqType	do_ckpt,
		ReqType	do_exit,
		ReqType	do_stop_sync )

pure virtual

Callback when the receiver thread gets a sync ack message.

Returns: false if the receiver thread needs to stop (e.g. simulation is to exit)

Implemented in gem5::DistIface::SyncNode, and gem5::DistIface::SyncSwitch.

◆ requestCkpt()

virtual void gem5::DistIface::Sync::requestCkpt ( ReqType req )

pure virtual

Implemented in gem5::DistIface::SyncNode, and gem5::DistIface::SyncSwitch.

◆ requestExit()

virtual void gem5::DistIface::Sync::requestExit ( ReqType req )

pure virtual

Implemented in gem5::DistIface::SyncNode, and gem5::DistIface::SyncSwitch.

◆ requestStopSync()

virtual void gem5::DistIface::Sync::requestStopSync ( ReqType req )

pure virtual

Implemented in gem5::DistIface::SyncNode, and gem5::DistIface::SyncSwitch.

◆ run()

virtual bool gem5::DistIface::Sync::run ( bool same_tick )

pure virtual

Core method to perform a full dist sync.

Returns: true if the sync completes, false if it gets aborted

Implemented in gem5::DistIface::SyncNode, and gem5::DistIface::SyncSwitch.

Referenced by drainComplete().

◆ serialize()

virtual void gem5::DistIface::Sync::serialize ( CheckpointOut & cp ) const

overridepure virtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Implemented in gem5::DistIface::SyncNode, and gem5::DistIface::SyncSwitch.

◆ unserialize()

virtual void gem5::DistIface::Sync::unserialize ( CheckpointIn & cp )

overridepure virtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Implemented in gem5::DistIface::SyncNode, and gem5::DistIface::SyncSwitch.

Friends And Related Symbol Documentation

◆ SyncEvent

friend class SyncEvent

friend

Definition at line 162 of file dist_iface.hh.

References SyncEvent.

Referenced by SyncEvent.

Member Data Documentation

◆ cv

std::condition_variable gem5::DistIface::Sync::cv

protected

Condition variable for the simulation thread to wait on until all receiver threads completes the current global synchronisation.

Definition at line 131 of file dist_iface.hh.

Referenced by abort(), gem5::DistIface::SyncNode::progress(), gem5::DistIface::SyncSwitch::progress(), gem5::DistIface::SyncNode::run(), and gem5::DistIface::SyncSwitch::run().

◆ doCkpt

bool gem5::DistIface::Sync::doCkpt

protected

Flag is set if taking a ckpt is permitted upon sync completion.

Definition at line 144 of file dist_iface.hh.

Referenced by drainComplete(), gem5::DistIface::SyncNode::progress(), gem5::DistIface::SyncSwitch::progress(), gem5::DistIface::SyncSwitch::run(), gem5::DistIface::SyncNode::SyncNode(), and gem5::DistIface::SyncSwitch::SyncSwitch().

◆ doExit

bool gem5::DistIface::Sync::doExit

protected

Flag is set if exit is permitted upon sync completion.

Definition at line 140 of file dist_iface.hh.

Referenced by gem5::DistIface::SyncNode::progress(), gem5::DistIface::SyncSwitch::progress(), gem5::DistIface::SyncSwitch::run(), gem5::DistIface::SyncNode::SyncNode(), and gem5::DistIface::SyncSwitch::SyncSwitch().

◆ doStopSync

bool gem5::DistIface::Sync::doStopSync

protected

Flag is set if sync is to stop upon sync completion.

Definition at line 148 of file dist_iface.hh.

Referenced by gem5::DistIface::SyncNode::progress(), gem5::DistIface::SyncSwitch::progress(), gem5::DistIface::SyncSwitch::run(), gem5::DistIface::SyncNode::SyncNode(), and gem5::DistIface::SyncSwitch::SyncSwitch().

◆ isAbort

bool gem5::DistIface::Sync::isAbort

protected

Flag is set if the sync is aborted (e.g.

due to connection lost)

Definition at line 160 of file dist_iface.hh.

Referenced by abort(), gem5::DistIface::SyncNode::progress(), gem5::DistIface::SyncSwitch::progress(), gem5::DistIface::SyncNode::run(), gem5::DistIface::SyncSwitch::run(), gem5::DistIface::SyncNode::SyncNode(), and gem5::DistIface::SyncSwitch::SyncSwitch().

◆ lock

std::mutex gem5::DistIface::Sync::lock

protected

The lock to protect access to the Sync object.

Definition at line 125 of file dist_iface.hh.

Referenced by abort(), gem5::DistIface::SyncNode::progress(), gem5::DistIface::SyncSwitch::progress(), gem5::DistIface::SyncNode::requestCkpt(), gem5::DistIface::SyncNode::requestExit(), gem5::DistIface::SyncNode::requestStopSync(), gem5::DistIface::SyncNode::run(), and gem5::DistIface::SyncSwitch::run().

◆ nextAt

Tick gem5::DistIface::Sync::nextAt

protected

Tick for the next periodic sync (if the event is not scheduled yet)

Definition at line 156 of file dist_iface.hh.

Referenced by init(), gem5::DistIface::SyncNode::progress(), gem5::DistIface::SyncSwitch::progress(), gem5::DistIface::SyncNode::run(), gem5::DistIface::SyncSwitch::run(), gem5::DistIface::SyncNode::SyncNode(), and gem5::DistIface::SyncSwitch::SyncSwitch().

◆ nextRepeat

Tick gem5::DistIface::Sync::nextRepeat

protected

The repeat value for the next periodic sync.

Definition at line 152 of file dist_iface.hh.

Referenced by init(), gem5::DistIface::SyncNode::progress(), gem5::DistIface::SyncSwitch::progress(), gem5::DistIface::SyncNode::run(), gem5::DistIface::SyncSwitch::run(), gem5::DistIface::SyncNode::SyncNode(), and gem5::DistIface::SyncSwitch::SyncSwitch().

◆ waitNum

unsigned gem5::DistIface::Sync::waitNum

protected

Number of receiver threads that not yet completed the current global synchronisation.

Definition at line 136 of file dist_iface.hh.

Referenced by abort(), gem5::DistIface::SyncNode::progress(), gem5::DistIface::SyncSwitch::progress(), gem5::DistIface::SyncNode::run(), gem5::DistIface::SyncSwitch::run(), gem5::DistIface::SyncNode::SyncNode(), and gem5::DistIface::SyncSwitch::SyncSwitch().

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

dev/net/dist_iface.hh
dev/net/dist_iface.cc

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ abort()

◆ drainComplete()

◆ init()

◆ progress()

◆ requestCkpt()

◆ requestExit()

◆ requestStopSync()

◆ run()

◆ serialize()

◆ unserialize()

Friends And Related Symbol Documentation

◆ SyncEvent

Member Data Documentation

◆ cv

◆ doCkpt

◆ doExit

◆ doStopSync

◆ isAbort

◆ lock

◆ nextAt

◆ nextRepeat

◆ waitNum