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