The communication monitor is a SimObject 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	MonitorRequestPort
	This is the request port of the communication monitor. More...

class	MonitorResponsePort
	This is the CPU-side port of the communication monitor. More...

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

Public Types
using	Params = CommMonitorParams
	Parameters of communication monitor. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	CommMonitor (const 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	startup () override
	startup() is the final initialization call before simulation. More...

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

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index. 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	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
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	regStats ()
	Callback to set stat parameters. More...

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

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

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

bool	tryTiming (PacketPtr pkt)

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

Private Attributes
MonitorRequestPort	memSidePort
	Instance of request port, facing the memory side. More...

MonitorResponsePort	cpuSidePort
	Instance of response port, i.e. More...

EventFunctionWrapper	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 ()
	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)

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

Detailed Description

The communication monitor is a SimObject 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 60 of file comm_monitor.hh.

Member Typedef Documentation

◆ Params

using CommMonitor::Params = CommMonitorParams

Parameters of communication monitor.

Definition at line 66 of file comm_monitor.hh.

Constructor & Destructor Documentation

◆ CommMonitor()

CommMonitor::CommMonitor ( const Params & params )

Constructor based on the Python params.

Parameters

params Python parameters

Definition at line 46 of file comm_monitor.cc.

References samplePeriodic().

Member Function Documentation

◆ getAddrRanges()

AddrRangeList CommMonitor::getAddrRanges ( ) const

private

Definition at line 489 of file comm_monitor.cc.

References RequestPort::getAddrRanges(), and memSidePort.

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

◆ getPort()

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

overridevirtual

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

Definition at line 76 of file comm_monitor.cc.

References cpuSidePort, SimObject::getPort(), and memSidePort.

◆ init()

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

References cpuSidePort, fatal, Port::isConnected(), and memSidePort.

◆ isSnooping()

bool CommMonitor::isSnooping ( ) const

private

Definition at line 482 of file comm_monitor.cc.

References cpuSidePort, and ResponsePort::isSnooping().

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

◆ recvAtomic()

Tick CommMonitor::recvAtomic ( PacketPtr pkt )

private

Definition at line 347 of file comm_monitor.cc.

References Packet::cacheResponding(), Packet::isResponse(), memSidePort, Packet::needsResponse(), ppPktReq, ppPktResp, RequestPort::sendAtomic(), and Stats::Group::stats.

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

◆ recvAtomicSnoop()

Tick CommMonitor::recvAtomicSnoop ( PacketPtr pkt )

private

Definition at line 368 of file comm_monitor.cc.

References cpuSidePort, and ResponsePort::sendAtomicSnoop().

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

◆ recvFunctional()

void CommMonitor::recvFunctional ( PacketPtr pkt )

private

Definition at line 88 of file comm_monitor.cc.

References memSidePort, and RequestPort::sendFunctional().

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

◆ recvFunctionalSnoop()

void CommMonitor::recvFunctionalSnoop ( PacketPtr pkt )

private

Definition at line 94 of file comm_monitor.cc.

References cpuSidePort, and ResponsePort::sendFunctionalSnoop().

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

◆ recvRangeChange()

void CommMonitor::recvRangeChange ( )

private

Definition at line 514 of file comm_monitor.cc.

References cpuSidePort, and ResponsePort::sendRangeChange().

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

◆ recvReqRetry()

void CommMonitor::recvReqRetry ( )

private

Definition at line 496 of file comm_monitor.cc.

References cpuSidePort, and ResponsePort::sendRetryReq().

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

◆ recvRespRetry()

void CommMonitor::recvRespRetry ( )

private

Definition at line 502 of file comm_monitor.cc.

References memSidePort, and RequestPort::sendRetryResp().

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

◆ recvRetrySnoopResp()

void CommMonitor::recvRetrySnoopResp ( )

private

Definition at line 476 of file comm_monitor.cc.

References cpuSidePort, and ResponsePort::sendRetrySnoopResp().

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

◆ recvTimingReq()

bool CommMonitor::recvTimingReq ( PacketPtr pkt )

private

Definition at line 374 of file comm_monitor.cc.

References Packet::cacheResponding(), curTick(), DPRINTF, Packet::isRead(), Packet::isRequest(), Packet::isWrite(), memSidePort, Packet::needsResponse(), Packet::popSenderState(), ppPktReq, Packet::pushSenderState(), RequestPort::sendTimingReq(), and Stats::Group::stats.

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

◆ recvTimingResp()

bool CommMonitor::recvTimingResp ( PacketPtr pkt )

private

Definition at line 415 of file comm_monitor.cc.

