The Event Queue API.

These methods relate to the event queue interface. More...

Typedefs
typedef int8_t	gem5::EventBase::Priority

Functions
virtual void	gem5::Event::trace (const char *action)
	This function isn't really useful if TRACING_ON is not defined.
bool	gem5::Event::scheduled () const
	Determine if the current event is scheduled.
void	gem5::Event::squash ()
	Squash the current event.
bool	gem5::Event::squashed () const
	Check whether the event is squashed.
bool	gem5::Event::isExitEvent () const
	See if this is a SimExitEvent (without resorting to RTTI)
bool	gem5::Event::isManaged () const
	Check whether this event will auto-delete.
bool	gem5::Event::isAutoDelete () const
	The function returns true if the object is automatically deleted after the event is processed.
Tick	gem5::Event::when () const
	Get the time that the event is scheduled.
Priority	gem5::Event::priority () const
	Get the event priority.
bool	gem5::operator< (const Event &l, const Event &r)
bool	gem5::operator> (const Event &l, const Event &r)
bool	gem5::operator<= (const Event &l, const Event &r)
bool	gem5::operator>= (const Event &l, const Event &r)
bool	gem5::operator== (const Event &l, const Event &r)
bool	gem5::operator!= (const Event &l, const Event &r)
	gem5::EventQueue::ScopedMigration::ScopedMigration (EventQueue *_new_eq, bool _doMigrate=true)
	Temporarily migrate execution to a different event queue.
	gem5::EventQueue::EventQueue (const std::string &n)
void	gem5::EventQueue::schedule (Event *event, Tick when, bool global=false)
	Schedule the given event on this queue.
void	gem5::EventQueue::deschedule (Event *event)
	Deschedule the specified event.
void	gem5::EventQueue::reschedule (Event *event, Tick when, bool always=false)
	Reschedule the specified event.
Tick	gem5::EventQueue::getCurTick () const
	While curTick() is useful for any object assigned to this event queue, if an object that is assigned to another event queue (or a non-event object) need to access the current tick of this event queue, this function is used.
void	gem5::EventQueue::serviceEvents (Tick when)
	process all events up to the given timestamp.
bool	gem5::EventQueue::empty () const
	Returns true if no events are queued.
void	gem5::EventQueue::dump () const
	This is a debugging function which will print everything on the event queue.
virtual void	gem5::EventQueue::wakeup (Tick when=(Tick) -1)
	Function to signal that the event loop should be woken up because an event has been scheduled by an agent outside the gem5 event loop(s) whose event insertion may not have been noticed by gem5.
EventQueue *	gem5::EventManager::eventQueue () const
void	gem5::EventManager::schedule (Event &event, Tick when)
void	gem5::EventManager::deschedule (Event &event)
void	gem5::EventManager::reschedule (Event &event, Tick when, bool always=false)
void	gem5::EventManager::schedule (Event *event, Tick when)
void	gem5::EventManager::deschedule (Event *event)
void	gem5::EventManager::reschedule (Event *event, Tick when, bool always=false)
void	gem5::EventManager::wakeupEventQueue (Tick when=(Tick) -1)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.
	gem5::EventFunctionWrapper::EventFunctionWrapper (const std::function< void(void)> &callback, const std::string &name, bool del=false, Priority p=Default_Pri)
	This function wraps a function into an event, to be executed later.
void	gem5::EventFunctionWrapper::process ()
const std::string	gem5::EventFunctionWrapper::name () const
const char *	gem5::EventFunctionWrapper::description () const
	Return a C string describing the event.

Variables
static const Priority	gem5::EventBase::Minimum_Pri = SCHAR_MIN
	Event priorities, to provide tie-breakers for events scheduled at the same cycle.
static const Priority	gem5::EventBase::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	gem5::EventBase::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	gem5::EventBase::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	gem5::EventBase::Delayed_Writeback_Pri = -1
	For some reason "delayed" inter-cluster writebacks are scheduled before regular writebacks (which have default priority).
static const Priority	gem5::EventBase::Default_Pri = 0
	Default is zero for historical reasons.
static const Priority	gem5::EventBase::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	gem5::EventBase::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	gem5::EventBase::CPU_Tick_Pri = 50
	CPU ticks must come after other associated CPU events (such as writebacks).
static const Priority	gem5::EventBase::CPU_Exit_Pri = 64
	If we want to exit a thread in a CPU, it comes after CPU_Tick_Pri.
static const Priority	gem5::EventBase::Stat_Event_Pri = 90
	Statistics events (dump, reset, etc.) come after everything else, but before exit.
static const Priority	gem5::EventBase::Progress_Event_Pri = 95
	Progress events come at the end.
static const Priority	gem5::EventBase::Sim_Exit_Pri = 100
	If we want to exit on this cycle, it's the very last thing we do.
static const Priority	gem5::EventBase::Maximum_Pri = SCHAR_MAX
	Maximum priority.
virtual	gem5::Event::~Event ()
virtual const std::string	gem5::Event::name () const
virtual const char *	gem5::Event::description () const
	Return a C string describing the event.
void	gem5::Event::dump () const
	Dump the current event data.
virtual const std::string	gem5::EventQueue::name () const
void	gem5::EventQueue::name (const std::string &st)
	gem5::EventManager::EventManager (EventManager &em)
	Event manger manages events in the event queue.
	gem5::EventManager::EventManager (EventManager *em)
	gem5::EventManager::EventManager (EventQueue *eq)

