#include <Network.hh>

Inheritance diagram for gem5::ruby::Network:

Classes
struct	AddrMapNode

Public Member Functions
	PARAMS (RubyNetwork)

	Network (const Params &p)

virtual	~Network ()

int	getNumNodes () const

void	setToNetQueue (NodeID global_id, bool ordered, int netNumber, std::string vnet_type, MessageBuffer *b)

virtual void	setFromNetQueue (NodeID global_id, bool ordered, int netNumber, std::string vnet_type, MessageBuffer *b)

virtual void	checkNetworkAllocation (NodeID local_id, bool ordered, int network_num, std::string vnet_type)

virtual void	makeExtOutLink (SwitchID src, NodeID dest, BasicLink *link, std::vector< NetDest > &routing_table_entry)=0

virtual void	makeExtInLink (NodeID src, SwitchID dest, BasicLink *link, std::vector< NetDest > &routing_table_entry)=0

virtual void	makeInternalLink (SwitchID src, SwitchID dest, BasicLink *link, std::vector< NetDest > &routing_table_entry, PortDirection src_outport, PortDirection dst_inport)=0

virtual void	collateStats ()=0

virtual void	print (std::ostream &out) const =0

virtual bool	functionalRead (Packet *pkt)

virtual bool	functionalRead (Packet *pkt, WriteMask &mask)

virtual uint32_t	functionalWrite (Packet *pkt)

NodeID	addressToNodeID (Addr addr, MachineType mtype)
	Map an address to the correct NodeID.

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

NodeID	getLocalNodeID (NodeID global_id) const

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	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.

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

Static Public Member Functions
static uint32_t	getNumberOfVirtualNetworks ()

static uint32_t	MessageSizeType_to_int (MessageSizeType size_type)

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
	Network (const Network &obj)

Network &	operator= (const Network &obj)

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.

Protected Attributes
uint32_t	m_nodes

std::vector< std::string >	m_vnet_type_names

Topology *	m_topology_ptr

std::vector< std::vector< MessageBuffer * > >	m_toNetQueues

std::vector< std::vector< MessageBuffer * > >	m_fromNetQueues

std::vector< bool >	m_ordered

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.

Static Protected Attributes
static uint32_t	m_virtual_networks

static uint32_t	m_control_msg_size

static uint32_t	m_data_msg_size

Private Attributes
std::unordered_multimap< MachineType, AddrMapNode >	addrMap

std::unordered_map< NodeID, NodeID >	globalToLocalMap

Additional Inherited Members
Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState

Detailed Description

Definition at line 82 of file Network.hh.

Constructor & Destructor Documentation

◆ Network() [1/2]

gem5::ruby::Network::Network ( const Params & p )

◆ ~Network()

gem5::ruby::Network::~Network ( )

virtual

Definition at line 146 of file Network.cc.

References m_fromNetQueues, m_nodes, m_toNetQueues, and m_topology_ptr.

◆ Network() [2/2]

gem5::ruby::Network::Network ( const Network & obj )

protected

Member Function Documentation

◆ addressToNodeID()

NodeID gem5::ruby::Network::addressToNodeID	(	Addr	addr,
		MachineType	mtype )

Map an address to the correct NodeID.

This function traverses the global address map to find the NodeID that corresponds to the given address and the type of the destination. For example for a request to a directory this function will return the NodeID of the right directory.

Parameters

the	destination address
the	type of the destination

Returns: the NodeID of the destination

Definition at line 235 of file Network.cc.

References gem5::X86ISA::addr, addrMap, gem5::ruby::Network::AddrMapNode::id, and gem5::ruby::Network::AddrMapNode::ranges.

Referenced by gem5::ruby::AbstractController::mapAddressToMachine().

◆ checkNetworkAllocation()

void gem5::ruby::Network::checkNetworkAllocation	(	NodeID	local_id,
		bool	ordered,
		int	network_num,
		std::string	vnet_type )

virtual

Definition at line 193 of file Network.cc.

References fatal_if, m_nodes, m_ordered, m_virtual_networks, and m_vnet_type_names.

Referenced by setFromNetQueue(), and setToNetQueue().

◆ collateStats()

virtual void gem5::ruby::Network::collateStats ( )

pure virtual

Implemented in gem5::ruby::garnet::GarnetNetwork, and gem5::ruby::SimpleNetwork.

Referenced by Network().

◆ functionalRead() [1/2]

virtual bool gem5::ruby::Network::functionalRead ( Packet * pkt )

inlinevirtual

Reimplemented in gem5::ruby::SimpleNetwork.

Definition at line 121 of file Network.hh.

References fatal.

◆ functionalRead() [2/2]

virtual bool gem5::ruby::Network::functionalRead	(	Packet *	pkt,
		WriteMask &	mask )

