LLVM 19.0.0git
Public Member Functions | Static Public Attributes | List of all members
llvm::legacy::FunctionPassManagerImpl Class Reference

FunctionPassManagerImpl manages FPPassManagers. More...

Inheritance diagram for llvm::legacy::FunctionPassManagerImpl:
Inheritance graph

Public Member Functions

 FunctionPassManagerImpl ()
void add (Pass *P)
PasscreatePrinterPass (raw_ostream &O, const std::string &Banner) const override
 createPrinterPass - Get a function printer pass.
void releaseMemoryOnTheFly ()
bool run (Function &F)
 run - Execute all of the passes scheduled for execution.
bool doInitialization (Module &M) override
 doInitialization - Run all of the initializers for the function passes.
bool doFinalization (Module &M) override
 doFinalization - Run all of the finalizers for the function passes.
PMDataManagergetAsPMDataManager () override
PassgetAsPass () override
PassManagerType getTopLevelPassManagerType () override
void getAnalysisUsage (AnalysisUsage &Info) const override
 Pass Manager itself does not invalidate any analysis info.
FPPassManagergetContainedManager (unsigned N)
void dumpPassStructure (unsigned Offset) override
- 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.
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 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).
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)
AnalysisResolvergetResolver () 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 ImmutablePassgetAsImmutablePass ()
virtual PMDataManagergetAsPMDataManager ()
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)
- Public Member Functions inherited from llvm::PMDataManager
 PMDataManager ()
virtual ~PMDataManager ()
virtual PassgetAsPass ()=0
void recordAvailableAnalysis (Pass *P)
 Augment AvailableAnalysis by adding analysis made available by pass P.
void verifyPreservedAnalysis (Pass *P)
 verifyPreservedAnalysis – Verify analysis presreved by pass P.
void removeNotPreservedAnalysis (Pass *P)
 Remove Analysis that is not preserved by the pass.
void removeDeadPasses (Pass *P, StringRef Msg, enum PassDebuggingString)
 Remove dead passes used by P.
void freePass (Pass *P, StringRef Msg, enum PassDebuggingString)
 Remove P.
void add (Pass *P, bool ProcessAnalysis=true)
 Add pass P into the PassVector.
virtual void addLowerLevelRequiredPass (Pass *P, Pass *RequiredPass)
 Add RequiredPass into list of lower level passes required by pass P.
virtual std::tuple< Pass *, boolgetOnTheFlyPass (Pass *P, AnalysisID PI, Function &F)
void initializeAnalysisInfo ()
 Initialize available analysis information.
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.
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.
PassfindAnalysisPass (AnalysisID AID, bool Direction)
 Find the pass that implements Analysis AID.
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
virtual PassManagerType getPassManagerType () 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.
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.
- Public Member Functions inherited from llvm::PMTopLevelManager
void schedulePass (Pass *P)
 Schedule pass P for execution.
void setLastUser (ArrayRef< Pass * > AnalysisPasses, Pass *P)
 Set pass P as the last user of the given analysis passes.
void collectLastUses (SmallVectorImpl< Pass * > &LastUses, Pass *P)
 Collect passes whose last user is P.
PassfindAnalysisPass (AnalysisID AID)
 Find the pass that implements Analysis AID.
const PassInfofindAnalysisPassInfo (AnalysisID AID) const
 Retrieve the PassInfo for an analysis.
AnalysisUsagefindAnalysisUsage (Pass *P)
 Find analysis usage information for the pass P.
virtual ~PMTopLevelManager ()
void addImmutablePass (ImmutablePass *P)
 Add immutable pass and initialize it.
SmallVectorImpl< ImmutablePass * > & getImmutablePasses ()
void addPassManager (PMDataManager *Manager)
void addIndirectPassManager (PMDataManager *Manager)
void dumpPasses () const
void dumpArguments () const

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)
- Public Attributes inherited from llvm::PMTopLevelManager
PMStack activeStack
- Protected Member Functions inherited from llvm::PMDataManager
bool isPassDebuggingExecutionsOrMore () const
 isPassDebuggingExecutionsOrMore - Return true if -debug-pass=Executions or higher is specified.
