gem5  v20.1.0.0
Public Member Functions | Private Attributes | List of all members
DistIface::SyncEvent Class Reference

The global event to schedule periodic dist sync. More...

Inheritance diagram for DistIface::SyncEvent:
GlobalSyncEvent BaseGlobalEventTemplate< GlobalSyncEvent > BaseGlobalEvent EventBase

Public Member Functions

 SyncEvent ()
 Only the firstly instantiated DistIface object will call this constructor. More...
 ~SyncEvent ()
void start ()
 Schedule the first periodic sync event. More...
void process () override
 This is a global event so process() will only be called by exactly one simulation thread. More...
bool draining () const
void draining (bool fl)
- Public Member Functions inherited from GlobalSyncEvent
 GlobalSyncEvent (Priority p, Flags f)
 GlobalSyncEvent (Tick when, Tick _repeat, Priority p, Flags f)
void process ()
const char * description () const
- Public Member Functions inherited from BaseGlobalEvent
 BaseGlobalEvent (Priority p, Flags f)
virtual ~BaseGlobalEvent ()
void schedule (Tick when)
bool scheduled () const
Tick when () const
void deschedule ()
void reschedule (Tick when)

Private Attributes

bool _draining
 Flag to set when the system is draining. More...

Additional Inherited Members

- Public Types inherited from GlobalSyncEvent
typedef BaseGlobalEventTemplate< GlobalSyncEventBase
- Public Types inherited from EventBase
typedef int8_t Priority
- Public Attributes inherited from GlobalSyncEvent
Tick repeat
- Static Public Attributes inherited from EventBase
static const Priority Minimum_Pri = SCHAR_MIN
 Event priorities, to provide tie-breakers for events scheduled at the same cycle. More...
static const Priority Debug_Enable_Pri = -101
 If we enable tracing on a particular cycle, do that as the very first thing so we don't miss any of the events on that cycle (even if we enter the debugger). More...
static const Priority Debug_Break_Pri = -100
 Breakpoints should happen before anything else (except enabling trace output), so we don't miss any action when debugging. More...
static const Priority CPU_Switch_Pri = -31
 CPU switches schedule the new CPU's tick event for the same cycle (after unscheduling the old CPU's tick event). More...
static const Priority Delayed_Writeback_Pri = -1
 For some reason "delayed" inter-cluster writebacks are scheduled before regular writebacks (which have default priority). More...
static const Priority Default_Pri = 0
 Default is zero for historical reasons. More...
static const Priority DVFS_Update_Pri = 31
 DVFS update event leads to stats dump therefore given a lower priority to ensure all relevant states have been updated. More...
static const Priority Serialize_Pri = 32
 Serailization needs to occur before tick events also, so that a serialize/unserialize is identical to an on-line CPU switch. More...
static const Priority CPU_Tick_Pri = 50
 CPU ticks must come after other associated CPU events (such as writebacks). More...
static const Priority CPU_Exit_Pri = 64
 If we want to exit a thread in a CPU, it comes after CPU_Tick_Pri. More...
static const Priority Stat_Event_Pri = 90
 Statistics events (dump, reset, etc.) come after everything else, but before exit. More...
static const Priority Progress_Event_Pri = 95
 Progress events come at the end. More...
static const Priority Sim_Exit_Pri = 100
 If we want to exit on this cycle, it's the very last thing we do. More...
static const Priority Maximum_Pri = SCHAR_MAX
 Maximum priority. More...
- Protected Types inherited from EventBase
typedef unsigned short FlagsType
typedef ::Flags< FlagsTypeFlags
- Protected Member Functions inherited from BaseGlobalEventTemplate< GlobalSyncEvent >
 BaseGlobalEventTemplate (Priority p, Flags f)
- Protected Attributes inherited from BaseGlobalEvent
Barrier barrier
 The barrier that all threads wait on before performing the global event. More...
std::vector< BarrierEvent * > barrierEvent
 The individual local event instances (one per thread/event queue). More...
- Static Protected Attributes inherited from EventBase
static const FlagsType PublicRead = 0x003f
static const FlagsType PublicWrite = 0x001d
static const FlagsType Squashed = 0x0001
static const FlagsType Scheduled = 0x0002
static const FlagsType Managed = 0x0004
static const FlagsType AutoDelete = Managed
static const FlagsType Reserved0 = 0x0008
 This used to be AutoSerialize. More...
static const FlagsType IsExitEvent = 0x0010
static const FlagsType IsMainQueue = 0x0020
static const FlagsType Initialized = 0x7a40
static const FlagsType InitMask = 0xffc0

Detailed Description

The global event to schedule periodic dist sync.

It is used as a singleton object.

The periodic synchronisation works as follows.

  1. A SyncEvent is scheduled as a global event when startup() is called.
  2. The process() method of the SyncEvent initiates a new barrier for each simulated Ethernet link.
  3. Simulation thread(s) then waits until all receiver threads complete the ongoing barrier. The global sync event is done.

Definition at line 295 of file dist_iface.hh.

Constructor & Destructor Documentation

◆ SyncEvent()

DistIface::SyncEvent::SyncEvent ( )

Only the firstly instantiated DistIface object will call this constructor.

Definition at line 307 of file dist_iface.hh.

◆ ~SyncEvent()

DistIface::SyncEvent::~SyncEvent ( )

Definition at line 309 of file dist_iface.hh.

Member Function Documentation

◆ draining() [1/2]

bool DistIface::SyncEvent::draining ( ) const

Definition at line 321 of file dist_iface.hh.

References _draining.

Referenced by DistIface::drain(), and DistIface::drainResume().

◆ draining() [2/2]

void DistIface::SyncEvent::draining ( bool  fl)

Definition at line 322 of file dist_iface.hh.

References _draining.

◆ process()

void DistIface::SyncEvent::process ( )

This is a global event so process() will only be called by exactly one simulation thread.

(See further comments in the .cc file.)

Implements BaseGlobalEvent.

Definition at line 365 of file

References curEventQueue(), curTick(), DistIface::Sync::doStopSync, exitSimLoop(), inform, DistIface::isSwitch, DistIface::Sync::nextRepeat, panic_if, MipsISA::sr, ThreadContext::Suspended, DistIface::sync, and warn_once.

◆ start()

void DistIface::SyncEvent::start ( )

Schedule the first periodic sync event.

Definition at line 331 of file

References curTick(), inform, DistIface::Sync::nextRepeat, panic, and DistIface::sync.

Referenced by DistIface::readyToExit(), DistIface::startup(), and DistIface::toggleSync().

Member Data Documentation

◆ _draining

bool DistIface::SyncEvent::_draining

Flag to set when the system is draining.

Definition at line 301 of file dist_iface.hh.

Referenced by draining().

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