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:

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.

uint32_t	domainID () const

bool	validPerfLevel (PerfLevel perf_level) const
	Checks whether the performance level requested exists in the current domain configuration.

void	perfLevel (PerfLevel perf_level)
	Sets the current performance level of the domain.

PerfLevel	perfLevel () const

PerfLevel	numPerfLevels () const
	Get the number of available performance levels for this clock domain.

Tick	clkPeriodAtPerfLevel () const

Tick	clkPeriodAtPerfLevel (PerfLevel perf_level) const

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

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

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

Tick	clockPeriod () const
	Get the clock period.

Public Member Functions inherited from gem5::ClockDomain
	ClockDomain (const Params &p, VoltageDomain *voltage_domain)

Tick	clockPeriod () const
	Get the clock period.

void	registerWithClockDomain (Clocked *c)
	Register a Clocked object with this ClockDomain.

VoltageDomain *	voltageDomain () const
	Get the voltage domain.

double	voltage () const
	Get the current voltage this clock domain operates at.

void	addDerivedDomain (DerivedClockDomain *clock_domain)
	Add a derived domain.

Public Member Functions inherited from gem5::SimObject
const Params &	params () 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.

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

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

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

Public Member Functions inherited from gem5::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.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	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.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

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.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (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.

Private Attributes
const std::vector< Tick >	freqOpPoints
	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.

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

PerfLevel	_perfLevel
	Current performance level the domain is set to.

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.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Protected Attributes inherited from gem5::ClockDomain
Tick	_clockPeriod
	Pre-computed clock period in ticks.

VoltageDomain *	_voltageDomain
	Voltage domain this clock domain belongs to.

std::vector< DerivedClockDomain * >	children
	Pointers to potential derived clock domains so we can propagate changes.

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.

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

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

typedef int32_t gem5::SrcClockDomain::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

typedef uint32_t gem5::SrcClockDomain::PerfLevel

Definition at line 191 of file clock_domain.hh.

Constructor & Destructor Documentation

◆ SrcClockDomain()

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

Definition at line 80 of file clock_domain.cc.

References _domainID, _perfLevel, clockPeriod(), fatal_if, freqOpPoints, gem5::Named::name(), gem5::VoltageDomain::numVoltages(), gem5::MipsISA::p, and gem5::VoltageDomain::registerSrcClockDom().

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 ( ) const

inline

Get the clock period.

Returns: Clock period in ticks

Definition at line 108 of file clock_domain.hh.

Referenced by signalPerfLevelUpdate(), and SrcClockDomain().

◆ clockPeriod() [2/2]

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

Set new clock value.

Parameters

clock The 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 gem5::DVFSHandler::DVFSHandler(), and 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_level the 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

cp	Checkpoint state

Reimplemented from gem5::SimObject.

Definition at line 168 of file clock_domain.cc.

References _perfLevel, gem5::Serializable::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(), 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

cp	Checkpoint state

Reimplemented from gem5::SimObject.

Definition at line 175 of file clock_domain.cc.

References _perfLevel, gem5::Serializable::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

the	target 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(), 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(), clkPeriodAtPerfLevel(), numPerfLevels(), and SrcClockDomain().

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

sim/clock_domain.hh
sim/clock_domain.cc

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DomainID

◆ Params

◆ PerfLevel

Constructor & Destructor Documentation

◆ SrcClockDomain()

Member Function Documentation

◆ clkPeriodAtPerfLevel() [1/2]

◆ clkPeriodAtPerfLevel() [2/2]

◆ clockPeriod() [1/2]

◆ clockPeriod() [2/2]

◆ domainID()

◆ numPerfLevels()

◆ perfLevel() [1/2]

◆ perfLevel() [2/2]

◆ serialize()

◆ signalPerfLevelUpdate()

◆ startup()

◆ unserialize()

◆ validPerfLevel()

Member Data Documentation

◆ _domainID

◆ _perfLevel

◆ emptyDomainID

◆ freqOpPoints