LLVM  14.0.0git
Public Member Functions | Static Public Attributes | List of all members
llvm::FPPassManager Class Reference

FPPassManager manages BBPassManagers and FunctionPasses. More...

#include "llvm/IR/LegacyPassManagers.h"

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

Public Member Functions

 FPPassManager ()
 
bool runOnFunction (Function &F)
 run - Execute all of the passes scheduled for execution. More...
 
bool runOnModule (Module &M) override
 runOnModule - Virtual method overriden by subclasses to process the module being operated on. More...
 
void cleanup ()
 cleanup - After running all passes, clean up pass manager cache. More...
 
bool doInitialization (Module &M) override
 doInitialization - Run all of the initializers for the function passes. More...
 
bool doFinalization (Module &M) override
 doFinalization - Run all of the finalizers for the function passes. More...
 
PMDataManagergetAsPMDataManager () override
 
PassgetAsPass () override
 
void getAnalysisUsage (AnalysisUsage &Info) const override
 Pass Manager itself does not invalidate any analysis info. More...
 
void dumpPassStructure (unsigned Offset) override
 Print passes managed by this manager. More...
 
StringRef getPassName () const override
 getPassName - Return a nice clean name for a pass. More...
 
FunctionPassgetContainedPass (unsigned N)
 
PassManagerType getPassManagerType () const override
 
- Public Member Functions inherited from llvm::ModulePass
 ModulePass (char &pid)
 
 ~ModulePass () override
 
PasscreatePrinterPass (raw_ostream &OS, const std::string &Banner) const override
 createPrinterPass - Get a module printer pass. 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
 
AnalysisID getPassID () const
 getPassID - Return the PassID number that corresponds to this pass. 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 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 void verifyAnalysis () const
 verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information. More...
 
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)
 
- Public Member Functions inherited from llvm::PMDataManager
 PMDataManager ()
 
virtual ~PMDataManager ()
 
void recordAvailableAnalysis (Pass *P)
 Augment AvailableAnalysis by adding analysis made available by pass P. More...
 
void verifyPreservedAnalysis (Pass *P)
 verifyPreservedAnalysis – Verify analysis presreved by pass P. More...
 
void removeNotPreservedAnalysis (Pass *P)
 Remove Analysis that is not preserved by the pass. More...
 
void removeDeadPasses (Pass *P, StringRef Msg, enum PassDebuggingString)
 Remove dead passes used by P. More...
 
void freePass (Pass *P, StringRef Msg, enum PassDebuggingString)
 Remove P. More...
 
void add (Pass *P, bool ProcessAnalysis=true)
 Add pass P into the PassVector. More...
 
virtual void addLowerLevelRequiredPass (Pass *P, Pass *RequiredPass)
 Add RequiredPass into list of lower level passes required by pass P. More...
 
virtual std::tuple< Pass *, bool > getOnTheFlyPass (Pass *P, AnalysisID PI, Function &F)
 
void initializeAnalysisInfo ()
 Initialize available analysis information. More...
 
bool preserveHigherLevelAnalysis (Pass *P)
 
void collectRequiredAndUsedAnalyses (SmallVectorImpl< Pass * > &UsedPasses, SmallVectorImpl< AnalysisID > &ReqPassNotAvailable, Pass *P)
 Populate UsedPasses with analysis pass that are used or required by pass P and are available. More...
 
void initializeAnalysisImpl (Pass *P)
 All Required analyses should be available to the pass as it runs! Here we fill in the AnalysisImpls member of the pass so that it can successfully use the getAnalysis() method to retrieve the implementations it needs. More...
 
PassfindAnalysisPass (AnalysisID AID, bool Direction)
 Find the pass that implements Analysis AID. More...
 
PMTopLevelManagergetTopLevelManager ()
 
void setTopLevelManager (PMTopLevelManager *T)
 
unsigned getDepth () const
 
void setDepth (unsigned newDepth)
 
void dumpLastUses (Pass *P, unsigned Offset) const
 
void dumpPassArguments () const
 
void dumpPassInfo (Pass *P, enum PassDebuggingString S1, enum PassDebuggingString S2, StringRef Msg)
 
void dumpRequiredSet (const Pass *P) const
 
void dumpPreservedSet (const Pass *P) const
 
void dumpUsedSet (const Pass *P) const
 
unsigned getNumContainedPasses () const
 
DenseMap< AnalysisID, Pass * > * getAvailableAnalysis ()
 
void populateInheritedAnalysis (PMStack &PMS)
 
unsigned initSizeRemarkInfo (Module &M, StringMap< std::pair< unsigned, unsigned >> &FunctionToInstrCount)
 Set the initial size of the module if the user has specified that they want remarks for size. More...
 
