LoopInfo.h revision dda30cd4af1c5f88fc00fd40b673f8e27c61379d
1//===- llvm/Analysis/LoopInfo.h - Natural Loop Calculator -------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 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. 14// 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. 18// 19// It can calculate on the fly various bits of information, for example: 20// 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 25// * the loop depth 26// * the trip count 27// * etc... 28// 29//===----------------------------------------------------------------------===// 30 31#ifndef LLVM_ANALYSIS_LOOP_INFO_H 32#define LLVM_ANALYSIS_LOOP_INFO_H 33 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/Analysis/Dominators.h" 39#include "llvm/Support/CFG.h" 40#include "llvm/Support/raw_ostream.h" 41#include <algorithm> 42 43namespace llvm { 44 45template<typename T> 46static void RemoveFromVector(std::vector<T*> &V, T *N) { 47 typename std::vector<T*>::iterator I = std::find(V.begin(), V.end(), N); 48 assert(I != V.end() && "N is not in this list!"); 49 V.erase(I); 50} 51 52class DominatorTree; 53class LoopInfo; 54class Loop; 55template<class N, class M> class LoopInfoBase; 56template<class N, class M> class LoopBase; 57 58//===----------------------------------------------------------------------===// 59/// LoopBase class - Instances of this class are used to represent loops that 60/// are detected in the flow graph 61/// 62template<class BlockT, class LoopT> 63class LoopBase { 64 LoopT *ParentLoop; 65 // SubLoops - Loops contained entirely within this one. 66 std::vector<LoopT *> SubLoops; 67 68 // Blocks - The list of blocks in this loop. First entry is the header node. 69 std::vector<BlockT*> Blocks; 70 71 // DO NOT IMPLEMENT 72 LoopBase(const LoopBase<BlockT, LoopT> &); 73 // DO NOT IMPLEMENT 74 const LoopBase<BlockT, LoopT>&operator=(const LoopBase<BlockT, LoopT> &); 75public: 76 /// Loop ctor - This creates an empty loop. 77 LoopBase() : ParentLoop(0) {} 78 ~LoopBase() { 79 for (size_t i = 0, e = SubLoops.size(); i != e; ++i) 80 delete SubLoops[i]; 81 } 82 83 /// getLoopDepth - Return the nesting level of this loop. An outer-most 84 /// loop has depth 1, for consistency with loop depth values used for basic 85 /// blocks, where depth 0 is used for blocks not inside any loops. 86 unsigned getLoopDepth() const { 87 unsigned D = 1; 88 for (const LoopT *CurLoop = ParentLoop; CurLoop; 89 CurLoop = CurLoop->ParentLoop) 90 ++D; 91 return D; 92 } 93 BlockT *getHeader() const { return Blocks.front(); } 94 LoopT *getParentLoop() const { return ParentLoop; } 95 96 /// contains - Return true if the specified loop is contained within in 97 /// this loop. 98 /// 99 bool contains(const LoopT *L) const { 100 if (L == this) return true; 101 if (L == 0) return false; 102 return contains(L->getParentLoop()); 103 } 104 105 /// contains - Return true if the specified basic block is in this loop. 106 /// 107 bool contains(const BlockT *BB) const { 108 return std::find(block_begin(), block_end(), BB) != block_end(); 109 } 110 111 /// contains - Return true if the specified instruction is in this loop. 112 /// 113 template<class InstT> 114 bool contains(const InstT *Inst) const { 115 return contains(Inst->getParent()); 116 } 117 118 /// iterator/begin/end - Return the loops contained entirely within this loop. 119 /// 120 const std::vector<LoopT *> &getSubLoops() const { return SubLoops; } 121 typedef typename std::vector<LoopT *>::const_iterator iterator; 122 iterator begin() const { return SubLoops.begin(); } 123 iterator end() const { return SubLoops.end(); } 124 bool empty() const { return SubLoops.empty(); } 125 126 /// getBlocks - Get a list of the basic blocks which make up this loop. 127 /// 128 const std::vector<BlockT*> &getBlocks() const { return Blocks; } 129 typedef typename std::vector<BlockT*>::const_iterator block_iterator; 130 block_iterator block_begin() const { return Blocks.begin(); } 131 block_iterator block_end() const { return Blocks.end(); } 132 133 /// isLoopExiting - True if terminator in the block can branch to another 134 /// block that is outside of the current loop. 135 /// 136 bool isLoopExiting(const BlockT *BB) const { 137 typedef GraphTraits<BlockT*> BlockTraits; 138 for (typename BlockTraits::ChildIteratorType SI = 139 BlockTraits::child_begin(const_cast<BlockT*>(BB)), 140 SE = BlockTraits::child_end(const_cast<BlockT*>(BB)); SI != SE; ++SI) { 141 if (!contains(*SI)) 142 return true; 143 } 144 return false; 145 } 146 147 /// getNumBackEdges - Calculate the number of back edges to the loop header 148 /// 149 unsigned getNumBackEdges() const { 150 unsigned NumBackEdges = 0; 151 BlockT *H = getHeader(); 152 153 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits; 154 for (typename InvBlockTraits::ChildIteratorType I = 155 InvBlockTraits::child_begin(const_cast<BlockT*>(H)), 156 E = InvBlockTraits::child_end(const_cast<BlockT*>(H)); I != E; ++I) 157 if (contains(*I)) 158 ++NumBackEdges; 159 160 return NumBackEdges; 161 } 162 163 //===--------------------------------------------------------------------===// 164 // APIs for simple analysis of the loop. 165 // 166 // Note that all of these methods can fail on general loops (ie, there may not 167 // be a preheader, etc). For best success, the loop simplification and 168 // induction variable canonicalization pass should be used to normalize loops 169 // for easy analysis. These methods assume canonical loops. 170 171 /// getExitingBlocks - Return all blocks inside the loop that have successors 172 /// outside of the loop. These are the blocks _inside of the current loop_ 173 /// which branch out. The returned list is always unique. 174 /// 175 void getExitingBlocks(SmallVectorImpl<BlockT *> &ExitingBlocks) const { 176 // Sort the blocks vector so that we can use binary search to do quick 177 // lookups. 178 SmallVector<BlockT*, 128> LoopBBs(block_begin(), block_end()); 179 std::sort(LoopBBs.begin(), LoopBBs.end()); 180 181 typedef GraphTraits<BlockT*> BlockTraits; 182 for (block_iterator BI = block_begin(), BE = block_end(); BI != BE; ++BI) 183 for (typename BlockTraits::ChildIteratorType I = 184 BlockTraits::child_begin(*BI), E = BlockTraits::child_end(*BI); 185 I != E; ++I) 186 if (!std::binary_search(LoopBBs.begin(), LoopBBs.end(), *I)) { 187 // Not in current loop? It must be an exit block. 188 ExitingBlocks.push_back(*BI); 189 break; 190 } 191 } 192 193 /// getExitingBlock - If getExitingBlocks would return exactly one block, 194 /// return that block. Otherwise return null. 195 BlockT *getExitingBlock() const { 196 SmallVector<BlockT*, 8> ExitingBlocks; 197 getExitingBlocks(ExitingBlocks); 198 if (ExitingBlocks.size() == 1) 199 return ExitingBlocks[0]; 200 return 0; 201 } 202 203 /// getExitBlocks - Return all of the successor blocks of this loop. These 204 /// are the blocks _outside of the current loop_ which are branched to. 205 /// 206 void getExitBlocks(SmallVectorImpl<BlockT*> &ExitBlocks) const { 207 // Sort the blocks vector so that we can use binary search to do quick 208 // lookups. 209 SmallVector<BlockT*, 128> LoopBBs(block_begin(), block_end()); 210 std::sort(LoopBBs.begin(), LoopBBs.end()); 211 212 typedef GraphTraits<BlockT*> BlockTraits; 213 for (block_iterator BI = block_begin(), BE = block_end(); BI != BE; ++BI) 214 for (typename BlockTraits::ChildIteratorType I = 215 BlockTraits::child_begin(*BI), E = BlockTraits::child_end(*BI); 216 I != E; ++I) 217 if (!std::binary_search(LoopBBs.begin(), LoopBBs.end(), *I)) 218 // Not in current loop? It must be an exit block. 219 ExitBlocks.push_back(*I); 220 } 221 222 /// getExitBlock - If getExitBlocks would return exactly one block, 223 /// return that block. Otherwise return null. 224 BlockT *getExitBlock() const { 225 SmallVector<BlockT*, 8> ExitBlocks; 226 getExitBlocks(ExitBlocks); 227 if (ExitBlocks.size() == 1) 228 return ExitBlocks[0]; 229 return 0; 230 } 231 232 /// getExitEdges - Return all pairs of (_inside_block_,_outside_block_). 233 typedef std::pair<const BlockT*,const BlockT*> Edge; 234 void getExitEdges(SmallVectorImpl<Edge> &ExitEdges) const { 235 // Sort the blocks vector so that we can use binary search to do quick 236 // lookups. 237 SmallVector<BlockT*, 128> LoopBBs(block_begin(), block_end()); 238 std::sort(LoopBBs.begin(), LoopBBs.end()); 239 240 typedef GraphTraits<BlockT*> BlockTraits; 241 for (block_iterator BI = block_begin(), BE = block_end(); BI != BE; ++BI) 242 for (typename BlockTraits::ChildIteratorType I = 243 BlockTraits::child_begin(*BI), E = BlockTraits::child_end(*BI); 244 I != E; ++I) 245 if (!std::binary_search(LoopBBs.begin(), LoopBBs.end(), *I)) 246 // Not in current loop? It must be an exit block. 247 ExitEdges.push_back(std::make_pair(*BI, *I)); 248 } 249 250 /// getLoopPreheader - If there is a preheader for this loop, return it. A 251 /// loop has a preheader if there is only one edge to the header of the loop 252 /// from outside of the loop. If this is the case, the block branching to the 253 /// header of the loop is the preheader node. 254 /// 255 /// This method returns null if there is no preheader for the loop. 256 /// 257 BlockT *getLoopPreheader() const { 258 // Keep track of nodes outside the loop branching to the header... 259 BlockT *Out = 0; 260 261 // Loop over the predecessors of the header node... 262 BlockT *Header = getHeader(); 263 typedef GraphTraits<BlockT*> BlockTraits; 264 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits; 265 for (typename InvBlockTraits::ChildIteratorType PI = 266 InvBlockTraits::child_begin(Header), 267 PE = InvBlockTraits::child_end(Header); PI != PE; ++PI) 268 if (!contains(*PI)) { // If the block is not in the loop... 269 if (Out && Out != *PI) 270 return 0; // Multiple predecessors outside the loop 271 Out = *PI; 272 } 273 274 // Make sure there is only one exit out of the preheader. 275 assert(Out && "Header of loop has no predecessors from outside loop?"); 276 typename BlockTraits::ChildIteratorType SI = BlockTraits::child_begin(Out); 277 ++SI; 278 if (SI != BlockTraits::child_end(Out)) 279 return 0; // Multiple exits from the block, must not be a preheader. 280 281 // If there is exactly one preheader, return it. If there was zero, then 282 // Out is still null. 283 return Out; 284 } 285 286 /// getLoopLatch - If there is a single latch block for this loop, return it. 287 /// A latch block is a block that contains a branch back to the header. 288 BlockT *getLoopLatch() const { 289 BlockT *Header = getHeader(); 290 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits; 291 typename InvBlockTraits::ChildIteratorType PI = 292 InvBlockTraits::child_begin(Header); 293 typename InvBlockTraits::ChildIteratorType PE = 294 InvBlockTraits::child_end(Header); 295 BlockT *Latch = 0; 296 for (; PI != PE; ++PI) 297 if (contains(*PI)) { 298 if (Latch) return 0; 299 Latch = *PI; 300 } 301 302 return Latch; 303 } 304 305 //===--------------------------------------------------------------------===// 306 // APIs for updating loop information after changing the CFG 307 // 308 309 /// addBasicBlockToLoop - This method is used by other analyses to update loop 310 /// information. NewBB is set to be a new member of the current loop. 311 /// Because of this, it is added as a member of all parent loops, and is added 312 /// to the specified LoopInfo object as being in the current basic block. It 313 /// is not valid to replace the loop header with this method. 314 /// 315 void addBasicBlockToLoop(BlockT *NewBB, LoopInfoBase<BlockT, LoopT> &LI); 316 317 /// replaceChildLoopWith - This is used when splitting loops up. It replaces 318 /// the OldChild entry in our children list with NewChild, and updates the 319 /// parent pointer of OldChild to be null and the NewChild to be this loop. 320 /// This updates the loop depth of the new child. 321 void replaceChildLoopWith(LoopT *OldChild, 322 LoopT *NewChild) { 323 assert(OldChild->ParentLoop == this && "This loop is already broken!"); 324 assert(NewChild->ParentLoop == 0 && "NewChild already has a parent!"); 325 typename std::vector<LoopT *>::iterator I = 326 std::find(SubLoops.begin(), SubLoops.end(), OldChild); 327 assert(I != SubLoops.end() && "OldChild not in loop!"); 328 *I = NewChild; 329 OldChild->ParentLoop = 0; 330 NewChild->ParentLoop = static_cast<LoopT *>(this); 331 } 332 333 /// addChildLoop - Add the specified loop to be a child of this loop. This 334 /// updates the loop depth of the new child. 335 /// 336 void addChildLoop(LoopT *NewChild) { 337 assert(NewChild->ParentLoop == 0 && "NewChild already has a parent!"); 338 NewChild->ParentLoop = static_cast<LoopT *>(this); 339 SubLoops.push_back(NewChild); 340 } 341 342 /// removeChildLoop - This removes the specified child from being a subloop of 343 /// this loop. The loop is not deleted, as it will presumably be inserted 344 /// into another loop. 345 LoopT *removeChildLoop(iterator I) { 346 assert(I != SubLoops.end() && "Cannot remove end iterator!"); 347 LoopT *Child = *I; 348 assert(Child->ParentLoop == this && "Child is not a child of this loop!"); 349 SubLoops.erase(SubLoops.begin()+(I-begin())); 350 Child->ParentLoop = 0; 351 return Child; 352 } 353 354 /// addBlockEntry - This adds a basic block directly to the basic block list. 355 /// This should only be used by transformations that create new loops. Other 356 /// transformations should use addBasicBlockToLoop. 357 void addBlockEntry(BlockT *BB) { 358 Blocks.push_back(BB); 359 } 360 361 /// moveToHeader - This method is used to move BB (which must be part of this 362 /// loop) to be the loop header of the loop (the block that dominates all 363 /// others). 364 void moveToHeader(BlockT *BB) { 365 if (Blocks[0] == BB) return; 366 for (unsigned i = 0; ; ++i) { 367 assert(i != Blocks.size() && "Loop does not contain BB!"); 368 if (Blocks[i] == BB) { 369 Blocks[i] = Blocks[0]; 370 Blocks[0] = BB; 371 return; 372 } 373 } 374 } 375 376 /// removeBlockFromLoop - This removes the specified basic block from the 377 /// current loop, updating the Blocks as appropriate. This does not update 378 /// the mapping in the LoopInfo class. 379 void removeBlockFromLoop(BlockT *BB) { 380 RemoveFromVector(Blocks, BB); 381 } 382 383 /// verifyLoop - Verify loop structure 384 void verifyLoop() const { 385#ifndef NDEBUG 386 assert(!Blocks.empty() && "Loop header is missing"); 387 388 // Sort the blocks vector so that we can use binary search to do quick 389 // lookups. 390 SmallVector<BlockT*, 128> LoopBBs(block_begin(), block_end()); 391 std::sort(LoopBBs.begin(), LoopBBs.end()); 392 393 // Check the individual blocks. 394 for (block_iterator I = block_begin(), E = block_end(); I != E; ++I) { 395 BlockT *BB = *I; 396 bool HasInsideLoopSuccs = false; 397 bool HasInsideLoopPreds = false; 398 SmallVector<BlockT *, 2> OutsideLoopPreds; 399 400 typedef GraphTraits<BlockT*> BlockTraits; 401 for (typename BlockTraits::ChildIteratorType SI = 402 BlockTraits::child_begin(BB), SE = BlockTraits::child_end(BB); 403 SI != SE; ++SI) 404 if (std::binary_search(LoopBBs.begin(), LoopBBs.end(), *SI)) { 405 HasInsideLoopSuccs = true; 406 break; 407 } 408 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits; 409 for (typename InvBlockTraits::ChildIteratorType PI = 410 InvBlockTraits::child_begin(BB), PE = InvBlockTraits::child_end(BB); 411 PI != PE; ++PI) { 412 if (std::binary_search(LoopBBs.begin(), LoopBBs.end(), *PI)) 413 HasInsideLoopPreds = true; 414 else 415 OutsideLoopPreds.push_back(*PI); 416 } 417 418 if (BB == getHeader()) { 419 assert(!OutsideLoopPreds.empty() && "Loop is unreachable!"); 420 } else if (!OutsideLoopPreds.empty()) { 421 // A non-header loop shouldn't be reachable from outside the loop, 422 // though it is permitted if the predecessor is not itself actually 423 // reachable. 424 BlockT *EntryBB = BB->getParent()->begin(); 425 for (df_iterator<BlockT *> NI = df_begin(EntryBB), 426 NE = df_end(EntryBB); NI != NE; ++NI) 427 for (unsigned i = 0, e = OutsideLoopPreds.size(); i != e; ++i) 428 assert(*NI != OutsideLoopPreds[i] && 429 "Loop has multiple entry points!"); 430 } 431 assert(HasInsideLoopPreds && "Loop block has no in-loop predecessors!"); 432 assert(HasInsideLoopSuccs && "Loop block has no in-loop successors!"); 433 assert(BB != getHeader()->getParent()->begin() && 434 "Loop contains function entry block!"); 435 } 436 437 // Check the subloops. 438 for (iterator I = begin(), E = end(); I != E; ++I) 439 // Each block in each subloop should be contained within this loop. 440 for (block_iterator BI = (*I)->block_begin(), BE = (*I)->block_end(); 441 BI != BE; ++BI) { 442 assert(std::binary_search(LoopBBs.begin(), LoopBBs.end(), *BI) && 443 "Loop does not contain all the blocks of a subloop!"); 444 } 445 446 // Check the parent loop pointer. 447 if (ParentLoop) { 448 assert(std::find(ParentLoop->begin(), ParentLoop->end(), this) != 449 ParentLoop->end() && 450 "Loop is not a subloop of its parent!"); 451 } 452#endif 453 } 454 455 /// verifyLoop - Verify loop structure of this loop and all nested loops. 456 void verifyLoopNest() const { 457 // Verify this loop. 458 verifyLoop(); 459 // Verify the subloops. 460 for (iterator I = begin(), E = end(); I != E; ++I) 461 (*I)->verifyLoopNest(); 462 } 463 464 void print(raw_ostream &OS, unsigned Depth = 0) const { 465 OS.indent(Depth*2) << "Loop at depth " << getLoopDepth() 466 << " containing: "; 467 468 for (unsigned i = 0; i < getBlocks().size(); ++i) { 469 if (i) OS << ","; 470 BlockT *BB = getBlocks()[i]; 471 WriteAsOperand(OS, BB, false); 472 if (BB == getHeader()) OS << "<header>"; 473 if (BB == getLoopLatch()) OS << "<latch>"; 474 if (isLoopExiting(BB)) OS << "<exiting>"; 475 } 476 OS << "\n"; 477 478 for (iterator I = begin(), E = end(); I != E; ++I) 479 (*I)->print(OS, Depth+2); 480 } 481 482protected: 483 friend class LoopInfoBase<BlockT, LoopT>; 484 explicit LoopBase(BlockT *BB) : ParentLoop(0) { 485 Blocks.push_back(BB); 486 } 487}; 488 489class Loop : public LoopBase<BasicBlock, Loop> { 490public: 491 Loop() {} 492 493 /// isLoopInvariant - Return true if the specified value is loop invariant 494 /// 495 bool isLoopInvariant(Value *V) const; 496 497 /// isLoopInvariant - Return true if the specified instruction is 498 /// loop-invariant. 499 /// 500 bool isLoopInvariant(Instruction *I) const; 501 502 /// makeLoopInvariant - If the given value is an instruction inside of the 503 /// loop and it can be hoisted, do so to make it trivially loop-invariant. 504 /// Return true if the value after any hoisting is loop invariant. This 505 /// function can be used as a slightly more aggressive replacement for 506 /// isLoopInvariant. 507 /// 508 /// If InsertPt is specified, it is the point to hoist instructions to. 509 /// If null, the terminator of the loop preheader is used. 510 /// 511 bool makeLoopInvariant(Value *V, bool &Changed, 512 Instruction *InsertPt = 0) const; 513 514 /// makeLoopInvariant - If the given instruction is inside of the 515 /// loop and it can be hoisted, do so to make it trivially loop-invariant. 516 /// Return true if the instruction after any hoisting is loop invariant. This 517 /// function can be used as a slightly more aggressive replacement for 518 /// isLoopInvariant. 519 /// 520 /// If InsertPt is specified, it is the point to hoist instructions to. 521 /// If null, the terminator of the loop preheader is used. 522 /// 523 bool makeLoopInvariant(Instruction *I, bool &Changed, 524 Instruction *InsertPt = 0) const; 525 526 /// getCanonicalInductionVariable - Check to see if the loop has a canonical 527 /// induction variable: an integer recurrence that starts at 0 and increments 528 /// by one each time through the loop. If so, return the phi node that 529 /// corresponds to it. 530 /// 531 /// The IndVarSimplify pass transforms loops to have a canonical induction 532 /// variable. 533 /// 534 PHINode *getCanonicalInductionVariable() const; 535 536 /// getCanonicalInductionVariableIncrement - Return the LLVM value that holds 537 /// the canonical induction variable value for the "next" iteration of the 538 /// loop. This always succeeds if getCanonicalInductionVariable succeeds. 539 /// 540 Instruction *getCanonicalInductionVariableIncrement() const; 541 542 /// getTripCount - Return a loop-invariant LLVM value indicating the number of 543 /// times the loop will be executed. Note that this means that the backedge 544 /// of the loop executes N-1 times. If the trip-count cannot be determined, 545 /// this returns null. 546 /// 547 /// The IndVarSimplify pass transforms loops to have a form that this 548 /// function easily understands. 549 /// 550 Value *getTripCount() const; 551 552 /// getSmallConstantTripCount - Returns the trip count of this loop as a 553 /// normal unsigned value, if possible. Returns 0 if the trip count is unknown 554 /// of not constant. Will also return 0 if the trip count is very large 555 /// (>= 2^32) 556 unsigned getSmallConstantTripCount() const; 557 558 /// getSmallConstantTripMultiple - Returns the largest constant divisor of the 559 /// trip count of this loop as a normal unsigned value, if possible. This 560 /// means that the actual trip count is always a multiple of the returned 561 /// value (don't forget the trip count could very well be zero as well!). 562 /// 563 /// Returns 1 if the trip count is unknown or not guaranteed to be the 564 /// multiple of a constant (which is also the case if the trip count is simply 565 /// constant, use getSmallConstantTripCount for that case), Will also return 1 566 /// if the trip count is very large (>= 2^32). 567 unsigned getSmallConstantTripMultiple() const; 568 569 /// isLCSSAForm - Return true if the Loop is in LCSSA form 570 bool isLCSSAForm() const; 571 572 /// isLoopSimplifyForm - Return true if the Loop is in the form that 573 /// the LoopSimplify form transforms loops to, which is sometimes called 574 /// normal form. 575 bool isLoopSimplifyForm() const; 576 577 /// hasDedicatedExits - Return true if no exit block for the loop 578 /// has a predecessor that is outside the loop. 579 bool hasDedicatedExits() const; 580 581 /// getUniqueExitBlocks - Return all unique successor blocks of this loop. 582 /// These are the blocks _outside of the current loop_ which are branched to. 583 /// This assumes that loop exits are in canonical form. 584 /// 585 void getUniqueExitBlocks(SmallVectorImpl<BasicBlock *> &ExitBlocks) const; 586 587 /// getUniqueExitBlock - If getUniqueExitBlocks would return exactly one 588 /// block, return that block. Otherwise return null. 589 BasicBlock *getUniqueExitBlock() const; 590 591 void dump() const; 592 593private: 594 friend class LoopInfoBase<BasicBlock, Loop>; 595 explicit Loop(BasicBlock *BB) : LoopBase<BasicBlock, Loop>(BB) {} 596}; 597 598//===----------------------------------------------------------------------===// 599/// LoopInfo - This class builds and contains all of the top level loop 600/// structures in the specified function. 601/// 602 603template<class BlockT, class LoopT> 604class LoopInfoBase { 605 // BBMap - Mapping of basic blocks to the inner most loop they occur in 606 std::map<BlockT *, LoopT *> BBMap; 607 std::vector<LoopT *> TopLevelLoops; 608 friend class LoopBase<BlockT, LoopT>; 609 610 void operator=(const LoopInfoBase &); // do not implement 611 LoopInfoBase(const LoopInfo &); // do not implement 612public: 613 LoopInfoBase() { } 614 ~LoopInfoBase() { releaseMemory(); } 615 616 void releaseMemory() { 617 for (typename std::vector<LoopT *>::iterator I = 618 TopLevelLoops.begin(), E = TopLevelLoops.end(); I != E; ++I) 619 delete *I; // Delete all of the loops... 620 621 BBMap.clear(); // Reset internal state of analysis 622 TopLevelLoops.clear(); 623 } 624 625 /// iterator/begin/end - The interface to the top-level loops in the current 626 /// function. 627 /// 628 typedef typename std::vector<LoopT *>::const_iterator iterator; 629 iterator begin() const { return TopLevelLoops.begin(); } 630 iterator end() const { return TopLevelLoops.end(); } 631 bool empty() const { return TopLevelLoops.empty(); } 632 633 /// getLoopFor - Return the inner most loop that BB lives in. If a basic 634 /// block is in no loop (for example the entry node), null is returned. 635 /// 636 LoopT *getLoopFor(const BlockT *BB) const { 637 typename std::map<BlockT *, LoopT *>::const_iterator I= 638 BBMap.find(const_cast<BlockT*>(BB)); 639 return I != BBMap.end() ? I->second : 0; 640 } 641 642 /// operator[] - same as getLoopFor... 643 /// 644 const LoopT *operator[](const BlockT *BB) const { 645 return getLoopFor(BB); 646 } 647 648 /// getLoopDepth - Return the loop nesting level of the specified block. A 649 /// depth of 0 means the block is not inside any loop. 650 /// 651 unsigned getLoopDepth(const BlockT *BB) const { 652 const LoopT *L = getLoopFor(BB); 653 return L ? L->getLoopDepth() : 0; 654 } 655 656 // isLoopHeader - True if the block is a loop header node 657 bool isLoopHeader(BlockT *BB) const { 658 const LoopT *L = getLoopFor(BB); 659 return L && L->getHeader() == BB; 660 } 661 662 /// removeLoop - This removes the specified top-level loop from this loop info 663 /// object. The loop is not deleted, as it will presumably be inserted into 664 /// another loop. 665 LoopT *removeLoop(iterator I) { 666 assert(I != end() && "Cannot remove end iterator!"); 667 LoopT *L = *I; 668 assert(L->getParentLoop() == 0 && "Not a top-level loop!"); 669 TopLevelLoops.erase(TopLevelLoops.begin() + (I-begin())); 670 return L; 671 } 672 673 /// changeLoopFor - Change the top-level loop that contains BB to the 674 /// specified loop. This should be used by transformations that restructure 675 /// the loop hierarchy tree. 676 void changeLoopFor(BlockT *BB, LoopT *L) { 677 LoopT *&OldLoop = BBMap[BB]; 678 assert(OldLoop && "Block not in a loop yet!"); 679 OldLoop = L; 680 } 681 682 /// changeTopLevelLoop - Replace the specified loop in the top-level loops 683 /// list with the indicated loop. 684 void changeTopLevelLoop(LoopT *OldLoop, 685 LoopT *NewLoop) { 686 typename std::vector<LoopT *>::iterator I = 687 std::find(TopLevelLoops.begin(), TopLevelLoops.end(), OldLoop); 688 assert(I != TopLevelLoops.end() && "Old loop not at top level!"); 689 *I = NewLoop; 690 assert(NewLoop->ParentLoop == 0 && OldLoop->ParentLoop == 0 && 691 "Loops already embedded into a subloop!"); 692 } 693 694 /// addTopLevelLoop - This adds the specified loop to the collection of 695 /// top-level loops. 696 void addTopLevelLoop(LoopT *New) { 697 assert(New->getParentLoop() == 0 && "Loop already in subloop!"); 698 TopLevelLoops.push_back(New); 699 } 700 701 /// removeBlock - This method completely removes BB from all data structures, 702 /// including all of the Loop objects it is nested in and our mapping from 703 /// BasicBlocks to loops. 704 void removeBlock(BlockT *BB) { 705 typename std::map<BlockT *, LoopT *>::iterator I = BBMap.find(BB); 706 if (I != BBMap.end()) { 707 for (LoopT *L = I->second; L; L = L->getParentLoop()) 708 L->removeBlockFromLoop(BB); 709 710 BBMap.erase(I); 711 } 712 } 713 714 // Internals 715 716 static bool isNotAlreadyContainedIn(const LoopT *SubLoop, 717 const LoopT *ParentLoop) { 718 if (SubLoop == 0) return true; 719 if (SubLoop == ParentLoop) return false; 720 return isNotAlreadyContainedIn(SubLoop->getParentLoop(), ParentLoop); 721 } 722 723 void Calculate(DominatorTreeBase<BlockT> &DT) { 724 BlockT *RootNode = DT.getRootNode()->getBlock(); 725 726 for (df_iterator<BlockT*> NI = df_begin(RootNode), 727 NE = df_end(RootNode); NI != NE; ++NI) 728 if (LoopT *L = ConsiderForLoop(*NI, DT)) 729 TopLevelLoops.push_back(L); 730 } 731 732 LoopT *ConsiderForLoop(BlockT *BB, DominatorTreeBase<BlockT> &DT) { 733 if (BBMap.find(BB) != BBMap.end()) return 0;// Haven't processed this node? 734 735 std::vector<BlockT *> TodoStack; 736 737 // Scan the predecessors of BB, checking to see if BB dominates any of 738 // them. This identifies backedges which target this node... 739 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits; 740 for (typename InvBlockTraits::ChildIteratorType I = 741 InvBlockTraits::child_begin(BB), E = InvBlockTraits::child_end(BB); 742 I != E; ++I) 743 if (DT.dominates(BB, *I)) // If BB dominates its predecessor... 744 TodoStack.push_back(*I); 745 746 if (TodoStack.empty()) return 0; // No backedges to this block... 747 748 // Create a new loop to represent this basic block... 749 LoopT *L = new LoopT(BB); 750 BBMap[BB] = L; 751 752 BlockT *EntryBlock = BB->getParent()->begin(); 753 754 while (!TodoStack.empty()) { // Process all the nodes in the loop 755 BlockT *X = TodoStack.back(); 756 TodoStack.pop_back(); 757 758 if (!L->contains(X) && // As of yet unprocessed?? 759 DT.dominates(EntryBlock, X)) { // X is reachable from entry block? 760 // Check to see if this block already belongs to a loop. If this occurs 761 // then we have a case where a loop that is supposed to be a child of 762 // the current loop was processed before the current loop. When this 763 // occurs, this child loop gets added to a part of the current loop, 764 // making it a sibling to the current loop. We have to reparent this 765 // loop. 766 if (LoopT *SubLoop = 767 const_cast<LoopT *>(getLoopFor(X))) 768 if (SubLoop->getHeader() == X && isNotAlreadyContainedIn(SubLoop, L)){ 769 // Remove the subloop from its current parent... 770 assert(SubLoop->ParentLoop && SubLoop->ParentLoop != L); 771 LoopT *SLP = SubLoop->ParentLoop; // SubLoopParent 772 typename std::vector<LoopT *>::iterator I = 773 std::find(SLP->SubLoops.begin(), SLP->SubLoops.end(), SubLoop); 774 assert(I != SLP->SubLoops.end() &&"SubLoop not a child of parent?"); 775 SLP->SubLoops.erase(I); // Remove from parent... 776 777 // Add the subloop to THIS loop... 778 SubLoop->ParentLoop = L; 779 L->SubLoops.push_back(SubLoop); 780 } 781 782 // Normal case, add the block to our loop... 783 L->Blocks.push_back(X); 784 785 typedef GraphTraits<Inverse<BlockT*> > InvBlockTraits; 786 787 // Add all of the predecessors of X to the end of the work stack... 788 TodoStack.insert(TodoStack.end(), InvBlockTraits::child_begin(X), 789 InvBlockTraits::child_end(X)); 790 } 791 } 792 793 // If there are any loops nested within this loop, create them now! 794 for (typename std::vector<BlockT*>::iterator I = L->Blocks.begin(), 795 E = L->Blocks.end(); I != E; ++I) 796 if (LoopT *NewLoop = ConsiderForLoop(*I, DT)) { 797 L->SubLoops.push_back(NewLoop); 798 NewLoop->ParentLoop = L; 799 } 800 801 // Add the basic blocks that comprise this loop to the BBMap so that this 802 // loop can be found for them. 803 // 804 for (typename std::vector<BlockT*>::iterator I = L->Blocks.begin(), 805 E = L->Blocks.end(); I != E; ++I) 806 BBMap.insert(std::make_pair(*I, L)); 807 808 // Now that we have a list of all of the child loops of this loop, check to 809 // see if any of them should actually be nested inside of each other. We 810 // can accidentally pull loops our of their parents, so we must make sure to 811 // organize the loop nests correctly now. 812 { 813 std::map<BlockT *, LoopT *> ContainingLoops; 814 for (unsigned i = 0; i != L->SubLoops.size(); ++i) { 815 LoopT *Child = L->SubLoops[i]; 816 assert(Child->getParentLoop() == L && "Not proper child loop?"); 817 818 if (LoopT *ContainingLoop = ContainingLoops[Child->getHeader()]) { 819 // If there is already a loop which contains this loop, move this loop 820 // into the containing loop. 821 MoveSiblingLoopInto(Child, ContainingLoop); 822 --i; // The loop got removed from the SubLoops list. 823 } else { 824 // This is currently considered to be a top-level loop. Check to see 825 // if any of the contained blocks are loop headers for subloops we 826 // have already processed. 827 for (unsigned b = 0, e = Child->Blocks.size(); b != e; ++b) { 828 LoopT *&BlockLoop = ContainingLoops[Child->Blocks[b]]; 829 if (BlockLoop == 0) { // Child block not processed yet... 830 BlockLoop = Child; 831 } else if (BlockLoop != Child) { 832 LoopT *SubLoop = BlockLoop; 833 // Reparent all of the blocks which used to belong to BlockLoops 834 for (unsigned j = 0, e = SubLoop->Blocks.size(); j != e; ++j) 835 ContainingLoops[SubLoop->Blocks[j]] = Child; 836 837 // There is already a loop which contains this block, that means 838 // that we should reparent the loop which the block is currently 839 // considered to belong to to be a child of this loop. 840 MoveSiblingLoopInto(SubLoop, Child); 841 --i; // We just shrunk the SubLoops list. 842 } 843 } 844 } 845 } 846 } 847 848 return L; 849 } 850 851 /// MoveSiblingLoopInto - This method moves the NewChild loop to live inside 852 /// of the NewParent Loop, instead of being a sibling of it. 853 void MoveSiblingLoopInto(LoopT *NewChild, 854 LoopT *NewParent) { 855 LoopT *OldParent = NewChild->getParentLoop(); 856 assert(OldParent && OldParent == NewParent->getParentLoop() && 857 NewChild != NewParent && "Not sibling loops!"); 858 859 // Remove NewChild from being a child of OldParent 860 typename std::vector<LoopT *>::iterator I = 861 std::find(OldParent->SubLoops.begin(), OldParent->SubLoops.end(), 862 NewChild); 863 assert(I != OldParent->SubLoops.end() && "Parent fields incorrect??"); 864 OldParent->SubLoops.erase(I); // Remove from parent's subloops list 865 NewChild->ParentLoop = 0; 866 867 InsertLoopInto(NewChild, NewParent); 868 } 869 870 /// InsertLoopInto - This inserts loop L into the specified parent loop. If 871 /// the parent loop contains a loop which should contain L, the loop gets 872 /// inserted into L instead. 873 void InsertLoopInto(LoopT *L, LoopT *Parent) { 874 BlockT *LHeader = L->getHeader(); 875 assert(Parent->contains(LHeader) && 876 "This loop should not be inserted here!"); 877 878 // Check to see if it belongs in a child loop... 879 for (unsigned i = 0, e = static_cast<unsigned>(Parent->SubLoops.size()); 880 i != e; ++i) 881 if (Parent->SubLoops[i]->contains(LHeader)) { 882 InsertLoopInto(L, Parent->SubLoops[i]); 883 return; 884 } 885 886 // If not, insert it here! 887 Parent->SubLoops.push_back(L); 888 L->ParentLoop = Parent; 889 } 890 891 // Debugging 892 893 void print(raw_ostream &OS) const { 894 for (unsigned i = 0; i < TopLevelLoops.size(); ++i) 895 TopLevelLoops[i]->print(OS); 896 #if 0 897 for (std::map<BasicBlock*, LoopT*>::const_iterator I = BBMap.begin(), 898 E = BBMap.end(); I != E; ++I) 899 OS << "BB '" << I->first->getName() << "' level = " 900 << I->second->getLoopDepth() << "\n"; 901 #endif 902 } 903}; 904 905class LoopInfo : public FunctionPass { 906 LoopInfoBase<BasicBlock, Loop> LI; 907 friend class LoopBase<BasicBlock, Loop>; 908 909 void operator=(const LoopInfo &); // do not implement 910 LoopInfo(const LoopInfo &); // do not implement 911public: 912 static char ID; // Pass identification, replacement for typeid 913 914 LoopInfo() : FunctionPass(&ID) {} 915 916 LoopInfoBase<BasicBlock, Loop>& getBase() { return LI; } 917 918 /// iterator/begin/end - The interface to the top-level loops in the current 919 /// function. 920 /// 921 typedef LoopInfoBase<BasicBlock, Loop>::iterator iterator; 922 inline iterator begin() const { return LI.begin(); } 923 inline iterator end() const { return LI.end(); } 924 bool empty() const { return LI.empty(); } 925 926 /// getLoopFor - Return the inner most loop that BB lives in. If a basic 927 /// block is in no loop (for example the entry node), null is returned. 928 /// 929 inline Loop *getLoopFor(const BasicBlock *BB) const { 930 return LI.getLoopFor(BB); 931 } 932 933 /// operator[] - same as getLoopFor... 934 /// 935 inline const Loop *operator[](const BasicBlock *BB) const { 936 return LI.getLoopFor(BB); 937 } 938 939 /// getLoopDepth - Return the loop nesting level of the specified block. A 940 /// depth of 0 means the block is not inside any loop. 941 /// 942 inline unsigned getLoopDepth(const BasicBlock *BB) const { 943 return LI.getLoopDepth(BB); 944 } 945 946 // isLoopHeader - True if the block is a loop header node 947 inline bool isLoopHeader(BasicBlock *BB) const { 948 return LI.isLoopHeader(BB); 949 } 950 951 /// runOnFunction - Calculate the natural loop information. 952 /// 953 virtual bool runOnFunction(Function &F); 954 955 virtual void verifyAnalysis() const; 956 957 virtual void releaseMemory() { LI.releaseMemory(); } 958 959 virtual void print(raw_ostream &O, const Module* M = 0) const; 960 961 virtual void getAnalysisUsage(AnalysisUsage &AU) const; 962 963 /// removeLoop - This removes the specified top-level loop from this loop info 964 /// object. The loop is not deleted, as it will presumably be inserted into 965 /// another loop. 966 inline Loop *removeLoop(iterator I) { return LI.removeLoop(I); } 967 968 /// changeLoopFor - Change the top-level loop that contains BB to the 969 /// specified loop. This should be used by transformations that restructure 970 /// the loop hierarchy tree. 971 inline void changeLoopFor(BasicBlock *BB, Loop *L) { 972 LI.changeLoopFor(BB, L); 973 } 974 975 /// changeTopLevelLoop - Replace the specified loop in the top-level loops 976 /// list with the indicated loop. 977 inline void changeTopLevelLoop(Loop *OldLoop, Loop *NewLoop) { 978 LI.changeTopLevelLoop(OldLoop, NewLoop); 979 } 980 981 /// addTopLevelLoop - This adds the specified loop to the collection of 982 /// top-level loops. 983 inline void addTopLevelLoop(Loop *New) { 984 LI.addTopLevelLoop(New); 985 } 986 987 /// removeBlock - This method completely removes BB from all data structures, 988 /// including all of the Loop objects it is nested in and our mapping from 989 /// BasicBlocks to loops. 990 void removeBlock(BasicBlock *BB) { 991 LI.removeBlock(BB); 992 } 993}; 994 995 996// Allow clients to walk the list of nested loops... 997template <> struct GraphTraits<const Loop*> { 998 typedef const Loop NodeType; 999 typedef LoopInfo::iterator ChildIteratorType; 1000 1001 static NodeType *getEntryNode(const Loop *L) { return L; } 1002 static inline ChildIteratorType child_begin(NodeType *N) { 1003 return N->begin(); 1004 } 1005 static inline ChildIteratorType child_end(NodeType *N) { 1006 return N->end(); 1007 } 1008}; 1009 1010template <> struct GraphTraits<Loop*> { 1011 typedef Loop NodeType; 1012 typedef LoopInfo::iterator ChildIteratorType; 1013 1014 static NodeType *getEntryNode(Loop *L) { return L; } 1015 static inline ChildIteratorType child_begin(NodeType *N) { 1016 return N->begin(); 1017 } 1018 static inline ChildIteratorType child_end(NodeType *N) { 1019 return N->end(); 1020 } 1021}; 1022 1023template<class BlockT, class LoopT> 1024void 1025LoopBase<BlockT, LoopT>::addBasicBlockToLoop(BlockT *NewBB, 1026 LoopInfoBase<BlockT, LoopT> &LIB) { 1027 assert((Blocks.empty() || LIB[getHeader()] == this) && 1028 "Incorrect LI specified for this loop!"); 1029 assert(NewBB && "Cannot add a null basic block to the loop!"); 1030 assert(LIB[NewBB] == 0 && "BasicBlock already in the loop!"); 1031 1032 LoopT *L = static_cast<LoopT *>(this); 1033 1034 // Add the loop mapping to the LoopInfo object... 1035 LIB.BBMap[NewBB] = L; 1036 1037 // Add the basic block to this loop and all parent loops... 1038 while (L) { 1039 L->Blocks.push_back(NewBB); 1040 L = L->getParentLoop(); 1041 } 1042} 1043 1044} // End llvm namespace 1045 1046#endif 1047