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, const SmallVectorImpl<BasicBlock *> &ExitBlocks);
 214
 215     bool TryTrivialLoopUnswitch(bool &Changed);
 216
 217     bool UnswitchIfProfitable(Value *LoopCond, Constant *Val,
 218                               TerminatorInst *TI = nullptr);
 219     void UnswitchTrivialCondition(Loop *L, Value *Cond, Constant *Val,
 220                                   BasicBlock *ExitBlock, TerminatorInst *TI);
 221     void UnswitchNontrivialCondition(Value *LIC, Constant *OnVal, Loop *L,
 222                                      TerminatorInst *TI);
 223
 224     void RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
 225                                               Constant *Val, bool isEqual);
 226
 227     void EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
 228                                         BasicBlock *TrueDest,
 229                                         BasicBlock *FalseDest,
 230                                         Instruction *InsertPt,
 231                                         TerminatorInst *TI);
 232
 233     void SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L);
 234   };
 235 }
 236
 237 // Analyze loop. Check its size, calculate is it possible to unswitch
 238 // it. Returns true if we can unswitch this loop.
 239 bool LUAnalysisCache::countLoop(const Loop *L, const TargetTransformInfo &TTI,
 240                                 AssumptionCache *AC) {
 241
 242   LoopPropsMapIt PropsIt;
 243   bool Inserted;
 244   std::tie(PropsIt, Inserted) =
 245       LoopsProperties.insert(std::make_pair(L, LoopProperties()));
 246
 247   LoopProperties &Props = PropsIt->second;
 248
 249   if (Inserted) {
 250     // New loop.
 251
 252     // Limit the number of instructions to avoid causing significant code
 253     // expansion, and the number of basic blocks, to avoid loops with
 254     // large numbers of branches which cause loop unswitching to go crazy.
 255     // This is a very ad-hoc heuristic.
 256
 257     SmallPtrSet<const Value *, 32> EphValues;
 258     CodeMetrics::collectEphemeralValues(L, AC, EphValues);
 259
 260     // FIXME: This is overly conservative because it does not take into
 261     // consideration code simplification opportunities and code that can
 262     // be shared by the resultant unswitched loops.
 263     CodeMetrics Metrics;
 264     for (Loop::block_iterator I = L->block_begin(), E = L->block_end(); I != E;
 265          ++I)
 266       Metrics.analyzeBasicBlock(*I, TTI, EphValues);
 267
 268     Props.SizeEstimation = Metrics.NumInsts;
 269     Props.CanBeUnswitchedCount = MaxSize / (Props.SizeEstimation);
 270     Props.WasUnswitchedCount = 0;
 271     MaxSize -= Props.SizeEstimation * Props.CanBeUnswitchedCount;
 272
 273     if (Metrics.notDuplicatable) {
 274       DEBUG(dbgs() << "NOT unswitching loop %"
 275                    << L->getHeader()->getName() << ", contents cannot be "
 276                    << "duplicated!\n");
 277       return false;
 278     }
 279   }
 280
 281   // Be careful. This links are good only before new loop addition.
 282   CurrentLoopProperties = &Props;
 283   CurLoopInstructions = &Props.UnswitchedVals;
 284
 285   return true;
 286 }
 287
 288 // Clean all data related to given loop.
 289 void LUAnalysisCache::forgetLoop(const Loop *L) {
 290
 291   LoopPropsMapIt LIt = LoopsProperties.find(L);
 292
 293   if (LIt != LoopsProperties.end()) {
 294     LoopProperties &Props = LIt->second;
 295     MaxSize += (Props.CanBeUnswitchedCount + Props.WasUnswitchedCount) *
 296                Props.SizeEstimation;
 297     LoopsProperties.erase(LIt);
 298   }
 299
 300   CurrentLoopProperties = nullptr;
 301   CurLoopInstructions = nullptr;
 302 }
 303
 304 // Mark case value as unswitched.
 305 // Since SI instruction can be partly unswitched, in order to avoid
 306 // extra unswitching in cloned loops keep track all unswitched values.
 307 void LUAnalysisCache::setUnswitched(const SwitchInst *SI, const Value *V) {
 308   (*CurLoopInstructions)[SI].insert(V);
 309 }
 310
 311 // Check was this case value unswitched before or not.
 312 bool LUAnalysisCache::isUnswitched(const SwitchInst *SI, const Value *V) {
 313   return (*CurLoopInstructions)[SI].count(V);
 314 }
 315
 316 bool LUAnalysisCache::CostAllowsUnswitching() {
 317   return CurrentLoopProperties->CanBeUnswitchedCount > 0;
 318 }
 319
 320 // Clone all loop-unswitch related loop properties.
 321 // Redistribute unswitching quotas.
 322 // Note, that new loop data is stored inside the VMap.
 323 void LUAnalysisCache::cloneData(const Loop *NewLoop, const Loop *OldLoop,
 324                                 const ValueToValueMapTy &VMap) {
 325
 326   LoopProperties &NewLoopProps = LoopsProperties[NewLoop];
 327   LoopProperties &OldLoopProps = *CurrentLoopProperties;
 328   UnswitchedValsMap &Insts = OldLoopProps.UnswitchedVals;
 329
 330   // Reallocate "can-be-unswitched quota"
 331
 332   --OldLoopProps.CanBeUnswitchedCount;
 333   ++OldLoopProps.WasUnswitchedCount;
 334   NewLoopProps.WasUnswitchedCount = 0;
 335   unsigned Quota = OldLoopProps.CanBeUnswitchedCount;
 336   NewLoopProps.CanBeUnswitchedCount = Quota / 2;
 337   OldLoopProps.CanBeUnswitchedCount = Quota - Quota / 2;
 338
 339   NewLoopProps.SizeEstimation = OldLoopProps.SizeEstimation;
 340
 341   // Clone unswitched values info:
 342   // for new loop switches we clone info about values that was
 343   // already unswitched and has redundant successors.
 344   for (UnswitchedValsIt I = Insts.begin(); I != Insts.end(); ++I) {
 345     const SwitchInst *OldInst = I->first;
 346     Value *NewI = VMap.lookup(OldInst);
 347     const SwitchInst *NewInst = cast_or_null<SwitchInst>(NewI);
 348     assert(NewInst && "All instructions that are in SrcBB must be in VMap.");
 349
 350     NewLoopProps.UnswitchedVals[NewInst] = OldLoopProps.UnswitchedVals[OldInst];
 351   }
 352 }
 353
 354 char LoopUnswitch::ID = 0;
 355 INITIALIZE_PASS_BEGIN(LoopUnswitch, "loop-unswitch", "Unswitch loops",
 356                       false, false)
 357 INITIALIZE_PASS_DEPENDENCY(TargetTransformInfoWrapperPass)
 358 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
 359 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
 360 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
 361 INITIALIZE_PASS_DEPENDENCY(LCSSA)
 362 INITIALIZE_PASS_END(LoopUnswitch, "loop-unswitch", "Unswitch loops",
 363                       false, false)
 364
 365 Pass *llvm::createLoopUnswitchPass(bool Os) {
 366   return new LoopUnswitch(Os);
 367 }
 368
 369 /// FindLIVLoopCondition - Cond is a condition that occurs in L.  If it is
 370 /// invariant in the loop, or has an invariant piece, return the invariant.
 371 /// 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 /// processCurrentLoop - Do actual work and unswitch loop if possible
 434 /// and profitable.
 435 bool LoopUnswitch::processCurrentLoop() {
 436   bool Changed = false;
 437
 438   initLoopData();
 439
 440   // If LoopSimplify was unable to form a preheader, don't do any unswitching.
 441   if (!loopPreheader)
 442     return false;
 443
 444   // Loops with indirectbr cannot be cloned.
 445   if (!currentLoop->isSafeToClone())
 446     return false;
 447
 448   // Without dedicated exits, splitting the exit edge may fail.
 449   if (!currentLoop->hasDedicatedExits())
 450     return false;
 451
 452   LLVMContext &Context = loopHeader->getContext();
 453
 454   // Probably we reach the quota of branches for this loop. If so
 455   // stop unswitching.
 456   if (!BranchesInfo.countLoop(
 457           currentLoop, getAnalysis<TargetTransformInfoWrapperPass>().getTTI(
 458                            *currentLoop->getHeader()->getParent()),
 459           AC))
 460     return false;
 461
 462   // Try trivial unswitch first before loop over other basic blocks in the loop.
 463   if (TryTrivialLoopUnswitch(Changed)) {
 464     return true;
 465   }
 466
 467   // Loop over all of the basic blocks in the loop.  If we find an interior
 468   // block that is branching on a loop-invariant condition, we can unswitch this
 469   // loop.
 470   for (Loop::block_iterator I = currentLoop->block_begin(),
 471          E = currentLoop->block_end(); I != E; ++I) {
 472     TerminatorInst *TI = (*I)->getTerminator();
 473     if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
 474       // If this isn't branching on an invariant condition, we can't unswitch
 475       // it.
 476       if (BI->isConditional()) {
 477         // See if this, or some part of it, is loop invariant.  If so, we can
 478         // unswitch on it if we desire.
 479         Value *LoopCond = FindLIVLoopCondition(BI->getCondition(),
 480                                                currentLoop, Changed);
 481         if (LoopCond &&
 482             UnswitchIfProfitable(LoopCond, ConstantInt::getTrue(Context), TI)) {
 483           ++NumBranches;
 484           return true;
 485         }
 486       }
 487     } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
 488       Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 489                                              currentLoop, Changed);
 490       unsigned NumCases = SI->getNumCases();
 491       if (LoopCond && NumCases) {
 492         // Find a value to unswitch on:
 493         // FIXME: this should chose the most expensive case!
 494         // FIXME: scan for a case with a non-critical edge?
 495         Constant *UnswitchVal = nullptr;
 496
 497         // Do not process same value again and again.
 498         // At this point we have some cases already unswitched and
 499         // some not yet unswitched. Let's find the first not yet unswitched one.
 500         for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
 501              i != e; ++i) {
 502           Constant *UnswitchValCandidate = i.getCaseValue();
 503           if (!BranchesInfo.isUnswitched(SI, UnswitchValCandidate)) {
 504             UnswitchVal = UnswitchValCandidate;
 505             break;
 506           }
 507         }
 508
 509         if (!UnswitchVal)
 510           continue;
 511
 512         if (UnswitchIfProfitable(LoopCond, UnswitchVal)) {
 513           ++NumSwitches;
 514           return true;
 515         }
 516       }
 517     }
 518
 519     // Scan the instructions to check for unswitchable values.
 520     for (BasicBlock::iterator BBI = (*I)->begin(), E = (*I)->end();
 521          BBI != E; ++BBI)
 522       if (SelectInst *SI = dyn_cast<SelectInst>(BBI)) {
 523         Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 524                                                currentLoop, Changed);
 525         if (LoopCond && UnswitchIfProfitable(LoopCond,
 526                                              ConstantInt::getTrue(Context))) {
 527           ++NumSelects;
 528           return true;
 529         }
 530       }
 531   }
 532   return Changed;
 533 }
 534
 535 /// isTrivialLoopExitBlock - Check to see if all paths from BB exit the
 536 /// loop with no side effects (including infinite loops).
 537 ///
 538 /// If true, we return true and set ExitBB to the block we
 539 /// exit through.
 540 ///
 541 static bool isTrivialLoopExitBlockHelper(Loop *L, BasicBlock *BB,
 542                                          BasicBlock *&ExitBB,
 543                                          std::set<BasicBlock*> &Visited) {
 544   if (!Visited.insert(BB).second) {
 545     // Already visited. Without more analysis, this could indicate an infinite
 546     // loop.
 547     return false;
 548   }
 549   if (!L->contains(BB)) {
 550     // Otherwise, this is a loop exit, this is fine so long as this is the
 551     // first exit.
 552     if (ExitBB) return false;
 553     ExitBB = BB;
 554     return true;
 555   }
 556
 557   // Otherwise, this is an unvisited intra-loop node.  Check all successors.
 558   for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI) {
 559     // Check to see if the successor is a trivial loop exit.
 560     if (!isTrivialLoopExitBlockHelper(L, *SI, ExitBB, Visited))
 561       return false;
 562   }
 563
 564   // Okay, everything after this looks good, check to make sure that this block
 565   // doesn't include any side effects.
 566   for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 567     if (I->mayHaveSideEffects())
 568       return false;
 569
 570   return true;
 571 }
 572
 573 /// isTrivialLoopExitBlock - Return true if the specified block unconditionally
 574 /// leads to an exit from the specified loop, and has no side-effects in the
 575 /// process.  If so, return the block that is exited to, otherwise return null.
 576 static BasicBlock *isTrivialLoopExitBlock(Loop *L, BasicBlock *BB) {
 577   std::set<BasicBlock*> Visited;
 578   Visited.insert(L->getHeader());  // Branches to header make infinite loops.
 579   BasicBlock *ExitBB = nullptr;
 580   if (isTrivialLoopExitBlockHelper(L, BB, ExitBB, Visited))
 581     return ExitBB;
 582   return nullptr;
 583 }
 584
 585 /// UnswitchIfProfitable - We have found that we can unswitch currentLoop when
 586 /// LoopCond == Val to simplify the loop.  If we decide that this is profitable,
 587 /// unswitch the loop, reprocess the pieces, then return true.
 588 bool LoopUnswitch::UnswitchIfProfitable(Value *LoopCond, Constant *Val,
 589                                         TerminatorInst *TI) {
 590   Function *F = loopHeader->getParent();
 591
 592   // Check to see if it would be profitable to unswitch current loop.
 593   if (!BranchesInfo.CostAllowsUnswitching()) {
 594     DEBUG(dbgs() << "NOT unswitching loop %"
 595                  << currentLoop->getHeader()->getName()
 596                  << " at non-trivial condition '" << *Val
 597                  << "' == " << *LoopCond << "\n"
 598                  << ". Cost too high.\n");
 599     return false;
 600   }
 601
 602   // Do not do non-trivial unswitch while optimizing for size.
 603   // FIXME: Use Function::optForSize().
 604   if (OptimizeForSize || F->hasFnAttribute(Attribute::OptimizeForSize))
 605     return false;
 606
 607   UnswitchNontrivialCondition(LoopCond, Val, currentLoop, TI);
 608   return true;
 609 }
 610
 611 /// CloneLoop - Recursively clone the specified loop and all of its children,
 612 /// mapping the blocks with the specified map.
 613 static Loop *CloneLoop(Loop *L, Loop *PL, ValueToValueMapTy &VM,
 614                        LoopInfo *LI, LPPassManager *LPM) {
 615   Loop *New = new Loop();
 616   LPM->insertLoop(New, PL);
 617
 618   // Add all of the blocks in L to the new loop.
 619   for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
 620        I != E; ++I)
 621     if (LI->getLoopFor(*I) == L)
 622       New->addBasicBlockToLoop(cast<BasicBlock>(VM[*I]), *LI);
 623
 624   // Add all of the subloops to the new loop.
 625   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
 626     CloneLoop(*I, New, VM, LI, LPM);
 627
 628   return New;
 629 }
 630
 631 static void copyMetadata(Instruction *DstInst, const Instruction *SrcInst,
 632                          bool Swapped) {
 633   if (!SrcInst || !SrcInst->hasMetadata())
 634     return;
 635
 636   SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
 637   SrcInst->getAllMetadata(MDs);
 638   for (auto &MD : MDs) {
 639     switch (MD.first) {
 640     default:
 641       break;
 642     case LLVMContext::MD_prof:
 643       if (Swapped && MD.second->getNumOperands() == 3 &&
 644           isa<MDString>(MD.second->getOperand(0))) {
 645         MDString *MDName = cast<MDString>(MD.second->getOperand(0));
 646         if (MDName->getString() == "branch_weights") {
 647           auto *ValT = cast_or_null<ConstantAsMetadata>(
 648                            MD.second->getOperand(1))->getValue();
 649           auto *ValF = cast_or_null<ConstantAsMetadata>(
 650                            MD.second->getOperand(2))->getValue();
 651           assert(ValT && ValF && "Invalid Operands of branch_weights");
 652           auto NewMD =
 653               MDBuilder(DstInst->getParent()->getContext())
 654                   .createBranchWeights(cast<ConstantInt>(ValF)->getZExtValue(),
 655                                        cast<ConstantInt>(ValT)->getZExtValue());
 656           MD.second = NewMD;
 657         }
 658       }
 659       // fallthrough.
 660     case LLVMContext::MD_make_implicit:
 661     case LLVMContext::MD_dbg:
 662       DstInst->setMetadata(MD.first, MD.second);
 663     }
 664   }
 665 }
 666
 667 /// EmitPreheaderBranchOnCondition - Emit a conditional branch on two values
 668 /// if LIC == Val, branch to TrueDst, otherwise branch to FalseDest.  Insert the
 669 /// code immediately before InsertPt.
 670 void LoopUnswitch::EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
 671                                                   BasicBlock *TrueDest,
 672                                                   BasicBlock *FalseDest,
 673                                                   Instruction *InsertPt,
 674                                                   TerminatorInst *TI) {
 675   // Insert a conditional branch on LIC to the two preheaders.  The original
 676   // code is the true version and the new code is the false version.
 677   Value *BranchVal = LIC;
 678   bool Swapped = false;
 679   if (!isa<ConstantInt>(Val) ||
 680       Val->getType() != Type::getInt1Ty(LIC->getContext()))
 681     BranchVal = new ICmpInst(InsertPt, ICmpInst::ICMP_EQ, LIC, Val);
 682   else if (Val != ConstantInt::getTrue(Val->getContext())) {
 683     // We want to enter the new loop when the condition is true.
 684     std::swap(TrueDest, FalseDest);
 685     Swapped = true;
 686   }
 687
 688   // Insert the new branch.
 689   BranchInst *BI = BranchInst::Create(TrueDest, FalseDest, BranchVal, InsertPt);
 690   copyMetadata(BI, TI, Swapped);
 691
 692   // If either edge is critical, split it. This helps preserve LoopSimplify
 693   // form for enclosing loops.
 694   auto Options = CriticalEdgeSplittingOptions(DT, LI).setPreserveLCSSA();
 695   SplitCriticalEdge(BI, 0, Options);
 696   SplitCriticalEdge(BI, 1, Options);
 697 }
 698
 699 /// UnswitchTrivialCondition - Given a loop that has a trivial unswitchable
 700 /// condition in it (a cond branch from its header block to its latch block,
 701 /// where the path through the loop that doesn't execute its body has no
 702 /// side-effects), unswitch it.  This doesn't involve any code duplication, just
 703 /// moving the conditional branch outside of the loop and updating loop info.
 704 void LoopUnswitch::UnswitchTrivialCondition(Loop *L, Value *Cond, Constant *Val,
 705                                             BasicBlock *ExitBlock,
 706                                             TerminatorInst *TI) {
 707   DEBUG(dbgs() << "loop-unswitch: Trivial-Unswitch loop %"
 708                << loopHeader->getName() << " [" << L->getBlocks().size()
 709                << " blocks] in Function "
 710                << L->getHeader()->getParent()->getName() << " on cond: " << *Val
 711                << " == " << *Cond << "\n");
 712
 713   // First step, split the preheader, so that we know that there is a safe place
 714   // to insert the conditional branch.  We will change loopPreheader to have a
 715   // conditional branch on Cond.
 716   BasicBlock *NewPH = SplitEdge(loopPreheader, loopHeader, DT, LI);
 717
 718   // Now that we have a place to insert the conditional branch, create a place
 719   // to branch to: this is the exit block out of the loop that we should
 720   // short-circuit to.
 721
 722   // Split this block now, so that the loop maintains its exit block, and so
 723   // that the jump from the preheader can execute the contents of the exit block
 724   // without actually branching to it (the exit block should be dominated by the
 725   // loop header, not the preheader).
 726   assert(!L->contains(ExitBlock) && "Exit block is in the loop?");
 727   BasicBlock *NewExit = SplitBlock(ExitBlock, ExitBlock->begin(), DT, LI);
 728
 729   // Okay, now we have a position to branch from and a position to branch to,
 730   // insert the new conditional branch.
 731   EmitPreheaderBranchOnCondition(Cond, Val, NewExit, NewPH,
 732                                  loopPreheader->getTerminator(), TI);
 733   LPM->deleteSimpleAnalysisValue(loopPreheader->getTerminator(), L);
 734   loopPreheader->getTerminator()->eraseFromParent();
 735
 736   // We need to reprocess this loop, it could be unswitched again.
 737   redoLoop = true;
 738
 739   // Now that we know that the loop is never entered when this condition is a
 740   // particular value, rewrite the loop with this info.  We know that this will
 741   // at least eliminate the old branch.
 742   RewriteLoopBodyWithConditionConstant(L, Cond, Val, false);
 743   ++NumTrivial;
 744 }
 745
 746 /// TryTrivialLoopUnswitch - Check if the first non-constant condition starting from the
 747 /// loop header is a trivial unswitch condition: that is, a condition controls whether
 748 /// or not the loop does anything at all. If it is a trivial condition, unswitching
 749 /// produces no code duplications (equivalently, it produces a simpler loop and a new
 750 /// empty loop, which gets deleted). Therefore always unswitch trivial condition.
 751 ///
 752 bool LoopUnswitch::TryTrivialLoopUnswitch(bool &Changed) {
 753   BasicBlock *CurrentBB = currentLoop->getHeader();
 754   TerminatorInst *CurrentTerm = CurrentBB->getTerminator();
 755   LLVMContext &Context = CurrentBB->getContext();
 756
 757   // If loop header has only one reachable successor (currently via an
 758   // unconditional branch or constant foldable conditional branch, but
 759   // should also consider adding constant foldable switch instruction in
 760   // future), we should keep looking for trivial condition candidates in
 761   // the successor as well. An alternative is to constant fold conditions
 762   // and merge successors into loop header (then we only need to check header's
 763   // terminator). The reason for not doing this in LoopUnswitch pass is that
 764   // it could potentially break LoopPassManager's invariants. Folding dead
 765   // branches could either eliminate the current loop or make other loops
 766   // unreachable. LCSSA form might also not be preserved after deleting branches.
 767   // The following code keeps traversing loop header's successors until it finds
 768   // the trivial condition candidate (condition that is not a constant).
 769   // Since unswitching generates branches with constant conditions, this
 770   // scenario could be very common in practice.
 771   SmallSet<BasicBlock*, 8> Visited;
 772
 773   while (true) {
 774     // If we exit loop or reach a previous visited block, then
 775     // we can not reach any trivial condition candidates (unfoldable
 776     // branch instructions or switch instructions) and no unswitch
 777     // can happen. Exit and return false.
 778     if (!currentLoop->contains(CurrentBB) || !Visited.insert(CurrentBB).second)
 779       return false;
 780
 781     // Check if this loop will execute any side-effecting instructions (e.g.
 782     // stores, calls, volatile loads) in the part of the loop that the code
 783     // *would* execute. Check the header first.
 784     for (BasicBlock::iterator I : *CurrentBB)
 785       if (I->mayHaveSideEffects())
 786         return false;
 787
 788     // FIXME: add check for constant foldable switch instructions.
 789     if (BranchInst *BI = dyn_cast<BranchInst>(CurrentTerm)) {
 790       if (BI->isUnconditional()) {
 791         CurrentBB = BI->getSuccessor(0);
 792       } else if (BI->getCondition() == ConstantInt::getTrue(Context)) {
 793         CurrentBB = BI->getSuccessor(0);
 794       } else if (BI->getCondition() == ConstantInt::getFalse(Context)) {
 795         CurrentBB = BI->getSuccessor(1);
 796       } else {
 797         // Found a trivial condition candidate (non-foldable conditional branch).
 798         break;
 799       }
 800     } else {
 801       break;
 802     }
 803
 804     CurrentTerm = CurrentBB->getTerminator();
 805   }
 806
 807   // CondVal is the condition that controls the trivial condition.
 808   // LoopExitBB is the BasicBlock that loop exits when meets trivial condition.
 809   Constant *CondVal = nullptr;
 810   BasicBlock *LoopExitBB = nullptr;
 811
 812   if (BranchInst *BI = dyn_cast<BranchInst>(CurrentTerm)) {
 813     // If this isn't branching on an invariant condition, we can't unswitch it.
 814     if (!BI->isConditional())
 815       return false;
 816
 817     Value *LoopCond = FindLIVLoopCondition(BI->getCondition(),
 818                                            currentLoop, Changed);
 819
 820     // Unswitch only if the trivial condition itself is an LIV (not
 821     // partial LIV which could occur in and/or)
 822     if (!LoopCond || LoopCond != BI->getCondition())
 823       return false;
 824
 825     // Check to see if a successor of the branch is guaranteed to
 826     // exit through a unique exit block without having any
 827     // side-effects.  If so, determine the value of Cond that causes
 828     // it to do this.
 829     if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
 830                                              BI->getSuccessor(0)))) {
 831       CondVal = ConstantInt::getTrue(Context);
 832     } else if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
 833                                                     BI->getSuccessor(1)))) {
 834       CondVal = ConstantInt::getFalse(Context);
 835     }
 836
 837     // If we didn't find a single unique LoopExit block, or if the loop exit block
 838     // contains phi nodes, this isn't trivial.
 839     if (!LoopExitBB || isa<PHINode>(LoopExitBB->begin()))
 840       return false;   // Can't handle this.
 841
 842     UnswitchTrivialCondition(currentLoop, LoopCond, CondVal, LoopExitBB, CurrentTerm);
 843     ++NumBranches;
 844     return true;
 845   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurrentTerm)) {
 846     // If this isn't switching on an invariant condition, we can't unswitch it.
 847     Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
 848                                            currentLoop, Changed);
 849
 850     // Unswitch only if the trivial condition itself is an LIV (not
 851     // partial LIV which could occur in and/or)
 852     if (!LoopCond || LoopCond != SI->getCondition())
 853       return false;
 854
 855     // Check to see if a successor of the switch is guaranteed to go to the
 856     // latch block or exit through a one exit block without having any
 857     // side-effects.  If so, determine the value of Cond that causes it to do
 858     // this.
 859     // Note that we can't trivially unswitch on the default case or
 860     // on already unswitched cases.
 861     for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
 862          i != e; ++i) {
 863       BasicBlock *LoopExitCandidate;
 864       if ((LoopExitCandidate = isTrivialLoopExitBlock(currentLoop,
 865                                                i.getCaseSuccessor()))) {
 866         // Okay, we found a trivial case, remember the value that is trivial.
 867         ConstantInt *CaseVal = i.getCaseValue();
 868
 869         // Check that it was not unswitched before, since already unswitched
 870         // trivial vals are looks trivial too.
 871         if (BranchesInfo.isUnswitched(SI, CaseVal))
 872           continue;
 873         LoopExitBB = LoopExitCandidate;
 874         CondVal = CaseVal;
 875         break;
 876       }
 877     }
 878
 879     // If we didn't find a single unique LoopExit block, or if the loop exit block
 880     // contains phi nodes, this isn't trivial.
 881     if (!LoopExitBB || isa<PHINode>(LoopExitBB->begin()))
 882       return false;   // Can't handle this.
 883
 884     UnswitchTrivialCondition(currentLoop, LoopCond, CondVal, LoopExitBB, nullptr);
 885     ++NumSwitches;
 886     return true;
 887   }
 888   return false;
 889 }
 890
 891 /// SplitExitEdges - Split all of the edges from inside the loop to their exit
 892 /// blocks.  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 /// UnswitchNontrivialCondition - We determined that the loop is profitable
 909 /// to unswitch when LIC equal Val.  Split it into loop versions and test the
 910 /// condition outside of either loop.  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 /// RemoveFromWorklist - Remove all instances of I from the worklist vector
