LLVM API Documentation

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
llvm::BasicBlockPass Class Referenceabstract

#include <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
 createPrinterPass - Get a basic block printer pass. More...
 
virtual bool doInitialization (Function &)
 
virtual bool runOnBasicBlock (BasicBlock &BB)=0
 
virtual bool doFinalization (Function &)
 
virtual void assignPassManager (PMStack &PMS, PassManagerType T)
 
virtual PassManagerType getPotentialPassManagerType () const
 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
 
AnalysisID getPassID () const
 getPassID - Return the PassID number that corresponds to this pass. More...
 
virtual bool doInitialization (Module &)
 
virtual bool doFinalization (Module &)
 
virtual void print (raw_ostream &O, const Module *M) const
 
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
 
virtual void releaseMemory ()
 
virtual void * getAdjustedAnalysisPointer (AnalysisID ID)
 
virtual ImmutablePassgetAsImmutablePass ()
 
virtual PMDataManagergetAsPMDataManager ()
 
virtual void verifyAnalysis () const
 
virtual void dumpPassStructure (unsigned Offset=0)
 
template<typename AnalysisType >
AnalysisType * getAnalysisIfAvailable () const
 
bool mustPreserveAnalysisID (char &AID) const
 
template<typename AnalysisType >
AnalysisType & getAnalysis () const
 
template<typename AnalysisType >
AnalysisType & getAnalysis (Function &F)
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI) const
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI, Function &F)
 

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 324 of file Pass.h.

Constructor & Destructor Documentation

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

Definition at line 326 of file Pass.h.

Member Function Documentation

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

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 1885 of file LegacyPassManager.cpp.

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

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

createPrinterPass - Get a basic block printer pass.

Implements llvm::Pass.

Definition at line 144 of file Pass.cpp.

References llvm::createPrintBasicBlockPass().

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 154 of file Pass.cpp.

bool BasicBlockPass::doInitialization ( Function )
virtual

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

Definition at line 149 of file Pass.cpp.

PassManagerType BasicBlockPass::getPotentialPassManagerType ( ) const
virtual

Return what kind of Pass Manager can manage this pass.

Reimplemented from llvm::Pass.

Definition at line 159 of file Pass.cpp.

References llvm::PMT_BasicBlockPassManager.

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

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


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