Instances of this class are used to represent loops that are detected in the flow graph. More...
#include "llvm/Support/GenericLoopInfo.h"
Public Types | |
| typedef std::vector< LoopT * >::const_iterator | iterator |
| typedef std::vector< LoopT * >::const_reverse_iterator | reverse_iterator |
| typedef ArrayRef< BlockT * >::const_iterator | block_iterator |
| typedef std::pair< BlockT *, BlockT * > | Edge |
| Edge type. | |
Public Member Functions | |
| unsigned | getLoopDepth () const |
| Return the nesting level of this loop. | |
| BlockT * | getHeader () const |
| LoopT * | getParentLoop () const |
| Return the parent loop if it exists or nullptr for top level loops. | |
| const LoopT * | getOutermostLoop () const |
| Get the outermost loop in which this loop is contained. | |
| LoopT * | getOutermostLoop () |
| void | setParentLoop (LoopT *L) |
| This is a raw interface for bypassing addChildLoop. | |
| bool | contains (const LoopT *L) const |
| Return true if the specified loop is contained within in this loop. | |
| bool | contains (const BlockT *BB) const |
| Return true if the specified basic block is in this loop. | |
| template<class InstT > | |
| bool | contains (const InstT *Inst) const |
| Return true if the specified instruction is in this loop. | |
| const std::vector< LoopT * > & | getSubLoops () const |
| Return the loops contained entirely within this loop. | |
| std::vector< LoopT * > & | getSubLoopsVector () |
| iterator | begin () const |
| iterator | end () const |
| reverse_iterator | rbegin () const |
| reverse_iterator | rend () const |
| bool | isInnermost () const |
| Return true if the loop does not contain any (natural) loops. | |
| bool | isOutermost () const |
| Return true if the loop does not have a parent (natural) loop. | |
| ArrayRef< BlockT * > | getBlocks () const |
| Get a list of the basic blocks which make up this loop. | |
| block_iterator | block_begin () const |
| block_iterator | block_end () const |
| iterator_range< block_iterator > | blocks () const |
| unsigned | getNumBlocks () const |
| Get the number of blocks in this loop in constant time. | |
| std::vector< BlockT * > & | getBlocksVector () |
Return a direct, mutable handle to the blocks vector so that we can mutate it efficiently with techniques like std::remove. | |
| SmallPtrSetImpl< const BlockT * > & | getBlocksSet () |
| Return a direct, mutable handle to the blocks set so that we can mutate it efficiently. | |
| const SmallPtrSetImpl< const BlockT * > & | getBlocksSet () const |
| Return a direct, immutable handle to the blocks set. | |
| bool | isInvalid () const |
| Return true if this loop is no longer valid. | |
| bool | isLoopExiting (const BlockT *BB) const |
| True if terminator in the block can branch to another block that is outside of the current loop. | |
| bool | isLoopLatch (const BlockT *BB) const |
| unsigned | getNumBackEdges () const |
| Calculate the number of back edges to the loop header. | |
| void | getExitingBlocks (SmallVectorImpl< BlockT * > &ExitingBlocks) const |
| Return all blocks inside the loop that have successors outside of the loop. | |
| BlockT * | getExitingBlock () const |
| If getExitingBlocks would return exactly one block, return that block. | |
| void | getExitBlocks (SmallVectorImpl< BlockT * > &ExitBlocks) const |
| Return all of the successor blocks of this loop. | |
| BlockT * | getExitBlock () const |
| If getExitBlocks would return exactly one block, return that block. | |
| bool | hasDedicatedExits () const |
| Return true if no exit block for the loop has a predecessor that is outside the loop. | |
| void | getUniqueExitBlocks (SmallVectorImpl< BlockT * > &ExitBlocks) const |
| Return all unique successor blocks of this loop. | |
| void | getUniqueNonLatchExitBlocks (SmallVectorImpl< BlockT * > &ExitBlocks) const |
| Return all unique successor blocks of this loop except successors from Latch block are not considered. | |
| BlockT * | getUniqueExitBlock () const |
| If getUniqueExitBlocks would return exactly one block, return that block. | |
| bool | hasNoExitBlocks () const |
| Return true if this loop does not have any exit blocks. | |
| void | getExitEdges (SmallVectorImpl< Edge > &ExitEdges) const |
| Return all pairs of (inside_block,outside_block). | |
| BlockT * | getLoopPreheader () const |
| If there is a preheader for this loop, return it. | |
| BlockT * | getLoopPredecessor () const |
| If the given loop's header has exactly one unique predecessor outside the loop, return it. | |
| BlockT * | getLoopLatch () const |
| If there is a single latch block for this loop, return it. | |
| void | getLoopLatches (SmallVectorImpl< BlockT * > &LoopLatches) const |
| Return all loop latch blocks of this loop. | |
| SmallVector< const LoopT *, 4 > | getLoopsInPreorder () const |
| Return all loops in the loop nest rooted by the loop in preorder, with siblings in forward program order. | |
| SmallVector< LoopT *, 4 > | getLoopsInPreorder () |
| void | addBasicBlockToLoop (BlockT *NewBB, LoopInfoBase< BlockT, LoopT > &LI) |
| This method is used by other analyses to update loop information. | |
| void | replaceChildLoopWith (LoopT *OldChild, LoopT *NewChild) |
| This is used when splitting loops up. | |
| void | addChildLoop (LoopT *NewChild) |
| Add the specified loop to be a child of this loop. | |
| LoopT * | removeChildLoop (iterator I) |
| This removes the specified child from being a subloop of this loop. | |
| LoopT * | removeChildLoop (LoopT *Child) |
| This removes the specified child from being a subloop of this loop. | |
| void | addBlockEntry (BlockT *BB) |
| This adds a basic block directly to the basic block list. | |
| void | reverseBlock (unsigned from) |
| interface to reverse Blocks[from, end of loop] in this loop | |
| void | reserveBlocks (unsigned size) |
| interface to do reserve() for Blocks | |
| void | moveToHeader (BlockT *BB) |
| 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). | |
| void | removeBlockFromLoop (BlockT *BB) |
| This removes the specified basic block from the current loop, updating the Blocks as appropriate. | |
| void | verifyLoop () const |
| Verify loop structure. | |
| void | verifyLoopNest (DenseSet< const LoopT * > *Loops) const |
| Verify loop structure of this loop and all nested loops. | |
| bool | isAnnotatedParallel () const |
| Returns true if the loop is annotated parallel. | |
| void | print (raw_ostream &OS, bool Verbose=false, bool PrintNested=true, unsigned Depth=0) const |
| Print loop with all the BBs inside it. | |
Static Public Member Functions | |
| template<class Type > | |
| static void | getInnerLoopsInPreorder (const LoopT &L, SmallVectorImpl< Type > &PreOrderLoops) |
| Return all inner loops in the loop nest rooted by the loop in preorder, with siblings in forward program order. | |
Protected Member Functions | |
| LoopBase () | |
| This creates an empty loop. | |
| LoopBase (BlockT *BB) | |
| ~LoopBase () | |
Friends | |
| class | LoopInfoBase< BlockT, LoopT > |
Detailed Description
class llvm::LoopBase< BlockT, LoopT >
Instances of this class are used to represent loops that are detected in the flow graph.
Definition at line 59 of file GenericLoopInfo.h.
Member Typedef Documentation
◆ block_iterator
| typedef ArrayRef<BlockT*>::const_iterator llvm::LoopBase< BlockT, LoopT >::block_iterator |
Definition at line 177 of file GenericLoopInfo.h.
◆ Edge
| typedef std::pair<BlockT *, BlockT *> llvm::LoopBase< BlockT, LoopT >::Edge |
Edge type.
Definition at line 301 of file GenericLoopInfo.h.
◆ iterator
| typedef std::vector<LoopT*>::const_iterator llvm::LoopBase< BlockT, LoopT >::iterator |
Definition at line 153 of file GenericLoopInfo.h.
◆ reverse_iterator
| typedef std::vector<LoopT*>::const_reverse_iterator llvm::LoopBase< BlockT, LoopT >::reverse_iterator |
Definition at line 155 of file GenericLoopInfo.h.
Constructor & Destructor Documentation
◆ LoopBase() [1/2]
|
inlineprotected |
This creates an empty loop.
Definition at line 481 of file GenericLoopInfo.h.
◆ LoopBase() [2/2]
|
inlineexplicitprotected |
Definition at line 483 of file GenericLoopInfo.h.
References Blocks, and llvm::SmallPtrSetImpl< PtrType >::insert().
◆ ~LoopBase()
|
inlineprotected |
Definition at line 497 of file GenericLoopInfo.h.
References Blocks, and llvm::SmallPtrSetImplBase::clear().
Member Function Documentation
◆ addBasicBlockToLoop()
| void llvm::LoopBase< BlockT, LoopT >::addBasicBlockToLoop | ( | BlockT * | NewBB, |
| LoopInfoBase< BlockT, LoopT > & | LIB | ||
| ) |
This method is used by other analyses to update loop information.
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 271 of file GenericLoopInfoImpl.h.
Referenced by llvm::addClonedBlockToLoopInfo(), buildClonedLoops(), cloneLoopBlocks(), llvm::cloneLoopWithPreheader(), llvm::VPBasicBlock::execute(), and UpdateAnalysisInformation().
◆ addBlockEntry()
|
inline |
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 415 of file GenericLoopInfo.h.
References assert(), Blocks, llvm::SmallPtrSetImpl< PtrType >::insert(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by separateNestedLoop().
◆ addChildLoop()
|
inline |
Add the specified loop to be a child of this loop.
This updates the loop depth of the new child.
Definition at line 387 of file GenericLoopInfo.h.
References assert(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by llvm::addClonedBlockToLoopInfo(), buildClonedLoops(), cloneLoopNest(), llvm::cloneLoopWithPreheader(), createNaturalLoopInternal(), llvm::TileInfo::CreateTiledLoops(), llvm::VPRegionBlock::execute(), hoistLoopToNewParent(), rebuildLoopAfterUnswitch(), and separateNestedLoop().
◆ begin()
|
inline |
Definition at line 156 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getSubLoops().
Referenced by llvm::LoopInfo::erase(), isLoopDead(), llvm::LoopBase< BlockT, LoopT >::removeChildLoop(), llvm::LoopFullUnrollPass::run(), and llvm::simplifyLoop().
◆ block_begin()
|
inline |
Definition at line 178 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getBlocks().
Referenced by llvm::LoopBase< BlockT, LoopT >::blocks(), detectPopcountIdiom(), detectShiftUntilLessThanIdiom(), detectShiftUntilZeroIdiom(), and partitionOuterLoopBlocks().
◆ block_end()
|
inline |
Definition at line 179 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getBlocks().
Referenced by llvm::LoopBase< BlockT, LoopT >::blocks(), and partitionOuterLoopBlocks().
◆ blocks()
|
inline |
Definition at line 180 of file GenericLoopInfo.h.
References assert(), llvm::LoopBase< BlockT, LoopT >::block_begin(), llvm::LoopBase< BlockT, LoopT >::block_end(), llvm::LoopBase< BlockT, LoopT >::isInvalid(), and llvm::make_range().
Referenced by buildClonedLoops(), llvm::LoopVectorizationLegality::canFoldTailByMasking(), cloneLoopNest(), llvm::LoopVectorizationCostModel::collectElementTypesForWidening(), llvm::LoopVectorizationCostModel::collectInstsToScalarize(), llvm::SimpleLoopSafetyInfo::computeLoopSafetyInfo(), llvm::ICFLoopSafetyInfo::computeLoopSafetyInfo(), containsDecreasingPointers(), llvm::LoopInfo::erase(), llvm::LoopVectorizationCostModel::expectedCost(), llvm::AArch64TTIImpl::preferPredicateOverEpilogue(), llvm::LoopVectorizationLegality::prepareToFoldTailByMasking(), llvm::LoopVectorizationCostModel::selectInterleaveCount(), llvm::LoopVectorizationCostModel::setCostBasedWideningDecision(), llvm::LoopVectorizationCostModel::setVectorizedCallDecision(), and llvm::MemorySSA::verifyMemorySSA().
◆ contains() [1/3]
|
inline |
Return true if the specified basic block is in this loop.
Definition at line 134 of file GenericLoopInfo.h.
References assert(), llvm::SmallPtrSetImpl< PtrType >::count(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
◆ contains() [2/3]
|
inline |
Return true if the specified instruction is in this loop.
Definition at line 140 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::contains().
◆ contains() [3/3]
|
inline |
Return true if the specified loop is contained within in this loop.
Definition at line 124 of file GenericLoopInfo.h.
References assert(), llvm::LoopBase< BlockT, LoopT >::contains(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by llvm::RecurrenceDescriptor::AddReductionVar(), llvm::LoopSafetyInfo::allLoopPathsLeadToBlock(), llvm::LoopAccessInfo::blockNeedsPredication(), buildClonedLoops(), llvm::LoopVectorizationCostModel::calculateRegisterUsage(), llvm::LoopVectorizationLegality::canFoldTailByMasking(), CanProveNotTakenFirstIteration(), llvm::canSinkOrHoistInst(), collectCastInstrs(), llvm::collectChildrenInLoop(), collectTransitivePredecessors(), llvm::LoopVectorizationCostModel::collectValuesToIgnore(), ConnectProlog(), llvm::LoopBase< BlockT, LoopT >::contains(), llvm::VPRecipeBuilder::createBlockInMask(), llvm::ICFLoopSafetyInfo::doesNotWriteMemoryBefore(), llvm::InnerLoopVectorizer::fixupIVUsers(), llvm::ScalarEvolution::getAddRecExpr(), getInnermostLoopFor(), llvm::LoopVectorizationCostModel::getInstructionCost(), llvm::getLoopConvergenceHeart(), llvm::LoopBase< BlockT, LoopT >::getLoopLatches(), llvm::LoopBase< BlockT, LoopT >::getNumBackEdges(), getSingleSchedPred(), llvm::hasOutsideLoopUser(), hoistLoopToNewParent(), inSubLoop(), llvm::RecurrenceDescriptor::isFixedOrderRecurrence(), isFoldableInLoop(), llvm::InductionDescriptor::isFPInductionPHI(), llvm::HardwareLoopInfo::isHardwareLoopCandidate(), llvm::LoopBase< BlockT, LoopT >::isLoopExiting(), llvm::LoopBase< BlockT, LoopT >::isLoopLatch(), isNotUsedOrFoldableInLoop(), llvm::isSafeToUnrollAndJam(), llvm::isUniformLoop(), llvm::LPPassManager::markLoopAsDeleted(), llvm::LPMUpdater::markLoopAsDeleted(), needToInsertPhisForLCSSA(), partitionLoopBlocks(), pointerInvalidatedByLoop(), llvm::promoteLoopAccessesToScalars(), rebuildLoopAfterUnswitch(), removeBlockFromLoops(), llvm::LoopInfo::replacementPreservesLCSSAForm(), llvm::LoopVectorizationCostModel::setCostBasedWideningDecision(), sink(), splitPredecessorsOfLoopExit(), llvm::UnrollAndJamLoop(), llvm::UnrollLoop(), unswitchNontrivialInvariants(), unswitchTrivialSwitch(), visitPointers(), and llvm::LoopBlocksTraversal::visitPreorder().
◆ end()
|
inline |
Definition at line 157 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getSubLoops().
Referenced by llvm::LoopInfo::erase(), isLoopDead(), llvm::LoopFullUnrollPass::run(), and llvm::simplifyLoop().
◆ getBlocks()
|
inline |
Get a list of the basic blocks which make up this loop.
Definition at line 173 of file GenericLoopInfo.h.
References assert(), Blocks, and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by llvm::LoopBase< BlockT, LoopT >::block_begin(), llvm::LoopBase< BlockT, LoopT >::block_end(), llvm::canSinkOrHoistInst(), llvm::cloneLoopWithPreheader(), llvm::SimpleLoopSafetyInfo::computeLoopSafetyInfo(), computeUnrollAndJamCount(), llvm::LoopBase< BlockT, LoopT >::getHeader(), pointerInvalidatedByLoop(), and llvm::UnrollRuntimeLoopRemainder().
◆ getBlocksSet() [1/2]
|
inline |
Return a direct, mutable handle to the blocks set so that we can mutate it efficiently.
Definition at line 200 of file GenericLoopInfo.h.
References assert(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
◆ getBlocksSet() [2/2]
|
inline |
Return a direct, immutable handle to the blocks set.
Definition at line 206 of file GenericLoopInfo.h.
References assert(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
◆ getBlocksVector()
|
inline |
Return a direct, mutable handle to the blocks vector so that we can mutate it efficiently with techniques like std::remove.
Definition at line 194 of file GenericLoopInfo.h.
References assert(), Blocks, and llvm::LoopBase< BlockT, LoopT >::isInvalid().
◆ getExitBlock()
| BlockT * llvm::LoopBase< BlockT, LoopT >::getExitBlock |
If getExitBlocks would return exactly one block, return that block.
getExitBlock - If getExitBlocks would return exactly one block, return that block.
Otherwise return null.
Definition at line 107 of file GenericLoopInfoImpl.h.
References llvm::getExitBlockHelper().
Referenced by checkLoopsStructure(), llvm::ModuloScheduleExpanderMVE::expand(), llvm::LoopNest::getInterveningInstructions(), llvm::splitLoopBound(), llvm::UnrollAndJamLoop(), and llvm::LoopVersioning::versionLoop().
◆ getExitBlocks()
| void llvm::LoopBase< BlockT, LoopT >::getExitBlocks | ( | SmallVectorImpl< BlockT * > & | ExitBlocks | ) | const |
Return all of the successor blocks of this loop.
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 64 of file GenericLoopInfoImpl.h.
References assert(), blocks, contains(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().
Referenced by llvm::InnerLoopVectorizer::fixVectorizedLoop().
◆ getExitEdges()
| void llvm::LoopBase< BlockT, LoopT >::getExitEdges | ( | SmallVectorImpl< Edge > & | ExitEdges | ) | const |
Return all pairs of (inside_block,outside_block).
getExitEdges - Return all pairs of (inside_block,outside_block).
Definition at line 164 of file GenericLoopInfoImpl.h.
References assert(), blocks, contains(), and llvm::SmallVectorImpl< T >::emplace_back().
◆ getExitingBlock()
| BlockT * llvm::LoopBase< BlockT, LoopT >::getExitingBlock |
If getExitingBlocks would return exactly one block, return that block.
getExitingBlock - If getExitingBlocks would return exactly one block, return that block.
Otherwise return null.
Definition at line 48 of file GenericLoopInfoImpl.h.
References llvm::any_of(), assert(), blocks, contains(), and isExitBlock().
Referenced by checkLoopsStructure(), collectUsersInExitBlock(), llvm::LoopVectorizationCostModel::computeMaxVF(), llvm::LoopVectorizationCostModel::requiresScalarEpilogue(), llvm::splitLoopBound(), and llvm::UnrollAndJamLoop().
◆ getExitingBlocks()
| void llvm::LoopBase< BlockT, LoopT >::getExitingBlocks | ( | SmallVectorImpl< BlockT * > & | ExitingBlocks | ) | const |
Return all blocks inside the loop that have successors outside of the loop.
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 33 of file GenericLoopInfoImpl.h.
References assert(), blocks, contains(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().
Referenced by llvm::HardwareLoopInfo::isHardwareLoopCandidate().
◆ getHeader()
|
inline |
Definition at line 90 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getBlocks().
Referenced by llvm::addClonedBlockToLoopInfo(), llvm::BlockFrequencyInfoImplBase::addLoopSuccessorsToDist(), llvm::RecurrenceDescriptor::AddReductionVar(), llvm::addStringMetadataToLoop(), llvm::LoopSafetyInfo::allLoopPathsLeadToBlock(), llvm::LoopVersioning::annotateInstWithNoAlias(), llvm::LoopBlocksTraversal::begin(), buildClonedLoops(), CanProveNotTakenFirstIteration(), llvm::LoopVectorizationLegality::canVectorize(), checkLoopsStructure(), llvm::cloneLoopWithPreheader(), collectTransitivePredecessors(), llvm::LoopVectorizationCostModel::collectValuesToIgnore(), CompareSCEVComplexity(), llvm::LoopSafetyInfo::computeBlockColors(), llvm::SimpleLoopSafetyInfo::computeLoopSafetyInfo(), llvm::VPRecipeBuilder::createBlockInMask(), llvm::VPRecipeBuilder::createHeaderMask(), createStringMetadata(), llvm::VPRecipeBuilder::createSwitchEdgeMasks(), llvm::InnerLoopVectorizer::createVectorLoopSkeleton(), detectShiftUntilBitTestIdiom(), detectShiftUntilZeroIdiom(), llvm::ICFLoopSafetyInfo::doesNotWriteMemoryBefore(), emitBasicBlockLoopComments(), llvm::LoopVectorizationPlanner::emitInvalidCostRemarks(), llvm::InnerLoopVectorizer::emitMemRuntimeChecks(), llvm::LoopVectorizeHints::emitRemarkWithHints(), llvm::LoopBlocksTraversal::end(), llvm::SystemZPostRASchedStrategy::enterMBB(), llvm::VPReductionPHIRecipe::execute(), llvm::LoopVectorizationPlanner::executePlan(), llvm::InnerLoopVectorizer::fixVectorizedLoop(), llvm::ScalarEvolution::getAddExpr(), llvm::ScalarEvolution::getAddRecExpr(), llvm::LoopVectorizationCostModel::getInstructionCost(), llvm::LoopNest::getInterveningInstructions(), llvm::getLoopConvergenceHeart(), llvm::LoopBase< BlockT, LoopT >::getLoopLatches(), llvm::BlockFrequencyInfoImplBase::getLoopName(), llvm::LoopBase< BlockT, LoopT >::getNumBackEdges(), llvm::getPtrStride(), getSingleSchedPred(), getStartAndEndForAccess(), llvm::HardwareLoopInfo::HardwareLoopInfo(), llvm::InnerLoopVectorizer::InnerLoopVectorizer(), llvm::ScalarEvolution::isBasicBlockEntryGuardedByCond(), llvm::LoopVectorizationLegality::isConsecutivePtr(), isExistingPhi(), isExplicitVecOuterLoop(), llvm::RecurrenceDescriptor::isFixedOrderRecurrence(), llvm::InductionDescriptor::isFPInductionPHI(), llvm::SimpleLoopSafetyInfo::isGuaranteedToExecute(), llvm::HardwareLoopInfo::isHardwareLoopCandidate(), llvm::InductionDescriptor::isInductionPHI(), llvm::ScalarEvolution::isKnownViaInduction(), isLoadInvariantInLoop(), llvm::LoopBase< BlockT, LoopT >::isLoopLatch(), llvm::RecurrenceDescriptor::isReductionPHI(), llvm::LoopVectorizationPlanner::plan(), pointerInvalidatedByLoop(), llvm::LoopVersioning::prepareNoAliasMetadata(), llvm::MemorySSA::print(), llvm::SCEV::print(), llvm::IVUsers::print(), llvm::EpilogueVectorizerMainLoop::printDebugTracesAtEnd(), llvm::EpilogueVectorizerEpilogueLoop::printDebugTracesAtEnd(), PrintParentLoopComment(), removeBlockFromLoops(), llvm::reportVectorization(), llvm::LPPassManager::runOnFunction(), llvm::SwingSchedulerDAG::schedule(), llvm::LoopVectorizationPlanner::selectEpilogueVectorizationFactor(), llvm::LoopVectorizeHints::setAlreadyVectorized(), llvm::splitLoopBound(), llvm::VPRecipeBuilder::tryToCreateWidenRecipe(), llvm::UnrollAndJamLoop(), llvm::MachineTraceMetrics::Ensemble::verify(), llvm::LoopVersioning::versionLoop(), and visitPointers().
◆ getInnerLoopsInPreorder()
|
inlinestatic |
Return all inner loops in the loop nest rooted by the loop in preorder, with siblings in forward program order.
Definition at line 337 of file GenericLoopInfo.h.
References llvm::SmallVectorImpl< T >::append(), llvm::SmallVectorBase< Size_T >::empty(), llvm::SmallVectorImpl< T >::pop_back_val(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().
Referenced by llvm::LoopBase< BlockT, LoopT >::getLoopsInPreorder().
◆ getLoopDepth()
|
inline |
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 82 of file GenericLoopInfo.h.
References assert(), D, and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by checkDependencies(), doesContainLoop(), emitBasicBlockLoopComments(), llvm::ScalarEvolution::getAddRecExpr(), llvm::LoopNest::getInnermostLoop(), getInnerMostLoop(), getInnermostLoopFor(), PrintParentLoopComment(), llvm::LoopVectorizationCostModel::selectInterleaveCount(), and UpdateAnalysisInformation().
◆ getLoopLatch()
| BlockT * llvm::LoopBase< BlockT, LoopT >::getLoopLatch |
If there is a single latch block for this loop, return it.
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.
Definition at line 245 of file GenericLoopInfoImpl.h.
References assert(), and contains().
Referenced by areInnerLoopLatchPHIsSupported(), areOuterLoopExitPHIsSupported(), llvm::LoopAccessInfo::blockNeedsPredication(), checkLoopsStructure(), llvm::LoopVectorizationCostModel::computeMaxVF(), createAndCollectMergePhiForReduction(), llvm::VPlan::createInitialVPlan(), llvm::InnerLoopVectorizer::emitIterationCountCheck(), llvm::EpilogueVectorizerMainLoop::emitIterationCountCheck(), llvm::EpilogueVectorizerEpilogueLoop::emitMinimumVectorEpilogueIterCountCheck(), llvm::LoopVectorizationPlanner::executePlan(), expandBounds(), llvm::VPRecipeBuilder::fixHeaderPhis(), llvm::InnerLoopVectorizer::fixupIVUsers(), llvm::LoopVectorizationCostModel::getInstructionCost(), llvm::LoopNest::getInterveningInstructions(), getOuterLoopLatchCmp(), getReductionInstr(), llvm::hasIterationCountInvariantInParent(), llvm::RecurrenceDescriptor::isFixedOrderRecurrence(), llvm::InductionDescriptor::isInductionPHI(), llvm::isUniformLoop(), partitionLoopBlocks(), llvm::LoopVectorizationCostModel::requiresScalarEpilogue(), SplitBlockPredecessorsImpl(), tryToUnrollAndJamLoop(), llvm::UnrollAndJamLoop(), and llvm::UnrollRuntimeLoopRemainder().
◆ getLoopLatches()
|
inline |
Return all loop latch blocks of this loop.
A latch block is a block that contains a branch back to the header.
Definition at line 326 of file GenericLoopInfo.h.
References assert(), llvm::LoopBase< BlockT, LoopT >::contains(), llvm::LoopBase< BlockT, LoopT >::getHeader(), H, llvm::LoopBase< BlockT, LoopT >::isInvalid(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().
◆ getLoopPredecessor()
| BlockT * llvm::LoopBase< BlockT, LoopT >::getLoopPredecessor |
If the given loop's header has exactly one unique predecessor outside the loop, return it.
getLoopPredecessor - If the given loop's header has exactly one unique predecessor outside the loop, return it.
Otherwise return null. This is less strict that the loop "preheader" concept, which requires the predecessor to have exactly one successor.
Definition at line 224 of file GenericLoopInfoImpl.h.
References assert(), and contains().
Referenced by llvm::ScalarEvolution::isBasicBlockEntryGuardedByCond().
◆ getLoopPreheader()
| BlockT * llvm::LoopBase< BlockT, LoopT >::getLoopPreheader |
If there is a preheader for this loop, return it.
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.
A loop has a preheader if there is only one edge to the header of the loop from outside of the loop and it is legal to hoist instructions into the predecessor. 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 199 of file GenericLoopInfoImpl.h.
References assert(), llvm::hasSingleElement(), and llvm::detail::isLegalToHoistInto().
Referenced by llvm::RecurrenceDescriptor::AddReductionVar(), buildClonedLoops(), CanProveNotTakenFirstIteration(), checkLoopsStructure(), llvm::cloneLoopWithPreheader(), createAndCollectMergePhiForReduction(), llvm::VPlan::createInitialVPlan(), llvm::InnerLoopVectorizer::createVectorLoopSkeleton(), createWidenInductionRecipes(), detectPopcountIdiom(), detectShiftUntilBitTestIdiom(), detectShiftUntilLessThanIdiom(), detectShiftUntilZeroIdiom(), llvm::LoopVectorizationPlanner::executePlan(), llvm::PeelingModuloScheduleExpander::expand(), llvm::ModuloScheduleExpanderMVE::expand(), llvm::InnerLoopVectorizer::fixVectorizedLoop(), llvm::LoopNest::getInterveningInstructions(), llvm::hoistRegion(), llvm::RecurrenceDescriptor::isFixedOrderRecurrence(), llvm::InductionDescriptor::isInductionPHI(), partitionLoopBlocks(), llvm::promoteLoopAccessesToScalars(), llvm::LoopConstrainer::run(), llvm::splitLoopBound(), llvm::VPRecipeBuilder::tryToCreateWidenRecipe(), llvm::UnrollAndJamLoop(), llvm::PeelingModuloScheduleExpander::validateAgainstModuloScheduleExpander(), and llvm::LoopVersioning::versionLoop().
◆ getLoopsInPreorder() [1/2]
|
inline |
Definition at line 360 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getInnerLoopsInPreorder(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().
◆ getLoopsInPreorder() [2/2]
|
inline |
Return all loops in the loop nest rooted by the loop in preorder, with siblings in forward program order.
Definition at line 353 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getInnerLoopsInPreorder(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().
Referenced by checkDependencies(), llvm::cloneLoopWithPreheader(), and partitionOuterLoopBlocks().
◆ getNumBackEdges()
|
inline |
Calculate the number of back edges to the loop header.
Definition at line 248 of file GenericLoopInfo.h.
References assert(), llvm::LoopBase< BlockT, LoopT >::contains(), llvm::count_if(), llvm::LoopBase< BlockT, LoopT >::getHeader(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by detectShiftUntilBitTestIdiom(), and detectShiftUntilZeroIdiom().
◆ getNumBlocks()
|
inline |
Get the number of blocks in this loop in constant time.
Invalidate the loop, indicating that it is no longer a loop.
Definition at line 187 of file GenericLoopInfo.h.
References assert(), Blocks, and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by llvm::LoopBlocksTraversal::begin(), llvm::LoopVectorizationLegality::canVectorize(), cloneLoopNest(), detectShiftUntilBitTestIdiom(), detectShiftUntilZeroIdiom(), and llvm::LoopBlocksDFS::LoopBlocksDFS().
◆ getOutermostLoop() [1/2]
|
inline |
Definition at line 110 of file GenericLoopInfo.h.
◆ getOutermostLoop() [2/2]
|
inline |
Get the outermost loop in which this loop is contained.
This may be the loop itself, if it already is the outermost loop.
Definition at line 103 of file GenericLoopInfo.h.
◆ getParentLoop()
|
inline |
Return the parent loop if it exists or nullptr for top level loops.
A loop is either top-level in a function (that is, it is not contained in any other loop) or it is entirely enclosed in some other loop. If a loop is top-level, it has no parent, otherwise its parent is the innermost loop in which it is enclosed.
Definition at line 99 of file GenericLoopInfo.h.
Referenced by llvm::addClonedBlockToLoopInfo(), buildClonedLoops(), checkLoopsStructure(), llvm::cloneLoopWithPreheader(), emitBasicBlockLoopComments(), llvm::LoopInfo::erase(), expandBounds(), getInnerMostLoop(), getInnermostLoopFor(), getTopMostExitingLoop(), llvm::hasIterationCountInvariantInParent(), hoistLoopToNewParent(), llvm::LoopBase< BlockT, LoopT >::isOutermost(), PrintParentLoopComment(), rebuildLoopAfterUnswitch(), removeBlockFromLoops(), llvm::LoopConstrainer::run(), llvm::LoopFlattenPass::run(), llvm::PassManager< Loop, LoopAnalysisManager, LoopStandardAnalysisResults &, LPMUpdater & >::runWithLoopNestPasses(), llvm::UnrollAndJamLoop(), llvm::UnrollLoop(), unswitchNontrivialInvariants(), and UpdateAnalysisInformation().
◆ getSubLoops()
|
inline |
Return the loops contained entirely within this loop.
Definition at line 145 of file GenericLoopInfo.h.
References assert(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by areInnerLoopLatchPHIsSupported(), llvm::LoopBase< BlockT, LoopT >::begin(), checkLoopsStructure(), llvm::LoopBase< BlockT, LoopT >::end(), llvm::LoopNest::getMaxPerfectDepth(), isEligibleLoopForm(), llvm::LoopBase< BlockT, LoopT >::isInnermost(), populateWorklist(), llvm::LoopBase< BlockT, LoopT >::rbegin(), and llvm::LoopBase< BlockT, LoopT >::rend().
◆ getSubLoopsVector()
|
inline |
Definition at line 149 of file GenericLoopInfo.h.
References assert(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
◆ getUniqueExitBlock()
| BlockT * llvm::LoopBase< BlockT, LoopT >::getUniqueExitBlock |
If getUniqueExitBlocks would return exactly one block, return that block.
Otherwise return null.
Definition at line 158 of file GenericLoopInfoImpl.h.
References llvm::getExitBlockHelper().
Referenced by areInnerLoopExitPHIsSupported(), areOuterLoopExitPHIsSupported(), llvm::VPlan::createInitialVPlan(), llvm::InnerLoopVectorizer::createVectorLoopSkeleton(), llvm::InnerLoopVectorizer::fixupIVUsers(), and llvm::LoopVersioning::versionLoop().
◆ getUniqueExitBlocks()
| void llvm::LoopBase< BlockT, LoopT >::getUniqueExitBlocks | ( | SmallVectorImpl< BlockT * > & | ExitBlocks | ) | const |
Return all unique successor blocks of this loop.
These are the blocks outside of the current loop which are branched to.
Definition at line 142 of file GenericLoopInfoImpl.h.
References llvm::getUniqueExitBlocksHelper().
Referenced by sink(), and splitPredecessorsOfLoopExit().
◆ getUniqueNonLatchExitBlocks()
| void llvm::LoopBase< BlockT, LoopT >::getUniqueNonLatchExitBlocks | ( | SmallVectorImpl< BlockT * > & | ExitBlocks | ) | const |
Return all unique successor blocks of this loop except successors from Latch block are not considered.
If the exit comes from Latch has also non Latch predecessor in a loop it will be added to ExitBlocks. These are the blocks outside of the current loop which are branched to.
Definition at line 149 of file GenericLoopInfoImpl.h.
References assert(), and llvm::getUniqueExitBlocksHelper().
◆ hasDedicatedExits()
| bool llvm::LoopBase< BlockT, LoopT >::hasDedicatedExits |
Return true if no exit block for the loop has a predecessor that is outside the loop.
Definition at line 112 of file GenericLoopInfoImpl.h.
References contains().
◆ hasNoExitBlocks()
| bool llvm::LoopBase< BlockT, LoopT >::hasNoExitBlocks |
Return true if this loop does not have any exit blocks.
Definition at line 95 of file GenericLoopInfoImpl.h.
References llvm::getExitBlockHelper().
◆ isAnnotatedParallel()
|
inline |
Returns true if the loop is annotated parallel.
Derived classes can override this method using static template polymorphism.
Definition at line 471 of file GenericLoopInfo.h.
◆ isInnermost()
|
inline |
Return true if the loop does not contain any (natural) loops.
Definition at line 167 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getSubLoops().
Referenced by llvm::LoopVectorizationLegality::canVectorize(), cloneLoopNest(), emitBasicBlockLoopComments(), llvm::LoopInfo::erase(), llvm::LoopVectorizationCostModel::getWideningDecision(), isExplicitVecOuterLoop(), llvm::LoopVectorizationCostModel::isProfitableToScalarize(), llvm::LoopVectorizationCostModel::isScalarAfterVectorization(), llvm::LoopVectorizationCostModel::isUniformAfterVectorization(), llvm::LoopVectorizationPlanner::plan(), llvm::LoopVectorizationPlanner::planInVPlanNativePath(), and llvm::reportVectorization().
◆ isInvalid()
|
inline |
Return true if this loop is no longer valid.
The only valid use of this helper is "assert(L.isInvalid())" or equivalent, since IsInvalid is set to true by the destructor. In other words, if this accessor returns true, the caller has already triggered UB by calling this accessor; and so it can only be called in a context where a return value of true indicates a programmer error.
Definition at line 217 of file GenericLoopInfo.h.
Referenced by llvm::LoopBase< BlockT, LoopT >::addBlockEntry(), llvm::LoopBase< BlockT, LoopT >::addChildLoop(), llvm::LoopBase< BlockT, LoopT >::blocks(), llvm::LoopBase< BlockT, LoopT >::contains(), llvm::LoopInfo::erase(), llvm::LoopBase< BlockT, LoopT >::getBlocks(), llvm::LoopBase< BlockT, LoopT >::getBlocksSet(), llvm::LoopBase< BlockT, LoopT >::getBlocksVector(), llvm::LoopBase< BlockT, LoopT >::getLoopDepth(), llvm::LoopBase< BlockT, LoopT >::getLoopLatches(), llvm::LoopBase< BlockT, LoopT >::getNumBackEdges(), llvm::LoopBase< BlockT, LoopT >::getNumBlocks(), llvm::LoopBase< BlockT, LoopT >::getSubLoops(), llvm::LoopBase< BlockT, LoopT >::getSubLoopsVector(), llvm::LoopBase< BlockT, LoopT >::isLoopExiting(), llvm::LoopBase< BlockT, LoopT >::isLoopLatch(), llvm::LoopBase< BlockT, LoopT >::moveToHeader(), llvm::LoopBase< BlockT, LoopT >::removeBlockFromLoop(), llvm::LoopBase< BlockT, LoopT >::removeChildLoop(), llvm::LoopBase< BlockT, LoopT >::reserveBlocks(), llvm::LoopBase< BlockT, LoopT >::reverseBlock(), and llvm::LoopBase< BlockT, LoopT >::setParentLoop().
◆ isLoopExiting()
|
inline |
True if terminator in the block can branch to another block that is outside of the current loop.
BB must be inside the loop.
Definition at line 227 of file GenericLoopInfo.h.
References assert(), llvm::LoopBase< BlockT, LoopT >::contains(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by llvm::VPRecipeBuilder::createEdgeMask(), llvm::VPRecipeBuilder::createSwitchEdgeMasks(), getTopMostExitingLoop(), and llvm::VirtRegAuxInfo::weightCalcHelper().
◆ isLoopLatch()
|
inline |
Definition at line 241 of file GenericLoopInfo.h.
References assert(), llvm::LoopBase< BlockT, LoopT >::contains(), llvm::LoopBase< BlockT, LoopT >::getHeader(), llvm::is_contained(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by llvm::HardwareLoopInfo::isHardwareLoopCandidate().
◆ isOutermost()
|
inline |
Return true if the loop does not have a parent (natural) loop.
Definition at line 170 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getParentLoop().
Referenced by llvm::LoopInfo::erase(), and llvm::CacheCost::getCacheCost().
◆ moveToHeader()
|
inline |
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 435 of file GenericLoopInfo.h.
References assert(), Blocks, and llvm::LoopBase< BlockT, LoopT >::isInvalid().
◆ print()
| void llvm::LoopBase< BlockT, LoopT >::print | ( | raw_ostream & | OS, |
| bool | Verbose = false, |
||
| bool | PrintNested = true, |
||
| unsigned | Depth = 0 |
||
| ) | const |
Print loop with all the BBs inside it.
Definition at line 403 of file GenericLoopInfoImpl.h.
References llvm::Depth, E, H, I, llvm::raw_ostream::indent(), OS, and llvm::Verbose.
Referenced by llvm::operator<<().
◆ rbegin()
|
inline |
Definition at line 158 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getSubLoops().
◆ removeBlockFromLoop()
|
inline |
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 452 of file GenericLoopInfo.h.
References assert(), Blocks, llvm::SmallPtrSetImpl< PtrType >::erase(), llvm::find(), I, and llvm::LoopBase< BlockT, LoopT >::isInvalid().
◆ removeChildLoop() [1/2]
|
inline |
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 396 of file GenericLoopInfo.h.
References assert(), llvm::LoopBase< BlockT, LoopT >::begin(), I, and llvm::LoopBase< BlockT, LoopT >::isInvalid().
Referenced by llvm::LoopInfo::erase(), hoistLoopToNewParent(), rebuildLoopAfterUnswitch(), and llvm::LoopBase< BlockT, LoopT >::removeChildLoop().
◆ removeChildLoop() [2/2]
|
inline |
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 GenericLoopInfo.h.
References llvm::find(), and llvm::LoopBase< BlockT, LoopT >::removeChildLoop().
◆ rend()
|
inline |
Definition at line 159 of file GenericLoopInfo.h.
References llvm::LoopBase< BlockT, LoopT >::getSubLoops().
◆ replaceChildLoopWith()
| void llvm::LoopBase< BlockT, LoopT >::replaceChildLoopWith | ( | LoopT * | OldChild, |
| LoopT * | NewChild | ||
| ) |
This is used when splitting loops up.
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 301 of file GenericLoopInfoImpl.h.
References assert().
Referenced by separateNestedLoop().
◆ reserveBlocks()
|
inline |
interface to do reserve() for Blocks
Definition at line 428 of file GenericLoopInfo.h.
References assert(), Blocks, llvm::LoopBase< BlockT, LoopT >::isInvalid(), and llvm::size().
Referenced by buildClonedLoops().
◆ reverseBlock()
|
inline |
interface to reverse Blocks[from, end of loop] in this loop
Definition at line 422 of file GenericLoopInfo.h.
References assert(), Blocks, and llvm::LoopBase< BlockT, LoopT >::isInvalid().
◆ setParentLoop()
|
inline |
This is a raw interface for bypassing addChildLoop.
Definition at line 118 of file GenericLoopInfo.h.
References assert(), and llvm::LoopBase< BlockT, LoopT >::isInvalid().
◆ verifyLoop()
| void llvm::LoopBase< BlockT, LoopT >::verifyLoop |
Verify loop structure.
verifyLoop - Verify loop structure
Definition at line 315 of file GenericLoopInfoImpl.h.
References assert().
Referenced by createNaturalLoopInternal(), llvm::LoopUnrollPass::run(), llvm::LoopFullUnrollPass::run(), and llvm::LPPassManager::runOnFunction().
◆ verifyLoopNest()
| void llvm::LoopBase< BlockT, LoopT >::verifyLoopNest | ( | DenseSet< const LoopT * > * | Loops | ) | const |
Friends And Related Function Documentation
◆ LoopInfoBase< BlockT, LoopT >
|
friend |
Definition at line 474 of file GenericLoopInfo.h.
The documentation for this class was generated from the following files:
- include/llvm/Support/GenericLoopInfo.h
- include/llvm/Support/GenericLoopInfoImpl.h
