LLVM  8.0.0svn
Public Member Functions | Protected Member Functions | List of all members
llvm::ModulePass Class Referenceabstract

ModulePass class - This class is used to implement unstructured interprocedural optimizations and analyses. More...

#include "llvm/Pass.h"

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

Public Member Functions

 ModulePass (char &pid)
 
 ~ModulePass () override
 
PasscreatePrinterPass (raw_ostream &OS, const std::string &Banner) const override
 createPrinterPass - Get a module printer pass. More...
 
virtual bool runOnModule (Module &M)=0
 runOnModule - Virtual method overriden by subclasses to process the module being operated on. More...
 
void assignPassManager (PMStack &PMS, PassManagerType T) override
 Find appropriate Module 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 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 &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 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 skipModule (Module &M) 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

ModulePass class - This class is used to implement unstructured interprocedural optimizations and analyses.

ModulePasses may do anything they want to the program.

Definition at line 225 of file Pass.h.

Constructor & Destructor Documentation

◆ ModulePass()

llvm::ModulePass::ModulePass ( char pid)
inlineexplicit

◆ ~ModulePass()

ModulePass::~ModulePass ( )
overridedefault

Referenced by llvm::Pass::~Pass().

Member Function Documentation

◆ assignPassManager()

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

Find appropriate Module Pass Manager in the PM Stack and add self into that manager.

Reimplemented from llvm::Pass.

Definition at line 1939 of file LegacyPassManager.cpp.

References llvm::PMDataManager::add(), assert(), llvm::PMStack::empty(), llvm::PMDataManager::getPassManagerType(), llvm::PMT_ModulePassManager, llvm::PMStack::pop(), and llvm::PMStack::top().

Referenced by llvm::FunctionPass::assignPassManager().

◆ createPrinterPass()

Pass * ModulePass::createPrinterPass ( raw_ostream OS,
const std::string &  Banner 
) const
overridevirtual

createPrinterPass - Get a module printer pass.

Implements llvm::Pass.

Definition at line 50 of file Pass.cpp.

References llvm::createPrintModulePass().

◆ getPotentialPassManagerType()

PassManagerType ModulePass::getPotentialPassManagerType ( ) const
overridevirtual

Return what kind of Pass Manager can manage this pass.

Reimplemented from llvm::Pass.

Definition at line 55 of file Pass.cpp.

References llvm::PMT_ModulePassManager.

◆ runOnModule()

virtual bool llvm::ModulePass::runOnModule ( Module M)
pure virtual

◆ skipModule()

bool ModulePass::skipModule ( Module M) const
protected

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

This is the case when optimization bisect is over the limit.

Definition at line 59 of file Pass.cpp.

References llvm::Module::getContext(), llvm::LLVMContext::getOptPassGate(), and llvm::OptPassGate::shouldRunPass().


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