ModulePass class - This class is used to implement unstructured interprocedural optimizations and analyses. More...
#include "llvm/Pass.h"
Public Member Functions | |
| ModulePass (char &pid) | |
| ~ModulePass () override | |
| Pass * | createPrinterPass (raw_ostream &OS, const std::string &Banner) const override |
| createPrinterPass - Get a module printer pass. | |
| virtual bool | runOnModule (Module &M)=0 |
| runOnModule - Virtual method overriden by subclasses to process the module being operated on. | |
| void | assignPassManager (PMStack &PMS, PassManagerType T) override |
| Find appropriate Module Pass Manager in the PM Stack and add self into that manager. | |
| PassManagerType | getPotentialPassManagerType () const override |
| Return what kind of Pass Manager can manage this pass. | |
 Public Member Functions inherited from llvm::Pass | |
| Pass (PassKind K, char &pid) | |
| Pass (const Pass &)=delete | |
| Pass & | operator= (const Pass &)=delete |
| virtual | ~Pass () |
| PassKind | getPassKind () const |
| virtual StringRef | getPassName () const |
| getPassName - Return a nice clean name for a pass. | |
| AnalysisID | getPassID () const |
| getPassID - Return the PassID number that corresponds to this pass. | |
| virtual bool | doInitialization (Module &) |
| doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run. | |
| virtual bool | doFinalization (Module &) |
| doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run. | |
| virtual void | print (raw_ostream &OS, const Module *M) const |
| print - Print out the internal state of the pass. | |
| void | dump () const |
| virtual Pass * | createPrinterPass (raw_ostream &OS, const std::string &Banner) const =0 |
| createPrinterPass - Get a Pass appropriate to print the IR this pass operates on (Module, Function or MachineFunction). | |
| virtual void | assignPassManager (PMStack &, PassManagerType) |
| Each pass is responsible for assigning a pass manager to itself. | |
| virtual void | preparePassManager (PMStack &) |
| Check if available pass managers are suitable for this pass or not. | |
| virtual PassManagerType | getPotentialPassManagerType () const |
| Return what kind of Pass Manager can manage this pass. | |
| void | setResolver (AnalysisResolver *AR) |
| AnalysisResolver * | getResolver () const |
| virtual void | getAnalysisUsage (AnalysisUsage &) const |
| getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job. | |
| 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. | |
| virtual void * | getAdjustedAnalysisPointer (AnalysisID ID) |
| getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance. | |
| virtual ImmutablePass * | getAsImmutablePass () |
| virtual PMDataManager * | getAsPMDataManager () |
| virtual void | verifyAnalysis () const |
| verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information. | |
| 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. | |
| bool | mustPreserveAnalysisID (char &AID) const |
| mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID. | |
| 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. | |
| template<typename AnalysisType > | |
| AnalysisType & | getAnalysis (Function &F, bool *Changed=nullptr) |
| getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. | |
| template<typename AnalysisType > | |
| AnalysisType & | getAnalysisID (AnalysisID PI) const |
| template<typename AnalysisType > | |
| AnalysisType & | getAnalysisID (AnalysisID PI, Function &F, bool *Changed=nullptr) |
Protected Member Functions | |
| bool | skipModule (Module &M) const |
| Optional passes call this function to check whether the pass should be skipped. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from llvm::Pass | |
| static const PassInfo * | lookupPassInfo (const void *TI) |
| static const PassInfo * | lookupPassInfo (StringRef Arg) |
| static Pass * | createPass (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.
Constructor & Destructor Documentation
◆ ModulePass()
◆ ~ModulePass()
|
overridedefault |
Member Function Documentation
◆ assignPassManager()
|
overridevirtual |
Find appropriate Module Pass Manager in the PM Stack and add self into that manager.
Reimplemented from llvm::Pass.
Definition at line 1703 of file LegacyPassManager.cpp.
References llvm::PMDataManager::add(), llvm::PMDataManager::getPassManagerType(), llvm::PMT_ModulePassManager, llvm::PMStack::pop(), and llvm::PMStack::top().
◆ createPrinterPass()
|
overridevirtual |
createPrinterPass - Get a module printer pass.
Implements llvm::Pass.
Definition at line 50 of file Pass.cpp.
References llvm::createPrintModulePass(), and OS.
◆ getPotentialPassManagerType()
|
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()
runOnModule - Virtual method overriden by subclasses to process the module being operated on.
Implemented in llvm::ImmutablePass, llvm::CallGraphWrapperPass, llvm::DOTGraphTraitsModuleViewerWrapperPass< AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT >, llvm::DOTGraphTraitsModulePrinterWrapperPass< AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT >, llvm::DXILMetadataAnalysisWrapperPass, llvm::DXILResourceWrapperPass, llvm::GlobalsAAWrapperPass, llvm::IRSimilarityIdentifierWrapperPass, llvm::ModuleSummaryIndexWrapperPass, llvm::StackSafetyGlobalInfoWrapperPass, llvm::FPPassManager, llvm::AMDGPUResourceUsageAnalysis, llvm::DXILFinalizeLinkageLegacy, llvm::DXILIntrinsicExpansionLegacy, llvm::DXILResourceMDWrapper, llvm::dxil::ShaderFlagsAnalysisWrapper, and llvm::SPIRVModuleAnalysis.
◆ skipModule()
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 63 of file Pass.cpp.
References getDescription(), llvm::Pass::getPassName(), llvm::OptPassGate::isEnabled(), and llvm::OptPassGate::shouldRunPass().
The documentation for this class was generated from the following files:
- include/llvm/Pass.h
- lib/IR/LegacyPassManager.cpp
- lib/IR/Pass.cpp
