lib/Transforms/Scalar/JumpThreading.cpp

   1 //===- JumpThreading.cpp - Thread control through conditional blocks ------===//
   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 file implements the Jump Threading pass.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Transforms/Scalar.h"
  15 #include "llvm/ADT/DenseMap.h"
  16 #include "llvm/ADT/DenseSet.h"
  17 #include "llvm/ADT/STLExtras.h"
  18 #include "llvm/ADT/SmallPtrSet.h"
  19 #include "llvm/ADT/SmallSet.h"
  20 #include "llvm/ADT/Statistic.h"
  21 #include "llvm/Analysis/GlobalsModRef.h"
  22 #include "llvm/Analysis/CFG.h"
  23 #include "llvm/Analysis/BlockFrequencyInfo.h"
  24 #include "llvm/Analysis/BlockFrequencyInfoImpl.h"
  25 #include "llvm/Analysis/BranchProbabilityInfo.h"
  26 #include "llvm/Analysis/ConstantFolding.h"
  27 #include "llvm/Analysis/InstructionSimplify.h"
  28 #include "llvm/Analysis/LazyValueInfo.h"
  29 #include "llvm/Analysis/Loads.h"
  30 #include "llvm/Analysis/LoopInfo.h"
  31 #include "llvm/Analysis/TargetLibraryInfo.h"
  32 #include "llvm/Analysis/ValueTracking.h"
  33 #include "llvm/IR/DataLayout.h"
  34 #include "llvm/IR/IntrinsicInst.h"
  35 #include "llvm/IR/LLVMContext.h"
  36 #include "llvm/IR/MDBuilder.h"
  37 #include "llvm/IR/Metadata.h"
  38 #include "llvm/IR/ValueHandle.h"
  39 #include "llvm/Pass.h"
  40 #include "llvm/Support/CommandLine.h"
  41 #include "llvm/Support/Debug.h"
  42 #include "llvm/Support/raw_ostream.h"
  43 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  44 #include "llvm/Transforms/Utils/Local.h"
  45 #include "llvm/Transforms/Utils/SSAUpdater.h"
  46 #include <algorithm>
  47 #include <memory>
  48 using namespace llvm;
  49
  50 #define DEBUG_TYPE "jump-threading"
  51
  52 STATISTIC(NumThreads, "Number of jumps threaded");
  53 STATISTIC(NumFolds,   "Number of terminators folded");
  54 STATISTIC(NumDupes,   "Number of branch blocks duplicated to eliminate phi");
  55
  56 static cl::opt<unsigned>
  57 BBDuplicateThreshold("jump-threading-threshold",
  58           cl::desc("Max block size to duplicate for jump threading"),
  59           cl::init(6), cl::Hidden);
  60
  61 static cl::opt<unsigned>
  62 ImplicationSearchThreshold(
  63   "jump-threading-implication-search-threshold",
  64   cl::desc("The number of predecessors to search for a stronger "
  65            "condition to use to thread over a weaker condition"),
  66   cl::init(3), cl::Hidden);
  67
  68 namespace {
  69   // These are at global scope so static functions can use them too.
  70   typedef SmallVectorImpl<std::pair<Constant*, BasicBlock*> > PredValueInfo;
  71   typedef SmallVector<std::pair<Constant*, BasicBlock*>, 8> PredValueInfoTy;
  72
  73   // This is used to keep track of what kind of constant we're currently hoping
  74   // to find.
  75   enum ConstantPreference {
  76     WantInteger,
  77     WantBlockAddress
  78   };
  79
  80   /// This pass performs 'jump threading', which looks at blocks that have
  81   /// multiple predecessors and multiple successors.  If one or more of the
  82   /// predecessors of the block can be proven to always jump to one of the
  83   /// successors, we forward the edge from the predecessor to the successor by
  84   /// duplicating the contents of this block.
  85   ///
  86   /// An example of when this can occur is code like this:
  87   ///
  88   ///   if () { ...
  89   ///     X = 4;
  90   ///   }
  91   ///   if (X < 3) {
  92   ///
  93   /// In this case, the unconditional branch at the end of the first if can be
  94   /// revectored to the false side of the second if.
  95   ///
  96   class JumpThreading : public FunctionPass {
  97     TargetLibraryInfo *TLI;
  98     LazyValueInfo *LVI;
  99     std::unique_ptr<BlockFrequencyInfo> BFI;
 100     std::unique_ptr<BranchProbabilityInfo> BPI;
 101     bool HasProfileData;
 102 #ifdef NDEBUG
 103     SmallPtrSet<BasicBlock*, 16> LoopHeaders;
 104 #else
 105     SmallSet<AssertingVH<BasicBlock>, 16> LoopHeaders;
 106 #endif
 107     DenseSet<std::pair<Value*, BasicBlock*> > RecursionSet;
 108
 109     unsigned BBDupThreshold;
 110
 111     // RAII helper for updating the recursion stack.
 112     struct RecursionSetRemover {
 113       DenseSet<std::pair<Value*, BasicBlock*> > &TheSet;
 114       std::pair<Value*, BasicBlock*> ThePair;
 115
 116       RecursionSetRemover(DenseSet<std::pair<Value*, BasicBlock*> > &S,
 117                           std::pair<Value*, BasicBlock*> P)
 118         : TheSet(S), ThePair(P) { }
 119
 120       ~RecursionSetRemover() {
 121         TheSet.erase(ThePair);
 122       }
 123     };
 124   public:
 125     static char ID; // Pass identification
 126     JumpThreading(int T = -1) : FunctionPass(ID) {
 127       BBDupThreshold = (T == -1) ? BBDuplicateThreshold : unsigned(T);
 128       initializeJumpThreadingPass(*PassRegistry::getPassRegistry());
 129     }
 130
 131     bool runOnFunction(Function &F) override;
 132
 133     void getAnalysisUsage(AnalysisUsage &AU) const override {
 134       AU.addRequired<LazyValueInfo>();
 135       AU.addPreserved<LazyValueInfo>();
 136       AU.addPreserved<GlobalsAAWrapperPass>();
 137       AU.addRequired<TargetLibraryInfoWrapperPass>();
 138     }
 139
 140     void releaseMemory() override {
 141       BFI.reset();
 142       BPI.reset();
 143     }
 144
 145     void FindLoopHeaders(Function &F);
 146     bool ProcessBlock(BasicBlock *BB);
 147     bool ThreadEdge(BasicBlock *BB, const SmallVectorImpl<BasicBlock*> &PredBBs,
 148                     BasicBlock *SuccBB);
 149     bool DuplicateCondBranchOnPHIIntoPred(BasicBlock *BB,
 150                                   const SmallVectorImpl<BasicBlock *> &PredBBs);
 151
 152     bool ComputeValueKnownInPredecessors(Value *V, BasicBlock *BB,
 153                                          PredValueInfo &Result,
 154                                          ConstantPreference Preference,
 155                                          Instruction *CxtI = nullptr);
 156     bool ProcessThreadableEdges(Value *Cond, BasicBlock *BB,
 157                                 ConstantPreference Preference,
 158                                 Instruction *CxtI = nullptr);
 159
 160     bool ProcessBranchOnPHI(PHINode *PN);
 161     bool ProcessBranchOnXOR(BinaryOperator *BO);
 162     bool ProcessImpliedCondition(BasicBlock *BB);
 163
 164     bool SimplifyPartiallyRedundantLoad(LoadInst *LI);
 165     bool TryToUnfoldSelect(CmpInst *CondCmp, BasicBlock *BB);
 166
 167   private:
 168     BasicBlock *SplitBlockPreds(BasicBlock *BB, ArrayRef<BasicBlock *> Preds,
 169                                 const char *Suffix);
 170     void UpdateBlockFreqAndEdgeWeight(BasicBlock *PredBB, BasicBlock *BB,
 171                                       BasicBlock *NewBB, BasicBlock *SuccBB);
 172   };
 173 }
 174
 175 char JumpThreading::ID = 0;
 176 INITIALIZE_PASS_BEGIN(JumpThreading, "jump-threading",
 177                 "Jump Threading", false, false)
 178 INITIALIZE_PASS_DEPENDENCY(LazyValueInfo)
 179 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
 180 INITIALIZE_PASS_END(JumpThreading, "jump-threading",
 181                 "Jump Threading", false, false)
 182
 183 // Public interface to the Jump Threading pass
 184 FunctionPass *llvm::createJumpThreadingPass(int Threshold) { return new JumpThreading(Threshold); }
 185
 186 /// runOnFunction - Top level algorithm.
 187 ///
 188 bool JumpThreading::runOnFunction(Function &F) {
 189   if (skipOptnoneFunction(F))
 190     return false;
 191
 192   DEBUG(dbgs() << "Jump threading on function '" << F.getName() << "'\n");
 193   TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
 194   LVI = &getAnalysis<LazyValueInfo>();
 195   BFI.reset();
 196   BPI.reset();
 197   // When profile data is available, we need to update edge weights after
 198   // successful jump threading, which requires both BPI and BFI being available.
 199   HasProfileData = F.getEntryCount().hasValue();
 200   if (HasProfileData) {
 201     LoopInfo LI{DominatorTree(F)};
 202     BPI.reset(new BranchProbabilityInfo(F, LI));
 203     BFI.reset(new BlockFrequencyInfo(F, *BPI, LI));
 204   }
 205
 206   // Remove unreachable blocks from function as they may result in infinite
 207   // loop. We do threading if we found something profitable. Jump threading a
 208   // branch can create other opportunities. If these opportunities form a cycle
 209   // i.e. if any jump threading is undoing previous threading in the path, then
 210   // we will loop forever. We take care of this issue by not jump threading for
 211   // back edges. This works for normal cases but not for unreachable blocks as
 212   // they may have cycle with no back edge.
 213   removeUnreachableBlocks(F);
 214
 215   FindLoopHeaders(F);
 216
 217   bool Changed, EverChanged = false;
 218   do {
 219     Changed = false;
 220     for (Function::iterator I = F.begin(), E = F.end(); I != E;) {
 221       BasicBlock *BB = &*I;
 222       // Thread all of the branches we can over this block.
 223       while (ProcessBlock(BB))
 224         Changed = true;
 225
 226       ++I;
 227
 228       // If the block is trivially dead, zap it.  This eliminates the successor
 229       // edges which simplifies the CFG.
 230       if (pred_empty(BB) &&
 231           BB != &BB->getParent()->getEntryBlock()) {
 232         DEBUG(dbgs() << "  JT: Deleting dead block '" << BB->getName()
 233               << "' with terminator: " << *BB->getTerminator() << '\n');
 234         LoopHeaders.erase(BB);
 235         LVI->eraseBlock(BB);
 236         DeleteDeadBlock(BB);
 237         Changed = true;
 238         continue;
 239       }
 240
 241       BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator());
 242
 243       // Can't thread an unconditional jump, but if the block is "almost
 244       // empty", we can replace uses of it with uses of the successor and make
 245       // this dead.
 246       if (BI && BI->isUnconditional() &&
 247           BB != &BB->getParent()->getEntryBlock() &&
 248           // If the terminator is the only non-phi instruction, try to nuke it.
 249           BB->getFirstNonPHIOrDbg()->isTerminator()) {
 250         // Since TryToSimplifyUncondBranchFromEmptyBlock may delete the
 251         // block, we have to make sure it isn't in the LoopHeaders set.  We
 252         // reinsert afterward if needed.
 253         bool ErasedFromLoopHeaders = LoopHeaders.erase(BB);
 254         BasicBlock *Succ = BI->getSuccessor(0);
 255
 256         // FIXME: It is always conservatively correct to drop the info
 257         // for a block even if it doesn't get erased.  This isn't totally
 258         // awesome, but it allows us to use AssertingVH to prevent nasty
 259         // dangling pointer issues within LazyValueInfo.
 260         LVI->eraseBlock(BB);
 261         if (TryToSimplifyUncondBranchFromEmptyBlock(BB)) {
 262           Changed = true;
 263           // If we deleted BB and BB was the header of a loop, then the
 264           // successor is now the header of the loop.
 265           BB = Succ;
 266         }
 267
 268         if (ErasedFromLoopHeaders)
 269           LoopHeaders.insert(BB);
 270       }
 271     }
 272     EverChanged |= Changed;
 273   } while (Changed);
 274
 275   LoopHeaders.clear();
 276   return EverChanged;
 277 }
 278
 279 /// getJumpThreadDuplicationCost - Return the cost of duplicating this block to
 280 /// thread across it. Stop scanning the block when passing the threshold.
 281 static unsigned getJumpThreadDuplicationCost(const BasicBlock *BB,
 282                                              unsigned Threshold) {
 283   /// Ignore PHI nodes, these will be flattened when duplication happens.
 284   BasicBlock::const_iterator I(BB->getFirstNonPHI());
 285
 286   // FIXME: THREADING will delete values that are just used to compute the
 287   // branch, so they shouldn't count against the duplication cost.
 288
 289   // Sum up the cost of each instruction until we get to the terminator.  Don't
 290   // include the terminator because the copy won't include it.
 291   unsigned Size = 0;
 292   for (; !isa<TerminatorInst>(I); ++I) {
 293
 294     // Stop scanning the block if we've reached the threshold.
 295     if (Size > Threshold)
 296       return Size;
 297
 298     // Debugger intrinsics don't incur code size.
 299     if (isa<DbgInfoIntrinsic>(I)) continue;
 300
 301     // If this is a pointer->pointer bitcast, it is free.
 302     if (isa<BitCastInst>(I) && I->getType()->isPointerTy())
 303       continue;
 304
 305     // Bail out if this instruction gives back a token type, it is not possible
 306     // to duplicate it if it is used outside this BB.
 307     if (I->getType()->isTokenTy() && I->isUsedOutsideOfBlock(BB))
 308       return ~0U;
 309
 310     // All other instructions count for at least one unit.
 311     ++Size;
 312
 313     // Calls are more expensive.  If they are non-intrinsic calls, we model them
 314     // as having cost of 4.  If they are a non-vector intrinsic, we model them
 315     // as having cost of 2 total, and if they are a vector intrinsic, we model
 316     // them as having cost 1.
 317     if (const CallInst *CI = dyn_cast<CallInst>(I)) {
 318       if (CI->cannotDuplicate() || CI->isConvergent())
 319         // Blocks with NoDuplicate are modelled as having infinite cost, so they
 320         // are never duplicated.
 321         return ~0U;
 322       else if (!isa<IntrinsicInst>(CI))
 323         Size += 3;
 324       else if (!CI->getType()->isVectorTy())
 325         Size += 1;
 326     }
 327   }
 328
 329   // Threading through a switch statement is particularly profitable.  If this
 330   // block ends in a switch, decrease its cost to make it more likely to happen.
 331   if (isa<SwitchInst>(I))
 332     Size = Size > 6 ? Size-6 : 0;
 333
 334   // The same holds for indirect branches, but slightly more so.
 335   if (isa<IndirectBrInst>(I))
 336     Size = Size > 8 ? Size-8 : 0;
 337
 338   return Size;
 339 }
 340
 341 /// FindLoopHeaders - We do not want jump threading to turn proper loop
 342 /// structures into irreducible loops.  Doing this breaks up the loop nesting
 343 /// hierarchy and pessimizes later transformations.  To prevent this from
 344 /// happening, we first have to find the loop headers.  Here we approximate this
 345 /// by finding targets of backedges in the CFG.
 346 ///
 347 /// Note that there definitely are cases when we want to allow threading of
 348 /// edges across a loop header.  For example, threading a jump from outside the
 349 /// loop (the preheader) to an exit block of the loop is definitely profitable.
 350 /// It is also almost always profitable to thread backedges from within the loop
 351 /// to exit blocks, and is often profitable to thread backedges to other blocks
 352 /// within the loop (forming a nested loop).  This simple analysis is not rich
 353 /// enough to track all of these properties and keep it up-to-date as the CFG
 354 /// mutates, so we don't allow any of these transformations.
 355 ///
 356 void JumpThreading::FindLoopHeaders(Function &F) {
 357   SmallVector<std::pair<const BasicBlock*,const BasicBlock*>, 32> Edges;
 358   FindFunctionBackedges(F, Edges);
 359
 360   for (unsigned i = 0, e = Edges.size(); i != e; ++i)
 361     LoopHeaders.insert(const_cast<BasicBlock*>(Edges[i].second));
 362 }
 363
 364 /// getKnownConstant - Helper method to determine if we can thread over a
 365 /// terminator with the given value as its condition, and if so what value to
 366 /// use for that. What kind of value this is depends on whether we want an
 367 /// integer or a block address, but an undef is always accepted.
 368 /// Returns null if Val is null or not an appropriate constant.
 369 static Constant *getKnownConstant(Value *Val, ConstantPreference Preference) {
 370   if (!Val)
 371     return nullptr;
 372
 373   // Undef is "known" enough.
 374   if (UndefValue *U = dyn_cast<UndefValue>(Val))
 375     return U;
 376
 377   if (Preference == WantBlockAddress)
 378     return dyn_cast<BlockAddress>(Val->stripPointerCasts());
 379
 380   return dyn_cast<ConstantInt>(Val);
 381 }
 382
 383 /// ComputeValueKnownInPredecessors - Given a basic block BB and a value V, see
 384 /// if we can infer that the value is a known ConstantInt/BlockAddress or undef
 385 /// in any of our predecessors.  If so, return the known list of value and pred
 386 /// BB in the result vector.
 387 ///
 388 /// This returns true if there were any known values.
 389 ///
 390 bool JumpThreading::
 391 ComputeValueKnownInPredecessors(Value *V, BasicBlock *BB, PredValueInfo &Result,
 392                                 ConstantPreference Preference,
 393                                 Instruction *CxtI) {
 394   // This method walks up use-def chains recursively.  Because of this, we could
 395   // get into an infinite loop going around loops in the use-def chain.  To
 396   // prevent this, keep track of what (value, block) pairs we've already visited
 397   // and terminate the search if we loop back to them
 398   if (!RecursionSet.insert(std::make_pair(V, BB)).second)
 399     return false;
 400
 401   // An RAII help to remove this pair from the recursion set once the recursion
 402   // stack pops back out again.
 403   RecursionSetRemover remover(RecursionSet, std::make_pair(V, BB));
 404
 405   // If V is a constant, then it is known in all predecessors.
 406   if (Constant *KC = getKnownConstant(V, Preference)) {
 407     for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
 408       Result.push_back(std::make_pair(KC, *PI));
 409
 410     return true;
 411   }
 412
 413   // If V is a non-instruction value, or an instruction in a different block,
 414   // then it can't be derived from a PHI.
 415   Instruction *I = dyn_cast<Instruction>(V);
 416   if (!I || I->getParent() != BB) {
 417
 418     // Okay, if this is a live-in value, see if it has a known value at the end
 419     // of any of our predecessors.
 420     //
 421     // FIXME: This should be an edge property, not a block end property.
 422     /// TODO: Per PR2563, we could infer value range information about a
 423     /// predecessor based on its terminator.
 424     //
 425     // FIXME: change this to use the more-rich 'getPredicateOnEdge' method if
 426     // "I" is a non-local compare-with-a-constant instruction.  This would be
 427     // able to handle value inequalities better, for example if the compare is
 428     // "X < 4" and "X < 3" is known true but "X < 4" itself is not available.
 429     // Perhaps getConstantOnEdge should be smart enough to do this?
 430
 431     for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
 432       BasicBlock *P = *PI;
 433       // If the value is known by LazyValueInfo to be a constant in a
 434       // predecessor, use that information to try to thread this block.
 435       Constant *PredCst = LVI->getConstantOnEdge(V, P, BB, CxtI);
 436       if (Constant *KC = getKnownConstant(PredCst, Preference))
 437         Result.push_back(std::make_pair(KC, P));
 438     }
 439
 440     return !Result.empty();
 441   }
 442
 443   /// If I is a PHI node, then we know the incoming values for any constants.
 444   if (PHINode *PN = dyn_cast<PHINode>(I)) {
 445     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 446       Value *InVal = PN->getIncomingValue(i);
 447       if (Constant *KC = getKnownConstant(InVal, Preference)) {
 448         Result.push_back(std::make_pair(KC, PN->getIncomingBlock(i)));
 449       } else {
 450         Constant *CI = LVI->getConstantOnEdge(InVal,
 451                                               PN->getIncomingBlock(i),
 452                                               BB, CxtI);
 453         if (Constant *KC = getKnownConstant(CI, Preference))
 454           Result.push_back(std::make_pair(KC, PN->getIncomingBlock(i)));
 455       }
 456     }
 457
 458     return !Result.empty();
 459   }
 460
 461   PredValueInfoTy LHSVals, RHSVals;
 462
 463   // Handle some boolean conditions.
 464   if (I->getType()->getPrimitiveSizeInBits() == 1) {
 465     assert(Preference == WantInteger && "One-bit non-integer type?");
 466     // X | true -> true
 467     // X & false -> false
 468     if (I->getOpcode() == Instruction::Or ||
 469         I->getOpcode() == Instruction::And) {
 470       ComputeValueKnownInPredecessors(I->getOperand(0), BB, LHSVals,
 471                                       WantInteger, CxtI);
 472       ComputeValueKnownInPredecessors(I->getOperand(1), BB, RHSVals,
 473                                       WantInteger, CxtI);
 474
 475       if (LHSVals.empty() && RHSVals.empty())
 476         return false;
 477
 478       ConstantInt *InterestingVal;
 479       if (I->getOpcode() == Instruction::Or)
 480         InterestingVal = ConstantInt::getTrue(I->getContext());
 481       else
 482         InterestingVal = ConstantInt::getFalse(I->getContext());
 483
 484       SmallPtrSet<BasicBlock*, 4> LHSKnownBBs;
 485
 486       // Scan for the sentinel.  If we find an undef, force it to the
 487       // interesting value: x|undef -> true and x&undef -> false.
 488       for (unsigned i = 0, e = LHSVals.size(); i != e; ++i)
 489         if (LHSVals[i].first == InterestingVal ||
 490             isa<UndefValue>(LHSVals[i].first)) {
 491           Result.push_back(LHSVals[i]);
 492           Result.back().first = InterestingVal;
 493           LHSKnownBBs.insert(LHSVals[i].second);
 494         }
 495       for (unsigned i = 0, e = RHSVals.size(); i != e; ++i)
 496         if (RHSVals[i].first == InterestingVal ||
 497             isa<UndefValue>(RHSVals[i].first)) {
 498           // If we already inferred a value for this block on the LHS, don't
 499           // re-add it.
 500           if (!LHSKnownBBs.count(RHSVals[i].second)) {
 501             Result.push_back(RHSVals[i]);
 502             Result.back().first = InterestingVal;
 503           }
 504         }
 505
 506       return !Result.empty();
 507     }
 508
 509     // Handle the NOT form of XOR.
 510     if (I->getOpcode() == Instruction::Xor &&
 511         isa<ConstantInt>(I->getOperand(1)) &&
 512         cast<ConstantInt>(I->getOperand(1))->isOne()) {
 513       ComputeValueKnownInPredecessors(I->getOperand(0), BB, Result,
 514                                       WantInteger, CxtI);
 515       if (Result.empty())
 516         return false;
 517
 518       // Invert the known values.
 519       for (unsigned i = 0, e = Result.size(); i != e; ++i)
 520         Result[i].first = ConstantExpr::getNot(Result[i].first);
 521
 522       return true;
 523     }
 524
 525   // Try to simplify some other binary operator values.
 526   } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) {
 527     assert(Preference != WantBlockAddress
 528             && "A binary operator creating a block address?");
 529     if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
 530       PredValueInfoTy LHSVals;
 531       ComputeValueKnownInPredecessors(BO->getOperand(0), BB, LHSVals,
 532                                       WantInteger, CxtI);
 533
 534       // Try to use constant folding to simplify the binary operator.
 535       for (unsigned i = 0, e = LHSVals.size(); i != e; ++i) {
 536         Constant *V = LHSVals[i].first;
 537         Constant *Folded = ConstantExpr::get(BO->getOpcode(), V, CI);
 538
 539         if (Constant *KC = getKnownConstant(Folded, WantInteger))
 540           Result.push_back(std::make_pair(KC, LHSVals[i].second));
 541       }
 542     }
 543
 544     return !Result.empty();
 545   }
 546
 547   // Handle compare with phi operand, where the PHI is defined in this block.
 548   if (CmpInst *Cmp = dyn_cast<CmpInst>(I)) {
 549     assert(Preference == WantInteger && "Compares only produce integers");
 550     PHINode *PN = dyn_cast<PHINode>(Cmp->getOperand(0));
 551     if (PN && PN->getParent() == BB) {
 552       const DataLayout &DL = PN->getModule()->getDataLayout();
 553       // We can do this simplification if any comparisons fold to true or false.
 554       // See if any do.
 555       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 556         BasicBlock *PredBB = PN->getIncomingBlock(i);
 557         Value *LHS = PN->getIncomingValue(i);
 558         Value *RHS = Cmp->getOperand(1)->DoPHITranslation(BB, PredBB);
 559
 560         Value *Res = SimplifyCmpInst(Cmp->getPredicate(), LHS, RHS, DL);
 561         if (!Res) {
 562           if (!isa<Constant>(RHS))
 563             continue;
 564
 565           LazyValueInfo::Tristate
 566             ResT = LVI->getPredicateOnEdge(Cmp->getPredicate(), LHS,
 567                                            cast<Constant>(RHS), PredBB, BB,
 568                                            CxtI ? CxtI : Cmp);
 569           if (ResT == LazyValueInfo::Unknown)
 570             continue;
 571           Res = ConstantInt::get(Type::getInt1Ty(LHS->getContext()), ResT);
 572         }
 573
 574         if (Constant *KC = getKnownConstant(Res, WantInteger))
 575           Result.push_back(std::make_pair(KC, PredBB));
 576       }
 577
 578       return !Result.empty();
 579     }
 580
 581     // If comparing a live-in value against a constant, see if we know the
 582     // live-in value on any predecessors.
 583     if (isa<Constant>(Cmp->getOperand(1)) && Cmp->getType()->isIntegerTy()) {
 584       if (!isa<Instruction>(Cmp->getOperand(0)) ||
 585           cast<Instruction>(Cmp->getOperand(0))->getParent() != BB) {
 586         Constant *RHSCst = cast<Constant>(Cmp->getOperand(1));
 587
 588         for (pred_iterator PI = pred_begin(BB), E = pred_end(BB);PI != E; ++PI){
 589           BasicBlock *P = *PI;
 590           // If the value is known by LazyValueInfo to be a constant in a
 591           // predecessor, use that information to try to thread this block.
 592           LazyValueInfo::Tristate Res =
 593             LVI->getPredicateOnEdge(Cmp->getPredicate(), Cmp->getOperand(0),
 594                                     RHSCst, P, BB, CxtI ? CxtI : Cmp);
 595           if (Res == LazyValueInfo::Unknown)
 596             continue;
 597
 598           Constant *ResC = ConstantInt::get(Cmp->getType(), Res);
 599           Result.push_back(std::make_pair(ResC, P));
 600         }
 601
 602         return !Result.empty();
 603       }
 604
 605       // Try to find a constant value for the LHS of a comparison,
 606       // and evaluate it statically if we can.
 607       if (Constant *CmpConst = dyn_cast<Constant>(Cmp->getOperand(1))) {
 608         PredValueInfoTy LHSVals;
 609         ComputeValueKnownInPredecessors(I->getOperand(0), BB, LHSVals,
 610                                         WantInteger, CxtI);
 611
 612         for (unsigned i = 0, e = LHSVals.size(); i != e; ++i) {
 613           Constant *V = LHSVals[i].first;
 614           Constant *Folded = ConstantExpr::getCompare(Cmp->getPredicate(),
 615                                                       V, CmpConst);
 616           if (Constant *KC = getKnownConstant(Folded, WantInteger))
 617             Result.push_back(std::make_pair(KC, LHSVals[i].second));
 618         }
 619
 620         return !Result.empty();
 621       }
 622     }
 623   }
 624
 625   if (SelectInst *SI = dyn_cast<SelectInst>(I)) {
 626     // Handle select instructions where at least one operand is a known constant
 627     // and we can figure out the condition value for any predecessor block.
 628     Constant *TrueVal = getKnownConstant(SI->getTrueValue(), Preference);
 629     Constant *FalseVal = getKnownConstant(SI->getFalseValue(), Preference);
 630     PredValueInfoTy Conds;
 631     if ((TrueVal || FalseVal) &&
 632         ComputeValueKnownInPredecessors(SI->getCondition(), BB, Conds,
 633                                         WantInteger, CxtI)) {
 634       for (unsigned i = 0, e = Conds.size(); i != e; ++i) {
 635         Constant *Cond = Conds[i].first;
 636
 637         // Figure out what value to use for the condition.
 638         bool KnownCond;
 639         if (ConstantInt *CI = dyn_cast<ConstantInt>(Cond)) {
 640           // A known boolean.
 641           KnownCond = CI->isOne();
 642         } else {
 643           assert(isa<UndefValue>(Cond) && "Unexpected condition value");
 644           // Either operand will do, so be sure to pick the one that's a known
 645           // constant.
 646           // FIXME: Do this more cleverly if both values are known constants?
 647           KnownCond = (TrueVal != nullptr);
 648         }
 649
 650         // See if the select has a known constant value for this predecessor.
 651         if (Constant *Val = KnownCond ? TrueVal : FalseVal)
 652           Result.push_back(std::make_pair(Val, Conds[i].second));
 653       }
 654
 655       return !Result.empty();
 656     }
 657   }
 658
 659   // If all else fails, see if LVI can figure out a constant value for us.
 660   Constant *CI = LVI->getConstant(V, BB, CxtI);
 661   if (Constant *KC = getKnownConstant(CI, Preference)) {
 662     for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
 663       Result.push_back(std::make_pair(KC, *PI));
 664   }
 665
 666   return !Result.empty();
 667 }
 668
 669
 670
 671 /// GetBestDestForBranchOnUndef - If we determine that the specified block ends
 672 /// in an undefined jump, decide which block is best to revector to.
 673 ///
 674 /// Since we can pick an arbitrary destination, we pick the successor with the
 675 /// fewest predecessors.  This should reduce the in-degree of the others.
 676 ///
 677 static unsigned GetBestDestForJumpOnUndef(BasicBlock *BB) {
 678   TerminatorInst *BBTerm = BB->getTerminator();
 679   unsigned MinSucc = 0;
 680   BasicBlock *TestBB = BBTerm->getSuccessor(MinSucc);
 681   // Compute the successor with the minimum number of predecessors.
 682   unsigned MinNumPreds = std::distance(pred_begin(TestBB), pred_end(TestBB));
 683   for (unsigned i = 1, e = BBTerm->getNumSuccessors(); i != e; ++i) {
 684     TestBB = BBTerm->getSuccessor(i);
 685     unsigned NumPreds = std::distance(pred_begin(TestBB), pred_end(TestBB));
 686     if (NumPreds < MinNumPreds) {
 687       MinSucc = i;
 688       MinNumPreds = NumPreds;
 689     }
 690   }
 691
 692   return MinSucc;
 693 }
 694
 695 static bool hasAddressTakenAndUsed(BasicBlock *BB) {
 696   if (!BB->hasAddressTaken()) return false;
 697
 698   // If the block has its address taken, it may be a tree of dead constants
 699   // hanging off of it.  These shouldn't keep the block alive.
 700   BlockAddress *BA = BlockAddress::get(BB);
 701   BA->removeDeadConstantUsers();
 702   return !BA->use_empty();
 703 }
 704
 705 /// ProcessBlock - If there are any predecessors whose control can be threaded
 706 /// through to a successor, transform them now.
 707 bool JumpThreading::ProcessBlock(BasicBlock *BB) {
 708   // If the block is trivially dead, just return and let the caller nuke it.
 709   // This simplifies other transformations.
 710   if (pred_empty(BB) &&
 711       BB != &BB->getParent()->getEntryBlock())
 712     return false;
 713
 714   // If this block has a single predecessor, and if that pred has a single
 715   // successor, merge the blocks.  This encourages recursive jump threading
 716   // because now the condition in this block can be threaded through
 717   // predecessors of our predecessor block.
 718   if (BasicBlock *SinglePred = BB->getSinglePredecessor()) {
 719     const TerminatorInst *TI = SinglePred->getTerminator();
 720     if (!TI->isExceptional() && TI->getNumSuccessors() == 1 &&
 721         SinglePred != BB && !hasAddressTakenAndUsed(BB)) {
 722       // If SinglePred was a loop header, BB becomes one.
 723       if (LoopHeaders.erase(SinglePred))
 724         LoopHeaders.insert(BB);
 725
 726       LVI->eraseBlock(SinglePred);
 727       MergeBasicBlockIntoOnlyPred(BB);
 728
 729       return true;
 730     }
 731   }
 732
 733   // What kind of constant we're looking for.
 734   ConstantPreference Preference = WantInteger;
 735
 736   // Look to see if the terminator is a conditional branch, switch or indirect
 737   // branch, if not we can't thread it.
 738   Value *Condition;
 739   Instruction *Terminator = BB->getTerminator();
 740   if (BranchInst *BI = dyn_cast<BranchInst>(Terminator)) {
 741     // Can't thread an unconditional jump.
 742     if (BI->isUnconditional()) return false;
 743     Condition = BI->getCondition();
 744   } else if (SwitchInst *SI = dyn_cast<SwitchInst>(Terminator)) {
 745     Condition = SI->getCondition();
 746   } else if (IndirectBrInst *IB = dyn_cast<IndirectBrInst>(Terminator)) {
 747     // Can't thread indirect branch with no successors.
 748     if (IB->getNumSuccessors() == 0) return false;
 749     Condition = IB->getAddress()->stripPointerCasts();
 750     Preference = WantBlockAddress;
 751   } else {
 752     return false; // Must be an invoke.
 753   }
 754
 755   // Run constant folding to see if we can reduce the condition to a simple
 756   // constant.
 757   if (Instruction *I = dyn_cast<Instruction>(Condition)) {
 758     Value *SimpleVal =
 759         ConstantFoldInstruction(I, BB->getModule()->getDataLayout(), TLI);
 760     if (SimpleVal) {
 761       I->replaceAllUsesWith(SimpleVal);
 762       I->eraseFromParent();
 763       Condition = SimpleVal;
 764     }
 765   }
 766
 767   // If the terminator is branching on an undef, we can pick any of the
 768   // successors to branch to.  Let GetBestDestForJumpOnUndef decide.
 769   if (isa<UndefValue>(Condition)) {
 770     unsigned BestSucc = GetBestDestForJumpOnUndef(BB);
 771
 772     // Fold the branch/switch.
 773     TerminatorInst *BBTerm = BB->getTerminator();
 774     for (unsigned i = 0, e = BBTerm->getNumSuccessors(); i != e; ++i) {
 775       if (i == BestSucc) continue;
 776       BBTerm->getSuccessor(i)->removePredecessor(BB, true);
 777     }
 778
 779     DEBUG(dbgs() << "  In block '" << BB->getName()
 780           << "' folding undef terminator: " << *BBTerm << '\n');
 781     BranchInst::Create(BBTerm->getSuccessor(BestSucc), BBTerm);
 782     BBTerm->eraseFromParent();
 783     return true;
 784   }
 785
 786   // If the terminator of this block is branching on a constant, simplify the
 787   // terminator to an unconditional branch.  This can occur due to threading in
 788   // other blocks.
 789   if (getKnownConstant(Condition, Preference)) {
 790     DEBUG(dbgs() << "  In block '" << BB->getName()
 791           << "' folding terminator: " << *BB->getTerminator() << '\n');
 792     ++NumFolds;
 793     ConstantFoldTerminator(BB, true);
 794     return true;
 795   }
 796
 797   Instruction *CondInst = dyn_cast<Instruction>(Condition);
 798
 799   // All the rest of our checks depend on the condition being an instruction.
 800   if (!CondInst) {
 801     // FIXME: Unify this with code below.
 802     if (ProcessThreadableEdges(Condition, BB, Preference, Terminator))
 803       return true;
 804     return false;
 805   }
 806
 807
 808   if (CmpInst *CondCmp = dyn_cast<CmpInst>(CondInst)) {
 809     // If we're branching on a conditional, LVI might be able to determine
 810     // it's value at the branch instruction.  We only handle comparisons
 811     // against a constant at this time.
 812     // TODO: This should be extended to handle switches as well.
 813     BranchInst *CondBr = dyn_cast<BranchInst>(BB->getTerminator());
 814     Constant *CondConst = dyn_cast<Constant>(CondCmp->getOperand(1));
 815     if (CondBr && CondConst && CondBr->isConditional()) {
 816       LazyValueInfo::Tristate Ret =
 817         LVI->getPredicateAt(CondCmp->getPredicate(), CondCmp->getOperand(0),
 818                             CondConst, CondBr);
 819       if (Ret != LazyValueInfo::Unknown) {
 820         unsigned ToRemove = Ret == LazyValueInfo::True ? 1 : 0;
 821         unsigned ToKeep = Ret == LazyValueInfo::True ? 0 : 1;
 822         CondBr->getSuccessor(ToRemove)->removePredecessor(BB, true);
 823         BranchInst::Create(CondBr->getSuccessor(ToKeep), CondBr);
 824         CondBr->eraseFromParent();
 825         if (CondCmp->use_empty())
 826           CondCmp->eraseFromParent();
 827         else if (CondCmp->getParent() == BB) {
 828           // If the fact we just learned is true for all uses of the
 829           // condition, replace it with a constant value
 830           auto *CI = Ret == LazyValueInfo::True ?
 831             ConstantInt::getTrue(CondCmp->getType()) :
 832             ConstantInt::getFalse(CondCmp->getType());
 833           CondCmp->replaceAllUsesWith(CI);
 834           CondCmp->eraseFromParent();
 835         }
 836         return true;
 837       }
 838     }
 839
 840     if (CondBr && CondConst && TryToUnfoldSelect(CondCmp, BB))
 841       return true;
 842   }
 843
 844   // Check for some cases that are worth simplifying.  Right now we want to look
 845   // for loads that are used by a switch or by the condition for the branch.  If
 846   // we see one, check to see if it's partially redundant.  If so, insert a PHI
 847   // which can then be used to thread the values.
 848   //
 849   Value *SimplifyValue = CondInst;
 850   if (CmpInst *CondCmp = dyn_cast<CmpInst>(SimplifyValue))
 851     if (isa<Constant>(CondCmp->getOperand(1)))
 852       SimplifyValue = CondCmp->getOperand(0);
 853
 854   // TODO: There are other places where load PRE would be profitable, such as
 855   // more complex comparisons.
 856   if (LoadInst *LI = dyn_cast<LoadInst>(SimplifyValue))
 857     if (SimplifyPartiallyRedundantLoad(LI))
 858       return true;
 859
 860
 861   // Handle a variety of cases where we are branching on something derived from
 862   // a PHI node in the current block.  If we can prove that any predecessors
 863   // compute a predictable value based on a PHI node, thread those predecessors.
 864   //
 865   if (ProcessThreadableEdges(CondInst, BB, Preference, Terminator))
 866     return true;
 867
 868   // If this is an otherwise-unfoldable branch on a phi node in the current
 869   // block, see if we can simplify.
 870   if (PHINode *PN = dyn_cast<PHINode>(CondInst))
 871     if (PN->getParent() == BB && isa<BranchInst>(BB->getTerminator()))
 872       return ProcessBranchOnPHI(PN);
 873
 874
 875   // If this is an otherwise-unfoldable branch on a XOR, see if we can simplify.
 876   if (CondInst->getOpcode() == Instruction::Xor &&
 877       CondInst->getParent() == BB && isa<BranchInst>(BB->getTerminator()))
 878     return ProcessBranchOnXOR(cast<BinaryOperator>(CondInst));
 879
 880   // Search for a stronger dominating condition that can be used to simplify a
 881   // conditional branch leaving BB.
 882   if (ProcessImpliedCondition(BB))
 883     return true;
 884
 885   return false;
 886 }
 887
 888 bool JumpThreading::ProcessImpliedCondition(BasicBlock *BB) {
 889   auto *BI = dyn_cast<BranchInst>(BB->getTerminator());
 890   if (!BI || !BI->isConditional())
 891     return false;
 892
 893   Value *Cond = BI->getCondition();
 894   BasicBlock *CurrentBB = BB;
 895   BasicBlock *CurrentPred = BB->getSinglePredecessor();
 896   unsigned Iter = 0;
 897
 898   while (CurrentPred && Iter++ < ImplicationSearchThreshold) {
 899     auto *PBI = dyn_cast<BranchInst>(CurrentPred->getTerminator());
 900     if (!PBI || !PBI->isConditional() || PBI->getSuccessor(0) != CurrentBB)
 901       return false;
 902
 903     if (isImpliedCondition(PBI->getCondition(), Cond)) {
 904       BI->getSuccessor(1)->removePredecessor(BB);
 905       BranchInst::Create(BI->getSuccessor(0), BI);
 906       BI->eraseFromParent();
 907       return true;
 908     }
 909     CurrentBB = CurrentPred;
 910     CurrentPred = CurrentBB->getSinglePredecessor();
 911   }
 912
 913   return false;
 914 }
 915
 916 /// SimplifyPartiallyRedundantLoad - If LI is an obviously partially redundant
 917 /// load instruction, eliminate it by replacing it with a PHI node.  This is an
 918 /// important optimization that encourages jump threading, and needs to be run
 919 /// interlaced with other jump threading tasks.
 920 bool JumpThreading::SimplifyPartiallyRedundantLoad(LoadInst *LI) {
 921   // Don't hack volatile/atomic loads.
 922   if (!LI->isSimple()) return false;
 923
 924   // If the load is defined in a block with exactly one predecessor, it can't be
 925   // partially redundant.
 926   BasicBlock *LoadBB = LI->getParent();
 927   if (LoadBB->getSinglePredecessor())
 928     return false;
 929
 930   // If the load is defined in an EH pad, it can't be partially redundant,
 931   // because the edges between the invoke and the EH pad cannot have other
 932   // instructions between them.
 933   if (LoadBB->isEHPad())
 934     return false;
 935
 936   Value *LoadedPtr = LI->getOperand(0);
 937
 938   // If the loaded operand is defined in the LoadBB, it can't be available.
 939   // TODO: Could do simple PHI translation, that would be fun :)
 940   if (Instruction *PtrOp = dyn_cast<Instruction>(LoadedPtr))
 941     if (PtrOp->getParent() == LoadBB)
 942       return false;
 943
 944   // Scan a few instructions up from the load, to see if it is obviously live at
 945   // the entry to its block.
 946   BasicBlock::iterator BBIt(LI);
 947
 948   if (Value *AvailableVal =
 949         FindAvailableLoadedValue(LoadedPtr, LoadBB, BBIt, DefMaxInstsToScan)) {
 950     // If the value of the load is locally available within the block, just use
 951     // it.  This frequently occurs for reg2mem'd allocas.
 952     //cerr << "LOAD ELIMINATED:\n" << *BBIt << *LI << "\n";
 953
 954     // If the returned value is the load itself, replace with an undef. This can
 955     // only happen in dead loops.
 956     if (AvailableVal == LI) AvailableVal = UndefValue::get(LI->getType());
 957     if (AvailableVal->getType() != LI->getType())
 958       AvailableVal =
 959           CastInst::CreateBitOrPointerCast(AvailableVal, LI->getType(), "", LI);
 960     LI->replaceAllUsesWith(AvailableVal);
 961     LI->eraseFromParent();
 962     return true;
 963   }
 964
 965   // Otherwise, if we scanned the whole block and got to the top of the block,
 966   // we know the block is locally transparent to the load.  If not, something
 967   // might clobber its value.
 968   if (BBIt != LoadBB->begin())
 969     return false;
 970
 971   // If all of the loads and stores that feed the value have the same AA tags,
 972   // then we can propagate them onto any newly inserted loads.
 973   AAMDNodes AATags;
 974   LI->getAAMetadata(AATags);
 975
 976   SmallPtrSet<BasicBlock*, 8> PredsScanned;
 977   typedef SmallVector<std::pair<BasicBlock*, Value*>, 8> AvailablePredsTy;
 978   AvailablePredsTy AvailablePreds;
 979   BasicBlock *OneUnavailablePred = nullptr;
 980
 981   // If we got here, the loaded value is transparent through to the start of the
 982   // block.  Check to see if it is available in any of the predecessor blocks.
 983   for (pred_iterator PI = pred_begin(LoadBB), PE = pred_end(LoadBB);
 984        PI != PE; ++PI) {
 985     BasicBlock *PredBB = *PI;
 986
 987     // If we already scanned this predecessor, skip it.
 988     if (!PredsScanned.insert(PredBB).second)
 989       continue;
 990
 991     // Scan the predecessor to see if the value is available in the pred.
 992     BBIt = PredBB->end();
 993     AAMDNodes ThisAATags;
 994     Value *PredAvailable = FindAvailableLoadedValue(LoadedPtr, PredBB, BBIt,
 995                                                     DefMaxInstsToScan,
 996                                                     nullptr, &ThisAATags);
 997     if (!PredAvailable) {
 998       OneUnavailablePred = PredBB;
 999       continue;
1000     }
1001
1002     // If AA tags disagree or are not present, forget about them.
1003     if (AATags != ThisAATags) AATags = AAMDNodes();
1004
1005     // If so, this load is partially redundant.  Remember this info so that we
1006     // can create a PHI node.
1007     AvailablePreds.push_back(std::make_pair(PredBB, PredAvailable));
1008   }
1009
1010   // If the loaded value isn't available in any predecessor, it isn't partially
1011   // redundant.
1012   if (AvailablePreds.empty()) return false;
1013
1014   // Okay, the loaded value is available in at least one (and maybe all!)
1015   // predecessors.  If the value is unavailable in more than one unique
1016   // predecessor, we want to insert a merge block for those common predecessors.
1017   // This ensures that we only have to insert one reload, thus not increasing
1018   // code size.
1019   BasicBlock *UnavailablePred = nullptr;
1020
1021   // If there is exactly one predecessor where the value is unavailable, the
1022   // already computed 'OneUnavailablePred' block is it.  If it ends in an
1023   // unconditional branch, we know that it isn't a critical edge.
1024   if (PredsScanned.size() == AvailablePreds.size()+1 &&
1025       OneUnavailablePred->getTerminator()->getNumSuccessors() == 1) {
1026     UnavailablePred = OneUnavailablePred;
1027   } else if (PredsScanned.size() != AvailablePreds.size()) {
1028     // Otherwise, we had multiple unavailable predecessors or we had a critical
1029     // edge from the one.
1030     SmallVector<BasicBlock*, 8> PredsToSplit;
1031     SmallPtrSet<BasicBlock*, 8> AvailablePredSet;
1032
1033     for (unsigned i = 0, e = AvailablePreds.size(); i != e; ++i)
1034       AvailablePredSet.insert(AvailablePreds[i].first);
1035
1036     // Add all the unavailable predecessors to the PredsToSplit list.
1037     for (pred_iterator PI = pred_begin(LoadBB), PE = pred_end(LoadBB);
1038          PI != PE; ++PI) {
1039       BasicBlock *P = *PI;
1040       // If the predecessor is an indirect goto, we can't split the edge.
1041       if (isa<IndirectBrInst>(P->getTerminator()))
1042         return false;
1043
1044       if (!AvailablePredSet.count(P))
1045         PredsToSplit.push_back(P);
1046     }
1047
1048     // Split them out to their own block.
1049     UnavailablePred = SplitBlockPreds(LoadBB, PredsToSplit, "thread-pre-split");
1050   }
1051
1052   // If the value isn't available in all predecessors, then there will be
1053   // exactly one where it isn't available.  Insert a load on that edge and add
1054   // it to the AvailablePreds list.
1055   if (UnavailablePred) {
1056     assert(UnavailablePred->getTerminator()->getNumSuccessors() == 1 &&
1057            "Can't handle critical edge here!");
1058     LoadInst *NewVal = new LoadInst(LoadedPtr, LI->getName()+".pr", false,
1059                                  LI->getAlignment(),
1060                                  UnavailablePred->getTerminator());
1061     NewVal->setDebugLoc(LI->getDebugLoc());
1062     if (AATags)
1063       NewVal->setAAMetadata(AATags);
1064
1065     AvailablePreds.push_back(std::make_pair(UnavailablePred, NewVal));
1066   }
1067
1068   // Now we know that each predecessor of this block has a value in
1069   // AvailablePreds, sort them for efficient access as we're walking the preds.
1070   array_pod_sort(AvailablePreds.begin(), AvailablePreds.end());
1071
1072   // Create a PHI node at the start of the block for the PRE'd load value.
1073   pred_iterator PB = pred_begin(LoadBB), PE = pred_end(LoadBB);
1074   PHINode *PN = PHINode::Create(LI->getType(), std::distance(PB, PE), "",
1075                                 &LoadBB->front());
1076   PN->takeName(LI);
1077   PN->setDebugLoc(LI->getDebugLoc());
1078
1079   // Insert new entries into the PHI for each predecessor.  A single block may
1080   // have multiple entries here.
1081   for (pred_iterator PI = PB; PI != PE; ++PI) {
1082     BasicBlock *P = *PI;
1083     AvailablePredsTy::iterator I =
1084       std::lower_bound(AvailablePreds.begin(), AvailablePreds.end(),
1085                        std::make_pair(P, (Value*)nullptr));
1086
1087     assert(I != AvailablePreds.end() && I->first == P &&
1088            "Didn't find entry for predecessor!");
1089
1090     // If we have an available predecessor but it requires casting, insert the
1091     // cast in the predecessor and use the cast. Note that we have to update the
1092     // AvailablePreds vector as we go so that all of the PHI entries for this
1093     // predecessor use the same bitcast.
1094     Value *&PredV = I->second;
1095     if (PredV->getType() != LI->getType())
1096       PredV = CastInst::CreateBitOrPointerCast(PredV, LI->getType(), "",
1097                                                P->getTerminator());
1098
1099     PN->addIncoming(PredV, I->first);
1100   }
1101
1102   //cerr << "PRE: " << *LI << *PN << "\n";
1103
1104   LI->replaceAllUsesWith(PN);
1105   LI->eraseFromParent();
1106
1107   return true;
1108 }
1109
1110 /// FindMostPopularDest - The specified list contains multiple possible
1111 /// threadable destinations.  Pick the one that occurs the most frequently in
1112 /// the list.
1113 static BasicBlock *
1114 FindMostPopularDest(BasicBlock *BB,
1115                     const SmallVectorImpl<std::pair<BasicBlock*,
1116                                   BasicBlock*> > &PredToDestList) {
1117   assert(!PredToDestList.empty());
1118
1119   // Determine popularity.  If there are multiple possible destinations, we
1120   // explicitly choose to ignore 'undef' destinations.  We prefer to thread
1121   // blocks with known and real destinations to threading undef.  We'll handle
1122   // them later if interesting.
1123   DenseMap<BasicBlock*, unsigned> DestPopularity;
1124   for (unsigned i = 0, e = PredToDestList.size(); i != e; ++i)
1125     if (PredToDestList[i].second)
1126       DestPopularity[PredToDestList[i].second]++;
1127
1128   // Find the most popular dest.
1129   DenseMap<BasicBlock*, unsigned>::iterator DPI = DestPopularity.begin();
1130   BasicBlock *MostPopularDest = DPI->first;
1131   unsigned Popularity = DPI->second;
1132   SmallVector<BasicBlock*, 4> SamePopularity;
1133
1134   for (++DPI; DPI != DestPopularity.end(); ++DPI) {
1135     // If the popularity of this entry isn't higher than the popularity we've
1136     // seen so far, ignore it.
1137     if (DPI->second < Popularity)
1138       ; // ignore.
1139     else if (DPI->second == Popularity) {
1140       // If it is the same as what we've seen so far, keep track of it.
1141       SamePopularity.push_back(DPI->first);
1142     } else {
1143       // If it is more popular, remember it.
1144       SamePopularity.clear();
1145       MostPopularDest = DPI->first;
1146       Popularity = DPI->second;
1147     }
1148   }
1149
1150   // Okay, now we know the most popular destination.  If there is more than one
1151   // destination, we need to determine one.  This is arbitrary, but we need
1152   // to make a deterministic decision.  Pick the first one that appears in the
1153   // successor list.
1154   if (!SamePopularity.empty()) {
1155     SamePopularity.push_back(MostPopularDest);
1156     TerminatorInst *TI = BB->getTerminator();
1157     for (unsigned i = 0; ; ++i) {
1158       assert(i != TI->getNumSuccessors() && "Didn't find any successor!");
1159
1160       if (std::find(SamePopularity.begin(), SamePopularity.end(),
1161                     TI->getSuccessor(i)) == SamePopularity.end())
1162         continue;
1163
1164       MostPopularDest = TI->getSuccessor(i);
1165       break;
1166     }
1167   }
1168
1169   // Okay, we have finally picked the most popular destination.
1170   return MostPopularDest;
1171 }
1172
1173 bool JumpThreading::ProcessThreadableEdges(Value *Cond, BasicBlock *BB,
1174                                            ConstantPreference Preference,
1175                                            Instruction *CxtI) {
1176   // If threading this would thread across a loop header, don't even try to
1177   // thread the edge.
1178   if (LoopHeaders.count(BB))
1179     return false;
1180
1181   PredValueInfoTy PredValues;
1182   if (!ComputeValueKnownInPredecessors(Cond, BB, PredValues, Preference, CxtI))
1183     return false;
1184
1185   assert(!PredValues.empty() &&
1186          "ComputeValueKnownInPredecessors returned true with no values");
1187
1188   DEBUG(dbgs() << "IN BB: " << *BB;
1189         for (unsigned i = 0, e = PredValues.size(); i != e; ++i) {
1190           dbgs() << "  BB '" << BB->getName() << "': FOUND condition = "
1191             << *PredValues[i].first
1192             << " for pred '" << PredValues[i].second->getName() << "'.\n";
1193         });
1194
1195   // Decide what we want to thread through.  Convert our list of known values to
1196   // a list of known destinations for each pred.  This also discards duplicate
1197   // predecessors and keeps track of the undefined inputs (which are represented
1198   // as a null dest in the PredToDestList).
1199   SmallPtrSet<BasicBlock*, 16> SeenPreds;
1200   SmallVector<std::pair<BasicBlock*, BasicBlock*>, 16> PredToDestList;
1201
1202   BasicBlock *OnlyDest = nullptr;
1203   BasicBlock *MultipleDestSentinel = (BasicBlock*)(intptr_t)~0ULL;
1204
1205   for (unsigned i = 0, e = PredValues.size(); i != e; ++i) {
1206     BasicBlock *Pred = PredValues[i].second;
1207     if (!SeenPreds.insert(Pred).second)
1208       continue;  // Duplicate predecessor entry.
1209
1210     // If the predecessor ends with an indirect goto, we can't change its
1211     // destination.
1212     if (isa<IndirectBrInst>(Pred->getTerminator()))
1213       continue;
1214
1215     Constant *Val = PredValues[i].first;
1216
1217     BasicBlock *DestBB;
1218     if (isa<UndefValue>(Val))
1219       DestBB = nullptr;
1220     else if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator()))
1221       DestBB = BI->getSuccessor(cast<ConstantInt>(Val)->isZero());
1222     else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
1223       DestBB = SI->findCaseValue(cast<ConstantInt>(Val)).getCaseSuccessor();
1224     } else {
1225       assert(isa<IndirectBrInst>(BB->getTerminator())
1226               && "Unexpected terminator");
1227       DestBB = cast<BlockAddress>(Val)->getBasicBlock();
1228     }
1229
1230     // If we have exactly one destination, remember it for efficiency below.
1231     if (PredToDestList.empty())
1232       OnlyDest = DestBB;
1233     else if (OnlyDest != DestBB)
1234       OnlyDest = MultipleDestSentinel;
1235
1236     PredToDestList.push_back(std::make_pair(Pred, DestBB));
1237   }
1238
1239   // If all edges were unthreadable, we fail.
1240   if (PredToDestList.empty())
1241     return false;
1242
1243   // Determine which is the most common successor.  If we have many inputs and
1244   // this block is a switch, we want to start by threading the batch that goes
1245   // to the most popular destination first.  If we only know about one
1246   // threadable destination (the common case) we can avoid this.
1247   BasicBlock *MostPopularDest = OnlyDest;
1248
1249   if (MostPopularDest == MultipleDestSentinel)
1250     MostPopularDest = FindMostPopularDest(BB, PredToDestList);
1251
1252   // Now that we know what the most popular destination is, factor all
1253   // predecessors that will jump to it into a single predecessor.
1254   SmallVector<BasicBlock*, 16> PredsToFactor;
1255   for (unsigned i = 0, e = PredToDestList.size(); i != e; ++i)
1256     if (PredToDestList[i].second == MostPopularDest) {
1257       BasicBlock *Pred = PredToDestList[i].first;
1258
1259       // This predecessor may be a switch or something else that has multiple
1260       // edges to the block.  Factor each of these edges by listing them
1261       // according to # occurrences in PredsToFactor.
1262       TerminatorInst *PredTI = Pred->getTerminator();
1263       for (unsigned i = 0, e = PredTI->getNumSuccessors(); i != e; ++i)
1264         if (PredTI->getSuccessor(i) == BB)
1265           PredsToFactor.push_back(Pred);
1266     }
1267
1268   // If the threadable edges are branching on an undefined value, we get to pick
1269   // the destination that these predecessors should get to.
1270   if (!MostPopularDest)
1271     MostPopularDest = BB->getTerminator()->
1272                             getSuccessor(GetBestDestForJumpOnUndef(BB));
1273
1274   // Ok, try to thread it!
1275   return ThreadEdge(BB, PredsToFactor, MostPopularDest);
1276 }
1277
1278 /// ProcessBranchOnPHI - We have an otherwise unthreadable conditional branch on
1279 /// a PHI node in the current block.  See if there are any simplifications we
1280 /// can do based on inputs to the phi node.
1281 ///
1282 bool JumpThreading::ProcessBranchOnPHI(PHINode *PN) {
1283   BasicBlock *BB = PN->getParent();
1284
1285   // TODO: We could make use of this to do it once for blocks with common PHI
1286   // values.
1287   SmallVector<BasicBlock*, 1> PredBBs;
1288   PredBBs.resize(1);
1289
1290   // If any of the predecessor blocks end in an unconditional branch, we can
1291   // *duplicate* the conditional branch into that block in order to further
1292   // encourage jump threading and to eliminate cases where we have branch on a
1293   // phi of an icmp (branch on icmp is much better).
1294   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1295     BasicBlock *PredBB = PN->getIncomingBlock(i);
1296     if (BranchInst *PredBr = dyn_cast<BranchInst>(PredBB->getTerminator()))
1297       if (PredBr->isUnconditional()) {
1298         PredBBs[0] = PredBB;
1299         // Try to duplicate BB into PredBB.
1300         if (DuplicateCondBranchOnPHIIntoPred(BB, PredBBs))
1301           return true;
1302       }
1303   }
1304
1305   return false;
1306 }
1307
1308 /// ProcessBranchOnXOR - We have an otherwise unthreadable conditional branch on
1309 /// a xor instruction in the current block.  See if there are any
1310 /// simplifications we can do based on inputs to the xor.
1311 ///
1312 bool JumpThreading::ProcessBranchOnXOR(BinaryOperator *BO) {
1313   BasicBlock *BB = BO->getParent();
1314
1315   // If either the LHS or RHS of the xor is a constant, don't do this
1316   // optimization.
1317   if (isa<ConstantInt>(BO->getOperand(0)) ||
1318       isa<ConstantInt>(BO->getOperand(1)))
1319     return false;
1320
1321   // If the first instruction in BB isn't a phi, we won't be able to infer
1322   // anything special about any particular predecessor.
1323   if (!isa<PHINode>(BB->front()))
1324     return false;
1325
1326   // If we have a xor as the branch input to this block, and we know that the
1327   // LHS or RHS of the xor in any predecessor is true/false, then we can clone
1328   // the condition into the predecessor and fix that value to true, saving some
1329   // logical ops on that path and encouraging other paths to simplify.
1330   //
1331   // This copies something like this:
1332   //
1333   //  BB:
1334   //    %X = phi i1 [1],  [%X']
1335   //    %Y = icmp eq i32 %A, %B
1336   //    %Z = xor i1 %X, %Y
1337   //    br i1 %Z, ...
1338   //
1339   // Into:
1340   //  BB':
1341   //    %Y = icmp ne i32 %A, %B
1342   //    br i1 %Y, ...
1343
1344   PredValueInfoTy XorOpValues;
1345   bool isLHS = true;
1346   if (!ComputeValueKnownInPredecessors(BO->getOperand(0), BB, XorOpValues,
1347                                        WantInteger, BO)) {
1348     assert(XorOpValues.empty());
1349     if (!ComputeValueKnownInPredecessors(BO->getOperand(1), BB, XorOpValues,
1350                                          WantInteger, BO))
1351       return false;
1352     isLHS = false;
1353   }
1354
1355   assert(!XorOpValues.empty() &&
1356          "ComputeValueKnownInPredecessors returned true with no values");
1357
1358   // Scan the information to see which is most popular: true or false.  The
1359   // predecessors can be of the set true, false, or undef.
1360   unsigned NumTrue = 0, NumFalse = 0;
1361   for (unsigned i = 0, e = XorOpValues.size(); i != e; ++i) {
1362     if (isa<UndefValue>(XorOpValues[i].first))
1363       // Ignore undefs for the count.
1364       continue;
1365     if (cast<ConstantInt>(XorOpValues[i].first)->isZero())
1366       ++NumFalse;
1367     else
1368       ++NumTrue;
1369   }
1370
1371   // Determine which value to split on, true, false, or undef if neither.
1372   ConstantInt *SplitVal = nullptr;
1373   if (NumTrue > NumFalse)
1374     SplitVal = ConstantInt::getTrue(BB->getContext());
1375   else if (NumTrue != 0 || NumFalse != 0)
1376     SplitVal = ConstantInt::getFalse(BB->getContext());
1377
1378   // Collect all of the blocks that this can be folded into so that we can
1379   // factor this once and clone it once.
1380   SmallVector<BasicBlock*, 8> BlocksToFoldInto;
1381   for (unsigned i = 0, e = XorOpValues.size(); i != e; ++i) {
1382     if (XorOpValues[i].first != SplitVal &&
1383         !isa<UndefValue>(XorOpValues[i].first))
1384       continue;
1385
1386     BlocksToFoldInto.push_back(XorOpValues[i].second);
1387   }
1388
1389   // If we inferred a value for all of the predecessors, then duplication won't
1390   // help us.  However, we can just replace the LHS or RHS with the constant.
1391   if (BlocksToFoldInto.size() ==
1392       cast<PHINode>(BB->front()).getNumIncomingValues()) {
1393     if (!SplitVal) {
1394       // If all preds provide undef, just nuke the xor, because it is undef too.
1395       BO->replaceAllUsesWith(UndefValue::get(BO->getType()));
1396       BO->eraseFromParent();
1397     } else if (SplitVal->isZero()) {
1398       // If all preds provide 0, replace the xor with the other input.
1399       BO->replaceAllUsesWith(BO->getOperand(isLHS));
1400       BO->eraseFromParent();
1401     } else {
1402       // If all preds provide 1, set the computed value to 1.
1403       BO->setOperand(!isLHS, SplitVal);
1404     }
1405
1406     return true;
1407   }
1408
1409   // Try to duplicate BB into PredBB.
1410   return DuplicateCondBranchOnPHIIntoPred(BB, BlocksToFoldInto);
1411 }
1412
1413
1414 /// AddPHINodeEntriesForMappedBlock - We're adding 'NewPred' as a new
1415 /// predecessor to the PHIBB block.  If it has PHI nodes, add entries for
1416 /// NewPred using the entries from OldPred (suitably mapped).
1417 static void AddPHINodeEntriesForMappedBlock(BasicBlock *PHIBB,
1418                                             BasicBlock *OldPred,
1419                                             BasicBlock *NewPred,
1420                                      DenseMap<Instruction*, Value*> &ValueMap) {
1421   for (BasicBlock::iterator PNI = PHIBB->begin();
1422        PHINode *PN = dyn_cast<PHINode>(PNI); ++PNI) {
1423     // Ok, we have a PHI node.  Figure out what the incoming value was for the
1424     // DestBlock.
1425     Value *IV = PN->getIncomingValueForBlock(OldPred);
1426
1427     // Remap the value if necessary.
1428     if (Instruction *Inst = dyn_cast<Instruction>(IV)) {
1429       DenseMap<Instruction*, Value*>::iterator I = ValueMap.find(Inst);
1430       if (I != ValueMap.end())
1431         IV = I->second;
1432     }
1433
1434     PN->addIncoming(IV, NewPred);
1435   }
1436 }
1437
1438 /// ThreadEdge - We have decided that it is safe and profitable to factor the
1439 /// blocks in PredBBs to one predecessor, then thread an edge from it to SuccBB
1440 /// across BB.  Transform the IR to reflect this change.
1441 bool JumpThreading::ThreadEdge(BasicBlock *BB,
1442                                const SmallVectorImpl<BasicBlock*> &PredBBs,
1443                                BasicBlock *SuccBB) {
1444   // If threading to the same block as we come from, we would infinite loop.
1445   if (SuccBB == BB) {
1446     DEBUG(dbgs() << "  Not threading across BB '" << BB->getName()
1447           << "' - would thread to self!\n");
1448     return false;
1449   }
1450
1451   // If threading this would thread across a loop header, don't thread the edge.
1452   // See the comments above FindLoopHeaders for justifications and caveats.
1453   if (LoopHeaders.count(BB)) {
1454     DEBUG(dbgs() << "  Not threading across loop header BB '" << BB->getName()
1455           << "' to dest BB '" << SuccBB->getName()
1456           << "' - it might create an irreducible loop!\n");
1457     return false;
1458   }
1459
1460   unsigned JumpThreadCost = getJumpThreadDuplicationCost(BB, BBDupThreshold);
1461   if (JumpThreadCost > BBDupThreshold) {
1462     DEBUG(dbgs() << "  Not threading BB '" << BB->getName()
1463           << "' - Cost is too high: " << JumpThreadCost << "\n");
1464     return false;
1465   }
1466
1467   // And finally, do it!  Start by factoring the predecessors if needed.
1468   BasicBlock *PredBB;
1469   if (PredBBs.size() == 1)
1470     PredBB = PredBBs[0];
1471   else {
1472     DEBUG(dbgs() << "  Factoring out " << PredBBs.size()
1473           << " common predecessors.\n");
1474     PredBB = SplitBlockPreds(BB, PredBBs, ".thr_comm");
1475   }
1476
1477   // And finally, do it!
1478   DEBUG(dbgs() << "  Threading edge from '" << PredBB->getName() << "' to '"
1479         << SuccBB->getName() << "' with cost: " << JumpThreadCost
1480         << ", across block:\n    "
1481         << *BB << "\n");
1482
1483   LVI->threadEdge(PredBB, BB, SuccBB);
1484
1485   // We are going to have to map operands from the original BB block to the new
1486   // copy of the block 'NewBB'.  If there are PHI nodes in BB, evaluate them to
1487   // account for entry from PredBB.
1488   DenseMap<Instruction*, Value*> ValueMapping;
1489
1490   BasicBlock *NewBB = BasicBlock::Create(BB->getContext(),
1491                                          BB->getName()+".thread",
1492                                          BB->getParent(), BB);
1493   NewBB->moveAfter(PredBB);
1494
1495   // Set the block frequency of NewBB.
1496   if (HasProfileData) {
1497     auto NewBBFreq =
1498         BFI->getBlockFreq(PredBB) * BPI->getEdgeProbability(PredBB, BB);
1499     BFI->setBlockFreq(NewBB, NewBBFreq.getFrequency());
1500   }
1501
1502   BasicBlock::iterator BI = BB->begin();
1503   for (; PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
1504     ValueMapping[PN] = PN->getIncomingValueForBlock(PredBB);
1505
1506   // Clone the non-phi instructions of BB into NewBB, keeping track of the
1507   // mapping and using it to remap operands in the cloned instructions.
1508   for (; !isa<TerminatorInst>(BI); ++BI) {
1509     Instruction *New = BI->clone();
1510     New->setName(BI->getName());
1511     NewBB->getInstList().push_back(New);
1512     ValueMapping[&*BI] = New;
1513
1514     // Remap operands to patch up intra-block references.
1515     for (unsigned i = 0, e = New->getNumOperands(); i != e; ++i)
1516       if (Instruction *Inst = dyn_cast<Instruction>(New->getOperand(i))) {
1517         DenseMap<Instruction*, Value*>::iterator I = ValueMapping.find(Inst);
1518         if (I != ValueMapping.end())
1519           New->setOperand(i, I->second);
1520       }
1521   }
1522
1523   // We didn't copy the terminator from BB over to NewBB, because there is now
1524   // an unconditional jump to SuccBB.  Insert the unconditional jump.
1525   BranchInst *NewBI = BranchInst::Create(SuccBB, NewBB);
1526   NewBI->setDebugLoc(BB->getTerminator()->getDebugLoc());
1527
1528   // Check to see if SuccBB has PHI nodes. If so, we need to add entries to the
1529   // PHI nodes for NewBB now.
1530   AddPHINodeEntriesForMappedBlock(SuccBB, BB, NewBB, ValueMapping);
1531
1532   // If there were values defined in BB that are used outside the block, then we
1533   // now have to update all uses of the value to use either the original value,
1534   // the cloned value, or some PHI derived value.  This can require arbitrary
1535   // PHI insertion, of which we are prepared to do, clean these up now.
1536   SSAUpdater SSAUpdate;
1537   SmallVector<Use*, 16> UsesToRename;
1538   for (BasicBlock::iterator I = BB->begin(); I != BB->end(); ++I) {
1539     // Scan all uses of this instruction to see if it is used outside of its
1540     // block, and if so, record them in UsesToRename.
1541     for (Use &U : I->uses()) {
1542       Instruction *User = cast<Instruction>(U.getUser());
1543       if (PHINode *UserPN = dyn_cast<PHINode>(User)) {
1544         if (UserPN->getIncomingBlock(U) == BB)
1545           continue;
1546       } else if (User->getParent() == BB)
1547         continue;
1548
1549       UsesToRename.push_back(&U);
1550     }
1551
1552     // If there are no uses outside the block, we're done with this instruction.
1553     if (UsesToRename.empty())
1554       continue;
1555
1556     DEBUG(dbgs() << "JT: Renaming non-local uses of: " << *I << "\n");
1557
1558     // We found a use of I outside of BB.  Rename all uses of I that are outside
1559     // its block to be uses of the appropriate PHI node etc.  See ValuesInBlocks
1560     // with the two values we know.
1561     SSAUpdate.Initialize(I->getType(), I->getName());
1562     SSAUpdate.AddAvailableValue(BB, &*I);
1563     SSAUpdate.AddAvailableValue(NewBB, ValueMapping[&*I]);
1564
1565     while (!UsesToRename.empty())
1566       SSAUpdate.RewriteUse(*UsesToRename.pop_back_val());
1567     DEBUG(dbgs() << "\n");
1568   }
1569
1570
1571   // Ok, NewBB is good to go.  Update the terminator of PredBB to jump to
1572   // NewBB instead of BB.  This eliminates predecessors from BB, which requires
1573   // us to simplify any PHI nodes in BB.
1574   TerminatorInst *PredTerm = PredBB->getTerminator();
1575   for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i)
1576     if (PredTerm->getSuccessor(i) == BB) {
1577       BB->removePredecessor(PredBB, true);
1578       PredTerm->setSuccessor(i, NewBB);
1579     }
1580
1581   // At this point, the IR is fully up to date and consistent.  Do a quick scan
1582   // over the new instructions and zap any that are constants or dead.  This
1583   // frequently happens because of phi translation.
1584   SimplifyInstructionsInBlock(NewBB, TLI);
1585
1586   // Update the edge weight from BB to SuccBB, which should be less than before.
1587   UpdateBlockFreqAndEdgeWeight(PredBB, BB, NewBB, SuccBB);
1588
1589   // Threaded an edge!
1590   ++NumThreads;
1591   return true;
1592 }
1593
1594 /// Create a new basic block that will be the predecessor of BB and successor of
1595 /// all blocks in Preds. When profile data is availble, update the frequency of
1596 /// this new block.
1597 BasicBlock *JumpThreading::SplitBlockPreds(BasicBlock *BB,
1598                                            ArrayRef<BasicBlock *> Preds,
1599                                            const char *Suffix) {
1600   // Collect the frequencies of all predecessors of BB, which will be used to
1601   // update the edge weight on BB->SuccBB.
1602   BlockFrequency PredBBFreq(0);
1603   if (HasProfileData)
1604     for (auto Pred : Preds)
1605       PredBBFreq += BFI->getBlockFreq(Pred) * BPI->getEdgeProbability(Pred, BB);
1606
1607   BasicBlock *PredBB = SplitBlockPredecessors(BB, Preds, Suffix);
1608
1609   // Set the block frequency of the newly created PredBB, which is the sum of
1610   // frequencies of Preds.
1611   if (HasProfileData)
1612     BFI->setBlockFreq(PredBB, PredBBFreq.getFrequency());
1613   return PredBB;
1614 }
1615
1616 /// Update the block frequency of BB and branch weight and the metadata on the
1617 /// edge BB->SuccBB. This is done by scaling the weight of BB->SuccBB by 1 -
1618 /// Freq(PredBB->BB) / Freq(BB->SuccBB).
1619 void JumpThreading::UpdateBlockFreqAndEdgeWeight(BasicBlock *PredBB,
1620                                                  BasicBlock *BB,
1621                                                  BasicBlock *NewBB,
1622                                                  BasicBlock *SuccBB) {
1623   if (!HasProfileData)
1624     return;
1625
1626   assert(BFI && BPI && "BFI & BPI should have been created here");
1627
1628   // As the edge from PredBB to BB is deleted, we have to update the block
1629   // frequency of BB.
1630   auto BBOrigFreq = BFI->getBlockFreq(BB);
1631   auto NewBBFreq = BFI->getBlockFreq(NewBB);
1632   auto BB2SuccBBFreq = BBOrigFreq * BPI->getEdgeProbability(BB, SuccBB);
1633   auto BBNewFreq = BBOrigFreq - NewBBFreq;
1634   BFI->setBlockFreq(BB, BBNewFreq.getFrequency());
1635
1636   // Collect updated outgoing edges' frequencies from BB and use them to update
1637   // edge weights.
1638   SmallVector<uint64_t, 4> BBSuccFreq;
1639   for (auto I = succ_begin(BB), E = succ_end(BB); I != E; ++I) {
1640     auto SuccFreq = (*I == SuccBB)
1641                         ? BB2SuccBBFreq - NewBBFreq
1642                         : BBOrigFreq * BPI->getEdgeProbability(BB, *I);
1643     BBSuccFreq.push_back(SuccFreq.getFrequency());
1644   }
1645
1646   // Normalize edge weights in Weights64 so that the sum of them can fit in
1647   BranchProbability::normalizeEdgeWeights(BBSuccFreq.begin(), BBSuccFreq.end());
1648
1649   SmallVector<uint32_t, 4> Weights;
1650   for (auto Freq : BBSuccFreq)
1651     Weights.push_back(static_cast<uint32_t>(Freq));
1652
1653   // Update edge weights in BPI.
1654   for (int I = 0, E = Weights.size(); I < E; I++)
1655     BPI->setEdgeWeight(BB, I, Weights[I]);
1656
1657   if (Weights.size() >= 2) {
1658     auto TI = BB->getTerminator();
1659     TI->setMetadata(
1660         LLVMContext::MD_prof,
1661         MDBuilder(TI->getParent()->getContext()).createBranchWeights(Weights));
1662   }
1663 }
1664
1665 /// DuplicateCondBranchOnPHIIntoPred - PredBB contains an unconditional branch
1666 /// to BB which contains an i1 PHI node and a conditional branch on that PHI.
1667 /// If we can duplicate the contents of BB up into PredBB do so now, this
1668 /// improves the odds that the branch will be on an analyzable instruction like
1669 /// a compare.
1670 bool JumpThreading::DuplicateCondBranchOnPHIIntoPred(BasicBlock *BB,
1671                                  const SmallVectorImpl<BasicBlock *> &PredBBs) {
1672   assert(!PredBBs.empty() && "Can't handle an empty set");
1673
1674   // If BB is a loop header, then duplicating this block outside the loop would
1675   // cause us to transform this into an irreducible loop, don't do this.
1676   // See the comments above FindLoopHeaders for justifications and caveats.
1677   if (LoopHeaders.count(BB)) {
1678     DEBUG(dbgs() << "  Not duplicating loop header '" << BB->getName()
1679           << "' into predecessor block '" << PredBBs[0]->getName()
1680           << "' - it might create an irreducible loop!\n");
1681     return false;
1682   }
1683
1684   unsigned DuplicationCost = getJumpThreadDuplicationCost(BB, BBDupThreshold);
1685   if (DuplicationCost > BBDupThreshold) {
1686     DEBUG(dbgs() << "  Not duplicating BB '" << BB->getName()
1687           << "' - Cost is too high: " << DuplicationCost << "\n");
1688     return false;
1689   }
1690
1691   // And finally, do it!  Start by factoring the predecessors if needed.
1692   BasicBlock *PredBB;
1693   if (PredBBs.size() == 1)
1694     PredBB = PredBBs[0];
1695   else {
1696     DEBUG(dbgs() << "  Factoring out " << PredBBs.size()
1697           << " common predecessors.\n");
1698     PredBB = SplitBlockPreds(BB, PredBBs, ".thr_comm");
1699   }
1700
1701   // Okay, we decided to do this!  Clone all the instructions in BB onto the end
1702   // of PredBB.
1703   DEBUG(dbgs() << "  Duplicating block '" << BB->getName() << "' into end of '"
1704         << PredBB->getName() << "' to eliminate branch on phi.  Cost: "
1705         << DuplicationCost << " block is:" << *BB << "\n");
1706
1707   // Unless PredBB ends with an unconditional branch, split the edge so that we
1708   // can just clone the bits from BB into the end of the new PredBB.
1709   BranchInst *OldPredBranch = dyn_cast<BranchInst>(PredBB->getTerminator());
1710
1711   if (!OldPredBranch || !OldPredBranch->isUnconditional()) {
1712     PredBB = SplitEdge(PredBB, BB);
1713     OldPredBranch = cast<BranchInst>(PredBB->getTerminator());
1714   }
1715
1716   // We are going to have to map operands from the original BB block into the
1717   // PredBB block.  Evaluate PHI nodes in BB.
1718   DenseMap<Instruction*, Value*> ValueMapping;
1719
1720   BasicBlock::iterator BI = BB->begin();
1721   for (; PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
1722     ValueMapping[PN] = PN->getIncomingValueForBlock(PredBB);
1723   // Clone the non-phi instructions of BB into PredBB, keeping track of the
1724   // mapping and using it to remap operands in the cloned instructions.
1725   for (; BI != BB->end(); ++BI) {
1726     Instruction *New = BI->clone();
1727
1728     // Remap operands to patch up intra-block references.
1729     for (unsigned i = 0, e = New->getNumOperands(); i != e; ++i)
1730       if (Instruction *Inst = dyn_cast<Instruction>(New->getOperand(i))) {
1731         DenseMap<Instruction*, Value*>::iterator I = ValueMapping.find(Inst);
1732         if (I != ValueMapping.end())
1733           New->setOperand(i, I->second);
1734       }
1735
1736     // If this instruction can be simplified after the operands are updated,
1737     // just use the simplified value instead.  This frequently happens due to
1738     // phi translation.
1739     if (Value *IV =
1740             SimplifyInstruction(New, BB->getModule()->getDataLayout())) {
1741       delete New;
1742       ValueMapping[&*BI] = IV;
1743     } else {
1744       // Otherwise, insert the new instruction into the block.
1745       New->setName(BI->getName());
1746       PredBB->getInstList().insert(OldPredBranch->getIterator(), New);
1747       ValueMapping[&*BI] = New;
1748     }
1749   }
1750
1751   // Check to see if the targets of the branch had PHI nodes. If so, we need to
1752   // add entries to the PHI nodes for branch from PredBB now.
1753   BranchInst *BBBranch = cast<BranchInst>(BB->getTerminator());
1754   AddPHINodeEntriesForMappedBlock(BBBranch->getSuccessor(0), BB, PredBB,
1755                                   ValueMapping);
1756   AddPHINodeEntriesForMappedBlock(BBBranch->getSuccessor(1), BB, PredBB,
1757                                   ValueMapping);
1758
1759   // If there were values defined in BB that are used outside the block, then we
1760   // now have to update all uses of the value to use either the original value,
1761   // the cloned value, or some PHI derived value.  This can require arbitrary
1762   // PHI insertion, of which we are prepared to do, clean these up now.
1763   SSAUpdater SSAUpdate;
1764   SmallVector<Use*, 16> UsesToRename;
1765   for (BasicBlock::iterator I = BB->begin(); I != BB->end(); ++I) {
1766     // Scan all uses of this instruction to see if it is used outside of its
1767     // block, and if so, record them in UsesToRename.
1768     for (Use &U : I->uses()) {
1769       Instruction *User = cast<Instruction>(U.getUser());
1770       if (PHINode *UserPN = dyn_cast<PHINode>(User)) {
1771         if (UserPN->getIncomingBlock(U) == BB)
1772           continue;
1773       } else if (User->getParent() == BB)
1774         continue;
1775
1776       UsesToRename.push_back(&U);
1777     }
1778
1779     // If there are no uses outside the block, we're done with this instruction.
1780     if (UsesToRename.empty())
1781       continue;
1782
1783     DEBUG(dbgs() << "JT: Renaming non-local uses of: " << *I << "\n");
1784
1785     // We found a use of I outside of BB.  Rename all uses of I that are outside
1786     // its block to be uses of the appropriate PHI node etc.  See ValuesInBlocks
1787     // with the two values we know.
1788     SSAUpdate.Initialize(I->getType(), I->getName());
1789     SSAUpdate.AddAvailableValue(BB, &*I);
1790     SSAUpdate.AddAvailableValue(PredBB, ValueMapping[&*I]);
1791
1792     while (!UsesToRename.empty())
1793       SSAUpdate.RewriteUse(*UsesToRename.pop_back_val());
1794     DEBUG(dbgs() << "\n");
1795   }
1796
1797   // PredBB no longer jumps to BB, remove entries in the PHI node for the edge
1798   // that we nuked.
1799   BB->removePredecessor(PredBB, true);
1800
1801   // Remove the unconditional branch at the end of the PredBB block.
1802   OldPredBranch->eraseFromParent();
1803
1804   ++NumDupes;
1805   return true;
1806 }
1807
1808 /// TryToUnfoldSelect - Look for blocks of the form
1809 /// bb1:
1810 ///   %a = select
1811 ///   br bb
1812 ///
1813 /// bb2:
1814 ///   %p = phi [%a, %bb] ...
1815 ///   %c = icmp %p
1816 ///   br i1 %c
1817 ///
1818 /// And expand the select into a branch structure if one of its arms allows %c
1819 /// to be folded. This later enables threading from bb1 over bb2.
1820 bool JumpThreading::TryToUnfoldSelect(CmpInst *CondCmp, BasicBlock *BB) {
1821   BranchInst *CondBr = dyn_cast<BranchInst>(BB->getTerminator());
1822   PHINode *CondLHS = dyn_cast<PHINode>(CondCmp->getOperand(0));
1823   Constant *CondRHS = cast<Constant>(CondCmp->getOperand(1));
1824
1825   if (!CondBr || !CondBr->isConditional() || !CondLHS ||
1826       CondLHS->getParent() != BB)
1827     return false;
1828
1829   for (unsigned I = 0, E = CondLHS->getNumIncomingValues(); I != E; ++I) {
1830     BasicBlock *Pred = CondLHS->getIncomingBlock(I);
1831     SelectInst *SI = dyn_cast<SelectInst>(CondLHS->getIncomingValue(I));
1832
1833     // Look if one of the incoming values is a select in the corresponding
1834     // predecessor.
1835     if (!SI || SI->getParent() != Pred || !SI->hasOneUse())
1836       continue;
1837
1838     BranchInst *PredTerm = dyn_cast<BranchInst>(Pred->getTerminator());
1839     if (!PredTerm || !PredTerm->isUnconditional())
1840       continue;
1841
1842     // Now check if one of the select values would allow us to constant fold the
1843     // terminator in BB. We don't do the transform if both sides fold, those
1844     // cases will be threaded in any case.
1845     LazyValueInfo::Tristate LHSFolds =
1846         LVI->getPredicateOnEdge(CondCmp->getPredicate(), SI->getOperand(1),
1847                                 CondRHS, Pred, BB, CondCmp);
1848     LazyValueInfo::Tristate RHSFolds =
1849         LVI->getPredicateOnEdge(CondCmp->getPredicate(), SI->getOperand(2),
1850                                 CondRHS, Pred, BB, CondCmp);
1851     if ((LHSFolds != LazyValueInfo::Unknown ||
1852          RHSFolds != LazyValueInfo::Unknown) &&
1853         LHSFolds != RHSFolds) {
1854       // Expand the select.
1855       //
1856       // Pred --
1857       //  |    v
1858       //  |  NewBB
1859       //  |    |
1860       //  |-----
1861       //  v
1862       // BB
1863       BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "select.unfold",
1864                                              BB->getParent(), BB);
1865       // Move the unconditional branch to NewBB.
1866       PredTerm->removeFromParent();
1867       NewBB->getInstList().insert(NewBB->end(), PredTerm);
1868       // Create a conditional branch and update PHI nodes.
1869       BranchInst::Create(NewBB, BB, SI->getCondition(), Pred);
1870       CondLHS->setIncomingValue(I, SI->getFalseValue());
1871       CondLHS->addIncoming(SI->getTrueValue(), NewBB);
1872       // The select is now dead.
1873       SI->eraseFromParent();
1874
1875       // Update any other PHI nodes in BB.
1876       for (BasicBlock::iterator BI = BB->begin();
1877            PHINode *Phi = dyn_cast<PHINode>(BI); ++BI)
1878         if (Phi != CondLHS)
1879           Phi->addIncoming(Phi->getIncomingValueForBlock(Pred), NewBB);
1880       return true;
1881     }
1882   }
1883   return false;
1884 }