Helper class for objects that need to be clocked. More...

#include <clocked_object.hh>

Inheritance diagram for gem5::Clocked:

Public Member Functions
void	updateClockPeriod ()
	Update the tick to the current tick.

Tick	clockEdge (Cycles cycles=Cycles(0)) const
	Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle.

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.

Tick	nextCycle () const
	Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future.

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Protected Member Functions
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance.

void	resetClock () const
	Reset the object's clock using the current global tick value.

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Private Member Functions
void	update () const
	Align cycle and tick to the next clock edge if not already done.

Private Attributes
Tick	tick

Cycles	cycle

ClockDomain &	clockDomain
	The clock domain this clocked object belongs to.

Detailed Description

Helper class for objects that need to be clocked.

Clocked objects typically inherit from this class. Objects that need SimObject functionality as well should inherit from ClockedObject.

Definition at line 62 of file clocked_object.hh.

Constructor & Destructor Documentation

◆ Clocked() [1/2]

gem5::Clocked::Clocked ( ClockDomain & clk_domain )

inlineprotected

Create a clocked object and set the clock domain based on the parameters.

Definition at line 115 of file clocked_object.hh.

References clockDomain, and gem5::ClockDomain::registerWithClockDomain().

◆ Clocked() [2/2]

gem5::Clocked::Clocked ( Clocked & )

protecteddelete

◆ ~Clocked()

virtual gem5::Clocked::~Clocked ( )

inlineprotectedvirtual

Virtual destructor due to inheritance.

Definition at line 129 of file clocked_object.hh.

Member Function Documentation

◆ clockEdge()

Tick gem5::Clocked::clockEdge ( Cycles cycles = Cycles(0) ) const

inline

Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle.

When curTick() is on a clock edge, the number of cycles in the parameter is added to curTick() to be returned. When curTick() is not aligned to a clock edge, the number of cycles in the parameter is added to the next clock edge.

Parameters

cycles The number of cycles into the future

Returns: The start tick when the requested clock edge occurs. Precisely, this tick can be curTick() + [0, clockPeriod()) + clockPeriod() * cycles

Definition at line 177 of file clocked_object.hh.

References clockPeriod(), tick, and update().

◆ clockPeriod()

Tick gem5::Clocked::clockPeriod ( ) const

inline

Definition at line 217 of file clocked_object.hh.

References clockDomain, and gem5::ClockDomain::clockPeriod().

Referenced by gem5::TesterThread::checkDeadlock(), clockEdge(), gem5::Iris::BaseCPU::clockPeriodUpdated(), cyclesToTicks(), gem5::GPUDispatcher::dispatch(), gem5::SMMUProcess::doDelay(), gem5::BaseKvmCPU::doMMIOAccess(), gem5::ArmISA::TableWalker::fetchDescriptor(), gem5::ArmISA::TableWalker::Stage2Walk::finish(), frequency(), gem5::MathExprPowerModel::getStatValue(), gem5::ComputeUnit::init(), gem5::prefetch::Queued::insert(), gem5::ruby::VIPERCoalescer::issueRequest(), gem5::BaseKvmCPU::kvmRun(), gem5::GPUDispatcher::notifyWgCompl(), gem5::ruby::GPUCoalescer::printRequestTable(), gem5::CPUProgressEvent::process(), gem5::BaseCache::recvAtomic(), gem5::CoherentXBar::recvAtomicBackdoor(), gem5::Cache::recvAtomicSnoop(), gem5::CoherentXBar::recvAtomicSnoop(), gem5::CoherentXBar::recvTimingReq(), gem5::HMCController::recvTimingReq(), gem5::NoncoherentXBar::recvTimingReq(), gem5::TLBCoalescer::CpuSidePort::recvTimingReq(), gem5::VegaTLBCoalescer::CpuSidePort::recvTimingReq(), gem5::CoherentXBar::recvTimingResp(), gem5::NoncoherentXBar::recvTimingResp(), gem5::Cache::recvTimingSnoopReq(), gem5::CoherentXBar::recvTimingSnoopReq(), gem5::CoherentXBar::recvTimingSnoopResp(), gem5::ruby::BankedArray::reserve(), resetClock(), gem5::TraceCPU::schedDcacheNext(), gem5::GPUDispatcher::scheduleDispatch(), gem5::ruby::Consumer::scheduleEventAbsolute(), gem5::ScalarRegisterFile::scheduleWriteOperandsFromLoad(), gem5::VectorRegisterFile::scheduleWriteOperandsFromLoad(), gem5::BaseCache::sendMSHRQueuePacket(), gem5::ruby::Throttle::ThrottleStats::ThrottleStats(), gem5::AtomicSimpleCPU::tick(), gem5::IGbE::tick(), ticksToCycles(), gem5::prefetch::Queued::translationComplete(), update(), gem5::GPUDispatcher::updateInvCounter(), gem5::Sp805::value(), gem5::ruby::garnet::NetworkInterface::wakeup(), gem5::ruby::GPUCoalescer::wakeup(), gem5::ruby::HTMSequencer::wakeup(), and gem5::ruby::Sequencer::wakeup().

