gem5::ClockedObject Class Reference

The ClockedObject class extends the SimObject with a clock and accessor functions to relate ticks to the cycles of the object. More...

#include <clocked_object.hh>

Inheritance diagram for gem5::ClockedObject:

Public Types
using	Params = ClockedObjectParams
	Parameters of ClockedObject.
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	ClockedObject (const ClockedObjectParams &p)
void	serialize (CheckpointOut &cp) const override
	Serialize an object.
void	unserialize (CheckpointIn &cp) override
	Unserialize an object.
Public Member Functions inherited from gem5::SimObject
const Params &	params () const
	SimObject (const Params &p)
virtual	~SimObject ()
virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.
virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.
virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.
virtual void	regProbePoints ()
	Register probe points for this object.
virtual void	regProbeListeners ()
	Register probe listeners for this object.
ProbeManager *	getProbeManager ()
	Get the probe manager for this object.
virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.
virtual void	startup ()
	startup() is the final initialization call before simulation.
DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.
virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.
virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.
void	serialize (CheckpointOut &cp) const override
	Serialize an object.
void	unserialize (CheckpointIn &cp) override
	Unserialize an object.
Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () const
void	schedule (Event &event, Tick when)
void	deschedule (Event &event)
void	reschedule (Event &event, Tick when, bool always=false)
void	schedule (Event *event, Tick when)
void	deschedule (Event *event)
void	reschedule (Event *event, Tick when, bool always=false)
void	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.
void	setCurTick (Tick newVal)
	EventManager (EventManager &em)
	Event manger manages events in the event queue.
	EventManager (EventManager *em)
	EventManager (EventQueue *eq)
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)
Public Member Functions inherited from gem5::Drainable
DrainState	drainState () const
	Return the current drain state of an object.
virtual void	notifyFork ()
	Notify a child process of a fork.
Public Member Functions inherited from gem5::statistics::Group
	Group (Group *parent, const char *name=nullptr)
	Construct a new statistics group.
virtual	~Group ()
virtual void	regStats ()
	Callback to set stat parameters.
virtual void	resetStats ()
	Callback to reset stats.
virtual void	preDumpStats ()
	Callback before stats are dumped.
void	addStat (statistics::Info *info)
	Register a stat with this group.
const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.
const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.
void	addStatGroup (const char *name, Group *block)
	Add a stat block as a child of this block.
const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.
void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.
	Group ()=delete
	Group (const Group &)=delete
Group &	operator= (const Group &)=delete
Public Member Functions inherited from gem5::Named
	Named (std::string_view name_)
virtual	~Named ()=default
virtual std::string	name () const
Public Member Functions inherited from gem5::Clocked
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

Public Attributes
PowerState *	powerState

Additional Inherited Members
Static Public Member Functions inherited from gem5::SimObject
static void	serializeAll (const std::string &cpt_dir)
	Create a checkpoint by serializing all SimObjects in the system.
static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.
static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.
static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.
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.
Protected Member Functions inherited from gem5::Drainable
	Drainable ()
virtual	~Drainable ()
virtual void	drainResume ()
	Resume execution after a successful drain.
void	signalDrainDone () const
	Signal that an object is drained.
Protected Member Functions inherited from gem5::Clocked
	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.
Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.
Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Detailed Description

The ClockedObject class extends the SimObject with a clock and accessor functions to relate ticks to the cycles of the object.

Definition at line 234 of file clocked_object.hh.

Member Typedef Documentation

Params

using gem5::ClockedObject::Params = ClockedObjectParams

Parameters of ClockedObject.

Definition at line 240 of file clocked_object.hh.

Constructor & Destructor Documentation

ClockedObject()

gem5::ClockedObject::ClockedObject

(

const ClockedObjectParams &

p

)

Definition at line 46 of file clocked_object.cc.

References gem5::Clocked::Clocked(), gem5::MipsISA::p, powerState, and gem5::SimObject::SimObject().

Referenced by gem5::ruby::AbstractController::AbstractController(), gem5::memory::AbstractMemory::AbstractMemory(), gem5::prefetch::AccessMapPatternMatching::AccessMapPatternMatching(), gem5::AMDGPUMemoryManager::AMDGPUMemoryManager(), gem5::prefetch::Base::Base(), gem5::BaseCache::BaseCache(), gem5::BaseCPU::BaseCPU(), gem5::BaseTags::BaseTags(), gem5::BaseTrafficGen::BaseTrafficGen(), gem5::BaseXBar::BaseXBar(), gem5::ruby::BasicRouter::BasicRouter(), gem5::branch_prediction::BranchTargetBuffer::BranchTargetBuffer(), gem5::Bridge::Bridge(), gem5::ComputeUnit::ComputeUnit(), gem5::GarnetSyntheticTraffic::GarnetSyntheticTraffic(), gem5::VegaISA::GpuTLB::GpuTLB(), gem5::X86ISA::GpuTLB::GpuTLB(), gem5::GUPSGen::GUPSGen(), gem5::LdsState::LdsState(), gem5::memory::qos::MemCtrl::MemCtrl(), gem5::MemDelay::MemDelay(), gem5::MemTest::MemTest(), gem5::ruby::Network::Network(), gem5::ruby::garnet::NetworkInterface::NetworkInterface(), gem5::ruby::garnet::NetworkLink::NetworkLink(), gem5::PioDevice::PioDevice(), gem5::ProtocolTester::ProtocolTester(), gem5::RubyDirectedTester::RubyDirectedTester(), gem5::ruby::RubyPort::RubyPort(), gem5::ruby::RubySystem::RubySystem(), gem5::RubyTester::RubyTester(), gem5::Scp::Scp(), gem5::SerialLink::SerialLink(), gem5::ruby::garnet::NetworkLink::setSourceQueue(), gem5::Shader::Shader(), gem5::SimpleCache::SimpleCache(), gem5::SMMUv3::SMMUv3(), gem5::SMMUv3DeviceInterface::SMMUv3DeviceInterface(), gem5::SpatterGen::SpatterGen(), gem5::ArmISA::TableWalker::TableWalker(), gem5::TesterThread::TesterThread(), gem5::ThermalModel::ThermalModel(), gem5::TickedObject::TickedObject(), gem5::TLBCoalescer::TLBCoalescer(), gem5::TraceCPU::TraceCPU(), gem5::VegaTLBCoalescer::VegaTLBCoalescer(), gem5::RiscvISA::Walker::Walker(), gem5::VegaISA::Walker::Walker(), gem5::X86ISA::Walker::Walker(), and gem5::ruby::garnet::NetworkLink::~NetworkLink().

