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     // LoopProcessWorklist - Used to check if second loop needs processing
 152     // after 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 /// FindLIVLoopCondition - Cond is a condition that occurs in L.  If it is
 371 /// invariant in the loop, or has an invariant piece, return the invariant.
 372 /// Otherwise, return null.
 373 static Value *FindLIVLoopCondition(Value *Cond, Loop *L, bool &Changed) {
 374
 375   // We started analyze new instruction, increment scanned instructions counter.
 376   ++TotalInsts;
 377
 378   // We can never unswitch on vector conditions.
 379   if (Cond->getType()->isVectorTy())
 380     return nullptr;
 381
 382   // Constants should be folded, not unswitched on!
 383   if (isa<Constant>(Cond)) return nullptr;
 384
 385   // TODO: Handle: br (VARIANT|INVARIANT).
 386
 387   // Hoist simple values out.
 388   if (L->makeLoopInvariant(Cond, Changed))
 389     return Cond;
 390
 391   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Cond))
 392     if (BO->getOpcode() == Instruction::And ||
 393         BO->getOpcode() == Instruction::Or) {
 394       // If either the left or right side is invariant, we can unswitch on this,
 395       // which will cause the branch to go away in one loop and the condition to
 396       // simplify in the other one.
 397       if (Value *LHS = FindLIVLoopCondition(BO->getOperand(0), L, Changed))
 398         return LHS;
 399       if (Value *RHS = FindLIVLoopCondition(BO->getOperand(1), L, Changed))
 400         return RHS;
 401     }
 402
 403   return nullptr;
 404 }
 405
 406 bool LoopUnswitch::runOnLoop(Loop *L, LPPassManager &LPM_Ref) {
 407   if (skipOptnoneFunction(L))
 408     return false;
 409
 410   AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(
 411       *L->getHeader()->getParent());
 412   LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
 413   LPM = &LPM_Ref;
 414   DominatorTreeWrapperPass *DTWP =
 415       getAnalysisIfAvailable<DominatorTreeWrapperPass>();
 416   DT = DTWP ? &DTWP->getDomTree() : nullptr;
 417   currentLoop = L;
 418   Function *F = currentLoop->getHeader()->getParent();
 419   bool Changed = false;
 420   do {
 421     assert(currentLoop->isLCSSAForm(*DT));
 422     redoLoop = false;
 423     Changed |= processCurrentLoop();
 424   } while(redoLoop);
 425
 426   if (Changed) {
 427     // FIXME: Reconstruct dom info, because it is not preserved properly.
 428     if (DT)
 429       DT->recalculate(*F);
 430   }
 431   return Changed;
 432 }
 433
 434 /// processCurrentLoop - Do actual work and unswitch loop if possible
 435 /// and profitable.
 436 bool LoopUnswitch::processCurrentLoop() {
 437   bool Changed = false;
 438
 439   initLoopData();
 440
 441   // If LoopSimplify was unable to form a preheader, don't do any unswitching.
 442   if (!loopPreheader)
 443     return false;
 444
 445   // Loops with indirectbr cannot be cloned.
 446   if (!currentLoop->isSafeToClone())
 447     return false;
 448
 449   // Without dedicated exits, splitting the exit edge may fail.
 450   if (!currentLoop->hasDedicatedExits())
 451     return false;
 452
 453   LLVMContext &Context = loopHeader->getContext();
 454
 455   // Probably we reach the quota of branches for this loop. If so
 456   // stop unswitching.
 457   if (!BranchesInfo.countLoop(
 458           currentLoop, getAnalysis<TargetTransformInfoWrapperPass>().getTTI(
 459                            *currentLoop->getHeader()->getParent()),
 460           AC))
 461     return false;
 462
 463   // Try trivial unswitch first before loop over other basic blocks in the loop.
 464   if (TryTrivialLoopUnswitch(Changed)) {
 465     return true;
 466   }
 467
 468   // Loop over all of the basic blocks in the loop.  If we find an interior
 469   // block that is branching on a loop-invariant condition, we can unswitch this
 470   // loop.
 471   for (Loop::block_iterator I = currentLoop->block_begin(),
 472          E = currentLoop->block_end(); I != E; ++I) {
 473     TerminatorInst *TI = (*I)->getTerminator();
 474     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
 475       // If this isn't branching on an invariant condition, we can't unswitch
 476       // it.
 477       if (BI->isConditional()) {
 478         // See if this, or some part of it, is loop invariant.  If so, we can
 479         // unswitch on it if we desire.
 480         Value *LoopCond = FindLIVLoopCondition(BI->getCondition(),
 481                                                currentLoop, Changed);
 482         if (LoopCond &&
 483             UnswitchIfProfitable(LoopCond, ConstantInt::getTrue(Context), TI)) {
 484           ++NumBranches;
 485           return true;
 486         }
 487       }
 488     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
 489       Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 490                                              currentLoop, Changed);
 491       unsigned NumCases = SI->getNumCases();
 492       if (LoopCond && NumCases) {
 493         // Find a value to unswitch on:
 494         // FIXME: this should chose the most expensive case!
 495         // FIXME: scan for a case with a non-critical edge?
 496         Constant *UnswitchVal = nullptr;
 497
 498         // Do not process same value again and again.
 499         // At this point we have some cases already unswitched and
 500         // some not yet unswitched. Let's find the first not yet unswitched one.
 501         for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
 502              i != e; ++i) {
 503           Constant *UnswitchValCandidate = i.getCaseValue();
 504           if (!BranchesInfo.isUnswitched(SI, UnswitchValCandidate)) {
 505             UnswitchVal = UnswitchValCandidate;
 506             break;
 507           }
 508         }
 509
 510         if (!UnswitchVal)
 511           continue;
 512
 513         if (UnswitchIfProfitable(LoopCond, UnswitchVal)) {
 514           ++NumSwitches;
 515           return true;
 516         }
 517       }
 518     }
 519
 520     // Scan the instructions to check for unswitchable values.
 521     for (BasicBlock::iterator BBI = (*I)->begin(), E = (*I)->end();
 522          BBI != E; ++BBI)
 523       if (SelectInst *SI = dyn_cast<SelectInst>(BBI)) {
 524         Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 525                                                currentLoop, Changed);
 526         if (LoopCond && UnswitchIfProfitable(LoopCond,
 527                                              ConstantInt::getTrue(Context))) {
 528           ++NumSelects;
 529           return true;
 530         }
 531       }
 532   }
 533   return Changed;
 534 }
 535
 536 /// isTrivialLoopExitBlock - Check to see if all paths from BB exit the
 537 /// loop with no side effects (including infinite loops).
 538 ///
 539 /// If true, we return true and set ExitBB to the block we
 540 /// exit through.
 541 ///
 542 static bool isTrivialLoopExitBlockHelper(Loop *L, BasicBlock *BB,
 543                                          BasicBlock *&ExitBB,
 544                                          std::set<BasicBlock*> &Visited) {
 545   if (!Visited.insert(BB).second) {
 546     // Already visited. Without more analysis, this could indicate an infinite
 547     // loop.
 548     return false;
 549   }
 550   if (!L->contains(BB)) {
 551     // Otherwise, this is a loop exit, this is fine so long as this is the
 552     // first exit.
 553     if (ExitBB) return false;
 554     ExitBB = BB;
 555     return true;
 556   }
 557
 558   // Otherwise, this is an unvisited intra-loop node.  Check all successors.
 559   for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI) {
 560     // Check to see if the successor is a trivial loop exit.
 561     if (!isTrivialLoopExitBlockHelper(L, *SI, ExitBB, Visited))
 562       return false;
 563   }
 564
 565   // Okay, everything after this looks good, check to make sure that this block
 566   // doesn't include any side effects.
 567   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 568     if (I->mayHaveSideEffects())
 569       return false;
 570
 571   return true;
 572 }
 573
 574 /// isTrivialLoopExitBlock - Return true if the specified block unconditionally
 575 /// leads to an exit from the specified loop, and has no side-effects in the
 576 /// process.  If so, return the block that is exited to, otherwise return null.
 577 static BasicBlock *isTrivialLoopExitBlock(Loop *L, BasicBlock *BB) {
 578   std::set<BasicBlock*> Visited;
 579   Visited.insert(L->getHeader());  // Branches to header make infinite loops.
 580   BasicBlock *ExitBB = nullptr;
 581   if (isTrivialLoopExitBlockHelper(L, BB, ExitBB, Visited))
 582     return ExitBB;
 583   return nullptr;
 584 }
 585
 586 /// UnswitchIfProfitable - We have found that we can unswitch currentLoop when
 587 /// LoopCond == Val to simplify the loop.  If we decide that this is profitable,
 588 /// unswitch the loop, reprocess the pieces, then return true.
 589 bool LoopUnswitch::UnswitchIfProfitable(Value *LoopCond, Constant *Val,
 590                                         TerminatorInst *TI) {
 591   Function *F = loopHeader->getParent();
 592
 593   // Check to see if it would be profitable to unswitch current loop.
 594   if (!BranchesInfo.CostAllowsUnswitching()) {
 595     DEBUG(dbgs() << "NOT unswitching loop %"
 596                  << currentLoop->getHeader()->getName()
 597                  << " at non-trivial condition '" << *Val
 598                  << "' == " << *LoopCond << "\n"
 599                  << ". Cost too high.\n");
 600     return false;
 601   }
 602
 603   // Do not do non-trivial unswitch while optimizing for size.
 604   // FIXME: Use Function::optForSize().
 605   if (OptimizeForSize || F->hasFnAttribute(Attribute::OptimizeForSize))
 606     return false;
 607
 608   UnswitchNontrivialCondition(LoopCond, Val, currentLoop, TI);
 609   return true;
 610 }
 611
 612 /// CloneLoop - Recursively clone the specified loop and all of its children,
 613 /// mapping the blocks with the specified map.
 614 static Loop *CloneLoop(Loop *L, Loop *PL, ValueToValueMapTy &VM,
 615                        LoopInfo *LI, LPPassManager *LPM) {
 616   Loop *New = new Loop();
 617   LPM->insertLoop(New, PL);
 618
 619   // Add all of the blocks in L to the new loop.
 620   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
 621        I != E; ++I)
 622     if (LI->getLoopFor(*I) == L)
 623       New->addBasicBlockToLoop(cast<BasicBlock>(VM[*I]), *LI);
 624
 625   // Add all of the subloops to the new loop.
 626   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
 627     CloneLoop(*I, New, VM, LI, LPM);
 628
 629   return New;
 630 }
 631
 632 static void copyMetadata(Instruction *DstInst, const Instruction *SrcInst,
 633                          bool Swapped) {
 634   if (!SrcInst || !SrcInst->hasMetadata())
 635     return;
 636
 637   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
 638   SrcInst->getAllMetadata(MDs);
 639   for (auto &MD : MDs) {
 640     switch (MD.first) {
 641     default:
 642       break;
 643     case LLVMContext::MD_prof:
 644       if (Swapped && MD.second->getNumOperands() == 3 &&
 645           isa<MDString>(MD.second->getOperand(0))) {
 646         MDString *MDName = cast<MDString>(MD.second->getOperand(0));
 647         if (MDName->getString() == "branch_weights") {
 648           auto *ValT = cast_or_null<ConstantAsMetadata>(
 649                            MD.second->getOperand(1))->getValue();
 650           auto *ValF = cast_or_null<ConstantAsMetadata>(
 651                            MD.second->getOperand(2))->getValue();
 652           assert(ValT && ValF && "Invalid Operands of branch_weights");
 653           auto NewMD =
 654               MDBuilder(DstInst->getParent()->getContext())
 655                   .createBranchWeights(cast<ConstantInt>(ValF)->getZExtValue(),
 656                                        cast<ConstantInt>(ValT)->getZExtValue());
 657           MD.second = NewMD;
 658         }
 659       }
 660       // fallthrough.
 661     case LLVMContext::MD_make_implicit:
 662     case LLVMContext::MD_dbg:
 663       DstInst->setMetadata(MD.first, MD.second);
 664     }
 665   }
 666 }
 667
 668 /// EmitPreheaderBranchOnCondition - Emit a conditional branch on two values
 669 /// if LIC == Val, branch to TrueDst, otherwise branch to FalseDest.  Insert the
 670 /// code immediately before InsertPt.
 671 void LoopUnswitch::EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
 672                                                   BasicBlock *TrueDest,
 673                                                   BasicBlock *FalseDest,
 674                                                   Instruction *InsertPt,
 675                                                   TerminatorInst *TI) {
 676   // Insert a conditional branch on LIC to the two preheaders.  The original
 677   // code is the true version and the new code is the false version.
 678   Value *BranchVal = LIC;
 679   bool Swapped = false;
 680   if (!isa<ConstantInt>(Val) ||
 681       Val->getType() != Type::getInt1Ty(LIC->getContext()))
 682     BranchVal = new ICmpInst(InsertPt, ICmpInst::ICMP_EQ, LIC, Val);
 683   else if (Val != ConstantInt::getTrue(Val->getContext())) {
 684     // We want to enter the new loop when the condition is true.
 685     std::swap(TrueDest, FalseDest);
 686     Swapped = true;
 687   }
 688
 689   // Insert the new branch.
 690   BranchInst *BI = BranchInst::Create(TrueDest, FalseDest, BranchVal, InsertPt);
 691   copyMetadata(BI, TI, Swapped);
 692
 693   // If either edge is critical, split it. This helps preserve LoopSimplify
 694   // form for enclosing loops.
 695   auto Options = CriticalEdgeSplittingOptions(DT, LI).setPreserveLCSSA();
 696   SplitCriticalEdge(BI, 0, Options);
 697   SplitCriticalEdge(BI, 1, Options);
 698 }
 699
 700 /// UnswitchTrivialCondition - Given a loop that has a trivial unswitchable
 701 /// condition in it (a cond branch from its header block to its latch block,
 702 /// where the path through the loop that doesn't execute its body has no
 703 /// side-effects), unswitch it.  This doesn't involve any code duplication, just
 704 /// moving the conditional branch outside of the loop and updating loop info.
 705 void LoopUnswitch::UnswitchTrivialCondition(Loop *L, Value *Cond, Constant *Val,
 706                                             BasicBlock *ExitBlock,
 707                                             TerminatorInst *TI) {
 708   DEBUG(dbgs() << "loop-unswitch: Trivial-Unswitch loop %"
 709                << loopHeader->getName() << " [" << L->getBlocks().size()
 710                << " blocks] in Function "
 711                << L->getHeader()->getParent()->getName() << " on cond: " << *Val
 712                << " == " << *Cond << "\n");
 713
 714   // First step, split the preheader, so that we know that there is a safe place
 715   // to insert the conditional branch.  We will change loopPreheader to have a
 716   // conditional branch on Cond.
 717   BasicBlock *NewPH = SplitEdge(loopPreheader, loopHeader, DT, LI);
 718
 719   // Now that we have a place to insert the conditional branch, create a place
 720   // to branch to: this is the exit block out of the loop that we should
 721   // short-circuit to.
 722
 723   // Split this block now, so that the loop maintains its exit block, and so
 724   // that the jump from the preheader can execute the contents of the exit block
 725   // without actually branching to it (the exit block should be dominated by the
 726   // loop header, not the preheader).
 727   assert(!L->contains(ExitBlock) && "Exit block is in the loop?");
 728   BasicBlock *NewExit = SplitBlock(ExitBlock, ExitBlock->begin(), DT, LI);
 729
 730   // Okay, now we have a position to branch from and a position to branch to,
 731   // insert the new conditional branch.
 732   EmitPreheaderBranchOnCondition(Cond, Val, NewExit, NewPH,
 733                                  loopPreheader->getTerminator(), TI);
 734   LPM->deleteSimpleAnalysisValue(loopPreheader->getTerminator(), L);
 735   loopPreheader->getTerminator()->eraseFromParent();
 736
 737   // We need to reprocess this loop, it could be unswitched again.
 738   redoLoop = true;
 739
 740   // Now that we know that the loop is never entered when this condition is a
 741   // particular value, rewrite the loop with this info.  We know that this will
 742   // at least eliminate the old branch.
 743   RewriteLoopBodyWithConditionConstant(L, Cond, Val, false);
 744   ++NumTrivial;
 745 }
 746
 747 /// Check if the first non-constant condition starting from the loop header is
 748 /// a trivial unswitch condition: that is, a condition controls whether or not
 749 /// the loop does anything at all. If it is a trivial condition, unswitching
 750 /// produces no code duplications (equivalently, it produces a simpler loop and
 751 /// a new empty loop, which gets deleted). Therefore always unswitch trivial
 752 /// condition.
 753 bool LoopUnswitch::TryTrivialLoopUnswitch(bool &Changed) {
 754   BasicBlock *CurrentBB = currentLoop->getHeader();
 755   TerminatorInst *CurrentTerm = CurrentBB->getTerminator();
 756   LLVMContext &Context = CurrentBB->getContext();
 757
 758   // If loop header has only one reachable successor (currently via an
 759   // unconditional branch or constant foldable conditional branch, but
 760   // should also consider adding constant foldable switch instruction in
 761   // future), we should keep looking for trivial condition candidates in
 762   // the successor as well. An alternative is to constant fold conditions
 763   // and merge successors into loop header (then we only need to check header's
 764   // terminator). The reason for not doing this in LoopUnswitch pass is that
 765   // it could potentially break LoopPassManager's invariants. Folding dead
 766   // branches could either eliminate the current loop or make other loops
 767   // unreachable. LCSSA form might also not be preserved after deleting
 768   // branches. The following code keeps traversing loop header's successors
 769   // until it finds the trivial condition candidate (condition that is not a
 770   // constant). Since unswitching generates branches with constant conditions,
 771   // this scenario could be very common in practice.
 772   SmallSet<BasicBlock*, 8> Visited;
 773
 774   while (true) {
 775     // If we exit loop or reach a previous visited block, then
 776     // we can not reach any trivial condition candidates (unfoldable
 777     // branch instructions or switch instructions) and no unswitch
 778     // can happen. Exit and return false.
 779     if (!currentLoop->contains(CurrentBB) || !Visited.insert(CurrentBB).second)
 780       return false;
 781
 782     // Check if this loop will execute any side-effecting instructions (e.g.
 783     // stores, calls, volatile loads) in the part of the loop that the code
 784     // *would* execute. Check the header first.
 785     for (BasicBlock::iterator I : *CurrentBB)
 786       if (I->mayHaveSideEffects())
 787         return false;
 788
 789     // FIXME: add check for constant foldable switch instructions.
 790     if (BranchInst *BI = dyn_cast<BranchInst>(CurrentTerm)) {
 791       if (BI->isUnconditional()) {
 792         CurrentBB = BI->getSuccessor(0);
 793       } else if (BI->getCondition() == ConstantInt::getTrue(Context)) {
 794         CurrentBB = BI->getSuccessor(0);
 795       } else if (BI->getCondition() == ConstantInt::getFalse(Context)) {
 796         CurrentBB = BI->getSuccessor(1);
 797       } else {
 798         // Found a trivial condition candidate: non-foldable conditional branch.
 799         break;
 800       }
 801     } else {
 802       break;
 803     }
 804
 805     CurrentTerm = CurrentBB->getTerminator();
 806   }
 807
 808   // CondVal is the condition that controls the trivial condition.
 809   // LoopExitBB is the BasicBlock that loop exits when meets trivial condition.
 810   Constant *CondVal = nullptr;
 811   BasicBlock *LoopExitBB = nullptr;
 812
 813   if (BranchInst *BI = dyn_cast<BranchInst>(CurrentTerm)) {
 814     // If this isn't branching on an invariant condition, we can't unswitch it.
 815     if (!BI->isConditional())
 816       return false;
 817
 818     Value *LoopCond = FindLIVLoopCondition(BI->getCondition(),
 819                                            currentLoop, Changed);
 820
 821     // Unswitch only if the trivial condition itself is an LIV (not
 822     // partial LIV which could occur in and/or)
 823     if (!LoopCond || LoopCond != BI->getCondition())
 824       return false;
 825
 826     // Check to see if a successor of the branch is guaranteed to
 827     // exit through a unique exit block without having any
 828     // side-effects.  If so, determine the value of Cond that causes
 829     // it to do this.
 830     if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
 831                                              BI->getSuccessor(0)))) {
 832       CondVal = ConstantInt::getTrue(Context);
 833     } else if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
 834                                                     BI->getSuccessor(1)))) {
 835       CondVal = ConstantInt::getFalse(Context);
 836     }
 837
 838     // If we didn't find a single unique LoopExit block, or if the loop exit
 839     // block contains phi nodes, this isn't trivial.
 840     if (!LoopExitBB || isa<PHINode>(LoopExitBB->begin()))
 841       return false;   // Can't handle this.
 842
 843     UnswitchTrivialCondition(currentLoop, LoopCond, CondVal, LoopExitBB,
 844                              CurrentTerm);
 845     ++NumBranches;
 846     return true;
 847   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurrentTerm)) {
 848     // If this isn't switching on an invariant condition, we can't unswitch it.
 849     Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 850                                            currentLoop, Changed);
 851
 852     // Unswitch only if the trivial condition itself is an LIV (not
 853     // partial LIV which could occur in and/or)
 854     if (!LoopCond || LoopCond != SI->getCondition())
 855       return false;
 856
 857     // Check to see if a successor of the switch is guaranteed to go to the
 858     // latch block or exit through a one exit block without having any
 859     // side-effects.  If so, determine the value of Cond that causes it to do
 860     // this.
 861     // Note that we can't trivially unswitch on the default case or
 862     // on already unswitched cases.
 863     for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
 864          i != e; ++i) {
 865       BasicBlock *LoopExitCandidate;
 866       if ((LoopExitCandidate = isTrivialLoopExitBlock(currentLoop,
 867                                                i.getCaseSuccessor()))) {
 868         // Okay, we found a trivial case, remember the value that is trivial.
 869         ConstantInt *CaseVal = i.getCaseValue();
 870
 871         // Check that it was not unswitched before, since already unswitched
 872         // trivial vals are looks trivial too.
 873         if (BranchesInfo.isUnswitched(SI, CaseVal))
 874           continue;
 875         LoopExitBB = LoopExitCandidate;
 876         CondVal = CaseVal;
 877         break;
 878       }
 879     }
 880
 881     // If we didn't find a single unique LoopExit block, or if the loop exit
 882     // block contains phi nodes, this isn't trivial.
 883     if (!LoopExitBB || isa<PHINode>(LoopExitBB->begin()))
 884       return false;   // Can't handle this.
 885
 886     UnswitchTrivialCondition(currentLoop, LoopCond, CondVal, LoopExitBB,
 887                              nullptr);
 888     ++NumSwitches;
 889     return true;
 890   }
 891   return false;
 892 }
 893
 894 /// SplitExitEdges - Split all of the edges from inside the loop to their exit
 895 /// blocks.  Update the appropriate Phi nodes as we do so.
 896 void LoopUnswitch::SplitExitEdges(Loop *L,
 897                                const SmallVectorImpl<BasicBlock *> &ExitBlocks){
 898
 899   for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
 900     BasicBlock *ExitBlock = ExitBlocks[i];
 901     SmallVector<BasicBlock *, 4> Preds(pred_begin(ExitBlock),
 902                                        pred_end(ExitBlock));
 903
 904     // Although SplitBlockPredecessors doesn't preserve loop-simplify in
 905     // general, if we call it on all predecessors of all exits then it does.
 906     SplitBlockPredecessors(ExitBlock, Preds, ".us-lcssa", DT, LI,
 907                            /*PreserveLCSSA*/ true);
 908   }
 909 }
 910
 911 /// UnswitchNontrivialCondition - We determined that the loop is profitable
 912 /// to unswitch when LIC equal Val.  Split it into loop versions and test the
 913 /// condition outside of either loop.  Return the loops created as Out1/Out2.
 914 void LoopUnswitch::UnswitchNontrivialCondition(Value *LIC, Constant *Val,
 915                                                Loop *L, TerminatorInst *TI) {
 916   Function *F = loopHeader->getParent();
 917   DEBUG(dbgs() << "loop-unswitch: Unswitching loop %"
 918         << loopHeader->getName() << " [" << L->getBlocks().size()
 919         << " blocks] in Function " << F->getName()
 920         << " when '" << *Val << "' == " << *LIC << "\n");
 921
 922   if (ScalarEvolution *SE = getAnalysisIfAvailable<ScalarEvolution>())
 923     SE->forgetLoop(L);
 924
 925   LoopBlocks.clear();
 926   NewBlocks.clear();
 927
 928   // First step, split the preheader and exit blocks, and add these blocks to
 929   // the LoopBlocks list.
 930   BasicBlock *NewPreheader = SplitEdge(loopPreheader, loopHeader, DT, LI);
 931   LoopBlocks.push_back(NewPreheader);
 932
 933   // We want the loop to come after the preheader, but before the exit blocks.
 934   LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
 935
 936   SmallVector<BasicBlock*, 8> ExitBlocks;
 937   L->getUniqueExitBlocks(ExitBlocks);
 938
 939   // Split all of the edges from inside the loop to their exit blocks.  Update
 940   // the appropriate Phi nodes as we do so.
 941   SplitExitEdges(L, ExitBlocks);
 942
 943   // The exit blocks may have been changed due to edge splitting, recompute.
 944   ExitBlocks.clear();
 945   L->getUniqueExitBlocks(ExitBlocks);
 946
 947   // Add exit blocks to the loop blocks.
 948   LoopBlocks.insert(LoopBlocks.end(), ExitBlocks.begin(), ExitBlocks.end());
 949
 950   // Next step, clone all of the basic blocks that make up the loop (including
 951   // the loop preheader and exit blocks), keeping track of the mapping between
 952   // the instructions and blocks.
 953   NewBlocks.reserve(LoopBlocks.size());
 954   ValueToValueMapTy VMap;
 955   for (unsigned i = 0, e = LoopBlocks.size(); i != e; ++i) {
 956     BasicBlock *NewBB = CloneBasicBlock(LoopBlocks[i], VMap, ".us", F);
 957
 958     NewBlocks.push_back(NewBB);
 959     VMap[LoopBlocks[i]] = NewBB;  // Keep the BB mapping.
 960     LPM->cloneBasicBlockSimpleAnalysis(LoopBlocks[i], NewBB, L);
 961   }
 962
 963   // Splice the newly inserted blocks into the function right before the
 964   // original preheader.
 965   F->getBasicBlockList().splice(NewPreheader, F->getBasicBlockList(),
 966                                 NewBlocks[0], F->end());
 967
 968   // FIXME: We could register any cloned assumptions instead of clearing the
 969   // whole function's cache.
 970   AC->clear();
 971
 972   // Now we create the new Loop object for the versioned loop.
 973   Loop *NewLoop = CloneLoop(L, L->getParentLoop(), VMap, LI, LPM);
 974
 975   // Recalculate unswitching quota, inherit simplified switches info for NewBB,
 976   // Probably clone more loop-unswitch related loop properties.
 977   BranchesInfo.cloneData(NewLoop, L, VMap);
 978
 979   Loop *ParentLoop = L->getParentLoop();
 980   if (ParentLoop) {
 981     // Make sure to add the cloned preheader and exit blocks to the parent loop
 982     // as well.
 983     ParentLoop->addBasicBlockToLoop(NewBlocks[0], *LI);
 984   }
 985
 986   for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
 987     BasicBlock *NewExit = cast<BasicBlock>(VMap[ExitBlocks[i]]);
 988     // The new exit block should be in the same loop as the old one.
 989     if (Loop *ExitBBLoop = LI->getLoopFor(ExitBlocks[i]))
 990       ExitBBLoop->addBasicBlockToLoop(NewExit, *LI);
 991
 992     assert(NewExit->getTerminator()->getNumSuccessors() == 1 &&
 993            "Exit block should have been split to have one successor!");
 994     BasicBlock *ExitSucc = NewExit->getTerminator()->getSuccessor(0);
 995
 996     // If the successor of the exit block had PHI nodes, add an entry for
 997     // NewExit.
 998     for (BasicBlock::iterator I = ExitSucc->begin();
 999          PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1000       Value *V = PN->getIncomingValueForBlock(ExitBlocks[i]);
1001       ValueToValueMapTy::iterator It = VMap.find(V);
1002       if (It != VMap.end()) V = It->second;
1003       PN->addIncoming(V, NewExit);
1004     }
1005
1006     if (LandingPadInst *LPad = NewExit->getLandingPadInst()) {
1007       PHINode *PN = PHINode::Create(LPad->getType(), 0, "",
1008                                     ExitSucc->getFirstInsertionPt());
1009
1010       for (pred_iterator I = pred_begin(ExitSucc), E = pred_end(ExitSucc);
1011            I != E; ++I) {
1012         BasicBlock *BB = *I;
1013         LandingPadInst *LPI = BB->getLandingPadInst();
1014         LPI->replaceAllUsesWith(PN);
1015         PN->addIncoming(LPI, BB);
1016       }
1017     }
1018   }
1019
1020   // Rewrite the code to refer to itself.
1021   for (unsigned i = 0, e = NewBlocks.size(); i != e; ++i)
1022     for (BasicBlock::iterator I = NewBlocks[i]->begin(),
1023            E = NewBlocks[i]->end(); I != E; ++I)
1024       RemapInstruction(I, VMap,RF_NoModuleLevelChanges|RF_IgnoreMissingEntries);
1025
1026   // Rewrite the original preheader to select between versions of the loop.
1027   BranchInst *OldBR = cast<BranchInst>(loopPreheader->getTerminator());
1028   assert(OldBR->isUnconditional() && OldBR->getSuccessor(0) == LoopBlocks[0] &&
1029          "Preheader splitting did not work correctly!");
1030
1031   // Emit the new branch that selects between the two versions of this loop.
1032   EmitPreheaderBranchOnCondition(LIC, Val, NewBlocks[0], LoopBlocks[0], OldBR,
1033                                  TI);
1034   LPM->deleteSimpleAnalysisValue(OldBR, L);
1035   OldBR->eraseFromParent();
1036
1037   LoopProcessWorklist.push_back(NewLoop);
1038   redoLoop = true;
1039
1040   // Keep a WeakVH holding onto LIC.  If the first call to RewriteLoopBody
1041   // deletes the instruction (for example by simplifying a PHI that feeds into
1042   // the condition that we're unswitching on), we don't rewrite the second
1043   // iteration.
1044   WeakVH LICHandle(LIC);
1045
1046   // Now we rewrite the original code to know that the condition is true and the
1047   // new code to know that the condition is false.
1048   RewriteLoopBodyWithConditionConstant(L, LIC, Val, false);
1049
1050   // It's possible that simplifying one loop could cause the other to be
1051   // changed to another value or a constant.  If its a constant, don't simplify
1052   // it.
1053   if (!LoopProcessWorklist.empty() && LoopProcessWorklist.back() == NewLoop &&
1054       LICHandle && !isa<Constant>(LICHandle))
1055     RewriteLoopBodyWithConditionConstant(NewLoop, LICHandle, Val, true);
1056 }
1057
1058 /// RemoveFromWorklist - Remove all instances of I from the worklist vector
1059 /// specified.
1060 static void RemoveFromWorklist(Instruction *I,
1061                                std::vector<Instruction*> &Worklist) {
1062
1063   Worklist.erase(std::remove(Worklist.begin(), Worklist.end(), I),
1064                  Worklist.end());
1065 }
1066
1067 /// ReplaceUsesOfWith - When we find that I really equals V, remove I from the
1068 /// program, replacing all uses with V and update the worklist.
1069 static void ReplaceUsesOfWith(Instruction *I, Value *V,
1070                               std::vector<Instruction*> &Worklist,
1071                               Loop *L, LPPassManager *LPM) {
1072   DEBUG(dbgs() << "Replace with '" << *V << "': " << *I);
1073
1074   // Add uses to the worklist, which may be dead now.
1075   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1076     if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1077       Worklist.push_back(Use);
1078
1079   // Add users to the worklist which may be simplified now.
1080   for (User *U : I->users())
1081     Worklist.push_back(cast<Instruction>(U));
1082   LPM->deleteSimpleAnalysisValue(I, L);
1083   RemoveFromWorklist(I, Worklist);
1084   I->replaceAllUsesWith(V);
1085   I->eraseFromParent();
1086   ++NumSimplify;
1087 }
1088
1089 // RewriteLoopBodyWithConditionConstant - We know either that the value LIC has
1090 // the value specified by Val in the specified loop, or we know it does NOT have
1091 // that value.  Rewrite any uses of LIC or of properties correlated to it.
1092 void LoopUnswitch::RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
1093                                                         Constant *Val,
1094                                                         bool IsEqual) {
1095   assert(!isa<Constant>(LIC) && "Why are we unswitching on a constant?");
1096
1097   // FIXME: Support correlated properties, like:
1098   //  for (...)
1099   //    if (li1 < li2)
1100   //      ...
1101   //    if (li1 > li2)
1102   //      ...
1103
1104   // FOLD boolean conditions (X|LIC), (X&LIC).  Fold conditional branches,
1105   // selects, switches.
1106   std::vector<Instruction*> Worklist;
1107   LLVMContext &Context = Val->getContext();
1108
1109   // If we know that LIC == Val, or that LIC == NotVal, just replace uses of LIC
1110   // in the loop with the appropriate one directly.
1111   if (IsEqual || (isa<ConstantInt>(Val) &&
1112       Val->getType()->isIntegerTy(1))) {
1113     Value *Replacement;
1114     if (IsEqual)
1115       Replacement = Val;
1116     else
1117       Replacement = ConstantInt::get(Type::getInt1Ty(Val->getContext()),
1118                                      !cast<ConstantInt>(Val)->getZExtValue());
1119
1120     for (User *U : LIC->users()) {
1121       Instruction *UI = dyn_cast<Instruction>(U);
1122       if (!UI || !L->contains(UI))
1123         continue;
1124       Worklist.push_back(UI);
1125     }
1126
1127     for (std::vector<Instruction*>::iterator UI = Worklist.begin(),
1128          UE = Worklist.end(); UI != UE; ++UI)
1129       (*UI)->replaceUsesOfWith(LIC, Replacement);
1130
1131     SimplifyCode(Worklist, L);
1132     return;
1133   }
1134
1135   // Otherwise, we don't know the precise value of LIC, but we do know that it
1136   // is certainly NOT "Val".  As such, simplify any uses in the loop that we
1137   // can.  This case occurs when we unswitch switch statements.
1138   for (User *U : LIC->users()) {
1139     Instruction *UI = dyn_cast<Instruction>(U);
1140     if (!UI || !L->contains(UI))
1141       continue;
1142
1143     Worklist.push_back(UI);
1144
1145     // TODO: We could do other simplifications, for example, turning
1146     // 'icmp eq LIC, Val' -> false.
1147
1148     // If we know that LIC is not Val, use this info to simplify code.
1149     SwitchInst *SI = dyn_cast<SwitchInst>(UI);
1150     if (!SI || !isa<ConstantInt>(Val)) continue;
1151
1152     SwitchInst::CaseIt DeadCase = SI->findCaseValue(cast<ConstantInt>(Val));
1153     // Default case is live for multiple values.
1154     if (DeadCase == SI->case_default()) continue;
1155
1156     // Found a dead case value.  Don't remove PHI nodes in the
1157     // successor if they become single-entry, those PHI nodes may
1158     // be in the Users list.
1159
1160     BasicBlock *Switch = SI->getParent();
1161     BasicBlock *SISucc = DeadCase.getCaseSuccessor();
1162     BasicBlock *Latch = L->getLoopLatch();
1163
1164     BranchesInfo.setUnswitched(SI, Val);
1165
1166     if (!SI->findCaseDest(SISucc)) continue;  // Edge is critical.
1167     // If the DeadCase successor dominates the loop latch, then the
1168     // transformation isn't safe since it will delete the sole predecessor edge
1169     // to the latch.
1170     if (Latch && DT->dominates(SISucc, Latch))
1171       continue;
1172
1173     // FIXME: This is a hack.  We need to keep the successor around
1174     // and hooked up so as to preserve the loop structure, because
1175     // trying to update it is complicated.  So instead we preserve the
1176     // loop structure and put the block on a dead code path.
1177     SplitEdge(Switch, SISucc, DT, LI);
1178     // Compute the successors instead of relying on the return value
1179     // of SplitEdge, since it may have split the switch successor
1180     // after PHI nodes.
1181     BasicBlock *NewSISucc = DeadCase.getCaseSuccessor();
1182     BasicBlock *OldSISucc = *succ_begin(NewSISucc);
1183     // Create an "unreachable" destination.
1184     BasicBlock *Abort = BasicBlock::Create(Context, "us-unreachable",
1185                                            Switch->getParent(),
1186                                            OldSISucc);
1187     new UnreachableInst(Context, Abort);
1188     // Force the new case destination to branch to the "unreachable"
1189     // block while maintaining a (dead) CFG edge to the old block.
1190     NewSISucc->getTerminator()->eraseFromParent();
1191     BranchInst::Create(Abort, OldSISucc,
1192                        ConstantInt::getTrue(Context), NewSISucc);
1193     // Release the PHI operands for this edge.
1194     for (BasicBlock::iterator II = NewSISucc->begin();
1195          PHINode *PN = dyn_cast<PHINode>(II); ++II)
1196       PN->setIncomingValue(PN->getBasicBlockIndex(Switch),
1197                            UndefValue::get(PN->getType()));
1198     // Tell the domtree about the new block. We don't fully update the
1199     // domtree here -- instead we force it to do a full recomputation
1200     // after the pass is complete -- but we do need to inform it of
1201     // new blocks.
1202     if (DT)
1203       DT->addNewBlock(Abort, NewSISucc);
1204   }
1205
1206   SimplifyCode(Worklist, L);
1207 }
1208
1209 /// SimplifyCode - Okay, now that we have simplified some instructions in the
1210 /// loop, walk over it and constant prop, dce, and fold control flow where
1211 /// possible.  Note that this is effectively a very simple loop-structure-aware
1212 /// optimizer.  During processing of this loop, L could very well be deleted, so
1213 /// it must not be used.
1214 ///
1215 /// FIXME: When the loop optimizer is more mature, separate this out to a new
1216 /// pass.
1217 ///
1218 void LoopUnswitch::SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L) {
1219   const DataLayout &DL = L->getHeader()->getModule()->getDataLayout();
1220   while (!Worklist.empty()) {
1221     Instruction *I = Worklist.back();
1222     Worklist.pop_back();
1223
1224     // Simple DCE.
1225     if (isInstructionTriviallyDead(I)) {
1226       DEBUG(dbgs() << "Remove dead instruction '" << *I);
1227
1228       // Add uses to the worklist, which may be dead now.
1229       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1230         if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1231           Worklist.push_back(Use);
1232       LPM->deleteSimpleAnalysisValue(I, L);
1233       RemoveFromWorklist(I, Worklist);
1234       I->eraseFromParent();
1235       ++NumSimplify;
1236       continue;
1237     }
1238
1239     // See if instruction simplification can hack this up.  This is common for
1240     // things like "select false, X, Y" after unswitching made the condition be
1241     // 'false'.  TODO: update the domtree properly so we can pass it here.
1242     if (Value *V = SimplifyInstruction(I, DL))
1243       if (LI->replacementPreservesLCSSAForm(I, V)) {
1244         ReplaceUsesOfWith(I, V, Worklist, L, LPM);
1245         continue;
1246       }
1247
1248     // Special case hacks that appear commonly in unswitched code.
1249     if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
1250       if (BI->isUnconditional()) {
1251         // If BI's parent is the only pred of the successor, fold the two blocks
1252         // together.
1253         BasicBlock *Pred = BI->getParent();
1254         BasicBlock *Succ = BI->getSuccessor(0);
1255         BasicBlock *SinglePred = Succ->getSinglePredecessor();
1256         if (!SinglePred) continue;  // Nothing to do.
1257         assert(SinglePred == Pred && "CFG broken");
1258
1259         DEBUG(dbgs() << "Merging blocks: " << Pred->getName() << " <- "
1260               << Succ->getName() << "\n");
1261
1262         // Resolve any single entry PHI nodes in Succ.
1263         while (PHINode *PN = dyn_cast<PHINode>(Succ->begin()))
1264           ReplaceUsesOfWith(PN, PN->getIncomingValue(0), Worklist, L, LPM);
1265
1266         // If Succ has any successors with PHI nodes, update them to have
1267         // entries coming from Pred instead of Succ.
1268         Succ->replaceAllUsesWith(Pred);
1269
1270         // Move all of the successor contents from Succ to Pred.
1271         Pred->getInstList().splice(BI, Succ->getInstList(), Succ->begin(),
1272                                    Succ->end());
1273         LPM->deleteSimpleAnalysisValue(BI, L);
1274         BI->eraseFromParent();
1275         RemoveFromWorklist(BI, Worklist);
1276
1277         // Remove Succ from the loop tree.
1278         LI->removeBlock(Succ);
1279         LPM->deleteSimpleAnalysisValue(Succ, L);
1280         Succ->eraseFromParent();
1281         ++NumSimplify;
1282         continue;
1283       }
1284
1285       continue;
1286     }
1287   }
1288 }