◆ clockPeriodUpdated()

virtual void gem5::Clocked::clockPeriodUpdated ( )

inlineprotectedvirtual

A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Reimplemented in gem5::Iris::BaseCPU.

Definition at line 148 of file clocked_object.hh.

Referenced by updateClockPeriod().

◆ curCycle()

Cycles gem5::Clocked::curCycle ( ) const

inline

Determine the current cycle, corresponding to a tick aligned to a clock edge.

Returns: When curTick() is on a clock edge, return the Cycle corresponding to that clock edge. When curTick() is not on a clock edge, return the Cycle corresponding to the next clock edge.

Definition at line 195 of file clocked_object.hh.

References cycle, and update().

Referenced by gem5::o3::CPU::activateContext(), gem5::TesterThread::addOutstandingReqs(), gem5::minor::FUPipeline::advance(), gem5::ruby::garnet::SwitchAllocator::arbitrate_outports(), gem5::minor::FUPipeline::canInsert(), gem5::TesterThread::checkDeadlock(), gem5::RubyTester::checkForDeadlock(), gem5::BaseCache::clearBlocked(), gem5::ruby::GPUCoalescer::coalescePacket(), gem5::ruby::garnet::GarnetNetwork::collateStats(), gem5::minor::Execute::commit(), gem5::minor::FUPipeline::cyclesBeforeInsert(), gem5::ruby::garnet::OutputUnit::decrement_credit(), gem5::minor::Execute::evaluate(), gem5::o3::CPU::haltContext(), gem5::VegaISA::GpuTLB::handleTranslationReturn(), gem5::DmaThread::hitCallback(), gem5::GpuWavefront::hitCallback(), gem5::RubyTester::hitCallback(), gem5::ruby::garnet::OutputUnit::increment_credit(), gem5::ruby::RubyPrefetcher::initializeStream(), gem5::ruby::HTMSequencer::insertRequest(), gem5::ruby::Sequencer::insertRequest(), gem5::minor::Execute::issue(), gem5::TesterThread::issueNextAction(), gem5::ruby::RubyPrefetcher::issueNextPrefetch(), gem5::VegaISA::GpuTLB::issueTLBLookup(), gem5::ruby::Throttle::operateVnet(), gem5::TesterThread::printOutstandingReqs(), gem5::ruby::GPUCoalescer::printRequestTable(), gem5::VegaTLBCoalescer::processProbeTLBEvent(), gem5::RiscvISA::ISA::readMiscReg(), gem5::X86ISA::ISA::readMiscReg(), gem5::ruby::Sequencer::recordMissLatency(), gem5::VegaTLBCoalescer::CpuSidePort::recvTimingReq(), gem5::ruby::RubySystem::resetStats(), gem5::BaseCache::setBlocked(), gem5::X86ISA::ISA::setMiscReg(), gem5::o3::CPU::suspendContext(), gem5::o3::CPU::takeOverFrom(), gem5::TimingSimpleCPU::takeOverFrom(), gem5::o3::CPU::tick(), gem5::VegaISA::GpuTLB::translationReturn(), gem5::BaseCPU::updateCycleCounters(), gem5::TimingSimpleCPU::updateCycleCounts(), gem5::VegaTLBCoalescer::updatePhysAddresses(), gem5::o3::CPU::wakeCPU(), gem5::ruby::garnet::CrossbarSwitch::wakeup(), gem5::ruby::GPUCoalescer::wakeup(), gem5::ruby::HTMSequencer::wakeup(), and gem5::ruby::Sequencer::wakeup().