1056 /// specified.
1057 static void RemoveFromWorklist(Instruction *I,
1058                                std::vector<Instruction*> &Worklist) {
1059
1060   Worklist.erase(std::remove(Worklist.begin(), Worklist.end(), I),
1061                  Worklist.end());
1062 }
1063
1064 /// ReplaceUsesOfWith - When we find that I really equals V, remove I from the
1065 /// program, replacing all uses with V and update the worklist.
1066 static void ReplaceUsesOfWith(Instruction *I, Value *V,
1067                               std::vector<Instruction*> &Worklist,
1068                               Loop *L, LPPassManager *LPM) {
1069   DEBUG(dbgs() << "Replace with '" << *V << "': " << *I);
1070
1071   // Add uses to the worklist, which may be dead now.
1072   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1073     if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1074       Worklist.push_back(Use);
1075
1076   // Add users to the worklist which may be simplified now.
1077   for (User *U : I->users())
1078     Worklist.push_back(cast<Instruction>(U));
1079   LPM->deleteSimpleAnalysisValue(I, L);
1080   RemoveFromWorklist(I, Worklist);
1081   I->replaceAllUsesWith(V);
1082   I->eraseFromParent();
1083   ++NumSimplify;
1084 }
1085
1086 // RewriteLoopBodyWithConditionConstant - We know either that the value LIC has
1087 // the value specified by Val in the specified loop, or we know it does NOT have
1088 // that value.  Rewrite any uses of LIC or of properties correlated to it.
1089 void LoopUnswitch::RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
1090                                                         Constant *Val,
1091                                                         bool IsEqual) {
1092   assert(!isa<Constant>(LIC) && "Why are we unswitching on a constant?");
1093
1094   // FIXME: Support correlated properties, like:
1095   //  for (...)
1096   //    if (li1 < li2)
1097   //      ...
1098   //    if (li1 > li2)
1099   //      ...
1100
1101   // FOLD boolean conditions (X|LIC), (X&LIC).  Fold conditional branches,
1102   // selects, switches.
1103   std::vector<Instruction*> Worklist;
1104   LLVMContext &Context = Val->getContext();
1105
1106   // If we know that LIC == Val, or that LIC == NotVal, just replace uses of LIC
1107   // in the loop with the appropriate one directly.
1108   if (IsEqual || (isa<ConstantInt>(Val) &&
1109       Val->getType()->isIntegerTy(1))) {
1110     Value *Replacement;
1111     if (IsEqual)
1112       Replacement = Val;
1113     else
1114       Replacement = ConstantInt::get(Type::getInt1Ty(Val->getContext()),
1115                                      !cast<ConstantInt>(Val)->getZExtValue());
1116
1117     for (User *U : LIC->users()) {
1118       Instruction *UI = dyn_cast<Instruction>(U);
1119       if (!UI || !L->contains(UI))
1120         continue;
1121       Worklist.push_back(UI);
1122     }
1123
1124     for (std::vector<Instruction*>::iterator UI = Worklist.begin(),
1125          UE = Worklist.end(); UI != UE; ++UI)
1126       (*UI)->replaceUsesOfWith(LIC, Replacement);
1127
1128     SimplifyCode(Worklist, L);
1129     return;
1130   }
1131
1132   // Otherwise, we don't know the precise value of LIC, but we do know that it
1133   // is certainly NOT "Val".  As such, simplify any uses in the loop that we
1134   // can.  This case occurs when we unswitch switch statements.
1135   for (User *U : LIC->users()) {
1136     Instruction *UI = dyn_cast<Instruction>(U);
1137     if (!UI || !L->contains(UI))
1138       continue;
1139
1140     Worklist.push_back(UI);
1141
1142     // TODO: We could do other simplifications, for example, turning
1143     // 'icmp eq LIC, Val' -> false.
1144
1145     // If we know that LIC is not Val, use this info to simplify code.
1146     SwitchInst *SI = dyn_cast<SwitchInst>(UI);
1147     if (!SI || !isa<ConstantInt>(Val)) continue;
1148
1149     SwitchInst::CaseIt DeadCase = SI->findCaseValue(cast<ConstantInt>(Val));
1150     // Default case is live for multiple values.
1151     if (DeadCase == SI->case_default()) continue;
1152
1153     // Found a dead case value.  Don't remove PHI nodes in the
1154     // successor if they become single-entry, those PHI nodes may
1155     // be in the Users list.
1156
1157     BasicBlock *Switch = SI->getParent();
1158     BasicBlock *SISucc = DeadCase.getCaseSuccessor();
1159     BasicBlock *Latch = L->getLoopLatch();
1160
1161     BranchesInfo.setUnswitched(SI, Val);
1162
1163     if (!SI->findCaseDest(SISucc)) continue;  // Edge is critical.
1164     // If the DeadCase successor dominates the loop latch, then the
1165     // transformation isn't safe since it will delete the sole predecessor edge
1166     // to the latch.
1167     if (Latch && DT->dominates(SISucc, Latch))
1168       continue;
1169
1170     // FIXME: This is a hack.  We need to keep the successor around
1171     // and hooked up so as to preserve the loop structure, because
1172     // trying to update it is complicated.  So instead we preserve the
1173     // loop structure and put the block on a dead code path.
1174     SplitEdge(Switch, SISucc, DT, LI);
1175     // Compute the successors instead of relying on the return value
1176     // of SplitEdge, since it may have split the switch successor
1177     // after PHI nodes.
1178     BasicBlock *NewSISucc = DeadCase.getCaseSuccessor();
1179     BasicBlock *OldSISucc = *succ_begin(NewSISucc);
1180     // Create an "unreachable" destination.
1181     BasicBlock *Abort = BasicBlock::Create(Context, "us-unreachable",
1182                                            Switch->getParent(),
1183                                            OldSISucc);
1184     new UnreachableInst(Context, Abort);
1185     // Force the new case destination to branch to the "unreachable"
1186     // block while maintaining a (dead) CFG edge to the old block.
1187     NewSISucc->getTerminator()->eraseFromParent();
1188     BranchInst::Create(Abort, OldSISucc,
1189                        ConstantInt::getTrue(Context), NewSISucc);
1190     // Release the PHI operands for this edge.
1191     for (BasicBlock::iterator II = NewSISucc->begin();
1192          PHINode *PN = dyn_cast<PHINode>(II); ++II)
1193       PN->setIncomingValue(PN->getBasicBlockIndex(Switch),
1194                            UndefValue::get(PN->getType()));
1195     // Tell the domtree about the new block. We don't fully update the
1196     // domtree here -- instead we force it to do a full recomputation
1197     // after the pass is complete -- but we do need to inform it of
1198     // new blocks.
1199     if (DT)
1200       DT->addNewBlock(Abort, NewSISucc);
1201   }
1202
1203   SimplifyCode(Worklist, L);
1204 }
1205
1206 /// SimplifyCode - Okay, now that we have simplified some instructions in the
1207 /// loop, walk over it and constant prop, dce, and fold control flow where
1208 /// possible.  Note that this is effectively a very simple loop-structure-aware
1209 /// optimizer.  During processing of this loop, L could very well be deleted, so
1210 /// it must not be used.
1211 ///
1212 /// FIXME: When the loop optimizer is more mature, separate this out to a new
1213 /// pass.
1214 ///
1215 void LoopUnswitch::SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L) {
1216   const DataLayout &DL = L->getHeader()->getModule()->getDataLayout();
1217   while (!Worklist.empty()) {
1218     Instruction *I = Worklist.back();
1219     Worklist.pop_back();
1220
1221     // Simple DCE.
1222     if (isInstructionTriviallyDead(I)) {
1223       DEBUG(dbgs() << "Remove dead instruction '" << *I);
1224
1225       // Add uses to the worklist, which may be dead now.
1226       for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1227         if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1228           Worklist.push_back(Use);
1229       LPM->deleteSimpleAnalysisValue(I, L);
1230       RemoveFromWorklist(I, Worklist);
1231       I->eraseFromParent();
1232       ++NumSimplify;
1233       continue;
1234     }
1235
1236     // See if instruction simplification can hack this up.  This is common for
1237     // things like "select false, X, Y" after unswitching made the condition be
1238     // 'false'.  TODO: update the domtree properly so we can pass it here.
1239     if (Value *V = SimplifyInstruction(I, DL))
1240       if (LI->replacementPreservesLCSSAForm(I, V)) {
1241         ReplaceUsesOfWith(I, V, Worklist, L, LPM);
1242         continue;
1243       }
1244
1245     // Special case hacks that appear commonly in unswitched code.
1246     if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
1247       if (BI->isUnconditional()) {
1248         // If BI's parent is the only pred of the successor, fold the two blocks
1249         // together.
1250         BasicBlock *Pred = BI->getParent();
1251         BasicBlock *Succ = BI->getSuccessor(0);
1252         BasicBlock *SinglePred = Succ->getSinglePredecessor();
1253         if (!SinglePred) continue;  // Nothing to do.
1254         assert(SinglePred == Pred && "CFG broken");
1255
1256         DEBUG(dbgs() << "Merging blocks: " << Pred->getName() << " <- "
1257               << Succ->getName() << "\n");
1258
1259         // Resolve any single entry PHI nodes in Succ.
1260         while (PHINode *PN = dyn_cast<PHINode>(Succ->begin()))
1261           ReplaceUsesOfWith(PN, PN->getIncomingValue(0), Worklist, L, LPM);
1262
1263         // If Succ has any successors with PHI nodes, update them to have
1264         // entries coming from Pred instead of Succ.
1265         Succ->replaceAllUsesWith(Pred);
1266
1267         // Move all of the successor contents from Succ to Pred.
1268         Pred->getInstList().splice(BI, Succ->getInstList(), Succ->begin(),
1269                                    Succ->end());
1270         LPM->deleteSimpleAnalysisValue(BI, L);
1271         BI->eraseFromParent();
1272         RemoveFromWorklist(BI, Worklist);
1273
1274         // Remove Succ from the loop tree.
1275         LI->removeBlock(Succ);
1276         LPM->deleteSimpleAnalysisValue(Succ, L);
1277         Succ->eraseFromParent();
1278         ++NumSimplify;
1279         continue;
1280       }
1281
1282       continue;
1283     }
1284   }
1285 }