Detailed Description

These methods relate to the event queue interface.

Typedef Documentation

Priority

typedef int8_t gem5::EventBase::Priority

Definition at line 126 of file eventq.hh.

Function Documentation

deschedule() [1/3]

void gem5::EventManager::deschedule ( Event & event )

inline

Definition at line 1021 of file eventq.hh.

References gem5::MipsISA::event, and eventq.

Referenced by gem5::BaseCPU::activateContext(), gem5::IGbE::chkInterrupt(), gem5::HDLcd::cmdDisable(), gem5::MemTest::completeRequest(), gem5::IGbE::cpuPostInt(), gem5::ruby::GPUCoalescer::descheduleDeadlockEvent(), gem5::ruby::Sequencer::descheduleDeadlockEvent(), gem5::BaseCPU::deschedulePowerGatingEvent(), gem5::AtomicSimpleCPU::drain(), gem5::BaseKvmCPU::drain(), gem5::BaseTrafficGen::drain(), gem5::IGbE::drain(), gem5::o3::CPU::drain(), gem5::GenericTimer::handleStream(), gem5::LupioTMR::lupioTMRWrite(), gem5::DVFSHandler::perfLevel(), gem5::IGbE::postInterrupt(), gem5::Uart8250::readIir(), gem5::Uart8250::readRbr(), gem5::PL031::resyncMatch(), gem5::SparcISA::ISA::setFSReg(), gem5::Iris::ThreadContext::setStatus(), gem5::BasePixelPump::stop(), gem5::Sp805::stopCounter(), gem5::memory::DRAMInterface::Rank::suspend(), gem5::AtomicSimpleCPU::suspendContext(), gem5::BaseKvmCPU::suspendContext(), gem5::TimingSimpleCPU::suspendContext(), gem5::Root::timeSyncEnable(), gem5::o3::CPU::tryDrain(), gem5::GPUDispatcher::unserialize(), gem5::EnergyCtrl::write(), gem5::MC146818::writeData(), gem5::Uart8250::writeIer(), gem5::Uart8250::writeThr(), gem5::AtomicSimpleCPU::~AtomicSimpleCPU(), gem5::MC146818::~MC146818(), and gem5::Iris::ThreadContext::~ThreadContext().

deschedule() [2/3]

void gem5::EventManager::deschedule ( Event * event )

inline

Definition at line 1048 of file eventq.hh.

References gem5::MipsISA::event, and eventq.

deschedule() [3/3]

void gem5::EventQueue::deschedule ( Event * event )

inline

Deschedule the specified event.

Should be called only from the owning thread.

Definition at line 790 of file eventq.hh.

References gem5::curEventQueue(), gem5::MipsISA::event, gem5::inParallelMode, remove(), gem5::EventBase::Scheduled, and gem5::EventBase::Squashed.

Referenced by gem5::pybind_init_event(), and ~EventQueue().

description() [1/2]

const char * gem5::Event::description ( ) const

virtual

Return a C string describing the event.

This string should not be dynamically allocated; just a const char array describing the event class.

Reimplemented in gem5::AMDGPUInterruptHandler::DmaEvent, gem5::ComputeUnit::ScalarDataPort::MemReqEvent, gem5::ComputeUnit::SQCPort::MemReqEvent, gem5::CountedExitEvent, gem5::CPUProgressEvent, gem5::EventFunctionWrapper, gem5::GPUComputeDriver::DriverWakeupEvent, gem5::HSAPacketProcessor::QueueProcessEvent, gem5::HWScheduler::SchedulerWakeupEvent, gem5::Intel8254Timer::Counter::CounterEvent, gem5::LocalSimLoopExitEvent, gem5::MC146818::RTCEvent, gem5::MC146818::RTCTickEvent, gem5::MemberEventWrapper< F >, gem5::MemberEventWrapper<&AbstractController::sendRetryRespToMem >, gem5::MemberEventWrapper<&BaseRemoteGDB::connect >, gem5::MemberEventWrapper<&BaseRemoteGDB::detach >, gem5::MemberEventWrapper<&BaseRemoteGDB::singleStep >, gem5::MemberEventWrapper<&ISA::processHSTickCompare >, gem5::MemberEventWrapper<&ISA::processHSTickCompare >, gem5::MemberEventWrapper<&ISA::processSTickCompare >, gem5::MemberEventWrapper<&ISA::processSTickCompare >, gem5::MemberEventWrapper<&ISA::processTickCompare >, gem5::MemberEventWrapper<&ISA::processTickCompare >, gem5::MemberEventWrapper<&Kernel::t0Handler >, gem5::MemberEventWrapper<&MemSinkCtrl::processNextReqEvent >, gem5::MemberEventWrapper<&PowerDomain::setFollowerPowerStates >, gem5::MemberEventWrapper<&Scheduler::maxTickFunc >, gem5::MemberEventWrapper<&Scheduler::pause >, gem5::MemberEventWrapper<&Scheduler::runReady >, gem5::MemberEventWrapper<&Scheduler::stop >, gem5::MemberEventWrapper<&Scheduler::timeAdvances >, gem5::MemberEventWrapper<&SMMUv3::processCommands >, gem5::MemberEventWrapper<&SMMUv3DeviceInterface::atsSendDeviceRetry >, gem5::o3::Fetch::FinishTranslationEvent, gem5::o3::InstructionQueue::FUCompletion, gem5::o3::LSQUnit::WritebackEvent, gem5::SMMUDeviceRetryEvent, gem5::TimingSimpleCPU::DcachePort::DTickEvent, gem5::TimingSimpleCPU::IcachePort::ITickEvent, gem5::TimingSimpleCPU::IprEvent, gem5::TimingSimpleCPU::TimingCPUPort::TickEvent, gem5::tlm::chi::TlmGenerator::TransactionEvent, gem5::trace::TarmacParserRecord::TarmacParserRecordEvent, gem5::VegaISA::GpuTLB::TLBEvent, and gem5::X86ISA::GpuTLB::TLBEvent.

