gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
gem5::CommMonitor Class Reference

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:
gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

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 gem5::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...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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...
 
ProbeManagergetProbeManager ()
 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 gem5::EventManager
EventQueueeventQueue () 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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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 InforesolveStat (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
 
Groupoperator= (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. More...
 
probing::PacketUPtr ppPktResp
 Successfully forwarded response packet. More...
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 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 gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing all SimObjects in the system. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Protected Member Functions inherited from gem5::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 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
paramsPython parameters

Definition at line 51 of file comm_monitor.cc.

References samplePeriodic().

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::CommMonitor::getAddrRanges ( ) const
private

◆ 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_namePort name
idxIndex 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

◆ recvAtomic()

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

◆ recvAtomicSnoop()

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

◆ recvFunctional()

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

◆ recvFunctionalSnoop()

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

◆ recvRangeChange()

void gem5::CommMonitor::recvRangeChange ( )
private

◆ recvReqRetry()

void gem5::CommMonitor::recvReqRetry ( )
private

◆ recvRespRetry()

void gem5::CommMonitor::recvRespRetry ( )
private

◆ recvRetrySnoopResp()

void gem5::CommMonitor::recvRetrySnoopResp ( )
private

◆ recvTimingReq()

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

◆ recvTimingResp()

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

◆ recvTimingSnoopReq()

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

◆ recvTimingSnoopResp()

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

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

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

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

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.


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

Generated on Tue Sep 21 2021 12:27:24 for gem5 by doxygen 1.8.17