Inheritance diagram for gem5::DistIface::SyncSwitch:

Public Member Functions
	SyncSwitch (int num_nodes)

	~SyncSwitch ()

bool	run (bool same_tick) override
	Core method to perform a full dist sync.

bool	progress (Tick max_req_tick, Tick next_repeat, ReqType do_ckpt, ReqType do_exit, ReqType do_stop_sync) override
	Callback when the receiver thread gets a sync ack message.

void	requestCkpt (ReqType) override

void	requestExit (ReqType) override

void	requestStopSync (ReqType) override

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

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

Public Member Functions inherited from gem5::DistIface::Sync
void	init (Tick start, Tick repeat)
	Initialize periodic sync params.

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

void	drainComplete ()

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)

Private Attributes
unsigned	numExitReq
	Counter for recording exit requests.

unsigned	numCkptReq
	Counter for recording ckpt requests.

unsigned	numStopSyncReq
	Counter for recording stop sync requests.

unsigned	numNodes
	Number of connected simulated nodes.

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.

Protected Attributes inherited from gem5::DistIface::Sync
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.

Detailed Description

Definition at line 241 of file dist_iface.hh.

Constructor & Destructor Documentation

◆ SyncSwitch()

gem5::DistIface::SyncSwitch::SyncSwitch ( int num_nodes )

Definition at line 96 of file dist_iface.cc.

References gem5::DistIface::Sync::doCkpt, gem5::DistIface::Sync::doExit, gem5::DistIface::Sync::doStopSync, gem5::DistIface::Sync::isAbort, gem5::DistIface::Sync::nextAt, gem5::DistIface::Sync::nextRepeat, numCkptReq, numExitReq, numNodes, numStopSyncReq, and gem5::DistIface::Sync::waitNum.

◆ ~SyncSwitch()

gem5::DistIface::SyncSwitch::~SyncSwitch ( )

inline

Definition at line 263 of file dist_iface.hh.

Member Function Documentation

◆ progress()

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

overridevirtual

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)

Implements gem5::DistIface::Sync.

Definition at line 201 of file dist_iface.cc.

References gem5::DistIface::Sync::cv, gem5::DistIface::Sync::doCkpt, gem5::DistIface::Sync::doExit, gem5::DistIface::Sync::doStopSync, gem5::DistIface::Sync::isAbort, gem5::DistIface::Sync::lock, gem5::DistIface::Sync::nextAt, gem5::DistIface::Sync::nextRepeat, numCkptReq, numExitReq, numStopSyncReq, and gem5::DistIface::Sync::waitNum.

◆ requestCkpt()

void gem5::DistIface::SyncSwitch::requestCkpt ( ReqType )

inlineoverridevirtual

Implements gem5::DistIface::Sync.

Definition at line 272 of file dist_iface.hh.

References panic.

◆ requestExit()

void gem5::DistIface::SyncSwitch::requestExit ( ReqType )

inlineoverridevirtual

Implements gem5::DistIface::Sync.

Definition at line 275 of file dist_iface.hh.

References panic.

◆ requestStopSync()

void gem5::DistIface::SyncSwitch::requestStopSync ( ReqType )

inlineoverridevirtual

Implements gem5::DistIface::Sync.

Definition at line 278 of file dist_iface.hh.

References panic.

◆ run()

bool gem5::DistIface::SyncSwitch::run ( bool same_tick )

overridevirtual

Core method to perform a full dist sync.

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

Implements gem5::DistIface::Sync.

Definition at line 158 of file dist_iface.cc.

References gem5::curTick(), gem5::DistIface::Sync::cv, gem5::DistIface::Sync::doCkpt, gem5::DistIface::Sync::doExit, gem5::DistIface::Sync::doStopSync, header, gem5::DistIface::Sync::isAbort, gem5::DistIface::Sync::lock, gem5::DistIface::Sync::nextAt, gem5::DistIface::Sync::nextRepeat, numCkptReq, numExitReq, numNodes, numStopSyncReq, gem5::DistIface::primary, and gem5::DistIface::Sync::waitNum.

◆ serialize()

void gem5::DistIface::SyncSwitch::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::DistIface::Sync.

Definition at line 321 of file dist_iface.cc.

References numExitReq, and SERIALIZE_SCALAR.

◆ unserialize()

void gem5::DistIface::SyncSwitch::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::DistIface::Sync.

Definition at line 327 of file dist_iface.cc.

References numExitReq, and UNSERIALIZE_SCALAR.

Member Data Documentation

◆ numCkptReq

unsigned gem5::DistIface::SyncSwitch::numCkptReq

private

Counter for recording ckpt requests.

Definition at line 251 of file dist_iface.hh.

Referenced by progress(), run(), and SyncSwitch().

◆ numExitReq

unsigned gem5::DistIface::SyncSwitch::numExitReq

private

Counter for recording exit requests.

Definition at line 247 of file dist_iface.hh.

Referenced by progress(), run(), serialize(), SyncSwitch(), and unserialize().

◆ numNodes

unsigned gem5::DistIface::SyncSwitch::numNodes

private

Number of connected simulated nodes.

Definition at line 259 of file dist_iface.hh.

Referenced by run(), and SyncSwitch().

◆ numStopSyncReq

unsigned gem5::DistIface::SyncSwitch::numStopSyncReq

private

Counter for recording stop sync requests.

Definition at line 255 of file dist_iface.hh.

Referenced by progress(), run(), and 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

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SyncSwitch()

◆ ~SyncSwitch()

Member Function Documentation

◆ progress()

◆ requestCkpt()

◆ requestExit()

◆ requestStopSync()

◆ run()

◆ serialize()

◆ unserialize()

Member Data Documentation

◆ numCkptReq

◆ numExitReq

◆ numNodes

◆ numStopSyncReq