LLVM API Documentation

llvm::LoopBase< BlockT, LoopT > Class Template Reference

#include <LoopInfo.h>

Inheritance diagram for llvm::LoopBase< BlockT, LoopT >:
[legend]
Collaboration diagram for llvm::LoopBase< BlockT, LoopT >:
[legend]

List of all members.

Public Types

typedef std::vector< LoopT * >
::const_iterator 
iterator
typedef std::vector< BlockT * >
::const_iterator 
block_iterator
typedef std::pair< const
BlockT *, const BlockT * > 
Edge

Public Member Functions

 LoopBase ()
 Loop ctor - This creates an empty loop.
 ~LoopBase ()
unsigned getLoopDepth () const
BlockT * getHeader () const
LoopT * getParentLoop () const
bool contains (const BlockT *BB) const
const std::vector< LoopT * > & getSubLoops () const
iterator begin () const
iterator end () const
bool empty () const
const std::vector< BlockT * > & getBlocks () const
block_iterator block_begin () const
block_iterator block_end () const
bool isLoopExit (const BlockT *BB) const
unsigned getNumBackEdges () const
void getExitingBlocks (SmallVectorImpl< BlockT * > &ExitingBlocks) const
BlockT * getExitingBlock () const
void getExitBlocks (SmallVectorImpl< BlockT * > &ExitBlocks) const
BlockT * getExitBlock () const
void getExitEdges (SmallVectorImpl< Edge > &ExitEdges) const
void getUniqueExitBlocks (SmallVectorImpl< BlockT * > &ExitBlocks) const
BlockT * getUniqueExitBlock () const
BlockT * getLoopPreheader () const
BlockT * getLoopLatch () const
void addBasicBlockToLoop (BlockT *NewBB, LoopInfoBase< BlockT, LoopT > &LI)
void replaceChildLoopWith (LoopT *OldChild, LoopT *NewChild)
void addChildLoop (LoopT *NewChild)
LoopT * removeChildLoop (iterator I)
void addBlockEntry (BlockT *BB)
void moveToHeader (BlockT *BB)
void removeBlockFromLoop (BlockT *BB)
void verifyLoop () const
 verifyLoop - Verify loop structure
void print (std::ostream &OS, unsigned Depth=0) const
void print (std::ostream *O, unsigned Depth=0) const
void dump () const

Protected Member Functions

 LoopBase (BlockT *BB)

Friends

class LoopInfoBase< BlockT, LoopT >


Detailed Description

template<class BlockT, class LoopT>
class llvm::LoopBase< BlockT, LoopT >

LoopBase class - Instances of this class are used to represent loops that are detected in the flow graph

Definition at line 63 of file LoopInfo.h.


Member Typedef Documentation

template<class BlockT, class LoopT>
typedef std::vector<LoopT *>::const_iterator llvm::LoopBase< BlockT, LoopT >::iterator

Definition at line 105 of file LoopInfo.h.

template<class BlockT, class LoopT>
typedef std::vector<BlockT*>::const_iterator llvm::LoopBase< BlockT, LoopT >::block_iterator

Definition at line 113 of file LoopInfo.h.

template<class BlockT, class LoopT>
typedef std::pair<const BlockT*,const BlockT*> llvm::LoopBase< BlockT, LoopT >::Edge

getExitEdges - Return all pairs of (_inside_block_,_outside_block_). (Modelled after getExitingBlocks().)

Definition at line 218 of file LoopInfo.h.


Constructor & Destructor Documentation

template<class BlockT, class LoopT>
llvm::LoopBase< BlockT, LoopT >::LoopBase (  )  [inline]

Loop ctor - This creates an empty loop.

Definition at line 77 of file LoopInfo.h.

template<class BlockT, class LoopT>
llvm::LoopBase< BlockT, LoopT >::~LoopBase (  )  [inline]

Definition at line 78 of file LoopInfo.h.

template<class BlockT, class LoopT>
llvm::LoopBase< BlockT, LoopT >::LoopBase ( BlockT *  BB  )  [inline, explicit, protected]

Definition at line 485 of file LoopInfo.h.


Member Function Documentation

template<class BlockT, class LoopT>
unsigned llvm::LoopBase< BlockT, LoopT >::getLoopDepth (  )  const [inline]

getLoopDepth - Return the nesting level of this loop. An outer-most loop has depth 1, for consistency with loop depth values used for basic blocks, where depth 0 is used for blocks not inside any loops.

Definition at line 86 of file LoopInfo.h.

Referenced by llvm::AsmPrinter::EmitComments(), llvm::ScalarEvolution::getAddRecExpr(), llvm::LoopBase< llvm::MachineBasicBlock, llvm::MachineLoop >::print(), and PrintLoopInfo().

template<class BlockT, class LoopT>
BlockT* llvm::LoopBase< BlockT, LoopT >::getHeader (  )  const [inline]

