#include <looppoint_analysis.hh>

Inheritance diagram for gem5::LooppointAnalysis:

Public Types
typedef ProbeListenerArg< LooppointAnalysis, std::pair< SimpleThread *, StaticInstPtr > >	looppointAnalysisListener

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	LooppointAnalysis (const LooppointAnalysisParams &params)

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

void	checkPc (const std::pair< SimpleThread *, StaticInstPtr > &inst_pair)
	This function is called when a the probe point notifies the LoopPointAnalysis probe listener.

void	startListening ()
	When this function is called, it sets the class variable ifListening to true, then calls the regProbeListeners() function to register the probe listeners to the probe points,.

void	stopListening ()
	When this function is called, it sets the class variable ifListening to false, then removes the probe listeners from the probe points.

std::unordered_map< Addr, uint64_t >	getLocalBBV () const

void	clearLocalBBV ()

Public Member Functions inherited from gem5::ProbeListenerObject
	ProbeListenerObject (const ProbeListenerObjectParams &params)

virtual	~ProbeListenerObject ()

ProbeManager *	getProbeManager ()

template<typename T, typename... Args>
void	connectListener (Args &&...args)

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.

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 (std::string_view name_)

virtual	~Named ()=default

virtual std::string	name () const

Private Member Functions
void	updateLocalBBV (const Addr pc)
	This function updates the localBBV for the input PC's basic block.

Private Attributes
LooppointAnalysisManager *	lpaManager
	This is the pointer to the LooppointAnalysisManager SimObject that is managing all the LooppointAnalysis ProbeListenerObjects.

AddrRange	bbValidAddrRange
	This is the valid address range for the basic block that the LooppointAnalysis considers analyzing.

AddrRange	markerValidAddrRange
	We only consider the loops within this address range as candidates for marking the execution points.

std::vector< AddrRange >	bbExcludedAddrRanges
	Any basic block that is in this range will not be analyzed.

bool	ifListening
	Only when this is set to true, the LooppointAnalysis will listen to the probe points.

uint64_t	bbInstCounter
	The counter for the number of instructions within the current basic block.

std::unordered_map< Addr, uint64_t >	localBBV
	The basic block vector for the current core that the LooppointAnalysis is attached to.

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::ProbeListenerObject
ProbeManager *	manager

std::vector< ProbeListenerPtr<> >	listeners

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

Definition at line 51 of file looppoint_analysis.hh.

Member Typedef Documentation

◆ looppointAnalysisListener

typedef ProbeListenerArg<LooppointAnalysis, std::pair<SimpleThread*, StaticInstPtr> > gem5::LooppointAnalysis::looppointAnalysisListener

Definition at line 81 of file looppoint_analysis.hh.

Constructor & Destructor Documentation

◆ LooppointAnalysis()

gem5::LooppointAnalysis::LooppointAnalysis ( const LooppointAnalysisParams & params )

Definition at line 34 of file looppoint_analysis.cc.

References bbExcludedAddrRanges, bbInstCounter, bbValidAddrRange, DPRINTF, gem5::ArmISA::i, ifListening, LooppointAnalysis(), lpaManager, markerValidAddrRange, gem5::SimObject::params(), and gem5::ProbeListenerObject::ProbeListenerObject().

Referenced by LooppointAnalysis(), regProbeListeners(), and stopListening().

Member Function Documentation

◆ checkPc()

void gem5::LooppointAnalysis::checkPc ( const std::pair< SimpleThread *, StaticInstPtr > & inst_pair )

This function is called when a the probe point notifies the LoopPointAnalysis probe listener.

Parameters

inst_pair A pair that contains the SimpleThread pointer and the StaticInstPtr of the commited instruction from the atomic CPU.

Definition at line 75 of file looppoint_analysis.cc.

References gem5::PCStateBase::as(), bbExcludedAddrRanges, bbInstCounter, bbValidAddrRange, gem5::SimpleThread::getIsaPtr(), gem5::SimpleThread::getTC(), gem5::ArmISA::i, gem5::BaseISA::inUserMode(), gem5::StaticInst::isControl(), gem5::StaticInst::isDirectCtrl(), gem5::StaticInst::isLastMicroop(), gem5::StaticInst::isMicroop(), lpaManager, markerValidAddrRange, gem5::MipsISA::pc, gem5::ThreadContext::pcState(), and updateLocalBBV().

Referenced by regProbeListeners().

◆ clearLocalBBV()

void gem5::LooppointAnalysis::clearLocalBBV ( )

inline

Definition at line 142 of file looppoint_analysis.hh.

References localBBV.

