lib/Transforms/Scalar/GVN.cpp

   1 //===- GVN.cpp - Eliminate redundant values and loads ---------------------===//
   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 performs global value numbering to eliminate fully redundant
  11 // instructions.  It also performs simple dead load elimination.
  12 //
  13 // Note that this pass does the value numbering itself; it does not use the
  14 // ValueNumbering analysis passes.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #include "llvm/Transforms/Scalar.h"
  19 #include "llvm/ADT/DenseMap.h"
  20 #include "llvm/ADT/DepthFirstIterator.h"
  21 #include "llvm/ADT/Hashing.h"
  22 #include "llvm/ADT/MapVector.h"
  23 #include "llvm/ADT/SetVector.h"
  24 #include "llvm/ADT/SmallPtrSet.h"
  25 #include "llvm/ADT/Statistic.h"
  26 #include "llvm/Analysis/AliasAnalysis.h"
  27 #include "llvm/Analysis/CFG.h"
  28 #include "llvm/Analysis/ConstantFolding.h"
  29 #include "llvm/Analysis/InstructionSimplify.h"
  30 #include "llvm/Analysis/Loads.h"
  31 #include "llvm/Analysis/MemoryBuiltins.h"
  32 #include "llvm/Analysis/MemoryDependenceAnalysis.h"
  33 #include "llvm/Analysis/PHITransAddr.h"
  34 #include "llvm/Analysis/ValueTracking.h"
  35 #include "llvm/IR/DataLayout.h"
  36 #include "llvm/IR/Dominators.h"
  37 #include "llvm/IR/GlobalVariable.h"
  38 #include "llvm/IR/IRBuilder.h"
  39 #include "llvm/IR/IntrinsicInst.h"
  40 #include "llvm/IR/LLVMContext.h"
  41 #include "llvm/IR/Metadata.h"
  42 #include "llvm/IR/PatternMatch.h"
  43 #include "llvm/Support/Allocator.h"
  44 #include "llvm/Support/CommandLine.h"
  45 #include "llvm/Support/Debug.h"
  46 #include "llvm/Target/TargetLibraryInfo.h"
  47 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  48 #include "llvm/Transforms/Utils/SSAUpdater.h"
  49 #include <vector>
  50 using namespace llvm;
  51 using namespace PatternMatch;
  52
  53 #define DEBUG_TYPE "gvn"
  54
  55 STATISTIC(NumGVNInstr,  "Number of instructions deleted");
  56 STATISTIC(NumGVNLoad,   "Number of loads deleted");
  57 STATISTIC(NumGVNPRE,    "Number of instructions PRE'd");
  58 STATISTIC(NumGVNBlocks, "Number of blocks merged");
  59 STATISTIC(NumGVNSimpl,  "Number of instructions simplified");
  60 STATISTIC(NumGVNEqProp, "Number of equalities propagated");
  61 STATISTIC(NumPRELoad,   "Number of loads PRE'd");
  62
  63 static cl::opt<bool> EnablePRE("enable-pre",
  64                                cl::init(true), cl::Hidden);
  65 static cl::opt<bool> EnableLoadPRE("enable-load-pre", cl::init(true));
  66
  67 // Maximum allowed recursion depth.
  68 static cl::opt<uint32_t>
  69 MaxRecurseDepth("max-recurse-depth", cl::Hidden, cl::init(1000), cl::ZeroOrMore,
  70                 cl::desc("Max recurse depth (default = 1000)"));
  71
  72 //===----------------------------------------------------------------------===//
  73 //                         ValueTable Class
  74 //===----------------------------------------------------------------------===//
  75
  76 /// This class holds the mapping between values and value numbers.  It is used
  77 /// as an efficient mechanism to determine the expression-wise equivalence of
  78 /// two values.
  79 namespace {
  80   struct Expression {
  81     uint32_t opcode;
  82     Type *type;
  83     SmallVector<uint32_t, 4> varargs;
  84
  85     Expression(uint32_t o = ~2U) : opcode(o) { }
  86
  87     bool operator==(const Expression &other) const {
  88       if (opcode != other.opcode)
  89         return false;
  90       if (opcode == ~0U || opcode == ~1U)
  91         return true;
  92       if (type != other.type)
  93         return false;
  94       if (varargs != other.varargs)
  95         return false;
  96       return true;
  97     }
  98
  99     friend hash_code hash_value(const Expression &Value) {
 100       return hash_combine(Value.opcode, Value.type,
 101                           hash_combine_range(Value.varargs.begin(),
 102                                              Value.varargs.end()));
 103     }
 104   };
 105
 106   class ValueTable {
 107     DenseMap<Value*, uint32_t> valueNumbering;
 108     DenseMap<Expression, uint32_t> expressionNumbering;
 109     AliasAnalysis *AA;
 110     MemoryDependenceAnalysis *MD;
 111     DominatorTree *DT;
 112
 113     uint32_t nextValueNumber;
 114
 115     Expression create_expression(Instruction* I);
 116     Expression create_cmp_expression(unsigned Opcode,
 117                                      CmpInst::Predicate Predicate,
 118                                      Value *LHS, Value *RHS);
 119     Expression create_extractvalue_expression(ExtractValueInst* EI);
 120     uint32_t lookup_or_add_call(CallInst* C);
 121   public:
 122     ValueTable() : nextValueNumber(1) { }
 123     uint32_t lookup_or_add(Value *V);
 124     uint32_t lookup(Value *V) const;
 125     uint32_t lookup_or_add_cmp(unsigned Opcode, CmpInst::Predicate Pred,
 126                                Value *LHS, Value *RHS);
 127     void add(Value *V, uint32_t num);
 128     void clear();
 129     void erase(Value *v);
 130     void setAliasAnalysis(AliasAnalysis* A) { AA = A; }
 131     AliasAnalysis *getAliasAnalysis() const { return AA; }
 132     void setMemDep(MemoryDependenceAnalysis* M) { MD = M; }
 133     void setDomTree(DominatorTree* D) { DT = D; }
 134     uint32_t getNextUnusedValueNumber() { return nextValueNumber; }
 135     void verifyRemoved(const Value *) const;
 136   };
 137 }
 138
 139 namespace llvm {
 140 template <> struct DenseMapInfo<Expression> {
 141   static inline Expression getEmptyKey() {
 142     return ~0U;
 143   }
 144
 145   static inline Expression getTombstoneKey() {
 146     return ~1U;
 147   }
 148
 149   static unsigned getHashValue(const Expression e) {
 150     using llvm::hash_value;
 151     return static_cast<unsigned>(hash_value(e));
 152   }
 153   static bool isEqual(const Expression &LHS, const Expression &RHS) {
 154     return LHS == RHS;
 155   }
 156 };
 157
 158 }
 159
 160 //===----------------------------------------------------------------------===//
 161 //                     ValueTable Internal Functions
 162 //===----------------------------------------------------------------------===//
 163
 164 Expression ValueTable::create_expression(Instruction *I) {
 165   Expression e;
 166   e.type = I->getType();
 167   e.opcode = I->getOpcode();
 168   for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
 169        OI != OE; ++OI)
 170     e.varargs.push_back(lookup_or_add(*OI));
 171   if (I->isCommutative()) {
 172     // Ensure that commutative instructions that only differ by a permutation
 173     // of their operands get the same value number by sorting the operand value
 174     // numbers.  Since all commutative instructions have two operands it is more
 175     // efficient to sort by hand rather than using, say, std::sort.
 176     assert(I->getNumOperands() == 2 && "Unsupported commutative instruction!");
 177     if (e.varargs[0] > e.varargs[1])
 178       std::swap(e.varargs[0], e.varargs[1]);
 179   }
 180
 181   if (CmpInst *C = dyn_cast<CmpInst>(I)) {
 182     // Sort the operand value numbers so x<y and y>x get the same value number.
 183     CmpInst::Predicate Predicate = C->getPredicate();
 184     if (e.varargs[0] > e.varargs[1]) {
 185       std::swap(e.varargs[0], e.varargs[1]);
 186       Predicate = CmpInst::getSwappedPredicate(Predicate);
 187     }
 188     e.opcode = (C->getOpcode() << 8) | Predicate;
 189   } else if (InsertValueInst *E = dyn_cast<InsertValueInst>(I)) {
 190     for (InsertValueInst::idx_iterator II = E->idx_begin(), IE = E->idx_end();
 191          II != IE; ++II)
 192       e.varargs.push_back(*II);
 193   }
 194
 195   return e;
 196 }
 197
 198 Expression ValueTable::create_cmp_expression(unsigned Opcode,
 199                                              CmpInst::Predicate Predicate,
 200                                              Value *LHS, Value *RHS) {
 201   assert((Opcode == Instruction::ICmp || Opcode == Instruction::FCmp) &&
 202          "Not a comparison!");
 203   Expression e;
 204   e.type = CmpInst::makeCmpResultType(LHS->getType());
 205   e.varargs.push_back(lookup_or_add(LHS));
 206   e.varargs.push_back(lookup_or_add(RHS));
 207
 208   // Sort the operand value numbers so x<y and y>x get the same value number.
 209   if (e.varargs[0] > e.varargs[1]) {
 210     std::swap(e.varargs[0], e.varargs[1]);
 211     Predicate = CmpInst::getSwappedPredicate(Predicate);
 212   }
 213   e.opcode = (Opcode << 8) | Predicate;
 214   return e;
 215 }
 216
 217 Expression ValueTable::create_extractvalue_expression(ExtractValueInst *EI) {
 218   assert(EI && "Not an ExtractValueInst?");
 219   Expression e;
 220   e.type = EI->getType();
 221   e.opcode = 0;
 222
 223   IntrinsicInst *I = dyn_cast<IntrinsicInst>(EI->getAggregateOperand());
 224   if (I != nullptr && EI->getNumIndices() == 1 && *EI->idx_begin() == 0 ) {
 225     // EI might be an extract from one of our recognised intrinsics. If it
 226     // is we'll synthesize a semantically equivalent expression instead on
 227     // an extract value expression.
 228     switch (I->getIntrinsicID()) {
 229       case Intrinsic::sadd_with_overflow:
 230       case Intrinsic::uadd_with_overflow:
 231         e.opcode = Instruction::Add;
 232         break;
 233       case Intrinsic::ssub_with_overflow:
 234       case Intrinsic::usub_with_overflow:
 235         e.opcode = Instruction::Sub;
 236         break;
 237       case Intrinsic::smul_with_overflow:
 238       case Intrinsic::umul_with_overflow:
 239         e.opcode = Instruction::Mul;
 240         break;
 241       default:
 242         break;
 243     }
 244
 245     if (e.opcode != 0) {
 246       // Intrinsic recognized. Grab its args to finish building the expression.
 247       assert(I->getNumArgOperands() == 2 &&
 248              "Expect two args for recognised intrinsics.");
 249       e.varargs.push_back(lookup_or_add(I->getArgOperand(0)));
 250       e.varargs.push_back(lookup_or_add(I->getArgOperand(1)));
 251       return e;
 252     }
 253   }
 254
 255   // Not a recognised intrinsic. Fall back to producing an extract value
 256   // expression.
 257   e.opcode = EI->getOpcode();
 258   for (Instruction::op_iterator OI = EI->op_begin(), OE = EI->op_end();
 259        OI != OE; ++OI)
 260     e.varargs.push_back(lookup_or_add(*OI));
 261
 262   for (ExtractValueInst::idx_iterator II = EI->idx_begin(), IE = EI->idx_end();
 263          II != IE; ++II)
 264     e.varargs.push_back(*II);
 265
 266   return e;
 267 }
 268
 269 //===----------------------------------------------------------------------===//
 270 //                     ValueTable External Functions
 271 //===----------------------------------------------------------------------===//
 272
 273 /// add - Insert a value into the table with a specified value number.
 274 void ValueTable::add(Value *V, uint32_t num) {
 275   valueNumbering.insert(std::make_pair(V, num));
 276 }
 277
 278 uint32_t ValueTable::lookup_or_add_call(CallInst *C) {
 279   if (AA->doesNotAccessMemory(C)) {
 280     Expression exp = create_expression(C);
 281     uint32_t &e = expressionNumbering[exp];
 282     if (!e) e = nextValueNumber++;
 283     valueNumbering[C] = e;
 284     return e;
 285   } else if (AA->onlyReadsMemory(C)) {
 286     Expression exp = create_expression(C);
 287     uint32_t &e = expressionNumbering[exp];
 288     if (!e) {
 289       e = nextValueNumber++;
 290       valueNumbering[C] = e;
 291       return e;
 292     }
 293     if (!MD) {
 294       e = nextValueNumber++;
 295       valueNumbering[C] = e;
 296       return e;
 297     }
 298
 299     MemDepResult local_dep = MD->getDependency(C);
 300
 301     if (!local_dep.isDef() && !local_dep.isNonLocal()) {
 302       valueNumbering[C] =  nextValueNumber;
 303       return nextValueNumber++;
 304     }
 305
 306     if (local_dep.isDef()) {
 307       CallInst* local_cdep = cast<CallInst>(local_dep.getInst());
 308
 309       if (local_cdep->getNumArgOperands() != C->getNumArgOperands()) {
 310         valueNumbering[C] = nextValueNumber;
 311         return nextValueNumber++;
 312       }
 313
 314       for (unsigned i = 0, e = C->getNumArgOperands(); i < e; ++i) {
 315         uint32_t c_vn = lookup_or_add(C->getArgOperand(i));
 316         uint32_t cd_vn = lookup_or_add(local_cdep->getArgOperand(i));
 317         if (c_vn != cd_vn) {
 318           valueNumbering[C] = nextValueNumber;
 319           return nextValueNumber++;
 320         }
 321       }
 322
 323       uint32_t v = lookup_or_add(local_cdep);
 324       valueNumbering[C] = v;
 325       return v;
 326     }
 327
 328     // Non-local case.
 329     const MemoryDependenceAnalysis::NonLocalDepInfo &deps =
 330       MD->getNonLocalCallDependency(CallSite(C));
 331     // FIXME: Move the checking logic to MemDep!
 332     CallInst* cdep = nullptr;
 333
 334     // Check to see if we have a single dominating call instruction that is
 335     // identical to C.
 336     for (unsigned i = 0, e = deps.size(); i != e; ++i) {
 337       const NonLocalDepEntry *I = &deps[i];
 338       if (I->getResult().isNonLocal())
 339         continue;
 340
 341       // We don't handle non-definitions.  If we already have a call, reject
 342       // instruction dependencies.
 343       if (!I->getResult().isDef() || cdep != nullptr) {
 344         cdep = nullptr;
 345         break;
 346       }
 347
 348       CallInst *NonLocalDepCall = dyn_cast<CallInst>(I->getResult().getInst());
 349       // FIXME: All duplicated with non-local case.
 350       if (NonLocalDepCall && DT->properlyDominates(I->getBB(), C->getParent())){
 351         cdep = NonLocalDepCall;
 352         continue;
 353       }
 354
 355       cdep = nullptr;
 356       break;
 357     }
 358
 359     if (!cdep) {
 360       valueNumbering[C] = nextValueNumber;
 361       return nextValueNumber++;
 362     }
 363
 364     if (cdep->getNumArgOperands() != C->getNumArgOperands()) {
 365       valueNumbering[C] = nextValueNumber;
 366       return nextValueNumber++;
 367     }
 368     for (unsigned i = 0, e = C->getNumArgOperands(); i < e; ++i) {
 369       uint32_t c_vn = lookup_or_add(C->getArgOperand(i));
 370       uint32_t cd_vn = lookup_or_add(cdep->getArgOperand(i));
 371       if (c_vn != cd_vn) {
 372         valueNumbering[C] = nextValueNumber;
 373         return nextValueNumber++;
 374       }
 375     }
 376
 377     uint32_t v = lookup_or_add(cdep);
 378     valueNumbering[C] = v;
 379     return v;
 380
 381   } else {
 382     valueNumbering[C] = nextValueNumber;
 383     return nextValueNumber++;
 384   }
 385 }
 386
 387 /// lookup_or_add - Returns the value number for the specified value, assigning
 388 /// it a new number if it did not have one before.
 389 uint32_t ValueTable::lookup_or_add(Value *V) {
 390   DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
 391   if (VI != valueNumbering.end())
 392     return VI->second;
 393
 394   if (!isa<Instruction>(V)) {
 395     valueNumbering[V] = nextValueNumber;
 396     return nextValueNumber++;
 397   }
 398
 399   Instruction* I = cast<Instruction>(V);
 400   Expression exp;
 401   switch (I->getOpcode()) {
 402     case Instruction::Call:
 403       return lookup_or_add_call(cast<CallInst>(I));
 404     case Instruction::Add:
 405     case Instruction::FAdd:
 406     case Instruction::Sub:
 407     case Instruction::FSub:
 408     case Instruction::Mul:
 409     case Instruction::FMul:
 410     case Instruction::UDiv:
 411     case Instruction::SDiv:
 412     case Instruction::FDiv:
 413     case Instruction::URem:
 414     case Instruction::SRem:
 415     case Instruction::FRem:
 416     case Instruction::Shl:
 417     case Instruction::LShr:
 418     case Instruction::AShr:
 419     case Instruction::And:
 420     case Instruction::Or:
 421     case Instruction::Xor:
 422     case Instruction::ICmp:
 423     case Instruction::FCmp:
 424     case Instruction::Trunc:
 425     case Instruction::ZExt:
 426     case Instruction::SExt:
 427     case Instruction::FPToUI:
 428     case Instruction::FPToSI:
 429     case Instruction::UIToFP:
 430     case Instruction::SIToFP:
 431     case Instruction::FPTrunc:
 432     case Instruction::FPExt:
 433     case Instruction::PtrToInt:
 434     case Instruction::IntToPtr:
 435     case Instruction::BitCast:
 436     case Instruction::Select:
 437     case Instruction::ExtractElement:
 438     case Instruction::InsertElement:
 439     case Instruction::ShuffleVector:
 440     case Instruction::InsertValue:
 441     case Instruction::GetElementPtr:
 442       exp = create_expression(I);
 443       break;
 444     case Instruction::ExtractValue:
 445       exp = create_extractvalue_expression(cast<ExtractValueInst>(I));
 446       break;
 447     default:
 448       valueNumbering[V] = nextValueNumber;
 449       return nextValueNumber++;
 450   }
 451
 452   uint32_t& e = expressionNumbering[exp];
 453   if (!e) e = nextValueNumber++;
 454   valueNumbering[V] = e;
 455   return e;
 456 }
 457
 458 /// lookup - Returns the value number of the specified value. Fails if
 459 /// the value has not yet been numbered.
 460 uint32_t ValueTable::lookup(Value *V) const {
 461   DenseMap<Value*, uint32_t>::const_iterator VI = valueNumbering.find(V);
 462   assert(VI != valueNumbering.end() && "Value not numbered?");
 463   return VI->second;
 464 }
 465
 466 /// lookup_or_add_cmp - Returns the value number of the given comparison,
 467 /// assigning it a new number if it did not have one before.  Useful when
 468 /// we deduced the result of a comparison, but don't immediately have an
 469 /// instruction realizing that comparison to hand.
 470 uint32_t ValueTable::lookup_or_add_cmp(unsigned Opcode,
 471                                        CmpInst::Predicate Predicate,
 472                                        Value *LHS, Value *RHS) {
 473   Expression exp = create_cmp_expression(Opcode, Predicate, LHS, RHS);
 474   uint32_t& e = expressionNumbering[exp];
 475   if (!e) e = nextValueNumber++;
 476   return e;
 477 }
 478
 479 /// clear - Remove all entries from the ValueTable.
 480 void ValueTable::clear() {
 481   valueNumbering.clear();
 482   expressionNumbering.clear();
 483   nextValueNumber = 1;
 484 }
 485
 486 /// erase - Remove a value from the value numbering.
 487 void ValueTable::erase(Value *V) {
 488   valueNumbering.erase(V);
 489 }
 490
 491 /// verifyRemoved - Verify that the value is removed from all internal data
 492 /// structures.
 493 void ValueTable::verifyRemoved(const Value *V) const {
 494   for (DenseMap<Value*, uint32_t>::const_iterator
 495          I = valueNumbering.begin(), E = valueNumbering.end(); I != E; ++I) {
 496     assert(I->first != V && "Inst still occurs in value numbering map!");
 497   }
 498 }
 499
 500 //===----------------------------------------------------------------------===//
 501 //                                GVN Pass
 502 //===----------------------------------------------------------------------===//
 503
 504 namespace {
 505   class GVN;
 506   struct AvailableValueInBlock {
 507     /// BB - The basic block in question.
 508     BasicBlock *BB;
 509     enum ValType {
 510       SimpleVal,  // A simple offsetted value that is accessed.
 511       LoadVal,    // A value produced by a load.
 512       MemIntrin,  // A memory intrinsic which is loaded from.
 513       UndefVal    // A UndefValue representing a value from dead block (which
 514                   // is not yet physically removed from the CFG).
 515     };
 516
 517     /// V - The value that is live out of the block.
 518     PointerIntPair<Value *, 2, ValType> Val;
 519
 520     /// Offset - The byte offset in Val that is interesting for the load query.
 521     unsigned Offset;
 522
 523     static AvailableValueInBlock get(BasicBlock *BB, Value *V,
 524                                      unsigned Offset = 0) {
 525       AvailableValueInBlock Res;
 526       Res.BB = BB;
 527       Res.Val.setPointer(V);
 528       Res.Val.setInt(SimpleVal);
 529       Res.Offset = Offset;
 530       return Res;
 531     }
 532
 533     static AvailableValueInBlock getMI(BasicBlock *BB, MemIntrinsic *MI,
 534                                        unsigned Offset = 0) {
 535       AvailableValueInBlock Res;
 536       Res.BB = BB;
 537       Res.Val.setPointer(MI);
 538       Res.Val.setInt(MemIntrin);
 539       Res.Offset = Offset;
 540       return Res;
 541     }
 542
 543     static AvailableValueInBlock getLoad(BasicBlock *BB, LoadInst *LI,
 544                                          unsigned Offset = 0) {
 545       AvailableValueInBlock Res;
 546       Res.BB = BB;
 547       Res.Val.setPointer(LI);
 548       Res.Val.setInt(LoadVal);
 549       Res.Offset = Offset;
 550       return Res;
 551     }
 552
 553     static AvailableValueInBlock getUndef(BasicBlock *BB) {
 554       AvailableValueInBlock Res;
 555       Res.BB = BB;
 556       Res.Val.setPointer(nullptr);
 557       Res.Val.setInt(UndefVal);
 558       Res.Offset = 0;
 559       return Res;
 560     }
 561
 562     bool isSimpleValue() const { return Val.getInt() == SimpleVal; }
 563     bool isCoercedLoadValue() const { return Val.getInt() == LoadVal; }
 564     bool isMemIntrinValue() const { return Val.getInt() == MemIntrin; }
 565     bool isUndefValue() const { return Val.getInt() == UndefVal; }
 566
 567     Value *getSimpleValue() const {
 568       assert(isSimpleValue() && "Wrong accessor");
 569       return Val.getPointer();
 570     }
 571
 572     LoadInst *getCoercedLoadValue() const {
 573       assert(isCoercedLoadValue() && "Wrong accessor");
 574       return cast<LoadInst>(Val.getPointer());
 575     }
 576
 577     MemIntrinsic *getMemIntrinValue() const {
 578       assert(isMemIntrinValue() && "Wrong accessor");
 579       return cast<MemIntrinsic>(Val.getPointer());
 580     }
 581
 582     /// MaterializeAdjustedValue - Emit code into this block to adjust the value
 583     /// defined here to the specified type.  This handles various coercion cases.
 584     Value *MaterializeAdjustedValue(Type *LoadTy, GVN &gvn) const;
 585   };
 586
 587   class GVN : public FunctionPass {
 588     bool NoLoads;
 589     MemoryDependenceAnalysis *MD;
 590     DominatorTree *DT;
 591     const DataLayout *DL;
 592     const TargetLibraryInfo *TLI;
 593     SetVector<BasicBlock *> DeadBlocks;
 594
 595     ValueTable VN;
 596
 597     /// LeaderTable - A mapping from value numbers to lists of Value*'s that
 598     /// have that value number.  Use findLeader to query it.
 599     struct LeaderTableEntry {
 600       Value *Val;
 601       const BasicBlock *BB;
 602       LeaderTableEntry *Next;
 603     };
 604     DenseMap<uint32_t, LeaderTableEntry> LeaderTable;
 605     BumpPtrAllocator TableAllocator;
 606
 607     SmallVector<Instruction*, 8> InstrsToErase;
 608
 609     typedef SmallVector<NonLocalDepResult, 64> LoadDepVect;
 610     typedef SmallVector<AvailableValueInBlock, 64> AvailValInBlkVect;
 611     typedef SmallVector<BasicBlock*, 64> UnavailBlkVect;
 612
 613   public:
 614     static char ID; // Pass identification, replacement for typeid
 615     explicit GVN(bool noloads = false)
 616         : FunctionPass(ID), NoLoads(noloads), MD(nullptr) {
 617       initializeGVNPass(*PassRegistry::getPassRegistry());
 618     }
 619
 620     bool runOnFunction(Function &F) override;
 621
 622     /// markInstructionForDeletion - This removes the specified instruction from
 623     /// our various maps and marks it for deletion.
 624     void markInstructionForDeletion(Instruction *I) {
 625       VN.erase(I);
 626       InstrsToErase.push_back(I);
 627     }
 628
 629     const DataLayout *getDataLayout() const { return DL; }
 630     DominatorTree &getDominatorTree() const { return *DT; }
 631     AliasAnalysis *getAliasAnalysis() const { return VN.getAliasAnalysis(); }
 632     MemoryDependenceAnalysis &getMemDep() const { return *MD; }
 633   private:
 634     /// addToLeaderTable - Push a new Value to the LeaderTable onto the list for
 635     /// its value number.
 636     void addToLeaderTable(uint32_t N, Value *V, const BasicBlock *BB) {
 637       LeaderTableEntry &Curr = LeaderTable[N];
 638       if (!Curr.Val) {
 639         Curr.Val = V;
 640         Curr.BB = BB;
 641         return;
 642       }
 643
 644       LeaderTableEntry *Node = TableAllocator.Allocate<LeaderTableEntry>();
 645       Node->Val = V;
 646       Node->BB = BB;
 647       Node->Next = Curr.Next;
 648       Curr.Next = Node;
 649     }
 650
 651     /// removeFromLeaderTable - Scan the list of values corresponding to a given
 652     /// value number, and remove the given instruction if encountered.
 653     void removeFromLeaderTable(uint32_t N, Instruction *I, BasicBlock *BB) {
 654       LeaderTableEntry* Prev = nullptr;
 655       LeaderTableEntry* Curr = &LeaderTable[N];
 656
 657       while (Curr->Val != I || Curr->BB != BB) {
 658         Prev = Curr;
 659         Curr = Curr->Next;
 660       }
 661
 662       if (Prev) {
 663         Prev->Next = Curr->Next;
 664       } else {
 665         if (!Curr->Next) {
 666           Curr->Val = nullptr;
 667           Curr->BB = nullptr;
 668         } else {
 669           LeaderTableEntry* Next = Curr->Next;
 670           Curr->Val = Next->Val;
 671           Curr->BB = Next->BB;
 672           Curr->Next = Next->Next;
 673         }
 674       }
 675     }
 676
 677     // List of critical edges to be split between iterations.
 678     SmallVector<std::pair<TerminatorInst*, unsigned>, 4> toSplit;
 679
 680     // This transformation requires dominator postdominator info
 681     void getAnalysisUsage(AnalysisUsage &AU) const override {
 682       AU.addRequired<DominatorTreeWrapperPass>();
 683       AU.addRequired<TargetLibraryInfo>();
 684       if (!NoLoads)
 685         AU.addRequired<MemoryDependenceAnalysis>();
 686       AU.addRequired<AliasAnalysis>();
 687
 688       AU.addPreserved<DominatorTreeWrapperPass>();
 689       AU.addPreserved<AliasAnalysis>();
 690     }
 691
 692
 693     // Helper fuctions of redundant load elimination
 694     bool processLoad(LoadInst *L);
 695     bool processNonLocalLoad(LoadInst *L);
 696     void AnalyzeLoadAvailability(LoadInst *LI, LoadDepVect &Deps,
 697                                  AvailValInBlkVect &ValuesPerBlock,
 698                                  UnavailBlkVect &UnavailableBlocks);
 699     bool PerformLoadPRE(LoadInst *LI, AvailValInBlkVect &ValuesPerBlock,
 700                         UnavailBlkVect &UnavailableBlocks);
 701
 702     // Other helper routines
 703     bool processInstruction(Instruction *I);
 704     bool processBlock(BasicBlock *BB);
 705     void dump(DenseMap<uint32_t, Value*> &d);
 706     bool iterateOnFunction(Function &F);
 707     bool performPRE(Function &F);
 708     Value *findLeader(const BasicBlock *BB, uint32_t num);
 709     void cleanupGlobalSets();
 710     void verifyRemoved(const Instruction *I) const;
 711     bool splitCriticalEdges();
 712     BasicBlock *splitCriticalEdges(BasicBlock *Pred, BasicBlock *Succ);
 713     unsigned replaceAllDominatedUsesWith(Value *From, Value *To,
 714                                          const BasicBlockEdge &Root);
 715     bool propagateEquality(Value *LHS, Value *RHS, const BasicBlockEdge &Root);
 716     bool processFoldableCondBr(BranchInst *BI);
 717     void addDeadBlock(BasicBlock *BB);
 718     void assignValNumForDeadCode();
 719   };
 720
 721   char GVN::ID = 0;
 722 }
 723
 724 // createGVNPass - The public interface to this file...
 725 FunctionPass *llvm::createGVNPass(bool NoLoads) {
 726   return new GVN(NoLoads);
 727 }
 728
 729 INITIALIZE_PASS_BEGIN(GVN, "gvn", "Global Value Numbering", false, false)
 730 INITIALIZE_PASS_DEPENDENCY(MemoryDependenceAnalysis)
 731 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
 732 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfo)
 733 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
 734 INITIALIZE_PASS_END(GVN, "gvn", "Global Value Numbering", false, false)
 735
 736 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 737 void GVN::dump(DenseMap<uint32_t, Value*>& d) {
 738   errs() << "{\n";
 739   for (DenseMap<uint32_t, Value*>::iterator I = d.begin(),
 740        E = d.end(); I != E; ++I) {
 741       errs() << I->first << "\n";
 742       I->second->dump();
 743   }
 744   errs() << "}\n";
 745 }
 746 #endif
 747
 748 /// IsValueFullyAvailableInBlock - Return true if we can prove that the value
 749 /// we're analyzing is fully available in the specified block.  As we go, keep
 750 /// track of which blocks we know are fully alive in FullyAvailableBlocks.  This
 751 /// map is actually a tri-state map with the following values:
 752 ///   0) we know the block *is not* fully available.
 753 ///   1) we know the block *is* fully available.
 754 ///   2) we do not know whether the block is fully available or not, but we are
 755 ///      currently speculating that it will be.
 756 ///   3) we are speculating for this block and have used that to speculate for
 757 ///      other blocks.
 758 static bool IsValueFullyAvailableInBlock(BasicBlock *BB,
 759                             DenseMap<BasicBlock*, char> &FullyAvailableBlocks,
 760                             uint32_t RecurseDepth) {
 761   if (RecurseDepth > MaxRecurseDepth)
 762     return false;
 763
 764   // Optimistically assume that the block is fully available and check to see
 765   // if we already know about this block in one lookup.
 766   std::pair<DenseMap<BasicBlock*, char>::iterator, char> IV =
 767     FullyAvailableBlocks.insert(std::make_pair(BB, 2));
 768
 769   // If the entry already existed for this block, return the precomputed value.
 770   if (!IV.second) {
 771     // If this is a speculative "available" value, mark it as being used for
 772     // speculation of other blocks.
 773     if (IV.first->second == 2)
 774       IV.first->second = 3;
 775     return IV.first->second != 0;
 776   }
 777
 778   // Otherwise, see if it is fully available in all predecessors.
 779   pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
 780
 781   // If this block has no predecessors, it isn't live-in here.
 782   if (PI == PE)
 783     goto SpeculationFailure;
 784
 785   for (; PI != PE; ++PI)
 786     // If the value isn't fully available in one of our predecessors, then it
 787     // isn't fully available in this block either.  Undo our previous
 788     // optimistic assumption and bail out.
 789     if (!IsValueFullyAvailableInBlock(*PI, FullyAvailableBlocks,RecurseDepth+1))
 790       goto SpeculationFailure;
 791
 792   return true;
 793
 794 // SpeculationFailure - If we get here, we found out that this is not, after
 795 // all, a fully-available block.  We have a problem if we speculated on this and
 796 // used the speculation to mark other blocks as available.
 797 SpeculationFailure:
 798   char &BBVal = FullyAvailableBlocks[BB];
 799
 800   // If we didn't speculate on this, just return with it set to false.
 801   if (BBVal == 2) {
 802     BBVal = 0;
 803     return false;
 804   }
 805
 806   // If we did speculate on this value, we could have blocks set to 1 that are
 807   // incorrect.  Walk the (transitive) successors of this block and mark them as
 808   // 0 if set to one.
 809   SmallVector<BasicBlock*, 32> BBWorklist;
 810   BBWorklist.push_back(BB);
 811
 812   do {
 813     BasicBlock *Entry = BBWorklist.pop_back_val();
 814     // Note that this sets blocks to 0 (unavailable) if they happen to not
 815     // already be in FullyAvailableBlocks.  This is safe.
 816     char &EntryVal = FullyAvailableBlocks[Entry];
 817     if (EntryVal == 0) continue;  // Already unavailable.
 818
 819     // Mark as unavailable.
 820     EntryVal = 0;
 821
 822     BBWorklist.append(succ_begin(Entry), succ_end(Entry));
 823   } while (!BBWorklist.empty());
 824
 825   return false;
 826 }
 827
 828
 829 /// CanCoerceMustAliasedValueToLoad - Return true if
 830 /// CoerceAvailableValueToLoadType will succeed.
 831 static bool CanCoerceMustAliasedValueToLoad(Value *StoredVal,
 832                                             Type *LoadTy,
 833                                             const DataLayout &DL) {
 834   // If the loaded or stored value is an first class array or struct, don't try
 835   // to transform them.  We need to be able to bitcast to integer.
 836   if (LoadTy->isStructTy() || LoadTy->isArrayTy() ||
 837       StoredVal->getType()->isStructTy() ||
 838       StoredVal->getType()->isArrayTy())
 839     return false;
 840
 841   // The store has to be at least as big as the load.
 842   if (DL.getTypeSizeInBits(StoredVal->getType()) <
 843         DL.getTypeSizeInBits(LoadTy))
 844     return false;
 845
 846   return true;
 847 }
 848
 849 /// CoerceAvailableValueToLoadType - If we saw a store of a value to memory, and
 850 /// then a load from a must-aliased pointer of a different type, try to coerce
 851 /// the stored value.  LoadedTy is the type of the load we want to replace and
 852 /// InsertPt is the place to insert new instructions.
 853 ///
 854 /// If we can't do it, return null.
 855 static Value *CoerceAvailableValueToLoadType(Value *StoredVal,
 856                                              Type *LoadedTy,
 857                                              Instruction *InsertPt,
 858                                              const DataLayout &DL) {
 859   if (!CanCoerceMustAliasedValueToLoad(StoredVal, LoadedTy, DL))
 860     return nullptr;
 861
 862   // If this is already the right type, just return it.
 863   Type *StoredValTy = StoredVal->getType();
 864
 865   uint64_t StoreSize = DL.getTypeSizeInBits(StoredValTy);
 866   uint64_t LoadSize = DL.getTypeSizeInBits(LoadedTy);
 867
 868   // If the store and reload are the same size, we can always reuse it.
 869   if (StoreSize == LoadSize) {
 870     // Pointer to Pointer -> use bitcast.
 871     if (StoredValTy->getScalarType()->isPointerTy() &&
 872         LoadedTy->getScalarType()->isPointerTy())
 873       return new BitCastInst(StoredVal, LoadedTy, "", InsertPt);
 874
 875     // Convert source pointers to integers, which can be bitcast.
 876     if (StoredValTy->getScalarType()->isPointerTy()) {
 877       StoredValTy = DL.getIntPtrType(StoredValTy);
 878       StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
 879     }
 880
 881     Type *TypeToCastTo = LoadedTy;
 882     if (TypeToCastTo->getScalarType()->isPointerTy())
 883       TypeToCastTo = DL.getIntPtrType(TypeToCastTo);
 884
 885     if (StoredValTy != TypeToCastTo)
 886       StoredVal = new BitCastInst(StoredVal, TypeToCastTo, "", InsertPt);
 887
 888     // Cast to pointer if the load needs a pointer type.
 889     if (LoadedTy->getScalarType()->isPointerTy())
 890       StoredVal = new IntToPtrInst(StoredVal, LoadedTy, "", InsertPt);
 891
 892     return StoredVal;
 893   }
 894
 895   // If the loaded value is smaller than the available value, then we can
 896   // extract out a piece from it.  If the available value is too small, then we
 897   // can't do anything.
 898   assert(StoreSize >= LoadSize && "CanCoerceMustAliasedValueToLoad fail");
 899
 900   // Convert source pointers to integers, which can be manipulated.
 901   if (StoredValTy->getScalarType()->isPointerTy()) {
 902     StoredValTy = DL.getIntPtrType(StoredValTy);
 903     StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
 904   }
 905
 906   // Convert vectors and fp to integer, which can be manipulated.
 907   if (!StoredValTy->isIntegerTy()) {
 908     StoredValTy = IntegerType::get(StoredValTy->getContext(), StoreSize);
 909     StoredVal = new BitCastInst(StoredVal, StoredValTy, "", InsertPt);
 910   }
 911
 912   // If this is a big-endian system, we need to shift the value down to the low
 913   // bits so that a truncate will work.
 914   if (DL.isBigEndian()) {
 915     Constant *Val = ConstantInt::get(StoredVal->getType(), StoreSize-LoadSize);
 916     StoredVal = BinaryOperator::CreateLShr(StoredVal, Val, "tmp", InsertPt);
 917   }
 918
 919   // Truncate the integer to the right size now.
 920   Type *NewIntTy = IntegerType::get(StoredValTy->getContext(), LoadSize);
 921   StoredVal = new TruncInst(StoredVal, NewIntTy, "trunc", InsertPt);
 922
 923   if (LoadedTy == NewIntTy)
 924     return StoredVal;
 925
 926   // If the result is a pointer, inttoptr.
 927   if (LoadedTy->getScalarType()->isPointerTy())
 928     return new IntToPtrInst(StoredVal, LoadedTy, "inttoptr", InsertPt);
 929
 930   // Otherwise, bitcast.
 931   return new BitCastInst(StoredVal, LoadedTy, "bitcast", InsertPt);
 932 }
 933
 934 /// AnalyzeLoadFromClobberingWrite - This function is called when we have a
 935 /// memdep query of a load that ends up being a clobbering memory write (store,
 936 /// memset, memcpy, memmove).  This means that the write *may* provide bits used
 937 /// by the load but we can't be sure because the pointers don't mustalias.
 938 ///
 939 /// Check this case to see if there is anything more we can do before we give
 940 /// up.  This returns -1 if we have to give up, or a byte number in the stored
 941 /// value of the piece that feeds the load.
 942 static int AnalyzeLoadFromClobberingWrite(Type *LoadTy, Value *LoadPtr,
 943                                           Value *WritePtr,
 944                                           uint64_t WriteSizeInBits,
 945                                           const DataLayout &DL) {
 946   // If the loaded or stored value is a first class array or struct, don't try
 947   // to transform them.  We need to be able to bitcast to integer.
 948   if (LoadTy->isStructTy() || LoadTy->isArrayTy())
 949     return -1;
 950
 951   int64_t StoreOffset = 0, LoadOffset = 0;
 952   Value *StoreBase = GetPointerBaseWithConstantOffset(WritePtr,StoreOffset,&DL);
 953   Value *LoadBase = GetPointerBaseWithConstantOffset(LoadPtr, LoadOffset, &DL);
 954   if (StoreBase != LoadBase)
 955     return -1;
 956
 957   // If the load and store are to the exact same address, they should have been
 958   // a must alias.  AA must have gotten confused.
 959   // FIXME: Study to see if/when this happens.  One case is forwarding a memset
 960   // to a load from the base of the memset.
 961 #if 0
 962   if (LoadOffset == StoreOffset) {
 963     dbgs() << "STORE/LOAD DEP WITH COMMON POINTER MISSED:\n"
 964     << "Base       = " << *StoreBase << "\n"
 965     << "Store Ptr  = " << *WritePtr << "\n"
 966     << "Store Offs = " << StoreOffset << "\n"
 967     << "Load Ptr   = " << *LoadPtr << "\n";
 968     abort();
 969   }
 970 #endif
 971
 972   // If the load and store don't overlap at all, the store doesn't provide
 973   // anything to the load.  In this case, they really don't alias at all, AA
 974   // must have gotten confused.
 975   uint64_t LoadSize = DL.getTypeSizeInBits(LoadTy);
 976
 977   if ((WriteSizeInBits & 7) | (LoadSize & 7))
 978     return -1;
 979   uint64_t StoreSize = WriteSizeInBits >> 3;  // Convert to bytes.
 980   LoadSize >>= 3;
 981
 982
 983   bool isAAFailure = false;
 984   if (StoreOffset < LoadOffset)
 985     isAAFailure = StoreOffset+int64_t(StoreSize) <= LoadOffset;
 986   else
 987     isAAFailure = LoadOffset+int64_t(LoadSize) <= StoreOffset;
 988
 989   if (isAAFailure) {
 990 #if 0
 991     dbgs() << "STORE LOAD DEP WITH COMMON BASE:\n"
 992     << "Base       = " << *StoreBase << "\n"
 993     << "Store Ptr  = " << *WritePtr << "\n"
 994     << "Store Offs = " << StoreOffset << "\n"
 995     << "Load Ptr   = " << *LoadPtr << "\n";
 996     abort();
 997 #endif
 998     return -1;
 999   }
1000
1001   // If the Load isn't completely contained within the stored bits, we don't
1002   // have all the bits to feed it.  We could do something crazy in the future
1003   // (issue a smaller load then merge the bits in) but this seems unlikely to be
1004   // valuable.
1005   if (StoreOffset > LoadOffset ||
1006       StoreOffset+StoreSize < LoadOffset+LoadSize)
1007     return -1;
1008
1009   // Okay, we can do this transformation.  Return the number of bytes into the
1010   // store that the load is.
1011   return LoadOffset-StoreOffset;
1012 }
1013
1014 /// AnalyzeLoadFromClobberingStore - This function is called when we have a
1015 /// memdep query of a load that ends up being a clobbering store.
1016 static int AnalyzeLoadFromClobberingStore(Type *LoadTy, Value *LoadPtr,
1017                                           StoreInst *DepSI,
1018                                           const DataLayout &DL) {
1019   // Cannot handle reading from store of first-class aggregate yet.
1020   if (DepSI->getValueOperand()->getType()->isStructTy() ||
1021       DepSI->getValueOperand()->getType()->isArrayTy())
1022     return -1;
1023
1024   Value *StorePtr = DepSI->getPointerOperand();
1025   uint64_t StoreSize =DL.getTypeSizeInBits(DepSI->getValueOperand()->getType());
1026   return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr,
1027                                         StorePtr, StoreSize, DL);
1028 }
1029
1030 /// AnalyzeLoadFromClobberingLoad - This function is called when we have a
1031 /// memdep query of a load that ends up being clobbered by another load.  See if
1032 /// the other load can feed into the second load.
1033 static int AnalyzeLoadFromClobberingLoad(Type *LoadTy, Value *LoadPtr,
1034                                          LoadInst *DepLI, const DataLayout &DL){
1035   // Cannot handle reading from store of first-class aggregate yet.
1036   if (DepLI->getType()->isStructTy() || DepLI->getType()->isArrayTy())
1037     return -1;
1038
1039   Value *DepPtr = DepLI->getPointerOperand();
1040   uint64_t DepSize = DL.getTypeSizeInBits(DepLI->getType());
1041   int R = AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr, DepPtr, DepSize, DL);
1042   if (R != -1) return R;
1043
1044   // If we have a load/load clobber an DepLI can be widened to cover this load,
1045   // then we should widen it!
1046   int64_t LoadOffs = 0;
1047   const Value *LoadBase =
1048     GetPointerBaseWithConstantOffset(LoadPtr, LoadOffs, &DL);
1049   unsigned LoadSize = DL.getTypeStoreSize(LoadTy);
1050
1051   unsigned Size = MemoryDependenceAnalysis::
1052     getLoadLoadClobberFullWidthSize(LoadBase, LoadOffs, LoadSize, DepLI, DL);
1053   if (Size == 0) return -1;
1054
1055   return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr, DepPtr, Size*8, DL);
1056 }
1057
1058
1059
1060 static int AnalyzeLoadFromClobberingMemInst(Type *LoadTy, Value *LoadPtr,
1061                                             MemIntrinsic *MI,
1062                                             const DataLayout &DL) {
1063   // If the mem operation is a non-constant size, we can't handle it.
1064   ConstantInt *SizeCst = dyn_cast<ConstantInt>(MI->getLength());
1065   if (!SizeCst) return -1;
1066   uint64_t MemSizeInBits = SizeCst->getZExtValue()*8;
1067
1068   // If this is memset, we just need to see if the offset is valid in the size
1069   // of the memset..
1070   if (MI->getIntrinsicID() == Intrinsic::memset)
1071     return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr, MI->getDest(),
1072                                           MemSizeInBits, DL);
1073
1074   // If we have a memcpy/memmove, the only case we can handle is if this is a
1075   // copy from constant memory.  In that case, we can read directly from the
1076   // constant memory.
1077   MemTransferInst *MTI = cast<MemTransferInst>(MI);
1078
1079   Constant *Src = dyn_cast<Constant>(MTI->getSource());
1080   if (!Src) return -1;
1081
1082   GlobalVariable *GV = dyn_cast<GlobalVariable>(GetUnderlyingObject(Src, &DL));
1083   if (!GV || !GV->isConstant()) return -1;
1084
1085   // See if the access is within the bounds of the transfer.
1086   int Offset = AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr,
1087                                               MI->getDest(), MemSizeInBits, DL);
1088   if (Offset == -1)
1089     return Offset;
1090
1091   unsigned AS = Src->getType()->getPointerAddressSpace();
1092   // Otherwise, see if we can constant fold a load from the constant with the
1093   // offset applied as appropriate.
1094   Src = ConstantExpr::getBitCast(Src,
1095                                  Type::getInt8PtrTy(Src->getContext(), AS));
1096   Constant *OffsetCst =
1097     ConstantInt::get(Type::getInt64Ty(Src->getContext()), (unsigned)Offset);
1098   Src = ConstantExpr::getGetElementPtr(Src, OffsetCst);
1099   Src = ConstantExpr::getBitCast(Src, PointerType::get(LoadTy, AS));
1100   if (ConstantFoldLoadFromConstPtr(Src, &DL))
1101     return Offset;
1102   return -1;
1103 }
1104
1105
1106 /// GetStoreValueForLoad - This function is called when we have a
1107 /// memdep query of a load that ends up being a clobbering store.  This means
1108 /// that the store provides bits used by the load but we the pointers don't
1109 /// mustalias.  Check this case to see if there is anything more we can do
1110 /// before we give up.
1111 static Value *GetStoreValueForLoad(Value *SrcVal, unsigned Offset,
1112                                    Type *LoadTy,
1113                                    Instruction *InsertPt, const DataLayout &DL){
1114   LLVMContext &Ctx = SrcVal->getType()->getContext();
1115
1116   uint64_t StoreSize = (DL.getTypeSizeInBits(SrcVal->getType()) + 7) / 8;
1117   uint64_t LoadSize = (DL.getTypeSizeInBits(LoadTy) + 7) / 8;
1118
1119   IRBuilder<> Builder(InsertPt->getParent(), InsertPt);
1120
1121   // Compute which bits of the stored value are being used by the load.  Convert
1122   // to an integer type to start with.
1123   if (SrcVal->getType()->getScalarType()->isPointerTy())
1124     SrcVal = Builder.CreatePtrToInt(SrcVal,
1125         DL.getIntPtrType(SrcVal->getType()));
1126   if (!SrcVal->getType()->isIntegerTy())
1127     SrcVal = Builder.CreateBitCast(SrcVal, IntegerType::get(Ctx, StoreSize*8));
1128
1129   // Shift the bits to the least significant depending on endianness.
1130   unsigned ShiftAmt;
1131   if (DL.isLittleEndian())
1132     ShiftAmt = Offset*8;
1133   else
1134     ShiftAmt = (StoreSize-LoadSize-Offset)*8;
1135
1136   if (ShiftAmt)
1137     SrcVal = Builder.CreateLShr(SrcVal, ShiftAmt);
1138
1139   if (LoadSize != StoreSize)
1140     SrcVal = Builder.CreateTrunc(SrcVal, IntegerType::get(Ctx, LoadSize*8));
1141
1142   return CoerceAvailableValueToLoadType(SrcVal, LoadTy, InsertPt, DL);
1143 }
1144
1145 /// GetLoadValueForLoad - This function is called when we have a
1146 /// memdep query of a load that ends up being a clobbering load.  This means
1147 /// that the load *may* provide bits used by the load but we can't be sure
1148 /// because the pointers don't mustalias.  Check this case to see if there is
1149 /// anything more we can do before we give up.
1150 static Value *GetLoadValueForLoad(LoadInst *SrcVal, unsigned Offset,
1151                                   Type *LoadTy, Instruction *InsertPt,
1152                                   GVN &gvn) {
1153   const DataLayout &DL = *gvn.getDataLayout();
1154   // If Offset+LoadTy exceeds the size of SrcVal, then we must be wanting to
1155   // widen SrcVal out to a larger load.
1156   unsigned SrcValSize = DL.getTypeStoreSize(SrcVal->getType());
1157   unsigned LoadSize = DL.getTypeStoreSize(LoadTy);
1158   if (Offset+LoadSize > SrcValSize) {
1159     assert(SrcVal->isSimple() && "Cannot widen volatile/atomic load!");
1160     assert(SrcVal->getType()->isIntegerTy() && "Can't widen non-integer load");
1161     // If we have a load/load clobber an DepLI can be widened to cover this
1162     // load, then we should widen it to the next power of 2 size big enough!
1163     unsigned NewLoadSize = Offset+LoadSize;
1164     if (!isPowerOf2_32(NewLoadSize))
1165       NewLoadSize = NextPowerOf2(NewLoadSize);
1166
1167     Value *PtrVal = SrcVal->getPointerOperand();
1168
1169     // Insert the new load after the old load.  This ensures that subsequent
1170     // memdep queries will find the new load.  We can't easily remove the old
1171     // load completely because it is already in the value numbering table.
1172     IRBuilder<> Builder(SrcVal->getParent(), ++BasicBlock::iterator(SrcVal));
1173     Type *DestPTy =
1174       IntegerType::get(LoadTy->getContext(), NewLoadSize*8);
1175     DestPTy = PointerType::get(DestPTy,
1176                                PtrVal->getType()->getPointerAddressSpace());
1177     Builder.SetCurrentDebugLocation(SrcVal->getDebugLoc());
1178     PtrVal = Builder.CreateBitCast(PtrVal, DestPTy);
1179     LoadInst *NewLoad = Builder.CreateLoad(PtrVal);
1180     NewLoad->takeName(SrcVal);
1181     NewLoad->setAlignment(SrcVal->getAlignment());
1182
1183     DEBUG(dbgs() << "GVN WIDENED LOAD: " << *SrcVal << "\n");
1184     DEBUG(dbgs() << "TO: " << *NewLoad << "\n");
1185
1186     // Replace uses of the original load with the wider load.  On a big endian
1187     // system, we need to shift down to get the relevant bits.
1188     Value *RV = NewLoad;
1189     if (DL.isBigEndian())
1190       RV = Builder.CreateLShr(RV,
1191                     NewLoadSize*8-SrcVal->getType()->getPrimitiveSizeInBits());
1192     RV = Builder.CreateTrunc(RV, SrcVal->getType());
1193     SrcVal->replaceAllUsesWith(RV);
1194
1195     // We would like to use gvn.markInstructionForDeletion here, but we can't
1196     // because the load is already memoized into the leader map table that GVN
1197     // tracks.  It is potentially possible to remove the load from the table,
1198     // but then there all of the operations based on it would need to be
1199     // rehashed.  Just leave the dead load around.
1200     gvn.getMemDep().removeInstruction(SrcVal);
1201     SrcVal = NewLoad;
1202   }
1203
1204   return GetStoreValueForLoad(SrcVal, Offset, LoadTy, InsertPt, DL);
1205 }
1206
1207
1208 /// GetMemInstValueForLoad - This function is called when we have a
1209 /// memdep query of a load that ends up being a clobbering mem intrinsic.
1210 static Value *GetMemInstValueForLoad(MemIntrinsic *SrcInst, unsigned Offset,
1211                                      Type *LoadTy, Instruction *InsertPt,
1212                                      const DataLayout &DL){
1213   LLVMContext &Ctx = LoadTy->getContext();
1214   uint64_t LoadSize = DL.getTypeSizeInBits(LoadTy)/8;
1215
1216   IRBuilder<> Builder(InsertPt->getParent(), InsertPt);
1217
1218   // We know that this method is only called when the mem transfer fully
1219   // provides the bits for the load.
1220   if (MemSetInst *MSI = dyn_cast<MemSetInst>(SrcInst)) {
1221     // memset(P, 'x', 1234) -> splat('x'), even if x is a variable, and
1222     // independently of what the offset is.
1223     Value *Val = MSI->getValue();
1224     if (LoadSize != 1)
1225       Val = Builder.CreateZExt(Val, IntegerType::get(Ctx, LoadSize*8));
1226
1227     Value *OneElt = Val;
1228
1229     // Splat the value out to the right number of bits.
1230     for (unsigned NumBytesSet = 1; NumBytesSet != LoadSize; ) {
1231       // If we can double the number of bytes set, do it.
1232       if (NumBytesSet*2 <= LoadSize) {
1233         Value *ShVal = Builder.CreateShl(Val, NumBytesSet*8);
1234         Val = Builder.CreateOr(Val, ShVal);
1235         NumBytesSet <<= 1;
1236         continue;
1237       }
1238
1239       // Otherwise insert one byte at a time.
1240       Value *ShVal = Builder.CreateShl(Val, 1*8);
1241       Val = Builder.CreateOr(OneElt, ShVal);
1242       ++NumBytesSet;
1243     }
1244
1245     return CoerceAvailableValueToLoadType(Val, LoadTy, InsertPt, DL);
1246   }
1247
1248   // Otherwise, this is a memcpy/memmove from a constant global.
1249   MemTransferInst *MTI = cast<MemTransferInst>(SrcInst);
1250   Constant *Src = cast<Constant>(MTI->getSource());
1251   unsigned AS = Src->getType()->getPointerAddressSpace();
1252
1253   // Otherwise, see if we can constant fold a load from the constant with the
1254   // offset applied as appropriate.
1255   Src = ConstantExpr::getBitCast(Src,
1256                                  Type::getInt8PtrTy(Src->getContext(), AS));
1257   Constant *OffsetCst =
1258     ConstantInt::get(Type::getInt64Ty(Src->getContext()), (unsigned)Offset);
1259   Src = ConstantExpr::getGetElementPtr(Src, OffsetCst);
1260   Src = ConstantExpr::getBitCast(Src, PointerType::get(LoadTy, AS));
1261   return ConstantFoldLoadFromConstPtr(Src, &DL);
1262 }
1263
1264
1265 /// ConstructSSAForLoadSet - Given a set of loads specified by ValuesPerBlock,
1266 /// construct SSA form, allowing us to eliminate LI.  This returns the value
1267 /// that should be used at LI's definition site.
1268 static Value *ConstructSSAForLoadSet(LoadInst *LI,
1269                          SmallVectorImpl<AvailableValueInBlock> &ValuesPerBlock,
1270                                      GVN &gvn) {
1271   // Check for the fully redundant, dominating load case.  In this case, we can
1272   // just use the dominating value directly.
1273   if (ValuesPerBlock.size() == 1 &&
1274       gvn.getDominatorTree().properlyDominates(ValuesPerBlock[0].BB,
1275                                                LI->getParent())) {
1276     assert(!ValuesPerBlock[0].isUndefValue() && "Dead BB dominate this block");
1277     return ValuesPerBlock[0].MaterializeAdjustedValue(LI->getType(), gvn);
1278   }
1279
1280   // Otherwise, we have to construct SSA form.
1281   SmallVector<PHINode*, 8> NewPHIs;
1282   SSAUpdater SSAUpdate(&NewPHIs);
1283   SSAUpdate.Initialize(LI->getType(), LI->getName());
1284
1285   Type *LoadTy = LI->getType();
1286
1287   for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i) {
1288     const AvailableValueInBlock &AV = ValuesPerBlock[i];
1289     BasicBlock *BB = AV.BB;
1290
1291     if (SSAUpdate.HasValueForBlock(BB))
1292       continue;
1293
1294     SSAUpdate.AddAvailableValue(BB, AV.MaterializeAdjustedValue(LoadTy, gvn));
1295   }
1296
1297   // Perform PHI construction.
1298   Value *V = SSAUpdate.GetValueInMiddleOfBlock(LI->getParent());
1299
1300   // If new PHI nodes were created, notify alias analysis.
1301   if (V->getType()->getScalarType()->isPointerTy()) {
1302     AliasAnalysis *AA = gvn.getAliasAnalysis();
1303
1304     for (unsigned i = 0, e = NewPHIs.size(); i != e; ++i)
1305       AA->copyValue(LI, NewPHIs[i]);
1306
1307     // Now that we've copied information to the new PHIs, scan through
1308     // them again and inform alias analysis that we've added potentially
1309     // escaping uses to any values that are operands to these PHIs.
1310     for (unsigned i = 0, e = NewPHIs.size(); i != e; ++i) {
1311       PHINode *P = NewPHIs[i];
1312       for (unsigned ii = 0, ee = P->getNumIncomingValues(); ii != ee; ++ii) {
1313         unsigned jj = PHINode::getOperandNumForIncomingValue(ii);
1314         AA->addEscapingUse(P->getOperandUse(jj));
1315       }
1316     }
1317   }
1318
1319   return V;
1320 }
1321
1322 Value *AvailableValueInBlock::MaterializeAdjustedValue(Type *LoadTy, GVN &gvn) const {
1323   Value *Res;
1324   if (isSimpleValue()) {
1325     Res = getSimpleValue();
1326     if (Res->getType() != LoadTy) {
1327       const DataLayout *DL = gvn.getDataLayout();
1328       assert(DL && "Need target data to handle type mismatch case");
1329       Res = GetStoreValueForLoad(Res, Offset, LoadTy, BB->getTerminator(),
1330                                  *DL);
1331
1332       DEBUG(dbgs() << "GVN COERCED NONLOCAL VAL:\nOffset: " << Offset << "  "
1333                    << *getSimpleValue() << '\n'
1334                    << *Res << '\n' << "\n\n\n");
1335     }
1336   } else if (isCoercedLoadValue()) {
1337     LoadInst *Load = getCoercedLoadValue();
1338     if (Load->getType() == LoadTy && Offset == 0) {
1339       Res = Load;
1340     } else {
1341       Res = GetLoadValueForLoad(Load, Offset, LoadTy, BB->getTerminator(),
1342                                 gvn);
1343
1344       DEBUG(dbgs() << "GVN COERCED NONLOCAL LOAD:\nOffset: " << Offset << "  "
1345                    << *getCoercedLoadValue() << '\n'
1346                    << *Res << '\n' << "\n\n\n");
1347     }
1348   } else if (isMemIntrinValue()) {
1349     const DataLayout *DL = gvn.getDataLayout();
1350     assert(DL && "Need target data to handle type mismatch case");
1351     Res = GetMemInstValueForLoad(getMemIntrinValue(), Offset,
1352                                  LoadTy, BB->getTerminator(), *DL);
1353     DEBUG(dbgs() << "GVN COERCED NONLOCAL MEM INTRIN:\nOffset: " << Offset
1354                  << "  " << *getMemIntrinValue() << '\n'
1355                  << *Res << '\n' << "\n\n\n");
1356   } else {
1357     assert(isUndefValue() && "Should be UndefVal");
1358     DEBUG(dbgs() << "GVN COERCED NONLOCAL Undef:\n";);
1359     return UndefValue::get(LoadTy);
1360   }
1361   return Res;
1362 }
1363
1364 static bool isLifetimeStart(const Instruction *Inst) {
1365   if (const IntrinsicInst* II = dyn_cast<IntrinsicInst>(Inst))
1366     return II->getIntrinsicID() == Intrinsic::lifetime_start;
1367   return false;
1368 }
1369
1370 void GVN::AnalyzeLoadAvailability(LoadInst *LI, LoadDepVect &Deps,
1371                                   AvailValInBlkVect &ValuesPerBlock,
1372                                   UnavailBlkVect &UnavailableBlocks) {
1373
1374   // Filter out useless results (non-locals, etc).  Keep track of the blocks
1375   // where we have a value available in repl, also keep track of whether we see
1376   // dependencies that produce an unknown value for the load (such as a call
1377   // that could potentially clobber the load).
1378   unsigned NumDeps = Deps.size();
1379   for (unsigned i = 0, e = NumDeps; i != e; ++i) {
1380     BasicBlock *DepBB = Deps[i].getBB();
1381     MemDepResult DepInfo = Deps[i].getResult();
1382
1383     if (DeadBlocks.count(DepBB)) {
1384       // Dead dependent mem-op disguise as a load evaluating the same value
1385       // as the load in question.
1386       ValuesPerBlock.push_back(AvailableValueInBlock::getUndef(DepBB));
1387       continue;
1388     }
1389
1390     if (!DepInfo.isDef() && !DepInfo.isClobber()) {
1391       UnavailableBlocks.push_back(DepBB);
1392       continue;
1393     }
1394
1395     if (DepInfo.isClobber()) {
1396       // The address being loaded in this non-local block may not be the same as
1397       // the pointer operand of the load if PHI translation occurs.  Make sure
1398       // to consider the right address.
1399       Value *Address = Deps[i].getAddress();
1400
1401       // If the dependence is to a store that writes to a superset of the bits
1402       // read by the load, we can extract the bits we need for the load from the
1403       // stored value.
1404       if (StoreInst *DepSI = dyn_cast<StoreInst>(DepInfo.getInst())) {
1405         if (DL && Address) {
1406           int Offset = AnalyzeLoadFromClobberingStore(LI->getType(), Address,
1407                                                       DepSI, *DL);
1408           if (Offset != -1) {
1409             ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
1410                                                        DepSI->getValueOperand(),
1411                                                                 Offset));
1412             continue;
1413           }
1414         }
1415       }
1416
1417       // Check to see if we have something like this:
1418       //    load i32* P
1419       //    load i8* (P+1)
1420       // if we have this, replace the later with an extraction from the former.
1421       if (LoadInst *DepLI = dyn_cast<LoadInst>(DepInfo.getInst())) {
1422         // If this is a clobber and L is the first instruction in its block, then
1423         // we have the first instruction in the entry block.
1424         if (DepLI != LI && Address && DL) {
1425           int Offset = AnalyzeLoadFromClobberingLoad(LI->getType(), Address,
1426                                                      DepLI, *DL);
1427
1428           if (Offset != -1) {
1429             ValuesPerBlock.push_back(AvailableValueInBlock::getLoad(DepBB,DepLI,
1430                                                                     Offset));
1431             continue;
1432           }
1433         }
1434       }
1435
1436       // If the clobbering value is a memset/memcpy/memmove, see if we can
1437       // forward a value on from it.
1438       if (MemIntrinsic *DepMI = dyn_cast<MemIntrinsic>(DepInfo.getInst())) {
1439         if (DL && Address) {
1440           int Offset = AnalyzeLoadFromClobberingMemInst(LI->getType(), Address,
1441                                                         DepMI, *DL);
1442           if (Offset != -1) {
1443             ValuesPerBlock.push_back(AvailableValueInBlock::getMI(DepBB, DepMI,
1444                                                                   Offset));
1445             continue;
1446           }
1447         }
1448       }
1449
1450       UnavailableBlocks.push_back(DepBB);
1451       continue;
1452     }
1453
1454     // DepInfo.isDef() here
1455
1456     Instruction *DepInst = DepInfo.getInst();
1457
1458     // Loading the allocation -> undef.
1459     if (isa<AllocaInst>(DepInst) || isMallocLikeFn(DepInst, TLI) ||
1460         // Loading immediately after lifetime begin -> undef.
1461         isLifetimeStart(DepInst)) {
1462       ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
1463                                              UndefValue::get(LI->getType())));
1464       continue;
1465     }
1466
1467     // Loading from calloc (which zero initializes memory) -> zero
1468     if (isCallocLikeFn(DepInst, TLI)) {
1469       ValuesPerBlock.push_back(AvailableValueInBlock::get(
1470           DepBB, Constant::getNullValue(LI->getType())));
1471       continue;
1472     }
1473
1474     if (StoreInst *S = dyn_cast<StoreInst>(DepInst)) {
1475       // Reject loads and stores that are to the same address but are of
1476       // different types if we have to.
1477       if (S->getValueOperand()->getType() != LI->getType()) {
1478         // If the stored value is larger or equal to the loaded value, we can
1479         // reuse it.
1480         if (!DL || !CanCoerceMustAliasedValueToLoad(S->getValueOperand(),
1481                                                     LI->getType(), *DL)) {
1482           UnavailableBlocks.push_back(DepBB);
1483           continue;
1484         }
1485       }
1486
1487       ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
1488                                                          S->getValueOperand()));
1489       continue;
1490     }
1491
1492     if (LoadInst *LD = dyn_cast<LoadInst>(DepInst)) {
1493       // If the types mismatch and we can't handle it, reject reuse of the load.
1494       if (LD->getType() != LI->getType()) {
1495         // If the stored value is larger or equal to the loaded value, we can
1496         // reuse it.
1497         if (!DL || !CanCoerceMustAliasedValueToLoad(LD, LI->getType(),*DL)) {
1498           UnavailableBlocks.push_back(DepBB);
1499           continue;
1500         }
1501       }
1502       ValuesPerBlock.push_back(AvailableValueInBlock::getLoad(DepBB, LD));
1503       continue;
1504     }
1505
1506     UnavailableBlocks.push_back(DepBB);
1507   }
1508 }
1509
1510 bool GVN::PerformLoadPRE(LoadInst *LI, AvailValInBlkVect &ValuesPerBlock,
1511                          UnavailBlkVect &UnavailableBlocks) {
1512   // Okay, we have *some* definitions of the value.  This means that the value
1513   // is available in some of our (transitive) predecessors.  Lets think about
1514   // doing PRE of this load.  This will involve inserting a new load into the
1515   // predecessor when it's not available.  We could do this in general, but
1516   // prefer to not increase code size.  As such, we only do this when we know
1517   // that we only have to insert *one* load (which means we're basically moving
1518   // the load, not inserting a new one).
1519
1520   SmallPtrSet<BasicBlock *, 4> Blockers;
1521   for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1522     Blockers.insert(UnavailableBlocks[i]);
1523
1524   // Let's find the first basic block with more than one predecessor.  Walk
1525   // backwards through predecessors if needed.
1526   BasicBlock *LoadBB = LI->getParent();
1527   BasicBlock *TmpBB = LoadBB;
1528
1529   while (TmpBB->getSinglePredecessor()) {
1530     TmpBB = TmpBB->getSinglePredecessor();
1531     if (TmpBB == LoadBB) // Infinite (unreachable) loop.
1532       return false;
1533     if (Blockers.count(TmpBB))
1534       return false;
1535
1536     // If any of these blocks has more than one successor (i.e. if the edge we
1537     // just traversed was critical), then there are other paths through this
1538     // block along which the load may not be anticipated.  Hoisting the load
1539     // above this block would be adding the load to execution paths along
1540     // which it was not previously executed.
1541     if (TmpBB->getTerminator()->getNumSuccessors() != 1)
1542       return false;
1543   }
1544
1545   assert(TmpBB);
1546   LoadBB = TmpBB;
1547
1548   // Check to see how many predecessors have the loaded value fully
1549   // available.
1550   MapVector<BasicBlock *, Value *> PredLoads;
1551   DenseMap<BasicBlock*, char> FullyAvailableBlocks;
1552   for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i)
1553     FullyAvailableBlocks[ValuesPerBlock[i].BB] = true;
1554   for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1555     FullyAvailableBlocks[UnavailableBlocks[i]] = false;
1556
1557   SmallVector<BasicBlock *, 4> CriticalEdgePred;
1558   for (BasicBlock *Pred : predecessors(LoadBB)) {
1559     if (IsValueFullyAvailableInBlock(Pred, FullyAvailableBlocks, 0)) {
1560       continue;
1561     }
1562
1563     if (Pred->getTerminator()->getNumSuccessors() != 1) {
1564       if (isa<IndirectBrInst>(Pred->getTerminator())) {
1565         DEBUG(dbgs() << "COULD NOT PRE LOAD BECAUSE OF INDBR CRITICAL EDGE '"
1566               << Pred->getName() << "': " << *LI << '\n');
1567         return false;
1568       }
1569
1570       if (LoadBB->isLandingPad()) {
1571         DEBUG(dbgs()
1572               << "COULD NOT PRE LOAD BECAUSE OF LANDING PAD CRITICAL EDGE '"
1573               << Pred->getName() << "': " << *LI << '\n');
1574         return false;
1575       }
1576
1577       CriticalEdgePred.push_back(Pred);
1578     } else {
1579       // Only add the predecessors that will not be split for now.
1580       PredLoads[Pred] = nullptr;
1581     }
1582   }
1583
1584   // Decide whether PRE is profitable for this load.
1585   unsigned NumUnavailablePreds = PredLoads.size() + CriticalEdgePred.size();
1586   assert(NumUnavailablePreds != 0 &&
1587          "Fully available value should already be eliminated!");
1588
1589   // If this load is unavailable in multiple predecessors, reject it.
1590   // FIXME: If we could restructure the CFG, we could make a common pred with
1591   // all the preds that don't have an available LI and insert a new load into
1592   // that one block.
1593   if (NumUnavailablePreds != 1)
1594       return false;
1595
1596   // Split critical edges, and update the unavailable predecessors accordingly.
1597   for (BasicBlock *OrigPred : CriticalEdgePred) {
1598     BasicBlock *NewPred = splitCriticalEdges(OrigPred, LoadBB);
1599     assert(!PredLoads.count(OrigPred) && "Split edges shouldn't be in map!");
1600     PredLoads[NewPred] = nullptr;
1601     DEBUG(dbgs() << "Split critical edge " << OrigPred->getName() << "->"
1602                  << LoadBB->getName() << '\n');
1603   }
1604
1605   // Check if the load can safely be moved to all the unavailable predecessors.
1606   bool CanDoPRE = true;
1607   SmallVector<Instruction*, 8> NewInsts;
1608   for (auto &PredLoad : PredLoads) {
1609     BasicBlock *UnavailablePred = PredLoad.first;
1610
1611     // Do PHI translation to get its value in the predecessor if necessary.  The
1612     // returned pointer (if non-null) is guaranteed to dominate UnavailablePred.
1613
1614     // If all preds have a single successor, then we know it is safe to insert
1615     // the load on the pred (?!?), so we can insert code to materialize the
1616     // pointer if it is not available.
1617     PHITransAddr Address(LI->getPointerOperand(), DL);
1618     Value *LoadPtr = nullptr;
1619     LoadPtr = Address.PHITranslateWithInsertion(LoadBB, UnavailablePred,
1620                                                 *DT, NewInsts);
1621
1622     // If we couldn't find or insert a computation of this phi translated value,
1623     // we fail PRE.
1624     if (!LoadPtr) {
1625       DEBUG(dbgs() << "COULDN'T INSERT PHI TRANSLATED VALUE OF: "
1626             << *LI->getPointerOperand() << "\n");
1627       CanDoPRE = false;
1628       break;
1629     }
1630
1631     PredLoad.second = LoadPtr;
1632   }
1633
1634   if (!CanDoPRE) {
1635     while (!NewInsts.empty()) {
1636       Instruction *I = NewInsts.pop_back_val();
1637       if (MD) MD->removeInstruction(I);
1638       I->eraseFromParent();
1639     }
1640     // HINT: Don't revert the edge-splitting as following transformation may
1641     // also need to split these critical edges.
1642     return !CriticalEdgePred.empty();
1643   }
1644
1645   // Okay, we can eliminate this load by inserting a reload in the predecessor
1646   // and using PHI construction to get the value in the other predecessors, do
1647   // it.
1648   DEBUG(dbgs() << "GVN REMOVING PRE LOAD: " << *LI << '\n');
1649   DEBUG(if (!NewInsts.empty())
1650           dbgs() << "INSERTED " << NewInsts.size() << " INSTS: "
1651                  << *NewInsts.back() << '\n');
1652
1653   // Assign value numbers to the new instructions.
1654   for (unsigned i = 0, e = NewInsts.size(); i != e; ++i) {
1655     // FIXME: We really _ought_ to insert these value numbers into their
1656     // parent's availability map.  However, in doing so, we risk getting into
1657     // ordering issues.  If a block hasn't been processed yet, we would be
1658     // marking a value as AVAIL-IN, which isn't what we intend.
1659     VN.lookup_or_add(NewInsts[i]);
1660   }
1661
1662   for (const auto &PredLoad : PredLoads) {
1663     BasicBlock *UnavailablePred = PredLoad.first;
1664     Value *LoadPtr = PredLoad.second;
1665
1666     Instruction *NewLoad = new LoadInst(LoadPtr, LI->getName()+".pre", false,
1667                                         LI->getAlignment(),
1668                                         UnavailablePred->getTerminator());
1669
1670     // Transfer the old load's TBAA tag to the new load.
1671     if (MDNode *Tag = LI->getMetadata(LLVMContext::MD_tbaa))
1672       NewLoad->setMetadata(LLVMContext::MD_tbaa, Tag);
1673
1674     // Transfer DebugLoc.
1675     NewLoad->setDebugLoc(LI->getDebugLoc());
1676
1677     // Add the newly created load.
1678     ValuesPerBlock.push_back(AvailableValueInBlock::get(UnavailablePred,
1679                                                         NewLoad));
1680     MD->invalidateCachedPointerInfo(LoadPtr);
1681     DEBUG(dbgs() << "GVN INSERTED " << *NewLoad << '\n');
1682   }
1683
1684   // Perform PHI construction.
1685   Value *V = ConstructSSAForLoadSet(LI, ValuesPerBlock, *this);
1686   LI->replaceAllUsesWith(V);
1687   if (isa<PHINode>(V))
1688     V->takeName(LI);
1689   if (V->getType()->getScalarType()->isPointerTy())
1690     MD->invalidateCachedPointerInfo(V);
1691   markInstructionForDeletion(LI);
1692   ++NumPRELoad;
1693   return true;
1694 }
1695
1696 /// processNonLocalLoad - Attempt to eliminate a load whose dependencies are
1697 /// non-local by performing PHI construction.
1698 bool GVN::processNonLocalLoad(LoadInst *LI) {
1699   // Step 1: Find the non-local dependencies of the load.
1700   LoadDepVect Deps;
1701   AliasAnalysis::Location Loc = VN.getAliasAnalysis()->getLocation(LI);
1702   MD->getNonLocalPointerDependency(Loc, true, LI->getParent(), Deps);
1703
1704   // If we had to process more than one hundred blocks to find the
1705   // dependencies, this load isn't worth worrying about.  Optimizing
1706   // it will be too expensive.
1707   unsigned NumDeps = Deps.size();
1708   if (NumDeps > 100)
1709     return false;
1710
1711   // If we had a phi translation failure, we'll have a single entry which is a
1712   // clobber in the current block.  Reject this early.
1713   if (NumDeps == 1 &&
1714       !Deps[0].getResult().isDef() && !Deps[0].getResult().isClobber()) {
1715     DEBUG(
1716       dbgs() << "GVN: non-local load ";
1717       LI->printAsOperand(dbgs());
1718       dbgs() << " has unknown dependencies\n";
1719     );
1720     return false;
1721   }
1722
1723   // Step 2: Analyze the availability of the load
1724   AvailValInBlkVect ValuesPerBlock;
1725   UnavailBlkVect UnavailableBlocks;
1726   AnalyzeLoadAvailability(LI, Deps, ValuesPerBlock, UnavailableBlocks);
1727
1728   // If we have no predecessors that produce a known value for this load, exit
1729   // early.
1730   if (ValuesPerBlock.empty())
1731     return false;
1732
1733   // Step 3: Eliminate fully redundancy.
1734   //
1735   // If all of the instructions we depend on produce a known value for this
1736   // load, then it is fully redundant and we can use PHI insertion to compute
1737   // its value.  Insert PHIs and remove the fully redundant value now.
1738   if (UnavailableBlocks.empty()) {
1739     DEBUG(dbgs() << "GVN REMOVING NONLOCAL LOAD: " << *LI << '\n');
1740
1741     // Perform PHI construction.
1742     Value *V = ConstructSSAForLoadSet(LI, ValuesPerBlock, *this);
1743     LI->replaceAllUsesWith(V);
1744
1745     if (isa<PHINode>(V))
1746       V->takeName(LI);
1747     if (V->getType()->getScalarType()->isPointerTy())
1748       MD->invalidateCachedPointerInfo(V);
1749     markInstructionForDeletion(LI);
1750     ++NumGVNLoad;
1751     return true;
1752   }
1753
1754   // Step 4: Eliminate partial redundancy.
1755   if (!EnablePRE || !EnableLoadPRE)
1756     return false;
1757
1758   return PerformLoadPRE(LI, ValuesPerBlock, UnavailableBlocks);
1759 }
1760
1761
1762 static void patchReplacementInstruction(Instruction *I, Value *Repl) {
1763   // Patch the replacement so that it is not more restrictive than the value
1764   // being replaced.
1765   BinaryOperator *Op = dyn_cast<BinaryOperator>(I);
1766   BinaryOperator *ReplOp = dyn_cast<BinaryOperator>(Repl);
1767   if (Op && ReplOp && isa<OverflowingBinaryOperator>(Op) &&
1768       isa<OverflowingBinaryOperator>(ReplOp)) {
1769     if (ReplOp->hasNoSignedWrap() && !Op->hasNoSignedWrap())
1770       ReplOp->setHasNoSignedWrap(false);
1771     if (ReplOp->hasNoUnsignedWrap() && !Op->hasNoUnsignedWrap())
1772       ReplOp->setHasNoUnsignedWrap(false);
1773   }
1774   if (Instruction *ReplInst = dyn_cast<Instruction>(Repl)) {
1775     SmallVector<std::pair<unsigned, MDNode*>, 4> Metadata;
1776     ReplInst->getAllMetadataOtherThanDebugLoc(Metadata);
1777     for (int i = 0, n = Metadata.size(); i < n; ++i) {
1778       unsigned Kind = Metadata[i].first;
1779       MDNode *IMD = I->getMetadata(Kind);
1780       MDNode *ReplMD = Metadata[i].second;
1781       switch(Kind) {
1782       default:
1783         ReplInst->setMetadata(Kind, nullptr); // Remove unknown metadata
1784         break;
1785       case LLVMContext::MD_dbg:
1786         llvm_unreachable("getAllMetadataOtherThanDebugLoc returned a MD_dbg");
1787       case LLVMContext::MD_tbaa:
1788         ReplInst->setMetadata(Kind, MDNode::getMostGenericTBAA(IMD, ReplMD));
1789         break;
1790       case LLVMContext::MD_range:
1791         ReplInst->setMetadata(Kind, MDNode::getMostGenericRange(IMD, ReplMD));
1792         break;
1793       case LLVMContext::MD_prof:
1794         llvm_unreachable("MD_prof in a non-terminator instruction");
1795         break;
1796       case LLVMContext::MD_fpmath:
1797         ReplInst->setMetadata(Kind, MDNode::getMostGenericFPMath(IMD, ReplMD));
1798         break;
1799       case LLVMContext::MD_invariant_load:
1800         // Only set the !invariant.load if it is present in both instructions.
1801         ReplInst->setMetadata(Kind, IMD);
1802         break;
1803       }
1804     }
1805   }
1806 }
1807
1808 static void patchAndReplaceAllUsesWith(Instruction *I, Value *Repl) {
1809   patchReplacementInstruction(I, Repl);
1810   I->replaceAllUsesWith(Repl);
1811 }
1812
1813 /// processLoad - Attempt to eliminate a load, first by eliminating it
1814 /// locally, and then attempting non-local elimination if that fails.
1815 bool GVN::processLoad(LoadInst *L) {
1816   if (!MD)
1817     return false;
1818
1819   if (!L->isSimple())
1820     return false;
1821
1822   if (L->use_empty()) {
1823     markInstructionForDeletion(L);
1824     return true;
1825   }
1826
1827   // ... to a pointer that has been loaded from before...
1828   MemDepResult Dep = MD->getDependency(L);
1829
1830   // If we have a clobber and target data is around, see if this is a clobber
1831   // that we can fix up through code synthesis.
1832   if (Dep.isClobber() && DL) {
1833     // Check to see if we have something like this:
1834     //   store i32 123, i32* %P
1835     //   %A = bitcast i32* %P to i8*
1836     //   %B = gep i8* %A, i32 1
1837     //   %C = load i8* %B
1838     //
1839     // We could do that by recognizing if the clobber instructions are obviously
1840     // a common base + constant offset, and if the previous store (or memset)
1841     // completely covers this load.  This sort of thing can happen in bitfield
1842     // access code.
1843     Value *AvailVal = nullptr;
1844     if (StoreInst *DepSI = dyn_cast<StoreInst>(Dep.getInst())) {
1845       int Offset = AnalyzeLoadFromClobberingStore(L->getType(),
1846                                                   L->getPointerOperand(),
1847                                                   DepSI, *DL);
1848       if (Offset != -1)
1849         AvailVal = GetStoreValueForLoad(DepSI->getValueOperand(), Offset,
1850                                         L->getType(), L, *DL);
1851     }
1852
1853     // Check to see if we have something like this:
1854     //    load i32* P
1855     //    load i8* (P+1)
1856     // if we have this, replace the later with an extraction from the former.
1857     if (LoadInst *DepLI = dyn_cast<LoadInst>(Dep.getInst())) {
1858       // If this is a clobber and L is the first instruction in its block, then
1859       // we have the first instruction in the entry block.
1860       if (DepLI == L)
1861         return false;
1862
1863       int Offset = AnalyzeLoadFromClobberingLoad(L->getType(),
1864                                                  L->getPointerOperand(),
1865                                                  DepLI, *DL);
1866       if (Offset != -1)
1867         AvailVal = GetLoadValueForLoad(DepLI, Offset, L->getType(), L, *this);
1868     }
1869
1870     // If the clobbering value is a memset/memcpy/memmove, see if we can forward
1871     // a value on from it.
1872     if (MemIntrinsic *DepMI = dyn_cast<MemIntrinsic>(Dep.getInst())) {
1873       int Offset = AnalyzeLoadFromClobberingMemInst(L->getType(),
1874                                                     L->getPointerOperand(),
1875                                                     DepMI, *DL);
1876       if (Offset != -1)
1877         AvailVal = GetMemInstValueForLoad(DepMI, Offset, L->getType(), L, *DL);
1878     }
1879
1880     if (AvailVal) {
1881       DEBUG(dbgs() << "GVN COERCED INST:\n" << *Dep.getInst() << '\n'
1882             << *AvailVal << '\n' << *L << "\n\n\n");
1883
1884       // Replace the load!
1885       L->replaceAllUsesWith(AvailVal);
1886       if (AvailVal->getType()->getScalarType()->isPointerTy())
1887         MD->invalidateCachedPointerInfo(AvailVal);
1888       markInstructionForDeletion(L);
1889       ++NumGVNLoad;
1890       return true;
1891     }
1892   }
1893
1894   // If the value isn't available, don't do anything!
1895   if (Dep.isClobber()) {
1896     DEBUG(
1897       // fast print dep, using operator<< on instruction is too slow.
1898       dbgs() << "GVN: load ";
1899       L->printAsOperand(dbgs());
1900       Instruction *I = Dep.getInst();
1901       dbgs() << " is clobbered by " << *I << '\n';
1902     );
1903     return false;
1904   }
1905
1906   // If it is defined in another block, try harder.
1907   if (Dep.isNonLocal())
1908     return processNonLocalLoad(L);
1909
1910   if (!Dep.isDef()) {
1911     DEBUG(
1912       // fast print dep, using operator<< on instruction is too slow.
1913       dbgs() << "GVN: load ";
1914       L->printAsOperand(dbgs());
1915       dbgs() << " has unknown dependence\n";
1916     );
1917     return false;
1918   }
1919
1920   Instruction *DepInst = Dep.getInst();
1921   if (StoreInst *DepSI = dyn_cast<StoreInst>(DepInst)) {
1922     Value *StoredVal = DepSI->getValueOperand();
1923
1924     // The store and load are to a must-aliased pointer, but they may not
1925     // actually have the same type.  See if we know how to reuse the stored
1926     // value (depending on its type).
1927     if (StoredVal->getType() != L->getType()) {
1928       if (DL) {
1929         StoredVal = CoerceAvailableValueToLoadType(StoredVal, L->getType(),
1930                                                    L, *DL);
1931         if (!StoredVal)
1932           return false;
1933
1934         DEBUG(dbgs() << "GVN COERCED STORE:\n" << *DepSI << '\n' << *StoredVal
1935                      << '\n' << *L << "\n\n\n");
1936       }
1937       else
1938         return false;
1939     }
1940
1941     // Remove it!
1942     L->replaceAllUsesWith(StoredVal);
1943     if (StoredVal->getType()->getScalarType()->isPointerTy())
1944       MD->invalidateCachedPointerInfo(StoredVal);
1945     markInstructionForDeletion(L);
1946     ++NumGVNLoad;
1947     return true;
1948   }
1949
1950   if (LoadInst *DepLI = dyn_cast<LoadInst>(DepInst)) {
1951     Value *AvailableVal = DepLI;
1952
1953     // The loads are of a must-aliased pointer, but they may not actually have
1954     // the same type.  See if we know how to reuse the previously loaded value
1955     // (depending on its type).
1956     if (DepLI->getType() != L->getType()) {
1957       if (DL) {
1958         AvailableVal = CoerceAvailableValueToLoadType(DepLI, L->getType(),
1959                                                       L, *DL);
1960         if (!AvailableVal)
1961           return false;
1962
1963         DEBUG(dbgs() << "GVN COERCED LOAD:\n" << *DepLI << "\n" << *AvailableVal
1964                      << "\n" << *L << "\n\n\n");
1965       }
1966       else
1967         return false;
1968     }
1969
1970     // Remove it!
1971     patchAndReplaceAllUsesWith(L, AvailableVal);
1972     if (DepLI->getType()->getScalarType()->isPointerTy())
1973       MD->invalidateCachedPointerInfo(DepLI);
1974     markInstructionForDeletion(L);
1975     ++NumGVNLoad;
1976     return true;
1977   }
1978
1979   // If this load really doesn't depend on anything, then we must be loading an
1980   // undef value.  This can happen when loading for a fresh allocation with no
1981   // intervening stores, for example.
1982   if (isa<AllocaInst>(DepInst) || isMallocLikeFn(DepInst, TLI)) {
1983     L->replaceAllUsesWith(UndefValue::get(L->getType()));
1984     markInstructionForDeletion(L);
1985     ++NumGVNLoad;
1986     return true;
1987   }
1988
1989   // If this load occurs either right after a lifetime begin,
1990   // then the loaded value is undefined.
1991   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(DepInst)) {
1992     if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
1993       L->replaceAllUsesWith(UndefValue::get(L->getType()));
1994       markInstructionForDeletion(L);
1995       ++NumGVNLoad;
1996       return true;
1997     }
1998   }
1999
2000   // If this load follows a calloc (which zero initializes memory),
2001   // then the loaded value is zero
2002   if (isCallocLikeFn(DepInst, TLI)) {
2003     L->replaceAllUsesWith(Constant::getNullValue(L->getType()));
2004     markInstructionForDeletion(L);
2005     ++NumGVNLoad;
2006     return true;
2007   }
2008
2009   return false;
2010 }
2011
2012 // findLeader - In order to find a leader for a given value number at a
2013 // specific basic block, we first obtain the list of all Values for that number,
2014 // and then scan the list to find one whose block dominates the block in
2015 // question.  This is fast because dominator tree queries consist of only
2016 // a few comparisons of DFS numbers.
2017 Value *GVN::findLeader(const BasicBlock *BB, uint32_t num) {
2018   LeaderTableEntry Vals = LeaderTable[num];
2019   if (!Vals.Val) return nullptr;
2020
2021   Value *Val = nullptr;
2022   if (DT->dominates(Vals.BB, BB)) {
2023     Val = Vals.Val;
2024     if (isa<Constant>(Val)) return Val;
2025   }
2026
2027   LeaderTableEntry* Next = Vals.Next;
2028   while (Next) {
2029     if (DT->dominates(Next->BB, BB)) {
2030       if (isa<Constant>(Next->Val)) return Next->Val;
2031       if (!Val) Val = Next->Val;
2032     }
2033
2034     Next = Next->Next;
2035   }
2036
2037   return Val;
2038 }
2039
2040 /// replaceAllDominatedUsesWith - Replace all uses of 'From' with 'To' if the
2041 /// use is dominated by the given basic block.  Returns the number of uses that
2042 /// were replaced.
2043 unsigned GVN::replaceAllDominatedUsesWith(Value *From, Value *To,
2044                                           const BasicBlockEdge &Root) {
2045   unsigned Count = 0;
2046   for (Value::use_iterator UI = From->use_begin(), UE = From->use_end();
2047        UI != UE; ) {
2048     Use &U = *UI++;
2049
2050     if (DT->dominates(Root, U)) {
2051       U.set(To);
2052       ++Count;
2053     }
2054   }
2055   return Count;
2056 }
2057
2058 /// isOnlyReachableViaThisEdge - There is an edge from 'Src' to 'Dst'.  Return
2059 /// true if every path from the entry block to 'Dst' passes via this edge.  In
2060 /// particular 'Dst' must not be reachable via another edge from 'Src'.
2061 static bool isOnlyReachableViaThisEdge(const BasicBlockEdge &E,
2062                                        DominatorTree *DT) {
2063   // While in theory it is interesting to consider the case in which Dst has
2064   // more than one predecessor, because Dst might be part of a loop which is
2065   // only reachable from Src, in practice it is pointless since at the time
2066   // GVN runs all such loops have preheaders, which means that Dst will have
2067   // been changed to have only one predecessor, namely Src.
2068   const BasicBlock *Pred = E.getEnd()->getSinglePredecessor();
2069   const BasicBlock *Src = E.getStart();
2070   assert((!Pred || Pred == Src) && "No edge between these basic blocks!");
2071   (void)Src;
2072   return Pred != nullptr;
2073 }
2074
2075 /// propagateEquality - The given values are known to be equal in every block
2076 /// dominated by 'Root'.  Exploit this, for example by replacing 'LHS' with
2077 /// 'RHS' everywhere in the scope.  Returns whether a change was made.
2078 bool GVN::propagateEquality(Value *LHS, Value *RHS,
2079                             const BasicBlockEdge &Root) {
2080   SmallVector<std::pair<Value*, Value*>, 4> Worklist;
2081   Worklist.push_back(std::make_pair(LHS, RHS));
2082   bool Changed = false;
2083   // For speed, compute a conservative fast approximation to
2084   // DT->dominates(Root, Root.getEnd());
2085   bool RootDominatesEnd = isOnlyReachableViaThisEdge(Root, DT);
2086
2087   while (!Worklist.empty()) {
2088     std::pair<Value*, Value*> Item = Worklist.pop_back_val();
2089     LHS = Item.first; RHS = Item.second;
2090
2091     if (LHS == RHS) continue;
2092     assert(LHS->getType() == RHS->getType() && "Equality but unequal types!");
2093
2094     // Don't try to propagate equalities between constants.
2095     if (isa<Constant>(LHS) && isa<Constant>(RHS)) continue;
2096
2097     // Prefer a constant on the right-hand side, or an Argument if no constants.
2098     if (isa<Constant>(LHS) || (isa<Argument>(LHS) && !isa<Constant>(RHS)))
2099       std::swap(LHS, RHS);
2100     assert((isa<Argument>(LHS) || isa<Instruction>(LHS)) && "Unexpected value!");
2101
2102     // If there is no obvious reason to prefer the left-hand side over the right-
2103     // hand side, ensure the longest lived term is on the right-hand side, so the
2104     // shortest lived term will be replaced by the longest lived.  This tends to
2105     // expose more simplifications.
2106     uint32_t LVN = VN.lookup_or_add(LHS);
2107     if ((isa<Argument>(LHS) && isa<Argument>(RHS)) ||
2108         (isa<Instruction>(LHS) && isa<Instruction>(RHS))) {
2109       // Move the 'oldest' value to the right-hand side, using the value number as
2110       // a proxy for age.
2111       uint32_t RVN = VN.lookup_or_add(RHS);
2112       if (LVN < RVN) {
2113         std::swap(LHS, RHS);
2114         LVN = RVN;
2115       }
2116     }
2117
2118     // If value numbering later sees that an instruction in the scope is equal
2119     // to 'LHS' then ensure it will be turned into 'RHS'.  In order to preserve
2120     // the invariant that instructions only occur in the leader table for their
2121     // own value number (this is used by removeFromLeaderTable), do not do this
2122     // if RHS is an instruction (if an instruction in the scope is morphed into
2123     // LHS then it will be turned into RHS by the next GVN iteration anyway, so
2124     // using the leader table is about compiling faster, not optimizing better).
2125     // The leader table only tracks basic blocks, not edges. Only add to if we
2126     // have the simple case where the edge dominates the end.
2127     if (RootDominatesEnd && !isa<Instruction>(RHS))
2128       addToLeaderTable(LVN, RHS, Root.getEnd());
2129
2130     // Replace all occurrences of 'LHS' with 'RHS' everywhere in the scope.  As
2131     // LHS always has at least one use that is not dominated by Root, this will
2132     // never do anything if LHS has only one use.
2133     if (!LHS->hasOneUse()) {
2134       unsigned NumReplacements = replaceAllDominatedUsesWith(LHS, RHS, Root);
2135       Changed |= NumReplacements > 0;
2136       NumGVNEqProp += NumReplacements;
2137     }
2138
2139     // Now try to deduce additional equalities from this one.  For example, if the
2140     // known equality was "(A != B)" == "false" then it follows that A and B are
2141     // equal in the scope.  Only boolean equalities with an explicit true or false
2142     // RHS are currently supported.
2143     if (!RHS->getType()->isIntegerTy(1))
2144       // Not a boolean equality - bail out.
2145       continue;
2146     ConstantInt *CI = dyn_cast<ConstantInt>(RHS);
2147     if (!CI)
2148       // RHS neither 'true' nor 'false' - bail out.
2149       continue;
2150     // Whether RHS equals 'true'.  Otherwise it equals 'false'.
2151     bool isKnownTrue = CI->isAllOnesValue();
2152     bool isKnownFalse = !isKnownTrue;
2153
2154     // If "A && B" is known true then both A and B are known true.  If "A || B"
2155     // is known false then both A and B are known false.
2156     Value *A, *B;
2157     if ((isKnownTrue && match(LHS, m_And(m_Value(A), m_Value(B)))) ||
2158         (isKnownFalse && match(LHS, m_Or(m_Value(A), m_Value(B))))) {
2159       Worklist.push_back(std::make_pair(A, RHS));
2160       Worklist.push_back(std::make_pair(B, RHS));
2161       continue;
2162     }
2163
2164     // If we are propagating an equality like "(A == B)" == "true" then also
2165     // propagate the equality A == B.  When propagating a comparison such as
2166     // "(A >= B)" == "true", replace all instances of "A < B" with "false".
2167     if (ICmpInst *Cmp = dyn_cast<ICmpInst>(LHS)) {
2168       Value *Op0 = Cmp->getOperand(0), *Op1 = Cmp->getOperand(1);
2169
2170       // If "A == B" is known true, or "A != B" is known false, then replace
2171       // A with B everywhere in the scope.
2172       if ((isKnownTrue && Cmp->getPredicate() == CmpInst::ICMP_EQ) ||
2173           (isKnownFalse && Cmp->getPredicate() == CmpInst::ICMP_NE))
2174         Worklist.push_back(std::make_pair(Op0, Op1));
2175
2176       // If "A >= B" is known true, replace "A < B" with false everywhere.
2177       CmpInst::Predicate NotPred = Cmp->getInversePredicate();
2178       Constant *NotVal = ConstantInt::get(Cmp->getType(), isKnownFalse);
2179       // Since we don't have the instruction "A < B" immediately to hand, work out
2180       // the value number that it would have and use that to find an appropriate
2181       // instruction (if any).
2182       uint32_t NextNum = VN.getNextUnusedValueNumber();
2183       uint32_t Num = VN.lookup_or_add_cmp(Cmp->getOpcode(), NotPred, Op0, Op1);
2184       // If the number we were assigned was brand new then there is no point in
2185       // looking for an instruction realizing it: there cannot be one!
2186       if (Num < NextNum) {
2187         Value *NotCmp = findLeader(Root.getEnd(), Num);
2188         if (NotCmp && isa<Instruction>(NotCmp)) {
2189           unsigned NumReplacements =
2190             replaceAllDominatedUsesWith(NotCmp, NotVal, Root);
2191           Changed |= NumReplacements > 0;
2192           NumGVNEqProp += NumReplacements;
2193         }
2194       }
2195       // Ensure that any instruction in scope that gets the "A < B" value number
2196       // is replaced with false.
2197       // The leader table only tracks basic blocks, not edges. Only add to if we
2198       // have the simple case where the edge dominates the end.
2199       if (RootDominatesEnd)
2200         addToLeaderTable(Num, NotVal, Root.getEnd());
2201
2202       continue;
2203     }
2204   }
2205
2206   return Changed;
2207 }
2208
2209 /// processInstruction - When calculating availability, handle an instruction
2210 /// by inserting it into the appropriate sets
2211 bool GVN::processInstruction(Instruction *I) {
2212   // Ignore dbg info intrinsics.
2213   if (isa<DbgInfoIntrinsic>(I))
2214     return false;
2215
2216   // If the instruction can be easily simplified then do so now in preference
2217   // to value numbering it.  Value numbering often exposes redundancies, for
2218   // example if it determines that %y is equal to %x then the instruction
2219   // "%z = and i32 %x, %y" becomes "%z = and i32 %x, %x" which we now simplify.
2220   if (Value *V = SimplifyInstruction(I, DL, TLI, DT)) {
2221     I->replaceAllUsesWith(V);
2222     if (MD && V->getType()->getScalarType()->isPointerTy())
2223       MD->invalidateCachedPointerInfo(V);
2224     markInstructionForDeletion(I);
2225     ++NumGVNSimpl;
2226     return true;
2227   }
2228
2229   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
2230     if (processLoad(LI))
2231       return true;
2232
2233     unsigned Num = VN.lookup_or_add(LI);
2234     addToLeaderTable(Num, LI, LI->getParent());
2235     return false;
2236   }
2237
2238   // For conditional branches, we can perform simple conditional propagation on
2239   // the condition value itself.
2240   if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
2241     if (!BI->isConditional())
2242       return false;
2243
2244     if (isa<Constant>(BI->getCondition()))
2245       return processFoldableCondBr(BI);
2246
2247     Value *BranchCond = BI->getCondition();
2248     BasicBlock *TrueSucc = BI->getSuccessor(0);
2249     BasicBlock *FalseSucc = BI->getSuccessor(1);
2250     // Avoid multiple edges early.
2251     if (TrueSucc == FalseSucc)
2252       return false;
2253
2254     BasicBlock *Parent = BI->getParent();
2255     bool Changed = false;
2256
2257     Value *TrueVal = ConstantInt::getTrue(TrueSucc->getContext());
2258     BasicBlockEdge TrueE(Parent, TrueSucc);
2259     Changed |= propagateEquality(BranchCond, TrueVal, TrueE);
2260
2261     Value *FalseVal = ConstantInt::getFalse(FalseSucc->getContext());
2262     BasicBlockEdge FalseE(Parent, FalseSucc);
2263     Changed |= propagateEquality(BranchCond, FalseVal, FalseE);
2264
2265     return Changed;
2266   }
2267
2268   // For switches, propagate the case values into the case destinations.
2269   if (SwitchInst *SI = dyn_cast<SwitchInst>(I)) {
2270     Value *SwitchCond = SI->getCondition();
2271     BasicBlock *Parent = SI->getParent();
2272     bool Changed = false;
2273
2274     // Remember how many outgoing edges there are to every successor.
2275     SmallDenseMap<BasicBlock *, unsigned, 16> SwitchEdges;
2276     for (unsigned i = 0, n = SI->getNumSuccessors(); i != n; ++i)
2277       ++SwitchEdges[SI->getSuccessor(i)];
2278
2279     for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
2280          i != e; ++i) {
2281       BasicBlock *Dst = i.getCaseSuccessor();
2282       // If there is only a single edge, propagate the case value into it.
2283       if (SwitchEdges.lookup(Dst) == 1) {
2284         BasicBlockEdge E(Parent, Dst);
2285         Changed |= propagateEquality(SwitchCond, i.getCaseValue(), E);
2286       }
2287     }
2288     return Changed;
2289   }
2290
2291   // Instructions with void type don't return a value, so there's
2292   // no point in trying to find redundancies in them.
2293   if (I->getType()->isVoidTy()) return false;
2294
2295   uint32_t NextNum = VN.getNextUnusedValueNumber();
2296   unsigned Num = VN.lookup_or_add(I);
2297
2298   // Allocations are always uniquely numbered, so we can save time and memory
2299   // by fast failing them.
2300   if (isa<AllocaInst>(I) || isa<TerminatorInst>(I) || isa<PHINode>(I)) {
2301     addToLeaderTable(Num, I, I->getParent());
2302     return false;
2303   }
2304
2305   // If the number we were assigned was a brand new VN, then we don't
2306   // need to do a lookup to see if the number already exists
2307   // somewhere in the domtree: it can't!
2308   if (Num >= NextNum) {
2309     addToLeaderTable(Num, I, I->getParent());
2310     return false;
2311   }
2312
2313   // Perform fast-path value-number based elimination of values inherited from
2314   // dominators.
2315   Value *repl = findLeader(I->getParent(), Num);
2316   if (!repl) {
2317     // Failure, just remember this instance for future use.
2318     addToLeaderTable(Num, I, I->getParent());
2319     return false;
2320   }
2321
2322   // Remove it!
2323   patchAndReplaceAllUsesWith(I, repl);
2324   if (MD && repl->getType()->getScalarType()->isPointerTy())
2325     MD->invalidateCachedPointerInfo(repl);
2326   markInstructionForDeletion(I);
2327   return true;
2328 }
2329
2330 /// runOnFunction - This is the main transformation entry point for a function.
2331 bool GVN::runOnFunction(Function& F) {
2332   if (skipOptnoneFunction(F))
2333     return false;
2334
2335   if (!NoLoads)
2336     MD = &getAnalysis<MemoryDependenceAnalysis>();
2337   DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
2338   DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
2339   DL = DLP ? &DLP->getDataLayout() : nullptr;
2340   TLI = &getAnalysis<TargetLibraryInfo>();
2341   VN.setAliasAnalysis(&getAnalysis<AliasAnalysis>());
2342   VN.setMemDep(MD);
2343   VN.setDomTree(DT);
2344
2345   bool Changed = false;
2346   bool ShouldContinue = true;
2347
2348   // Merge unconditional branches, allowing PRE to catch more
2349   // optimization opportunities.
2350   for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ) {
2351     BasicBlock *BB = FI++;
2352
2353     bool removedBlock = MergeBlockIntoPredecessor(BB, this);
2354     if (removedBlock) ++NumGVNBlocks;
2355
2356     Changed |= removedBlock;
2357   }
2358
2359   unsigned Iteration = 0;
2360   while (ShouldContinue) {
2361     DEBUG(dbgs() << "GVN iteration: " << Iteration << "\n");
2362     ShouldContinue = iterateOnFunction(F);
2363     Changed |= ShouldContinue;
2364     ++Iteration;
2365   }
2366
2367   if (EnablePRE) {
2368     // Fabricate val-num for dead-code in order to suppress assertion in
2369     // performPRE().
2370     assignValNumForDeadCode();
2371     bool PREChanged = true;
2372     while (PREChanged) {
2373       PREChanged = performPRE(F);
2374       Changed |= PREChanged;
2375     }
2376   }
2377
2378   // FIXME: Should perform GVN again after PRE does something.  PRE can move
2379   // computations into blocks where they become fully redundant.  Note that
2380   // we can't do this until PRE's critical edge splitting updates memdep.
2381   // Actually, when this happens, we should just fully integrate PRE into GVN.
2382
2383   cleanupGlobalSets();
2384   // Do not cleanup DeadBlocks in cleanupGlobalSets() as it's called for each
2385   // iteration.
2386   DeadBlocks.clear();
2387
2388   return Changed;
2389 }
2390
2391
2392 bool GVN::processBlock(BasicBlock *BB) {
2393   // FIXME: Kill off InstrsToErase by doing erasing eagerly in a helper function
2394   // (and incrementing BI before processing an instruction).
2395   assert(InstrsToErase.empty() &&
2396          "We expect InstrsToErase to be empty across iterations");
2397   if (DeadBlocks.count(BB))
2398     return false;
2399
2400   bool ChangedFunction = false;
2401
2402   for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();
2403        BI != BE;) {
2404     ChangedFunction |= processInstruction(BI);
2405     if (InstrsToErase.empty()) {
2406       ++BI;
2407       continue;
2408     }
2409
2410     // If we need some instructions deleted, do it now.
2411     NumGVNInstr += InstrsToErase.size();
2412
2413     // Avoid iterator invalidation.
2414     bool AtStart = BI == BB->begin();
2415     if (!AtStart)
2416       --BI;
2417
2418     for (SmallVectorImpl<Instruction *>::iterator I = InstrsToErase.begin(),
2419          E = InstrsToErase.end(); I != E; ++I) {
2420       DEBUG(dbgs() << "GVN removed: " << **I << '\n');
2421       if (MD) MD->removeInstruction(*I);
2422       DEBUG(verifyRemoved(*I));
2423       (*I)->eraseFromParent();
2424     }
2425     InstrsToErase.clear();
2426
2427     if (AtStart)
2428       BI = BB->begin();
2429     else
2430       ++BI;
2431   }
2432
2433   return ChangedFunction;
2434 }
2435
2436 /// performPRE - Perform a purely local form of PRE that looks for diamond
2437 /// control flow patterns and attempts to perform simple PRE at the join point.
2438 bool GVN::performPRE(Function &F) {
2439   bool Changed = false;
2440   SmallVector<std::pair<Value*, BasicBlock*>, 8> predMap;
2441   for (BasicBlock *CurrentBlock : depth_first(&F.getEntryBlock())) {
2442     // Nothing to PRE in the entry block.
2443     if (CurrentBlock == &F.getEntryBlock()) continue;
2444
2445     // Don't perform PRE on a landing pad.
2446     if (CurrentBlock->isLandingPad()) continue;
2447
2448     for (BasicBlock::iterator BI = CurrentBlock->begin(),
2449          BE = CurrentBlock->end(); BI != BE; ) {
2450       Instruction *CurInst = BI++;
2451
2452       if (isa<AllocaInst>(CurInst) ||
2453           isa<TerminatorInst>(CurInst) || isa<PHINode>(CurInst) ||
2454           CurInst->getType()->isVoidTy() ||
2455           CurInst->mayReadFromMemory() || CurInst->mayHaveSideEffects() ||
2456           isa<DbgInfoIntrinsic>(CurInst))
2457         continue;
2458
2459       // Don't do PRE on compares. The PHI would prevent CodeGenPrepare from
2460       // sinking the compare again, and it would force the code generator to
2461       // move the i1 from processor flags or predicate registers into a general
2462       // purpose register.
2463       if (isa<CmpInst>(CurInst))
2464         continue;
2465
2466       // We don't currently value number ANY inline asm calls.
2467       if (CallInst *CallI = dyn_cast<CallInst>(CurInst))
2468         if (CallI->isInlineAsm())
2469           continue;
2470
2471       uint32_t ValNo = VN.lookup(CurInst);
2472
2473       // Look for the predecessors for PRE opportunities.  We're
2474       // only trying to solve the basic diamond case, where
2475       // a value is computed in the successor and one predecessor,
2476       // but not the other.  We also explicitly disallow cases
2477       // where the successor is its own predecessor, because they're
2478       // more complicated to get right.
2479       unsigned NumWith = 0;
2480       unsigned NumWithout = 0;
2481       BasicBlock *PREPred = nullptr;
2482       predMap.clear();
2483
2484       for (BasicBlock *P : predecessors(CurrentBlock)) {
2485         // We're not interested in PRE where the block is its
2486         // own predecessor, or in blocks with predecessors
2487         // that are not reachable.
2488         if (P == CurrentBlock) {
2489           NumWithout = 2;
2490           break;
2491         } else if (!DT->isReachableFromEntry(P))  {
2492           NumWithout = 2;
2493           break;
2494         }
2495
2496         Value* predV = findLeader(P, ValNo);
2497         if (!predV) {
2498           predMap.push_back(std::make_pair(static_cast<Value *>(nullptr), P));
2499           PREPred = P;
2500           ++NumWithout;
2501         } else if (predV == CurInst) {
2502           /* CurInst dominates this predecessor. */
2503           NumWithout = 2;
2504           break;
2505         } else {
2506           predMap.push_back(std::make_pair(predV, P));
2507           ++NumWith;
2508         }
2509       }
2510
2511       // Don't do PRE when it might increase code size, i.e. when
2512       // we would need to insert instructions in more than one pred.
2513       if (NumWithout != 1 || NumWith == 0)
2514         continue;
2515
2516       // Don't do PRE across indirect branch.
2517       if (isa<IndirectBrInst>(PREPred->getTerminator()))
2518         continue;
2519
2520       // We can't do PRE safely on a critical edge, so instead we schedule
2521       // the edge to be split and perform the PRE the next time we iterate
2522       // on the function.
2523       unsigned SuccNum = GetSuccessorNumber(PREPred, CurrentBlock);
2524       if (isCriticalEdge(PREPred->getTerminator(), SuccNum)) {
2525         toSplit.push_back(std::make_pair(PREPred->getTerminator(), SuccNum));
2526         continue;
2527       }
2528
2529       // Instantiate the expression in the predecessor that lacked it.
2530       // Because we are going top-down through the block, all value numbers
2531       // will be available in the predecessor by the time we need them.  Any
2532       // that weren't originally present will have been instantiated earlier
2533       // in this loop.
2534       Instruction *PREInstr = CurInst->clone();
2535       bool success = true;
2536       for (unsigned i = 0, e = CurInst->getNumOperands(); i != e; ++i) {
2537         Value *Op = PREInstr->getOperand(i);
2538         if (isa<Argument>(Op) || isa<Constant>(Op) || isa<GlobalValue>(Op))
2539           continue;
2540
2541         if (Value *V = findLeader(PREPred, VN.lookup(Op))) {
2542           PREInstr->setOperand(i, V);
2543         } else {
2544           success = false;
2545           break;
2546         }
2547       }
2548
2549       // Fail out if we encounter an operand that is not available in
2550       // the PRE predecessor.  This is typically because of loads which
2551       // are not value numbered precisely.
2552       if (!success) {
2553         DEBUG(verifyRemoved(PREInstr));
2554         delete PREInstr;
2555         continue;
2556       }
2557
2558       PREInstr->insertBefore(PREPred->getTerminator());
2559       PREInstr->setName(CurInst->getName() + ".pre");
2560       PREInstr->setDebugLoc(CurInst->getDebugLoc());
2561       VN.add(PREInstr, ValNo);
2562       ++NumGVNPRE;
2563
2564       // Update the availability map to include the new instruction.
2565       addToLeaderTable(ValNo, PREInstr, PREPred);
2566
2567       // Create a PHI to make the value available in this block.
2568       PHINode* Phi = PHINode::Create(CurInst->getType(), predMap.size(),
2569                                      CurInst->getName() + ".pre-phi",
2570                                      CurrentBlock->begin());
2571       for (unsigned i = 0, e = predMap.size(); i != e; ++i) {
2572         if (Value *V = predMap[i].first)
2573           Phi->addIncoming(V, predMap[i].second);
2574         else
2575           Phi->addIncoming(PREInstr, PREPred);
2576       }
2577
2578       VN.add(Phi, ValNo);
2579       addToLeaderTable(ValNo, Phi, CurrentBlock);
2580       Phi->setDebugLoc(CurInst->getDebugLoc());
2581       CurInst->replaceAllUsesWith(Phi);
2582       if (Phi->getType()->getScalarType()->isPointerTy()) {
2583         // Because we have added a PHI-use of the pointer value, it has now
2584         // "escaped" from alias analysis' perspective.  We need to inform
2585         // AA of this.
2586         for (unsigned ii = 0, ee = Phi->getNumIncomingValues(); ii != ee;
2587              ++ii) {
2588           unsigned jj = PHINode::getOperandNumForIncomingValue(ii);
2589           VN.getAliasAnalysis()->addEscapingUse(Phi->getOperandUse(jj));
2590         }
2591
2592         if (MD)
2593           MD->invalidateCachedPointerInfo(Phi);
2594       }
2595       VN.erase(CurInst);
2596       removeFromLeaderTable(ValNo, CurInst, CurrentBlock);
2597
2598       DEBUG(dbgs() << "GVN PRE removed: " << *CurInst << '\n');
2599       if (MD) MD->removeInstruction(CurInst);
2600       DEBUG(verifyRemoved(CurInst));
2601       CurInst->eraseFromParent();
2602       Changed = true;
2603     }
2604   }
2605
2606   if (splitCriticalEdges())
2607     Changed = true;
2608
2609   return Changed;
2610 }
2611
2612 /// Split the critical edge connecting the given two blocks, and return
2613 /// the block inserted to the critical edge.
2614 BasicBlock *GVN::splitCriticalEdges(BasicBlock *Pred, BasicBlock *Succ) {
2615   BasicBlock *BB = SplitCriticalEdge(Pred, Succ, this);
2616   if (MD)
2617     MD->invalidateCachedPredecessors();
2618   return BB;
2619 }
2620
2621 /// splitCriticalEdges - Split critical edges found during the previous
2622 /// iteration that may enable further optimization.
2623 bool GVN::splitCriticalEdges() {
2624   if (toSplit.empty())
2625     return false;
2626   do {
2627     std::pair<TerminatorInst*, unsigned> Edge = toSplit.pop_back_val();
2628     SplitCriticalEdge(Edge.first, Edge.second, this);
2629   } while (!toSplit.empty());
2630   if (MD) MD->invalidateCachedPredecessors();
2631   return true;
2632 }
2633
2634 /// iterateOnFunction - Executes one iteration of GVN
2635 bool GVN::iterateOnFunction(Function &F) {
2636   cleanupGlobalSets();
2637
2638   // Top-down walk of the dominator tree
2639   bool Changed = false;
2640 #if 0
2641   // Needed for value numbering with phi construction to work.
2642   ReversePostOrderTraversal<Function*> RPOT(&F);
2643   for (ReversePostOrderTraversal<Function*>::rpo_iterator RI = RPOT.begin(),
2644        RE = RPOT.end(); RI != RE; ++RI)
2645     Changed |= processBlock(*RI);
2646 #else
2647   // Save the blocks this function have before transformation begins. GVN may
2648   // split critical edge, and hence may invalidate the RPO/DT iterator.
2649   //
2650   std::vector<BasicBlock *> BBVect;
2651   BBVect.reserve(256);
2652   for (DomTreeNode *x : depth_first(DT->getRootNode()))
2653     BBVect.push_back(x->getBlock());
2654
2655   for (std::vector<BasicBlock *>::iterator I = BBVect.begin(), E = BBVect.end();
2656        I != E; I++)
2657     Changed |= processBlock(*I);
2658 #endif
2659
2660   return Changed;
2661 }
2662
2663 void GVN::cleanupGlobalSets() {
2664   VN.clear();
2665   LeaderTable.clear();
2666   TableAllocator.Reset();
2667 }
2668
2669 /// verifyRemoved - Verify that the specified instruction does not occur in our
2670 /// internal data structures.
2671 void GVN::verifyRemoved(const Instruction *Inst) const {
2672   VN.verifyRemoved(Inst);
2673
2674   // Walk through the value number scope to make sure the instruction isn't
2675   // ferreted away in it.
2676   for (DenseMap<uint32_t, LeaderTableEntry>::const_iterator
2677        I = LeaderTable.begin(), E = LeaderTable.end(); I != E; ++I) {
2678     const LeaderTableEntry *Node = &I->second;
2679     assert(Node->Val != Inst && "Inst still in value numbering scope!");
2680
2681     while (Node->Next) {
2682       Node = Node->Next;
2683       assert(Node->Val != Inst && "Inst still in value numbering scope!");
2684     }
2685   }
2686 }
2687
2688 // BB is declared dead, which implied other blocks become dead as well. This
2689 // function is to add all these blocks to "DeadBlocks". For the dead blocks'
2690 // live successors, update their phi nodes by replacing the operands
2691 // corresponding to dead blocks with UndefVal.
2692 //
2693 void GVN::addDeadBlock(BasicBlock *BB) {
2694   SmallVector<BasicBlock *, 4> NewDead;
2695   SmallSetVector<BasicBlock *, 4> DF;
2696
2697   NewDead.push_back(BB);
2698   while (!NewDead.empty()) {
2699     BasicBlock *D = NewDead.pop_back_val();
2700     if (DeadBlocks.count(D))
2701       continue;
2702
2703     // All blocks dominated by D are dead.
2704     SmallVector<BasicBlock *, 8> Dom;
2705     DT->getDescendants(D, Dom);
2706     DeadBlocks.insert(Dom.begin(), Dom.end());
2707
2708     // Figure out the dominance-frontier(D).
2709     for (SmallVectorImpl<BasicBlock *>::iterator I = Dom.begin(),
2710            E = Dom.end(); I != E; I++) {
2711       BasicBlock *B = *I;
2712       for (BasicBlock *S : successors(B)) {
2713         if (DeadBlocks.count(S))
2714           continue;
2715
2716         bool AllPredDead = true;
2717         for (BasicBlock *Pred : predecessors(S))
2718           if (!DeadBlocks.count(Pred)) {
2719             AllPredDead = false;
2720             break;
2721           }
2722
2723         if (!AllPredDead) {
2724           // S could be proved dead later on. That is why we don't update phi
2725           // operands at this moment.
2726           DF.insert(S);
2727         } else {
2728           // While S is not dominated by D, it is dead by now. This could take
2729           // place if S already have a dead predecessor before D is declared
2730           // dead.
2731           NewDead.push_back(S);
2732         }
2733       }
2734     }
2735   }
2736
2737   // For the dead blocks' live successors, update their phi nodes by replacing
2738   // the operands corresponding to dead blocks with UndefVal.
2739   for(SmallSetVector<BasicBlock *, 4>::iterator I = DF.begin(), E = DF.end();
2740         I != E; I++) {
2741     BasicBlock *B = *I;
2742     if (DeadBlocks.count(B))
2743       continue;
2744
2745     SmallVector<BasicBlock *, 4> Preds(pred_begin(B), pred_end(B));
2746     for (SmallVectorImpl<BasicBlock *>::iterator PI = Preds.begin(),
2747            PE = Preds.end(); PI != PE; PI++) {
2748       BasicBlock *P = *PI;
2749
2750       if (!DeadBlocks.count(P))
2751         continue;
2752
2753       if (isCriticalEdge(P->getTerminator(), GetSuccessorNumber(P, B))) {
2754         if (BasicBlock *S = splitCriticalEdges(P, B))
2755           DeadBlocks.insert(P = S);
2756       }
2757
2758       for (BasicBlock::iterator II = B->begin(); isa<PHINode>(II); ++II) {
2759         PHINode &Phi = cast<PHINode>(*II);
2760         Phi.setIncomingValue(Phi.getBasicBlockIndex(P),
2761                              UndefValue::get(Phi.getType()));
2762       }
2763     }
2764   }
2765 }
2766
2767 // If the given branch is recognized as a foldable branch (i.e. conditional
2768 // branch with constant condition), it will perform following analyses and
2769 // transformation.
2770 //  1) If the dead out-coming edge is a critical-edge, split it. Let
2771 //     R be the target of the dead out-coming edge.
2772 //  1) Identify the set of dead blocks implied by the branch's dead outcoming
2773 //     edge. The result of this step will be {X| X is dominated by R}
2774 //  2) Identify those blocks which haves at least one dead prodecessor. The
2775 //     result of this step will be dominance-frontier(R).
2776 //  3) Update the PHIs in DF(R) by replacing the operands corresponding to
2777 //     dead blocks with "UndefVal" in an hope these PHIs will optimized away.
2778 //
2779 // Return true iff *NEW* dead code are found.
2780 bool GVN::processFoldableCondBr(BranchInst *BI) {
2781   if (!BI || BI->isUnconditional())
2782     return false;
2783
2784   ConstantInt *Cond = dyn_cast<ConstantInt>(BI->getCondition());
2785   if (!Cond)
2786     return false;
2787
2788   BasicBlock *DeadRoot = Cond->getZExtValue() ?
2789                          BI->getSuccessor(1) : BI->getSuccessor(0);
2790   if (DeadBlocks.count(DeadRoot))
2791     return false;
2792
2793   if (!DeadRoot->getSinglePredecessor())
2794     DeadRoot = splitCriticalEdges(BI->getParent(), DeadRoot);
2795
2796   addDeadBlock(DeadRoot);
2797   return true;
2798 }
2799
2800 // performPRE() will trigger assert if it come across an instruciton without
2801 // associated val-num. As it normally has far more live instructions than dead
2802 // instructions, it makes more sense just to "fabricate" a val-number for the
2803 // dead code than checking if instruction involved is dead or not.
2804 void GVN::assignValNumForDeadCode() {
2805   for (SetVector<BasicBlock *>::iterator I = DeadBlocks.begin(),
2806         E = DeadBlocks.end(); I != E; I++) {
2807     BasicBlock *BB = *I;
2808     for (BasicBlock::iterator II = BB->begin(), EE = BB->end();
2809           II != EE; II++) {
2810       Instruction *Inst = &*II;
2811       unsigned ValNum = VN.lookup_or_add(Inst);
2812       addToLeaderTable(ValNum, Inst, BB);
2813     }
2814   }
2815 }