gem5  v20.1.0.0
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
PowerState Class Reference

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

#include <power_state.hh>

Inheritance diagram for PowerState:
SimObject EventManager Serializable Drainable Stats::Group PowerDomain

Classes

struct  PowerStateStats
 

Public Types

typedef PowerStateParams Params
 Parameters of PowerState object. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 PowerState (const PowerStateParams *p)
 
const Paramsparams () const
 
virtual void addFollower (PowerState *pwr_obj)
 
void setControlledDomain (PowerDomain *pwr_dom)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
void set (Enums::PwrState p)
 Change the power state of this object to the power state p. More...
 
Enums::PwrState get () const
 
std::string getName () const
 
std::vector< double > getWeights () 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...
 
Enums::PwrState matchPwrState (Enums::PwrState p)
 Change the power state of this object to a power state equal to OR more performant than p. More...
 
std::set< Enums::PwrState > getPossibleStates () const
 Return the power states this object can be in. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () 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 regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. 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
EventQueueeventQueue () 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. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
- 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 Stats::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters. More...
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (Stats::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 

Protected Attributes

Enums::PwrState _currState
 To keep track of the current power state. More...
 
std::set< Enums::PwrState > possibleStates
 The possible power states this object can be in. More...
 
Tick prvEvalTick = 0
 Last tick the power stats were calculated. More...
 
PowerDomaincontrolledDomain = nullptr
 The power domain that this power state leads, nullptr if it doesn't lead any. More...
 
PowerState::PowerStateStats stats
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 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 SimObjectfind (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 ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 
- 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...
 

Detailed Description

Helper class for objects that have power states.

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

Definition at line 61 of file power_state.hh.

Member Typedef Documentation

◆ Params

typedef PowerStateParams PowerState::Params

Parameters of PowerState object.

Definition at line 67 of file power_state.hh.

Constructor & Destructor Documentation

◆ PowerState()

PowerState::PowerState ( const PowerStateParams *  p)

Definition at line 45 of file power_state.cc.

References MipsISA::p.

Member Function Documentation

◆ addFollower()

virtual void PowerState::addFollower ( PowerState pwr_obj)
inlinevirtual

Reimplemented in PowerDomain.

Definition at line 73 of file power_state.hh.

◆ computeStats()

void 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 180 of file power_state.cc.

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

Referenced by set().

◆ get()

Enums::PwrState PowerState::get ( ) const
inline

Definition at line 85 of file power_state.hh.

References _currState.

◆ getName()

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

Definition at line 90 of file power_state.hh.

References _currState.

◆ getPossibleStates()

std::set<Enums::PwrState> PowerState::getPossibleStates ( ) const
inline

Return the power states this object can be in.

Definition at line 115 of file power_state.hh.

References possibleStates.

Referenced by PowerDomain::calculatePossiblePwrStates().

◆ getWeights()

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

◆ matchPwrState()

Enums::PwrState 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 132 of file power_state.cc.

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

◆ params()

const Params* PowerState::params ( ) const
inline

Definition at line 68 of file power_state.hh.

References SimObject::_params.

◆ serialize()

void PowerState::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 69 of file power_state.cc.

References _currState, prvEvalTick, and SERIALIZE_SCALAR.

Referenced by ClockedObject::serialize().

◆ set()

void PowerState::set ( Enums::PwrState  p)

◆ setControlledDomain()

void PowerState::setControlledDomain ( PowerDomain pwr_dom)

Definition at line 59 of file power_state.cc.

References controlledDomain, DPRINTF, and SimObject::name().

◆ unserialize()

void PowerState::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 78 of file power_state.cc.

References _currState, prvEvalTick, and UNSERIALIZE_SCALAR.

Referenced by ClockedObject::unserialize().

Member Data Documentation

◆ _currState

Enums::PwrState PowerState::_currState
protected

◆ controlledDomain

PowerDomain* PowerState::controlledDomain = nullptr
protected

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

Definition at line 135 of file power_state.hh.

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

◆ possibleStates

std::set<Enums::PwrState> PowerState::possibleStates
protected

The possible power states this object can be in.

Definition at line 126 of file power_state.hh.

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

◆ prvEvalTick

Tick PowerState::prvEvalTick = 0
protected

Last tick the power stats were calculated.

Definition at line 129 of file power_state.hh.

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

◆ stats

PowerState::PowerStateStats PowerState::stats
protected

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

Generated on Wed Sep 30 2020 14:02:29 for gem5 by doxygen 1.8.17