gem5  v20.1.0.0
Public Member Functions | Private Attributes | List of all members
DistIface::SyncSwitch Class Reference
Inheritance diagram for DistIface::SyncSwitch:
DistIface::Sync Serializable

Public Member Functions

 SyncSwitch (int num_nodes)
 
 ~SyncSwitch ()
 
bool run (bool same_tick) override
 Core method to perform a full dist sync. More...
 
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. More...
 
void requestCkpt (ReqType) override
 
void requestExit (ReqType) override
 
void requestStopSync (ReqType) override
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from DistIface::Sync
void init (Tick start, Tick repeat)
 Initialize periodic sync params. More...
 
void abort ()
 Abort processing an on-going sync event (in case of an error, e.g. More...
 
void drainComplete ()
 
- Public Member Functions inherited from Serializable
 Serializable ()
 
virtual ~Serializable ()
 
void serializeSection (CheckpointOut &cp, const char *name) const
 Serialize an object into a new section. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
void unserializeSection (CheckpointIn &cp, const std::string &name)
 

Private Attributes

unsigned numExitReq
 Counter for recording exit requests. More...
 
unsigned numCkptReq
 Counter for recording ckpt requests. More...
 
unsigned numStopSyncReq
 Counter for recording stop sync requests. More...
 
unsigned numNodes
 Number of connected simulated nodes. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Protected Attributes inherited from DistIface::Sync
std::mutex lock
 The lock to protect access to the Sync object. More...
 
std::condition_variable cv
 Condition variable for the simulation thread to wait on until all receiver threads completes the current global synchronisation. More...
 
unsigned waitNum
 Number of receiver threads that not yet completed the current global synchronisation. More...
 
bool doExit
 Flag is set if exit is permitted upon sync completion. More...
 
bool doCkpt
 Flag is set if taking a ckpt is permitted upon sync completion. More...
 
bool doStopSync
 Flag is set if sync is to stop upon sync completion. More...
 
Tick nextRepeat
 The repeat value for the next periodic sync. More...
 
Tick nextAt
 Tick for the next periodic sync (if the event is not scheduled yet) More...
 
bool isAbort
 Flag is set if the sync is aborted (e.g. More...
 

Detailed Description

Definition at line 238 of file dist_iface.hh.

Constructor & Destructor Documentation

◆ SyncSwitch()

DistIface::SyncSwitch::SyncSwitch ( int  num_nodes)

Definition at line 94 of file dist_iface.cc.

◆ ~SyncSwitch()

DistIface::SyncSwitch::~SyncSwitch ( )
inline

Definition at line 260 of file dist_iface.hh.

Member Function Documentation

◆ progress()

bool 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 DistIface::Sync.

Definition at line 199 of file dist_iface.cc.

References X86ISA::lock.

◆ requestCkpt()

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

Implements DistIface::Sync.

Definition at line 269 of file dist_iface.hh.

References panic.

◆ requestExit()

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

Implements DistIface::Sync.

Definition at line 272 of file dist_iface.hh.

References panic.

◆ requestStopSync()

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

Implements DistIface::Sync.

Definition at line 275 of file dist_iface.hh.

References panic.

◆ run()

bool 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 DistIface::Sync.

Definition at line 156 of file dist_iface.cc.

References curTick(), header, X86ISA::lock, Stats::none, DistIface::primary, and DistIface::sendCmd().

◆ serialize()

void DistIface::SyncSwitch::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements DistIface::Sync.

Definition at line 319 of file dist_iface.cc.

References SERIALIZE_SCALAR.

◆ unserialize()

void DistIface::SyncSwitch::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements DistIface::Sync.

Definition at line 325 of file dist_iface.cc.

References UNSERIALIZE_SCALAR.

Member Data Documentation

◆ numCkptReq

unsigned DistIface::SyncSwitch::numCkptReq
private

Counter for recording ckpt requests.

Definition at line 248 of file dist_iface.hh.

◆ numExitReq

unsigned DistIface::SyncSwitch::numExitReq
private

Counter for recording exit requests.

Definition at line 244 of file dist_iface.hh.

◆ numNodes

unsigned DistIface::SyncSwitch::numNodes
private

Number of connected simulated nodes.

Definition at line 256 of file dist_iface.hh.

◆ numStopSyncReq

unsigned DistIface::SyncSwitch::numStopSyncReq
private

Counter for recording stop sync requests.

Definition at line 252 of file dist_iface.hh.


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

Generated on Wed Sep 30 2020 14:02:23 for gem5 by doxygen 1.8.17