gem5  v21.1.0.2
Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
gem5::Event Class Referenceabstract

#include <eventq.hh>

Inheritance diagram for gem5::Event:
gem5::EventBase gem5::Serializable gem5::EventWrapper< gem5::BaseRemoteGDB, &BaseRemoteGDB::singleStep > gem5::EventWrapper< gem5::memory::qos::MemSinkCtrl, &MemSinkCtrl::processNextReqEvent > gem5::EventWrapper< gem5::PowerDomain, &PowerDomain::setFollowerPowerStates > gem5::EventWrapper< gem5::SMMUv3, &SMMUv3::processCommands > gem5::EventWrapper< gem5::SMMUv3DeviceInterface, &SMMUv3DeviceInterface::atsSendDeviceRetry > gem5::EventWrapper< sc_gem5::Kernel, &Kernel::t0Handler > gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::maxTickFunc > gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::pause > gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::runReady > gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::stop > gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::timeAdvances > gem5::BaseGlobalEvent::BarrierEvent gem5::BasePixelPump::PixelEvent gem5::BaseRemoteGDB::TrapEvent gem5::ComputeUnit::ScalarDataPort::MemReqEvent gem5::CountedExitEvent gem5::CPUProgressEvent gem5::DmaReadFifo::DmaDoneEvent gem5::DVFSHandler::UpdateEvent gem5::EventFunctionWrapper gem5::EventWrapper< T, F > gem5::GPUComputeDriver::DriverWakeupEvent gem5::HSAPacketProcessor::QueueProcessEvent gem5::HWScheduler::SchedulerWakeupEvent gem5::Intel8254Timer::Counter::CounterEvent gem5::LdsState::TickEvent gem5::LocalSimLoopExitEvent gem5::MC146818::RTCEvent gem5::MC146818::RTCTickEvent gem5::o3::Fetch::FinishTranslationEvent gem5::o3::InstructionQueue::FUCompletion gem5::o3::LSQUnit::WritebackEvent gem5::PyEvent gem5::RegisterFile::RegisterEvent gem5::SMMUDeviceRetryEvent gem5::TesterThread::DeadlockCheckEvent gem5::TesterThread::TesterThreadEvent gem5::TimingSimpleCPU::IprEvent gem5::TimingSimpleCPU::TimingCPUPort::TickEvent gem5::Trace::TarmacParserRecord::TarmacParserRecordEvent gem5::X86ISA::GpuTLB::TLBEvent sc_gem5::Scheduler::TimeSlot

Public Member Functions

 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...
 
virtual BaseGlobalEventglobalEvent ()
 If this is part of a GlobalEvent, return the pointer to the Global Event. 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 gem5::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

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 ()
 

Private Member Functions

void setWhen (Tick when, EventQueue *q)
 
bool initialized () const
 

Static Private Member Functions

static EventinsertBefore (Event *event, Event *curr)
 
static EventremoveItem (Event *event, Event *last)
 

Private Attributes

EventnextBin
 
EventnextInBin
 
Tick _when
 timestamp when event should be processed More...
 
Priority _priority
 event priority More...
 
Flags flags
 
Counter instance
 This event's unique ID. More...
 
EventQueuequeue
 queue to which this event belongs (though it may or may not be scheduled on this queue yet) More...
 

Static Private Attributes

static Counter instanceCounter = 0
 Global counter to generate unique IDs for Event instances. More...
 

Friends

class EventQueue
 

Additional Inherited Members

- Public Types inherited from gem5::EventBase
typedef int8_t Priority
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Static Public Attributes inherited from gem5::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 gem5::EventBase
typedef unsigned short FlagsType
 
typedef ::gem5::Flags< FlagsTypeFlags
 
- Static Protected Attributes inherited from gem5::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

Definition at line 251 of file eventq.hh.

Constructor & Destructor Documentation

◆ Event()

gem5::Event::Event ( Priority  p = Default_Pri,
Flags  f = 0 
)
inline

Member Function Documentation

◆ acquire()

void gem5::Event::acquire ( )
inlineprotected

Memory management hooks for events that have the Managed flag set.

Events can use automatic memory management by setting the Managed flag. The default implementation automatically deletes events once they have been removed from the event queue. This typically happens when events are descheduled or have been triggered and not rescheduled.

