LLVM  8.0.1
Public Member Functions | Static Public Attributes | List of all members
llvm::LPPassManager Class Reference

#include "llvm/Analysis/LoopPass.h"

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

Public Member Functions

 LPPassManager ()
 
bool runOnFunction (Function &F) override
 run - Execute all of the passes scheduled for execution. More...
 
void getAnalysisUsage (AnalysisUsage &Info) const override
 Pass Manager itself does not invalidate any analysis info. More...
 
StringRef getPassName () const override
 getPassName - Return a nice clean name for a pass. More...
 
PMDataManagergetAsPMDataManager () override
 
PassgetAsPass () override
 
void dumpPassStructure (unsigned Offset) override
 Print passes managed by this manager. More...
 
LoopPassgetContainedPass (unsigned N)
 
PassManagerType getPassManagerType () const override
 
void addLoop (Loop &L)
 
void markLoopAsDeleted (Loop &L)
 
void cloneBasicBlockSimpleAnalysis (BasicBlock *From, BasicBlock *To, Loop *L)
 SimpleAnalysis - Provides simple interface to update analysis info maintained by various passes. More...
 
void deleteSimpleAnalysisValue (Value *V, Loop *L)
 deleteSimpleAnalysisValue - Invoke deleteAnalysisValue hook for all passes that implement simple analysis interface. More...
 
void deleteSimpleAnalysisLoop (Loop *L)
 Invoke deleteAnalysisLoop hook for all passes that implement simple analysis interface. More...
 
- Public Member Functions inherited from llvm::FunctionPass
 FunctionPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &OS, const std::string &Banner) const override
 createPrinterPass - Get a function printer pass. More...
 
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. 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 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 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)
 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)
 
