gem5  v20.1.0.0
Public Types | Public Member Functions | Protected Attributes | List of all members
PowerModelState Class Referenceabstract

A PowerModelState is an abstract class used as interface to get power figures out of SimObjects. More...

#include <power_model.hh>

Inheritance diagram for PowerModelState:
SimObject EventManager Serializable Drainable Stats::Group MathExprPowerModel

Public Types

typedef PowerModelStateParams Params
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 PowerModelState (const Params *p)
 
virtual double getDynamicPower () const =0
 Get the dynamic power consumption. More...
 
virtual double getStaticPower () const =0
 Get the static power consumption. More...
 
virtual void setTemperature (double temp)
 Temperature update. More...
 
void setClockedObject (ClockedObject *clkobj)
 
void regStats ()
 Callback to set stat parameters. 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 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

Stats::Value dynamicPower
 
Stats::Value staticPower
 
double _temp
 Current temperature. More...
 
ClockedObjectclocked_object
 The clocked object we belong to. More...
 
- 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

A PowerModelState is an abstract class used as interface to get power figures out of SimObjects.

Definition at line 54 of file power_model.hh.

Member Typedef Documentation

◆ Params

typedef PowerModelStateParams PowerModelState::Params

Definition at line 58 of file power_model.hh.

Constructor & Destructor Documentation

◆ PowerModelState()

PowerModelState::PowerModelState ( const Params p)

Definition at line 46 of file power_model.cc.

Member Function Documentation

◆ getDynamicPower()

virtual double PowerModelState::getDynamicPower ( ) const
pure virtual

Get the dynamic power consumption.

Returns
Power (Watts) consumed by this object (dynamic component)

Implemented in MathExprPowerModel.

Referenced by regStats().

◆ getStaticPower()

virtual double PowerModelState::getStaticPower ( ) const
pure virtual

Get the static power consumption.

Returns
Power (Watts) consumed by this object (static component)

Implemented in MathExprPowerModel.

Referenced by regStats().

◆ regStats()

void PowerModelState::regStats ( )
inlinevirtual

Callback to set stat parameters.

This callback is typically used for complex stats (e.g., distributions) that need parameters in addition to a name and a description. Stat names and descriptions should typically be set from the constructor usingo from the constructor using the ADD_STAT macro.

Reimplemented from Stats::Group.

Definition at line 86 of file power_model.hh.

References Stats::DataWrap< Derived, InfoProxyType >::desc(), dynamicPower, getDynamicPower(), getStaticPower(), Stats::ValueBase< Derived >::method(), SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), SimObject::params(), Stats::Group::regStats(), and staticPower.

Referenced by MathExprPowerModel::regStats().

◆ setClockedObject()

void PowerModelState::setClockedObject ( ClockedObject clkobj)
inline

Definition at line 82 of file power_model.hh.

References clocked_object.

◆ setTemperature()

virtual void PowerModelState::setTemperature ( double  temp)
inlinevirtual

Temperature update.

Parameters
tempCurrent temperature of the HW part (Celsius)

Definition at line 80 of file power_model.hh.

References _temp.

Member Data Documentation

◆ _temp

double PowerModelState::_temp
protected

Current temperature.

Definition at line 106 of file power_model.hh.

Referenced by MathExprPowerModel::getStatValue(), and setTemperature().

◆ clocked_object

ClockedObject* PowerModelState::clocked_object
protected

The clocked object we belong to.

Definition at line 109 of file power_model.hh.

Referenced by MathExprPowerModel::getStatValue(), and setClockedObject().

◆ dynamicPower

Stats::Value PowerModelState::dynamicPower
protected

Definition at line 103 of file power_model.hh.

Referenced by regStats().

◆ staticPower

Stats::Value PowerModelState::staticPower
protected

Definition at line 103 of file power_model.hh.

Referenced by regStats().


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