gem5  v20.1.0.0
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
BaseGlobalEvent::BarrierEvent Class Reference

The base class for the local events that will synchronize threads to perform the global event. More...

#include <global_event.hh>

Inheritance diagram for BaseGlobalEvent::BarrierEvent:
Event EventBase Serializable GlobalEvent::BarrierEvent GlobalSyncEvent::BarrierEvent

Public Member Functions

virtual BaseGlobalEventglobalEvent ()
 If this is part of a GlobalEvent, return the pointer to the Global Event. More...
 
- Public Member Functions inherited from Event
 Event (Priority p=Default_Pri, Flags f=0)
 
virtual void process ()=0
 
bool scheduled () const
 Determine if the current event is scheduled. More...
 
void squash ()
 Squash the current event. More...
 
bool squashed () const
 Check whether the event is squashed. More...
 
bool isExitEvent () const
 See if this is a SimExitEvent (without resorting to RTTI) More...
 
bool isManaged () const
 Check whether this event will auto-delete. More...
 
bool isAutoDelete () const
 The function returns true if the object is automatically deleted after the event is processed. More...
 
Tick when () const
 Get the time that the event is scheduled. More...
 
Priority priority () const
 Get the event priority. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
virtual ~Event ()
 
virtual const std::string name () const
 
virtual const char * description () const
 Return a C string describing the event. More...
 
void dump () const
 Dump the current event data. More...
 
- 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)
 

Protected Member Functions

 BarrierEvent (BaseGlobalEvent *global_event, Priority p, Flags f)
 
 ~BarrierEvent ()
 
bool globalBarrier ()
 
- Protected Member Functions inherited from Event
Flags getFlags () const
 
bool isFlagSet (Flags _flags) const
 
void setFlags (Flags _flags)
 
void clearFlags (Flags _flags)
 
void clearFlags ()
 
virtual void trace (const char *action)
 This function isn't really useful if TRACING_ON is not defined. More...
 
const std::string instanceString () const
 Return the instance number as a string. More...
 
void acquire ()
 Memory management hooks for events that have the Managed flag set. More...
 
void release ()
 Managed event removed from the event queue. More...
 
virtual void acquireImpl ()
 
virtual void releaseImpl ()
 

Protected Attributes

BaseGlobalEvent_globalEvent
 

Friends

class BaseGlobalEvent
 

Additional Inherited Members

- Public Types inherited from EventBase
typedef int8_t Priority
 
- 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)
 
- 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
 
- 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 base class for the local events that will synchronize threads to perform the global event.

This class is abstract, since it derives from the abstract Event class but still does not define the required process() method.

Definition at line 76 of file global_event.hh.

Constructor & Destructor Documentation

◆ BarrierEvent()

BaseGlobalEvent::BarrierEvent::BarrierEvent ( BaseGlobalEvent global_event,
Priority  p,
Flags  f 
)
inlineprotected

Definition at line 81 of file global_event.hh.

◆ ~BarrierEvent()

BaseGlobalEvent::BarrierEvent::~BarrierEvent ( )
protected

Member Function Documentation

◆ globalBarrier()

bool BaseGlobalEvent::BarrierEvent::globalBarrier ( )
inlineprotected

◆ globalEvent()

virtual BaseGlobalEvent* BaseGlobalEvent::BarrierEvent::globalEvent ( )
inlinevirtual

If this is part of a GlobalEvent, return the pointer to the Global Event.

By default, there is no GlobalEvent, so return NULL. (Overridden in GlobalEvent::BarrierEvent.)

Reimplemented from Event.

Definition at line 105 of file global_event.hh.

References _globalEvent.

Friends And Related Function Documentation

◆ BaseGlobalEvent

friend class BaseGlobalEvent
friend

Definition at line 88 of file global_event.hh.

Member Data Documentation

◆ _globalEvent

BaseGlobalEvent* BaseGlobalEvent::BarrierEvent::_globalEvent
protected

Definition at line 79 of file global_event.hh.

Referenced by globalBarrier(), globalEvent(), and ~BarrierEvent().


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

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