gem5  v20.1.0.0
Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
ExternalSlave Class Reference

#include <external_slave.hh>

Inheritance diagram for ExternalSlave:
SimObject EventManager Serializable Drainable Stats::Group

Classes

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

Public Member Functions

 ExternalSlave (ExternalSlaveParams *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 SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 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...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 

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

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...
 
AddrRangeList addrRanges
 The Range of addresses supported by the devices on the external side of this port. More...
 
- Protected Attributes inherited from SimObject
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...
 

Static Protected Attributes

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

Additional Inherited Members

- Public Types inherited from SimObject
typedef SimObjectParams Params
 
- 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

Definition at line 65 of file external_slave.hh.

Constructor & Destructor Documentation

◆ ExternalSlave()

ExternalSlave::ExternalSlave ( ExternalSlaveParams *  params)

Definition at line 181 of file external_slave.cc.

References portHandlers, and registerHandler().

Member Function Documentation

◆ getPort()

Port & ExternalSlave::getPort ( const std::string &  if_name,
PortID  idx = InvalidPortID 
)
overridevirtual

Port interface.

Responds only to port "port"

Reimplemented from SimObject.

Definition at line 195 of file external_slave.cc.

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

◆ init()

void ExternalSlave::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 SimObject.

Definition at line 222 of file external_slave.cc.

References externalPort, fatal, Port::isConnected(), SimObject::name(), and ResponsePort::sendRangeChange().

◆ registerHandler()

void ExternalSlave::registerHandler ( const std::string &  handler_name,
Handler handler 
)
static

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

Definition at line 240 of file external_slave.cc.

References portHandlers.

Referenced by ExternalSlave().

Member Data Documentation

◆ addrRanges

AddrRangeList ExternalSlave::addrRanges
protected

The Range of addresses supported by the devices on the external side of this port.

Definition at line 117 of file external_slave.hh.

Referenced by ExternalSlave::ExternalPort::getAddrRanges().

◆ externalPort

ExternalPort* ExternalSlave::externalPort
protected

The peer port for the gem5 port "port".

Definition at line 104 of file external_slave.hh.

Referenced by getPort(), and init().

◆ portData

std::string ExternalSlave::portData
protected

Handler-specific port configuration.

Definition at line 113 of file external_slave.hh.

Referenced by getPort().

◆ portHandlers

std::map< std::string, ExternalSlave::Handler * > ExternalSlave::portHandlers
staticprotected

Registered handlers.

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

Definition at line 123 of file external_slave.hh.

Referenced by ExternalSlave(), getPort(), and registerHandler().

◆ portName

std::string ExternalSlave::portName
protected

Name of the bound port.

This will be name() + ".port"

Definition at line 107 of file external_slave.hh.

Referenced by getPort().

◆ portType

std::string ExternalSlave::portType
protected

Key to select a port handler.

Definition at line 110 of file external_slave.hh.

Referenced by getPort().


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

Generated on Wed Sep 30 2020 14:02:24 for gem5 by doxygen 1.8.17