void emitInstrCountChangedRemark (Pass *P, Module &M, int64_t Delta, unsigned CountBefore, StringMap< std::pair< unsigned, unsigned >> &FunctionToInstrCount, Function *F=nullptr)
 Emit a remark signifying that the number of IR instructions in the module changed. More...
 

Static Public Attributes

static char ID = 0
 

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)
 
- Protected Member Functions inherited from llvm::ModulePass
bool skipModule (Module &M) const
 Optional passes call this function to check whether the pass should be skipped. More...
 
- Protected Member Functions inherited from llvm::PMDataManager
bool isPassDebuggingExecutionsOrMore () const
 isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions or higher is specified. More...
 
- Protected Attributes inherited from llvm::PMDataManager
PMTopLevelManagerTPM
 
SmallVector< Pass *, 16 > PassVector
 
DenseMap< AnalysisID, Pass * > * InheritedAnalysis [PMT_Last]
 

Detailed Description

FPPassManager manages BBPassManagers and FunctionPasses.

It batches all function passes and basic block pass managers together and sequence them to process one function at a time before processing next function.

Definition at line 460 of file LegacyPassManagers.h.

Constructor & Destructor Documentation

◆ FPPassManager()

llvm::FPPassManager::FPPassManager ( )
inlineexplicit

Definition at line 463 of file LegacyPassManagers.h.

Member Function Documentation

◆ cleanup()

void FPPassManager::cleanup ( )

cleanup - After running all passes, clean up pass manager cache.

Definition at line 1375 of file LegacyPassManager.cpp.

References assert(), llvm::AnalysisResolver::clearAnalysisImpls(), FP, getContainedPass(), llvm::PMDataManager::getNumContainedPasses(), and Index.

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

◆ doFinalization()

bool FPPassManager::doFinalization ( Module M)
overridevirtual

doFinalization - Run all of the finalizers for the function passes.

Reimplemented from llvm::Pass.

Definition at line 1499 of file LegacyPassManager.cpp.

References llvm::Pass::doFinalization(), getContainedPass(), llvm::PMDataManager::getNumContainedPasses(), Index, and M.

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

◆ doInitialization()

bool FPPassManager::doInitialization ( Module M)
overridevirtual

doInitialization - Run all of the initializers for the function passes.

Reimplemented from llvm::Pass.

Definition at line 1490 of file LegacyPassManager.cpp.

References llvm::Pass::doInitialization(), getContainedPass(), llvm::PMDataManager::getNumContainedPasses(), Index, and M.

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

◆ dumpPassStructure()

void FPPassManager::dumpPassStructure ( unsigned  Offset)
overridevirtual

◆ getAnalysisUsage()

void llvm::FPPassManager::getAnalysisUsage ( AnalysisUsage Info) const
inlineoverridevirtual

Pass Manager itself does not invalidate any analysis info.

Reimplemented from llvm::Pass.

Definition at line 496 of file LegacyPassManagers.h.

References Info.

◆ getAsPass()

Pass* llvm::FPPassManager::getAsPass ( )
inlineoverridevirtual

Implements llvm::PMDataManager.

Definition at line 493 of file LegacyPassManagers.h.

◆ getAsPMDataManager()

PMDataManager* llvm::FPPassManager::getAsPMDataManager ( )
inlineoverridevirtual

Reimplemented from llvm::Pass.

Definition at line 492 of file LegacyPassManagers.h.

◆ getContainedPass()

FunctionPass* llvm::FPPassManager::getContainedPass ( unsigned  N)
inline

◆ getPassManagerType()

PassManagerType llvm::FPPassManager::getPassManagerType ( ) const
inlineoverridevirtual

Reimplemented from llvm::PMDataManager.

Definition at line 511 of file LegacyPassManagers.h.

References llvm::PMT_FunctionPassManager.

◆ getPassName()

StringRef llvm::FPPassManager::getPassName ( ) const
inlineoverridevirtual

getPassName - Return a nice clean name for a pass.

This usually implemented in terms of the name that is registered by one of the Registration templates, but can be overloaded directly.

Reimplemented from llvm::Pass.

Definition at line 503 of file LegacyPassManagers.h.

◆ runOnFunction()

bool FPPassManager::runOnFunction ( Function F)

◆ runOnModule()

bool FPPassManager::runOnModule ( Module M)
overridevirtual

runOnModule - Virtual method overriden by subclasses to process the module being operated on.

Implements llvm::ModulePass.

Definition at line 1481 of file LegacyPassManager.cpp.

References F, M, and runOnFunction().

Member Data Documentation

◆ ID

char FPPassManager::ID = 0
static

Definition at line 462 of file LegacyPassManagers.h.


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