gem5  v21.1.0.2
Classes | Public Member Functions | Protected Attributes | List of all members
gem5::PowerState Class Reference

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

#include <power_state.hh>

Inheritance diagram for gem5::PowerState:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::PowerDomain

Classes

struct  PowerStateStats
 

Public Member Functions

 PowerState (const PowerStateParams &p)
 
 PARAMS (PowerState)
 Parameters of PowerState object. More...
 
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 gem5::SimObject
const Paramsparams () 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. 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 gem5::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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (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. 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...
 
gem5::PowerState::PowerStateStats stats
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Protected Member Functions inherited from gem5::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 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

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

Referenced by gem5::PowerDomain::calculatePossiblePwrStates().

◆ getWeights()

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

◆ 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, 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
cpCheckpoint 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)

◆ 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
cpCheckpoint 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

◆ 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

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

Generated on Tue Sep 21 2021 12:27:59 for gem5 by doxygen 1.8.17