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