The base crossbar contains the common elements of the non-coherent and coherent crossbar. More...

#include <xbar.hh>

Inheritance diagram for BaseXBar:

Classes
class	Layer
	A layer is an internal crossbar arbitration point with its own flow control. More...

struct	PortCache

class	ReqLayer

class	RespLayer

class	SnoopRespLayer

Public Member Functions
virtual	~BaseXBar ()

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

BaseMasterPort &	getMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
	A function used to return the port associated with this object. More...

BaseSlavePort &	getSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a slave port with a given name and index. More...

virtual void	regStats ()
	Register statistics for this object. More...

Public Member Functions inherited from MemObject
const Params *	params () const

	MemObject (const Params *params)

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

Enums::PwrState	pwrState () const

std::string	pwrStateName () const

std::vector< double >	pwrStateWeights () const
	Returns the percentage residency for each power state. More...

void	computeStats ()
	Record stats values like state residency by computing the time difference from previous update. More...

void	pwrState (Enums::PwrState)

void	regStats () override
	Register statistics for this 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	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	resetStats ()
	Reset statistics associated with this object. 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 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
	EventManager (EventManager &em)

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

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)

void	setCurTick (Tick newVal)

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 Clocked
void	updateClockPeriod () const
	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

Protected Member Functions
virtual void	recvRangeChange (PortID master_port_id)
	Function called by the port when the crossbar is recieving a range change. More...

PortID	findPort (Addr addr)
	Find which port connected to this crossbar (if any) should be given a packet with this address. More...

PortID	checkPortCache (Addr addr) const

void	updatePortCache (short id, const AddrRange &range)

void	clearPortCache ()

AddrRangeList	getAddrRanges () const
	Return the address ranges the crossbar is responsible for. More...

void	calcPacketTiming (PacketPtr pkt, Tick header_delay)
	Calculate the timing parameters for the packet. More...

	BaseXBar (const BaseXBarParams *p)

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

Protected Attributes
const Cycles	frontendLatency
	Cycles of front-end pipeline including the delay to accept the request and to decode the address. More...

const Cycles	forwardLatency
	Cycles of forward latency. More...

const Cycles	responseLatency
	Cycles of response latency. More...

const uint32_t	width
	the width of the xbar in bytes More...

AddrRangeMap< PortID >	portMap

std::unordered_map< RequestPtr, PortID >	routeTo
	Remember where request packets came from so that we can route responses to the appropriate port. More...

AddrRangeList	xbarRanges
	all contigous ranges seen by this crossbar More...

AddrRange	defaultRange

PortCache	portCache [3]

std::vector< bool >	gotAddrRanges
	Remember for each of the master ports of the crossbar if we got an address range from the connected slave. More...

bool	gotAllAddrRanges

std::vector< QueuedSlavePort * >	slavePorts
	The master and slave ports of the crossbar. More...

std::vector< MasterPort * >	masterPorts

PortID	defaultPortID
	Port that handles requests that don't match any of the interfaces. More...

const bool	useDefaultRange
	If true, use address range provided by default device. More...

Stats::Vector	transDist
	Stats for transaction distribution and data passing through the crossbar. More...

Stats::Vector2d	pktCount

Stats::Vector2d	pktSize

Protected Attributes inherited from ClockedObject
Enums::PwrState	_currPwrState
	To keep track of the current power state. More...

Tick	prvEvalTick

Stats::Scalar	numPwrStateTransitions

Stats::Distribution	pwrStateClkGateDist

Stats::Vector	pwrStateResidencyTicks

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

Additional Inherited Members
Public Types inherited from MemObject
typedef MemObjectParams	Params

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

Public Types inherited from SimObject
typedef SimObjectParams	Params

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 ()
	Get the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)

static void	unserializeGlobals (CheckpointIn &cp)

Static Public Attributes inherited from Serializable
static int	ckptCount = 0

static int	ckptMaxCount = 0

static int	ckptPrevCount = -1

Detailed Description

The base crossbar contains the common elements of the non-coherent and coherent crossbar.

It is an abstract class that does not have any of the functionality relating to the actual reception and transmission of packets, as this is left for the subclasses.

The BaseXBar is responsible for the basic flow control (busy or not), the administration of retries, and the address decoding.

Definition at line 73 of file xbar.hh.

Constructor & Destructor Documentation