inlinevirtual

Reimplemented in gem5::ruby::garnet::GarnetNetwork, and gem5::ruby::SimpleNetwork.

Definition at line 123 of file Network.hh.

References fatal.

◆ functionalWrite()

virtual uint32_t gem5::ruby::Network::functionalWrite ( Packet * pkt )

inlinevirtual

Reimplemented in gem5::ruby::garnet::GarnetNetwork, and gem5::ruby::SimpleNetwork.

Definition at line 125 of file Network.hh.

References fatal.

◆ getLocalNodeID()

NodeID gem5::ruby::Network::getLocalNodeID ( NodeID global_id ) const

Definition at line 253 of file Network.cc.

References globalToLocalMap.

Referenced by gem5::ruby::garnet::GarnetNetwork::get_router_id(), gem5::ruby::garnet::GarnetNetwork::makeExtInLink(), gem5::ruby::SimpleNetwork::makeExtInLink(), gem5::ruby::garnet::GarnetNetwork::makeExtOutLink(), gem5::ruby::SimpleNetwork::makeExtOutLink(), setFromNetQueue(), and setToNetQueue().

◆ getNumberOfVirtualNetworks()

static uint32_t gem5::ruby::Network::getNumberOfVirtualNetworks ( )

inlinestatic

Definition at line 90 of file Network.hh.

References m_virtual_networks.

Referenced by gem5::ruby::AbstractController::init(), gem5::ruby::AbstractController::resetStats(), and gem5::ruby::Throttle::ThrottleStats::ThrottleStats().

◆ getNumNodes()

int gem5::ruby::Network::getNumNodes ( ) const

inline

Definition at line 91 of file Network.hh.

References m_nodes.

◆ getPort()

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

inlineoverridevirtual

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 143 of file Network.hh.

References gem5::ruby::RubyDummyPort::instance().

◆ makeExtInLink()

virtual void gem5::ruby::Network::makeExtInLink	(	NodeID	src,
		SwitchID	dest,
		BasicLink *	link,
		std::vector< NetDest > &	routing_table_entry )

pure virtual

Implemented in gem5::ruby::garnet::GarnetNetwork, and gem5::ruby::SimpleNetwork.

Referenced by gem5::ruby::Topology::makeLink().

◆ makeExtOutLink()

virtual void gem5::ruby::Network::makeExtOutLink	(	SwitchID	src,
		NodeID	dest,
		BasicLink *	link,
		std::vector< NetDest > &	routing_table_entry )

pure virtual

Implemented in gem5::ruby::garnet::GarnetNetwork, and gem5::ruby::SimpleNetwork.

Referenced by gem5::ruby::Topology::makeLink().

◆ makeInternalLink()

virtual void gem5::ruby::Network::makeInternalLink	(	SwitchID	src,
		SwitchID	dest,
		BasicLink *	link,
		std::vector< NetDest > &	routing_table_entry,
		PortDirection	src_outport,
		PortDirection	dst_inport )

pure virtual

Implemented in gem5::ruby::garnet::GarnetNetwork, and gem5::ruby::SimpleNetwork.

Referenced by gem5::ruby::Topology::makeLink().

◆ MessageSizeType_to_int()

uint32_t gem5::ruby::Network::MessageSizeType_to_int ( MessageSizeType size_type )

static

Definition at line 164 of file Network.cc.

References m_control_msg_size, m_data_msg_size, and panic.

Referenced by gem5::ruby::garnet::NetworkInterface::flitisizeMessage(), gem5::ruby::network_message_to_size(), gem5::ruby::Throttle::operateVnet(), gem5::ruby::SimpleNetwork::regStats(), gem5::ruby::Switch::regStats(), and gem5::ruby::Throttle::ThrottleStats::ThrottleStats().

◆ operator=()

Network & gem5::ruby::Network::operator= ( const Network & obj )

protected

◆ PARAMS()

gem5::ruby::Network::PARAMS ( RubyNetwork )

◆ print()

virtual void gem5::ruby::Network::print ( std::ostream & out ) const

pure virtual

Implemented in gem5::ruby::garnet::GarnetNetwork, and gem5::ruby::SimpleNetwork.

Referenced by gem5::ruby::operator<<().

◆ setFromNetQueue()

void gem5::ruby::Network::setFromNetQueue	(	NodeID	global_id,
		bool	ordered,
		int	netNumber,
		std::string	vnet_type,
		MessageBuffer *	b )

virtual

Definition at line 222 of file Network.cc.

References gem5::ArmISA::b, checkNetworkAllocation(), getLocalNodeID(), and m_fromNetQueues.

◆ setToNetQueue()

void gem5::ruby::Network::setToNetQueue	(	NodeID	global_id,
		bool	ordered,
		int	netNumber,
		std::string	vnet_type,
		MessageBuffer *	b )

