gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
DistEtherLink Class Reference

Model for a fixed bandwidth full duplex ethernet link. More...

#include <dist_etherlink.hh>

Inheritance diagram for DistEtherLink:
EtherObject SimObject EventManager Serializable Drainable

Classes

class  Link
 Model base class for a single uni-directional link. More...
 
class  LocalIface
 Interface to the local simulated system. More...
 
class  RxLink
 Model for a receive link. More...
 
class  TxLink
 Model for a send link. More...
 

Public Types

typedef DistEtherLinkParams Params
 
- Public Types inherited from EtherObject
typedef EtherObjectParams Params
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 DistEtherLink (const Params *p)
 
 ~DistEtherLink ()
 
const Paramsparams () const
 
virtual EtherIntgetEthPort (const std::string &if_name, int idx) override
 Additional function to return the Port of a memory object. More...
 
virtual void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
virtual void startup () override
 startup() is the final initialization call before simulation. 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 EtherObject
 EtherObject (const Params *params)
 
const Paramsparams () const
 
- 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 regStats ()
 Register statistics for this object. More...
 
virtual void resetStats ()
 Reset statistics associated with this object. 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...
 
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
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
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)
 
void setCurTick (Tick newVal)
 
- 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...
 

Protected Attributes

DistIfacedistIface
 Interface to talk to the peer gem5 processes. More...
 
TxLinktxLink
 Send link. More...
 
RxLinkrxLink
 Receive link. More...
 
LocalIfacelocalIface
 
Tick linkDelay
 
- 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 ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 
- 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

Model for a fixed bandwidth full duplex ethernet link.

Definition at line 64 of file dist_etherlink.hh.

Member Typedef Documentation

typedef DistEtherLinkParams DistEtherLink::Params

Definition at line 220 of file dist_etherlink.hh.

Constructor & Destructor Documentation

DistEtherLink::DistEtherLink ( const Params p)

Definition at line 74 of file dist_etherlink.cc.

References distIface, DPRINTF, localIface, SimObject::name(), rxLink, txLink, and warn.

DistEtherLink::~DistEtherLink ( )

Definition at line 104 of file dist_etherlink.cc.

References distIface, localIface, rxLink, and txLink.

Member Function Documentation

EtherInt * DistEtherLink::getEthPort ( const std::string &  if_name,
int  idx 
)
overridevirtual

Additional function to return the Port of a memory object.

Implements EtherObject.

Definition at line 113 of file dist_etherlink.cc.

References EtherInt::getPeer(), localIface, and panic_if().

void DistEtherLink::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 140 of file dist_etherlink.cc.

References distIface, DistEtherLink::RxLink::doneEvent(), DPRINTF, DistIface::init(), linkDelay, and rxLink.

const Params* DistEtherLink::params ( ) const
inline

Definition at line 225 of file dist_etherlink.hh.

References SimObject::_params.

void DistEtherLink::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 124 of file dist_etherlink.cc.

References distIface, rxLink, Serializable::serializeSection(), and txLink.

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

Definition at line 147 of file dist_etherlink.cc.

References distIface, DPRINTF, and DistIface::startup().

void DistEtherLink::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 132 of file dist_etherlink.cc.

References distIface, rxLink, txLink, and Serializable::unserializeSection().

Member Data Documentation

DistIface* DistEtherLink::distIface
protected

Interface to talk to the peer gem5 processes.

Definition at line 206 of file dist_etherlink.hh.

Referenced by DistEtherLink(), init(), DistEtherLink::RxLink::rxDone(), serialize(), startup(), DistEtherLink::TxLink::transmit(), unserialize(), and ~DistEtherLink().

Tick DistEtherLink::linkDelay
protected

Definition at line 217 of file dist_etherlink.hh.

Referenced by init().

LocalIface* DistEtherLink::localIface
protected
RxLink* DistEtherLink::rxLink
protected

Receive link.

Definition at line 214 of file dist_etherlink.hh.

Referenced by DistEtherLink(), init(), serialize(), unserialize(), and ~DistEtherLink().

TxLink* DistEtherLink::txLink
protected

Send link.

Definition at line 210 of file dist_etherlink.hh.

Referenced by DistEtherLink(), serialize(), unserialize(), and ~DistEtherLink().


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

Generated on Fri Jun 9 2017 13:04:07 for gem5 by doxygen 1.8.6