#include "llvm/CodeGen/MachineTraceMetrics.h"

Inheritance diagram for llvm::MachineTraceMetrics:

[legend]

Classes
class	Ensemble
	A trace ensemble is a collection of traces selected using the same strategy, for example 'minimum resource height'. More...

struct	FixedBlockInfo
	Per-basic block information that doesn't depend on the trace through the block. More...

struct	InstrCycles
	InstrCycles represents the cycle height and depth of an instruction in a trace. More...

struct	LiveInReg
	A virtual register or regunit required by a basic block or its trace successors. More...

class	Trace
	A trace represents a plausible sequence of executed basic blocks that passes through the current basic block one. More...

struct	TraceBlockInfo
	Per-basic block information that relates to a specific trace through the block. More...

Public Member Functions
	MachineTraceMetrics ()

void	getAnalysisUsage (AnalysisUsage &) const override
	getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.

bool	runOnMachineFunction (MachineFunction &) override
	runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis.

void	releaseMemory () override
	releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memory when it is no longer needed.

void	verifyAnalysis () const override
	verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information.

const FixedBlockInfo *	getResources (const MachineBasicBlock *)
	Get the fixed resource information about MBB. Compute it on demand.

ArrayRef< unsigned >	getProcReleaseAtCycles (unsigned MBBNum) const
	Get the scaled number of cycles used per processor resource in MBB.

Ensemble *	getEnsemble (MachineTraceStrategy)
	Get the trace ensemble representing the given trace selection strategy.

void	invalidate (const MachineBasicBlock *MBB)
	Invalidate cached information about MBB.

Public Member Functions inherited from llvm::MachineFunctionPass
bool	doInitialization (Module &) override
	doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run.

Public Member Functions inherited from llvm::FunctionPass
	FunctionPass (char &pid)

Pass *	createPrinterPass (raw_ostream &OS, const std::string &Banner) const override
	createPrinterPass - Get a function printer pass.

virtual bool	runOnFunction (Function &F)=0
	runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass.

void	assignPassManager (PMStack &PMS, PassManagerType T) override
	Find appropriate Function Pass Manager or Call Graph Pass Manager in the PM Stack and add self into that manager.

PassManagerType	getPotentialPassManagerType () const override
	Return what kind of Pass Manager can manage this pass.

Public Member Functions inherited from llvm::Pass
	Pass (PassKind K, char &pid)

	Pass (const Pass &)=delete

Pass &	operator= (const Pass &)=delete

virtual	~Pass ()

PassKind	getPassKind () const

virtual StringRef	getPassName () const
	getPassName - Return a nice clean name for a pass.

AnalysisID	getPassID () const
	getPassID - Return the PassID number that corresponds to this pass.

virtual bool	doInitialization (Module &)
	doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run.

virtual bool	doFinalization (Module &)
	doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run.

virtual void	print (raw_ostream &OS, const Module *M) const
	print - Print out the internal state of the pass.

void	dump () const

virtual Pass *	createPrinterPass (raw_ostream &OS, const std::string &Banner) const =0
	createPrinterPass - Get a Pass appropriate to print the IR this pass operates on (Module, Function or MachineFunction).

virtual void	assignPassManager (PMStack &, PassManagerType)
	Each pass is responsible for assigning a pass manager to itself.

virtual void	preparePassManager (PMStack &)
	Check if available pass managers are suitable for this pass or not.

virtual PassManagerType	getPotentialPassManagerType () const
	Return what kind of Pass Manager can manage this pass.

void	setResolver (AnalysisResolver *AR)

AnalysisResolver *	getResolver () const

virtual void	getAnalysisUsage (AnalysisUsage &) const
	getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.

virtual void	releaseMemory ()
	releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memory when it is no longer needed.

virtual void *	getAdjustedAnalysisPointer (AnalysisID ID)
	getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance.

virtual ImmutablePass *	getAsImmutablePass ()

virtual PMDataManager *	getAsPMDataManager ()

