#include <NetworkInterface.hh>

Inheritance diagram for NetworkInterface:

Classes
class	InputPort

class	OutputPort

Public Types
typedef GarnetNetworkInterfaceParams	Params

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

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	NetworkInterface (const Params *p)

	~NetworkInterface ()=default

void	addInPort (NetworkLink in_link, CreditLink credit_link)

void	addOutPort (NetworkLink out_link, CreditLink credit_link, SwitchID router_id, uint32_t consumerVcs)

void	dequeueCallback ()

void	wakeup ()

void	addNode (std::vector< MessageBuffer * > &inNode, std::vector< MessageBuffer * > &outNode)

void	print (std::ostream &out) const

int	get_vnet (int vc)

void	init_net_ptr (GarnetNetwork *net_ptr)

uint32_t	functionalWrite (Packet *)

void	scheduleFlit (flit *t_flit)

int	get_router_id (int vnet)

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	resetStats ()
	Callback to reset stats. 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)

Private Member Functions
void	checkStallQueue ()

bool	flitisizeMessage (MsgPtr msg_ptr, int vnet)

int	calculateVC (int vnet)

void	scheduleOutputPort (OutputPort *oPort)

void	scheduleOutputLink ()
	This function looks at the NI buffers if some buffer has flits which are ready to traverse the link in the next cycle, and the downstream output vc associated with this flit has buffers left, the link is scheduled for the next cycle. More...

void	checkReschedule ()

void	incrementStats (flit *t_flit)

InputPort *	getInportForVnet (int vnet)

OutputPort *	getOutportForVnet (int vnet)

Private Attributes
GarnetNetwork *	m_net_ptr

const NodeID	m_id

const int	m_virtual_networks

int	m_vc_per_vnet

std::vector< int >	m_vc_allocator

std::vector< OutputPort * >	outPorts

std::vector< InputPort * >	inPorts

int	m_deadlock_threshold

std::vector< OutVcState >	outVcState

std::vector< int >	m_stall_count

std::vector< flitBuffer >	niOutVcs

std::vector< Tick >	m_ni_out_vcs_enqueue_time

std::vector< MessageBuffer * >	inNode_ptr

std::vector< MessageBuffer * >	outNode_ptr

std::vector< int >	vc_busy_counter

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)

Public Attributes inherited from ClockedObject
PowerState *	powerState

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

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

Detailed Description

Definition at line 52 of file NetworkInterface.hh.

Member Typedef Documentation

◆ Params

typedef GarnetNetworkInterfaceParams NetworkInterface::Params

Definition at line 55 of file NetworkInterface.hh.

Constructor & Destructor Documentation

◆ NetworkInterface()

NetworkInterface::NetworkInterface ( const Params * p )

Definition at line 47 of file NetworkInterface.cc.

References m_stall_count, m_virtual_networks, and niOutVcs.

◆ ~NetworkInterface()

NetworkInterface::~NetworkInterface ( )

default

Member Function Documentation

◆ addInPort()

void NetworkInterface::addInPort	(	NetworkLink *	in_link,
		CreditLink *	credit_link
	)

Definition at line 59 of file NetworkInterface.cc.

References DPRINTF, inPorts, m_vc_per_vnet, SimObject::name(), NetworkInterface::InputPort::outCreditQueue(), NetworkInterface::InputPort::printVnets(), NetworkLink::setLinkConsumer(), NetworkLink::setSourceQueue(), and NetworkLink::setVcsPerVnet().

◆ addNode()

void NetworkInterface::addNode	(	std::vector< MessageBuffer * > &	inNode,
		std::vector< MessageBuffer * > &	outNode
	)

Definition at line 123 of file NetworkInterface.cc.

References inNode_ptr, and outNode_ptr.

◆ addOutPort()

void NetworkInterface::addOutPort	(	NetworkLink *	out_link,
		CreditLink *	credit_link,
		SwitchID	router_id,
		uint32_t	consumerVcs
	)

◆ calculateVC()

int NetworkInterface::calculateVC ( int vnet )

private

Definition at line 450 of file NetworkInterface.cc.

References curTick(), ArmISA::i, IDLE_, m_deadlock_threshold, m_vc_allocator, m_vc_per_vnet, SimObject::name(), outVcState, panic_if, and vc_busy_counter.

Referenced by flitisizeMessage().

◆ checkReschedule()

void NetworkInterface::checkReschedule ( )

private

Definition at line 615 of file NetworkInterface.cc.