Definition at line 399 of file eventq.cc.

Referenced by dump(), and trace().

description() [2/2]

const char * gem5::EventFunctionWrapper::description ( ) const

inlinevirtual

Return a C string describing the event.

This string should not be dynamically allocated; just a const char array describing the event class.

Reimplemented from gem5::Event.

Definition at line 1176 of file eventq.hh.

dump() [1/2]

void gem5::Event::dump

(

)

const

Dump the current event data.

Definition at line 427 of file eventq.cc.

References _priority, gem5::cprintf(), description(), flags, name(), scheduled(), and when().

Referenced by gem5::EventQueue::debugVerify(), gem5::EventQueue::dump(), and gem5::pybind_init_event().

dump() [2/2]

void gem5::EventQueue::dump

(

)

const

This is a debugging function which will print everything on the event queue.

Definition at line 315 of file eventq.cc.

References gem5::cprintf(), gem5::curTick(), gem5::Event::dump(), empty(), head, gem5::Event::nextBin, and gem5::Event::nextInBin.

Referenced by gem5::pybind_init_event().

empty()

bool gem5::EventQueue::empty ( ) const

inline

Returns true if no events are queued.

Definition at line 891 of file eventq.hh.

References head.

Referenced by gem5::doSimLoop(), dump(), serviceEvents(), and ~EventQueue().

EventFunctionWrapper()

gem5::EventFunctionWrapper::EventFunctionWrapper ( const std::function< void(void)> & callback, const std::string & name, bool del = false, Priority p = Default_Pri )

inline

This function wraps a function into an event, to be executed later.

Definition at line 1149 of file eventq.hh.

References _name, gem5::EventBase::AutoDelete, callback, gem5::EventBase::Default_Pri, gem5::Event::Event(), name(), gem5::MipsISA::p, and gem5::Event::setFlags().

Referenced by gem5::SpatterGen::SpatterGenEvent::SpatterGenEvent().

EventManager() [1/3]

gem5::EventManager::EventManager ( EventManager & em )

inline

Event manger manages events in the event queue.

Where you can schedule and deschedule different events.

Definition at line 994 of file eventq.hh.

References gem5::X86ISA::em, EventManager(), and eventq.

Referenced by gem5::BasePixelPump::BasePixelPump(), EventManager(), EventManager(), gem5::Intel8254Timer::Intel8254Timer(), gem5::MC146818::MC146818(), gem5::memory::DRAMInterface::Rank::Rank(), gem5::memory::NVMInterface::Rank::Rank(), gem5::RiscvRTC::RTC::RTC(), gem5::SimObject::SimObject(), and gem5::X86ISA::Cmos::X86RTC::X86RTC().

EventManager() [2/3]

gem5::EventManager::EventManager ( EventManager * em )

inline

Definition at line 995 of file eventq.hh.

References gem5::X86ISA::em, EventManager(), and eventq.

EventManager() [3/3]

gem5::EventManager::EventManager ( EventQueue * eq )

inline

Definition at line 996 of file eventq.hh.

References gem5::PowerISA::eq, and eventq.

EventQueue()

gem5::EventQueue::EventQueue

(

const std::string &

n

)

Definition at line 444 of file eventq.cc.

References _curTick, head, gem5::ArmISA::n, and objName.

eventQueue()

EventQueue * gem5::EventManager::eventQueue ( ) const

inline

Definition at line 1003 of file eventq.hh.

References eventq.

Referenced by gem5::VncServer::accept(), gem5::X86KvmCPU::deliverInterrupts(), gem5::BaseKvmCPU::drain(), sc_gem5::Kernel::Kernel(), and gem5::BaseKvmCPU::wakeup().

getCurTick()

Tick gem5::EventQueue::getCurTick ( ) const

inline

While curTick() is useful for any object assigned to this event queue, if an object that is assigned to another event queue (or a non-event object) need to access the current tick of this event queue, this function is used.

Tick is the unit of time used in gem5.

Returns

Tick The current tick of this event queue.

Definition at line 850 of file eventq.hh.

References _curTick.

Referenced by reschedule(), and schedule().

isAutoDelete()

bool gem5::Event::isAutoDelete ( ) const

inline

The function returns true if the object is automatically deleted after the event is processed.

Definition at line 494 of file eventq.hh.

References isManaged().

Referenced by gem5::ruby::RubySystem::memWriteback().

isExitEvent()

bool gem5::Event::isExitEvent ( ) const

inline

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

Definition at line 479 of file eventq.hh.

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