◆ getLocalBBV()

std::unordered_map< Addr, uint64_t > gem5::LooppointAnalysis::getLocalBBV ( ) const

inline

Definition at line 136 of file looppoint_analysis.hh.

References localBBV.

◆ regProbeListeners()

void gem5::LooppointAnalysis::regProbeListeners ( )

virtual

Register probe listeners for this object.

No probe listeners by default, so do nothing in base.

Reimplemented from gem5::SimObject.

Definition at line 172 of file looppoint_analysis.cc.

References checkPc(), gem5::ProbeListenerObject::connectListener(), DPRINTF, ifListening, gem5::ProbeListenerObject::listeners, and LooppointAnalysis().

Referenced by startListening().

◆ startListening()

void gem5::LooppointAnalysis::startListening ( )

When this function is called, it sets the class variable ifListening to true, then calls the regProbeListeners() function to register the probe listeners to the probe points,.

Definition at line 186 of file looppoint_analysis.cc.

References ifListening, and regProbeListeners().

◆ stopListening()

void gem5::LooppointAnalysis::stopListening ( )

When this function is called, it sets the class variable ifListening to false, then removes the probe listeners from the probe points.

Definition at line 193 of file looppoint_analysis.cc.

References DPRINTF, ifListening, gem5::ProbeListenerObject::listeners, and LooppointAnalysis().

◆ updateLocalBBV()

void gem5::LooppointAnalysis::updateLocalBBV ( const Addr pc )

private

This function updates the localBBV for the input PC's basic block.

Specifically, it increments the count of the input PC's basic block in the localBBV.

Definition at line 65 of file looppoint_analysis.cc.

References localBBV, and gem5::MipsISA::pc.

Referenced by checkPc().

Member Data Documentation

◆ bbExcludedAddrRanges

std::vector<AddrRange> gem5::LooppointAnalysis::bbExcludedAddrRanges

private

Any basic block that is in this range will not be analyzed.

Definition at line 107 of file looppoint_analysis.hh.

Referenced by checkPc(), and LooppointAnalysis().

◆ bbInstCounter

uint64_t gem5::LooppointAnalysis::bbInstCounter

private

The counter for the number of instructions within the current basic block.

Definition at line 119 of file looppoint_analysis.hh.

Referenced by checkPc(), and LooppointAnalysis().

◆ bbValidAddrRange

AddrRange gem5::LooppointAnalysis::bbValidAddrRange

private

This is the valid address range for the basic block that the LooppointAnalysis considers analyzing.

Any basic block that is not in this range will not be analyzed, i.e. counting.

Definition at line 96 of file looppoint_analysis.hh.

Referenced by checkPc(), and LooppointAnalysis().

◆ ifListening

bool gem5::LooppointAnalysis::ifListening

private

Only when this is set to true, the LooppointAnalysis will listen to the probe points.

Definition at line 113 of file looppoint_analysis.hh.

Referenced by LooppointAnalysis(), regProbeListeners(), startListening(), and stopListening().

◆ localBBV

std::unordered_map<Addr, uint64_t> gem5::LooppointAnalysis::localBBV

private

The basic block vector for the current core that the LooppointAnalysis is attached to.

Definition at line 125 of file looppoint_analysis.hh.

Referenced by clearLocalBBV(), getLocalBBV(), and updateLocalBBV().

◆ lpaManager

LooppointAnalysisManager* gem5::LooppointAnalysis::lpaManager

private

This is the pointer to the LooppointAnalysisManager SimObject that is managing all the LooppointAnalysis ProbeListenerObjects.

Definition at line 89 of file looppoint_analysis.hh.

Referenced by checkPc(), and LooppointAnalysis().

◆ markerValidAddrRange

AddrRange gem5::LooppointAnalysis::markerValidAddrRange

private

We only consider the loops within this address range as candidates for marking the execution points.

Definition at line 102 of file looppoint_analysis.hh.

Referenced by checkPc(), and LooppointAnalysis().

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

cpu/simple/probes/looppoint_analysis.hh
cpu/simple/probes/looppoint_analysis.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ looppointAnalysisListener

Constructor & Destructor Documentation

◆ LooppointAnalysis()

Member Function Documentation

◆ checkPc()

◆ clearLocalBBV()

◆ getLocalBBV()

◆ regProbeListeners()

◆ startListening()

◆ stopListening()

◆ updateLocalBBV()

Member Data Documentation

◆ bbExcludedAddrRanges

◆ bbInstCounter

◆ bbValidAddrRange

◆ ifListening

◆ localBBV

◆ lpaManager

◆ markerValidAddrRange