MachineBlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate machine basic block frequencies. More...

#include "llvm/CodeGen/MachineBlockFrequencyInfo.h"

Inheritance diagram for llvm::MachineBlockFrequencyInfo:

[legend]

Collaboration diagram for llvm::MachineBlockFrequencyInfo:

[legend]

Public Member Functions
	MachineBlockFrequencyInfo ()

	MachineBlockFrequencyInfo (MachineFunction &F, MachineBranchProbabilityInfo &MBPI, MachineLoopInfo &MLI)

	~MachineBlockFrequencyInfo () override

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

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

void	calculate (const MachineFunction &F, const MachineBranchProbabilityInfo &MBPI, const MachineLoopInfo &MLI)
	calculate - compute block frequency info for the given function.

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.

BlockFrequency	getBlockFreq (const MachineBasicBlock *MBB) const
	getblockFreq - Return block frequency.

float	getBlockFreqRelativeToEntryBlock (const MachineBasicBlock *MBB) const
	Compute the frequency of the block, relative to the entry block.

std::optional< uint64_t >	getBlockProfileCount (const MachineBasicBlock *MBB) const

std::optional< uint64_t >	getProfileCountFromFreq (uint64_t Freq) const

bool	isIrrLoopHeader (const MachineBasicBlock *MBB) const

void	onEdgeSplit (const MachineBasicBlock &NewPredecessor, const MachineBasicBlock &NewSuccessor, const MachineBranchProbabilityInfo &MBPI)
	incrementally calculate block frequencies when we split edges, to avoid full CFG traversal.

const MachineFunction *	getFunction () const

const MachineBranchProbabilityInfo *	getMBPI () const

void	view (const Twine &Name, bool isSimple=true) const
	Pop up a ghostview window with the current block frequency propagation rendered using dot.

raw_ostream &	printBlockFreq (raw_ostream &OS, const BlockFrequency Freq) const

raw_ostream &	printBlockFreq (raw_ostream &OS, const MachineBasicBlock *MBB) const

uint64_t	getEntryFreq () const
	Divide a block's BlockFrequency::getFrequency() value by this value to obtain the entry block - relative frequency of said block.

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

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

MachineBlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate machine basic block frequencies.

Definition at line 33 of file MachineBlockFrequencyInfo.h.

Constructor & Destructor Documentation

◆ MachineBlockFrequencyInfo() [1/2]

MachineBlockFrequencyInfo::MachineBlockFrequencyInfo ( )

Definition at line 173 of file MachineBlockFrequencyInfo.cpp.

References llvm::PassRegistry::getPassRegistry(), and llvm::initializeMachineBlockFrequencyInfoPass().

◆ MachineBlockFrequencyInfo() [2/2]

MachineBlockFrequencyInfo::MachineBlockFrequencyInfo	(	MachineFunction &	F,
		MachineBranchProbabilityInfo &	MBPI,
		MachineLoopInfo &	MLI
	)

explicit

Definition at line 178 of file MachineBlockFrequencyInfo.cpp.

References calculate(), and F.

◆ ~MachineBlockFrequencyInfo()

MachineBlockFrequencyInfo::~MachineBlockFrequencyInfo ( )

overridedefault

Member Function Documentation

◆ calculate()

void MachineBlockFrequencyInfo::calculate	(	const MachineFunction &	F,
		const MachineBranchProbabilityInfo &	MBPI,
		const MachineLoopInfo &	MLI
	)

calculate - compute block frequency info for the given function.

Definition at line 194 of file MachineBlockFrequencyInfo.cpp.

References llvm::dbgs(), F, llvm::GVDT_None, llvm::PrintBlockFreqFuncName, llvm::PrintMachineBlockFreq, view(), llvm::ViewBlockFreqFuncName, and llvm::ViewMachineBlockFreqPropagationDAG.

Referenced by MachineBlockFrequencyInfo(), and runOnMachineFunction().

◆ getAnalysisUsage()

void MachineBlockFrequencyInfo::getAnalysisUsage ( AnalysisUsage & ) const

overridevirtual

getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.

If a pass specifies that it uses a particular analysis result to this function, it can then use the getAnalysis<AnalysisType>() function, below.

Reimplemented from llvm::Pass.

Definition at line 187 of file MachineBlockFrequencyInfo.cpp.

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

◆ getBlockFreq()

BlockFrequency MachineBlockFrequencyInfo::getBlockFreq ( const MachineBasicBlock * MBB ) const

getblockFreq - Return block frequency.

