blob: f350b9bbde5557161628121a64e3d60e0d72bb18 [file] [log] [blame]
Chris Lattnerd2a653a2008-12-05 07:49:08 +00001//===- GVN.cpp - Eliminate redundant values and loads ---------------------===//
Owen Andersonab6ec2e2007-07-24 17:55:58 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Owen Andersonab6ec2e2007-07-24 17:55:58 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This pass performs global value numbering to eliminate fully redundant
11// instructions. It also performs simple dead load elimination.
12//
John Criswell073e4d12009-03-10 15:04:53 +000013// Note that this pass does the value numbering itself; it does not use the
Matthijs Kooijman5afc2742008-06-05 07:55:49 +000014// ValueNumbering analysis passes.
15//
Owen Andersonab6ec2e2007-07-24 17:55:58 +000016//===----------------------------------------------------------------------===//
17
18#define DEBUG_TYPE "gvn"
Owen Andersonab6ec2e2007-07-24 17:55:58 +000019#include "llvm/Transforms/Scalar.h"
Chandler Carruthaafe0912012-06-29 12:38:19 +000020#include "llvm/ADT/DenseMap.h"
21#include "llvm/ADT/DepthFirstIterator.h"
22#include "llvm/ADT/Hashing.h"
23#include "llvm/ADT/SmallPtrSet.h"
24#include "llvm/ADT/Statistic.h"
Owen Anderson09b83ba2007-10-18 19:39:33 +000025#include "llvm/Analysis/AliasAnalysis.h"
Chris Lattner778cb922009-12-06 05:29:56 +000026#include "llvm/Analysis/ConstantFolding.h"
27#include "llvm/Analysis/Dominators.h"
Duncan Sands246b71c2010-11-12 21:10:24 +000028#include "llvm/Analysis/InstructionSimplify.h"
Dan Gohman826bdf82010-05-28 16:19:17 +000029#include "llvm/Analysis/Loads.h"
Victor Hernandezf390e042009-10-27 20:05:49 +000030#include "llvm/Analysis/MemoryBuiltins.h"
Owen Andersonab6ec2e2007-07-24 17:55:58 +000031#include "llvm/Analysis/MemoryDependenceAnalysis.h"
Chris Lattner972e6d82009-12-09 01:59:31 +000032#include "llvm/Analysis/PHITransAddr.h"
Chris Lattnere28618d2010-11-30 22:25:26 +000033#include "llvm/Analysis/ValueTracking.h"
Chris Lattnerbf0aa922011-01-02 22:09:33 +000034#include "llvm/Assembly/Writer.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000035#include "llvm/IR/DataLayout.h"
36#include "llvm/IR/GlobalVariable.h"
37#include "llvm/IR/IRBuilder.h"
38#include "llvm/IR/IntrinsicInst.h"
39#include "llvm/IR/LLVMContext.h"
40#include "llvm/IR/Metadata.h"
Chandler Carruthaafe0912012-06-29 12:38:19 +000041#include "llvm/Support/Allocator.h"
42#include "llvm/Support/CommandLine.h"
43#include "llvm/Support/Debug.h"
44#include "llvm/Support/PatternMatch.h"
Chad Rosierc24b86f2011-12-01 03:08:23 +000045#include "llvm/Target/TargetLibraryInfo.h"
Chris Lattnere28618d2010-11-30 22:25:26 +000046#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Chris Lattnere28618d2010-11-30 22:25:26 +000047#include "llvm/Transforms/Utils/SSAUpdater.h"
Owen Andersonab6ec2e2007-07-24 17:55:58 +000048using namespace llvm;
Duncan Sandsf4f47cc2011-10-05 14:28:49 +000049using namespace PatternMatch;
Owen Andersonab6ec2e2007-07-24 17:55:58 +000050
Bill Wendling3c793442008-12-22 22:14:07 +000051STATISTIC(NumGVNInstr, "Number of instructions deleted");
52STATISTIC(NumGVNLoad, "Number of loads deleted");
53STATISTIC(NumGVNPRE, "Number of instructions PRE'd");
Owen Anderson53d546e2008-07-15 16:28:06 +000054STATISTIC(NumGVNBlocks, "Number of blocks merged");
Duncan Sandsf4f47cc2011-10-05 14:28:49 +000055STATISTIC(NumGVNSimpl, "Number of instructions simplified");
56STATISTIC(NumGVNEqProp, "Number of equalities propagated");
Bill Wendling3c793442008-12-22 22:14:07 +000057STATISTIC(NumPRELoad, "Number of loads PRE'd");
Chris Lattner168be762008-03-22 04:13:49 +000058
Evan Cheng9598f932008-06-20 01:01:07 +000059static cl::opt<bool> EnablePRE("enable-pre",
Owen Andersonaddbe3e2008-07-17 19:41:00 +000060 cl::init(true), cl::Hidden);
Dan Gohmana8f8a852009-06-15 18:30:15 +000061static cl::opt<bool> EnableLoadPRE("enable-load-pre", cl::init(true));
Owen Andersone780d662008-06-19 19:57:25 +000062
Mon P Wang6120cfb2012-04-27 18:09:28 +000063// Maximum allowed recursion depth.
David Blaikie84e4b392012-04-27 19:30:32 +000064static cl::opt<uint32_t>
Mon P Wang6120cfb2012-04-27 18:09:28 +000065MaxRecurseDepth("max-recurse-depth", cl::Hidden, cl::init(1000), cl::ZeroOrMore,
66 cl::desc("Max recurse depth (default = 1000)"));
67
Owen Andersonab6ec2e2007-07-24 17:55:58 +000068//===----------------------------------------------------------------------===//
69// ValueTable Class
70//===----------------------------------------------------------------------===//
71
72/// This class holds the mapping between values and value numbers. It is used
73/// as an efficient mechanism to determine the expression-wise equivalence of
74/// two values.
75namespace {
Chris Lattner2dd09db2009-09-02 06:11:42 +000076 struct Expression {
Owen Anderson3a33d0c2011-01-03 19:00:11 +000077 uint32_t opcode;
Chris Lattner229907c2011-07-18 04:54:35 +000078 Type *type;
Owen Andersonab6ec2e2007-07-24 17:55:58 +000079 SmallVector<uint32_t, 4> varargs;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +000080
Chris Lattner45e393f2011-04-28 18:08:21 +000081 Expression(uint32_t o = ~2U) : opcode(o) { }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +000082
Owen Andersonab6ec2e2007-07-24 17:55:58 +000083 bool operator==(const Expression &other) const {
84 if (opcode != other.opcode)
85 return false;
Chris Lattner45e393f2011-04-28 18:08:21 +000086 if (opcode == ~0U || opcode == ~1U)
Owen Andersonab6ec2e2007-07-24 17:55:58 +000087 return true;
Chris Lattner45e393f2011-04-28 18:08:21 +000088 if (type != other.type)
Owen Andersonab6ec2e2007-07-24 17:55:58 +000089 return false;
Chris Lattner45e393f2011-04-28 18:08:21 +000090 if (varargs != other.varargs)
Benjamin Kramer43493c02010-12-21 21:30:19 +000091 return false;
92 return true;
Owen Andersonab6ec2e2007-07-24 17:55:58 +000093 }
Chandler Carruthe134d1a2012-03-05 11:29:54 +000094
95 friend hash_code hash_value(const Expression &Value) {
Chandler Carruthe134d1a2012-03-05 11:29:54 +000096 return hash_combine(Value.opcode, Value.type,
97 hash_combine_range(Value.varargs.begin(),
98 Value.varargs.end()));
99 }
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000100 };
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000101
Chris Lattner2dd09db2009-09-02 06:11:42 +0000102 class ValueTable {
Chris Lattner45e393f2011-04-28 18:08:21 +0000103 DenseMap<Value*, uint32_t> valueNumbering;
104 DenseMap<Expression, uint32_t> expressionNumbering;
105 AliasAnalysis *AA;
106 MemoryDependenceAnalysis *MD;
107 DominatorTree *DT;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000108
Chris Lattner45e393f2011-04-28 18:08:21 +0000109 uint32_t nextValueNumber;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000110
Chris Lattner45e393f2011-04-28 18:08:21 +0000111 Expression create_expression(Instruction* I);
Duncan Sands27f45952012-02-27 08:14:30 +0000112 Expression create_cmp_expression(unsigned Opcode,
113 CmpInst::Predicate Predicate,
114 Value *LHS, Value *RHS);
Lang Hames29cd98f2011-07-08 01:50:54 +0000115 Expression create_extractvalue_expression(ExtractValueInst* EI);
Chris Lattner45e393f2011-04-28 18:08:21 +0000116 uint32_t lookup_or_add_call(CallInst* C);
117 public:
118 ValueTable() : nextValueNumber(1) { }
119 uint32_t lookup_or_add(Value *V);
120 uint32_t lookup(Value *V) const;
Duncan Sands27f45952012-02-27 08:14:30 +0000121 uint32_t lookup_or_add_cmp(unsigned Opcode, CmpInst::Predicate Pred,
122 Value *LHS, Value *RHS);
Chris Lattner45e393f2011-04-28 18:08:21 +0000123 void add(Value *V, uint32_t num);
124 void clear();
125 void erase(Value *v);
126 void setAliasAnalysis(AliasAnalysis* A) { AA = A; }
127 AliasAnalysis *getAliasAnalysis() const { return AA; }
128 void setMemDep(MemoryDependenceAnalysis* M) { MD = M; }
129 void setDomTree(DominatorTree* D) { DT = D; }
130 uint32_t getNextUnusedValueNumber() { return nextValueNumber; }
131 void verifyRemoved(const Value *) const;
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000132 };
133}
134
135namespace llvm {
Chris Lattner0625bd62007-09-17 18:34:04 +0000136template <> struct DenseMapInfo<Expression> {
Owen Anderson9699a6e2007-08-02 18:16:06 +0000137 static inline Expression getEmptyKey() {
Owen Anderson3a33d0c2011-01-03 19:00:11 +0000138 return ~0U;
Owen Anderson9699a6e2007-08-02 18:16:06 +0000139 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000140
Owen Anderson9699a6e2007-08-02 18:16:06 +0000141 static inline Expression getTombstoneKey() {
Owen Anderson3a33d0c2011-01-03 19:00:11 +0000142 return ~1U;
Owen Anderson9699a6e2007-08-02 18:16:06 +0000143 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000144
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000145 static unsigned getHashValue(const Expression e) {
Chandler Carruthe134d1a2012-03-05 11:29:54 +0000146 using llvm::hash_value;
147 return static_cast<unsigned>(hash_value(e));
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000148 }
Chris Lattner0625bd62007-09-17 18:34:04 +0000149 static bool isEqual(const Expression &LHS, const Expression &RHS) {
150 return LHS == RHS;
151 }
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000152};
Chris Lattner45d040b2009-12-15 07:26:43 +0000153
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000154}
155
156//===----------------------------------------------------------------------===//
157// ValueTable Internal Functions
158//===----------------------------------------------------------------------===//
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000159
Owen Anderson3a33d0c2011-01-03 19:00:11 +0000160Expression ValueTable::create_expression(Instruction *I) {
161 Expression e;
162 e.type = I->getType();
163 e.opcode = I->getOpcode();
164 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
165 OI != OE; ++OI)
166 e.varargs.push_back(lookup_or_add(*OI));
Duncan Sands926d1012012-02-24 15:16:31 +0000167 if (I->isCommutative()) {
168 // Ensure that commutative instructions that only differ by a permutation
169 // of their operands get the same value number by sorting the operand value
170 // numbers. Since all commutative instructions have two operands it is more
171 // efficient to sort by hand rather than using, say, std::sort.
172 assert(I->getNumOperands() == 2 && "Unsupported commutative instruction!");
173 if (e.varargs[0] > e.varargs[1])
174 std::swap(e.varargs[0], e.varargs[1]);
175 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000176
Lang Hames29cd98f2011-07-08 01:50:54 +0000177 if (CmpInst *C = dyn_cast<CmpInst>(I)) {
Duncan Sands926d1012012-02-24 15:16:31 +0000178 // Sort the operand value numbers so x<y and y>x get the same value number.
179 CmpInst::Predicate Predicate = C->getPredicate();
180 if (e.varargs[0] > e.varargs[1]) {
181 std::swap(e.varargs[0], e.varargs[1]);
182 Predicate = CmpInst::getSwappedPredicate(Predicate);
183 }
184 e.opcode = (C->getOpcode() << 8) | Predicate;
Owen Anderson3a33d0c2011-01-03 19:00:11 +0000185 } else if (InsertValueInst *E = dyn_cast<InsertValueInst>(I)) {
186 for (InsertValueInst::idx_iterator II = E->idx_begin(), IE = E->idx_end();
187 II != IE; ++II)
188 e.varargs.push_back(*II);
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000189 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000190
Owen Anderson168ad692009-10-19 22:14:22 +0000191 return e;
192}
193
Duncan Sands27f45952012-02-27 08:14:30 +0000194Expression ValueTable::create_cmp_expression(unsigned Opcode,
195 CmpInst::Predicate Predicate,
196 Value *LHS, Value *RHS) {
197 assert((Opcode == Instruction::ICmp || Opcode == Instruction::FCmp) &&
198 "Not a comparison!");
199 Expression e;
200 e.type = CmpInst::makeCmpResultType(LHS->getType());
201 e.varargs.push_back(lookup_or_add(LHS));
202 e.varargs.push_back(lookup_or_add(RHS));
203
204 // Sort the operand value numbers so x<y and y>x get the same value number.
205 if (e.varargs[0] > e.varargs[1]) {
206 std::swap(e.varargs[0], e.varargs[1]);
207 Predicate = CmpInst::getSwappedPredicate(Predicate);
208 }
209 e.opcode = (Opcode << 8) | Predicate;
210 return e;
211}
212
Lang Hames29cd98f2011-07-08 01:50:54 +0000213Expression ValueTable::create_extractvalue_expression(ExtractValueInst *EI) {
214 assert(EI != 0 && "Not an ExtractValueInst?");
215 Expression e;
216 e.type = EI->getType();
217 e.opcode = 0;
218
219 IntrinsicInst *I = dyn_cast<IntrinsicInst>(EI->getAggregateOperand());
220 if (I != 0 && EI->getNumIndices() == 1 && *EI->idx_begin() == 0 ) {
221 // EI might be an extract from one of our recognised intrinsics. If it
222 // is we'll synthesize a semantically equivalent expression instead on
223 // an extract value expression.
224 switch (I->getIntrinsicID()) {
Lang Hames266dab72011-07-09 00:25:11 +0000225 case Intrinsic::sadd_with_overflow:
Lang Hames29cd98f2011-07-08 01:50:54 +0000226 case Intrinsic::uadd_with_overflow:
227 e.opcode = Instruction::Add;
228 break;
Lang Hames266dab72011-07-09 00:25:11 +0000229 case Intrinsic::ssub_with_overflow:
Lang Hames29cd98f2011-07-08 01:50:54 +0000230 case Intrinsic::usub_with_overflow:
231 e.opcode = Instruction::Sub;
232 break;
Lang Hames266dab72011-07-09 00:25:11 +0000233 case Intrinsic::smul_with_overflow:
Lang Hames29cd98f2011-07-08 01:50:54 +0000234 case Intrinsic::umul_with_overflow:
235 e.opcode = Instruction::Mul;
236 break;
237 default:
238 break;
239 }
240
241 if (e.opcode != 0) {
242 // Intrinsic recognized. Grab its args to finish building the expression.
243 assert(I->getNumArgOperands() == 2 &&
244 "Expect two args for recognised intrinsics.");
245 e.varargs.push_back(lookup_or_add(I->getArgOperand(0)));
246 e.varargs.push_back(lookup_or_add(I->getArgOperand(1)));
247 return e;
248 }
249 }
250
251 // Not a recognised intrinsic. Fall back to producing an extract value
252 // expression.
253 e.opcode = EI->getOpcode();
254 for (Instruction::op_iterator OI = EI->op_begin(), OE = EI->op_end();
255 OI != OE; ++OI)
256 e.varargs.push_back(lookup_or_add(*OI));
257
258 for (ExtractValueInst::idx_iterator II = EI->idx_begin(), IE = EI->idx_end();
259 II != IE; ++II)
260 e.varargs.push_back(*II);
261
262 return e;
263}
264
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000265//===----------------------------------------------------------------------===//
266// ValueTable External Functions
267//===----------------------------------------------------------------------===//
268
Owen Anderson6a903bc2008-06-18 21:41:49 +0000269/// add - Insert a value into the table with a specified value number.
Chris Lattner1eefa9c2009-09-21 02:42:51 +0000270void ValueTable::add(Value *V, uint32_t num) {
Owen Anderson6a903bc2008-06-18 21:41:49 +0000271 valueNumbering.insert(std::make_pair(V, num));
272}
273
Nick Lewycky12d825d2012-09-09 23:41:11 +0000274uint32_t ValueTable::lookup_or_add_call(CallInst *C) {
Owen Anderson168ad692009-10-19 22:14:22 +0000275 if (AA->doesNotAccessMemory(C)) {
276 Expression exp = create_expression(C);
Nick Lewycky12d825d2012-09-09 23:41:11 +0000277 uint32_t &e = expressionNumbering[exp];
Owen Anderson168ad692009-10-19 22:14:22 +0000278 if (!e) e = nextValueNumber++;
279 valueNumbering[C] = e;
280 return e;
281 } else if (AA->onlyReadsMemory(C)) {
282 Expression exp = create_expression(C);
Nick Lewycky12d825d2012-09-09 23:41:11 +0000283 uint32_t &e = expressionNumbering[exp];
Owen Anderson168ad692009-10-19 22:14:22 +0000284 if (!e) {
285 e = nextValueNumber++;
286 valueNumbering[C] = e;
287 return e;
288 }
Dan Gohman81132462009-11-14 02:27:51 +0000289 if (!MD) {
290 e = nextValueNumber++;
291 valueNumbering[C] = e;
292 return e;
293 }
Owen Anderson168ad692009-10-19 22:14:22 +0000294
295 MemDepResult local_dep = MD->getDependency(C);
296
297 if (!local_dep.isDef() && !local_dep.isNonLocal()) {
298 valueNumbering[C] = nextValueNumber;
299 return nextValueNumber++;
300 }
301
302 if (local_dep.isDef()) {
303 CallInst* local_cdep = cast<CallInst>(local_dep.getInst());
304
Gabor Greiff628ecd2010-06-30 09:17:53 +0000305 if (local_cdep->getNumArgOperands() != C->getNumArgOperands()) {
Owen Anderson168ad692009-10-19 22:14:22 +0000306 valueNumbering[C] = nextValueNumber;
307 return nextValueNumber++;
308 }
309
Gabor Greif2d958d42010-06-24 10:17:17 +0000310 for (unsigned i = 0, e = C->getNumArgOperands(); i < e; ++i) {
311 uint32_t c_vn = lookup_or_add(C->getArgOperand(i));
312 uint32_t cd_vn = lookup_or_add(local_cdep->getArgOperand(i));
Owen Anderson168ad692009-10-19 22:14:22 +0000313 if (c_vn != cd_vn) {
314 valueNumbering[C] = nextValueNumber;
315 return nextValueNumber++;
316 }
317 }
318
319 uint32_t v = lookup_or_add(local_cdep);
320 valueNumbering[C] = v;
321 return v;
322 }
323
324 // Non-local case.
325 const MemoryDependenceAnalysis::NonLocalDepInfo &deps =
326 MD->getNonLocalCallDependency(CallSite(C));
Eli Friedman7d58bc72011-06-15 00:47:34 +0000327 // FIXME: Move the checking logic to MemDep!
Owen Anderson168ad692009-10-19 22:14:22 +0000328 CallInst* cdep = 0;
329
330 // Check to see if we have a single dominating call instruction that is
331 // identical to C.
332 for (unsigned i = 0, e = deps.size(); i != e; ++i) {
Chris Lattner0c315472009-12-09 07:08:01 +0000333 const NonLocalDepEntry *I = &deps[i];
Chris Lattner0c315472009-12-09 07:08:01 +0000334 if (I->getResult().isNonLocal())
Owen Anderson168ad692009-10-19 22:14:22 +0000335 continue;
336
Eli Friedman7d58bc72011-06-15 00:47:34 +0000337 // We don't handle non-definitions. If we already have a call, reject
Owen Anderson168ad692009-10-19 22:14:22 +0000338 // instruction dependencies.
Eli Friedman7d58bc72011-06-15 00:47:34 +0000339 if (!I->getResult().isDef() || cdep != 0) {
Owen Anderson168ad692009-10-19 22:14:22 +0000340 cdep = 0;
341 break;
342 }
343
Chris Lattner0c315472009-12-09 07:08:01 +0000344 CallInst *NonLocalDepCall = dyn_cast<CallInst>(I->getResult().getInst());
Owen Anderson168ad692009-10-19 22:14:22 +0000345 // FIXME: All duplicated with non-local case.
Chris Lattner0c315472009-12-09 07:08:01 +0000346 if (NonLocalDepCall && DT->properlyDominates(I->getBB(), C->getParent())){
Owen Anderson168ad692009-10-19 22:14:22 +0000347 cdep = NonLocalDepCall;
348 continue;
349 }
350
351 cdep = 0;
352 break;
353 }
354
355 if (!cdep) {
356 valueNumbering[C] = nextValueNumber;
357 return nextValueNumber++;
358 }
359
Gabor Greiff628ecd2010-06-30 09:17:53 +0000360 if (cdep->getNumArgOperands() != C->getNumArgOperands()) {
Owen Anderson168ad692009-10-19 22:14:22 +0000361 valueNumbering[C] = nextValueNumber;
362 return nextValueNumber++;
363 }
Gabor Greif2d958d42010-06-24 10:17:17 +0000364 for (unsigned i = 0, e = C->getNumArgOperands(); i < e; ++i) {
365 uint32_t c_vn = lookup_or_add(C->getArgOperand(i));
366 uint32_t cd_vn = lookup_or_add(cdep->getArgOperand(i));
Owen Anderson168ad692009-10-19 22:14:22 +0000367 if (c_vn != cd_vn) {
368 valueNumbering[C] = nextValueNumber;
369 return nextValueNumber++;
370 }
371 }
372
373 uint32_t v = lookup_or_add(cdep);
374 valueNumbering[C] = v;
375 return v;
376
377 } else {
378 valueNumbering[C] = nextValueNumber;
379 return nextValueNumber++;
380 }
381}
382
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000383/// lookup_or_add - Returns the value number for the specified value, assigning
384/// it a new number if it did not have one before.
Chris Lattner1eefa9c2009-09-21 02:42:51 +0000385uint32_t ValueTable::lookup_or_add(Value *V) {
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000386 DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
387 if (VI != valueNumbering.end())
388 return VI->second;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000389
Owen Anderson168ad692009-10-19 22:14:22 +0000390 if (!isa<Instruction>(V)) {
Owen Anderson1059b5b2009-10-19 21:14:57 +0000391 valueNumbering[V] = nextValueNumber;
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000392 return nextValueNumber++;
393 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000394
Owen Anderson168ad692009-10-19 22:14:22 +0000395 Instruction* I = cast<Instruction>(V);
396 Expression exp;
397 switch (I->getOpcode()) {
398 case Instruction::Call:
399 return lookup_or_add_call(cast<CallInst>(I));
400 case Instruction::Add:
401 case Instruction::FAdd:
402 case Instruction::Sub:
403 case Instruction::FSub:
404 case Instruction::Mul:
405 case Instruction::FMul:
406 case Instruction::UDiv:
407 case Instruction::SDiv:
408 case Instruction::FDiv:
409 case Instruction::URem:
410 case Instruction::SRem:
411 case Instruction::FRem:
412 case Instruction::Shl:
413 case Instruction::LShr:
414 case Instruction::AShr:
415 case Instruction::And:
Nick Lewycky12d825d2012-09-09 23:41:11 +0000416 case Instruction::Or:
Owen Anderson168ad692009-10-19 22:14:22 +0000417 case Instruction::Xor:
Owen Anderson168ad692009-10-19 22:14:22 +0000418 case Instruction::ICmp:
419 case Instruction::FCmp:
Owen Anderson168ad692009-10-19 22:14:22 +0000420 case Instruction::Trunc:
421 case Instruction::ZExt:
422 case Instruction::SExt:
423 case Instruction::FPToUI:
424 case Instruction::FPToSI:
425 case Instruction::UIToFP:
426 case Instruction::SIToFP:
427 case Instruction::FPTrunc:
428 case Instruction::FPExt:
429 case Instruction::PtrToInt:
430 case Instruction::IntToPtr:
431 case Instruction::BitCast:
Owen Anderson168ad692009-10-19 22:14:22 +0000432 case Instruction::Select:
Owen Anderson168ad692009-10-19 22:14:22 +0000433 case Instruction::ExtractElement:
Owen Anderson168ad692009-10-19 22:14:22 +0000434 case Instruction::InsertElement:
Owen Anderson168ad692009-10-19 22:14:22 +0000435 case Instruction::ShuffleVector:
Owen Anderson168ad692009-10-19 22:14:22 +0000436 case Instruction::InsertValue:
Owen Anderson168ad692009-10-19 22:14:22 +0000437 case Instruction::GetElementPtr:
Owen Anderson3a33d0c2011-01-03 19:00:11 +0000438 exp = create_expression(I);
Owen Anderson168ad692009-10-19 22:14:22 +0000439 break;
Lang Hames29cd98f2011-07-08 01:50:54 +0000440 case Instruction::ExtractValue:
441 exp = create_extractvalue_expression(cast<ExtractValueInst>(I));
442 break;
Owen Anderson168ad692009-10-19 22:14:22 +0000443 default:
444 valueNumbering[V] = nextValueNumber;
445 return nextValueNumber++;
446 }
447
448 uint32_t& e = expressionNumbering[exp];
449 if (!e) e = nextValueNumber++;
450 valueNumbering[V] = e;
451 return e;
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000452}
453
454/// lookup - Returns the value number of the specified value. Fails if
455/// the value has not yet been numbered.
Chris Lattner1eefa9c2009-09-21 02:42:51 +0000456uint32_t ValueTable::lookup(Value *V) const {
Jeffrey Yasskinb40d3f72009-11-10 01:02:17 +0000457 DenseMap<Value*, uint32_t>::const_iterator VI = valueNumbering.find(V);
Chris Lattner2876a642008-03-21 21:14:38 +0000458 assert(VI != valueNumbering.end() && "Value not numbered?");
459 return VI->second;
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000460}
461
Duncan Sands27f45952012-02-27 08:14:30 +0000462/// lookup_or_add_cmp - Returns the value number of the given comparison,
463/// assigning it a new number if it did not have one before. Useful when
464/// we deduced the result of a comparison, but don't immediately have an
465/// instruction realizing that comparison to hand.
466uint32_t ValueTable::lookup_or_add_cmp(unsigned Opcode,
467 CmpInst::Predicate Predicate,
468 Value *LHS, Value *RHS) {
469 Expression exp = create_cmp_expression(Opcode, Predicate, LHS, RHS);
470 uint32_t& e = expressionNumbering[exp];
471 if (!e) e = nextValueNumber++;
472 return e;
473}
474
Chris Lattner45e393f2011-04-28 18:08:21 +0000475/// clear - Remove all entries from the ValueTable.
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000476void ValueTable::clear() {
477 valueNumbering.clear();
478 expressionNumbering.clear();
479 nextValueNumber = 1;
480}
481
Chris Lattner45e393f2011-04-28 18:08:21 +0000482/// erase - Remove a value from the value numbering.
Chris Lattner1eefa9c2009-09-21 02:42:51 +0000483void ValueTable::erase(Value *V) {
Owen Anderson10ffa862007-07-31 23:27:13 +0000484 valueNumbering.erase(V);
485}
486
Bill Wendling6b18a392008-12-22 21:36:08 +0000487/// verifyRemoved - Verify that the value is removed from all internal data
488/// structures.
489void ValueTable::verifyRemoved(const Value *V) const {
Jeffrey Yasskinb40d3f72009-11-10 01:02:17 +0000490 for (DenseMap<Value*, uint32_t>::const_iterator
Bill Wendling6b18a392008-12-22 21:36:08 +0000491 I = valueNumbering.begin(), E = valueNumbering.end(); I != E; ++I) {
492 assert(I->first != V && "Inst still occurs in value numbering map!");
493 }
494}
495
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000496//===----------------------------------------------------------------------===//
Bill Wendling456e8852008-12-22 22:32:22 +0000497// GVN Pass
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000498//===----------------------------------------------------------------------===//
499
500namespace {
Shuxin Yang637b9be2013-05-03 19:17:26 +0000501 class GVN;
502 struct AvailableValueInBlock {
503 /// BB - The basic block in question.
504 BasicBlock *BB;
505 enum ValType {
506 SimpleVal, // A simple offsetted value that is accessed.
507 LoadVal, // A value produced by a load.
508 MemIntrin // A memory intrinsic which is loaded from.
509 };
510
511 /// V - The value that is live out of the block.
512 PointerIntPair<Value *, 2, ValType> Val;
513
514 /// Offset - The byte offset in Val that is interesting for the load query.
515 unsigned Offset;
516
517 static AvailableValueInBlock get(BasicBlock *BB, Value *V,
518 unsigned Offset = 0) {
519 AvailableValueInBlock Res;
520 Res.BB = BB;
521 Res.Val.setPointer(V);
522 Res.Val.setInt(SimpleVal);
523 Res.Offset = Offset;
524 return Res;
525 }
526
527 static AvailableValueInBlock getMI(BasicBlock *BB, MemIntrinsic *MI,
528 unsigned Offset = 0) {
529 AvailableValueInBlock Res;
530 Res.BB = BB;
531 Res.Val.setPointer(MI);
532 Res.Val.setInt(MemIntrin);
533 Res.Offset = Offset;
534 return Res;
535 }
536
537 static AvailableValueInBlock getLoad(BasicBlock *BB, LoadInst *LI,
538 unsigned Offset = 0) {
539 AvailableValueInBlock Res;
540 Res.BB = BB;
541 Res.Val.setPointer(LI);
542 Res.Val.setInt(LoadVal);
543 Res.Offset = Offset;
544 return Res;
545 }
546
547 bool isSimpleValue() const { return Val.getInt() == SimpleVal; }
548 bool isCoercedLoadValue() const { return Val.getInt() == LoadVal; }
549 bool isMemIntrinValue() const { return Val.getInt() == MemIntrin; }
550
551 Value *getSimpleValue() const {
552 assert(isSimpleValue() && "Wrong accessor");
553 return Val.getPointer();
554 }
555
556 LoadInst *getCoercedLoadValue() const {
557 assert(isCoercedLoadValue() && "Wrong accessor");
558 return cast<LoadInst>(Val.getPointer());
559 }
560
561 MemIntrinsic *getMemIntrinValue() const {
562 assert(isMemIntrinValue() && "Wrong accessor");
563 return cast<MemIntrinsic>(Val.getPointer());
564 }
565
566 /// MaterializeAdjustedValue - Emit code into this block to adjust the value
567 /// defined here to the specified type. This handles various coercion cases.
568 Value *MaterializeAdjustedValue(Type *LoadTy, GVN &gvn) const;
569 };
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000570
Chris Lattner2dd09db2009-09-02 06:11:42 +0000571 class GVN : public FunctionPass {
Dan Gohman81132462009-11-14 02:27:51 +0000572 bool NoLoads;
Chris Lattner8541ede2008-12-01 00:40:32 +0000573 MemoryDependenceAnalysis *MD;
574 DominatorTree *DT;
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000575 const DataLayout *TD;
Chad Rosierc24b86f2011-12-01 03:08:23 +0000576 const TargetLibraryInfo *TLI;
577
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000578 ValueTable VN;
Nadav Rotem465834c2012-07-24 10:51:42 +0000579
Owen Andersone39cb572011-01-04 19:29:46 +0000580 /// LeaderTable - A mapping from value numbers to lists of Value*'s that
Owen Andersonc7c3bc62011-01-04 19:13:25 +0000581 /// have that value number. Use findLeader to query it.
582 struct LeaderTableEntry {
Owen Anderson5ab8d4b2010-12-21 23:54:34 +0000583 Value *Val;
Rafael Espindola64e7b5702012-08-10 15:55:25 +0000584 const BasicBlock *BB;
Owen Andersonc7c3bc62011-01-04 19:13:25 +0000585 LeaderTableEntry *Next;
Owen Anderson5ab8d4b2010-12-21 23:54:34 +0000586 };
Owen Andersone39cb572011-01-04 19:29:46 +0000587 DenseMap<uint32_t, LeaderTableEntry> LeaderTable;
Owen Andersonc21c1002010-11-18 18:32:40 +0000588 BumpPtrAllocator TableAllocator;
Nadav Rotem465834c2012-07-24 10:51:42 +0000589
Chris Lattner6cec6ab2011-04-28 16:18:52 +0000590 SmallVector<Instruction*, 8> InstrsToErase;
Shuxin Yang637b9be2013-05-03 19:17:26 +0000591
592 typedef SmallVector<NonLocalDepResult, 64> LoadDepVect;
593 typedef SmallVector<AvailableValueInBlock, 64> AvailValInBlkVect;
594 typedef SmallVector<BasicBlock*, 64> UnavailBlkVect;
595
Chris Lattnerf81f7892011-04-28 16:36:48 +0000596 public:
597 static char ID; // Pass identification, replacement for typeid
598 explicit GVN(bool noloads = false)
599 : FunctionPass(ID), NoLoads(noloads), MD(0) {
600 initializeGVNPass(*PassRegistry::getPassRegistry());
601 }
602
603 bool runOnFunction(Function &F);
Nadav Rotem465834c2012-07-24 10:51:42 +0000604
Chris Lattnerf81f7892011-04-28 16:36:48 +0000605 /// markInstructionForDeletion - This removes the specified instruction from
606 /// our various maps and marks it for deletion.
607 void markInstructionForDeletion(Instruction *I) {
608 VN.erase(I);
609 InstrsToErase.push_back(I);
610 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000611
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000612 const DataLayout *getDataLayout() const { return TD; }
Chris Lattnerf81f7892011-04-28 16:36:48 +0000613 DominatorTree &getDominatorTree() const { return *DT; }
614 AliasAnalysis *getAliasAnalysis() const { return VN.getAliasAnalysis(); }
Chris Lattner45e393f2011-04-28 18:08:21 +0000615 MemoryDependenceAnalysis &getMemDep() const { return *MD; }
Chris Lattnerf81f7892011-04-28 16:36:48 +0000616 private:
Owen Andersone39cb572011-01-04 19:29:46 +0000617 /// addToLeaderTable - Push a new Value to the LeaderTable onto the list for
Owen Andersonea326db2010-11-19 22:48:40 +0000618 /// its value number.
Rafael Espindola64e7b5702012-08-10 15:55:25 +0000619 void addToLeaderTable(uint32_t N, Value *V, const BasicBlock *BB) {
Chris Lattner17776012011-04-28 18:15:47 +0000620 LeaderTableEntry &Curr = LeaderTable[N];
Owen Anderson5ab8d4b2010-12-21 23:54:34 +0000621 if (!Curr.Val) {
622 Curr.Val = V;
623 Curr.BB = BB;
Owen Andersonc21c1002010-11-18 18:32:40 +0000624 return;
625 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000626
Chris Lattner17776012011-04-28 18:15:47 +0000627 LeaderTableEntry *Node = TableAllocator.Allocate<LeaderTableEntry>();
Owen Anderson5ab8d4b2010-12-21 23:54:34 +0000628 Node->Val = V;
629 Node->BB = BB;
630 Node->Next = Curr.Next;
631 Curr.Next = Node;
Owen Andersonc21c1002010-11-18 18:32:40 +0000632 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000633
Owen Andersone39cb572011-01-04 19:29:46 +0000634 /// removeFromLeaderTable - Scan the list of values corresponding to a given
Duncan Sands4df5e962012-05-22 14:17:53 +0000635 /// value number, and remove the given instruction if encountered.
636 void removeFromLeaderTable(uint32_t N, Instruction *I, BasicBlock *BB) {
Owen Andersonc7c3bc62011-01-04 19:13:25 +0000637 LeaderTableEntry* Prev = 0;
Owen Andersone39cb572011-01-04 19:29:46 +0000638 LeaderTableEntry* Curr = &LeaderTable[N];
Owen Andersonc21c1002010-11-18 18:32:40 +0000639
Duncan Sands4df5e962012-05-22 14:17:53 +0000640 while (Curr->Val != I || Curr->BB != BB) {
Owen Andersonc21c1002010-11-18 18:32:40 +0000641 Prev = Curr;
Owen Anderson5ab8d4b2010-12-21 23:54:34 +0000642 Curr = Curr->Next;
Owen Andersonc21c1002010-11-18 18:32:40 +0000643 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000644
Owen Andersonc21c1002010-11-18 18:32:40 +0000645 if (Prev) {
Owen Anderson5ab8d4b2010-12-21 23:54:34 +0000646 Prev->Next = Curr->Next;
Owen Andersonc21c1002010-11-18 18:32:40 +0000647 } else {
Owen Anderson5ab8d4b2010-12-21 23:54:34 +0000648 if (!Curr->Next) {
649 Curr->Val = 0;
650 Curr->BB = 0;
Owen Andersonc21c1002010-11-18 18:32:40 +0000651 } else {
Owen Andersonc7c3bc62011-01-04 19:13:25 +0000652 LeaderTableEntry* Next = Curr->Next;
Owen Anderson5ab8d4b2010-12-21 23:54:34 +0000653 Curr->Val = Next->Val;
654 Curr->BB = Next->BB;
Owen Anderson83546f22011-01-04 19:10:54 +0000655 Curr->Next = Next->Next;
Owen Andersonc21c1002010-11-18 18:32:40 +0000656 }
657 }
658 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000659
Bob Wilson92cdb6e2010-02-16 19:51:59 +0000660 // List of critical edges to be split between iterations.
661 SmallVector<std::pair<TerminatorInst*, unsigned>, 4> toSplit;
662
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000663 // This transformation requires dominator postdominator info
664 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000665 AU.addRequired<DominatorTree>();
Chad Rosierc24b86f2011-12-01 03:08:23 +0000666 AU.addRequired<TargetLibraryInfo>();
Dan Gohman81132462009-11-14 02:27:51 +0000667 if (!NoLoads)
668 AU.addRequired<MemoryDependenceAnalysis>();
Owen Anderson09b83ba2007-10-18 19:39:33 +0000669 AU.addRequired<AliasAnalysis>();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000670
Owen Anderson54e02192008-06-23 17:49:45 +0000671 AU.addPreserved<DominatorTree>();
Owen Anderson09b83ba2007-10-18 19:39:33 +0000672 AU.addPreserved<AliasAnalysis>();
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000673 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000674
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000675
Shuxin Yang637b9be2013-05-03 19:17:26 +0000676 // Helper fuctions of redundant load elimination
Chris Lattner6cec6ab2011-04-28 16:18:52 +0000677 bool processLoad(LoadInst *L);
Chris Lattner6cec6ab2011-04-28 16:18:52 +0000678 bool processNonLocalLoad(LoadInst *L);
Shuxin Yang637b9be2013-05-03 19:17:26 +0000679 void AnalyzeLoadAvailability(LoadInst *LI, LoadDepVect &Deps,
680 AvailValInBlkVect &ValuesPerBlock,
681 UnavailBlkVect &UnavailableBlocks);
682 bool PerformLoadPRE(LoadInst *LI, AvailValInBlkVect &ValuesPerBlock,
683 UnavailBlkVect &UnavailableBlocks);
684
685 // Other helper routines
686 bool processInstruction(Instruction *I);
Chris Lattner1eefa9c2009-09-21 02:42:51 +0000687 bool processBlock(BasicBlock *BB);
Chris Lattner6cec6ab2011-04-28 16:18:52 +0000688 void dump(DenseMap<uint32_t, Value*> &d);
Owen Anderson676070d2007-08-14 18:04:11 +0000689 bool iterateOnFunction(Function &F);
Chris Lattner6cec6ab2011-04-28 16:18:52 +0000690 bool performPRE(Function &F);
Rafael Espindola64e7b5702012-08-10 15:55:25 +0000691 Value *findLeader(const BasicBlock *BB, uint32_t num);
Nuno Lopese3127f32008-10-10 16:25:50 +0000692 void cleanupGlobalSets();
Bill Wendling6b18a392008-12-22 21:36:08 +0000693 void verifyRemoved(const Instruction *I) const;
Bob Wilson92cdb6e2010-02-16 19:51:59 +0000694 bool splitCriticalEdges();
Duncan Sandsf4f47cc2011-10-05 14:28:49 +0000695 unsigned replaceAllDominatedUsesWith(Value *From, Value *To,
Rafael Espindolacc80cde2012-08-16 15:09:43 +0000696 const BasicBlockEdge &Root);
697 bool propagateEquality(Value *LHS, Value *RHS, const BasicBlockEdge &Root);
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000698 };
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000699
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000700 char GVN::ID = 0;
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000701}
702
703// createGVNPass - The public interface to this file...
Bob Wilson11361662010-02-28 05:34:05 +0000704FunctionPass *llvm::createGVNPass(bool NoLoads) {
705 return new GVN(NoLoads);
Dan Gohman81132462009-11-14 02:27:51 +0000706}
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000707
Owen Anderson8ac477f2010-10-12 19:48:12 +0000708INITIALIZE_PASS_BEGIN(GVN, "gvn", "Global Value Numbering", false, false)
709INITIALIZE_PASS_DEPENDENCY(MemoryDependenceAnalysis)
710INITIALIZE_PASS_DEPENDENCY(DominatorTree)
Chad Rosierc24b86f2011-12-01 03:08:23 +0000711INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfo)
Owen Anderson8ac477f2010-10-12 19:48:12 +0000712INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
713INITIALIZE_PASS_END(GVN, "gvn", "Global Value Numbering", false, false)
Owen Andersonab6ec2e2007-07-24 17:55:58 +0000714
Manman Ren49d684e2012-09-12 05:06:18 +0000715#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
Owen Anderson6a903bc2008-06-18 21:41:49 +0000716void GVN::dump(DenseMap<uint32_t, Value*>& d) {
Dan Gohman57e80862009-12-18 03:25:51 +0000717 errs() << "{\n";
Owen Anderson6a903bc2008-06-18 21:41:49 +0000718 for (DenseMap<uint32_t, Value*>::iterator I = d.begin(),
Owen Anderson5e5599b2007-07-25 19:57:03 +0000719 E = d.end(); I != E; ++I) {
Dan Gohman57e80862009-12-18 03:25:51 +0000720 errs() << I->first << "\n";
Owen Anderson5e5599b2007-07-25 19:57:03 +0000721 I->second->dump();
722 }
Dan Gohman57e80862009-12-18 03:25:51 +0000723 errs() << "}\n";
Owen Anderson5e5599b2007-07-25 19:57:03 +0000724}
Manman Renc3366cc2012-09-06 19:55:56 +0000725#endif
Owen Anderson5e5599b2007-07-25 19:57:03 +0000726
Chris Lattner1db9bbe2008-12-02 08:16:11 +0000727/// IsValueFullyAvailableInBlock - Return true if we can prove that the value
728/// we're analyzing is fully available in the specified block. As we go, keep
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000729/// track of which blocks we know are fully alive in FullyAvailableBlocks. This
730/// map is actually a tri-state map with the following values:
731/// 0) we know the block *is not* fully available.
732/// 1) we know the block *is* fully available.
733/// 2) we do not know whether the block is fully available or not, but we are
734/// currently speculating that it will be.
735/// 3) we are speculating for this block and have used that to speculate for
736/// other blocks.
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000737static bool IsValueFullyAvailableInBlock(BasicBlock *BB,
Mon P Wang6120cfb2012-04-27 18:09:28 +0000738 DenseMap<BasicBlock*, char> &FullyAvailableBlocks,
739 uint32_t RecurseDepth) {
740 if (RecurseDepth > MaxRecurseDepth)
741 return false;
742
Chris Lattner1db9bbe2008-12-02 08:16:11 +0000743 // Optimistically assume that the block is fully available and check to see
744 // if we already know about this block in one lookup.
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000745 std::pair<DenseMap<BasicBlock*, char>::iterator, char> IV =
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000746 FullyAvailableBlocks.insert(std::make_pair(BB, 2));
Chris Lattner1db9bbe2008-12-02 08:16:11 +0000747
748 // If the entry already existed for this block, return the precomputed value.
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000749 if (!IV.second) {
750 // If this is a speculative "available" value, mark it as being used for
751 // speculation of other blocks.
752 if (IV.first->second == 2)
753 IV.first->second = 3;
754 return IV.first->second != 0;
755 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000756
Chris Lattner1db9bbe2008-12-02 08:16:11 +0000757 // Otherwise, see if it is fully available in all predecessors.
758 pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000759
Chris Lattner1db9bbe2008-12-02 08:16:11 +0000760 // If this block has no predecessors, it isn't live-in here.
761 if (PI == PE)
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000762 goto SpeculationFailure;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000763
Chris Lattner1db9bbe2008-12-02 08:16:11 +0000764 for (; PI != PE; ++PI)
765 // If the value isn't fully available in one of our predecessors, then it
766 // isn't fully available in this block either. Undo our previous
767 // optimistic assumption and bail out.
Mon P Wang6120cfb2012-04-27 18:09:28 +0000768 if (!IsValueFullyAvailableInBlock(*PI, FullyAvailableBlocks,RecurseDepth+1))
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000769 goto SpeculationFailure;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000770
Chris Lattner1db9bbe2008-12-02 08:16:11 +0000771 return true;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000772
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000773// SpeculationFailure - If we get here, we found out that this is not, after
774// all, a fully-available block. We have a problem if we speculated on this and
775// used the speculation to mark other blocks as available.
776SpeculationFailure:
777 char &BBVal = FullyAvailableBlocks[BB];
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000778
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000779 // If we didn't speculate on this, just return with it set to false.
780 if (BBVal == 2) {
781 BBVal = 0;
782 return false;
783 }
784
785 // If we did speculate on this value, we could have blocks set to 1 that are
786 // incorrect. Walk the (transitive) successors of this block and mark them as
787 // 0 if set to one.
788 SmallVector<BasicBlock*, 32> BBWorklist;
789 BBWorklist.push_back(BB);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000790
Dan Gohman28943872010-01-05 16:27:25 +0000791 do {
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000792 BasicBlock *Entry = BBWorklist.pop_back_val();
793 // Note that this sets blocks to 0 (unavailable) if they happen to not
794 // already be in FullyAvailableBlocks. This is safe.
795 char &EntryVal = FullyAvailableBlocks[Entry];
796 if (EntryVal == 0) continue; // Already unavailable.
797
798 // Mark as unavailable.
799 EntryVal = 0;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000800
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000801 for (succ_iterator I = succ_begin(Entry), E = succ_end(Entry); I != E; ++I)
802 BBWorklist.push_back(*I);
Dan Gohman28943872010-01-05 16:27:25 +0000803 } while (!BBWorklist.empty());
Daniel Dunbar7d6781b2009-09-20 02:20:51 +0000804
Chris Lattnerd2a653a2008-12-05 07:49:08 +0000805 return false;
Chris Lattner1db9bbe2008-12-02 08:16:11 +0000806}
807
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000808
Chris Lattner9045f232009-09-21 17:24:04 +0000809/// CanCoerceMustAliasedValueToLoad - Return true if
810/// CoerceAvailableValueToLoadType will succeed.
811static bool CanCoerceMustAliasedValueToLoad(Value *StoredVal,
Chris Lattner229907c2011-07-18 04:54:35 +0000812 Type *LoadTy,
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000813 const DataLayout &TD) {
Chris Lattner9045f232009-09-21 17:24:04 +0000814 // If the loaded or stored value is an first class array or struct, don't try
815 // to transform them. We need to be able to bitcast to integer.
Duncan Sands19d0b472010-02-16 11:11:14 +0000816 if (LoadTy->isStructTy() || LoadTy->isArrayTy() ||
817 StoredVal->getType()->isStructTy() ||
818 StoredVal->getType()->isArrayTy())
Chris Lattner9045f232009-09-21 17:24:04 +0000819 return false;
Nadav Rotem465834c2012-07-24 10:51:42 +0000820
Chris Lattner9045f232009-09-21 17:24:04 +0000821 // The store has to be at least as big as the load.
822 if (TD.getTypeSizeInBits(StoredVal->getType()) <
823 TD.getTypeSizeInBits(LoadTy))
824 return false;
Nadav Rotem465834c2012-07-24 10:51:42 +0000825
Chris Lattner9045f232009-09-21 17:24:04 +0000826 return true;
827}
Nadav Rotem465834c2012-07-24 10:51:42 +0000828
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000829/// CoerceAvailableValueToLoadType - If we saw a store of a value to memory, and
830/// then a load from a must-aliased pointer of a different type, try to coerce
831/// the stored value. LoadedTy is the type of the load we want to replace and
832/// InsertPt is the place to insert new instructions.
833///
834/// If we can't do it, return null.
Nadav Rotem465834c2012-07-24 10:51:42 +0000835static Value *CoerceAvailableValueToLoadType(Value *StoredVal,
Chris Lattner229907c2011-07-18 04:54:35 +0000836 Type *LoadedTy,
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000837 Instruction *InsertPt,
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000838 const DataLayout &TD) {
Chris Lattner9045f232009-09-21 17:24:04 +0000839 if (!CanCoerceMustAliasedValueToLoad(StoredVal, LoadedTy, TD))
840 return 0;
Nadav Rotem465834c2012-07-24 10:51:42 +0000841
Chris Lattner827a2702011-04-28 07:29:08 +0000842 // If this is already the right type, just return it.
Chris Lattner229907c2011-07-18 04:54:35 +0000843 Type *StoredValTy = StoredVal->getType();
Nadav Rotem465834c2012-07-24 10:51:42 +0000844
Jakub Staszak7470fb02011-09-02 14:57:37 +0000845 uint64_t StoreSize = TD.getTypeSizeInBits(StoredValTy);
846 uint64_t LoadSize = TD.getTypeSizeInBits(LoadedTy);
Nadav Rotem465834c2012-07-24 10:51:42 +0000847
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000848 // If the store and reload are the same size, we can always reuse it.
849 if (StoreSize == LoadSize) {
Chris Lattner6f83d062011-04-26 01:21:15 +0000850 // Pointer to Pointer -> use bitcast.
Hal Finkel69b07a22012-10-24 21:22:30 +0000851 if (StoredValTy->getScalarType()->isPointerTy() &&
852 LoadedTy->getScalarType()->isPointerTy())
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000853 return new BitCastInst(StoredVal, LoadedTy, "", InsertPt);
Nadav Rotem465834c2012-07-24 10:51:42 +0000854
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000855 // Convert source pointers to integers, which can be bitcast.
Hal Finkel69b07a22012-10-24 21:22:30 +0000856 if (StoredValTy->getScalarType()->isPointerTy()) {
Duncan Sands5bdd9dd2012-10-29 17:31:46 +0000857 StoredValTy = TD.getIntPtrType(StoredValTy);
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000858 StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
859 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000860
Chris Lattner229907c2011-07-18 04:54:35 +0000861 Type *TypeToCastTo = LoadedTy;
Hal Finkel69b07a22012-10-24 21:22:30 +0000862 if (TypeToCastTo->getScalarType()->isPointerTy())
Duncan Sandsa17bb142012-11-02 07:49:32 +0000863 TypeToCastTo = TD.getIntPtrType(TypeToCastTo);
Nadav Rotem465834c2012-07-24 10:51:42 +0000864
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000865 if (StoredValTy != TypeToCastTo)
866 StoredVal = new BitCastInst(StoredVal, TypeToCastTo, "", InsertPt);
Nadav Rotem465834c2012-07-24 10:51:42 +0000867
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000868 // Cast to pointer if the load needs a pointer type.
Hal Finkel69b07a22012-10-24 21:22:30 +0000869 if (LoadedTy->getScalarType()->isPointerTy())
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000870 StoredVal = new IntToPtrInst(StoredVal, LoadedTy, "", InsertPt);
Nadav Rotem465834c2012-07-24 10:51:42 +0000871
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000872 return StoredVal;
873 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000874
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000875 // If the loaded value is smaller than the available value, then we can
876 // extract out a piece from it. If the available value is too small, then we
877 // can't do anything.
Chris Lattner9045f232009-09-21 17:24:04 +0000878 assert(StoreSize >= LoadSize && "CanCoerceMustAliasedValueToLoad fail");
Nadav Rotem465834c2012-07-24 10:51:42 +0000879
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000880 // Convert source pointers to integers, which can be manipulated.
Hal Finkel69b07a22012-10-24 21:22:30 +0000881 if (StoredValTy->getScalarType()->isPointerTy()) {
Duncan Sands5bdd9dd2012-10-29 17:31:46 +0000882 StoredValTy = TD.getIntPtrType(StoredValTy);
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000883 StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
884 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000885
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000886 // Convert vectors and fp to integer, which can be manipulated.
Duncan Sands19d0b472010-02-16 11:11:14 +0000887 if (!StoredValTy->isIntegerTy()) {
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000888 StoredValTy = IntegerType::get(StoredValTy->getContext(), StoreSize);
889 StoredVal = new BitCastInst(StoredVal, StoredValTy, "", InsertPt);
890 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000891
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000892 // If this is a big-endian system, we need to shift the value down to the low
893 // bits so that a truncate will work.
894 if (TD.isBigEndian()) {
895 Constant *Val = ConstantInt::get(StoredVal->getType(), StoreSize-LoadSize);
896 StoredVal = BinaryOperator::CreateLShr(StoredVal, Val, "tmp", InsertPt);
897 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000898
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000899 // Truncate the integer to the right size now.
Chris Lattner229907c2011-07-18 04:54:35 +0000900 Type *NewIntTy = IntegerType::get(StoredValTy->getContext(), LoadSize);
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000901 StoredVal = new TruncInst(StoredVal, NewIntTy, "trunc", InsertPt);
Nadav Rotem465834c2012-07-24 10:51:42 +0000902
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000903 if (LoadedTy == NewIntTy)
904 return StoredVal;
Nadav Rotem465834c2012-07-24 10:51:42 +0000905
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000906 // If the result is a pointer, inttoptr.
Hal Finkel69b07a22012-10-24 21:22:30 +0000907 if (LoadedTy->getScalarType()->isPointerTy())
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000908 return new IntToPtrInst(StoredVal, LoadedTy, "inttoptr", InsertPt);
Nadav Rotem465834c2012-07-24 10:51:42 +0000909
Chris Lattnera0aa8fb2009-09-20 20:09:34 +0000910 // Otherwise, bitcast.
911 return new BitCastInst(StoredVal, LoadedTy, "bitcast", InsertPt);
912}
913
Chris Lattner42376062009-12-06 01:57:02 +0000914/// AnalyzeLoadFromClobberingWrite - This function is called when we have a
915/// memdep query of a load that ends up being a clobbering memory write (store,
916/// memset, memcpy, memmove). This means that the write *may* provide bits used
917/// by the load but we can't be sure because the pointers don't mustalias.
918///
919/// Check this case to see if there is anything more we can do before we give
920/// up. This returns -1 if we have to give up, or a byte number in the stored
921/// value of the piece that feeds the load.
Chris Lattner229907c2011-07-18 04:54:35 +0000922static int AnalyzeLoadFromClobberingWrite(Type *LoadTy, Value *LoadPtr,
Chris Lattner0def8612009-12-09 07:34:10 +0000923 Value *WritePtr,
Chris Lattner42376062009-12-06 01:57:02 +0000924 uint64_t WriteSizeInBits,
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000925 const DataLayout &TD) {
Chad Rosier6a0baa82012-01-30 22:44:13 +0000926 // If the loaded or stored value is a first class array or struct, don't try
Chris Lattner9045f232009-09-21 17:24:04 +0000927 // to transform them. We need to be able to bitcast to integer.
Duncan Sands19d0b472010-02-16 11:11:14 +0000928 if (LoadTy->isStructTy() || LoadTy->isArrayTy())
Chris Lattner9045f232009-09-21 17:24:04 +0000929 return -1;
Nadav Rotem465834c2012-07-24 10:51:42 +0000930
Chris Lattnerd28f9082009-09-21 06:24:16 +0000931 int64_t StoreOffset = 0, LoadOffset = 0;
Dan Gohman20a2ae92013-01-31 02:00:45 +0000932 Value *StoreBase = GetPointerBaseWithConstantOffset(WritePtr,StoreOffset,&TD);
933 Value *LoadBase = GetPointerBaseWithConstantOffset(LoadPtr, LoadOffset, &TD);
Chris Lattnerd28f9082009-09-21 06:24:16 +0000934 if (StoreBase != LoadBase)
935 return -1;
Nadav Rotem465834c2012-07-24 10:51:42 +0000936
Chris Lattnerd28f9082009-09-21 06:24:16 +0000937 // If the load and store are to the exact same address, they should have been
938 // a must alias. AA must have gotten confused.
Chris Lattner05638042010-03-25 05:58:19 +0000939 // FIXME: Study to see if/when this happens. One case is forwarding a memset
940 // to a load from the base of the memset.
Chris Lattnerd28f9082009-09-21 06:24:16 +0000941#if 0
Chris Lattner05638042010-03-25 05:58:19 +0000942 if (LoadOffset == StoreOffset) {
David Greene2e6efc42010-01-05 01:27:17 +0000943 dbgs() << "STORE/LOAD DEP WITH COMMON POINTER MISSED:\n"
Chris Lattnerd28f9082009-09-21 06:24:16 +0000944 << "Base = " << *StoreBase << "\n"
Chris Lattner42376062009-12-06 01:57:02 +0000945 << "Store Ptr = " << *WritePtr << "\n"
946 << "Store Offs = " << StoreOffset << "\n"
Chris Lattner3ddf8042009-12-10 00:04:46 +0000947 << "Load Ptr = " << *LoadPtr << "\n";
Chris Lattner946b58d2009-12-09 02:41:54 +0000948 abort();
Chris Lattnerd28f9082009-09-21 06:24:16 +0000949 }
Chris Lattner05638042010-03-25 05:58:19 +0000950#endif
Nadav Rotem465834c2012-07-24 10:51:42 +0000951
Chris Lattnerd28f9082009-09-21 06:24:16 +0000952 // If the load and store don't overlap at all, the store doesn't provide
953 // anything to the load. In this case, they really don't alias at all, AA
954 // must have gotten confused.
Chris Lattner0def8612009-12-09 07:34:10 +0000955 uint64_t LoadSize = TD.getTypeSizeInBits(LoadTy);
Nadav Rotem465834c2012-07-24 10:51:42 +0000956
Chris Lattner42376062009-12-06 01:57:02 +0000957 if ((WriteSizeInBits & 7) | (LoadSize & 7))
Chris Lattnerd28f9082009-09-21 06:24:16 +0000958 return -1;
Chris Lattner42376062009-12-06 01:57:02 +0000959 uint64_t StoreSize = WriteSizeInBits >> 3; // Convert to bytes.
Chris Lattnerd28f9082009-09-21 06:24:16 +0000960 LoadSize >>= 3;
Nadav Rotem465834c2012-07-24 10:51:42 +0000961
962
Chris Lattnerd28f9082009-09-21 06:24:16 +0000963 bool isAAFailure = false;
Chris Lattner05638042010-03-25 05:58:19 +0000964 if (StoreOffset < LoadOffset)
Chris Lattnerd28f9082009-09-21 06:24:16 +0000965 isAAFailure = StoreOffset+int64_t(StoreSize) <= LoadOffset;
Chris Lattner05638042010-03-25 05:58:19 +0000966 else
Chris Lattnerd28f9082009-09-21 06:24:16 +0000967 isAAFailure = LoadOffset+int64_t(LoadSize) <= StoreOffset;
Chris Lattner05638042010-03-25 05:58:19 +0000968
Chris Lattnerd28f9082009-09-21 06:24:16 +0000969 if (isAAFailure) {
970#if 0
David Greene2e6efc42010-01-05 01:27:17 +0000971 dbgs() << "STORE LOAD DEP WITH COMMON BASE:\n"
Chris Lattnerd28f9082009-09-21 06:24:16 +0000972 << "Base = " << *StoreBase << "\n"
Chris Lattner42376062009-12-06 01:57:02 +0000973 << "Store Ptr = " << *WritePtr << "\n"
974 << "Store Offs = " << StoreOffset << "\n"
Chris Lattner3ddf8042009-12-10 00:04:46 +0000975 << "Load Ptr = " << *LoadPtr << "\n";
Chris Lattner946b58d2009-12-09 02:41:54 +0000976 abort();
Chris Lattnerd28f9082009-09-21 06:24:16 +0000977#endif
978 return -1;
979 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000980
Chris Lattnerd28f9082009-09-21 06:24:16 +0000981 // If the Load isn't completely contained within the stored bits, we don't
982 // have all the bits to feed it. We could do something crazy in the future
983 // (issue a smaller load then merge the bits in) but this seems unlikely to be
984 // valuable.
985 if (StoreOffset > LoadOffset ||
986 StoreOffset+StoreSize < LoadOffset+LoadSize)
987 return -1;
Nadav Rotem465834c2012-07-24 10:51:42 +0000988
Chris Lattnerd28f9082009-09-21 06:24:16 +0000989 // Okay, we can do this transformation. Return the number of bytes into the
990 // store that the load is.
991 return LoadOffset-StoreOffset;
Nadav Rotem465834c2012-07-24 10:51:42 +0000992}
Chris Lattnerd28f9082009-09-21 06:24:16 +0000993
Chris Lattner42376062009-12-06 01:57:02 +0000994/// AnalyzeLoadFromClobberingStore - This function is called when we have a
995/// memdep query of a load that ends up being a clobbering store.
Chris Lattner229907c2011-07-18 04:54:35 +0000996static int AnalyzeLoadFromClobberingStore(Type *LoadTy, Value *LoadPtr,
Chris Lattner07df9ef2009-12-09 07:37:07 +0000997 StoreInst *DepSI,
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000998 const DataLayout &TD) {
Chris Lattner42376062009-12-06 01:57:02 +0000999 // Cannot handle reading from store of first-class aggregate yet.
Dan Gohmand2099112010-11-10 19:03:33 +00001000 if (DepSI->getValueOperand()->getType()->isStructTy() ||
1001 DepSI->getValueOperand()->getType()->isArrayTy())
Chris Lattner42376062009-12-06 01:57:02 +00001002 return -1;
1003
1004 Value *StorePtr = DepSI->getPointerOperand();
Dan Gohmand2099112010-11-10 19:03:33 +00001005 uint64_t StoreSize =TD.getTypeSizeInBits(DepSI->getValueOperand()->getType());
Chris Lattner07df9ef2009-12-09 07:37:07 +00001006 return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr,
Chris Lattner0def8612009-12-09 07:34:10 +00001007 StorePtr, StoreSize, TD);
Chris Lattner42376062009-12-06 01:57:02 +00001008}
1009
Chris Lattner6f83d062011-04-26 01:21:15 +00001010/// AnalyzeLoadFromClobberingLoad - This function is called when we have a
1011/// memdep query of a load that ends up being clobbered by another load. See if
1012/// the other load can feed into the second load.
Chris Lattner229907c2011-07-18 04:54:35 +00001013static int AnalyzeLoadFromClobberingLoad(Type *LoadTy, Value *LoadPtr,
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001014 LoadInst *DepLI, const DataLayout &TD){
Chris Lattner6f83d062011-04-26 01:21:15 +00001015 // Cannot handle reading from store of first-class aggregate yet.
1016 if (DepLI->getType()->isStructTy() || DepLI->getType()->isArrayTy())
1017 return -1;
Nadav Rotem465834c2012-07-24 10:51:42 +00001018
Chris Lattner6f83d062011-04-26 01:21:15 +00001019 Value *DepPtr = DepLI->getPointerOperand();
1020 uint64_t DepSize = TD.getTypeSizeInBits(DepLI->getType());
Chris Lattner827a2702011-04-28 07:29:08 +00001021 int R = AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr, DepPtr, DepSize, TD);
1022 if (R != -1) return R;
Nadav Rotem465834c2012-07-24 10:51:42 +00001023
Chris Lattner827a2702011-04-28 07:29:08 +00001024 // If we have a load/load clobber an DepLI can be widened to cover this load,
1025 // then we should widen it!
1026 int64_t LoadOffs = 0;
1027 const Value *LoadBase =
Dan Gohman20a2ae92013-01-31 02:00:45 +00001028 GetPointerBaseWithConstantOffset(LoadPtr, LoadOffs, &TD);
Chris Lattner827a2702011-04-28 07:29:08 +00001029 unsigned LoadSize = TD.getTypeStoreSize(LoadTy);
Nadav Rotem465834c2012-07-24 10:51:42 +00001030
Chris Lattner827a2702011-04-28 07:29:08 +00001031 unsigned Size = MemoryDependenceAnalysis::
1032 getLoadLoadClobberFullWidthSize(LoadBase, LoadOffs, LoadSize, DepLI, TD);
1033 if (Size == 0) return -1;
Nadav Rotem465834c2012-07-24 10:51:42 +00001034
Chris Lattner827a2702011-04-28 07:29:08 +00001035 return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr, DepPtr, Size*8, TD);
Chris Lattner6f83d062011-04-26 01:21:15 +00001036}
1037
1038
1039
Chris Lattner229907c2011-07-18 04:54:35 +00001040static int AnalyzeLoadFromClobberingMemInst(Type *LoadTy, Value *LoadPtr,
Chris Lattner07df9ef2009-12-09 07:37:07 +00001041 MemIntrinsic *MI,
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001042 const DataLayout &TD) {
Chris Lattner42376062009-12-06 01:57:02 +00001043 // If the mem operation is a non-constant size, we can't handle it.
1044 ConstantInt *SizeCst = dyn_cast<ConstantInt>(MI->getLength());
1045 if (SizeCst == 0) return -1;
1046 uint64_t MemSizeInBits = SizeCst->getZExtValue()*8;
Chris Lattner778cb922009-12-06 05:29:56 +00001047
1048 // If this is memset, we just need to see if the offset is valid in the size
1049 // of the memset..
Chris Lattner42376062009-12-06 01:57:02 +00001050 if (MI->getIntrinsicID() == Intrinsic::memset)
Chris Lattner07df9ef2009-12-09 07:37:07 +00001051 return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr, MI->getDest(),
1052 MemSizeInBits, TD);
Nadav Rotem465834c2012-07-24 10:51:42 +00001053
Chris Lattner778cb922009-12-06 05:29:56 +00001054 // If we have a memcpy/memmove, the only case we can handle is if this is a
1055 // copy from constant memory. In that case, we can read directly from the
1056 // constant memory.
1057 MemTransferInst *MTI = cast<MemTransferInst>(MI);
Nadav Rotem465834c2012-07-24 10:51:42 +00001058
Chris Lattner778cb922009-12-06 05:29:56 +00001059 Constant *Src = dyn_cast<Constant>(MTI->getSource());
1060 if (Src == 0) return -1;
Nadav Rotem465834c2012-07-24 10:51:42 +00001061
Dan Gohman0f124e12011-01-24 18:53:32 +00001062 GlobalVariable *GV = dyn_cast<GlobalVariable>(GetUnderlyingObject(Src, &TD));
Chris Lattner778cb922009-12-06 05:29:56 +00001063 if (GV == 0 || !GV->isConstant()) return -1;
Nadav Rotem465834c2012-07-24 10:51:42 +00001064
Chris Lattner778cb922009-12-06 05:29:56 +00001065 // See if the access is within the bounds of the transfer.
Chris Lattner07df9ef2009-12-09 07:37:07 +00001066 int Offset = AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr,
1067 MI->getDest(), MemSizeInBits, TD);
Chris Lattner778cb922009-12-06 05:29:56 +00001068 if (Offset == -1)
1069 return Offset;
Nadav Rotem465834c2012-07-24 10:51:42 +00001070
Chris Lattner778cb922009-12-06 05:29:56 +00001071 // Otherwise, see if we can constant fold a load from the constant with the
1072 // offset applied as appropriate.
1073 Src = ConstantExpr::getBitCast(Src,
1074 llvm::Type::getInt8PtrTy(Src->getContext()));
Nadav Rotem465834c2012-07-24 10:51:42 +00001075 Constant *OffsetCst =
Chris Lattner778cb922009-12-06 05:29:56 +00001076 ConstantInt::get(Type::getInt64Ty(Src->getContext()), (unsigned)Offset);
Jay Foaded8db7d2011-07-21 14:31:17 +00001077 Src = ConstantExpr::getGetElementPtr(Src, OffsetCst);
Chris Lattner07df9ef2009-12-09 07:37:07 +00001078 Src = ConstantExpr::getBitCast(Src, PointerType::getUnqual(LoadTy));
Chris Lattner778cb922009-12-06 05:29:56 +00001079 if (ConstantFoldLoadFromConstPtr(Src, &TD))
1080 return Offset;
Chris Lattner42376062009-12-06 01:57:02 +00001081 return -1;
1082}
Nadav Rotem465834c2012-07-24 10:51:42 +00001083
Chris Lattnerd28f9082009-09-21 06:24:16 +00001084
1085/// GetStoreValueForLoad - This function is called when we have a
1086/// memdep query of a load that ends up being a clobbering store. This means
Chris Lattner827a2702011-04-28 07:29:08 +00001087/// that the store provides bits used by the load but we the pointers don't
1088/// mustalias. Check this case to see if there is anything more we can do
1089/// before we give up.
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001090static Value *GetStoreValueForLoad(Value *SrcVal, unsigned Offset,
Chris Lattner229907c2011-07-18 04:54:35 +00001091 Type *LoadTy,
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001092 Instruction *InsertPt, const DataLayout &TD){
Chris Lattnerd28f9082009-09-21 06:24:16 +00001093 LLVMContext &Ctx = SrcVal->getType()->getContext();
Nadav Rotem465834c2012-07-24 10:51:42 +00001094
Chris Lattner5a62d6e2010-05-08 20:01:44 +00001095 uint64_t StoreSize = (TD.getTypeSizeInBits(SrcVal->getType()) + 7) / 8;
1096 uint64_t LoadSize = (TD.getTypeSizeInBits(LoadTy) + 7) / 8;
Nadav Rotem465834c2012-07-24 10:51:42 +00001097
Chris Lattnerf8ba1252009-12-09 18:13:28 +00001098 IRBuilder<> Builder(InsertPt->getParent(), InsertPt);
Nadav Rotem465834c2012-07-24 10:51:42 +00001099
Chris Lattnerd28f9082009-09-21 06:24:16 +00001100 // Compute which bits of the stored value are being used by the load. Convert
1101 // to an integer type to start with.
Hal Finkel69b07a22012-10-24 21:22:30 +00001102 if (SrcVal->getType()->getScalarType()->isPointerTy())
Micah Villmow12d91272012-10-24 15:52:52 +00001103 SrcVal = Builder.CreatePtrToInt(SrcVal,
Duncan Sands5bdd9dd2012-10-29 17:31:46 +00001104 TD.getIntPtrType(SrcVal->getType()));
Duncan Sands19d0b472010-02-16 11:11:14 +00001105 if (!SrcVal->getType()->isIntegerTy())
Benjamin Kramer547b6c52011-09-27 20:39:19 +00001106 SrcVal = Builder.CreateBitCast(SrcVal, IntegerType::get(Ctx, StoreSize*8));
Nadav Rotem465834c2012-07-24 10:51:42 +00001107
Chris Lattnerd28f9082009-09-21 06:24:16 +00001108 // Shift the bits to the least significant depending on endianness.
1109 unsigned ShiftAmt;
Chris Lattner42376062009-12-06 01:57:02 +00001110 if (TD.isLittleEndian())
Chris Lattnerd28f9082009-09-21 06:24:16 +00001111 ShiftAmt = Offset*8;
Chris Lattner42376062009-12-06 01:57:02 +00001112 else
Chris Lattner24705382009-09-21 17:55:47 +00001113 ShiftAmt = (StoreSize-LoadSize-Offset)*8;
Nadav Rotem465834c2012-07-24 10:51:42 +00001114
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001115 if (ShiftAmt)
Benjamin Kramer547b6c52011-09-27 20:39:19 +00001116 SrcVal = Builder.CreateLShr(SrcVal, ShiftAmt);
Nadav Rotem465834c2012-07-24 10:51:42 +00001117
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001118 if (LoadSize != StoreSize)
Benjamin Kramer547b6c52011-09-27 20:39:19 +00001119 SrcVal = Builder.CreateTrunc(SrcVal, IntegerType::get(Ctx, LoadSize*8));
Nadav Rotem465834c2012-07-24 10:51:42 +00001120
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001121 return CoerceAvailableValueToLoadType(SrcVal, LoadTy, InsertPt, TD);
Chris Lattnerd28f9082009-09-21 06:24:16 +00001122}
1123
Chad Rosier41003f82012-01-30 21:13:22 +00001124/// GetLoadValueForLoad - This function is called when we have a
Chris Lattner827a2702011-04-28 07:29:08 +00001125/// memdep query of a load that ends up being a clobbering load. This means
1126/// that the load *may* provide bits used by the load but we can't be sure
1127/// because the pointers don't mustalias. Check this case to see if there is
1128/// anything more we can do before we give up.
1129static Value *GetLoadValueForLoad(LoadInst *SrcVal, unsigned Offset,
Chris Lattner229907c2011-07-18 04:54:35 +00001130 Type *LoadTy, Instruction *InsertPt,
Chris Lattnerf81f7892011-04-28 16:36:48 +00001131 GVN &gvn) {
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001132 const DataLayout &TD = *gvn.getDataLayout();
Chris Lattner827a2702011-04-28 07:29:08 +00001133 // If Offset+LoadTy exceeds the size of SrcVal, then we must be wanting to
1134 // widen SrcVal out to a larger load.
1135 unsigned SrcValSize = TD.getTypeStoreSize(SrcVal->getType());
1136 unsigned LoadSize = TD.getTypeStoreSize(LoadTy);
1137 if (Offset+LoadSize > SrcValSize) {
Eli Friedman9a468152011-08-17 22:22:24 +00001138 assert(SrcVal->isSimple() && "Cannot widen volatile/atomic load!");
1139 assert(SrcVal->getType()->isIntegerTy() && "Can't widen non-integer load");
Chris Lattner827a2702011-04-28 07:29:08 +00001140 // If we have a load/load clobber an DepLI can be widened to cover this
1141 // load, then we should widen it to the next power of 2 size big enough!
1142 unsigned NewLoadSize = Offset+LoadSize;
1143 if (!isPowerOf2_32(NewLoadSize))
1144 NewLoadSize = NextPowerOf2(NewLoadSize);
1145
1146 Value *PtrVal = SrcVal->getPointerOperand();
Nadav Rotem465834c2012-07-24 10:51:42 +00001147
Chris Lattner17776012011-04-28 18:15:47 +00001148 // Insert the new load after the old load. This ensures that subsequent
1149 // memdep queries will find the new load. We can't easily remove the old
1150 // load completely because it is already in the value numbering table.
1151 IRBuilder<> Builder(SrcVal->getParent(), ++BasicBlock::iterator(SrcVal));
Nadav Rotem465834c2012-07-24 10:51:42 +00001152 Type *DestPTy =
Chris Lattner827a2702011-04-28 07:29:08 +00001153 IntegerType::get(LoadTy->getContext(), NewLoadSize*8);
Nadav Rotem465834c2012-07-24 10:51:42 +00001154 DestPTy = PointerType::get(DestPTy,
Chris Lattner827a2702011-04-28 07:29:08 +00001155 cast<PointerType>(PtrVal->getType())->getAddressSpace());
Devang Patelffb798c2011-05-04 23:58:50 +00001156 Builder.SetCurrentDebugLocation(SrcVal->getDebugLoc());
Chris Lattner827a2702011-04-28 07:29:08 +00001157 PtrVal = Builder.CreateBitCast(PtrVal, DestPTy);
1158 LoadInst *NewLoad = Builder.CreateLoad(PtrVal);
1159 NewLoad->takeName(SrcVal);
1160 NewLoad->setAlignment(SrcVal->getAlignment());
Devang Patelffb798c2011-05-04 23:58:50 +00001161
Chris Lattner827a2702011-04-28 07:29:08 +00001162 DEBUG(dbgs() << "GVN WIDENED LOAD: " << *SrcVal << "\n");
1163 DEBUG(dbgs() << "TO: " << *NewLoad << "\n");
Nadav Rotem465834c2012-07-24 10:51:42 +00001164
Chris Lattner827a2702011-04-28 07:29:08 +00001165 // Replace uses of the original load with the wider load. On a big endian
1166 // system, we need to shift down to get the relevant bits.
1167 Value *RV = NewLoad;
1168 if (TD.isBigEndian())
1169 RV = Builder.CreateLShr(RV,
1170 NewLoadSize*8-SrcVal->getType()->getPrimitiveSizeInBits());
1171 RV = Builder.CreateTrunc(RV, SrcVal->getType());
1172 SrcVal->replaceAllUsesWith(RV);
Nadav Rotem465834c2012-07-24 10:51:42 +00001173
Chris Lattnera5452c02011-04-28 20:02:57 +00001174 // We would like to use gvn.markInstructionForDeletion here, but we can't
1175 // because the load is already memoized into the leader map table that GVN
1176 // tracks. It is potentially possible to remove the load from the table,
1177 // but then there all of the operations based on it would need to be
1178 // rehashed. Just leave the dead load around.
Chris Lattner45e393f2011-04-28 18:08:21 +00001179 gvn.getMemDep().removeInstruction(SrcVal);
Chris Lattner827a2702011-04-28 07:29:08 +00001180 SrcVal = NewLoad;
1181 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001182
Chris Lattner827a2702011-04-28 07:29:08 +00001183 return GetStoreValueForLoad(SrcVal, Offset, LoadTy, InsertPt, TD);
1184}
1185
1186
Chris Lattner42376062009-12-06 01:57:02 +00001187/// GetMemInstValueForLoad - This function is called when we have a
1188/// memdep query of a load that ends up being a clobbering mem intrinsic.
1189static Value *GetMemInstValueForLoad(MemIntrinsic *SrcInst, unsigned Offset,
Chris Lattner229907c2011-07-18 04:54:35 +00001190 Type *LoadTy, Instruction *InsertPt,
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001191 const DataLayout &TD){
Chris Lattner42376062009-12-06 01:57:02 +00001192 LLVMContext &Ctx = LoadTy->getContext();
1193 uint64_t LoadSize = TD.getTypeSizeInBits(LoadTy)/8;
1194
1195 IRBuilder<> Builder(InsertPt->getParent(), InsertPt);
Nadav Rotem465834c2012-07-24 10:51:42 +00001196
Chris Lattner42376062009-12-06 01:57:02 +00001197 // We know that this method is only called when the mem transfer fully
1198 // provides the bits for the load.
1199 if (MemSetInst *MSI = dyn_cast<MemSetInst>(SrcInst)) {
1200 // memset(P, 'x', 1234) -> splat('x'), even if x is a variable, and
1201 // independently of what the offset is.
1202 Value *Val = MSI->getValue();
1203 if (LoadSize != 1)
1204 Val = Builder.CreateZExt(Val, IntegerType::get(Ctx, LoadSize*8));
Nadav Rotem465834c2012-07-24 10:51:42 +00001205
Chris Lattner42376062009-12-06 01:57:02 +00001206 Value *OneElt = Val;
Nadav Rotem465834c2012-07-24 10:51:42 +00001207
Chris Lattner42376062009-12-06 01:57:02 +00001208 // Splat the value out to the right number of bits.
1209 for (unsigned NumBytesSet = 1; NumBytesSet != LoadSize; ) {
1210 // If we can double the number of bytes set, do it.
1211 if (NumBytesSet*2 <= LoadSize) {
1212 Value *ShVal = Builder.CreateShl(Val, NumBytesSet*8);
1213 Val = Builder.CreateOr(Val, ShVal);
1214 NumBytesSet <<= 1;
1215 continue;
1216 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001217
Chris Lattner42376062009-12-06 01:57:02 +00001218 // Otherwise insert one byte at a time.
1219 Value *ShVal = Builder.CreateShl(Val, 1*8);
1220 Val = Builder.CreateOr(OneElt, ShVal);
1221 ++NumBytesSet;
1222 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001223
Chris Lattner42376062009-12-06 01:57:02 +00001224 return CoerceAvailableValueToLoadType(Val, LoadTy, InsertPt, TD);
1225 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001226
Chris Lattner778cb922009-12-06 05:29:56 +00001227 // Otherwise, this is a memcpy/memmove from a constant global.
1228 MemTransferInst *MTI = cast<MemTransferInst>(SrcInst);
1229 Constant *Src = cast<Constant>(MTI->getSource());
1230
1231 // Otherwise, see if we can constant fold a load from the constant with the
1232 // offset applied as appropriate.
1233 Src = ConstantExpr::getBitCast(Src,
1234 llvm::Type::getInt8PtrTy(Src->getContext()));
Nadav Rotem465834c2012-07-24 10:51:42 +00001235 Constant *OffsetCst =
Chris Lattner778cb922009-12-06 05:29:56 +00001236 ConstantInt::get(Type::getInt64Ty(Src->getContext()), (unsigned)Offset);
Jay Foaded8db7d2011-07-21 14:31:17 +00001237 Src = ConstantExpr::getGetElementPtr(Src, OffsetCst);
Chris Lattner778cb922009-12-06 05:29:56 +00001238 Src = ConstantExpr::getBitCast(Src, PointerType::getUnqual(LoadTy));
1239 return ConstantFoldLoadFromConstPtr(Src, &TD);
Chris Lattner42376062009-12-06 01:57:02 +00001240}
1241
Dan Gohmanb29cda92010-04-15 17:08:50 +00001242
Chris Lattnerb6c65fa2009-10-10 23:50:30 +00001243/// ConstructSSAForLoadSet - Given a set of loads specified by ValuesPerBlock,
1244/// construct SSA form, allowing us to eliminate LI. This returns the value
1245/// that should be used at LI's definition site.
Nadav Rotem465834c2012-07-24 10:51:42 +00001246static Value *ConstructSSAForLoadSet(LoadInst *LI,
Chris Lattnerb6c65fa2009-10-10 23:50:30 +00001247 SmallVectorImpl<AvailableValueInBlock> &ValuesPerBlock,
Chris Lattnerf81f7892011-04-28 16:36:48 +00001248 GVN &gvn) {
Chris Lattnerbf200182009-12-21 23:15:48 +00001249 // Check for the fully redundant, dominating load case. In this case, we can
1250 // just use the dominating value directly.
Nadav Rotem465834c2012-07-24 10:51:42 +00001251 if (ValuesPerBlock.size() == 1 &&
Chris Lattnerf81f7892011-04-28 16:36:48 +00001252 gvn.getDominatorTree().properlyDominates(ValuesPerBlock[0].BB,
1253 LI->getParent()))
1254 return ValuesPerBlock[0].MaterializeAdjustedValue(LI->getType(), gvn);
Chris Lattnerbf200182009-12-21 23:15:48 +00001255
1256 // Otherwise, we have to construct SSA form.
Chris Lattnerb6c65fa2009-10-10 23:50:30 +00001257 SmallVector<PHINode*, 8> NewPHIs;
1258 SSAUpdater SSAUpdate(&NewPHIs);
Duncan Sands67781492010-09-02 08:14:03 +00001259 SSAUpdate.Initialize(LI->getType(), LI->getName());
Nadav Rotem465834c2012-07-24 10:51:42 +00001260
Chris Lattner229907c2011-07-18 04:54:35 +00001261 Type *LoadTy = LI->getType();
Nadav Rotem465834c2012-07-24 10:51:42 +00001262
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001263 for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i) {
Chris Lattner93236ba2009-12-06 04:54:31 +00001264 const AvailableValueInBlock &AV = ValuesPerBlock[i];
1265 BasicBlock *BB = AV.BB;
Nadav Rotem465834c2012-07-24 10:51:42 +00001266
Chris Lattnerb6c65fa2009-10-10 23:50:30 +00001267 if (SSAUpdate.HasValueForBlock(BB))
1268 continue;
Chris Lattner93236ba2009-12-06 04:54:31 +00001269
Chris Lattnerf81f7892011-04-28 16:36:48 +00001270 SSAUpdate.AddAvailableValue(BB, AV.MaterializeAdjustedValue(LoadTy, gvn));
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001271 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001272
Chris Lattnerb6c65fa2009-10-10 23:50:30 +00001273 // Perform PHI construction.
1274 Value *V = SSAUpdate.GetValueInMiddleOfBlock(LI->getParent());
Nadav Rotem465834c2012-07-24 10:51:42 +00001275
Chris Lattnerb6c65fa2009-10-10 23:50:30 +00001276 // If new PHI nodes were created, notify alias analysis.
Hal Finkel69b07a22012-10-24 21:22:30 +00001277 if (V->getType()->getScalarType()->isPointerTy()) {
Chris Lattnerf81f7892011-04-28 16:36:48 +00001278 AliasAnalysis *AA = gvn.getAliasAnalysis();
Nadav Rotem465834c2012-07-24 10:51:42 +00001279
Chris Lattnerb6c65fa2009-10-10 23:50:30 +00001280 for (unsigned i = 0, e = NewPHIs.size(); i != e; ++i)
1281 AA->copyValue(LI, NewPHIs[i]);
Nadav Rotem465834c2012-07-24 10:51:42 +00001282
Owen Andersond62d3722011-01-03 23:51:43 +00001283 // Now that we've copied information to the new PHIs, scan through
1284 // them again and inform alias analysis that we've added potentially
1285 // escaping uses to any values that are operands to these PHIs.
1286 for (unsigned i = 0, e = NewPHIs.size(); i != e; ++i) {
1287 PHINode *P = NewPHIs[i];
Jay Foad372ad642011-06-20 14:18:48 +00001288 for (unsigned ii = 0, ee = P->getNumIncomingValues(); ii != ee; ++ii) {
1289 unsigned jj = PHINode::getOperandNumForIncomingValue(ii);
1290 AA->addEscapingUse(P->getOperandUse(jj));
1291 }
Owen Andersond62d3722011-01-03 23:51:43 +00001292 }
Chris Lattnerf81f7892011-04-28 16:36:48 +00001293 }
Chris Lattnerb6c65fa2009-10-10 23:50:30 +00001294
1295 return V;
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001296}
1297
Shuxin Yang637b9be2013-05-03 19:17:26 +00001298Value *AvailableValueInBlock::MaterializeAdjustedValue(Type *LoadTy, GVN &gvn) const {
1299 Value *Res;
1300 if (isSimpleValue()) {
1301 Res = getSimpleValue();
1302 if (Res->getType() != LoadTy) {
1303 const DataLayout *TD = gvn.getDataLayout();
1304 assert(TD && "Need target data to handle type mismatch case");
1305 Res = GetStoreValueForLoad(Res, Offset, LoadTy, BB->getTerminator(),
1306 *TD);
1307
1308 DEBUG(dbgs() << "GVN COERCED NONLOCAL VAL:\nOffset: " << Offset << " "
1309 << *getSimpleValue() << '\n'
1310 << *Res << '\n' << "\n\n\n");
1311 }
1312 } else if (isCoercedLoadValue()) {
1313 LoadInst *Load = getCoercedLoadValue();
1314 if (Load->getType() == LoadTy && Offset == 0) {
1315 Res = Load;
1316 } else {
1317 Res = GetLoadValueForLoad(Load, Offset, LoadTy, BB->getTerminator(),
1318 gvn);
1319
1320 DEBUG(dbgs() << "GVN COERCED NONLOCAL LOAD:\nOffset: " << Offset << " "
1321 << *getCoercedLoadValue() << '\n'
1322 << *Res << '\n' << "\n\n\n");
1323 }
1324 } else {
1325 const DataLayout *TD = gvn.getDataLayout();
1326 assert(TD && "Need target data to handle type mismatch case");
1327 Res = GetMemInstValueForLoad(getMemIntrinValue(), Offset,
1328 LoadTy, BB->getTerminator(), *TD);
1329 DEBUG(dbgs() << "GVN COERCED NONLOCAL MEM INTRIN:\nOffset: " << Offset
1330 << " " << *getMemIntrinValue() << '\n'
1331 << *Res << '\n' << "\n\n\n");
1332 }
1333 return Res;
1334}
1335
Gabor Greifce6dd882010-04-09 10:57:00 +00001336static bool isLifetimeStart(const Instruction *Inst) {
1337 if (const IntrinsicInst* II = dyn_cast<IntrinsicInst>(Inst))
Owen Andersonb9878ee2009-12-02 07:35:19 +00001338 return II->getIntrinsicID() == Intrinsic::lifetime_start;
Chris Lattnerc4680252009-12-02 06:44:58 +00001339 return false;
1340}
1341
Shuxin Yang637b9be2013-05-03 19:17:26 +00001342void GVN::AnalyzeLoadAvailability(LoadInst *LI, LoadDepVect &Deps,
1343 AvailValInBlkVect &ValuesPerBlock,
1344 UnavailBlkVect &UnavailableBlocks) {
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001345
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001346 // Filter out useless results (non-locals, etc). Keep track of the blocks
1347 // where we have a value available in repl, also keep track of whether we see
1348 // dependencies that produce an unknown value for the load (such as a call
1349 // that could potentially clobber the load).
Shuxin Yang637b9be2013-05-03 19:17:26 +00001350 unsigned NumDeps = Deps.size();
Bill Wendling8a333122012-01-31 06:57:53 +00001351 for (unsigned i = 0, e = NumDeps; i != e; ++i) {
Chris Lattner0c315472009-12-09 07:08:01 +00001352 BasicBlock *DepBB = Deps[i].getBB();
1353 MemDepResult DepInfo = Deps[i].getResult();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001354
Eli Friedmanc1702c82011-10-13 22:14:57 +00001355 if (!DepInfo.isDef() && !DepInfo.isClobber()) {
Eli Friedman7d58bc72011-06-15 00:47:34 +00001356 UnavailableBlocks.push_back(DepBB);
1357 continue;
1358 }
1359
Chris Lattner0e3d6332008-12-05 21:04:20 +00001360 if (DepInfo.isClobber()) {
Chris Lattnerca5f9cb2009-12-09 18:21:46 +00001361 // The address being loaded in this non-local block may not be the same as
1362 // the pointer operand of the load if PHI translation occurs. Make sure
1363 // to consider the right address.
1364 Value *Address = Deps[i].getAddress();
Nadav Rotem465834c2012-07-24 10:51:42 +00001365
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001366 // If the dependence is to a store that writes to a superset of the bits
1367 // read by the load, we can extract the bits we need for the load from the
1368 // stored value.
1369 if (StoreInst *DepSI = dyn_cast<StoreInst>(DepInfo.getInst())) {
Chris Lattnerca5f9cb2009-12-09 18:21:46 +00001370 if (TD && Address) {
1371 int Offset = AnalyzeLoadFromClobberingStore(LI->getType(), Address,
Chris Lattner07df9ef2009-12-09 07:37:07 +00001372 DepSI, *TD);
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001373 if (Offset != -1) {
1374 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
Dan Gohmand2099112010-11-10 19:03:33 +00001375 DepSI->getValueOperand(),
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001376 Offset));
1377 continue;
1378 }
1379 }
1380 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001381
Chris Lattner6f83d062011-04-26 01:21:15 +00001382 // Check to see if we have something like this:
1383 // load i32* P
1384 // load i8* (P+1)
1385 // if we have this, replace the later with an extraction from the former.
1386 if (LoadInst *DepLI = dyn_cast<LoadInst>(DepInfo.getInst())) {
1387 // If this is a clobber and L is the first instruction in its block, then
1388 // we have the first instruction in the entry block.
1389 if (DepLI != LI && Address && TD) {
1390 int Offset = AnalyzeLoadFromClobberingLoad(LI->getType(),
1391 LI->getPointerOperand(),
1392 DepLI, *TD);
Nadav Rotem465834c2012-07-24 10:51:42 +00001393
Chris Lattner6f83d062011-04-26 01:21:15 +00001394 if (Offset != -1) {
Chris Lattner827a2702011-04-28 07:29:08 +00001395 ValuesPerBlock.push_back(AvailableValueInBlock::getLoad(DepBB,DepLI,
1396 Offset));
Chris Lattner6f83d062011-04-26 01:21:15 +00001397 continue;
1398 }
1399 }
1400 }
Chris Lattner42376062009-12-06 01:57:02 +00001401
Chris Lattner42376062009-12-06 01:57:02 +00001402 // If the clobbering value is a memset/memcpy/memmove, see if we can
1403 // forward a value on from it.
Chris Lattner93236ba2009-12-06 04:54:31 +00001404 if (MemIntrinsic *DepMI = dyn_cast<MemIntrinsic>(DepInfo.getInst())) {
Chris Lattnerca5f9cb2009-12-09 18:21:46 +00001405 if (TD && Address) {
1406 int Offset = AnalyzeLoadFromClobberingMemInst(LI->getType(), Address,
Chris Lattner07df9ef2009-12-09 07:37:07 +00001407 DepMI, *TD);
Chris Lattner93236ba2009-12-06 04:54:31 +00001408 if (Offset != -1) {
1409 ValuesPerBlock.push_back(AvailableValueInBlock::getMI(DepBB, DepMI,
1410 Offset));
1411 continue;
Nadav Rotem465834c2012-07-24 10:51:42 +00001412 }
Chris Lattner42376062009-12-06 01:57:02 +00001413 }
1414 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001415
Chris Lattner0e3d6332008-12-05 21:04:20 +00001416 UnavailableBlocks.push_back(DepBB);
1417 continue;
1418 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001419
Eli Friedmanc1702c82011-10-13 22:14:57 +00001420 // DepInfo.isDef() here
Eli Friedman7d58bc72011-06-15 00:47:34 +00001421
Chris Lattner0e3d6332008-12-05 21:04:20 +00001422 Instruction *DepInst = DepInfo.getInst();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001423
Chris Lattner0e3d6332008-12-05 21:04:20 +00001424 // Loading the allocation -> undef.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001425 if (isa<AllocaInst>(DepInst) || isMallocLikeFn(DepInst, TLI) ||
Owen Andersonb9878ee2009-12-02 07:35:19 +00001426 // Loading immediately after lifetime begin -> undef.
1427 isLifetimeStart(DepInst)) {
Chris Lattner0cdc17e2009-09-21 06:30:24 +00001428 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
1429 UndefValue::get(LI->getType())));
Chris Lattner7e61daf2008-12-01 01:15:42 +00001430 continue;
1431 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001432
Chris Lattner0cdc17e2009-09-21 06:30:24 +00001433 if (StoreInst *S = dyn_cast<StoreInst>(DepInst)) {
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001434 // Reject loads and stores that are to the same address but are of
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001435 // different types if we have to.
Dan Gohmand2099112010-11-10 19:03:33 +00001436 if (S->getValueOperand()->getType() != LI->getType()) {
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001437 // If the stored value is larger or equal to the loaded value, we can
1438 // reuse it.
Dan Gohmand2099112010-11-10 19:03:33 +00001439 if (TD == 0 || !CanCoerceMustAliasedValueToLoad(S->getValueOperand(),
Chris Lattner9045f232009-09-21 17:24:04 +00001440 LI->getType(), *TD)) {
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001441 UnavailableBlocks.push_back(DepBB);
1442 continue;
1443 }
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001444 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001445
Chris Lattner0cdc17e2009-09-21 06:30:24 +00001446 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
Dan Gohmand2099112010-11-10 19:03:33 +00001447 S->getValueOperand()));
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001448 continue;
1449 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001450
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001451 if (LoadInst *LD = dyn_cast<LoadInst>(DepInst)) {
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001452 // If the types mismatch and we can't handle it, reject reuse of the load.
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001453 if (LD->getType() != LI->getType()) {
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001454 // If the stored value is larger or equal to the loaded value, we can
1455 // reuse it.
Chris Lattner9045f232009-09-21 17:24:04 +00001456 if (TD == 0 || !CanCoerceMustAliasedValueToLoad(LD, LI->getType(),*TD)){
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001457 UnavailableBlocks.push_back(DepBB);
1458 continue;
Nadav Rotem465834c2012-07-24 10:51:42 +00001459 }
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001460 }
Chris Lattner827a2702011-04-28 07:29:08 +00001461 ValuesPerBlock.push_back(AvailableValueInBlock::getLoad(DepBB, LD));
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001462 continue;
Owen Anderson5e5599b2007-07-25 19:57:03 +00001463 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001464
Chris Lattner4d8af2f2009-09-21 06:48:08 +00001465 UnavailableBlocks.push_back(DepBB);
Chris Lattner2876a642008-03-21 21:14:38 +00001466 }
Shuxin Yang637b9be2013-05-03 19:17:26 +00001467}
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001468
Shuxin Yang637b9be2013-05-03 19:17:26 +00001469bool GVN::PerformLoadPRE(LoadInst *LI, AvailValInBlkVect &ValuesPerBlock,
1470 UnavailBlkVect &UnavailableBlocks) {
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001471 // Okay, we have *some* definitions of the value. This means that the value
1472 // is available in some of our (transitive) predecessors. Lets think about
1473 // doing PRE of this load. This will involve inserting a new load into the
1474 // predecessor when it's not available. We could do this in general, but
1475 // prefer to not increase code size. As such, we only do this when we know
1476 // that we only have to insert *one* load (which means we're basically moving
1477 // the load, not inserting a new one).
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001478
Owen Andersoncc0c75c2009-05-31 09:03:40 +00001479 SmallPtrSet<BasicBlock *, 4> Blockers;
1480 for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1481 Blockers.insert(UnavailableBlocks[i]);
1482
Bill Wendling8bbcbed2011-08-17 21:32:02 +00001483 // Let's find the first basic block with more than one predecessor. Walk
1484 // backwards through predecessors if needed.
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001485 BasicBlock *LoadBB = LI->getParent();
Owen Andersoncc0c75c2009-05-31 09:03:40 +00001486 BasicBlock *TmpBB = LoadBB;
1487
Owen Andersoncc0c75c2009-05-31 09:03:40 +00001488 while (TmpBB->getSinglePredecessor()) {
Owen Andersoncc0c75c2009-05-31 09:03:40 +00001489 TmpBB = TmpBB->getSinglePredecessor();
Owen Andersoncc0c75c2009-05-31 09:03:40 +00001490 if (TmpBB == LoadBB) // Infinite (unreachable) loop.
1491 return false;
1492 if (Blockers.count(TmpBB))
1493 return false;
Nadav Rotem465834c2012-07-24 10:51:42 +00001494
Owen Andersonb590a922010-09-25 05:26:18 +00001495 // If any of these blocks has more than one successor (i.e. if the edge we
Nadav Rotem465834c2012-07-24 10:51:42 +00001496 // just traversed was critical), then there are other paths through this
1497 // block along which the load may not be anticipated. Hoisting the load
Owen Andersonb590a922010-09-25 05:26:18 +00001498 // above this block would be adding the load to execution paths along
1499 // which it was not previously executed.
Dale Johannesen81b64632009-06-17 20:48:23 +00001500 if (TmpBB->getTerminator()->getNumSuccessors() != 1)
Owen Andersonb590a922010-09-25 05:26:18 +00001501 return false;
Owen Andersoncc0c75c2009-05-31 09:03:40 +00001502 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001503
Owen Andersoncc0c75c2009-05-31 09:03:40 +00001504 assert(TmpBB);
1505 LoadBB = TmpBB;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001506
Bob Wilsond517b522010-02-01 21:17:14 +00001507 // Check to see how many predecessors have the loaded value fully
1508 // available.
1509 DenseMap<BasicBlock*, Value*> PredLoads;
Chris Lattnerd2a653a2008-12-05 07:49:08 +00001510 DenseMap<BasicBlock*, char> FullyAvailableBlocks;
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001511 for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i)
Chris Lattner0cdc17e2009-09-21 06:30:24 +00001512 FullyAvailableBlocks[ValuesPerBlock[i].BB] = true;
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001513 for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1514 FullyAvailableBlocks[UnavailableBlocks[i]] = false;
1515
Bob Wilsona2fda8b2010-05-04 20:03:21 +00001516 SmallVector<std::pair<TerminatorInst*, unsigned>, 4> NeedToSplit;
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001517 for (pred_iterator PI = pred_begin(LoadBB), E = pred_end(LoadBB);
1518 PI != E; ++PI) {
Bob Wilsond517b522010-02-01 21:17:14 +00001519 BasicBlock *Pred = *PI;
Mon P Wang6120cfb2012-04-27 18:09:28 +00001520 if (IsValueFullyAvailableInBlock(Pred, FullyAvailableBlocks, 0)) {
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001521 continue;
Bob Wilsond517b522010-02-01 21:17:14 +00001522 }
1523 PredLoads[Pred] = 0;
Bob Wilson92cdb6e2010-02-16 19:51:59 +00001524
Bob Wilsond517b522010-02-01 21:17:14 +00001525 if (Pred->getTerminator()->getNumSuccessors() != 1) {
Bob Wilson92cdb6e2010-02-16 19:51:59 +00001526 if (isa<IndirectBrInst>(Pred->getTerminator())) {
1527 DEBUG(dbgs() << "COULD NOT PRE LOAD BECAUSE OF INDBR CRITICAL EDGE '"
1528 << Pred->getName() << "': " << *LI << '\n');
1529 return false;
1530 }
Bill Wendling8bbcbed2011-08-17 21:32:02 +00001531
1532 if (LoadBB->isLandingPad()) {
1533 DEBUG(dbgs()
1534 << "COULD NOT PRE LOAD BECAUSE OF LANDING PAD CRITICAL EDGE '"
1535 << Pred->getName() << "': " << *LI << '\n');
1536 return false;
1537 }
1538
Bob Wilsonaff96b22010-02-16 21:06:42 +00001539 unsigned SuccNum = GetSuccessorNumber(Pred, LoadBB);
Bob Wilsona2fda8b2010-05-04 20:03:21 +00001540 NeedToSplit.push_back(std::make_pair(Pred->getTerminator(), SuccNum));
Bob Wilsond517b522010-02-01 21:17:14 +00001541 }
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001542 }
Bill Wendling8bbcbed2011-08-17 21:32:02 +00001543
Bob Wilsona2fda8b2010-05-04 20:03:21 +00001544 if (!NeedToSplit.empty()) {
Bob Wilson0c8b29b2010-05-05 20:44:15 +00001545 toSplit.append(NeedToSplit.begin(), NeedToSplit.end());
Bob Wilson892432b2010-03-01 23:37:32 +00001546 return false;
Bob Wilsona2fda8b2010-05-04 20:03:21 +00001547 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001548
Bob Wilsond517b522010-02-01 21:17:14 +00001549 // Decide whether PRE is profitable for this load.
1550 unsigned NumUnavailablePreds = PredLoads.size();
1551 assert(NumUnavailablePreds != 0 &&
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001552 "Fully available value should be eliminated above!");
Nadav Rotem465834c2012-07-24 10:51:42 +00001553
Owen Anderson13a642d2010-10-01 20:02:55 +00001554 // If this load is unavailable in multiple predecessors, reject it.
1555 // FIXME: If we could restructure the CFG, we could make a common pred with
1556 // all the preds that don't have an available LI and insert a new load into
1557 // that one block.
1558 if (NumUnavailablePreds != 1)
Bob Wilsond517b522010-02-01 21:17:14 +00001559 return false;
Bob Wilsond517b522010-02-01 21:17:14 +00001560
1561 // Check if the load can safely be moved to all the unavailable predecessors.
1562 bool CanDoPRE = true;
Chris Lattner44da5bd2009-11-28 15:39:14 +00001563 SmallVector<Instruction*, 8> NewInsts;
Bob Wilsond517b522010-02-01 21:17:14 +00001564 for (DenseMap<BasicBlock*, Value*>::iterator I = PredLoads.begin(),
1565 E = PredLoads.end(); I != E; ++I) {
1566 BasicBlock *UnavailablePred = I->first;
1567
1568 // Do PHI translation to get its value in the predecessor if necessary. The
1569 // returned pointer (if non-null) is guaranteed to dominate UnavailablePred.
1570
1571 // If all preds have a single successor, then we know it is safe to insert
1572 // the load on the pred (?!?), so we can insert code to materialize the
1573 // pointer if it is not available.
Dan Gohmand2099112010-11-10 19:03:33 +00001574 PHITransAddr Address(LI->getPointerOperand(), TD);
Bob Wilsond517b522010-02-01 21:17:14 +00001575 Value *LoadPtr = 0;
Shuxin Yangaf2c3dd2013-05-02 21:14:31 +00001576 LoadPtr = Address.PHITranslateWithInsertion(LoadBB, UnavailablePred,
1577 *DT, NewInsts);
Bob Wilsond517b522010-02-01 21:17:14 +00001578
1579 // If we couldn't find or insert a computation of this phi translated value,
1580 // we fail PRE.
1581 if (LoadPtr == 0) {
1582 DEBUG(dbgs() << "COULDN'T INSERT PHI TRANSLATED VALUE OF: "
Dan Gohmand2099112010-11-10 19:03:33 +00001583 << *LI->getPointerOperand() << "\n");
Bob Wilsond517b522010-02-01 21:17:14 +00001584 CanDoPRE = false;
1585 break;
1586 }
1587
Bob Wilsond517b522010-02-01 21:17:14 +00001588 I->second = LoadPtr;
Chris Lattner972e6d82009-12-09 01:59:31 +00001589 }
1590
Bob Wilsond517b522010-02-01 21:17:14 +00001591 if (!CanDoPRE) {
Chris Lattner193ce7c2011-01-11 08:19:16 +00001592 while (!NewInsts.empty()) {
1593 Instruction *I = NewInsts.pop_back_val();
1594 if (MD) MD->removeInstruction(I);
1595 I->eraseFromParent();
1596 }
Dale Johannesen81b64632009-06-17 20:48:23 +00001597 return false;
Chris Lattner32140312009-11-28 16:08:18 +00001598 }
Dale Johannesen81b64632009-06-17 20:48:23 +00001599
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001600 // Okay, we can eliminate this load by inserting a reload in the predecessor
1601 // and using PHI construction to get the value in the other predecessors, do
1602 // it.
David Greene2e6efc42010-01-05 01:27:17 +00001603 DEBUG(dbgs() << "GVN REMOVING PRE LOAD: " << *LI << '\n');
Chris Lattner32140312009-11-28 16:08:18 +00001604 DEBUG(if (!NewInsts.empty())
David Greene2e6efc42010-01-05 01:27:17 +00001605 dbgs() << "INSERTED " << NewInsts.size() << " INSTS: "
Chris Lattner32140312009-11-28 16:08:18 +00001606 << *NewInsts.back() << '\n');
Nadav Rotem465834c2012-07-24 10:51:42 +00001607
Bob Wilsond517b522010-02-01 21:17:14 +00001608 // Assign value numbers to the new instructions.
1609 for (unsigned i = 0, e = NewInsts.size(); i != e; ++i) {
Nadav Rotem465834c2012-07-24 10:51:42 +00001610 // FIXME: We really _ought_ to insert these value numbers into their
Bob Wilsond517b522010-02-01 21:17:14 +00001611 // parent's availability map. However, in doing so, we risk getting into
1612 // ordering issues. If a block hasn't been processed yet, we would be
1613 // marking a value as AVAIL-IN, which isn't what we intend.
1614 VN.lookup_or_add(NewInsts[i]);
1615 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001616
Bob Wilsond517b522010-02-01 21:17:14 +00001617 for (DenseMap<BasicBlock*, Value*>::iterator I = PredLoads.begin(),
1618 E = PredLoads.end(); I != E; ++I) {
1619 BasicBlock *UnavailablePred = I->first;
1620 Value *LoadPtr = I->second;
1621
Dan Gohman4467aa52010-12-15 23:53:55 +00001622 Instruction *NewLoad = new LoadInst(LoadPtr, LI->getName()+".pre", false,
1623 LI->getAlignment(),
1624 UnavailablePred->getTerminator());
1625
1626 // Transfer the old load's TBAA tag to the new load.
1627 if (MDNode *Tag = LI->getMetadata(LLVMContext::MD_tbaa))
1628 NewLoad->setMetadata(LLVMContext::MD_tbaa, Tag);
Bob Wilsond517b522010-02-01 21:17:14 +00001629
Devang Patelc5933f22011-05-17 19:43:38 +00001630 // Transfer DebugLoc.
1631 NewLoad->setDebugLoc(LI->getDebugLoc());
1632
Bob Wilsond517b522010-02-01 21:17:14 +00001633 // Add the newly created load.
1634 ValuesPerBlock.push_back(AvailableValueInBlock::get(UnavailablePred,
1635 NewLoad));
Bob Wilson923261b2010-02-23 05:55:00 +00001636 MD->invalidateCachedPointerInfo(LoadPtr);
1637 DEBUG(dbgs() << "GVN INSERTED " << *NewLoad << '\n');
Bob Wilsond517b522010-02-01 21:17:14 +00001638 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001639
Chris Lattner1db9bbe2008-12-02 08:16:11 +00001640 // Perform PHI construction.
Chris Lattnerf81f7892011-04-28 16:36:48 +00001641 Value *V = ConstructSSAForLoadSet(LI, ValuesPerBlock, *this);
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001642 LI->replaceAllUsesWith(V);
1643 if (isa<PHINode>(V))
1644 V->takeName(LI);
Hal Finkel69b07a22012-10-24 21:22:30 +00001645 if (V->getType()->getScalarType()->isPointerTy())
Chris Lattnera0aa8fb2009-09-20 20:09:34 +00001646 MD->invalidateCachedPointerInfo(V);
Chris Lattnerf81f7892011-04-28 16:36:48 +00001647 markInstructionForDeletion(LI);
Dan Gohmand2d1ae12010-06-22 15:08:57 +00001648 ++NumPRELoad;
Owen Anderson5e5599b2007-07-25 19:57:03 +00001649 return true;
1650}
1651
Shuxin Yang637b9be2013-05-03 19:17:26 +00001652/// processNonLocalLoad - Attempt to eliminate a load whose dependencies are
1653/// non-local by performing PHI construction.
1654bool GVN::processNonLocalLoad(LoadInst *LI) {
1655 // Step 1: Find the non-local dependencies of the load.
1656 LoadDepVect Deps;
1657 AliasAnalysis::Location Loc = VN.getAliasAnalysis()->getLocation(LI);
1658 MD->getNonLocalPointerDependency(Loc, true, LI->getParent(), Deps);
1659
1660 // If we had to process more than one hundred blocks to find the
1661 // dependencies, this load isn't worth worrying about. Optimizing
1662 // it will be too expensive.
1663 unsigned NumDeps = Deps.size();
1664 if (NumDeps > 100)
1665 return false;
1666
1667 // If we had a phi translation failure, we'll have a single entry which is a
1668 // clobber in the current block. Reject this early.
1669 if (NumDeps == 1 &&
1670 !Deps[0].getResult().isDef() && !Deps[0].getResult().isClobber()) {
1671 DEBUG(
1672 dbgs() << "GVN: non-local load ";
1673 WriteAsOperand(dbgs(), LI);
1674 dbgs() << " has unknown dependencies\n";
1675 );
1676 return false;
1677 }
1678
1679 // Step 2: Analyze the availability of the load
1680 AvailValInBlkVect ValuesPerBlock;
1681 UnavailBlkVect UnavailableBlocks;
1682 AnalyzeLoadAvailability(LI, Deps, ValuesPerBlock, UnavailableBlocks);
1683
1684 // If we have no predecessors that produce a known value for this load, exit
1685 // early.
1686 if (ValuesPerBlock.empty())
1687 return false;
1688
1689 // Step 3: Eliminate fully redundancy.
1690 //
1691 // If all of the instructions we depend on produce a known value for this
1692 // load, then it is fully redundant and we can use PHI insertion to compute
1693 // its value. Insert PHIs and remove the fully redundant value now.
1694 if (UnavailableBlocks.empty()) {
1695 DEBUG(dbgs() << "GVN REMOVING NONLOCAL LOAD: " << *LI << '\n');
1696
1697 // Perform PHI construction.
1698 Value *V = ConstructSSAForLoadSet(LI, ValuesPerBlock, *this);
1699 LI->replaceAllUsesWith(V);
1700
1701 if (isa<PHINode>(V))
1702 V->takeName(LI);
1703 if (V->getType()->getScalarType()->isPointerTy())
1704 MD->invalidateCachedPointerInfo(V);
1705 markInstructionForDeletion(LI);
1706 ++NumGVNLoad;
1707 return true;
1708 }
1709
1710 // Step 4: Eliminate partial redundancy.
1711 if (!EnablePRE || !EnableLoadPRE)
1712 return false;
1713
1714 return PerformLoadPRE(LI, ValuesPerBlock, UnavailableBlocks);
1715}
1716
1717
Dan Gohman00253592013-03-12 16:22:56 +00001718static void patchReplacementInstruction(Instruction *I, Value *Repl) {
Rafael Espindola47d988c2012-06-04 22:44:21 +00001719 // Patch the replacement so that it is not more restrictive than the value
1720 // being replaced.
1721 BinaryOperator *Op = dyn_cast<BinaryOperator>(I);
1722 BinaryOperator *ReplOp = dyn_cast<BinaryOperator>(Repl);
1723 if (Op && ReplOp && isa<OverflowingBinaryOperator>(Op) &&
1724 isa<OverflowingBinaryOperator>(ReplOp)) {
1725 if (ReplOp->hasNoSignedWrap() && !Op->hasNoSignedWrap())
1726 ReplOp->setHasNoSignedWrap(false);
1727 if (ReplOp->hasNoUnsignedWrap() && !Op->hasNoUnsignedWrap())
1728 ReplOp->setHasNoUnsignedWrap(false);
1729 }
1730 if (Instruction *ReplInst = dyn_cast<Instruction>(Repl)) {
1731 SmallVector<std::pair<unsigned, MDNode*>, 4> Metadata;
1732 ReplInst->getAllMetadataOtherThanDebugLoc(Metadata);
1733 for (int i = 0, n = Metadata.size(); i < n; ++i) {
1734 unsigned Kind = Metadata[i].first;
1735 MDNode *IMD = I->getMetadata(Kind);
1736 MDNode *ReplMD = Metadata[i].second;
1737 switch(Kind) {
1738 default:
1739 ReplInst->setMetadata(Kind, NULL); // Remove unknown metadata
1740 break;
1741 case LLVMContext::MD_dbg:
1742 llvm_unreachable("getAllMetadataOtherThanDebugLoc returned a MD_dbg");
1743 case LLVMContext::MD_tbaa:
Hal Finkel16ddd4b2012-06-16 20:33:37 +00001744 ReplInst->setMetadata(Kind, MDNode::getMostGenericTBAA(IMD, ReplMD));
Rafael Espindola47d988c2012-06-04 22:44:21 +00001745 break;
1746 case LLVMContext::MD_range:
Hal Finkel16ddd4b2012-06-16 20:33:37 +00001747 ReplInst->setMetadata(Kind, MDNode::getMostGenericRange(IMD, ReplMD));
Rafael Espindola47d988c2012-06-04 22:44:21 +00001748 break;
1749 case LLVMContext::MD_prof:
1750 llvm_unreachable("MD_prof in a non terminator instruction");
1751 break;
1752 case LLVMContext::MD_fpmath:
Hal Finkel16ddd4b2012-06-16 20:33:37 +00001753 ReplInst->setMetadata(Kind, MDNode::getMostGenericFPMath(IMD, ReplMD));
Rafael Espindola47d988c2012-06-04 22:44:21 +00001754 break;
1755 }
1756 }
1757 }
1758}
1759
Dan Gohman00253592013-03-12 16:22:56 +00001760static void patchAndReplaceAllUsesWith(Instruction *I, Value *Repl) {
1761 patchReplacementInstruction(I, Repl);
Rafael Espindola47d988c2012-06-04 22:44:21 +00001762 I->replaceAllUsesWith(Repl);
1763}
1764
Owen Anderson221a4362007-08-16 22:02:55 +00001765/// processLoad - Attempt to eliminate a load, first by eliminating it
1766/// locally, and then attempting non-local elimination if that fails.
Chris Lattner6cec6ab2011-04-28 16:18:52 +00001767bool GVN::processLoad(LoadInst *L) {
Dan Gohman81132462009-11-14 02:27:51 +00001768 if (!MD)
1769 return false;
1770
Eli Friedman9a468152011-08-17 22:22:24 +00001771 if (!L->isSimple())
Owen Andersonab6ec2e2007-07-24 17:55:58 +00001772 return false;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001773
Chris Lattnerf0d59072011-05-22 07:03:34 +00001774 if (L->use_empty()) {
1775 markInstructionForDeletion(L);
1776 return true;
1777 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001778
Owen Andersonab6ec2e2007-07-24 17:55:58 +00001779 // ... to a pointer that has been loaded from before...
Chris Lattner1eefa9c2009-09-21 02:42:51 +00001780 MemDepResult Dep = MD->getDependency(L);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001781
Chris Lattner6f83d062011-04-26 01:21:15 +00001782 // If we have a clobber and target data is around, see if this is a clobber
1783 // that we can fix up through code synthesis.
1784 if (Dep.isClobber() && TD) {
Chris Lattner0a9616d2009-09-21 05:57:11 +00001785 // Check to see if we have something like this:
Chris Lattner1dd48c32009-09-20 19:03:47 +00001786 // store i32 123, i32* %P
1787 // %A = bitcast i32* %P to i8*
1788 // %B = gep i8* %A, i32 1
1789 // %C = load i8* %B
1790 //
1791 // We could do that by recognizing if the clobber instructions are obviously
1792 // a common base + constant offset, and if the previous store (or memset)
1793 // completely covers this load. This sort of thing can happen in bitfield
1794 // access code.
Chris Lattner42376062009-12-06 01:57:02 +00001795 Value *AvailVal = 0;
Chris Lattner6f83d062011-04-26 01:21:15 +00001796 if (StoreInst *DepSI = dyn_cast<StoreInst>(Dep.getInst())) {
1797 int Offset = AnalyzeLoadFromClobberingStore(L->getType(),
1798 L->getPointerOperand(),
1799 DepSI, *TD);
1800 if (Offset != -1)
1801 AvailVal = GetStoreValueForLoad(DepSI->getValueOperand(), Offset,
1802 L->getType(), L, *TD);
1803 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001804
Chris Lattner6f83d062011-04-26 01:21:15 +00001805 // Check to see if we have something like this:
1806 // load i32* P
1807 // load i8* (P+1)
1808 // if we have this, replace the later with an extraction from the former.
1809 if (LoadInst *DepLI = dyn_cast<LoadInst>(Dep.getInst())) {
1810 // If this is a clobber and L is the first instruction in its block, then
1811 // we have the first instruction in the entry block.
1812 if (DepLI == L)
1813 return false;
Nadav Rotem465834c2012-07-24 10:51:42 +00001814
Chris Lattner6f83d062011-04-26 01:21:15 +00001815 int Offset = AnalyzeLoadFromClobberingLoad(L->getType(),
1816 L->getPointerOperand(),
1817 DepLI, *TD);
1818 if (Offset != -1)
Chris Lattnerf81f7892011-04-28 16:36:48 +00001819 AvailVal = GetLoadValueForLoad(DepLI, Offset, L->getType(), L, *this);
Chris Lattner6f83d062011-04-26 01:21:15 +00001820 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001821
Chris Lattner42376062009-12-06 01:57:02 +00001822 // If the clobbering value is a memset/memcpy/memmove, see if we can forward
1823 // a value on from it.
1824 if (MemIntrinsic *DepMI = dyn_cast<MemIntrinsic>(Dep.getInst())) {
Chris Lattner6f83d062011-04-26 01:21:15 +00001825 int Offset = AnalyzeLoadFromClobberingMemInst(L->getType(),
1826 L->getPointerOperand(),
1827 DepMI, *TD);
1828 if (Offset != -1)
1829 AvailVal = GetMemInstValueForLoad(DepMI, Offset, L->getType(), L, *TD);
Chris Lattner42376062009-12-06 01:57:02 +00001830 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001831
Chris Lattner42376062009-12-06 01:57:02 +00001832 if (AvailVal) {
David Greene2e6efc42010-01-05 01:27:17 +00001833 DEBUG(dbgs() << "GVN COERCED INST:\n" << *Dep.getInst() << '\n'
Chris Lattner42376062009-12-06 01:57:02 +00001834 << *AvailVal << '\n' << *L << "\n\n\n");
Nadav Rotem465834c2012-07-24 10:51:42 +00001835
Chris Lattner42376062009-12-06 01:57:02 +00001836 // Replace the load!
1837 L->replaceAllUsesWith(AvailVal);
Hal Finkel69b07a22012-10-24 21:22:30 +00001838 if (AvailVal->getType()->getScalarType()->isPointerTy())
Chris Lattner42376062009-12-06 01:57:02 +00001839 MD->invalidateCachedPointerInfo(AvailVal);
Chris Lattnerf81f7892011-04-28 16:36:48 +00001840 markInstructionForDeletion(L);
Dan Gohmand2d1ae12010-06-22 15:08:57 +00001841 ++NumGVNLoad;
Chris Lattner42376062009-12-06 01:57:02 +00001842 return true;
1843 }
Chris Lattner6f83d062011-04-26 01:21:15 +00001844 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001845
Chris Lattner6f83d062011-04-26 01:21:15 +00001846 // If the value isn't available, don't do anything!
1847 if (Dep.isClobber()) {
Torok Edwin72070282009-05-29 09:46:03 +00001848 DEBUG(
Chris Lattner6f83d062011-04-26 01:21:15 +00001849 // fast print dep, using operator<< on instruction is too slow.
David Greene2e6efc42010-01-05 01:27:17 +00001850 dbgs() << "GVN: load ";
1851 WriteAsOperand(dbgs(), L);
Chris Lattner1eefa9c2009-09-21 02:42:51 +00001852 Instruction *I = Dep.getInst();
David Greene2e6efc42010-01-05 01:27:17 +00001853 dbgs() << " is clobbered by " << *I << '\n';
Torok Edwin72070282009-05-29 09:46:03 +00001854 );
Chris Lattner0e3d6332008-12-05 21:04:20 +00001855 return false;
Torok Edwin72070282009-05-29 09:46:03 +00001856 }
Chris Lattner0e3d6332008-12-05 21:04:20 +00001857
Eli Friedmanc1702c82011-10-13 22:14:57 +00001858 // If it is defined in another block, try harder.
1859 if (Dep.isNonLocal())
1860 return processNonLocalLoad(L);
1861
1862 if (!Dep.isDef()) {
Eli Friedman7d58bc72011-06-15 00:47:34 +00001863 DEBUG(
1864 // fast print dep, using operator<< on instruction is too slow.
1865 dbgs() << "GVN: load ";
1866 WriteAsOperand(dbgs(), L);
1867 dbgs() << " has unknown dependence\n";
1868 );
1869 return false;
1870 }
1871
Chris Lattner1eefa9c2009-09-21 02:42:51 +00001872 Instruction *DepInst = Dep.getInst();
Chris Lattner0e3d6332008-12-05 21:04:20 +00001873 if (StoreInst *DepSI = dyn_cast<StoreInst>(DepInst)) {
Dan Gohmand2099112010-11-10 19:03:33 +00001874 Value *StoredVal = DepSI->getValueOperand();
Nadav Rotem465834c2012-07-24 10:51:42 +00001875
Chris Lattner1dd48c32009-09-20 19:03:47 +00001876 // The store and load are to a must-aliased pointer, but they may not
1877 // actually have the same type. See if we know how to reuse the stored
1878 // value (depending on its type).
Chris Lattner8ed7bef2009-10-21 04:11:19 +00001879 if (StoredVal->getType() != L->getType()) {
Duncan Sands246b71c2010-11-12 21:10:24 +00001880 if (TD) {
Chris Lattner8ed7bef2009-10-21 04:11:19 +00001881 StoredVal = CoerceAvailableValueToLoadType(StoredVal, L->getType(),
1882 L, *TD);
1883 if (StoredVal == 0)
1884 return false;
Nadav Rotem465834c2012-07-24 10:51:42 +00001885
David Greene2e6efc42010-01-05 01:27:17 +00001886 DEBUG(dbgs() << "GVN COERCED STORE:\n" << *DepSI << '\n' << *StoredVal
Chris Lattner8ed7bef2009-10-21 04:11:19 +00001887 << '\n' << *L << "\n\n\n");
1888 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001889 else
Chris Lattner1dd48c32009-09-20 19:03:47 +00001890 return false;
Chris Lattner1dd48c32009-09-20 19:03:47 +00001891 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001892
Chris Lattner0e3d6332008-12-05 21:04:20 +00001893 // Remove it!
Chris Lattner1dd48c32009-09-20 19:03:47 +00001894 L->replaceAllUsesWith(StoredVal);
Hal Finkel69b07a22012-10-24 21:22:30 +00001895 if (StoredVal->getType()->getScalarType()->isPointerTy())
Chris Lattner1dd48c32009-09-20 19:03:47 +00001896 MD->invalidateCachedPointerInfo(StoredVal);
Chris Lattnerf81f7892011-04-28 16:36:48 +00001897 markInstructionForDeletion(L);
Dan Gohmand2d1ae12010-06-22 15:08:57 +00001898 ++NumGVNLoad;
Chris Lattner0e3d6332008-12-05 21:04:20 +00001899 return true;
1900 }
1901
1902 if (LoadInst *DepLI = dyn_cast<LoadInst>(DepInst)) {
Chris Lattner1dd48c32009-09-20 19:03:47 +00001903 Value *AvailableVal = DepLI;
Nadav Rotem465834c2012-07-24 10:51:42 +00001904
Chris Lattner1dd48c32009-09-20 19:03:47 +00001905 // The loads are of a must-aliased pointer, but they may not actually have
1906 // the same type. See if we know how to reuse the previously loaded value
1907 // (depending on its type).
Chris Lattner8ed7bef2009-10-21 04:11:19 +00001908 if (DepLI->getType() != L->getType()) {
Duncan Sands246b71c2010-11-12 21:10:24 +00001909 if (TD) {
Chris Lattner6f83d062011-04-26 01:21:15 +00001910 AvailableVal = CoerceAvailableValueToLoadType(DepLI, L->getType(),
1911 L, *TD);
Chris Lattner8ed7bef2009-10-21 04:11:19 +00001912 if (AvailableVal == 0)
1913 return false;
Nadav Rotem465834c2012-07-24 10:51:42 +00001914
David Greene2e6efc42010-01-05 01:27:17 +00001915 DEBUG(dbgs() << "GVN COERCED LOAD:\n" << *DepLI << "\n" << *AvailableVal
Chris Lattner8ed7bef2009-10-21 04:11:19 +00001916 << "\n" << *L << "\n\n\n");
1917 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001918 else
Chris Lattner8ed7bef2009-10-21 04:11:19 +00001919 return false;
Chris Lattner1dd48c32009-09-20 19:03:47 +00001920 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001921
Chris Lattner0e3d6332008-12-05 21:04:20 +00001922 // Remove it!
Dan Gohman00253592013-03-12 16:22:56 +00001923 patchAndReplaceAllUsesWith(L, AvailableVal);
Hal Finkel69b07a22012-10-24 21:22:30 +00001924 if (DepLI->getType()->getScalarType()->isPointerTy())
Chris Lattnerfa9f99a2008-12-09 22:06:23 +00001925 MD->invalidateCachedPointerInfo(DepLI);
Chris Lattnerf81f7892011-04-28 16:36:48 +00001926 markInstructionForDeletion(L);
Dan Gohmand2d1ae12010-06-22 15:08:57 +00001927 ++NumGVNLoad;
Chris Lattner0e3d6332008-12-05 21:04:20 +00001928 return true;
1929 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001930
Chris Lattner3ff6d012008-11-30 01:39:32 +00001931 // If this load really doesn't depend on anything, then we must be loading an
1932 // undef value. This can happen when loading for a fresh allocation with no
1933 // intervening stores, for example.
Benjamin Kramer8bcc9712012-08-29 15:32:21 +00001934 if (isa<AllocaInst>(DepInst) || isMallocLikeFn(DepInst, TLI)) {
Owen Andersonb292b8c2009-07-30 23:03:37 +00001935 L->replaceAllUsesWith(UndefValue::get(L->getType()));
Chris Lattnerf81f7892011-04-28 16:36:48 +00001936 markInstructionForDeletion(L);
Dan Gohmand2d1ae12010-06-22 15:08:57 +00001937 ++NumGVNLoad;
Chris Lattner0e3d6332008-12-05 21:04:20 +00001938 return true;
Eli Friedman716c10c2008-02-12 12:08:14 +00001939 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001940
Owen Andersonb9878ee2009-12-02 07:35:19 +00001941 // If this load occurs either right after a lifetime begin,
Owen Anderson2b2bd282009-10-28 07:05:35 +00001942 // then the loaded value is undefined.
Chris Lattnerf81f7892011-04-28 16:36:48 +00001943 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(DepInst)) {
Owen Andersonb9878ee2009-12-02 07:35:19 +00001944 if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
Owen Anderson2b2bd282009-10-28 07:05:35 +00001945 L->replaceAllUsesWith(UndefValue::get(L->getType()));
Chris Lattnerf81f7892011-04-28 16:36:48 +00001946 markInstructionForDeletion(L);
Dan Gohmand2d1ae12010-06-22 15:08:57 +00001947 ++NumGVNLoad;
Owen Anderson2b2bd282009-10-28 07:05:35 +00001948 return true;
1949 }
1950 }
Eli Friedman716c10c2008-02-12 12:08:14 +00001951
Chris Lattner0e3d6332008-12-05 21:04:20 +00001952 return false;
Owen Andersonab6ec2e2007-07-24 17:55:58 +00001953}
1954
Nadav Rotem465834c2012-07-24 10:51:42 +00001955// findLeader - In order to find a leader for a given value number at a
Owen Andersonea326db2010-11-19 22:48:40 +00001956// specific basic block, we first obtain the list of all Values for that number,
Nadav Rotem465834c2012-07-24 10:51:42 +00001957// and then scan the list to find one whose block dominates the block in
Owen Andersonea326db2010-11-19 22:48:40 +00001958// question. This is fast because dominator tree queries consist of only
1959// a few comparisons of DFS numbers.
Rafael Espindola64e7b5702012-08-10 15:55:25 +00001960Value *GVN::findLeader(const BasicBlock *BB, uint32_t num) {
Owen Andersone39cb572011-01-04 19:29:46 +00001961 LeaderTableEntry Vals = LeaderTable[num];
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00001962 if (!Vals.Val) return 0;
Nadav Rotem465834c2012-07-24 10:51:42 +00001963
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00001964 Value *Val = 0;
1965 if (DT->dominates(Vals.BB, BB)) {
1966 Val = Vals.Val;
1967 if (isa<Constant>(Val)) return Val;
1968 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001969
Owen Andersonc7c3bc62011-01-04 19:13:25 +00001970 LeaderTableEntry* Next = Vals.Next;
Owen Andersonc21c1002010-11-18 18:32:40 +00001971 while (Next) {
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00001972 if (DT->dominates(Next->BB, BB)) {
1973 if (isa<Constant>(Next->Val)) return Next->Val;
1974 if (!Val) Val = Next->Val;
1975 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001976
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00001977 Next = Next->Next;
Owen Anderson1b3ea962008-06-20 01:15:47 +00001978 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00001979
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00001980 return Val;
Owen Anderson1b3ea962008-06-20 01:15:47 +00001981}
1982
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00001983/// replaceAllDominatedUsesWith - Replace all uses of 'From' with 'To' if the
1984/// use is dominated by the given basic block. Returns the number of uses that
1985/// were replaced.
1986unsigned GVN::replaceAllDominatedUsesWith(Value *From, Value *To,
Rafael Espindolacc80cde2012-08-16 15:09:43 +00001987 const BasicBlockEdge &Root) {
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00001988 unsigned Count = 0;
1989 for (Value::use_iterator UI = From->use_begin(), UE = From->use_end();
1990 UI != UE; ) {
Duncan Sands09203082012-02-08 14:10:53 +00001991 Use &U = (UI++).getUse();
Duncan Sands4d928e72012-03-04 13:25:19 +00001992
Rafael Espindolacc80cde2012-08-16 15:09:43 +00001993 if (DT->dominates(Root, U)) {
Duncan Sands09203082012-02-08 14:10:53 +00001994 U.set(To);
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00001995 ++Count;
1996 }
1997 }
1998 return Count;
1999}
2000
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002001/// isOnlyReachableViaThisEdge - There is an edge from 'Src' to 'Dst'. Return
2002/// true if every path from the entry block to 'Dst' passes via this edge. In
2003/// particular 'Dst' must not be reachable via another edge from 'Src'.
2004static bool isOnlyReachableViaThisEdge(const BasicBlockEdge &E,
2005 DominatorTree *DT) {
2006 // While in theory it is interesting to consider the case in which Dst has
2007 // more than one predecessor, because Dst might be part of a loop which is
2008 // only reachable from Src, in practice it is pointless since at the time
2009 // GVN runs all such loops have preheaders, which means that Dst will have
2010 // been changed to have only one predecessor, namely Src.
2011 const BasicBlock *Pred = E.getEnd()->getSinglePredecessor();
2012 const BasicBlock *Src = E.getStart();
2013 assert((!Pred || Pred == Src) && "No edge between these basic blocks!");
2014 (void)Src;
2015 return Pred != 0;
2016}
2017
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002018/// propagateEquality - The given values are known to be equal in every block
2019/// dominated by 'Root'. Exploit this, for example by replacing 'LHS' with
2020/// 'RHS' everywhere in the scope. Returns whether a change was made.
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002021bool GVN::propagateEquality(Value *LHS, Value *RHS,
2022 const BasicBlockEdge &Root) {
Duncan Sandsd12b18f2012-04-06 15:31:09 +00002023 SmallVector<std::pair<Value*, Value*>, 4> Worklist;
2024 Worklist.push_back(std::make_pair(LHS, RHS));
Duncan Sandsf537a6e2011-10-15 11:13:42 +00002025 bool Changed = false;
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002026 // For speed, compute a conservative fast approximation to
2027 // DT->dominates(Root, Root.getEnd());
2028 bool RootDominatesEnd = isOnlyReachableViaThisEdge(Root, DT);
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002029
Duncan Sandsd12b18f2012-04-06 15:31:09 +00002030 while (!Worklist.empty()) {
2031 std::pair<Value*, Value*> Item = Worklist.pop_back_val();
2032 LHS = Item.first; RHS = Item.second;
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002033
Duncan Sandsd12b18f2012-04-06 15:31:09 +00002034 if (LHS == RHS) continue;
2035 assert(LHS->getType() == RHS->getType() && "Equality but unequal types!");
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002036
Duncan Sandsd12b18f2012-04-06 15:31:09 +00002037 // Don't try to propagate equalities between constants.
2038 if (isa<Constant>(LHS) && isa<Constant>(RHS)) continue;
Duncan Sands27f45952012-02-27 08:14:30 +00002039
Duncan Sandsd12b18f2012-04-06 15:31:09 +00002040 // Prefer a constant on the right-hand side, or an Argument if no constants.
2041 if (isa<Constant>(LHS) || (isa<Argument>(LHS) && !isa<Constant>(RHS)))
2042 std::swap(LHS, RHS);
2043 assert((isa<Argument>(LHS) || isa<Instruction>(LHS)) && "Unexpected value!");
Duncan Sands27f45952012-02-27 08:14:30 +00002044
Duncan Sandsd12b18f2012-04-06 15:31:09 +00002045 // If there is no obvious reason to prefer the left-hand side over the right-
2046 // hand side, ensure the longest lived term is on the right-hand side, so the
2047 // shortest lived term will be replaced by the longest lived. This tends to
2048 // expose more simplifications.
2049 uint32_t LVN = VN.lookup_or_add(LHS);
2050 if ((isa<Argument>(LHS) && isa<Argument>(RHS)) ||
2051 (isa<Instruction>(LHS) && isa<Instruction>(RHS))) {
2052 // Move the 'oldest' value to the right-hand side, using the value number as
2053 // a proxy for age.
2054 uint32_t RVN = VN.lookup_or_add(RHS);
2055 if (LVN < RVN) {
2056 std::swap(LHS, RHS);
2057 LVN = RVN;
Duncan Sands9edea842012-02-27 12:11:41 +00002058 }
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002059 }
Duncan Sands27f45952012-02-27 08:14:30 +00002060
Duncan Sands4df5e962012-05-22 14:17:53 +00002061 // If value numbering later sees that an instruction in the scope is equal
2062 // to 'LHS' then ensure it will be turned into 'RHS'. In order to preserve
2063 // the invariant that instructions only occur in the leader table for their
2064 // own value number (this is used by removeFromLeaderTable), do not do this
2065 // if RHS is an instruction (if an instruction in the scope is morphed into
2066 // LHS then it will be turned into RHS by the next GVN iteration anyway, so
2067 // using the leader table is about compiling faster, not optimizing better).
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002068 // The leader table only tracks basic blocks, not edges. Only add to if we
2069 // have the simple case where the edge dominates the end.
2070 if (RootDominatesEnd && !isa<Instruction>(RHS))
2071 addToLeaderTable(LVN, RHS, Root.getEnd());
Duncan Sandsd12b18f2012-04-06 15:31:09 +00002072
2073 // Replace all occurrences of 'LHS' with 'RHS' everywhere in the scope. As
2074 // LHS always has at least one use that is not dominated by Root, this will
2075 // never do anything if LHS has only one use.
2076 if (!LHS->hasOneUse()) {
2077 unsigned NumReplacements = replaceAllDominatedUsesWith(LHS, RHS, Root);
2078 Changed |= NumReplacements > 0;
2079 NumGVNEqProp += NumReplacements;
2080 }
2081
2082 // Now try to deduce additional equalities from this one. For example, if the
2083 // known equality was "(A != B)" == "false" then it follows that A and B are
2084 // equal in the scope. Only boolean equalities with an explicit true or false
2085 // RHS are currently supported.
2086 if (!RHS->getType()->isIntegerTy(1))
2087 // Not a boolean equality - bail out.
2088 continue;
2089 ConstantInt *CI = dyn_cast<ConstantInt>(RHS);
2090 if (!CI)
2091 // RHS neither 'true' nor 'false' - bail out.
2092 continue;
2093 // Whether RHS equals 'true'. Otherwise it equals 'false'.
2094 bool isKnownTrue = CI->isAllOnesValue();
2095 bool isKnownFalse = !isKnownTrue;
2096
2097 // If "A && B" is known true then both A and B are known true. If "A || B"
2098 // is known false then both A and B are known false.
2099 Value *A, *B;
2100 if ((isKnownTrue && match(LHS, m_And(m_Value(A), m_Value(B)))) ||
2101 (isKnownFalse && match(LHS, m_Or(m_Value(A), m_Value(B))))) {
2102 Worklist.push_back(std::make_pair(A, RHS));
2103 Worklist.push_back(std::make_pair(B, RHS));
2104 continue;
2105 }
2106
2107 // If we are propagating an equality like "(A == B)" == "true" then also
2108 // propagate the equality A == B. When propagating a comparison such as
2109 // "(A >= B)" == "true", replace all instances of "A < B" with "false".
2110 if (ICmpInst *Cmp = dyn_cast<ICmpInst>(LHS)) {
2111 Value *Op0 = Cmp->getOperand(0), *Op1 = Cmp->getOperand(1);
2112
2113 // If "A == B" is known true, or "A != B" is known false, then replace
2114 // A with B everywhere in the scope.
2115 if ((isKnownTrue && Cmp->getPredicate() == CmpInst::ICMP_EQ) ||
2116 (isKnownFalse && Cmp->getPredicate() == CmpInst::ICMP_NE))
2117 Worklist.push_back(std::make_pair(Op0, Op1));
2118
2119 // If "A >= B" is known true, replace "A < B" with false everywhere.
2120 CmpInst::Predicate NotPred = Cmp->getInversePredicate();
2121 Constant *NotVal = ConstantInt::get(Cmp->getType(), isKnownFalse);
2122 // Since we don't have the instruction "A < B" immediately to hand, work out
2123 // the value number that it would have and use that to find an appropriate
2124 // instruction (if any).
2125 uint32_t NextNum = VN.getNextUnusedValueNumber();
2126 uint32_t Num = VN.lookup_or_add_cmp(Cmp->getOpcode(), NotPred, Op0, Op1);
2127 // If the number we were assigned was brand new then there is no point in
2128 // looking for an instruction realizing it: there cannot be one!
2129 if (Num < NextNum) {
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002130 Value *NotCmp = findLeader(Root.getEnd(), Num);
Duncan Sandsd12b18f2012-04-06 15:31:09 +00002131 if (NotCmp && isa<Instruction>(NotCmp)) {
2132 unsigned NumReplacements =
2133 replaceAllDominatedUsesWith(NotCmp, NotVal, Root);
2134 Changed |= NumReplacements > 0;
2135 NumGVNEqProp += NumReplacements;
2136 }
2137 }
2138 // Ensure that any instruction in scope that gets the "A < B" value number
2139 // is replaced with false.
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002140 // The leader table only tracks basic blocks, not edges. Only add to if we
2141 // have the simple case where the edge dominates the end.
2142 if (RootDominatesEnd)
2143 addToLeaderTable(Num, NotVal, Root.getEnd());
Duncan Sandsd12b18f2012-04-06 15:31:09 +00002144
2145 continue;
2146 }
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002147 }
2148
2149 return Changed;
2150}
Owen Andersonbfe133e2008-12-15 02:03:00 +00002151
Owen Anderson398602a2007-08-14 18:16:29 +00002152/// processInstruction - When calculating availability, handle an instruction
Owen Andersonab6ec2e2007-07-24 17:55:58 +00002153/// by inserting it into the appropriate sets
Chris Lattner6cec6ab2011-04-28 16:18:52 +00002154bool GVN::processInstruction(Instruction *I) {
Devang Patel03936a12010-02-11 00:20:49 +00002155 // Ignore dbg info intrinsics.
2156 if (isa<DbgInfoIntrinsic>(I))
2157 return false;
2158
Duncan Sands246b71c2010-11-12 21:10:24 +00002159 // If the instruction can be easily simplified then do so now in preference
2160 // to value numbering it. Value numbering often exposes redundancies, for
2161 // example if it determines that %y is equal to %x then the instruction
2162 // "%z = and i32 %x, %y" becomes "%z = and i32 %x, %x" which we now simplify.
Chad Rosierc24b86f2011-12-01 03:08:23 +00002163 if (Value *V = SimplifyInstruction(I, TD, TLI, DT)) {
Duncan Sands246b71c2010-11-12 21:10:24 +00002164 I->replaceAllUsesWith(V);
Hal Finkel69b07a22012-10-24 21:22:30 +00002165 if (MD && V->getType()->getScalarType()->isPointerTy())
Duncan Sands246b71c2010-11-12 21:10:24 +00002166 MD->invalidateCachedPointerInfo(V);
Chris Lattnerf81f7892011-04-28 16:36:48 +00002167 markInstructionForDeletion(I);
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002168 ++NumGVNSimpl;
Duncan Sands246b71c2010-11-12 21:10:24 +00002169 return true;
2170 }
2171
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002172 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
Chris Lattner6cec6ab2011-04-28 16:18:52 +00002173 if (processLoad(LI))
2174 return true;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002175
Chris Lattner6cec6ab2011-04-28 16:18:52 +00002176 unsigned Num = VN.lookup_or_add(LI);
2177 addToLeaderTable(Num, LI, LI->getParent());
2178 return false;
Owen Anderson6a903bc2008-06-18 21:41:49 +00002179 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002180
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002181 // For conditional branches, we can perform simple conditional propagation on
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00002182 // the condition value itself.
2183 if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00002184 if (!BI->isConditional() || isa<Constant>(BI->getCondition()))
2185 return false;
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002186
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00002187 Value *BranchCond = BI->getCondition();
Duncan Sandsf4f47cc2011-10-05 14:28:49 +00002188
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00002189 BasicBlock *TrueSucc = BI->getSuccessor(0);
2190 BasicBlock *FalseSucc = BI->getSuccessor(1);
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002191 // Avoid multiple edges early.
2192 if (TrueSucc == FalseSucc)
2193 return false;
2194
Duncan Sandse90dd052011-10-05 14:17:01 +00002195 BasicBlock *Parent = BI->getParent();
Duncan Sandsc52af462011-10-07 08:29:06 +00002196 bool Changed = false;
Duncan Sandse90dd052011-10-05 14:17:01 +00002197
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002198 Value *TrueVal = ConstantInt::getTrue(TrueSucc->getContext());
2199 BasicBlockEdge TrueE(Parent, TrueSucc);
2200 Changed |= propagateEquality(BranchCond, TrueVal, TrueE);
Duncan Sandsc52af462011-10-07 08:29:06 +00002201
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002202 Value *FalseVal = ConstantInt::getFalse(FalseSucc->getContext());
2203 BasicBlockEdge FalseE(Parent, FalseSucc);
2204 Changed |= propagateEquality(BranchCond, FalseVal, FalseE);
Duncan Sandsc52af462011-10-07 08:29:06 +00002205
2206 return Changed;
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00002207 }
Duncan Sandsc52af462011-10-07 08:29:06 +00002208
2209 // For switches, propagate the case values into the case destinations.
2210 if (SwitchInst *SI = dyn_cast<SwitchInst>(I)) {
2211 Value *SwitchCond = SI->getCondition();
2212 BasicBlock *Parent = SI->getParent();
2213 bool Changed = false;
Benjamin Kramerdd62d6b2012-08-24 15:06:28 +00002214
2215 // Remember how many outgoing edges there are to every successor.
2216 SmallDenseMap<BasicBlock *, unsigned, 16> SwitchEdges;
2217 for (unsigned i = 0, n = SI->getNumSuccessors(); i != n; ++i)
2218 ++SwitchEdges[SI->getSuccessor(i)];
2219
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00002220 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00002221 i != e; ++i) {
2222 BasicBlock *Dst = i.getCaseSuccessor();
Benjamin Kramerdd62d6b2012-08-24 15:06:28 +00002223 // If there is only a single edge, propagate the case value into it.
2224 if (SwitchEdges.lookup(Dst) == 1) {
2225 BasicBlockEdge E(Parent, Dst);
Rafael Espindolacc80cde2012-08-16 15:09:43 +00002226 Changed |= propagateEquality(SwitchCond, i.getCaseValue(), E);
Benjamin Kramerdd62d6b2012-08-24 15:06:28 +00002227 }
Duncan Sandsc52af462011-10-07 08:29:06 +00002228 }
2229 return Changed;
2230 }
2231
Owen Anderson7b25ff02011-01-04 22:15:21 +00002232 // Instructions with void type don't return a value, so there's
Duncan Sands1be25a72012-02-27 09:54:35 +00002233 // no point in trying to find redundancies in them.
Owen Anderson7b25ff02011-01-04 22:15:21 +00002234 if (I->getType()->isVoidTy()) return false;
Nadav Rotem465834c2012-07-24 10:51:42 +00002235
Owen Anderson41a15502011-01-04 18:54:18 +00002236 uint32_t NextNum = VN.getNextUnusedValueNumber();
2237 unsigned Num = VN.lookup_or_add(I);
2238
Owen Anderson0c1e6342008-04-07 09:59:07 +00002239 // Allocations are always uniquely numbered, so we can save time and memory
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002240 // by fast failing them.
Chris Lattnerb6252a32010-12-19 20:24:28 +00002241 if (isa<AllocaInst>(I) || isa<TerminatorInst>(I) || isa<PHINode>(I)) {
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002242 addToLeaderTable(Num, I, I->getParent());
Owen Anderson0c1e6342008-04-07 09:59:07 +00002243 return false;
Owen Anderson6a903bc2008-06-18 21:41:49 +00002244 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002245
Owen Anderson3ea90a72008-07-03 17:44:33 +00002246 // If the number we were assigned was a brand new VN, then we don't
2247 // need to do a lookup to see if the number already exists
2248 // somewhere in the domtree: it can't!
Duncan Sands1be25a72012-02-27 09:54:35 +00002249 if (Num >= NextNum) {
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002250 addToLeaderTable(Num, I, I->getParent());
Chris Lattnerb6252a32010-12-19 20:24:28 +00002251 return false;
2252 }
Nadav Rotem465834c2012-07-24 10:51:42 +00002253
Owen Andersonbfe133e2008-12-15 02:03:00 +00002254 // Perform fast-path value-number based elimination of values inherited from
2255 // dominators.
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002256 Value *repl = findLeader(I->getParent(), Num);
Chris Lattnerb6252a32010-12-19 20:24:28 +00002257 if (repl == 0) {
2258 // Failure, just remember this instance for future use.
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002259 addToLeaderTable(Num, I, I->getParent());
Chris Lattnerb6252a32010-12-19 20:24:28 +00002260 return false;
Owen Andersonab6ec2e2007-07-24 17:55:58 +00002261 }
Nadav Rotem465834c2012-07-24 10:51:42 +00002262
Chris Lattnerb6252a32010-12-19 20:24:28 +00002263 // Remove it!
Dan Gohman00253592013-03-12 16:22:56 +00002264 patchAndReplaceAllUsesWith(I, repl);
Hal Finkel69b07a22012-10-24 21:22:30 +00002265 if (MD && repl->getType()->getScalarType()->isPointerTy())
Chris Lattnerb6252a32010-12-19 20:24:28 +00002266 MD->invalidateCachedPointerInfo(repl);
Chris Lattnerf81f7892011-04-28 16:36:48 +00002267 markInstructionForDeletion(I);
Chris Lattnerb6252a32010-12-19 20:24:28 +00002268 return true;
Owen Andersonab6ec2e2007-07-24 17:55:58 +00002269}
2270
Bill Wendling456e8852008-12-22 22:32:22 +00002271/// runOnFunction - This is the main transformation entry point for a function.
Owen Anderson676070d2007-08-14 18:04:11 +00002272bool GVN::runOnFunction(Function& F) {
Dan Gohman81132462009-11-14 02:27:51 +00002273 if (!NoLoads)
2274 MD = &getAnalysis<MemoryDependenceAnalysis>();
Chris Lattner8541ede2008-12-01 00:40:32 +00002275 DT = &getAnalysis<DominatorTree>();
Micah Villmowcdfe20b2012-10-08 16:38:25 +00002276 TD = getAnalysisIfAvailable<DataLayout>();
Chad Rosierc24b86f2011-12-01 03:08:23 +00002277 TLI = &getAnalysis<TargetLibraryInfo>();
Owen Andersonf7928602008-05-12 20:15:55 +00002278 VN.setAliasAnalysis(&getAnalysis<AliasAnalysis>());
Chris Lattner8541ede2008-12-01 00:40:32 +00002279 VN.setMemDep(MD);
2280 VN.setDomTree(DT);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002281
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002282 bool Changed = false;
2283 bool ShouldContinue = true;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002284
Owen Andersonac310962008-07-16 17:52:31 +00002285 // Merge unconditional branches, allowing PRE to catch more
2286 // optimization opportunities.
2287 for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ) {
Chris Lattnerf6ae9042011-01-11 08:13:40 +00002288 BasicBlock *BB = FI++;
Nadav Rotem465834c2012-07-24 10:51:42 +00002289
Owen Andersonc0623812008-07-17 00:01:40 +00002290 bool removedBlock = MergeBlockIntoPredecessor(BB, this);
Dan Gohmand2d1ae12010-06-22 15:08:57 +00002291 if (removedBlock) ++NumGVNBlocks;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002292
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002293 Changed |= removedBlock;
Owen Andersonac310962008-07-16 17:52:31 +00002294 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002295
Chris Lattner0a5a8d52008-12-09 19:21:47 +00002296 unsigned Iteration = 0;
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002297 while (ShouldContinue) {
David Greene2e6efc42010-01-05 01:27:17 +00002298 DEBUG(dbgs() << "GVN iteration: " << Iteration << "\n");
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002299 ShouldContinue = iterateOnFunction(F);
Bob Wilson92cdb6e2010-02-16 19:51:59 +00002300 if (splitCriticalEdges())
2301 ShouldContinue = true;
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002302 Changed |= ShouldContinue;
Chris Lattner0a5a8d52008-12-09 19:21:47 +00002303 ++Iteration;
Owen Anderson676070d2007-08-14 18:04:11 +00002304 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002305
Owen Anderson04a6e0b2008-07-18 18:03:38 +00002306 if (EnablePRE) {
Owen Anderson2fbfb702008-09-03 23:06:07 +00002307 bool PREChanged = true;
2308 while (PREChanged) {
2309 PREChanged = performPRE(F);
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002310 Changed |= PREChanged;
Owen Anderson2fbfb702008-09-03 23:06:07 +00002311 }
Owen Anderson04a6e0b2008-07-18 18:03:38 +00002312 }
Chris Lattner0a5a8d52008-12-09 19:21:47 +00002313 // FIXME: Should perform GVN again after PRE does something. PRE can move
2314 // computations into blocks where they become fully redundant. Note that
2315 // we can't do this until PRE's critical edge splitting updates memdep.
2316 // Actually, when this happens, we should just fully integrate PRE into GVN.
Nuno Lopese3127f32008-10-10 16:25:50 +00002317
2318 cleanupGlobalSets();
2319
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002320 return Changed;
Owen Anderson676070d2007-08-14 18:04:11 +00002321}
2322
2323
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002324bool GVN::processBlock(BasicBlock *BB) {
Chris Lattner6cec6ab2011-04-28 16:18:52 +00002325 // FIXME: Kill off InstrsToErase by doing erasing eagerly in a helper function
2326 // (and incrementing BI before processing an instruction).
2327 assert(InstrsToErase.empty() &&
2328 "We expect InstrsToErase to be empty across iterations");
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002329 bool ChangedFunction = false;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002330
Owen Andersonaccdca12008-06-12 19:25:32 +00002331 for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();
2332 BI != BE;) {
Chris Lattner6cec6ab2011-04-28 16:18:52 +00002333 ChangedFunction |= processInstruction(BI);
2334 if (InstrsToErase.empty()) {
Owen Andersonaccdca12008-06-12 19:25:32 +00002335 ++BI;
2336 continue;
2337 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002338
Owen Andersonaccdca12008-06-12 19:25:32 +00002339 // If we need some instructions deleted, do it now.
Chris Lattner6cec6ab2011-04-28 16:18:52 +00002340 NumGVNInstr += InstrsToErase.size();
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002341
Owen Andersonaccdca12008-06-12 19:25:32 +00002342 // Avoid iterator invalidation.
2343 bool AtStart = BI == BB->begin();
2344 if (!AtStart)
2345 --BI;
2346
Chris Lattner6cec6ab2011-04-28 16:18:52 +00002347 for (SmallVector<Instruction*, 4>::iterator I = InstrsToErase.begin(),
2348 E = InstrsToErase.end(); I != E; ++I) {
David Greene2e6efc42010-01-05 01:27:17 +00002349 DEBUG(dbgs() << "GVN removed: " << **I << '\n');
Dan Gohman81132462009-11-14 02:27:51 +00002350 if (MD) MD->removeInstruction(*I);
Bill Wendlingebb6a542008-12-22 21:57:30 +00002351 DEBUG(verifyRemoved(*I));
Dan Gohmanfd41de02013-02-12 18:44:43 +00002352 (*I)->eraseFromParent();
Chris Lattner8541ede2008-12-01 00:40:32 +00002353 }
Chris Lattner6cec6ab2011-04-28 16:18:52 +00002354 InstrsToErase.clear();
Owen Andersonaccdca12008-06-12 19:25:32 +00002355
2356 if (AtStart)
2357 BI = BB->begin();
2358 else
2359 ++BI;
Owen Andersonaccdca12008-06-12 19:25:32 +00002360 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002361
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002362 return ChangedFunction;
Owen Andersonaccdca12008-06-12 19:25:32 +00002363}
2364
Owen Anderson6a903bc2008-06-18 21:41:49 +00002365/// performPRE - Perform a purely local form of PRE that looks for diamond
2366/// control flow patterns and attempts to perform simple PRE at the join point.
Chris Lattnera546dcf2009-10-31 22:11:15 +00002367bool GVN::performPRE(Function &F) {
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002368 bool Changed = false;
Dan Gohmanf3771602013-02-12 19:49:10 +00002369 SmallVector<std::pair<Value*, BasicBlock*>, 8> predMap;
Owen Anderson6a903bc2008-06-18 21:41:49 +00002370 for (df_iterator<BasicBlock*> DI = df_begin(&F.getEntryBlock()),
2371 DE = df_end(&F.getEntryBlock()); DI != DE; ++DI) {
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002372 BasicBlock *CurrentBlock = *DI;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002373
Owen Anderson6a903bc2008-06-18 21:41:49 +00002374 // Nothing to PRE in the entry block.
2375 if (CurrentBlock == &F.getEntryBlock()) continue;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002376
Bill Wendling8bbcbed2011-08-17 21:32:02 +00002377 // Don't perform PRE on a landing pad.
2378 if (CurrentBlock->isLandingPad()) continue;
2379
Owen Anderson6a903bc2008-06-18 21:41:49 +00002380 for (BasicBlock::iterator BI = CurrentBlock->begin(),
2381 BE = CurrentBlock->end(); BI != BE; ) {
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002382 Instruction *CurInst = BI++;
Duncan Sands1efabaa2009-05-06 06:49:50 +00002383
Victor Hernandez8acf2952009-10-23 21:09:37 +00002384 if (isa<AllocaInst>(CurInst) ||
Victor Hernandez5d034492009-09-18 22:35:49 +00002385 isa<TerminatorInst>(CurInst) || isa<PHINode>(CurInst) ||
Devang Patel92f86192009-10-14 17:29:00 +00002386 CurInst->getType()->isVoidTy() ||
Duncan Sands1efabaa2009-05-06 06:49:50 +00002387 CurInst->mayReadFromMemory() || CurInst->mayHaveSideEffects() ||
John Criswell073e4d12009-03-10 15:04:53 +00002388 isa<DbgInfoIntrinsic>(CurInst))
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002389 continue;
Jakob Stoklund Olesen4e550442012-03-29 17:22:39 +00002390
2391 // Don't do PRE on compares. The PHI would prevent CodeGenPrepare from
2392 // sinking the compare again, and it would force the code generator to
2393 // move the i1 from processor flags or predicate registers into a general
2394 // purpose register.
2395 if (isa<CmpInst>(CurInst))
2396 continue;
2397
Owen Anderson03986072010-08-07 00:20:35 +00002398 // We don't currently value number ANY inline asm calls.
2399 if (CallInst *CallI = dyn_cast<CallInst>(CurInst))
2400 if (CallI->isInlineAsm())
2401 continue;
Duncan Sands1efabaa2009-05-06 06:49:50 +00002402
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002403 uint32_t ValNo = VN.lookup(CurInst);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002404
Owen Anderson6a903bc2008-06-18 21:41:49 +00002405 // Look for the predecessors for PRE opportunities. We're
2406 // only trying to solve the basic diamond case, where
2407 // a value is computed in the successor and one predecessor,
2408 // but not the other. We also explicitly disallow cases
2409 // where the successor is its own predecessor, because they're
2410 // more complicated to get right.
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002411 unsigned NumWith = 0;
2412 unsigned NumWithout = 0;
2413 BasicBlock *PREPred = 0;
Chris Lattnerf00aae42008-12-01 07:29:03 +00002414 predMap.clear();
2415
Owen Anderson6a903bc2008-06-18 21:41:49 +00002416 for (pred_iterator PI = pred_begin(CurrentBlock),
2417 PE = pred_end(CurrentBlock); PI != PE; ++PI) {
Gabor Greifb0d56ff2010-07-09 14:36:49 +00002418 BasicBlock *P = *PI;
Owen Anderson6a903bc2008-06-18 21:41:49 +00002419 // We're not interested in PRE where the block is its
Bob Wilson76e8c592010-02-03 00:33:21 +00002420 // own predecessor, or in blocks with predecessors
Owen Anderson1b3ea962008-06-20 01:15:47 +00002421 // that are not reachable.
Gabor Greifb0d56ff2010-07-09 14:36:49 +00002422 if (P == CurrentBlock) {
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002423 NumWithout = 2;
Owen Anderson1b3ea962008-06-20 01:15:47 +00002424 break;
Dan Gohmanf6066702013-02-12 18:38:36 +00002425 } else if (!DT->isReachableFromEntry(P)) {
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002426 NumWithout = 2;
Owen Anderson1b3ea962008-06-20 01:15:47 +00002427 break;
2428 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002429
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002430 Value* predV = findLeader(P, ValNo);
Owen Andersonc21c1002010-11-18 18:32:40 +00002431 if (predV == 0) {
Dan Gohmanf3771602013-02-12 19:49:10 +00002432 predMap.push_back(std::make_pair(static_cast<Value *>(0), P));
Gabor Greifb0d56ff2010-07-09 14:36:49 +00002433 PREPred = P;
Dan Gohmand2d1ae12010-06-22 15:08:57 +00002434 ++NumWithout;
Owen Andersonc21c1002010-11-18 18:32:40 +00002435 } else if (predV == CurInst) {
Dan Gohman2001cd82013-02-12 19:05:10 +00002436 /* CurInst dominates this predecessor. */
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002437 NumWithout = 2;
Dan Gohman2001cd82013-02-12 19:05:10 +00002438 break;
Owen Anderson6a903bc2008-06-18 21:41:49 +00002439 } else {
Dan Gohmanf3771602013-02-12 19:49:10 +00002440 predMap.push_back(std::make_pair(predV, P));
Dan Gohmand2d1ae12010-06-22 15:08:57 +00002441 ++NumWith;
Owen Anderson6a903bc2008-06-18 21:41:49 +00002442 }
2443 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002444
Owen Anderson6a903bc2008-06-18 21:41:49 +00002445 // Don't do PRE when it might increase code size, i.e. when
2446 // we would need to insert instructions in more than one pred.
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002447 if (NumWithout != 1 || NumWith == 0)
Owen Anderson6a903bc2008-06-18 21:41:49 +00002448 continue;
Nadav Rotem465834c2012-07-24 10:51:42 +00002449
Chris Lattnera546dcf2009-10-31 22:11:15 +00002450 // Don't do PRE across indirect branch.
2451 if (isa<IndirectBrInst>(PREPred->getTerminator()))
2452 continue;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002453
Owen Andersonfdf9f162008-06-19 19:54:19 +00002454 // We can't do PRE safely on a critical edge, so instead we schedule
2455 // the edge to be split and perform the PRE the next time we iterate
2456 // on the function.
Bob Wilsonaff96b22010-02-16 21:06:42 +00002457 unsigned SuccNum = GetSuccessorNumber(PREPred, CurrentBlock);
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002458 if (isCriticalEdge(PREPred->getTerminator(), SuccNum)) {
2459 toSplit.push_back(std::make_pair(PREPred->getTerminator(), SuccNum));
Owen Andersonfdf9f162008-06-19 19:54:19 +00002460 continue;
2461 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002462
Bob Wilson76e8c592010-02-03 00:33:21 +00002463 // Instantiate the expression in the predecessor that lacked it.
Owen Anderson6a903bc2008-06-18 21:41:49 +00002464 // Because we are going top-down through the block, all value numbers
2465 // will be available in the predecessor by the time we need them. Any
Bob Wilson76e8c592010-02-03 00:33:21 +00002466 // that weren't originally present will have been instantiated earlier
Owen Anderson6a903bc2008-06-18 21:41:49 +00002467 // in this loop.
Nick Lewycky42fb7452009-09-27 07:38:41 +00002468 Instruction *PREInstr = CurInst->clone();
Owen Anderson6a903bc2008-06-18 21:41:49 +00002469 bool success = true;
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002470 for (unsigned i = 0, e = CurInst->getNumOperands(); i != e; ++i) {
2471 Value *Op = PREInstr->getOperand(i);
2472 if (isa<Argument>(Op) || isa<Constant>(Op) || isa<GlobalValue>(Op))
2473 continue;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002474
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002475 if (Value *V = findLeader(PREPred, VN.lookup(Op))) {
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002476 PREInstr->setOperand(i, V);
2477 } else {
2478 success = false;
2479 break;
Owen Anderson8e462e92008-07-11 20:05:13 +00002480 }
Owen Anderson6a903bc2008-06-18 21:41:49 +00002481 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002482
Owen Anderson6a903bc2008-06-18 21:41:49 +00002483 // Fail out if we encounter an operand that is not available in
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002484 // the PRE predecessor. This is typically because of loads which
Owen Anderson6a903bc2008-06-18 21:41:49 +00002485 // are not value numbered precisely.
2486 if (!success) {
Bill Wendling3c793442008-12-22 22:14:07 +00002487 DEBUG(verifyRemoved(PREInstr));
Dan Gohmanfd41de02013-02-12 18:44:43 +00002488 delete PREInstr;
Owen Anderson6a903bc2008-06-18 21:41:49 +00002489 continue;
2490 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002491
Owen Anderson6a903bc2008-06-18 21:41:49 +00002492 PREInstr->insertBefore(PREPred->getTerminator());
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002493 PREInstr->setName(CurInst->getName() + ".pre");
Devang Patel341b38c2011-05-17 20:00:02 +00002494 PREInstr->setDebugLoc(CurInst->getDebugLoc());
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002495 VN.add(PREInstr, ValNo);
Dan Gohmand2d1ae12010-06-22 15:08:57 +00002496 ++NumGVNPRE;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002497
Owen Anderson6a903bc2008-06-18 21:41:49 +00002498 // Update the availability map to include the new instruction.
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002499 addToLeaderTable(ValNo, PREInstr, PREPred);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002500
Owen Anderson6a903bc2008-06-18 21:41:49 +00002501 // Create a PHI to make the value available in this block.
Dan Gohmanf3771602013-02-12 19:49:10 +00002502 PHINode* Phi = PHINode::Create(CurInst->getType(), predMap.size(),
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002503 CurInst->getName() + ".pre-phi",
Owen Anderson6a903bc2008-06-18 21:41:49 +00002504 CurrentBlock->begin());
Dan Gohmanf3771602013-02-12 19:49:10 +00002505 for (unsigned i = 0, e = predMap.size(); i != e; ++i) {
2506 if (Value *V = predMap[i].first)
2507 Phi->addIncoming(V, predMap[i].second);
2508 else
2509 Phi->addIncoming(PREInstr, PREPred);
Gabor Greifd323f5e2010-07-09 14:48:08 +00002510 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002511
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002512 VN.add(Phi, ValNo);
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002513 addToLeaderTable(ValNo, Phi, CurrentBlock);
Devang Patelffb798c2011-05-04 23:58:50 +00002514 Phi->setDebugLoc(CurInst->getDebugLoc());
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002515 CurInst->replaceAllUsesWith(Phi);
Hal Finkel69b07a22012-10-24 21:22:30 +00002516 if (Phi->getType()->getScalarType()->isPointerTy()) {
Owen Andersond62d3722011-01-03 23:51:43 +00002517 // Because we have added a PHI-use of the pointer value, it has now
2518 // "escaped" from alias analysis' perspective. We need to inform
2519 // AA of this.
Jay Foad372ad642011-06-20 14:18:48 +00002520 for (unsigned ii = 0, ee = Phi->getNumIncomingValues(); ii != ee;
2521 ++ii) {
2522 unsigned jj = PHINode::getOperandNumForIncomingValue(ii);
2523 VN.getAliasAnalysis()->addEscapingUse(Phi->getOperandUse(jj));
2524 }
Nadav Rotem465834c2012-07-24 10:51:42 +00002525
Owen Andersond62d3722011-01-03 23:51:43 +00002526 if (MD)
2527 MD->invalidateCachedPointerInfo(Phi);
2528 }
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002529 VN.erase(CurInst);
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002530 removeFromLeaderTable(ValNo, CurInst, CurrentBlock);
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002531
David Greene2e6efc42010-01-05 01:27:17 +00002532 DEBUG(dbgs() << "GVN PRE removed: " << *CurInst << '\n');
Dan Gohman81132462009-11-14 02:27:51 +00002533 if (MD) MD->removeInstruction(CurInst);
Bill Wendlingebb6a542008-12-22 21:57:30 +00002534 DEBUG(verifyRemoved(CurInst));
Dan Gohmanfd41de02013-02-12 18:44:43 +00002535 CurInst->eraseFromParent();
Chris Lattner6f5bf6a2008-12-01 07:35:54 +00002536 Changed = true;
Owen Anderson6a903bc2008-06-18 21:41:49 +00002537 }
2538 }
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002539
Bob Wilson92cdb6e2010-02-16 19:51:59 +00002540 if (splitCriticalEdges())
2541 Changed = true;
Daniel Dunbar7d6781b2009-09-20 02:20:51 +00002542
Bob Wilson92cdb6e2010-02-16 19:51:59 +00002543 return Changed;
2544}
2545
2546/// splitCriticalEdges - Split critical edges found during the previous
2547/// iteration that may enable further optimization.
2548bool GVN::splitCriticalEdges() {
2549 if (toSplit.empty())
2550 return false;
2551 do {
2552 std::pair<TerminatorInst*, unsigned> Edge = toSplit.pop_back_val();
2553 SplitCriticalEdge(Edge.first, Edge.second, this);
2554 } while (!toSplit.empty());
Evan Cheng7263cf8432010-03-01 22:23:12 +00002555 if (MD) MD->invalidateCachedPredecessors();
Bob Wilson92cdb6e2010-02-16 19:51:59 +00002556 return true;
Owen Anderson6a903bc2008-06-18 21:41:49 +00002557}
2558
Bill Wendling456e8852008-12-22 22:32:22 +00002559/// iterateOnFunction - Executes one iteration of GVN
Owen Anderson676070d2007-08-14 18:04:11 +00002560bool GVN::iterateOnFunction(Function &F) {
Nuno Lopese3127f32008-10-10 16:25:50 +00002561 cleanupGlobalSets();
Nadav Rotem465834c2012-07-24 10:51:42 +00002562
Owen Andersonab6ec2e2007-07-24 17:55:58 +00002563 // Top-down walk of the dominator tree
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002564 bool Changed = false;
Owen Anderson03aacba2008-12-15 03:52:17 +00002565#if 0
2566 // Needed for value numbering with phi construction to work.
Owen Andersonbfe133e2008-12-15 02:03:00 +00002567 ReversePostOrderTraversal<Function*> RPOT(&F);
2568 for (ReversePostOrderTraversal<Function*>::rpo_iterator RI = RPOT.begin(),
2569 RE = RPOT.end(); RI != RE; ++RI)
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002570 Changed |= processBlock(*RI);
Owen Anderson03aacba2008-12-15 03:52:17 +00002571#else
2572 for (df_iterator<DomTreeNode*> DI = df_begin(DT->getRootNode()),
2573 DE = df_end(DT->getRootNode()); DI != DE; ++DI)
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002574 Changed |= processBlock(DI->getBlock());
Owen Anderson03aacba2008-12-15 03:52:17 +00002575#endif
2576
Chris Lattner1eefa9c2009-09-21 02:42:51 +00002577 return Changed;
Owen Andersonab6ec2e2007-07-24 17:55:58 +00002578}
Nuno Lopese3127f32008-10-10 16:25:50 +00002579
2580void GVN::cleanupGlobalSets() {
2581 VN.clear();
Owen Andersone39cb572011-01-04 19:29:46 +00002582 LeaderTable.clear();
Owen Andersonc21c1002010-11-18 18:32:40 +00002583 TableAllocator.Reset();
Nuno Lopese3127f32008-10-10 16:25:50 +00002584}
Bill Wendling6b18a392008-12-22 21:36:08 +00002585
2586/// verifyRemoved - Verify that the specified instruction does not occur in our
2587/// internal data structures.
Bill Wendlinge7f08e72008-12-22 22:28:56 +00002588void GVN::verifyRemoved(const Instruction *Inst) const {
2589 VN.verifyRemoved(Inst);
Bill Wendling3c793442008-12-22 22:14:07 +00002590
Bill Wendlinge7f08e72008-12-22 22:28:56 +00002591 // Walk through the value number scope to make sure the instruction isn't
2592 // ferreted away in it.
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002593 for (DenseMap<uint32_t, LeaderTableEntry>::const_iterator
Owen Andersone39cb572011-01-04 19:29:46 +00002594 I = LeaderTable.begin(), E = LeaderTable.end(); I != E; ++I) {
Owen Andersonc7c3bc62011-01-04 19:13:25 +00002595 const LeaderTableEntry *Node = &I->second;
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00002596 assert(Node->Val != Inst && "Inst still in value numbering scope!");
Nadav Rotem465834c2012-07-24 10:51:42 +00002597
Owen Anderson5ab8d4b2010-12-21 23:54:34 +00002598 while (Node->Next) {
2599 Node = Node->Next;
2600 assert(Node->Val != Inst && "Inst still in value numbering scope!");
Bill Wendling3c793442008-12-22 22:14:07 +00002601 }
2602 }
Bill Wendling6b18a392008-12-22 21:36:08 +00002603}