Referenced by gem5::pybind_init_event().

isManaged()

bool gem5::Event::isManaged ( ) const

inline

Check whether this event will auto-delete.

Definition at line 486 of file eventq.hh.

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

Referenced by isAutoDelete().

name() [1/4]

const std::string gem5::Event::name ( ) const

virtual

Reimplemented in gem5::BasePixelPump::PixelEvent, gem5::EventFunctionWrapper, gem5::SMMUDeviceRetryEvent, gem5::TesterThread::DeadlockCheckEvent, and gem5::TesterThread::TesterThreadEvent.

Definition at line 84 of file eventq.cc.

References gem5::csprintf(), and instanceString().

Referenced by dump(), gem5::ruby::RubySystem::memWriteback(), gem5::pybind_init_event(), and unserialize().

name() [2/4]

const std::string gem5::EventFunctionWrapper::name ( ) const

inlinevirtual

Reimplemented from gem5::Event.

Definition at line 1168 of file eventq.hh.

References _name.

Referenced by EventFunctionWrapper(), and gem5::SpatterGen::SpatterGenEvent::SpatterGenEvent().

name() [3/4]

virtual const std::string gem5::EventQueue::name ( ) const

inlinevirtual

Definition at line 747 of file eventq.hh.

References objName.

name() [4/4]

void gem5::EventQueue::name ( const std::string & st )

inline

Definition at line 748 of file eventq.hh.

References objName, and gem5::ArmISA::st.

operator!=()

bool gem5::operator!= ( const Event & l, const Event & r )

inline

Definition at line 572 of file eventq.hh.

References gem5::MipsISA::l, and gem5::MipsISA::r.

operator<()

bool gem5::operator< ( const Event & l, const Event & r )

inline

Definition at line 522 of file eventq.hh.

References gem5::MipsISA::l, and gem5::MipsISA::r.

operator<=()

bool gem5::operator<= ( const Event & l, const Event & r )

inline

Definition at line 542 of file eventq.hh.

References gem5::MipsISA::l, and gem5::MipsISA::r.

operator==()

bool gem5::operator== ( const Event & l, const Event & r )

inline

Definition at line 563 of file eventq.hh.

References gem5::MipsISA::l, and gem5::MipsISA::r.

operator>()

bool gem5::operator> ( const Event & l, const Event & r )

inline

Definition at line 533 of file eventq.hh.

References gem5::MipsISA::l, and gem5::MipsISA::r.

operator>=()

bool gem5::operator>= ( const Event & l, const Event & r )

inline

Definition at line 553 of file eventq.hh.

References gem5::MipsISA::l, and gem5::MipsISA::r.

priority()

Priority gem5::Event::priority ( ) const

inline

Get the event priority.

Definition at line 508 of file eventq.hh.

References _priority.

Referenced by gem5::EventQueue::debugVerify(), gem5::pybind_init_event(), and gem5::PyEvent::PyEvent().

process()

void gem5::EventFunctionWrapper::process ( )

inlinevirtual

Implements gem5::Event.

Definition at line 1162 of file eventq.hh.

References callback.

reschedule() [1/3]

void gem5::EventManager::reschedule ( Event & event, Tick when, bool always = false )

inline

Definition at line 1030 of file eventq.hh.

References gem5::MipsISA::event, and eventq.

Referenced by gem5::FlashDevice::accessDevice(), gem5::FlashDevice::actionComplete(), gem5::memory::DRAMInterface::activateBank(), gem5::TimingSimpleCPU::advanceInst(), gem5::memory::NVMInterface::chooseRead(), gem5::MemTest::completeRequest(), gem5::memory::CfiMemory::dequeue(), gem5::memory::SimpleMemory::dequeue(), gem5::memory::DRAMInterface::doBurstAccess(), gem5::memory::NVMInterface::doBurstAccess(), gem5::SystemCounter::freqUpdateSchedule(), gem5::GenericTimer::handleStream(), gem5::memory::DRAMInterface::prechargeBank(), gem5::System::Threads::quiesceTick(), gem5::MemTest::recvRetry(), gem5::GenericWatchdog::refresh(), gem5::Sp805::restartCounter(), gem5::TraceCPU::schedDcacheNextEvent(), gem5::Shader::ScheduleAdd(), gem5::Uart8250::scheduleIntr(), gem5::o3::CPU::scheduleTickEvent(), gem5::IdeDisk::serialize(), gem5::X86ISA::Interrupts::setReg(), gem5::AtomicSimpleCPU::tick(), gem5::MemTest::tick(), gem5::NSGigE::transferDone(), gem5::sinic::Device::transferDone(), gem5::GenericWatchdog::unserialize(), gem5::IdeDisk::unserialize(), gem5::Sp805::unserialize(), gem5::SystemCounter::unserialize(), gem5::X86ISA::Interrupts::unserialize(), and gem5::BaseTrafficGen::update().

reschedule() [2/3]

void gem5::EventManager::reschedule ( Event * event, Tick when, bool always = false )

inline

Definition at line 1057 of file eventq.hh.

References gem5::MipsISA::event, and eventq.

reschedule() [3/3]

void gem5::EventQueue::reschedule ( Event * event, Tick when, bool always = false )

inline

Reschedule the specified event.

Should be called only from the owning thread.

Definition at line 814 of file eventq.hh.

