LLVM  6.0.0svn
Public Member Functions | Protected Member Functions | List of all members
llvm::BasicBlockPass Class Referenceabstract

BasicBlockPass class - This class is used to implement most local optimizations. More...

#include "llvm/Pass.h"

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

Public Member Functions

 BasicBlockPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &O, const std::string &Banner) const override
 createPrinterPass - Get a basic block printer pass. More...
 
virtual bool doInitialization (Function &)
 doInitialization - Virtual method overridden by BasicBlockPass subclasses to do any necessary per-function initialization. More...
 
virtual bool runOnBasicBlock (BasicBlock &BB)=0
 runOnBasicBlock - Virtual method overriden by subclasses to do the per-basicblock processing of the pass. More...
 
virtual bool doFinalization (Function &)
 doFinalization - Virtual method overriden by BasicBlockPass subclasses to do any post processing needed after all passes have run. More...
 
void assignPassManager (PMStack &PMS, PassManagerType T) override
 Find appropriate Basic 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 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 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...
 
virtual void print (raw_ostream &O, 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 getAnalysisUsage (AnalysisUsage &) const
 getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job. More...
 
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. More...
 
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)
 

Protected Member Functions

bool skipBasicBlock (const BasicBlock &BB) const
 Optional passes call this function to check whether the pass should be skipped. More...
 

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)
 

Detailed Description

BasicBlockPass class - This class is used to implement most local optimizations.

Optimizations should subclass this class if they meet the following constraints:

  1. Optimizations are local, operating on either a basic block or instruction at a time.
  2. Optimizations do not modify the CFG of the contained function, or any other basic block in the function.
  3. Optimizations conform to all of the constraints of FunctionPasses.

Definition at line 335 of file Pass.h.

Constructor & Destructor Documentation

◆ BasicBlockPass()

llvm::BasicBlockPass::BasicBlockPass ( char pid)
inlineexplicit

Member Function Documentation

◆ assignPassManager()

void BasicBlockPass::assignPassManager ( PMStack PMS,
PassManagerType  PreferredType 
)
overridevirtual

Find appropriate Basic Pass Manager or Call Graph Pass Manager in the PM Stack and add self into that manager.

Reimplemented from llvm::Pass.

Definition at line 1870 of file LegacyPassManager.cpp.

References llvm::PMTopLevelManager::addIndirectPassManager(), assert(), llvm::PMStack::empty(), llvm::PMDataManager::getPassManagerType(), llvm::PMT_BasicBlockPassManager, llvm::PMStack::push(), and llvm::PMStack::top().

◆ createPrinterPass()

Pass * BasicBlockPass::createPrinterPass ( raw_ostream O,
const std::string &  Banner 
) const
overridevirtual

createPrinterPass - Get a basic block printer pass.

Implements llvm::Pass.

Definition at line 167 of file Pass.cpp.

References llvm::createPrintBasicBlockPass().

◆ doFinalization()

bool BasicBlockPass::doFinalization ( Function )
virtual

doFinalization - Virtual method overriden by BasicBlockPass subclasses to do any post processing needed after all passes have run.

Definition at line 177 of file Pass.cpp.

Referenced by llvm::AnalysisResolver::findImplPass().

◆ doInitialization()

bool BasicBlockPass::doInitialization ( Function )
virtual

doInitialization - Virtual method overridden by BasicBlockPass subclasses to do any necessary per-function initialization.

Definition at line 172 of file Pass.cpp.

Referenced by llvm::AnalysisResolver::findImplPass().

◆ getPotentialPassManagerType()

PassManagerType BasicBlockPass::getPotentialPassManagerType ( ) const
overridevirtual

Return what kind of Pass Manager can manage this pass.

Reimplemented from llvm::Pass.

Definition at line 198 of file Pass.cpp.

References llvm::PMT_BasicBlockPassManager.

◆ runOnBasicBlock()

virtual bool llvm::BasicBlockPass::runOnBasicBlock ( BasicBlock BB)
pure virtual

runOnBasicBlock - Virtual method overriden by subclasses to do the per-basicblock processing of the pass.

Referenced by llvm::AnalysisResolver::findImplPass().

◆ skipBasicBlock()

bool BasicBlockPass::skipBasicBlock ( const BasicBlock BB) const
protected

Optional passes call this function to check whether the pass should be skipped.

This is the case when Attribute::OptimizeNone is set or when optimization bisect is over the limit.

Definition at line 182 of file Pass.cpp.

References llvm::dbgs(), DEBUG, F, llvm::Function::getContext(), llvm::Function::getEntryBlock(), llvm::Value::getName(), llvm::LLVMContext::getOptBisect(), llvm::BasicBlock::getParent(), llvm::Pass::getPassName(), llvm::Function::hasFnAttribute(), and llvm::OptBisect::shouldRunPass().


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