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:

Public Types
typedef TarmacParserParams	Params

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	TarmacParser (const Params &p)

virtual	~TarmacParser ()

InstRecord *	getInstRecord (Tick when, ThreadContext *tc, const StaticInstPtr staticInst, const PCStateBase &pc, const StaticInstPtr macroStaticInst=nullptr) override

Public Member Functions inherited from gem5::trace::InstTracer
	PARAMS (InstTracer)

	InstTracer (const Params &p)

virtual	~InstTracer ()

std::string	disassemble (StaticInstPtr inst, const PCStateBase &pc, const loader::SymbolTable *symtab=nullptr) const

Public Member Functions inherited from gem5::SimObject
const Params &	params () 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.

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

virtual void	startup ()
	startup() is the final initialization call before simulation.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () 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.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	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.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

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.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (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.

Private Attributes
std::ifstream	trace
	TARMAC trace file.

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

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

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

bool	memWrCheck
	If true, memory write accesses are checked.

AddrRange	ignoredAddrRange
	Ignored addresses (ignored if empty).

bool	cpuId
	If true, the trace format includes the CPU id.

bool	started
	True if tracing has started.

bool	macroopInProgress
	True if a macroop is currently in progress.

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.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

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 216 of file tarmac_parser.hh.

Member Typedef Documentation

◆ Params

typedef TarmacParserParams gem5::trace::TarmacParser::Params

Definition at line 221 of file tarmac_parser.hh.

Constructor & Destructor Documentation

◆ TarmacParser()

gem5::trace::TarmacParser::TarmacParser ( const Params & p )

inline

Definition at line 223 of file tarmac_parser.hh.

References advanceTraceToStartPc(), exitOnDiff, exitOnInsnDiff, gem5::MipsISA::p, started, startPc, and trace.

◆ ~TarmacParser()

virtual gem5::trace::TarmacParser::~TarmacParser ( )

inlinevirtual

Definition at line 242 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 1315 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,
		const PCStateBase &	pc,
		const StaticInstPtr	macroStaticInst = nullptr )

inlineoverridevirtual

Implements gem5::trace::InstTracer.

Definition at line 248 of file tarmac_parser.hh.

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

Friends And Related Symbol Documentation

◆ TarmacParserRecord

friend class TarmacParserRecord

friend

Definition at line 218 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 294 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 279 of file tarmac_parser.hh.

Referenced by gem5::trace::TarmacParserRecord::dump(), gem5::trace::TarmacParserRecord::TarmacParserRecordEvent::process(), 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 285 of file tarmac_parser.hh.

Referenced by gem5::trace::TarmacParserRecord::dump(), gem5::trace::TarmacParserRecord::TarmacParserRecordEvent::process(), and TarmacParser().

◆ ignoredAddrRange

AddrRange gem5::trace::TarmacParser::ignoredAddrRange

private

Ignored addresses (ignored if empty).

Definition at line 291 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 300 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 288 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 297 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 274 of file tarmac_parser.hh.

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

◆ trace

std::ifstream gem5::trace::TarmacParser::trace

private

TARMAC trace file.

Definition at line 268 of file tarmac_parser.hh.

Referenced by gem5::trace::TarmacParserRecord::advanceTrace(), advanceTraceToStartPc(), TarmacParser(), and ~TarmacParser().

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

arch/arm/tracers/tarmac_parser.hh
arch/arm/tracers/tarmac_parser.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ TarmacParser()

◆ ~TarmacParser()

Member Function Documentation

◆ advanceTraceToStartPc()

◆ getInstRecord()

Friends And Related Symbol Documentation

◆ TarmacParserRecord

Member Data Documentation

◆ cpuId

◆ exitOnDiff

◆ exitOnInsnDiff

◆ ignoredAddrRange

◆ macroopInProgress

◆ memWrCheck

◆ started

◆ startPc

◆ trace