gem5  v21.1.0.2
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
gem5::ExternalMaster Class Reference

#include <external_master.hh>

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

Classes

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

Public Member Functions

 ExternalMaster (const ExternalMasterParams &params)
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Port interface. More...
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
- 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 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 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 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 (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 void registerHandler (const std::string &handler_name, Handler *handler)
 Register a handler which can provide ports with port_type == handler_name. More...
 
- 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...
 

Public Attributes

const RequestorID id
 

Protected Attributes

ExternalPortexternalPort
 The peer port for the gem5 port "port". More...
 
std::string portName
 Name of the bound port. More...
 
std::string portType
 Key to select a port handler. More...
 
std::string portData
 Handler-specific port configuration. 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...
 

Static Protected Attributes

static std::map< std::string, Handler * > portHandlers
 Registered handlers. More...
 

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. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 

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:

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