LLVM  14.0.0git
Public Member Functions | Static Public Member Functions | List of all members
llvm::Pass Class Referenceabstract

Pass interface - Implemented by all 'passes'. More...

#include "llvm/Pass.h"

Inheritance diagram for llvm::Pass:
Inheritance graph
[legend]

Public Member Functions

 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 PasscreatePrinterPass (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). More...
 
virtual void assignPassManager (PMStack &, PassManagerType)
 Each pass is responsible for assigning a pass manager to itself. More...
 
virtual void preparePassManager (PMStack &)
 Check if available pass managers are suitable for this pass or not. More...
 
virtual PassManagerType getPotentialPassManagerType () const
 Return what kind of Pass Manager can manage this pass. 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, 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. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI) const
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI, Function &F, bool *Changed=nullptr)
 

Static Public Member Functions

static const PassInfolookupPassInfo (const void *TI)
 
static const PassInfolookupPassInfo (StringRef Arg)
 
static PasscreatePass (AnalysisID ID)
 

Detailed Description

Pass interface - Implemented by all 'passes'.

Subclass this if you are an interprocedural optimization or you do not fit into any of the more constrained passes described below.

Definition at line 91 of file Pass.h.

Constructor & Destructor Documentation

◆ Pass() [1/2]

llvm::Pass::Pass ( PassKind  K,
char &  pid 
)
inlineexplicit

Definition at line 97 of file Pass.h.

◆ Pass() [2/2]

llvm::Pass::Pass ( const Pass )
delete

◆ ~Pass()

Pass::~Pass ( )
virtual

Definition at line 39 of file Pass.cpp.

Member Function Documentation

◆ assignPassManager()

virtual void llvm::Pass::assignPassManager ( PMStack ,
PassManagerType   
)
inlinevirtual

Each pass is responsible for assigning a pass manager to itself.

PMS is the stack of available pass manager.

Reimplemented in llvm::FunctionPass, llvm::ModulePass, llvm::RegionPass, llvm::CallGraphSCCPass, and llvm::LoopPass.

Definition at line 139 of file Pass.h.

Referenced by llvm::FunctionPass::assignPassManager(), and llvm::PMTopLevelManager::schedulePass().

◆ createPass()

Pass * Pass::createPass ( AnalysisID  ID)
static

◆ createPrinterPass()

virtual Pass* llvm::Pass::createPrinterPass ( raw_ostream OS,
const std::string &  Banner 
) const
pure virtual

◆ doFinalization()

virtual bool llvm::Pass::doFinalization ( Module )
inlinevirtual

◆ doInitialization()

virtual bool llvm::Pass::doInitialization ( Module )
inlinevirtual

◆ dump()

LLVM_DUMP_METHOD void Pass::dump ( ) const

◆ dumpPassStructure()

void Pass::dumpPassStructure ( unsigned  Offset = 0)
virtual

◆ getAdjustedAnalysisPointer()

void * Pass::getAdjustedAnalysisPointer ( AnalysisID  ID)
virtual

getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance.

If needed, it should override this to adjust the this pointer as needed for the specified pass info.

Definition at line 105 of file Pass.cpp.

Referenced by getAnalysisID(), and getAnalysisIfAvailable().

◆ getAnalysis() [1/2]

template<typename AnalysisType >
AnalysisType & llvm::Pass::getAnalysis

getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function.

Definition at line 230 of file PassAnalysisSupport.h.

References assert().

Referenced by llvm::SIRegisterInfo::findReachingDef(), llvm::SITargetLowering::LowerFormalArguments(), llvm::SITargetLowering::passSpecialInputs(), and llvm::SwingSchedulerDAG::schedule().

◆ getAnalysis() [2/2]

template<typename AnalysisType >
AnalysisType & llvm::Pass::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.

If as part of the dependencies, an IR transformation is triggered (e.g. because the analysis requires BreakCriticalEdges), and Changed is non null, *Changed is updated.

Definition at line 260 of file PassAnalysisSupport.h.

References assert(), and F.

◆ getAnalysisID() [1/2]

template<typename AnalysisType >
AnalysisType & llvm::Pass::getAnalysisID ( AnalysisID  PI) const

Definition at line 236 of file PassAnalysisSupport.h.

References assert(), and getAdjustedAnalysisPointer().

◆ getAnalysisID() [2/2]

template<typename AnalysisType >
AnalysisType & llvm::Pass::getAnalysisID ( AnalysisID  PI,
Function F,
bool *  Changed = nullptr 
)

