#include <LoopInfo.h>

Inheritance diagram for llvm::LoopInfoBase< N, M >:

Public Types
typedef std::vector< LoopT * > ::const_iterator	iterator

typedef std::vector< LoopT * > ::const_reverse_iterator	reverse_iterator

Public Member Functions
	LoopInfoBase ()

	~LoopInfoBase ()

void	releaseMemory ()

iterator	begin () const

iterator	end () const

reverse_iterator	rbegin () const

reverse_iterator	rend () const

bool	empty () const

LoopT *	getLoopFor (const BlockT *BB) const

const LoopT *	operator[] (const BlockT *BB) const

unsigned	getLoopDepth (const BlockT *BB) const

bool	isLoopHeader (BlockT *BB) const

LoopT *	removeLoop (iterator I)

void	changeLoopFor (BlockT BB, LoopT L)

void	changeTopLevelLoop (LoopT OldLoop, LoopT NewLoop)

void	addTopLevelLoop (LoopT *New)

void	removeBlock (BlockT *BB)

void	Analyze (DominatorTreeBase< BlockT > &DomTree)
	Create the loop forest using a stable algorithm. More...

void	print (raw_ostream &OS) const

Static Public Member Functions
static bool	isNotAlreadyContainedIn (const LoopT SubLoop, const LoopT ParentLoop)

Friends
class	LoopBase< BlockT, LoopT >

class	LoopInfo

Detailed Description

template<class N, class M>
class llvm::LoopInfoBase< N, M >

LoopInfo - This class builds and contains all of the top level loop structures in the specified function.

Definition at line 56 of file LoopInfo.h.

Member Typedef Documentation

template<class N, class M>

typedef std::vector<LoopT *>::const_iterator llvm::LoopInfoBase< N, M >::iterator

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

Definition at line 477 of file LoopInfo.h.

template<class N, class M>

typedef std::vector<LoopT *>::const_reverse_iterator llvm::LoopInfoBase< N, M >::reverse_iterator

Definition at line 479 of file LoopInfo.h.

Constructor & Destructor Documentation

template<class N, class M>

llvm::LoopInfoBase< N, M >::LoopInfoBase ( )

inline

Definition at line 462 of file LoopInfo.h.

template<class N, class M>

llvm::LoopInfoBase< N, M >::~LoopInfoBase ( )

inline

Definition at line 463 of file LoopInfo.h.

Member Function Documentation

template<class N, class M>

void llvm::LoopInfoBase< N, M >::addTopLevelLoop ( LoopT * New )

inline

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

Definition at line 549 of file LoopInfo.h.

Referenced by llvm::MachineLoopInfo::addTopLevelLoop(), and llvm::LoopInfo::addTopLevelLoop().

template<class BlockT , class LoopT >

void llvm::LoopInfoBase< BlockT, LoopT >::Analyze ( DominatorTreeBase< BlockT > & DomTree )

Create the loop forest using a stable algorithm.

Analyze LoopInfo discovers loops during a postorder DominatorTree traversal interleaved with backward CFG traversals within each subloop (discoverAndMapSubloop). The backward traversal skips inner subloops, so this part of the algorithm is linear in the number of CFG edges. Subloop and Block vectors are then populated during a single forward CFG traversal (PopulateLoopDFS).

During the two CFG traversals each block is seen three times: 1) Discovered and mapped by a reverse CFG traversal. 2) Visited during a forward DFS CFG traversal. 3) Reverse-inserted in the loop in postorder following forward DFS.

The Block vectors are inclusive, so step 3 requires loop-depth number of insertions per block.

Definition at line 498 of file LoopInfoImpl.h.

References llvm::discoverAndMapSubloop(), llvm::DominatorTreeBase< NodeT >::dominates(), llvm::SmallVectorBase::empty(), llvm::DomTreeNodeBase< NodeT >::getBlock(), llvm::DominatorTreeBase< NodeT >::getRootNode(), llvm::DominatorTreeBase< NodeT >::isReachableFromEntry(), llvm::po_begin(), llvm::po_end(), and llvm::SmallVectorTemplateBase< T, isPodLike< T >::value >::push_back().

template<class N, class M>

