gem5  v21.1.0.2
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
gem5::EtherTapStub Class Reference

#include <ethertap.hh>

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

Public Types

using Params = EtherTapStubParams
 
- Public Types inherited from gem5::EtherTapBase
using Params = EtherTapBaseParams
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 EtherTapStub (const Params &p)
 
 ~EtherTapStub ()
 
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::EtherTapBase
 EtherTapBase (const Params &p)
 
virtual ~EtherTapBase ()
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
bool recvSimulated (EthPacketPtr packet)
 
void sendSimulated (void *data, size_t len)
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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 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
 

Protected Member Functions

void attach (int fd)
 
void detach ()
 
void recvReal (int revent) override
 
bool sendReal (const void *data, size_t len) override
 
- Protected Member Functions inherited from gem5::EtherTapBase
void pollFd (int fd)
 
void stopPolling ()
 
void retransmit ()
 
- 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...
 

Protected Attributes

TapListenerlistener
 
int socket
 
uint32_t buffer_used
 
uint32_t frame_len
 
- Protected Attributes inherited from gem5::EtherTapBase
uint8_t * buffer
 
int buflen
 
EtherDumpdump
 
TapEventevent
 
EtherTapIntinterface
 
std::queue< EthPacketPtrpacketBuffer
 
EventFunctionWrapper txEvent
 
- 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...
 

Friends

class TapListener
 

Additional Inherited Members

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

Detailed Description

Definition at line 133 of file ethertap.hh.

Member Typedef Documentation

◆ Params

using gem5::EtherTapStub::Params = EtherTapStubParams

Definition at line 136 of file ethertap.hh.

Constructor & Destructor Documentation

◆ EtherTapStub()

gem5::EtherTapStub::EtherTapStub ( const Params p)

◆ ~EtherTapStub()

gem5::EtherTapStub::~EtherTapStub ( )

Definition at line 298 of file ethertap.cc.

References listener.

Member Function Documentation

◆ attach()

void gem5::EtherTapStub::attach ( int  fd)
protected

◆ detach()

void gem5::EtherTapStub::detach ( )
protected

Definition at line 338 of file ethertap.cc.

References DPRINTF, socket, and gem5::EtherTapBase::stopPolling().

Referenced by recvReal().

◆ recvReal()

void gem5::EtherTapStub::recvReal ( int  revent)
overrideprotectedvirtual

◆ sendReal()

bool gem5::EtherTapStub::sendReal ( const void *  data,
size_t  len 
)
overrideprotectedvirtual

Implements gem5::EtherTapBase.

Definition at line 393 of file ethertap.cc.

References data, frame_len, gem5::ArmISA::len, and socket.

◆ serialize()

void gem5::EtherTapStub::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Reimplemented from gem5::EtherTapBase.

Definition at line 304 of file ethertap.cc.

References buffer_used, frame_len, gem5::EtherTapBase::serialize(), SERIALIZE_SCALAR, and socket.

◆ unserialize()

void gem5::EtherTapStub::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Reimplemented from gem5::EtherTapBase.

Definition at line 314 of file ethertap.cc.

References buffer_used, frame_len, socket, gem5::EtherTapBase::unserialize(), and UNSERIALIZE_SCALAR.

Friends And Related Function Documentation

◆ TapListener

friend class TapListener
friend

Definition at line 145 of file ethertap.hh.

Referenced by EtherTapStub().

Member Data Documentation

◆ buffer_used

uint32_t gem5::EtherTapStub::buffer_used
protected

Definition at line 153 of file ethertap.hh.

Referenced by attach(), recvReal(), serialize(), and unserialize().

◆ frame_len

uint32_t gem5::EtherTapStub::frame_len
protected

Definition at line 154 of file ethertap.hh.

Referenced by attach(), recvReal(), sendReal(), serialize(), and unserialize().

◆ listener

TapListener* gem5::EtherTapStub::listener
protected

Definition at line 146 of file ethertap.hh.

Referenced by EtherTapStub(), and ~EtherTapStub().

◆ socket

int gem5::EtherTapStub::socket
protected

Definition at line 148 of file ethertap.hh.

Referenced by attach(), detach(), recvReal(), sendReal(), serialize(), and unserialize().


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

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