- Protected Member Functions inherited from llvm::PMTopLevelManager
 PMTopLevelManager (PMDataManager *PMDM)
 Initialize top level manager. Create first pass manager.
unsigned getNumContainedManagers () const
void initializeAllAnalysisInfo ()
- Protected Attributes inherited from llvm::PMDataManager
PMTopLevelManagerTPM = nullptr
SmallVector< Pass *, 16 > PassVector
DenseMap< AnalysisID, Pass * > * InheritedAnalysis [PMT_Last]
- Protected Attributes inherited from llvm::PMTopLevelManager
SmallVector< PMDataManager *, 8 > PassManagers
 Collection of pass managers.

Detailed Description

FunctionPassManagerImpl manages FPPassManagers.

Definition at line 247 of file LegacyPassManager.cpp.

Constructor & Destructor Documentation

◆ FunctionPassManagerImpl()

llvm::legacy::FunctionPassManagerImpl::FunctionPassManagerImpl ( )

Definition at line 255 of file LegacyPassManager.cpp.

Member Function Documentation

◆ add()

void llvm::legacy::FunctionPassManagerImpl::add ( Pass P)

◆ createPrinterPass()

Pass * llvm::legacy::FunctionPassManagerImpl::createPrinterPass ( raw_ostream O,
const std::string &  Banner 
) const

createPrinterPass - Get a function printer pass.

Implements llvm::Pass.

Definition at line 265 of file LegacyPassManager.cpp.

References llvm::createPrintFunctionPass().

◆ doFinalization()

bool llvm::legacy::FunctionPassManagerImpl::doFinalization ( Module M)

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

Reimplemented from llvm::Pass.

Definition at line 332 of file LegacyPassManager.cpp.

References llvm::FPPassManager::doFinalization(), getContainedManager(), llvm::PMTopLevelManager::getImmutablePasses(), and llvm::PMTopLevelManager::getNumContainedManagers().

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

◆ doInitialization()

bool llvm::legacy::FunctionPassManagerImpl::doInitialization ( Module M)

◆ dumpPassStructure()

void llvm::legacy::FunctionPassManagerImpl::dumpPassStructure ( unsigned  Offset)

◆ getAnalysisUsage()

void llvm::legacy::FunctionPassManagerImpl::getAnalysisUsage ( AnalysisUsage Info) const

Pass Manager itself does not invalidate any analysis info.

Reimplemented from llvm::Pass.

Definition at line 294 of file LegacyPassManager.cpp.

References Info.

◆ getAsPass()

Pass * llvm::legacy::FunctionPassManagerImpl::getAsPass ( )

Implements llvm::PMDataManager.

Definition at line 288 of file LegacyPassManager.cpp.

◆ getAsPMDataManager()

PMDataManager * llvm::legacy::FunctionPassManagerImpl::getAsPMDataManager ( )

Implements llvm::PMTopLevelManager.

Definition at line 287 of file LegacyPassManager.cpp.

◆ getContainedManager()

FPPassManager * llvm::legacy::FunctionPassManagerImpl::getContainedManager ( unsigned  N)

◆ getTopLevelPassManagerType()

PassManagerType llvm::legacy::FunctionPassManagerImpl::getTopLevelPassManagerType ( )

Implements llvm::PMTopLevelManager.

Definition at line 289 of file LegacyPassManager.cpp.

References llvm::PMT_FunctionPassManager.

◆ releaseMemoryOnTheFly()

void llvm::legacy::FunctionPassManagerImpl::releaseMemoryOnTheFly ( )

◆ run()

bool llvm::legacy::FunctionPassManagerImpl::run ( Function F)

run - Execute all of the passes scheduled for execution.

Keep track of whether any of the passes modifies the module, and if so, return true.

Definition at line 358 of file LegacyPassManager.cpp.

References llvm::FPPassManager::cleanup(), F, getContainedManager(), llvm::PMTopLevelManager::getNumContainedManagers(), llvm::PMTopLevelManager::initializeAllAnalysisInfo(), and llvm::FPPassManager::runOnFunction().

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

Member Data Documentation

◆ ID

char llvm::legacy::FunctionPassManagerImpl::ID = 0

Definition at line 254 of file LegacyPassManager.cpp.

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