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

#include <dist_etherlink.hh>

Inheritance diagram for gem5::DistEtherLink:

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
using	Params = DistEtherLinkParams

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	DistEtherLink (const Params &p)

	~DistEtherLink ()

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.

virtual void	init () override
	init() is called after all C++ SimObjects have been created and all ports are connected.

virtual void	startup () override
	startup() is the final initialization call before simulation.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () 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.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	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.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

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.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from gem5::Named
	Named (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Protected Attributes
DistIface *	distIface
	Interface to talk to the peer gem5 processes.

TxLink *	txLink
	Send link.

RxLink *	rxLink
	Receive link.

LocalIface *	localIface

Tick	linkDelay

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

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.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Detailed Description

Model for a fixed bandwidth full duplex ethernet link.

Definition at line 69 of file dist_etherlink.hh.

Member Typedef Documentation

◆ Params

using gem5::DistEtherLink::Params = DistEtherLinkParams

Definition at line 221 of file dist_etherlink.hh.

Constructor & Destructor Documentation

◆ DistEtherLink()

gem5::DistEtherLink::DistEtherLink ( const Params & p )

Definition at line 72 of file dist_etherlink.cc.

References distIface, DPRINTF, localIface, gem5::Named::name(), gem5::MipsISA::p, rxLink, txLink, and warn.

◆ ~DistEtherLink()

gem5::DistEtherLink::~DistEtherLink ( )

Definition at line 102 of file dist_etherlink.cc.

References distIface, localIface, rxLink, and txLink.

Member Function Documentation

◆ getPort()

Port & gem5::DistEtherLink::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_name	Port name
idx	Index in the case of a VectorPort

Returns: A reference to the given port

Reimplemented from gem5::SimObject.

Definition at line 111 of file dist_etherlink.cc.

References gem5::SimObject::getPort(), and localIface.

◆ init()

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

Definition at line 135 of file dist_etherlink.cc.

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

◆ serialize()

void gem5::DistEtherLink::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 119 of file dist_etherlink.cc.

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

◆ startup()

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

Definition at line 142 of file dist_etherlink.cc.

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

◆ unserialize()

void gem5::DistEtherLink::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 127 of file dist_etherlink.cc.

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

Member Data Documentation

◆ distIface

DistIface* gem5::DistEtherLink::distIface

protected

Interface to talk to the peer gem5 processes.

Definition at line 207 of file dist_etherlink.hh.

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

◆ linkDelay

Tick gem5::DistEtherLink::linkDelay

protected

Definition at line 218 of file dist_etherlink.hh.

Referenced by init().

◆ localIface

LocalIface* gem5::DistEtherLink::localIface

protected

Definition at line 216 of file dist_etherlink.hh.

Referenced by DistEtherLink(), getPort(), gem5::DistEtherLink::RxLink::rxDone(), gem5::DistEtherLink::TxLink::txDone(), and ~DistEtherLink().

◆ rxLink

RxLink* gem5::DistEtherLink::rxLink

protected

Receive link.

Definition at line 215 of file dist_etherlink.hh.

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

◆ txLink

TxLink* gem5::DistEtherLink::txLink

protected

Send link.

Definition at line 211 of file dist_etherlink.hh.

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

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

dev/net/dist_etherlink.hh
dev/net/dist_etherlink.cc

Classes

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ DistEtherLink()

◆ ~DistEtherLink()

Member Function Documentation

◆ getPort()

◆ init()

◆ serialize()

◆ startup()

◆ unserialize()

Member Data Documentation

◆ distIface

◆ linkDelay

◆ localIface

◆ rxLink

◆ txLink