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