Definition at line 267 of file PassAnalysisSupport.h.

References assert(), F, and getAdjustedAnalysisPointer().

◆ getAnalysisIfAvailable()

template<typename AnalysisType >
AnalysisType * llvm::Pass::getAnalysisIfAvailable

getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to get analysis information that might be around, for example to update it.

This is different than getAnalysis in that it can fail (if the analysis results haven't been computed), so should only be used if you can handle the case when the analysis is not available. This method is often used by transformation APIs to update analysis results for a pass automatically as the transform is performed.

Definition at line 211 of file PassAnalysisSupport.h.

References assert(), and getAdjustedAnalysisPointer().

◆ getAnalysisUsage()

void Pass::getAnalysisUsage ( AnalysisUsage ) const
virtual

getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.

If a pass specifies that it uses a particular analysis result to this function, it can then use the getAnalysis<AnalysisType>() function, below.

Reimplemented in llvm::legacy::PassManagerImpl, llvm::FPPassManager, llvm::legacy::FunctionPassManagerImpl, llvm::RGPassManager, llvm::LPPassManager, llvm::CallGraphSCCPass, llvm::LegacyInlinerBase, llvm::sroa::SROALegacyPass, llvm::gvn::GVNLegacyPass, IROutlinerLegacyPass, llvm::ScalarEvolutionWrapperPass, LoopInterchangeLegacyPass, llvm::ExternalAAWrapperPass, llvm::AAResultsWrapperPass, llvm::LoopInfoWrapperPass, llvm::MemorySSAWrapperPass, llvm::IRSimilarityIdentifierWrapperPass, llvm::RegionInfoPass, llvm::MemorySSAPrinterLegacyPass, LintLegacyPass, llvm::LoopAccessLegacyAnalysis, llvm::IRTranslator, X86LowerAMXIntrinsicsLegacyPass, llvm::RegBankSelect, llvm::MemoryDependenceWrapperPass, llvm::GVNHoistLegacyPass, llvm::BranchProbabilityInfoWrapperPass, llvm::AAEvalLegacyPass, llvm::CallGraphWrapperPass, llvm::SlotIndexes, llvm::AsmPrinter, llvm::DominatorTreeWrapperPass, llvm::NVPTXAsmPrinter, llvm::LiveIntervals, llvm::LiveVariables, llvm::BasicAAWrapperPass, llvm::GISelCSEAnalysisWrapperPass, llvm::MachineOptimizationRemarkEmitterPass, llvm::PredicateInfoPrinterLegacyPass, llvm::ProfileSummaryInfoWrapperPass, llvm::IVUsersWrapperPass, llvm::DOTGraphTraitsModulePrinter< AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT >, llvm::DominanceFrontierWrapperPass, llvm::AMDGPUArgumentUsageInfo, llvm::StackSafetyGlobalInfoWrapperPass, llvm::GlobalsAAWrapperPass, llvm::LazyValueInfoWrapperPass, llvm::OptimizationRemarkEmitterWrapperPass, llvm::MachineLoopInfo, llvm::PhiValuesWrapperPass, llvm::BlockFrequencyInfoWrapperPass, llvm::WebAssemblyExceptionInfo, llvm::ExecutionDomainFix, FunctionSpecializationLegacyPass, llvm::DOTGraphTraitsModuleViewer< AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT >, llvm::CFLSteensAAWrapperPass, llvm::AMDGPUAsmPrinter, llvm::DummyCGSCCPass, llvm::LCSSAVerificationPass, llvm::GISelKnownBitsAnalysis, llvm::StackSafetyInfoWrapperPass, llvm::CFLAndersAAWrapperPass, llvm::ReachingDefAnalysis, llvm::LazyBlockFrequencyInfoPass, llvm::DOTGraphTraitsPrinter< AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT >, llvm::DemandedBitsWrapperPass, llvm::StackProtector, llvm::MachineDominanceFrontier, llvm::MachineRegionInfoPass, llvm::LazyBranchProbabilityInfoPass, llvm::MachinePipeliner, llvm::objcarc::ObjCARCAAWrapperPass, llvm::MachineDominatorTree, llvm::ImmutableModuleSummaryIndexWrapperPass, llvm::LiveStacks, llvm::Localizer, llvm::MachinePostDominatorTree, llvm::PostDominatorTreeWrapperPass, llvm::AMDGPUAAWrapperPass, llvm::TypeBasedAAWrapperPass, llvm::IntervalPartition, llvm::VirtRegMap, llvm::ScopedNoAliasAAWrapperPass, LiveDebugValues, llvm::ModuleSummaryIndexWrapperPass, llvm::SelectionDAGISel, llvm::LazyMachineBlockFrequencyInfoPass, llvm::SCEVAAWrapperPass, llvm::DOTGraphTraitsViewer< AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT >, llvm::AMDGPUResourceUsageAnalysis, llvm::BreakFalseDeps, llvm::MachineFunctionPass, llvm::InstructionCombiningPass, llvm::Legalizer, llvm::MachineBlockFrequencyInfo, llvm::ARMBlockPlacement, llvm::MipsDAGToDAGISel, llvm::MachineBranchProbabilityInfo, llvm::LegacyDivergenceAnalysis, llvm::InstructionSelect, llvm::InjectTLIMappingsLegacy, llvm::ReplaceWithVeclibLegacy, llvm::AMDGPUPerfHintAnalysis, llvm::UnifyFunctionExitNodesLegacyPass, llvm::DependenceAnalysisWrapperPass, and llvm::MachineTraceMetrics.

Definition at line 93 of file Pass.cpp.

Referenced by llvm::MachineFunctionPass::getAnalysisUsage().

◆ getAsImmutablePass()

ImmutablePass * Pass::getAsImmutablePass ( )
virtual

Reimplemented in llvm::ImmutablePass.

Definition at line 109 of file Pass.cpp.

◆ getAsPMDataManager()

PMDataManager * Pass::getAsPMDataManager ( )
virtual

◆ getPassID()

AnalysisID llvm::Pass::getPassID ( ) const
inline

getPassID - Return the PassID number that corresponds to this pass.

Definition at line 110 of file Pass.h.

Referenced by getPassName(), and llvm::TargetPassConfig::insertPass().

◆ getPassKind()

PassKind llvm::Pass::getPassKind ( ) const
inline

Definition at line 102 of file Pass.h.

◆ getPassName()

StringRef Pass::getPassName ( ) const
virtual

◆ getPotentialPassManagerType()

PassManagerType Pass::getPotentialPassManagerType ( ) const
virtual

Return what kind of Pass Manager can manage this pass.

Reimplemented in llvm::FunctionPass, llvm::ModulePass, llvm::RegionPass, llvm::CallGraphSCCPass, and llvm::LoopPass.

Definition at line 88 of file Pass.cpp.

References llvm::PMT_Unknown.

Referenced by llvm::PMTopLevelManager::schedulePass().

◆ getResolver()

AnalysisResolver* llvm::Pass::getResolver ( ) const
inline

Definition at line 150 of file Pass.h.

Referenced by llvm::PMTopLevelManager::setLastUser().

◆ lookupPassInfo() [1/2]

const PassInfo * Pass::lookupPassInfo ( const void *  TI)
static

◆ lookupPassInfo() [2/2]

const PassInfo * Pass::lookupPassInfo ( StringRef  Arg)
static

◆ mustPreserveAnalysisID()

bool Pass::mustPreserveAnalysisID ( char &  AID) const

mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID.

This obviously cannot give you a properly typed instance of the class if you don't have the class name available (use getAnalysisIfAvailable if you do), but it can tell you if you need to preserve the pass at least.

Definition at line 64 of file Pass.cpp.

Referenced by llvm::LPPassManager::runOnFunction().

◆ operator=()

Pass& llvm::Pass::operator= ( const Pass )
delete

◆ preparePassManager()

void Pass::preparePassManager ( PMStack )
virtual

Check if available pass managers are suitable for this pass or not.

Reimplemented in llvm::RegionPass, and llvm::LoopPass.

Definition at line 84 of file Pass.cpp.

◆ print()

void Pass::print ( raw_ostream OS,
const Module M 
) const
virtual

print - Print out the internal state of the pass.

This is called by Analyze to print out the contents of an analysis. Otherwise it is not necessary to implement this method. Beware that the module pointer MAY be null. This automatically forwards to a virtual function that does not provide the Module* in case the analysis doesn't need it it can just be ignored.

Reimplemented in llvm::MemorySSAWrapperPass, llvm::LoopAccessLegacyAnalysis, llvm::BranchProbabilityInfoWrapperPass, llvm::DominatorTreeWrapperPass, llvm::VirtRegMap, llvm::AMDGPUArgumentUsageInfo, llvm::WebAssemblyExceptionInfo, llvm::PhysicalRegisterUsageInfo, llvm::BlockFrequencyInfoWrapperPass, llvm::LazyBlockFrequencyInfoPass, llvm::DemandedBitsWrapperPass, llvm::LazyBranchProbabilityInfoPass, llvm::LazyMachineBlockFrequencyInfoPass, llvm::ScalarEvolutionWrapperPass, llvm::IVUsersWrapperPass, llvm::DominanceFrontierWrapperPass, llvm::RegionInfoPass, llvm::MachineDominatorTree, llvm::MachineRegionInfoPass, llvm::PostDominatorTreeWrapperPass, llvm::LegacyDivergenceAnalysis, llvm::LoopInfoWrapperPass, LintLegacyPass, llvm::StackSafetyGlobalInfoWrapperPass, llvm::StackSafetyInfoWrapperPass, llvm::LiveIntervals, llvm::LiveStacks, llvm::IntervalPartition, llvm::CallGraphWrapperPass, llvm::DependenceAnalysisWrapperPass, and llvm::MachinePostDominatorTree.

Definition at line 125 of file Pass.cpp.

References getPassName().

Referenced by llvm::A57ChainingConstraint::apply(), llvm::SpillPlacement::BlockConstraint::dump(), dump(), llvm::XCoreRegisterInfo::eliminateFrameIndex(), llvm::ARMTargetLowering::EmitInstrWithCustomInserter(), llvm::HexagonLowerToMC(), llvm::MSP430MCInstLower::Lower(), llvm::BPFMCInstLower::Lower(), llvm::LanaiMCInstLower::Lower(), llvm::WebAssemblyMCInstLower::lower(), llvm::DiagnosticInfoMIROptimization::MachineArgument::MachineArgument(), llvm::operator<<(), llvm::LazyMachineBlockFrequencyInfoPass::print(), llvm::MachineBasicBlock::print(), llvm::AArch64InstPrinter::printAdrpLabel(), llvm::AArch64InstPrinter::printAlignedLabel(), llvm::AArch64InstPrinter::printInst(), and llvm::X86IntelInstPrinter::printU8Imm().

◆ releaseMemory()

void Pass::releaseMemory ( )
virtual

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.

The default behavior of passes is to hold onto memory for the entire duration of their lifetime (which is the entire compile time). For pipelined passes, this is not a big deal because that memory gets recycled every time the pass is invoked on another program unit. For IP passes, it is more important to free memory when it is unused.

Optionally implement this function to release pass memory when it is no longer used.

Reimplemented in llvm::ScalarEvolutionWrapperPass, llvm::LoopInfoWrapperPass, llvm::MemorySSAWrapperPass, llvm::DependenceAnalysisWrapperPass, llvm::RegionInfoPass, llvm::LoopAccessLegacyAnalysis, llvm::MemoryDependenceWrapperPass, llvm::BranchProbabilityInfoWrapperPass, llvm::CallGraphWrapperPass, llvm::SlotIndexes, llvm::DominatorTreeWrapperPass, llvm::LiveIntervals, llvm::LiveVariables, llvm::AssumptionCacheTracker, llvm::GISelCSEAnalysisWrapperPass, llvm::MachineDominatorTree, llvm::IVUsersWrapperPass, llvm::DominanceFrontierWrapperPass, llvm::LazyValueInfoWrapperPass, llvm::BlockFrequencyInfoWrapperPass, llvm::PhiValuesWrapperPass, llvm::MachineLoopInfo, llvm::WebAssemblyExceptionInfo, llvm::GISelKnownBitsAnalysis, llvm::LazyBlockFrequencyInfoPass, llvm::ReachingDefAnalysis, llvm::DemandedBitsWrapperPass, llvm::MachineTraceMetrics, llvm::LazyBranchProbabilityInfoPass, llvm::MachineDominanceFrontier, llvm::MachineRegionInfoPass, llvm::LiveStacks, llvm::IntervalPartition, llvm::PostDominatorTreeWrapperPass, llvm::MachinePostDominatorTree, llvm::LazyMachineBlockFrequencyInfoPass, and llvm::MachineBlockFrequencyInfo.

Definition at line 97 of file Pass.cpp.

Referenced by llvm::legacy::FunctionPassManagerImpl::releaseMemoryOnTheFly().

◆ setResolver()

void Pass::setResolver ( AnalysisResolver AR)

Definition at line 117 of file Pass.cpp.

References assert().

Referenced by llvm::legacy::FunctionPassManager::FunctionPassManager().

◆ verifyAnalysis()

void Pass::verifyAnalysis ( ) const
virtual

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