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 #include "llvm/Transforms/Scalar.h"
  30 #include "llvm/ADT/STLExtras.h"
  31 #include "llvm/ADT/SmallPtrSet.h"
  32 #include "llvm/ADT/Statistic.h"
  33 #include "llvm/Analysis/AssumptionCache.h"
  34 #include "llvm/Analysis/CodeMetrics.h"
  35 #include "llvm/Analysis/InstructionSimplify.h"
  36 #include "llvm/Analysis/LoopInfo.h"
  37 #include "llvm/Analysis/LoopPass.h"
  38 #include "llvm/Analysis/ScalarEvolution.h"
  39 #include "llvm/Analysis/TargetTransformInfo.h"
  40 #include "llvm/IR/Constants.h"
  41 #include "llvm/IR/DerivedTypes.h"
  42 #include "llvm/IR/Dominators.h"
  43 #include "llvm/IR/Function.h"
  44 #include "llvm/IR/Instructions.h"
  45 #include "llvm/Support/CommandLine.h"
  46 #include "llvm/Support/Debug.h"
  47 #include "llvm/Support/raw_ostream.h"
  48 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  49 #include "llvm/Transforms/Utils/Cloning.h"
  50 #include "llvm/Transforms/Utils/Local.h"
  51 #include <algorithm>
  52 #include <map>
  53 #include <set>
  54 using namespace llvm;
  55
  56 #define DEBUG_TYPE "loop-unswitch"
  57
  58 STATISTIC(NumBranches, "Number of branches unswitched");
  59 STATISTIC(NumSwitches, "Number of switches unswitched");
  60 STATISTIC(NumSelects , "Number of selects unswitched");
  61 STATISTIC(NumTrivial , "Number of unswitches that are trivial");
  62 STATISTIC(NumSimplify, "Number of simplifications of unswitched code");
  63 STATISTIC(TotalInsts,  "Total number of instructions analyzed");
  64
  65 // The specific value of 100 here was chosen based only on intuition and a
  66 // few specific examples.
  67 static cl::opt<unsigned>
  68 Threshold("loop-unswitch-threshold", cl::desc("Max loop size to unswitch"),
  69           cl::init(100), cl::Hidden);
  70
  71 namespace {
  72
  73   class LUAnalysisCache {
  74
  75     typedef DenseMap<const SwitchInst*, SmallPtrSet<const Value *, 8> >
  76       UnswitchedValsMap;
  77
  78     typedef UnswitchedValsMap::iterator UnswitchedValsIt;
  79
  80     struct LoopProperties {
  81       unsigned CanBeUnswitchedCount;
  82       unsigned SizeEstimation;
  83       UnswitchedValsMap UnswitchedVals;
  84     };
  85
  86     // Here we use std::map instead of DenseMap, since we need to keep valid
  87     // LoopProperties pointer for current loop for better performance.
  88     typedef std::map<const Loop*, LoopProperties> LoopPropsMap;
  89     typedef LoopPropsMap::iterator LoopPropsMapIt;
  90
  91     LoopPropsMap LoopsProperties;
  92     UnswitchedValsMap *CurLoopInstructions;
  93     LoopProperties *CurrentLoopProperties;
  94
  95     // Max size of code we can produce on remained iterations.
  96     unsigned MaxSize;
  97
  98     public:
  99
 100       LUAnalysisCache() :
 101         CurLoopInstructions(nullptr), CurrentLoopProperties(nullptr),
 102         MaxSize(Threshold)
 103       {}
 104
 105       // Analyze loop. Check its size, calculate is it possible to unswitch
 106       // it. Returns true if we can unswitch this loop.
 107       bool countLoop(const Loop *L, const TargetTransformInfo &TTI,
 108                      AssumptionCache *AC);
 109
 110       // Clean all data related to given loop.
 111       void forgetLoop(const Loop *L);
 112
 113       // Mark case value as unswitched.
 114       // Since SI instruction can be partly unswitched, in order to avoid
 115       // extra unswitching in cloned loops keep track all unswitched values.
 116       void setUnswitched(const SwitchInst *SI, const Value *V);
 117
 118       // Check was this case value unswitched before or not.
 119       bool isUnswitched(const SwitchInst *SI, const Value *V);
 120
 121       // Clone all loop-unswitch related loop properties.
 122       // Redistribute unswitching quotas.
 123       // Note, that new loop data is stored inside the VMap.
 124       void cloneData(const Loop *NewLoop, const Loop *OldLoop,
 125                      const ValueToValueMapTy &VMap);
 126   };
 127
 128   class LoopUnswitch : public LoopPass {
 129     LoopInfo *LI;  // Loop information
 130     LPPassManager *LPM;
 131     AssumptionCache *AC;
 132
 133     // LoopProcessWorklist - Used to check if second loop needs processing
 134     // after RewriteLoopBodyWithConditionConstant rewrites first loop.
 135     std::vector<Loop*> LoopProcessWorklist;
 136
 137     LUAnalysisCache BranchesInfo;
 138
 139     bool OptimizeForSize;
 140     bool redoLoop;
 141
 142     Loop *currentLoop;
 143     DominatorTree *DT;
 144     BasicBlock *loopHeader;
 145     BasicBlock *loopPreheader;
 146
 147     // LoopBlocks contains all of the basic blocks of the loop, including the
 148     // preheader of the loop, the body of the loop, and the exit blocks of the
 149     // loop, in that order.
 150     std::vector<BasicBlock*> LoopBlocks;
 151     // NewBlocks contained cloned copy of basic blocks from LoopBlocks.
 152     std::vector<BasicBlock*> NewBlocks;
 153
 154   public:
 155     static char ID; // Pass ID, replacement for typeid
 156     explicit LoopUnswitch(bool Os = false) :
 157       LoopPass(ID), OptimizeForSize(Os), redoLoop(false),
 158       currentLoop(nullptr), DT(nullptr), loopHeader(nullptr),
 159       loopPreheader(nullptr) {
 160         initializeLoopUnswitchPass(*PassRegistry::getPassRegistry());
 161       }
 162
 163     bool runOnLoop(Loop *L, LPPassManager &LPM) override;
 164     bool processCurrentLoop();
 165
 166     /// This transformation requires natural loop information & requires that
 167     /// loop preheaders be inserted into the CFG.
 168     ///
 169     void getAnalysisUsage(AnalysisUsage &AU) const override {
 170       AU.addRequired<AssumptionCacheTracker>();
 171       AU.addRequiredID(LoopSimplifyID);
 172       AU.addPreservedID(LoopSimplifyID);
 173       AU.addRequired<LoopInfoWrapperPass>();
 174       AU.addPreserved<LoopInfoWrapperPass>();
 175       AU.addRequiredID(LCSSAID);
 176       AU.addPreservedID(LCSSAID);
 177       AU.addPreserved<DominatorTreeWrapperPass>();
 178       AU.addPreserved<ScalarEvolution>();
 179       AU.addRequired<TargetTransformInfoWrapperPass>();
 180     }
 181
 182   private:
 183
 184     void releaseMemory() override {
 185       BranchesInfo.forgetLoop(currentLoop);
 186     }
 187
 188     void initLoopData() {
 189       loopHeader = currentLoop->getHeader();
 190       loopPreheader = currentLoop->getLoopPreheader();
 191     }
 192
 193     /// Split all of the edges from inside the loop to their exit blocks.
 194     /// Update the appropriate Phi nodes as we do so.
 195     void SplitExitEdges(Loop *L, const SmallVectorImpl<BasicBlock *> &ExitBlocks);
 196
 197     bool UnswitchIfProfitable(Value *LoopCond, Constant *Val);
 198     void UnswitchTrivialCondition(Loop *L, Value *Cond, Constant *Val,
 199                                   BasicBlock *ExitBlock);
 200     void UnswitchNontrivialCondition(Value *LIC, Constant *OnVal, Loop *L);
 201
 202     void RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
 203                                               Constant *Val, bool isEqual);
 204
 205     void EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
 206                                         BasicBlock *TrueDest,
 207                                         BasicBlock *FalseDest,
 208                                         Instruction *InsertPt);
 209
 210     void SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L);
 211     bool IsTrivialUnswitchCondition(Value *Cond, Constant **Val = nullptr,
 212                                     BasicBlock **LoopExit = nullptr);
 213
 214   };
 215 }
 216
 217 // Analyze loop. Check its size, calculate is it possible to unswitch
 218 // it. Returns true if we can unswitch this loop.
 219 bool LUAnalysisCache::countLoop(const Loop *L, const TargetTransformInfo &TTI,
 220                                 AssumptionCache *AC) {
 221
 222   LoopPropsMapIt PropsIt;
 223   bool Inserted;
 224   std::tie(PropsIt, Inserted) =
 225       LoopsProperties.insert(std::make_pair(L, LoopProperties()));
 226
 227   LoopProperties &Props = PropsIt->second;
 228
 229   if (Inserted) {
 230     // New loop.
 231
 232     // Limit the number of instructions to avoid causing significant code
 233     // expansion, and the number of basic blocks, to avoid loops with
 234     // large numbers of branches which cause loop unswitching to go crazy.
 235     // This is a very ad-hoc heuristic.
 236
 237     SmallPtrSet<const Value *, 32> EphValues;
 238     CodeMetrics::collectEphemeralValues(L, AC, EphValues);
 239
 240     // FIXME: This is overly conservative because it does not take into
 241     // consideration code simplification opportunities and code that can
 242     // be shared by the resultant unswitched loops.
 243     CodeMetrics Metrics;
 244     for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
 245          I != E; ++I)
 246       Metrics.analyzeBasicBlock(*I, TTI, EphValues);
 247
 248     Props.SizeEstimation = std::min(Metrics.NumInsts, Metrics.NumBlocks * 5);
 249     Props.CanBeUnswitchedCount = MaxSize / (Props.SizeEstimation);
 250     MaxSize -= Props.SizeEstimation * Props.CanBeUnswitchedCount;
 251
 252     if (Metrics.notDuplicatable) {
 253       DEBUG(dbgs() << "NOT unswitching loop %"
 254                    << L->getHeader()->getName() << ", contents cannot be "
 255                    << "duplicated!\n");
 256       return false;
 257     }
 258   }
 259
 260   if (!Props.CanBeUnswitchedCount) {
 261     DEBUG(dbgs() << "NOT unswitching loop %"
 262                  << L->getHeader()->getName() << ", cost too high: "
 263                  << L->getBlocks().size() << "\n");
 264     return false;
 265   }
 266
 267   // Be careful. This links are good only before new loop addition.
 268   CurrentLoopProperties = &Props;
 269   CurLoopInstructions = &Props.UnswitchedVals;
 270
 271   return true;
 272 }
 273
 274 // Clean all data related to given loop.
 275 void LUAnalysisCache::forgetLoop(const Loop *L) {
 276
 277   LoopPropsMapIt LIt = LoopsProperties.find(L);
 278
 279   if (LIt != LoopsProperties.end()) {
 280     LoopProperties &Props = LIt->second;
 281     MaxSize += Props.CanBeUnswitchedCount * Props.SizeEstimation;
 282     LoopsProperties.erase(LIt);
 283   }
 284
 285   CurrentLoopProperties = nullptr;
 286   CurLoopInstructions = nullptr;
 287 }
 288
 289 // Mark case value as unswitched.
 290 // Since SI instruction can be partly unswitched, in order to avoid
 291 // extra unswitching in cloned loops keep track all unswitched values.
 292 void LUAnalysisCache::setUnswitched(const SwitchInst *SI, const Value *V) {
 293   (*CurLoopInstructions)[SI].insert(V);
 294 }
 295
 296 // Check was this case value unswitched before or not.
 297 bool LUAnalysisCache::isUnswitched(const SwitchInst *SI, const Value *V) {
 298   return (*CurLoopInstructions)[SI].count(V);
 299 }
 300
 301 // Clone all loop-unswitch related loop properties.
 302 // Redistribute unswitching quotas.
 303 // Note, that new loop data is stored inside the VMap.
 304 void LUAnalysisCache::cloneData(const Loop *NewLoop, const Loop *OldLoop,
 305                                 const ValueToValueMapTy &VMap) {
 306
 307   LoopProperties &NewLoopProps = LoopsProperties[NewLoop];
 308   LoopProperties &OldLoopProps = *CurrentLoopProperties;
 309   UnswitchedValsMap &Insts = OldLoopProps.UnswitchedVals;
 310
 311   // Reallocate "can-be-unswitched quota"
 312
 313   --OldLoopProps.CanBeUnswitchedCount;
 314   unsigned Quota = OldLoopProps.CanBeUnswitchedCount;
 315   NewLoopProps.CanBeUnswitchedCount = Quota / 2;
 316   OldLoopProps.CanBeUnswitchedCount = Quota - Quota / 2;
 317
 318   NewLoopProps.SizeEstimation = OldLoopProps.SizeEstimation;
 319
 320   // Clone unswitched values info:
 321   // for new loop switches we clone info about values that was
 322   // already unswitched and has redundant successors.
 323   for (UnswitchedValsIt I = Insts.begin(); I != Insts.end(); ++I) {
 324     const SwitchInst *OldInst = I->first;
 325     Value *NewI = VMap.lookup(OldInst);
 326     const SwitchInst *NewInst = cast_or_null<SwitchInst>(NewI);
 327     assert(NewInst && "All instructions that are in SrcBB must be in VMap.");
 328
 329     NewLoopProps.UnswitchedVals[NewInst] = OldLoopProps.UnswitchedVals[OldInst];
 330   }
 331 }
 332
 333 char LoopUnswitch::ID = 0;
 334 INITIALIZE_PASS_BEGIN(LoopUnswitch, "loop-unswitch", "Unswitch loops",
 335                       false, false)
 336 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass)
 337 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
 338 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
 339 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
 340 INITIALIZE_PASS_DEPENDENCY(LCSSA)
 341 INITIALIZE_PASS_END(LoopUnswitch, "loop-unswitch", "Unswitch loops",
 342                       false, false)
 343
 344 Pass *llvm::createLoopUnswitchPass(bool Os) {
 345   return new LoopUnswitch(Os);
 346 }
 347
 348 /// FindLIVLoopCondition - Cond is a condition that occurs in L.  If it is
 349 /// invariant in the loop, or has an invariant piece, return the invariant.
 350 /// Otherwise, return null.
 351 static Value *FindLIVLoopCondition(Value *Cond, Loop *L, bool &Changed) {
 352
 353   // We started analyze new instruction, increment scanned instructions counter.
 354   ++TotalInsts;
 355
 356   // We can never unswitch on vector conditions.
 357   if (Cond->getType()->isVectorTy())
 358     return nullptr;
 359
 360   // Constants should be folded, not unswitched on!
 361   if (isa<Constant>(Cond)) return nullptr;
 362
 363   // TODO: Handle: br (VARIANT|INVARIANT).
 364
 365   // Hoist simple values out.
 366   if (L->makeLoopInvariant(Cond, Changed))
 367     return Cond;
 368
 369   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Cond))
 370     if (BO->getOpcode() == Instruction::And ||
 371         BO->getOpcode() == Instruction::Or) {
 372       // If either the left or right side is invariant, we can unswitch on this,
 373       // which will cause the branch to go away in one loop and the condition to
 374       // simplify in the other one.
 375       if (Value *LHS = FindLIVLoopCondition(BO->getOperand(0), L, Changed))
 376         return LHS;
 377       if (Value *RHS = FindLIVLoopCondition(BO->getOperand(1), L, Changed))
 378         return RHS;
 379     }
 380
 381   return nullptr;
 382 }
 383
 384 bool LoopUnswitch::runOnLoop(Loop *L, LPPassManager &LPM_Ref) {
 385   if (skipOptnoneFunction(L))
 386     return false;
 387
 388   AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(
 389       *L->getHeader()->getParent());
 390   LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
 391   LPM = &LPM_Ref;
 392   DominatorTreeWrapperPass *DTWP =
 393       getAnalysisIfAvailable<DominatorTreeWrapperPass>();
 394   DT = DTWP ? &DTWP->getDomTree() : nullptr;
 395   currentLoop = L;
 396   Function *F = currentLoop->getHeader()->getParent();
 397   bool Changed = false;
 398   do {
 399     assert(currentLoop->isLCSSAForm(*DT));
 400     redoLoop = false;
 401     Changed |= processCurrentLoop();
 402   } while(redoLoop);
 403
 404   if (Changed) {
 405     // FIXME: Reconstruct dom info, because it is not preserved properly.
 406     if (DT)
 407       DT->recalculate(*F);
 408   }
 409   return Changed;
 410 }
 411
 412 /// processCurrentLoop - Do actual work and unswitch loop if possible
 413 /// and profitable.
 414 bool LoopUnswitch::processCurrentLoop() {
 415   bool Changed = false;
 416
 417   initLoopData();
 418
 419   // If LoopSimplify was unable to form a preheader, don't do any unswitching.
 420   if (!loopPreheader)
 421     return false;
 422
 423   // Loops with indirectbr cannot be cloned.
 424   if (!currentLoop->isSafeToClone())
 425     return false;
 426
 427   // Without dedicated exits, splitting the exit edge may fail.
 428   if (!currentLoop->hasDedicatedExits())
 429     return false;
 430
 431   LLVMContext &Context = loopHeader->getContext();
 432
 433   // Probably we reach the quota of branches for this loop. If so
 434   // stop unswitching.
 435   if (!BranchesInfo.countLoop(
 436           currentLoop, getAnalysis<TargetTransformInfoWrapperPass>().getTTI(),
 437           AC))
 438     return false;
 439
 440   // Loop over all of the basic blocks in the loop.  If we find an interior
 441   // block that is branching on a loop-invariant condition, we can unswitch this
 442   // loop.
 443   for (Loop::block_iterator I = currentLoop->block_begin(),
 444          E = currentLoop->block_end(); I != E; ++I) {
 445     TerminatorInst *TI = (*I)->getTerminator();
 446     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
 447       // If this isn't branching on an invariant condition, we can't unswitch
 448       // it.
 449       if (BI->isConditional()) {
 450         // See if this, or some part of it, is loop invariant.  If so, we can
 451         // unswitch on it if we desire.
 452         Value *LoopCond = FindLIVLoopCondition(BI->getCondition(),
 453                                                currentLoop, Changed);
 454         if (LoopCond && UnswitchIfProfitable(LoopCond,
 455                                              ConstantInt::getTrue(Context))) {
 456           ++NumBranches;
 457           return true;
 458         }
 459       }
 460     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
 461       Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 462                                              currentLoop, Changed);
 463       unsigned NumCases = SI->getNumCases();
 464       if (LoopCond && NumCases) {
 465         // Find a value to unswitch on:
 466         // FIXME: this should chose the most expensive case!
 467         // FIXME: scan for a case with a non-critical edge?
 468         Constant *UnswitchVal = nullptr;
 469
 470         // Do not process same value again and again.
 471         // At this point we have some cases already unswitched and
 472         // some not yet unswitched. Let's find the first not yet unswitched one.
 473         for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
 474              i != e; ++i) {
 475           Constant *UnswitchValCandidate = i.getCaseValue();
 476           if (!BranchesInfo.isUnswitched(SI, UnswitchValCandidate)) {
 477             UnswitchVal = UnswitchValCandidate;
 478             break;
 479           }
 480         }
 481
 482         if (!UnswitchVal)
 483           continue;
 484
 485         if (UnswitchIfProfitable(LoopCond, UnswitchVal)) {
 486           ++NumSwitches;
 487           return true;
 488         }
 489       }
 490     }
 491
 492     // Scan the instructions to check for unswitchable values.
 493     for (BasicBlock::iterator BBI = (*I)->begin(), E = (*I)->end();
 494          BBI != E; ++BBI)
 495       if (SelectInst *SI = dyn_cast<SelectInst>(BBI)) {
 496         Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 497                                                currentLoop, Changed);
 498         if (LoopCond && UnswitchIfProfitable(LoopCond,
 499                                              ConstantInt::getTrue(Context))) {
 500           ++NumSelects;
 501           return true;
 502         }
 503       }
 504   }
 505   return Changed;
 506 }
 507
 508 /// isTrivialLoopExitBlock - Check to see if all paths from BB exit the
 509 /// loop with no side effects (including infinite loops).
 510 ///
 511 /// If true, we return true and set ExitBB to the block we
 512 /// exit through.
 513 ///
 514 static bool isTrivialLoopExitBlockHelper(Loop *L, BasicBlock *BB,
 515                                          BasicBlock *&ExitBB,
 516                                          std::set<BasicBlock*> &Visited) {
 517   if (!Visited.insert(BB).second) {
 518     // Already visited. Without more analysis, this could indicate an infinite
 519     // loop.
 520     return false;
 521   }
 522   if (!L->contains(BB)) {
 523     // Otherwise, this is a loop exit, this is fine so long as this is the
 524     // first exit.
 525     if (ExitBB) return false;
 526     ExitBB = BB;
 527     return true;
 528   }
 529
 530   // Otherwise, this is an unvisited intra-loop node.  Check all successors.
 531   for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI) {
 532     // Check to see if the successor is a trivial loop exit.
 533     if (!isTrivialLoopExitBlockHelper(L, *SI, ExitBB, Visited))
 534       return false;
 535   }
 536
 537   // Okay, everything after this looks good, check to make sure that this block
 538   // doesn't include any side effects.
 539   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 540     if (I->mayHaveSideEffects())
 541       return false;
 542
 543   return true;
 544 }
 545
 546 /// isTrivialLoopExitBlock - Return true if the specified block unconditionally
 547 /// leads to an exit from the specified loop, and has no side-effects in the
 548 /// process.  If so, return the block that is exited to, otherwise return null.
 549 static BasicBlock *isTrivialLoopExitBlock(Loop *L, BasicBlock *BB) {
 550   std::set<BasicBlock*> Visited;
 551   Visited.insert(L->getHeader());  // Branches to header make infinite loops.
 552   BasicBlock *ExitBB = nullptr;
 553   if (isTrivialLoopExitBlockHelper(L, BB, ExitBB, Visited))
 554     return ExitBB;
 555   return nullptr;
 556 }
 557
 558 /// IsTrivialUnswitchCondition - Check to see if this unswitch condition is
 559 /// trivial: that is, that the condition controls whether or not the loop does
 560 /// anything at all.  If this is a trivial condition, unswitching produces no
 561 /// code duplications (equivalently, it produces a simpler loop and a new empty
 562 /// loop, which gets deleted).
 563 ///
 564 /// If this is a trivial condition, return true, otherwise return false.  When
 565 /// returning true, this sets Cond and Val to the condition that controls the
 566 /// trivial condition: when Cond dynamically equals Val, the loop is known to
 567 /// exit.  Finally, this sets LoopExit to the BB that the loop exits to when
 568 /// Cond == Val.
 569 ///
 570 bool LoopUnswitch::IsTrivialUnswitchCondition(Value *Cond, Constant **Val,
 571                                        BasicBlock **LoopExit) {
 572   BasicBlock *Header = currentLoop->getHeader();
 573   TerminatorInst *HeaderTerm = Header->getTerminator();
 574   LLVMContext &Context = Header->getContext();
 575
 576   BasicBlock *LoopExitBB = nullptr;
 577   if (BranchInst *BI = dyn_cast<BranchInst>(HeaderTerm)) {
 578     // If the header block doesn't end with a conditional branch on Cond, we
 579     // can't handle it.
 580     if (!BI->isConditional() || BI->getCondition() != Cond)
 581       return false;
 582
 583     // Check to see if a successor of the branch is guaranteed to
 584     // exit through a unique exit block without having any
 585     // side-effects.  If so, determine the value of Cond that causes it to do
 586     // this.
 587     if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
 588                                              BI->getSuccessor(0)))) {
 589       if (Val) *Val = ConstantInt::getTrue(Context);
 590     } else if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
 591                                                     BI->getSuccessor(1)))) {
 592       if (Val) *Val = ConstantInt::getFalse(Context);
 593     }
 594   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(HeaderTerm)) {
 595     // If this isn't a switch on Cond, we can't handle it.
 596     if (SI->getCondition() != Cond) return false;
 597
 598     // Check to see if a successor of the switch is guaranteed to go to the
 599     // latch block or exit through a one exit block without having any
 600     // side-effects.  If so, determine the value of Cond that causes it to do
 601     // this.
 602     // Note that we can't trivially unswitch on the default case or
 603     // on already unswitched cases.
 604     for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
 605          i != e; ++i) {
 606       BasicBlock *LoopExitCandidate;
 607       if ((LoopExitCandidate = isTrivialLoopExitBlock(currentLoop,
 608                                                i.getCaseSuccessor()))) {
 609         // Okay, we found a trivial case, remember the value that is trivial.
 610         ConstantInt *CaseVal = i.getCaseValue();
 611
 612         // Check that it was not unswitched before, since already unswitched
 613         // trivial vals are looks trivial too.
 614         if (BranchesInfo.isUnswitched(SI, CaseVal))
 615           continue;
 616         LoopExitBB = LoopExitCandidate;
 617         if (Val) *Val = CaseVal;
 618         break;
 619       }
 620     }
 621   }
 622
 623   // If we didn't find a single unique LoopExit block, or if the loop exit block
 624   // contains phi nodes, this isn't trivial.
 625   if (!LoopExitBB || isa<PHINode>(LoopExitBB->begin()))
 626     return false;   // Can't handle this.
 627
 628   if (LoopExit) *LoopExit = LoopExitBB;
 629
 630   // We already know that nothing uses any scalar values defined inside of this
 631   // loop.  As such, we just have to check to see if this loop will execute any
 632   // side-effecting instructions (e.g. stores, calls, volatile loads) in the
 633   // part of the loop that the code *would* execute.  We already checked the
 634   // tail, check the header now.
 635   for (BasicBlock::iterator I = Header->begin(), E = Header->end(); I != E; ++I)
 636     if (I->mayHaveSideEffects())
 637       return false;
 638   return true;
 639 }
 640
 641 /// UnswitchIfProfitable - We have found that we can unswitch currentLoop when
 642 /// LoopCond == Val to simplify the loop.  If we decide that this is profitable,
 643 /// unswitch the loop, reprocess the pieces, then return true.
 644 bool LoopUnswitch::UnswitchIfProfitable(Value *LoopCond, Constant *Val) {
 645   Function *F = loopHeader->getParent();
 646   Constant *CondVal = nullptr;
 647   BasicBlock *ExitBlock = nullptr;
 648
 649   if (IsTrivialUnswitchCondition(LoopCond, &CondVal, &ExitBlock)) {
 650     // If the condition is trivial, always unswitch. There is no code growth
 651     // for this case.
 652     UnswitchTrivialCondition(currentLoop, LoopCond, CondVal, ExitBlock);
 653     return true;
 654   }
 655
 656   // Check to see if it would be profitable to unswitch current loop.
 657
 658   // Do not do non-trivial unswitch while optimizing for size.
 659   if (OptimizeForSize ||
 660       F->getAttributes().hasAttribute(AttributeSet::FunctionIndex,
 661                                       Attribute::OptimizeForSize))
 662     return false;
 663
 664   UnswitchNontrivialCondition(LoopCond, Val, currentLoop);
 665   return true;
 666 }
 667
 668 /// CloneLoop - Recursively clone the specified loop and all of its children,
 669 /// mapping the blocks with the specified map.
 670 static Loop *CloneLoop(Loop *L, Loop *PL, ValueToValueMapTy &VM,
 671                        LoopInfo *LI, LPPassManager *LPM) {
 672   Loop *New = new Loop();
 673   LPM->insertLoop(New, PL);
 674
 675   // Add all of the blocks in L to the new loop.
 676   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
 677        I != E; ++I)
 678     if (LI->getLoopFor(*I) == L)
 679       New->addBasicBlockToLoop(cast<BasicBlock>(VM[*I]), *LI);
 680
 681   // Add all of the subloops to the new loop.
 682   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
 683     CloneLoop(*I, New, VM, LI, LPM);
 684
 685   return New;
 686 }
 687
 688 /// EmitPreheaderBranchOnCondition - Emit a conditional branch on two values
 689 /// if LIC == Val, branch to TrueDst, otherwise branch to FalseDest.  Insert the
 690 /// code immediately before InsertPt.
 691 void LoopUnswitch::EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
 692                                                   BasicBlock *TrueDest,
 693                                                   BasicBlock *FalseDest,
 694                                                   Instruction *InsertPt) {
 695   // Insert a conditional branch on LIC to the two preheaders.  The original
 696   // code is the true version and the new code is the false version.
 697   Value *BranchVal = LIC;
 698   if (!isa<ConstantInt>(Val) ||
 699       Val->getType() != Type::getInt1Ty(LIC->getContext()))
 700     BranchVal = new ICmpInst(InsertPt, ICmpInst::ICMP_EQ, LIC, Val);
 701   else if (Val != ConstantInt::getTrue(Val->getContext()))
 702     // We want to enter the new loop when the condition is true.
 703     std::swap(TrueDest, FalseDest);
 704
 705   // Insert the new branch.
 706   BranchInst *BI = BranchInst::Create(TrueDest, FalseDest, BranchVal, InsertPt);
 707
 708   // If either edge is critical, split it. This helps preserve LoopSimplify
 709   // form for enclosing loops.
 710   auto Options = CriticalEdgeSplittingOptions(DT, LI).setPreserveLCSSA();
 711   SplitCriticalEdge(BI, 0, Options);
 712   SplitCriticalEdge(BI, 1, Options);
 713 }
 714
 715 /// UnswitchTrivialCondition - Given a loop that has a trivial unswitchable
 716 /// condition in it (a cond branch from its header block to its latch block,
 717 /// where the path through the loop that doesn't execute its body has no
 718 /// side-effects), unswitch it.  This doesn't involve any code duplication, just
 719 /// moving the conditional branch outside of the loop and updating loop info.
 720 void LoopUnswitch::UnswitchTrivialCondition(Loop *L, Value *Cond,
 721                                             Constant *Val,
 722                                             BasicBlock *ExitBlock) {
 723   DEBUG(dbgs() << "loop-unswitch: Trivial-Unswitch loop %"
 724         << loopHeader->getName() << " [" << L->getBlocks().size()
 725         << " blocks] in Function " << L->getHeader()->getParent()->getName()
 726         << " on cond: " << *Val << " == " << *Cond << "\n");
 727
 728   // First step, split the preheader, so that we know that there is a safe place
 729   // to insert the conditional branch.  We will change loopPreheader to have a
 730   // conditional branch on Cond.
 731   BasicBlock *NewPH = SplitEdge(loopPreheader, loopHeader, DT, LI);
 732
 733   // Now that we have a place to insert the conditional branch, create a place
 734   // to branch to: this is the exit block out of the loop that we should
 735   // short-circuit to.
 736
 737   // Split this block now, so that the loop maintains its exit block, and so
 738   // that the jump from the preheader can execute the contents of the exit block
 739   // without actually branching to it (the exit block should be dominated by the
 740   // loop header, not the preheader).
 741   assert(!L->contains(ExitBlock) && "Exit block is in the loop?");
 742   BasicBlock *NewExit = SplitBlock(ExitBlock, ExitBlock->begin(), DT, LI);
 743
 744   // Okay, now we have a position to branch from and a position to branch to,
 745   // insert the new conditional branch.
 746   EmitPreheaderBranchOnCondition(Cond, Val, NewExit, NewPH,
 747                                  loopPreheader->getTerminator());
 748   LPM->deleteSimpleAnalysisValue(loopPreheader->getTerminator(), L);
 749   loopPreheader->getTerminator()->eraseFromParent();
 750
 751   // We need to reprocess this loop, it could be unswitched again.
 752   redoLoop = true;
 753
 754   // Now that we know that the loop is never entered when this condition is a
 755   // particular value, rewrite the loop with this info.  We know that this will
 756   // at least eliminate the old branch.
 757   RewriteLoopBodyWithConditionConstant(L, Cond, Val, false);
 758   ++NumTrivial;
 759 }
 760
 761 /// SplitExitEdges - Split all of the edges from inside the loop to their exit
 762 /// blocks.  Update the appropriate Phi nodes as we do so.
 763 void LoopUnswitch::SplitExitEdges(Loop *L,
 764                                const SmallVectorImpl<BasicBlock *> &ExitBlocks){
 765
 766   for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
 767     BasicBlock *ExitBlock = ExitBlocks[i];
 768     SmallVector<BasicBlock *, 4> Preds(pred_begin(ExitBlock),
 769                                        pred_end(ExitBlock));
 770
 771     // Although SplitBlockPredecessors doesn't preserve loop-simplify in
 772     // general, if we call it on all predecessors of all exits then it does.
 773     SplitBlockPredecessors(ExitBlock, Preds, ".us-lcssa",
 774                            /*AliasAnalysis*/ nullptr, DT, LI,
 775                            /*PreserveLCSSA*/ true);
 776   }
 777 }
 778
 779 /// UnswitchNontrivialCondition - We determined that the loop is profitable
 780 /// to unswitch when LIC equal Val.  Split it into loop versions and test the
 781 /// condition outside of either loop.  Return the loops created as Out1/Out2.
 782 void LoopUnswitch::UnswitchNontrivialCondition(Value *LIC, Constant *Val,
 783                                                Loop *L) {
 784   Function *F = loopHeader->getParent();
 785   DEBUG(dbgs() << "loop-unswitch: Unswitching loop %"
 786         << loopHeader->getName() << " [" << L->getBlocks().size()
 787         << " blocks] in Function " << F->getName()
 788         << " when '" << *Val << "' == " << *LIC << "\n");
 789
 790   if (ScalarEvolution *SE = getAnalysisIfAvailable<ScalarEvolution>())
 791     SE->forgetLoop(L);
 792
 793   LoopBlocks.clear();
 794   NewBlocks.clear();
 795
 796   // First step, split the preheader and exit blocks, and add these blocks to
 797   // the LoopBlocks list.
 798   BasicBlock *NewPreheader = SplitEdge(loopPreheader, loopHeader, DT, LI);
 799   LoopBlocks.push_back(NewPreheader);
 800
 801   // We want the loop to come after the preheader, but before the exit blocks.
 802   LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
 803
 804   SmallVector<BasicBlock*, 8> ExitBlocks;
 805   L->getUniqueExitBlocks(ExitBlocks);
 806
 807   // Split all of the edges from inside the loop to their exit blocks.  Update
 808   // the appropriate Phi nodes as we do so.
 809   SplitExitEdges(L, ExitBlocks);
 810
 811   // The exit blocks may have been changed due to edge splitting, recompute.
 812   ExitBlocks.clear();
 813   L->getUniqueExitBlocks(ExitBlocks);
 814
 815   // Add exit blocks to the loop blocks.
 816   LoopBlocks.insert(LoopBlocks.end(), ExitBlocks.begin(), ExitBlocks.end());
 817
 818   // Next step, clone all of the basic blocks that make up the loop (including
 819   // the loop preheader and exit blocks), keeping track of the mapping between
 820   // the instructions and blocks.
 821   NewBlocks.reserve(LoopBlocks.size());
 822   ValueToValueMapTy VMap;
 823   for (unsigned i = 0, e = LoopBlocks.size(); i != e; ++i) {
 824     BasicBlock *NewBB = CloneBasicBlock(LoopBlocks[i], VMap, ".us", F);
 825
 826     NewBlocks.push_back(NewBB);
 827     VMap[LoopBlocks[i]] = NewBB;  // Keep the BB mapping.
 828     LPM->cloneBasicBlockSimpleAnalysis(LoopBlocks[i], NewBB, L);
 829   }
 830
 831   // Splice the newly inserted blocks into the function right before the
 832   // original preheader.
 833   F->getBasicBlockList().splice(NewPreheader, F->getBasicBlockList(),
 834                                 NewBlocks[0], F->end());
 835
 836   // FIXME: We could register any cloned assumptions instead of clearing the
 837   // whole function's cache.
 838   AC->clear();
 839
 840   // Now we create the new Loop object for the versioned loop.
 841   Loop *NewLoop = CloneLoop(L, L->getParentLoop(), VMap, LI, LPM);
 842
 843   // Recalculate unswitching quota, inherit simplified switches info for NewBB,
 844   // Probably clone more loop-unswitch related loop properties.
 845   BranchesInfo.cloneData(NewLoop, L, VMap);
 846
 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);
 852   }
 853
 854   for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
 855     BasicBlock *NewExit = cast<BasicBlock>(VMap[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);
 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     for (BasicBlock::iterator I = ExitSucc->begin();
 867          PHINode *PN = dyn_cast<PHINode>(I); ++I) {
 868       Value *V = PN->getIncomingValueForBlock(ExitBlocks[i]);
 869       ValueToValueMapTy::iterator It = VMap.find(V);
 870       if (It != VMap.end()) V = It->second;
 871       PN->addIncoming(V, NewExit);
 872     }
 873
 874     if (LandingPadInst *LPad = NewExit->getLandingPadInst()) {
 875       PHINode *PN = PHINode::Create(LPad->getType(), 0, "",
 876                                     ExitSucc->getFirstInsertionPt());
 877
 878       for (pred_iterator I = pred_begin(ExitSucc), E = pred_end(ExitSucc);
 879            I != E; ++I) {
 880         BasicBlock *BB = *I;
 881         LandingPadInst *LPI = BB->getLandingPadInst();
 882         LPI->replaceAllUsesWith(PN);
 883         PN->addIncoming(LPI, BB);
 884       }
 885     }
 886   }
 887
 888   // Rewrite the code to refer to itself.
 889   for (unsigned i = 0, e = NewBlocks.size(); i != e; ++i)
 890     for (BasicBlock::iterator I = NewBlocks[i]->begin(),
 891            E = NewBlocks[i]->end(); I != E; ++I)
 892       RemapInstruction(I, VMap,RF_NoModuleLevelChanges|RF_IgnoreMissingEntries);
 893
 894   // Rewrite the original preheader to select between versions of the loop.
 895   BranchInst *OldBR = cast<BranchInst>(loopPreheader->getTerminator());
 896   assert(OldBR->isUnconditional() && OldBR->getSuccessor(0) == LoopBlocks[0] &&
 897          "Preheader splitting did not work correctly!");
 898
 899   // Emit the new branch that selects between the two versions of this loop.
 900   EmitPreheaderBranchOnCondition(LIC, Val, NewBlocks[0], LoopBlocks[0], OldBR);
 901   LPM->deleteSimpleAnalysisValue(OldBR, L);
 902   OldBR->eraseFromParent();
 903
 904   LoopProcessWorklist.push_back(NewLoop);
 905   redoLoop = true;
 906
 907   // Keep a WeakVH holding onto LIC.  If the first call to RewriteLoopBody
 908   // deletes the instruction (for example by simplifying a PHI that feeds into
 909   // the condition that we're unswitching on), we don't rewrite the second
 910   // iteration.
 911   WeakVH LICHandle(LIC);
 912
 913   // Now we rewrite the original code to know that the condition is true and the
 914   // new code to know that the condition is false.
 915   RewriteLoopBodyWithConditionConstant(L, LIC, Val, false);
 916
 917   // It's possible that simplifying one loop could cause the other to be
 918   // changed to another value or a constant.  If its a constant, don't simplify
 919   // it.
 920   if (!LoopProcessWorklist.empty() && LoopProcessWorklist.back() == NewLoop &&
 921       LICHandle && !isa<Constant>(LICHandle))
 922     RewriteLoopBodyWithConditionConstant(NewLoop, LICHandle, Val, true);
 923 }
 924
 925 /// RemoveFromWorklist - Remove all instances of I from the worklist vector
 926 /// specified.
 927 static void RemoveFromWorklist(Instruction *I,
 928                                std::vector<Instruction*> &Worklist) {
 929
 930   Worklist.erase(std::remove(Worklist.begin(), Worklist.end(), I),
 931                  Worklist.end());
 932 }
 933
 934 /// ReplaceUsesOfWith - When we find that I really equals V, remove I from the
 935 /// program, replacing all uses with V and update the worklist.
 936 static void ReplaceUsesOfWith(Instruction *I, Value *V,
 937                               std::vector<Instruction*> &Worklist,
 938                               Loop *L, LPPassManager *LPM) {
 939   DEBUG(dbgs() << "Replace with '" << *V << "': " << *I);
 940
 941   // Add uses to the worklist, which may be dead now.
 942   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 943     if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
 944       Worklist.push_back(Use);
 945
 946   // Add users to the worklist which may be simplified now.
 947   for (User *U : I->users())
 948     Worklist.push_back(cast<Instruction>(U));
 949   LPM->deleteSimpleAnalysisValue(I, L);
 950   RemoveFromWorklist(I, Worklist);
 951   I->replaceAllUsesWith(V);
 952   I->eraseFromParent();
 953   ++NumSimplify;
 954 }
 955
 956 // RewriteLoopBodyWithConditionConstant - We know either that the value LIC has
 957 // the value specified by Val in the specified loop, or we know it does NOT have
 958 // that value.  Rewrite any uses of LIC or of properties correlated to it.
 959 void LoopUnswitch::RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
 960                                                         Constant *Val,
 961                                                         bool IsEqual) {
 962   assert(!isa<Constant>(LIC) && "Why are we unswitching on a constant?");
 963
 964   // FIXME: Support correlated properties, like:
 965   //  for (...)
 966   //    if (li1 < li2)
 967   //      ...
 968   //    if (li1 > li2)
 969   //      ...
 970
 971   // FOLD boolean conditions (X|LIC), (X&LIC).  Fold conditional branches,
 972   // selects, switches.
 973   std::vector<Instruction*> Worklist;
 974   LLVMContext &Context = Val->getContext();
 975
 976   // If we know that LIC == Val, or that LIC == NotVal, just replace uses of LIC
 977   // in the loop with the appropriate one directly.
 978   if (IsEqual || (isa<ConstantInt>(Val) &&
 979       Val->getType()->isIntegerTy(1))) {
 980     Value *Replacement;
 981     if (IsEqual)
 982       Replacement = Val;
 983     else
 984       Replacement = ConstantInt::get(Type::getInt1Ty(Val->getContext()),
 985                                      !cast<ConstantInt>(Val)->getZExtValue());
 986
 987     for (User *U : LIC->users()) {
 988       Instruction *UI = dyn_cast<Instruction>(U);
 989       if (!UI || !L->contains(UI))
 990         continue;
 991       Worklist.push_back(UI);
 992     }
 993
 994     for (std::vector<Instruction*>::iterator UI = Worklist.begin(),
 995          UE = Worklist.end(); UI != UE; ++UI)
 996       (*UI)->replaceUsesOfWith(LIC, Replacement);
 997
 998     SimplifyCode(Worklist, L);
 999     return;
1000   }
1001
1002   // Otherwise, we don't know the precise value of LIC, but we do know that it
1003   // is certainly NOT "Val".  As such, simplify any uses in the loop that we
1004   // can.  This case occurs when we unswitch switch statements.
1005   for (User *U : LIC->users()) {
1006     Instruction *UI = dyn_cast<Instruction>(U);
1007     if (!UI || !L->contains(UI))
1008       continue;
1009
1010     Worklist.push_back(UI);
1011
1012     // TODO: We could do other simplifications, for example, turning
1013     // 'icmp eq LIC, Val' -> false.
1014
1015     // If we know that LIC is not Val, use this info to simplify code.
1016     SwitchInst *SI = dyn_cast<SwitchInst>(UI);
1017     if (!SI || !isa<ConstantInt>(Val)) continue;
1018
1019     SwitchInst::CaseIt DeadCase = SI->findCaseValue(cast<ConstantInt>(Val));
1020     // Default case is live for multiple values.
1021     if (DeadCase == SI->case_default()) continue;
1022
1023     // Found a dead case value.  Don't remove PHI nodes in the
1024     // successor if they become single-entry, those PHI nodes may
1025     // be in the Users list.
1026
1027     BasicBlock *Switch = SI->getParent();
1028     BasicBlock *SISucc = DeadCase.getCaseSuccessor();
1029     BasicBlock *Latch = L->getLoopLatch();
1030
1031     BranchesInfo.setUnswitched(SI, Val);
1032
1033     if (!SI->findCaseDest(SISucc)) continue;  // Edge is critical.
1034     // If the DeadCase successor dominates the loop latch, then the
1035     // transformation isn't safe since it will delete the sole predecessor edge
1036     // to the latch.
1037     if (Latch && DT->dominates(SISucc, Latch))
1038       continue;
1039
1040     // FIXME: This is a hack.  We need to keep the successor around
1041     // and hooked up so as to preserve the loop structure, because
1042     // trying to update it is complicated.  So instead we preserve the
1043     // loop structure and put the block on a dead code path.
1044     SplitEdge(Switch, SISucc, DT, LI);
1045     // Compute the successors instead of relying on the return value
1046     // of SplitEdge, since it may have split the switch successor
1047     // after PHI nodes.
1048     BasicBlock *NewSISucc = DeadCase.getCaseSuccessor();
1049     BasicBlock *OldSISucc = *succ_begin(NewSISucc);
1050     // Create an "unreachable" destination.
1051     BasicBlock *Abort = BasicBlock::Create(Context, "us-unreachable",
1052                                            Switch->getParent(),
1053                                            OldSISucc);
1054     new UnreachableInst(Context, Abort);
1055     // Force the new case destination to branch to the "unreachable"
1056     // block while maintaining a (dead) CFG edge to the old block.
1057     NewSISucc->getTerminator()->eraseFromParent();
1058     BranchInst::Create(Abort, OldSISucc,
1059                        ConstantInt::getTrue(Context), NewSISucc);
1060     // Release the PHI operands for this edge.
1061     for (BasicBlock::iterator II = NewSISucc->begin();
1062          PHINode *PN = dyn_cast<PHINode>(II); ++II)
1063       PN->setIncomingValue(PN->getBasicBlockIndex(Switch),
1064                            UndefValue::get(PN->getType()));
1065     // Tell the domtree about the new block. We don't fully update the
1066     // domtree here -- instead we force it to do a full recomputation
1067     // after the pass is complete -- but we do need to inform it of
1068     // new blocks.
1069     if (DT)
1070       DT->addNewBlock(Abort, NewSISucc);
1071   }
1072
1073   SimplifyCode(Worklist, L);
1074 }
1075
1076 /// SimplifyCode - Okay, now that we have simplified some instructions in the
1077 /// loop, walk over it and constant prop, dce, and fold control flow where
1078 /// possible.  Note that this is effectively a very simple loop-structure-aware
1079 /// optimizer.  During processing of this loop, L could very well be deleted, so
1080 /// it must not be used.
1081 ///
1082 /// FIXME: When the loop optimizer is more mature, separate this out to a new
1083 /// pass.
1084 ///
1085 void LoopUnswitch::SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L) {
1086   while (!Worklist.empty()) {
1087     Instruction *I = Worklist.back();
1088     Worklist.pop_back();
1089
1090     // Simple DCE.
1091     if (isInstructionTriviallyDead(I)) {
1092       DEBUG(dbgs() << "Remove dead instruction '" << *I);
1093
1094       // Add uses to the worklist, which may be dead now.
1095       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1096         if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1097           Worklist.push_back(Use);
1098       LPM->deleteSimpleAnalysisValue(I, L);
1099       RemoveFromWorklist(I, Worklist);
1100       I->eraseFromParent();
1101       ++NumSimplify;
1102       continue;
1103     }
1104
1105     // See if instruction simplification can hack this up.  This is common for
1106     // things like "select false, X, Y" after unswitching made the condition be
1107     // 'false'.  TODO: update the domtree properly so we can pass it here.
1108     if (Value *V = SimplifyInstruction(I))
1109       if (LI->replacementPreservesLCSSAForm(I, V)) {
1110         ReplaceUsesOfWith(I, V, Worklist, L, LPM);
1111         continue;
1112       }
1113
1114     // Special case hacks that appear commonly in unswitched code.
1115     if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
1116       if (BI->isUnconditional()) {
1117         // If BI's parent is the only pred of the successor, fold the two blocks
1118         // together.
1119         BasicBlock *Pred = BI->getParent();
1120         BasicBlock *Succ = BI->getSuccessor(0);
1121         BasicBlock *SinglePred = Succ->getSinglePredecessor();
1122         if (!SinglePred) continue;  // Nothing to do.
1123         assert(SinglePred == Pred && "CFG broken");
1124
1125         DEBUG(dbgs() << "Merging blocks: " << Pred->getName() << " <- "
1126               << Succ->getName() << "\n");
1127
1128         // Resolve any single entry PHI nodes in Succ.
1129         while (PHINode *PN = dyn_cast<PHINode>(Succ->begin()))
1130           ReplaceUsesOfWith(PN, PN->getIncomingValue(0), Worklist, L, LPM);
1131
1132         // If Succ has any successors with PHI nodes, update them to have
1133         // entries coming from Pred instead of Succ.
1134         Succ->replaceAllUsesWith(Pred);
1135
1136         // Move all of the successor contents from Succ to Pred.
1137         Pred->getInstList().splice(BI, Succ->getInstList(), Succ->begin(),
1138                                    Succ->end());
1139         LPM->deleteSimpleAnalysisValue(BI, L);
1140         BI->eraseFromParent();
1141         RemoveFromWorklist(BI, Worklist);
1142
1143         // Remove Succ from the loop tree.
1144         LI->removeBlock(Succ);
1145         LPM->deleteSimpleAnalysisValue(Succ, L);
1146         Succ->eraseFromParent();
1147         ++NumSimplify;
1148         continue;
1149       }
1150
1151       continue;
1152     }
1153   }
1154 }