1 //===- llvm/Analysis/LoopInfo.h - Natural Loop Calculator -------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the LoopInfo class that is used to identify natural loops
11 // and determine the loop depth of various nodes of the CFG. A natural loop
12 // has exactly one entry-point, which is called the header. Note that natural
13 // loops may actually be several loops that share the same header node.
15 // This analysis calculates the nesting structure of loops in a function. For
16 // each natural loop identified, this analysis identifies natural loops
17 // contained entirely within the loop and the basic blocks the make up the loop.
19 // It can calculate on the fly various bits of information, for example:
21 // * whether there is a preheader for the loop
22 // * the number of back edges to the header
23 // * whether or not a particular block branches out of the loop
24 // * the successor blocks of the loop
29 //===----------------------------------------------------------------------===//
31 #ifndef LLVM_ANALYSIS_LOOP_INFO_H
32 #define LLVM_ANALYSIS_LOOP_INFO_H
34 #include "llvm/Pass.h"
35 #include "llvm/ADT/DepthFirstIterator.h"
36 #include "llvm/ADT/GraphTraits.h"
37 #include "llvm/ADT/SmallVector.h"
38 #include "llvm/ADT/STLExtras.h"
39 #include "llvm/Analysis/Dominators.h"
40 #include "llvm/Support/CFG.h"
41 #include "llvm/Support/raw_ostream.h"
47 static void RemoveFromVector(std::vector<T*> &V, T *N) {
48 typename std::vector<T*>::iterator I = std::find(V.begin(), V.end(), N);
49 assert(I != V.end() && "N is not in this list!");
56 template<class N, class M> class LoopInfoBase;
57 template<class N, class M> class LoopBase;
59 //===----------------------------------------------------------------------===//
60 /// LoopBase class - Instances of this class are used to represent loops that
61 /// are detected in the flow graph
63 template<class BlockT, class LoopT>
66 // SubLoops - Loops contained entirely within this one.
67 std::vector<LoopT *> SubLoops;
69 // Blocks - The list of blocks in this loop. First entry is the header node.
70 std::vector<BlockT*> Blocks;
73 LoopBase(const LoopBase<BlockT, LoopT> &);
75 const LoopBase<BlockT, LoopT>&operator=(const LoopBase<BlockT, LoopT> &);
77 /// Loop ctor - This creates an empty loop.
78 LoopBase() : ParentLoop(0) {}
80 for (size_t i = 0, e = SubLoops.size(); i != e; ++i)
84 /// getLoopDepth - Return the nesting level of this loop. An outer-most
85 /// loop has depth 1, for consistency with loop depth values used for basic
86 /// blocks, where depth 0 is used for blocks not inside any loops.
87 unsigned getLoopDepth() const {
89 for (const LoopT *CurLoop = ParentLoop; CurLoop;
90 CurLoop = CurLoop->ParentLoop)
94 BlockT *getHeader() const { return Blocks.front(); }
95 LoopT *getParentLoop() const { return ParentLoop; }
97 /// contains - Return true if the specified loop is contained within in
100 bool contains(const LoopT *L) const {
101 if (L == this) return true;
102 if (L == 0) return false;
103 return contains(L->getParentLoop());
106 /// contains - Return true if the specified basic block is in this loop.
108 bool contains(const BlockT *BB) const {
109 return std::find(block_begin(), block_end(), BB) != block_end();
112 /// contains - Return true if the specified instruction is in this loop.
114 template<class InstT>
115 bool contains(const InstT *Inst) const {
116 return contains(Inst->getParent());
119 /// iterator/begin/end - Return the loops contained entirely within this loop.
121 const std::vector<LoopT *> &getSubLoops() const { return SubLoops; }
122 typedef typename std::vector<LoopT *>::const_iterator iterator;
123 iterator begin() const { return SubLoops.begin(); }
124 iterator end() const { return SubLoops.end(); }
125 bool empty() const { return SubLoops.empty(); }
127 /// getBlocks - Get a list of the basic blocks which make up this loop.
129 const std::vector<BlockT*> &getBlocks() const { return Blocks; }
130 typedef typename std::vector<BlockT*>::const_iterator block_iterator;
131 block_iterator block_begin() const { return Blocks.begin(); }
132 block_iterator block_end() const { return Blocks.end(); }
134 /// isLoopExiting - True if terminator in the block can branch to another
135 /// block that is outside of the current loop.
137 bool isLoopExiting(const BlockT *BB) const {
138 typedef GraphTraits<BlockT*> BlockTraits;
139 for (typename BlockTraits::ChildIteratorType SI =
140 BlockTraits::child_begin(const_cast<BlockT*>(BB)),
141 SE = BlockTraits::child_end(const_cast<BlockT*>(BB)); SI != SE; ++SI) {
148 /// getNumBackEdges - Calculate the number of back edges to the loop header
150 unsigned getNumBackEdges() const {
151 unsigned NumBackEdges = 0;
152 BlockT *H = getHeader();
154 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits;
155 for (typename InvBlockTraits::ChildIteratorType I =
156 InvBlockTraits::child_begin(const_cast<BlockT*>(H)),
157 E = InvBlockTraits::child_end(const_cast<BlockT*>(H)); I != E; ++I)
164 //===--------------------------------------------------------------------===//
165 // APIs for simple analysis of the loop.
167 // Note that all of these methods can fail on general loops (ie, there may not
168 // be a preheader, etc). For best success, the loop simplification and
169 // induction variable canonicalization pass should be used to normalize loops
170 // for easy analysis. These methods assume canonical loops.
172 /// getExitingBlocks - Return all blocks inside the loop that have successors
173 /// outside of the loop. These are the blocks _inside of the current loop_
174 /// which branch out. The returned list is always unique.
176 void getExitingBlocks(SmallVectorImpl<BlockT *> &ExitingBlocks) const {
177 // Sort the blocks vector so that we can use binary search to do quick
179 SmallVector<BlockT*, 128> LoopBBs(block_begin(), block_end());
180 std::sort(LoopBBs.begin(), LoopBBs.end());
182 typedef GraphTraits<BlockT*> BlockTraits;
183 for (block_iterator BI = block_begin(), BE = block_end(); BI != BE; ++BI)
184 for (typename BlockTraits::ChildIteratorType I =
185 BlockTraits::child_begin(*BI), E = BlockTraits::child_end(*BI);
187 if (!std::binary_search(LoopBBs.begin(), LoopBBs.end(), *I)) {
188 // Not in current loop? It must be an exit block.
189 ExitingBlocks.push_back(*BI);
194 /// getExitingBlock - If getExitingBlocks would return exactly one block,
195 /// return that block. Otherwise return null.
196 BlockT *getExitingBlock() const {
197 SmallVector<BlockT*, 8> ExitingBlocks;
198 getExitingBlocks(ExitingBlocks);
199 if (ExitingBlocks.size() == 1)
200 return ExitingBlocks[0];
204 /// getExitBlocks - Return all of the successor blocks of this loop. These
205 /// are the blocks _outside of the current loop_ which are branched to.
207 void getExitBlocks(SmallVectorImpl<BlockT*> &ExitBlocks) const {
208 // Sort the blocks vector so that we can use binary search to do quick
210 SmallVector<BlockT*, 128> LoopBBs(block_begin(), block_end());
211 std::sort(LoopBBs.begin(), LoopBBs.end());
213 typedef GraphTraits<BlockT*> BlockTraits;
214 for (block_iterator BI = block_begin(), BE = block_end(); BI != BE; ++BI)
215 for (typename BlockTraits::ChildIteratorType I =
216 BlockTraits::child_begin(*BI), E = BlockTraits::child_end(*BI);
218 if (!std::binary_search(LoopBBs.begin(), LoopBBs.end(), *I))
219 // Not in current loop? It must be an exit block.
220 ExitBlocks.push_back(*I);
223 /// getExitBlock - If getExitBlocks would return exactly one block,
224 /// return that block. Otherwise return null.
225 BlockT *getExitBlock() const {
226 SmallVector<BlockT*, 8> ExitBlocks;
227 getExitBlocks(ExitBlocks);
228 if (ExitBlocks.size() == 1)
229 return ExitBlocks[0];
234 typedef std::pair<BlockT*, BlockT*> Edge;
236 /// getExitEdges - Return all pairs of (_inside_block_,_outside_block_).
237 template <typename EdgeT>
238 void getExitEdges(SmallVectorImpl<EdgeT> &ExitEdges) const {
239 // Sort the blocks vector so that we can use binary search to do quick
241 SmallVector<BlockT*, 128> LoopBBs(block_begin(), block_end());
242 array_pod_sort(LoopBBs.begin(), LoopBBs.end());
244 typedef GraphTraits<BlockT*> BlockTraits;
245 for (block_iterator BI = block_begin(), BE = block_end(); BI != BE; ++BI)
246 for (typename BlockTraits::ChildIteratorType I =
247 BlockTraits::child_begin(*BI), E = BlockTraits::child_end(*BI);
249 if (!std::binary_search(LoopBBs.begin(), LoopBBs.end(), *I))
250 // Not in current loop? It must be an exit block.
251 ExitEdges.push_back(EdgeT(*BI, *I));
254 /// getLoopPreheader - If there is a preheader for this loop, return it. A
255 /// loop has a preheader if there is only one edge to the header of the loop
256 /// from outside of the loop. If this is the case, the block branching to the
257 /// header of the loop is the preheader node.
259 /// This method returns null if there is no preheader for the loop.
261 BlockT *getLoopPreheader() const {
262 // Keep track of nodes outside the loop branching to the header...
263 BlockT *Out = getLoopPredecessor();
266 // Make sure there is only one exit out of the preheader.
267 typedef GraphTraits<BlockT*> BlockTraits;
268 typename BlockTraits::ChildIteratorType SI = BlockTraits::child_begin(Out);
270 if (SI != BlockTraits::child_end(Out))
271 return 0; // Multiple exits from the block, must not be a preheader.
273 // The predecessor has exactly one successor, so it is a preheader.
277 /// getLoopPredecessor - If the given loop's header has exactly one unique
278 /// predecessor outside the loop, return it. Otherwise return null.
279 /// This is less strict that the loop "preheader" concept, which requires
280 /// the predecessor to have exactly one successor.
282 BlockT *getLoopPredecessor() const {
283 // Keep track of nodes outside the loop branching to the header...
286 // Loop over the predecessors of the header node...
287 BlockT *Header = getHeader();
288 typedef GraphTraits<BlockT*> BlockTraits;
289 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits;
290 for (typename InvBlockTraits::ChildIteratorType PI =
291 InvBlockTraits::child_begin(Header),
292 PE = InvBlockTraits::child_end(Header); PI != PE; ++PI) {
293 typename InvBlockTraits::NodeType *N = *PI;
294 if (!contains(N)) { // If the block is not in the loop...
296 return 0; // Multiple predecessors outside the loop
301 // Make sure there is only one exit out of the preheader.
302 assert(Out && "Header of loop has no predecessors from outside loop?");
306 /// getLoopLatch - If there is a single latch block for this loop, return it.
307 /// A latch block is a block that contains a branch back to the header.
308 BlockT *getLoopLatch() const {
309 BlockT *Header = getHeader();
310 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits;
311 typename InvBlockTraits::ChildIteratorType PI =
312 InvBlockTraits::child_begin(Header);
313 typename InvBlockTraits::ChildIteratorType PE =
314 InvBlockTraits::child_end(Header);
316 for (; PI != PE; ++PI) {
317 typename InvBlockTraits::NodeType *N = *PI;
327 //===--------------------------------------------------------------------===//
328 // APIs for updating loop information after changing the CFG
331 /// addBasicBlockToLoop - This method is used by other analyses to update loop
332 /// information. NewBB is set to be a new member of the current loop.
333 /// Because of this, it is added as a member of all parent loops, and is added
334 /// to the specified LoopInfo object as being in the current basic block. It
335 /// is not valid to replace the loop header with this method.
337 void addBasicBlockToLoop(BlockT *NewBB, LoopInfoBase<BlockT, LoopT> &LI);
339 /// replaceChildLoopWith - This is used when splitting loops up. It replaces
340 /// the OldChild entry in our children list with NewChild, and updates the
341 /// parent pointer of OldChild to be null and the NewChild to be this loop.
342 /// This updates the loop depth of the new child.
343 void replaceChildLoopWith(LoopT *OldChild,
345 assert(OldChild->ParentLoop == this && "This loop is already broken!");
346 assert(NewChild->ParentLoop == 0 && "NewChild already has a parent!");
347 typename std::vector<LoopT *>::iterator I =
348 std::find(SubLoops.begin(), SubLoops.end(), OldChild);
349 assert(I != SubLoops.end() && "OldChild not in loop!");
351 OldChild->ParentLoop = 0;
352 NewChild->ParentLoop = static_cast<LoopT *>(this);
355 /// addChildLoop - Add the specified loop to be a child of this loop. This
356 /// updates the loop depth of the new child.
358 void addChildLoop(LoopT *NewChild) {
359 assert(NewChild->ParentLoop == 0 && "NewChild already has a parent!");
360 NewChild->ParentLoop = static_cast<LoopT *>(this);
361 SubLoops.push_back(NewChild);
364 /// removeChildLoop - This removes the specified child from being a subloop of
365 /// this loop. The loop is not deleted, as it will presumably be inserted
366 /// into another loop.
367 LoopT *removeChildLoop(iterator I) {
368 assert(I != SubLoops.end() && "Cannot remove end iterator!");
370 assert(Child->ParentLoop == this && "Child is not a child of this loop!");
371 SubLoops.erase(SubLoops.begin()+(I-begin()));
372 Child->ParentLoop = 0;
376 /// addBlockEntry - This adds a basic block directly to the basic block list.
377 /// This should only be used by transformations that create new loops. Other
378 /// transformations should use addBasicBlockToLoop.
379 void addBlockEntry(BlockT *BB) {
380 Blocks.push_back(BB);
383 /// moveToHeader - This method is used to move BB (which must be part of this
384 /// loop) to be the loop header of the loop (the block that dominates all
386 void moveToHeader(BlockT *BB) {
387 if (Blocks[0] == BB) return;
388 for (unsigned i = 0; ; ++i) {
389 assert(i != Blocks.size() && "Loop does not contain BB!");
390 if (Blocks[i] == BB) {
391 Blocks[i] = Blocks[0];
398 /// removeBlockFromLoop - This removes the specified basic block from the
399 /// current loop, updating the Blocks as appropriate. This does not update
400 /// the mapping in the LoopInfo class.
401 void removeBlockFromLoop(BlockT *BB) {
402 RemoveFromVector(Blocks, BB);
405 /// verifyLoop - Verify loop structure
406 void verifyLoop() const {
408 assert(!Blocks.empty() && "Loop header is missing");
410 // Sort the blocks vector so that we can use binary search to do quick
412 SmallVector<BlockT*, 128> LoopBBs(block_begin(), block_end());
413 std::sort(LoopBBs.begin(), LoopBBs.end());
415 // Check the individual blocks.
416 for (block_iterator I = block_begin(), E = block_end(); I != E; ++I) {
418 bool HasInsideLoopSuccs = false;
419 bool HasInsideLoopPreds = false;
420 SmallVector<BlockT *, 2> OutsideLoopPreds;
422 typedef GraphTraits<BlockT*> BlockTraits;
423 for (typename BlockTraits::ChildIteratorType SI =
424 BlockTraits::child_begin(BB), SE = BlockTraits::child_end(BB);
426 if (std::binary_search(LoopBBs.begin(), LoopBBs.end(), *SI)) {
427 HasInsideLoopSuccs = true;
430 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits;
431 for (typename InvBlockTraits::ChildIteratorType PI =
432 InvBlockTraits::child_begin(BB), PE = InvBlockTraits::child_end(BB);
434 typename InvBlockTraits::NodeType *N = *PI;
435 if (std::binary_search(LoopBBs.begin(), LoopBBs.end(), N))
436 HasInsideLoopPreds = true;
438 OutsideLoopPreds.push_back(N);
441 if (BB == getHeader()) {
442 assert(!OutsideLoopPreds.empty() && "Loop is unreachable!");
443 } else if (!OutsideLoopPreds.empty()) {
444 // A non-header loop shouldn't be reachable from outside the loop,
445 // though it is permitted if the predecessor is not itself actually
447 BlockT *EntryBB = BB->getParent()->begin();
448 for (df_iterator<BlockT *> NI = df_begin(EntryBB),
449 NE = df_end(EntryBB); NI != NE; ++NI)
450 for (unsigned i = 0, e = OutsideLoopPreds.size(); i != e; ++i)
451 assert(*NI != OutsideLoopPreds[i] &&
452 "Loop has multiple entry points!");
454 assert(HasInsideLoopPreds && "Loop block has no in-loop predecessors!");
455 assert(HasInsideLoopSuccs && "Loop block has no in-loop successors!");
456 assert(BB != getHeader()->getParent()->begin() &&
457 "Loop contains function entry block!");
460 // Check the subloops.
461 for (iterator I = begin(), E = end(); I != E; ++I)
462 // Each block in each subloop should be contained within this loop.
463 for (block_iterator BI = (*I)->block_begin(), BE = (*I)->block_end();
465 assert(std::binary_search(LoopBBs.begin(), LoopBBs.end(), *BI) &&
466 "Loop does not contain all the blocks of a subloop!");
469 // Check the parent loop pointer.
471 assert(std::find(ParentLoop->begin(), ParentLoop->end(), this) !=
473 "Loop is not a subloop of its parent!");
478 /// verifyLoop - Verify loop structure of this loop and all nested loops.
479 void verifyLoopNest() const {
482 // Verify the subloops.
483 for (iterator I = begin(), E = end(); I != E; ++I)
484 (*I)->verifyLoopNest();
487 void print(raw_ostream &OS, unsigned Depth = 0) const {
488 OS.indent(Depth*2) << "Loop at depth " << getLoopDepth()
491 for (unsigned i = 0; i < getBlocks().size(); ++i) {
493 BlockT *BB = getBlocks()[i];
494 WriteAsOperand(OS, BB, false);
495 if (BB == getHeader()) OS << "<header>";
496 if (BB == getLoopLatch()) OS << "<latch>";
497 if (isLoopExiting(BB)) OS << "<exiting>";
501 for (iterator I = begin(), E = end(); I != E; ++I)
502 (*I)->print(OS, Depth+2);
506 friend class LoopInfoBase<BlockT, LoopT>;
507 explicit LoopBase(BlockT *BB) : ParentLoop(0) {
508 Blocks.push_back(BB);
512 template<class BlockT, class LoopT>
513 raw_ostream& operator<<(raw_ostream &OS, const LoopBase<BlockT, LoopT> &Loop) {
518 class Loop : public LoopBase<BasicBlock, Loop> {
522 /// isLoopInvariant - Return true if the specified value is loop invariant
524 bool isLoopInvariant(Value *V) const;
526 /// isLoopInvariant - Return true if the specified instruction is
529 bool isLoopInvariant(Instruction *I) const;
531 /// makeLoopInvariant - If the given value is an instruction inside of the
532 /// loop and it can be hoisted, do so to make it trivially loop-invariant.
533 /// Return true if the value after any hoisting is loop invariant. This
534 /// function can be used as a slightly more aggressive replacement for
537 /// If InsertPt is specified, it is the point to hoist instructions to.
538 /// If null, the terminator of the loop preheader is used.
540 bool makeLoopInvariant(Value *V, bool &Changed,
541 Instruction *InsertPt = 0) const;
543 /// makeLoopInvariant - If the given instruction is inside of the
544 /// loop and it can be hoisted, do so to make it trivially loop-invariant.
545 /// Return true if the instruction after any hoisting is loop invariant. This
546 /// function can be used as a slightly more aggressive replacement for
549 /// If InsertPt is specified, it is the point to hoist instructions to.
550 /// If null, the terminator of the loop preheader is used.
552 bool makeLoopInvariant(Instruction *I, bool &Changed,
553 Instruction *InsertPt = 0) const;
555 /// getCanonicalInductionVariable - Check to see if the loop has a canonical
556 /// induction variable: an integer recurrence that starts at 0 and increments
557 /// by one each time through the loop. If so, return the phi node that
558 /// corresponds to it.
560 /// The IndVarSimplify pass transforms loops to have a canonical induction
563 PHINode *getCanonicalInductionVariable() const;
565 /// getTripCount - Return a loop-invariant LLVM value indicating the number of
566 /// times the loop will be executed. Note that this means that the backedge
567 /// of the loop executes N-1 times. If the trip-count cannot be determined,
568 /// this returns null.
570 /// The IndVarSimplify pass transforms loops to have a form that this
571 /// function easily understands.
573 Value *getTripCount() const;
575 /// getSmallConstantTripCount - Returns the trip count of this loop as a
576 /// normal unsigned value, if possible. Returns 0 if the trip count is unknown
577 /// of not constant. Will also return 0 if the trip count is very large
580 /// The IndVarSimplify pass transforms loops to have a form that this
581 /// function easily understands.
583 unsigned getSmallConstantTripCount() const;
585 /// getSmallConstantTripMultiple - Returns the largest constant divisor of the
586 /// trip count of this loop as a normal unsigned value, if possible. This
587 /// means that the actual trip count is always a multiple of the returned
588 /// value (don't forget the trip count could very well be zero as well!).
590 /// Returns 1 if the trip count is unknown or not guaranteed to be the
591 /// multiple of a constant (which is also the case if the trip count is simply
592 /// constant, use getSmallConstantTripCount for that case), Will also return 1
593 /// if the trip count is very large (>= 2^32).
594 unsigned getSmallConstantTripMultiple() const;
596 /// isLCSSAForm - Return true if the Loop is in LCSSA form
597 bool isLCSSAForm(DominatorTree &DT) const;
599 /// isLoopSimplifyForm - Return true if the Loop is in the form that
600 /// the LoopSimplify form transforms loops to, which is sometimes called
602 bool isLoopSimplifyForm() const;
604 /// hasDedicatedExits - Return true if no exit block for the loop
605 /// has a predecessor that is outside the loop.
606 bool hasDedicatedExits() const;
608 /// getUniqueExitBlocks - Return all unique successor blocks of this loop.
609 /// These are the blocks _outside of the current loop_ which are branched to.
610 /// This assumes that loop exits are in canonical form.
612 void getUniqueExitBlocks(SmallVectorImpl<BasicBlock *> &ExitBlocks) const;
614 /// getUniqueExitBlock - If getUniqueExitBlocks would return exactly one
615 /// block, return that block. Otherwise return null.
616 BasicBlock *getUniqueExitBlock() const;
621 friend class LoopInfoBase<BasicBlock, Loop>;
622 explicit Loop(BasicBlock *BB) : LoopBase<BasicBlock, Loop>(BB) {}
625 //===----------------------------------------------------------------------===//
626 /// LoopInfo - This class builds and contains all of the top level loop
627 /// structures in the specified function.
630 template<class BlockT, class LoopT>
632 // BBMap - Mapping of basic blocks to the inner most loop they occur in
633 std::map<BlockT *, LoopT *> BBMap;
634 std::vector<LoopT *> TopLevelLoops;
635 friend class LoopBase<BlockT, LoopT>;
637 void operator=(const LoopInfoBase &); // do not implement
638 LoopInfoBase(const LoopInfo &); // do not implement
641 ~LoopInfoBase() { releaseMemory(); }
643 void releaseMemory() {
644 for (typename std::vector<LoopT *>::iterator I =
645 TopLevelLoops.begin(), E = TopLevelLoops.end(); I != E; ++I)
646 delete *I; // Delete all of the loops...
648 BBMap.clear(); // Reset internal state of analysis
649 TopLevelLoops.clear();
652 /// iterator/begin/end - The interface to the top-level loops in the current
655 typedef typename std::vector<LoopT *>::const_iterator iterator;
656 iterator begin() const { return TopLevelLoops.begin(); }
657 iterator end() const { return TopLevelLoops.end(); }
658 bool empty() const { return TopLevelLoops.empty(); }
660 /// getLoopFor - Return the inner most loop that BB lives in. If a basic
661 /// block is in no loop (for example the entry node), null is returned.
663 LoopT *getLoopFor(const BlockT *BB) const {
664 typename std::map<BlockT *, LoopT *>::const_iterator I=
665 BBMap.find(const_cast<BlockT*>(BB));
666 return I != BBMap.end() ? I->second : 0;
669 /// operator[] - same as getLoopFor...
671 const LoopT *operator[](const BlockT *BB) const {
672 return getLoopFor(BB);
675 /// getLoopDepth - Return the loop nesting level of the specified block. A
676 /// depth of 0 means the block is not inside any loop.
678 unsigned getLoopDepth(const BlockT *BB) const {
679 const LoopT *L = getLoopFor(BB);
680 return L ? L->getLoopDepth() : 0;
683 // isLoopHeader - True if the block is a loop header node
684 bool isLoopHeader(BlockT *BB) const {
685 const LoopT *L = getLoopFor(BB);
686 return L && L->getHeader() == BB;
689 /// removeLoop - This removes the specified top-level loop from this loop info
690 /// object. The loop is not deleted, as it will presumably be inserted into
692 LoopT *removeLoop(iterator I) {
693 assert(I != end() && "Cannot remove end iterator!");
695 assert(L->getParentLoop() == 0 && "Not a top-level loop!");
696 TopLevelLoops.erase(TopLevelLoops.begin() + (I-begin()));
700 /// changeLoopFor - Change the top-level loop that contains BB to the
701 /// specified loop. This should be used by transformations that restructure
702 /// the loop hierarchy tree.
703 void changeLoopFor(BlockT *BB, LoopT *L) {
704 LoopT *&OldLoop = BBMap[BB];
705 assert(OldLoop && "Block not in a loop yet!");
709 /// changeTopLevelLoop - Replace the specified loop in the top-level loops
710 /// list with the indicated loop.
711 void changeTopLevelLoop(LoopT *OldLoop,
713 typename std::vector<LoopT *>::iterator I =
714 std::find(TopLevelLoops.begin(), TopLevelLoops.end(), OldLoop);
715 assert(I != TopLevelLoops.end() && "Old loop not at top level!");
717 assert(NewLoop->ParentLoop == 0 && OldLoop->ParentLoop == 0 &&
718 "Loops already embedded into a subloop!");
721 /// addTopLevelLoop - This adds the specified loop to the collection of
723 void addTopLevelLoop(LoopT *New) {
724 assert(New->getParentLoop() == 0 && "Loop already in subloop!");
725 TopLevelLoops.push_back(New);
728 /// removeBlock - This method completely removes BB from all data structures,
729 /// including all of the Loop objects it is nested in and our mapping from
730 /// BasicBlocks to loops.
731 void removeBlock(BlockT *BB) {
732 typename std::map<BlockT *, LoopT *>::iterator I = BBMap.find(BB);
733 if (I != BBMap.end()) {
734 for (LoopT *L = I->second; L; L = L->getParentLoop())
735 L->removeBlockFromLoop(BB);
743 static bool isNotAlreadyContainedIn(const LoopT *SubLoop,
744 const LoopT *ParentLoop) {
745 if (SubLoop == 0) return true;
746 if (SubLoop == ParentLoop) return false;
747 return isNotAlreadyContainedIn(SubLoop->getParentLoop(), ParentLoop);
750 void Calculate(DominatorTreeBase<BlockT> &DT) {
751 BlockT *RootNode = DT.getRootNode()->getBlock();
753 for (df_iterator<BlockT*> NI = df_begin(RootNode),
754 NE = df_end(RootNode); NI != NE; ++NI)
755 if (LoopT *L = ConsiderForLoop(*NI, DT))
756 TopLevelLoops.push_back(L);
759 LoopT *ConsiderForLoop(BlockT *BB, DominatorTreeBase<BlockT> &DT) {
760 if (BBMap.find(BB) != BBMap.end()) return 0;// Haven't processed this node?
762 std::vector<BlockT *> TodoStack;
764 // Scan the predecessors of BB, checking to see if BB dominates any of
765 // them. This identifies backedges which target this node...
766 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits;
767 for (typename InvBlockTraits::ChildIteratorType I =
768 InvBlockTraits::child_begin(BB), E = InvBlockTraits::child_end(BB);
770 typename InvBlockTraits::NodeType *N = *I;
771 if (DT.dominates(BB, N)) // If BB dominates its predecessor...
772 TodoStack.push_back(N);
775 if (TodoStack.empty()) return 0; // No backedges to this block...
777 // Create a new loop to represent this basic block...
778 LoopT *L = new LoopT(BB);
781 BlockT *EntryBlock = BB->getParent()->begin();
783 while (!TodoStack.empty()) { // Process all the nodes in the loop
784 BlockT *X = TodoStack.back();
785 TodoStack.pop_back();
787 if (!L->contains(X) && // As of yet unprocessed??
788 DT.dominates(EntryBlock, X)) { // X is reachable from entry block?
789 // Check to see if this block already belongs to a loop. If this occurs
790 // then we have a case where a loop that is supposed to be a child of
791 // the current loop was processed before the current loop. When this
792 // occurs, this child loop gets added to a part of the current loop,
793 // making it a sibling to the current loop. We have to reparent this
796 const_cast<LoopT *>(getLoopFor(X)))
797 if (SubLoop->getHeader() == X && isNotAlreadyContainedIn(SubLoop, L)){
798 // Remove the subloop from its current parent...
799 assert(SubLoop->ParentLoop && SubLoop->ParentLoop != L);
800 LoopT *SLP = SubLoop->ParentLoop; // SubLoopParent
801 typename std::vector<LoopT *>::iterator I =
802 std::find(SLP->SubLoops.begin(), SLP->SubLoops.end(), SubLoop);
803 assert(I != SLP->SubLoops.end() &&"SubLoop not a child of parent?");
804 SLP->SubLoops.erase(I); // Remove from parent...
806 // Add the subloop to THIS loop...
807 SubLoop->ParentLoop = L;
808 L->SubLoops.push_back(SubLoop);
811 // Normal case, add the block to our loop...
812 L->Blocks.push_back(X);
814 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits;
816 // Add all of the predecessors of X to the end of the work stack...
817 TodoStack.insert(TodoStack.end(), InvBlockTraits::child_begin(X),
818 InvBlockTraits::child_end(X));
822 // If there are any loops nested within this loop, create them now!
823 for (typename std::vector<BlockT*>::iterator I = L->Blocks.begin(),
824 E = L->Blocks.end(); I != E; ++I)
825 if (LoopT *NewLoop = ConsiderForLoop(*I, DT)) {
826 L->SubLoops.push_back(NewLoop);
827 NewLoop->ParentLoop = L;
830 // Add the basic blocks that comprise this loop to the BBMap so that this
831 // loop can be found for them.
833 for (typename std::vector<BlockT*>::iterator I = L->Blocks.begin(),
834 E = L->Blocks.end(); I != E; ++I)
835 BBMap.insert(std::make_pair(*I, L));
837 // Now that we have a list of all of the child loops of this loop, check to
838 // see if any of them should actually be nested inside of each other. We
839 // can accidentally pull loops our of their parents, so we must make sure to
840 // organize the loop nests correctly now.
842 std::map<BlockT *, LoopT *> ContainingLoops;
843 for (unsigned i = 0; i != L->SubLoops.size(); ++i) {
844 LoopT *Child = L->SubLoops[i];
845 assert(Child->getParentLoop() == L && "Not proper child loop?");
847 if (LoopT *ContainingLoop = ContainingLoops[Child->getHeader()]) {
848 // If there is already a loop which contains this loop, move this loop
849 // into the containing loop.
850 MoveSiblingLoopInto(Child, ContainingLoop);
851 --i; // The loop got removed from the SubLoops list.
853 // This is currently considered to be a top-level loop. Check to see
854 // if any of the contained blocks are loop headers for subloops we
855 // have already processed.
856 for (unsigned b = 0, e = Child->Blocks.size(); b != e; ++b) {
857 LoopT *&BlockLoop = ContainingLoops[Child->Blocks[b]];
858 if (BlockLoop == 0) { // Child block not processed yet...
860 } else if (BlockLoop != Child) {
861 LoopT *SubLoop = BlockLoop;
862 // Reparent all of the blocks which used to belong to BlockLoops
863 for (unsigned j = 0, f = SubLoop->Blocks.size(); j != f; ++j)
864 ContainingLoops[SubLoop->Blocks[j]] = Child;
866 // There is already a loop which contains this block, that means
867 // that we should reparent the loop which the block is currently
868 // considered to belong to to be a child of this loop.
869 MoveSiblingLoopInto(SubLoop, Child);
870 --i; // We just shrunk the SubLoops list.
880 /// MoveSiblingLoopInto - This method moves the NewChild loop to live inside
881 /// of the NewParent Loop, instead of being a sibling of it.
882 void MoveSiblingLoopInto(LoopT *NewChild,
884 LoopT *OldParent = NewChild->getParentLoop();
885 assert(OldParent && OldParent == NewParent->getParentLoop() &&
886 NewChild != NewParent && "Not sibling loops!");
888 // Remove NewChild from being a child of OldParent
889 typename std::vector<LoopT *>::iterator I =
890 std::find(OldParent->SubLoops.begin(), OldParent->SubLoops.end(),
892 assert(I != OldParent->SubLoops.end() && "Parent fields incorrect??");
893 OldParent->SubLoops.erase(I); // Remove from parent's subloops list
894 NewChild->ParentLoop = 0;
896 InsertLoopInto(NewChild, NewParent);
899 /// InsertLoopInto - This inserts loop L into the specified parent loop. If
900 /// the parent loop contains a loop which should contain L, the loop gets
901 /// inserted into L instead.
902 void InsertLoopInto(LoopT *L, LoopT *Parent) {
903 BlockT *LHeader = L->getHeader();
904 assert(Parent->contains(LHeader) &&
905 "This loop should not be inserted here!");
907 // Check to see if it belongs in a child loop...
908 for (unsigned i = 0, e = static_cast<unsigned>(Parent->SubLoops.size());
910 if (Parent->SubLoops[i]->contains(LHeader)) {
911 InsertLoopInto(L, Parent->SubLoops[i]);
915 // If not, insert it here!
916 Parent->SubLoops.push_back(L);
917 L->ParentLoop = Parent;
922 void print(raw_ostream &OS) const {
923 for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
924 TopLevelLoops[i]->print(OS);
926 for (std::map<BasicBlock*, LoopT*>::const_iterator I = BBMap.begin(),
927 E = BBMap.end(); I != E; ++I)
928 OS << "BB '" << I->first->getName() << "' level = "
929 << I->second->getLoopDepth() << "\n";
934 class LoopInfo : public FunctionPass {
935 LoopInfoBase<BasicBlock, Loop> LI;
936 friend class LoopBase<BasicBlock, Loop>;
938 void operator=(const LoopInfo &); // do not implement
939 LoopInfo(const LoopInfo &); // do not implement
941 static char ID; // Pass identification, replacement for typeid
943 LoopInfo() : FunctionPass(ID) {}
945 LoopInfoBase<BasicBlock, Loop>& getBase() { return LI; }
947 /// iterator/begin/end - The interface to the top-level loops in the current
950 typedef LoopInfoBase<BasicBlock, Loop>::iterator iterator;
951 inline iterator begin() const { return LI.begin(); }
952 inline iterator end() const { return LI.end(); }
953 bool empty() const { return LI.empty(); }
955 /// getLoopFor - Return the inner most loop that BB lives in. If a basic
956 /// block is in no loop (for example the entry node), null is returned.
958 inline Loop *getLoopFor(const BasicBlock *BB) const {
959 return LI.getLoopFor(BB);
962 /// operator[] - same as getLoopFor...
964 inline const Loop *operator[](const BasicBlock *BB) const {
965 return LI.getLoopFor(BB);
968 /// getLoopDepth - Return the loop nesting level of the specified block. A
969 /// depth of 0 means the block is not inside any loop.
971 inline unsigned getLoopDepth(const BasicBlock *BB) const {
972 return LI.getLoopDepth(BB);
975 // isLoopHeader - True if the block is a loop header node
976 inline bool isLoopHeader(BasicBlock *BB) const {
977 return LI.isLoopHeader(BB);
980 /// runOnFunction - Calculate the natural loop information.
982 virtual bool runOnFunction(Function &F);
984 virtual void verifyAnalysis() const;
986 virtual void releaseMemory() { LI.releaseMemory(); }
988 virtual void print(raw_ostream &O, const Module* M = 0) const;
990 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
992 /// removeLoop - This removes the specified top-level loop from this loop info
993 /// object. The loop is not deleted, as it will presumably be inserted into
995 inline Loop *removeLoop(iterator I) { return LI.removeLoop(I); }
997 /// changeLoopFor - Change the top-level loop that contains BB to the
998 /// specified loop. This should be used by transformations that restructure
999 /// the loop hierarchy tree.
1000 inline void changeLoopFor(BasicBlock *BB, Loop *L) {
1001 LI.changeLoopFor(BB, L);
1004 /// changeTopLevelLoop - Replace the specified loop in the top-level loops
1005 /// list with the indicated loop.
1006 inline void changeTopLevelLoop(Loop *OldLoop, Loop *NewLoop) {
1007 LI.changeTopLevelLoop(OldLoop, NewLoop);
1010 /// addTopLevelLoop - This adds the specified loop to the collection of
1011 /// top-level loops.
1012 inline void addTopLevelLoop(Loop *New) {
1013 LI.addTopLevelLoop(New);
1016 /// removeBlock - This method completely removes BB from all data structures,
1017 /// including all of the Loop objects it is nested in and our mapping from
1018 /// BasicBlocks to loops.
1019 void removeBlock(BasicBlock *BB) {
1025 // Allow clients to walk the list of nested loops...
1026 template <> struct GraphTraits<const Loop*> {
1027 typedef const Loop NodeType;
1028 typedef LoopInfo::iterator ChildIteratorType;
1030 static NodeType *getEntryNode(const Loop *L) { return L; }
1031 static inline ChildIteratorType child_begin(NodeType *N) {
1034 static inline ChildIteratorType child_end(NodeType *N) {
1039 template <> struct GraphTraits<Loop*> {
1040 typedef Loop NodeType;
1041 typedef LoopInfo::iterator ChildIteratorType;
1043 static NodeType *getEntryNode(Loop *L) { return L; }
1044 static inline ChildIteratorType child_begin(NodeType *N) {
1047 static inline ChildIteratorType child_end(NodeType *N) {
1052 template<class BlockT, class LoopT>
1054 LoopBase<BlockT, LoopT>::addBasicBlockToLoop(BlockT *NewBB,
1055 LoopInfoBase<BlockT, LoopT> &LIB) {
1056 assert((Blocks.empty() || LIB[getHeader()] == this) &&
1057 "Incorrect LI specified for this loop!");
1058 assert(NewBB && "Cannot add a null basic block to the loop!");
1059 assert(LIB[NewBB] == 0 && "BasicBlock already in the loop!");
1061 LoopT *L = static_cast<LoopT *>(this);
1063 // Add the loop mapping to the LoopInfo object...
1064 LIB.BBMap[NewBB] = L;
1066 // Add the basic block to this loop and all parent loops...
1068 L->Blocks.push_back(NewBB);
1069 L = L->getParentLoop();
1073 } // End llvm namespace