References gem5::curEventQueue(), gem5::MipsISA::event, getCurTick(), gem5::inParallelMode, insert(), remove(), gem5::EventBase::Scheduled, and gem5::EventBase::Squashed.

Referenced by gem5::pybind_init_event().

schedule() [1/3]

void gem5::EventManager::schedule ( Event & event, Tick when )

inline

Definition at line 1012 of file eventq.hh.

References gem5::MipsISA::event, and eventq.

Referenced by gem5::memory::DRAMSim2::accessAndRespond(), gem5::memory::DRAMsim3::accessAndRespond(), gem5::FlashDevice::accessDevice(), gem5::memory::DRAMInterface::activateBank(), gem5::AtomicSimpleCPU::activateContext(), gem5::BaseKvmCPU::activateContext(), gem5::MinorCPU::activateContext(), gem5::TimingSimpleCPU::activateContext(), gem5::BasePixelPump::beginLine(), gem5::TraceCPU::checkAndSchedExitEvent(), gem5::TesterThread::checkDeadlock(), gem5::memory::DRAMInterface::Rank::checkDrainDone(), gem5::memory::DRAMInterface::checkRefreshState(), gem5::IGbE::chkInterrupt(), gem5::memory::NVMInterface::chooseRead(), gem5::HDLcd::cmdEnable(), gem5::ruby::GPUCoalescer::completeHitCallback(), gem5::MemTest::completeRequest(), gem5::SDMAEngine::copyDone(), gem5::NSGigE::cpuIntrPost(), gem5::sinic::Base::cpuIntrPost(), gem5::GUPSGen::createNextReq(), gem5::TraceCPU::dcacheRetryRecvd(), gem5::prefetch::BOP::delayQueueEventWrapper(), gem5::GPUDispatcher::dispatch(), gem5::ComputeUnit::dispWorkgroup(), gem5::Pl111::dmaDone(), gem5::DmaVirtDevice::dmaVirt(), gem5::memory::DRAMInterface::doBurstAccess(), gem5::memory::NVMInterface::doBurstAccess(), gem5::IdeDisk::doDmaDataRead(), gem5::IdeDisk::doDmaDataWrite(), gem5::IdeDisk::doDmaRead(), gem5::IdeDisk::doDmaTransfer(), gem5::IdeDisk::doDmaWrite(), gem5::ThermalModel::doStep(), gem5::TimingSimpleCPU::drain(), gem5::AtomicSimpleCPU::drainResume(), gem5::BaseKvmCPU::drainResume(), gem5::o3::CPU::drainResume(), gem5::TimingSimpleCPU::drainResume(), gem5::RegisterFileCache::enqCacheInsertEvent(), gem5::RegisterFile::enqRegBusyEvent(), gem5::RegisterFile::enqRegFreeEvent(), gem5::ruby::RubySystem::enqueueRubyEvent(), gem5::ComputeUnit::exec(), gem5::Shader::execScheduledAdds(), gem5::GoodbyeObject::fillBuffer(), gem5::BaseKvmCPU::finishMMIOPending(), gem5::compression::FrequentValues::generateCodes(), gem5::SimpleCache::handleRequest(), gem5::GUPSGen::handleResponse(), gem5::VegaISA::GpuTLB::handleTranslationReturn(), gem5::X86ISA::GpuTLB::handleTranslationReturn(), gem5::RubyDirectedTester::hitCallback(), gem5::TraceCPU::icacheRetryRecvd(), gem5::TraceCPU::init(), gem5::ComputeUnit::injectGlobalMemFence(), gem5::prefetch::BOP::insertIntoDelayQueue(), gem5::ruby::Sequencer::insertRequest(), gem5::ruby::VIPERCoalescer::issueRequest(), gem5::VegaISA::GpuTLB::issueTLBLookup(), gem5::X86ISA::GpuTLB::issueTLBLookup(), gem5::LupioTMR::lupioTMRSet(), gem5::ruby::GPUCoalescer::makeRequest(), gem5::ruby::AbstractController::memRespQueueDequeued(), gem5::ArmISA::TableWalker::nextWalk(), gem5::GPUDispatcher::notifyWgCompl(), gem5::DVFSHandler::perfLevel(), gem5::IGbE::postInterrupt(), gem5::memory::DRAMInterface::prechargeBank(), gem5::prefetch::AccessMapPatternMatching::processEpochEvent(), gem5::HelloObject::processEvent(), gem5::SparcISA::ISA::processHSTickCompare(), gem5::memory::DRAMInterface::Rank::processPowerEvent(), gem5::VegaTLBCoalescer::processProbeTLBEvent(), gem5::memory::NVMInterface::processReadReadyEvent(), gem5::memory::DRAMInterface::Rank::processRefreshEvent(), gem5::SparcISA::ISA::processSTickCompare(), gem5::memory::NVMInterface::processWriteRespondEvent(), gem5::Plic::propagateOutput(), gem5::SDMAEngine::ptePdeDone(), gem5::PowerDomain::pwrStateChangeCallback(), gem5::Pl111::readFramebuffer(), gem5::BaseCache::recvAtomic(), gem5::MemTest::recvRetry(), gem5::memory::CfiMemory::recvTimingReq(), gem5::memory::SimpleMemory::recvTimingReq(), gem5::RiscvISA::Walker::recvTimingResp(), gem5::X86ISA::Walker::recvTimingResp(), gem5::BasePixelPump::renderPixels(), gem5::System::Threads::replace(), gem5::IGbE::restartClock(), gem5::PL031::resyncMatch(), gem5::EtherTapBase::retransmit(), gem5::Gicv3Its::runProcessTiming(), gem5::NSGigE::rxKick(), gem5::CommMonitor::samplePeriodic(), gem5::HSAPacketProcessor::schedAQLProcessing(), gem5::SMMUv3DeviceInterface::schedAtsTimingResp(), gem5::TraceCPU::schedDcacheNextEvent(), gem5::TraceCPU::schedIcacheNext(), gem5::MipsISA::ISA::scheduleCP0Update(), gem5::TesterThread::scheduleDeadlockCheckEvent(), gem5::SMMUv3DeviceInterface::scheduleDeviceRetry(), gem5::GPUDispatcher::scheduleDispatch(), gem5::Uart8250::scheduleIntr(), gem5::SpatterGen::scheduleNextGenEvent(), gem5::SpatterGen::scheduleNextSendEvent(), gem5::memory::DRAMInterface::Rank::schedulePowerEvent(), gem5::BaseCPU::schedulePowerGatingEvent(), gem5::o3::CPU::scheduleThreadExitEvent(), gem5::o3::CPU::scheduleTickEvent(), gem5::tlm::chi::TlmGenerator::scheduleTransaction(), gem5::BaseTrafficGen::scheduleUpdate(), gem5::TesterThread::scheduleWakeup(), gem5::memory::DRAMInterface::Rank::scheduleWakeUpEvent(), gem5::Iris::ThreadContext::semihostingEvent(), gem5::EtherBus::send(), gem5::ComputeUnit::sendInvL2(), gem5::GUPSGen::sendNextReq(), gem5::ComputeUnit::sendRequest(), gem5::memory::DRAMSim2::sendResponse(), gem5::memory::DRAMsim3::sendResponse(), gem5::EtherTapBase::sendSimulated(), gem5::SparcISA::ISA::setFSReg(), gem5::Pl011::setInterrupts(), gem5::BasePixelPump::start(), gem5::IdeDisk::startDma(), gem5::BaseKvmCPU::startup(), gem5::CommMonitor::startup(), gem5::GUPSGen::startup(), gem5::HelloObject::startup(), gem5::MC146818::startup(), gem5::memory::DRAMInterface::Rank::startup(), gem5::memory::DRAMSim2::startup(), gem5::memory::DRAMsim3::startup(), gem5::prefetch::AccessMapPatternMatching::startup(), gem5::StatTester::startup(), gem5::ThermalModel::startup(), sc_gem5::Kernel::startup(), gem5::RiscvISA::Walker::startWalkWrapper(), gem5::BaseCPU::suspendContext(), gem5::BaseKvmCPU::tick(), gem5::GarnetSyntheticTraffic::tick(), gem5::IGbE::tick(), gem5::memory::DRAMSim2::tick(), gem5::memory::DRAMsim3::tick(), gem5::MemTest::tick(), gem5::o3::CPU::tick(), gem5::Root::timeSync(), gem5::Root::timeSyncEnable(), gem5::VegaISA::GpuTLB::translationReturn(), gem5::X86ISA::GpuTLB::translationReturn(), gem5::NSGigE::transmit(), gem5::NSGigE::txKick(), gem5::BaseTrafficGen::unserialize(), gem5::DVFSHandler::unserialize(), gem5::EnergyCtrl::unserialize(), gem5::GicV2::unserialize(), gem5::GPUDispatcher::unserialize(), gem5::IdeDisk::unserialize(), gem5::IGbE::unserialize(), gem5::NSGigE::unserialize(), gem5::PL031::unserialize(), gem5::Pl111::unserialize(), gem5::Plic::unserialize(), gem5::sinic::Base::unserialize(), gem5::sinic::Device::unserialize(), gem5::SparcISA::ISA::unserialize(), gem5::Uart8250::unserialize(), gem5::VGic::unserialize(), gem5::X86ISA::Interrupts::unserialize(), gem5::GPUDispatcher::updateInvCounter(), gem5::Plic::updateOutput(), gem5::TLBCoalescer::updatePhysAddresses(), gem5::VegaTLBCoalescer::updatePhysAddresses(), gem5::HDLcd::virtRefresh(), gem5::o3::CPU::wakeCPU(), gem5::GUPSGen::wakeUp(), gem5::ruby::GPUCoalescer::wakeup(), gem5::ruby::Sequencer::wakeup(), gem5::RubyDirectedTester::wakeup(), gem5::RubyTester::wakeup(), gem5::EnergyCtrl::write(), gem5::SMMUv3::writeControl(), gem5::MC146818::writeData(), and gem5::SDMAEngine::writeDone().

