FunctionPass class - This class is used to implement most global optimizations. More...
#include "llvm/Pass.h"
Public Member Functions | |
| FunctionPass (char &pid) | |
| Pass * | createPrinterPass (raw_ostream &OS, const std::string &Banner) const override |
| createPrinterPass - Get a function printer pass. | |
| virtual bool | runOnFunction (Function &F)=0 |
| runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass. | |
| 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. | |
| 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 | skipFunction (const Function &F) 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
FunctionPass class - This class is used to implement most global optimizations.
Optimizations should subclass this class if they meet the following constraints:
- Optimizations are organized globally, i.e., a function at a time
- Optimizing a function does not cause the addition or removal of any functions in the module
Constructor & Destructor Documentation
◆ FunctionPass()
|
inlineexplicit |
Member Function Documentation
◆ assignPassManager()
|
overridevirtual |
Find appropriate Function Pass Manager or Call Graph Pass Manager in the PM Stack and add self into that manager.
Reimplemented from llvm::Pass.
Definition at line 1715 of file LegacyPassManager.cpp.
References llvm::PMDataManager::add(), llvm::PMTopLevelManager::addIndirectPassManager(), llvm::Pass::assignPassManager(), llvm::PMDataManager::getPassManagerType(), llvm::PMDataManager::getTopLevelManager(), llvm::PMT_FunctionPassManager, llvm::PMStack::pop(), llvm::PMDataManager::populateInheritedAnalysis(), llvm::PMStack::push(), and llvm::PMStack::top().
◆ createPrinterPass()
|
overridevirtual |
createPrinterPass - Get a function printer pass.
Implements llvm::Pass.
Definition at line 165 of file Pass.cpp.
References llvm::createPrintFunctionPass(), and OS.
◆ getPotentialPassManagerType()
|
overridevirtual |
Return what kind of Pass Manager can manage this pass.
Reimplemented from llvm::Pass.
Definition at line 170 of file Pass.cpp.
References llvm::PMT_FunctionPassManager.
◆ runOnFunction()
runOnFunction - Virtual method overriden by subclasses to do the per-function processing of the pass.
Implemented in llvm::DominanceFrontierWrapperPass, llvm::MemoryDependenceWrapperPass, llvm::MemorySSAWrapperPass, llvm::AAResultsWrapperPass, llvm::BasicAAWrapperPass, llvm::BlockFrequencyInfoWrapperPass, llvm::BranchProbabilityInfoWrapperPass, llvm::CycleInfoWrapperPass, llvm::DependenceAnalysisWrapperPass, llvm::DOTGraphTraitsViewerWrapperPass< AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT >, llvm::DOTGraphTraitsPrinterWrapperPass< AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT >, llvm::LazyBlockFrequencyInfoPass, llvm::LazyBranchProbabilityInfoPass, llvm::LazyValueInfoWrapperPass, llvm::LoopInfoWrapperPass, llvm::LPPassManager, llvm::LCSSAVerificationPass, llvm::OptimizationRemarkEmitterWrapperPass, llvm::PhiValuesWrapperPass, llvm::PostDominatorTreeWrapperPass, llvm::RegionInfoPass, llvm::RGPassManager, llvm::ScalarEvolutionWrapperPass, llvm::SCEVAAWrapperPass, llvm::StackSafetyInfoWrapperPass, llvm::UniformityInfoWrapperPass, llvm::AssignmentTrackingAnalysis, llvm::ReplaceWithVeclibLegacy, llvm::DominatorTreeWrapperPass, llvm::InstructionCombiningPass, AMDGPUAnnotateUniformValuesLegacy, AMDGPULateCodeGenPrepareLegacy, SIAnnotateControlFlowLegacy, llvm::SPIRVConvergenceRegionAnalysisWrapperPass, llvm::SPIRVMergeRegionExitTargets, SPIRVStripConvergentIntrinsics, llvm::gvn::GVNLegacyPass, and llvm::StackProtector.
◆ skipFunction()
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 178 of file Pass.cpp.
References llvm::dbgs(), F, getDescription(), llvm::Pass::getPassName(), llvm::OptPassGate::isEnabled(), LLVM_DEBUG, and llvm::OptPassGate::shouldRunPass().
Referenced by llvm::InstructionCombiningPass::runOnFunction(), llvm::ExecutionDomainFix::runOnMachineFunction(), llvm::IRTranslator::runOnMachineFunction(), llvm::SelectionDAGISelLegacy::runOnMachineFunction(), llvm::BreakFalseDeps::runOnMachineFunction(), and llvm::ARMBlockPlacement::runOnMachineFunction().
The documentation for this class was generated from the following files:
- include/llvm/Pass.h
- lib/IR/LegacyPassManager.cpp
- lib/IR/Pass.cpp
