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

#include <ethertap.hh>

Inheritance diagram for EtherTapBase:
EtherObject SimObject EventManager Serializable Drainable EtherTapStub

Classes

class  TxEvent
 

Public Types

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

Public Member Functions

 EtherTapBase (const Params *p)
 
virtual ~EtherTapBase ()
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
EtherIntgetEthPort (const std::string &if_name, int idx) override
 Additional function to return the Port of a memory object. More...
 
bool recvSimulated (EthPacketPtr packet)
 
void sendSimulated (void *data, size_t len)
 
- 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 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 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...
 
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
 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 Member Functions

void pollFd (int fd)
 
void stopPolling ()
 
virtual void recvReal (int revent)=0
 
virtual bool sendReal (const void *data, size_t len)=0
 
void retransmit ()
 
- 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...
 

Protected Attributes

uint8_t * buffer
 
int buflen
 
EtherDumpdump
 
TapEventevent
 
EtherTapIntinterface
 
std::queue< EthPacketPtrpacketBuffer
 
TxEvent txEvent
 
- 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...
 

Friends

class TapEvent
 
class TxEvent
 

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
 

Detailed Description

Definition at line 59 of file ethertap.hh.

Member Typedef Documentation

typedef EtherTapBaseParams EtherTapBase::Params

Definition at line 62 of file ethertap.hh.

Constructor & Destructor Documentation

EtherTapBase::EtherTapBase ( const Params p)

Definition at line 85 of file ethertap.cc.

References buffer, and buflen.

EtherTapBase::~EtherTapBase ( )
virtual

Definition at line 93 of file ethertap.cc.

References buffer, event, and interface.

Member Function Documentation

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

Additional function to return the Port of a memory object.

Implements EtherObject.

Definition at line 153 of file ethertap.cc.

References EtherInt::getPeer(), interface, and panic.

const Params* EtherTapBase::params ( ) const
inline

Definition at line 67 of file ethertap.hh.

References SimObject::_params.

void EtherTapBase::pollFd ( int  fd)
protected

Definition at line 136 of file ethertap.cc.

References event, pollQueue, PollQueue::schedule(), and TapEvent.

Referenced by EtherTapStub::attach().

virtual void EtherTapBase::recvReal ( int  revent)
protectedpure virtual

Implemented in EtherTapStub.

bool EtherTapBase::recvSimulated ( EthPacketPtr  packet)

Definition at line 164 of file ethertap.cc.

References DDUMP, DPRINTF, EtherDump::dump(), dump, interface, EtherInt::recvDone(), and sendReal().

Referenced by EtherTapInt::recvPacket().

void EtherTapBase::retransmit ( )
protected
virtual bool EtherTapBase::sendReal ( const void *  data,
size_t  len 
)
protectedpure virtual

Implemented in EtherTapStub.

Referenced by recvSimulated().

void EtherTapBase::sendSimulated ( void *  data,
size_t  len 
)
void EtherTapBase::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements Serializable.

Reimplemented in EtherTapStub.

Definition at line 101 of file ethertap.cc.

References buffer, buflen, event, SERIALIZE_ARRAY, and SERIALIZE_SCALAR.

Referenced by EtherTapStub::serialize().

void EtherTapBase::stopPolling ( )
protected

Definition at line 144 of file ethertap.cc.

References event.

Referenced by EtherTapStub::detach().

void EtherTapBase::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements Serializable.

Reimplemented in EtherTapStub.

Definition at line 118 of file ethertap.cc.

References buffer, buflen, event, pollQueue, PollEvent::queued(), PollQueue::schedule(), TapEvent, UNSERIALIZE_ARRAY, and UNSERIALIZE_SCALAR.

Referenced by EtherTapStub::unserialize().

Friends And Related Function Documentation

friend class TapEvent
friend

Definition at line 86 of file ethertap.hh.

Referenced by pollFd(), and unserialize().

friend class TxEvent
friend

Definition at line 125 of file ethertap.hh.

Member Data Documentation

uint8_t* EtherTapBase::buffer
protected
int EtherTapBase::buflen
protected

Definition at line 77 of file ethertap.hh.

Referenced by EtherTapBase(), EtherTapStub::recvReal(), serialize(), and unserialize().

EtherDump* EtherTapBase::dump
protected

Definition at line 79 of file ethertap.hh.

Referenced by recvSimulated(), retransmit(), and sendSimulated().

TapEvent* EtherTapBase::event
protected

Definition at line 87 of file ethertap.hh.

Referenced by pollFd(), serialize(), stopPolling(), unserialize(), and ~EtherTapBase().

EtherTapInt* EtherTapBase::interface
protected

Definition at line 101 of file ethertap.hh.

Referenced by getEthPort(), recvSimulated(), retransmit(), sendSimulated(), and ~EtherTapBase().

std::queue<EthPacketPtr> EtherTapBase::packetBuffer
protected

Definition at line 110 of file ethertap.hh.

Referenced by retransmit(), and sendSimulated().

TxEvent EtherTapBase::txEvent
protected

Definition at line 126 of file ethertap.hh.

Referenced by retransmit(), and sendSimulated().


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

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