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

#include <thermal_model.hh>

Inheritance diagram for gem5::ThermalModel:
gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Types

typedef ThermalModelParams Params
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::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)
 
Temperature getTemperature () const
 
void startup () override
 startup() is the final initialization call before simulation. More...
 
void doStep ()
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
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...
 
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
 
- Public Member Functions inherited from gem5::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...
 
const double _step
 Step in seconds for thermal updates. 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...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 
- 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 Member Functions inherited from gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (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 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

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 144 of file thermal_model.hh.

Member Typedef Documentation

◆ Params

typedef ThermalModelParams gem5::ThermalModel::Params

Definition at line 147 of file thermal_model.hh.

Constructor & Destructor Documentation

◆ ThermalModel()

gem5::ThermalModel::ThermalModel ( const Params p)

ThermalModel.

Definition at line 145 of file thermal_model.cc.

References doStep().

Member Function Documentation

◆ addCapacitor()

void gem5::ThermalModel::addCapacitor ( ThermalCapacitor c)

Definition at line 227 of file thermal_model.cc.

References gem5::ArmISA::c, capacitors, and entities.

◆ addDomain()

void gem5::ThermalModel::addDomain ( ThermalDomain d)

Definition at line 213 of file thermal_model.cc.

References gem5::ArmISA::d, domains, and entities.

◆ addNode()

void gem5::ThermalModel::addNode ( ThermalNode n)
inline

Definition at line 155 of file thermal_model.hh.

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

◆ addReference()

void gem5::ThermalModel::addReference ( ThermalReference r)

Definition at line 220 of file thermal_model.cc.

References entities, gem5::MipsISA::r, and references.

◆ addResistor()

void gem5::ThermalModel::addResistor ( ThermalResistor r)

Definition at line 234 of file thermal_model.cc.

References entities, gem5::MipsISA::r, and resistors.

◆ doStep()

void gem5::ThermalModel::doStep ( )

◆ getTemperature()

Temperature gem5::ThermalModel::getTemperature ( ) const

Definition at line 241 of file thermal_model.cc.

References eq_nodes, gem5::Temperature::fromKelvin(), and gem5::ArmISA::n.

◆ startup()

void gem5::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 gem5::SimObject.

Definition at line 180 of file thermal_model.cc.

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

Member Data Documentation

◆ _step

const double gem5::ThermalModel::_step
private

Step in seconds for thermal updates.

Definition at line 180 of file thermal_model.hh.

Referenced by doStep(), and startup().

◆ capacitors

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

Definition at line 167 of file thermal_model.hh.

Referenced by addCapacitor().

◆ domains

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

Definition at line 165 of file thermal_model.hh.

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

◆ entities

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

Definition at line 170 of file thermal_model.hh.

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

◆ eq_nodes

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

Definition at line 174 of file thermal_model.hh.

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

◆ nodes

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

Definition at line 173 of file thermal_model.hh.

Referenced by addNode(), and startup().

◆ references

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

Definition at line 166 of file thermal_model.hh.

Referenced by addReference(), and startup().

◆ resistors

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

Definition at line 168 of file thermal_model.hh.

Referenced by addResistor().

◆ stepEvent

EventFunctionWrapper gem5::ThermalModel::stepEvent
private

Stepping event to update the model values.

Definition at line 177 of file thermal_model.hh.

Referenced by doStep(), and startup().


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

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