gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | List of all members
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 ThermalDomain:
SimObject ThermalEntity EventManager Serializable Drainable

Public Types

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

Public Member Functions

 ThermalDomain (const Params *p)
 
double initialTemperature () const
 Get the startup temperature. More...
 
double 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...
 
void regStats () override
 Register statistics for this object. 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 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 resetStats ()
 Reset statistics associated with this object. 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 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
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
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)
 
void setCurTick (Tick newVal)
 
- 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...
 

Private Attributes

double _initTemperature
 
ThermalNodenode
 
SubSystemsubsystem
 
Stats::Value currentTemp
 Stat for reporting voltage of the domain. More...
 
ProbePointArg< double > * ppThermalUpdate
 Probe to signal for temperature changes in this domain. 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 ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 
- 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...
 
- 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...
 

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 59 of file thermal_domain.hh.

Member Typedef Documentation

typedef ThermalDomainParams ThermalDomain::Params

Definition at line 63 of file thermal_domain.hh.

Constructor & Destructor Documentation

ThermalDomain::ThermalDomain ( const Params p)

Definition at line 53 of file thermal_domain.cc.

Member Function Documentation

double ThermalDomain::currentTemperature ( ) const

Get the current temperature.

Returns
Initial temperature of the domain

Definition at line 60 of file thermal_domain.cc.

References node, and ThermalNode::temp.

Referenced by regStats().

void ThermalDomain::emitUpdate ( )

Emit a temperature update through probe points interface.

Definition at line 88 of file thermal_domain.cc.

References node, ProbePointArg< T >::notify(), ppThermalUpdate, and ThermalNode::temp.

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

Get nodal equation imposed by this node.

Implements ThermalEntity.

Definition at line 113 of file thermal_domain.cc.

References LinearEquation::cnt(), PowerISA::eq, SubSystem::getDynamicPower(), SubSystem::getStaticPower(), node, power(), and subsystem.

ThermalNode* ThermalDomain::getNode ( ) const
inline

Definition at line 82 of file thermal_domain.hh.

References node.

double ThermalDomain::initialTemperature ( ) const
inline

Get the startup temperature.

Returns
Initial temperature of the domain

Definition at line 71 of file thermal_domain.hh.

References _initTemperature.

void ThermalDomain::regStats ( )
overridevirtual
void ThermalDomain::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 100 of file thermal_domain.cc.

References _initTemperature, and SERIALIZE_SCALAR.

void ThermalDomain::setNode ( ThermalNode n)
inline

Set/Get circuit node associated with this domain.

Definition at line 81 of file thermal_domain.hh.

References ArmISA::n, and node.

void ThermalDomain::setSubSystem ( SubSystem ss)

Set the SubSystem reference we belong to.

Definition at line 66 of file thermal_domain.cc.

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

void ThermalDomain::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 106 of file thermal_domain.cc.

References _initTemperature, and UNSERIALIZE_SCALAR.

Member Data Documentation

double ThermalDomain::_initTemperature
private

Definition at line 103 of file thermal_domain.hh.

Referenced by initialTemperature(), serialize(), and unserialize().

Stats::Value ThermalDomain::currentTemp
private

Stat for reporting voltage of the domain.

Definition at line 108 of file thermal_domain.hh.

Referenced by regStats().

ThermalNode* ThermalDomain::node
private

Definition at line 104 of file thermal_domain.hh.

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

ProbePointArg<double>* ThermalDomain::ppThermalUpdate
private

Probe to signal for temperature changes in this domain.

Definition at line 111 of file thermal_domain.hh.

Referenced by emitUpdate(), and setSubSystem().

SubSystem* ThermalDomain::subsystem
private

Definition at line 105 of file thermal_domain.hh.

Referenced by getEquation(), and setSubSystem().


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

Generated on Fri Jun 9 2017 13:04:20 for gem5 by doxygen 1.8.6