BaseXBar::BaseXBar ( const BaseXBarParams * p )

protected

Definition at line 58 of file xbar.cc.

BaseXBar::~BaseXBar ( )

virtual

Definition at line 70 of file xbar.cc.

References ArmISA::m, masterPorts, ArmISA::s, and slavePorts.

Member Function Documentation

void BaseXBar::calcPacketTiming	(	PacketPtr	pkt,
		Tick	header_delay
	)

protected

Calculate the timing parameters for the packet.

Updates the headerDelay and payloadDelay fields of the packet object with the relative number of ticks required to transmit the header and the payload, respectively.

Parameters

pkt	Packet to populate with timings
header_delay	Header delay to be added

Definition at line 109 of file xbar.cc.

References Clocked::clockEdge(), Clocked::clockPeriod(), curTick(), divCeil(), Packet::getSize(), Packet::hasData(), Packet::headerDelay, ArmISA::offset, panic_if(), Packet::payloadDelay, SimClock::Int::us, and width.

Referenced by HMCController::recvTimingReq(), NoncoherentXBar::recvTimingReq(), CoherentXBar::recvTimingReq(), NoncoherentXBar::recvTimingResp(), CoherentXBar::recvTimingResp(), CoherentXBar::recvTimingSnoopReq(), and CoherentXBar::recvTimingSnoopResp().

PortID BaseXBar::checkPortCache ( Addr addr ) const

inlineprotected

Definition at line 364 of file xbar.hh.

References BaseXBar::PortCache::id, InvalidPortID, and portCache.

Referenced by findPort().

void BaseXBar::clearPortCache ( )

inlineprotected

Definition at line 394 of file xbar.hh.

References portCache, and BaseXBar::PortCache::valid.

Referenced by CoherentXBar::CoherentXBar(), NoncoherentXBar::NoncoherentXBar(), and recvRangeChange().

PortID BaseXBar::findPort ( Addr addr )

protected

Find which port connected to this crossbar (if any) should be given a packet with this address.

Parameters

addr	Address to find port for.

Returns: id of port that the packet should be sent out of.

Definition at line 324 of file xbar.cc.

References checkPortCache(), AddrRange::contains(), defaultPortID, defaultRange, DPRINTF, AddrRangeMap< V >::end(), fatal, AddrRangeMap< V >::find(), gotAllAddrRanges, ArmISA::i, InvalidPortID, SimObject::name(), portMap, updatePortCache(), and useDefaultRange.

Referenced by NoncoherentXBar::recvAtomic(), CoherentXBar::recvAtomic(), NoncoherentXBar::recvFunctional(), CoherentXBar::recvFunctional(), NoncoherentXBar::recvTimingReq(), CoherentXBar::recvTimingReq(), and CoherentXBar::recvTimingSnoopReq().

AddrRangeList BaseXBar::getAddrRanges ( ) const

protected

Return the address ranges the crossbar is responsible for.

Returns: a list of non-overlapping address ranges

Definition at line 525 of file xbar.cc.

References DPRINTF, gotAllAddrRanges, and xbarRanges.

Referenced by NoncoherentXBar::NoncoherentXBarSlavePort::getAddrRanges(), and CoherentXBar::CoherentXBarSlavePort::getAddrRanges().

BaseMasterPort & BaseXBar::getMasterPort	(	const std::string &	if_name,
		PortID	idx = `InvalidPortID`
	)

virtual

A function used to return the port associated with this object.

Reimplemented from MemObject.

Definition at line 85 of file xbar.cc.

References defaultPortID, MemObject::getMasterPort(), and masterPorts.

Referenced by regStats().

BaseSlavePort & BaseXBar::getSlavePort	(	const std::string &	if_name,
		PortID	idx = `InvalidPortID`
	)

virtual

Get a slave port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic base master port.

Parameters

if_name	Port name
idx	Index in the case of a VectorPort

Returns: A reference to the given port

Reimplemented from MemObject.

Definition at line 98 of file xbar.cc.

References MemObject::getSlavePort(), and slavePorts.

Referenced by recvRangeChange(), and regStats().

void BaseXBar::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 SimObject.

Reimplemented in CoherentXBar.

Definition at line 80 of file xbar.cc.

Referenced by CoherentXBar::init().

void BaseXBar::recvRangeChange ( PortID master_port_id )

