#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	loadState (CheckpointIn &cp) override
	Schedule the timesync event at loadState() so that curTick is correct. More...

void	initState () override
	Schedule the timesync event at initState() when not unserializing. 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 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	regStats ()
	Register statistics for this object. More...

virtual void	resetStats ()
	Reset statistics associated with this object. 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 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 EventManager
	EventManager (EventManager &em)

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

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)

void	setCurTick (Tick newVal)

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

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 ()
	Get the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)

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

EventWrapper< Root,&Root::timeSync >	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

Friends
class	EventWrapper< Root,&Root::timeSync >

Additional Inherited Members
Static Public Attributes inherited from Serializable
static int	ckptCount = 0

static int	ckptMaxCount = 0

static int	ckptPrevCount = -1

Detailed Description

Definition at line 49 of file root.hh.

Member Typedef Documentation

typedef RootParams Root::Params

Definition at line 98 of file root.hh.

Constructor & Destructor Documentation

Root::Root ( Params * p )

Definition at line 107 of file root.cc.

References _period, _root, _spinThreshold, lastTime, Time::setTick(), Time::setTimer(), and simQuantum.

Member Function Documentation

void Root::initState ( )

overridevirtual

Schedule the timesync event at initState() when not unserializing.

Reimplemented from SimObject.

Definition at line 121 of file root.cc.

References params(), and timeSyncEnable().

void Root::loadState ( CheckpointIn & cp )

overridevirtual

Schedule the timesync event at loadState() so that curTick is correct.

Reimplemented from SimObject.

Definition at line 127 of file root.cc.

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

const Params* Root::params ( ) const

inline

Definition at line 100 of file root.hh.

References SimObject::_params.

Referenced by initState(), and loadState().

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.