Definition at line 209 of file Network.cc.

References gem5::ArmISA::b, checkNetworkAllocation(), getLocalNodeID(), and m_toNetQueues.

Member Data Documentation

◆ addrMap

std::unordered_multimap<MachineType, AddrMapNode> gem5::ruby::Network::addrMap

private

Definition at line 174 of file Network.hh.

Referenced by addressToNodeID(), and Network().

◆ globalToLocalMap

std::unordered_map<NodeID, NodeID> gem5::ruby::Network::globalToLocalMap

private

Definition at line 178 of file Network.hh.

Referenced by getLocalNodeID(), and Network().

◆ m_control_msg_size

uint32_t gem5::ruby::Network::m_control_msg_size

staticprotected

Definition at line 159 of file Network.hh.

Referenced by MessageSizeType_to_int(), and Network().

◆ m_data_msg_size

uint32_t gem5::ruby::Network::m_data_msg_size

staticprotected

Definition at line 160 of file Network.hh.

Referenced by MessageSizeType_to_int(), and Network().

◆ m_fromNetQueues

std::vector<std::vector<MessageBuffer*> > gem5::ruby::Network::m_fromNetQueues

protected

Definition at line 164 of file Network.hh.

Referenced by gem5::ruby::garnet::GarnetNetwork::init(), gem5::ruby::SimpleNetwork::makeExtOutLink(), Network(), setFromNetQueue(), and ~Network().

◆ m_nodes

uint32_t gem5::ruby::Network::m_nodes

protected

Definition at line 155 of file Network.hh.

Referenced by checkNetworkAllocation(), getNumNodes(), gem5::ruby::garnet::GarnetNetwork::init(), gem5::ruby::garnet::GarnetNetwork::makeExtInLink(), gem5::ruby::SimpleNetwork::makeExtInLink(), gem5::ruby::garnet::GarnetNetwork::makeExtOutLink(), gem5::ruby::SimpleNetwork::makeExtOutLink(), Network(), and ~Network().

◆ m_ordered

std::vector<bool> gem5::ruby::Network::m_ordered

protected

Definition at line 165 of file Network.hh.

Referenced by checkNetworkAllocation(), gem5::ruby::garnet::GarnetNetwork::isVNetOrdered(), gem5::ruby::SimpleNetwork::isVNetOrdered(), and Network().

◆ m_toNetQueues

std::vector<std::vector<MessageBuffer*> > gem5::ruby::Network::m_toNetQueues

protected

Definition at line 163 of file Network.hh.

Referenced by gem5::ruby::garnet::GarnetNetwork::init(), gem5::ruby::SimpleNetwork::makeExtInLink(), Network(), setToNetQueue(), and ~Network().

◆ m_topology_ptr

Topology* gem5::ruby::Network::m_topology_ptr

protected

Definition at line 158 of file Network.hh.

Referenced by gem5::ruby::garnet::GarnetNetwork::init(), gem5::ruby::SimpleNetwork::init(), Network(), and ~Network().

◆ m_virtual_networks

uint32_t gem5::ruby::Network::m_virtual_networks

staticprotected

Definition at line 156 of file Network.hh.

Referenced by checkNetworkAllocation(), gem5::ruby::garnet::GarnetNetwork::GarnetNetwork(), getNumberOfVirtualNetworks(), Network(), and gem5::ruby::garnet::GarnetNetwork::regStats().

◆ m_vnet_type_names

std::vector<std::string> gem5::ruby::Network::m_vnet_type_names

protected

Definition at line 157 of file Network.hh.

Referenced by checkNetworkAllocation(), gem5::ruby::garnet::GarnetNetwork::GarnetNetwork(), and Network().

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

mem/ruby/network/Network.hh
mem/ruby/network/Network.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Network() [1/2]

◆ ~Network()

◆ Network() [2/2]

Member Function Documentation

◆ addressToNodeID()

◆ checkNetworkAllocation()

◆ collateStats()

◆ functionalRead() [1/2]

◆ functionalRead() [2/2]

◆ functionalWrite()

◆ getLocalNodeID()

◆ getNumberOfVirtualNetworks()

◆ getNumNodes()

◆ getPort()

◆ makeExtInLink()

◆ makeExtOutLink()

◆ makeInternalLink()

◆ MessageSizeType_to_int()

◆ operator=()

◆ PARAMS()

◆ print()

◆ setFromNetQueue()

◆ setToNetQueue()

Member Data Documentation

◆ addrMap

◆ globalToLocalMap

◆ m_control_msg_size

◆ m_data_msg_size

◆ m_fromNetQueues

◆ m_nodes

◆ m_ordered

◆ m_toNetQueues

◆ m_topology_ptr

◆ m_virtual_networks

◆ m_vnet_type_names