schedule() [2/3]

void gem5::EventManager::schedule ( Event * event, Tick when )

inline

Definition at line 1039 of file eventq.hh.

References gem5::MipsISA::event, and eventq.

schedule() [3/3]

void gem5::EventQueue::schedule ( Event * event, Tick when, bool global = false )

inline

Schedule the given event on this queue.

Safe to call from any thread.

Definition at line 757 of file eventq.hh.

References asyncInsert(), gem5::curEventQueue(), gem5::MipsISA::event, getCurTick(), gem5::inParallelMode, insert(), and gem5::EventBase::Scheduled.

Referenced by gem5::SyscallDesc::setupRetry().

scheduled()

bool gem5::Event::scheduled ( ) const

inline

Determine if the current event is scheduled.

Definition at line 458 of file eventq.hh.

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

Referenced by gem5::memory::DRAMInterface::activateBank(), gem5::BasePixelPump::PixelEvent::active(), gem5::memory::DRAMInterface::checkRefreshState(), gem5::Intel8254Timer::Counter::CounterEvent::clocksLeft(), gem5::BaseRemoteGDB::descheduleInstCommitEvent(), gem5::memory::DRAMInterface::doBurstAccess(), gem5::BasePixelPump::PixelEvent::drain(), dump(), gem5::GenericTimer::handleStream(), gem5::DVFSHandler::perfLevel(), gem5::memory::DRAMInterface::prechargeBank(), gem5::memory::MemCtrl::processNextReqEvent(), gem5::memory::MemCtrl::processRespondEvent(), gem5::pybind_init_event(), gem5::UFSHostDevice::readDevice(), releaseImpl(), sc_gem5::Scheduler::TimeSlot::releaseImpl(), gem5::memory::DRAMInterface::respondEvent(), gem5::BasePixelPump::PixelEvent::resume(), gem5::HSAPacketProcessor::schedAQLProcessing(), gem5::BasePixelPump::PixelEvent::serialize(), gem5::BasePixelPump::PixelEvent::suspend(), gem5::BasePixelPump::PixelEvent::unserialize(), unserialize(), gem5::UFSHostDevice::writeDevice(), and ~Event().

