blob: c78c4c308cbe92e4af1e037a48f1b883a5d272ee [file] [log] [blame]
Chris Lattner72bc70d2008-12-05 07:49:08 +00001//===- GVN.cpp - Eliminate redundant values and loads ---------------------===//
Owen Anderson1ad2cb72007-07-24 17:55:58 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-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 Anderson1ad2cb72007-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 Criswell090c0a22009-03-10 15:04:53 +000013// Note that this pass does the value numbering itself; it does not use the
Matthijs Kooijman845f5242008-06-05 07:55:49 +000014// ValueNumbering analysis passes.
15//
Owen Anderson1ad2cb72007-07-24 17:55:58 +000016//===----------------------------------------------------------------------===//
17
18#define DEBUG_TYPE "gvn"
Owen Anderson1ad2cb72007-07-24 17:55:58 +000019#include "llvm/Transforms/Scalar.h"
Owen Anderson45537912007-07-26 18:26:51 +000020#include "llvm/Constants.h"
Owen Anderson1ad2cb72007-07-24 17:55:58 +000021#include "llvm/DerivedTypes.h"
Chris Lattnera53cfd12009-12-28 21:28:46 +000022#include "llvm/GlobalVariable.h"
Owen Anderson45537912007-07-26 18:26:51 +000023#include "llvm/Function.h"
Devang Patelc64bc162009-03-06 02:59:27 +000024#include "llvm/IntrinsicInst.h"
Dan Gohmanf4177aa2010-12-15 23:53:55 +000025#include "llvm/LLVMContext.h"
Chris Lattnereed919b2009-09-21 05:57:11 +000026#include "llvm/Operator.h"
Owen Andersonb388ca92007-10-18 19:39:33 +000027#include "llvm/Analysis/AliasAnalysis.h"
Chris Lattnerbc9a28d2009-12-06 05:29:56 +000028#include "llvm/Analysis/ConstantFolding.h"
29#include "llvm/Analysis/Dominators.h"
Duncan Sands88c3df72010-11-12 21:10:24 +000030#include "llvm/Analysis/InstructionSimplify.h"
Dan Gohmandd9344f2010-05-28 16:19:17 +000031#include "llvm/Analysis/Loads.h"
Victor Hernandezf006b182009-10-27 20:05:49 +000032#include "llvm/Analysis/MemoryBuiltins.h"
Owen Anderson1ad2cb72007-07-24 17:55:58 +000033#include "llvm/Analysis/MemoryDependenceAnalysis.h"
Chris Lattner05e15f82009-12-09 01:59:31 +000034#include "llvm/Analysis/PHITransAddr.h"
Chris Lattnered58a6f2010-11-30 22:25:26 +000035#include "llvm/Analysis/ValueTracking.h"
Chris Lattner9fc5cdf2011-01-02 22:09:33 +000036#include "llvm/Assembly/Writer.h"
Chris Lattnered58a6f2010-11-30 22:25:26 +000037#include "llvm/Target/TargetData.h"
38#include "llvm/Transforms/Utils/BasicBlockUtils.h"
39#include "llvm/Transforms/Utils/Local.h"
40#include "llvm/Transforms/Utils/SSAUpdater.h"
41#include "llvm/ADT/DenseMap.h"
42#include "llvm/ADT/DepthFirstIterator.h"
43#include "llvm/ADT/PostOrderIterator.h"
44#include "llvm/ADT/SmallPtrSet.h"
45#include "llvm/ADT/Statistic.h"
Owen Andersona04a0642010-11-18 18:32:40 +000046#include "llvm/Support/Allocator.h"
Owen Anderson1ad2cb72007-07-24 17:55:58 +000047#include "llvm/Support/CFG.h"
Owen Andersonaa0b6342008-06-19 19:57:25 +000048#include "llvm/Support/CommandLine.h"
Chris Lattner9f8a6a72008-03-29 04:36:18 +000049#include "llvm/Support/Debug.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000050#include "llvm/Support/ErrorHandling.h"
Chris Lattnereed919b2009-09-21 05:57:11 +000051#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattnerfaf815b2009-12-06 01:57:02 +000052#include "llvm/Support/IRBuilder.h"
Owen Andersona04a0642010-11-18 18:32:40 +000053#include <list>
Owen Anderson1ad2cb72007-07-24 17:55:58 +000054using namespace llvm;
55
Bill Wendling70ded192008-12-22 22:14:07 +000056STATISTIC(NumGVNInstr, "Number of instructions deleted");
57STATISTIC(NumGVNLoad, "Number of loads deleted");
58STATISTIC(NumGVNPRE, "Number of instructions PRE'd");
Owen Anderson961edc82008-07-15 16:28:06 +000059STATISTIC(NumGVNBlocks, "Number of blocks merged");
Bill Wendling70ded192008-12-22 22:14:07 +000060STATISTIC(NumPRELoad, "Number of loads PRE'd");
Chris Lattnerd27290d2008-03-22 04:13:49 +000061
Evan Cheng88d11c02008-06-20 01:01:07 +000062static cl::opt<bool> EnablePRE("enable-pre",
Owen Andersonc2b856e2008-07-17 19:41:00 +000063 cl::init(true), cl::Hidden);
Dan Gohmanc915c952009-06-15 18:30:15 +000064static cl::opt<bool> EnableLoadPRE("enable-load-pre", cl::init(true));
Owen Andersonaa0b6342008-06-19 19:57:25 +000065
Owen Anderson1ad2cb72007-07-24 17:55:58 +000066//===----------------------------------------------------------------------===//
67// ValueTable Class
68//===----------------------------------------------------------------------===//
69
70/// This class holds the mapping between values and value numbers. It is used
71/// as an efficient mechanism to determine the expression-wise equivalence of
72/// two values.
73namespace {
Chris Lattner3e8b6632009-09-02 06:11:42 +000074 struct Expression {
Owen Anderson30f4a552011-01-03 19:00:11 +000075 uint32_t opcode;
Owen Anderson1ad2cb72007-07-24 17:55:58 +000076 const Type* type;
Owen Anderson1ad2cb72007-07-24 17:55:58 +000077 SmallVector<uint32_t, 4> varargs;
Daniel Dunbara279bc32009-09-20 02:20:51 +000078
Owen Anderson1ad2cb72007-07-24 17:55:58 +000079 Expression() { }
Owen Anderson30f4a552011-01-03 19:00:11 +000080 Expression(uint32_t o) : opcode(o) { }
Daniel Dunbara279bc32009-09-20 02:20:51 +000081
Owen Anderson1ad2cb72007-07-24 17:55:58 +000082 bool operator==(const Expression &other) const {
83 if (opcode != other.opcode)
84 return false;
Owen Anderson30f4a552011-01-03 19:00:11 +000085 else if (opcode == ~0U || opcode == ~1U)
Owen Anderson1ad2cb72007-07-24 17:55:58 +000086 return true;
87 else if (type != other.type)
88 return false;
Benjamin Krameraad94aa2010-12-21 21:30:19 +000089 else if (varargs != other.varargs)
90 return false;
91 return true;
Owen Anderson1ad2cb72007-07-24 17:55:58 +000092 }
Owen Anderson1ad2cb72007-07-24 17:55:58 +000093 };
Daniel Dunbara279bc32009-09-20 02:20:51 +000094
Chris Lattner3e8b6632009-09-02 06:11:42 +000095 class ValueTable {
Owen Anderson1ad2cb72007-07-24 17:55:58 +000096 private:
97 DenseMap<Value*, uint32_t> valueNumbering;
98 DenseMap<Expression, uint32_t> expressionNumbering;
Owen Andersona472c4a2008-05-12 20:15:55 +000099 AliasAnalysis* AA;
100 MemoryDependenceAnalysis* MD;
101 DominatorTree* DT;
Daniel Dunbara279bc32009-09-20 02:20:51 +0000102
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000103 uint32_t nextValueNumber;
Daniel Dunbara279bc32009-09-20 02:20:51 +0000104
Owen Anderson30f4a552011-01-03 19:00:11 +0000105 Expression create_expression(Instruction* I);
Owen Andersond41ed4e2009-10-19 22:14:22 +0000106 uint32_t lookup_or_add_call(CallInst* C);
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000107 public:
Dan Gohmane63c4a22009-04-01 16:37:47 +0000108 ValueTable() : nextValueNumber(1) { }
Chris Lattnerb2412a82009-09-21 02:42:51 +0000109 uint32_t lookup_or_add(Value *V);
110 uint32_t lookup(Value *V) const;
111 void add(Value *V, uint32_t num);
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000112 void clear();
Chris Lattnerb2412a82009-09-21 02:42:51 +0000113 void erase(Value *v);
Owen Andersona472c4a2008-05-12 20:15:55 +0000114 void setAliasAnalysis(AliasAnalysis* A) { AA = A; }
Chris Lattner663e4412008-12-01 00:40:32 +0000115 AliasAnalysis *getAliasAnalysis() const { return AA; }
Owen Andersona472c4a2008-05-12 20:15:55 +0000116 void setMemDep(MemoryDependenceAnalysis* M) { MD = M; }
117 void setDomTree(DominatorTree* D) { DT = D; }
Owen Anderson0ae33ef2008-07-03 17:44:33 +0000118 uint32_t getNextUnusedValueNumber() { return nextValueNumber; }
Bill Wendling246dbbb2008-12-22 21:36:08 +0000119 void verifyRemoved(const Value *) const;
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000120 };
121}
122
123namespace llvm {
Chris Lattner76c1b972007-09-17 18:34:04 +0000124template <> struct DenseMapInfo<Expression> {
Owen Anderson830db6a2007-08-02 18:16:06 +0000125 static inline Expression getEmptyKey() {
Owen Anderson30f4a552011-01-03 19:00:11 +0000126 return ~0U;
Owen Anderson830db6a2007-08-02 18:16:06 +0000127 }
Daniel Dunbara279bc32009-09-20 02:20:51 +0000128
Owen Anderson830db6a2007-08-02 18:16:06 +0000129 static inline Expression getTombstoneKey() {
Owen Anderson30f4a552011-01-03 19:00:11 +0000130 return ~1U;
Owen Anderson830db6a2007-08-02 18:16:06 +0000131 }
Daniel Dunbara279bc32009-09-20 02:20:51 +0000132
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000133 static unsigned getHashValue(const Expression e) {
134 unsigned hash = e.opcode;
Daniel Dunbara279bc32009-09-20 02:20:51 +0000135
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000136 hash = ((unsigned)((uintptr_t)e.type >> 4) ^
Owen Andersond41ed4e2009-10-19 22:14:22 +0000137 (unsigned)((uintptr_t)e.type >> 9));
Daniel Dunbara279bc32009-09-20 02:20:51 +0000138
Owen Anderson830db6a2007-08-02 18:16:06 +0000139 for (SmallVector<uint32_t, 4>::const_iterator I = e.varargs.begin(),
140 E = e.varargs.end(); I != E; ++I)
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000141 hash = *I + hash * 37;
Owen Anderson30f4a552011-01-03 19:00:11 +0000142
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000143 return hash;
144 }
Chris Lattner76c1b972007-09-17 18:34:04 +0000145 static bool isEqual(const Expression &LHS, const Expression &RHS) {
146 return LHS == RHS;
147 }
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000148};
Chris Lattner4bbf4ee2009-12-15 07:26:43 +0000149
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000150}
151
152//===----------------------------------------------------------------------===//
153// ValueTable Internal Functions
154//===----------------------------------------------------------------------===//
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000155
Owen Anderson30f4a552011-01-03 19:00:11 +0000156
157Expression ValueTable::create_expression(Instruction *I) {
158 Expression e;
159 e.type = I->getType();
160 e.opcode = I->getOpcode();
161 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
162 OI != OE; ++OI)
163 e.varargs.push_back(lookup_or_add(*OI));
164
165 if (CmpInst *C = dyn_cast<CmpInst>(I))
166 e.opcode = (C->getOpcode() << 8) | C->getPredicate();
167 else if (ExtractValueInst *E = dyn_cast<ExtractValueInst>(I)) {
168 for (ExtractValueInst::idx_iterator II = E->idx_begin(), IE = E->idx_end();
169 II != IE; ++II)
170 e.varargs.push_back(*II);
171 } else if (InsertValueInst *E = dyn_cast<InsertValueInst>(I)) {
172 for (InsertValueInst::idx_iterator II = E->idx_begin(), IE = E->idx_end();
173 II != IE; ++II)
174 e.varargs.push_back(*II);
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000175 }
Owen Anderson30f4a552011-01-03 19:00:11 +0000176
Owen Andersond41ed4e2009-10-19 22:14:22 +0000177 return e;
178}
179
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000180//===----------------------------------------------------------------------===//
181// ValueTable External Functions
182//===----------------------------------------------------------------------===//
183
Owen Andersonb2303722008-06-18 21:41:49 +0000184/// add - Insert a value into the table with a specified value number.
Chris Lattnerb2412a82009-09-21 02:42:51 +0000185void ValueTable::add(Value *V, uint32_t num) {
Owen Andersonb2303722008-06-18 21:41:49 +0000186 valueNumbering.insert(std::make_pair(V, num));
187}
188
Owen Andersond41ed4e2009-10-19 22:14:22 +0000189uint32_t ValueTable::lookup_or_add_call(CallInst* C) {
190 if (AA->doesNotAccessMemory(C)) {
191 Expression exp = create_expression(C);
192 uint32_t& e = expressionNumbering[exp];
193 if (!e) e = nextValueNumber++;
194 valueNumbering[C] = e;
195 return e;
196 } else if (AA->onlyReadsMemory(C)) {
197 Expression exp = create_expression(C);
198 uint32_t& e = expressionNumbering[exp];
199 if (!e) {
200 e = nextValueNumber++;
201 valueNumbering[C] = e;
202 return e;
203 }
Dan Gohman4ec01b22009-11-14 02:27:51 +0000204 if (!MD) {
205 e = nextValueNumber++;
206 valueNumbering[C] = e;
207 return e;
208 }
Owen Andersond41ed4e2009-10-19 22:14:22 +0000209
210 MemDepResult local_dep = MD->getDependency(C);
211
212 if (!local_dep.isDef() && !local_dep.isNonLocal()) {
213 valueNumbering[C] = nextValueNumber;
214 return nextValueNumber++;
215 }
216
217 if (local_dep.isDef()) {
218 CallInst* local_cdep = cast<CallInst>(local_dep.getInst());
219
Gabor Greif237e1da2010-06-30 09:17:53 +0000220 if (local_cdep->getNumArgOperands() != C->getNumArgOperands()) {
Owen Andersond41ed4e2009-10-19 22:14:22 +0000221 valueNumbering[C] = nextValueNumber;
222 return nextValueNumber++;
223 }
224
Gabor Greifd883a9d2010-06-24 10:17:17 +0000225 for (unsigned i = 0, e = C->getNumArgOperands(); i < e; ++i) {
226 uint32_t c_vn = lookup_or_add(C->getArgOperand(i));
227 uint32_t cd_vn = lookup_or_add(local_cdep->getArgOperand(i));
Owen Andersond41ed4e2009-10-19 22:14:22 +0000228 if (c_vn != cd_vn) {
229 valueNumbering[C] = nextValueNumber;
230 return nextValueNumber++;
231 }
232 }
233
234 uint32_t v = lookup_or_add(local_cdep);
235 valueNumbering[C] = v;
236 return v;
237 }
238
239 // Non-local case.
240 const MemoryDependenceAnalysis::NonLocalDepInfo &deps =
241 MD->getNonLocalCallDependency(CallSite(C));
242 // FIXME: call/call dependencies for readonly calls should return def, not
243 // clobber! Move the checking logic to MemDep!
244 CallInst* cdep = 0;
245
246 // Check to see if we have a single dominating call instruction that is
247 // identical to C.
248 for (unsigned i = 0, e = deps.size(); i != e; ++i) {
Chris Lattnere18b9712009-12-09 07:08:01 +0000249 const NonLocalDepEntry *I = &deps[i];
Owen Andersond41ed4e2009-10-19 22:14:22 +0000250 // Ignore non-local dependencies.
Chris Lattnere18b9712009-12-09 07:08:01 +0000251 if (I->getResult().isNonLocal())
Owen Andersond41ed4e2009-10-19 22:14:22 +0000252 continue;
253
254 // We don't handle non-depedencies. If we already have a call, reject
255 // instruction dependencies.
Chris Lattnere18b9712009-12-09 07:08:01 +0000256 if (I->getResult().isClobber() || cdep != 0) {
Owen Andersond41ed4e2009-10-19 22:14:22 +0000257 cdep = 0;
258 break;
259 }
260
Chris Lattnere18b9712009-12-09 07:08:01 +0000261 CallInst *NonLocalDepCall = dyn_cast<CallInst>(I->getResult().getInst());
Owen Andersond41ed4e2009-10-19 22:14:22 +0000262 // FIXME: All duplicated with non-local case.
Chris Lattnere18b9712009-12-09 07:08:01 +0000263 if (NonLocalDepCall && DT->properlyDominates(I->getBB(), C->getParent())){
Owen Andersond41ed4e2009-10-19 22:14:22 +0000264 cdep = NonLocalDepCall;
265 continue;
266 }
267
268 cdep = 0;
269 break;
270 }
271
272 if (!cdep) {
273 valueNumbering[C] = nextValueNumber;
274 return nextValueNumber++;
275 }
276
Gabor Greif237e1da2010-06-30 09:17:53 +0000277 if (cdep->getNumArgOperands() != C->getNumArgOperands()) {
Owen Andersond41ed4e2009-10-19 22:14:22 +0000278 valueNumbering[C] = nextValueNumber;
279 return nextValueNumber++;
280 }
Gabor Greifd883a9d2010-06-24 10:17:17 +0000281 for (unsigned i = 0, e = C->getNumArgOperands(); i < e; ++i) {
282 uint32_t c_vn = lookup_or_add(C->getArgOperand(i));
283 uint32_t cd_vn = lookup_or_add(cdep->getArgOperand(i));
Owen Andersond41ed4e2009-10-19 22:14:22 +0000284 if (c_vn != cd_vn) {
285 valueNumbering[C] = nextValueNumber;
286 return nextValueNumber++;
287 }
288 }
289
290 uint32_t v = lookup_or_add(cdep);
291 valueNumbering[C] = v;
292 return v;
293
294 } else {
295 valueNumbering[C] = nextValueNumber;
296 return nextValueNumber++;
297 }
298}
299
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000300/// lookup_or_add - Returns the value number for the specified value, assigning
301/// it a new number if it did not have one before.
Chris Lattnerb2412a82009-09-21 02:42:51 +0000302uint32_t ValueTable::lookup_or_add(Value *V) {
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000303 DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
304 if (VI != valueNumbering.end())
305 return VI->second;
Daniel Dunbara279bc32009-09-20 02:20:51 +0000306
Owen Andersond41ed4e2009-10-19 22:14:22 +0000307 if (!isa<Instruction>(V)) {
Owen Anderson158d86e2009-10-19 21:14:57 +0000308 valueNumbering[V] = nextValueNumber;
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000309 return nextValueNumber++;
310 }
Owen Andersond41ed4e2009-10-19 22:14:22 +0000311
312 Instruction* I = cast<Instruction>(V);
313 Expression exp;
314 switch (I->getOpcode()) {
315 case Instruction::Call:
316 return lookup_or_add_call(cast<CallInst>(I));
317 case Instruction::Add:
318 case Instruction::FAdd:
319 case Instruction::Sub:
320 case Instruction::FSub:
321 case Instruction::Mul:
322 case Instruction::FMul:
323 case Instruction::UDiv:
324 case Instruction::SDiv:
325 case Instruction::FDiv:
326 case Instruction::URem:
327 case Instruction::SRem:
328 case Instruction::FRem:
329 case Instruction::Shl:
330 case Instruction::LShr:
331 case Instruction::AShr:
332 case Instruction::And:
333 case Instruction::Or :
334 case Instruction::Xor:
Owen Andersond41ed4e2009-10-19 22:14:22 +0000335 case Instruction::ICmp:
336 case Instruction::FCmp:
Owen Andersond41ed4e2009-10-19 22:14:22 +0000337 case Instruction::Trunc:
338 case Instruction::ZExt:
339 case Instruction::SExt:
340 case Instruction::FPToUI:
341 case Instruction::FPToSI:
342 case Instruction::UIToFP:
343 case Instruction::SIToFP:
344 case Instruction::FPTrunc:
345 case Instruction::FPExt:
346 case Instruction::PtrToInt:
347 case Instruction::IntToPtr:
348 case Instruction::BitCast:
Owen Andersond41ed4e2009-10-19 22:14:22 +0000349 case Instruction::Select:
Owen Andersond41ed4e2009-10-19 22:14:22 +0000350 case Instruction::ExtractElement:
Owen Andersond41ed4e2009-10-19 22:14:22 +0000351 case Instruction::InsertElement:
Owen Andersond41ed4e2009-10-19 22:14:22 +0000352 case Instruction::ShuffleVector:
Owen Andersond41ed4e2009-10-19 22:14:22 +0000353 case Instruction::ExtractValue:
Owen Andersond41ed4e2009-10-19 22:14:22 +0000354 case Instruction::InsertValue:
Owen Andersond41ed4e2009-10-19 22:14:22 +0000355 case Instruction::GetElementPtr:
Owen Anderson30f4a552011-01-03 19:00:11 +0000356 exp = create_expression(I);
Owen Andersond41ed4e2009-10-19 22:14:22 +0000357 break;
358 default:
359 valueNumbering[V] = nextValueNumber;
360 return nextValueNumber++;
361 }
362
363 uint32_t& e = expressionNumbering[exp];
364 if (!e) e = nextValueNumber++;
365 valueNumbering[V] = e;
366 return e;
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000367}
368
369/// lookup - Returns the value number of the specified value. Fails if
370/// the value has not yet been numbered.
Chris Lattnerb2412a82009-09-21 02:42:51 +0000371uint32_t ValueTable::lookup(Value *V) const {
Jeffrey Yasskin81cf4322009-11-10 01:02:17 +0000372 DenseMap<Value*, uint32_t>::const_iterator VI = valueNumbering.find(V);
Chris Lattner88365bb2008-03-21 21:14:38 +0000373 assert(VI != valueNumbering.end() && "Value not numbered?");
374 return VI->second;
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000375}
376
377/// clear - Remove all entries from the ValueTable
378void ValueTable::clear() {
379 valueNumbering.clear();
380 expressionNumbering.clear();
381 nextValueNumber = 1;
382}
383
Owen Andersonbf7d0bc2007-07-31 23:27:13 +0000384/// erase - Remove a value from the value numbering
Chris Lattnerb2412a82009-09-21 02:42:51 +0000385void ValueTable::erase(Value *V) {
Owen Andersonbf7d0bc2007-07-31 23:27:13 +0000386 valueNumbering.erase(V);
387}
388
Bill Wendling246dbbb2008-12-22 21:36:08 +0000389/// verifyRemoved - Verify that the value is removed from all internal data
390/// structures.
391void ValueTable::verifyRemoved(const Value *V) const {
Jeffrey Yasskin81cf4322009-11-10 01:02:17 +0000392 for (DenseMap<Value*, uint32_t>::const_iterator
Bill Wendling246dbbb2008-12-22 21:36:08 +0000393 I = valueNumbering.begin(), E = valueNumbering.end(); I != E; ++I) {
394 assert(I->first != V && "Inst still occurs in value numbering map!");
395 }
396}
397
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000398//===----------------------------------------------------------------------===//
Bill Wendling30788b82008-12-22 22:32:22 +0000399// GVN Pass
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000400//===----------------------------------------------------------------------===//
401
402namespace {
403
Chris Lattner3e8b6632009-09-02 06:11:42 +0000404 class GVN : public FunctionPass {
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000405 bool runOnFunction(Function &F);
406 public:
407 static char ID; // Pass identification, replacement for typeid
Bob Wilsonb29d7d22010-02-28 05:34:05 +0000408 explicit GVN(bool noloads = false)
Owen Anderson081c34b2010-10-19 17:21:58 +0000409 : FunctionPass(ID), NoLoads(noloads), MD(0) {
410 initializeGVNPass(*PassRegistry::getPassRegistry());
411 }
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000412
413 private:
Dan Gohman4ec01b22009-11-14 02:27:51 +0000414 bool NoLoads;
Chris Lattner663e4412008-12-01 00:40:32 +0000415 MemoryDependenceAnalysis *MD;
416 DominatorTree *DT;
Duncan Sands88c3df72010-11-12 21:10:24 +0000417 const TargetData* TD;
Chris Lattner663e4412008-12-01 00:40:32 +0000418
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000419 ValueTable VN;
Owen Andersona04a0642010-11-18 18:32:40 +0000420
Owen Anderson68c26392010-11-19 22:48:40 +0000421 /// NumberTable - A mapping from value numers to lists of Value*'s that
422 /// have that value number. Use lookupNumber to query it.
Owen Andersonf0568382010-12-21 23:54:34 +0000423 struct NumberTableEntry {
424 Value *Val;
425 BasicBlock *BB;
426 NumberTableEntry *Next;
427 };
428 DenseMap<uint32_t, NumberTableEntry> NumberTable;
Owen Andersona04a0642010-11-18 18:32:40 +0000429 BumpPtrAllocator TableAllocator;
Owen Anderson68c26392010-11-19 22:48:40 +0000430
431 /// insert_table - Push a new Value to the NumberTable onto the list for
432 /// its value number.
Owen Andersonf0568382010-12-21 23:54:34 +0000433 void insert_table(uint32_t N, Value *V, BasicBlock *BB) {
434 NumberTableEntry& Curr = NumberTable[N];
435 if (!Curr.Val) {
436 Curr.Val = V;
437 Curr.BB = BB;
Owen Andersona04a0642010-11-18 18:32:40 +0000438 return;
439 }
440
Owen Andersonf0568382010-12-21 23:54:34 +0000441 NumberTableEntry* Node = TableAllocator.Allocate<NumberTableEntry>();
442 Node->Val = V;
443 Node->BB = BB;
444 Node->Next = Curr.Next;
445 Curr.Next = Node;
Owen Andersona04a0642010-11-18 18:32:40 +0000446 }
447
Owen Anderson68c26392010-11-19 22:48:40 +0000448 /// erase_table - Scan the list of values corresponding to a given value
449 /// number, and remove the given value if encountered.
Owen Andersonf0568382010-12-21 23:54:34 +0000450 void erase_table(uint32_t N, Value *V, BasicBlock *BB) {
451 NumberTableEntry* Prev = 0;
452 NumberTableEntry* Curr = &NumberTable[N];
Owen Andersona04a0642010-11-18 18:32:40 +0000453
Owen Andersonf0568382010-12-21 23:54:34 +0000454 while (Curr->Val != V || Curr->BB != BB) {
Owen Andersona04a0642010-11-18 18:32:40 +0000455 Prev = Curr;
Owen Andersonf0568382010-12-21 23:54:34 +0000456 Curr = Curr->Next;
Owen Andersona04a0642010-11-18 18:32:40 +0000457 }
458
459 if (Prev) {
Owen Andersonf0568382010-12-21 23:54:34 +0000460 Prev->Next = Curr->Next;
Owen Andersona04a0642010-11-18 18:32:40 +0000461 } else {
Owen Andersonf0568382010-12-21 23:54:34 +0000462 if (!Curr->Next) {
463 Curr->Val = 0;
464 Curr->BB = 0;
Owen Andersona04a0642010-11-18 18:32:40 +0000465 } else {
Owen Andersonf0568382010-12-21 23:54:34 +0000466 NumberTableEntry* Next = Curr->Next;
467 Curr->Val = Next->Val;
468 Curr->BB = Next->BB;
Owen Anderson680ac4f2011-01-04 19:10:54 +0000469 Curr->Next = Next->Next;
Owen Andersona04a0642010-11-18 18:32:40 +0000470 }
471 }
472 }
Daniel Dunbara279bc32009-09-20 02:20:51 +0000473
Bob Wilson484d4a32010-02-16 19:51:59 +0000474 // List of critical edges to be split between iterations.
475 SmallVector<std::pair<TerminatorInst*, unsigned>, 4> toSplit;
476
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000477 // This transformation requires dominator postdominator info
478 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000479 AU.addRequired<DominatorTree>();
Dan Gohman4ec01b22009-11-14 02:27:51 +0000480 if (!NoLoads)
481 AU.addRequired<MemoryDependenceAnalysis>();
Owen Andersonb388ca92007-10-18 19:39:33 +0000482 AU.addRequired<AliasAnalysis>();
Daniel Dunbara279bc32009-09-20 02:20:51 +0000483
Owen Andersonb70a5712008-06-23 17:49:45 +0000484 AU.addPreserved<DominatorTree>();
Owen Andersonb388ca92007-10-18 19:39:33 +0000485 AU.addPreserved<AliasAnalysis>();
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000486 }
Daniel Dunbara279bc32009-09-20 02:20:51 +0000487
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000488 // Helper fuctions
489 // FIXME: eliminate or document these better
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000490 bool processLoad(LoadInst* L,
Chris Lattner8e1e95c2008-03-21 22:01:16 +0000491 SmallVectorImpl<Instruction*> &toErase);
Chris Lattnerb2412a82009-09-21 02:42:51 +0000492 bool processInstruction(Instruction *I,
Chris Lattner8e1e95c2008-03-21 22:01:16 +0000493 SmallVectorImpl<Instruction*> &toErase);
Owen Anderson830db6a2007-08-02 18:16:06 +0000494 bool processNonLocalLoad(LoadInst* L,
Chris Lattner8e1e95c2008-03-21 22:01:16 +0000495 SmallVectorImpl<Instruction*> &toErase);
Chris Lattnerb2412a82009-09-21 02:42:51 +0000496 bool processBlock(BasicBlock *BB);
Owen Andersonb2303722008-06-18 21:41:49 +0000497 void dump(DenseMap<uint32_t, Value*>& d);
Owen Anderson3e75a422007-08-14 18:04:11 +0000498 bool iterateOnFunction(Function &F);
Owen Andersonb2303722008-06-18 21:41:49 +0000499 bool performPRE(Function& F);
Chris Lattnerb2412a82009-09-21 02:42:51 +0000500 Value *lookupNumber(BasicBlock *BB, uint32_t num);
Nuno Lopes7cdd9ee2008-10-10 16:25:50 +0000501 void cleanupGlobalSets();
Bill Wendling246dbbb2008-12-22 21:36:08 +0000502 void verifyRemoved(const Instruction *I) const;
Bob Wilson484d4a32010-02-16 19:51:59 +0000503 bool splitCriticalEdges();
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000504 };
Daniel Dunbara279bc32009-09-20 02:20:51 +0000505
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000506 char GVN::ID = 0;
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000507}
508
509// createGVNPass - The public interface to this file...
Bob Wilsonb29d7d22010-02-28 05:34:05 +0000510FunctionPass *llvm::createGVNPass(bool NoLoads) {
511 return new GVN(NoLoads);
Dan Gohman4ec01b22009-11-14 02:27:51 +0000512}
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000513
Owen Anderson2ab36d32010-10-12 19:48:12 +0000514INITIALIZE_PASS_BEGIN(GVN, "gvn", "Global Value Numbering", false, false)
515INITIALIZE_PASS_DEPENDENCY(MemoryDependenceAnalysis)
516INITIALIZE_PASS_DEPENDENCY(DominatorTree)
517INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
518INITIALIZE_PASS_END(GVN, "gvn", "Global Value Numbering", false, false)
Owen Anderson1ad2cb72007-07-24 17:55:58 +0000519
Owen Andersonb2303722008-06-18 21:41:49 +0000520void GVN::dump(DenseMap<uint32_t, Value*>& d) {
Dan Gohmanad12b262009-12-18 03:25:51 +0000521 errs() << "{\n";
Owen Andersonb2303722008-06-18 21:41:49 +0000522 for (DenseMap<uint32_t, Value*>::iterator I = d.begin(),
Owen Anderson0cd32032007-07-25 19:57:03 +0000523 E = d.end(); I != E; ++I) {
Dan Gohmanad12b262009-12-18 03:25:51 +0000524 errs() << I->first << "\n";
Owen Anderson0cd32032007-07-25 19:57:03 +0000525 I->second->dump();
526 }
Dan Gohmanad12b262009-12-18 03:25:51 +0000527 errs() << "}\n";
Owen Anderson0cd32032007-07-25 19:57:03 +0000528}
529
Chris Lattnerc89c6a92008-12-02 08:16:11 +0000530/// IsValueFullyAvailableInBlock - Return true if we can prove that the value
531/// we're analyzing is fully available in the specified block. As we go, keep
Chris Lattner72bc70d2008-12-05 07:49:08 +0000532/// track of which blocks we know are fully alive in FullyAvailableBlocks. This
533/// map is actually a tri-state map with the following values:
534/// 0) we know the block *is not* fully available.
535/// 1) we know the block *is* fully available.
536/// 2) we do not know whether the block is fully available or not, but we are
537/// currently speculating that it will be.
538/// 3) we are speculating for this block and have used that to speculate for
539/// other blocks.
Daniel Dunbara279bc32009-09-20 02:20:51 +0000540static bool IsValueFullyAvailableInBlock(BasicBlock *BB,
Chris Lattner72bc70d2008-12-05 07:49:08 +0000541 DenseMap<BasicBlock*, char> &FullyAvailableBlocks) {
Chris Lattnerc89c6a92008-12-02 08:16:11 +0000542 // Optimistically assume that the block is fully available and check to see
543 // if we already know about this block in one lookup.
Daniel Dunbara279bc32009-09-20 02:20:51 +0000544 std::pair<DenseMap<BasicBlock*, char>::iterator, char> IV =
Chris Lattner72bc70d2008-12-05 07:49:08 +0000545 FullyAvailableBlocks.insert(std::make_pair(BB, 2));
Chris Lattnerc89c6a92008-12-02 08:16:11 +0000546
547 // If the entry already existed for this block, return the precomputed value.
Chris Lattner72bc70d2008-12-05 07:49:08 +0000548 if (!IV.second) {
549 // If this is a speculative "available" value, mark it as being used for
550 // speculation of other blocks.
551 if (IV.first->second == 2)
552 IV.first->second = 3;
553 return IV.first->second != 0;
554 }
Daniel Dunbara279bc32009-09-20 02:20:51 +0000555
Chris Lattnerc89c6a92008-12-02 08:16:11 +0000556 // Otherwise, see if it is fully available in all predecessors.
557 pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
Daniel Dunbara279bc32009-09-20 02:20:51 +0000558
Chris Lattnerc89c6a92008-12-02 08:16:11 +0000559 // If this block has no predecessors, it isn't live-in here.
560 if (PI == PE)
Chris Lattner72bc70d2008-12-05 07:49:08 +0000561 goto SpeculationFailure;
Daniel Dunbara279bc32009-09-20 02:20:51 +0000562
Chris Lattnerc89c6a92008-12-02 08:16:11 +0000563 for (; PI != PE; ++PI)
564 // If the value isn't fully available in one of our predecessors, then it
565 // isn't fully available in this block either. Undo our previous
566 // optimistic assumption and bail out.
567 if (!IsValueFullyAvailableInBlock(*PI, FullyAvailableBlocks))
Chris Lattner72bc70d2008-12-05 07:49:08 +0000568 goto SpeculationFailure;
Daniel Dunbara279bc32009-09-20 02:20:51 +0000569
Chris Lattnerc89c6a92008-12-02 08:16:11 +0000570 return true;
Daniel Dunbara279bc32009-09-20 02:20:51 +0000571
Chris Lattner72bc70d2008-12-05 07:49:08 +0000572// SpeculationFailure - If we get here, we found out that this is not, after
573// all, a fully-available block. We have a problem if we speculated on this and
574// used the speculation to mark other blocks as available.
575SpeculationFailure:
576 char &BBVal = FullyAvailableBlocks[BB];
Daniel Dunbara279bc32009-09-20 02:20:51 +0000577
Chris Lattner72bc70d2008-12-05 07:49:08 +0000578 // If we didn't speculate on this, just return with it set to false.
579 if (BBVal == 2) {
580 BBVal = 0;
581 return false;
582 }
583
584 // If we did speculate on this value, we could have blocks set to 1 that are
585 // incorrect. Walk the (transitive) successors of this block and mark them as
586 // 0 if set to one.
587 SmallVector<BasicBlock*, 32> BBWorklist;
588 BBWorklist.push_back(BB);
Daniel Dunbara279bc32009-09-20 02:20:51 +0000589
Dan Gohman321a8132010-01-05 16:27:25 +0000590 do {
Chris Lattner72bc70d2008-12-05 07:49:08 +0000591 BasicBlock *Entry = BBWorklist.pop_back_val();
592 // Note that this sets blocks to 0 (unavailable) if they happen to not
593 // already be in FullyAvailableBlocks. This is safe.
594 char &EntryVal = FullyAvailableBlocks[Entry];
595 if (EntryVal == 0) continue; // Already unavailable.
596
597 // Mark as unavailable.
598 EntryVal = 0;
Daniel Dunbara279bc32009-09-20 02:20:51 +0000599
Chris Lattner72bc70d2008-12-05 07:49:08 +0000600 for (succ_iterator I = succ_begin(Entry), E = succ_end(Entry); I != E; ++I)
601 BBWorklist.push_back(*I);
Dan Gohman321a8132010-01-05 16:27:25 +0000602 } while (!BBWorklist.empty());
Daniel Dunbara279bc32009-09-20 02:20:51 +0000603
Chris Lattner72bc70d2008-12-05 07:49:08 +0000604 return false;
Chris Lattnerc89c6a92008-12-02 08:16:11 +0000605}
606
Chris Lattner771a5422009-09-20 20:09:34 +0000607
Chris Lattner8b2bc3d2009-09-21 17:24:04 +0000608/// CanCoerceMustAliasedValueToLoad - Return true if
609/// CoerceAvailableValueToLoadType will succeed.
610static bool CanCoerceMustAliasedValueToLoad(Value *StoredVal,
611 const Type *LoadTy,
612 const TargetData &TD) {
613 // If the loaded or stored value is an first class array or struct, don't try
614 // to transform them. We need to be able to bitcast to integer.
Duncan Sands1df98592010-02-16 11:11:14 +0000615 if (LoadTy->isStructTy() || LoadTy->isArrayTy() ||
616 StoredVal->getType()->isStructTy() ||
617 StoredVal->getType()->isArrayTy())
Chris Lattner8b2bc3d2009-09-21 17:24:04 +0000618 return false;
619
620 // The store has to be at least as big as the load.
621 if (TD.getTypeSizeInBits(StoredVal->getType()) <
622 TD.getTypeSizeInBits(LoadTy))
623 return false;
624
625 return true;
626}
627
628
Chris Lattner771a5422009-09-20 20:09:34 +0000629/// CoerceAvailableValueToLoadType - If we saw a store of a value to memory, and
630/// then a load from a must-aliased pointer of a different type, try to coerce
631/// the stored value. LoadedTy is the type of the load we want to replace and
632/// InsertPt is the place to insert new instructions.
633///
634/// If we can't do it, return null.
635static Value *CoerceAvailableValueToLoadType(Value *StoredVal,
636 const Type *LoadedTy,
637 Instruction *InsertPt,
638 const TargetData &TD) {
Chris Lattner8b2bc3d2009-09-21 17:24:04 +0000639 if (!CanCoerceMustAliasedValueToLoad(StoredVal, LoadedTy, TD))
640 return 0;
641
Chris Lattner771a5422009-09-20 20:09:34 +0000642 const Type *StoredValTy = StoredVal->getType();
643
Chris Lattner7944c212010-05-08 20:01:44 +0000644 uint64_t StoreSize = TD.getTypeStoreSizeInBits(StoredValTy);
Chris Lattner771a5422009-09-20 20:09:34 +0000645 uint64_t LoadSize = TD.getTypeSizeInBits(LoadedTy);
646
647 // If the store and reload are the same size, we can always reuse it.
648 if (StoreSize == LoadSize) {
Duncan Sands1df98592010-02-16 11:11:14 +0000649 if (StoredValTy->isPointerTy() && LoadedTy->isPointerTy()) {
Chris Lattner771a5422009-09-20 20:09:34 +0000650 // Pointer to Pointer -> use bitcast.
651 return new BitCastInst(StoredVal, LoadedTy, "", InsertPt);
652 }
653
654 // Convert source pointers to integers, which can be bitcast.
Duncan Sands1df98592010-02-16 11:11:14 +0000655 if (StoredValTy->isPointerTy()) {
Chris Lattner771a5422009-09-20 20:09:34 +0000656 StoredValTy = TD.getIntPtrType(StoredValTy->getContext());
657 StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
658 }
659
660 const Type *TypeToCastTo = LoadedTy;
Duncan Sands1df98592010-02-16 11:11:14 +0000661 if (TypeToCastTo->isPointerTy())
Chris Lattner771a5422009-09-20 20:09:34 +0000662 TypeToCastTo = TD.getIntPtrType(StoredValTy->getContext());
663
664 if (StoredValTy != TypeToCastTo)
665 StoredVal = new BitCastInst(StoredVal, TypeToCastTo, "", InsertPt);
666
667 // Cast to pointer if the load needs a pointer type.
Duncan Sands1df98592010-02-16 11:11:14 +0000668 if (LoadedTy->isPointerTy())
Chris Lattner771a5422009-09-20 20:09:34 +0000669 StoredVal = new IntToPtrInst(StoredVal, LoadedTy, "", InsertPt);
670
671 return StoredVal;
672 }
673
674 // If the loaded value is smaller than the available value, then we can
675 // extract out a piece from it. If the available value is too small, then we
676 // can't do anything.
Chris Lattner8b2bc3d2009-09-21 17:24:04 +0000677 assert(StoreSize >= LoadSize && "CanCoerceMustAliasedValueToLoad fail");
Chris Lattner771a5422009-09-20 20:09:34 +0000678
679 // Convert source pointers to integers, which can be manipulated.
Duncan Sands1df98592010-02-16 11:11:14 +0000680 if (StoredValTy->isPointerTy()) {
Chris Lattner771a5422009-09-20 20:09:34 +0000681 StoredValTy = TD.getIntPtrType(StoredValTy->getContext());
682 StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
683 }
684
685 // Convert vectors and fp to integer, which can be manipulated.
Duncan Sands1df98592010-02-16 11:11:14 +0000686 if (!StoredValTy->isIntegerTy()) {
Chris Lattner771a5422009-09-20 20:09:34 +0000687 StoredValTy = IntegerType::get(StoredValTy->getContext(), StoreSize);
688 StoredVal = new BitCastInst(StoredVal, StoredValTy, "", InsertPt);
689 }
690
691 // If this is a big-endian system, we need to shift the value down to the low
692 // bits so that a truncate will work.
693 if (TD.isBigEndian()) {
694 Constant *Val = ConstantInt::get(StoredVal->getType(), StoreSize-LoadSize);
695 StoredVal = BinaryOperator::CreateLShr(StoredVal, Val, "tmp", InsertPt);
696 }
697
698 // Truncate the integer to the right size now.
699 const Type *NewIntTy = IntegerType::get(StoredValTy->getContext(), LoadSize);
700 StoredVal = new TruncInst(StoredVal, NewIntTy, "trunc", InsertPt);
701
702 if (LoadedTy == NewIntTy)
703 return StoredVal;
704
705 // If the result is a pointer, inttoptr.
Duncan Sands1df98592010-02-16 11:11:14 +0000706 if (LoadedTy->isPointerTy())
Chris Lattner771a5422009-09-20 20:09:34 +0000707 return new IntToPtrInst(StoredVal, LoadedTy, "inttoptr", InsertPt);
708
709 // Otherwise, bitcast.
710 return new BitCastInst(StoredVal, LoadedTy, "bitcast", InsertPt);
711}
712
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000713/// AnalyzeLoadFromClobberingWrite - This function is called when we have a
714/// memdep query of a load that ends up being a clobbering memory write (store,
715/// memset, memcpy, memmove). This means that the write *may* provide bits used
716/// by the load but we can't be sure because the pointers don't mustalias.
717///
718/// Check this case to see if there is anything more we can do before we give
719/// up. This returns -1 if we have to give up, or a byte number in the stored
720/// value of the piece that feeds the load.
Chris Lattner03f17da2009-12-09 07:34:10 +0000721static int AnalyzeLoadFromClobberingWrite(const Type *LoadTy, Value *LoadPtr,
722 Value *WritePtr,
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000723 uint64_t WriteSizeInBits,
Chris Lattner4fbd14e2009-09-21 06:48:08 +0000724 const TargetData &TD) {
Chris Lattner8b2bc3d2009-09-21 17:24:04 +0000725 // If the loaded or stored value is an first class array or struct, don't try
726 // to transform them. We need to be able to bitcast to integer.
Duncan Sands1df98592010-02-16 11:11:14 +0000727 if (LoadTy->isStructTy() || LoadTy->isArrayTy())
Chris Lattner8b2bc3d2009-09-21 17:24:04 +0000728 return -1;
729
Chris Lattnerca749402009-09-21 06:24:16 +0000730 int64_t StoreOffset = 0, LoadOffset = 0;
Chris Lattnered58a6f2010-11-30 22:25:26 +0000731 Value *StoreBase = GetPointerBaseWithConstantOffset(WritePtr, StoreOffset,TD);
732 Value *LoadBase = GetPointerBaseWithConstantOffset(LoadPtr, LoadOffset, TD);
Chris Lattnerca749402009-09-21 06:24:16 +0000733 if (StoreBase != LoadBase)
734 return -1;
735
736 // If the load and store are to the exact same address, they should have been
737 // a must alias. AA must have gotten confused.
Chris Lattner219d7742010-03-25 05:58:19 +0000738 // FIXME: Study to see if/when this happens. One case is forwarding a memset
739 // to a load from the base of the memset.
Chris Lattnerca749402009-09-21 06:24:16 +0000740#if 0
Chris Lattner219d7742010-03-25 05:58:19 +0000741 if (LoadOffset == StoreOffset) {
David Greenebf7f78e2010-01-05 01:27:17 +0000742 dbgs() << "STORE/LOAD DEP WITH COMMON POINTER MISSED:\n"
Chris Lattnerca749402009-09-21 06:24:16 +0000743 << "Base = " << *StoreBase << "\n"
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000744 << "Store Ptr = " << *WritePtr << "\n"
745 << "Store Offs = " << StoreOffset << "\n"
Chris Lattnerb6760b42009-12-10 00:04:46 +0000746 << "Load Ptr = " << *LoadPtr << "\n";
Chris Lattnerb3f927f2009-12-09 02:41:54 +0000747 abort();
Chris Lattnerca749402009-09-21 06:24:16 +0000748 }
Chris Lattner219d7742010-03-25 05:58:19 +0000749#endif
Chris Lattnerca749402009-09-21 06:24:16 +0000750
751 // If the load and store don't overlap at all, the store doesn't provide
752 // anything to the load. In this case, they really don't alias at all, AA
753 // must have gotten confused.
Chris Lattner03f17da2009-12-09 07:34:10 +0000754 uint64_t LoadSize = TD.getTypeSizeInBits(LoadTy);
Chris Lattnerca749402009-09-21 06:24:16 +0000755
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000756 if ((WriteSizeInBits & 7) | (LoadSize & 7))
Chris Lattnerca749402009-09-21 06:24:16 +0000757 return -1;
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000758 uint64_t StoreSize = WriteSizeInBits >> 3; // Convert to bytes.
Chris Lattnerca749402009-09-21 06:24:16 +0000759 LoadSize >>= 3;
760
761
762 bool isAAFailure = false;
Chris Lattner219d7742010-03-25 05:58:19 +0000763 if (StoreOffset < LoadOffset)
Chris Lattnerca749402009-09-21 06:24:16 +0000764 isAAFailure = StoreOffset+int64_t(StoreSize) <= LoadOffset;
Chris Lattner219d7742010-03-25 05:58:19 +0000765 else
Chris Lattnerca749402009-09-21 06:24:16 +0000766 isAAFailure = LoadOffset+int64_t(LoadSize) <= StoreOffset;
Chris Lattner219d7742010-03-25 05:58:19 +0000767
Chris Lattnerca749402009-09-21 06:24:16 +0000768 if (isAAFailure) {
769#if 0
David Greenebf7f78e2010-01-05 01:27:17 +0000770 dbgs() << "STORE LOAD DEP WITH COMMON BASE:\n"
Chris Lattnerca749402009-09-21 06:24:16 +0000771 << "Base = " << *StoreBase << "\n"
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000772 << "Store Ptr = " << *WritePtr << "\n"
773 << "Store Offs = " << StoreOffset << "\n"
Chris Lattnerb6760b42009-12-10 00:04:46 +0000774 << "Load Ptr = " << *LoadPtr << "\n";
Chris Lattnerb3f927f2009-12-09 02:41:54 +0000775 abort();
Chris Lattnerca749402009-09-21 06:24:16 +0000776#endif
777 return -1;
778 }
779
780 // If the Load isn't completely contained within the stored bits, we don't
781 // have all the bits to feed it. We could do something crazy in the future
782 // (issue a smaller load then merge the bits in) but this seems unlikely to be
783 // valuable.
784 if (StoreOffset > LoadOffset ||
785 StoreOffset+StoreSize < LoadOffset+LoadSize)
786 return -1;
787
788 // Okay, we can do this transformation. Return the number of bytes into the
789 // store that the load is.
790 return LoadOffset-StoreOffset;
791}
792
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000793/// AnalyzeLoadFromClobberingStore - This function is called when we have a
794/// memdep query of a load that ends up being a clobbering store.
Chris Lattner4ca70fe2009-12-09 07:37:07 +0000795static int AnalyzeLoadFromClobberingStore(const Type *LoadTy, Value *LoadPtr,
796 StoreInst *DepSI,
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000797 const TargetData &TD) {
798 // Cannot handle reading from store of first-class aggregate yet.
Dan Gohman3355c4e2010-11-10 19:03:33 +0000799 if (DepSI->getValueOperand()->getType()->isStructTy() ||
800 DepSI->getValueOperand()->getType()->isArrayTy())
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000801 return -1;
802
803 Value *StorePtr = DepSI->getPointerOperand();
Dan Gohman3355c4e2010-11-10 19:03:33 +0000804 uint64_t StoreSize =TD.getTypeSizeInBits(DepSI->getValueOperand()->getType());
Chris Lattner4ca70fe2009-12-09 07:37:07 +0000805 return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr,
Chris Lattner03f17da2009-12-09 07:34:10 +0000806 StorePtr, StoreSize, TD);
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000807}
808
Chris Lattner4ca70fe2009-12-09 07:37:07 +0000809static int AnalyzeLoadFromClobberingMemInst(const Type *LoadTy, Value *LoadPtr,
810 MemIntrinsic *MI,
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000811 const TargetData &TD) {
812 // If the mem operation is a non-constant size, we can't handle it.
813 ConstantInt *SizeCst = dyn_cast<ConstantInt>(MI->getLength());
814 if (SizeCst == 0) return -1;
815 uint64_t MemSizeInBits = SizeCst->getZExtValue()*8;
Chris Lattnerbc9a28d2009-12-06 05:29:56 +0000816
817 // If this is memset, we just need to see if the offset is valid in the size
818 // of the memset..
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000819 if (MI->getIntrinsicID() == Intrinsic::memset)
Chris Lattner4ca70fe2009-12-09 07:37:07 +0000820 return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr, MI->getDest(),
821 MemSizeInBits, TD);
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000822
Chris Lattnerbc9a28d2009-12-06 05:29:56 +0000823 // If we have a memcpy/memmove, the only case we can handle is if this is a
824 // copy from constant memory. In that case, we can read directly from the
825 // constant memory.
826 MemTransferInst *MTI = cast<MemTransferInst>(MI);
827
828 Constant *Src = dyn_cast<Constant>(MTI->getSource());
829 if (Src == 0) return -1;
830
Dan Gohman5034dd32010-12-15 20:02:24 +0000831 GlobalVariable *GV = dyn_cast<GlobalVariable>(GetUnderlyingObject(Src));
Chris Lattnerbc9a28d2009-12-06 05:29:56 +0000832 if (GV == 0 || !GV->isConstant()) return -1;
833
834 // See if the access is within the bounds of the transfer.
Chris Lattner4ca70fe2009-12-09 07:37:07 +0000835 int Offset = AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr,
836 MI->getDest(), MemSizeInBits, TD);
Chris Lattnerbc9a28d2009-12-06 05:29:56 +0000837 if (Offset == -1)
838 return Offset;
839
840 // Otherwise, see if we can constant fold a load from the constant with the
841 // offset applied as appropriate.
842 Src = ConstantExpr::getBitCast(Src,
843 llvm::Type::getInt8PtrTy(Src->getContext()));
844 Constant *OffsetCst =
845 ConstantInt::get(Type::getInt64Ty(Src->getContext()), (unsigned)Offset);
846 Src = ConstantExpr::getGetElementPtr(Src, &OffsetCst, 1);
Chris Lattner4ca70fe2009-12-09 07:37:07 +0000847 Src = ConstantExpr::getBitCast(Src, PointerType::getUnqual(LoadTy));
Chris Lattnerbc9a28d2009-12-06 05:29:56 +0000848 if (ConstantFoldLoadFromConstPtr(Src, &TD))
849 return Offset;
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000850 return -1;
851}
852
Chris Lattnerca749402009-09-21 06:24:16 +0000853
854/// GetStoreValueForLoad - This function is called when we have a
855/// memdep query of a load that ends up being a clobbering store. This means
856/// that the store *may* provide bits used by the load but we can't be sure
857/// because the pointers don't mustalias. Check this case to see if there is
858/// anything more we can do before we give up.
Chris Lattner4fbd14e2009-09-21 06:48:08 +0000859static Value *GetStoreValueForLoad(Value *SrcVal, unsigned Offset,
860 const Type *LoadTy,
861 Instruction *InsertPt, const TargetData &TD){
Chris Lattnerca749402009-09-21 06:24:16 +0000862 LLVMContext &Ctx = SrcVal->getType()->getContext();
863
Chris Lattner7944c212010-05-08 20:01:44 +0000864 uint64_t StoreSize = (TD.getTypeSizeInBits(SrcVal->getType()) + 7) / 8;
865 uint64_t LoadSize = (TD.getTypeSizeInBits(LoadTy) + 7) / 8;
Chris Lattnerca749402009-09-21 06:24:16 +0000866
Chris Lattnerb2c6ae82009-12-09 18:13:28 +0000867 IRBuilder<> Builder(InsertPt->getParent(), InsertPt);
Chris Lattnerca749402009-09-21 06:24:16 +0000868
869 // Compute which bits of the stored value are being used by the load. Convert
870 // to an integer type to start with.
Duncan Sands1df98592010-02-16 11:11:14 +0000871 if (SrcVal->getType()->isPointerTy())
Chris Lattnerb2c6ae82009-12-09 18:13:28 +0000872 SrcVal = Builder.CreatePtrToInt(SrcVal, TD.getIntPtrType(Ctx), "tmp");
Duncan Sands1df98592010-02-16 11:11:14 +0000873 if (!SrcVal->getType()->isIntegerTy())
Chris Lattnerb2c6ae82009-12-09 18:13:28 +0000874 SrcVal = Builder.CreateBitCast(SrcVal, IntegerType::get(Ctx, StoreSize*8),
875 "tmp");
Chris Lattnerca749402009-09-21 06:24:16 +0000876
877 // Shift the bits to the least significant depending on endianness.
878 unsigned ShiftAmt;
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000879 if (TD.isLittleEndian())
Chris Lattnerca749402009-09-21 06:24:16 +0000880 ShiftAmt = Offset*8;
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000881 else
Chris Lattner19ad7842009-09-21 17:55:47 +0000882 ShiftAmt = (StoreSize-LoadSize-Offset)*8;
Chris Lattnerca749402009-09-21 06:24:16 +0000883
Chris Lattner4fbd14e2009-09-21 06:48:08 +0000884 if (ShiftAmt)
Chris Lattnerb2c6ae82009-12-09 18:13:28 +0000885 SrcVal = Builder.CreateLShr(SrcVal, ShiftAmt, "tmp");
Chris Lattnerca749402009-09-21 06:24:16 +0000886
Chris Lattner4fbd14e2009-09-21 06:48:08 +0000887 if (LoadSize != StoreSize)
Chris Lattnerb2c6ae82009-12-09 18:13:28 +0000888 SrcVal = Builder.CreateTrunc(SrcVal, IntegerType::get(Ctx, LoadSize*8),
889 "tmp");
Chris Lattnerca749402009-09-21 06:24:16 +0000890
Chris Lattner4fbd14e2009-09-21 06:48:08 +0000891 return CoerceAvailableValueToLoadType(SrcVal, LoadTy, InsertPt, TD);
Chris Lattnerca749402009-09-21 06:24:16 +0000892}
893
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000894/// GetMemInstValueForLoad - This function is called when we have a
895/// memdep query of a load that ends up being a clobbering mem intrinsic.
896static Value *GetMemInstValueForLoad(MemIntrinsic *SrcInst, unsigned Offset,
897 const Type *LoadTy, Instruction *InsertPt,
898 const TargetData &TD){
899 LLVMContext &Ctx = LoadTy->getContext();
900 uint64_t LoadSize = TD.getTypeSizeInBits(LoadTy)/8;
901
902 IRBuilder<> Builder(InsertPt->getParent(), InsertPt);
903
904 // We know that this method is only called when the mem transfer fully
905 // provides the bits for the load.
906 if (MemSetInst *MSI = dyn_cast<MemSetInst>(SrcInst)) {
907 // memset(P, 'x', 1234) -> splat('x'), even if x is a variable, and
908 // independently of what the offset is.
909 Value *Val = MSI->getValue();
910 if (LoadSize != 1)
911 Val = Builder.CreateZExt(Val, IntegerType::get(Ctx, LoadSize*8));
912
913 Value *OneElt = Val;
914
915 // Splat the value out to the right number of bits.
916 for (unsigned NumBytesSet = 1; NumBytesSet != LoadSize; ) {
917 // If we can double the number of bytes set, do it.
918 if (NumBytesSet*2 <= LoadSize) {
919 Value *ShVal = Builder.CreateShl(Val, NumBytesSet*8);
920 Val = Builder.CreateOr(Val, ShVal);
921 NumBytesSet <<= 1;
922 continue;
923 }
924
925 // Otherwise insert one byte at a time.
926 Value *ShVal = Builder.CreateShl(Val, 1*8);
927 Val = Builder.CreateOr(OneElt, ShVal);
928 ++NumBytesSet;
929 }
930
931 return CoerceAvailableValueToLoadType(Val, LoadTy, InsertPt, TD);
932 }
Chris Lattnerbc9a28d2009-12-06 05:29:56 +0000933
934 // Otherwise, this is a memcpy/memmove from a constant global.
935 MemTransferInst *MTI = cast<MemTransferInst>(SrcInst);
936 Constant *Src = cast<Constant>(MTI->getSource());
937
938 // Otherwise, see if we can constant fold a load from the constant with the
939 // offset applied as appropriate.
940 Src = ConstantExpr::getBitCast(Src,
941 llvm::Type::getInt8PtrTy(Src->getContext()));
942 Constant *OffsetCst =
943 ConstantInt::get(Type::getInt64Ty(Src->getContext()), (unsigned)Offset);
944 Src = ConstantExpr::getGetElementPtr(Src, &OffsetCst, 1);
945 Src = ConstantExpr::getBitCast(Src, PointerType::getUnqual(LoadTy));
946 return ConstantFoldLoadFromConstPtr(Src, &TD);
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000947}
948
Dan Gohmanb3579832010-04-15 17:08:50 +0000949namespace {
Chris Lattnerfaf815b2009-12-06 01:57:02 +0000950
Chris Lattner87913512009-09-21 06:30:24 +0000951struct AvailableValueInBlock {
952 /// BB - The basic block in question.
953 BasicBlock *BB;
Chris Lattnercb9cbc42009-12-06 04:54:31 +0000954 enum ValType {
955 SimpleVal, // A simple offsetted value that is accessed.
956 MemIntrin // A memory intrinsic which is loaded from.
957 };
958
Chris Lattner87913512009-09-21 06:30:24 +0000959 /// V - The value that is live out of the block.
Chris Lattnercb9cbc42009-12-06 04:54:31 +0000960 PointerIntPair<Value *, 1, ValType> Val;
961
962 /// Offset - The byte offset in Val that is interesting for the load query.
Chris Lattner4fbd14e2009-09-21 06:48:08 +0000963 unsigned Offset;
Chris Lattner87913512009-09-21 06:30:24 +0000964
Chris Lattner4fbd14e2009-09-21 06:48:08 +0000965 static AvailableValueInBlock get(BasicBlock *BB, Value *V,
966 unsigned Offset = 0) {
Chris Lattner87913512009-09-21 06:30:24 +0000967 AvailableValueInBlock Res;
968 Res.BB = BB;
Chris Lattnercb9cbc42009-12-06 04:54:31 +0000969 Res.Val.setPointer(V);
970 Res.Val.setInt(SimpleVal);
Chris Lattner4fbd14e2009-09-21 06:48:08 +0000971 Res.Offset = Offset;
Chris Lattner87913512009-09-21 06:30:24 +0000972 return Res;
973 }
Chris Lattnercb9cbc42009-12-06 04:54:31 +0000974
975 static AvailableValueInBlock getMI(BasicBlock *BB, MemIntrinsic *MI,
976 unsigned Offset = 0) {
977 AvailableValueInBlock Res;
978 Res.BB = BB;
979 Res.Val.setPointer(MI);
980 Res.Val.setInt(MemIntrin);
981 Res.Offset = Offset;
982 return Res;
983 }
984
985 bool isSimpleValue() const { return Val.getInt() == SimpleVal; }
986 Value *getSimpleValue() const {
987 assert(isSimpleValue() && "Wrong accessor");
988 return Val.getPointer();
989 }
990
991 MemIntrinsic *getMemIntrinValue() const {
992 assert(!isSimpleValue() && "Wrong accessor");
993 return cast<MemIntrinsic>(Val.getPointer());
994 }
Chris Lattner5362c542009-12-21 23:04:33 +0000995
996 /// MaterializeAdjustedValue - Emit code into this block to adjust the value
997 /// defined here to the specified type. This handles various coercion cases.
998 Value *MaterializeAdjustedValue(const Type *LoadTy,
999 const TargetData *TD) const {
1000 Value *Res;
1001 if (isSimpleValue()) {
1002 Res = getSimpleValue();
1003 if (Res->getType() != LoadTy) {
1004 assert(TD && "Need target data to handle type mismatch case");
1005 Res = GetStoreValueForLoad(Res, Offset, LoadTy, BB->getTerminator(),
1006 *TD);
1007
1008 DEBUG(errs() << "GVN COERCED NONLOCAL VAL:\nOffset: " << Offset << " "
1009 << *getSimpleValue() << '\n'
1010 << *Res << '\n' << "\n\n\n");
1011 }
1012 } else {
1013 Res = GetMemInstValueForLoad(getMemIntrinValue(), Offset,
1014 LoadTy, BB->getTerminator(), *TD);
1015 DEBUG(errs() << "GVN COERCED NONLOCAL MEM INTRIN:\nOffset: " << Offset
1016 << " " << *getMemIntrinValue() << '\n'
1017 << *Res << '\n' << "\n\n\n");
1018 }
1019 return Res;
1020 }
Chris Lattner87913512009-09-21 06:30:24 +00001021};
1022
Dan Gohmanb3579832010-04-15 17:08:50 +00001023}
1024
Chris Lattnera09fbf02009-10-10 23:50:30 +00001025/// ConstructSSAForLoadSet - Given a set of loads specified by ValuesPerBlock,
1026/// construct SSA form, allowing us to eliminate LI. This returns the value
1027/// that should be used at LI's definition site.
1028static Value *ConstructSSAForLoadSet(LoadInst *LI,
1029 SmallVectorImpl<AvailableValueInBlock> &ValuesPerBlock,
1030 const TargetData *TD,
Chris Lattnerd2191e52009-12-21 23:15:48 +00001031 const DominatorTree &DT,
Chris Lattnera09fbf02009-10-10 23:50:30 +00001032 AliasAnalysis *AA) {
Chris Lattnerd2191e52009-12-21 23:15:48 +00001033 // Check for the fully redundant, dominating load case. In this case, we can
1034 // just use the dominating value directly.
1035 if (ValuesPerBlock.size() == 1 &&
1036 DT.properlyDominates(ValuesPerBlock[0].BB, LI->getParent()))
1037 return ValuesPerBlock[0].MaterializeAdjustedValue(LI->getType(), TD);
1038
1039 // Otherwise, we have to construct SSA form.
Chris Lattnera09fbf02009-10-10 23:50:30 +00001040 SmallVector<PHINode*, 8> NewPHIs;
1041 SSAUpdater SSAUpdate(&NewPHIs);
Duncan Sandsfc6e29d2010-09-02 08:14:03 +00001042 SSAUpdate.Initialize(LI->getType(), LI->getName());
Chris Lattnera09fbf02009-10-10 23:50:30 +00001043
1044 const Type *LoadTy = LI->getType();
1045
Chris Lattner771a5422009-09-20 20:09:34 +00001046 for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i) {
Chris Lattnercb9cbc42009-12-06 04:54:31 +00001047 const AvailableValueInBlock &AV = ValuesPerBlock[i];
1048 BasicBlock *BB = AV.BB;
Chris Lattner771a5422009-09-20 20:09:34 +00001049
Chris Lattnera09fbf02009-10-10 23:50:30 +00001050 if (SSAUpdate.HasValueForBlock(BB))
1051 continue;
Chris Lattnercb9cbc42009-12-06 04:54:31 +00001052
Chris Lattner5362c542009-12-21 23:04:33 +00001053 SSAUpdate.AddAvailableValue(BB, AV.MaterializeAdjustedValue(LoadTy, TD));
Chris Lattner771a5422009-09-20 20:09:34 +00001054 }
Chris Lattnera09fbf02009-10-10 23:50:30 +00001055
1056 // Perform PHI construction.
1057 Value *V = SSAUpdate.GetValueInMiddleOfBlock(LI->getParent());
1058
1059 // If new PHI nodes were created, notify alias analysis.
Duncan Sands1df98592010-02-16 11:11:14 +00001060 if (V->getType()->isPointerTy())
Chris Lattnera09fbf02009-10-10 23:50:30 +00001061 for (unsigned i = 0, e = NewPHIs.size(); i != e; ++i)
1062 AA->copyValue(LI, NewPHIs[i]);
Owen Anderson392249f2011-01-03 23:51:43 +00001063
1064 // Now that we've copied information to the new PHIs, scan through
1065 // them again and inform alias analysis that we've added potentially
1066 // escaping uses to any values that are operands to these PHIs.
1067 for (unsigned i = 0, e = NewPHIs.size(); i != e; ++i) {
1068 PHINode *P = NewPHIs[i];
1069 for (unsigned ii = 0, ee = P->getNumIncomingValues(); ii != ee; ++ii)
1070 AA->addEscapingUse(P->getOperandUse(2*ii));
1071 }
Chris Lattnera09fbf02009-10-10 23:50:30 +00001072
1073 return V;
Chris Lattner771a5422009-09-20 20:09:34 +00001074}
1075
Gabor Greifea3eec92010-04-09 10:57:00 +00001076static bool isLifetimeStart(const Instruction *Inst) {
1077 if (const IntrinsicInst* II = dyn_cast<IntrinsicInst>(Inst))
Owen Anderson9ff5a232009-12-02 07:35:19 +00001078 return II->getIntrinsicID() == Intrinsic::lifetime_start;
Chris Lattner720e7902009-12-02 06:44:58 +00001079 return false;
1080}
1081
Owen Anderson62bc33c2007-08-16 22:02:55 +00001082/// processNonLocalLoad - Attempt to eliminate a load whose dependencies are
1083/// non-local by performing PHI construction.
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001084bool GVN::processNonLocalLoad(LoadInst *LI,
Chris Lattner8e1e95c2008-03-21 22:01:16 +00001085 SmallVectorImpl<Instruction*> &toErase) {
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001086 // Find the non-local dependencies of the load.
Chris Lattner0ee443d2009-12-22 04:25:02 +00001087 SmallVector<NonLocalDepResult, 64> Deps;
Dan Gohman6d8eb152010-11-11 21:50:19 +00001088 AliasAnalysis::Location Loc = VN.getAliasAnalysis()->getLocation(LI);
1089 MD->getNonLocalPointerDependency(Loc, true, LI->getParent(), Deps);
David Greenebf7f78e2010-01-05 01:27:17 +00001090 //DEBUG(dbgs() << "INVESTIGATING NONLOCAL LOAD: "
Dan Gohman2a298992009-07-31 20:24:18 +00001091 // << Deps.size() << *LI << '\n');
Daniel Dunbara279bc32009-09-20 02:20:51 +00001092
Owen Anderson516eb1c2008-08-26 22:07:42 +00001093 // If we had to process more than one hundred blocks to find the
1094 // dependencies, this load isn't worth worrying about. Optimizing
1095 // it will be too expensive.
Chris Lattner91bcf642008-12-09 19:25:07 +00001096 if (Deps.size() > 100)
Owen Anderson516eb1c2008-08-26 22:07:42 +00001097 return false;
Chris Lattner5f4f84b2008-12-18 00:51:32 +00001098
1099 // If we had a phi translation failure, we'll have a single entry which is a
1100 // clobber in the current block. Reject this early.
Chris Lattnere18b9712009-12-09 07:08:01 +00001101 if (Deps.size() == 1 && Deps[0].getResult().isClobber()) {
Torok Edwin4306b1a2009-06-17 18:48:18 +00001102 DEBUG(
David Greenebf7f78e2010-01-05 01:27:17 +00001103 dbgs() << "GVN: non-local load ";
1104 WriteAsOperand(dbgs(), LI);
1105 dbgs() << " is clobbered by " << *Deps[0].getResult().getInst() << '\n';
Torok Edwin4306b1a2009-06-17 18:48:18 +00001106 );
Chris Lattner5f4f84b2008-12-18 00:51:32 +00001107 return false;
Torok Edwin4306b1a2009-06-17 18:48:18 +00001108 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001109
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001110 // Filter out useless results (non-locals, etc). Keep track of the blocks
1111 // where we have a value available in repl, also keep track of whether we see
1112 // dependencies that produce an unknown value for the load (such as a call
1113 // that could potentially clobber the load).
Chris Lattner87913512009-09-21 06:30:24 +00001114 SmallVector<AvailableValueInBlock, 16> ValuesPerBlock;
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001115 SmallVector<BasicBlock*, 16> UnavailableBlocks;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001116
Chris Lattner91bcf642008-12-09 19:25:07 +00001117 for (unsigned i = 0, e = Deps.size(); i != e; ++i) {
Chris Lattnere18b9712009-12-09 07:08:01 +00001118 BasicBlock *DepBB = Deps[i].getBB();
1119 MemDepResult DepInfo = Deps[i].getResult();
Daniel Dunbara279bc32009-09-20 02:20:51 +00001120
Chris Lattnerb51deb92008-12-05 21:04:20 +00001121 if (DepInfo.isClobber()) {
Chris Lattneraf064ae2009-12-09 18:21:46 +00001122 // The address being loaded in this non-local block may not be the same as
1123 // the pointer operand of the load if PHI translation occurs. Make sure
1124 // to consider the right address.
1125 Value *Address = Deps[i].getAddress();
1126
Chris Lattner4fbd14e2009-09-21 06:48:08 +00001127 // If the dependence is to a store that writes to a superset of the bits
1128 // read by the load, we can extract the bits we need for the load from the
1129 // stored value.
1130 if (StoreInst *DepSI = dyn_cast<StoreInst>(DepInfo.getInst())) {
Chris Lattneraf064ae2009-12-09 18:21:46 +00001131 if (TD && Address) {
1132 int Offset = AnalyzeLoadFromClobberingStore(LI->getType(), Address,
Chris Lattner4ca70fe2009-12-09 07:37:07 +00001133 DepSI, *TD);
Chris Lattner4fbd14e2009-09-21 06:48:08 +00001134 if (Offset != -1) {
1135 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
Dan Gohman3355c4e2010-11-10 19:03:33 +00001136 DepSI->getValueOperand(),
Chris Lattner4fbd14e2009-09-21 06:48:08 +00001137 Offset));
1138 continue;
1139 }
1140 }
1141 }
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001142
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001143 // If the clobbering value is a memset/memcpy/memmove, see if we can
1144 // forward a value on from it.
Chris Lattnercb9cbc42009-12-06 04:54:31 +00001145 if (MemIntrinsic *DepMI = dyn_cast<MemIntrinsic>(DepInfo.getInst())) {
Chris Lattneraf064ae2009-12-09 18:21:46 +00001146 if (TD && Address) {
1147 int Offset = AnalyzeLoadFromClobberingMemInst(LI->getType(), Address,
Chris Lattner4ca70fe2009-12-09 07:37:07 +00001148 DepMI, *TD);
Chris Lattnercb9cbc42009-12-06 04:54:31 +00001149 if (Offset != -1) {
1150 ValuesPerBlock.push_back(AvailableValueInBlock::getMI(DepBB, DepMI,
1151 Offset));
1152 continue;
1153 }
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001154 }
1155 }
Chris Lattner4fbd14e2009-09-21 06:48:08 +00001156
Chris Lattnerb51deb92008-12-05 21:04:20 +00001157 UnavailableBlocks.push_back(DepBB);
1158 continue;
1159 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001160
Chris Lattnerb51deb92008-12-05 21:04:20 +00001161 Instruction *DepInst = DepInfo.getInst();
Daniel Dunbara279bc32009-09-20 02:20:51 +00001162
Chris Lattnerb51deb92008-12-05 21:04:20 +00001163 // Loading the allocation -> undef.
Chris Lattner720e7902009-12-02 06:44:58 +00001164 if (isa<AllocaInst>(DepInst) || isMalloc(DepInst) ||
Owen Anderson9ff5a232009-12-02 07:35:19 +00001165 // Loading immediately after lifetime begin -> undef.
1166 isLifetimeStart(DepInst)) {
Chris Lattner87913512009-09-21 06:30:24 +00001167 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
1168 UndefValue::get(LI->getType())));
Chris Lattnerbf145d62008-12-01 01:15:42 +00001169 continue;
1170 }
Owen Andersonb62f7922009-10-28 07:05:35 +00001171
Chris Lattner87913512009-09-21 06:30:24 +00001172 if (StoreInst *S = dyn_cast<StoreInst>(DepInst)) {
Daniel Dunbara279bc32009-09-20 02:20:51 +00001173 // Reject loads and stores that are to the same address but are of
Chris Lattner771a5422009-09-20 20:09:34 +00001174 // different types if we have to.
Dan Gohman3355c4e2010-11-10 19:03:33 +00001175 if (S->getValueOperand()->getType() != LI->getType()) {
Chris Lattner771a5422009-09-20 20:09:34 +00001176 // If the stored value is larger or equal to the loaded value, we can
1177 // reuse it.
Dan Gohman3355c4e2010-11-10 19:03:33 +00001178 if (TD == 0 || !CanCoerceMustAliasedValueToLoad(S->getValueOperand(),
Chris Lattner8b2bc3d2009-09-21 17:24:04 +00001179 LI->getType(), *TD)) {
Chris Lattner771a5422009-09-20 20:09:34 +00001180 UnavailableBlocks.push_back(DepBB);
1181 continue;
1182 }
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001183 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001184
Chris Lattner87913512009-09-21 06:30:24 +00001185 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
Dan Gohman3355c4e2010-11-10 19:03:33 +00001186 S->getValueOperand()));
Chris Lattner4fbd14e2009-09-21 06:48:08 +00001187 continue;
1188 }
1189
1190 if (LoadInst *LD = dyn_cast<LoadInst>(DepInst)) {
Chris Lattner771a5422009-09-20 20:09:34 +00001191 // If the types mismatch and we can't handle it, reject reuse of the load.
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001192 if (LD->getType() != LI->getType()) {
Chris Lattner771a5422009-09-20 20:09:34 +00001193 // If the stored value is larger or equal to the loaded value, we can
1194 // reuse it.
Chris Lattner8b2bc3d2009-09-21 17:24:04 +00001195 if (TD == 0 || !CanCoerceMustAliasedValueToLoad(LD, LI->getType(),*TD)){
Chris Lattner771a5422009-09-20 20:09:34 +00001196 UnavailableBlocks.push_back(DepBB);
1197 continue;
1198 }
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001199 }
Chris Lattner87913512009-09-21 06:30:24 +00001200 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB, LD));
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001201 continue;
Owen Anderson0cd32032007-07-25 19:57:03 +00001202 }
Chris Lattner4fbd14e2009-09-21 06:48:08 +00001203
1204 UnavailableBlocks.push_back(DepBB);
1205 continue;
Chris Lattner88365bb2008-03-21 21:14:38 +00001206 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001207
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001208 // If we have no predecessors that produce a known value for this load, exit
1209 // early.
1210 if (ValuesPerBlock.empty()) return false;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001211
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001212 // If all of the instructions we depend on produce a known value for this
1213 // load, then it is fully redundant and we can use PHI insertion to compute
1214 // its value. Insert PHIs and remove the fully redundant value now.
1215 if (UnavailableBlocks.empty()) {
David Greenebf7f78e2010-01-05 01:27:17 +00001216 DEBUG(dbgs() << "GVN REMOVING NONLOCAL LOAD: " << *LI << '\n');
Chris Lattner771a5422009-09-20 20:09:34 +00001217
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001218 // Perform PHI construction.
Chris Lattnerd2191e52009-12-21 23:15:48 +00001219 Value *V = ConstructSSAForLoadSet(LI, ValuesPerBlock, TD, *DT,
Chris Lattnera09fbf02009-10-10 23:50:30 +00001220 VN.getAliasAnalysis());
Chris Lattner771a5422009-09-20 20:09:34 +00001221 LI->replaceAllUsesWith(V);
Daniel Dunbara279bc32009-09-20 02:20:51 +00001222
Chris Lattner771a5422009-09-20 20:09:34 +00001223 if (isa<PHINode>(V))
1224 V->takeName(LI);
Duncan Sands1df98592010-02-16 11:11:14 +00001225 if (V->getType()->isPointerTy())
Chris Lattner771a5422009-09-20 20:09:34 +00001226 MD->invalidateCachedPointerInfo(V);
Bob Wilson74175c22010-02-22 21:39:41 +00001227 VN.erase(LI);
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001228 toErase.push_back(LI);
Dan Gohmanfe601042010-06-22 15:08:57 +00001229 ++NumGVNLoad;
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001230 return true;
1231 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001232
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001233 if (!EnablePRE || !EnableLoadPRE)
1234 return false;
1235
1236 // Okay, we have *some* definitions of the value. This means that the value
1237 // is available in some of our (transitive) predecessors. Lets think about
1238 // doing PRE of this load. This will involve inserting a new load into the
1239 // predecessor when it's not available. We could do this in general, but
1240 // prefer to not increase code size. As such, we only do this when we know
1241 // that we only have to insert *one* load (which means we're basically moving
1242 // the load, not inserting a new one).
Daniel Dunbara279bc32009-09-20 02:20:51 +00001243
Owen Anderson88554df2009-05-31 09:03:40 +00001244 SmallPtrSet<BasicBlock *, 4> Blockers;
1245 for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1246 Blockers.insert(UnavailableBlocks[i]);
1247
1248 // Lets find first basic block with more than one predecessor. Walk backwards
1249 // through predecessors if needed.
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001250 BasicBlock *LoadBB = LI->getParent();
Owen Anderson88554df2009-05-31 09:03:40 +00001251 BasicBlock *TmpBB = LoadBB;
1252
1253 bool isSinglePred = false;
Dale Johannesen42c3f552009-06-17 20:48:23 +00001254 bool allSingleSucc = true;
Owen Anderson88554df2009-05-31 09:03:40 +00001255 while (TmpBB->getSinglePredecessor()) {
1256 isSinglePred = true;
1257 TmpBB = TmpBB->getSinglePredecessor();
Owen Anderson88554df2009-05-31 09:03:40 +00001258 if (TmpBB == LoadBB) // Infinite (unreachable) loop.
1259 return false;
1260 if (Blockers.count(TmpBB))
1261 return false;
Owen Andersonb0ba0f42010-09-25 05:26:18 +00001262
1263 // If any of these blocks has more than one successor (i.e. if the edge we
1264 // just traversed was critical), then there are other paths through this
1265 // block along which the load may not be anticipated. Hoisting the load
1266 // above this block would be adding the load to execution paths along
1267 // which it was not previously executed.
Dale Johannesen42c3f552009-06-17 20:48:23 +00001268 if (TmpBB->getTerminator()->getNumSuccessors() != 1)
Owen Andersonb0ba0f42010-09-25 05:26:18 +00001269 return false;
Owen Anderson88554df2009-05-31 09:03:40 +00001270 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001271
Owen Anderson88554df2009-05-31 09:03:40 +00001272 assert(TmpBB);
1273 LoadBB = TmpBB;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001274
Chris Lattnercb9cbc42009-12-06 04:54:31 +00001275 // FIXME: It is extremely unclear what this loop is doing, other than
1276 // artificially restricting loadpre.
Owen Anderson88554df2009-05-31 09:03:40 +00001277 if (isSinglePred) {
1278 bool isHot = false;
Chris Lattnercb9cbc42009-12-06 04:54:31 +00001279 for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i) {
1280 const AvailableValueInBlock &AV = ValuesPerBlock[i];
1281 if (AV.isSimpleValue())
Daniel Dunbara279bc32009-09-20 02:20:51 +00001282 // "Hot" Instruction is in some loop (because it dominates its dep.
1283 // instruction).
Chris Lattnercb9cbc42009-12-06 04:54:31 +00001284 if (Instruction *I = dyn_cast<Instruction>(AV.getSimpleValue()))
1285 if (DT->dominates(LI, I)) {
1286 isHot = true;
1287 break;
1288 }
1289 }
Owen Anderson88554df2009-05-31 09:03:40 +00001290
1291 // We are interested only in "hot" instructions. We don't want to do any
1292 // mis-optimizations here.
1293 if (!isHot)
1294 return false;
1295 }
1296
Bob Wilson6cad4172010-02-01 21:17:14 +00001297 // Check to see how many predecessors have the loaded value fully
1298 // available.
1299 DenseMap<BasicBlock*, Value*> PredLoads;
Chris Lattner72bc70d2008-12-05 07:49:08 +00001300 DenseMap<BasicBlock*, char> FullyAvailableBlocks;
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001301 for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i)
Chris Lattner87913512009-09-21 06:30:24 +00001302 FullyAvailableBlocks[ValuesPerBlock[i].BB] = true;
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001303 for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1304 FullyAvailableBlocks[UnavailableBlocks[i]] = false;
1305
Bob Wilson34414a62010-05-04 20:03:21 +00001306 SmallVector<std::pair<TerminatorInst*, unsigned>, 4> NeedToSplit;
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001307 for (pred_iterator PI = pred_begin(LoadBB), E = pred_end(LoadBB);
1308 PI != E; ++PI) {
Bob Wilson6cad4172010-02-01 21:17:14 +00001309 BasicBlock *Pred = *PI;
1310 if (IsValueFullyAvailableInBlock(Pred, FullyAvailableBlocks)) {
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001311 continue;
Bob Wilson6cad4172010-02-01 21:17:14 +00001312 }
1313 PredLoads[Pred] = 0;
Bob Wilson484d4a32010-02-16 19:51:59 +00001314
Bob Wilson6cad4172010-02-01 21:17:14 +00001315 if (Pred->getTerminator()->getNumSuccessors() != 1) {
Bob Wilson484d4a32010-02-16 19:51:59 +00001316 if (isa<IndirectBrInst>(Pred->getTerminator())) {
1317 DEBUG(dbgs() << "COULD NOT PRE LOAD BECAUSE OF INDBR CRITICAL EDGE '"
1318 << Pred->getName() << "': " << *LI << '\n');
1319 return false;
1320 }
Bob Wilsonae23daf2010-02-16 21:06:42 +00001321 unsigned SuccNum = GetSuccessorNumber(Pred, LoadBB);
Bob Wilson34414a62010-05-04 20:03:21 +00001322 NeedToSplit.push_back(std::make_pair(Pred->getTerminator(), SuccNum));
Bob Wilson6cad4172010-02-01 21:17:14 +00001323 }
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001324 }
Bob Wilson34414a62010-05-04 20:03:21 +00001325 if (!NeedToSplit.empty()) {
Bob Wilsonbc786532010-05-05 20:44:15 +00001326 toSplit.append(NeedToSplit.begin(), NeedToSplit.end());
Bob Wilson70704972010-03-01 23:37:32 +00001327 return false;
Bob Wilson34414a62010-05-04 20:03:21 +00001328 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001329
Bob Wilson6cad4172010-02-01 21:17:14 +00001330 // Decide whether PRE is profitable for this load.
1331 unsigned NumUnavailablePreds = PredLoads.size();
1332 assert(NumUnavailablePreds != 0 &&
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001333 "Fully available value should be eliminated above!");
Owen Anderson7267e142010-10-01 20:02:55 +00001334
1335 // If this load is unavailable in multiple predecessors, reject it.
1336 // FIXME: If we could restructure the CFG, we could make a common pred with
1337 // all the preds that don't have an available LI and insert a new load into
1338 // that one block.
1339 if (NumUnavailablePreds != 1)
Bob Wilson6cad4172010-02-01 21:17:14 +00001340 return false;
Bob Wilson6cad4172010-02-01 21:17:14 +00001341
1342 // Check if the load can safely be moved to all the unavailable predecessors.
1343 bool CanDoPRE = true;
Chris Lattnerdd696052009-11-28 15:39:14 +00001344 SmallVector<Instruction*, 8> NewInsts;
Bob Wilson6cad4172010-02-01 21:17:14 +00001345 for (DenseMap<BasicBlock*, Value*>::iterator I = PredLoads.begin(),
1346 E = PredLoads.end(); I != E; ++I) {
1347 BasicBlock *UnavailablePred = I->first;
1348
1349 // Do PHI translation to get its value in the predecessor if necessary. The
1350 // returned pointer (if non-null) is guaranteed to dominate UnavailablePred.
1351
1352 // If all preds have a single successor, then we know it is safe to insert
1353 // the load on the pred (?!?), so we can insert code to materialize the
1354 // pointer if it is not available.
Dan Gohman3355c4e2010-11-10 19:03:33 +00001355 PHITransAddr Address(LI->getPointerOperand(), TD);
Bob Wilson6cad4172010-02-01 21:17:14 +00001356 Value *LoadPtr = 0;
1357 if (allSingleSucc) {
1358 LoadPtr = Address.PHITranslateWithInsertion(LoadBB, UnavailablePred,
1359 *DT, NewInsts);
1360 } else {
Daniel Dunbar6d8f2ca2010-02-24 08:48:04 +00001361 Address.PHITranslateValue(LoadBB, UnavailablePred, DT);
Bob Wilson6cad4172010-02-01 21:17:14 +00001362 LoadPtr = Address.getAddr();
Bob Wilson6cad4172010-02-01 21:17:14 +00001363 }
1364
1365 // If we couldn't find or insert a computation of this phi translated value,
1366 // we fail PRE.
1367 if (LoadPtr == 0) {
1368 DEBUG(dbgs() << "COULDN'T INSERT PHI TRANSLATED VALUE OF: "
Dan Gohman3355c4e2010-11-10 19:03:33 +00001369 << *LI->getPointerOperand() << "\n");
Bob Wilson6cad4172010-02-01 21:17:14 +00001370 CanDoPRE = false;
1371 break;
1372 }
1373
1374 // Make sure it is valid to move this load here. We have to watch out for:
1375 // @1 = getelementptr (i8* p, ...
1376 // test p and branch if == 0
1377 // load @1
1378 // It is valid to have the getelementptr before the test, even if p can be 0,
1379 // as getelementptr only does address arithmetic.
1380 // If we are not pushing the value through any multiple-successor blocks
1381 // we do not have this case. Otherwise, check that the load is safe to
1382 // put anywhere; this can be improved, but should be conservatively safe.
1383 if (!allSingleSucc &&
1384 // FIXME: REEVALUTE THIS.
1385 !isSafeToLoadUnconditionally(LoadPtr,
1386 UnavailablePred->getTerminator(),
1387 LI->getAlignment(), TD)) {
1388 CanDoPRE = false;
1389 break;
1390 }
1391
1392 I->second = LoadPtr;
Chris Lattner05e15f82009-12-09 01:59:31 +00001393 }
1394
Bob Wilson6cad4172010-02-01 21:17:14 +00001395 if (!CanDoPRE) {
1396 while (!NewInsts.empty())
1397 NewInsts.pop_back_val()->eraseFromParent();
Dale Johannesen42c3f552009-06-17 20:48:23 +00001398 return false;
Chris Lattner0c264b12009-11-28 16:08:18 +00001399 }
Dale Johannesen42c3f552009-06-17 20:48:23 +00001400
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001401 // Okay, we can eliminate this load by inserting a reload in the predecessor
1402 // and using PHI construction to get the value in the other predecessors, do
1403 // it.
David Greenebf7f78e2010-01-05 01:27:17 +00001404 DEBUG(dbgs() << "GVN REMOVING PRE LOAD: " << *LI << '\n');
Chris Lattner0c264b12009-11-28 16:08:18 +00001405 DEBUG(if (!NewInsts.empty())
David Greenebf7f78e2010-01-05 01:27:17 +00001406 dbgs() << "INSERTED " << NewInsts.size() << " INSTS: "
Chris Lattner0c264b12009-11-28 16:08:18 +00001407 << *NewInsts.back() << '\n');
1408
Bob Wilson6cad4172010-02-01 21:17:14 +00001409 // Assign value numbers to the new instructions.
1410 for (unsigned i = 0, e = NewInsts.size(); i != e; ++i) {
1411 // FIXME: We really _ought_ to insert these value numbers into their
1412 // parent's availability map. However, in doing so, we risk getting into
1413 // ordering issues. If a block hasn't been processed yet, we would be
1414 // marking a value as AVAIL-IN, which isn't what we intend.
1415 VN.lookup_or_add(NewInsts[i]);
1416 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001417
Bob Wilson6cad4172010-02-01 21:17:14 +00001418 for (DenseMap<BasicBlock*, Value*>::iterator I = PredLoads.begin(),
1419 E = PredLoads.end(); I != E; ++I) {
1420 BasicBlock *UnavailablePred = I->first;
1421 Value *LoadPtr = I->second;
1422
Dan Gohmanf4177aa2010-12-15 23:53:55 +00001423 Instruction *NewLoad = new LoadInst(LoadPtr, LI->getName()+".pre", false,
1424 LI->getAlignment(),
1425 UnavailablePred->getTerminator());
1426
1427 // Transfer the old load's TBAA tag to the new load.
1428 if (MDNode *Tag = LI->getMetadata(LLVMContext::MD_tbaa))
1429 NewLoad->setMetadata(LLVMContext::MD_tbaa, Tag);
Bob Wilson6cad4172010-02-01 21:17:14 +00001430
1431 // Add the newly created load.
1432 ValuesPerBlock.push_back(AvailableValueInBlock::get(UnavailablePred,
1433 NewLoad));
Bob Wilson188f4282010-02-23 05:55:00 +00001434 MD->invalidateCachedPointerInfo(LoadPtr);
1435 DEBUG(dbgs() << "GVN INSERTED " << *NewLoad << '\n');
Bob Wilson6cad4172010-02-01 21:17:14 +00001436 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001437
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001438 // Perform PHI construction.
Chris Lattnerd2191e52009-12-21 23:15:48 +00001439 Value *V = ConstructSSAForLoadSet(LI, ValuesPerBlock, TD, *DT,
Chris Lattnera09fbf02009-10-10 23:50:30 +00001440 VN.getAliasAnalysis());
Chris Lattner771a5422009-09-20 20:09:34 +00001441 LI->replaceAllUsesWith(V);
1442 if (isa<PHINode>(V))
1443 V->takeName(LI);
Duncan Sands1df98592010-02-16 11:11:14 +00001444 if (V->getType()->isPointerTy())
Chris Lattner771a5422009-09-20 20:09:34 +00001445 MD->invalidateCachedPointerInfo(V);
Bob Wilson74175c22010-02-22 21:39:41 +00001446 VN.erase(LI);
Chris Lattnerc89c6a92008-12-02 08:16:11 +00001447 toErase.push_back(LI);
Dan Gohmanfe601042010-06-22 15:08:57 +00001448 ++NumPRELoad;
Owen Anderson0cd32032007-07-25 19:57:03 +00001449 return true;
1450}
1451
Owen Anderson62bc33c2007-08-16 22:02:55 +00001452/// processLoad - Attempt to eliminate a load, first by eliminating it
1453/// locally, and then attempting non-local elimination if that fails.
Chris Lattnerb51deb92008-12-05 21:04:20 +00001454bool GVN::processLoad(LoadInst *L, SmallVectorImpl<Instruction*> &toErase) {
Dan Gohman4ec01b22009-11-14 02:27:51 +00001455 if (!MD)
1456 return false;
1457
Chris Lattnerb51deb92008-12-05 21:04:20 +00001458 if (L->isVolatile())
Owen Anderson1ad2cb72007-07-24 17:55:58 +00001459 return false;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001460
Owen Anderson1ad2cb72007-07-24 17:55:58 +00001461 // ... to a pointer that has been loaded from before...
Chris Lattnerb2412a82009-09-21 02:42:51 +00001462 MemDepResult Dep = MD->getDependency(L);
Daniel Dunbara279bc32009-09-20 02:20:51 +00001463
Chris Lattnerb51deb92008-12-05 21:04:20 +00001464 // If the value isn't available, don't do anything!
Chris Lattnerb2412a82009-09-21 02:42:51 +00001465 if (Dep.isClobber()) {
Chris Lattnereed919b2009-09-21 05:57:11 +00001466 // Check to see if we have something like this:
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001467 // store i32 123, i32* %P
1468 // %A = bitcast i32* %P to i8*
1469 // %B = gep i8* %A, i32 1
1470 // %C = load i8* %B
1471 //
1472 // We could do that by recognizing if the clobber instructions are obviously
1473 // a common base + constant offset, and if the previous store (or memset)
1474 // completely covers this load. This sort of thing can happen in bitfield
1475 // access code.
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001476 Value *AvailVal = 0;
Chris Lattnereed919b2009-09-21 05:57:11 +00001477 if (StoreInst *DepSI = dyn_cast<StoreInst>(Dep.getInst()))
Duncan Sands88c3df72010-11-12 21:10:24 +00001478 if (TD) {
Chris Lattner4ca70fe2009-12-09 07:37:07 +00001479 int Offset = AnalyzeLoadFromClobberingStore(L->getType(),
1480 L->getPointerOperand(),
1481 DepSI, *TD);
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001482 if (Offset != -1)
Dan Gohman3355c4e2010-11-10 19:03:33 +00001483 AvailVal = GetStoreValueForLoad(DepSI->getValueOperand(), Offset,
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001484 L->getType(), L, *TD);
Chris Lattner1ce08292009-09-21 06:22:46 +00001485 }
Chris Lattnereed919b2009-09-21 05:57:11 +00001486
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001487 // If the clobbering value is a memset/memcpy/memmove, see if we can forward
1488 // a value on from it.
1489 if (MemIntrinsic *DepMI = dyn_cast<MemIntrinsic>(Dep.getInst())) {
Duncan Sands88c3df72010-11-12 21:10:24 +00001490 if (TD) {
Chris Lattner4ca70fe2009-12-09 07:37:07 +00001491 int Offset = AnalyzeLoadFromClobberingMemInst(L->getType(),
1492 L->getPointerOperand(),
1493 DepMI, *TD);
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001494 if (Offset != -1)
1495 AvailVal = GetMemInstValueForLoad(DepMI, Offset, L->getType(), L,*TD);
1496 }
1497 }
1498
1499 if (AvailVal) {
David Greenebf7f78e2010-01-05 01:27:17 +00001500 DEBUG(dbgs() << "GVN COERCED INST:\n" << *Dep.getInst() << '\n'
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001501 << *AvailVal << '\n' << *L << "\n\n\n");
1502
1503 // Replace the load!
1504 L->replaceAllUsesWith(AvailVal);
Duncan Sands1df98592010-02-16 11:11:14 +00001505 if (AvailVal->getType()->isPointerTy())
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001506 MD->invalidateCachedPointerInfo(AvailVal);
Bob Wilson74175c22010-02-22 21:39:41 +00001507 VN.erase(L);
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001508 toErase.push_back(L);
Dan Gohmanfe601042010-06-22 15:08:57 +00001509 ++NumGVNLoad;
Chris Lattnerfaf815b2009-12-06 01:57:02 +00001510 return true;
1511 }
1512
Torok Edwin3f3c6d42009-05-29 09:46:03 +00001513 DEBUG(
1514 // fast print dep, using operator<< on instruction would be too slow
David Greenebf7f78e2010-01-05 01:27:17 +00001515 dbgs() << "GVN: load ";
1516 WriteAsOperand(dbgs(), L);
Chris Lattnerb2412a82009-09-21 02:42:51 +00001517 Instruction *I = Dep.getInst();
David Greenebf7f78e2010-01-05 01:27:17 +00001518 dbgs() << " is clobbered by " << *I << '\n';
Torok Edwin3f3c6d42009-05-29 09:46:03 +00001519 );
Chris Lattnerb51deb92008-12-05 21:04:20 +00001520 return false;
Torok Edwin3f3c6d42009-05-29 09:46:03 +00001521 }
Chris Lattnerb51deb92008-12-05 21:04:20 +00001522
1523 // If it is defined in another block, try harder.
Chris Lattnerb2412a82009-09-21 02:42:51 +00001524 if (Dep.isNonLocal())
Chris Lattnerb51deb92008-12-05 21:04:20 +00001525 return processNonLocalLoad(L, toErase);
Eli Friedmanb6c36e42008-02-12 12:08:14 +00001526
Chris Lattnerb2412a82009-09-21 02:42:51 +00001527 Instruction *DepInst = Dep.getInst();
Chris Lattnerb51deb92008-12-05 21:04:20 +00001528 if (StoreInst *DepSI = dyn_cast<StoreInst>(DepInst)) {
Dan Gohman3355c4e2010-11-10 19:03:33 +00001529 Value *StoredVal = DepSI->getValueOperand();
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001530
1531 // The store and load are to a must-aliased pointer, but they may not
1532 // actually have the same type. See if we know how to reuse the stored
1533 // value (depending on its type).
Chris Lattnera52fce42009-10-21 04:11:19 +00001534 if (StoredVal->getType() != L->getType()) {
Duncan Sands88c3df72010-11-12 21:10:24 +00001535 if (TD) {
Chris Lattnera52fce42009-10-21 04:11:19 +00001536 StoredVal = CoerceAvailableValueToLoadType(StoredVal, L->getType(),
1537 L, *TD);
1538 if (StoredVal == 0)
1539 return false;
1540
David Greenebf7f78e2010-01-05 01:27:17 +00001541 DEBUG(dbgs() << "GVN COERCED STORE:\n" << *DepSI << '\n' << *StoredVal
Chris Lattnera52fce42009-10-21 04:11:19 +00001542 << '\n' << *L << "\n\n\n");
1543 }
1544 else
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001545 return false;
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001546 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001547
Chris Lattnerb51deb92008-12-05 21:04:20 +00001548 // Remove it!
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001549 L->replaceAllUsesWith(StoredVal);
Duncan Sands1df98592010-02-16 11:11:14 +00001550 if (StoredVal->getType()->isPointerTy())
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001551 MD->invalidateCachedPointerInfo(StoredVal);
Bob Wilson74175c22010-02-22 21:39:41 +00001552 VN.erase(L);
Chris Lattnerb51deb92008-12-05 21:04:20 +00001553 toErase.push_back(L);
Dan Gohmanfe601042010-06-22 15:08:57 +00001554 ++NumGVNLoad;
Chris Lattnerb51deb92008-12-05 21:04:20 +00001555 return true;
1556 }
1557
1558 if (LoadInst *DepLI = dyn_cast<LoadInst>(DepInst)) {
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001559 Value *AvailableVal = DepLI;
1560
1561 // The loads are of a must-aliased pointer, but they may not actually have
1562 // the same type. See if we know how to reuse the previously loaded value
1563 // (depending on its type).
Chris Lattnera52fce42009-10-21 04:11:19 +00001564 if (DepLI->getType() != L->getType()) {
Duncan Sands88c3df72010-11-12 21:10:24 +00001565 if (TD) {
Chris Lattnera52fce42009-10-21 04:11:19 +00001566 AvailableVal = CoerceAvailableValueToLoadType(DepLI, L->getType(), L,*TD);
1567 if (AvailableVal == 0)
1568 return false;
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001569
David Greenebf7f78e2010-01-05 01:27:17 +00001570 DEBUG(dbgs() << "GVN COERCED LOAD:\n" << *DepLI << "\n" << *AvailableVal
Chris Lattnera52fce42009-10-21 04:11:19 +00001571 << "\n" << *L << "\n\n\n");
1572 }
1573 else
1574 return false;
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001575 }
1576
Chris Lattnerb51deb92008-12-05 21:04:20 +00001577 // Remove it!
Chris Lattnerbb6495c2009-09-20 19:03:47 +00001578 L->replaceAllUsesWith(AvailableVal);
Duncan Sands1df98592010-02-16 11:11:14 +00001579 if (DepLI->getType()->isPointerTy())
Chris Lattnerbc99be12008-12-09 22:06:23 +00001580 MD->invalidateCachedPointerInfo(DepLI);
Bob Wilson74175c22010-02-22 21:39:41 +00001581 VN.erase(L);
Chris Lattnerb51deb92008-12-05 21:04:20 +00001582 toErase.push_back(L);
Dan Gohmanfe601042010-06-22 15:08:57 +00001583 ++NumGVNLoad;
Chris Lattnerb51deb92008-12-05 21:04:20 +00001584 return true;
1585 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001586
Chris Lattner237a8282008-11-30 01:39:32 +00001587 // If this load really doesn't depend on anything, then we must be loading an
1588 // undef value. This can happen when loading for a fresh allocation with no
1589 // intervening stores, for example.
Victor Hernandez7b929da2009-10-23 21:09:37 +00001590 if (isa<AllocaInst>(DepInst) || isMalloc(DepInst)) {
Owen Anderson9e9a0d52009-07-30 23:03:37 +00001591 L->replaceAllUsesWith(UndefValue::get(L->getType()));
Bob Wilson74175c22010-02-22 21:39:41 +00001592 VN.erase(L);
Chris Lattner237a8282008-11-30 01:39:32 +00001593 toErase.push_back(L);
Dan Gohmanfe601042010-06-22 15:08:57 +00001594 ++NumGVNLoad;
Chris Lattnerb51deb92008-12-05 21:04:20 +00001595 return true;
Eli Friedmanb6c36e42008-02-12 12:08:14 +00001596 }
Owen Andersonb62f7922009-10-28 07:05:35 +00001597
Owen Anderson9ff5a232009-12-02 07:35:19 +00001598 // If this load occurs either right after a lifetime begin,
Owen Andersonb62f7922009-10-28 07:05:35 +00001599 // then the loaded value is undefined.
1600 if (IntrinsicInst* II = dyn_cast<IntrinsicInst>(DepInst)) {
Owen Anderson9ff5a232009-12-02 07:35:19 +00001601 if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
Owen Andersonb62f7922009-10-28 07:05:35 +00001602 L->replaceAllUsesWith(UndefValue::get(L->getType()));
Bob Wilson74175c22010-02-22 21:39:41 +00001603 VN.erase(L);
Owen Andersonb62f7922009-10-28 07:05:35 +00001604 toErase.push_back(L);
Dan Gohmanfe601042010-06-22 15:08:57 +00001605 ++NumGVNLoad;
Owen Andersonb62f7922009-10-28 07:05:35 +00001606 return true;
1607 }
1608 }
Eli Friedmanb6c36e42008-02-12 12:08:14 +00001609
Chris Lattnerb51deb92008-12-05 21:04:20 +00001610 return false;
Owen Anderson1ad2cb72007-07-24 17:55:58 +00001611}
1612
Owen Anderson68c26392010-11-19 22:48:40 +00001613// lookupNumber - In order to find a leader for a given value number at a
1614// specific basic block, we first obtain the list of all Values for that number,
1615// and then scan the list to find one whose block dominates the block in
1616// question. This is fast because dominator tree queries consist of only
1617// a few comparisons of DFS numbers.
Chris Lattnerb2412a82009-09-21 02:42:51 +00001618Value *GVN::lookupNumber(BasicBlock *BB, uint32_t num) {
Owen Andersonf0568382010-12-21 23:54:34 +00001619 NumberTableEntry Vals = NumberTable[num];
1620 if (!Vals.Val) return 0;
Owen Andersona04a0642010-11-18 18:32:40 +00001621
Owen Andersonf0568382010-12-21 23:54:34 +00001622 Value *Val = 0;
1623 if (DT->dominates(Vals.BB, BB)) {
1624 Val = Vals.Val;
1625 if (isa<Constant>(Val)) return Val;
1626 }
1627
1628 NumberTableEntry* Next = Vals.Next;
Owen Andersona04a0642010-11-18 18:32:40 +00001629 while (Next) {
Owen Andersonf0568382010-12-21 23:54:34 +00001630 if (DT->dominates(Next->BB, BB)) {
1631 if (isa<Constant>(Next->Val)) return Next->Val;
1632 if (!Val) Val = Next->Val;
1633 }
Owen Andersona04a0642010-11-18 18:32:40 +00001634
Owen Andersonf0568382010-12-21 23:54:34 +00001635 Next = Next->Next;
Owen Anderson6fafe842008-06-20 01:15:47 +00001636 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001637
Owen Andersonf0568382010-12-21 23:54:34 +00001638 return Val;
Owen Anderson6fafe842008-06-20 01:15:47 +00001639}
1640
Owen Anderson255dafc2008-12-15 02:03:00 +00001641
Owen Anderson36057c72007-08-14 18:16:29 +00001642/// processInstruction - When calculating availability, handle an instruction
Owen Anderson1ad2cb72007-07-24 17:55:58 +00001643/// by inserting it into the appropriate sets
Owen Andersonaf4240a2008-06-12 19:25:32 +00001644bool GVN::processInstruction(Instruction *I,
Chris Lattner8e1e95c2008-03-21 22:01:16 +00001645 SmallVectorImpl<Instruction*> &toErase) {
Devang Patelbe905e22010-02-11 00:20:49 +00001646 // Ignore dbg info intrinsics.
1647 if (isa<DbgInfoIntrinsic>(I))
1648 return false;
1649
Duncan Sands88c3df72010-11-12 21:10:24 +00001650 // If the instruction can be easily simplified then do so now in preference
1651 // to value numbering it. Value numbering often exposes redundancies, for
1652 // example if it determines that %y is equal to %x then the instruction
1653 // "%z = and i32 %x, %y" becomes "%z = and i32 %x, %x" which we now simplify.
Duncan Sandseff05812010-11-14 18:36:10 +00001654 if (Value *V = SimplifyInstruction(I, TD, DT)) {
Duncan Sands88c3df72010-11-12 21:10:24 +00001655 I->replaceAllUsesWith(V);
1656 if (MD && V->getType()->isPointerTy())
1657 MD->invalidateCachedPointerInfo(V);
1658 VN.erase(I);
1659 toErase.push_back(I);
1660 return true;
1661 }
1662
Chris Lattnerb2412a82009-09-21 02:42:51 +00001663 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
1664 bool Changed = processLoad(LI, toErase);
Daniel Dunbara279bc32009-09-20 02:20:51 +00001665
Chris Lattnerb2412a82009-09-21 02:42:51 +00001666 if (!Changed) {
1667 unsigned Num = VN.lookup_or_add(LI);
Owen Andersonf0568382010-12-21 23:54:34 +00001668 insert_table(Num, LI, LI->getParent());
Owen Andersonb2303722008-06-18 21:41:49 +00001669 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001670
Chris Lattnerb2412a82009-09-21 02:42:51 +00001671 return Changed;
Owen Andersonb2303722008-06-18 21:41:49 +00001672 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001673
Owen Andersonf0568382010-12-21 23:54:34 +00001674 // For conditions branches, we can perform simple conditional propagation on
1675 // the condition value itself.
1676 if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
Owen Andersonf0568382010-12-21 23:54:34 +00001677 if (!BI->isConditional() || isa<Constant>(BI->getCondition()))
1678 return false;
1679
1680 Value *BranchCond = BI->getCondition();
1681 uint32_t CondVN = VN.lookup_or_add(BranchCond);
1682
1683 BasicBlock *TrueSucc = BI->getSuccessor(0);
1684 BasicBlock *FalseSucc = BI->getSuccessor(1);
1685
1686 if (TrueSucc->getSinglePredecessor())
1687 insert_table(CondVN,
1688 ConstantInt::getTrue(TrueSucc->getContext()),
1689 TrueSucc);
1690 if (FalseSucc->getSinglePredecessor())
1691 insert_table(CondVN,
1692 ConstantInt::getFalse(TrueSucc->getContext()),
1693 FalseSucc);
1694
1695 return false;
1696 }
Owen Anderson680ac4f2011-01-04 19:10:54 +00001697
Owen Andersonc2146a62011-01-04 18:54:18 +00001698 uint32_t NextNum = VN.getNextUnusedValueNumber();
1699 unsigned Num = VN.lookup_or_add(I);
1700
Owen Andersone5ffa902008-04-07 09:59:07 +00001701 // Allocations are always uniquely numbered, so we can save time and memory
Daniel Dunbara279bc32009-09-20 02:20:51 +00001702 // by fast failing them.
Chris Lattner459f4f82010-12-19 20:24:28 +00001703 if (isa<AllocaInst>(I) || isa<TerminatorInst>(I) || isa<PHINode>(I)) {
Owen Andersonf0568382010-12-21 23:54:34 +00001704 insert_table(Num, I, I->getParent());
Owen Andersone5ffa902008-04-07 09:59:07 +00001705 return false;
Owen Andersonb2303722008-06-18 21:41:49 +00001706 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001707
Owen Anderson0ae33ef2008-07-03 17:44:33 +00001708 // If the number we were assigned was a brand new VN, then we don't
1709 // need to do a lookup to see if the number already exists
1710 // somewhere in the domtree: it can't!
Chris Lattner459f4f82010-12-19 20:24:28 +00001711 if (Num == NextNum) {
Owen Andersonf0568382010-12-21 23:54:34 +00001712 insert_table(Num, I, I->getParent());
Chris Lattner459f4f82010-12-19 20:24:28 +00001713 return false;
1714 }
1715
Owen Anderson255dafc2008-12-15 02:03:00 +00001716 // Perform fast-path value-number based elimination of values inherited from
1717 // dominators.
Chris Lattner459f4f82010-12-19 20:24:28 +00001718 Value *repl = lookupNumber(I->getParent(), Num);
1719 if (repl == 0) {
1720 // Failure, just remember this instance for future use.
Owen Andersonf0568382010-12-21 23:54:34 +00001721 insert_table(Num, I, I->getParent());
Chris Lattner459f4f82010-12-19 20:24:28 +00001722 return false;
Owen Anderson1ad2cb72007-07-24 17:55:58 +00001723 }
Chris Lattner459f4f82010-12-19 20:24:28 +00001724
1725 // Remove it!
1726 VN.erase(I);
1727 I->replaceAllUsesWith(repl);
1728 if (MD && repl->getType()->isPointerTy())
1729 MD->invalidateCachedPointerInfo(repl);
1730 toErase.push_back(I);
1731 return true;
Owen Anderson1ad2cb72007-07-24 17:55:58 +00001732}
1733
Bill Wendling30788b82008-12-22 22:32:22 +00001734/// runOnFunction - This is the main transformation entry point for a function.
Owen Anderson3e75a422007-08-14 18:04:11 +00001735bool GVN::runOnFunction(Function& F) {
Dan Gohman4ec01b22009-11-14 02:27:51 +00001736 if (!NoLoads)
1737 MD = &getAnalysis<MemoryDependenceAnalysis>();
Chris Lattner663e4412008-12-01 00:40:32 +00001738 DT = &getAnalysis<DominatorTree>();
Duncan Sands88c3df72010-11-12 21:10:24 +00001739 TD = getAnalysisIfAvailable<TargetData>();
Owen Andersona472c4a2008-05-12 20:15:55 +00001740 VN.setAliasAnalysis(&getAnalysis<AliasAnalysis>());
Chris Lattner663e4412008-12-01 00:40:32 +00001741 VN.setMemDep(MD);
1742 VN.setDomTree(DT);
Daniel Dunbara279bc32009-09-20 02:20:51 +00001743
Chris Lattnerb2412a82009-09-21 02:42:51 +00001744 bool Changed = false;
1745 bool ShouldContinue = true;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001746
Owen Anderson5d0af032008-07-16 17:52:31 +00001747 // Merge unconditional branches, allowing PRE to catch more
1748 // optimization opportunities.
1749 for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ) {
Chris Lattnerb2412a82009-09-21 02:42:51 +00001750 BasicBlock *BB = FI;
Owen Anderson5d0af032008-07-16 17:52:31 +00001751 ++FI;
Owen Andersonb31b06d2008-07-17 00:01:40 +00001752 bool removedBlock = MergeBlockIntoPredecessor(BB, this);
Dan Gohmanfe601042010-06-22 15:08:57 +00001753 if (removedBlock) ++NumGVNBlocks;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001754
Chris Lattnerb2412a82009-09-21 02:42:51 +00001755 Changed |= removedBlock;
Owen Anderson5d0af032008-07-16 17:52:31 +00001756 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001757
Chris Lattnerae199312008-12-09 19:21:47 +00001758 unsigned Iteration = 0;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001759
Chris Lattnerb2412a82009-09-21 02:42:51 +00001760 while (ShouldContinue) {
David Greenebf7f78e2010-01-05 01:27:17 +00001761 DEBUG(dbgs() << "GVN iteration: " << Iteration << "\n");
Chris Lattnerb2412a82009-09-21 02:42:51 +00001762 ShouldContinue = iterateOnFunction(F);
Bob Wilson484d4a32010-02-16 19:51:59 +00001763 if (splitCriticalEdges())
1764 ShouldContinue = true;
Chris Lattnerb2412a82009-09-21 02:42:51 +00001765 Changed |= ShouldContinue;
Chris Lattnerae199312008-12-09 19:21:47 +00001766 ++Iteration;
Owen Anderson3e75a422007-08-14 18:04:11 +00001767 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001768
Owen Andersone98c54c2008-07-18 18:03:38 +00001769 if (EnablePRE) {
Owen Anderson0c7f91c2008-09-03 23:06:07 +00001770 bool PREChanged = true;
1771 while (PREChanged) {
1772 PREChanged = performPRE(F);
Chris Lattnerb2412a82009-09-21 02:42:51 +00001773 Changed |= PREChanged;
Owen Anderson0c7f91c2008-09-03 23:06:07 +00001774 }
Owen Andersone98c54c2008-07-18 18:03:38 +00001775 }
Chris Lattnerae199312008-12-09 19:21:47 +00001776 // FIXME: Should perform GVN again after PRE does something. PRE can move
1777 // computations into blocks where they become fully redundant. Note that
1778 // we can't do this until PRE's critical edge splitting updates memdep.
1779 // Actually, when this happens, we should just fully integrate PRE into GVN.
Nuno Lopes7cdd9ee2008-10-10 16:25:50 +00001780
1781 cleanupGlobalSets();
1782
Chris Lattnerb2412a82009-09-21 02:42:51 +00001783 return Changed;
Owen Anderson3e75a422007-08-14 18:04:11 +00001784}
1785
1786
Chris Lattnerb2412a82009-09-21 02:42:51 +00001787bool GVN::processBlock(BasicBlock *BB) {
Chris Lattnerae199312008-12-09 19:21:47 +00001788 // FIXME: Kill off toErase by doing erasing eagerly in a helper function (and
1789 // incrementing BI before processing an instruction).
Owen Andersonaf4240a2008-06-12 19:25:32 +00001790 SmallVector<Instruction*, 8> toErase;
Chris Lattnerb2412a82009-09-21 02:42:51 +00001791 bool ChangedFunction = false;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001792
Owen Andersonaf4240a2008-06-12 19:25:32 +00001793 for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();
1794 BI != BE;) {
Chris Lattnerb2412a82009-09-21 02:42:51 +00001795 ChangedFunction |= processInstruction(BI, toErase);
Owen Andersonaf4240a2008-06-12 19:25:32 +00001796 if (toErase.empty()) {
1797 ++BI;
1798 continue;
1799 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001800
Owen Andersonaf4240a2008-06-12 19:25:32 +00001801 // If we need some instructions deleted, do it now.
1802 NumGVNInstr += toErase.size();
Daniel Dunbara279bc32009-09-20 02:20:51 +00001803
Owen Andersonaf4240a2008-06-12 19:25:32 +00001804 // Avoid iterator invalidation.
1805 bool AtStart = BI == BB->begin();
1806 if (!AtStart)
1807 --BI;
1808
1809 for (SmallVector<Instruction*, 4>::iterator I = toErase.begin(),
Chris Lattner663e4412008-12-01 00:40:32 +00001810 E = toErase.end(); I != E; ++I) {
David Greenebf7f78e2010-01-05 01:27:17 +00001811 DEBUG(dbgs() << "GVN removed: " << **I << '\n');
Dan Gohman4ec01b22009-11-14 02:27:51 +00001812 if (MD) MD->removeInstruction(*I);
Owen Andersonaf4240a2008-06-12 19:25:32 +00001813 (*I)->eraseFromParent();
Bill Wendlingec40d502008-12-22 21:57:30 +00001814 DEBUG(verifyRemoved(*I));
Chris Lattner663e4412008-12-01 00:40:32 +00001815 }
Chris Lattnerae199312008-12-09 19:21:47 +00001816 toErase.clear();
Owen Andersonaf4240a2008-06-12 19:25:32 +00001817
1818 if (AtStart)
1819 BI = BB->begin();
1820 else
1821 ++BI;
Owen Andersonaf4240a2008-06-12 19:25:32 +00001822 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001823
Chris Lattnerb2412a82009-09-21 02:42:51 +00001824 return ChangedFunction;
Owen Andersonaf4240a2008-06-12 19:25:32 +00001825}
1826
Owen Andersonb2303722008-06-18 21:41:49 +00001827/// performPRE - Perform a purely local form of PRE that looks for diamond
1828/// control flow patterns and attempts to perform simple PRE at the join point.
Chris Lattnerfb6e7012009-10-31 22:11:15 +00001829bool GVN::performPRE(Function &F) {
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001830 bool Changed = false;
Chris Lattner09713792008-12-01 07:29:03 +00001831 DenseMap<BasicBlock*, Value*> predMap;
Owen Andersonb2303722008-06-18 21:41:49 +00001832 for (df_iterator<BasicBlock*> DI = df_begin(&F.getEntryBlock()),
1833 DE = df_end(&F.getEntryBlock()); DI != DE; ++DI) {
Chris Lattnerb2412a82009-09-21 02:42:51 +00001834 BasicBlock *CurrentBlock = *DI;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001835
Owen Andersonb2303722008-06-18 21:41:49 +00001836 // Nothing to PRE in the entry block.
1837 if (CurrentBlock == &F.getEntryBlock()) continue;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001838
Owen Andersonb2303722008-06-18 21:41:49 +00001839 for (BasicBlock::iterator BI = CurrentBlock->begin(),
1840 BE = CurrentBlock->end(); BI != BE; ) {
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001841 Instruction *CurInst = BI++;
Duncan Sands7af1c782009-05-06 06:49:50 +00001842
Victor Hernandez7b929da2009-10-23 21:09:37 +00001843 if (isa<AllocaInst>(CurInst) ||
Victor Hernandez83d63912009-09-18 22:35:49 +00001844 isa<TerminatorInst>(CurInst) || isa<PHINode>(CurInst) ||
Devang Patel9674d152009-10-14 17:29:00 +00001845 CurInst->getType()->isVoidTy() ||
Duncan Sands7af1c782009-05-06 06:49:50 +00001846 CurInst->mayReadFromMemory() || CurInst->mayHaveSideEffects() ||
John Criswell090c0a22009-03-10 15:04:53 +00001847 isa<DbgInfoIntrinsic>(CurInst))
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001848 continue;
Owen Anderson5015b342010-08-07 00:20:35 +00001849
1850 // We don't currently value number ANY inline asm calls.
1851 if (CallInst *CallI = dyn_cast<CallInst>(CurInst))
1852 if (CallI->isInlineAsm())
1853 continue;
Duncan Sands7af1c782009-05-06 06:49:50 +00001854
Chris Lattnerb2412a82009-09-21 02:42:51 +00001855 uint32_t ValNo = VN.lookup(CurInst);
Daniel Dunbara279bc32009-09-20 02:20:51 +00001856
Owen Andersonb2303722008-06-18 21:41:49 +00001857 // Look for the predecessors for PRE opportunities. We're
1858 // only trying to solve the basic diamond case, where
1859 // a value is computed in the successor and one predecessor,
1860 // but not the other. We also explicitly disallow cases
1861 // where the successor is its own predecessor, because they're
1862 // more complicated to get right.
Chris Lattnerb2412a82009-09-21 02:42:51 +00001863 unsigned NumWith = 0;
1864 unsigned NumWithout = 0;
1865 BasicBlock *PREPred = 0;
Chris Lattner09713792008-12-01 07:29:03 +00001866 predMap.clear();
1867
Owen Andersonb2303722008-06-18 21:41:49 +00001868 for (pred_iterator PI = pred_begin(CurrentBlock),
1869 PE = pred_end(CurrentBlock); PI != PE; ++PI) {
Gabor Greif08149852010-07-09 14:36:49 +00001870 BasicBlock *P = *PI;
Owen Andersonb2303722008-06-18 21:41:49 +00001871 // We're not interested in PRE where the block is its
Bob Wilsone7b635f2010-02-03 00:33:21 +00001872 // own predecessor, or in blocks with predecessors
Owen Anderson6fafe842008-06-20 01:15:47 +00001873 // that are not reachable.
Gabor Greif08149852010-07-09 14:36:49 +00001874 if (P == CurrentBlock) {
Chris Lattnerb2412a82009-09-21 02:42:51 +00001875 NumWithout = 2;
Owen Anderson6fafe842008-06-20 01:15:47 +00001876 break;
Owen Andersona04a0642010-11-18 18:32:40 +00001877 } else if (!DT->dominates(&F.getEntryBlock(), P)) {
Chris Lattnerb2412a82009-09-21 02:42:51 +00001878 NumWithout = 2;
Owen Anderson6fafe842008-06-20 01:15:47 +00001879 break;
1880 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001881
Owen Andersona04a0642010-11-18 18:32:40 +00001882 Value* predV = lookupNumber(P, ValNo);
1883 if (predV == 0) {
Gabor Greif08149852010-07-09 14:36:49 +00001884 PREPred = P;
Dan Gohmanfe601042010-06-22 15:08:57 +00001885 ++NumWithout;
Owen Andersona04a0642010-11-18 18:32:40 +00001886 } else if (predV == CurInst) {
Chris Lattnerb2412a82009-09-21 02:42:51 +00001887 NumWithout = 2;
Owen Andersonb2303722008-06-18 21:41:49 +00001888 } else {
Owen Andersona04a0642010-11-18 18:32:40 +00001889 predMap[P] = predV;
Dan Gohmanfe601042010-06-22 15:08:57 +00001890 ++NumWith;
Owen Andersonb2303722008-06-18 21:41:49 +00001891 }
1892 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001893
Owen Andersonb2303722008-06-18 21:41:49 +00001894 // Don't do PRE when it might increase code size, i.e. when
1895 // we would need to insert instructions in more than one pred.
Chris Lattnerb2412a82009-09-21 02:42:51 +00001896 if (NumWithout != 1 || NumWith == 0)
Owen Andersonb2303722008-06-18 21:41:49 +00001897 continue;
Chris Lattnerfb6e7012009-10-31 22:11:15 +00001898
1899 // Don't do PRE across indirect branch.
1900 if (isa<IndirectBrInst>(PREPred->getTerminator()))
1901 continue;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001902
Owen Anderson5c274ee2008-06-19 19:54:19 +00001903 // We can't do PRE safely on a critical edge, so instead we schedule
1904 // the edge to be split and perform the PRE the next time we iterate
1905 // on the function.
Bob Wilsonae23daf2010-02-16 21:06:42 +00001906 unsigned SuccNum = GetSuccessorNumber(PREPred, CurrentBlock);
Chris Lattnerb2412a82009-09-21 02:42:51 +00001907 if (isCriticalEdge(PREPred->getTerminator(), SuccNum)) {
1908 toSplit.push_back(std::make_pair(PREPred->getTerminator(), SuccNum));
Owen Anderson5c274ee2008-06-19 19:54:19 +00001909 continue;
1910 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001911
Bob Wilsone7b635f2010-02-03 00:33:21 +00001912 // Instantiate the expression in the predecessor that lacked it.
Owen Andersonb2303722008-06-18 21:41:49 +00001913 // Because we are going top-down through the block, all value numbers
1914 // will be available in the predecessor by the time we need them. Any
Bob Wilsone7b635f2010-02-03 00:33:21 +00001915 // that weren't originally present will have been instantiated earlier
Owen Andersonb2303722008-06-18 21:41:49 +00001916 // in this loop.
Nick Lewycky67760642009-09-27 07:38:41 +00001917 Instruction *PREInstr = CurInst->clone();
Owen Andersonb2303722008-06-18 21:41:49 +00001918 bool success = true;
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001919 for (unsigned i = 0, e = CurInst->getNumOperands(); i != e; ++i) {
1920 Value *Op = PREInstr->getOperand(i);
1921 if (isa<Argument>(Op) || isa<Constant>(Op) || isa<GlobalValue>(Op))
1922 continue;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001923
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001924 if (Value *V = lookupNumber(PREPred, VN.lookup(Op))) {
1925 PREInstr->setOperand(i, V);
1926 } else {
1927 success = false;
1928 break;
Owen Andersonc45996b2008-07-11 20:05:13 +00001929 }
Owen Andersonb2303722008-06-18 21:41:49 +00001930 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001931
Owen Andersonb2303722008-06-18 21:41:49 +00001932 // Fail out if we encounter an operand that is not available in
Daniel Dunbara279bc32009-09-20 02:20:51 +00001933 // the PRE predecessor. This is typically because of loads which
Owen Andersonb2303722008-06-18 21:41:49 +00001934 // are not value numbered precisely.
1935 if (!success) {
1936 delete PREInstr;
Bill Wendling70ded192008-12-22 22:14:07 +00001937 DEBUG(verifyRemoved(PREInstr));
Owen Andersonb2303722008-06-18 21:41:49 +00001938 continue;
1939 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001940
Owen Andersonb2303722008-06-18 21:41:49 +00001941 PREInstr->insertBefore(PREPred->getTerminator());
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001942 PREInstr->setName(CurInst->getName() + ".pre");
Owen Anderson6fafe842008-06-20 01:15:47 +00001943 predMap[PREPred] = PREInstr;
Chris Lattnerb2412a82009-09-21 02:42:51 +00001944 VN.add(PREInstr, ValNo);
Dan Gohmanfe601042010-06-22 15:08:57 +00001945 ++NumGVNPRE;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001946
Owen Andersonb2303722008-06-18 21:41:49 +00001947 // Update the availability map to include the new instruction.
Owen Andersonf0568382010-12-21 23:54:34 +00001948 insert_table(ValNo, PREInstr, PREPred);
Daniel Dunbara279bc32009-09-20 02:20:51 +00001949
Owen Andersonb2303722008-06-18 21:41:49 +00001950 // Create a PHI to make the value available in this block.
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001951 PHINode* Phi = PHINode::Create(CurInst->getType(),
1952 CurInst->getName() + ".pre-phi",
Owen Andersonb2303722008-06-18 21:41:49 +00001953 CurrentBlock->begin());
1954 for (pred_iterator PI = pred_begin(CurrentBlock),
Gabor Greif1d3ae022010-07-09 14:48:08 +00001955 PE = pred_end(CurrentBlock); PI != PE; ++PI) {
1956 BasicBlock *P = *PI;
1957 Phi->addIncoming(predMap[P], P);
1958 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001959
Chris Lattnerb2412a82009-09-21 02:42:51 +00001960 VN.add(Phi, ValNo);
Owen Andersonf0568382010-12-21 23:54:34 +00001961 insert_table(ValNo, Phi, CurrentBlock);
Daniel Dunbara279bc32009-09-20 02:20:51 +00001962
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001963 CurInst->replaceAllUsesWith(Phi);
Owen Anderson392249f2011-01-03 23:51:43 +00001964 if (Phi->getType()->isPointerTy()) {
1965 // Because we have added a PHI-use of the pointer value, it has now
1966 // "escaped" from alias analysis' perspective. We need to inform
1967 // AA of this.
1968 for (unsigned ii = 0, ee = Phi->getNumIncomingValues(); ii != ee; ++ii)
1969 VN.getAliasAnalysis()->addEscapingUse(Phi->getOperandUse(2*ii));
1970
1971 if (MD)
1972 MD->invalidateCachedPointerInfo(Phi);
1973 }
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001974 VN.erase(CurInst);
Owen Andersonf0568382010-12-21 23:54:34 +00001975 erase_table(ValNo, CurInst, CurrentBlock);
Daniel Dunbara279bc32009-09-20 02:20:51 +00001976
David Greenebf7f78e2010-01-05 01:27:17 +00001977 DEBUG(dbgs() << "GVN PRE removed: " << *CurInst << '\n');
Dan Gohman4ec01b22009-11-14 02:27:51 +00001978 if (MD) MD->removeInstruction(CurInst);
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001979 CurInst->eraseFromParent();
Bill Wendlingec40d502008-12-22 21:57:30 +00001980 DEBUG(verifyRemoved(CurInst));
Chris Lattnerd0f5bfc2008-12-01 07:35:54 +00001981 Changed = true;
Owen Andersonb2303722008-06-18 21:41:49 +00001982 }
1983 }
Daniel Dunbara279bc32009-09-20 02:20:51 +00001984
Bob Wilson484d4a32010-02-16 19:51:59 +00001985 if (splitCriticalEdges())
1986 Changed = true;
Daniel Dunbara279bc32009-09-20 02:20:51 +00001987
Bob Wilson484d4a32010-02-16 19:51:59 +00001988 return Changed;
1989}
1990
1991/// splitCriticalEdges - Split critical edges found during the previous
1992/// iteration that may enable further optimization.
1993bool GVN::splitCriticalEdges() {
1994 if (toSplit.empty())
1995 return false;
1996 do {
1997 std::pair<TerminatorInst*, unsigned> Edge = toSplit.pop_back_val();
1998 SplitCriticalEdge(Edge.first, Edge.second, this);
1999 } while (!toSplit.empty());
Evan Cheng19d417c2010-03-01 22:23:12 +00002000 if (MD) MD->invalidateCachedPredecessors();
Bob Wilson484d4a32010-02-16 19:51:59 +00002001 return true;
Owen Andersonb2303722008-06-18 21:41:49 +00002002}
2003
Bill Wendling30788b82008-12-22 22:32:22 +00002004/// iterateOnFunction - Executes one iteration of GVN
Owen Anderson3e75a422007-08-14 18:04:11 +00002005bool GVN::iterateOnFunction(Function &F) {
Nuno Lopes7cdd9ee2008-10-10 16:25:50 +00002006 cleanupGlobalSets();
Owen Andersona04a0642010-11-18 18:32:40 +00002007
Owen Anderson1ad2cb72007-07-24 17:55:58 +00002008 // Top-down walk of the dominator tree
Chris Lattnerb2412a82009-09-21 02:42:51 +00002009 bool Changed = false;
Owen Andersonc34d1122008-12-15 03:52:17 +00002010#if 0
2011 // Needed for value numbering with phi construction to work.
Owen Anderson255dafc2008-12-15 02:03:00 +00002012 ReversePostOrderTraversal<Function*> RPOT(&F);
2013 for (ReversePostOrderTraversal<Function*>::rpo_iterator RI = RPOT.begin(),
2014 RE = RPOT.end(); RI != RE; ++RI)
Chris Lattnerb2412a82009-09-21 02:42:51 +00002015 Changed |= processBlock(*RI);
Owen Andersonc34d1122008-12-15 03:52:17 +00002016#else
2017 for (df_iterator<DomTreeNode*> DI = df_begin(DT->getRootNode()),
2018 DE = df_end(DT->getRootNode()); DI != DE; ++DI)
Chris Lattnerb2412a82009-09-21 02:42:51 +00002019 Changed |= processBlock(DI->getBlock());
Owen Andersonc34d1122008-12-15 03:52:17 +00002020#endif
2021
Chris Lattnerb2412a82009-09-21 02:42:51 +00002022 return Changed;
Owen Anderson1ad2cb72007-07-24 17:55:58 +00002023}
Nuno Lopes7cdd9ee2008-10-10 16:25:50 +00002024
2025void GVN::cleanupGlobalSets() {
2026 VN.clear();
Owen Andersona04a0642010-11-18 18:32:40 +00002027 NumberTable.clear();
2028 TableAllocator.Reset();
Nuno Lopes7cdd9ee2008-10-10 16:25:50 +00002029}
Bill Wendling246dbbb2008-12-22 21:36:08 +00002030
2031/// verifyRemoved - Verify that the specified instruction does not occur in our
2032/// internal data structures.
Bill Wendling6d463f22008-12-22 22:28:56 +00002033void GVN::verifyRemoved(const Instruction *Inst) const {
2034 VN.verifyRemoved(Inst);
Bill Wendling70ded192008-12-22 22:14:07 +00002035
Bill Wendling6d463f22008-12-22 22:28:56 +00002036 // Walk through the value number scope to make sure the instruction isn't
2037 // ferreted away in it.
Owen Andersonf0568382010-12-21 23:54:34 +00002038 for (DenseMap<uint32_t, NumberTableEntry>::const_iterator
Owen Andersona04a0642010-11-18 18:32:40 +00002039 I = NumberTable.begin(), E = NumberTable.end(); I != E; ++I) {
Owen Andersonf0568382010-12-21 23:54:34 +00002040 const NumberTableEntry *Node = &I->second;
2041 assert(Node->Val != Inst && "Inst still in value numbering scope!");
Owen Andersona04a0642010-11-18 18:32:40 +00002042
Owen Andersonf0568382010-12-21 23:54:34 +00002043 while (Node->Next) {
2044 Node = Node->Next;
2045 assert(Node->Val != Inst && "Inst still in value numbering scope!");
Bill Wendling70ded192008-12-22 22:14:07 +00002046 }
2047 }
Bill Wendling246dbbb2008-12-22 21:36:08 +00002048}