#include <Switch.hh>

Inheritance diagram for gem5::ruby::Switch:

Classes
struct	SwitchStats

Public Types
typedef SwitchParams	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
	Switch (const Params &p)

	~Switch ()=default

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

void	addInPort (const std::vector< MessageBuffer * > &in)

void	addOutPort (const std::vector< MessageBuffer * > &out, const NetDest &routing_table_entry, Cycles link_latency, int link_weight, int bw_multiplier, bool is_external, PortDirection dst_inport="")

void	resetStats ()
	Callback to reset stats.

void	collateStats ()

void	regStats ()
	Callback to set stat parameters.

const statistics::Formula &	getMsgCount (unsigned int type) const

void	print (std::ostream &out) const

void	init_net_ptr (SimpleNetwork *net_ptr)

bool	functionalRead (Packet *)

bool	functionalRead (Packet *, WriteMask &)

uint32_t	functionalWrite (Packet *)

BaseRoutingUnit &	getRoutingUnit ()

Public Member Functions inherited from gem5::ruby::BasicRouter
	PARAMS (BasicRouter)

	BasicRouter (const Params &p)

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

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

Public Attributes
gem5::ruby::Switch::SwitchStats	switchStats

Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState

Static Public Attributes
static constexpr Event::Priority	PERFECTSWITCH_EV_PRI = Event::Default_Pri

static constexpr Event::Priority	THROTTLE_EV_PRI = Event::Default_Pri + 1

Private Member Functions
	Switch (const Switch &obj)

Switch &	operator= (const Switch &obj)

Private Attributes
PerfectSwitch	perfectSwitch

SimpleNetwork *	m_network_ptr

std::list< Throttle >	throttles

const Cycles	m_int_routing_latency

const Cycles	m_ext_routing_latency

BaseRoutingUnit &	m_routing_unit

unsigned	m_num_connected_buffers

std::vector< MessageBuffer * >	m_port_buffers

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.

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 inherited from gem5::ruby::BasicRouter
uint32_t	m_id

uint32_t	m_latency

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.

Detailed Description

Definition at line 78 of file Switch.hh.

Member Typedef Documentation

◆ Params

typedef SwitchParams gem5::ruby::Switch::Params

Definition at line 87 of file Switch.hh.

Constructor & Destructor Documentation

◆ Switch() [1/2]

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

Definition at line 59 of file Switch.cc.

References m_port_buffers, and gem5::MipsISA::p.

◆ ~Switch()

gem5::ruby::Switch::~Switch ( )

default

◆ Switch() [2/2]

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

private

Member Function Documentation

◆ addInPort()

void gem5::ruby::Switch::addInPort ( const std::vector< MessageBuffer * > & in )

Definition at line 82 of file Switch.cc.

References gem5::ruby::PerfectSwitch::addInPort(), and perfectSwitch.

◆ addOutPort()

void gem5::ruby::Switch::addOutPort	(	const std::vector< MessageBuffer * > &	out,
		const NetDest &	routing_table_entry,
		Cycles	link_latency,
		int	link_weight,
		int	bw_multiplier,
		bool	is_external,
		PortDirection	dst_inport = "" )

Definition at line 88 of file Switch.cc.

References gem5::ruby::PerfectSwitch::addOutPort(), gem5::Clocked::cyclesToTicks(), gem5::ruby::SimpleNetwork::getEndpointBandwidth(), gem5::ArmISA::i, m_ext_routing_latency, gem5::ruby::BasicRouter::m_id, m_int_routing_latency, m_network_ptr, m_num_connected_buffers, m_port_buffers, gem5::SimObject::params(), perfectSwitch, and throttles.

◆ collateStats()

void gem5::ruby::Switch::collateStats ( )

Definition at line 179 of file Switch.cc.

References gem5::ruby::PerfectSwitch::collateStats(), and perfectSwitch.

◆ functionalRead() [1/2]

bool gem5::ruby::Switch::functionalRead ( Packet * pkt )

Definition at line 192 of file Switch.cc.

References functionalRead(), gem5::ArmISA::i, and m_port_buffers.

Referenced by functionalRead(), and functionalRead().

◆ functionalRead() [2/2]

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

Definition at line 202 of file Switch.cc.

References functionalRead(), gem5::ArmISA::i, m_port_buffers, and gem5::ArmISA::mask.

◆ functionalWrite()

uint32_t gem5::ruby::Switch::functionalWrite ( Packet * pkt )

Definition at line 213 of file Switch.cc.

References gem5::ArmISA::i, and m_port_buffers.

◆ getMsgCount()

const statistics::Formula & gem5::ruby::Switch::getMsgCount ( unsigned int type ) const

inline

Definition at line 102 of file Switch.hh.

References gem5::ruby::Switch::SwitchStats::m_msg_counts, switchStats, and gem5::X86ISA::type.

◆ getRoutingUnit()

BaseRoutingUnit & gem5::ruby::Switch::getRoutingUnit ( )

inline

Definition at line 112 of file Switch.hh.

References m_routing_unit.

Referenced by gem5::ruby::PerfectSwitch::addOutPort(), and gem5::ruby::PerfectSwitch::operateMessageBuffer().

