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

#include <root.hh>

Inheritance diagram for gem5::Root:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

struct  RootStats
 

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...
 
 PARAMS (Root)
 
 Root (const Params &p, int)
 
void startup () override
 Schedule the timesync event at startup(). 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::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...
 
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
 

Static Public Member Functions

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

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

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. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

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 179 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
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 206 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 200 of file root.cc.

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

◆ timeSync()

void gem5::Root::timeSync ( )
protected

◆ timeSyncEnable()

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

◆ 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 162 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 172 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
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 216 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().

◆ _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(), 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:

Generated on Tue Sep 21 2021 12:28:04 for gem5 by doxygen 1.8.17