#include <kernel.hh>

Inheritance diagram for sc_gem5::Kernel:

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.

void	regStats () override
	Callback to set stat parameters.

void	startup () override
	startup() is the final initialization call before simulation.

void	t0Handler ()

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

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

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::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.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	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.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

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.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (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.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Static Private Member Functions
static void	stopWork ()

Private Attributes
gem5::MemberEventWrapper<&Kernel::t0Handler >	t0Event

Additional Inherited Members
Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

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	)

Definition at line 57 of file kernel.cc.

References gem5::EventManager::eventQueue(), sc_gem5::scheduler, and sc_gem5::Scheduler::setEventQueue().

Member Function Documentation

◆ endOfSimulationComplete()

bool sc_gem5::Kernel::endOfSimulationComplete ( )

static

Definition at line 52 of file kernel.cc.

◆ 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, c, sc_gem5::Scheduler::elaborationDone(), fatal, gem5::Fiber::finished(), 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, c, gem5::Fiber::finished(), gem5::statistics::Group::regStats(), 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.

◆ 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 112 of file kernel.cc.

References sc_gem5::allChannels, sc_gem5::allModules, sc_gem5::allPorts, c, gem5::curTick(), gem5::Fiber::finished(), sc_gem5::kernel, 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

Definition at line 54 of file kernel.cc.

Referenced by init(), sc_gem5::Scheduler::initPhase(), sc_gem5::Scheduler::pause(), regStats(), sc_core::sc_get_status(), sc_core::sc_pause(), sc_core::sc_stop(), sc_gem5::Scheduler::start(), startup(), stop(), stopWork(), and t0Handler().

◆ status() [2/2]

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

static

Definition at line 55 of file kernel.cc.

◆ stop()

void sc_gem5::Kernel::stop ( )

static

Definition at line 143 of file kernel.cc.

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

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

◆ stopWork()

void sc_gem5::Kernel::stopWork ( )

staticprivate

Definition at line 152 of file kernel.cc.

References sc_gem5::allChannels, sc_gem5::allModules, sc_gem5::allPorts, c, sc_core::SC_END_OF_SIMULATION, sc_core::SC_STOPPED, sc_gem5::scheduler, status(), and sc_gem5::Scheduler::throwUp().

Referenced by startup(), and stop().

◆ t0Handler()

void sc_gem5::Kernel::t0Handler ( )

Definition at line 172 of file kernel.cc.

References sc_gem5::Scheduler::clear(), sc_gem5::Scheduler::initPhase(), sc_core::SC_RUNNING, sc_gem5::scheduler, sc_gem5::Scheduler::scheduleStop(), and status().

Member Data Documentation

◆ t0Event

gem5::MemberEventWrapper<&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:

systemc/core/kernel.hh
systemc/core/kernel.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ Kernel()

Member Function Documentation

◆ endOfSimulationComplete()

◆ init()

◆ regStats()

◆ startOfSimulationComplete()

◆ startup()

◆ status() [1/2]

◆ status() [2/2]

◆ stop()

◆ stopWork()

◆ t0Handler()

Member Data Documentation

◆ t0Event