#include <external_master.hh>

Inheritance diagram for gem5::ExternalMaster:

Classes
class	ExternalPort
	Derive from this class to create an external port interface. More...

class	Handler

Public Member Functions
	ExternalMaster (const ExternalMasterParams &params)

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Port interface.

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

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 void	startup ()
	startup() is the final initialization call before simulation.

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	regStats ()
	Callback to set stat parameters.

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 void	registerHandler (const std::string &handler_name, Handler *handler)
	Register a handler which can provide ports with port_type == handler_name.

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.

Public Attributes
const RequestorID	id

Protected Attributes
ExternalPort *	externalPort
	The peer port for the gem5 port "port".

std::string	portName
	Name of the bound port.

std::string	portType
	Key to select a port handler.

std::string	portData
	Handler-specific port configuration.

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.

Static Protected Attributes
static std::map< std::string, Handler * >	portHandlers
	Registered handlers.

Additional Inherited Members
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

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.

Detailed Description

Definition at line 66 of file external_master.hh.

Constructor & Destructor Documentation

◆ ExternalMaster()

gem5::ExternalMaster::ExternalMaster ( const ExternalMasterParams & params )

Definition at line 53 of file external_master.cc.

Member Function Documentation

◆ getPort()

Port & gem5::ExternalMaster::getPort	(	const std::string &	if_name,
		PortID	idx = InvalidPortID )

overridevirtual

Port interface.

Responds only to port "port"

Reimplemented from gem5::SimObject.

Definition at line 63 of file external_master.cc.

References DPRINTF, externalPort, fatal, gem5::SimObject::getPort(), portData, portHandlers, portName, and portType.

◆ init()

void gem5::ExternalMaster::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 90 of file external_master.cc.

References externalPort, fatal, gem5::Port::isConnected(), and gem5::Named::name().

◆ registerHandler()

void gem5::ExternalMaster::registerHandler	(	const std::string &	handler_name,
		Handler *	handler )

static

Register a handler which can provide ports with port_type == handler_name.

Definition at line 100 of file external_master.cc.

References portHandlers.

Member Data Documentation

◆ externalPort

ExternalPort* gem5::ExternalMaster::externalPort

protected

The peer port for the gem5 port "port".

Definition at line 103 of file external_master.hh.

Referenced by getPort(), and init().

◆ id

const RequestorID gem5::ExternalMaster::id

Definition at line 134 of file external_master.hh.

◆ portData

std::string gem5::ExternalMaster::portData

protected

Handler-specific port configuration.

Definition at line 112 of file external_master.hh.

Referenced by getPort().

◆ portHandlers

std::map< std::string, ExternalMaster::Handler * > gem5::ExternalMaster::portHandlers

staticprotected

Registered handlers.

Handlers are chosen using the port_type parameter on ExternalMasters. port_types form a global namespace across the simulation and so handlers are registered into a global structure

Definition at line 118 of file external_master.hh.

Referenced by getPort(), and registerHandler().

◆ portName

std::string gem5::ExternalMaster::portName

protected

Name of the bound port.

This will be name() + ".port"

Definition at line 106 of file external_master.hh.

Referenced by getPort().

◆ portType

std::string gem5::ExternalMaster::portType

protected

Key to select a port handler.

Definition at line 109 of file external_master.hh.

Referenced by getPort().

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

mem/external_master.hh
mem/external_master.cc

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExternalMaster()

Member Function Documentation

◆ getPort()

◆ init()

◆ registerHandler()

Member Data Documentation

◆ externalPort

◆ id

◆ portData

◆ portHandlers

◆ portName

◆ portType