ScopedMigration()

gem5::EventQueue::ScopedMigration::ScopedMigration ( EventQueue * _new_eq, bool _doMigrate = true )

inline

Temporarily migrate execution to a different event queue.

An instance of this class temporarily migrates execution to different event queue by releasing the current queue, locking the new queue, and updating curEventQueue(). This can, for example, be useful when performing IO across thread event queues when timing is not crucial (e.g., during fast forwarding).

ScopedMigration does nothing if both eqs are the same

Definition at line 682 of file eventq.hh.

References gem5::curEventQueue(), gem5::EventQueue::curEventQueue, doMigrate, gem5::EventQueue::EventQueue(), new_eq, and old_eq.

serviceEvents()

void gem5::EventQueue::serviceEvents ( Tick when )

inline

process all events up to the given timestamp.

we inline a quick test to see if there are any events to process; if so, call the internal out-of-line version to process them all.

Notes:

• This is only used for "instruction" event queues. Instead of counting ticks, this is actually counting instructions.
• This updates the current tick value to the value of the entry at the head of the queue.

Todo

this assert is a good bug catcher. I need to make it true again.

Definition at line 869 of file eventq.hh.

References empty(), nextTick(), serviceOne(), and setCurTick().

Referenced by gem5::minor::Execute::doInstCommitAccounting(), and gem5::BaseSimpleCPU::serviceInstCountEvents().

squash()

void gem5::Event::squash ( )

inline

Squash the current event.

Definition at line 465 of file eventq.hh.

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

Referenced by gem5::pybind_init_event().

squashed()

bool gem5::Event::squashed ( ) const

inline

Check whether the event is squashed.

Definition at line 472 of file eventq.hh.

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

Referenced by gem5::pybind_init_event().

trace()

void gem5::Event::trace ( const char * action )

protectedvirtual

This function isn't really useful if TRACING_ON is not defined.

trace event activity

Definition at line 405 of file eventq.cc.

References description(), DPRINTF, Event(), instanceString(), and when().

wakeup()

virtual void gem5::EventQueue::wakeup ( Tick when = (Tick)-1 )

inlinevirtual

Function to signal that the event loop should be woken up because an event has been scheduled by an agent outside the gem5 event loop(s) whose event insertion may not have been noticed by gem5.

This function isn't needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 onto other schedulers.

Parameters

when	Time of a delayed wakeup (if known). This parameter can be used by an implementation to schedule a wakeup in the future if it is sure it will remain active until then. Or it can be ignored and the event queue can be woken up now.

Definition at line 923 of file eventq.hh.

Referenced by gem5::dumprstStatsHandler(), gem5::dumpStatsHandler(), gem5::exitNowHandler(), gem5::externalProcessHandler(), gem5::ioHandler(), and gem5::PollQueue::setupAsyncIO().

wakeupEventQueue()

void gem5::EventManager::wakeupEventQueue ( Tick when = (Tick)-1 )

inline

This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.

Definition at line 1068 of file eventq.hh.

References eventq.

when()

Tick gem5::Event::when ( ) const

inline

Get the time that the event is scheduled.

Definition at line 501 of file eventq.hh.

References _when.

Referenced by gem5::memory::DRAMInterface::activateBank(), gem5::Intel8254Timer::Counter::CounterEvent::clocksLeft(), gem5::EventQueue::debugVerify(), gem5::memory::DRAMInterface::doBurstAccess(), dump(), gem5::ruby::RubySystem::memWriteback(), gem5::memory::DRAMInterface::prechargeBank(), gem5::pybind_init_event(), gem5::LdsState::TickEvent::schedule(), setWhen(), gem5::BasePixelPump::PixelEvent::suspend(), and trace().

