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 ClockedObject:

Public Types
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

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

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

Enums::PwrState	pwrState () const

std::string	pwrStateName () const

std::vector< double >	pwrStateWeights () const
	Returns the percentage residency for each power state. More...

void	computeStats ()
	Record stats values like state residency by computing the time difference from previous update. More...

void	pwrState (Enums::PwrState)

void	regStats () override
	Register statistics for this object. More...

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint. More...

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint. More...

virtual void	resetStats ()
	Reset statistics associated with this object. More...

virtual void	regProbePoints ()
	Register probe points for this object. More...

virtual void	regProbeListeners ()
	Register probe listeners for this object. More...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...

virtual void	startup ()
	startup() is the final initialization call before simulation. More...

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining. More...

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes. More...

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers. More...

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

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

Public Member Functions inherited from EventManager
	EventManager (EventManager &em)

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

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)

void	setCurTick (Tick newVal)

Public Member Functions inherited from 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)

Public Member Functions inherited from Drainable
DrainState	drainState () const
	Return the current drain state of an object. More...

virtual void	notifyFork ()
	Notify a child process of a fork. More...

Public Member Functions inherited from Clocked
void	updateClockPeriod () const
	Update the tick to the current tick. More...

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

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

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

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Protected Attributes
Enums::PwrState	_currPwrState
	To keep track of the current power state. More...

Tick	prvEvalTick

Stats::Scalar	numPwrStateTransitions

Stats::Distribution	pwrStateClkGateDist

Stats::Vector	pwrStateResidencyTicks

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Additional Inherited Members
Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it. More...

Static Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	Get the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)

static void	unserializeGlobals (CheckpointIn &cp)

Static Public Attributes inherited from Serializable
static int	ckptCount = 0

static int	ckptMaxCount = 0

static int	ckptPrevCount = -1

Protected Member Functions inherited from Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain. More...

void	signalDrainDone () const
	Signal that an object is drained. More...

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

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance. More...

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

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

typedef ClockedObjectParams ClockedObject::Params

Parameters of ClockedObject.

Definition at line 241 of file clocked_object.hh.

Constructor & Destructor Documentation

ClockedObject::ClockedObject ( const ClockedObjectParams * p )

Definition at line 46 of file clocked_object.cc.

Member Function Documentation

void ClockedObject::computeStats ( )

Record stats values like state residency by computing the time difference from previous update.

Also, updates the previous evaluation tick once all stats are recorded. Usually called on power state change and stats dump callback.

Definition at line 109 of file clocked_object.cc.

References _currPwrState, curTick(), prvEvalTick, pwrStateClkGateDist, pwrStateResidencyTicks, and Stats::DistBase< Derived, Stor >::sample().

Referenced by ClockedObjectDumpCallback::process(), and pwrState().

const Params* ClockedObject::params ( ) const

inline

Definition at line 242 of file clocked_object.hh.

References SimObject::_params.

Referenced by regStats().

Enums::PwrState ClockedObject::pwrState ( ) const

inline

Definition at line 248 of file clocked_object.hh.

References _currPwrState.

Referenced by DRAMCtrl::Rank::computeStats(), DRAMCtrl::Rank::processActivateEvent(), DRAMCtrl::Rank::processPowerEvent(), DRAMCtrl::Rank::processPrechargeEvent(), DRAMCtrl::Rank::processRefreshEvent(), DRAMCtrl::Rank::processWakeUpEvent(), and DRAMCtrl::Rank::scheduleWakeUpEvent().

void ClockedObject::pwrState ( Enums::PwrState p )

Definition at line 77 of file clocked_object.cc.

References _currPwrState, computeStats(), curTick(), numPwrStateTransitions, MipsISA::p, prvEvalTick, warn, and warn_once.

std::string ClockedObject::pwrStateName ( ) const

inline

Definition at line 251 of file clocked_object.hh.

References _currPwrState.

std::vector< double > ClockedObject::pwrStateWeights ( ) const

Returns the percentage residency for each power state.

Definition at line 127 of file clocked_object.cc.

References _currPwrState, curTick(), ArmISA::i, prvEvalTick, pwrStateResidencyTicks, Stats::VectorBase< Derived, Stor >::total(), and Stats::VectorBase< Derived, Stor >::value().

Referenced by PowerModel::getDynamicPower(), and PowerModel::getStaticPower().

void ClockedObject::regStats ( )

overridevirtual

Register statistics for this object.

For every stats dump, the power state residency and other distribution stats should be computed just before the dump to ensure correct stats value being reported for current dump window. It avoids things like having any unreported time spent in a power state to be forwarded to the next dump window which might have rather unpleasant effects (like perturbing the distribution stats).

Reimplemented from SimObject.

Reimplemented in System, and TickedObject.

Definition at line 147 of file clocked_object.cc.

References Stats::DataWrap< Derived, InfoProxyType >::desc(), Stats::DataWrap< Derived, InfoProxyType >::flags(), ArmISA::i, Stats::VectorBase< Derived, Stor >::init(), Stats::Distribution::init(), SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), Stats::nonan, Stats::nozero, numPwrStateTransitions, params(), Stats::pdf, pwrStateClkGateDist, pwrStateResidencyTicks, Stats::registerDumpCallback(), SimObject::regStats(), and Stats::DataWrapVec< Derived, InfoProxyType >::subname().