The communication monitor is a MemObject which can monitor statistics of the communication happening between two ports in the memory system. More...

#include <comm_monitor.hh>

Inheritance diagram for CommMonitor:

Classes
class	CommMonitorSenderState
	Sender state class for the monitor so that we can annotate packets with a transmit time and receive time. More...

class	MonitorMasterPort
	This is the master port of the communication monitor. More...

class	MonitorSlavePort
	This is the slave port of the communication monitor. More...

struct	MonitorStats
	Stats declarations, all in a struct for convenience. More...

Public Types
typedef CommMonitorParams	Params
	Parameters of communication monitor. More...

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

Public Member Functions
const Params *	params () const

	CommMonitor (Params *params)
	Constructor based on the Python params. More...

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

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

void	startup () override
	startup() is the final initialization call before simulation. More...

void	regProbePoints () override
	Register probe points for this object. More...

BaseMasterPort &	getMasterPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a master port with a given name and index. More...

BaseSlavePort &	getSlavePort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a slave port with a given name and index. 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	regProbeListeners ()
	Register probe listeners for this object. More...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. 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 Attributes
Memory system probe points
ProbePoints::PacketUPtr	ppPktReq
	Successfully forwarded request packet. More...

ProbePoints::PacketUPtr	ppPktResp
	Successfully forwarded response packet. More...

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

Private Member Functions
void	recvFunctional (PacketPtr pkt)

void	recvFunctionalSnoop (PacketPtr pkt)

Tick	recvAtomic (PacketPtr pkt)

Tick	recvAtomicSnoop (PacketPtr pkt)

bool	recvTimingReq (PacketPtr pkt)

bool	recvTimingResp (PacketPtr pkt)

void	recvTimingSnoopReq (PacketPtr pkt)

bool	recvTimingSnoopResp (PacketPtr pkt)

void	recvRetrySnoopResp ()

AddrRangeList	getAddrRanges () const

bool	isSnooping () const

void	recvReqRetry ()

void	recvRespRetry ()

void	recvRangeChange ()

void	samplePeriodic ()
	This function is called periodically at the end of each time bin. More...

Private Attributes
MonitorMasterPort	masterPort
	Instance of master port, facing the memory side. More...

MonitorSlavePort	slavePort
	Instance of slave port, i.e. More...

EventWrapper< CommMonitor,&CommMonitor::samplePeriodic >	samplePeriodicEvent
	Periodic event called at the end of each simulation time bin. More...

MonitorStats	stats
	Instantiate stats. More...

Configuration
const Tick	samplePeriodTicks
	Length of simulation time bin. More...

const double	samplePeriod
	Sample period in seconds. More...

Additional Inherited Members
Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it. More...

Static Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	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

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

Detailed Description

The communication monitor is a MemObject which can monitor statistics of the communication happening between two ports in the memory system.

Currently the following stats are implemented: Histograms of read/write transactions, read/write burst lengths, read/write bandwidth, outstanding read/write requests, read latency and inter transaction time (read-read, write-write, read/write-read/write). Furthermore it allows to capture the number of accesses to an address over time ("heat map"). All stats can be disabled from Python.

Definition at line 64 of file comm_monitor.hh.

Member Typedef Documentation

typedef CommMonitorParams CommMonitor::Params

Parameters of communication monitor.

Definition at line 70 of file comm_monitor.hh.

Constructor & Destructor Documentation

CommMonitor::CommMonitor ( Params * params )

Constructor based on the Python params.

Parameters

params Python parameters

Definition at line 51 of file comm_monitor.cc.

References DPRINTF, SimObject::name(), samplePeriod, and samplePeriodTicks.

Member Function Documentation

AddrRangeList CommMonitor::getAddrRanges ( ) const

private

Definition at line 359 of file comm_monitor.cc.

References MasterPort::getAddrRanges(), and masterPort.

Referenced by CommMonitor::MonitorSlavePort::getAddrRanges().

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

overridevirtual

Get a master 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 87 of file comm_monitor.cc.

References MemObject::getMasterPort(), and masterPort.

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

overridevirtual

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 97 of file comm_monitor.cc.

References MemObject::getSlavePort(), and slavePort.

void CommMonitor::init ( )

overridevirtual

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 72 of file comm_monitor.cc.

References fatal, BaseMasterPort::isConnected(), BaseSlavePort::isConnected(), masterPort, and slavePort.

bool CommMonitor::isSnooping ( ) const

private

Definition at line 352 of file comm_monitor.cc.

References SlavePort::isSnooping(), and slavePort.

Referenced by CommMonitor::MonitorMasterPort::isSnooping().

const Params* CommMonitor::params ( ) const

inline

Definition at line 71 of file comm_monitor.hh.

References SimObject::_params.

Referenced by regStats().

Tick CommMonitor::recvAtomic ( PacketPtr pkt )

private

Definition at line 218 of file comm_monitor.cc.