~Event()

gem5::Event::~Event ( )

virtual

Definition at line 77 of file eventq.cc.

References flags, and scheduled().

Variable Documentation

CPU_Exit_Pri

const Priority gem5::EventBase::CPU_Exit_Pri = 64

static

If we want to exit a thread in a CPU, it comes after CPU_Tick_Pri.

Definition at line 214 of file eventq.hh.

CPU_Switch_Pri

const Priority gem5::EventBase::CPU_Switch_Pri = -31

static

CPU switches schedule the new CPU's tick event for the same cycle (after unscheduling the old CPU's tick event).

The switch needs to come before any tick events to make sure we don't tick both CPUs in the same cycle.

Definition at line 166 of file eventq.hh.

CPU_Tick_Pri

const Priority gem5::EventBase::CPU_Tick_Pri = 50

static

CPU ticks must come after other associated CPU events (such as writebacks).

Definition at line 207 of file eventq.hh.

Referenced by gem5::TesterThread::DeadlockCheckEvent::DeadlockCheckEvent(), gem5::o3::Commit::generateTrapEvent(), gem5::MipsISA::ISA::scheduleCP0Update(), gem5::TesterThread::TesterThreadEvent::TesterThreadEvent(), gem5::VegaISA::GpuTLB::TLBEvent::TLBEvent(), and gem5::X86ISA::GpuTLB::TLBEvent::TLBEvent().

Debug_Break_Pri

const Priority gem5::EventBase::Debug_Break_Pri = -100

static

Breakpoints should happen before anything else (except enabling trace output), so we don't miss any action when debugging.

Definition at line 156 of file eventq.hh.

Referenced by gem5::DebugBreakEvent::DebugBreakEvent().

Debug_Enable_Pri

const Priority gem5::EventBase::Debug_Enable_Pri = -101

static

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

Definition at line 147 of file eventq.hh.

Default_Pri

const Priority gem5::EventBase::Default_Pri = 0

static

Default is zero for historical reasons.

Definition at line 182 of file eventq.hh.

Referenced by gem5::Event::Event(), gem5::EventFunctionWrapper::EventFunctionWrapper(), sc_gem5::getPriorityOfTlmPhase(), gem5::MemberEventWrapper<&ISA::processTickCompare >::MemberEventWrapper(), gem5::MemberEventWrapper<&ISA::processTickCompare >::MemberEventWrapper(), gem5::pybind_init_event(), gem5::HSAPacketProcessor::QueueProcessEvent::QueueProcessEvent(), sc_gem5::Scheduler::TimeSlot::TimeSlot(), and gem5::o3::LSQUnit::WritebackEvent::WritebackEvent().

Delayed_Writeback_Pri

const Priority gem5::EventBase::Delayed_Writeback_Pri = -1

static

For some reason "delayed" inter-cluster writebacks are scheduled before regular writebacks (which have default priority).

Steve?

Definition at line 175 of file eventq.hh.

DVFS_Update_Pri

const Priority gem5::EventBase::DVFS_Update_Pri = 31

static

DVFS update event leads to stats dump therefore given a lower priority to ensure all relevant states have been updated.

Definition at line 190 of file eventq.hh.

Referenced by gem5::DVFSHandler::UpdateEvent::UpdateEvent().

Maximum_Pri

const Priority gem5::EventBase::Maximum_Pri = SCHAR_MAX

static

Maximum priority.

Definition at line 244 of file eventq.hh.

Minimum_Pri

const Priority gem5::EventBase::Minimum_Pri = SCHAR_MIN

static

Event priorities, to provide tie-breakers for events scheduled at the same cycle.

Most events are scheduled at the default priority; these values are used to control events that need to be ordered within a cycle. Minimum priority

Definition at line 138 of file eventq.hh.

Referenced by gem5::GlobalSimLoopExitEvent::GlobalSimLoopExitEvent().

Progress_Event_Pri

const Priority gem5::EventBase::Progress_Event_Pri = 95

static

Progress events come at the end.

Definition at line 229 of file eventq.hh.

Referenced by gem5::CPUProgressEvent::CPUProgressEvent(), and gem5::simulate().

Serialize_Pri

const Priority gem5::EventBase::Serialize_Pri = 32

static

Serailization needs to occur before tick events also, so that a serialize/unserialize is identical to an on-line CPU switch.

Definition at line 199 of file eventq.hh.

Sim_Exit_Pri

const Priority gem5::EventBase::Sim_Exit_Pri = 100

static

If we want to exit on this cycle, it's the very last thing we do.

Definition at line 237 of file eventq.hh.

Referenced by gem5::CountedExitEvent::CountedExitEvent(), gem5::GlobalSimLoopExitEvent::GlobalSimLoopExitEvent(), gem5::LocalSimLoopExitEvent::LocalSimLoopExitEvent(), gem5::DistIface::SyncEvent::SyncEvent(), and gem5::Iris::ThreadContext::ThreadContext().

Stat_Event_Pri

const Priority gem5::EventBase::Stat_Event_Pri = 90

static

Statistics events (dump, reset, etc.) come after everything else, but before exit.

Definition at line 222 of file eventq.hh.

Referenced by gem5::o3::InstructionQueue::FUCompletion::FUCompletion(), and gem5::statistics::StatEvent::StatEvent().