#include <AbstractController.hh>

Inheritance diagram for AbstractController:

Classes
struct	ControllerStats

class	MemoryPort
	Port that forwards requests and receives responses from the memory controller. More...

struct	SenderState

struct	TransMapPair

Public Member Functions
	PARAMS (RubyController)

	AbstractController (const Params &p)

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

NodeID	getVersion () const

MachineType	getType () const

void	initNetworkPtr (Network *net_ptr)

void	blockOnQueue (Addr, MessageBuffer *)

bool	isBlocked (Addr) const

void	unblock (Addr)

bool	isBlocked (Addr)

virtual MessageBuffer *	getMandatoryQueue () const =0

virtual MessageBuffer *	getMemReqQueue () const =0

virtual MessageBuffer *	getMemRespQueue () const =0

virtual AccessPermission	getAccessPermission (const Addr &addr)=0

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

virtual void	wakeup ()=0

virtual void	resetStats ()=0
	Callback to reset stats. More...

virtual void	regStats ()
	Callback to set stat parameters. More...

virtual void	recordCacheTrace (int cntrl, CacheRecorder *tr)=0

virtual Sequencer *	getCPUSequencer () const =0

virtual DMASequencer *	getDMASequencer () const =0

virtual GPUCoalescer *	getGPUCoalescer () const =0

virtual Cycles	mandatoryQueueLatency (const RubyRequestType &param_type)

virtual bool	functionalReadBuffers (PacketPtr &)=0
	These functions are used by ruby system to read/write the data blocks that exist with in the controller. More...

virtual void	functionalRead (const Addr &addr, PacketPtr)

virtual bool	functionalReadBuffers (PacketPtr &, WriteMask &mask)=0
	Functional read that reads only blocks not present in the mask. More...

virtual void	functionalRead (const Addr &addr, PacketPtr pkt, WriteMask &mask)

void	functionalMemoryRead (PacketPtr)

virtual int	functionalWriteBuffers (PacketPtr &)=0
	The return value indicates the number of messages written with the data from the packet. More...

virtual int	functionalWrite (const Addr &addr, PacketPtr)=0

int	functionalMemoryWrite (PacketPtr)

virtual void	enqueuePrefetch (const Addr &, const RubyRequestType &)
	Function for enqueuing a prefetch request. More...

virtual void	notifyCoalesced (const Addr &addr, const RubyRequestType &type, const RequestPtr &req, const DataBlock &data_blk, const bool &was_miss)
	Notifies controller of a request coalesced at the sequencer. More...

virtual void	collateStats ()
	Function for collating statistics from all the controllers of this particular type. More...

virtual void	initNetQueues ()=0
	Initialize the message buffers. More...

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

void	recvTimingResp (PacketPtr pkt)

Tick	recvAtomic (PacketPtr pkt)

const AddrRangeList &	getAddrRanges () const

MachineID	getMachineID () const

RequestorID	getRequestorId () const

Stats::Histogram &	getDelayHist ()

Stats::Histogram &	getDelayVCHist (uint32_t index)

bool	respondsTo (Addr addr)

MachineID	mapAddressToMachine (Addr addr, MachineType mtype) const
	Map an address to the correct MachineID. More...

MachineID	mapAddressToDownstreamMachine (Addr addr, MachineType mtype=MachineType_NUM) const
	Maps an address to the correct dowstream MachineID (i.e. More...

const NetDest &	allDownstreamDest () const

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

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 &p)

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

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block. 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)

ClockedObject *	getObject ()

void	scheduleEventAbsolute (Tick timeAbs)

void	scheduleEvent (Cycles timeDelta)

Public Attributes
AbstractController::ControllerStats	stats

Public Attributes inherited from ClockedObject
PowerState *	powerState

Protected Types
typedef std::vector< MessageBuffer * >	MsgVecType

typedef std::set< MessageBuffer * >	MsgBufType

typedef std::map< Addr, MsgVecType * >	WaitingBufType

Protected Member Functions
void	profileRequest (const std::string &request)
	Profiles original cache requests including PUTs. More...

void	profileMsgDelay (uint32_t virtualNetwork, Cycles delay)
	Profiles the delay associated with messages. More...