Return 0 if we don't have the information. Please note that initial frequency is equal to 1024. It means that we should not rely on the value itself, but only on the comparison to the other block frequencies. We do this to avoid using of floating points. For example, to get the frequency of a block relative to the entry block, divide the integral value returned by this function (the BlockFrequency::getFrequency() value) by getEntryFreq().

Definition at line 230 of file MachineBlockFrequencyInfo.cpp.

References MBB.

Referenced by llvm::RegBankSelect::computeMapping(), llvm::RegBankSelect::InstrInsertPoint::frequency(), llvm::RegBankSelect::MBBInsertPoint::frequency(), llvm::RegBankSelect::EdgeInsertPoint::frequency(), llvm::MBFIWrapper::getBlockFreq(), and getBlockFreqRelativeToEntryBlock().

◆ getBlockFreqRelativeToEntryBlock()

float llvm::MachineBlockFrequencyInfo::getBlockFreqRelativeToEntryBlock ( const MachineBasicBlock * MBB ) const

inline

Compute the frequency of the block, relative to the entry block.

This API assumes getEntryFreq() is non-zero.

Definition at line 68 of file MachineBlockFrequencyInfo.h.

References getBlockFreq(), getEntryFreq(), llvm::BlockFrequency::getFrequency(), and MBB.

Referenced by llvm::calculateRegAllocScore(), llvm::AsmPrinter::emitFunctionBody(), and llvm::LiveIntervals::getSpillWeight().

◆ getBlockProfileCount()

std::optional< uint64_t > MachineBlockFrequencyInfo::getBlockProfileCount ( const MachineBasicBlock * MBB ) const

Definition at line 234 of file MachineBlockFrequencyInfo.cpp.

References F, and MBB.

Referenced by llvm::MBFIWrapper::getBlockProfileCount(), and isColdBlock().

◆ getEntryFreq()

uint64_t MachineBlockFrequencyInfo::getEntryFreq ( ) const

Divide a block's BlockFrequency::getFrequency() value by this value to obtain the entry block - relative frequency of said block.

Definition at line 289 of file MachineBlockFrequencyInfo.cpp.

Referenced by getBlockFreqRelativeToEntryBlock(), and llvm::MBFIWrapper::getEntryFreq().

◆ getFunction()

const MachineFunction * MachineBlockFrequencyInfo::getFunction ( ) const

Definition at line 269 of file MachineBlockFrequencyInfo.cpp.

◆ getMBPI()

const MachineBranchProbabilityInfo * MachineBlockFrequencyInfo::getMBPI ( ) const

Definition at line 273 of file MachineBlockFrequencyInfo.cpp.

Referenced by llvm::DOTGraphTraits< MachineBlockFrequencyInfo * >::getEdgeAttributes(), and llvm::MIRProfileLoader::setBranchProbs().

◆ getProfileCountFromFreq()

std::optional< uint64_t > MachineBlockFrequencyInfo::getProfileCountFromFreq ( uint64_t Freq ) const

Definition at line 244 of file MachineBlockFrequencyInfo.cpp.

References F.

Referenced by llvm::MBFIWrapper::getBlockProfileCount().

◆ isIrrLoopHeader()

bool MachineBlockFrequencyInfo::isIrrLoopHeader ( const MachineBasicBlock * MBB ) const

Definition at line 252 of file MachineBlockFrequencyInfo.cpp.

References assert(), and MBB.

◆ onEdgeSplit()

void MachineBlockFrequencyInfo::onEdgeSplit	(	const MachineBasicBlock &	NewPredecessor,
		const MachineBasicBlock &	NewSuccessor,
		const MachineBranchProbabilityInfo &	MBPI
	)

incrementally calculate block frequencies when we split edges, to avoid full CFG traversal.

Definition at line 258 of file MachineBlockFrequencyInfo.cpp.

References assert(), and llvm::MachineBranchProbabilityInfo::getEdgeProbability().

◆ printBlockFreq() [1/2]

raw_ostream & MachineBlockFrequencyInfo::printBlockFreq	(	raw_ostream &	OS,
		const BlockFrequency	Freq
	)		const

Definition at line 278 of file MachineBlockFrequencyInfo.cpp.

References OS.

Referenced by llvm::MBFIWrapper::printBlockFreq().

◆ printBlockFreq() [2/2]

raw_ostream & MachineBlockFrequencyInfo::printBlockFreq	(	raw_ostream &	OS,
		const MachineBasicBlock *	MBB
	)		const

Definition at line 284 of file MachineBlockFrequencyInfo.cpp.

References MBB, and OS.

◆ releaseMemory()

void MachineBlockFrequencyInfo::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 220 of file MachineBlockFrequencyInfo.cpp.