#include <eventq.hh>

Inheritance diagram for gem5::Event:

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.

void	squash ()
	Squash the current event.

bool	squashed () const
	Check whether the event is squashed.

bool	isExitEvent () const
	See if this is a SimExitEvent (without resorting to RTTI)

bool	isManaged () const
	Check whether this event will auto-delete.

bool	isAutoDelete () const
	The function returns true if the object is automatically deleted after the event is processed.

Tick	when () const
	Get the time that the event is scheduled.

Priority	priority () const
	Get the event priority.

virtual BaseGlobalEvent *	globalEvent ()
	If this is part of a GlobalEvent, return the pointer to the Global Event.

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

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


virtual	~Event ()

virtual const std::string	name () const

virtual const char *	description () const
	Return a C string describing the event.

void	dump () const
	Dump the current event data.

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)

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.

const std::string	instanceString () const
	Return the instance number as a string.


void	acquire ()
	Memory management hooks for events that have the Managed flag set.

void	release ()
	Managed event removed from the event queue.

virtual void	acquireImpl ()

virtual void	releaseImpl ()

Private Member Functions
void	setWhen (Tick when, EventQueue *q)

bool	initialized () const

Static Private Member Functions
static Event *	insertBefore (Event event, Event curr)

static Event *	removeItem (Event event, Event last)

Private Attributes
Event *	nextBin

Event *	nextInBin

Tick	_when
	timestamp when event should be processed

Priority	_priority
	event priority

Flags	flags

Counter	instance
	This event's unique ID.

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

Static Private Attributes
static Counter	instanceCounter = 0
	Global counter to generate unique IDs for Event instances.

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.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

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.

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

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.

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

static const Priority	Delayed_Writeback_Pri = -1
	For some reason "delayed" inter-cluster writebacks are scheduled before regular writebacks (which have default priority).

static const Priority	Default_Pri = 0
	Default is zero for historical reasons.

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.

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.

static const Priority	CPU_Tick_Pri = 50
	CPU ticks must come after other associated CPU events (such as writebacks).

static const Priority	CPU_Exit_Pri = 64
	If we want to exit a thread in a CPU, it comes after CPU_Tick_Pri.

static const Priority	Stat_Event_Pri = 90
	Statistics events (dump, reset, etc.) come after everything else, but before exit.

static const Priority	Progress_Event_Pri = 95
	Progress events come at the end.

static const Priority	Sim_Exit_Pri = 100
	If we want to exit on this cycle, it's the very last thing we do.

static const Priority	Maximum_Pri = SCHAR_MAX
	Maximum priority.

Protected Types inherited from gem5::EventBase
typedef unsigned short	FlagsType

typedef ::gem5::Flags< FlagsType >	Flags

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.

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 254 of file eventq.hh.

Constructor & Destructor Documentation

◆ Event()

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

inline

Definition at line 407 of file eventq.hh.

References gem5::curTick(), gem5::ArmISA::f, instance, instanceCounter, gem5::EventBase::PublicWrite, and queue.

Member Function Documentation

◆ acquire()

void gem5::Event::acquire ( )

protected

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 112 of file eventq.cc.

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

◆ acquireImpl()

void gem5::Event::acquireImpl ( )

protectedvirtual

Reimplemented in gem5::PyEvent.

Definition at line 126 of file eventq.cc.

Referenced by acquire().

◆ clearFlags() [1/2]

void gem5::Event::clearFlags ( )

inlineprotected

Definition at line 345 of file eventq.hh.

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

◆ clearFlags() [2/2]

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

inlineprotected

Definition at line 338 of file eventq.hh.

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

◆ getFlags()

Flags gem5::Event::getFlags ( ) const

inlineprotected

Definition at line 318 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 513 of file eventq.hh.

Referenced by gem5::simulate().

◆ initialized()

bool gem5::Event::initialized ( ) const

inlineprivate

Definition at line 311 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 417 of file eventq.cc.

References gem5::csprintf(), and instance.

Referenced by name(), and trace().

◆ isFlagSet()

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

inlineprotected

Definition at line 324 of file eventq.hh.

References flags, gem5::Flags< T >::isSet(), gem5::Flags< T >::noneSet(), and gem5::EventBase::PublicRead.

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

◆ process()

virtual void gem5::Event::process ( )

pure virtual

Referenced by gem5::AMDGPUMemoryManager::GPUMemPort::recvTimingResp(), and gem5::BaseRemoteGDB::scheduleInstCommitEvent().

◆ release()

void gem5::Event::release ( )

protected

Managed event removed from the event queue.

