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

The ClockDomain provides clock to group of clocked objects bundled under the same clock domain. More...

#include <clock_domain.hh>

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

Classes

struct  ClockDomainStats
 

Public Types

typedef ClockDomainParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

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

Protected Attributes

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

Private Attributes

gem5::ClockDomain::ClockDomainStats stats
 

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

Detailed Description

The ClockDomain provides clock to group of clocked objects bundled under the same clock domain.

The clock domains, in turn, are grouped into voltage domains. The clock domains provide support for a hierarchial structure with source and derived domains.

Definition at line 71 of file clock_domain.hh.

Member Typedef Documentation

◆ Params

typedef ClockDomainParams gem5::ClockDomain::Params

Definition at line 100 of file clock_domain.hh.

Constructor & Destructor Documentation

◆ ClockDomain()

gem5::ClockDomain::ClockDomain ( const Params p,
VoltageDomain voltage_domain 
)

Definition at line 66 of file clock_domain.cc.

Member Function Documentation

◆ addDerivedDomain()

void gem5::ClockDomain::addDerivedDomain ( DerivedClockDomain clock_domain)
inline

Add a derived domain.

Parameters
Deriveddomain to add as a child

Definition at line 142 of file clock_domain.hh.

References children.

Referenced by gem5::DerivedClockDomain::DerivedClockDomain().

◆ clockPeriod()

Tick gem5::ClockDomain::clockPeriod ( ) const
inline

◆ registerWithClockDomain()

void gem5::ClockDomain::registerWithClockDomain ( Clocked c)
inline

Register a Clocked object with this ClockDomain.

Parameters
Clockedto add as a member

Definition at line 115 of file clock_domain.hh.

References gem5::ArmISA::c, and members.

Referenced by gem5::Clocked::Clocked().

◆ voltage()

double gem5::ClockDomain::voltage ( ) const

Get the current voltage this clock domain operates at.

Returns
Voltage applied to the clock domain

Definition at line 75 of file clock_domain.cc.

References _voltageDomain, and gem5::VoltageDomain::voltage().

Referenced by gem5::Clocked::voltage().

◆ voltageDomain()

VoltageDomain* gem5::ClockDomain::voltageDomain ( ) const
inline

Get the voltage domain.

Returns
Voltage domain this clock domain belongs to

Definition at line 127 of file clock_domain.hh.

References _voltageDomain.

Referenced by gem5::VoltageDomain::registerSrcClockDom(), gem5::SrcClockDomain::signalPerfLevelUpdate(), and gem5::DVFSHandler::voltageAtPerfLevel().

Member Data Documentation

◆ _clockPeriod

Tick gem5::ClockDomain::_clockPeriod
protected

Pre-computed clock period in ticks.

This is populated by the inheriting classes based on how their period is determined.

Definition at line 79 of file clock_domain.hh.

Referenced by clockPeriod(), gem5::SrcClockDomain::clockPeriod(), gem5::RealViewOsc::clockPeriod(), gem5::RealViewOsc::read(), gem5::RealViewOsc::RealViewOsc(), gem5::RealViewOsc::serialize(), gem5::RealViewOsc::unserialize(), and gem5::DerivedClockDomain::updateClockPeriod().

◆ _voltageDomain

VoltageDomain* gem5::ClockDomain::_voltageDomain
protected

Voltage domain this clock domain belongs to.

Definition at line 84 of file clock_domain.hh.

Referenced by voltage(), and voltageDomain().

◆ children

std::vector<DerivedClockDomain*> gem5::ClockDomain::children
protected

Pointers to potential derived clock domains so we can propagate changes.

Definition at line 90 of file clock_domain.hh.

Referenced by addDerivedDomain(), gem5::SrcClockDomain::clockPeriod(), gem5::RealViewOsc::clockPeriod(), and gem5::DerivedClockDomain::updateClockPeriod().

◆ members

std::vector<Clocked *> gem5::ClockDomain::members
protected

Pointers to members of this clock domain, so that when the clock period changes, we can update each member's tick.

Definition at line 96 of file clock_domain.hh.

Referenced by gem5::SrcClockDomain::clockPeriod(), gem5::RealViewOsc::clockPeriod(), registerWithClockDomain(), gem5::RealViewOsc::startup(), and gem5::DerivedClockDomain::updateClockPeriod().

◆ stats

gem5::ClockDomain::ClockDomainStats gem5::ClockDomain::stats
private

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

Generated on Tue Sep 21 2021 12:27:23 for gem5 by doxygen 1.8.17