gem5  v21.0.0.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Types | Private Attributes | Static Private Attributes | List of all members
SimObject Class Reference

Abstract superclass for simulation objects. More...

#include <sim_object.hh>

Inheritance diagram for SimObject:
EventManager Serializable Drainable Stats::Group AbstractNVM AddrMapper ArmInterruptPinGen ArmISA::PMU ArmISA::Stage2MMU ArmSemihosting BaseIndexingPolicy BaseInterrupts BaseISA BaseMemProbe BaseMMU BaseTLB BasicLink BloomFilter::Base BPredUnit CacheMemory ClockDomain ClockedObject CommMonitor Compressor::Base DirectedGenerator DirectoryMemory DiskImage Display DistEtherLink Doorbell DVFSHandler EmulatedDriver EtherBus EtherDump EtherLink EtherSwitch EtherTapBase ExternalMaster ExternalSlave FastModel::CortexA76Cluster FastModel::CortexR52Cluster FaultModel FUDesc FUPool GenericTimer Gicv2mFrame GoodbyeObject GPUDispatcher HelloObject I2CDevice IdeDisk IndirectPredictor IntrControl KvmVM LoopPredictor MemChecker MemCheckerMonitor MessageBuffer MinorFU MinorFUPool MinorFUTiming MinorOpClass MinorOpClassSet OpDesc PciBar Platform PMAChecker PoolManager PowerModel PowerModelState PowerState Prefetcher::DeltaCorrelatingPredictionTables ProbeListenerObject Process PS2Device QoS::Policy QoS::TurnaroundPolicy RealViewTemperatureSensor RedirectPath RegisterFile RegisterManager ReplacementPolicy::Base RiscvRTC Root RubyPrefetcher sc_gem5::Kernel SCMI::Communication SCMI::VirtualChannel SerialDevice SimpleDisk SimpleMemobj SimpleObject SnoopFilter SouthBridge StatisticalCorrector SubSystem System SystemCounter TAGEBase ThermalCapacitor ThermalDomain ThermalNode ThermalReference ThermalResistor TimingExpr Trace::InstTracer UFSHostDevice::UFSSCSIDevice VirtIODeviceBase VncInput VoltageDomain Wavefront WireBuffer Workload WriteAllocator X86ISA::ACPI::RSDP X86ISA::ACPI::SysDescTable X86ISA::E820Entry X86ISA::E820Table X86ISA::IntelMP::BaseConfigEntry X86ISA::IntelMP::ConfigTable X86ISA::IntelMP::ExtConfigEntry X86ISA::IntelMP::FloatingPointer X86ISA::SMBios::SMBiosStructure X86ISA::SMBios::SMBiosTable

Public Types

typedef SimObjectParams Params
 

Public Member Functions

const Paramsparams () const
 
 SimObject (const Params &p)
 
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...
 
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...
 
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
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 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 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
 

Static Public Member Functions

static void serializeAll (CheckpointOut &cp)
 Serialize 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 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
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Types

typedef std::vector< SimObject * > SimObjectList
 

Private Attributes

ProbeManagerprobeManager
 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:

  1. SimObject::init()
  2. SimObject::regStats()
  3. SimObject::resetStats()
  4. SimObject::startup()
  5. 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.

The python version of a SimObject class actually represents its Params structure which holds all its parameter settings and its name. When python needs to create a C++ instance of one of those classes, it uses the Params struct's create() method which returns one instance, set up with the parameters in the struct.

When writing a SimObject class, there are three different cases as far as what you need to do to support the create() method, for hypothetical class Foo.

If you have a constructor with a signature like this:

Foo(const FooParams &)

you don't have to do anything, a create method will be automatically defined which will call your constructor and return that instance. You should use this option most of the time.

If you have a constructor with that signature but still want to define your own create method for some reason, you can do that by providing an alternative implementation which will override the default. It should have this signature:

Foo *FooParams::create() const;

If you don't have a constructor with that signature at all, then you must implement the create method with that signature which will build your object in some other way.

A reference to the SimObjectParams will be returned via the params() API. It is quite common for a derived class (DerivSimObject) to access its derived parameters by downcasting the SimObjectParam to DerivSimObjectParams

using Params = DerivSimObjectParams;
const Params &
params() const
{
return reinterpret_cast<const Params&>(_params);
}

We provide the PARAMS(..) macro as syntactic sugar to replace the code above with a much simpler:

PARAMS(DerivSimObject);

Definition at line 141 of file sim_object.hh.

Member Typedef Documentation

◆ Params

typedef SimObjectParams SimObject::Params

Definition at line 162 of file sim_object.hh.

◆ SimObjectList

Definition at line 145 of file sim_object.hh.

Constructor & Destructor Documentation

◆ ~SimObject()

SimObject::~SimObject ( )
virtual

Definition at line 64 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.

Reimplemented in FullO3CPU< O3CPUImpl >.

Definition at line 284 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
cpCheckpoint state

Implements Serializable.

Reimplemented in System, TickedObject, and VoltageDomain.

Definition at line 313 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 129 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
cpCheckpoint state

Implements Serializable.

Reimplemented in System, TickedObject, and VoltageDomain.

Definition at line 314 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 151 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 148 of file sim_object.hh.

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


The documentation for this class was generated from the following files:
SimObject::Params
SimObjectParams Params
Definition: sim_object.hh:162
SimObject::_params
const SimObjectParams & _params
Cached copy of the object parameters.
Definition: sim_object.hh:159
SimObject::params
const Params & params() const
Definition: sim_object.hh:168
PARAMS
#define PARAMS(type)
Definition: sim_object.hh:344

Generated on Tue Mar 23 2021 19:41:40 for gem5 by doxygen 1.8.17