#include <thermal_model.hh>

Inheritance diagram for ThermalModel:

Public Types
typedef ThermalModelParams	Params

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	ThermalModel (const Params *p)
	ThermalModel. More...

void	addDomain (ThermalDomain *d)

void	addReference (ThermalReference *r)

void	addCapacitor (ThermalCapacitor *c)

void	addResistor (ThermalResistor *r)

void	addNode (ThermalNode *n)

double	getTemp () const

void	startup () override
	startup() is the final initialization call before simulation. More...

void	doStep ()

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

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

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
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)
	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	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 (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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from Clocked
void	updateClockPeriod ()
	Update the tick to the current tick. More...

Tick	clockEdge (Cycles cycles=Cycles(0)) const
	Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge. More...

Tick	nextCycle () const
	Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Private Attributes
std::vector< ThermalDomain * >	domains

std::vector< ThermalReference * >	references

std::vector< ThermalCapacitor * >	capacitors

std::vector< ThermalResistor * >	resistors

std::vector< ThermalEntity * >	entities

std::vector< ThermalNode * >	nodes

std::vector< ThermalNode * >	eq_nodes

EventFunctionWrapper	stepEvent
	Stepping event to update the model values. More...

double	_step
	Step in seconds for thermal updates. 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 ()
	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)

Public Attributes inherited from ClockedObject
PowerState *	powerState

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 Member Functions inherited from Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance. More...

void	resetClock () const
	Reset the object's clock using the current global tick value. More...

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. 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

See also: gem5 Thermal Model

A ThermalModel is the element which ties all thermal objects together and provides the thermal solver to the system. It is reponsible for updating temperature for all Thermal Domains over time by reading power from simobjects.

Definition at line 147 of file thermal_model.hh.

Member Typedef Documentation

◆ Params

typedef ThermalModelParams ThermalModel::Params

Definition at line 150 of file thermal_model.hh.

Constructor & Destructor Documentation

◆ ThermalModel()

ThermalModel::ThermalModel ( const Params * p )

ThermalModel.

Definition at line 194 of file thermal_model.cc.

References doStep().

Member Function Documentation

◆ addCapacitor()

void ThermalModel::addCapacitor ( ThermalCapacitor * c )

Definition at line 287 of file thermal_model.cc.

References ArmISA::c, capacitors, and entities.

◆ addDomain()

void ThermalModel::addDomain ( ThermalDomain * d )

Definition at line 279 of file thermal_model.cc.

References ArmISA::d, domains, and entities.

◆ addNode()

void ThermalModel::addNode ( ThermalNode * n )

inline

Definition at line 158 of file thermal_model.hh.

References ArmISA::n, and nodes.

◆ addReference()

void ThermalModel::addReference ( ThermalReference * r )

Definition at line 283 of file thermal_model.cc.

References entities, MipsISA::r, and references.

◆ addResistor()

void ThermalModel::addResistor ( ThermalResistor * r )

Definition at line 291 of file thermal_model.cc.

References entities, MipsISA::r, and resistors.

◆ doStep()

void ThermalModel::doStep ( )

Definition at line 218 of file thermal_model.cc.

References _step, curTick(), domains, ArmISA::e, entities, PowerISA::eq, eq_nodes, ArmISA::i, ArmISA::n, SimClock::Int::s, EventManager::schedule(), LinearSystem::solve(), and stepEvent.

Referenced by ThermalModel().

◆ getTemp()

double ThermalModel::getTemp ( ) const

Definition at line 296 of file thermal_model.cc.

References eq_nodes, and ArmISA::n.

Referenced by RealViewTemperatureSensor::read().

◆ serialize()

void ThermalModel::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Reimplemented from ClockedObject.

Definition at line 206 of file thermal_model.cc.

References _step, and SERIALIZE_SCALAR.

◆ startup()

void ThermalModel::startup ( )

overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from SimObject.

Definition at line 247 of file thermal_model.cc.

References _step, curTick(), domains, eq_nodes, ArmISA::i, ArmISA::n, nodes, references, SimClock::Int::s, EventManager::schedule(), and stepEvent.

◆ unserialize()

void ThermalModel::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Reimplemented from ClockedObject.

Definition at line 212 of file thermal_model.cc.

References _step, and UNSERIALIZE_SCALAR.

Member Data Documentation

◆ _step

double ThermalModel::_step

private

Step in seconds for thermal updates.

Definition at line 185 of file thermal_model.hh.

Referenced by doStep(), serialize(), startup(), and unserialize().

◆ capacitors

std::vector<ThermalCapacitor *> ThermalModel::capacitors

private

Definition at line 172 of file thermal_model.hh.

Referenced by addCapacitor().

◆ domains

std::vector<ThermalDomain *> ThermalModel::domains

private

Definition at line 170 of file thermal_model.hh.

Referenced by addDomain(), doStep(), and startup().

◆ entities

std::vector<ThermalEntity *> ThermalModel::entities

private

Definition at line 175 of file thermal_model.hh.

Referenced by addCapacitor(), addDomain(), addReference(), addResistor(), and doStep().

◆ eq_nodes

std::vector<ThermalNode*> ThermalModel::eq_nodes

private

Definition at line 179 of file thermal_model.hh.

Referenced by doStep(), getTemp(), and startup().

◆ nodes

std::vector<ThermalNode*> ThermalModel::nodes

private

Definition at line 178 of file thermal_model.hh.

Referenced by addNode(), and startup().

◆ references

std::vector<ThermalReference *> ThermalModel::references

private

Definition at line 171 of file thermal_model.hh.

Referenced by addReference(), and startup().

◆ resistors

std::vector<ThermalResistor *> ThermalModel::resistors

private

Definition at line 173 of file thermal_model.hh.

Referenced by addResistor().

◆ stepEvent

EventFunctionWrapper ThermalModel::stepEvent

private

Stepping event to update the model values.

Definition at line 182 of file thermal_model.hh.

Referenced by doStep(), and startup().

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

sim/power/thermal_model.hh
sim/power/thermal_model.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ ThermalModel()

Member Function Documentation

◆ addCapacitor()

◆ addDomain()

◆ addNode()

◆ addReference()

◆ addResistor()

◆ doStep()

◆ getTemp()

◆ serialize()

◆ startup()

◆ unserialize()

Member Data Documentation

◆ _step

◆ capacitors

◆ domains

◆ entities

◆ eq_nodes

◆ nodes

◆ references

◆ resistors

◆ stepEvent