◆ cyclesToTicks()

Tick gem5::Clocked::cyclesToTicks ( Cycles c ) const

inline

Definition at line 227 of file clocked_object.hh.

References gem5::ArmISA::c, and clockPeriod().

Referenced by gem5::BaseCache::access(), gem5::ruby::Switch::addOutPort(), gem5::ruby::garnet::NetworkInterface::checkStallQueue(), gem5::Wavefront::exec(), gem5::ruby::garnet::NetworkInterface::incrementStats(), gem5::ruby::Sequencer::invL1(), gem5::ruby::VIPERCoalescer::invTCC(), gem5::ruby::VIPERCoalescer::invTCP(), gem5::ruby::DMASequencer::issueNext(), gem5::ruby::RubyPrefetcherProxy::issuePrefetch(), gem5::ruby::Sequencer::issueRequest(), gem5::ruby::VIPERCoalescer::issueRequest(), gem5::VegaISA::GpuTLB::issueTLBLookup(), gem5::X86ISA::GpuTLB::issueTLBLookup(), gem5::ruby::DMASequencer::makeRequest(), gem5::ruby::Throttle::operateVnet(), gem5::prefetch::AccessMapPatternMatching::processEpochEvent(), gem5::LdsState::processPacket(), gem5::VegaTLBCoalescer::processProbeTLBEvent(), gem5::Plic::propagateOutput(), gem5::ruby::AbstractController::recvTimingResp(), gem5::VegaISA::GpuTLB::translationReturn(), gem5::X86ISA::GpuTLB::translationReturn(), gem5::ruby::garnet::NetworkInterface::wakeup(), gem5::ruby::GPUCoalescer::wakeup(), gem5::RegisterFileCache::waveExecuteInst(), gem5::ScalarRegisterFile::waveExecuteInst(), and gem5::VectorRegisterFile::waveExecuteInst().

◆ frequency()

uint64_t gem5::Clocked::frequency ( ) const

inline

Definition at line 215 of file clocked_object.hh.

References clockPeriod(), and gem5::sim_clock::Frequency.

◆ nextCycle()

Tick gem5::Clocked::nextCycle ( ) const

inline

Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future.

When curTick() is at the current cycle edge, this returns the next clock edge. When calling this during the middle of a cycle, this returns 2 clock edges in the future.

Returns: The start tick of the first cycle that is at least one cycle in the future. Precisely, the returned tick can be in the range curTick() + [clockPeriod(), 2 * clockPeriod())

Definition at line 213 of file clocked_object.hh.

References clockEdge().

Referenced by gem5::SpatterGen::checkForSimExit(), gem5::GUPSGen::createNextReq(), gem5::ComputeUnit::dispWorkgroup(), gem5::AtomicSimpleCPU::drainResume(), gem5::BaseKvmCPU::drainResume(), gem5::o3::CPU::drainResume(), gem5::TimingSimpleCPU::drainResume(), gem5::ComputeUnit::exec(), gem5::BaseKvmCPU::finishMMIOPending(), gem5::GUPSGen::handleResponse(), gem5::SpatterGen::proceedPastSyncPoint(), gem5::SpatterGen::processNextGenEvent(), gem5::SpatterGen::processNextSendEvent(), gem5::pseudo_inst::quiesceSkip(), gem5::SpatterGen::recvReqRetry(), gem5::SpatterGen::recvTimingResp(), gem5::SMMUv3DeviceInterface::schedAtsTimingResp(), gem5::SMMUv3DeviceInterface::schedTimingResp(), gem5::TesterThread::scheduleDeadlockCheckEvent(), gem5::SMMUv3DeviceInterface::scheduleDeviceRetry(), gem5::o3::CPU::scheduleThreadExitEvent(), gem5::TesterThread::scheduleWakeup(), gem5::GUPSGen::sendNextReq(), gem5::GUPSGen::startup(), gem5::GUPSGen::wakeUp(), and gem5::SMMUv3::writeControl().