References Clocked::clockEdge(), curTick(), inNode_ptr, inPorts, NetworkLink::isReady(), niOutVcs, outPorts, and Consumer::scheduleEvent().

Referenced by wakeup().

◆ checkStallQueue()

void NetworkInterface::checkStallQueue ( )

private

Definition at line 309 of file NetworkInterface.cc.

References Clocked::clockEdge(), curTick(), Clocked::cyclesToTicks(), flit::get_msg_ptr(), flit::get_vc(), flit::get_vnet(), incrementStats(), inPorts, m_stall_count, and outNode_ptr.

Referenced by wakeup().

◆ dequeueCallback()

void NetworkInterface::dequeueCallback ( )

Definition at line 137 of file NetworkInterface.cc.

References Clocked::clockEdge(), and Consumer::scheduleEventAbsolute().

Referenced by wakeup().

◆ flitisizeMessage()

bool NetworkInterface::flitisizeMessage	(	MsgPtr	msg_ptr,
		int	vnet
	)

private

◆ functionalWrite()

uint32_t NetworkInterface::functionalWrite ( Packet * pkt )

Definition at line 662 of file NetworkInterface.cc.

References niOutVcs, and outPorts.

◆ get_router_id()

int NetworkInterface::get_router_id ( int vnet )

inline

Definition at line 76 of file NetworkInterface.hh.

References getOutportForVnet(), and NetworkInterface::OutputPort::routerID().

◆ get_vnet()

int NetworkInterface::get_vnet ( int vc )

Definition at line 598 of file NetworkInterface.cc.

References fatal, ArmISA::i, m_vc_per_vnet, and m_virtual_networks.

Referenced by scheduleOutputPort().

◆ getInportForVnet()

NetworkInterface::InputPort * NetworkInterface::getInportForVnet ( int vnet )

private

Definition at line 551 of file NetworkInterface.cc.

References inPorts.

◆ getOutportForVnet()

NetworkInterface::OutputPort * NetworkInterface::getOutportForVnet ( int vnet )

private

Definition at line 569 of file NetworkInterface.cc.

References outPorts.

Referenced by flitisizeMessage(), get_router_id(), and scheduleFlit().

◆ incrementStats()

void NetworkInterface::incrementStats ( flit * t_flit )

private

◆ init_net_ptr()

void NetworkInterface::init_net_ptr ( GarnetNetwork * net_ptr )

inline

Definition at line 70 of file NetworkInterface.hh.

References m_net_ptr.

◆ print()

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

virtual

Implements Consumer.

Definition at line 656 of file NetworkInterface.cc.

◆ scheduleFlit()

void NetworkInterface::scheduleFlit ( flit * t_flit )

Definition at line 580 of file NetworkInterface.cc.

References Clocked::clockEdge(), DPRINTF, flit::get_msg_ptr(), flit::get_vnet(), getOutportForVnet(), flitBuffer::insert(), SimObject::name(), NetworkInterface::OutputPort::outFlitQueue(), NetworkInterface::OutputPort::outNetLink(), panic, and Consumer::scheduleEventAbsolute().

Referenced by scheduleOutputPort().

◆ scheduleOutputLink()

void NetworkInterface::scheduleOutputLink ( )

private

This function looks at the NI buffers if some buffer has flits which are ready to traverse the link in the next cycle, and the downstream output vc associated with this flit has buffers left, the link is scheduled for the next cycle.

Definition at line 542 of file NetworkInterface.cc.

References outPorts, and scheduleOutputPort().

Referenced by wakeup().

◆ scheduleOutputPort()

void NetworkInterface::scheduleOutputPort ( OutputPort * oPort )

private

Definition at line 474 of file NetworkInterface.cc.

References Clocked::clockEdge(), curTick(), flit::get_type(), get_vnet(), HEAD_TAIL_, ArmISA::i, INFINITE_, GarnetNetwork::isVNetOrdered(), NetworkInterface::OutputPort::isVnetSupported(), m_net_ptr, m_ni_out_vcs_enqueue_time, m_vc_per_vnet, niOutVcs, outVcState, scheduleFlit(), flit::set_time(), TAIL_, and NetworkInterface::OutputPort::vcRoundRobin().

Referenced by scheduleOutputLink().

◆ wakeup()

void NetworkInterface::wakeup ( )

virtual

Member Data Documentation

◆ inNode_ptr

std::vector<MessageBuffer *> NetworkInterface::inNode_ptr

private

Definition at line 279 of file NetworkInterface.hh.

