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

The source clock domains provides the notion of a clock domain that is connected to a tunable clock source. More...

#include <clock_domain.hh>

Inheritance diagram for gem5::SrcClockDomain:
gem5::ClockDomain gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Types

typedef SrcClockDomainParams Params
 
typedef int32_t DomainID
 
typedef uint32_t PerfLevel
 
- Public Types inherited from gem5::ClockDomain
typedef ClockDomainParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 SrcClockDomain (const Params &p)
 
void clockPeriod (Tick clock_period)
 Set new clock value. More...
 
uint32_t domainID () const
 
bool validPerfLevel (PerfLevel perf_level) const
 Checks whether the performance level requested exists in the current domain configuration. More...
 
void perfLevel (PerfLevel perf_level)
 Sets the current performance level of the domain. More...
 
PerfLevel perfLevel () const
 
PerfLevel numPerfLevels () const
 Get the number of available performance levels for this clock domain. More...
 
Tick clkPeriodAtPerfLevel () const
 
Tick clkPeriodAtPerfLevel (PerfLevel perf_level) const
 
void startup () override
 startup() is the final initialization call before simulation. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Tick clockPeriod () const
 Get the clock period. More...
 
- Public Member Functions inherited from gem5::ClockDomain
 ClockDomain (const Params &p, VoltageDomain *voltage_domain)
 
Tick clockPeriod () const
 Get the clock period. More...
 
void registerWithClockDomain (Clocked *c)
 Register a Clocked object with this ClockDomain. More...
 
VoltageDomainvoltageDomain () const
 Get the voltage domain. More...
 
double voltage () const
 Get the current voltage this clock domain operates at. More...
 
void addDerivedDomain (DerivedClockDomain *clock_domain)
 Add a derived domain. 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
 

Static Public Attributes

static const DomainID emptyDomainID = -1
 

Private Member Functions

void signalPerfLevelUpdate ()
 Inform other components about the changed performance level. More...
 

Private Attributes

const std::vector< TickfreqOpPoints
 List of possible frequency operational points, should be in descending order An empty list corresponds to default frequency specified for its clock domain, overall implying NO DVFS. More...
 
const uint32_t _domainID
 Software recognizable id number for the domain, should be unique for each domain. More...
 
PerfLevel _perfLevel
 Current performance level the domain is set to. 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::ClockDomain
Tick _clockPeriod
 Pre-computed clock period in ticks. More...
 
VoltageDomain_voltageDomain
 Voltage domain this clock domain belongs to. More...
 
std::vector< DerivedClockDomain * > children
 Pointers to potential derived clock domains so we can propagate changes. More...
 
std::vector< Clocked * > members
 Pointers to members of this clock domain, so that when the clock period changes, we can update each member's tick. 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

The source clock domains provides the notion of a clock domain that is connected to a tunable clock source.

It maintains the clock period and provides methods for setting/getting the clock and configuration parameters for clock domain that handler is going to manage. This includes frequency values at various performance levels, domain id, and current performance level. Note that a performance level as requested by the software corresponds to one of the frequency operational points the domain can operate at.

Definition at line 166 of file clock_domain.hh.

Member Typedef Documentation

◆ DomainID

Definition at line 183 of file clock_domain.hh.

◆ Params

typedef SrcClockDomainParams gem5::SrcClockDomain::Params

Definition at line 171 of file clock_domain.hh.

◆ PerfLevel

Definition at line 191 of file clock_domain.hh.

Constructor & Destructor Documentation

◆ SrcClockDomain()

gem5::SrcClockDomain::SrcClockDomain ( const Params p)

Member Function Documentation

◆ clkPeriodAtPerfLevel() [1/2]

Tick gem5::SrcClockDomain::clkPeriodAtPerfLevel ( ) const
inline
Returns
the clock period (expressed in ticks) for the current performance level

Definition at line 227 of file clock_domain.hh.

References freqOpPoints, and perfLevel().

Referenced by signalPerfLevelUpdate().

◆ clkPeriodAtPerfLevel() [2/2]

Tick gem5::SrcClockDomain::clkPeriodAtPerfLevel ( PerfLevel  perf_level) const
inline

Definition at line 229 of file clock_domain.hh.

References freqOpPoints, and validPerfLevel().

◆ clockPeriod() [1/2]

Tick gem5::ClockDomain::clockPeriod
inline

Get the clock period.

Returns
Clock period in ticks

Definition at line 108 of file clock_domain.hh.