The methods below may be overridden by events that need custom memory management. For example, events exported to Python need to impement reference counting to ensure that the Python implementation of the event is kept alive while it lives in the event queue.

Note
Memory managers are responsible for implementing reference counting (by overriding both acquireImpl() and releaseImpl()) or checking if an event is no longer scheduled in releaseImpl() before deallocating it. Managed event scheduled and being held in the event queue.

Definition at line 383 of file eventq.hh.

References acquireImpl(), flags, gem5::Flags< T >::isSet(), and gem5::EventBase::Managed.

◆ acquireImpl()

virtual void gem5::Event::acquireImpl ( )
inlineprotectedvirtual

Reimplemented in gem5::PyEvent.

Definition at line 397 of file eventq.hh.

Referenced by acquire().

◆ clearFlags() [1/2]

void gem5::Event::clearFlags ( )
inlineprotected

Definition at line 342 of file eventq.hh.

References gem5::Flags< T >::clear(), flags, and gem5::EventBase::PublicWrite.

◆ clearFlags() [2/2]

void gem5::Event::clearFlags ( Flags  _flags)
inlineprotected

◆ getFlags()

Flags gem5::Event::getFlags ( ) const
inlineprotected

Definition at line 315 of file eventq.hh.

References flags, and gem5::EventBase::PublicRead.

◆ globalEvent()

virtual BaseGlobalEvent* gem5::Event::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 in gem5::BaseGlobalEvent::BarrierEvent.

Definition at line 520 of file eventq.hh.

Referenced by gem5::simulate().

◆ initialized()

bool gem5::Event::initialized ( ) const
inlineprivate

Definition at line 308 of file eventq.hh.

References flags, gem5::EventBase::Initialized, and gem5::EventBase::InitMask.

Referenced by unserialize().

◆ insertBefore()

Event * gem5::Event::insertBefore ( Event event,
Event curr 
)
staticprivate

Definition at line 91 of file eventq.cc.

References gem5::MipsISA::event, nextBin, and nextInBin.

Referenced by gem5::EventQueue::insert().

◆ instanceString()

const std::string gem5::Event::instanceString ( ) const
protected

Return the instance number as a string.

Definition at line 391 of file eventq.cc.

References gem5::csprintf(), and instance.

Referenced by name(), and trace().

◆ isFlagSet()

bool gem5::Event::isFlagSet ( Flags  _flags) const
inlineprotected

◆ process()

virtual void gem5::Event::process ( )
pure virtual

Implemented in gem5::BasePixelPump::PixelEvent, sc_gem5::Scheduler::TimeSlot, gem5::CountedExitEvent, gem5::TesterThread::DeadlockCheckEvent, gem5::GPUComputeDriver::DriverWakeupEvent, gem5::TesterThread::TesterThreadEvent, gem5::LocalSimLoopExitEvent, gem5::PyEvent, gem5::EventFunctionWrapper, gem5::EventWrapper< T, F >, gem5::EventWrapper< gem5::memory::qos::MemSinkCtrl, &MemSinkCtrl::processNextReqEvent >, gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::timeAdvances >, gem5::EventWrapper< sc_gem5::Kernel, &Kernel::t0Handler >, gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::stop >, gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::maxTickFunc >, gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::pause >, gem5::EventWrapper< sc_gem5::Scheduler, &Scheduler::runReady >, gem5::EventWrapper< gem5::SMMUv3DeviceInterface, &SMMUv3DeviceInterface::atsSendDeviceRetry >, gem5::EventWrapper< gem5::PowerDomain, &PowerDomain::setFollowerPowerStates >, gem5::EventWrapper< gem5::SMMUv3, &SMMUv3::processCommands >, gem5::EventWrapper< gem5::BaseRemoteGDB, &BaseRemoteGDB::singleStep >, gem5::ComputeUnit::ScalarDataPort::MemReqEvent, gem5::DmaReadFifo::DmaDoneEvent, gem5::o3::LSQUnit::WritebackEvent, gem5::X86ISA::GpuTLB::TLBEvent, gem5::TimingSimpleCPU::IprEvent, gem5::BaseRemoteGDB::TrapEvent, gem5::HSAPacketProcessor::QueueProcessEvent, gem5::DVFSHandler::UpdateEvent, gem5::TimingSimpleCPU::DcachePort::DTickEvent, gem5::GlobalEvent::BarrierEvent, gem5::o3::Fetch::FinishTranslationEvent, gem5::LdsState::TickEvent, gem5::o3::InstructionQueue::FUCompletion, gem5::Trace::TarmacParserRecord::TarmacParserRecordEvent, gem5::RegisterFile::MarkRegBusyScbEvent, gem5::CPUProgressEvent, gem5::Intel8254Timer::Counter::CounterEvent, gem5::RegisterFile::MarkRegFreeScbEvent, gem5::MC146818::RTCTickEvent, gem5::HWScheduler::SchedulerWakeupEvent, gem5::MC146818::RTCEvent, and gem5::SMMUDeviceRetryEvent.

