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

#include <thermal_domain.hh>

Inheritance diagram for ThermalDomain:

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

ThermalNode *	getNode () 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
	Callback to set stat parameters. 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 Params *	params () 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...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...

virtual Port &	getPort (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
	EventManager (EventManager &em)

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

EventQueue *	eventQueue () 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...

Public Member Functions inherited from Stats::Group
	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

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

Private Attributes
double	_initTemperature

ThermalNode *	node

SubSystem *	subsystem

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 SimObject *	find (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
EventQueue *	eventq
	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

◆ Params

typedef ThermalDomainParams ThermalDomain::Params

Definition at line 63 of file thermal_domain.hh.

Constructor & Destructor Documentation

◆ ThermalDomain()

ThermalDomain::ThermalDomain ( const Params * p )

Definition at line 53 of file thermal_domain.cc.

Referenced by emitUpdate().

Member Function Documentation

◆ currentTemperature()

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 initialTemperature(), and regStats().

◆ emitUpdate()

void ThermalDomain::emitUpdate ( )

Emit a temperature update through probe points interface.

Definition at line 88 of file thermal_domain.cc.

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

Referenced by getNode().

◆ getEquation()

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.

Referenced by getNode().

◆ getNode()

ThermalNode* ThermalDomain::getNode ( ) const

inline

Definition at line 82 of file thermal_domain.hh.

References emitUpdate(), getEquation(), ArmISA::n, node, regStats(), serialize(), setSubSystem(), ArmISA::ss, and unserialize().

◆ initialTemperature()

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, and currentTemperature().

◆ regStats()

void ThermalDomain::regStats ( )

overridevirtual

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 76 of file thermal_domain.cc.

References currentTemp, currentTemperature(), Stats::DataWrap< Derived, InfoProxyType >::desc(), Stats::ValueBase< Derived >::method(), SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), SimObject::params(), and Stats::Group::regStats().

Referenced by getNode().

◆ serialize()

void ThermalDomain::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 100 of file thermal_domain.cc.

References _initTemperature, and SERIALIZE_SCALAR.

Referenced by getNode().

◆ setNode()

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.

◆ setSubSystem()

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.

Referenced by getNode().

◆ unserialize()

void ThermalDomain::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 106 of file thermal_domain.cc.

References _initTemperature, and UNSERIALIZE_SCALAR.

Referenced by getNode().

Member Data Documentation

◆ _initTemperature

double ThermalDomain::_initTemperature

private

Definition at line 103 of file thermal_domain.hh.

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

◆ currentTemp

Stats::Value ThermalDomain::currentTemp

private

Stat for reporting voltage of the domain.

Definition at line 108 of file thermal_domain.hh.

Referenced by regStats().

◆ node

ThermalNode* ThermalDomain::node

private

Definition at line 104 of file thermal_domain.hh.

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

◆ ppThermalUpdate

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

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:

sim/power/thermal_domain.hh
sim/power/thermal_domain.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ ThermalDomain()

Member Function Documentation

◆ currentTemperature()

◆ emitUpdate()

◆ getEquation()

◆ getNode()

◆ initialTemperature()

◆ regStats()

◆ serialize()

◆ setNode()

◆ setSubSystem()

◆ unserialize()

Member Data Documentation

◆ _initTemperature

◆ currentTemp

◆ node

◆ ppThermalUpdate

◆ subsystem