References Packet::cacheResponding(), Packet::isResponse(), masterPort, Packet::needsResponse(), ppPktReq, ppPktResp, MasterPort::sendAtomic(), stats, CommMonitor::MonitorStats::updateReqStats(), and CommMonitor::MonitorStats::updateRespStats().

Referenced by CommMonitor::MonitorSlavePort::recvAtomic().

Tick CommMonitor::recvAtomicSnoop ( PacketPtr pkt )

private

Definition at line 238 of file comm_monitor.cc.

References SlavePort::sendAtomicSnoop(), and slavePort.

Referenced by CommMonitor::MonitorMasterPort::recvAtomicSnoop().

void CommMonitor::recvFunctional ( PacketPtr pkt )

private

Definition at line 107 of file comm_monitor.cc.

References masterPort, and MasterPort::sendFunctional().

Referenced by CommMonitor::MonitorSlavePort::recvFunctional().

void CommMonitor::recvFunctionalSnoop ( PacketPtr pkt )

private

Definition at line 113 of file comm_monitor.cc.

References SlavePort::sendFunctionalSnoop(), and slavePort.

Referenced by CommMonitor::MonitorMasterPort::recvFunctionalSnoop().

void CommMonitor::recvRangeChange ( )

private

Definition at line 378 of file comm_monitor.cc.

References SlavePort::sendRangeChange(), and slavePort.

Referenced by CommMonitor::MonitorMasterPort::recvRangeChange().

void CommMonitor::recvReqRetry ( )

private

Definition at line 366 of file comm_monitor.cc.

References SlavePort::sendRetryReq(), and slavePort.

Referenced by CommMonitor::MonitorMasterPort::recvReqRetry().

void CommMonitor::recvRespRetry ( )

private

Definition at line 372 of file comm_monitor.cc.

References masterPort, and MasterPort::sendRetryResp().

Referenced by CommMonitor::MonitorSlavePort::recvRespRetry().

void CommMonitor::recvRetrySnoopResp ( )

private

Definition at line 346 of file comm_monitor.cc.

References SlavePort::sendRetrySnoopResp(), and slavePort.

Referenced by CommMonitor::MonitorMasterPort::recvRetrySnoopResp().

bool CommMonitor::recvTimingReq ( PacketPtr pkt )

private

Definition at line 244 of file comm_monitor.cc.

References Packet::cacheResponding(), curTick(), CommMonitor::MonitorStats::disableLatencyHists, DPRINTF, Packet::isRead(), Packet::isRequest(), Packet::isWrite(), masterPort, Packet::needsResponse(), Packet::popSenderState(), ppPktReq, Packet::pushSenderState(), MasterPort::sendTimingReq(), stats, and CommMonitor::MonitorStats::updateReqStats().

Referenced by CommMonitor::MonitorSlavePort::recvTimingReq().

bool CommMonitor::recvTimingResp ( PacketPtr pkt )

private

Definition at line 285 of file comm_monitor.cc.

References curTick(), CommMonitor::MonitorStats::disableLatencyHists, DPRINTF, Packet::isRead(), Packet::isResponse(), Packet::isWrite(), panic, ppPktResp, Packet::SenderState::predecessor, Packet::senderState, SlavePort::sendTimingResp(), slavePort, stats, CommMonitor::CommMonitorSenderState::transmitTime, and CommMonitor::MonitorStats::updateRespStats().

Referenced by CommMonitor::MonitorMasterPort::recvTimingResp().

void CommMonitor::recvTimingSnoopReq ( PacketPtr pkt )

private

Definition at line 334 of file comm_monitor.cc.

References SlavePort::sendTimingSnoopReq(), and slavePort.

Referenced by CommMonitor::MonitorMasterPort::recvTimingSnoopReq().

bool CommMonitor::recvTimingSnoopResp ( PacketPtr pkt )

private

Definition at line 340 of file comm_monitor.cc.

References masterPort, and MasterPort::sendTimingSnoopResp().

Referenced by CommMonitor::MonitorSlavePort::recvTimingSnoopResp().

void CommMonitor::regProbePoints ( )

overridevirtual

Register probe points for this object.

No probe points by default, so do nothing in base.

Reimplemented from SimObject.

Definition at line 80 of file comm_monitor.cc.

References SimObject::getProbeManager(), ppPktReq, and ppPktResp.

void CommMonitor::regStats ( )

overridevirtual

Register statistics for this object.

Reimplemented from SimObject.

Definition at line 384 of file comm_monitor.cc.

void CommMonitor::samplePeriodic ( )

private

This function is called periodically at the end of each time bin.

Definition at line 512 of file comm_monitor.cc.

void CommMonitor::startup ( )

overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from SimObject.

Definition at line 550 of file comm_monitor.cc.

References curTick(), samplePeriodicEvent, samplePeriodTicks, and EventManager::schedule().