Referenced by gem5::BaseRemoteGDB::scheduleInstCommitEvent().

◆ release()

void gem5::Event::release ( )
inlineprotected

Managed event removed from the event queue.

Definition at line 392 of file eventq.hh.

References flags, gem5::Flags< T >::isSet(), gem5::EventBase::Managed, and releaseImpl().

Referenced by gem5::BaseGlobalEvent::BarrierEvent::globalBarrier().

◆ releaseImpl()

virtual void gem5::Event::releaseImpl ( )
inlineprotectedvirtual

Reimplemented in sc_gem5::Scheduler::TimeSlot, and gem5::PyEvent.

Definition at line 399 of file eventq.hh.

References scheduled().

Referenced by release().

◆ removeItem()

Event * gem5::Event::removeItem ( Event event,
Event last 
)
staticprivate

Definition at line 135 of file eventq.cc.

References gem5::MipsISA::event, nextBin, nextInBin, and panic.

Referenced by gem5::EventQueue::remove().

◆ serialize()

void gem5::Event::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Reimplemented in gem5::LocalSimLoopExitEvent.

Definition at line 239 of file eventq.cc.

References _priority, _when, flags, and SERIALIZE_SCALAR.

Referenced by gem5::LocalSimLoopExitEvent::serialize(), and gem5::BasePixelPump::PixelEvent::serialize().

◆ setFlags()

void gem5::Event::setFlags ( Flags  _flags)
inlineprotected

◆ setWhen()

void gem5::Event::setWhen ( Tick  when,
EventQueue q 
)
inlineprivate

Definition at line 296 of file eventq.hh.

References _when, gem5::curTick(), gem5::ArmISA::q, queue, and when().

◆ unserialize()

void gem5::Event::unserialize ( CheckpointIn cp)
overridevirtual

Friends And Related Function Documentation

◆ EventQueue

friend class EventQueue
friend

Definition at line 253 of file eventq.hh.

Member Data Documentation

◆ _priority

Priority gem5::Event::_priority
private

event priority

Definition at line 272 of file eventq.hh.

Referenced by dump(), priority(), serialize(), and unserialize().

◆ _when

Tick gem5::Event::_when
private

timestamp when event should be processed

Definition at line 271 of file eventq.hh.

Referenced by serialize(), setWhen(), unserialize(), and when().

◆ flags

Flags gem5::Event::flags
private

◆ instance

Counter gem5::Event::instance
private

This event's unique ID.

We can also use pointer values for this but they're not consistent across runs making debugging more difficult. Thus we use a global counter value when debugging.

Definition at line 283 of file eventq.hh.

Referenced by Event(), and instanceString().

◆ instanceCounter

Counter gem5::Event::instanceCounter = 0
staticprivate

Global counter to generate unique IDs for Event instances.

Definition at line 277 of file eventq.hh.

Referenced by Event().

◆ nextBin

Event* gem5::Event::nextBin
private

◆ nextInBin

Event* gem5::Event::nextInBin
private

◆ queue

EventQueue* gem5::Event::queue
private

queue to which this event belongs (though it may or may not be scheduled on this queue yet)

Definition at line 287 of file eventq.hh.

Referenced by Event(), and setWhen().


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

Generated on Tue Sep 21 2021 12:27:31 for gem5 by doxygen 1.8.17