template<class BlockT, class LoopT>
LoopT* llvm::LoopBase< BlockT, LoopT >::getParentLoop (  )  const [inline]

template<class BlockT, class LoopT>
bool llvm::LoopBase< BlockT, LoopT >::contains ( const BlockT *  BB  )  const [inline]

template<class BlockT, class LoopT>
const std::vector<LoopT *>& llvm::LoopBase< BlockT, LoopT >::getSubLoops (  )  const [inline]

iterator/begin/end - Return the loops contained entirely within this loop.

Definition at line 104 of file LoopInfo.h.

template<class BlockT, class LoopT>
iterator llvm::LoopBase< BlockT, LoopT >::begin (  )  const [inline]

template<class BlockT, class LoopT>
iterator llvm::LoopBase< BlockT, LoopT >::end (  )  const [inline]

template<class BlockT, class LoopT>
bool llvm::LoopBase< BlockT, LoopT >::empty (  )  const [inline]

template<class BlockT, class LoopT>
const std::vector<BlockT*>& llvm::LoopBase< BlockT, LoopT >::getBlocks (  )  const [inline]

getBlocks - Get a list of the basic blocks which make up this loop.

Definition at line 112 of file LoopInfo.h.

Referenced by llvm::LPPassManager::deleteLoopFromQueue(), llvm::ExtractLoop(), llvm::LoopBase< llvm::MachineBasicBlock, llvm::MachineLoop >::print(), llvm::MSILWriter::printLoop(), and llvm::UnrollLoop().

template<class BlockT, class LoopT>
block_iterator llvm::LoopBase< BlockT, LoopT >::block_begin (  )  const [inline]

template<class BlockT, class LoopT>
block_iterator llvm::LoopBase< BlockT, LoopT >::block_end (  )  const [inline]

template<class BlockT, class LoopT>
bool llvm::LoopBase< BlockT, LoopT >::isLoopExit ( const BlockT *  BB  )  const [inline]

isLoopExit - True if terminator in the block can branch to another block that is outside of the current loop.

Definition at line 120 of file LoopInfo.h.

Referenced by llvm::LoopBase< llvm::MachineBasicBlock, llvm::MachineLoop >::print().

template<class BlockT, class LoopT>
unsigned llvm::LoopBase< BlockT, LoopT >::getNumBackEdges (  )  const [inline]

getNumBackEdges - Calculate the number of back edges to the loop header

Definition at line 133 of file LoopInfo.h.

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::getExitingBlocks ( SmallVectorImpl< BlockT * > &  ExitingBlocks  )  const [inline]

getExitingBlocks - Return all blocks inside the loop that have successors outside of the loop. These are the blocks _inside of the current loop_ which branch out. The returned list is always unique.

Definition at line 159 of file LoopInfo.h.

Referenced by llvm::LoopBase< llvm::MachineBasicBlock, llvm::MachineLoop >::getExitingBlock().

template<class BlockT, class LoopT>
BlockT* llvm::LoopBase< BlockT, LoopT >::getExitingBlock (  )  const [inline]

getExitingBlock - If getExitingBlocks would return exactly one block, return that block. Otherwise return null.

Definition at line 179 of file LoopInfo.h.

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::getExitBlocks ( SmallVectorImpl< BlockT * > &  ExitBlocks  )  const [inline]

getExitBlocks - Return all of the successor blocks of this loop. These are the blocks _outside of the current loop_ which are branched to.

Definition at line 190 of file LoopInfo.h.

Referenced by llvm::LoopBase< llvm::MachineBasicBlock, llvm::MachineLoop >::getExitBlock(), llvm::Loop::isLoopSimplifyForm(), and PrintLoopInfo().

template<class BlockT, class LoopT>
BlockT* llvm::LoopBase< BlockT, LoopT >::getExitBlock (  )  const [inline]

getExitBlock - If getExitBlocks would return exactly one block, return that block. Otherwise return null.

Definition at line 208 of file LoopInfo.h.

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::getExitEdges ( SmallVectorImpl< Edge > &  ExitEdges  )  const [inline]

Definition at line 219 of file LoopInfo.h.

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::getUniqueExitBlocks ( SmallVectorImpl< BlockT * > &  ExitBlocks  )  const [inline]

getUniqueExitBlocks - Return all unique successor blocks of this loop. These are the blocks _outside of the current loop_ which are branched to. This assumes that loop is in canonical form.

Definition at line 239 of file LoopInfo.h.

Referenced by llvm::LoopBase< llvm::MachineBasicBlock, llvm::MachineLoop >::getUniqueExitBlock().

template<class BlockT, class LoopT>
BlockT* llvm::LoopBase< BlockT, LoopT >::getUniqueExitBlock (  )  const [inline]

getUniqueExitBlock - If getUniqueExitBlocks would return exactly one block, return that block. Otherwise return null.

Definition at line 295 of file LoopInfo.h.

template<class BlockT, class LoopT>
BlockT* llvm::LoopBase< BlockT, LoopT >::getLoopPreheader (  )  const [inline]

