LLVM  3.7.0
Public Member Functions | Static Public Attributes | List of all members
llvm::BlockFrequencyInfo Class Reference

BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate IR basic block frequencies. More...

#include <BlockFrequencyInfo.h>

Inheritance diagram for llvm::BlockFrequencyInfo:
[legend]
Collaboration diagram for llvm::BlockFrequencyInfo:
[legend]

Public Member Functions

 BlockFrequencyInfo ()
 
 ~BlockFrequencyInfo () 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 runOnFunction (Function &F) override
 runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass. 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...
 
void print (raw_ostream &O, const Module *M) const override
 print - Print out the internal state of the pass. More...
 
const FunctiongetFunction () const
 
void view () const
 Pop up a ghostview window with the current block frequency propagation rendered using dot. More...
 
BlockFrequency getBlockFreq (const BasicBlock *BB) const
 getblockFreq - Return block frequency. More...
 
raw_ostreamprintBlockFreq (raw_ostream &OS, const BlockFrequency Freq) const
 
raw_ostreamprintBlockFreq (raw_ostream &OS, const BasicBlock *BB) const
 
uint64_t getEntryFreq () const
 
- Public Member Functions inherited from llvm::FunctionPass
 FunctionPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &O, 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)
 
virtual ~Pass ()
 
PassKind getPassKind () const
 
virtual const char * 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 doInitialization (Module &)
 doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run. More...
 
virtual bool doFinalization (Module &)
 doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run. 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::FunctionPass
bool skipOptnoneFunction (const Function &F) const
 skipOptnoneFunction - This function has Attribute::OptimizeNone and most transformation passes should skip it. More...
 

Detailed Description

BlockFrequencyInfo pass uses BlockFrequencyInfoImpl implementation to estimate IR basic block frequencies.

Definition at line 28 of file BlockFrequencyInfo.h.

Constructor & Destructor Documentation

BlockFrequencyInfo::BlockFrequencyInfo ( )
BlockFrequencyInfo::~BlockFrequencyInfo ( )
override

Definition at line 122 of file BlockFrequencyInfo.cpp.

Member Function Documentation

void BlockFrequencyInfo::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 124 of file BlockFrequencyInfo.cpp.

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

BlockFrequency BlockFrequencyInfo::getBlockFreq ( const BasicBlock BB) const

getblockFreq - Return block frequency.

Return 0 if we don't have the information. Please note that initial frequency is equal to ENTRY_FREQ. 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 149 of file BlockFrequencyInfo.cpp.

References llvm::AMDGPUISD::BFI.

Referenced by llvm::DOTGraphTraits< BlockFrequencyInfo * >::getNodeLabel().

uint64_t BlockFrequencyInfo::getEntryFreq ( ) const

Definition at line 180 of file BlockFrequencyInfo.cpp.

References llvm::AMDGPUISD::BFI.

const Function * BlockFrequencyInfo::getFunction ( ) const
void BlockFrequencyInfo::print ( raw_ostream O,
const Module M 
) const
overridevirtual

print - Print out the internal state of the pass.

This is called by Analyze to print out the contents of an analysis. Otherwise it is not necessary to implement this method. Beware that the module pointer MAY be null. This automatically forwards to a virtual function that does not provide the Module* in case the analysis doesn't need it it can just be ignored.

Reimplemented from llvm::Pass.

Definition at line 145 of file BlockFrequencyInfo.cpp.

References llvm::AMDGPUISD::BFI.

raw_ostream & BlockFrequencyInfo::printBlockFreq ( raw_ostream OS,
const BlockFrequency  Freq 
) const
raw_ostream & BlockFrequencyInfo::printBlockFreq ( raw_ostream OS,
const BasicBlock BB 
) const

Definition at line 175 of file BlockFrequencyInfo.cpp.

References llvm::AMDGPUISD::BFI.

void BlockFrequencyInfo::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 143 of file BlockFrequencyInfo.cpp.

References llvm::AMDGPUISD::BFI.

bool BlockFrequencyInfo::runOnFunction ( Function F)
overridevirtual

runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass.

Implements llvm::FunctionPass.

Definition at line 130 of file BlockFrequencyInfo.cpp.

References llvm::AMDGPUISD::BFI, GVDT_None, view(), and ViewBlockFreqPropagationDAG.

void BlockFrequencyInfo::view ( ) const

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

Definition at line 155 of file BlockFrequencyInfo.cpp.

References llvm::errs(), and llvm::ViewGraph().

Referenced by runOnFunction().

Member Data Documentation

block Block Frequency true char BlockFrequencyInfo::ID = 0
static

Definition at line 33 of file BlockFrequencyInfo.h.


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