gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
gem5::VoltageDomain Class Reference

A VoltageDomain is used to group clock domains that operate under the same voltage. More...

#include <voltage_domain.hh>

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

Classes

struct  VoltageDomainStats
 

Public Types

typedef VoltageDomainParams Params
 
typedef SrcClockDomain::PerfLevel PerfLevel
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 VoltageDomain (const Params &p)
 
double voltage () const
 Get the current voltage. More...
 
double voltage (PerfLevel perf_level) const
 Get the voltage at specified performance level. More...
 
uint32_t numVoltages () const
 
void perfLevel (PerfLevel perf_level)
 Set the voltage point of the domain. More...
 
PerfLevel perfLevel () const
 Get the voltage point of the domain. More...
 
void registerSrcClockDom (SrcClockDomain *src_clock_dom)
 Register a SrcClockDomain with this voltage domain. More...
 
void startup () override
 Startup has all SrcClockDomains registered with this voltage domain, so try to make sure that all perf level requests from them are met. More...
 
bool sanitiseVoltages ()
 Recomputes the highest (fastest, i.e., numerically lowest) requested performance level of all associated clock domains, and updates the performance level of this voltage domain to match. 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::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...
 
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...
 
- 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
 

Private Types

typedef std::vector< double > Voltages
 
typedef std::vector< SrcClockDomain * > SrcClockChildren
 List of associated SrcClockDomains that are connected to this voltage domain. More...
 

Private Attributes

const Voltages voltageOpPoints
 List of possible minimum voltage at each of the frequency operational points, should be in descending order and same size as freqOpPoints. More...
 
PerfLevel _perfLevel
 
gem5::VoltageDomain::VoltageDomainStats stats
 
SrcClockChildren srcClockChildren
 

Additional Inherited Members

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

Detailed Description

A VoltageDomain is used to group clock domains that operate under the same voltage.

The class provides methods for setting and getting the voltage.

Definition at line 56 of file voltage_domain.hh.

Member Typedef Documentation

◆ Params

typedef VoltageDomainParams gem5::VoltageDomain::Params

Definition at line 60 of file voltage_domain.hh.

◆ PerfLevel

Definition at line 63 of file voltage_domain.hh.

◆ SrcClockChildren

List of associated SrcClockDomains that are connected to this voltage domain.

Definition at line 158 of file voltage_domain.hh.

◆ Voltages

typedef std::vector<double> gem5::VoltageDomain::Voltages
private

Definition at line 133 of file voltage_domain.hh.

Constructor & Destructor Documentation

◆ VoltageDomain()

gem5::VoltageDomain::VoltageDomain ( const Params p)

Definition at line 51 of file voltage_domain.cc.

References fatal_if, gem5::Named::name(), and voltageOpPoints.

Member Function Documentation

◆ numVoltages()

uint32_t gem5::VoltageDomain::numVoltages ( ) const
inline

Definition at line 87 of file voltage_domain.hh.

References voltageOpPoints.

Referenced by sanitiseVoltages(), gem5::SrcClockDomain::SrcClockDomain(), and voltage().

◆ perfLevel() [1/2]

PerfLevel gem5::VoltageDomain::perfLevel ( ) const
inline

Get the voltage point of the domain.

Parameters
Voltagevalue to be set

Definition at line 99 of file voltage_domain.hh.

References _perfLevel.

Referenced by sanitiseVoltages(), and unserialize().

◆ perfLevel() [2/2]

void gem5::VoltageDomain::perfLevel ( PerfLevel  perf_level)

Set the voltage point of the domain.

Parameters
Voltagevalue to be set

Definition at line 65 of file voltage_domain.cc.

References _perfLevel, chatty_assert, DPRINTF, gem5::Named::name(), voltage(), and voltageOpPoints.

◆ registerSrcClockDom()

void gem5::VoltageDomain::registerSrcClockDom ( SrcClockDomain src_clock_dom)
inline

