LLVM  3.7.0
Public Member Functions | Protected Member Functions | List of all members
llvm::FunctionPass Class Referenceabstract

FunctionPass class - This class is used to implement most global optimizations. More...

#include <Pass.h>

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

Public Member Functions

 FunctionPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &O, const std::string &Banner) const override
 createPrinterPass - Get a function printer pass. More...
 
virtual bool runOnFunction (Function &F)=0
 runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the 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...
 
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 skipOptnoneFunction (const Function &F) const
 skipOptnoneFunction - This function has Attribute::OptimizeNone and most transformation passes should skip it. 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

FunctionPass class - This class is used to implement most global optimizations.

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

  1. Optimizations are organized globally, i.e., a function at a time
  2. Optimizing a function does not cause the addition or removal of any functions in the module

Definition at line 294 of file Pass.h.

Constructor & Destructor Documentation

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

Definition at line 296 of file Pass.h.

Member Function Documentation

void FunctionPass::assignPassManager ( PMStack PMS,
PassManagerType  PreferredType 
)
overridevirtual
Pass * FunctionPass::createPrinterPass ( raw_ostream O,
const std::string &  Banner 
) const
overridevirtual

createPrinterPass - Get a function printer pass.

Implements llvm::Pass.

Definition at line 134 of file Pass.cpp.

References llvm::createPrintFunctionPass().

PassManagerType FunctionPass::getPotentialPassManagerType ( ) const
overridevirtual

Return what kind of Pass Manager can manage this pass.

Reimplemented from llvm::Pass.

Definition at line 139 of file Pass.cpp.

References llvm::PMT_FunctionPassManager.

virtual bool llvm::FunctionPass::runOnFunction ( Function F)
pure virtual
bool FunctionPass::skipOptnoneFunction ( const Function F) const
protected

skipOptnoneFunction - This function has Attribute::OptimizeNone and most transformation passes should skip it.

Definition at line 143 of file Pass.cpp.

References llvm::dbgs(), DEBUG, llvm::Value::getName(), llvm::Pass::getPassName(), llvm::Function::hasFnAttribute(), and llvm::Attribute::OptimizeNone.


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