gem5  v20.1.0.0
Classes | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
BaseMemProbe Class Referenceabstract

Base class for memory system probes accepting Packet instances. More...

#include <base.hh>

Inheritance diagram for BaseMemProbe:
SimObject EventManager Serializable Drainable Stats::Group MemFootprintProbe MemTraceProbe StackDistProbe

Classes

class  PacketListener
 

Public Member Functions

 BaseMemProbe (BaseMemProbeParams *params)
 
void regProbeListeners () override
 Register probe listeners for this object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. 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
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 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 InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 

Protected Member Functions

virtual void handleRequest (const ProbePoints::PacketInfo &pkt_info)=0
 Callback to analyse intercepted Packets. More...
 
- 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...
 

Private Attributes

std::vector< std::unique_ptr< PacketListener > > listeners
 

Additional Inherited Members

- 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 SimObjectfind (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 Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Detailed Description

Base class for memory system probes accepting Packet instances.

This is a helper base class for memory system probes that instrument Packet handling. Unlike the ProbeListenerObject base class, this class supports instrumentation of multiple ProbeManager instances. However, it's limited to one probe point name. This enables features like tracing or stack distance analysis of packets from multiple components using the same probe. For example, a stack distance probe could be hooked up to multiple memories in a multi-channel configuration.

Definition at line 61 of file base.hh.

Constructor & Destructor Documentation

◆ BaseMemProbe()

BaseMemProbe::BaseMemProbe ( BaseMemProbeParams *  params)

Definition at line 42 of file base.cc.

Member Function Documentation

◆ handleRequest()

virtual void BaseMemProbe::handleRequest ( const ProbePoints::PacketInfo pkt_info)
protectedpure virtual

Callback to analyse intercepted Packets.

Implemented in MemFootprintProbe, StackDistProbe, and MemTraceProbe.

Referenced by BaseMemProbe::PacketListener::notify().

◆ regProbeListeners()

void BaseMemProbe::regProbeListeners ( )
overridevirtual

Register probe listeners for this object.

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

Reimplemented from SimObject.

Definition at line 48 of file base.cc.

References ArmISA::i, listeners, MipsISA::p, and SimObject::params().

Member Data Documentation

◆ listeners

std::vector<std::unique_ptr<PacketListener> > BaseMemProbe::listeners
private

Definition at line 91 of file base.hh.

Referenced by regProbeListeners().


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

Generated on Wed Sep 30 2020 14:02:21 for gem5 by doxygen 1.8.17