lib/Transforms/Scalar/LoopUnswitch.cpp

   1 //===-- LoopUnswitch.cpp - Hoist loop-invariant conditionals in loop ------===//
   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 transforms loops that contain branches on loop-invariant conditions
  11 // to have multiple loops.  For example, it turns the left into the right code:
  12 //
  13 //  for (...)                  if (lic)
  14 //    A                          for (...)
  15 //    if (lic)                     A; B; C
  16 //      B                      else
  17 //    C                          for (...)
  18 //                                 A; C
  19 //
  20 // This can increase the size of the code exponentially (doubling it every time
  21 // a loop is unswitched) so we only unswitch if the resultant code will be
  22 // smaller than a threshold.
  23 //
  24 // This pass expects LICM to be run before it to hoist invariant conditions out
  25 // of the loop, to make the unswitching opportunity obvious.
  26 //
  27 //===----------------------------------------------------------------------===//
  28
  29 #define DEBUG_TYPE "loop-unswitch"
  30 #include "llvm/Transforms/Scalar.h"
  31 #include "llvm/Constants.h"
  32 #include "llvm/DerivedTypes.h"
  33 #include "llvm/Function.h"
  34 #include "llvm/Instructions.h"
  35 #include "llvm/Analysis/ConstantFolding.h"
  36 #include "llvm/Analysis/LoopInfo.h"
  37 #include "llvm/Analysis/LoopPass.h"
  38 #include "llvm/Analysis/Dominators.h"
  39 #include "llvm/Transforms/Utils/Cloning.h"
  40 #include "llvm/Transforms/Utils/Local.h"
  41 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  42 #include "llvm/ADT/Statistic.h"
  43 #include "llvm/ADT/SmallPtrSet.h"
  44 #include "llvm/Support/CommandLine.h"
  45 #include "llvm/Support/Compiler.h"
  46 #include "llvm/Support/Debug.h"
  47 #include <algorithm>
  48 #include <set>
  49 using namespace llvm;
  50
  51 STATISTIC(NumBranches, "Number of branches unswitched");
  52 STATISTIC(NumSwitches, "Number of switches unswitched");
  53 STATISTIC(NumSelects , "Number of selects unswitched");
  54 STATISTIC(NumTrivial , "Number of unswitches that are trivial");
  55 STATISTIC(NumSimplify, "Number of simplifications of unswitched code");
  56
  57 static cl::opt<unsigned>
  58 Threshold("loop-unswitch-threshold", cl::desc("Max loop size to unswitch"),
  59           cl::init(10), cl::Hidden);
  60
  61 namespace {
  62   class VISIBILITY_HIDDEN LoopUnswitch : public LoopPass {
  63     LoopInfo *LI;  // Loop information
  64     LPPassManager *LPM;
  65
  66     // LoopProcessWorklist - Used to check if second loop needs processing
  67     // after RewriteLoopBodyWithConditionConstant rewrites first loop.
  68     std::vector<Loop*> LoopProcessWorklist;
  69     SmallPtrSet<Value *,8> UnswitchedVals;
  70
  71     bool OptimizeForSize;
  72     bool redoLoop;
  73
  74     Loop *currentLoop;
  75     DominanceFrontier *DF;
  76     DominatorTree *DT;
  77     BasicBlock *loopHeader;
  78     BasicBlock *loopPreheader;
  79
  80     /// LoopDF - Loop's dominance frontier. This set is a collection of
  81     /// loop exiting blocks' DF member blocks. However this does set does not
  82     /// includes basic blocks that are inside loop.
  83     SmallPtrSet<BasicBlock *, 8> LoopDF;
  84
  85     /// OrigLoopExitMap - This is used to map loop exiting block with
  86     /// corresponding loop exit block, before updating CFG.
  87     DenseMap<BasicBlock *, BasicBlock *> OrigLoopExitMap;
  88
  89     // LoopBlocks contains all of the basic blocks of the loop, including the
  90     // preheader of the loop, the body of the loop, and the exit blocks of the
  91     // loop, in that order.
  92     std::vector<BasicBlock*> LoopBlocks;
  93     // NewBlocks contained cloned copy of basic blocks from LoopBlocks.
  94     std::vector<BasicBlock*> NewBlocks;
  95   public:
  96     static char ID; // Pass ID, replacement for typeid
  97     explicit LoopUnswitch(bool Os = false) :
  98       LoopPass((intptr_t)&ID), OptimizeForSize(Os), redoLoop(false),
  99       currentLoop(NULL), DF(NULL), DT(NULL), loopHeader(NULL),
 100       loopPreheader(NULL) {}
 101
 102     bool runOnLoop(Loop *L, LPPassManager &LPM);
 103     bool processCurrentLoop();
 104
 105     /// This transformation requires natural loop information & requires that
 106     /// loop preheaders be inserted into the CFG...
 107     ///
 108     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 109       AU.addRequiredID(LoopSimplifyID);
 110       AU.addPreservedID(LoopSimplifyID);
 111       AU.addRequired<LoopInfo>();
 112       AU.addPreserved<LoopInfo>();
 113       AU.addRequiredID(LCSSAID);
 114       AU.addPreservedID(LCSSAID);
 115       AU.addPreserved<DominatorTree>();
 116       AU.addPreserved<DominanceFrontier>();
 117     }
 118
 119   private:
 120
 121     /// RemoveLoopFromWorklist - If the specified loop is on the loop worklist,
 122     /// remove it.
 123     void RemoveLoopFromWorklist(Loop *L) {
 124       std::vector<Loop*>::iterator I = std::find(LoopProcessWorklist.begin(),
 125                                                  LoopProcessWorklist.end(), L);
 126       if (I != LoopProcessWorklist.end())
 127         LoopProcessWorklist.erase(I);
 128     }
 129
 130     void initLoopData() {
 131       loopHeader = currentLoop->getHeader();
 132       loopPreheader = currentLoop->getLoopPreheader();
 133     }
 134
 135     /// Split all of the edges from inside the loop to their exit blocks.
 136     /// Update the appropriate Phi nodes as we do so.
 137     void SplitExitEdges(Loop *L, const SmallVector<BasicBlock *, 8> &ExitBlocks,
 138                         SmallVector<BasicBlock *, 8> &MiddleBlocks);
 139
 140     /// If BB's dominance frontier  has a member that is not part of loop L then
 141     /// remove it. Add NewDFMember in BB's dominance frontier.
 142     void ReplaceLoopExternalDFMember(Loop *L, BasicBlock *BB,
 143                                      BasicBlock *NewDFMember);
 144
 145     bool UnswitchIfProfitable(Value *LoopCond, Constant *Val);
 146     unsigned getLoopUnswitchCost(Value *LIC);
 147     void UnswitchTrivialCondition(Loop *L, Value *Cond, Constant *Val,
 148                                   BasicBlock *ExitBlock);
 149     void UnswitchNontrivialCondition(Value *LIC, Constant *OnVal, Loop *L);
 150
 151     void RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
 152                                               Constant *Val, bool isEqual);
 153
 154     void EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
 155                                         BasicBlock *TrueDest,
 156                                         BasicBlock *FalseDest,
 157                                         Instruction *InsertPt);
 158
 159     void SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L);
 160     void RemoveBlockIfDead(BasicBlock *BB,
 161                            std::vector<Instruction*> &Worklist, Loop *l);
 162     void RemoveLoopFromHierarchy(Loop *L);
 163     bool IsTrivialUnswitchCondition(Value *Cond, Constant **Val = 0,
 164                                     BasicBlock **LoopExit = 0);
 165
 166   };
 167 }
 168 char LoopUnswitch::ID = 0;
 169 static RegisterPass<LoopUnswitch> X("loop-unswitch", "Unswitch loops");
 170
 171 LoopPass *llvm::createLoopUnswitchPass(bool Os) {
 172   return new LoopUnswitch(Os);
 173 }
 174
 175 /// FindLIVLoopCondition - Cond is a condition that occurs in L.  If it is
 176 /// invariant in the loop, or has an invariant piece, return the invariant.
 177 /// Otherwise, return null.
 178 static Value *FindLIVLoopCondition(Value *Cond, Loop *L, bool &Changed) {
 179   // Constants should be folded, not unswitched on!
 180   if (isa<Constant>(Cond)) return false;
 181
 182   // TODO: Handle: br (VARIANT|INVARIANT).
 183   // TODO: Hoist simple expressions out of loops.
 184   if (L->isLoopInvariant(Cond)) return Cond;
 185
 186   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Cond))
 187     if (BO->getOpcode() == Instruction::And ||
 188         BO->getOpcode() == Instruction::Or) {
 189       // If either the left or right side is invariant, we can unswitch on this,
 190       // which will cause the branch to go away in one loop and the condition to
 191       // simplify in the other one.
 192       if (Value *LHS = FindLIVLoopCondition(BO->getOperand(0), L, Changed))
 193         return LHS;
 194       if (Value *RHS = FindLIVLoopCondition(BO->getOperand(1), L, Changed))
 195         return RHS;
 196     }
 197
 198   return 0;
 199 }
 200
 201 bool LoopUnswitch::runOnLoop(Loop *L, LPPassManager &LPM_Ref) {
 202   LI = &getAnalysis<LoopInfo>();
 203   LPM = &LPM_Ref;
 204   DF = getAnalysisToUpdate<DominanceFrontier>();
 205   DT = getAnalysisToUpdate<DominatorTree>();
 206   currentLoop = L;
 207   bool Changed = false;
 208
 209   do {
 210     assert(currentLoop->isLCSSAForm());
 211     redoLoop = false;
 212     Changed |= processCurrentLoop();
 213   } while(redoLoop);
 214
 215   return Changed;
 216 }
 217
 218 /// processCurrentLoop - Do actual work and unswitch loop if possible
 219 /// and profitable.
 220 bool LoopUnswitch::processCurrentLoop() {
 221   bool Changed = false;
 222
 223   // Loop over all of the basic blocks in the loop.  If we find an interior
 224   // block that is branching on a loop-invariant condition, we can unswitch this
 225   // loop.
 226   for (Loop::block_iterator I = currentLoop->block_begin(),
 227          E = currentLoop->block_end();
 228        I != E; ++I) {
 229     TerminatorInst *TI = (*I)->getTerminator();
 230     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
 231       // If this isn't branching on an invariant condition, we can't unswitch
 232       // it.
 233       if (BI->isConditional()) {
 234         // See if this, or some part of it, is loop invariant.  If so, we can
 235         // unswitch on it if we desire.
 236         Value *LoopCond = FindLIVLoopCondition(BI->getCondition(),
 237                                                currentLoop, Changed);
 238         if (LoopCond && UnswitchIfProfitable(LoopCond,
 239                                              ConstantInt::getTrue())) {
 240           ++NumBranches;
 241           return true;
 242         }
 243       }
 244     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
 245       Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 246                                              currentLoop, Changed);
 247       if (LoopCond && SI->getNumCases() > 1) {
 248         // Find a value to unswitch on:
 249         // FIXME: this should chose the most expensive case!
 250         Constant *UnswitchVal = SI->getCaseValue(1);
 251         // Do not process same value again and again.
 252         if (!UnswitchedVals.insert(UnswitchVal))
 253           continue;
 254
 255         if (UnswitchIfProfitable(LoopCond, UnswitchVal)) {
 256           ++NumSwitches;
 257           return true;
 258         }
 259       }
 260     }
 261
 262     // Scan the instructions to check for unswitchable values.
 263     for (BasicBlock::iterator BBI = (*I)->begin(), E = (*I)->end();
 264          BBI != E; ++BBI)
 265       if (SelectInst *SI = dyn_cast<SelectInst>(BBI)) {
 266         Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 267                                                currentLoop, Changed);
 268         if (LoopCond && UnswitchIfProfitable(LoopCond,
 269                                              ConstantInt::getTrue())) {
 270           ++NumSelects;
 271           return true;
 272         }
 273       }
 274   }
 275   return Changed;
 276 }
 277
 278 /// isTrivialLoopExitBlock - Check to see if all paths from BB either:
 279 ///   1. Exit the loop with no side effects.
 280 ///   2. Branch to the latch block with no side-effects.
 281 ///
 282 /// If these conditions are true, we return true and set ExitBB to the block we
 283 /// exit through.
 284 ///
 285 static bool isTrivialLoopExitBlockHelper(Loop *L, BasicBlock *BB,
 286                                          BasicBlock *&ExitBB,
 287                                          std::set<BasicBlock*> &Visited) {
 288   if (!Visited.insert(BB).second) {
 289     // Already visited and Ok, end of recursion.
 290     return true;
 291   } else if (!L->contains(BB)) {
 292     // Otherwise, this is a loop exit, this is fine so long as this is the
 293     // first exit.
 294     if (ExitBB != 0) return false;
 295     ExitBB = BB;
 296     return true;
 297   }
 298
 299   // Otherwise, this is an unvisited intra-loop node.  Check all successors.
 300   for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI) {
 301     // Check to see if the successor is a trivial loop exit.
 302     if (!isTrivialLoopExitBlockHelper(L, *SI, ExitBB, Visited))
 303       return false;
 304   }
 305
 306   // Okay, everything after this looks good, check to make sure that this block
 307   // doesn't include any side effects.
 308   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 309     if (I->mayWriteToMemory())
 310       return false;
 311
 312   return true;
 313 }
 314
 315 /// isTrivialLoopExitBlock - Return true if the specified block unconditionally
 316 /// leads to an exit from the specified loop, and has no side-effects in the
 317 /// process.  If so, return the block that is exited to, otherwise return null.
 318 static BasicBlock *isTrivialLoopExitBlock(Loop *L, BasicBlock *BB) {
 319   std::set<BasicBlock*> Visited;
 320   Visited.insert(L->getHeader());  // Branches to header are ok.
 321   BasicBlock *ExitBB = 0;
 322   if (isTrivialLoopExitBlockHelper(L, BB, ExitBB, Visited))
 323     return ExitBB;
 324   return 0;
 325 }
 326
 327 /// IsTrivialUnswitchCondition - Check to see if this unswitch condition is
 328 /// trivial: that is, that the condition controls whether or not the loop does
 329 /// anything at all.  If this is a trivial condition, unswitching produces no
 330 /// code duplications (equivalently, it produces a simpler loop and a new empty
 331 /// loop, which gets deleted).
 332 ///
 333 /// If this is a trivial condition, return true, otherwise return false.  When
 334 /// returning true, this sets Cond and Val to the condition that controls the
 335 /// trivial condition: when Cond dynamically equals Val, the loop is known to
 336 /// exit.  Finally, this sets LoopExit to the BB that the loop exits to when
 337 /// Cond == Val.
 338 ///
 339 bool LoopUnswitch::IsTrivialUnswitchCondition(Value *Cond, Constant **Val,
 340                                        BasicBlock **LoopExit) {
 341   BasicBlock *Header = currentLoop->getHeader();
 342   TerminatorInst *HeaderTerm = Header->getTerminator();
 343
 344   BasicBlock *LoopExitBB = 0;
 345   if (BranchInst *BI = dyn_cast<BranchInst>(HeaderTerm)) {
 346     // If the header block doesn't end with a conditional branch on Cond, we
 347     // can't handle it.
 348     if (!BI->isConditional() || BI->getCondition() != Cond)
 349       return false;
 350
 351     // Check to see if a successor of the branch is guaranteed to go to the
 352     // latch block or exit through a one exit block without having any
 353     // side-effects.  If so, determine the value of Cond that causes it to do
 354     // this.
 355     if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
 356                                              BI->getSuccessor(0)))) {
 357       if (Val) *Val = ConstantInt::getTrue();
 358     } else if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
 359                                                     BI->getSuccessor(1)))) {
 360       if (Val) *Val = ConstantInt::getFalse();
 361     }
 362   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(HeaderTerm)) {
 363     // If this isn't a switch on Cond, we can't handle it.
 364     if (SI->getCondition() != Cond) return false;
 365
 366     // Check to see if a successor of the switch is guaranteed to go to the
 367     // latch block or exit through a one exit block without having any
 368     // side-effects.  If so, determine the value of Cond that causes it to do
 369     // this.  Note that we can't trivially unswitch on the default case.
 370     for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i)
 371       if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
 372                                                SI->getSuccessor(i)))) {
 373         // Okay, we found a trivial case, remember the value that is trivial.
 374         if (Val) *Val = SI->getCaseValue(i);
 375         break;
 376       }
 377   }
 378
 379   // If we didn't find a single unique LoopExit block, or if the loop exit block
 380   // contains phi nodes, this isn't trivial.
 381   if (!LoopExitBB || isa<PHINode>(LoopExitBB->begin()))
 382     return false;   // Can't handle this.
 383
 384   if (LoopExit) *LoopExit = LoopExitBB;
 385
 386   // We already know that nothing uses any scalar values defined inside of this
 387   // loop.  As such, we just have to check to see if this loop will execute any
 388   // side-effecting instructions (e.g. stores, calls, volatile loads) in the
 389   // part of the loop that the code *would* execute.  We already checked the
 390   // tail, check the header now.
 391   for (BasicBlock::iterator I = Header->begin(), E = Header->end(); I != E; ++I)
 392     if (I->mayWriteToMemory())
 393       return false;
 394   return true;
 395 }
 396
 397 /// getLoopUnswitchCost - Return the cost (code size growth) that will happen if
 398 /// we choose to unswitch current loop on the specified value.
 399 ///
 400 unsigned LoopUnswitch::getLoopUnswitchCost(Value *LIC) {
 401   // If the condition is trivial, always unswitch.  There is no code growth for
 402   // this case.
 403   if (IsTrivialUnswitchCondition(LIC))
 404     return 0;
 405
 406   // FIXME: This is really overly conservative.  However, more liberal
 407   // estimations have thus far resulted in excessive unswitching, which is bad
 408   // both in compile time and in code size.  This should be replaced once
 409   // someone figures out how a good estimation.
 410   return currentLoop->getBlocks().size();
 411
 412   unsigned Cost = 0;
 413   // FIXME: this is brain dead.  It should take into consideration code
 414   // shrinkage.
 415   for (Loop::block_iterator I = currentLoop->block_begin(),
 416          E = currentLoop->block_end();
 417        I != E; ++I) {
 418     BasicBlock *BB = *I;
 419     // Do not include empty blocks in the cost calculation.  This happen due to
 420     // loop canonicalization and will be removed.
 421     if (BB->begin() == BasicBlock::iterator(BB->getTerminator()))
 422       continue;
 423
 424     // Count basic blocks.
 425     ++Cost;
 426   }
 427
 428   return Cost;
 429 }
 430
 431 /// UnswitchIfProfitable - We have found that we can unswitch currentLoop when
 432 /// LoopCond == Val to simplify the loop.  If we decide that this is profitable,
 433 /// unswitch the loop, reprocess the pieces, then return true.
 434 bool LoopUnswitch::UnswitchIfProfitable(Value *LoopCond, Constant *Val){
 435   // Check to see if it would be profitable to unswitch current loop.
 436   unsigned Cost = getLoopUnswitchCost(LoopCond);
 437
 438   // Do not do non-trivial unswitch while optimizing for size.
 439   if (Cost && OptimizeForSize)
 440     return false;
 441
 442   if (Cost > Threshold) {
 443     // FIXME: this should estimate growth by the amount of code shared by the
 444     // resultant unswitched loops.
 445     //
 446     DOUT << "NOT unswitching loop %"
 447          << currentLoop->getHeader()->getName() << ", cost too high: "
 448          << currentLoop->getBlocks().size() << "\n";
 449     return false;
 450   }
 451
 452   initLoopData();
 453
 454   Constant *CondVal;
 455   BasicBlock *ExitBlock;
 456   if (IsTrivialUnswitchCondition(LoopCond, &CondVal, &ExitBlock)) {
 457     UnswitchTrivialCondition(currentLoop, LoopCond, CondVal, ExitBlock);
 458   } else {
 459     UnswitchNontrivialCondition(LoopCond, Val, currentLoop);
 460   }
 461
 462   return true;
 463 }
 464
 465 // RemapInstruction - Convert the instruction operands from referencing the
 466 // current values into those specified by ValueMap.
 467 //
 468 static inline void RemapInstruction(Instruction *I,
 469                                     DenseMap<const Value *, Value*> &ValueMap) {
 470   for (unsigned op = 0, E = I->getNumOperands(); op != E; ++op) {
 471     Value *Op = I->getOperand(op);
 472     DenseMap<const Value *, Value*>::iterator It = ValueMap.find(Op);
 473     if (It != ValueMap.end()) Op = It->second;
 474     I->setOperand(op, Op);
 475   }
 476 }
 477
 478 // CloneDomInfo - NewBB is cloned from Orig basic block. Now clone Dominator
 479 // Info.
 480 //
 481 // If Orig block's immediate dominator is mapped in VM then use corresponding
 482 // immediate dominator from the map. Otherwise Orig block's dominator is also
 483 // NewBB's dominator.
 484 //
 485 // OrigPreheader is loop pre-header before this pass started
 486 // updating CFG. NewPrehader is loops new pre-header. However, after CFG
 487 // manipulation, loop L may not exist. So rely on input parameter NewPreheader.
 488 static void CloneDomInfo(BasicBlock *NewBB, BasicBlock *Orig,
 489                          BasicBlock *NewPreheader, BasicBlock *OrigPreheader,
 490                          BasicBlock *OrigHeader,
 491                          DominatorTree *DT, DominanceFrontier *DF,
 492                          DenseMap<const Value*, Value*> &VM) {
 493
 494   // If NewBB alreay has found its place in domiantor tree then no need to do
 495   // anything.
 496   if (DT->getNode(NewBB))
 497     return;
 498
 499   // If Orig does not have any immediate domiantor then its clone, NewBB, does
 500   // not need any immediate dominator.
 501   DomTreeNode *OrigNode = DT->getNode(Orig);
 502   if (!OrigNode)
 503     return;
 504   DomTreeNode *OrigIDomNode = OrigNode->getIDom();
 505   if (!OrigIDomNode)
 506     return;
 507
 508   BasicBlock *OrigIDom = NULL;
 509
 510   // If Orig is original loop header then its immediate dominator is
 511   // NewPreheader.
 512   if (Orig == OrigHeader)
 513     OrigIDom = NewPreheader;
 514
 515   // If Orig is new pre-header then its immediate dominator is
 516   // original pre-header.
 517   else if (Orig == NewPreheader)
 518     OrigIDom = OrigPreheader;
 519
 520   // Otherwise ask DT to find Orig's immediate dominator.
 521   else
 522      OrigIDom = OrigIDomNode->getBlock();
 523
 524   // Initially use Orig's immediate dominator as NewBB's immediate dominator.
 525   BasicBlock *NewIDom = OrigIDom;
 526   DenseMap<const Value*, Value*>::iterator I = VM.find(OrigIDom);
 527   if (I != VM.end()) {
 528     NewIDom = cast<BasicBlock>(I->second);
 529
 530     // If NewIDom does not have corresponding dominatore tree node then
 531     // get one.
 532     if (!DT->getNode(NewIDom))
 533       CloneDomInfo(NewIDom, OrigIDom, NewPreheader, OrigPreheader,
 534                    OrigHeader, DT, DF, VM);
 535   }
 536
 537   DT->addNewBlock(NewBB, NewIDom);
 538
 539   // Copy cloned dominance frontiner set
 540   DominanceFrontier::DomSetType NewDFSet;
 541   if (DF) {
 542     DominanceFrontier::iterator DFI = DF->find(Orig);
 543     if ( DFI != DF->end()) {
 544       DominanceFrontier::DomSetType S = DFI->second;
 545       for (DominanceFrontier::DomSetType::iterator I = S.begin(), E = S.end();
 546            I != E; ++I) {
 547         BasicBlock *BB = *I;
 548         DenseMap<const Value*, Value*>::iterator IDM = VM.find(BB);
 549         if (IDM != VM.end())
 550           NewDFSet.insert(cast<BasicBlock>(IDM->second));
 551         else
 552           NewDFSet.insert(BB);
 553       }
 554     }
 555     DF->addBasicBlock(NewBB, NewDFSet);
 556   }
 557 }
 558
 559 /// CloneLoop - Recursively clone the specified loop and all of its children,
 560 /// mapping the blocks with the specified map.
 561 static Loop *CloneLoop(Loop *L, Loop *PL, DenseMap<const Value*, Value*> &VM,
 562                        LoopInfo *LI, LPPassManager *LPM) {
 563   Loop *New = new Loop();
 564
 565   LPM->insertLoop(New, PL);
 566
 567   // Add all of the blocks in L to the new loop.
 568   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
 569        I != E; ++I)
 570     if (LI->getLoopFor(*I) == L)
 571       New->addBasicBlockToLoop(cast<BasicBlock>(VM[*I]), LI->getBase());
 572
 573   // Add all of the subloops to the new loop.
 574   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
 575     CloneLoop(*I, New, VM, LI, LPM);
 576
 577   return New;
 578 }
 579
 580 /// EmitPreheaderBranchOnCondition - Emit a conditional branch on two values
 581 /// if LIC == Val, branch to TrueDst, otherwise branch to FalseDest.  Insert the
 582 /// code immediately before InsertPt.
 583 void LoopUnswitch::EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
 584                                                   BasicBlock *TrueDest,
 585                                                   BasicBlock *FalseDest,
 586                                                   Instruction *InsertPt) {
 587   // Insert a conditional branch on LIC to the two preheaders.  The original
 588   // code is the true version and the new code is the false version.
 589   Value *BranchVal = LIC;
 590   if (!isa<ConstantInt>(Val) || Val->getType() != Type::Int1Ty)
 591     BranchVal = new ICmpInst(ICmpInst::ICMP_EQ, LIC, Val, "tmp", InsertPt);
 592   else if (Val != ConstantInt::getTrue())
 593     // We want to enter the new loop when the condition is true.
 594     std::swap(TrueDest, FalseDest);
 595
 596   // Insert the new branch.
 597   BranchInst::Create(TrueDest, FalseDest, BranchVal, InsertPt);
 598 }
 599
 600
 601 /// UnswitchTrivialCondition - Given a loop that has a trivial unswitchable
 602 /// condition in it (a cond branch from its header block to its latch block,
 603 /// where the path through the loop that doesn't execute its body has no
 604 /// side-effects), unswitch it.  This doesn't involve any code duplication, just
 605 /// moving the conditional branch outside of the loop and updating loop info.
 606 void LoopUnswitch::UnswitchTrivialCondition(Loop *L, Value *Cond,
 607                                             Constant *Val,
 608                                             BasicBlock *ExitBlock) {
 609   DOUT << "loop-unswitch: Trivial-Unswitch loop %"
 610        << loopHeader->getName() << " [" << L->getBlocks().size()
 611        << " blocks] in Function " << L->getHeader()->getParent()->getName()
 612        << " on cond: " << *Val << " == " << *Cond << "\n";
 613
 614   // First step, split the preheader, so that we know that there is a safe place
 615   // to insert the conditional branch.  We will change loopPreheader to have a
 616   // conditional branch on Cond.
 617   BasicBlock *NewPH = SplitEdge(loopPreheader, loopHeader, this);
 618
 619   // Now that we have a place to insert the conditional branch, create a place
 620   // to branch to: this is the exit block out of the loop that we should
 621   // short-circuit to.
 622
 623   // Split this block now, so that the loop maintains its exit block, and so
 624   // that the jump from the preheader can execute the contents of the exit block
 625   // without actually branching to it (the exit block should be dominated by the
 626   // loop header, not the preheader).
 627   assert(!L->contains(ExitBlock) && "Exit block is in the loop?");
 628   BasicBlock *NewExit = SplitBlock(ExitBlock, ExitBlock->begin(), this);
 629
 630   // Okay, now we have a position to branch from and a position to branch to,
 631   // insert the new conditional branch.
 632   EmitPreheaderBranchOnCondition(Cond, Val, NewExit, NewPH,
 633                                  loopPreheader->getTerminator());
 634   if (DT) {
 635     DT->changeImmediateDominator(NewExit, loopPreheader);
 636     DT->changeImmediateDominator(NewPH, loopPreheader);
 637   }
 638
 639   if (DF) {
 640     // NewExit is now part of NewPH and Loop Header's dominance
 641     // frontier.
 642     DominanceFrontier::iterator  DFI = DF->find(NewPH);
 643     if (DFI != DF->end())
 644       DF->addToFrontier(DFI, NewExit);
 645     DFI = DF->find(loopHeader);
 646     DF->addToFrontier(DFI, NewExit);
 647
 648     // ExitBlock does not have successors then NewExit is part of
 649     // its dominance frontier.
 650     if (succ_begin(ExitBlock) == succ_end(ExitBlock)) {
 651       DFI = DF->find(ExitBlock);
 652       DF->addToFrontier(DFI, NewExit);
 653     }
 654   }
 655   LPM->deleteSimpleAnalysisValue(loopPreheader->getTerminator(), L);
 656   loopPreheader->getTerminator()->eraseFromParent();
 657
 658   // We need to reprocess this loop, it could be unswitched again.
 659   redoLoop = true;
 660
 661   // Now that we know that the loop is never entered when this condition is a
 662   // particular value, rewrite the loop with this info.  We know that this will
 663   // at least eliminate the old branch.
 664   RewriteLoopBodyWithConditionConstant(L, Cond, Val, false);
 665   ++NumTrivial;
 666 }
 667
 668 /// ReplaceLoopExternalDFMember -
 669 /// If BB's dominance frontier  has a member that is not part of loop L then
 670 /// remove it. Add NewDFMember in BB's dominance frontier.
 671 void LoopUnswitch::ReplaceLoopExternalDFMember(Loop *L, BasicBlock *BB,
 672                                                BasicBlock *NewDFMember) {
 673
 674   DominanceFrontier::iterator DFI = DF->find(BB);
 675   if (DFI == DF->end())
 676     return;
 677
 678   DominanceFrontier::DomSetType &DFSet = DFI->second;
 679   for (DominanceFrontier::DomSetType::iterator DI = DFSet.begin(),
 680          DE = DFSet.end(); DI != DE;) {
 681     BasicBlock *B = *DI++;
 682     if (L->contains(B))
 683       continue;
 684
 685     DF->removeFromFrontier(DFI, B);
 686     LoopDF.insert(B);
 687   }
 688
 689   DF->addToFrontier(DFI, NewDFMember);
 690 }
 691
 692 /// SplitExitEdges - Split all of the edges from inside the loop to their exit
 693 /// blocks.  Update the appropriate Phi nodes as we do so.
 694 void LoopUnswitch::SplitExitEdges(Loop *L,
 695                                  const SmallVector<BasicBlock *, 8> &ExitBlocks,
 696                                   SmallVector<BasicBlock *, 8> &MiddleBlocks) {
 697
 698   for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
 699     BasicBlock *ExitBlock = ExitBlocks[i];
 700     std::vector<BasicBlock*> Preds(pred_begin(ExitBlock), pred_end(ExitBlock));
 701
 702     for (unsigned j = 0, e = Preds.size(); j != e; ++j) {
 703       BasicBlock* MiddleBlock = SplitEdge(Preds[j], ExitBlock, this);
 704       MiddleBlocks.push_back(MiddleBlock);
 705       BasicBlock* StartBlock = Preds[j];
 706       BasicBlock* EndBlock;
 707       if (MiddleBlock->getSinglePredecessor() == ExitBlock) {
 708         EndBlock = MiddleBlock;
 709         MiddleBlock = EndBlock->getSinglePredecessor();;
 710       } else {
 711         EndBlock = ExitBlock;
 712       }
 713
 714       OrigLoopExitMap[StartBlock] = EndBlock;
 715
 716       std::set<PHINode*> InsertedPHIs;
 717       PHINode* OldLCSSA = 0;
 718       for (BasicBlock::iterator I = EndBlock->begin();
 719            (OldLCSSA = dyn_cast<PHINode>(I)); ++I) {
 720         Value* OldValue = OldLCSSA->getIncomingValueForBlock(MiddleBlock);
 721         PHINode* NewLCSSA = PHINode::Create(OldLCSSA->getType(),
 722                                             OldLCSSA->getName() + ".us-lcssa",
 723                                             MiddleBlock->getTerminator());
 724         NewLCSSA->addIncoming(OldValue, StartBlock);
 725         OldLCSSA->setIncomingValue(OldLCSSA->getBasicBlockIndex(MiddleBlock),
 726                                    NewLCSSA);
 727         InsertedPHIs.insert(NewLCSSA);
 728       }
 729
 730       BasicBlock::iterator InsertPt = EndBlock->getFirstNonPHI();
 731       for (BasicBlock::iterator I = MiddleBlock->begin();
 732          (OldLCSSA = dyn_cast<PHINode>(I)) && InsertedPHIs.count(OldLCSSA) == 0;
 733          ++I) {
 734         PHINode *NewLCSSA = PHINode::Create(OldLCSSA->getType(),
 735                                             OldLCSSA->getName() + ".us-lcssa",
 736                                             InsertPt);
 737         OldLCSSA->replaceAllUsesWith(NewLCSSA);
 738         NewLCSSA->addIncoming(OldLCSSA, MiddleBlock);
 739       }
 740
 741       if (DF && DT) {
 742         // StartBlock -- > MiddleBlock -- > EndBlock
 743         // StartBlock is loop exiting block. EndBlock will become merge point
 744         // of two loop exits after loop unswitch.
 745
 746         // If StartBlock's DF member includes a block that is not loop member
 747         // then replace that DF member with EndBlock.
 748
 749         // If MiddleBlock's DF member includes a block that is not loop member
 750         // tnen replace that DF member with EndBlock.
 751
 752         ReplaceLoopExternalDFMember(L, StartBlock, EndBlock);
 753         ReplaceLoopExternalDFMember(L, MiddleBlock, EndBlock);
 754       }
 755     }
 756   }
 757
 758 }
 759
 760 /// addBBToDomFrontier - Helper function. Insert DFBB in Basic Block BB's
 761 /// dominance frontier using iterator DFI.
 762 static void addBBToDomFrontier(DominanceFrontier &DF,
 763                                DominanceFrontier::iterator &DFI,
 764                                BasicBlock *BB, BasicBlock *DFBB) {
 765   if (DFI != DF.end()) {
 766     DF.addToFrontier(DFI, DFBB);
 767     return;
 768   }
 769
 770   DominanceFrontier::DomSetType NSet;
 771   NSet.insert(DFBB);
 772   DF.addBasicBlock(BB, NSet);
 773   DFI = DF.find(BB);
 774 }
 775
 776 /// UnswitchNontrivialCondition - We determined that the loop is profitable
 777 /// to unswitch when LIC equal Val.  Split it into loop versions and test the
 778 /// condition outside of either loop.  Return the loops created as Out1/Out2.
 779 void LoopUnswitch::UnswitchNontrivialCondition(Value *LIC, Constant *Val,
 780                                                Loop *L) {
 781   Function *F = loopHeader->getParent();
 782   DOUT << "loop-unswitch: Unswitching loop %"
 783        << loopHeader->getName() << " [" << L->getBlocks().size()
 784        << " blocks] in Function " << F->getName()
 785        << " when '" << *Val << "' == " << *LIC << "\n";
 786
 787   LoopBlocks.clear();
 788   NewBlocks.clear();
 789
 790   // First step, split the preheader and exit blocks, and add these blocks to
 791   // the LoopBlocks list.
 792   BasicBlock *NewPreheader = SplitEdge(loopPreheader, loopHeader, this);
 793   LoopBlocks.push_back(NewPreheader);
 794
 795   // We want the loop to come after the preheader, but before the exit blocks.
 796   LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
 797
 798   SmallVector<BasicBlock*, 8> ExitBlocks;
 799   L->getUniqueExitBlocks(ExitBlocks);
 800
 801   // Split all of the edges from inside the loop to their exit blocks.  Update
 802   // the appropriate Phi nodes as we do so.
 803   SmallVector<BasicBlock *,8> MiddleBlocks;
 804   SplitExitEdges(L, ExitBlocks, MiddleBlocks);
 805
 806   // The exit blocks may have been changed due to edge splitting, recompute.
 807   ExitBlocks.clear();
 808   L->getUniqueExitBlocks(ExitBlocks);
 809
 810   // Add exit blocks to the loop blocks.
 811   LoopBlocks.insert(LoopBlocks.end(), ExitBlocks.begin(), ExitBlocks.end());
 812
 813   // Next step, clone all of the basic blocks that make up the loop (including
 814   // the loop preheader and exit blocks), keeping track of the mapping between
 815   // the instructions and blocks.
 816   NewBlocks.reserve(LoopBlocks.size());
 817   DenseMap<const Value*, Value*> ValueMap;
 818   for (unsigned i = 0, e = LoopBlocks.size(); i != e; ++i) {
 819     BasicBlock *New = CloneBasicBlock(LoopBlocks[i], ValueMap, ".us", F);
 820     NewBlocks.push_back(New);
 821     ValueMap[LoopBlocks[i]] = New;  // Keep the BB mapping.
 822     LPM->cloneBasicBlockSimpleAnalysis(LoopBlocks[i], New, L);
 823   }
 824
 825   // OutSiders are basic block that are dominated by original header and
 826   // at the same time they are not part of loop.
 827   SmallPtrSet<BasicBlock *, 8> OutSiders;
 828   if (DT) {
 829     DomTreeNode *OrigHeaderNode = DT->getNode(loopHeader);
 830     for(std::vector<DomTreeNode*>::iterator DI = OrigHeaderNode->begin(),
 831           DE = OrigHeaderNode->end();  DI != DE; ++DI) {
 832       BasicBlock *B = (*DI)->getBlock();
 833
 834       DenseMap<const Value*, Value*>::iterator VI = ValueMap.find(B);
 835       if (VI == ValueMap.end())
 836         OutSiders.insert(B);
 837     }
 838   }
 839
 840   // Splice the newly inserted blocks into the function right before the
 841   // original preheader.
 842   F->getBasicBlockList().splice(LoopBlocks[0], F->getBasicBlockList(),
 843                                 NewBlocks[0], F->end());
 844
 845   // Now we create the new Loop object for the versioned loop.
 846   Loop *NewLoop = CloneLoop(L, L->getParentLoop(), ValueMap, LI, LPM);
 847   Loop *ParentLoop = L->getParentLoop();
 848   if (ParentLoop) {
 849     // Make sure to add the cloned preheader and exit blocks to the parent loop
 850     // as well.
 851     ParentLoop->addBasicBlockToLoop(NewBlocks[0], LI->getBase());
 852   }
 853
 854   for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
 855     BasicBlock *NewExit = cast<BasicBlock>(ValueMap[ExitBlocks[i]]);
 856     // The new exit block should be in the same loop as the old one.
 857     if (Loop *ExitBBLoop = LI->getLoopFor(ExitBlocks[i]))
 858       ExitBBLoop->addBasicBlockToLoop(NewExit, LI->getBase());
 859
 860     assert(NewExit->getTerminator()->getNumSuccessors() == 1 &&
 861            "Exit block should have been split to have one successor!");
 862     BasicBlock *ExitSucc = NewExit->getTerminator()->getSuccessor(0);
 863
 864     // If the successor of the exit block had PHI nodes, add an entry for
 865     // NewExit.
 866     PHINode *PN;
 867     for (BasicBlock::iterator I = ExitSucc->begin();
 868          (PN = dyn_cast<PHINode>(I)); ++I) {
 869       Value *V = PN->getIncomingValueForBlock(ExitBlocks[i]);
 870       DenseMap<const Value *, Value*>::iterator It = ValueMap.find(V);
 871       if (It != ValueMap.end()) V = It->second;
 872       PN->addIncoming(V, NewExit);
 873     }
 874   }
 875
 876   // Rewrite the code to refer to itself.
 877   for (unsigned i = 0, e = NewBlocks.size(); i != e; ++i)
 878     for (BasicBlock::iterator I = NewBlocks[i]->begin(),
 879            E = NewBlocks[i]->end(); I != E; ++I)
 880       RemapInstruction(I, ValueMap);
 881
 882   // Rewrite the original preheader to select between versions of the loop.
 883   BranchInst *OldBR = cast<BranchInst>(loopPreheader->getTerminator());
 884   assert(OldBR->isUnconditional() && OldBR->getSuccessor(0) == LoopBlocks[0] &&
 885          "Preheader splitting did not work correctly!");
 886
 887   // Emit the new branch that selects between the two versions of this loop.
 888   EmitPreheaderBranchOnCondition(LIC, Val, NewBlocks[0], LoopBlocks[0], OldBR);
 889   LPM->deleteSimpleAnalysisValue(OldBR, L);
 890   OldBR->eraseFromParent();
 891
 892   // Update dominator info
 893   if (DF && DT) {
 894
 895     SmallVector<BasicBlock *,4> ExitingBlocks;
 896     L->getExitingBlocks(ExitingBlocks);
 897
 898     // Clone dominator info for all cloned basic block.
 899     for (unsigned i = 0, e = LoopBlocks.size(); i != e; ++i) {
 900       BasicBlock *LBB = LoopBlocks[i];
 901       BasicBlock *NBB = NewBlocks[i];
 902       CloneDomInfo(NBB, LBB, NewPreheader, loopPreheader,
 903                    loopHeader, DT, DF, ValueMap);
 904
 905       //   If LBB's dominance frontier includes DFMember
 906       //      such that DFMember is also a member of LoopDF then
 907       //         - Remove DFMember from LBB's dominance frontier
 908       //         - Copy loop exiting blocks', that are dominated by BB,
 909       //           dominance frontier member in BB's dominance frontier
 910
 911       DominanceFrontier::iterator LBBI = DF->find(LBB);
 912       DominanceFrontier::iterator NBBI = DF->find(NBB);
 913       if (LBBI == DF->end())
 914         continue;
 915
 916       DominanceFrontier::DomSetType &LBSet = LBBI->second;
 917       for (DominanceFrontier::DomSetType::iterator LI = LBSet.begin(),
 918              LE = LBSet.end(); LI != LE; /* NULL */) {
 919         BasicBlock *B = *LI++;
 920         if (B == LBB && B == loopHeader)
 921           continue;
 922         bool removeB = false;
 923         if (!LoopDF.count(B))
 924           continue;
 925
 926         // If LBB dominates loop exits then insert loop exit block's DF
 927         // into B's DF.
 928         for(SmallVector<BasicBlock *, 4>::iterator
 929               LExitI = ExitingBlocks.begin(),
 930               LExitE = ExitingBlocks.end(); LExitI != LExitE; ++LExitI) {
 931           BasicBlock *E = *LExitI;
 932
 933           if (!DT->dominates(LBB,E))
 934             continue;
 935
 936           DenseMap<BasicBlock *, BasicBlock *>::iterator DFBI =
 937             OrigLoopExitMap.find(E);
 938           if (DFBI == OrigLoopExitMap.end())
 939             continue;
 940
 941           BasicBlock *DFB = DFBI->second;
 942           DF->addToFrontier(LBBI, DFB);
 943           DF->addToFrontier(NBBI, DFB);
 944           removeB = true;
 945         }
 946
 947         // If B's replacement is inserted in DF then now is the time to remove
 948         // B.
 949         if (removeB) {
 950           DF->removeFromFrontier(LBBI, B);
 951           if (L->contains(B))
 952             DF->removeFromFrontier(NBBI, cast<BasicBlock>(ValueMap[B]));
 953           else
 954             DF->removeFromFrontier(NBBI, B);
 955         }
 956       }
 957
 958     }
 959
 960     // MiddleBlocks are dominated by original pre header. SplitEdge updated
 961     // MiddleBlocks' dominance frontier appropriately.
 962     for (unsigned i = 0, e = MiddleBlocks.size(); i != e; ++i) {
 963       BasicBlock *MBB = MiddleBlocks[i];
 964       if (!MBB->getSinglePredecessor())
 965         DT->changeImmediateDominator(MBB, loopPreheader);
 966     }
 967
 968     // All Outsiders are now dominated by original pre header.
 969     for (SmallPtrSet<BasicBlock *, 8>::iterator OI = OutSiders.begin(),
 970            OE = OutSiders.end(); OI != OE; ++OI) {
 971       BasicBlock *OB = *OI;
 972       DT->changeImmediateDominator(OB, loopPreheader);
 973     }
 974
 975     // New loop headers are dominated by original preheader
 976     DT->changeImmediateDominator(NewBlocks[0], loopPreheader);
 977     DT->changeImmediateDominator(LoopBlocks[0], loopPreheader);
 978   }
 979
 980   LoopProcessWorklist.push_back(NewLoop);
 981   redoLoop = true;
 982
 983   // Now we rewrite the original code to know that the condition is true and the
 984   // new code to know that the condition is false.
 985   RewriteLoopBodyWithConditionConstant(L      , LIC, Val, false);
 986
 987   // It's possible that simplifying one loop could cause the other to be
 988   // deleted.  If so, don't simplify it.
 989   if (!LoopProcessWorklist.empty() && LoopProcessWorklist.back() == NewLoop)
 990     RewriteLoopBodyWithConditionConstant(NewLoop, LIC, Val, true);
 991 }
 992
 993 /// RemoveFromWorklist - Remove all instances of I from the worklist vector
 994 /// specified.
 995 static void RemoveFromWorklist(Instruction *I,
 996                                std::vector<Instruction*> &Worklist) {
 997   std::vector<Instruction*>::iterator WI = std::find(Worklist.begin(),
 998                                                      Worklist.end(), I);
 999   while (WI != Worklist.end()) {
1000     unsigned Offset = WI-Worklist.begin();
1001     Worklist.erase(WI);
1002     WI = std::find(Worklist.begin()+Offset, Worklist.end(), I);
1003   }
1004 }
1005
1006 /// ReplaceUsesOfWith - When we find that I really equals V, remove I from the
1007 /// program, replacing all uses with V and update the worklist.
1008 static void ReplaceUsesOfWith(Instruction *I, Value *V,
1009                               std::vector<Instruction*> &Worklist,
1010                               Loop *L, LPPassManager *LPM) {
1011   DOUT << "Replace with '" << *V << "': " << *I;
1012
1013   // Add uses to the worklist, which may be dead now.
1014   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1015     if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1016       Worklist.push_back(Use);
1017
1018   // Add users to the worklist which may be simplified now.
1019   for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
1020        UI != E; ++UI)
1021     Worklist.push_back(cast<Instruction>(*UI));
1022   LPM->deleteSimpleAnalysisValue(I, L);
1023   RemoveFromWorklist(I, Worklist);
1024   I->replaceAllUsesWith(V);
1025   I->eraseFromParent();
1026   ++NumSimplify;
1027 }
1028
1029 /// RemoveBlockIfDead - If the specified block is dead, remove it, update loop
1030 /// information, and remove any dead successors it has.
1031 ///
1032 void LoopUnswitch::RemoveBlockIfDead(BasicBlock *BB,
1033                                      std::vector<Instruction*> &Worklist,
1034                                      Loop *L) {
1035   if (pred_begin(BB) != pred_end(BB)) {
1036     // This block isn't dead, since an edge to BB was just removed, see if there
1037     // are any easy simplifications we can do now.
1038     if (BasicBlock *Pred = BB->getSinglePredecessor()) {
1039       // If it has one pred, fold phi nodes in BB.
1040       while (isa<PHINode>(BB->begin()))
1041         ReplaceUsesOfWith(BB->begin(),
1042                           cast<PHINode>(BB->begin())->getIncomingValue(0),
1043                           Worklist, L, LPM);
1044
1045       // If this is the header of a loop and the only pred is the latch, we now
1046       // have an unreachable loop.
1047       if (Loop *L = LI->getLoopFor(BB))
1048         if (loopHeader == BB && L->contains(Pred)) {
1049           // Remove the branch from the latch to the header block, this makes
1050           // the header dead, which will make the latch dead (because the header
1051           // dominates the latch).
1052           LPM->deleteSimpleAnalysisValue(Pred->getTerminator(), L);
1053           Pred->getTerminator()->eraseFromParent();
1054           new UnreachableInst(Pred);
1055
1056           // The loop is now broken, remove it from LI.
1057           RemoveLoopFromHierarchy(L);
1058
1059           // Reprocess the header, which now IS dead.
1060           RemoveBlockIfDead(BB, Worklist, L);
1061           return;
1062         }
1063
1064       // If pred ends in a uncond branch, add uncond branch to worklist so that
1065       // the two blocks will get merged.
1066       if (BranchInst *BI = dyn_cast<BranchInst>(Pred->getTerminator()))
1067         if (BI->isUnconditional())
1068           Worklist.push_back(BI);
1069     }
1070     return;
1071   }
1072
1073   DOUT << "Nuking dead block: " << *BB;
1074
1075   // Remove the instructions in the basic block from the worklist.
1076   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1077     RemoveFromWorklist(I, Worklist);
1078
1079     // Anything that uses the instructions in this basic block should have their
1080     // uses replaced with undefs.
1081     if (!I->use_empty())
1082       I->replaceAllUsesWith(UndefValue::get(I->getType()));
1083   }
1084
1085   // If this is the edge to the header block for a loop, remove the loop and
1086   // promote all subloops.
1087   if (Loop *BBLoop = LI->getLoopFor(BB)) {
1088     if (BBLoop->getLoopLatch() == BB)
1089       RemoveLoopFromHierarchy(BBLoop);
1090   }
1091
1092   // Remove the block from the loop info, which removes it from any loops it
1093   // was in.
1094   LI->removeBlock(BB);
1095
1096
1097   // Remove phi node entries in successors for this block.
1098   TerminatorInst *TI = BB->getTerminator();
1099   std::vector<BasicBlock*> Succs;
1100   for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i) {
1101     Succs.push_back(TI->getSuccessor(i));
1102     TI->getSuccessor(i)->removePredecessor(BB);
1103   }
1104
1105   // Unique the successors, remove anything with multiple uses.
1106   std::sort(Succs.begin(), Succs.end());
1107   Succs.erase(std::unique(Succs.begin(), Succs.end()), Succs.end());
1108
1109   // Remove the basic block, including all of the instructions contained in it.
1110   LPM->deleteSimpleAnalysisValue(BB, L);
1111   BB->eraseFromParent();
1112   // Remove successor blocks here that are not dead, so that we know we only
1113   // have dead blocks in this list.  Nondead blocks have a way of becoming dead,
1114   // then getting removed before we revisit them, which is badness.
1115   //
1116   for (unsigned i = 0; i != Succs.size(); ++i)
1117     if (pred_begin(Succs[i]) != pred_end(Succs[i])) {
1118       // One exception is loop headers.  If this block was the preheader for a
1119       // loop, then we DO want to visit the loop so the loop gets deleted.
1120       // We know that if the successor is a loop header, that this loop had to
1121       // be the preheader: the case where this was the latch block was handled
1122       // above and headers can only have two predecessors.
1123       if (!LI->isLoopHeader(Succs[i])) {
1124         Succs.erase(Succs.begin()+i);
1125         --i;
1126       }
1127     }
1128
1129   for (unsigned i = 0, e = Succs.size(); i != e; ++i)
1130     RemoveBlockIfDead(Succs[i], Worklist, L);
1131 }
1132
1133 /// RemoveLoopFromHierarchy - We have discovered that the specified loop has
1134 /// become unwrapped, either because the backedge was deleted, or because the
1135 /// edge into the header was removed.  If the edge into the header from the
1136 /// latch block was removed, the loop is unwrapped but subloops are still alive,
1137 /// so they just reparent loops.  If the loops are actually dead, they will be
1138 /// removed later.
1139 void LoopUnswitch::RemoveLoopFromHierarchy(Loop *L) {
1140   LPM->deleteLoopFromQueue(L);
1141   RemoveLoopFromWorklist(L);
1142 }
1143
1144
1145
1146 // RewriteLoopBodyWithConditionConstant - We know either that the value LIC has
1147 // the value specified by Val in the specified loop, or we know it does NOT have
1148 // that value.  Rewrite any uses of LIC or of properties correlated to it.
1149 void LoopUnswitch::RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
1150                                                         Constant *Val,
1151                                                         bool IsEqual) {
1152   assert(!isa<Constant>(LIC) && "Why are we unswitching on a constant?");
1153
1154   // FIXME: Support correlated properties, like:
1155   //  for (...)
1156   //    if (li1 < li2)
1157   //      ...
1158   //    if (li1 > li2)
1159   //      ...
1160
1161   // FOLD boolean conditions (X|LIC), (X&LIC).  Fold conditional branches,
1162   // selects, switches.
1163   std::vector<User*> Users(LIC->use_begin(), LIC->use_end());
1164   std::vector<Instruction*> Worklist;
1165
1166   // If we know that LIC == Val, or that LIC == NotVal, just replace uses of LIC
1167   // in the loop with the appropriate one directly.
1168   if (IsEqual || (isa<ConstantInt>(Val) && Val->getType() == Type::Int1Ty)) {
1169     Value *Replacement;
1170     if (IsEqual)
1171       Replacement = Val;
1172     else
1173       Replacement = ConstantInt::get(Type::Int1Ty,
1174                                      !cast<ConstantInt>(Val)->getZExtValue());
1175
1176     for (unsigned i = 0, e = Users.size(); i != e; ++i)
1177       if (Instruction *U = cast<Instruction>(Users[i])) {
1178         if (!L->contains(U->getParent()))
1179           continue;
1180         U->replaceUsesOfWith(LIC, Replacement);
1181         Worklist.push_back(U);
1182       }
1183   } else {
1184     // Otherwise, we don't know the precise value of LIC, but we do know that it
1185     // is certainly NOT "Val".  As such, simplify any uses in the loop that we
1186     // can.  This case occurs when we unswitch switch statements.
1187     for (unsigned i = 0, e = Users.size(); i != e; ++i)
1188       if (Instruction *U = cast<Instruction>(Users[i])) {
1189         if (!L->contains(U->getParent()))
1190           continue;
1191
1192         Worklist.push_back(U);
1193
1194         // If we know that LIC is not Val, use this info to simplify code.
1195         if (SwitchInst *SI = dyn_cast<SwitchInst>(U)) {
1196           for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i) {
1197             if (SI->getCaseValue(i) == Val) {
1198               // Found a dead case value.  Don't remove PHI nodes in the
1199               // successor if they become single-entry, those PHI nodes may
1200               // be in the Users list.
1201
1202               // FIXME: This is a hack.  We need to keep the successor around
1203               // and hooked up so as to preserve the loop structure, because
1204               // trying to update it is complicated.  So instead we preserve the
1205               // loop structure and put the block on an dead code path.
1206
1207               BasicBlock *SISucc = SI->getSuccessor(i);
1208               BasicBlock* Old = SI->getParent();
1209               BasicBlock* Split = SplitBlock(Old, SI, this);
1210
1211               Instruction* OldTerm = Old->getTerminator();
1212               BranchInst::Create(Split, SISucc,
1213                                  ConstantInt::getTrue(), OldTerm);
1214
1215               if (DT) {
1216                 // Now, SISucc is dominated by Old.
1217                 DT->changeImmediateDominator(SISucc, Old);
1218                 if (DF) {
1219                   // Now, Split does not dominate SISucc.
1220                   // SISucc is the only member in Split's DF.
1221                   DominanceFrontier::iterator S_DFI = DF->find(Split);
1222                   if (S_DFI != DF->end())
1223                     S_DFI->second.clear();
1224                   addBBToDomFrontier(*DF, S_DFI, Split, SISucc);
1225                 }
1226               }
1227
1228               LPM->deleteSimpleAnalysisValue(Old->getTerminator(), L);
1229               Old->getTerminator()->eraseFromParent();
1230
1231               PHINode *PN;
1232               for (BasicBlock::iterator II = SISucc->begin();
1233                    (PN = dyn_cast<PHINode>(II)); ++II) {
1234                 Value *InVal = PN->removeIncomingValue(Split, false);
1235                 PN->addIncoming(InVal, Old);
1236               }
1237
1238               SI->removeCase(i);
1239               break;
1240             }
1241           }
1242         }
1243
1244         // TODO: We could do other simplifications, for example, turning
1245         // LIC == Val -> false.
1246       }
1247   }
1248
1249   SimplifyCode(Worklist, L);
1250 }
1251
1252 /// SimplifyCode - Okay, now that we have simplified some instructions in the
1253 /// loop, walk over it and constant prop, dce, and fold control flow where
1254 /// possible.  Note that this is effectively a very simple loop-structure-aware
1255 /// optimizer.  During processing of this loop, L could very well be deleted, so
1256 /// it must not be used.
1257 ///
1258 /// FIXME: When the loop optimizer is more mature, separate this out to a new
1259 /// pass.
1260 ///
1261 void LoopUnswitch::SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L) {
1262   while (!Worklist.empty()) {
1263     Instruction *I = Worklist.back();
1264     Worklist.pop_back();
1265
1266     // Simple constant folding.
1267     if (Constant *C = ConstantFoldInstruction(I)) {
1268       ReplaceUsesOfWith(I, C, Worklist, L, LPM);
1269       continue;
1270     }
1271
1272     // Simple DCE.
1273     if (isInstructionTriviallyDead(I)) {
1274       DOUT << "Remove dead instruction '" << *I;
1275
1276       // Add uses to the worklist, which may be dead now.
1277       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1278         if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1279           Worklist.push_back(Use);
1280       LPM->deleteSimpleAnalysisValue(I, L);
1281       RemoveFromWorklist(I, Worklist);
1282       I->eraseFromParent();
1283       ++NumSimplify;
1284       continue;
1285     }
1286
1287     // Special case hacks that appear commonly in unswitched code.
1288     switch (I->getOpcode()) {
1289     case Instruction::Select:
1290       if (ConstantInt *CB = dyn_cast<ConstantInt>(I->getOperand(0))) {
1291         ReplaceUsesOfWith(I, I->getOperand(!CB->getZExtValue()+1), Worklist, L,
1292                           LPM);
1293         continue;
1294       }
1295       break;
1296     case Instruction::And:
1297       if (isa<ConstantInt>(I->getOperand(0)) &&
1298           I->getOperand(0)->getType() == Type::Int1Ty)   // constant -> RHS
1299         cast<BinaryOperator>(I)->swapOperands();
1300       if (ConstantInt *CB = dyn_cast<ConstantInt>(I->getOperand(1)))
1301         if (CB->getType() == Type::Int1Ty) {
1302           if (CB->isOne())      // X & 1 -> X
1303             ReplaceUsesOfWith(I, I->getOperand(0), Worklist, L, LPM);
1304           else                  // X & 0 -> 0
1305             ReplaceUsesOfWith(I, I->getOperand(1), Worklist, L, LPM);
1306           continue;
1307         }
1308       break;
1309     case Instruction::Or:
1310       if (isa<ConstantInt>(I->getOperand(0)) &&
1311           I->getOperand(0)->getType() == Type::Int1Ty)   // constant -> RHS
1312         cast<BinaryOperator>(I)->swapOperands();
1313       if (ConstantInt *CB = dyn_cast<ConstantInt>(I->getOperand(1)))
1314         if (CB->getType() == Type::Int1Ty) {
1315           if (CB->isOne())   // X | 1 -> 1
1316             ReplaceUsesOfWith(I, I->getOperand(1), Worklist, L, LPM);
1317           else                  // X | 0 -> X
1318             ReplaceUsesOfWith(I, I->getOperand(0), Worklist, L, LPM);
1319           continue;
1320         }
1321       break;
1322     case Instruction::Br: {
1323       BranchInst *BI = cast<BranchInst>(I);
1324       if (BI->isUnconditional()) {
1325         // If BI's parent is the only pred of the successor, fold the two blocks
1326         // together.
1327         BasicBlock *Pred = BI->getParent();
1328         BasicBlock *Succ = BI->getSuccessor(0);
1329         BasicBlock *SinglePred = Succ->getSinglePredecessor();
1330         if (!SinglePred) continue;  // Nothing to do.
1331         assert(SinglePred == Pred && "CFG broken");
1332
1333         DOUT << "Merging blocks: " << Pred->getName() << " <- "
1334              << Succ->getName() << "\n";
1335
1336         // Resolve any single entry PHI nodes in Succ.
1337         while (PHINode *PN = dyn_cast<PHINode>(Succ->begin()))
1338           ReplaceUsesOfWith(PN, PN->getIncomingValue(0), Worklist, L, LPM);
1339
1340         // Move all of the successor contents from Succ to Pred.
1341         Pred->getInstList().splice(BI, Succ->getInstList(), Succ->begin(),
1342                                    Succ->end());
1343         LPM->deleteSimpleAnalysisValue(BI, L);
1344         BI->eraseFromParent();
1345         RemoveFromWorklist(BI, Worklist);
1346
1347         // If Succ has any successors with PHI nodes, update them to have
1348         // entries coming from Pred instead of Succ.
1349         Succ->replaceAllUsesWith(Pred);
1350
1351         // Remove Succ from the loop tree.
1352         LI->removeBlock(Succ);
1353         LPM->deleteSimpleAnalysisValue(Succ, L);
1354         Succ->eraseFromParent();
1355         ++NumSimplify;
1356       } else if (ConstantInt *CB = dyn_cast<ConstantInt>(BI->getCondition())){
1357         // Conditional branch.  Turn it into an unconditional branch, then
1358         // remove dead blocks.
1359         break;  // FIXME: Enable.
1360
1361         DOUT << "Folded branch: " << *BI;
1362         BasicBlock *DeadSucc = BI->getSuccessor(CB->getZExtValue());
1363         BasicBlock *LiveSucc = BI->getSuccessor(!CB->getZExtValue());
1364         DeadSucc->removePredecessor(BI->getParent(), true);
1365         Worklist.push_back(BranchInst::Create(LiveSucc, BI));
1366         LPM->deleteSimpleAnalysisValue(BI, L);
1367         BI->eraseFromParent();
1368         RemoveFromWorklist(BI, Worklist);
1369         ++NumSimplify;
1370
1371         RemoveBlockIfDead(DeadSucc, Worklist, L);
1372       }
1373       break;
1374     }
1375     }
1376   }
1377 }