iterator llvm::LoopInfoBase< N, M >::begin ( ) const

inline

Definition at line 480 of file LoopInfo.h.

Referenced by llvm::MachineLoopInfo::begin(), and llvm::LoopInfo::begin().

template<class N, class M>

void llvm::LoopInfoBase< N, M >::changeLoopFor	(	BlockT *	BB,
		LoopT *	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 527 of file LoopInfo.h.

Referenced by llvm::MachineLoopInfo::changeLoopFor(), llvm::LoopInfo::changeLoopFor(), and llvm::discoverAndMapSubloop().

template<class N, class M>

void llvm::LoopInfoBase< N, M >::changeTopLevelLoop	(	LoopT *	OldLoop,
		LoopT *	NewLoop
	)

inline

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

Definition at line 537 of file LoopInfo.h.

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

template<class N, class M>

bool llvm::LoopInfoBase< N, M >::empty ( ) const

inline

Definition at line 484 of file LoopInfo.h.

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

template<class N, class M>

iterator llvm::LoopInfoBase< N, M >::end ( ) const

inline

Definition at line 481 of file LoopInfo.h.

Referenced by llvm::MachineLoopInfo::end(), and llvm::LoopInfo::end().

template<class N, class M>

unsigned llvm::LoopInfoBase< N, M >::getLoopDepth ( const BlockT * 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 502 of file LoopInfo.h.

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

template<class N, class M>

LoopT* llvm::LoopInfoBase< N, M >::getLoopFor ( const BlockT * 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 489 of file LoopInfo.h.

Referenced by llvm::discoverAndMapSubloop(), llvm::MachineLoopInfo::getLoopFor(), llvm::LoopInfo::getLoopFor(), llvm::MachineLoopInfo::operator[](), and llvm::LoopInfo::operator[]().

template<class N, class M>

bool llvm::LoopInfoBase< N, M >::isLoopHeader ( BlockT * BB ) const

inline

Definition at line 508 of file LoopInfo.h.

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

template<class N, class M>

static bool llvm::LoopInfoBase< N, M >::isNotAlreadyContainedIn	(	const LoopT *	SubLoop,
		const LoopT *	ParentLoop
	)

inlinestatic

Definition at line 569 of file LoopInfo.h.

template<class N, class M>

const LoopT* llvm::LoopInfoBase< N, M >::operator[] ( const BlockT * BB ) const

inline

operator[] - same as getLoopFor...

Definition at line 495 of file LoopInfo.h.

template<class BlockT , class LoopT >

void llvm::LoopInfoBase< BlockT, LoopT >::print ( raw_ostream & OS ) const

Definition at line 536 of file LoopInfoImpl.h.

References I.

template<class N, class M>

reverse_iterator llvm::LoopInfoBase< N, M >::rbegin ( ) const

inline

Definition at line 482 of file LoopInfo.h.

Referenced by llvm::LoopInfo::rbegin().

template<class N, class M>

void llvm::LoopInfoBase< N, M >::releaseMemory ( )

inline

Definition at line 465 of file LoopInfo.h.

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

template<class N, class M>

void llvm::LoopInfoBase< N, M >::removeBlock ( BlockT * 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 557 of file LoopInfo.h.

Referenced by llvm::MachineLoopInfo::removeBlock(), and llvm::LoopInfo::removeBlock().

template<class N, class M>

LoopT* llvm::LoopInfoBase< N, M >::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 516 of file LoopInfo.h.

Referenced by llvm::MachineLoopInfo::removeLoop(), and llvm::LoopInfo::removeLoop().

template<class N, class M>

reverse_iterator llvm::LoopInfoBase< N, M >::rend ( ) const

inline

Definition at line 483 of file LoopInfo.h.

Referenced by llvm::LoopInfo::rend().

Friends And Related Function Documentation

template<class N, class M>

friend class LoopBase< BlockT, LoopT >

friend

Definition at line 456 of file LoopInfo.h.

template<class N, class M>

friend class LoopInfo

friend

Definition at line 457 of file LoopInfo.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

template<class N, class M> class llvm::LoopInfoBase< N, M >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<class N, class M>
class llvm::LoopInfoBase< N, M >