lib/Analysis/LoopInfo.cpp

   1 //===- LoopInfo.cpp - Natural Loop Calculator -----------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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.  Note that the
  12 // loops identified may actually be several natural loops that share the same
  13 // header node... not just a single natural loop.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/Analysis/LoopInfo.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/Analysis/Dominators.h"
  21 #include "llvm/Assembly/Writer.h"
  22 #include "llvm/Support/CFG.h"
  23 #include "llvm/ADT/DepthFirstIterator.h"
  24 #include <algorithm>
  25 #include <iostream>
  26 using namespace llvm;
  27
  28 static RegisterAnalysis<LoopInfo>
  29 X("loops", "Natural Loop Construction", true);
  30
  31 //===----------------------------------------------------------------------===//
  32 // Loop implementation
  33 //
  34 bool Loop::contains(const BasicBlock *BB) const {
  35   return std::find(Blocks.begin(), Blocks.end(), BB) != Blocks.end();
  36 }
  37
  38 bool Loop::isLoopExit(const BasicBlock *BB) const {
  39   for (succ_const_iterator SI = succ_begin(BB), SE = succ_end(BB);
  40        SI != SE; ++SI) {
  41     if (!contains(*SI))
  42       return true;
  43   }
  44   return false;
  45 }
  46
  47 /// getNumBackEdges - Calculate the number of back edges to the loop header.
  48 ///
  49 unsigned Loop::getNumBackEdges() const {
  50   unsigned NumBackEdges = 0;
  51   BasicBlock *H = getHeader();
  52
  53   for (pred_iterator I = pred_begin(H), E = pred_end(H); I != E; ++I)
  54     if (contains(*I))
  55       ++NumBackEdges;
  56
  57   return NumBackEdges;
  58 }
  59
  60 /// isLoopInvariant - Return true if the specified value is loop invariant
  61 ///
  62 bool Loop::isLoopInvariant(Value *V) const {
  63   if (Instruction *I = dyn_cast<Instruction>(V))
  64     return !contains(I->getParent());
  65   return true;  // All non-instructions are loop invariant
  66 }
  67
  68 void Loop::print(std::ostream &OS, unsigned Depth) const {
  69   OS << std::string(Depth*2, ' ') << "Loop Containing: ";
  70
  71   for (unsigned i = 0; i < getBlocks().size(); ++i) {
  72     if (i) OS << ",";
  73     WriteAsOperand(OS, getBlocks()[i], false);
  74   }
  75   OS << "\n";
  76
  77   for (iterator I = begin(), E = end(); I != E; ++I)
  78     (*I)->print(OS, Depth+2);
  79 }
  80
  81 void Loop::dump() const {
  82   print(std::cerr);
  83 }
  84
  85
  86 //===----------------------------------------------------------------------===//
  87 // LoopInfo implementation
  88 //
  89 void LoopInfo::stub() {}
  90
  91 bool LoopInfo::runOnFunction(Function &) {
  92   releaseMemory();
  93   Calculate(getAnalysis<DominatorSet>());    // Update
  94   return false;
  95 }
  96
  97 void LoopInfo::releaseMemory() {
  98   for (std::vector<Loop*>::iterator I = TopLevelLoops.begin(),
  99          E = TopLevelLoops.end(); I != E; ++I)
 100     delete *I;   // Delete all of the loops...
 101
 102   BBMap.clear();                             // Reset internal state of analysis
 103   TopLevelLoops.clear();
 104 }
 105
 106
 107 void LoopInfo::Calculate(const DominatorSet &DS) {
 108   BasicBlock *RootNode = DS.getRoot();
 109
 110   for (df_iterator<BasicBlock*> NI = df_begin(RootNode),
 111          NE = df_end(RootNode); NI != NE; ++NI)
 112     if (Loop *L = ConsiderForLoop(*NI, DS))
 113       TopLevelLoops.push_back(L);
 114 }
 115
 116 void LoopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
 117   AU.setPreservesAll();
 118   AU.addRequired<DominatorSet>();
 119 }
 120
 121 void LoopInfo::print(std::ostream &OS, const Module* ) const {
 122   for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
 123     TopLevelLoops[i]->print(OS);
 124 #if 0
 125   for (std::map<BasicBlock*, Loop*>::const_iterator I = BBMap.begin(),
 126          E = BBMap.end(); I != E; ++I)
 127     OS << "BB '" << I->first->getName() << "' level = "
 128        << I->second->getLoopDepth() << "\n";
 129 #endif
 130 }
 131
 132 static bool isNotAlreadyContainedIn(Loop *SubLoop, Loop *ParentLoop) {
 133   if (SubLoop == 0) return true;
 134   if (SubLoop == ParentLoop) return false;
 135   return isNotAlreadyContainedIn(SubLoop->getParentLoop(), ParentLoop);
 136 }
 137
 138 Loop *LoopInfo::ConsiderForLoop(BasicBlock *BB, const DominatorSet &DS) {
 139   if (BBMap.find(BB) != BBMap.end()) return 0;   // Haven't processed this node?
 140
 141   std::vector<BasicBlock *> TodoStack;
 142
 143   // Scan the predecessors of BB, checking to see if BB dominates any of
 144   // them.  This identifies backedges which target this node...
 145   for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I)
 146     if (DS.dominates(BB, *I))   // If BB dominates it's predecessor...
 147       TodoStack.push_back(*I);
 148
 149   if (TodoStack.empty()) return 0;  // No backedges to this block...
 150
 151   // Create a new loop to represent this basic block...
 152   Loop *L = new Loop(BB);
 153   BBMap[BB] = L;
 154
 155   BasicBlock *EntryBlock = &BB->getParent()->getEntryBlock();
 156
 157   while (!TodoStack.empty()) {  // Process all the nodes in the loop
 158     BasicBlock *X = TodoStack.back();
 159     TodoStack.pop_back();
 160
 161     if (!L->contains(X) &&         // As of yet unprocessed??
 162         DS.dominates(EntryBlock, X)) {   // X is reachable from entry block?
 163       // Check to see if this block already belongs to a loop.  If this occurs
 164       // then we have a case where a loop that is supposed to be a child of the
 165       // current loop was processed before the current loop.  When this occurs,
 166       // this child loop gets added to a part of the current loop, making it a
 167       // sibling to the current loop.  We have to reparent this loop.
 168       if (Loop *SubLoop = const_cast<Loop*>(getLoopFor(X)))
 169         if (SubLoop->getHeader() == X && isNotAlreadyContainedIn(SubLoop, L)) {
 170           // Remove the subloop from it's current parent...
 171           assert(SubLoop->ParentLoop && SubLoop->ParentLoop != L);
 172           Loop *SLP = SubLoop->ParentLoop;  // SubLoopParent
 173           std::vector<Loop*>::iterator I =
 174             std::find(SLP->SubLoops.begin(), SLP->SubLoops.end(), SubLoop);
 175           assert(I != SLP->SubLoops.end() && "SubLoop not a child of parent?");
 176           SLP->SubLoops.erase(I);   // Remove from parent...
 177
 178           // Add the subloop to THIS loop...
 179           SubLoop->ParentLoop = L;
 180           L->SubLoops.push_back(SubLoop);
 181         }
 182
 183       // Normal case, add the block to our loop...
 184       L->Blocks.push_back(X);
 185
 186       // Add all of the predecessors of X to the end of the work stack...
 187       TodoStack.insert(TodoStack.end(), pred_begin(X), pred_end(X));
 188     }
 189   }
 190
 191   // If there are any loops nested within this loop, create them now!
 192   for (std::vector<BasicBlock*>::iterator I = L->Blocks.begin(),
 193          E = L->Blocks.end(); I != E; ++I)
 194     if (Loop *NewLoop = ConsiderForLoop(*I, DS)) {
 195       L->SubLoops.push_back(NewLoop);
 196       NewLoop->ParentLoop = L;
 197     }
 198
 199   // Add the basic blocks that comprise this loop to the BBMap so that this
 200   // loop can be found for them.
 201   //
 202   for (std::vector<BasicBlock*>::iterator I = L->Blocks.begin(),
 203          E = L->Blocks.end(); I != E; ++I) {
 204     std::map<BasicBlock*, Loop*>::iterator BBMI = BBMap.lower_bound(*I);
 205     if (BBMI == BBMap.end() || BBMI->first != *I)  // Not in map yet...
 206       BBMap.insert(BBMI, std::make_pair(*I, L));   // Must be at this level
 207   }
 208
 209   // Now that we have a list of all of the child loops of this loop, check to
 210   // see if any of them should actually be nested inside of each other.  We can
 211   // accidentally pull loops our of their parents, so we must make sure to
 212   // organize the loop nests correctly now.
 213   {
 214     std::map<BasicBlock*, Loop*> ContainingLoops;
 215     for (unsigned i = 0; i != L->SubLoops.size(); ++i) {
 216       Loop *Child = L->SubLoops[i];
 217       assert(Child->getParentLoop() == L && "Not proper child loop?");
 218
 219       if (Loop *ContainingLoop = ContainingLoops[Child->getHeader()]) {
 220         // If there is already a loop which contains this loop, move this loop
 221         // into the containing loop.
 222         MoveSiblingLoopInto(Child, ContainingLoop);
 223         --i;  // The loop got removed from the SubLoops list.
 224       } else {
 225         // This is currently considered to be a top-level loop.  Check to see if
 226         // any of the contained blocks are loop headers for subloops we have
 227         // already processed.
 228         for (unsigned b = 0, e = Child->Blocks.size(); b != e; ++b) {
 229           Loop *&BlockLoop = ContainingLoops[Child->Blocks[b]];
 230           if (BlockLoop == 0) {   // Child block not processed yet...
 231             BlockLoop = Child;
 232           } else if (BlockLoop != Child) {
 233             Loop *SubLoop = BlockLoop;
 234             // Reparent all of the blocks which used to belong to BlockLoops
 235             for (unsigned j = 0, e = SubLoop->Blocks.size(); j != e; ++j)
 236               ContainingLoops[SubLoop->Blocks[j]] = Child;
 237
 238             // There is already a loop which contains this block, that means
 239             // that we should reparent the loop which the block is currently
 240             // considered to belong to to be a child of this loop.
 241             MoveSiblingLoopInto(SubLoop, Child);
 242             --i;  // We just shrunk the SubLoops list.
 243           }
 244         }
 245       }
 246     }
 247   }
 248
 249   return L;
 250 }
 251
 252 /// MoveSiblingLoopInto - This method moves the NewChild loop to live inside of
 253 /// the NewParent Loop, instead of being a sibling of it.
 254 void LoopInfo::MoveSiblingLoopInto(Loop *NewChild, Loop *NewParent) {
 255   Loop *OldParent = NewChild->getParentLoop();
 256   assert(OldParent && OldParent == NewParent->getParentLoop() &&
 257          NewChild != NewParent && "Not sibling loops!");
 258
 259   // Remove NewChild from being a child of OldParent
 260   std::vector<Loop*>::iterator I =
 261     std::find(OldParent->SubLoops.begin(), OldParent->SubLoops.end(), NewChild);
 262   assert(I != OldParent->SubLoops.end() && "Parent fields incorrect??");
 263   OldParent->SubLoops.erase(I);   // Remove from parent's subloops list
 264   NewChild->ParentLoop = 0;
 265
 266   InsertLoopInto(NewChild, NewParent);
 267 }
 268
 269 /// InsertLoopInto - This inserts loop L into the specified parent loop.  If the
 270 /// parent loop contains a loop which should contain L, the loop gets inserted
 271 /// into L instead.
 272 void LoopInfo::InsertLoopInto(Loop *L, Loop *Parent) {
 273   BasicBlock *LHeader = L->getHeader();
 274   assert(Parent->contains(LHeader) && "This loop should not be inserted here!");
 275
 276   // Check to see if it belongs in a child loop...
 277   for (unsigned i = 0, e = Parent->SubLoops.size(); i != e; ++i)
 278     if (Parent->SubLoops[i]->contains(LHeader)) {
 279       InsertLoopInto(L, Parent->SubLoops[i]);
 280       return;
 281     }
 282
 283   // If not, insert it here!
 284   Parent->SubLoops.push_back(L);
 285   L->ParentLoop = Parent;
 286 }
 287
 288 /// changeLoopFor - Change the top-level loop that contains BB to the
 289 /// specified loop.  This should be used by transformations that restructure
 290 /// the loop hierarchy tree.
 291 void LoopInfo::changeLoopFor(BasicBlock *BB, Loop *L) {
 292   Loop *&OldLoop = BBMap[BB];
 293   assert(OldLoop && "Block not in a loop yet!");
 294   OldLoop = L;
 295 }
 296
 297 /// changeTopLevelLoop - Replace the specified loop in the top-level loops
 298 /// list with the indicated loop.
 299 void LoopInfo::changeTopLevelLoop(Loop *OldLoop, Loop *NewLoop) {
 300   std::vector<Loop*>::iterator I = std::find(TopLevelLoops.begin(),
 301                                              TopLevelLoops.end(), OldLoop);
 302   assert(I != TopLevelLoops.end() && "Old loop not at top level!");
 303   *I = NewLoop;
 304   assert(NewLoop->ParentLoop == 0 && OldLoop->ParentLoop == 0 &&
 305          "Loops already embedded into a subloop!");
 306 }
 307
 308 /// removeLoop - This removes the specified top-level loop from this loop info
 309 /// object.  The loop is not deleted, as it will presumably be inserted into
 310 /// another loop.
 311 Loop *LoopInfo::removeLoop(iterator I) {
 312   assert(I != end() && "Cannot remove end iterator!");
 313   Loop *L = *I;
 314   assert(L->getParentLoop() == 0 && "Not a top-level loop!");
 315   TopLevelLoops.erase(TopLevelLoops.begin() + (I-begin()));
 316   return L;
 317 }
 318
 319 /// removeBlock - This method completely removes BB from all data structures,
 320 /// including all of the Loop objects it is nested in and our mapping from
 321 /// BasicBlocks to loops.
 322 void LoopInfo::removeBlock(BasicBlock *BB) {
 323   std::map<BasicBlock *, Loop*>::iterator I = BBMap.find(BB);
 324   if (I != BBMap.end()) {
 325     for (Loop *L = I->second; L; L = L->getParentLoop())
 326       L->removeBlockFromLoop(BB);
 327
 328     BBMap.erase(I);
 329   }
 330 }
 331
 332
 333 //===----------------------------------------------------------------------===//
 334 // APIs for simple analysis of the loop.
 335 //
 336
 337 /// getExitBlocks - Return all of the successor blocks of this loop.  These
 338 /// are the blocks _outside of the current loop_ which are branched to.
 339 ///
 340 void Loop::getExitBlocks(std::vector<BasicBlock*> &ExitBlocks) const {
 341   for (std::vector<BasicBlock*>::const_iterator BI = Blocks.begin(),
 342          BE = Blocks.end(); BI != BE; ++BI)
 343     for (succ_iterator I = succ_begin(*BI), E = succ_end(*BI); I != E; ++I)
 344       if (!contains(*I))               // Not in current loop?
 345         ExitBlocks.push_back(*I);          // It must be an exit block...
 346 }
 347
 348
 349 /// getLoopPreheader - If there is a preheader for this loop, return it.  A
 350 /// loop has a preheader if there is only one edge to the header of the loop
 351 /// from outside of the loop.  If this is the case, the block branching to the
 352 /// header of the loop is the preheader node.
 353 ///
 354 /// This method returns null if there is no preheader for the loop.
 355 ///
 356 BasicBlock *Loop::getLoopPreheader() const {
 357   // Keep track of nodes outside the loop branching to the header...
 358   BasicBlock *Out = 0;
 359
 360   // Loop over the predecessors of the header node...
 361   BasicBlock *Header = getHeader();
 362   for (pred_iterator PI = pred_begin(Header), PE = pred_end(Header);
 363        PI != PE; ++PI)
 364     if (!contains(*PI)) {     // If the block is not in the loop...
 365       if (Out && Out != *PI)
 366         return 0;             // Multiple predecessors outside the loop
 367       Out = *PI;
 368     }
 369
 370   // Make sure there is only one exit out of the preheader...
 371   succ_iterator SI = succ_begin(Out);
 372   ++SI;
 373   if (SI != succ_end(Out))
 374     return 0;  // Multiple exits from the block, must not be a preheader.
 375
 376
 377   // If there is exactly one preheader, return it.  If there was zero, then Out
 378   // is still null.
 379   return Out;
 380 }
 381
 382 /// getCanonicalInductionVariable - Check to see if the loop has a canonical
 383 /// induction variable: an integer recurrence that starts at 0 and increments by
 384 /// one each time through the loop.  If so, return the phi node that corresponds
 385 /// to it.
 386 ///
 387 PHINode *Loop::getCanonicalInductionVariable() const {
 388   BasicBlock *H = getHeader();
 389
 390   BasicBlock *Incoming = 0, *Backedge = 0;
 391   pred_iterator PI = pred_begin(H);
 392   assert(PI != pred_end(H) && "Loop must have at least one backedge!");
 393   Backedge = *PI++;
 394   if (PI == pred_end(H)) return 0;  // dead loop
 395   Incoming = *PI++;
 396   if (PI != pred_end(H)) return 0;  // multiple backedges?
 397
 398   if (contains(Incoming)) {
 399     if (contains(Backedge))
 400       return 0;
 401     std::swap(Incoming, Backedge);
 402   } else if (!contains(Backedge))
 403     return 0;
 404
 405   // Loop over all of the PHI nodes, looking for a canonical indvar.
 406   for (BasicBlock::iterator I = H->begin(); isa<PHINode>(I); ++I) {
 407     PHINode *PN = cast<PHINode>(I);
 408     if (Instruction *Inc =
 409         dyn_cast<Instruction>(PN->getIncomingValueForBlock(Backedge)))
 410       if (Inc->getOpcode() == Instruction::Add && Inc->getOperand(0) == PN)
 411         if (ConstantInt *CI = dyn_cast<ConstantInt>(Inc->getOperand(1)))
 412           if (CI->equalsInt(1))
 413             return PN;
 414   }
 415   return 0;
 416 }
 417
 418 /// getCanonicalInductionVariableIncrement - Return the LLVM value that holds
 419 /// the canonical induction variable value for the "next" iteration of the loop.
 420 /// This always succeeds if getCanonicalInductionVariable succeeds.
 421 ///
 422 Instruction *Loop::getCanonicalInductionVariableIncrement() const {
 423   if (PHINode *PN = getCanonicalInductionVariable()) {
 424     bool P1InLoop = contains(PN->getIncomingBlock(1));
 425     return cast<Instruction>(PN->getIncomingValue(P1InLoop));
 426   }
 427   return 0;
 428 }
 429
 430 /// getTripCount - Return a loop-invariant LLVM value indicating the number of
 431 /// times the loop will be executed.  Note that this means that the backedge of
 432 /// the loop executes N-1 times.  If the trip-count cannot be determined, this
 433 /// returns null.
 434 ///
 435 Value *Loop::getTripCount() const {
 436   // Canonical loops will end with a 'setne I, V', where I is the incremented
 437   // canonical induction variable and V is the trip count of the loop.
 438   Instruction *Inc = getCanonicalInductionVariableIncrement();
 439   if (Inc == 0) return 0;
 440   PHINode *IV = cast<PHINode>(Inc->getOperand(0));
 441
 442   BasicBlock *BackedgeBlock =
 443     IV->getIncomingBlock(contains(IV->getIncomingBlock(1)));
 444
 445   if (BranchInst *BI = dyn_cast<BranchInst>(BackedgeBlock->getTerminator()))
 446     if (BI->isConditional())
 447       if (SetCondInst *SCI = dyn_cast<SetCondInst>(BI->getCondition()))
 448         if (SCI->getOperand(0) == Inc)
 449           if (BI->getSuccessor(0) == getHeader()) {
 450             if (SCI->getOpcode() == Instruction::SetNE)
 451               return SCI->getOperand(1);
 452           } else if (SCI->getOpcode() == Instruction::SetEQ) {
 453             return SCI->getOperand(1);
 454           }
 455
 456   return 0;
 457 }
 458
 459
 460 //===-------------------------------------------------------------------===//
 461 // APIs for updating loop information after changing the CFG
 462 //
 463
 464 /// addBasicBlockToLoop - This function is used by other analyses to update loop
 465 /// information.  NewBB is set to be a new member of the current loop.  Because
 466 /// of this, it is added as a member of all parent loops, and is added to the
 467 /// specified LoopInfo object as being in the current basic block.  It is not
 468 /// valid to replace the loop header with this method.
 469 ///
 470 void Loop::addBasicBlockToLoop(BasicBlock *NewBB, LoopInfo &LI) {
 471   assert((Blocks.empty() || LI[getHeader()] == this) &&
 472          "Incorrect LI specified for this loop!");
 473   assert(NewBB && "Cannot add a null basic block to the loop!");
 474   assert(LI[NewBB] == 0 && "BasicBlock already in the loop!");
 475
 476   // Add the loop mapping to the LoopInfo object...
 477   LI.BBMap[NewBB] = this;
 478
 479   // Add the basic block to this loop and all parent loops...
 480   Loop *L = this;
 481   while (L) {
 482     L->Blocks.push_back(NewBB);
 483     L = L->getParentLoop();
 484   }
 485 }
 486
 487 /// replaceChildLoopWith - This is used when splitting loops up.  It replaces
 488 /// the OldChild entry in our children list with NewChild, and updates the
 489 /// parent pointers of the two loops as appropriate.
 490 void Loop::replaceChildLoopWith(Loop *OldChild, Loop *NewChild) {
 491   assert(OldChild->ParentLoop == this && "This loop is already broken!");
 492   assert(NewChild->ParentLoop == 0 && "NewChild already has a parent!");
 493   std::vector<Loop*>::iterator I = std::find(SubLoops.begin(), SubLoops.end(),
 494                                              OldChild);
 495   assert(I != SubLoops.end() && "OldChild not in loop!");
 496   *I = NewChild;
 497   OldChild->ParentLoop = 0;
 498   NewChild->ParentLoop = this;
 499 }
 500
 501 /// addChildLoop - Add the specified loop to be a child of this loop.
 502 ///
 503 void Loop::addChildLoop(Loop *NewChild) {
 504   assert(NewChild->ParentLoop == 0 && "NewChild already has a parent!");
 505   NewChild->ParentLoop = this;
 506   SubLoops.push_back(NewChild);
 507 }
 508
 509 template<typename T>
 510 static void RemoveFromVector(std::vector<T*> &V, T *N) {
 511   typename std::vector<T*>::iterator I = std::find(V.begin(), V.end(), N);
 512   assert(I != V.end() && "N is not in this list!");
 513   V.erase(I);
 514 }
 515
 516 /// removeChildLoop - This removes the specified child from being a subloop of
 517 /// this loop.  The loop is not deleted, as it will presumably be inserted
 518 /// into another loop.
 519 Loop *Loop::removeChildLoop(iterator I) {
 520   assert(I != SubLoops.end() && "Cannot remove end iterator!");
 521   Loop *Child = *I;
 522   assert(Child->ParentLoop == this && "Child is not a child of this loop!");
 523   SubLoops.erase(SubLoops.begin()+(I-begin()));
 524   Child->ParentLoop = 0;
 525   return Child;
 526 }
 527
 528
 529 /// removeBlockFromLoop - This removes the specified basic block from the
 530 /// current loop, updating the Blocks and ExitBlocks lists as appropriate.  This
 531 /// does not update the mapping in the LoopInfo class.
 532 void Loop::removeBlockFromLoop(BasicBlock *BB) {
 533   RemoveFromVector(Blocks, BB);
 534 }