gem5  v20.1.0.0
Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
EtherBus Class Reference

#include <etherbus.hh>

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

Public Types

typedef EtherBusParams Params
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 EtherBus (const Params *p)
 
virtual ~EtherBus ()
 
const Paramsparams () const
 
void txDone ()
 
void reg (EtherInt *dev)
 
bool busy () const
 
bool send (EtherInt *sender, EthPacketPtr &packet)
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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
 

Protected Types

typedef std::list< EtherInt * > devlist_t
 

Protected Attributes

devlist_t devlist
 
double ticksPerByte
 
bool loopback
 
EventFunctionWrapper event
 
EthPacketPtr packet
 
EtherIntsender
 
EtherDumpdump
 
- 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...
 

Additional Inherited Members

- 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 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 43 of file etherbus.hh.

Member Typedef Documentation

◆ devlist_t

typedef std::list<EtherInt *> EtherBus::devlist_t
protected

Definition at line 46 of file etherbus.hh.

◆ Params

typedef EtherBusParams EtherBus::Params

Definition at line 58 of file etherbus.hh.

Constructor & Destructor Documentation

◆ EtherBus()

EtherBus::EtherBus ( const Params p)

Definition at line 51 of file etherbus.cc.

References txDone().

◆ ~EtherBus()

virtual EtherBus::~EtherBus ( )
inlinevirtual

Definition at line 60 of file etherbus.hh.

Member Function Documentation

◆ busy()

bool EtherBus::busy ( ) const
inline

Definition at line 70 of file etherbus.hh.

References packet.

Referenced by send().

◆ getPort()

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

Get a port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic port.

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

Parameters
if_namePort name
idxIndex in the case of a VectorPort
Returns
A reference to the given port

Reimplemented from SimObject.

Definition at line 83 of file etherbus.cc.

References panic.

◆ params()

const Params* EtherBus::params ( ) const
inline

Definition at line 63 of file etherbus.hh.

References SimObject::_params.

◆ reg()

void EtherBus::reg ( EtherInt dev)

◆ send()

bool EtherBus::send ( EtherInt sender,
EthPacketPtr packet 
)

Definition at line 89 of file etherbus.cc.

References busy(), curTick(), DDUMP, DPRINTF, event, packet, EventManager::schedule(), sender, and ticksPerByte.

◆ txDone()

void EtherBus::txDone ( )

Definition at line 59 of file etherbus.cc.

References DDUMP, devlist, DPRINTF, dump, EtherDump::dump(), ArmISA::i, loopback, packet, EtherInt::sendDone(), and sender.

Referenced by EtherBus().

Member Data Documentation

◆ devlist

devlist_t EtherBus::devlist
protected

Definition at line 47 of file etherbus.hh.

Referenced by txDone().

◆ dump

EtherDump* EtherBus::dump
protected

Definition at line 55 of file etherbus.hh.

Referenced by txDone().

◆ event

EventFunctionWrapper EtherBus::event
protected

Definition at line 52 of file etherbus.hh.

Referenced by send().

◆ loopback

bool EtherBus::loopback
protected

Definition at line 49 of file etherbus.hh.

Referenced by txDone().

◆ packet

EthPacketPtr EtherBus::packet
protected

Definition at line 53 of file etherbus.hh.

Referenced by busy(), send(), and txDone().

◆ sender

EtherInt* EtherBus::sender
protected

Definition at line 54 of file etherbus.hh.

Referenced by send(), and txDone().

◆ ticksPerByte

double EtherBus::ticksPerByte
protected

Definition at line 48 of file etherbus.hh.

Referenced by send().


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