virtual void	verifyAnalysis () const
	verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information.

virtual void	dumpPassStructure (unsigned Offset=0)

template<typename AnalysisType >
AnalysisType *	getAnalysisIfAvailable () const
	getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to get analysis information that might be around, for example to update it.

bool	mustPreserveAnalysisID (char &AID) const
	mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID.

template<typename AnalysisType >
AnalysisType &	getAnalysis () const
	getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function.

template<typename AnalysisType >
AnalysisType &	getAnalysis (Function &F, bool *Changed=nullptr)
	getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function.

template<typename AnalysisType >
AnalysisType &	getAnalysisID (AnalysisID PI) const

template<typename AnalysisType >
AnalysisType &	getAnalysisID (AnalysisID PI, Function &F, bool *Changed=nullptr)

Static Public Attributes
static char	ID = 0

Friends
class	Ensemble

class	Trace

Additional Inherited Members
Static Public Member Functions inherited from llvm::Pass
static const PassInfo *	lookupPassInfo (const void *TI)

static const PassInfo *	lookupPassInfo (StringRef Arg)

static Pass *	createPass (AnalysisID ID)

Protected Member Functions inherited from llvm::MachineFunctionPass
	MachineFunctionPass (char &ID)

virtual bool	runOnMachineFunction (MachineFunction &MF)=0
	runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis.

void	getAnalysisUsage (AnalysisUsage &AU) const override
	getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.

virtual MachineFunctionProperties	getRequiredProperties () const

virtual MachineFunctionProperties	getSetProperties () const

virtual MachineFunctionProperties	getClearedProperties () const

Protected Member Functions inherited from llvm::FunctionPass
bool	skipFunction (const Function &F) const
	Optional passes call this function to check whether the pass should be skipped.

Detailed Description

Definition at line 96 of file MachineTraceMetrics.h.

Constructor & Destructor Documentation

◆ MachineTraceMetrics()

Machine Trace true MachineTraceMetrics::MachineTraceMetrics ( )

Definition at line 54 of file MachineTraceMetrics.cpp.

Member Function Documentation

◆ getAnalysisUsage()

void MachineTraceMetrics::getAnalysisUsage ( AnalysisUsage & AU ) const

overridevirtual

getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.

For MachineFunctionPasses, calling AU.preservesCFG() indicates that the pass does not modify the MachineBasicBlock CFG.

Reimplemented from llvm::MachineFunctionPass.

Definition at line 58 of file MachineTraceMetrics.cpp.

References llvm::AnalysisUsage::addRequired(), llvm::MachineFunctionPass::getAnalysisUsage(), and llvm::AnalysisUsage::setPreservesAll().

◆ getEnsemble()

MachineTraceMetrics::Ensemble * MachineTraceMetrics::getEnsemble ( MachineTraceStrategy strategy )

Get the trace ensemble representing the given trace selection strategy.

The returned Ensemble object is owned by the MachineTraceMetrics analysis, and valid for the lifetime of the analysis pass.

Definition at line 398 of file MachineTraceMetrics.cpp.

References assert(), llvm_unreachable, llvm::TS_Local, llvm::TS_MinInstrCount, and llvm::TS_NumStrategies.

◆ getProcReleaseAtCycles()

ArrayRef< unsigned > MachineTraceMetrics::getProcReleaseAtCycles ( unsigned MBBNum ) const

Get the scaled number of cycles used per processor resource in MBB.

This is an array with SchedModel.getNumProcResourceKinds() entries. The getResources() function above must have been called first.

These numbers have already been scaled by SchedModel.getResourceFactor().

Definition at line 144 of file MachineTraceMetrics.cpp.

References assert(), llvm::SmallVectorTemplateCommon< T, typename >::data(), llvm::TargetSchedModel::getNumProcResourceKinds(), and llvm::SmallVectorBase< Size_T >::size().

◆ getResources()

