Store the result of a depth first search within basic blocks contained by a single loop. More...

#include "llvm/Analysis/LoopIterator.h"

Public Types
typedef std::vector< BasicBlock * >::const_iterator	POIterator
	Postorder list iterators. More...

typedef std::vector< BasicBlock * >::const_reverse_iterator	RPOIterator

Public Member Functions
	LoopBlocksDFS (Loop *Container)

Loop *	getLoop () const

void	perform (LoopInfo *LI)
	Traverse the loop blocks and store the DFS result. More...

bool	isComplete () const
	Return true if postorder numbers are assigned to all loop blocks. More...

POIterator	beginPostorder () const
	Iterate over the cached postorder blocks. More...

POIterator	endPostorder () const

RPOIterator	beginRPO () const
	Reverse iterate over the cached postorder blocks. More...

RPOIterator	endRPO () const

bool	hasPreorder (BasicBlock *BB) const
	Return true if this block has been preorder visited. More...

bool	hasPostorder (BasicBlock *BB) const
	Return true if this block has a postorder number. More...

unsigned	getPostorder (BasicBlock *BB) const
	Get a block's postorder number. More...

unsigned	getRPO (BasicBlock *BB) const
	Get a block's reverse postorder number. More...

void	clear ()

Friends
class	LoopBlocksTraversal

Detailed Description

Store the result of a depth first search within basic blocks contained by a single loop.

TODO: This could be generalized for any CFG region, or the entire CFG.

Definition at line 98 of file LoopIterator.h.

Member Typedef Documentation

◆ POIterator

typedef std::vector<BasicBlock*>::const_iterator llvm::LoopBlocksDFS::POIterator

Postorder list iterators.

Definition at line 101 of file LoopIterator.h.

◆ RPOIterator

typedef std::vector<BasicBlock*>::const_reverse_iterator llvm::LoopBlocksDFS::RPOIterator

Definition at line 102 of file LoopIterator.h.

Constructor & Destructor Documentation

◆ LoopBlocksDFS()

llvm::LoopBlocksDFS::LoopBlocksDFS ( Loop * Container )

inline

Definition at line 116 of file LoopIterator.h.

References llvm::LoopBase< BlockT, LoopT >::getNumBlocks(), and llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::reserve().

Member Function Documentation

◆ beginPostorder()

POIterator llvm::LoopBlocksDFS::beginPostorder ( ) const

inline

Iterate over the cached postorder blocks.

Definition at line 130 of file LoopIterator.h.

References assert().

Referenced by getOnlyLiveSuccessor().

◆ beginRPO()

RPOIterator llvm::LoopBlocksDFS::beginRPO ( ) const

inline

Reverse iterate over the cached postorder blocks.

Definition at line 137 of file LoopIterator.h.

References assert().

Referenced by llvm::LoopBlocksRPO::begin(), llvm::LoopVectorizationCostModel::calculateRegisterUsage(), CloneLoopBlocks(), cloneLoopBlocks(), llvm::concatenateVectors(), getOnlyLiveSuccessor(), llvm::VPRecipeBuilder::tryToCreateRecipe(), and llvm::UnrollLoop().

◆ clear()

void llvm::LoopBlocksDFS::clear ( )

inline

Definition at line 165 of file LoopIterator.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::clear().

◆ endPostorder()

POIterator llvm::LoopBlocksDFS::endPostorder ( ) const

inline

Definition at line 134 of file LoopIterator.h.

Referenced by getOnlyLiveSuccessor().

◆ endRPO()

RPOIterator llvm::LoopBlocksDFS::endRPO ( ) const

inline

Definition at line 141 of file LoopIterator.h.

Referenced by llvm::LoopVectorizationCostModel::calculateRegisterUsage(), CloneLoopBlocks(), cloneLoopBlocks(), llvm::concatenateVectors(), llvm::LoopBlocksRPO::end(), getOnlyLiveSuccessor(), llvm::VPRecipeBuilder::tryToCreateRecipe(), and llvm::UnrollLoop().

◆ getLoop()

Loop* llvm::LoopBlocksDFS::getLoop ( ) const

inline

Definition at line 121 of file LoopIterator.h.

◆ getPostorder()

unsigned llvm::LoopBlocksDFS::getPostorder ( BasicBlock * BB ) const

inline

Get a block's postorder number.

Definition at line 153 of file LoopIterator.h.

References assert(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::find(), and llvm::iterator_adaptor_base< WrappedSuccIterator, succ_iterator, std::iterator_traits< succ_iterator >::iterator_category, NodeRef, std::ptrdiff_t, NodeRef *, NodeRef >::I.

◆ getRPO()

unsigned llvm::LoopBlocksDFS::getRPO ( BasicBlock * BB ) const

inline

Get a block's reverse postorder number.

Definition at line 161 of file LoopIterator.h.

◆ hasPostorder()

bool llvm::LoopBlocksDFS::hasPostorder ( BasicBlock * BB ) const

inline

Return true if this block has a postorder number.

Definition at line 147 of file LoopIterator.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::end(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::find(), and llvm::iterator_adaptor_base< WrappedSuccIterator, succ_iterator, std::iterator_traits< succ_iterator >::iterator_category, NodeRef, std::ptrdiff_t, NodeRef *, NodeRef >::I.

◆ hasPreorder()

bool llvm::LoopBlocksDFS::hasPreorder ( BasicBlock * BB ) const

inline

Return true if this block has been preorder visited.

Definition at line 144 of file LoopIterator.h.

References llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::count().

◆ isComplete()

bool llvm::LoopBlocksDFS::isComplete ( ) const

inline

Return true if postorder numbers are assigned to all loop blocks.

Definition at line 127 of file LoopIterator.h.

References llvm::LoopBase< BlockT, LoopT >::getNumBlocks().

Referenced by getOnlyLiveSuccessor().

◆ perform()

void LoopBlocksDFS::perform ( LoopInfo * LI )

Traverse the loop blocks and store the DFS result.

Useful for clients that just want the final DFS result and don't need to visit blocks during the initial traversal.

Definition at line 817 of file LoopInfo.cpp.

References llvm::LoopBlocksTraversal::begin(), and llvm::LoopBlocksTraversal::end().

Referenced by llvm::LoopVectorizationCostModel::calculateRegisterUsage(), llvm::concatenateVectors(), getOnlyLiveSuccessor(), llvm::peelLoop(), llvm::LoopBlocksRPO::perform(), llvm::VPRecipeBuilder::tryToCreateRecipe(), llvm::UnrollLoop(), and llvm::UnrollRuntimeLoopRemainder().

Friends And Related Function Documentation

◆ LoopBlocksTraversal

friend class LoopBlocksTraversal

friend

Definition at line 104 of file LoopIterator.h.

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

include/llvm/Analysis/LoopIterator.h
lib/Analysis/LoopInfo.cpp

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ POIterator

◆ RPOIterator

Constructor & Destructor Documentation

◆ LoopBlocksDFS()

Member Function Documentation

◆ beginPostorder()

◆ beginRPO()

◆ clear()

◆ endPostorder()

◆ endRPO()

◆ getLoop()

◆ getPostorder()

◆ getRPO()

◆ hasPostorder()

◆ hasPreorder()

◆ isComplete()

◆ perform()

Friends And Related Function Documentation

◆ LoopBlocksTraversal