References cpuSidePort, curTick(), DPRINTF, Packet::isRead(), Packet::isResponse(), Packet::isWrite(), panic, ppPktResp, Packet::SenderState::predecessor, Packet::senderState, ResponsePort::sendTimingResp(), Stats::Group::stats, and CommMonitor::CommMonitorSenderState::transmitTime.

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

◆ recvTimingSnoopReq()

void CommMonitor::recvTimingSnoopReq ( PacketPtr pkt )

private

Definition at line 464 of file comm_monitor.cc.

References cpuSidePort, and ResponsePort::sendTimingSnoopReq().

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

◆ recvTimingSnoopResp()

bool CommMonitor::recvTimingSnoopResp ( PacketPtr pkt )

private

Definition at line 470 of file comm_monitor.cc.

References memSidePort, and RequestPort::sendTimingSnoopResp().

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

◆ regProbePoints()

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

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

◆ samplePeriodic()

void CommMonitor::samplePeriodic ( )

private

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

Definition at line 520 of file comm_monitor.cc.

References curTick(), samplePeriod, samplePeriodicEvent, samplePeriodTicks, EventManager::schedule(), simTicks, Stats::Group::stats, and Stats::ValueBase< Derived >::value().

Referenced by CommMonitor().

◆ startup()

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

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

◆ tryTiming()

bool CommMonitor::tryTiming ( PacketPtr pkt )

private

Definition at line 508 of file comm_monitor.cc.

References memSidePort, and RequestPort::tryTiming().

Referenced by CommMonitor::MonitorResponsePort::tryTiming().

Member Data Documentation

◆ cpuSidePort

MonitorResponsePort CommMonitor::cpuSidePort

private

Instance of response port, i.e.

on the CPU side

Definition at line 237 of file comm_monitor.hh.

Referenced by getPort(), init(), isSnooping(), recvAtomicSnoop(), recvFunctionalSnoop(), recvRangeChange(), recvReqRetry(), recvRetrySnoopResp(), recvTimingResp(), and recvTimingSnoopReq().

◆ memSidePort

MonitorRequestPort CommMonitor::memSidePort

private

Instance of request port, facing the memory side.

Definition at line 176 of file comm_monitor.hh.

Referenced by getAddrRanges(), getPort(), init(), recvAtomic(), recvFunctional(), recvRespRetry(), recvTimingReq(), recvTimingSnoopResp(), and tryTiming().

◆ ppPktReq

ProbePoints::PacketUPtr CommMonitor::ppPktReq

protected

Successfully forwarded request packet.

Definition at line 419 of file comm_monitor.hh.

Referenced by recvAtomic(), recvTimingReq(), and regProbePoints().

◆ ppPktResp

ProbePoints::PacketUPtr CommMonitor::ppPktResp

protected

Successfully forwarded response packet.

Definition at line 422 of file comm_monitor.hh.

Referenced by recvAtomic(), recvTimingResp(), and regProbePoints().

◆ samplePeriod

const double CommMonitor::samplePeriod

private

Sample period in seconds.

Definition at line 405 of file comm_monitor.hh.

Referenced by samplePeriodic().

◆ samplePeriodicEvent

EventFunctionWrapper CommMonitor::samplePeriodicEvent

private

Periodic event called at the end of each simulation time bin.

Definition at line 395 of file comm_monitor.hh.

Referenced by samplePeriodic(), and startup().

◆ samplePeriodTicks

const Tick CommMonitor::samplePeriodTicks

private

Length of simulation time bin.

Definition at line 403 of file comm_monitor.hh.

Referenced by samplePeriodic(), and startup().

◆ stats

MonitorStats CommMonitor::stats

private

Instantiate stats.

Definition at line 410 of file comm_monitor.hh.

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

mem/comm_monitor.hh
mem/comm_monitor.cc

Classes

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ CommMonitor()

Member Function Documentation

◆ getAddrRanges()

◆ getPort()

◆ init()

◆ isSnooping()

◆ recvAtomic()

◆ recvAtomicSnoop()

◆ recvFunctional()

◆ recvFunctionalSnoop()

◆ recvRangeChange()

◆ recvReqRetry()

◆ recvRespRetry()

◆ recvRetrySnoopResp()

◆ recvTimingReq()

◆ recvTimingResp()

◆ recvTimingSnoopReq()

◆ recvTimingSnoopResp()

◆ regProbePoints()

◆ samplePeriodic()

◆ startup()

◆ tryTiming()

Member Data Documentation

◆ cpuSidePort

◆ memSidePort

◆ ppPktReq

◆ ppPktResp

◆ samplePeriod

◆ samplePeriodicEvent

◆ samplePeriodTicks

◆ stats