protectedvirtual

Function called by the port when the crossbar is recieving a range change.

Function called by the port when the crossbar is receiving a range change.

Parameters

master_port_id id of the port that received the change

Reimplemented in HMCController.

Definition at line 364 of file xbar.cc.

References AddrRangeMap< V >::begin(), clearPortCache(), defaultPortID, defaultRange, DPRINTF, AddrRangeMap< V >::end(), AddrRangeMap< V >::erase(), fatal, AddrRangeMap< V >::find(), getSlavePort(), gotAddrRanges, gotAllAddrRanges, AddrRangeMap< V >::insert(), masterPorts, SimObject::name(), MipsISA::p, portMap, MipsISA::r, ArmISA::s, slavePorts, AddrRange::to_string(), useDefaultRange, and xbarRanges.

Referenced by HMCController::recvRangeChange(), NoncoherentXBar::NoncoherentXBarMasterPort::recvRangeChange(), and CoherentXBar::CoherentXBarMasterPort::recvRangeChange().

void BaseXBar::regStats ( )

virtual

Register statistics for this object.

Reimplemented from SimObject.

Reimplemented in CoherentXBar, and NoncoherentXBar.

Definition at line 543 of file xbar.cc.

References Stats::DataWrap< Derived, InfoProxyType >::desc(), Stats::DataWrap< Derived, InfoProxyType >::flags(), getMasterPort(), getSlavePort(), ArmISA::i, Stats::VectorBase< Derived, Stor >::init(), Stats::Vector2dBase< Derived, Stor >::init(), ArmISA::j, masterPorts, SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), Stats::nonan, Stats::nozero, MemCmd::NUM_MEM_CMDS, pktCount, pktSize, ClockedObject::regStats(), slavePorts, Stats::DataWrapVec< Derived, InfoProxyType >::subname(), MemCmd::toString(), Stats::total, transDist, and Stats::DataWrapVec2d< Derived, InfoProxyType >::ysubname().

Referenced by NoncoherentXBar::regStats(), and CoherentXBar::regStats().

void BaseXBar::updatePortCache	(	short	id,
		const AddrRange &	range
	)

inlineprotected

Definition at line 379 of file xbar.hh.

References SparcISA::id, BaseXBar::PortCache::id, portCache, BaseXBar::PortCache::range, and BaseXBar::PortCache::valid.

Referenced by findPort().

Member Data Documentation

PortID BaseXBar::defaultPortID

protected

Port that handles requests that don't match any of the interfaces.

Definition at line 432 of file xbar.hh.

Referenced by CoherentXBar::CoherentXBar(), findPort(), getMasterPort(), NoncoherentXBar::NoncoherentXBar(), and recvRangeChange().

AddrRange BaseXBar::defaultRange

protected

Definition at line 335 of file xbar.hh.

Referenced by findPort(), and recvRangeChange().

const Cycles BaseXBar::forwardLatency

protected

Cycles of forward latency.

Definition at line 316 of file xbar.hh.

Referenced by HMCController::recvTimingReq(), NoncoherentXBar::recvTimingReq(), CoherentXBar::recvTimingReq(), and CoherentXBar::recvTimingSnoopReq().

const Cycles BaseXBar::frontendLatency

protected

Cycles of front-end pipeline including the delay to accept the request and to decode the address.

Definition at line 314 of file xbar.hh.

Referenced by HMCController::recvTimingReq(), NoncoherentXBar::recvTimingReq(), and CoherentXBar::recvTimingReq().

std::vector<bool> BaseXBar::gotAddrRanges

protected

Remember for each of the master ports of the crossbar if we got an address range from the connected slave.

For convenience, also keep track of if we got ranges from all the slave modules or not.

Definition at line 424 of file xbar.hh.

Referenced by HMCController::recvRangeChange(), and recvRangeChange().

bool BaseXBar::gotAllAddrRanges

protected

Definition at line 425 of file xbar.hh.

Referenced by findPort(), getAddrRanges(), HMCController::recvRangeChange(), and recvRangeChange().

Stats::Vector2d BaseXBar::pktCount

protected

Definition at line 452 of file xbar.hh.

