#include <root.hh>

Inheritance diagram for Root:

Public Types
typedef RootParams	Params

Public Types inherited from SimObject
typedef SimObjectParams	Params

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

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

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

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

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

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

const Params *	params () const

	Root (Params *p)

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

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

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

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

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

virtual Port &	getPort (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 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. 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 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 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 Stats::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 (Stats::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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Static Public Member Functions
static Root *	root ()
	Use this function to get a pointer to the single Root object in the simulation. More...

Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

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

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

static void	serializeAll (const std::string &cpt_dir)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

Protected Member Functions
void	timeSync ()

Protected Member Functions inherited from 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
bool	_enabled

Time	_period

Tick	_periodTick

Time	_spinThreshold

Time	lastTime

EventFunctionWrapper	syncEvent

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

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

Static Private Attributes
static Root *	_root = NULL

Detailed Description

Definition at line 47 of file root.hh.

Member Typedef Documentation

◆ Params

typedef RootParams Root::Params

Definition at line 95 of file root.hh.

Constructor & Destructor Documentation

◆ Root()

Root::Root ( Params * p )

Definition at line 103 of file root.cc.

References timeSync().

Member Function Documentation

◆ params()

const Params* Root::params ( ) const

inline

Definition at line 97 of file root.hh.

References SimObject::_params.

Referenced by startup().

◆ root()

static Root* 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 73 of file root.hh.

References _root.

Referenced by Stats::resolve().

◆ serialize()

void Root::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 124 of file root.cc.

References FullSystem, and SERIALIZE_SCALAR.

◆ startup()

void Root::startup ( )

overridevirtual

Schedule the timesync event at startup().

Reimplemented from SimObject.

Definition at line 118 of file root.cc.

References params(), and timeSyncEnable().

◆ timeSync()

void Root::timeSync ( )

protected

Definition at line 47 of file root.cc.

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

Referenced by Root().

◆ timeSyncEnable()

void Root::timeSyncEnable ( bool en )

Enable or disable time syncing.

Definition at line 68 of file root.cc.

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

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

◆ timeSyncEnabled()

bool Root::timeSyncEnabled ( ) const

inline

Check whether time syncing is enabled.

Definition at line 82 of file root.hh.

References _enabled.

Referenced by timeSyncPeriod(), and timeSyncSpinThreshold().

◆ timeSyncPeriod() [1/2]

const Time Root::timeSyncPeriod ( ) const

inline

Retrieve the period for the sync event.

Definition at line 84 of file root.hh.

References _period.

Referenced by timeSync().

◆ timeSyncPeriod() [2/2]

void Root::timeSyncPeriod ( Time newPeriod )

Configure the period for time sync events.

Definition at line 86 of file root.cc.

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

◆ timeSyncSpinThreshold() [1/2]

const Time Root::timeSyncSpinThreshold ( ) const

inline

Retrieve the threshold for time remaining to spin wait.

Definition at line 86 of file root.hh.

References _spinThreshold.

◆ timeSyncSpinThreshold() [2/2]

void Root::timeSyncSpinThreshold ( Time newThreshold )

Set the threshold for time remaining to spin wait.

Definition at line 96 of file root.cc.

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

Member Data Documentation

◆ _enabled

bool Root::_enabled

protected

Definition at line 53 of file root.hh.

Referenced by timeSyncEnable(), and timeSyncEnabled().

◆ _period

Time Root::_period

protected

Definition at line 54 of file root.hh.

Referenced by timeSyncPeriod().

◆ _periodTick

Tick Root::_periodTick

protected

Definition at line 55 of file root.hh.

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

◆ _root

Root * Root::_root = NULL

staticprivate

Definition at line 50 of file root.hh.

Referenced by root().

◆ _spinThreshold

Time Root::_spinThreshold

protected

Definition at line 56 of file root.hh.

Referenced by timeSync(), and timeSyncSpinThreshold().

◆ lastTime

Time Root::lastTime

protected

Definition at line 58 of file root.hh.

Referenced by timeSync().

◆ syncEvent

EventFunctionWrapper Root::syncEvent

protected

Definition at line 61 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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Params

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]

Member Data Documentation

◆ _enabled

◆ _period

◆ _periodTick

◆ _root

◆ _spinThreshold

◆ lastTime

◆ syncEvent