Abstract superclass for simulation objects. More...

#include <sim_object.hh>

Inheritance diagram for SimObject:

Public Types
typedef SimObjectParams	Params

Public Member Functions
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...

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

Private Types
typedef std::vector< SimObject * >	SimObjectList

Private Attributes
ProbeManager *	probeManager
	Manager coordinates hooking up probe points with listeners. More...

Static Private Attributes
static SimObjectList	simObjectList
	List of all instantiated simulation objects. More...

Additional Inherited Members
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...

Detailed Description

Abstract superclass for simulation objects.

Represents things that correspond to physical components and can be specified via the config file (CPUs, caches, etc.).

SimObject initialization is controlled by the instantiate method in src/python/m5/simulate.py. There are slightly different initialization paths when starting the simulation afresh and when loading from a checkpoint. After instantiation and connecting ports, simulate.py initializes the object using the following call sequence:

SimObject::init()
SimObject::regStats()
- SimObject::initState() if starting afresh.
- SimObject::loadState() if restoring from a checkpoint.
SimObject::resetStats()
SimObject::startup()
Drainable::drainResume() if resuming from a checkpoint.

Note: Whenever a method is called on all objects in the simulator's object tree (e.g., init(), startup(), or loadState()), a pre-order depth-first traversal is performed (see descendants() in SimObject.py). This has the effect of calling the method on the parent node before its children.

Definition at line 92 of file sim_object.hh.

Member Typedef Documentation

◆ Params

typedef SimObjectParams SimObject::Params

Definition at line 113 of file sim_object.hh.

◆ SimObjectList

typedef std::vector<SimObject *> SimObject::SimObjectList

private

Definition at line 96 of file sim_object.hh.

Constructor & Destructor Documentation

◆ ~SimObject()

SimObject::~SimObject ( )

virtual

Definition at line 67 of file sim_object.cc.

References probeManager.

Member Function Documentation

◆ drain()

DrainState SimObject::drain ( )

inlineoverridevirtual

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

Implements Drainable.

Definition at line 235 of file sim_object.hh.

References Drained.

◆ serialize()

void SimObject::serialize ( CheckpointOut & cp ) const

inlineoverridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements Serializable.

Reimplemented in System, TickedObject, and VoltageDomain.

Definition at line 264 of file sim_object.hh.

Referenced by SrcClockDomain::serialize().

◆ serializeAll()

void SimObject::serializeAll ( CheckpointOut & cp )

static

Serialize all SimObjects in the system.

Definition at line 132 of file sim_object.cc.

References name(), Serializable::serializeSection(), and simObjectList.

Referenced by Serializable::serializeAll().

◆ unserialize()

void SimObject::unserialize ( CheckpointIn & cp )

inlineoverridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements Serializable.

Reimplemented in System, TickedObject, and VoltageDomain.

Definition at line 265 of file sim_object.hh.

Referenced by SrcClockDomain::unserialize().

Member Data Documentation

◆ probeManager

ProbeManager* SimObject::probeManager

private

Manager coordinates hooking up probe points with listeners.

Definition at line 102 of file sim_object.hh.

Referenced by getProbeManager(), SimObject(), and ~SimObject().

◆ simObjectList

SimObject::SimObjectList SimObject::simObjectList

staticprivate

List of all instantiated simulation objects.

Definition at line 99 of file sim_object.hh.

Referenced by find(), serializeAll(), and SimObject().

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

sim/sim_object.hh
sim/sim_object.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

◆ SimObjectList

Constructor & Destructor Documentation

◆ ~SimObject()

Member Function Documentation

◆ drain()

◆ serialize()

◆ serializeAll()

◆ unserialize()

Member Data Documentation

◆ probeManager

◆ simObjectList