Member Function Documentation

serialize()

void gem5::ClockedObject::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::CopyEngine, gem5::CpuLocalTimer, gem5::DumbTOD, gem5::EnergyCtrl, gem5::GenericTimerFrame, gem5::GenericWatchdog, gem5::GicV2, gem5::Gicv3, gem5::Gicv3Its, gem5::HDLcd, gem5::HiFiveBase, gem5::I2CBus, gem5::IdeController, gem5::IGbE, gem5::Iob, gem5::LupV, gem5::Malta, gem5::MaltaCChip, gem5::MaltaIO, gem5::memory::DRAMSys, gem5::MinorCPU, gem5::MmDisk, gem5::NoMaliGpu, gem5::NSGigE, gem5::PciDevice, gem5::Pl011, gem5::PL031, gem5::Pl050, gem5::Pl111, gem5::Plic, gem5::PM4PacketProcessor, gem5::RealViewCtrl, gem5::ruby::RubySystem, gem5::SDMAEngine, gem5::sinic::Device, gem5::SMMUv3, gem5::Sp804, gem5::Sp805, gem5::TickedObject, gem5::TrafficGen, gem5::Uart8250, gem5::UFSHostDevice, gem5::VegaISA::GpuTLB, gem5::VGic, gem5::X86ISA::Cmos, gem5::X86ISA::GpuTLB, gem5::X86ISA::I8042, gem5::X86ISA::I82094AA, gem5::X86ISA::I8237, gem5::X86ISA::I8254, gem5::X86ISA::I8259, and gem5::X86ISA::Speaker.

Definition at line 59 of file clocked_object.cc.

References powerState.

Referenced by gem5::MmDisk::serialize(), gem5::PM4PacketProcessor::serialize(), gem5::SDMAEngine::serialize(), gem5::TickedObject::serialize(), and gem5::UFSHostDevice::serialize().

unserialize()

void gem5::ClockedObject::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::CopyEngine, gem5::CpuLocalTimer, gem5::DumbTOD, gem5::EnergyCtrl, gem5::GenericTimerFrame, gem5::GenericWatchdog, gem5::GicV2, gem5::Gicv3, gem5::Gicv3Its, gem5::HDLcd, gem5::HiFiveBase, gem5::I2CBus, gem5::IdeController, gem5::IGbE, gem5::Iob, gem5::LupV, gem5::Malta, gem5::MaltaCChip, gem5::MaltaIO, gem5::memory::DRAMSys, gem5::MinorCPU, gem5::NoMaliGpu, gem5::NSGigE, gem5::PciBridge, gem5::PciDevice, gem5::PciEndpoint, gem5::Pl011, gem5::PL031, gem5::Pl050, gem5::Pl111, gem5::Plic, gem5::PM4PacketProcessor, gem5::RealViewCtrl, gem5::ruby::RubySystem, gem5::SDMAEngine, gem5::sinic::Device, gem5::SMMUv3, gem5::Sp804, gem5::Sp805, gem5::TickedObject, gem5::TrafficGen, gem5::Uart8250, gem5::UFSHostDevice, gem5::VegaISA::GpuTLB, gem5::VGic, gem5::X86ISA::Cmos, gem5::X86ISA::GpuTLB, gem5::X86ISA::I8042, gem5::X86ISA::I82094AA, gem5::X86ISA::I8237, gem5::X86ISA::I8254, gem5::X86ISA::I8259, and gem5::X86ISA::Speaker.

Definition at line 64 of file clocked_object.cc.

References powerState.

Referenced by gem5::PM4PacketProcessor::unserialize(), gem5::SDMAEngine::unserialize(), gem5::TickedObject::unserialize(), and gem5::UFSHostDevice::unserialize().

Member Data Documentation

powerState

PowerState* gem5::ClockedObject::powerState

Definition at line 245 of file clocked_object.hh.

Referenced by gem5::BaseCPU::activateContext(), ClockedObject(), gem5::BaseCPU::enterPwrGating(), gem5::FVPBasePwrCtrl::powerCoreOff(), gem5::FVPBasePwrCtrl::powerCoreOn(), gem5::BaseCPU::schedulePowerGatingEvent(), serialize(), gem5::BaseCPU::startup(), gem5::BaseCPU::suspendContext(), gem5::BaseCPU::switchOut(), gem5::BaseCPU::takeOverFrom(), and unserialize().

---

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

• sim/clocked_object.hh
• sim/clocked_object.cc