Register a SrcClockDomain with this voltage domain.

Parameters
src_clock_domainThe SrcClockDomain to register.

Definition at line 105 of file voltage_domain.hh.

References srcClockChildren, and gem5::ClockDomain::voltageDomain().

Referenced by gem5::SrcClockDomain::SrcClockDomain().

◆ sanitiseVoltages()

bool gem5::VoltageDomain::sanitiseVoltages ( )

Recomputes the highest (fastest, i.e., numerically lowest) requested performance level of all associated clock domains, and updates the performance level of this voltage domain to match.

This means that for two connected clock domains, one fast and one slow, the voltage domain will provide the voltage associated with the fast DVFS operation point. Must be called whenever a clock domain decides to swtich its performance level.

Returns
True, if the voltage was actually changed.

Definition at line 83 of file voltage_domain.cc.

References chatty_assert, gem5::ArmISA::d, gem5::ArmISA::dit, DPRINTF, gem5::Named::name(), numVoltages(), perfLevel(), and srcClockChildren.

Referenced by gem5::SrcClockDomain::signalPerfLevelUpdate(), and startup().

◆ serialize()

void gem5::VoltageDomain::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Reimplemented from gem5::SimObject.

Definition at line 131 of file voltage_domain.cc.

References _perfLevel, and SERIALIZE_SCALAR.

◆ startup()

void gem5::VoltageDomain::startup ( )
overridevirtual

Startup has all SrcClockDomains registered with this voltage domain, so try to make sure that all perf level requests from them are met.

Reimplemented from gem5::SimObject.

Definition at line 122 of file voltage_domain.cc.

References gem5::Named::name(), sanitiseVoltages(), and warn.

◆ unserialize()

void gem5::VoltageDomain::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Reimplemented from gem5::SimObject.

Definition at line 137 of file voltage_domain.cc.

References _perfLevel, perfLevel(), and UNSERIALIZE_SCALAR.

◆ voltage() [1/2]

double gem5::VoltageDomain::voltage ( ) const
inline

Get the current voltage.

Returns
Voltage of the domain

Definition at line 70 of file voltage_domain.hh.

References _perfLevel, and voltageOpPoints.

Referenced by perfLevel(), gem5::ClockDomain::voltage(), and gem5::VoltageDomain::VoltageDomainStats::VoltageDomainStats().

◆ voltage() [2/2]

double gem5::VoltageDomain::voltage ( PerfLevel  perf_level) const
inline

Get the voltage at specified performance level.

Parameters
perf_levelPerformance level for which the voltage is requested
Returns
Voltage of the domain at specified performance level

Definition at line 78 of file voltage_domain.hh.

References chatty_assert, gem5::Named::name(), numVoltages(), and voltageOpPoints.

Member Data Documentation

◆ _perfLevel

PerfLevel gem5::VoltageDomain::_perfLevel
private

Definition at line 142 of file voltage_domain.hh.

Referenced by perfLevel(), serialize(), unserialize(), and voltage().

◆ srcClockChildren

SrcClockChildren gem5::VoltageDomain::srcClockChildren
private

Definition at line 159 of file voltage_domain.hh.

Referenced by registerSrcClockDom(), and sanitiseVoltages().

◆ stats

gem5::VoltageDomain::VoltageDomainStats gem5::VoltageDomain::stats
private

◆ voltageOpPoints

const Voltages gem5::VoltageDomain::voltageOpPoints
private

List of possible minimum voltage at each of the frequency operational points, should be in descending order and same size as freqOpPoints.

An empty list corresponds to default voltage specified for the voltage domain its clock domain belongs. The same voltage is applied for each freqOpPoints, overall implying NO DVS

Definition at line 141 of file voltage_domain.hh.

Referenced by numVoltages(), perfLevel(), voltage(), and VoltageDomain().


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

Generated on Tue Sep 21 2021 12:28:25 for gem5 by doxygen 1.8.17