- 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 PassgetOnTheFlyPass (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::FunctionPass
bool skipFunction (const Function &F) 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

Definition at line 97 of file LoopPass.h.

Constructor & Destructor Documentation

◆ LPPassManager()

LPPassManager::LPPassManager ( )
explicit

Definition at line 70 of file LoopPass.cpp.

Referenced by llvm::LoopPass::assignPassManager().

Member Function Documentation

◆ addLoop()

void LPPassManager::addLoop ( Loop L)

◆ cloneBasicBlockSimpleAnalysis()

void LPPassManager::cloneBasicBlockSimpleAnalysis ( BasicBlock From,
BasicBlock To,
Loop L 
)

SimpleAnalysis - Provides simple interface to update analysis info maintained by various passes.

cloneBasicBlockSimpleAnalysis - Invoke cloneBasicBlockAnalysis hook for all loop passes.

Note, if required this interface can be extracted into a separate abstract class but it would require additional use of multiple inheritance in Pass class hierarchy, something we are trying to avoid. cloneBasicBlockSimpleAnalysis - Invoke cloneBasicBlockAnalysis hook for all passes that implement simple analysis interface.

Definition at line 97 of file LoopPass.cpp.

References llvm::LoopPass::cloneBasicBlockAnalysis(), getContainedPass(), and llvm::PMDataManager::getNumContainedPasses().

Referenced by CloneLoop().

◆ deleteSimpleAnalysisLoop()

void LPPassManager::deleteSimpleAnalysisLoop ( Loop L)

Invoke deleteAnalysisLoop hook for all passes that implement simple analysis interface.

Invoke deleteAnalysisLoop hook for all passes.

Definition at line 119 of file LoopPass.cpp.

References llvm::LoopPass::deleteAnalysisLoop(), getContainedPass(), and llvm::PMDataManager::getNumContainedPasses().

Referenced by llvm::SimpleLoopUnswitchPass::run(), and runOnFunction().

◆ deleteSimpleAnalysisValue()

void LPPassManager::deleteSimpleAnalysisValue ( Value V,
Loop L 
)

deleteSimpleAnalysisValue - Invoke deleteAnalysisValue hook for all passes that implement simple analysis interface.

deleteSimpleAnalysisValue - Invoke deleteAnalysisValue hook for all passes.

Definition at line 106 of file LoopPass.cpp.

References llvm::LoopPass::deleteAnalysisValue(), getContainedPass(), llvm::PMDataManager::getNumContainedPasses(), and I.

Referenced by CloneLoop(), and ReplaceUsesOfWith().

◆ dumpPassStructure()

void LPPassManager::dumpPassStructure ( unsigned  Offset)
overridevirtual

◆ getAnalysisUsage()

void LPPassManager::getAnalysisUsage ( AnalysisUsage Info) const
overridevirtual

Pass Manager itself does not invalidate any analysis info.

Reimplemented from llvm::Pass.

Definition at line 135 of file LoopPass.cpp.

References llvm::AnalysisUsage::addRequired(), and llvm::AnalysisUsage::setPreservesAll().

◆ getAsPass()

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

Implements llvm::PMDataManager.

Definition at line 113 of file LoopPass.h.

References llvm::Pass::dumpPassStructure().

Referenced by llvm::LoopPass::assignPassManager().

◆ getAsPMDataManager()

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

Reimplemented from llvm::Pass.

Definition at line 112 of file LoopPass.h.

◆ getContainedPass()

LoopPass* llvm::LPPassManager::getContainedPass ( unsigned  N)
inline

◆ getPassManagerType()

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

Reimplemented from llvm::PMDataManager.

Definition at line 124 of file LoopPass.h.

References From, and llvm::PMT_LoopPassManager.

◆ getPassName()

StringRef llvm::LPPassManager::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 110 of file LoopPass.h.

Referenced by llvm::LoopPass::skipLoop().

◆ markLoopAsDeleted()

void LPPassManager::markLoopAsDeleted ( Loop L)

◆ runOnFunction()

bool LPPassManager::runOnFunction ( Function F)
overridevirtual

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.

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

Implements llvm::FunctionPass.

Definition at line 161 of file LoopPass.cpp.

References llvm::PMTopLevelManager::activeStack, addLoopIntoQueue(), assert(), deleteSimpleAnalysisLoop(), llvm::LoopPass::doFinalization(), llvm::LoopPass::doInitialization(), llvm::PMDataManager::dumpPassInfo(), llvm::PMDataManager::dumpPreservedSet(), llvm::PMDataManager::dumpRequiredSet(), llvm::PMDataManager::emitInstrCountChangedRemark(), llvm::EXECUTION_MSG, llvm::PMDataManager::freePass(), getContainedPass(), llvm::Function::getContext(), llvm::LoopBase< BlockT, LoopT >::getHeader(), llvm::Function::getInstructionCount(), llvm::Value::getName(), llvm::Loop::getName(), llvm::PMDataManager::getNumContainedPasses(), llvm::GlobalValue::getParent(), llvm::getPassTimer(), llvm::LCSSAVerificationPass::ID, llvm::PMDataManager::initializeAnalysisImpl(), llvm::PMDataManager::initSizeRemarkInfo(), InstrCount, llvm::Loop::isRecursivelyLCSSAForm(), llvm::MODIFICATION_MSG, llvm::Pass::mustPreserveAnalysisID(), llvm::ON_LOOP_MSG, P, llvm::PMDataManager::populateInheritedAnalysis(), llvm::PMDataManager::recordAvailableAnalysis(), llvm::PMDataManager::removeDeadPasses(), llvm::PMDataManager::removeNotPreservedAnalysis(), llvm::reverse(), llvm::LoopPass::runOnLoop(), llvm::Module::shouldEmitInstrCountChangedRemark(), llvm::PMDataManager::TPM, llvm::LoopBase< BlockT, LoopT >::verifyLoop(), llvm::PMDataManager::verifyPreservedAnalysis(), X, and llvm::LLVMContext::yield().

Member Data Documentation

◆ ID

char LPPassManager::ID = 0
static

Definition at line 99 of file LoopPass.h.


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