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

Tarmac Parser: this tracer parses an existing Tarmac trace and it diffs it with gem5 simulation status, comparing results and reporting architectural mismatches if any. More...

#include <tarmac_parser.hh>

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

Public Types

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

Public Member Functions

 TarmacParser (const Params &p)
 
virtual ~TarmacParser ()
 
InstRecordgetInstRecord (Tick when, ThreadContext *tc, const StaticInstPtr staticInst, ArmISA::PCState pc, const StaticInstPtr macroStaticInst=NULL)
 
- 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
 

Private Member Functions

void advanceTraceToStartPc ()
 Helper function to advance the trace up to startPc. More...
 

Private Attributes

std::ifstream trace
 TARMAC trace file. More...
 
Addr startPc
 Tracing starts when the PC gets this value for the first time (ignored if 0x0). More...
 
bool exitOnDiff
 If true, the simulation is stopped as the first mismatch is detected. More...
 
bool exitOnInsnDiff
 If true, the simulation is stopped as the first mismatch is detected on PC or opcode. More...
 
bool memWrCheck
 If true, memory write accesses are checked. More...
 
AddrRange ignoredAddrRange
 Ignored addresses (ignored if empty). More...
 
bool cpuId
 If true, the trace format includes the CPU id. More...
 
bool started
 True if tracing has started. More...
 
bool macroopInProgress
 True if a macroop is currently in progress. More...
 

Friends

class TarmacParserRecord
 

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

Detailed Description

Tarmac Parser: this tracer parses an existing Tarmac trace and it diffs it with gem5 simulation status, comparing results and reporting architectural mismatches if any.

Definition at line 214 of file tarmac_parser.hh.

Member Typedef Documentation

◆ Params

typedef TarmacParserParams gem5::Trace::TarmacParser::Params

Definition at line 219 of file tarmac_parser.hh.

Constructor & Destructor Documentation

◆ TarmacParser()

gem5::Trace::TarmacParser::TarmacParser ( const Params p)
inline

◆ ~TarmacParser()

virtual gem5::Trace::TarmacParser::~TarmacParser ( )
inlinevirtual

Definition at line 240 of file tarmac_parser.hh.

References trace.

Member Function Documentation

◆ advanceTraceToStartPc()

void gem5::Trace::TarmacParser::advanceTraceToStartPc ( )
private

Helper function to advance the trace up to startPc.

Definition at line 1326 of file tarmac_parser.cc.

References cpuId, gem5::Trace::TarmacParserRecord::MaxLineLength, panic, gem5::MipsISA::pc, startPc, and trace.

Referenced by TarmacParser().

◆ getInstRecord()

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

Implements gem5::Trace::InstTracer.

Definition at line 246 of file tarmac_parser.hh.

References gem5::MipsISA::pc, started, startPc, and TarmacParserRecord.

Friends And Related Function Documentation

◆ TarmacParserRecord

friend class TarmacParserRecord
friend

Definition at line 216 of file tarmac_parser.hh.

Referenced by getInstRecord().

Member Data Documentation

◆ cpuId

bool gem5::Trace::TarmacParser::cpuId
private

If true, the trace format includes the CPU id.

Definition at line 291 of file tarmac_parser.hh.

Referenced by gem5::Trace::TarmacParserRecord::advanceTrace(), and advanceTraceToStartPc().

◆ exitOnDiff

bool gem5::Trace::TarmacParser::exitOnDiff
private

If true, the simulation is stopped as the first mismatch is detected.

Definition at line 276 of file tarmac_parser.hh.

Referenced by gem5::Trace::TarmacParserRecord::dump(), and TarmacParser().

◆ exitOnInsnDiff

bool gem5::Trace::TarmacParser::exitOnInsnDiff
private

If true, the simulation is stopped as the first mismatch is detected on PC or opcode.

Definition at line 282 of file tarmac_parser.hh.

Referenced by gem5::Trace::TarmacParserRecord::dump(), and TarmacParser().

◆ ignoredAddrRange

AddrRange gem5::Trace::TarmacParser::ignoredAddrRange
private

Ignored addresses (ignored if empty).

Definition at line 288 of file tarmac_parser.hh.

Referenced by gem5::Trace::TarmacParserRecord::readMemNoEffect().

◆ macroopInProgress

bool gem5::Trace::TarmacParser::macroopInProgress
private

True if a macroop is currently in progress.

Definition at line 297 of file tarmac_parser.hh.

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

◆ memWrCheck

bool gem5::Trace::TarmacParser::memWrCheck
private

If true, memory write accesses are checked.

Definition at line 285 of file tarmac_parser.hh.

Referenced by gem5::Trace::TarmacParserRecord::advanceTrace().

◆ started

bool gem5::Trace::TarmacParser::started
private

True if tracing has started.

Definition at line 294 of file tarmac_parser.hh.

Referenced by getInstRecord(), and TarmacParser().

◆ startPc

Addr gem5::Trace::TarmacParser::startPc
private

Tracing starts when the PC gets this value for the first time (ignored if 0x0).

Definition at line 271 of file tarmac_parser.hh.

Referenced by advanceTraceToStartPc(), getInstRecord(), and TarmacParser().

◆ trace

std::ifstream gem5::Trace::TarmacParser::trace
private

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