Helper class for objects that have power states. More...

#include <power_state.hh>

Inheritance diagram for gem5::PowerState:

Classes
struct	PowerStateStats

Public Member Functions
	PowerState (const PowerStateParams &p)

	PARAMS (PowerState)
	Parameters of PowerState object.

virtual void	addFollower (PowerState *pwr_obj)

void	setControlledDomain (PowerDomain *pwr_dom)

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

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

void	set (enums::PwrState p)
	Change the power state of this object to the power state p.

enums::PwrState	get () const

std::string	getName () const

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

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

enums::PwrState	matchPwrState (enums::PwrState p)
	Change the power state of this object to a power state equal to OR more performant than p.

std::set< enums::PwrState >	getPossibleStates () const
	Return the power states this object can be in.

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 (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Protected Attributes
enums::PwrState	_currState
	To keep track of the current power state.

std::set< enums::PwrState >	possibleStates
	The possible power states this object can be in.

Tick	prvEvalTick = 0
	Last tick the power stats were calculated.

PowerDomain *	controlledDomain = nullptr
	The power domain that this power state leads, nullptr if it doesn't lead any.

gem5::PowerState::PowerStateStats	stats

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.

Additional Inherited Members
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

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.

Detailed Description

Helper class for objects that have power states.

This class provides the basic functionality to change between power states.

Definition at line 64 of file power_state.hh.

Constructor & Destructor Documentation

◆ PowerState()

gem5::PowerState::PowerState ( const PowerStateParams & p )

Definition at line 52 of file power_state.cc.

References gem5::MipsISA::p.

Member Function Documentation

◆ addFollower()

virtual void gem5::PowerState::addFollower ( PowerState * pwr_obj )

inlinevirtual

Reimplemented in gem5::PowerDomain.

Definition at line 72 of file power_state.hh.

◆ computeStats()

void gem5::PowerState::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 187 of file power_state.cc.

References _currState, gem5::curTick(), prvEvalTick, gem5::PowerState::PowerStateStats::pwrStateResidencyTicks, gem5::statistics::DistBase< Derived, Stor >::sample(), stats, and gem5::PowerState::PowerStateStats::ticksClkGated.

Referenced by set().

◆ get()

enums::PwrState gem5::PowerState::get ( ) const

inline

Definition at line 84 of file power_state.hh.

References _currState.

Referenced by gem5::BaseCPU::schedulePowerGatingEvent(), gem5::BaseCPU::startup(), and gem5::BaseCPU::takeOverFrom().

◆ getName()

std::string gem5::PowerState::getName ( ) const

inline

Definition at line 89 of file power_state.hh.

References _currState.

◆ getPossibleStates()

std::set< enums::PwrState > gem5::PowerState::getPossibleStates ( ) const

inline

Return the power states this object can be in.

Definition at line 114 of file power_state.hh.

References possibleStates.

◆ getWeights()

std::vector< double > gem5::PowerState::getWeights ( ) const

Returns the percentage residency for each power state.

Definition at line 205 of file power_state.cc.

References _currState, gem5::curTick(), gem5::ArmISA::i, prvEvalTick, gem5::PowerState::PowerStateStats::pwrStateResidencyTicks, stats, gem5::statistics::VectorBase< Derived, Stor >::total(), and gem5::statistics::VectorBase< Derived, Stor >::value().

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

◆ matchPwrState()

enums::PwrState gem5::PowerState::matchPwrState ( enums::PwrState p )

Change the power state of this object to a power state equal to OR more performant than p.

Returns the power state the object actually went to.

Definition at line 139 of file power_state.cc.

References _currState, controlledDomain, DPRINTF, gem5::PowerState::PowerStateStats::numPwrMatchStateTransitions, gem5::MipsISA::p, possibleStates, gem5::ArmISA::set, stats, and warn_if.

◆ PARAMS()

gem5::PowerState::PARAMS ( PowerState )

Parameters of PowerState object.

◆ serialize()

void gem5::PowerState::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.

Definition at line 76 of file power_state.cc.

References _currState, prvEvalTick, and SERIALIZE_SCALAR.

Referenced by gem5::ClockedObject::serialize().

◆ set()

void gem5::PowerState::set ( enums::PwrState p )

Change the power state of this object to the power state p.

Definition at line 96 of file power_state.cc.

References _currState, computeStats(), controlledDomain, gem5::curTick(), gem5::Named::name(), gem5::PowerState::PowerStateStats::numTransitions, gem5::MipsISA::p, panic_if, possibleStates, prvEvalTick, gem5::PowerDomain::pwrStateChangeCallback(), stats, warn, and warn_once.

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

◆ setControlledDomain()

void gem5::PowerState::setControlledDomain ( PowerDomain * pwr_dom )

Definition at line 66 of file power_state.cc.

References controlledDomain, DPRINTF, and gem5::Named::name().

◆ unserialize()

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

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 85 of file power_state.cc.

References _currState, prvEvalTick, and UNSERIALIZE_SCALAR.

Referenced by gem5::ClockedObject::unserialize().

Member Data Documentation

◆ _currState

enums::PwrState gem5::PowerState::_currState

protected

To keep track of the current power state.

Definition at line 122 of file power_state.hh.

Referenced by computeStats(), get(), getName(), getWeights(), matchPwrState(), gem5::PowerDomain::PowerDomain(), gem5::PowerDomain::pwrStateChangeCallback(), serialize(), set(), gem5::PowerDomain::setFollowerPowerStates(), and unserialize().

◆ controlledDomain

PowerDomain* gem5::PowerState::controlledDomain = nullptr

protected

The power domain that this power state leads, nullptr if it doesn't lead any.

Definition at line 134 of file power_state.hh.

Referenced by matchPwrState(), set(), and setControlledDomain().

◆ possibleStates

std::set<enums::PwrState> gem5::PowerState::possibleStates

protected

The possible power states this object can be in.

Definition at line 125 of file power_state.hh.

Referenced by gem5::PowerDomain::calculatePossiblePwrStates(), getPossibleStates(), matchPwrState(), and set().

◆ prvEvalTick

Tick gem5::PowerState::prvEvalTick = 0

protected

Last tick the power stats were calculated.

Definition at line 128 of file power_state.hh.

Referenced by computeStats(), getWeights(), serialize(), set(), and unserialize().

◆ stats

gem5::PowerState::PowerStateStats gem5::PowerState::stats

protected

Referenced by computeStats(), getWeights(), matchPwrState(), and set().

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

sim/power_state.hh
sim/power_state.cc

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PowerState()

Member Function Documentation

◆ addFollower()

◆ computeStats()

◆ get()

◆ getName()

◆ getPossibleStates()

◆ getWeights()

◆ matchPwrState()

◆ PARAMS()

◆ serialize()

◆ set()

◆ setControlledDomain()

◆ unserialize()

Member Data Documentation

◆ _currState

◆ controlledDomain

◆ possibleStates

◆ prvEvalTick

◆ stats