gem5  v21.1.0.2
Public Types | Public Member Functions | Static Public Member Functions | Static Private Member Functions | Private Attributes | List of all members
sc_gem5::Kernel Class Reference

#include <kernel.hh>

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

Public Types

typedef gem5::SystemC_KernelParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 Kernel (const Params &params, int)
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
void regStats () override
 Callback to set stat parameters. More...
 
void startup () override
 startup() is the final initialization call before simulation. More...
 
void t0Handler ()
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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 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 sc_core::sc_status status ()
 
static void status (sc_core::sc_status s)
 
static void stop ()
 
static bool startOfSimulationComplete ()
 
static bool endOfSimulationComplete ()
 
- 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...
 

Static Private Member Functions

static void stopWork ()
 

Private Attributes

gem5::EventWrapper< Kernel, &Kernel::t0Handlert0Event
 

Additional Inherited Members

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

Detailed Description

Definition at line 45 of file kernel.hh.

Member Typedef Documentation

◆ Params

typedef gem5::SystemC_KernelParams sc_gem5::Kernel::Params

Definition at line 48 of file kernel.hh.

Constructor & Destructor Documentation

◆ Kernel()

sc_gem5::Kernel::Kernel ( const Params params,
int   
)

Member Function Documentation

◆ endOfSimulationComplete()

bool sc_gem5::Kernel::endOfSimulationComplete ( )
static

Definition at line 52 of file kernel.cc.

Referenced by sc_core::sc_end_of_simulation_invoked().

◆ init()

void sc_gem5::Kernel::init ( )
overridevirtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from gem5::SimObject.

Definition at line 66 of file kernel.cc.

References sc_gem5::allChannels, sc_gem5::allModules, sc_gem5::allPorts, gem5::ArmISA::c, sc_gem5::Scheduler::elaborationDone(), fatal, gem5::Fiber::finished(), gem5::ArmISA::m, gem5::MipsISA::p, sc_core::SC_BEFORE_END_OF_ELABORATION, sc_gem5::scheduler, sc_gem5::scMainFiber, and status().

◆ regStats()

void sc_gem5::Kernel::regStats ( )
overridevirtual

Callback to set stat parameters.

This callback is typically used for complex stats (e.g., distributions) that need parameters in addition to a name and a description. Stat names and descriptions should typically be set from the constructor usingo from the constructor using the ADD_STAT macro.

Reimplemented from gem5::statistics::Group.

Definition at line 86 of file kernel.cc.

References sc_gem5::allChannels, sc_gem5::allModules, sc_gem5::allPorts, gem5::ArmISA::c, gem5::Fiber::finished(), gem5::ArmISA::m, gem5::MipsISA::p, sc_core::SC_END_OF_ELABORATION, sc_gem5::scheduler, sc_gem5::scMainFiber, status(), and sc_gem5::Scheduler::throwUp().

◆ startOfSimulationComplete()

bool sc_gem5::Kernel::startOfSimulationComplete ( )
static

Definition at line 51 of file kernel.cc.

Referenced by sc_core::sc_start_of_simulation_invoked().

◆ startup()

void sc_gem5::Kernel::startup ( )
overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from gem5::SimObject.

Definition at line 110 of file kernel.cc.

References sc_gem5::allChannels, sc_gem5::allModules, sc_gem5::allPorts, gem5::ArmISA::c, gem5::curTick(), gem5::Fiber::finished(), sc_gem5::kernel, gem5::ArmISA::m, gem5::MipsISA::p, sc_core::SC_RUNNING, sc_core::SC_START_OF_SIMULATION, gem5::EventManager::schedule(), sc_gem5::scheduler, sc_gem5::scMainFiber, status(), stopWork(), t0Event, and sc_gem5::Scheduler::throwUp().

◆ status() [1/2]

sc_core::sc_status sc_gem5::Kernel::status ( )
static

◆ status() [2/2]

void sc_gem5::Kernel::status ( sc_core::sc_status  s)
static

Definition at line 55 of file kernel.cc.

References gem5::ArmISA::s.

◆ stop()

void sc_gem5::Kernel::stop ( )
static

Definition at line 141 of file kernel.cc.

References sc_core::SC_RUNNING, status(), and stopWork().

Referenced by sc_core::sc_stop(), and sc_gem5::Scheduler::stop().

◆ stopWork()

void sc_gem5::Kernel::stopWork ( )
staticprivate

◆ t0Handler()

void sc_gem5::Kernel::t0Handler ( )

Member Data Documentation

◆ t0Event

gem5::EventWrapper<Kernel, &Kernel::t0Handler> sc_gem5::Kernel::t0Event
private

Definition at line 68 of file kernel.hh.

Referenced by startup().


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

Generated on Tue Sep 21 2021 12:35:16 for gem5 by doxygen 1.8.17