lib/Transforms/Utils/LoopSimplify.cpp

   1 //===- LoopSimplify.cpp - Loop Canonicalization Pass ----------------------===//
   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 pass performs several transformations to transform natural loops into a
  11 // simpler form, which makes subsequent analyses and transformations simpler and
  12 // more effective.
  13 //
  14 // Loop pre-header insertion guarantees that there is a single, non-critical
  15 // entry edge from outside of the loop to the loop header.  This simplifies a
  16 // number of analyses and transformations, such as LICM.
  17 //
  18 // Loop exit-block insertion guarantees that all exit blocks from the loop
  19 // (blocks which are outside of the loop that have predecessors inside of the
  20 // loop) only have predecessors from inside of the loop (and are thus dominated
  21 // by the loop header).  This simplifies transformations such as store-sinking
  22 // that are built into LICM.
  23 //
  24 // This pass also guarantees that loops will have exactly one backedge.
  25 //
  26 // Indirectbr instructions introduce several complications. If the loop
  27 // contains or is entered by an indirectbr instruction, it may not be possible
  28 // to transform the loop and make these guarantees. Client code should check
  29 // that these conditions are true before relying on them.
  30 //
  31 // Note that the simplifycfg pass will clean up blocks which are split out but
  32 // end up being unnecessary, so usage of this pass should not pessimize
  33 // generated code.
  34 //
  35 // This pass obviously modifies the CFG, but updates loop information and
  36 // dominator information.
  37 //
  38 //===----------------------------------------------------------------------===//
  39
  40 #define DEBUG_TYPE "loopsimplify"
  41 #include "llvm/Transforms/Scalar.h"
  42 #include "llvm/Constants.h"
  43 #include "llvm/Instructions.h"
  44 #include "llvm/IntrinsicInst.h"
  45 #include "llvm/Function.h"
  46 #include "llvm/LLVMContext.h"
  47 #include "llvm/Type.h"
  48 #include "llvm/Analysis/AliasAnalysis.h"
  49 #include "llvm/Analysis/Dominators.h"
  50 #include "llvm/Analysis/LoopPass.h"
  51 #include "llvm/Analysis/ScalarEvolution.h"
  52 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  53 #include "llvm/Transforms/Utils/Local.h"
  54 #include "llvm/Support/CFG.h"
  55 #include "llvm/Support/Debug.h"
  56 #include "llvm/ADT/SetOperations.h"
  57 #include "llvm/ADT/SetVector.h"
  58 #include "llvm/ADT/Statistic.h"
  59 #include "llvm/ADT/DepthFirstIterator.h"
  60 using namespace llvm;
  61
  62 STATISTIC(NumInserted, "Number of pre-header or exit blocks inserted");
  63 STATISTIC(NumNested  , "Number of nested loops split out");
  64
  65 namespace {
  66   struct LoopSimplify : public LoopPass {
  67     static char ID; // Pass identification, replacement for typeid
  68     LoopSimplify() : LoopPass(&ID) {}
  69
  70     // AA - If we have an alias analysis object to update, this is it, otherwise
  71     // this is null.
  72     AliasAnalysis *AA;
  73     LoopInfo *LI;
  74     DominatorTree *DT;
  75     Loop *L;
  76     virtual bool runOnLoop(Loop *L, LPPassManager &LPM);
  77
  78     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  79       // We need loop information to identify the loops...
  80       AU.addRequiredTransitive<DominatorTree>();
  81       AU.addPreserved<DominatorTree>();
  82
  83       // Request DominanceFrontier now, even though LoopSimplify does
  84       // not use it. This allows Pass Manager to schedule Dominance
  85       // Frontier early enough such that one LPPassManager can handle
  86       // multiple loop transformation passes.
  87       AU.addRequired<DominanceFrontier>();
  88       AU.addPreserved<DominanceFrontier>();
  89
  90       AU.addRequiredTransitive<LoopInfo>();
  91       AU.addPreserved<LoopInfo>();
  92
  93       AU.addPreserved<AliasAnalysis>();
  94       AU.addPreserved<ScalarEvolution>();
  95       AU.addPreservedID(BreakCriticalEdgesID);  // No critical edges added.
  96     }
  97
  98     /// verifyAnalysis() - Verify LoopSimplifyForm's guarantees.
  99     void verifyAnalysis() const;
 100
 101   private:
 102     bool ProcessLoop(Loop *L, LPPassManager &LPM);
 103     BasicBlock *RewriteLoopExitBlock(Loop *L, BasicBlock *Exit);
 104     BasicBlock *InsertPreheaderForLoop(Loop *L);
 105     Loop *SeparateNestedLoop(Loop *L, LPPassManager &LPM);
 106     BasicBlock *InsertUniqueBackedgeBlock(Loop *L, BasicBlock *Preheader);
 107     void PlaceSplitBlockCarefully(BasicBlock *NewBB,
 108                                   SmallVectorImpl<BasicBlock*> &SplitPreds,
 109                                   Loop *L);
 110   };
 111 }
 112
 113 char LoopSimplify::ID = 0;
 114 static RegisterPass<LoopSimplify>
 115 X("loopsimplify", "Canonicalize natural loops", true);
 116
 117 // Publically exposed interface to pass...
 118 const PassInfo *const llvm::LoopSimplifyID = &X;
 119 Pass *llvm::createLoopSimplifyPass() { return new LoopSimplify(); }
 120
 121 /// runOnLoop - Run down all loops in the CFG (recursively, but we could do
 122 /// it in any convenient order) inserting preheaders...
 123 ///
 124 bool LoopSimplify::runOnLoop(Loop *l, LPPassManager &LPM) {
 125   L = l;
 126   bool Changed = false;
 127   LI = &getAnalysis<LoopInfo>();
 128   AA = getAnalysisIfAvailable<AliasAnalysis>();
 129   DT = &getAnalysis<DominatorTree>();
 130
 131   Changed |= ProcessLoop(L, LPM);
 132
 133   return Changed;
 134 }
 135
 136 /// ProcessLoop - Walk the loop structure in depth first order, ensuring that
 137 /// all loops have preheaders.
 138 ///
 139 bool LoopSimplify::ProcessLoop(Loop *L, LPPassManager &LPM) {
 140   bool Changed = false;
 141 ReprocessLoop:
 142
 143   // Check to see that no blocks (other than the header) in this loop have
 144   // predecessors that are not in the loop.  This is not valid for natural
 145   // loops, but can occur if the blocks are unreachable.  Since they are
 146   // unreachable we can just shamelessly delete those CFG edges!
 147   for (Loop::block_iterator BB = L->block_begin(), E = L->block_end();
 148        BB != E; ++BB) {
 149     if (*BB == L->getHeader()) continue;
 150
 151     SmallPtrSet<BasicBlock*, 4> BadPreds;
 152     for (pred_iterator PI = pred_begin(*BB),
 153          PE = pred_end(*BB); PI != PE; ++PI) {
 154       BasicBlock *P = *PI;
 155       if (!L->contains(P))
 156         BadPreds.insert(P);
 157     }
 158
 159     // Delete each unique out-of-loop (and thus dead) predecessor.
 160     for (SmallPtrSet<BasicBlock*, 4>::iterator I = BadPreds.begin(),
 161          E = BadPreds.end(); I != E; ++I) {
 162
 163       DEBUG(dbgs() << "LoopSimplify: Deleting edge from dead predecessor ";
 164             WriteAsOperand(dbgs(), *I, false);
 165             dbgs() << "\n");
 166
 167       // Inform each successor of each dead pred.
 168       for (succ_iterator SI = succ_begin(*I), SE = succ_end(*I); SI != SE; ++SI)
 169         (*SI)->removePredecessor(*I);
 170       // Zap the dead pred's terminator and replace it with unreachable.
 171       TerminatorInst *TI = (*I)->getTerminator();
 172        TI->replaceAllUsesWith(UndefValue::get(TI->getType()));
 173       (*I)->getTerminator()->eraseFromParent();
 174       new UnreachableInst((*I)->getContext(), *I);
 175       Changed = true;
 176     }
 177   }
 178
 179   // If there are exiting blocks with branches on undef, resolve the undef in
 180   // the direction which will exit the loop. This will help simplify loop
 181   // trip count computations.
 182   SmallVector<BasicBlock*, 8> ExitingBlocks;
 183   L->getExitingBlocks(ExitingBlocks);
 184   for (SmallVectorImpl<BasicBlock *>::iterator I = ExitingBlocks.begin(),
 185        E = ExitingBlocks.end(); I != E; ++I)
 186     if (BranchInst *BI = dyn_cast<BranchInst>((*I)->getTerminator()))
 187       if (BI->isConditional()) {
 188         if (UndefValue *Cond = dyn_cast<UndefValue>(BI->getCondition())) {
 189
 190           DEBUG(dbgs() << "LoopSimplify: Resolving \"br i1 undef\" to exit in ";
 191                 WriteAsOperand(dbgs(), *I, false);
 192                 dbgs() << "\n");
 193
 194           BI->setCondition(ConstantInt::get(Cond->getType(),
 195                                             !L->contains(BI->getSuccessor(0))));
 196           Changed = true;
 197         }
 198       }
 199
 200   // Does the loop already have a preheader?  If so, don't insert one.
 201   BasicBlock *Preheader = L->getLoopPreheader();
 202   if (!Preheader) {
 203     Preheader = InsertPreheaderForLoop(L);
 204     if (Preheader) {
 205       ++NumInserted;
 206       Changed = true;
 207     }
 208   }
 209
 210   // Next, check to make sure that all exit nodes of the loop only have
 211   // predecessors that are inside of the loop.  This check guarantees that the
 212   // loop preheader/header will dominate the exit blocks.  If the exit block has
 213   // predecessors from outside of the loop, split the edge now.
 214   SmallVector<BasicBlock*, 8> ExitBlocks;
 215   L->getExitBlocks(ExitBlocks);
 216
 217   SmallSetVector<BasicBlock *, 8> ExitBlockSet(ExitBlocks.begin(),
 218                                                ExitBlocks.end());
 219   for (SmallSetVector<BasicBlock *, 8>::iterator I = ExitBlockSet.begin(),
 220          E = ExitBlockSet.end(); I != E; ++I) {
 221     BasicBlock *ExitBlock = *I;
 222     for (pred_iterator PI = pred_begin(ExitBlock), PE = pred_end(ExitBlock);
 223          PI != PE; ++PI)
 224       // Must be exactly this loop: no subloops, parent loops, or non-loop preds
 225       // allowed.
 226       if (!L->contains(*PI)) {
 227         if (RewriteLoopExitBlock(L, ExitBlock)) {
 228           ++NumInserted;
 229           Changed = true;
 230         }
 231         break;
 232       }
 233   }
 234
 235   // If the header has more than two predecessors at this point (from the
 236   // preheader and from multiple backedges), we must adjust the loop.
 237   BasicBlock *LoopLatch = L->getLoopLatch();
 238   if (!LoopLatch) {
 239     // If this is really a nested loop, rip it out into a child loop.  Don't do
 240     // this for loops with a giant number of backedges, just factor them into a
 241     // common backedge instead.
 242     if (L->getNumBackEdges() < 8) {
 243       if (SeparateNestedLoop(L, LPM)) {
 244         ++NumNested;
 245         // This is a big restructuring change, reprocess the whole loop.
 246         Changed = true;
 247         // GCC doesn't tail recursion eliminate this.
 248         goto ReprocessLoop;
 249       }
 250     }
 251
 252     // If we either couldn't, or didn't want to, identify nesting of the loops,
 253     // insert a new block that all backedges target, then make it jump to the
 254     // loop header.
 255     LoopLatch = InsertUniqueBackedgeBlock(L, Preheader);
 256     if (LoopLatch) {
 257       ++NumInserted;
 258       Changed = true;
 259     }
 260   }
 261
 262   // Scan over the PHI nodes in the loop header.  Since they now have only two
 263   // incoming values (the loop is canonicalized), we may have simplified the PHI
 264   // down to 'X = phi [X, Y]', which should be replaced with 'Y'.
 265   PHINode *PN;
 266   for (BasicBlock::iterator I = L->getHeader()->begin();
 267        (PN = dyn_cast<PHINode>(I++)); )
 268     if (Value *V = PN->hasConstantValue(DT)) {
 269       if (AA) AA->deleteValue(PN);
 270       PN->replaceAllUsesWith(V);
 271       PN->eraseFromParent();
 272     }
 273
 274   // If this loop has multiple exits and the exits all go to the same
 275   // block, attempt to merge the exits. This helps several passes, such
 276   // as LoopRotation, which do not support loops with multiple exits.
 277   // SimplifyCFG also does this (and this code uses the same utility
 278   // function), however this code is loop-aware, where SimplifyCFG is
 279   // not. That gives it the advantage of being able to hoist
 280   // loop-invariant instructions out of the way to open up more
 281   // opportunities, and the disadvantage of having the responsibility
 282   // to preserve dominator information.
 283   bool UniqueExit = true;
 284   if (!ExitBlocks.empty())
 285     for (unsigned i = 1, e = ExitBlocks.size(); i != e; ++i)
 286       if (ExitBlocks[i] != ExitBlocks[0]) {
 287         UniqueExit = false;
 288         break;
 289       }
 290   if (UniqueExit) {
 291     for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
 292       BasicBlock *ExitingBlock = ExitingBlocks[i];
 293       if (!ExitingBlock->getSinglePredecessor()) continue;
 294       BranchInst *BI = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
 295       if (!BI || !BI->isConditional()) continue;
 296       CmpInst *CI = dyn_cast<CmpInst>(BI->getCondition());
 297       if (!CI || CI->getParent() != ExitingBlock) continue;
 298
 299       // Attempt to hoist out all instructions except for the
 300       // comparison and the branch.
 301       bool AllInvariant = true;
 302       for (BasicBlock::iterator I = ExitingBlock->begin(); &*I != BI; ) {
 303         Instruction *Inst = I++;
 304         // Skip debug info intrinsics.
 305         if (isa<DbgInfoIntrinsic>(Inst))
 306           continue;
 307         if (Inst == CI)
 308           continue;
 309         if (!L->makeLoopInvariant(Inst, Changed,
 310                                   Preheader ? Preheader->getTerminator() : 0)) {
 311           AllInvariant = false;
 312           break;
 313         }
 314       }
 315       if (!AllInvariant) continue;
 316
 317       // The block has now been cleared of all instructions except for
 318       // a comparison and a conditional branch. SimplifyCFG may be able
 319       // to fold it now.
 320       if (!FoldBranchToCommonDest(BI)) continue;
 321
 322       // Success. The block is now dead, so remove it from the loop,
 323       // update the dominator tree and dominance frontier, and delete it.
 324
 325       DEBUG(dbgs() << "LoopSimplify: Eliminating exiting block ";
 326             WriteAsOperand(dbgs(), ExitingBlock, false);
 327             dbgs() << "\n");
 328
 329       assert(pred_begin(ExitingBlock) == pred_end(ExitingBlock));
 330       Changed = true;
 331       LI->removeBlock(ExitingBlock);
 332
 333       DominanceFrontier *DF = getAnalysisIfAvailable<DominanceFrontier>();
 334       DomTreeNode *Node = DT->getNode(ExitingBlock);
 335       const std::vector<DomTreeNodeBase<BasicBlock> *> &Children =
 336         Node->getChildren();
 337       while (!Children.empty()) {
 338         DomTreeNode *Child = Children.front();
 339         DT->changeImmediateDominator(Child, Node->getIDom());
 340         if (DF) DF->changeImmediateDominator(Child->getBlock(),
 341                                              Node->getIDom()->getBlock(),
 342                                              DT);
 343       }
 344       DT->eraseNode(ExitingBlock);
 345       if (DF) DF->removeBlock(ExitingBlock);
 346
 347       BI->getSuccessor(0)->removePredecessor(ExitingBlock);
 348       BI->getSuccessor(1)->removePredecessor(ExitingBlock);
 349       ExitingBlock->eraseFromParent();
 350     }
 351   }
 352
 353   return Changed;
 354 }
 355
 356 /// InsertPreheaderForLoop - Once we discover that a loop doesn't have a
 357 /// preheader, this method is called to insert one.  This method has two phases:
 358 /// preheader insertion and analysis updating.
 359 ///
 360 BasicBlock *LoopSimplify::InsertPreheaderForLoop(Loop *L) {
 361   BasicBlock *Header = L->getHeader();
 362
 363   // Compute the set of predecessors of the loop that are not in the loop.
 364   SmallVector<BasicBlock*, 8> OutsideBlocks;
 365   for (pred_iterator PI = pred_begin(Header), PE = pred_end(Header);
 366        PI != PE; ++PI) {
 367     BasicBlock *P = *PI;
 368     if (!L->contains(P)) {         // Coming in from outside the loop?
 369       // If the loop is branched to from an indirect branch, we won't
 370       // be able to fully transform the loop, because it prohibits
 371       // edge splitting.
 372       if (isa<IndirectBrInst>(P->getTerminator())) return 0;
 373
 374       // Keep track of it.
 375       OutsideBlocks.push_back(P);
 376     }
 377   }
 378
 379   // Split out the loop pre-header.
 380   BasicBlock *NewBB =
 381     SplitBlockPredecessors(Header, &OutsideBlocks[0], OutsideBlocks.size(),
 382                            ".preheader", this);
 383
 384   DEBUG(dbgs() << "LoopSimplify: Creating pre-header ";
 385         WriteAsOperand(dbgs(), NewBB, false);
 386         dbgs() << "\n");
 387
 388   // Make sure that NewBB is put someplace intelligent, which doesn't mess up
 389   // code layout too horribly.
 390   PlaceSplitBlockCarefully(NewBB, OutsideBlocks, L);
 391
 392   return NewBB;
 393 }
 394
 395 /// RewriteLoopExitBlock - Ensure that the loop preheader dominates all exit
 396 /// blocks.  This method is used to split exit blocks that have predecessors
 397 /// outside of the loop.
 398 BasicBlock *LoopSimplify::RewriteLoopExitBlock(Loop *L, BasicBlock *Exit) {
 399   SmallVector<BasicBlock*, 8> LoopBlocks;
 400   for (pred_iterator I = pred_begin(Exit), E = pred_end(Exit); I != E; ++I) {
 401     BasicBlock *P = *I;
 402     if (L->contains(P)) {
 403       // Don't do this if the loop is exited via an indirect branch.
 404       if (isa<IndirectBrInst>(P->getTerminator())) return 0;
 405
 406       LoopBlocks.push_back(P);
 407     }
 408   }
 409
 410   assert(!LoopBlocks.empty() && "No edges coming in from outside the loop?");
 411   BasicBlock *NewBB = SplitBlockPredecessors(Exit, &LoopBlocks[0],
 412                                              LoopBlocks.size(), ".loopexit",
 413                                              this);
 414
 415   DEBUG(dbgs() << "LoopSimplify: Creating dedicated exit block ";
 416         WriteAsOperand(dbgs(), NewBB, false);
 417         dbgs() << "\n");
 418
 419   return NewBB;
 420 }
 421
 422 /// AddBlockAndPredsToSet - Add the specified block, and all of its
 423 /// predecessors, to the specified set, if it's not already in there.  Stop
 424 /// predecessor traversal when we reach StopBlock.
 425 static void AddBlockAndPredsToSet(BasicBlock *InputBB, BasicBlock *StopBlock,
 426                                   std::set<BasicBlock*> &Blocks) {
 427   std::vector<BasicBlock *> WorkList;
 428   WorkList.push_back(InputBB);
 429   do {
 430     BasicBlock *BB = WorkList.back(); WorkList.pop_back();
 431     if (Blocks.insert(BB).second && BB != StopBlock)
 432       // If BB is not already processed and it is not a stop block then
 433       // insert its predecessor in the work list
 434       for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I) {
 435         BasicBlock *WBB = *I;
 436         WorkList.push_back(WBB);
 437       }
 438   } while(!WorkList.empty());
 439 }
 440
 441 /// FindPHIToPartitionLoops - The first part of loop-nestification is to find a
 442 /// PHI node that tells us how to partition the loops.
 443 static PHINode *FindPHIToPartitionLoops(Loop *L, DominatorTree *DT,
 444                                         AliasAnalysis *AA) {
 445   for (BasicBlock::iterator I = L->getHeader()->begin(); isa<PHINode>(I); ) {
 446     PHINode *PN = cast<PHINode>(I);
 447     ++I;
 448     if (Value *V = PN->hasConstantValue(DT)) {
 449       // This is a degenerate PHI already, don't modify it!
 450       PN->replaceAllUsesWith(V);
 451       if (AA) AA->deleteValue(PN);
 452       PN->eraseFromParent();
 453       continue;
 454     }
 455
 456     // Scan this PHI node looking for a use of the PHI node by itself.
 457     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 458       if (PN->getIncomingValue(i) == PN &&
 459           L->contains(PN->getIncomingBlock(i)))
 460         // We found something tasty to remove.
 461         return PN;
 462   }
 463   return 0;
 464 }
 465
 466 // PlaceSplitBlockCarefully - If the block isn't already, move the new block to
 467 // right after some 'outside block' block.  This prevents the preheader from
 468 // being placed inside the loop body, e.g. when the loop hasn't been rotated.
 469 void LoopSimplify::PlaceSplitBlockCarefully(BasicBlock *NewBB,
 470                                        SmallVectorImpl<BasicBlock*> &SplitPreds,
 471                                             Loop *L) {
 472   // Check to see if NewBB is already well placed.
 473   Function::iterator BBI = NewBB; --BBI;
 474   for (unsigned i = 0, e = SplitPreds.size(); i != e; ++i) {
 475     if (&*BBI == SplitPreds[i])
 476       return;
 477   }
 478
 479   // If it isn't already after an outside block, move it after one.  This is
 480   // always good as it makes the uncond branch from the outside block into a
 481   // fall-through.
 482
 483   // Figure out *which* outside block to put this after.  Prefer an outside
 484   // block that neighbors a BB actually in the loop.
 485   BasicBlock *FoundBB = 0;
 486   for (unsigned i = 0, e = SplitPreds.size(); i != e; ++i) {
 487     Function::iterator BBI = SplitPreds[i];
 488     if (++BBI != NewBB->getParent()->end() &&
 489         L->contains(BBI)) {
 490       FoundBB = SplitPreds[i];
 491       break;
 492     }
 493   }
 494
 495   // If our heuristic for a *good* bb to place this after doesn't find
 496   // anything, just pick something.  It's likely better than leaving it within
 497   // the loop.
 498   if (!FoundBB)
 499     FoundBB = SplitPreds[0];
 500   NewBB->moveAfter(FoundBB);
 501 }
 502
 503
 504 /// SeparateNestedLoop - If this loop has multiple backedges, try to pull one of
 505 /// them out into a nested loop.  This is important for code that looks like
 506 /// this:
 507 ///
 508 ///  Loop:
 509 ///     ...
 510 ///     br cond, Loop, Next
 511 ///     ...
 512 ///     br cond2, Loop, Out
 513 ///
 514 /// To identify this common case, we look at the PHI nodes in the header of the
 515 /// loop.  PHI nodes with unchanging values on one backedge correspond to values
 516 /// that change in the "outer" loop, but not in the "inner" loop.
 517 ///
 518 /// If we are able to separate out a loop, return the new outer loop that was
 519 /// created.
 520 ///
 521 Loop *LoopSimplify::SeparateNestedLoop(Loop *L, LPPassManager &LPM) {
 522   PHINode *PN = FindPHIToPartitionLoops(L, DT, AA);
 523   if (PN == 0) return 0;  // No known way to partition.
 524
 525   // Pull out all predecessors that have varying values in the loop.  This
 526   // handles the case when a PHI node has multiple instances of itself as
 527   // arguments.
 528   SmallVector<BasicBlock*, 8> OuterLoopPreds;
 529   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 530     if (PN->getIncomingValue(i) != PN ||
 531         !L->contains(PN->getIncomingBlock(i))) {
 532       // We can't split indirectbr edges.
 533       if (isa<IndirectBrInst>(PN->getIncomingBlock(i)->getTerminator()))
 534         return 0;
 535
 536       OuterLoopPreds.push_back(PN->getIncomingBlock(i));
 537     }
 538
 539   DEBUG(dbgs() << "LoopSimplify: Splitting out a new outer loop\n");
 540
 541   BasicBlock *Header = L->getHeader();
 542   BasicBlock *NewBB = SplitBlockPredecessors(Header, &OuterLoopPreds[0],
 543                                              OuterLoopPreds.size(),
 544                                              ".outer", this);
 545
 546   // Make sure that NewBB is put someplace intelligent, which doesn't mess up
 547   // code layout too horribly.
 548   PlaceSplitBlockCarefully(NewBB, OuterLoopPreds, L);
 549
 550   // Create the new outer loop.
 551   Loop *NewOuter = new Loop();
 552
 553   // Change the parent loop to use the outer loop as its child now.
 554   if (Loop *Parent = L->getParentLoop())
 555     Parent->replaceChildLoopWith(L, NewOuter);
 556   else
 557     LI->changeTopLevelLoop(L, NewOuter);
 558
 559   // L is now a subloop of our outer loop.
 560   NewOuter->addChildLoop(L);
 561
 562   // Add the new loop to the pass manager queue.
 563   LPM.insertLoopIntoQueue(NewOuter);
 564
 565   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
 566        I != E; ++I)
 567     NewOuter->addBlockEntry(*I);
 568
 569   // Now reset the header in L, which had been moved by
 570   // SplitBlockPredecessors for the outer loop.
 571   L->moveToHeader(Header);
 572
 573   // Determine which blocks should stay in L and which should be moved out to
 574   // the Outer loop now.
 575   std::set<BasicBlock*> BlocksInL;
 576   for (pred_iterator PI=pred_begin(Header), E = pred_end(Header); PI!=E; ++PI) {
 577     BasicBlock *P = *PI;
 578     if (DT->dominates(Header, P))
 579       AddBlockAndPredsToSet(P, Header, BlocksInL);
 580   }
 581
 582   // Scan all of the loop children of L, moving them to OuterLoop if they are
 583   // not part of the inner loop.
 584   const std::vector<Loop*> &SubLoops = L->getSubLoops();
 585   for (size_t I = 0; I != SubLoops.size(); )
 586     if (BlocksInL.count(SubLoops[I]->getHeader()))
 587       ++I;   // Loop remains in L
 588     else
 589       NewOuter->addChildLoop(L->removeChildLoop(SubLoops.begin() + I));
 590
 591   // Now that we know which blocks are in L and which need to be moved to
 592   // OuterLoop, move any blocks that need it.
 593   for (unsigned i = 0; i != L->getBlocks().size(); ++i) {
 594     BasicBlock *BB = L->getBlocks()[i];
 595     if (!BlocksInL.count(BB)) {
 596       // Move this block to the parent, updating the exit blocks sets
 597       L->removeBlockFromLoop(BB);
 598       if ((*LI)[BB] == L)
 599         LI->changeLoopFor(BB, NewOuter);
 600       --i;
 601     }
 602   }
 603
 604   return NewOuter;
 605 }
 606
 607
 608
 609 /// InsertUniqueBackedgeBlock - This method is called when the specified loop
 610 /// has more than one backedge in it.  If this occurs, revector all of these
 611 /// backedges to target a new basic block and have that block branch to the loop
 612 /// header.  This ensures that loops have exactly one backedge.
 613 ///
 614 BasicBlock *
 615 LoopSimplify::InsertUniqueBackedgeBlock(Loop *L, BasicBlock *Preheader) {
 616   assert(L->getNumBackEdges() > 1 && "Must have > 1 backedge!");
 617
 618   // Get information about the loop
 619   BasicBlock *Header = L->getHeader();
 620   Function *F = Header->getParent();
 621
 622   // Unique backedge insertion currently depends on having a preheader.
 623   if (!Preheader)
 624     return 0;
 625
 626   // Figure out which basic blocks contain back-edges to the loop header.
 627   std::vector<BasicBlock*> BackedgeBlocks;
 628   for (pred_iterator I = pred_begin(Header), E = pred_end(Header); I != E; ++I){
 629     BasicBlock *P = *I;
 630     if (P != Preheader) BackedgeBlocks.push_back(P);
 631   }
 632
 633   // Create and insert the new backedge block...
 634   BasicBlock *BEBlock = BasicBlock::Create(Header->getContext(),
 635                                            Header->getName()+".backedge", F);
 636   BranchInst *BETerminator = BranchInst::Create(Header, BEBlock);
 637
 638   DEBUG(dbgs() << "LoopSimplify: Inserting unique backedge block ";
 639         WriteAsOperand(dbgs(), BEBlock, false);
 640         dbgs() << "\n");
 641
 642   // Move the new backedge block to right after the last backedge block.
 643   Function::iterator InsertPos = BackedgeBlocks.back(); ++InsertPos;
 644   F->getBasicBlockList().splice(InsertPos, F->getBasicBlockList(), BEBlock);
 645
 646   // Now that the block has been inserted into the function, create PHI nodes in
 647   // the backedge block which correspond to any PHI nodes in the header block.
 648   for (BasicBlock::iterator I = Header->begin(); isa<PHINode>(I); ++I) {
 649     PHINode *PN = cast<PHINode>(I);
 650     PHINode *NewPN = PHINode::Create(PN->getType(), PN->getName()+".be",
 651                                      BETerminator);
 652     NewPN->reserveOperandSpace(BackedgeBlocks.size());
 653     if (AA) AA->copyValue(PN, NewPN);
 654
 655     // Loop over the PHI node, moving all entries except the one for the
 656     // preheader over to the new PHI node.
 657     unsigned PreheaderIdx = ~0U;
 658     bool HasUniqueIncomingValue = true;
 659     Value *UniqueValue = 0;
 660     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 661       BasicBlock *IBB = PN->getIncomingBlock(i);
 662       Value *IV = PN->getIncomingValue(i);
 663       if (IBB == Preheader) {
 664         PreheaderIdx = i;
 665       } else {
 666         NewPN->addIncoming(IV, IBB);
 667         if (HasUniqueIncomingValue) {
 668           if (UniqueValue == 0)
 669             UniqueValue = IV;
 670           else if (UniqueValue != IV)
 671             HasUniqueIncomingValue = false;
 672         }
 673       }
 674     }
 675
 676     // Delete all of the incoming values from the old PN except the preheader's
 677     assert(PreheaderIdx != ~0U && "PHI has no preheader entry??");
 678     if (PreheaderIdx != 0) {
 679       PN->setIncomingValue(0, PN->getIncomingValue(PreheaderIdx));
 680       PN->setIncomingBlock(0, PN->getIncomingBlock(PreheaderIdx));
 681     }
 682     // Nuke all entries except the zero'th.
 683     for (unsigned i = 0, e = PN->getNumIncomingValues()-1; i != e; ++i)
 684       PN->removeIncomingValue(e-i, false);
 685
 686     // Finally, add the newly constructed PHI node as the entry for the BEBlock.
 687     PN->addIncoming(NewPN, BEBlock);
 688
 689     // As an optimization, if all incoming values in the new PhiNode (which is a
 690     // subset of the incoming values of the old PHI node) have the same value,
 691     // eliminate the PHI Node.
 692     if (HasUniqueIncomingValue) {
 693       NewPN->replaceAllUsesWith(UniqueValue);
 694       if (AA) AA->deleteValue(NewPN);
 695       BEBlock->getInstList().erase(NewPN);
 696     }
 697   }
 698
 699   // Now that all of the PHI nodes have been inserted and adjusted, modify the
 700   // backedge blocks to just to the BEBlock instead of the header.
 701   for (unsigned i = 0, e = BackedgeBlocks.size(); i != e; ++i) {
 702     TerminatorInst *TI = BackedgeBlocks[i]->getTerminator();
 703     for (unsigned Op = 0, e = TI->getNumSuccessors(); Op != e; ++Op)
 704       if (TI->getSuccessor(Op) == Header)
 705         TI->setSuccessor(Op, BEBlock);
 706   }
 707
 708   //===--- Update all analyses which we must preserve now -----------------===//
 709
 710   // Update Loop Information - we know that this block is now in the current
 711   // loop and all parent loops.
 712   L->addBasicBlockToLoop(BEBlock, LI->getBase());
 713
 714   // Update dominator information
 715   DT->splitBlock(BEBlock);
 716   if (DominanceFrontier *DF = getAnalysisIfAvailable<DominanceFrontier>())
 717     DF->splitBlock(BEBlock);
 718
 719   return BEBlock;
 720 }
 721
 722 void LoopSimplify::verifyAnalysis() const {
 723   // It used to be possible to just assert L->isLoopSimplifyForm(), however
 724   // with the introduction of indirectbr, there are now cases where it's
 725   // not possible to transform a loop as necessary. We can at least check
 726   // that there is an indirectbr near any time there's trouble.
 727
 728   // Indirectbr can interfere with preheader and unique backedge insertion.
 729   if (!L->getLoopPreheader() || !L->getLoopLatch()) {
 730     bool HasIndBrPred = false;
 731     for (pred_iterator PI = pred_begin(L->getHeader()),
 732          PE = pred_end(L->getHeader()); PI != PE; ++PI)
 733       if (isa<IndirectBrInst>((*PI)->getTerminator())) {
 734         HasIndBrPred = true;
 735         break;
 736       }
 737     assert(HasIndBrPred &&
 738            "LoopSimplify has no excuse for missing loop header info!");
 739   }
 740
 741   // Indirectbr can interfere with exit block canonicalization.
 742   if (!L->hasDedicatedExits()) {
 743     bool HasIndBrExiting = false;
 744     SmallVector<BasicBlock*, 8> ExitingBlocks;
 745     L->getExitingBlocks(ExitingBlocks);
 746     for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i)
 747       if (isa<IndirectBrInst>((ExitingBlocks[i])->getTerminator())) {
 748         HasIndBrExiting = true;
 749         break;
 750       }
 751     assert(HasIndBrExiting &&
 752            "LoopSimplify has no excuse for missing exit block info!");
 753   }
 754 }