Referenced by NoncoherentXBar::recvAtomic(), CoherentXBar::recvAtomic(), HMCController::recvTimingReq(), NoncoherentXBar::recvTimingReq(), CoherentXBar::recvTimingReq(), NoncoherentXBar::recvTimingResp(), CoherentXBar::recvTimingResp(), CoherentXBar::recvTimingSnoopResp(), and regStats().

Stats::Vector2d BaseXBar::pktSize

protected

Definition at line 453 of file xbar.hh.

Referenced by NoncoherentXBar::recvAtomic(), CoherentXBar::recvAtomic(), HMCController::recvTimingReq(), NoncoherentXBar::recvTimingReq(), CoherentXBar::recvTimingReq(), NoncoherentXBar::recvTimingResp(), CoherentXBar::recvTimingResp(), CoherentXBar::recvTimingSnoopResp(), and regStats().

PortCache BaseXBar::portCache[3]

protected

Definition at line 360 of file xbar.hh.

Referenced by checkPortCache(), clearPortCache(), and updatePortCache().

AddrRangeMap<PortID> BaseXBar::portMap

protected

Definition at line 322 of file xbar.hh.

Referenced by findPort(), and recvRangeChange().

const Cycles BaseXBar::responseLatency

protected

Cycles of response latency.

Definition at line 318 of file xbar.hh.

Referenced by NoncoherentXBar::recvTimingResp(), CoherentXBar::recvTimingResp(), and CoherentXBar::recvTimingSnoopResp().

std::unordered_map<RequestPtr, PortID> BaseXBar::routeTo

protected

Remember where request packets came from so that we can route responses to the appropriate port.

This relies on the fact that the underlying Request pointer inside the Packet stays constant.

Definition at line 330 of file xbar.hh.

Referenced by HMCController::recvTimingReq(), NoncoherentXBar::recvTimingReq(), CoherentXBar::recvTimingReq(), NoncoherentXBar::recvTimingResp(), CoherentXBar::recvTimingResp(), CoherentXBar::recvTimingSnoopReq(), and CoherentXBar::recvTimingSnoopResp().

std::vector<QueuedSlavePort*> BaseXBar::slavePorts

protected

The master and slave ports of the crossbar.

Definition at line 428 of file xbar.hh.

Referenced by CoherentXBar::CoherentXBar(), CoherentXBar::forwardAtomic(), getSlavePort(), CoherentXBar::init(), NoncoherentXBar::NoncoherentXBar(), NoncoherentXBar::recvAtomic(), CoherentXBar::recvAtomic(), NoncoherentXBar::recvFunctional(), CoherentXBar::recvFunctional(), CoherentXBar::recvFunctionalSnoop(), recvRangeChange(), HMCController::recvTimingReq(), NoncoherentXBar::recvTimingReq(), CoherentXBar::recvTimingReq(), NoncoherentXBar::recvTimingResp(), CoherentXBar::recvTimingResp(), CoherentXBar::recvTimingSnoopResp(), regStats(), and ~BaseXBar().

Stats::Vector BaseXBar::transDist

protected

Stats for transaction distribution and data passing through the crossbar.

The transaction distribution is globally counting different types of commands. The packet count and total packet size are two-dimensional vectors that are indexed by the slave port and master port id (thus the neighbouring master and neighbouring slave), summing up both directions (request and response).

Definition at line 451 of file xbar.hh.

Referenced by NoncoherentXBar::recvAtomic(), CoherentXBar::recvAtomic(), HMCController::recvTimingReq(), NoncoherentXBar::recvTimingReq(), CoherentXBar::recvTimingReq(), NoncoherentXBar::recvTimingResp(), CoherentXBar::recvTimingResp(), CoherentXBar::recvTimingSnoopReq(), CoherentXBar::recvTimingSnoopResp(), and regStats().

const bool BaseXBar::useDefaultRange

protected

If true, use address range provided by default device.

Any address not handled by another port and not in default device's range will cause a fatal error. If false, just send all addresses not handled by another port to default device.

Definition at line 438 of file xbar.hh.

Referenced by findPort(), and recvRangeChange().

const uint32_t BaseXBar::width

protected

the width of the xbar in bytes

Definition at line 320 of file xbar.hh.

Referenced by calcPacketTiming().

AddrRangeList BaseXBar::xbarRanges

protected

all contigous ranges seen by this crossbar

Definition at line 333 of file xbar.hh.

Referenced by getAddrRanges(), and recvRangeChange().