◆ init()

void gem5::ruby::Switch::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::ruby::BasicRouter.

Definition at line 74 of file Switch.cc.

References gem5::ruby::BasicRouter::init(), gem5::ruby::PerfectSwitch::init(), gem5::ruby::BaseRoutingUnit::init_parent(), m_network_ptr, m_routing_unit, and perfectSwitch.

◆ init_net_ptr()

void gem5::ruby::Switch::init_net_ptr ( SimpleNetwork * net_ptr )

inline

Definition at line 106 of file Switch.hh.

References m_network_ptr.

◆ operator=()

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

private

◆ print()

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

Definition at line 185 of file Switch.cc.

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

◆ regStats()

void gem5::ruby::Switch::regStats ( )

virtual

Callback to set stat parameters.

This callback is typically used for complex stats (e.g., distributions) that need parameters in addition to a name and a description. Stat names and descriptions should typically be set from the constructor usingo from the constructor using the ADD_STAT macro.

Reimplemented from gem5::statistics::Group.

Definition at line 138 of file Switch.cc.

References gem5::statistics::constant(), gem5::csprintf(), gem5::statistics::DataWrap< Derived, InfoProxyType >::flags(), gem5::ruby::Switch::SwitchStats::m_avg_utilization, gem5::ruby::Switch::SwitchStats::m_msg_bytes, gem5::ruby::Switch::SwitchStats::m_msg_counts, gem5::ruby::Network::MessageSizeType_to_int(), gem5::statistics::nozero, gem5::statistics::Group::regStats(), switchStats, throttles, and gem5::X86ISA::type.

◆ resetStats()

void gem5::ruby::Switch::resetStats ( )

virtual

Callback to reset stats.

Reimplemented from gem5::statistics::Group.

Definition at line 173 of file Switch.cc.

References gem5::ruby::PerfectSwitch::clearStats(), and perfectSwitch.

Member Data Documentation

◆ m_ext_routing_latency

const Cycles gem5::ruby::Switch::m_ext_routing_latency

private

Definition at line 124 of file Switch.hh.

Referenced by addOutPort().

◆ m_int_routing_latency

const Cycles gem5::ruby::Switch::m_int_routing_latency

private

Definition at line 123 of file Switch.hh.

Referenced by addOutPort().

◆ m_network_ptr

SimpleNetwork* gem5::ruby::Switch::m_network_ptr

private

Definition at line 120 of file Switch.hh.

Referenced by addOutPort(), init(), and init_net_ptr().

◆ m_num_connected_buffers

unsigned gem5::ruby::Switch::m_num_connected_buffers

private

Definition at line 128 of file Switch.hh.

Referenced by addOutPort().

◆ m_port_buffers

std::vector<MessageBuffer*> gem5::ruby::Switch::m_port_buffers

private

Definition at line 129 of file Switch.hh.

Referenced by addOutPort(), functionalRead(), functionalRead(), functionalWrite(), and Switch().

◆ m_routing_unit

BaseRoutingUnit& gem5::ruby::Switch::m_routing_unit

private

Definition at line 126 of file Switch.hh.

Referenced by getRoutingUnit(), and init().

◆ perfectSwitch

PerfectSwitch gem5::ruby::Switch::perfectSwitch

private

Definition at line 119 of file Switch.hh.

Referenced by addInPort(), addOutPort(), collateStats(), init(), and resetStats().

◆ PERFECTSWITCH_EV_PRI

Event::Priority gem5::ruby::Switch::PERFECTSWITCH_EV_PRI = Event::Default_Pri

staticconstexpr

Definition at line 84 of file Switch.hh.

◆ switchStats

gem5::ruby::Switch::SwitchStats gem5::ruby::Switch::switchStats

Referenced by getMsgCount(), and regStats().

◆ THROTTLE_EV_PRI

Event::Priority gem5::ruby::Switch::THROTTLE_EV_PRI = Event::Default_Pri + 1

staticconstexpr

Definition at line 85 of file Switch.hh.

◆ throttles

std::list<Throttle> gem5::ruby::Switch::throttles

private

Definition at line 121 of file Switch.hh.

Referenced by addOutPort(), and regStats().

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

mem/ruby/network/simple/Switch.hh
mem/ruby/network/simple/Switch.cc

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ Switch() [1/2]

◆ ~Switch()

◆ Switch() [2/2]

Member Function Documentation

◆ addInPort()

◆ addOutPort()

◆ collateStats()

◆ functionalRead() [1/2]

◆ functionalRead() [2/2]

◆ functionalWrite()

◆ getMsgCount()

◆ getRoutingUnit()

◆ init()

◆ init_net_ptr()

◆ operator=()

◆ print()

◆ regStats()

◆ resetStats()

Member Data Documentation

◆ m_ext_routing_latency

◆ m_int_routing_latency

◆ m_network_ptr

◆ m_num_connected_buffers

◆ m_port_buffers

◆ m_routing_unit

◆ perfectSwitch

◆ PERFECTSWITCH_EV_PRI

◆ switchStats

◆ THROTTLE_EV_PRI

◆ throttles