gem5  v21.1.0.2
Public Types | Public Member Functions | Protected Types | Protected Attributes | Friends | List of all members
gem5::Trace::TarmacTracer Class Reference

Tarmac Tracer: this tracer generates a new Tarmac Record for every instruction being executed in gem5. More...

#include <tarmac_tracer.hh>

Inheritance diagram for gem5::Trace::TarmacTracer:
gem5::Trace::InstTracer gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Types

typedef TarmacTracerParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 TarmacTracer (const Params &p)
 
InstRecordgetInstRecord (Tick when, ThreadContext *tc, const StaticInstPtr staticInst, ArmISA::PCState pc, const StaticInstPtr macroStaticInst=NULL)
 Generates a TarmacTracerRecord, depending on the Tarmac version. More...
 
- Public Member Functions inherited from gem5::Trace::InstTracer
 InstTracer (const Params &p)
 
virtual ~InstTracer ()
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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...
 
virtual void regProbeListeners ()
 Register probe listeners 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 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 Types

typedef std::unique_ptr< PrintablePEntryPtr
 
typedef TarmacTracerRecord::InstPtr InstPtr
 
typedef TarmacTracerRecord::MemPtr MemPtr
 
typedef TarmacTracerRecord::RegPtr RegPtr
 

Protected Attributes

Tick startTick
 startTick and endTick allow to trace a specific window of ticks rather than the entire CPU execution. More...
 
Tick endTick
 
std::vector< InstPtrinstQueue
 Collection of heterogeneous printable entries: could be representing either instructions, register or memory entries. More...
 
std::vector< MemPtrmemQueue
 
std::vector< RegPtrregQueue
 
- 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...
 

Friends

class TarmacTracerRecord
 
class TarmacTracerRecordV8
 

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

Tarmac Tracer: this tracer generates a new Tarmac Record for every instruction being executed in gem5.

The record is made by a collection of entries which are stored in the tracer queues.

Definition at line 85 of file tarmac_tracer.hh.

Member Typedef Documentation

◆ InstPtr

Definition at line 108 of file tarmac_tracer.hh.

◆ MemPtr

Definition at line 109 of file tarmac_tracer.hh.

◆ Params

typedef TarmacTracerParams gem5::Trace::TarmacTracer::Params

Definition at line 91 of file tarmac_tracer.hh.

◆ PEntryPtr

typedef std::unique_ptr<Printable> gem5::Trace::TarmacTracer::PEntryPtr
protected

Definition at line 107 of file tarmac_tracer.hh.

◆ RegPtr

Definition at line 110 of file tarmac_tracer.hh.

Constructor & Destructor Documentation

◆ TarmacTracer()

gem5::Trace::TarmacTracer::TarmacTracer ( const Params p)

Definition at line 57 of file tarmac_tracer.cc.

References endTick, panic_if, gem5::setDebugFlag(), and startTick.

Member Function Documentation

◆ getInstRecord()

InstRecord * gem5::Trace::TarmacTracer::getInstRecord ( Tick  when,
ThreadContext tc,
const StaticInstPtr  staticInst,
ArmISA::PCState  pc,
const StaticInstPtr  macroStaticInst = NULL 
)
virtual

Generates a TarmacTracerRecord, depending on the Tarmac version.

At the moment supported formats are:

  • Tarmac
  • TarmacV8

Implements gem5::Trace::InstTracer.

Definition at line 77 of file tarmac_tracer.cc.

References endTick, gem5::ArmSystem::highestELIs64(), gem5::MipsISA::pc, TarmacTracerRecord, and TarmacTracerRecordV8.

Friends And Related Function Documentation

◆ TarmacTracerRecord

friend class TarmacTracerRecord
friend

Definition at line 87 of file tarmac_tracer.hh.

Referenced by getInstRecord().

◆ TarmacTracerRecordV8

friend class TarmacTracerRecordV8
friend

Definition at line 88 of file tarmac_tracer.hh.

Referenced by getInstRecord().

Member Data Documentation

◆ endTick

Tick gem5::Trace::TarmacTracer::endTick
protected

Definition at line 117 of file tarmac_tracer.hh.

Referenced by getInstRecord(), and TarmacTracer().

◆ instQueue

std::vector<InstPtr> gem5::Trace::TarmacTracer::instQueue
protected

Collection of heterogeneous printable entries: could be representing either instructions, register or memory entries.

When dealing with MacroInstructions the following separate queues will be used. micro-instruction entries will be buffered and dumped to the tracefile only at the end of the Macro.

Definition at line 126 of file tarmac_tracer.hh.

Referenced by gem5::Trace::TarmacTracerRecord::dump().

◆ memQueue

std::vector<MemPtr> gem5::Trace::TarmacTracer::memQueue
protected

Definition at line 127 of file tarmac_tracer.hh.

Referenced by gem5::Trace::TarmacTracerRecord::dump().

◆ regQueue

std::vector<RegPtr> gem5::Trace::TarmacTracer::regQueue
protected

Definition at line 128 of file tarmac_tracer.hh.

Referenced by gem5::Trace::TarmacTracerRecord::dump().

◆ startTick

Tick gem5::Trace::TarmacTracer::startTick
protected

startTick and endTick allow to trace a specific window of ticks rather than the entire CPU execution.

Definition at line 116 of file tarmac_tracer.hh.

Referenced by TarmacTracer().


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

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