gem5  v22.1.0.0
Public Types | Public Member Functions | Private Attributes | List of all members
gem5::ThermalDomain Class Reference

A ThermalDomain is used to group objects under that operate under the same temperature. More...

#include <thermal_domain.hh>

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

Public Types

typedef ThermalDomainParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 ThermalDomain (const Params &p)
 
Temperature initialTemperature () const
 Get the startup temperature. More...
 
Temperature currentTemperature () const
 Get the current temperature. More...
 
void setNode (ThermalNode *n)
 Set/Get circuit node associated with this domain. More...
 
ThermalNodegetNode () const
 
LinearEquation getEquation (ThermalNode *tn, unsigned n, double step) const override
 Get nodal equation imposed by this node. More...
 
void emitUpdate ()
 Emit a temperature update through probe points interface. More...
 
void setSubSystem (SubSystem *ss)
 Set the SubSystem reference we belong to. 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
 

Private Attributes

const Temperature _initTemperature
 
ThermalNodenode
 
SubSystemsubsystem
 
statistics::Value currentTemp
 Stat for reporting voltage of the domain. More...
 
ProbePointArg< Temperature > * ppThermalUpdate
 Probe to signal for temperature changes in this domain. More...
 

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 ThermalDomain is used to group objects under that operate under the same temperature.

Theses domains can be tied together using thermal models (such as RC) to model temperature across components.

Definition at line 61 of file thermal_domain.hh.

Member Typedef Documentation

◆ Params

typedef ThermalDomainParams gem5::ThermalDomain::Params

Definition at line 65 of file thermal_domain.hh.

Constructor & Destructor Documentation

◆ ThermalDomain()

gem5::ThermalDomain::ThermalDomain ( const Params p)

Member Function Documentation

◆ currentTemperature()

Temperature gem5::ThermalDomain::currentTemperature ( ) const

Get the current temperature.

Returns
current temperature of the domain

Definition at line 64 of file thermal_domain.cc.

References node, and gem5::ThermalNode::temp.

Referenced by ThermalDomain().

◆ emitUpdate()

void gem5::ThermalDomain::emitUpdate ( )

Emit a temperature update through probe points interface.

Definition at line 80 of file thermal_domain.cc.

References node, ppThermalUpdate, and gem5::ThermalNode::temp.

◆ getEquation()

LinearEquation gem5::ThermalDomain::getEquation ( ThermalNode tn,
unsigned  n,
double  step 
) const
overridevirtual

Get nodal equation imposed by this node.

Implements gem5::ThermalEntity.

Definition at line 87 of file thermal_domain.cc.

References gem5::PowerISA::eq, gem5::SubSystem::getDynamicPower(), gem5::SubSystem::getStaticPower(), gem5::ArmISA::n, node, and subsystem.

◆ getNode()

ThermalNode* gem5::ThermalDomain::getNode ( ) const
inline

Definition at line 84 of file thermal_domain.hh.

References node.

◆ initialTemperature()

Temperature gem5::ThermalDomain::initialTemperature ( ) const
inline

Get the startup temperature.

Returns
Initial temperature of the domain

Definition at line 73 of file thermal_domain.hh.

References _initTemperature.

◆ setNode()

void gem5::ThermalDomain::setNode ( ThermalNode n)
inline

Set/Get circuit node associated with this domain.

Definition at line 83 of file thermal_domain.hh.

References gem5::ArmISA::n, and node.

◆ setSubSystem()

void gem5::ThermalDomain::setSubSystem ( SubSystem ss)

Set the SubSystem reference we belong to.

Definition at line 70 of file thermal_domain.cc.

References gem5::SimObject::getProbeManager(), ppThermalUpdate, ss, and subsystem.

Member Data Documentation

◆ _initTemperature

const Temperature gem5::ThermalDomain::_initTemperature
private

Definition at line 101 of file thermal_domain.hh.

Referenced by initialTemperature().

◆ currentTemp

statistics::Value gem5::ThermalDomain::currentTemp
private

Stat for reporting voltage of the domain.

Definition at line 106 of file thermal_domain.hh.

Referenced by ThermalDomain().

◆ node

ThermalNode* gem5::ThermalDomain::node
private

Definition at line 102 of file thermal_domain.hh.

Referenced by currentTemperature(), emitUpdate(), getEquation(), getNode(), and setNode().

◆ ppThermalUpdate

ProbePointArg<Temperature>* gem5::ThermalDomain::ppThermalUpdate
private

Probe to signal for temperature changes in this domain.

Definition at line 109 of file thermal_domain.hh.

Referenced by emitUpdate(), and setSubSystem().

◆ subsystem

SubSystem* gem5::ThermalDomain::subsystem
private

Definition at line 103 of file thermal_domain.hh.

Referenced by getEquation(), and setSubSystem().


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

Generated on Wed Dec 21 2022 10:23:30 for gem5 by doxygen 1.9.1