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