LLVM  6.0.0svn
Public Member Functions | Static Public Attributes | List of all members
llvm::LoopInfoWrapperPass Class Reference

The legacy pass manager's analysis pass to compute loop information. More...

#include "llvm/Analysis/LoopInfo.h"

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

Public Member Functions

 LoopInfoWrapperPass ()
 
LoopInfogetLoopInfo ()
 
const LoopInfogetLoopInfo () const
 
bool runOnFunction (Function &F) override
 Calculate the natural loop information for a given function. More...
 
void verifyAnalysis () const override
 verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information. More...
 
void releaseMemory () override
 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...
 
void print (raw_ostream &O, const Module *M=nullptr) const override
 print - Print out the internal state of the pass. More...
 
void getAnalysisUsage (AnalysisUsage &AU) const override
 getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job. 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
 
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...
 
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 * 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 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)
 

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...
 

Detailed Description

The legacy pass manager's analysis pass to compute loop information.

Definition at line 932 of file LoopInfo.h.

Constructor & Destructor Documentation

◆ LoopInfoWrapperPass()

llvm::LoopInfoWrapperPass::LoopInfoWrapperPass ( )
inline

Member Function Documentation

◆ getAnalysisUsage()

void LoopInfoWrapperPass::getAnalysisUsage ( AnalysisUsage ) const
overridevirtual

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 from llvm::Pass.

Definition at line 771 of file LoopInfo.cpp.

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

◆ getLoopInfo() [1/2]

LoopInfo& llvm::LoopInfoWrapperPass::getLoopInfo ( )
inline

Definition at line 942 of file LoopInfo.h.

◆ getLoopInfo() [2/2]

const LoopInfo& llvm::LoopInfoWrapperPass::getLoopInfo ( ) const
inline

Definition at line 943 of file LoopInfo.h.

References F().

◆ print()

void LoopInfoWrapperPass::print ( raw_ostream OS,
const Module M = nullptr 
) const
overridevirtual

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 from llvm::Pass.

Definition at line 776 of file LoopInfo.cpp.

◆ releaseMemory()

void llvm::LoopInfoWrapperPass::releaseMemory ( )
inlineoverridevirtual

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 from llvm::Pass.

Definition at line 950 of file LoopInfo.h.

References llvm::RISCVFenceField::O, llvm::LoopBase< BlockT, LoopT >::print(), llvm::printLoop(), and llvm::LoopInfoBase< BlockT, LoopT >::releaseMemory().

◆ runOnFunction()

Natural Loop true bool LoopInfoWrapperPass::runOnFunction ( Function F)
overridevirtual

Calculate the natural loop information for a given function.

Implements llvm::FunctionPass.

Definition at line 753 of file LoopInfo.cpp.

◆ verifyAnalysis()

void LoopInfoWrapperPass::verifyAnalysis ( ) const
overridevirtual

verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information.

Reimplemented from llvm::Pass.

Definition at line 759 of file LoopInfo.cpp.

References llvm::VerifyLoopInfo.

Member Data Documentation

◆ ID

char LoopInfoWrapperPass::ID = 0
static

Definition at line 936 of file LoopInfo.h.

Referenced by llvm::printLoop().


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