template<typename EventType , typename StateType >
void	incomingTransactionStart (Addr addr, EventType type, StateType initialState, bool retried)
	Profiles an event that initiates a protocol transactions for a specific line (e.g. More...

template<typename StateType >
void	incomingTransactionEnd (Addr addr, StateType finalState)
	Profiles an event that ends a transaction. More...

template<typename EventType >
void	outgoingTransactionStart (Addr addr, EventType type)
	Profiles an event that initiates a transaction in a peer controller (e.g. More...

void	outgoingTransactionEnd (Addr addr, bool retried)
	Profiles the end of an outgoing transaction. More...

void	stallBuffer (MessageBuffer *buf, Addr addr)

void	wakeUpBuffer (MessageBuffer *buf, Addr addr)

void	wakeUpBuffers (Addr addr)

void	wakeUpAllBuffers (Addr addr)

void	wakeUpAllBuffers ()

bool	serviceMemoryQueue ()

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
std::unordered_map< Addr, TransMapPair >	m_inTrans

std::unordered_map< Addr, TransMapPair >	m_outTrans

const NodeID	m_version

MachineID	m_machineID

const NodeID	m_clusterID

const RequestorID	m_id

Network *	m_net_ptr

bool	m_is_blocking

std::map< Addr, MessageBuffer * >	m_block_map

WaitingBufType	m_waiting_buffers

unsigned int	m_in_ports

unsigned int	m_cur_in_port

const int	m_number_of_TBEs

const int	m_transitions_per_cycle

const unsigned int	m_buffer_size

Cycles	m_recycle_latency

const Cycles	m_mandatory_queue_latency

MemoryPort	memoryPort

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 Types
typedef std::unordered_map< MachineType, MachineID >	AddrMapEntry

Private Attributes
const AddrRangeList	addrRanges
	The address range to which the controller responds on the CPU side. More...

AddrRangeMap< AddrMapEntry, 3 >	downstreamAddrMap

NetDest	downstreamDestinations

Additional Inherited Members
Public Types inherited from ClockedObject
using	Params = ClockedObjectParams
	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 ()
	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)

Detailed Description

Definition at line 76 of file AbstractController.hh.

Member Typedef Documentation

◆ AddrMapEntry

typedef std::unordered_map<MachineType, MachineID> AbstractController::AddrMapEntry

private

Definition at line 366 of file AbstractController.hh.

◆ MsgBufType

typedef std::set<MessageBuffer*> AbstractController::MsgBufType

protected

Definition at line 314 of file AbstractController.hh.

◆ MsgVecType

typedef std::vector<MessageBuffer*> AbstractController::MsgVecType

protected

Definition at line 313 of file AbstractController.hh.

◆ WaitingBufType

typedef std::map<Addr, MsgVecType* > AbstractController::WaitingBufType

protected

Definition at line 315 of file AbstractController.hh.

Constructor & Destructor Documentation

◆ AbstractController()

AbstractController::AbstractController ( const Params & p )

Definition at line 50 of file AbstractController.cc.

References collateStats(), m_version, and Stats::registerDumpCallback().

Member Function Documentation

◆ allDownstreamDest()

const NetDest& AbstractController::allDownstreamDest ( ) const

inline

Definition at line 211 of file AbstractController.hh.

References downstreamDestinations.

◆ blockOnQueue()

void AbstractController::blockOnQueue	(	Addr	addr,
		MessageBuffer *	port
	)

Definition at line 306 of file AbstractController.cc.

References X86ISA::addr, m_block_map, and m_is_blocking.

Referenced by Sequencer::writeCallback().

◆ collateStats()

virtual void AbstractController::collateStats ( )

inlinevirtual

Function for collating statistics from all the controllers of this particular type.

This function should only be called from the version 0 of this controller type.

Definition at line 152 of file AbstractController.hh.

References fatal.

Referenced by AbstractController().

◆ enqueuePrefetch()

virtual void AbstractController::enqueuePrefetch	(	const Addr &	,
		const RubyRequestType &
	)

inlinevirtual

Function for enqueuing a prefetch request.

Definition at line 137 of file AbstractController.hh.

References fatal.

Referenced by RubyPrefetcher::initializeStream(), and RubyPrefetcher::issueNextPrefetch().

◆ functionalMemoryRead()

void AbstractController::functionalMemoryRead ( PacketPtr pkt )

Definition at line 340 of file AbstractController.cc.

References MessageBuffer::functionalRead(), getMemReqQueue(), memoryPort, and RequestPort::sendFunctional().

◆ functionalMemoryWrite()

int AbstractController::functionalMemoryWrite ( PacketPtr pkt )

Definition at line 349 of file AbstractController.cc.

References memoryPort, and RequestPort::sendFunctional().

◆ functionalRead() [1/2]

virtual void AbstractController::functionalRead	(	const Addr &	addr,
		PacketPtr	pkt,
		WriteMask &	mask
	)

inlinevirtual

Definition at line 125 of file AbstractController.hh.

References panic.

◆ functionalRead() [2/2]

virtual void AbstractController::functionalRead	(	const Addr &	addr,
		PacketPtr
	)

inlinevirtual

Definition at line 119 of file AbstractController.hh.

References panic.

Referenced by RubySystem::functionalRead().

◆ functionalReadBuffers() [1/2]

virtual bool AbstractController::functionalReadBuffers ( PacketPtr & )

pure virtual

These functions are used by ruby system to read/write the data blocks that exist with in the controller.

◆ functionalReadBuffers() [2/2]

virtual bool AbstractController::functionalReadBuffers	(	PacketPtr &	,
		WriteMask &	mask
	)

pure virtual

Functional read that reads only blocks not present in the mask.

Return number of bytes read.

◆ functionalWrite()

virtual int AbstractController::functionalWrite	(	const Addr &	addr,
		PacketPtr
	)

pure virtual

◆ functionalWriteBuffers()

virtual int AbstractController::functionalWriteBuffers ( PacketPtr & )

pure virtual

The return value indicates the number of messages written with the data from the packet.

◆ getAccessPermission()

virtual AccessPermission AbstractController::getAccessPermission ( const Addr & addr )

pure virtual

◆ getAddrRanges()

const AddrRangeList& AbstractController::getAddrRanges ( ) const

inline

Definition at line 165 of file AbstractController.hh.

References addrRanges.

Referenced by Network::Network().

◆ getCPUSequencer()

virtual Sequencer* AbstractController::getCPUSequencer ( ) const

pure virtual

Referenced by Profiler::collateStats().

◆ getDelayHist()

Stats::Histogram& AbstractController::getDelayHist ( )

inline

Definition at line 171 of file AbstractController.hh.

References AbstractController::ControllerStats::delayHistogram, and stats.

Referenced by Profiler::collateStats().

◆ getDelayVCHist()

Stats::Histogram& AbstractController::getDelayVCHist ( uint32_t index )

inline

Definition at line 172 of file AbstractController.hh.

References AbstractController::ControllerStats::delayVCHistogram, MipsISA::index, and stats.

Referenced by Profiler::collateStats().

◆ getDMASequencer()

virtual DMASequencer* AbstractController::getDMASequencer ( ) const

pure virtual

◆ getGPUCoalescer()

virtual GPUCoalescer* AbstractController::getGPUCoalescer ( ) const

pure virtual

Referenced by Profiler::collateStats().

◆ getMachineID()

MachineID AbstractController::getMachineID ( ) const

inline

Definition at line 168 of file AbstractController.hh.

References m_machineID.

Referenced by Network::Network(), and RubySystem::registerAbstractController().

◆ getMandatoryQueue()

virtual MessageBuffer* AbstractController::getMandatoryQueue ( ) const

pure virtual

Referenced by RubyPort::init().

◆ getMemReqQueue()

virtual MessageBuffer* AbstractController::getMemReqQueue ( ) const

pure virtual

Referenced by functionalMemoryRead(), init(), and serviceMemoryQueue().

◆ getMemRespQueue()

virtual MessageBuffer* AbstractController::getMemRespQueue ( ) const

pure virtual

Referenced by recvTimingResp().

◆ getPort()

Port & AbstractController::getPort	(	const std::string &	if_name,
		PortID	idx = `InvalidPortID`
	)

virtual

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

Reimplemented from SimObject.

Definition at line 334 of file AbstractController.cc.

References memoryPort.

◆ getRequestorId()

RequestorID AbstractController::getRequestorId ( ) const

inline

Definition at line 169 of file AbstractController.hh.

References m_id.

◆ getType()

MachineType AbstractController::getType ( ) const

inline

Definition at line 84 of file AbstractController.hh.

References MachineID::getType(), and m_machineID.

Referenced by Network::Network(), and Topology::Topology().

◆ getVersion()

NodeID AbstractController::getVersion ( ) const

inline

Definition at line 83 of file AbstractController.hh.

References MachineID::getNum(), and m_machineID.

Referenced by Network::Network(), and Topology::Topology().

◆ incomingTransactionEnd()

template<typename StateType >

void AbstractController::incomingTransactionEnd	(	Addr	addr,
		StateType	finalState
	)

inlineprotected

Profiles an event that ends a transaction.

Parameters

addr	address of the line with a outstanding transaction
finalState	state of the line after the transaction

Definition at line 251 of file AbstractController.hh.

References X86ISA::addr, curTick(), AbstractController::ControllerStats::inTransLatHist, AbstractController::ControllerStats::inTransLatTotal, m_inTrans, stats, and Clocked::ticksToCycles().

◆ incomingTransactionStart()

template<typename EventType , typename StateType >

void AbstractController::incomingTransactionStart	(	Addr	addr,
		EventType	type,
		StateType	initialState,
		bool	retried
	)

inlineprotected

Profiles an event that initiates a protocol transactions for a specific line (e.g.

events triggered by incoming request messages). A histogram with the latency of the transactions is generated for all combinations of trigger event, initial state, and final state.

Parameters

addr	address of the line
type	event that started the transaction
initialState	state of the line before the transaction

Definition at line 235 of file AbstractController.hh.

References X86ISA::addr, curTick(), AbstractController::ControllerStats::inTransLatRetries, m_inTrans, stats, and X86ISA::type.

◆ init()

void AbstractController::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.

Definition at line 70 of file AbstractController.cc.

References NetDest::add(), AbstractController::ControllerStats::delayHistogram, AbstractController::ControllerStats::delayVCHistogram, downstreamAddrMap, downstreamDestinations, AddrRangeMap< V, max_cache_size >::end(), fatal_if, getMemReqQueue(), Network::getNumberOfVirtualNetworks(), MachineID::getType(), ArmISA::i, Stats::Histogram::init(), AddrRangeMap< V, max_cache_size >::insert(), AddrRangeMap< V, max_cache_size >::intersects(), SimObject::name(), SimObject::params(), NetDest::resize(), MessageBuffer::setConsumer(), and stats.

◆ initNetQueues()

virtual void AbstractController::initNetQueues ( )

pure virtual

Initialize the message buffers.

◆ initNetworkPtr()

void AbstractController::initNetworkPtr ( Network * net_ptr )

inline

Definition at line 86 of file AbstractController.hh.

References m_net_ptr.

Referenced by Network::Network().

◆ isBlocked() [1/2]

bool AbstractController::isBlocked ( Addr addr )

Definition at line 328 of file AbstractController.cc.

References X86ISA::addr, and m_block_map.

◆ isBlocked() [2/2]

bool AbstractController::isBlocked ( Addr addr ) const

Definition at line 313 of file AbstractController.cc.

References X86ISA::addr, m_block_map, and m_is_blocking.

Referenced by Sequencer::makeRequest().

◆ mandatoryQueueLatency()

virtual Cycles AbstractController::mandatoryQueueLatency ( const RubyRequestType & param_type )

inlinevirtual

Definition at line 113 of file AbstractController.hh.

References m_mandatory_queue_latency.

Referenced by VIPERCoalescer::invTCP(), VIPERCoalescer::issueRequest(), and Sequencer::issueRequest().

◆ mapAddressToDownstreamMachine()

MachineID AbstractController::mapAddressToDownstreamMachine	(	Addr	addr,
		MachineType	mtype = `MachineType_NUM`
	)		const

Maps an address to the correct dowstream MachineID (i.e.

the component in the next level of the cache hierarchy towards memory)

This function uses the local list of possible destinations instead of querying the network.

Parameters

the	destination address
the	type of the destination (optional)

Returns: the MachineID of the destination

Definition at line 405 of file AbstractController.cc.

References X86ISA::addr, AddrRangeMap< V, max_cache_size >::contains(), downstreamAddrMap, AddrRangeMap< V, max_cache_size >::end(), fatal_if, ArmISA::i, ArmISA::j, and SimObject::name().

◆ mapAddressToMachine()

MachineID AbstractController::mapAddressToMachine	(	Addr	addr,
		MachineType	mtype
	)		const

Map an address to the correct MachineID.

This function querries the network for the NodeID of the destination for a given request using its address and the type of the destination. For example for a request with a given address to a directory it will return the MachineID of the authorative directory.

Parameters

the	destination address
the	type of the destination

Returns: the MachineID of the destination

Definition at line 397 of file AbstractController.cc.

References X86ISA::addr, Network::addressToNodeID(), and m_net_ptr.

Referenced by RubyPort::MemResponsePort::recvAtomic().

◆ notifyCoalesced()

virtual void AbstractController::notifyCoalesced	(	const Addr &	addr,
		const RubyRequestType &	type,
		const RequestPtr &	req,
		const DataBlock &	data_blk,
		const bool &	was_miss
	)

inlinevirtual

Notifies controller of a request coalesced at the sequencer.

By default, it does nothing. Behavior is protocol-specific

Definition at line 142 of file AbstractController.hh.

Referenced by Sequencer::hitCallback().

◆ outgoingTransactionEnd()

void AbstractController::outgoingTransactionEnd	(	Addr	addr,
		bool	retried
	)

inlineprotected

Profiles the end of an outgoing transaction.

(e.g. receiving the response for a requests)

Parameters

addr	address of the line with an outstanding transaction

Definition at line 283 of file AbstractController.hh.

References X86ISA::addr, curTick(), m_outTrans, AbstractController::ControllerStats::outTransLatHist, AbstractController::ControllerStats::outTransLatHistRetries, stats, and Clocked::ticksToCycles().

◆ outgoingTransactionStart()

template<typename EventType >

void AbstractController::outgoingTransactionStart	(	Addr	addr,
		EventType	type
	)

inlineprotected

Profiles an event that initiates a transaction in a peer controller (e.g.

an event that sends a request message)

Parameters

addr	address of the line
type	event that started the transaction

Definition at line 271 of file AbstractController.hh.

References X86ISA::addr, curTick(), m_outTrans, and X86ISA::type.

◆ PARAMS()

AbstractController::PARAMS ( RubyController )

◆ print()

virtual void AbstractController::print ( std::ostream & out ) const

pure virtual

Implements Consumer.

◆ profileMsgDelay()

void AbstractController::profileMsgDelay	(	uint32_t	virtualNetwork,
		Cycles	delay
	)

protected

Profiles the delay associated with messages.

Definition at line 124 of file AbstractController.cc.

References AbstractController::ControllerStats::delayHistogram, AbstractController::ControllerStats::delayVCHistogram, Stats::DistBase< Derived, Stor >::sample(), and stats.

◆ profileRequest()

void AbstractController::profileRequest ( const std::string & request )

protected

Profiles original cache requests including PUTs.

◆ recordCacheTrace()

virtual void AbstractController::recordCacheTrace	(	int	cntrl,
		CacheRecorder *	tr
	)

pure virtual

◆ recvAtomic()

Tick AbstractController::recvAtomic ( PacketPtr pkt )

Definition at line 391 of file AbstractController.cc.

References memoryPort, RequestPort::sendAtomic(), and Clocked::ticksToCycles().

Referenced by RubyPort::MemResponsePort::recvAtomic().

◆ recvTimingResp()

void AbstractController::recvTimingResp ( PacketPtr pkt )

Definition at line 359 of file AbstractController.cc.

References Clocked::clockEdge(), Clocked::cyclesToTicks(), MessageBuffer::enqueue(), Packet::getAddr(), RubySystem::getBlockSizeBytes(), getMemRespQueue(), Packet::getPtr(), Packet::isRead(), Packet::isResponse(), Packet::isWrite(), m_machineID, panic, ArmISA::s, and Packet::senderState.

Referenced by AbstractController::MemoryPort::recvTimingResp(), and serviceMemoryQueue().

◆ regStats()

void AbstractController::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 Stats::Group.

Definition at line 118 of file AbstractController.cc.

References Stats::Group::regStats().

◆ resetStats()

void AbstractController::resetStats ( )

pure virtual

Callback to reset stats.

Reimplemented from Stats::Group.

Definition at line 108 of file AbstractController.cc.

References AbstractController::ControllerStats::delayHistogram, AbstractController::ControllerStats::delayVCHistogram, Network::getNumberOfVirtualNetworks(), ArmISA::i, Stats::DistBase< Derived, Stor >::reset(), and stats.

◆ respondsTo()

bool AbstractController::respondsTo ( Addr addr )

inline

Definition at line 175 of file AbstractController.hh.

References X86ISA::addr, and addrRanges.

◆ serviceMemoryQueue()

bool AbstractController::serviceMemoryQueue ( )

protected

◆ stallBuffer()

void AbstractController::stallBuffer	(	MessageBuffer *	buf,
		Addr	addr
	)

protected

Definition at line 132 of file AbstractController.cc.

References X86ISA::addr, DPRINTF, m_cur_in_port, m_in_ports, and m_waiting_buffers.

◆ unblock()

void AbstractController::unblock ( Addr addr )

Definition at line 319 of file AbstractController.cc.

References X86ISA::addr, m_block_map, and m_is_blocking.

Referenced by Sequencer::writeCallback().

◆ wakeup()

virtual void AbstractController::wakeup ( )

pure virtual

Implements Consumer.

◆ wakeUpAllBuffers() [1/2]

void AbstractController::wakeUpAllBuffers ( )

protected

Definition at line 209 of file AbstractController.cc.

References Clocked::clockEdge(), and m_waiting_buffers.

◆ wakeUpAllBuffers() [2/2]

void AbstractController::wakeUpAllBuffers ( Addr addr )

protected

Definition at line 189 of file AbstractController.cc.

References X86ISA::addr, Clocked::clockEdge(), m_in_ports, and m_waiting_buffers.

◆ wakeUpBuffer()

void AbstractController::wakeUpBuffer	(	MessageBuffer *	buf,
		Addr	addr
	)

protected

Definition at line 146 of file AbstractController.cc.

References X86ISA::addr, Clocked::clockEdge(), m_waiting_buffers, and MessageBuffer::reanalyzeMessages().

◆ wakeUpBuffers()

void AbstractController::wakeUpBuffers ( Addr addr )

protected

Definition at line 168 of file AbstractController.cc.

References X86ISA::addr, Clocked::clockEdge(), m_cur_in_port, and m_waiting_buffers.

Member Data Documentation

◆ addrRanges

const AddrRangeList AbstractController::addrRanges

private

The address range to which the controller responds on the CPU side.

Definition at line 364 of file AbstractController.hh.

Referenced by getAddrRanges(), and respondsTo().

◆ downstreamAddrMap

AddrRangeMap<AddrMapEntry, 3> AbstractController::downstreamAddrMap

private

Definition at line 368 of file AbstractController.hh.

Referenced by init(), and mapAddressToDownstreamMachine().

◆ downstreamDestinations

NetDest AbstractController::downstreamDestinations

private

Definition at line 370 of file AbstractController.hh.

Referenced by allDownstreamDest(), and init().

◆ m_block_map

std::map<Addr, MessageBuffer*> AbstractController::m_block_map

protected

Definition at line 311 of file AbstractController.hh.

Referenced by blockOnQueue(), isBlocked(), and unblock().

◆ m_buffer_size

const unsigned int AbstractController::m_buffer_size

protected

Definition at line 322 of file AbstractController.hh.

◆ m_clusterID

const NodeID AbstractController::m_clusterID

protected

Definition at line 304 of file AbstractController.hh.

◆ m_cur_in_port

unsigned int AbstractController::m_cur_in_port

protected

Definition at line 319 of file AbstractController.hh.

Referenced by stallBuffer(), and wakeUpBuffers().

◆ m_id

const RequestorID AbstractController::m_id

protected

Definition at line 307 of file AbstractController.hh.

Referenced by getRequestorId(), and serviceMemoryQueue().

◆ m_in_ports

unsigned int AbstractController::m_in_ports

protected

Definition at line 318 of file AbstractController.hh.

Referenced by stallBuffer(), and wakeUpAllBuffers().

◆ m_inTrans

std::unordered_map<Addr, TransMapPair> AbstractController::m_inTrans

protected

Definition at line 221 of file AbstractController.hh.

Referenced by incomingTransactionEnd(), and incomingTransactionStart().

◆ m_is_blocking

bool AbstractController::m_is_blocking

protected

Definition at line 310 of file AbstractController.hh.

Referenced by blockOnQueue(), isBlocked(), and unblock().

◆ m_machineID

MachineID AbstractController::m_machineID

protected

Definition at line 303 of file AbstractController.hh.

Referenced by getMachineID(), getType(), getVersion(), and recvTimingResp().

◆ m_mandatory_queue_latency

const Cycles AbstractController::m_mandatory_queue_latency

protected

Definition at line 324 of file AbstractController.hh.

Referenced by mandatoryQueueLatency().

◆ m_net_ptr

Network* AbstractController::m_net_ptr

protected

Definition at line 309 of file AbstractController.hh.

Referenced by initNetworkPtr(), and mapAddressToMachine().

◆ m_number_of_TBEs

const int AbstractController::m_number_of_TBEs

protected

Definition at line 320 of file AbstractController.hh.

◆ m_outTrans

std::unordered_map<Addr, TransMapPair> AbstractController::m_outTrans

protected

Definition at line 222 of file AbstractController.hh.

Referenced by outgoingTransactionEnd(), and outgoingTransactionStart().

◆ m_recycle_latency

Cycles AbstractController::m_recycle_latency

protected

Definition at line 323 of file AbstractController.hh.

◆ m_transitions_per_cycle

const int AbstractController::m_transitions_per_cycle

protected

Definition at line 321 of file AbstractController.hh.

◆ m_version

const NodeID AbstractController::m_version

protected

Definition at line 302 of file AbstractController.hh.

Referenced by AbstractController().

◆ m_waiting_buffers

WaitingBufType AbstractController::m_waiting_buffers

protected

Definition at line 316 of file AbstractController.hh.

Referenced by stallBuffer(), wakeUpAllBuffers(), wakeUpBuffer(), and wakeUpBuffers().

◆ memoryPort

MemoryPort AbstractController::memoryPort

protected

Definition at line 350 of file AbstractController.hh.

Referenced by functionalMemoryRead(), functionalMemoryWrite(), getPort(), recvAtomic(), and serviceMemoryQueue().

◆ stats

AbstractController::ControllerStats AbstractController::stats

Referenced by getDelayHist(), getDelayVCHist(), incomingTransactionEnd(), incomingTransactionStart(), init(), outgoingTransactionEnd(), profileMsgDelay(), and resetStats().

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

mem/ruby/slicc_interface/AbstractController.hh
mem/ruby/slicc_interface/AbstractController.cc

Classes

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AddrMapEntry

◆ MsgBufType

◆ MsgVecType

◆ WaitingBufType

Constructor & Destructor Documentation

◆ AbstractController()

Member Function Documentation

◆ allDownstreamDest()

◆ blockOnQueue()

◆ collateStats()

◆ enqueuePrefetch()

◆ functionalMemoryRead()

◆ functionalMemoryWrite()

◆ functionalRead() [1/2]

◆ functionalRead() [2/2]

◆ functionalReadBuffers() [1/2]

◆ functionalReadBuffers() [2/2]

◆ functionalWrite()

◆ functionalWriteBuffers()

◆ getAccessPermission()

◆ getAddrRanges()

◆ getCPUSequencer()

◆ getDelayHist()

◆ getDelayVCHist()

◆ getDMASequencer()

◆ getGPUCoalescer()

◆ getMachineID()

◆ getMandatoryQueue()

◆ getMemReqQueue()

◆ getMemRespQueue()

◆ getPort()

◆ getRequestorId()

◆ getType()

◆ getVersion()

◆ incomingTransactionEnd()

◆ incomingTransactionStart()

◆ init()

◆ initNetQueues()

◆ initNetworkPtr()

◆ isBlocked() [1/2]

◆ isBlocked() [2/2]

◆ mandatoryQueueLatency()

◆ mapAddressToDownstreamMachine()

◆ mapAddressToMachine()

◆ notifyCoalesced()

◆ outgoingTransactionEnd()

◆ outgoingTransactionStart()

◆ PARAMS()

◆ print()

◆ profileMsgDelay()

◆ profileRequest()

◆ recordCacheTrace()

◆ recvAtomic()

◆ recvTimingResp()

◆ regStats()

◆ resetStats()

◆ respondsTo()

◆ serviceMemoryQueue()

◆ stallBuffer()

◆ unblock()

◆ wakeup()

◆ wakeUpAllBuffers() [1/2]

◆ wakeUpAllBuffers() [2/2]

◆ wakeUpBuffer()

◆ wakeUpBuffers()

Member Data Documentation

◆ addrRanges

◆ downstreamAddrMap

◆ downstreamDestinations