getLoopPreheader - If there is a preheader for this loop, return it. A loop has a preheader if there is only one edge to the header of the loop from outside of the loop. If this is the case, the block branching to the header of the loop is the preheader node.

This method returns null if there is no preheader for the loop.

Definition at line 310 of file LoopInfo.h.

Referenced by getSCEVStartAndStride(), InsertAffinePhi(), llvm::Loop::isLoopSimplifyForm(), LoopIsOuterMostWithPreheader(), llvm::Loop::makeLoopInvariant(), llvm::UnrollLoop(), and llvm::LoopBase< llvm::MachineBasicBlock, llvm::MachineLoop >::verifyLoop().

template<class BlockT, class LoopT>
BlockT* llvm::LoopBase< BlockT, LoopT >::getLoopLatch (  )  const [inline]

getLoopLatch - If there is a single latch block for this loop, return it. A latch block is a block that contains a branch back to the header. A loop header in normal form has two edges into it: one from a preheader and one from a latch block.

Definition at line 343 of file LoopInfo.h.

Referenced by llvm::CloneLoop(), FindIVIncInsertPt(), InsertAffinePhi(), llvm::ScalarEvolution::isLoopBackedgeGuardedByCond(), llvm::Loop::isLoopSimplifyForm(), IVUseShouldUsePostIncValue(), llvm::LoopBase< llvm::MachineBasicBlock, llvm::MachineLoop >::print(), llvm::UnrollLoop(), and llvm::LoopBase< llvm::MachineBasicBlock, llvm::MachineLoop >::verifyLoop().

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::addBasicBlockToLoop ( BlockT *  NewBB,
LoopInfoBase< BlockT, LoopT > &  LI 
) [inline]

addBasicBlockToLoop - This method is used by other analyses to update loop information. NewBB is set to be a new member of the current loop. Because of this, it is added as a member of all parent loops, and is added to the specified LoopInfo object as being in the current basic block. It is not valid to replace the loop header with this method.

Definition at line 1020 of file LoopInfo.h.

References llvm::LoopInfoBase< BlockT, LoopT >::BBMap, llvm::LoopBase< BlockT, LoopT >::getHeader(), and L.

Referenced by CloneLoop(), llvm::CloneLoop(), llvm::SplitBlock(), and llvm::UnrollLoop().

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::replaceChildLoopWith ( LoopT *  OldChild,
LoopT *  NewChild 
) [inline]

replaceChildLoopWith - This is used when splitting loops up. It replaces the OldChild entry in our children list with NewChild, and updates the parent pointer of OldChild to be null and the NewChild to be this loop. This updates the loop depth of the new child.

Definition at line 384 of file LoopInfo.h.

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::addChildLoop ( LoopT *  NewChild  )  [inline]

addChildLoop - Add the specified loop to be a child of this loop. This updates the loop depth of the new child.

Definition at line 399 of file LoopInfo.h.

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

template<class BlockT, class LoopT>
LoopT* llvm::LoopBase< BlockT, LoopT >::removeChildLoop ( iterator  I  )  [inline]

removeChildLoop - This removes the specified child from being a subloop of this loop. The loop is not deleted, as it will presumably be inserted into another loop.

Definition at line 408 of file LoopInfo.h.

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

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::addBlockEntry ( BlockT *  BB  )  [inline]

addBlockEntry - This adds a basic block directly to the basic block list. This should only be used by transformations that create new loops. Other transformations should use addBasicBlockToLoop.

Definition at line 420 of file LoopInfo.h.

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::moveToHeader ( BlockT *  BB  )  [inline]

moveToHeader - This method is used to move BB (which must be part of this loop) to be the loop header of the loop (the block that dominates all others).

Definition at line 427 of file LoopInfo.h.

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::removeBlockFromLoop ( BlockT *  BB  )  [inline]

removeBlockFromLoop - This removes the specified basic block from the current loop, updating the Blocks as appropriate. This does not update the mapping in the LoopInfo class.

Definition at line 442 of file LoopInfo.h.

Referenced by llvm::LoopInfoBase< llvm::MachineBasicBlock, llvm::MachineLoop >::removeBlock().

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::verifyLoop (  )  const [inline]

verifyLoop - Verify loop structure

Definition at line 447 of file LoopInfo.h.

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::print ( std::ostream &  OS,
unsigned  Depth = 0 
) const [inline]

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::print ( std::ostream *  O,
unsigned  Depth = 0 
) const [inline]

Definition at line 475 of file LoopInfo.h.

template<class BlockT, class LoopT>
void llvm::LoopBase< BlockT, LoopT >::dump (  )  const [inline]

Definition at line 479 of file LoopInfo.h.


Friends And Related Function Documentation

template<class BlockT, class LoopT>
friend class LoopInfoBase< BlockT, LoopT > [friend]

Definition at line 484 of file LoopInfo.h.


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