Referenced by addNode(), checkReschedule(), and wakeup().

◆ inPorts

std::vector<InputPort *> NetworkInterface::inPorts

private

Definition at line 267 of file NetworkInterface.hh.

Referenced by addInPort(), addOutPort(), checkReschedule(), checkStallQueue(), getInportForVnet(), and wakeup().

◆ m_deadlock_threshold

int NetworkInterface::m_deadlock_threshold

private

Definition at line 268 of file NetworkInterface.hh.

Referenced by calculateVC().

◆ m_id

const NodeID NetworkInterface::m_id

private

Definition at line 262 of file NetworkInterface.hh.

Referenced by flitisizeMessage(), and wakeup().

◆ m_net_ptr

GarnetNetwork* NetworkInterface::m_net_ptr

private

Definition at line 261 of file NetworkInterface.hh.

Referenced by addOutPort(), flitisizeMessage(), incrementStats(), init_net_ptr(), and scheduleOutputPort().

◆ m_ni_out_vcs_enqueue_time

std::vector<Tick> NetworkInterface::m_ni_out_vcs_enqueue_time

private

Definition at line 276 of file NetworkInterface.hh.

Referenced by addOutPort(), flitisizeMessage(), and scheduleOutputPort().

◆ m_stall_count

std::vector<int> NetworkInterface::m_stall_count

private

Definition at line 271 of file NetworkInterface.hh.

Referenced by checkStallQueue(), NetworkInterface(), and wakeup().

◆ m_vc_allocator

std::vector<int> NetworkInterface::m_vc_allocator

private

Definition at line 265 of file NetworkInterface.hh.

Referenced by calculateVC().

◆ m_vc_per_vnet

int NetworkInterface::m_vc_per_vnet

private

Definition at line 264 of file NetworkInterface.hh.

Referenced by addInPort(), addOutPort(), calculateVC(), get_vnet(), and scheduleOutputPort().

◆ m_virtual_networks

const int NetworkInterface::m_virtual_networks

private

Definition at line 263 of file NetworkInterface.hh.

Referenced by addOutPort(), get_vnet(), and NetworkInterface().

◆ niOutVcs

std::vector<flitBuffer> NetworkInterface::niOutVcs

private

Definition at line 275 of file NetworkInterface.hh.

Referenced by addOutPort(), checkReschedule(), flitisizeMessage(), functionalWrite(), NetworkInterface(), and scheduleOutputPort().

◆ outNode_ptr

std::vector<MessageBuffer *> NetworkInterface::outNode_ptr

private

Definition at line 281 of file NetworkInterface.hh.

Referenced by addNode(), checkStallQueue(), and wakeup().

◆ outPorts

std::vector<OutputPort *> NetworkInterface::outPorts

private

Definition at line 266 of file NetworkInterface.hh.

Referenced by addOutPort(), checkReschedule(), functionalWrite(), getOutportForVnet(), scheduleOutputLink(), and wakeup().

◆ outVcState

std::vector<OutVcState> NetworkInterface::outVcState

private

Definition at line 269 of file NetworkInterface.hh.

Referenced by addOutPort(), calculateVC(), flitisizeMessage(), scheduleOutputPort(), and wakeup().

◆ vc_busy_counter

std::vector<int> NetworkInterface::vc_busy_counter

private

Definition at line 283 of file NetworkInterface.hh.

Referenced by calculateVC().

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

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

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ NetworkInterface()

◆ ~NetworkInterface()

Member Function Documentation

◆ addInPort()

◆ addNode()

◆ addOutPort()

◆ calculateVC()

◆ checkReschedule()

◆ checkStallQueue()

◆ dequeueCallback()

◆ flitisizeMessage()

◆ functionalWrite()

◆ get_router_id()

◆ get_vnet()

◆ getInportForVnet()

◆ getOutportForVnet()

◆ incrementStats()

◆ init_net_ptr()

◆ print()

◆ scheduleFlit()

◆ scheduleOutputLink()

◆ scheduleOutputPort()

◆ wakeup()

Member Data Documentation

◆ inNode_ptr

◆ inPorts

◆ m_deadlock_threshold

◆ m_id

◆ m_net_ptr

◆ m_ni_out_vcs_enqueue_time

◆ m_stall_count

◆ m_vc_allocator

◆ m_vc_per_vnet

◆ m_virtual_networks

◆ niOutVcs

◆ outNode_ptr

◆ outPorts

◆ outVcState

◆ vc_busy_counter