#include <NetworkLink.hh>

Inheritance diagram for NetworkLink:

Public Types
typedef NetworkLinkParams	Params

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	NetworkLink (const Params *p)

	~NetworkLink ()=default

void	setLinkConsumer (Consumer *consumer)

void	setSourceQueue (flitBuffer src_queue, ClockedObject srcClockObject)

virtual void	setVcsPerVnet (uint32_t consumerVcs)

void	setType (link_type type)

link_type	getType ()

void	print (std::ostream &out) const

int	get_id () const

flitBuffer *	getBuffer ()

virtual void	wakeup ()

unsigned int	getLinkUtilization () const

const std::vector< unsigned int > &	getVcLoad () const

bool	isReady (Tick curTime)

flit *	peekLink ()

flit *	consumeLink ()

uint32_t	functionalWrite (Packet *)

void	resetStats ()
	Callback to reset stats. More...

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

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

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

Public Member Functions inherited from SimObject
const Params *	params () 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	regProbePoints ()
	Register probe points for this object. More...

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

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

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index. 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
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. 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 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...

Public Member Functions inherited from Stats::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	preDumpStats ()
	Callback before stats are dumped. More...

void	addStat (Stats::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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from Clocked
void	updateClockPeriod ()
	Update the tick to the current tick. More...

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

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge. More...

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

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Public Member Functions inherited from Consumer
	Consumer (ClockedObject *_em)

virtual	~Consumer ()

virtual void	storeEventInfo (int info)

bool	alreadyScheduled (Tick time)

void	insertScheduledWakeupTime (Tick time)

ClockedObject *	getObject ()

void	scheduleEventAbsolute (Tick timeAbs)

void	scheduleEvent (Cycles timeDelta)

Public Attributes
std::vector< int >	mVnets

uint32_t	bitWidth

Public Attributes inherited from ClockedObject
PowerState *	powerState

Protected Attributes
uint32_t	m_virt_nets

flitBuffer	linkBuffer

Consumer *	link_consumer

flitBuffer *	link_srcQueue

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

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

Private Attributes
const int	m_id

link_type	m_type

const Cycles	m_latency

ClockedObject *	src_object

unsigned int	m_link_utilized

std::vector< unsigned int >	m_vc_load

Additional Inherited Members
Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (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 ()
	Gets the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

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 Member Functions inherited from Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance. More...

void	resetClock () const
	Reset the object's clock using the current global tick value. More...

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...

Detailed Description

Definition at line 47 of file NetworkLink.hh.

Member Typedef Documentation

◆ Params

typedef NetworkLinkParams NetworkLink::Params

Definition at line 50 of file NetworkLink.hh.

Constructor & Destructor Documentation

◆ NetworkLink()

NetworkLink::NetworkLink ( const Params * p )

Definition at line 39 of file NetworkLink.cc.

References bitWidth, ArmISA::i, mVnets, and MipsISA::p.

◆ ~NetworkLink()

NetworkLink::~NetworkLink ( )

default

Member Function Documentation

◆ consumeLink()

flit* NetworkLink::consumeLink ( )

inline

Definition at line 73 of file NetworkLink.hh.

References flitBuffer::getTopFlit(), and linkBuffer.

Referenced by InputUnit::wakeup(), OutputUnit::wakeup(), and NetworkInterface::wakeup().

◆ functionalWrite()

uint32_t NetworkLink::functionalWrite ( Packet * pkt )

Definition at line 126 of file NetworkLink.cc.

References flitBuffer::functionalWrite(), and linkBuffer.

◆ get_id()

int NetworkLink::get_id ( ) const

inline

Definition at line 60 of file NetworkLink.hh.

References m_id.

Referenced by InputUnit::get_inlink_id(), and OutputUnit::get_outlink_id().

◆ getBuffer()

flitBuffer* NetworkLink::getBuffer ( )

inline

Definition at line 61 of file NetworkLink.hh.

References linkBuffer.

Referenced by NetworkBridge::NetworkBridge().

◆ getLinkUtilization()

unsigned int NetworkLink::getLinkUtilization ( ) const

inline

Definition at line 64 of file NetworkLink.hh.

References m_link_utilized.

◆ getType()

link_type NetworkLink::getType ( )

inline

Definition at line 58 of file NetworkLink.hh.

References m_type.

◆ getVcLoad()

const std::vector<unsigned int>& NetworkLink::getVcLoad ( ) const

inline

Definition at line 65 of file NetworkLink.hh.

References m_vc_load.

◆ isReady()

bool NetworkLink::isReady ( Tick curTime )

inline

Definition at line 67 of file NetworkLink.hh.

References flitBuffer::isReady(), and linkBuffer.

Referenced by NetworkInterface::checkReschedule(), InputUnit::wakeup(), OutputUnit::wakeup(), and NetworkInterface::wakeup().

◆ peekLink()

flit* NetworkLink::peekLink ( )

inline

Definition at line 72 of file NetworkLink.hh.

References linkBuffer, and flitBuffer::peekTopFlit().

◆ print()

void NetworkLink::print ( std::ostream & out ) const

inlinevirtual

Implements Consumer.

Definition at line 59 of file NetworkLink.hh.

◆ resetStats()

void NetworkLink::resetStats ( )

virtual

Callback to reset stats.

Reimplemented from Stats::Group.

Definition at line 104 of file NetworkLink.cc.

References ArmISA::i, m_link_utilized, and m_vc_load.

◆ setLinkConsumer()

void NetworkLink::setLinkConsumer ( Consumer * consumer )

Definition at line 55 of file NetworkLink.cc.

References link_consumer.

Referenced by NetworkInterface::addInPort(), Router::addInPort(), NetworkInterface::addOutPort(), Router::addOutPort(), and NetworkBridge::NetworkBridge().

◆ setSourceQueue()

void NetworkLink::setSourceQueue	(	flitBuffer *	src_queue,
		ClockedObject *	srcClockObject
	)

Definition at line 67 of file NetworkLink.cc.

References link_srcQueue, and src_object.

Referenced by NetworkInterface::addInPort(), Router::addInPort(), NetworkInterface::addOutPort(), Router::addOutPort(), and NetworkBridge::NetworkBridge().

◆ setType()

void NetworkLink::setType ( link_type type )

inline

Definition at line 57 of file NetworkLink.hh.

References m_type, and type.

Referenced by GarnetNetwork::makeExtInLink(), GarnetNetwork::makeExtOutLink(), and GarnetNetwork::makeInternalLink().

◆ setVcsPerVnet()

void NetworkLink::setVcsPerVnet ( uint32_t consumerVcs )

virtual

Reimplemented in NetworkBridge.

Definition at line 61 of file NetworkLink.cc.

References m_vc_load, and m_virt_nets.

Referenced by NetworkInterface::addInPort(), Router::addInPort(), NetworkInterface::addOutPort(), Router::addOutPort(), and NetworkBridge::setVcsPerVnet().

◆ wakeup()

void NetworkLink::wakeup ( )

virtual

Implements Consumer.

Reimplemented in NetworkBridge.

Definition at line 74 of file NetworkLink.cc.

References bitWidth, Clocked::clockEdge(), curTick(), DPRINTF, flit::get_vc(), flit::get_vnet(), flitBuffer::getTopFlit(), flitBuffer::insert(), flitBuffer::isEmpty(), flitBuffer::isReady(), link_consumer, link_srcQueue, linkBuffer, m_latency, m_link_utilized, m_type, m_vc_load, flit::m_width, mVnets, SimObject::name(), NUM_LINK_TYPES_, Consumer::scheduleEvent(), Consumer::scheduleEventAbsolute(), flit::set_time(), and src_object.

Member Data Documentation

◆ bitWidth

uint32_t NetworkLink::bitWidth

Definition at line 79 of file NetworkLink.hh.

Referenced by Router::addInPort(), Router::addOutPort(), NetworkBridge::flitisizeAndSend(), NetworkInterface::InputPort::InputPort(), NetworkLink(), NetworkInterface::OutputPort::OutputPort(), and wakeup().

◆ link_consumer

Consumer* NetworkLink::link_consumer

protected

Definition at line 95 of file NetworkLink.hh.

Referenced by NetworkBridge::scheduleFlit(), setLinkConsumer(), and wakeup().

◆ link_srcQueue

flitBuffer* NetworkLink::link_srcQueue

protected

Definition at line 96 of file NetworkLink.hh.

Referenced by setSourceQueue(), wakeup(), and NetworkBridge::wakeup().

◆ linkBuffer

flitBuffer NetworkLink::linkBuffer

protected

Definition at line 94 of file NetworkLink.hh.

Referenced by consumeLink(), functionalWrite(), getBuffer(), isReady(), NetworkBridge::NetworkBridge(), peekLink(), NetworkBridge::scheduleFlit(), and wakeup().

◆ m_id

const int NetworkLink::m_id

private

Definition at line 82 of file NetworkLink.hh.

Referenced by get_id().

◆ m_latency

const Cycles NetworkLink::m_latency

private

Definition at line 84 of file NetworkLink.hh.

Referenced by wakeup().

◆ m_link_utilized

unsigned int NetworkLink::m_link_utilized

private

Definition at line 89 of file NetworkLink.hh.

Referenced by getLinkUtilization(), resetStats(), and wakeup().

◆ m_type

link_type NetworkLink::m_type

private

Definition at line 83 of file NetworkLink.hh.

Referenced by getType(), setType(), and wakeup().

◆ m_vc_load

std::vector<unsigned int> NetworkLink::m_vc_load

private

Definition at line 90 of file NetworkLink.hh.

Referenced by getVcLoad(), resetStats(), setVcsPerVnet(), and wakeup().

◆ m_virt_nets

uint32_t NetworkLink::m_virt_nets

protected

Definition at line 93 of file NetworkLink.hh.

Referenced by setVcsPerVnet(), and NetworkBridge::setVcsPerVnet().

◆ mVnets

std::vector<int> NetworkLink::mVnets

Definition at line 78 of file NetworkLink.hh.

Referenced by NetworkInterface::InputPort::InputPort(), NetworkLink(), NetworkInterface::OutputPort::OutputPort(), and wakeup().

◆ src_object

ClockedObject* NetworkLink::src_object

private

Definition at line 86 of file NetworkLink.hh.

Referenced by setSourceQueue(), and wakeup().

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

mem/ruby/network/garnet/NetworkLink.hh
mem/ruby/network/garnet/NetworkLink.cc

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ NetworkLink()

◆ ~NetworkLink()

Member Function Documentation

◆ consumeLink()

◆ functionalWrite()

◆ get_id()

◆ getBuffer()

◆ getLinkUtilization()

◆ getType()

◆ getVcLoad()

◆ isReady()

◆ peekLink()

◆ print()

◆ resetStats()

◆ setLinkConsumer()

◆ setSourceQueue()

◆ setType()

◆ setVcsPerVnet()

◆ wakeup()

Member Data Documentation

◆ bitWidth

◆ link_consumer

◆ link_srcQueue

◆ linkBuffer

◆ m_id

◆ m_latency

◆ m_link_utilized

◆ m_type

◆ m_vc_load

◆ m_virt_nets

◆ mVnets

◆ src_object