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

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	CommMonitor (const Params &params)
	Constructor based on the Python params.

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

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

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

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () const

void	schedule (Event &event, Tick when)

void	deschedule (Event &event)

void	reschedule (Event &event, Tick when, bool always=false)

void	schedule (Event *event, Tick when)

void	deschedule (Event *event)

void	reschedule (Event *event, Tick when, bool always=false)

void	wakeupEventQueue (Tick when=(Tick) -1)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from gem5::Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Member Functions inherited from gem5::Drainable
DrainState	drainState () const
	Return the current drain state of an object.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from gem5::Named
	Named (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Protected Attributes
Memory system probe points
probing::PacketUPtr	ppPktReq
	Successfully forwarded request packet.

probing::PacketUPtr	ppPktResp
	Successfully forwarded response packet.

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

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.

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

MonitorResponsePort	cpuSidePort
	Instance of response port, i.e.

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

MonitorStats	stats
	Instantiate stats.

Configuration
const Tick	samplePeriodTicks
	Length of simulation time bin.

const double	samplePeriod
	Sample period in seconds.

Additional Inherited Members
Static Public Member Functions inherited from gem5::SimObject
static void	serializeAll (const std::string &cpt_dir)
	Create a checkpoint by serializing all SimObjects in the system.

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

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

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 63 of file comm_monitor.hh.

Member Typedef Documentation

◆ Params

using gem5::CommMonitor::Params = CommMonitorParams

Parameters of communication monitor.

Definition at line 69 of file comm_monitor.hh.

Constructor & Destructor Documentation

◆ CommMonitor()

gem5::CommMonitor::CommMonitor ( const Params & params )

Constructor based on the Python params.

Parameters

params Python parameters

Definition at line 51 of file comm_monitor.cc.

References samplePeriodic().

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::CommMonitor::getAddrRanges ( ) const

private

Definition at line 500 of file comm_monitor.cc.

References gem5::RequestPort::getAddrRanges(), and memSidePort.

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

◆ getPort()

Port & gem5::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 gem5::SimObject.

Definition at line 81 of file comm_monitor.cc.

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

◆ init()

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

Definition at line 66 of file comm_monitor.cc.

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

◆ isSnooping()

bool gem5::CommMonitor::isSnooping ( ) const

private

Definition at line 493 of file comm_monitor.cc.

References cpuSidePort, and gem5::ResponsePort::isSnooping().

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

◆ recvAtomic()

Tick gem5::CommMonitor::recvAtomic ( PacketPtr pkt )

private

Definition at line 358 of file comm_monitor.cc.

References gem5::Packet::cacheResponding(), gem5::Packet::isResponse(), memSidePort, gem5::Packet::needsResponse(), ppPktReq, ppPktResp, gem5::RequestPort::sendAtomic(), stats, gem5::CommMonitor::MonitorStats::updateReqStats(), and gem5::CommMonitor::MonitorStats::updateRespStats().

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

◆ recvAtomicSnoop()

Tick gem5::CommMonitor::recvAtomicSnoop ( PacketPtr pkt )

private

Definition at line 379 of file comm_monitor.cc.

References cpuSidePort, and gem5::ResponsePort::sendAtomicSnoop().

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

◆ recvFunctional()

void gem5::CommMonitor::recvFunctional ( PacketPtr pkt )

private

Definition at line 93 of file comm_monitor.cc.

References memSidePort, and gem5::RequestPort::sendFunctional().

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

◆ recvFunctionalSnoop()

void gem5::CommMonitor::recvFunctionalSnoop ( PacketPtr pkt )

private

Definition at line 99 of file comm_monitor.cc.

References cpuSidePort, and gem5::ResponsePort::sendFunctionalSnoop().

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

◆ recvRangeChange()

void gem5::CommMonitor::recvRangeChange ( )

private

Definition at line 525 of file comm_monitor.cc.

References cpuSidePort, and gem5::ResponsePort::sendRangeChange().

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

◆ recvReqRetry()

void gem5::CommMonitor::recvReqRetry ( )

private

Definition at line 507 of file comm_monitor.cc.

References cpuSidePort, and gem5::ResponsePort::sendRetryReq().

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

◆ recvRespRetry()

void gem5::CommMonitor::recvRespRetry ( )

private

Definition at line 513 of file comm_monitor.cc.

References memSidePort, and gem5::RequestPort::sendRetryResp().

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

◆ recvRetrySnoopResp()

void gem5::CommMonitor::recvRetrySnoopResp ( )

private

Definition at line 487 of file comm_monitor.cc.

References cpuSidePort, and gem5::ResponsePort::sendRetrySnoopResp().

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

◆ recvTimingReq()

bool gem5::CommMonitor::recvTimingReq ( PacketPtr pkt )

private

Definition at line 385 of file comm_monitor.cc.

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

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

◆ recvTimingResp()

bool gem5::CommMonitor::recvTimingResp ( PacketPtr pkt )

private

Definition at line 426 of file comm_monitor.cc.

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

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

◆ recvTimingSnoopReq()

void gem5::CommMonitor::recvTimingSnoopReq ( PacketPtr pkt )

private

Definition at line 475 of file comm_monitor.cc.

References cpuSidePort, and gem5::ResponsePort::sendTimingSnoopReq().

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

◆ recvTimingSnoopResp()

bool gem5::CommMonitor::recvTimingSnoopResp ( PacketPtr pkt )

private

Definition at line 481 of file comm_monitor.cc.

References memSidePort, and gem5::RequestPort::sendTimingSnoopResp().

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

◆ regProbePoints()

void gem5::CommMonitor::regProbePoints ( )

overridevirtual

Register probe points for this object.

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

Reimplemented from gem5::SimObject.

Definition at line 74 of file comm_monitor.cc.

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

◆ samplePeriodic()

void gem5::CommMonitor::samplePeriodic ( )

private

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

Definition at line 531 of file comm_monitor.cc.

Referenced by CommMonitor().

◆ startup()

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

Definition at line 569 of file comm_monitor.cc.

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

◆ tryTiming()

bool gem5::CommMonitor::tryTiming ( PacketPtr pkt )

private

Definition at line 519 of file comm_monitor.cc.

References memSidePort, and gem5::RequestPort::tryTiming().

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

Member Data Documentation

◆ cpuSidePort

MonitorResponsePort gem5::CommMonitor::cpuSidePort

private

Instance of response port, i.e.

on the CPU side

Definition at line 240 of file comm_monitor.hh.

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

◆ memSidePort

MonitorRequestPort gem5::CommMonitor::memSidePort

private

Instance of request port, facing the memory side.

Definition at line 179 of file comm_monitor.hh.

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

◆ ppPktReq

probing::PacketUPtr gem5::CommMonitor::ppPktReq

protected

Successfully forwarded request packet.

Definition at line 423 of file comm_monitor.hh.

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

◆ ppPktResp

probing::PacketUPtr gem5::CommMonitor::ppPktResp

protected

Successfully forwarded response packet.

Definition at line 426 of file comm_monitor.hh.

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

◆ samplePeriod

const double gem5::CommMonitor::samplePeriod

private

Sample period in seconds.

Definition at line 409 of file comm_monitor.hh.

Referenced by samplePeriodic().

◆ samplePeriodicEvent

EventFunctionWrapper gem5::CommMonitor::samplePeriodicEvent

private

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

Definition at line 399 of file comm_monitor.hh.

Referenced by samplePeriodic(), and startup().

◆ samplePeriodTicks

const Tick gem5::CommMonitor::samplePeriodTicks

private

Length of simulation time bin.

Definition at line 407 of file comm_monitor.hh.

Referenced by samplePeriodic(), and startup().

◆ stats

MonitorStats gem5::CommMonitor::stats

private

Instantiate stats.

Definition at line 414 of file comm_monitor.hh.

Referenced by recvAtomic(), recvTimingReq(), recvTimingResp(), and samplePeriodic().

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