LLVM API Documentation

llvm::LoopInfo Class Reference

#include <LoopInfo.h>

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

List of all members.

Public Types

typedef LoopInfoBase
< BasicBlock, Loop >::iterator 
iterator

Public Member Functions

 LoopInfo ()
LoopInfoBase< BasicBlock, Loop > & getBase ()
iterator begin () const
iterator end () const
bool empty () const
Loop * getLoopFor (const BasicBlock *BB) const
const Loop * operator[] (const BasicBlock *BB) const
unsigned getLoopDepth (const BasicBlock *BB) const
bool isLoopHeader (BasicBlock *BB) const
virtual bool runOnFunction (Function &F)
virtual void releaseMemory ()
virtual void print (std::ostream &O, const Module *M=0) const
virtual void getAnalysisUsage (AnalysisUsage &AU) const
Loop * removeLoop (iterator I)
void changeLoopFor (BasicBlock *BB, Loop *L)
void changeTopLevelLoop (Loop *OldLoop, Loop *NewLoop)
void addTopLevelLoop (Loop *New)
void removeBlock (BasicBlock *BB)

Static Public Member Functions

static bool isNotAlreadyContainedIn (const Loop *SubLoop, const Loop *ParentLoop)

Static Public Attributes

static char ID = 0

Friends

class LoopBase< BasicBlock, Loop >


Detailed Description

Definition at line 893 of file LoopInfo.h.


Member Typedef Documentation

iterator/begin/end - The interface to the top-level loops in the current function.

Definition at line 909 of file LoopInfo.h.


Constructor & Destructor Documentation

llvm::LoopInfo::LoopInfo (  )  [inline]

Definition at line 902 of file LoopInfo.h.


Member Function Documentation

LoopInfoBase<BasicBlock, Loop>& llvm::LoopInfo::getBase (  )  [inline]

iterator llvm::LoopInfo::begin (  )  const [inline]

iterator llvm::LoopInfo::end (  )  const [inline]

bool llvm::LoopInfo::empty (  )  const [inline]

Definition at line 912 of file LoopInfo.h.

References empty(), and LI.

Referenced by llvm::MachineLoopInfo::empty(), and empty().

Loop* llvm::LoopInfo::getLoopFor ( const BasicBlock *  BB  )  const [inline]

getLoopFor - Return the inner most loop that BB lives in. If a basic block is in no loop (for example the entry node), null is returned.

Definition at line 917 of file LoopInfo.h.

References getLoopFor(), and LI.

Referenced by llvm::IVUsers::AddUsersIfInteresting(), CloneLoop(), llvm::LPPassManager::deleteLoopFromQueue(), llvm::MachineLoopInfo::getLoopFor(), getLoopFor(), llvm::MachineLoopInfo::operator[](), operator[](), llvm::MSILWriter::printFunctionBody(), llvm::MSILWriter::printLoop(), llvm::SplitBlock(), and llvm::SplitCriticalEdge().

const Loop* llvm::LoopInfo::operator[] ( const BasicBlock *  BB  )  const [inline]

operator[] - same as getLoopFor...

Definition at line 923 of file LoopInfo.h.

References getLoopFor(), and LI.

unsigned llvm::LoopInfo::getLoopDepth ( const BasicBlock *  BB  )  const [inline]

getLoopDepth - Return the loop nesting level of the specified block. A depth of 0 means the block is not inside any loop.

Definition at line 930 of file LoopInfo.h.

References getLoopDepth(), and LI.

Referenced by llvm::MachineLoopInfo::getLoopDepth(), and getLoopDepth().

bool llvm::LoopInfo::isLoopHeader ( BasicBlock *  BB  )  const [inline]

Definition at line 935 of file LoopInfo.h.

References isLoopHeader(), and LI.

Referenced by llvm::MachineLoopInfo::isLoopHeader(), and isLoopHeader().

bool LoopInfo::runOnFunction ( Function &  F  )  [virtual]

runOnFunction - Calculate the natural loop information.

Implements llvm::FunctionPass.

Definition at line 301 of file LoopInfo.cpp.

References getBase(), and releaseMemory().

virtual void llvm::LoopInfo::releaseMemory (  )  [inline, virtual]

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 943 of file LoopInfo.h.

References LI, and releaseMemory().

Referenced by llvm::MachineLoopInfo::releaseMemory(), releaseMemory(), and runOnFunction().

virtual void llvm::LoopInfo::print ( std::ostream &  O,
const Module *  M = 0 
) const [inline, virtual]

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 945 of file LoopInfo.h.

References LI, M, and print().

Referenced by print().

void LoopInfo::getAnalysisUsage ( AnalysisUsage &   )  const [virtual]

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 307 of file LoopInfo.cpp.

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

Loop* llvm::LoopInfo::removeLoop ( iterator  I  )  [inline]

removeLoop - This removes the specified top-level loop from this loop info object. The loop is not deleted, as it will presumably be inserted into another loop.

Definition at line 954 of file LoopInfo.h.

References LI, and removeLoop().

Referenced by llvm::LPPassManager::deleteLoopFromQueue(), removeLoop(), and llvm::MachineLoopInfo::removeLoop().

void llvm::LoopInfo::changeLoopFor ( BasicBlock *  BB,
Loop *  L 
) [inline]

changeLoopFor - Change the top-level loop that contains BB to the specified loop. This should be used by transformations that restructure the loop hierarchy tree.

Definition at line 959 of file LoopInfo.h.

References changeLoopFor(), and LI.

Referenced by llvm::MachineLoopInfo::changeLoopFor(), changeLoopFor(), and llvm::LPPassManager::deleteLoopFromQueue().

void llvm::LoopInfo::changeTopLevelLoop ( Loop *  OldLoop,
Loop *  NewLoop 
) [inline]

changeTopLevelLoop - Replace the specified loop in the top-level loops list with the indicated loop.

Definition at line 965 of file LoopInfo.h.

References changeTopLevelLoop(), and LI.

Referenced by changeTopLevelLoop(), and llvm::MachineLoopInfo::changeTopLevelLoop().

void llvm::LoopInfo::addTopLevelLoop ( Loop *  New  )  [inline]

addTopLevelLoop - This adds the specified loop to the collection of top-level loops.

Definition at line 971 of file LoopInfo.h.

References addTopLevelLoop(), and LI.

Referenced by llvm::MachineLoopInfo::addTopLevelLoop(), addTopLevelLoop(), llvm::LPPassManager::deleteLoopFromQueue(), and llvm::LPPassManager::insertLoop().

void llvm::LoopInfo::removeBlock ( BasicBlock *  BB  )  [inline]

removeBlock - This method completely removes BB from all data structures, including all of the Loop objects it is nested in and our mapping from BasicBlocks to loops.

Definition at line 978 of file LoopInfo.h.

References LI, and removeBlock().

Referenced by llvm::LPPassManager::deleteLoopFromQueue(), FoldBlockIntoPredecessor(), llvm::MachineLoopInfo::removeBlock(), and removeBlock().

static bool llvm::LoopInfo::isNotAlreadyContainedIn ( const Loop *  SubLoop,
const Loop *  ParentLoop 
) [inline, static]

Definition at line 982 of file LoopInfo.h.

Referenced by containsAddRecFromDifferentLoop().


Friends And Related Function Documentation

friend class LoopBase< BasicBlock, Loop > [friend]

Definition at line 895 of file LoopInfo.h.


Member Data Documentation

char LoopInfo::ID = 0 [static]

Definition at line 900 of file LoopInfo.h.


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