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:

Public Types
typedef TarmacTracerParams	Params

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	TarmacTracer (const Params &p)

InstRecord *	getInstRecord (Tick when, ThreadContext *tc, const StaticInstPtr staticInst, const PCStateBase &pc, const StaticInstPtr macroStaticInst=nullptr) override
	Generates a TarmacTracerRecord, depending on the Tarmac version.

std::ostream &	output ()

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

Protected Types
typedef std::unique_ptr< Printable >	PEntryPtr

typedef TarmacTracerRecord::InstPtr	InstPtr

typedef TarmacTracerRecord::MemPtr	MemPtr

typedef TarmacTracerRecord::RegPtr	RegPtr

Protected Attributes
OutputStream *	outstream

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

Tick	endTick

std::vector< InstPtr >	instQueue
	Collection of heterogeneous printable entries: could be representing either instructions, register or memory entries.

std::vector< MemPtr >	memQueue

std::vector< RegPtr >	regQueue

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.

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.

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.

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 93 of file tarmac_tracer.hh.

Member Typedef Documentation

◆ InstPtr

typedef TarmacTracerRecord::InstPtr gem5::trace::TarmacTracer::InstPtr

protected

Definition at line 117 of file tarmac_tracer.hh.

◆ MemPtr

typedef TarmacTracerRecord::MemPtr gem5::trace::TarmacTracer::MemPtr

protected

Definition at line 118 of file tarmac_tracer.hh.

◆ Params

typedef TarmacTracerParams gem5::trace::TarmacTracer::Params

Definition at line 99 of file tarmac_tracer.hh.

◆ PEntryPtr

typedef std::unique_ptr<Printable> gem5::trace::TarmacTracer::PEntryPtr

protected

Definition at line 116 of file tarmac_tracer.hh.

◆ RegPtr

typedef TarmacTracerRecord::RegPtr gem5::trace::TarmacTracer::RegPtr

protected

Definition at line 119 of file tarmac_tracer.hh.

Constructor & Destructor Documentation

◆ TarmacTracer()

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

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

overridevirtual

Generates a TarmacTracerRecord, depending on the Tarmac version.

At the moment supported formats are:

Tarmac
TarmacV8

Implements gem5::trace::InstTracer.

Definition at line 100 of file tarmac_tracer.cc.

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

◆ output()

std::ostream & gem5::trace::TarmacTracer::output ( )

Definition at line 122 of file tarmac_tracer.cc.

References outstream, and gem5::OutputStream::stream().

Referenced by gem5::trace::TarmacTracerRecord::flushQueues().

Friends And Related Symbol Documentation

◆ TarmacTracerRecord

friend class TarmacTracerRecord

friend

Definition at line 95 of file tarmac_tracer.hh.

Referenced by getInstRecord().

◆ TarmacTracerRecordV8

friend class TarmacTracerRecordV8

friend

Definition at line 96 of file tarmac_tracer.hh.

Referenced by getInstRecord().

Member Data Documentation

◆ endTick

Tick gem5::trace::TarmacTracer::endTick

protected

Definition at line 128 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 137 of file tarmac_tracer.hh.

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

◆ memQueue

std::vector<MemPtr> gem5::trace::TarmacTracer::memQueue

protected

Definition at line 138 of file tarmac_tracer.hh.

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

◆ outstream

OutputStream* gem5::trace::TarmacTracer::outstream

protected

Definition at line 121 of file tarmac_tracer.hh.

Referenced by output().

◆ regQueue

std::vector<RegPtr> gem5::trace::TarmacTracer::regQueue

protected

Definition at line 139 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 127 of file tarmac_tracer.hh.

Referenced by TarmacTracer().

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

arch/arm/tracers/tarmac_tracer.hh
arch/arm/tracers/tarmac_tracer.cc

Public Types

Public Member Functions

Protected Types

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ InstPtr

◆ MemPtr

◆ Params

◆ PEntryPtr

◆ RegPtr

Constructor & Destructor Documentation

◆ TarmacTracer()

Member Function Documentation

◆ getInstRecord()

◆ output()

Friends And Related Symbol Documentation

◆ TarmacTracerRecord

◆ TarmacTracerRecordV8

Member Data Documentation

◆ endTick

◆ instQueue

◆ memQueue

◆ outstream

◆ regQueue

◆ startTick