Definition at line 119 of file eventq.cc.

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

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

◆ releaseImpl()

void gem5::Event::releaseImpl ( )

protectedvirtual

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

Definition at line 131 of file eventq.cc.

References scheduled().

Referenced by release().

◆ removeItem()

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

staticprivate

Definition at line 161 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

cp	Checkpoint state

Implements gem5::Serializable.

Reimplemented in gem5::BasePixelPump::PixelEvent, and gem5::LocalSimLoopExitEvent.

Definition at line 265 of file eventq.cc.

References _priority, _when, flags, and SERIALIZE_SCALAR.

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

◆ setFlags()

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

inlineprotected

Definition at line 331 of file eventq.hh.

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

Referenced by gem5::AMDGPUSystemHub::AtomicResponseEvent::AtomicResponseEvent(), gem5::AMDGPUInterruptHandler::DmaEvent::DmaEvent(), gem5::EventFunctionWrapper::EventFunctionWrapper(), gem5::MemberEventWrapper< F >::MemberEventWrapper(), gem5::ComputeUnit::ScalarDataPort::MemReqEvent::MemReqEvent(), gem5::ComputeUnit::SQCPort::MemReqEvent::MemReqEvent(), gem5::RegisterFileCache::RegisterCacheEvent::RegisterCacheEvent(), gem5::RegisterFile::RegisterEvent::RegisterEvent(), gem5::AMDGPUSystemHub::ResponseEvent::ResponseEvent(), gem5::ComputeUnit::DataPort::SystemHubEvent::SystemHubEvent(), gem5::ComputeUnit::ScalarDataPort::SystemHubEvent::SystemHubEvent(), and gem5::FetchUnit::SystemHubEvent::SystemHubEvent().

◆ setWhen()

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

inlineprivate

Definition at line 299 of file eventq.hh.

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

◆ unserialize()

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

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Reimplemented in gem5::BasePixelPump::PixelEvent, and gem5::LocalSimLoopExitEvent.

Definition at line 274 of file eventq.cc.

References _priority, _when, gem5::Flags< T >::clear(), DPRINTF, flags, gem5::EventBase::Initialized, initialized(), gem5::Flags< T >::isSet(), name(), gem5::EventBase::Scheduled, scheduled(), gem5::Flags< T >::set(), gem5::EventBase::Squashed, and UNSERIALIZE_SCALAR.

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

Friends And Related Symbol Documentation

◆ EventQueue

friend class EventQueue

friend

Definition at line 256 of file eventq.hh.

Member Data Documentation

◆ _priority

Priority gem5::Event::_priority

private

event priority

Definition at line 275 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 274 of file eventq.hh.

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

◆ flags

Flags gem5::Event::flags

private

Definition at line 276 of file eventq.hh.

Referenced by acquire(), clearFlags(), clearFlags(), dump(), getFlags(), initialized(), isExitEvent(), isFlagSet(), isManaged(), release(), scheduled(), serialize(), gem5::EventQueue::serviceOne(), setFlags(), squash(), squashed(), unserialize(), and ~Event().

◆ 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 286 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 280 of file eventq.hh.

Referenced by Event().

◆ nextBin

Event* gem5::Event::nextBin

private

Definition at line 268 of file eventq.hh.

Referenced by gem5::EventQueue::debugVerify(), gem5::EventQueue::dump(), gem5::EventQueue::insert(), insertBefore(), gem5::EventQueue::remove(), removeItem(), and gem5::EventQueue::serviceOne().

◆ nextInBin

Event* gem5::Event::nextInBin

private

Definition at line 269 of file eventq.hh.

Referenced by gem5::EventQueue::debugVerify(), gem5::EventQueue::dump(), insertBefore(), removeItem(), and gem5::EventQueue::serviceOne().

◆ 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 290 of file eventq.hh.

Referenced by Event(), and setWhen().

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

sim/eventq.hh
sim/eventq.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Event()

Member Function Documentation

◆ acquire()

◆ acquireImpl()

◆ clearFlags() [1/2]

◆ clearFlags() [2/2]

◆ getFlags()

◆ globalEvent()

◆ initialized()

◆ insertBefore()

◆ instanceString()

◆ isFlagSet()

◆ process()

◆ release()

◆ releaseImpl()

◆ removeItem()

◆ serialize()

◆ setFlags()

◆ setWhen()

◆ unserialize()

Friends And Related Symbol Documentation

◆ EventQueue

Member Data Documentation

◆ _priority

◆ _when

◆ flags

◆ instance

◆ instanceCounter

◆ nextBin

◆ nextInBin

◆ queue