gem5::SerialLink Class Reference

SerialLink is a simple variation of the Bridge class, with the ability to account for the latency of packet serialization. More...

#include <serial_link.hh>

Inheritance diagram for gem5::SerialLink:

Classes
class	DeferredPacket
	A deferred packet stores a packet along with its scheduled transmission time. More...
class	SerialLinkRequestPort
	Port on the side that forwards requests and receives responses. More...
class	SerialLinkResponsePort
	The port on the side that receives requests and sends responses. More...

Public Types
typedef SerialLinkParams	Params
Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.
virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.
	SerialLink (const SerialLinkParams &p)
Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)
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.
virtual void	startup ()
	startup() is the final initialization call before simulation.
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
Public Member Functions inherited from gem5::Clocked
void	updateClockPeriod ()
	Update the tick to the current tick.
Tick	clockEdge (Cycles cycles=Cycles(0)) const
	Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle.
Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.
Tick	nextCycle () const
	Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future.
uint64_t	frequency () const
Tick	clockPeriod () const
double	voltage () const
Cycles	ticksToCycles (Tick t) const
Tick	cyclesToTicks (Cycles c) const

Protected Attributes
SerialLinkResponsePort	cpu_side_port
	Response port of the serial_link.
SerialLinkRequestPort	mem_side_port
	Request port of the serial_link.
unsigned	num_lanes
	Number of parallel lanes in this serial link.
uint64_t	link_speed
	Speed of each link (Gb/s) in this serial link.
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.
Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState
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.
Protected Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.
	Clocked (Clocked &)=delete
Clocked &	operator= (Clocked &)=delete
virtual	~Clocked ()
	Virtual destructor due to inheritance.
void	resetClock () const
	Reset the object's clock using the current global tick value.
virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Detailed Description

SerialLink is a simple variation of the Bridge class, with the ability to account for the latency of packet serialization.

We assume that the serializer component at the transmitter side does not need to receive the whole packet to start the serialization. But the deserializer waits for the complete packet to check its integrity first.

Definition at line 68 of file serial_link.hh.

Member Typedef Documentation

Params

typedef SerialLinkParams gem5::SerialLink::Params

Definition at line 323 of file serial_link.hh.

Constructor & Destructor Documentation

SerialLink()

gem5::SerialLink::SerialLink

(

const SerialLinkParams &

p

)

Definition at line 84 of file serial_link.cc.

Member Function Documentation

getPort()

Port & gem5::SerialLink::getPort ( const std::string & if_name, PortID idx = InvalidPortID )

virtual

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 96 of file serial_link.cc.

References cpu_side_port, gem5::SimObject::getPort(), and mem_side_port.

init()

void gem5::SerialLink::init ( )

virtual

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 108 of file serial_link.cc.

References cpu_side_port, fatal, gem5::Port::isConnected(), mem_side_port, and gem5::ResponsePort::sendRangeChange().

Member Data Documentation

cpu_side_port

SerialLinkResponsePort gem5::SerialLink::cpu_side_port

protected

Response port of the serial_link.

Definition at line 305 of file serial_link.hh.

Referenced by getPort(), init(), gem5::SerialLink::SerialLinkRequestPort::recvTimingResp(), and gem5::SerialLink::SerialLinkRequestPort::trySendTiming().

link_speed

uint64_t gem5::SerialLink::link_speed

protected

Speed of each link (Gb/s) in this serial link.

Definition at line 314 of file serial_link.hh.

mem_side_port

SerialLinkRequestPort gem5::SerialLink::mem_side_port

protected

Request port of the serial_link.

Definition at line 308 of file serial_link.hh.

Referenced by getPort(), init(), gem5::SerialLink::SerialLinkResponsePort::recvAtomic(), gem5::SerialLink::SerialLinkResponsePort::recvFunctional(), gem5::SerialLink::SerialLinkResponsePort::recvTimingReq(), and gem5::SerialLink::SerialLinkResponsePort::trySendTiming().

num_lanes

unsigned gem5::SerialLink::num_lanes

protected

Number of parallel lanes in this serial link.

Definition at line 311 of file serial_link.hh.

---

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

• mem/serial_link.hh
• mem/serial_link.cc