gem5  v20.1.0.0
Classes | Public Member Functions | Private Attributes | List of all members
SimPoint Class Reference

#include <simpoint.hh>

Inheritance diagram for SimPoint:
ProbeListenerObject SimObject EventManager Serializable Drainable Stats::Group

Classes

struct  BBInfo
 Basic Block information. More...
 

Public Member Functions

 SimPoint (const SimPointParams *params)
 
virtual ~SimPoint ()
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
void profile (const std::pair< SimpleThread *, StaticInstPtr > &)
 Profile basic blocks for SimPoints. More...
 
- Public Member Functions inherited from ProbeListenerObject
 ProbeListenerObject (const ProbeListenerObjectParams *params)
 
virtual ~ProbeListenerObject ()
 
ProbeManagergetProbeManager ()
 
- Public Member Functions inherited from SimObject
const Paramsparams () 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 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
 

Private Attributes

const uint64_t intervalSize
 SimPoint profiling interval size in instructions. More...
 
uint64_t intervalCount
 Inst count in current basic block. More...
 
uint64_t intervalDrift
 Excess inst count from previous interval. More...
 
OutputStreamsimpointStream
 Pointer to SimPoint BBV output stream. More...
 
std::unordered_map< BasicBlockRange, BBInfobbMap
 Hash table containing all previously seen basic blocks. More...
 
BasicBlockRange currentBBV
 Currently executing basic block. More...
 
uint64_t currentBBVInstCount
 inst count in current basic block More...
 

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 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 Attributes inherited from ProbeListenerObject
ProbeManagermanager
 
std::vector< ProbeListener * > listeners
 
- 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

Definition at line 72 of file simpoint.hh.

Constructor & Destructor Documentation

◆ SimPoint()

SimPoint::SimPoint ( const SimPointParams *  params)

Definition at line 42 of file simpoint.cc.

References OutputDirectory::create(), fatal, MipsISA::p, simout, and simpointStream.

◆ ~SimPoint()

SimPoint::~SimPoint ( )
virtual

Definition at line 56 of file simpoint.cc.

References OutputDirectory::close(), simout, and simpointStream.

Member Function Documentation

◆ init()

void SimPoint::init ( )
virtual

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 62 of file simpoint.cc.

◆ profile()

void SimPoint::profile ( const std::pair< SimpleThread *, StaticInstPtr > &  p)

Profile basic blocks for SimPoints.

Called at every macro inst to increment basic block inst counts and to profile block if end of block.

Definition at line 75 of file simpoint.cc.

References bbMap, SimPoint::BBInfo::count, currentBBV, currentBBVInstCount, SimPoint::BBInfo::id, SimPoint::BBInfo::insts, intervalCount, intervalDrift, intervalSize, StaticInst::isControl(), StaticInst::isLastMicroop(), StaticInst::isMicroop(), MipsISA::p, SimpleThread::pcState(), simpointStream, and OutputStream::stream().

Referenced by regProbeListeners().

◆ regProbeListeners()

void SimPoint::regProbeListeners ( )
virtual

Register probe listeners for this object.

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

Reimplemented from SimObject.

Definition at line 66 of file simpoint.cc.

References ProbeListenerObject::listeners, and profile().

Member Data Documentation

◆ bbMap

std::unordered_map<BasicBlockRange, BBInfo> SimPoint::bbMap
private

Hash table containing all previously seen basic blocks.

Definition at line 111 of file simpoint.hh.

Referenced by profile().

◆ currentBBV

BasicBlockRange SimPoint::currentBBV
private

Currently executing basic block.

Definition at line 113 of file simpoint.hh.

Referenced by profile().

◆ currentBBVInstCount

uint64_t SimPoint::currentBBVInstCount
private

inst count in current basic block

Definition at line 115 of file simpoint.hh.

Referenced by profile().

◆ intervalCount

uint64_t SimPoint::intervalCount
private

Inst count in current basic block.

Definition at line 94 of file simpoint.hh.

Referenced by profile().

◆ intervalDrift

uint64_t SimPoint::intervalDrift
private

Excess inst count from previous interval.

Definition at line 96 of file simpoint.hh.

Referenced by profile().

◆ intervalSize

const uint64_t SimPoint::intervalSize
private

SimPoint profiling interval size in instructions.

Definition at line 91 of file simpoint.hh.

Referenced by profile().

◆ simpointStream

OutputStream* SimPoint::simpointStream
private

Pointer to SimPoint BBV output stream.

Definition at line 98 of file simpoint.hh.

Referenced by profile(), SimPoint(), and ~SimPoint().


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

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