◆ clockPeriod() [2/2]

void gem5::SrcClockDomain::clockPeriod ( Tick  clock_period)

Set new clock value.

Parameters
clockThe new clock period in ticks

Definition at line 115 of file clock_domain.cc.

References gem5::ClockDomain::_clockPeriod, gem5::ArmISA::c, gem5::ClockDomain::children, DPRINTF, fatal, gem5::ArmISA::m, gem5::ClockDomain::members, and gem5::Named::name().

◆ domainID()

uint32_t gem5::SrcClockDomain::domainID ( ) const
inline
Returns
the domainID of the domain

Definition at line 189 of file clock_domain.hh.

References _domainID.

Referenced by perfLevel().

◆ numPerfLevels()

PerfLevel gem5::SrcClockDomain::numPerfLevels ( ) const
inline

Get the number of available performance levels for this clock domain.

Returns
Number of perf levels configured for this domain.

Definition at line 221 of file clock_domain.hh.

References freqOpPoints.

Referenced by gem5::DVFSHandler::numPerfLevels(), and validPerfLevel().

◆ perfLevel() [1/2]

PerfLevel gem5::SrcClockDomain::perfLevel ( ) const
inline
Returns
the current performance level of the domain

Definition at line 214 of file clock_domain.hh.

References _perfLevel.

Referenced by clkPeriodAtPerfLevel().

◆ perfLevel() [2/2]

void gem5::SrcClockDomain::perfLevel ( PerfLevel  perf_level)

Sets the current performance level of the domain.

Parameters
perf_levelthe target performance level

Definition at line 139 of file clock_domain.cc.

References _perfLevel, domainID(), DPRINTF, gem5::Named::name(), signalPerfLevelUpdate(), and validPerfLevel().

Referenced by gem5::DVFSHandler::perfLevel().

◆ serialize()

void gem5::SrcClockDomain::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 168 of file clock_domain.cc.

References _perfLevel, gem5::SimObject::serialize(), and SERIALIZE_SCALAR.

◆ signalPerfLevelUpdate()

void gem5::SrcClockDomain::signalPerfLevelUpdate ( )
private

Inform other components about the changed performance level.

Definition at line 157 of file clock_domain.cc.

References clkPeriodAtPerfLevel(), gem5::ClockDomain::clockPeriod(), gem5::VoltageDomain::sanitiseVoltages(), and gem5::ClockDomain::voltageDomain().

Referenced by perfLevel(), and startup().

◆ startup()

void gem5::SrcClockDomain::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 182 of file clock_domain.cc.

References signalPerfLevelUpdate().

◆ unserialize()

void gem5::SrcClockDomain::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 175 of file clock_domain.cc.

References _perfLevel, gem5::SimObject::unserialize(), and UNSERIALIZE_SCALAR.

◆ validPerfLevel()

bool gem5::SrcClockDomain::validPerfLevel ( PerfLevel  perf_level) const
inline

Checks whether the performance level requested exists in the current domain configuration.

Parameters
thetarget performance level of the domain
Returns
validity status of the given performance level

Definition at line 200 of file clock_domain.hh.

References numPerfLevels().

Referenced by clkPeriodAtPerfLevel(), and perfLevel().

Member Data Documentation

◆ _domainID

const uint32_t gem5::SrcClockDomain::_domainID
private

Software recognizable id number for the domain, should be unique for each domain.

Definition at line 258 of file clock_domain.hh.

Referenced by domainID(), and SrcClockDomain().

◆ _perfLevel

PerfLevel gem5::SrcClockDomain::_perfLevel
private

Current performance level the domain is set to.

The performance level corresponds to one selected frequency (and related voltage) from the supplied list of frequencies, with perfLevel = 0 being the fastest performance state.

Definition at line 266 of file clock_domain.hh.

Referenced by perfLevel(), serialize(), SrcClockDomain(), and unserialize().

◆ emptyDomainID

const DomainID gem5::SrcClockDomain::emptyDomainID = -1
static

Definition at line 184 of file clock_domain.hh.

Referenced by gem5::DVFSHandler::DVFSHandler().

◆ freqOpPoints

const std::vector<Tick> gem5::SrcClockDomain::freqOpPoints
private

List of possible frequency operational points, should be in descending order An empty list corresponds to default frequency specified for its clock domain, overall implying NO DVFS.

Definition at line 252 of file clock_domain.hh.

Referenced by clkPeriodAtPerfLevel(), numPerfLevels(), and SrcClockDomain().


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

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