#include <root.hh>

Inheritance diagram for gem5::Root:

Classes
struct	RootStats

Public Member Functions
bool	timeSyncEnabled () const
	Check whether time syncing is enabled.

const Time	timeSyncPeriod () const
	Retrieve the period for the sync event.

const Time	timeSyncSpinThreshold () const
	Retrieve the threshold for time remaining to spin wait.

void	timeSyncEnable (bool en)
	Enable or disable time syncing.

void	timeSyncPeriod (Time newPeriod)
	Configure the period for time sync events.

void	timeSyncSpinThreshold (Time newThreshold)
	Set the threshold for time remaining to spin wait.

	PARAMS (Root)

	Root (const Params &p, int)

void	startup () override
	Schedule the timesync event at startup().

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

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

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.

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

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

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 Member Functions
static Root *	root ()
	Use this function to get a pointer to the single Root object in the simulation.

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
void	timeSync ()

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
bool	_enabled

Time	_period

Tick	_periodTick

Time	_spinThreshold

Time	lastTime

Globals	globals

EventFunctionWrapper	syncEvent

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.

Static Private Attributes
static Root *	_root = NULL

Additional Inherited Members
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Detailed Description

Definition at line 65 of file root.hh.

Constructor & Destructor Documentation

◆ Root()

gem5::Root::Root	(	const Params &	p,
		int	)

Definition at line 178 of file root.cc.

References timeSync().

Member Function Documentation

◆ PARAMS()

gem5::Root::PARAMS ( Root )

◆ root()

static Root * gem5::Root::root ( )

inlinestatic

Use this function to get a pointer to the single Root object in the simulation.

This function asserts that such an object has actual been constructed to avoid having to perform that check everywhere the root is used. This is to allow calling the functions below.

Returns: Pointer to the single root object.

Definition at line 93 of file root.hh.

References _root.

Referenced by gem5::BaseCPU::regStats(), and gem5::statistics::resolve().

◆ serialize()

void gem5::Root::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 205 of file root.cc.

References gem5::FullSystem, globals, SERIALIZE_SCALAR, and gem5::Serializable::serializeSection().

◆ startup()

void gem5::Root::startup ( )

overridevirtual

Schedule the timesync event at startup().

Reimplemented from gem5::SimObject.

Definition at line 199 of file root.cc.

References gem5::SimObject::params(), and timeSyncEnable().

◆ timeSync()

void gem5::Root::timeSync ( )

protected

Definition at line 122 of file root.cc.

References _periodTick, _spinThreshold, gem5::curTick(), DPRINTF, lastTime, gem5::EventManager::schedule(), gem5::Time::setTimer(), gem5::sleep(), syncEvent, and timeSyncPeriod().

Referenced by Root().

◆ timeSyncEnable()

void gem5::Root::timeSyncEnable ( bool en )

Enable or disable time syncing.

Definition at line 143 of file root.cc.

References _enabled, _periodTick, gem5::curTick(), gem5::EventManager::deschedule(), gem5::ArmISA::en, gem5::EventManager::schedule(), and syncEvent.

Referenced by startup(), timeSyncPeriod(), and timeSyncSpinThreshold().

◆ timeSyncEnabled()

bool gem5::Root::timeSyncEnabled ( ) const

inline

Check whether time syncing is enabled.

Definition at line 128 of file root.hh.

References _enabled.

Referenced by timeSyncPeriod(), and timeSyncSpinThreshold().

◆ timeSyncPeriod() [1/2]

const Time gem5::Root::timeSyncPeriod ( ) const

inline

Retrieve the period for the sync event.

Definition at line 130 of file root.hh.

References _period.

Referenced by timeSync().

◆ timeSyncPeriod() [2/2]

void gem5::Root::timeSyncPeriod ( Time newPeriod )

Configure the period for time sync events.

Definition at line 161 of file root.cc.

References _period, _periodTick, gem5::ArmISA::en, gem5::Time::getTick(), timeSyncEnable(), and timeSyncEnabled().

◆ timeSyncSpinThreshold() [1/2]

const Time gem5::Root::timeSyncSpinThreshold ( ) const

inline

Retrieve the threshold for time remaining to spin wait.

Definition at line 132 of file root.hh.

References _spinThreshold.

◆ timeSyncSpinThreshold() [2/2]

void gem5::Root::timeSyncSpinThreshold ( Time newThreshold )

Set the threshold for time remaining to spin wait.

Definition at line 171 of file root.cc.

References _spinThreshold, gem5::ArmISA::en, timeSyncEnable(), and timeSyncEnabled().

◆ unserialize()

void gem5::Root::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 213 of file root.cc.

References globals, gem5::ArmISA::i, gem5::mainEventQueue, gem5::numMainEventQueues, gem5::EventManager::setCurTick(), gem5::Globals::unserializedCurTick, and gem5::Serializable::unserializeSection().

Member Data Documentation

◆ _enabled

bool gem5::Root::_enabled

protected

Definition at line 71 of file root.hh.

Referenced by timeSyncEnable(), and timeSyncEnabled().

◆ _period

Time gem5::Root::_period

protected

Definition at line 72 of file root.hh.

Referenced by timeSyncPeriod(), and timeSyncPeriod().

◆ _periodTick

Tick gem5::Root::_periodTick

protected

Definition at line 73 of file root.hh.

Referenced by timeSync(), timeSyncEnable(), and timeSyncPeriod().

◆ _root

Root * gem5::Root::_root = NULL

staticprivate

Definition at line 68 of file root.hh.

Referenced by root().

◆ _spinThreshold

Time gem5::Root::_spinThreshold

protected

Definition at line 74 of file root.hh.

Referenced by timeSync(), timeSyncSpinThreshold(), and timeSyncSpinThreshold().

◆ globals

Globals gem5::Root::globals

protected

Definition at line 78 of file root.hh.

Referenced by serialize(), and unserialize().

◆ lastTime

Time gem5::Root::lastTime

protected

Definition at line 76 of file root.hh.

Referenced by timeSync().

◆ syncEvent

EventFunctionWrapper gem5::Root::syncEvent

protected

Definition at line 81 of file root.hh.

Referenced by timeSync(), and timeSyncEnable().

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

sim/root.hh
sim/root.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Root()

Member Function Documentation

◆ PARAMS()

◆ root()

◆ serialize()

◆ startup()

◆ timeSync()

◆ timeSyncEnable()

◆ timeSyncEnabled()

◆ timeSyncPeriod() [1/2]

◆ timeSyncPeriod() [2/2]

◆ timeSyncSpinThreshold() [1/2]

◆ timeSyncSpinThreshold() [2/2]

◆ unserialize()

Member Data Documentation

◆ _enabled

◆ _period

◆ _periodTick

◆ _root

◆ _spinThreshold

◆ globals

◆ lastTime

◆ syncEvent