LLVM  6.0.0svn
Public Member Functions | Static Public Attributes | List of all members
llvm::MachineBlockFrequencyInfo Class Reference

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

#include "llvm/CodeGen/MachineBlockFrequencyInfo.h"

Inheritance diagram for llvm::MachineBlockFrequencyInfo:
Inheritance graph
[legend]
Collaboration diagram for llvm::MachineBlockFrequencyInfo:
Collaboration graph
[legend]

Public Member Functions

 MachineBlockFrequencyInfo ()
 
 ~MachineBlockFrequencyInfo () override
 
void getAnalysisUsage (AnalysisUsage &AU) const override
 getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job. More...
 
bool runOnMachineFunction (MachineFunction &F) override
 runOnMachineFunction - This method must be overloaded to perform the desired machine code transformation or analysis. More...
 
void calculate (const MachineFunction &F, const MachineBranchProbabilityInfo &MBPI, const MachineLoopInfo &MLI)
 calculate - compute block frequency info for the given function. More...
 
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. More...
 
BlockFrequency getBlockFreq (const MachineBasicBlock *MBB) const
 getblockFreq - Return block frequency. More...
 
Optional< uint64_t > getBlockProfileCount (const MachineBasicBlock *MBB) const
 
Optional< uint64_t > getProfileCountFromFreq (uint64_t Freq) const
 
bool isIrrLoopHeader (const MachineBasicBlock *MBB)
 
const MachineFunctiongetFunction () const
 
const MachineBranchProbabilityInfogetMBPI () const
 
void view (const Twine &Name, bool isSimple=true) const
 Pop up a ghostview window with the current block frequency propagation rendered using dot. More...
 
raw_ostreamprintBlockFreq (raw_ostream &OS, const BlockFrequency Freq) const
 
raw_ostreamprintBlockFreq (raw_ostream &OS, const MachineBasicBlock *MBB) const
 
uint64_t getEntryFreq () const
 
- 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. More...
 
- Public Member Functions inherited from llvm::FunctionPass
 FunctionPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &OS, const std::string &Banner) const override
 createPrinterPass - Get a function printer pass. More...
 
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. More...
 
PassManagerType getPotentialPassManagerType () const override
 Return what kind of Pass Manager can manage this pass. More...
 
- Public Member Functions inherited from llvm::Pass
 Pass (PassKind K, char &pid)
 
 Pass (const Pass &)=delete
 
Passoperator= (const Pass &)=delete
 
virtual ~Pass ()
 
PassKind getPassKind () const
 
virtual StringRef getPassName () const
 getPassName - Return a nice clean name for a pass. More...
 
AnalysisID getPassID () const
 getPassID - Return the PassID number that corresponds to this pass. More...
 
virtual bool doFinalization (Module &)
 doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run. More...
 
virtual void print (raw_ostream &OS, const Module *M) const
 print - Print out the internal state of the pass. More...
 
void dump () const
 
virtual void preparePassManager (PMStack &)
 Check if available pass managers are suitable for this pass or not. More...
 
void setResolver (AnalysisResolver *AR)
 
AnalysisResolvergetResolver () const
 
virtual void * getAdjustedAnalysisPointer (AnalysisID ID)
 getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance. More...
 
virtual ImmutablePassgetAsImmutablePass ()
 
virtual PMDataManagergetAsPMDataManager ()
 
virtual void verifyAnalysis () const
 verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information. More...
 
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. More...
 
bool mustPreserveAnalysisID (char &AID) const
 mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID. More...
 
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. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysis (Function &F)
 getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI) const
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI, Function &F)
 

Static Public Attributes

static char ID = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from llvm::Pass
static const PassInfolookupPassInfo (const void *TI)
 
static const PassInfolookupPassInfo (StringRef Arg)
 
static PasscreatePass (AnalysisID ID)
 
- Protected Member Functions inherited from llvm::MachineFunctionPass
 MachineFunctionPass (char &ID)
 
void getAnalysisUsage (AnalysisUsage &AU) const override
 getAnalysisUsage - Subclasses that override getAnalysisUsage must call this. More...
 
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. More...
 

Detailed Description

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

Definition at line 34 of file MachineBlockFrequencyInfo.h.

Constructor & Destructor Documentation

◆ MachineBlockFrequencyInfo()

MachineBlockFrequencyInfo::MachineBlockFrequencyInfo ( )

◆ ~MachineBlockFrequencyInfo()

MachineBlockFrequencyInfo::~MachineBlockFrequencyInfo ( )
overridedefault

Member Function Documentation

◆ calculate()

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

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

Definition at line 221 of file MachineBlockFrequencyInfo.cpp.

Referenced by collectDebugValues(), llvm::RegBankSelect::InstrInsertPoint::frequency(), llvm::RegBankSelect::MBBInsertPoint::frequency(), llvm::RegBankSelect::EdgeInsertPoint::frequency(), llvm::RegBankSelect::getAnalysisUsage(), llvm::LiveIntervals::getSpillWeight(), hasTiedDef(), isIrreducibleCFG(), and llvm::SplitEditor::overlapIntv().

◆ getBlockProfileCount()

Optional< uint64_t > MachineBlockFrequencyInfo::getBlockProfileCount ( const MachineBasicBlock MBB) const

Definition at line 225 of file MachineBlockFrequencyInfo.cpp.

References F(), and llvm::None.

◆ getEntryFreq()

uint64_t MachineBlockFrequencyInfo::getEntryFreq ( ) const

◆ getFunction()

const MachineFunction * MachineBlockFrequencyInfo::getFunction ( ) const

◆ getMBPI()

const MachineBranchProbabilityInfo * MachineBlockFrequencyInfo::getMBPI ( ) const

◆ getProfileCountFromFreq()

Optional< uint64_t > MachineBlockFrequencyInfo::getProfileCountFromFreq ( uint64_t  Freq) const

Definition at line 232 of file MachineBlockFrequencyInfo.cpp.

References F(), and llvm::None.

◆ isIrrLoopHeader()

bool MachineBlockFrequencyInfo::isIrrLoopHeader ( const MachineBasicBlock MBB)

Definition at line 238 of file MachineBlockFrequencyInfo.cpp.

References assert().

◆ printBlockFreq() [1/2]

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

Definition at line 252 of file MachineBlockFrequencyInfo.cpp.

Referenced by llvm::createGreedyRegisterAllocator().

◆ printBlockFreq() [2/2]

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

Definition at line 258 of file MachineBlockFrequencyInfo.cpp.

◆ 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 211 of file MachineBlockFrequencyInfo.cpp.

◆ runOnMachineFunction()

bool MachineBlockFrequencyInfo::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 203 of file MachineBlockFrequencyInfo.cpp.

References calculate().

◆ view()

void MachineBlockFrequencyInfo::view ( const Twine Name,
bool  isSimple = true 
) const

Pop up a ghostview window with the current block frequency propagation rendered using dot.

Definition at line 215 of file MachineBlockFrequencyInfo.cpp.

References llvm::ViewGraph().

Referenced by calculate().

Member Data Documentation

◆ ID

Machine Block Frequency true char MachineBlockFrequencyInfo::ID = 0
static

Definition at line 39 of file MachineBlockFrequencyInfo.h.


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