#include <inst_pb_trace.hh>

Inheritance diagram for Trace::InstPBTrace:

Public Member Functions
	InstPBTrace (const InstPBTraceParams *p)

virtual	~InstPBTrace ()

InstPBTraceRecord *	getInstRecord (Tick when, ThreadContext *tc, const StaticInstPtr si, TheISA::PCState pc, const StaticInstPtr mi=NULL) override

Public Member Functions inherited from Trace::InstTracer
	InstTracer (const Params *p)

virtual	~InstTracer ()

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

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

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

virtual Port &	getPort (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
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. 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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Protected Member Functions
void	createTraceFile (std::string filename)
	Create the output file and write the header into it. More...

void	closeStreams ()
	If there is a pending message still write it out and then close the file. More...

void	traceInst (ThreadContext *tc, StaticInstPtr si, TheISA::PCState pc)
	Write an instruction to the trace file. More...

void	traceMem (StaticInstPtr si, Addr a, Addr s, unsigned f)
	Write a memory request to the trace file as part of the cur instruction. More...

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
std::unique_ptr< uint8_t[]>	buf

size_t	bufSize

ProtoMessage::Inst *	curMsg
	This is the message were working on writing. More...

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

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

Static Protected Attributes
static ProtoOutputStream *	traceStream
	One output stream for the entire simulation. More...

Friends
class	InstPBTraceRecord

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 SimObject *	find (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)

Detailed Description

Definition at line 83 of file inst_pb_trace.hh.

Constructor & Destructor Documentation

◆ InstPBTrace()

Trace::InstPBTrace::InstPBTrace ( const InstPBTraceParams * p )

Definition at line 69 of file inst_pb_trace.cc.

References createTraceFile(), and MipsISA::p.

◆ ~InstPBTrace()

Trace::InstPBTrace::~InstPBTrace ( )

virtual

Definition at line 113 of file inst_pb_trace.cc.

References closeStreams().

Member Function Documentation

◆ closeStreams()

void Trace::InstPBTrace::closeStreams ( )

protected

If there is a pending message still write it out and then close the file.

Definition at line 98 of file inst_pb_trace.cc.

References curMsg, traceStream, and ProtoOutputStream::write().

Referenced by createTraceFile(), and ~InstPBTrace().

◆ createTraceFile()

void Trace::InstPBTrace::createTraceFile ( std::string filename )

protected

Create the output file and write the header into it.

Parameters

filename the file to create (if ends with .gz it will be compressed)

Definition at line 77 of file inst_pb_trace.cc.

References closeStreams(), SimClock::Frequency, registerExitCallback(), OutputDirectory::resolve(), simout, traceStream, and ProtoOutputStream::write().

Referenced by InstPBTrace().

◆ getInstRecord()

InstPBTraceRecord * Trace::InstPBTrace::getInstRecord	(	Tick	when,
		ThreadContext *	tc,
		const StaticInstPtr	si,
		TheISA::PCState	pc,
		const StaticInstPtr	mi = `NULL`
	)

overridevirtual

Implements Trace::InstTracer.

Definition at line 119 of file inst_pb_trace.cc.

References InstPBTraceRecord, ArmISA::mi, MipsISA::pc, and ArmISA::si.

◆ traceInst()

void Trace::InstPBTrace::traceInst	(	ThreadContext *	tc,
		StaticInstPtr	si,
		TheISA::PCState	pc
	)

protected

Write an instruction to the trace file.

Parameters

tc	thread context for the cpu ID
si	for the machInst and opClass
pc	for the PC Addr

Todo:: if we are running multi-threaded I assume we'd need a lock here

Definition at line 131 of file inst_pb_trace.cc.

References buf, bufSize, ThreadContext::cpuId(), curMsg, curTick(), letoh(), MipsISA::pc, ArmISA::si, traceStream, and ProtoOutputStream::write().

Referenced by Trace::InstPBTraceRecord::dump().

◆ traceMem()

void Trace::InstPBTrace::traceMem	(	StaticInstPtr	si,
		Addr	a,
		Addr	s,
		unsigned	f
	)

protected

Write a memory request to the trace file as part of the cur instruction.

Parameters

si	for the machInst and opClass
a	address of the request
s	size of the request
f	flags for the request

Definition at line 162 of file inst_pb_trace.cc.

References ArmISA::a, curMsg, ArmISA::f, panic_if, ArmISA::s, and ArmISA::si.

Referenced by Trace::InstPBTraceRecord::dump().

Friends And Related Function Documentation

◆ InstPBTraceRecord

friend class InstPBTraceRecord

friend

Definition at line 133 of file inst_pb_trace.hh.

Referenced by getInstRecord().

Member Data Documentation

◆ buf

std::unique_ptr<uint8_t []> Trace::InstPBTrace::buf

protected

Definition at line 94 of file inst_pb_trace.hh.

Referenced by traceInst().

◆ bufSize

size_t Trace::InstPBTrace::bufSize

protected

Definition at line 95 of file inst_pb_trace.hh.

Referenced by traceInst().

◆ curMsg

ProtoMessage::Inst* Trace::InstPBTrace::curMsg

protected

This is the message were working on writing.

The majority of the message exists however the memory accesses will be delayed.

Definition at line 106 of file inst_pb_trace.hh.

Referenced by closeStreams(), traceInst(), and traceMem().

◆ traceStream

ProtoOutputStream * Trace::InstPBTrace::traceStream

staticprotected

One output stream for the entire simulation.

We encode the CPU & system ID so all we need is a single file

Definition at line 100 of file inst_pb_trace.hh.

Referenced by closeStreams(), createTraceFile(), and traceInst().

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

cpu/inst_pb_trace.hh
cpu/inst_pb_trace.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InstPBTrace()

◆ ~InstPBTrace()

Member Function Documentation

◆ closeStreams()

◆ createTraceFile()

◆ getInstRecord()

◆ traceInst()

◆ traceMem()

Friends And Related Function Documentation

◆ InstPBTraceRecord

Member Data Documentation

◆ buf

◆ bufSize

◆ curMsg

◆ traceStream