const MachineTraceMetrics::FixedBlockInfo * MachineTraceMetrics::getResources ( const MachineBasicBlock * MBB )

Get the fixed resource information about MBB. Compute it on demand.

Compute the resource usage in basic block MBB.

Definition at line 97 of file MachineTraceMetrics.cpp.

References assert(), llvm::MachineBasicBlock::getNumber(), llvm::TargetSchedModel::getNumProcResourceKinds(), llvm::TargetSchedModel::getResourceFactor(), llvm::TargetSchedModel::getWriteProcResBegin(), llvm::TargetSchedModel::getWriteProcResEnd(), llvm::MachineTraceMetrics::FixedBlockInfo::HasCalls, llvm::TargetSchedModel::hasInstrSchedModel(), llvm::MachineTraceMetrics::FixedBlockInfo::hasResources(), llvm::MachineTraceMetrics::FixedBlockInfo::InstrCount, InstrCount, MBB, MI, and llvm::TargetSchedModel::resolveSchedClass().

◆ invalidate()

void MachineTraceMetrics::invalidate ( const MachineBasicBlock * MBB )

Invalidate cached information about MBB.

This must be called before MBB is erased, or the CFG is otherwise changed.

This invalidates per-block information about resource usage for MBB only, and it invalidates per-trace information for any trace that passes through MBB.

Call Ensemble::getTrace() again to update any trace handles.

Definition at line 415 of file MachineTraceMetrics.cpp.

References llvm::dbgs(), llvm::MachineBasicBlock::getNumber(), LLVM_DEBUG, MBB, and llvm::printMBBReference().

◆ releaseMemory()

void MachineTraceMetrics::releaseMemory ( )

overridevirtual

releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memory when it is no longer needed.

The default behavior of passes is to hold onto memory for the entire duration of their lifetime (which is the entire compile time). For pipelined passes, this is not a big deal because that memory gets recycled every time the pass is invoked on another program unit. For IP passes, it is more important to free memory when it is unused.

Optionally implement this function to release pass memory when it is no longer used.

Reimplemented from llvm::Pass.

Definition at line 79 of file MachineTraceMetrics.cpp.

◆ runOnMachineFunction()

bool MachineTraceMetrics::runOnMachineFunction ( MachineFunction & MF )

overridevirtual

runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis.

Implements llvm::MachineFunctionPass.

Definition at line 65 of file MachineTraceMetrics.cpp.

References llvm::MachineFunction::getNumBlockIDs(), llvm::TargetSchedModel::getNumProcResourceKinds(), llvm::MachineFunction::getRegInfo(), llvm::MachineFunction::getSubtarget(), llvm::TargetSchedModel::init(), and llvm::SmallVectorImpl< T >::resize().

◆ verifyAnalysis()

void MachineTraceMetrics::verifyAnalysis ( ) const

overridevirtual

verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information.

Reimplemented from llvm::Pass.

Definition at line 424 of file MachineTraceMetrics.cpp.

References assert(), and llvm::MachineFunction::getNumBlockIDs().

Friends And Related Function Documentation

◆ Ensemble

friend class Ensemble

friend

Definition at line 105 of file MachineTraceMetrics.h.

◆ Trace

friend class Trace

friend

Definition at line 106 of file MachineTraceMetrics.h.

Member Data Documentation

◆ ID

char MachineTraceMetrics::ID = 0

static

Definition at line 110 of file MachineTraceMetrics.h.

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

include/llvm/CodeGen/MachineTraceMetrics.h
lib/CodeGen/MachineTraceMetrics.cpp

Classes

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MachineTraceMetrics()

Member Function Documentation

◆ getAnalysisUsage()

◆ getEnsemble()

◆ getProcReleaseAtCycles()

◆ getResources()

◆ invalidate()

◆ releaseMemory()

◆ runOnMachineFunction()

◆ verifyAnalysis()

Friends And Related Function Documentation

◆ Ensemble

◆ Trace

Member Data Documentation

◆ ID