LLVM  3.7.0
Public Member Functions | Protected Member Functions | List of all members
llvm::LoopPass Class Referenceabstract

#include <LoopPass.h>

Inheritance diagram for llvm::LoopPass:
[legend]
Collaboration diagram for llvm::LoopPass:
[legend]

Public Member Functions

 LoopPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &O, const std::string &Banner) const override
 getPrinterPass - Get a pass to print the function corresponding to a Loop. More...
 
virtual bool runOnLoop (Loop *L, LPPassManager &LPM)=0
 
virtual bool doInitialization (Loop *L, LPPassManager &LPM)
 
virtual bool doFinalization ()
 
void preparePassManager (PMStack &PMS) override
 Check if available pass managers are suitable for this pass or not. More...
 
void assignPassManager (PMStack &PMS, PassManagerType PMT) override
 Assign pass manager to manage this pass. More...
 
PassManagerType getPotentialPassManagerType () const override
 Return what kind of Pass Manager can manage this pass. More...
 
virtual void cloneBasicBlockAnalysis (BasicBlock *F, BasicBlock *T, Loop *L)
 SimpleAnalysis - Provides simple interface to update analysis info maintained by various passes. More...
 
virtual void deleteAnalysisValue (Value *V, Loop *L)
 deleteAnalysisValue - Delete analysis info associated with value V. More...
 
virtual void deleteAnalysisLoop (Loop *L)
 Delete analysis info associated with Loop L. More...
 
- Public Member Functions inherited from llvm::Pass
 Pass (PassKind K, char &pid)
 
virtual ~Pass ()
 
PassKind getPassKind () const
 
virtual const char * 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 &O, const Module *M) const
 print - Print out the internal state of the pass. More...
 
void dump () const
 
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)
 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)
 

Protected Member Functions

bool skipOptnoneFunction (const Loop *L) const
 skipOptnoneFunction - Containing function has Attribute::OptimizeNone and most transformation passes should skip it. More...
 

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)
 

Detailed Description

Definition at line 29 of file LoopPass.h.

Constructor & Destructor Documentation

llvm::LoopPass::LoopPass ( char &  pid)
inlineexplicit

Definition at line 31 of file LoopPass.h.

Member Function Documentation

void LoopPass::assignPassManager ( PMStack PMS,
PassManagerType  PMT 
)
overridevirtual
virtual void llvm::LoopPass::cloneBasicBlockAnalysis ( BasicBlock F,
BasicBlock T,
Loop L 
)
inlinevirtual

SimpleAnalysis - Provides simple interface to update analysis info maintained by various 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. Each loop pass can override these simple analysis hooks to update desired analysis information. cloneBasicBlockAnalysis - Clone analysis info associated with basic block.

Definition at line 80 of file LoopPass.h.

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

Pass * LoopPass::createPrinterPass ( raw_ostream O,
const std::string &  Banner 
) const
overridevirtual

getPrinterPass - Get a pass to print the function corresponding to a Loop.

Implements llvm::Pass.

Definition at line 328 of file LoopPass.cpp.

virtual void llvm::LoopPass::deleteAnalysisLoop ( Loop L)
inlinevirtual

Delete analysis info associated with Loop L.

Called to notify a Pass that a loop has been deleted and any associated analysis values can be deleted.

Definition at line 88 of file LoopPass.h.

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

virtual void llvm::LoopPass::deleteAnalysisValue ( Value V,
Loop L 
)
inlinevirtual

deleteAnalysisValue - Delete analysis info associated with value V.

Definition at line 83 of file LoopPass.h.

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

virtual bool llvm::LoopPass::doFinalization ( )
inlinevirtual

Definition at line 52 of file LoopPass.h.

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

virtual bool llvm::LoopPass::doInitialization ( Loop L,
LPPassManager LPM 
)
inlinevirtual

Definition at line 46 of file LoopPass.h.

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

PassManagerType llvm::LoopPass::getPotentialPassManagerType ( ) const
inlineoverridevirtual

Return what kind of Pass Manager can manage this pass.

Reimplemented from llvm::Pass.

Definition at line 66 of file LoopPass.h.

References llvm::PMT_LoopPassManager.

void LoopPass::preparePassManager ( PMStack )
overridevirtual

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

Reimplemented from llvm::Pass.

Definition at line 339 of file LoopPass.cpp.

References llvm::PMStack::empty(), llvm::PMDataManager::getPassManagerType(), llvm::PMT_LoopPassManager, llvm::PMStack::pop(), llvm::PMDataManager::preserveHigherLevelAnalysis(), and llvm::PMStack::top().

virtual bool llvm::LoopPass::runOnLoop ( Loop L,
LPPassManager LPM 
)
pure virtual
bool LoopPass::skipOptnoneFunction ( const Loop L) const
protected

skipOptnoneFunction - Containing function has Attribute::OptimizeNone and most transformation passes should skip it.

Definition at line 392 of file LoopPass.cpp.

References llvm::dbgs(), DEBUG, F(), llvm::LoopBase< N, M >::getHeader(), llvm::Value::getName(), llvm::Pass::getPassName(), llvm::Function::hasFnAttribute(), and llvm::Attribute::OptimizeNone.


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