blob: 249194d036c040ecd056969581958cd2f853500d [file] [log] [blame]
Chris Lattner159b98f2008-12-05 07:49:08 +00001//===- GVN.cpp - Eliminate redundant values and loads ---------------------===//
Owen Anderson85c40642007-07-24 17:55:58 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-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 Anderson85c40642007-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 Criswell6e0aa282009-03-10 15:04:53 +000013// Note that this pass does the value numbering itself; it does not use the
Matthijs Kooijman9aac1db2008-06-05 07:55:49 +000014// ValueNumbering analysis passes.
15//
Owen Anderson85c40642007-07-24 17:55:58 +000016//===----------------------------------------------------------------------===//
17
18#define DEBUG_TYPE "gvn"
Owen Anderson85c40642007-07-24 17:55:58 +000019#include "llvm/Transforms/Scalar.h"
Owen Anderson5d72a422007-07-25 19:57:03 +000020#include "llvm/BasicBlock.h"
Owen Andersonacfa3ad2007-07-26 18:26:51 +000021#include "llvm/Constants.h"
Owen Anderson85c40642007-07-24 17:55:58 +000022#include "llvm/DerivedTypes.h"
Owen Andersonacfa3ad2007-07-26 18:26:51 +000023#include "llvm/Function.h"
Devang Patela7379552009-03-06 02:59:27 +000024#include "llvm/IntrinsicInst.h"
Owen Anderson24be4c12009-07-03 00:17:18 +000025#include "llvm/LLVMContext.h"
Chris Lattner0907b522009-09-21 05:57:11 +000026#include "llvm/Operator.h"
Owen Andersonacfa3ad2007-07-26 18:26:51 +000027#include "llvm/Value.h"
Owen Anderson85c40642007-07-24 17:55:58 +000028#include "llvm/ADT/DenseMap.h"
29#include "llvm/ADT/DepthFirstIterator.h"
Owen Andersona03e7862008-12-15 02:03:00 +000030#include "llvm/ADT/PostOrderIterator.h"
Owen Anderson85c40642007-07-24 17:55:58 +000031#include "llvm/ADT/SmallPtrSet.h"
32#include "llvm/ADT/SmallVector.h"
33#include "llvm/ADT/Statistic.h"
Owen Anderson5e9366f2007-10-18 19:39:33 +000034#include "llvm/Analysis/AliasAnalysis.h"
Chris Lattner4bb632f2009-12-06 05:29:56 +000035#include "llvm/Analysis/ConstantFolding.h"
36#include "llvm/Analysis/Dominators.h"
Victor Hernandez28f4d2f2009-10-27 20:05:49 +000037#include "llvm/Analysis/MemoryBuiltins.h"
Owen Anderson85c40642007-07-24 17:55:58 +000038#include "llvm/Analysis/MemoryDependenceAnalysis.h"
Chris Lattnerefff3222009-12-09 01:59:31 +000039#include "llvm/Analysis/PHITransAddr.h"
Owen Anderson85c40642007-07-24 17:55:58 +000040#include "llvm/Support/CFG.h"
Owen Andersona2bf7662008-06-19 19:57:25 +000041#include "llvm/Support/CommandLine.h"
Chris Lattner9c5be3c2008-03-29 04:36:18 +000042#include "llvm/Support/Debug.h"
Edwin Török675d5622009-07-11 20:10:48 +000043#include "llvm/Support/ErrorHandling.h"
Chris Lattner0907b522009-09-21 05:57:11 +000044#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattnercb00f732009-12-06 01:57:02 +000045#include "llvm/Support/IRBuilder.h"
Daniel Dunbar005975c2009-07-25 00:23:56 +000046#include "llvm/Support/raw_ostream.h"
Chris Lattner7741aa52009-09-20 19:03:47 +000047#include "llvm/Target/TargetData.h"
Owen Andersonec747c42008-06-19 19:54:19 +000048#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Dale Johannesena19b67f2009-06-17 20:48:23 +000049#include "llvm/Transforms/Utils/Local.h"
Chris Lattner6e5ea272009-10-10 23:50:30 +000050#include "llvm/Transforms/Utils/SSAUpdater.h"
Owen Anderson85c40642007-07-24 17:55:58 +000051using namespace llvm;
52
Bill Wendling3858cae2008-12-22 22:14:07 +000053STATISTIC(NumGVNInstr, "Number of instructions deleted");
54STATISTIC(NumGVNLoad, "Number of loads deleted");
55STATISTIC(NumGVNPRE, "Number of instructions PRE'd");
Owen Anderson7558f202008-07-15 16:28:06 +000056STATISTIC(NumGVNBlocks, "Number of blocks merged");
Bill Wendling3858cae2008-12-22 22:14:07 +000057STATISTIC(NumPRELoad, "Number of loads PRE'd");
Chris Lattner1be83222008-03-22 04:13:49 +000058
Evan Cheng019a2e12008-06-20 01:01:07 +000059static cl::opt<bool> EnablePRE("enable-pre",
Owen Anderson3a053612008-07-17 19:41:00 +000060 cl::init(true), cl::Hidden);
Dan Gohman828f89f2009-06-15 18:30:15 +000061static cl::opt<bool> EnableLoadPRE("enable-load-pre", cl::init(true));
Owen Andersona2bf7662008-06-19 19:57:25 +000062
Owen Anderson85c40642007-07-24 17:55:58 +000063//===----------------------------------------------------------------------===//
64// ValueTable Class
65//===----------------------------------------------------------------------===//
66
67/// This class holds the mapping between values and value numbers. It is used
68/// as an efficient mechanism to determine the expression-wise equivalence of
69/// two values.
70namespace {
Chris Lattnerfa2d1ba2009-09-02 06:11:42 +000071 struct Expression {
Dan Gohman7ce405e2009-06-04 22:49:04 +000072 enum ExpressionOpcode { ADD, FADD, SUB, FSUB, MUL, FMUL,
73 UDIV, SDIV, FDIV, UREM, SREM,
Daniel Dunbar3be44e62009-09-20 02:20:51 +000074 FREM, SHL, LSHR, ASHR, AND, OR, XOR, ICMPEQ,
75 ICMPNE, ICMPUGT, ICMPUGE, ICMPULT, ICMPULE,
76 ICMPSGT, ICMPSGE, ICMPSLT, ICMPSLE, FCMPOEQ,
77 FCMPOGT, FCMPOGE, FCMPOLT, FCMPOLE, FCMPONE,
78 FCMPORD, FCMPUNO, FCMPUEQ, FCMPUGT, FCMPUGE,
Owen Anderson85c40642007-07-24 17:55:58 +000079 FCMPULT, FCMPULE, FCMPUNE, EXTRACT, INSERT,
80 SHUFFLE, SELECT, TRUNC, ZEXT, SEXT, FPTOUI,
Daniel Dunbar3be44e62009-09-20 02:20:51 +000081 FPTOSI, UITOFP, SITOFP, FPTRUNC, FPEXT,
Owen Anderson771d1122008-05-13 08:17:22 +000082 PTRTOINT, INTTOPTR, BITCAST, GEP, CALL, CONSTANT,
Owen Andersona7d4c7c2009-10-19 22:14:22 +000083 INSERTVALUE, EXTRACTVALUE, EMPTY, TOMBSTONE };
Owen Anderson85c40642007-07-24 17:55:58 +000084
85 ExpressionOpcode opcode;
86 const Type* type;
Owen Anderson85c40642007-07-24 17:55:58 +000087 SmallVector<uint32_t, 4> varargs;
Chris Lattnerff36c952009-09-21 02:42:51 +000088 Value *function;
Daniel Dunbar3be44e62009-09-20 02:20:51 +000089
Owen Anderson85c40642007-07-24 17:55:58 +000090 Expression() { }
91 Expression(ExpressionOpcode o) : opcode(o) { }
Daniel Dunbar3be44e62009-09-20 02:20:51 +000092
Owen Anderson85c40642007-07-24 17:55:58 +000093 bool operator==(const Expression &other) const {
94 if (opcode != other.opcode)
95 return false;
96 else if (opcode == EMPTY || opcode == TOMBSTONE)
97 return true;
98 else if (type != other.type)
99 return false;
Owen Anderson5e9366f2007-10-18 19:39:33 +0000100 else if (function != other.function)
101 return false;
Owen Anderson85c40642007-07-24 17:55:58 +0000102 else {
103 if (varargs.size() != other.varargs.size())
104 return false;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000105
Owen Anderson85c40642007-07-24 17:55:58 +0000106 for (size_t i = 0; i < varargs.size(); ++i)
107 if (varargs[i] != other.varargs[i])
108 return false;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000109
Owen Anderson85c40642007-07-24 17:55:58 +0000110 return true;
111 }
112 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000113
Owen Anderson85c40642007-07-24 17:55:58 +0000114 bool operator!=(const Expression &other) const {
Bill Wendling9b5d4b72008-12-22 22:16:31 +0000115 return !(*this == other);
Owen Anderson85c40642007-07-24 17:55:58 +0000116 }
117 };
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000118
Chris Lattnerfa2d1ba2009-09-02 06:11:42 +0000119 class ValueTable {
Owen Anderson85c40642007-07-24 17:55:58 +0000120 private:
121 DenseMap<Value*, uint32_t> valueNumbering;
122 DenseMap<Expression, uint32_t> expressionNumbering;
Owen Andersonbcf2bd52008-05-12 20:15:55 +0000123 AliasAnalysis* AA;
124 MemoryDependenceAnalysis* MD;
125 DominatorTree* DT;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000126
Owen Anderson85c40642007-07-24 17:55:58 +0000127 uint32_t nextValueNumber;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000128
Owen Anderson85c40642007-07-24 17:55:58 +0000129 Expression::ExpressionOpcode getOpcode(BinaryOperator* BO);
130 Expression::ExpressionOpcode getOpcode(CmpInst* C);
131 Expression::ExpressionOpcode getOpcode(CastInst* C);
132 Expression create_expression(BinaryOperator* BO);
133 Expression create_expression(CmpInst* C);
134 Expression create_expression(ShuffleVectorInst* V);
135 Expression create_expression(ExtractElementInst* C);
136 Expression create_expression(InsertElementInst* V);
137 Expression create_expression(SelectInst* V);
138 Expression create_expression(CastInst* C);
139 Expression create_expression(GetElementPtrInst* G);
Owen Anderson5e9366f2007-10-18 19:39:33 +0000140 Expression create_expression(CallInst* C);
Owen Anderson771d1122008-05-13 08:17:22 +0000141 Expression create_expression(Constant* C);
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000142 Expression create_expression(ExtractValueInst* C);
143 Expression create_expression(InsertValueInst* C);
144
145 uint32_t lookup_or_add_call(CallInst* C);
Owen Anderson85c40642007-07-24 17:55:58 +0000146 public:
Dan Gohman936a6522009-04-01 16:37:47 +0000147 ValueTable() : nextValueNumber(1) { }
Chris Lattnerff36c952009-09-21 02:42:51 +0000148 uint32_t lookup_or_add(Value *V);
149 uint32_t lookup(Value *V) const;
150 void add(Value *V, uint32_t num);
Owen Anderson85c40642007-07-24 17:55:58 +0000151 void clear();
Chris Lattnerff36c952009-09-21 02:42:51 +0000152 void erase(Value *v);
Owen Anderson85c40642007-07-24 17:55:58 +0000153 unsigned size();
Owen Andersonbcf2bd52008-05-12 20:15:55 +0000154 void setAliasAnalysis(AliasAnalysis* A) { AA = A; }
Chris Lattner02ca4422008-12-01 00:40:32 +0000155 AliasAnalysis *getAliasAnalysis() const { return AA; }
Owen Andersonbcf2bd52008-05-12 20:15:55 +0000156 void setMemDep(MemoryDependenceAnalysis* M) { MD = M; }
157 void setDomTree(DominatorTree* D) { DT = D; }
Owen Anderson8a8d13c2008-07-03 17:44:33 +0000158 uint32_t getNextUnusedValueNumber() { return nextValueNumber; }
Bill Wendling2a023742008-12-22 21:36:08 +0000159 void verifyRemoved(const Value *) const;
Owen Anderson85c40642007-07-24 17:55:58 +0000160 };
161}
162
163namespace llvm {
Chris Lattner92eea072007-09-17 18:34:04 +0000164template <> struct DenseMapInfo<Expression> {
Owen Andersonbf8a3eb2007-08-02 18:16:06 +0000165 static inline Expression getEmptyKey() {
166 return Expression(Expression::EMPTY);
167 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000168
Owen Andersonbf8a3eb2007-08-02 18:16:06 +0000169 static inline Expression getTombstoneKey() {
170 return Expression(Expression::TOMBSTONE);
171 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000172
Owen Anderson85c40642007-07-24 17:55:58 +0000173 static unsigned getHashValue(const Expression e) {
174 unsigned hash = e.opcode;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000175
Anton Korobeynikov8522e1c2008-02-20 11:26:25 +0000176 hash = ((unsigned)((uintptr_t)e.type >> 4) ^
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000177 (unsigned)((uintptr_t)e.type >> 9));
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000178
Owen Andersonbf8a3eb2007-08-02 18:16:06 +0000179 for (SmallVector<uint32_t, 4>::const_iterator I = e.varargs.begin(),
180 E = e.varargs.end(); I != E; ++I)
Owen Anderson85c40642007-07-24 17:55:58 +0000181 hash = *I + hash * 37;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000182
Anton Korobeynikov8522e1c2008-02-20 11:26:25 +0000183 hash = ((unsigned)((uintptr_t)e.function >> 4) ^
184 (unsigned)((uintptr_t)e.function >> 9)) +
185 hash * 37;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000186
Owen Anderson85c40642007-07-24 17:55:58 +0000187 return hash;
188 }
Chris Lattner92eea072007-09-17 18:34:04 +0000189 static bool isEqual(const Expression &LHS, const Expression &RHS) {
190 return LHS == RHS;
191 }
Owen Anderson85c40642007-07-24 17:55:58 +0000192};
Chris Lattner169f3a22009-12-15 07:26:43 +0000193
194template <>
195struct isPodLike<Expression> { static const bool value = true; };
196
Owen Anderson85c40642007-07-24 17:55:58 +0000197}
198
199//===----------------------------------------------------------------------===//
200// ValueTable Internal Functions
201//===----------------------------------------------------------------------===//
Chris Lattner3d7103e2008-03-21 21:14:38 +0000202Expression::ExpressionOpcode ValueTable::getOpcode(BinaryOperator* BO) {
Owen Anderson85c40642007-07-24 17:55:58 +0000203 switch(BO->getOpcode()) {
Chris Lattner3d7103e2008-03-21 21:14:38 +0000204 default: // THIS SHOULD NEVER HAPPEN
Edwin Törökbd448e32009-07-14 16:55:14 +0000205 llvm_unreachable("Binary operator with unknown opcode?");
Chris Lattner3d7103e2008-03-21 21:14:38 +0000206 case Instruction::Add: return Expression::ADD;
Dan Gohman7ce405e2009-06-04 22:49:04 +0000207 case Instruction::FAdd: return Expression::FADD;
Chris Lattner3d7103e2008-03-21 21:14:38 +0000208 case Instruction::Sub: return Expression::SUB;
Dan Gohman7ce405e2009-06-04 22:49:04 +0000209 case Instruction::FSub: return Expression::FSUB;
Chris Lattner3d7103e2008-03-21 21:14:38 +0000210 case Instruction::Mul: return Expression::MUL;
Dan Gohman7ce405e2009-06-04 22:49:04 +0000211 case Instruction::FMul: return Expression::FMUL;
Chris Lattner3d7103e2008-03-21 21:14:38 +0000212 case Instruction::UDiv: return Expression::UDIV;
213 case Instruction::SDiv: return Expression::SDIV;
214 case Instruction::FDiv: return Expression::FDIV;
215 case Instruction::URem: return Expression::UREM;
216 case Instruction::SRem: return Expression::SREM;
217 case Instruction::FRem: return Expression::FREM;
218 case Instruction::Shl: return Expression::SHL;
219 case Instruction::LShr: return Expression::LSHR;
220 case Instruction::AShr: return Expression::ASHR;
221 case Instruction::And: return Expression::AND;
222 case Instruction::Or: return Expression::OR;
223 case Instruction::Xor: return Expression::XOR;
Owen Anderson85c40642007-07-24 17:55:58 +0000224 }
225}
226
227Expression::ExpressionOpcode ValueTable::getOpcode(CmpInst* C) {
Nick Lewycky8f5253b2009-07-08 03:04:38 +0000228 if (isa<ICmpInst>(C)) {
Owen Anderson85c40642007-07-24 17:55:58 +0000229 switch (C->getPredicate()) {
Chris Lattner3d7103e2008-03-21 21:14:38 +0000230 default: // THIS SHOULD NEVER HAPPEN
Edwin Törökbd448e32009-07-14 16:55:14 +0000231 llvm_unreachable("Comparison with unknown predicate?");
Chris Lattner3d7103e2008-03-21 21:14:38 +0000232 case ICmpInst::ICMP_EQ: return Expression::ICMPEQ;
233 case ICmpInst::ICMP_NE: return Expression::ICMPNE;
234 case ICmpInst::ICMP_UGT: return Expression::ICMPUGT;
235 case ICmpInst::ICMP_UGE: return Expression::ICMPUGE;
236 case ICmpInst::ICMP_ULT: return Expression::ICMPULT;
237 case ICmpInst::ICMP_ULE: return Expression::ICMPULE;
238 case ICmpInst::ICMP_SGT: return Expression::ICMPSGT;
239 case ICmpInst::ICMP_SGE: return Expression::ICMPSGE;
240 case ICmpInst::ICMP_SLT: return Expression::ICMPSLT;
241 case ICmpInst::ICMP_SLE: return Expression::ICMPSLE;
Owen Anderson85c40642007-07-24 17:55:58 +0000242 }
Nick Lewycky8f5253b2009-07-08 03:04:38 +0000243 } else {
244 switch (C->getPredicate()) {
245 default: // THIS SHOULD NEVER HAPPEN
Edwin Törökbd448e32009-07-14 16:55:14 +0000246 llvm_unreachable("Comparison with unknown predicate?");
Nick Lewycky8f5253b2009-07-08 03:04:38 +0000247 case FCmpInst::FCMP_OEQ: return Expression::FCMPOEQ;
248 case FCmpInst::FCMP_OGT: return Expression::FCMPOGT;
249 case FCmpInst::FCMP_OGE: return Expression::FCMPOGE;
250 case FCmpInst::FCMP_OLT: return Expression::FCMPOLT;
251 case FCmpInst::FCMP_OLE: return Expression::FCMPOLE;
252 case FCmpInst::FCMP_ONE: return Expression::FCMPONE;
253 case FCmpInst::FCMP_ORD: return Expression::FCMPORD;
254 case FCmpInst::FCMP_UNO: return Expression::FCMPUNO;
255 case FCmpInst::FCMP_UEQ: return Expression::FCMPUEQ;
256 case FCmpInst::FCMP_UGT: return Expression::FCMPUGT;
257 case FCmpInst::FCMP_UGE: return Expression::FCMPUGE;
258 case FCmpInst::FCMP_ULT: return Expression::FCMPULT;
259 case FCmpInst::FCMP_ULE: return Expression::FCMPULE;
260 case FCmpInst::FCMP_UNE: return Expression::FCMPUNE;
261 }
Owen Anderson85c40642007-07-24 17:55:58 +0000262 }
263}
264
Chris Lattner3d7103e2008-03-21 21:14:38 +0000265Expression::ExpressionOpcode ValueTable::getOpcode(CastInst* C) {
Owen Anderson85c40642007-07-24 17:55:58 +0000266 switch(C->getOpcode()) {
Chris Lattner3d7103e2008-03-21 21:14:38 +0000267 default: // THIS SHOULD NEVER HAPPEN
Edwin Törökbd448e32009-07-14 16:55:14 +0000268 llvm_unreachable("Cast operator with unknown opcode?");
Chris Lattner3d7103e2008-03-21 21:14:38 +0000269 case Instruction::Trunc: return Expression::TRUNC;
270 case Instruction::ZExt: return Expression::ZEXT;
271 case Instruction::SExt: return Expression::SEXT;
272 case Instruction::FPToUI: return Expression::FPTOUI;
273 case Instruction::FPToSI: return Expression::FPTOSI;
274 case Instruction::UIToFP: return Expression::UITOFP;
275 case Instruction::SIToFP: return Expression::SITOFP;
276 case Instruction::FPTrunc: return Expression::FPTRUNC;
277 case Instruction::FPExt: return Expression::FPEXT;
278 case Instruction::PtrToInt: return Expression::PTRTOINT;
279 case Instruction::IntToPtr: return Expression::INTTOPTR;
280 case Instruction::BitCast: return Expression::BITCAST;
Owen Anderson85c40642007-07-24 17:55:58 +0000281 }
282}
283
Owen Anderson5e9366f2007-10-18 19:39:33 +0000284Expression ValueTable::create_expression(CallInst* C) {
285 Expression e;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000286
Owen Anderson5e9366f2007-10-18 19:39:33 +0000287 e.type = C->getType();
Owen Anderson5e9366f2007-10-18 19:39:33 +0000288 e.function = C->getCalledFunction();
289 e.opcode = Expression::CALL;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000290
Owen Anderson5e9366f2007-10-18 19:39:33 +0000291 for (CallInst::op_iterator I = C->op_begin()+1, E = C->op_end();
292 I != E; ++I)
Owen Anderson07f478f2008-04-11 05:11:49 +0000293 e.varargs.push_back(lookup_or_add(*I));
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000294
Owen Anderson5e9366f2007-10-18 19:39:33 +0000295 return e;
296}
297
Owen Anderson85c40642007-07-24 17:55:58 +0000298Expression ValueTable::create_expression(BinaryOperator* BO) {
299 Expression e;
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000300 e.varargs.push_back(lookup_or_add(BO->getOperand(0)));
301 e.varargs.push_back(lookup_or_add(BO->getOperand(1)));
Owen Anderson5e9366f2007-10-18 19:39:33 +0000302 e.function = 0;
Owen Anderson85c40642007-07-24 17:55:58 +0000303 e.type = BO->getType();
304 e.opcode = getOpcode(BO);
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000305
Owen Anderson85c40642007-07-24 17:55:58 +0000306 return e;
307}
308
309Expression ValueTable::create_expression(CmpInst* C) {
310 Expression e;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000311
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000312 e.varargs.push_back(lookup_or_add(C->getOperand(0)));
313 e.varargs.push_back(lookup_or_add(C->getOperand(1)));
Owen Anderson5e9366f2007-10-18 19:39:33 +0000314 e.function = 0;
Owen Anderson85c40642007-07-24 17:55:58 +0000315 e.type = C->getType();
316 e.opcode = getOpcode(C);
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000317
Owen Anderson85c40642007-07-24 17:55:58 +0000318 return e;
319}
320
321Expression ValueTable::create_expression(CastInst* C) {
322 Expression e;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000323
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000324 e.varargs.push_back(lookup_or_add(C->getOperand(0)));
Owen Anderson5e9366f2007-10-18 19:39:33 +0000325 e.function = 0;
Owen Anderson85c40642007-07-24 17:55:58 +0000326 e.type = C->getType();
327 e.opcode = getOpcode(C);
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000328
Owen Anderson85c40642007-07-24 17:55:58 +0000329 return e;
330}
331
332Expression ValueTable::create_expression(ShuffleVectorInst* S) {
333 Expression e;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000334
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000335 e.varargs.push_back(lookup_or_add(S->getOperand(0)));
336 e.varargs.push_back(lookup_or_add(S->getOperand(1)));
337 e.varargs.push_back(lookup_or_add(S->getOperand(2)));
Owen Anderson5e9366f2007-10-18 19:39:33 +0000338 e.function = 0;
Owen Anderson85c40642007-07-24 17:55:58 +0000339 e.type = S->getType();
340 e.opcode = Expression::SHUFFLE;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000341
Owen Anderson85c40642007-07-24 17:55:58 +0000342 return e;
343}
344
345Expression ValueTable::create_expression(ExtractElementInst* E) {
346 Expression e;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000347
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000348 e.varargs.push_back(lookup_or_add(E->getOperand(0)));
349 e.varargs.push_back(lookup_or_add(E->getOperand(1)));
Owen Anderson5e9366f2007-10-18 19:39:33 +0000350 e.function = 0;
Owen Anderson85c40642007-07-24 17:55:58 +0000351 e.type = E->getType();
352 e.opcode = Expression::EXTRACT;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000353
Owen Anderson85c40642007-07-24 17:55:58 +0000354 return e;
355}
356
357Expression ValueTable::create_expression(InsertElementInst* I) {
358 Expression e;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000359
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000360 e.varargs.push_back(lookup_or_add(I->getOperand(0)));
361 e.varargs.push_back(lookup_or_add(I->getOperand(1)));
362 e.varargs.push_back(lookup_or_add(I->getOperand(2)));
Owen Anderson5e9366f2007-10-18 19:39:33 +0000363 e.function = 0;
Owen Anderson85c40642007-07-24 17:55:58 +0000364 e.type = I->getType();
365 e.opcode = Expression::INSERT;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000366
Owen Anderson85c40642007-07-24 17:55:58 +0000367 return e;
368}
369
370Expression ValueTable::create_expression(SelectInst* I) {
371 Expression e;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000372
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000373 e.varargs.push_back(lookup_or_add(I->getCondition()));
374 e.varargs.push_back(lookup_or_add(I->getTrueValue()));
375 e.varargs.push_back(lookup_or_add(I->getFalseValue()));
Owen Anderson5e9366f2007-10-18 19:39:33 +0000376 e.function = 0;
Owen Anderson85c40642007-07-24 17:55:58 +0000377 e.type = I->getType();
378 e.opcode = Expression::SELECT;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000379
Owen Anderson85c40642007-07-24 17:55:58 +0000380 return e;
381}
382
383Expression ValueTable::create_expression(GetElementPtrInst* G) {
384 Expression e;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000385
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000386 e.varargs.push_back(lookup_or_add(G->getPointerOperand()));
Owen Anderson5e9366f2007-10-18 19:39:33 +0000387 e.function = 0;
Owen Anderson85c40642007-07-24 17:55:58 +0000388 e.type = G->getType();
389 e.opcode = Expression::GEP;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000390
Owen Anderson85c40642007-07-24 17:55:58 +0000391 for (GetElementPtrInst::op_iterator I = G->idx_begin(), E = G->idx_end();
392 I != E; ++I)
Owen Anderson07f478f2008-04-11 05:11:49 +0000393 e.varargs.push_back(lookup_or_add(*I));
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000394
Owen Anderson85c40642007-07-24 17:55:58 +0000395 return e;
396}
397
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000398Expression ValueTable::create_expression(ExtractValueInst* E) {
399 Expression e;
400
401 e.varargs.push_back(lookup_or_add(E->getAggregateOperand()));
402 for (ExtractValueInst::idx_iterator II = E->idx_begin(), IE = E->idx_end();
403 II != IE; ++II)
404 e.varargs.push_back(*II);
405 e.function = 0;
406 e.type = E->getType();
407 e.opcode = Expression::EXTRACTVALUE;
408
409 return e;
410}
411
412Expression ValueTable::create_expression(InsertValueInst* E) {
413 Expression e;
414
415 e.varargs.push_back(lookup_or_add(E->getAggregateOperand()));
416 e.varargs.push_back(lookup_or_add(E->getInsertedValueOperand()));
417 for (InsertValueInst::idx_iterator II = E->idx_begin(), IE = E->idx_end();
418 II != IE; ++II)
419 e.varargs.push_back(*II);
420 e.function = 0;
421 e.type = E->getType();
422 e.opcode = Expression::INSERTVALUE;
423
424 return e;
425}
426
Owen Anderson85c40642007-07-24 17:55:58 +0000427//===----------------------------------------------------------------------===//
428// ValueTable External Functions
429//===----------------------------------------------------------------------===//
430
Owen Andersone6b4ff82008-06-18 21:41:49 +0000431/// add - Insert a value into the table with a specified value number.
Chris Lattnerff36c952009-09-21 02:42:51 +0000432void ValueTable::add(Value *V, uint32_t num) {
Owen Andersone6b4ff82008-06-18 21:41:49 +0000433 valueNumbering.insert(std::make_pair(V, num));
434}
435
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000436uint32_t ValueTable::lookup_or_add_call(CallInst* C) {
437 if (AA->doesNotAccessMemory(C)) {
438 Expression exp = create_expression(C);
439 uint32_t& e = expressionNumbering[exp];
440 if (!e) e = nextValueNumber++;
441 valueNumbering[C] = e;
442 return e;
443 } else if (AA->onlyReadsMemory(C)) {
444 Expression exp = create_expression(C);
445 uint32_t& e = expressionNumbering[exp];
446 if (!e) {
447 e = nextValueNumber++;
448 valueNumbering[C] = e;
449 return e;
450 }
Dan Gohmanc8d26652009-11-14 02:27:51 +0000451 if (!MD) {
452 e = nextValueNumber++;
453 valueNumbering[C] = e;
454 return e;
455 }
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000456
457 MemDepResult local_dep = MD->getDependency(C);
458
459 if (!local_dep.isDef() && !local_dep.isNonLocal()) {
460 valueNumbering[C] = nextValueNumber;
461 return nextValueNumber++;
462 }
463
464 if (local_dep.isDef()) {
465 CallInst* local_cdep = cast<CallInst>(local_dep.getInst());
466
467 if (local_cdep->getNumOperands() != C->getNumOperands()) {
468 valueNumbering[C] = nextValueNumber;
469 return nextValueNumber++;
470 }
471
472 for (unsigned i = 1; i < C->getNumOperands(); ++i) {
473 uint32_t c_vn = lookup_or_add(C->getOperand(i));
474 uint32_t cd_vn = lookup_or_add(local_cdep->getOperand(i));
475 if (c_vn != cd_vn) {
476 valueNumbering[C] = nextValueNumber;
477 return nextValueNumber++;
478 }
479 }
480
481 uint32_t v = lookup_or_add(local_cdep);
482 valueNumbering[C] = v;
483 return v;
484 }
485
486 // Non-local case.
487 const MemoryDependenceAnalysis::NonLocalDepInfo &deps =
488 MD->getNonLocalCallDependency(CallSite(C));
489 // FIXME: call/call dependencies for readonly calls should return def, not
490 // clobber! Move the checking logic to MemDep!
491 CallInst* cdep = 0;
492
493 // Check to see if we have a single dominating call instruction that is
494 // identical to C.
495 for (unsigned i = 0, e = deps.size(); i != e; ++i) {
Chris Lattner1a957962009-12-09 07:08:01 +0000496 const NonLocalDepEntry *I = &deps[i];
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000497 // Ignore non-local dependencies.
Chris Lattner1a957962009-12-09 07:08:01 +0000498 if (I->getResult().isNonLocal())
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000499 continue;
500
501 // We don't handle non-depedencies. If we already have a call, reject
502 // instruction dependencies.
Chris Lattner1a957962009-12-09 07:08:01 +0000503 if (I->getResult().isClobber() || cdep != 0) {
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000504 cdep = 0;
505 break;
506 }
507
Chris Lattner1a957962009-12-09 07:08:01 +0000508 CallInst *NonLocalDepCall = dyn_cast<CallInst>(I->getResult().getInst());
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000509 // FIXME: All duplicated with non-local case.
Chris Lattner1a957962009-12-09 07:08:01 +0000510 if (NonLocalDepCall && DT->properlyDominates(I->getBB(), C->getParent())){
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000511 cdep = NonLocalDepCall;
512 continue;
513 }
514
515 cdep = 0;
516 break;
517 }
518
519 if (!cdep) {
520 valueNumbering[C] = nextValueNumber;
521 return nextValueNumber++;
522 }
523
524 if (cdep->getNumOperands() != C->getNumOperands()) {
525 valueNumbering[C] = nextValueNumber;
526 return nextValueNumber++;
527 }
528 for (unsigned i = 1; i < C->getNumOperands(); ++i) {
529 uint32_t c_vn = lookup_or_add(C->getOperand(i));
530 uint32_t cd_vn = lookup_or_add(cdep->getOperand(i));
531 if (c_vn != cd_vn) {
532 valueNumbering[C] = nextValueNumber;
533 return nextValueNumber++;
534 }
535 }
536
537 uint32_t v = lookup_or_add(cdep);
538 valueNumbering[C] = v;
539 return v;
540
541 } else {
542 valueNumbering[C] = nextValueNumber;
543 return nextValueNumber++;
544 }
545}
546
Owen Anderson85c40642007-07-24 17:55:58 +0000547/// lookup_or_add - Returns the value number for the specified value, assigning
548/// it a new number if it did not have one before.
Chris Lattnerff36c952009-09-21 02:42:51 +0000549uint32_t ValueTable::lookup_or_add(Value *V) {
Owen Anderson85c40642007-07-24 17:55:58 +0000550 DenseMap<Value*, uint32_t>::iterator VI = valueNumbering.find(V);
551 if (VI != valueNumbering.end())
552 return VI->second;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000553
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000554 if (!isa<Instruction>(V)) {
Owen Andersonb472cd82009-10-19 21:14:57 +0000555 valueNumbering[V] = nextValueNumber;
Owen Anderson85c40642007-07-24 17:55:58 +0000556 return nextValueNumber++;
557 }
Owen Andersona7d4c7c2009-10-19 22:14:22 +0000558
559 Instruction* I = cast<Instruction>(V);
560 Expression exp;
561 switch (I->getOpcode()) {
562 case Instruction::Call:
563 return lookup_or_add_call(cast<CallInst>(I));
564 case Instruction::Add:
565 case Instruction::FAdd:
566 case Instruction::Sub:
567 case Instruction::FSub:
568 case Instruction::Mul:
569 case Instruction::FMul:
570 case Instruction::UDiv:
571 case Instruction::SDiv:
572 case Instruction::FDiv:
573 case Instruction::URem:
574 case Instruction::SRem:
575 case Instruction::FRem:
576 case Instruction::Shl:
577 case Instruction::LShr:
578 case Instruction::AShr:
579 case Instruction::And:
580 case Instruction::Or :
581 case Instruction::Xor:
582 exp = create_expression(cast<BinaryOperator>(I));
583 break;
584 case Instruction::ICmp:
585 case Instruction::FCmp:
586 exp = create_expression(cast<CmpInst>(I));
587 break;
588 case Instruction::Trunc:
589 case Instruction::ZExt:
590 case Instruction::SExt:
591 case Instruction::FPToUI:
592 case Instruction::FPToSI:
593 case Instruction::UIToFP:
594 case Instruction::SIToFP:
595 case Instruction::FPTrunc:
596 case Instruction::FPExt:
597 case Instruction::PtrToInt:
598 case Instruction::IntToPtr:
599 case Instruction::BitCast:
600 exp = create_expression(cast<CastInst>(I));
601 break;
602 case Instruction::Select:
603 exp = create_expression(cast<SelectInst>(I));
604 break;
605 case Instruction::ExtractElement:
606 exp = create_expression(cast<ExtractElementInst>(I));
607 break;
608 case Instruction::InsertElement:
609 exp = create_expression(cast<InsertElementInst>(I));
610 break;
611 case Instruction::ShuffleVector:
612 exp = create_expression(cast<ShuffleVectorInst>(I));
613 break;
614 case Instruction::ExtractValue:
615 exp = create_expression(cast<ExtractValueInst>(I));
616 break;
617 case Instruction::InsertValue:
618 exp = create_expression(cast<InsertValueInst>(I));
619 break;
620 case Instruction::GetElementPtr:
621 exp = create_expression(cast<GetElementPtrInst>(I));
622 break;
623 default:
624 valueNumbering[V] = nextValueNumber;
625 return nextValueNumber++;
626 }
627
628 uint32_t& e = expressionNumbering[exp];
629 if (!e) e = nextValueNumber++;
630 valueNumbering[V] = e;
631 return e;
Owen Anderson85c40642007-07-24 17:55:58 +0000632}
633
634/// lookup - Returns the value number of the specified value. Fails if
635/// the value has not yet been numbered.
Chris Lattnerff36c952009-09-21 02:42:51 +0000636uint32_t ValueTable::lookup(Value *V) const {
Jeffrey Yasskin8154d2e2009-11-10 01:02:17 +0000637 DenseMap<Value*, uint32_t>::const_iterator VI = valueNumbering.find(V);
Chris Lattner3d7103e2008-03-21 21:14:38 +0000638 assert(VI != valueNumbering.end() && "Value not numbered?");
639 return VI->second;
Owen Anderson85c40642007-07-24 17:55:58 +0000640}
641
642/// clear - Remove all entries from the ValueTable
643void ValueTable::clear() {
644 valueNumbering.clear();
645 expressionNumbering.clear();
646 nextValueNumber = 1;
647}
648
Owen Anderson5aff8002007-07-31 23:27:13 +0000649/// erase - Remove a value from the value numbering
Chris Lattnerff36c952009-09-21 02:42:51 +0000650void ValueTable::erase(Value *V) {
Owen Anderson5aff8002007-07-31 23:27:13 +0000651 valueNumbering.erase(V);
652}
653
Bill Wendling2a023742008-12-22 21:36:08 +0000654/// verifyRemoved - Verify that the value is removed from all internal data
655/// structures.
656void ValueTable::verifyRemoved(const Value *V) const {
Jeffrey Yasskin8154d2e2009-11-10 01:02:17 +0000657 for (DenseMap<Value*, uint32_t>::const_iterator
Bill Wendling2a023742008-12-22 21:36:08 +0000658 I = valueNumbering.begin(), E = valueNumbering.end(); I != E; ++I) {
659 assert(I->first != V && "Inst still occurs in value numbering map!");
660 }
661}
662
Owen Anderson85c40642007-07-24 17:55:58 +0000663//===----------------------------------------------------------------------===//
Bill Wendling42f17f62008-12-22 22:32:22 +0000664// GVN Pass
Owen Anderson85c40642007-07-24 17:55:58 +0000665//===----------------------------------------------------------------------===//
666
667namespace {
Chris Lattnerfa2d1ba2009-09-02 06:11:42 +0000668 struct ValueNumberScope {
Owen Anderson2a412722008-06-20 01:15:47 +0000669 ValueNumberScope* parent;
670 DenseMap<uint32_t, Value*> table;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000671
Owen Anderson2a412722008-06-20 01:15:47 +0000672 ValueNumberScope(ValueNumberScope* p) : parent(p) { }
673 };
674}
675
676namespace {
Owen Anderson85c40642007-07-24 17:55:58 +0000677
Chris Lattnerfa2d1ba2009-09-02 06:11:42 +0000678 class GVN : public FunctionPass {
Owen Anderson85c40642007-07-24 17:55:58 +0000679 bool runOnFunction(Function &F);
680 public:
681 static char ID; // Pass identification, replacement for typeid
Dan Gohmanc8d26652009-11-14 02:27:51 +0000682 explicit GVN(bool nopre = false, bool noloads = false)
683 : FunctionPass(&ID), NoPRE(nopre), NoLoads(noloads), MD(0) { }
Owen Anderson85c40642007-07-24 17:55:58 +0000684
685 private:
Evan Chengf036e552009-10-30 20:12:24 +0000686 bool NoPRE;
Dan Gohmanc8d26652009-11-14 02:27:51 +0000687 bool NoLoads;
Chris Lattner02ca4422008-12-01 00:40:32 +0000688 MemoryDependenceAnalysis *MD;
689 DominatorTree *DT;
690
Owen Anderson85c40642007-07-24 17:55:58 +0000691 ValueTable VN;
Owen Anderson2a412722008-06-20 01:15:47 +0000692 DenseMap<BasicBlock*, ValueNumberScope*> localAvail;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000693
Owen Anderson85c40642007-07-24 17:55:58 +0000694 // This transformation requires dominator postdominator info
695 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Owen Anderson85c40642007-07-24 17:55:58 +0000696 AU.addRequired<DominatorTree>();
Dan Gohmanc8d26652009-11-14 02:27:51 +0000697 if (!NoLoads)
698 AU.addRequired<MemoryDependenceAnalysis>();
Owen Anderson5e9366f2007-10-18 19:39:33 +0000699 AU.addRequired<AliasAnalysis>();
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000700
Owen Andersonaef6a922008-06-23 17:49:45 +0000701 AU.addPreserved<DominatorTree>();
Owen Anderson5e9366f2007-10-18 19:39:33 +0000702 AU.addPreserved<AliasAnalysis>();
Owen Anderson85c40642007-07-24 17:55:58 +0000703 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000704
Owen Anderson85c40642007-07-24 17:55:58 +0000705 // Helper fuctions
706 // FIXME: eliminate or document these better
Owen Anderson85c40642007-07-24 17:55:58 +0000707 bool processLoad(LoadInst* L,
Chris Lattner7de20452008-03-21 22:01:16 +0000708 SmallVectorImpl<Instruction*> &toErase);
Chris Lattnerff36c952009-09-21 02:42:51 +0000709 bool processInstruction(Instruction *I,
Chris Lattner7de20452008-03-21 22:01:16 +0000710 SmallVectorImpl<Instruction*> &toErase);
Owen Andersonbf8a3eb2007-08-02 18:16:06 +0000711 bool processNonLocalLoad(LoadInst* L,
Chris Lattner7de20452008-03-21 22:01:16 +0000712 SmallVectorImpl<Instruction*> &toErase);
Chris Lattnerff36c952009-09-21 02:42:51 +0000713 bool processBlock(BasicBlock *BB);
Owen Andersone6b4ff82008-06-18 21:41:49 +0000714 void dump(DenseMap<uint32_t, Value*>& d);
Owen Andersonbe168b32007-08-14 18:04:11 +0000715 bool iterateOnFunction(Function &F);
Chris Lattnerff36c952009-09-21 02:42:51 +0000716 Value *CollapsePhi(PHINode* p);
Owen Andersone6b4ff82008-06-18 21:41:49 +0000717 bool performPRE(Function& F);
Chris Lattnerff36c952009-09-21 02:42:51 +0000718 Value *lookupNumber(BasicBlock *BB, uint32_t num);
Nuno Lopes274474b2008-10-10 16:25:50 +0000719 void cleanupGlobalSets();
Bill Wendling2a023742008-12-22 21:36:08 +0000720 void verifyRemoved(const Instruction *I) const;
Owen Anderson85c40642007-07-24 17:55:58 +0000721 };
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000722
Owen Anderson85c40642007-07-24 17:55:58 +0000723 char GVN::ID = 0;
Owen Anderson85c40642007-07-24 17:55:58 +0000724}
725
726// createGVNPass - The public interface to this file...
Dan Gohmanc8d26652009-11-14 02:27:51 +0000727FunctionPass *llvm::createGVNPass(bool NoPRE, bool NoLoads) {
728 return new GVN(NoPRE, NoLoads);
729}
Owen Anderson85c40642007-07-24 17:55:58 +0000730
731static RegisterPass<GVN> X("gvn",
732 "Global Value Numbering");
733
Owen Andersone6b4ff82008-06-18 21:41:49 +0000734void GVN::dump(DenseMap<uint32_t, Value*>& d) {
Dan Gohman288145c2009-12-18 03:25:51 +0000735 errs() << "{\n";
Owen Andersone6b4ff82008-06-18 21:41:49 +0000736 for (DenseMap<uint32_t, Value*>::iterator I = d.begin(),
Owen Anderson5d72a422007-07-25 19:57:03 +0000737 E = d.end(); I != E; ++I) {
Dan Gohman288145c2009-12-18 03:25:51 +0000738 errs() << I->first << "\n";
Owen Anderson5d72a422007-07-25 19:57:03 +0000739 I->second->dump();
740 }
Dan Gohman288145c2009-12-18 03:25:51 +0000741 errs() << "}\n";
Owen Anderson5d72a422007-07-25 19:57:03 +0000742}
743
Chris Lattnerff36c952009-09-21 02:42:51 +0000744static bool isSafeReplacement(PHINode* p, Instruction *inst) {
Owen Andersond68b1af2009-08-26 22:55:11 +0000745 if (!isa<PHINode>(inst))
746 return true;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000747
Owen Andersond68b1af2009-08-26 22:55:11 +0000748 for (Instruction::use_iterator UI = p->use_begin(), E = p->use_end();
749 UI != E; ++UI)
750 if (PHINode* use_phi = dyn_cast<PHINode>(UI))
751 if (use_phi->getParent() == inst->getParent())
752 return false;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000753
Owen Andersond68b1af2009-08-26 22:55:11 +0000754 return true;
755}
756
Chris Lattnerff36c952009-09-21 02:42:51 +0000757Value *GVN::CollapsePhi(PHINode *PN) {
758 Value *ConstVal = PN->hasConstantValue(DT);
759 if (!ConstVal) return 0;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000760
Chris Lattnerff36c952009-09-21 02:42:51 +0000761 Instruction *Inst = dyn_cast<Instruction>(ConstVal);
762 if (!Inst)
763 return ConstVal;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000764
Chris Lattnerff36c952009-09-21 02:42:51 +0000765 if (DT->dominates(Inst, PN))
766 if (isSafeReplacement(PN, Inst))
767 return Inst;
Owen Andersone02ad522007-08-16 22:51:56 +0000768 return 0;
769}
Owen Anderson5d72a422007-07-25 19:57:03 +0000770
Chris Lattnerdcded152008-12-02 08:16:11 +0000771/// IsValueFullyAvailableInBlock - Return true if we can prove that the value
772/// we're analyzing is fully available in the specified block. As we go, keep
Chris Lattner159b98f2008-12-05 07:49:08 +0000773/// track of which blocks we know are fully alive in FullyAvailableBlocks. This
774/// map is actually a tri-state map with the following values:
775/// 0) we know the block *is not* fully available.
776/// 1) we know the block *is* fully available.
777/// 2) we do not know whether the block is fully available or not, but we are
778/// currently speculating that it will be.
779/// 3) we are speculating for this block and have used that to speculate for
780/// other blocks.
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000781static bool IsValueFullyAvailableInBlock(BasicBlock *BB,
Chris Lattner159b98f2008-12-05 07:49:08 +0000782 DenseMap<BasicBlock*, char> &FullyAvailableBlocks) {
Chris Lattnerdcded152008-12-02 08:16:11 +0000783 // Optimistically assume that the block is fully available and check to see
784 // if we already know about this block in one lookup.
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000785 std::pair<DenseMap<BasicBlock*, char>::iterator, char> IV =
Chris Lattner159b98f2008-12-05 07:49:08 +0000786 FullyAvailableBlocks.insert(std::make_pair(BB, 2));
Chris Lattnerdcded152008-12-02 08:16:11 +0000787
788 // If the entry already existed for this block, return the precomputed value.
Chris Lattner159b98f2008-12-05 07:49:08 +0000789 if (!IV.second) {
790 // If this is a speculative "available" value, mark it as being used for
791 // speculation of other blocks.
792 if (IV.first->second == 2)
793 IV.first->second = 3;
794 return IV.first->second != 0;
795 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000796
Chris Lattnerdcded152008-12-02 08:16:11 +0000797 // Otherwise, see if it is fully available in all predecessors.
798 pred_iterator PI = pred_begin(BB), PE = pred_end(BB);
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000799
Chris Lattnerdcded152008-12-02 08:16:11 +0000800 // If this block has no predecessors, it isn't live-in here.
801 if (PI == PE)
Chris Lattner159b98f2008-12-05 07:49:08 +0000802 goto SpeculationFailure;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000803
Chris Lattnerdcded152008-12-02 08:16:11 +0000804 for (; PI != PE; ++PI)
805 // If the value isn't fully available in one of our predecessors, then it
806 // isn't fully available in this block either. Undo our previous
807 // optimistic assumption and bail out.
808 if (!IsValueFullyAvailableInBlock(*PI, FullyAvailableBlocks))
Chris Lattner159b98f2008-12-05 07:49:08 +0000809 goto SpeculationFailure;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000810
Chris Lattnerdcded152008-12-02 08:16:11 +0000811 return true;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000812
Chris Lattner159b98f2008-12-05 07:49:08 +0000813// SpeculationFailure - If we get here, we found out that this is not, after
814// all, a fully-available block. We have a problem if we speculated on this and
815// used the speculation to mark other blocks as available.
816SpeculationFailure:
817 char &BBVal = FullyAvailableBlocks[BB];
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000818
Chris Lattner159b98f2008-12-05 07:49:08 +0000819 // If we didn't speculate on this, just return with it set to false.
820 if (BBVal == 2) {
821 BBVal = 0;
822 return false;
823 }
824
825 // If we did speculate on this value, we could have blocks set to 1 that are
826 // incorrect. Walk the (transitive) successors of this block and mark them as
827 // 0 if set to one.
828 SmallVector<BasicBlock*, 32> BBWorklist;
829 BBWorklist.push_back(BB);
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000830
Chris Lattner159b98f2008-12-05 07:49:08 +0000831 while (!BBWorklist.empty()) {
832 BasicBlock *Entry = BBWorklist.pop_back_val();
833 // Note that this sets blocks to 0 (unavailable) if they happen to not
834 // already be in FullyAvailableBlocks. This is safe.
835 char &EntryVal = FullyAvailableBlocks[Entry];
836 if (EntryVal == 0) continue; // Already unavailable.
837
838 // Mark as unavailable.
839 EntryVal = 0;
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000840
Chris Lattner159b98f2008-12-05 07:49:08 +0000841 for (succ_iterator I = succ_begin(Entry), E = succ_end(Entry); I != E; ++I)
842 BBWorklist.push_back(*I);
843 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +0000844
Chris Lattner159b98f2008-12-05 07:49:08 +0000845 return false;
Chris Lattnerdcded152008-12-02 08:16:11 +0000846}
847
Chris Lattnerd6b1d052009-09-20 20:09:34 +0000848
Chris Lattner012b3602009-09-21 17:24:04 +0000849/// CanCoerceMustAliasedValueToLoad - Return true if
850/// CoerceAvailableValueToLoadType will succeed.
851static bool CanCoerceMustAliasedValueToLoad(Value *StoredVal,
852 const Type *LoadTy,
853 const TargetData &TD) {
854 // If the loaded or stored value is an first class array or struct, don't try
855 // to transform them. We need to be able to bitcast to integer.
856 if (isa<StructType>(LoadTy) || isa<ArrayType>(LoadTy) ||
857 isa<StructType>(StoredVal->getType()) ||
858 isa<ArrayType>(StoredVal->getType()))
859 return false;
860
861 // The store has to be at least as big as the load.
862 if (TD.getTypeSizeInBits(StoredVal->getType()) <
863 TD.getTypeSizeInBits(LoadTy))
864 return false;
865
866 return true;
867}
868
869
Chris Lattnerd6b1d052009-09-20 20:09:34 +0000870/// CoerceAvailableValueToLoadType - If we saw a store of a value to memory, and
871/// then a load from a must-aliased pointer of a different type, try to coerce
872/// the stored value. LoadedTy is the type of the load we want to replace and
873/// InsertPt is the place to insert new instructions.
874///
875/// If we can't do it, return null.
876static Value *CoerceAvailableValueToLoadType(Value *StoredVal,
877 const Type *LoadedTy,
878 Instruction *InsertPt,
879 const TargetData &TD) {
Chris Lattner012b3602009-09-21 17:24:04 +0000880 if (!CanCoerceMustAliasedValueToLoad(StoredVal, LoadedTy, TD))
881 return 0;
882
Chris Lattnerd6b1d052009-09-20 20:09:34 +0000883 const Type *StoredValTy = StoredVal->getType();
884
885 uint64_t StoreSize = TD.getTypeSizeInBits(StoredValTy);
886 uint64_t LoadSize = TD.getTypeSizeInBits(LoadedTy);
887
888 // If the store and reload are the same size, we can always reuse it.
889 if (StoreSize == LoadSize) {
890 if (isa<PointerType>(StoredValTy) && isa<PointerType>(LoadedTy)) {
891 // Pointer to Pointer -> use bitcast.
892 return new BitCastInst(StoredVal, LoadedTy, "", InsertPt);
893 }
894
895 // Convert source pointers to integers, which can be bitcast.
896 if (isa<PointerType>(StoredValTy)) {
897 StoredValTy = TD.getIntPtrType(StoredValTy->getContext());
898 StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
899 }
900
901 const Type *TypeToCastTo = LoadedTy;
902 if (isa<PointerType>(TypeToCastTo))
903 TypeToCastTo = TD.getIntPtrType(StoredValTy->getContext());
904
905 if (StoredValTy != TypeToCastTo)
906 StoredVal = new BitCastInst(StoredVal, TypeToCastTo, "", InsertPt);
907
908 // Cast to pointer if the load needs a pointer type.
909 if (isa<PointerType>(LoadedTy))
910 StoredVal = new IntToPtrInst(StoredVal, LoadedTy, "", InsertPt);
911
912 return StoredVal;
913 }
914
915 // If the loaded value is smaller than the available value, then we can
916 // extract out a piece from it. If the available value is too small, then we
917 // can't do anything.
Chris Lattner012b3602009-09-21 17:24:04 +0000918 assert(StoreSize >= LoadSize && "CanCoerceMustAliasedValueToLoad fail");
Chris Lattnerd6b1d052009-09-20 20:09:34 +0000919
920 // Convert source pointers to integers, which can be manipulated.
921 if (isa<PointerType>(StoredValTy)) {
922 StoredValTy = TD.getIntPtrType(StoredValTy->getContext());
923 StoredVal = new PtrToIntInst(StoredVal, StoredValTy, "", InsertPt);
924 }
925
926 // Convert vectors and fp to integer, which can be manipulated.
927 if (!isa<IntegerType>(StoredValTy)) {
928 StoredValTy = IntegerType::get(StoredValTy->getContext(), StoreSize);
929 StoredVal = new BitCastInst(StoredVal, StoredValTy, "", InsertPt);
930 }
931
932 // If this is a big-endian system, we need to shift the value down to the low
933 // bits so that a truncate will work.
934 if (TD.isBigEndian()) {
935 Constant *Val = ConstantInt::get(StoredVal->getType(), StoreSize-LoadSize);
936 StoredVal = BinaryOperator::CreateLShr(StoredVal, Val, "tmp", InsertPt);
937 }
938
939 // Truncate the integer to the right size now.
940 const Type *NewIntTy = IntegerType::get(StoredValTy->getContext(), LoadSize);
941 StoredVal = new TruncInst(StoredVal, NewIntTy, "trunc", InsertPt);
942
943 if (LoadedTy == NewIntTy)
944 return StoredVal;
945
946 // If the result is a pointer, inttoptr.
947 if (isa<PointerType>(LoadedTy))
948 return new IntToPtrInst(StoredVal, LoadedTy, "inttoptr", InsertPt);
949
950 // Otherwise, bitcast.
951 return new BitCastInst(StoredVal, LoadedTy, "bitcast", InsertPt);
952}
953
Chris Lattner8f912082009-09-21 06:24:16 +0000954/// GetBaseWithConstantOffset - Analyze the specified pointer to see if it can
955/// be expressed as a base pointer plus a constant offset. Return the base and
956/// offset to the caller.
957static Value *GetBaseWithConstantOffset(Value *Ptr, int64_t &Offset,
Chris Lattneraae7fcb2009-09-21 06:48:08 +0000958 const TargetData &TD) {
Chris Lattner8f912082009-09-21 06:24:16 +0000959 Operator *PtrOp = dyn_cast<Operator>(Ptr);
960 if (PtrOp == 0) return Ptr;
961
962 // Just look through bitcasts.
963 if (PtrOp->getOpcode() == Instruction::BitCast)
964 return GetBaseWithConstantOffset(PtrOp->getOperand(0), Offset, TD);
965
966 // If this is a GEP with constant indices, we can look through it.
967 GEPOperator *GEP = dyn_cast<GEPOperator>(PtrOp);
968 if (GEP == 0 || !GEP->hasAllConstantIndices()) return Ptr;
969
970 gep_type_iterator GTI = gep_type_begin(GEP);
971 for (User::op_iterator I = GEP->idx_begin(), E = GEP->idx_end(); I != E;
972 ++I, ++GTI) {
973 ConstantInt *OpC = cast<ConstantInt>(*I);
974 if (OpC->isZero()) continue;
975
976 // Handle a struct and array indices which add their offset to the pointer.
977 if (const StructType *STy = dyn_cast<StructType>(*GTI)) {
Chris Lattneraae7fcb2009-09-21 06:48:08 +0000978 Offset += TD.getStructLayout(STy)->getElementOffset(OpC->getZExtValue());
Chris Lattner8f912082009-09-21 06:24:16 +0000979 } else {
Chris Lattneraae7fcb2009-09-21 06:48:08 +0000980 uint64_t Size = TD.getTypeAllocSize(GTI.getIndexedType());
Chris Lattner8f912082009-09-21 06:24:16 +0000981 Offset += OpC->getSExtValue()*Size;
982 }
983 }
984
985 // Re-sign extend from the pointer size if needed to get overflow edge cases
986 // right.
Chris Lattneraae7fcb2009-09-21 06:48:08 +0000987 unsigned PtrSize = TD.getPointerSizeInBits();
Chris Lattner8f912082009-09-21 06:24:16 +0000988 if (PtrSize < 64)
989 Offset = (Offset << (64-PtrSize)) >> (64-PtrSize);
990
991 return GetBaseWithConstantOffset(GEP->getPointerOperand(), Offset, TD);
992}
993
994
Chris Lattnercb00f732009-12-06 01:57:02 +0000995/// AnalyzeLoadFromClobberingWrite - This function is called when we have a
996/// memdep query of a load that ends up being a clobbering memory write (store,
997/// memset, memcpy, memmove). This means that the write *may* provide bits used
998/// by the load but we can't be sure because the pointers don't mustalias.
999///
1000/// Check this case to see if there is anything more we can do before we give
1001/// up. This returns -1 if we have to give up, or a byte number in the stored
1002/// value of the piece that feeds the load.
Chris Lattner598abfd2009-12-09 07:34:10 +00001003static int AnalyzeLoadFromClobberingWrite(const Type *LoadTy, Value *LoadPtr,
1004 Value *WritePtr,
Chris Lattnercb00f732009-12-06 01:57:02 +00001005 uint64_t WriteSizeInBits,
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001006 const TargetData &TD) {
Chris Lattner012b3602009-09-21 17:24:04 +00001007 // If the loaded or stored value is an first class array or struct, don't try
1008 // to transform them. We need to be able to bitcast to integer.
Chris Lattner598abfd2009-12-09 07:34:10 +00001009 if (isa<StructType>(LoadTy) || isa<ArrayType>(LoadTy))
Chris Lattner012b3602009-09-21 17:24:04 +00001010 return -1;
1011
Chris Lattner8f912082009-09-21 06:24:16 +00001012 int64_t StoreOffset = 0, LoadOffset = 0;
Chris Lattnercb00f732009-12-06 01:57:02 +00001013 Value *StoreBase = GetBaseWithConstantOffset(WritePtr, StoreOffset, TD);
Chris Lattner8f912082009-09-21 06:24:16 +00001014 Value *LoadBase =
Chris Lattner598abfd2009-12-09 07:34:10 +00001015 GetBaseWithConstantOffset(LoadPtr, LoadOffset, TD);
Chris Lattner8f912082009-09-21 06:24:16 +00001016 if (StoreBase != LoadBase)
1017 return -1;
1018
1019 // If the load and store are to the exact same address, they should have been
1020 // a must alias. AA must have gotten confused.
1021 // FIXME: Study to see if/when this happens.
1022 if (LoadOffset == StoreOffset) {
1023#if 0
1024 errs() << "STORE/LOAD DEP WITH COMMON POINTER MISSED:\n"
1025 << "Base = " << *StoreBase << "\n"
Chris Lattnercb00f732009-12-06 01:57:02 +00001026 << "Store Ptr = " << *WritePtr << "\n"
1027 << "Store Offs = " << StoreOffset << "\n"
Chris Lattnere559e792009-12-10 00:04:46 +00001028 << "Load Ptr = " << *LoadPtr << "\n";
Chris Lattner4c619092009-12-09 02:41:54 +00001029 abort();
Chris Lattner8f912082009-09-21 06:24:16 +00001030#endif
1031 return -1;
1032 }
1033
1034 // If the load and store don't overlap at all, the store doesn't provide
1035 // anything to the load. In this case, they really don't alias at all, AA
1036 // must have gotten confused.
1037 // FIXME: Investigate cases where this bails out, e.g. rdar://7238614. Then
1038 // remove this check, as it is duplicated with what we have below.
Chris Lattner598abfd2009-12-09 07:34:10 +00001039 uint64_t LoadSize = TD.getTypeSizeInBits(LoadTy);
Chris Lattner8f912082009-09-21 06:24:16 +00001040
Chris Lattnercb00f732009-12-06 01:57:02 +00001041 if ((WriteSizeInBits & 7) | (LoadSize & 7))
Chris Lattner8f912082009-09-21 06:24:16 +00001042 return -1;
Chris Lattnercb00f732009-12-06 01:57:02 +00001043 uint64_t StoreSize = WriteSizeInBits >> 3; // Convert to bytes.
Chris Lattner8f912082009-09-21 06:24:16 +00001044 LoadSize >>= 3;
1045
1046
1047 bool isAAFailure = false;
1048 if (StoreOffset < LoadOffset) {
1049 isAAFailure = StoreOffset+int64_t(StoreSize) <= LoadOffset;
1050 } else {
1051 isAAFailure = LoadOffset+int64_t(LoadSize) <= StoreOffset;
1052 }
1053 if (isAAFailure) {
1054#if 0
1055 errs() << "STORE LOAD DEP WITH COMMON BASE:\n"
1056 << "Base = " << *StoreBase << "\n"
Chris Lattnercb00f732009-12-06 01:57:02 +00001057 << "Store Ptr = " << *WritePtr << "\n"
1058 << "Store Offs = " << StoreOffset << "\n"
Chris Lattnere559e792009-12-10 00:04:46 +00001059 << "Load Ptr = " << *LoadPtr << "\n";
Chris Lattner4c619092009-12-09 02:41:54 +00001060 abort();
Chris Lattner8f912082009-09-21 06:24:16 +00001061#endif
1062 return -1;
1063 }
1064
1065 // If the Load isn't completely contained within the stored bits, we don't
1066 // have all the bits to feed it. We could do something crazy in the future
1067 // (issue a smaller load then merge the bits in) but this seems unlikely to be
1068 // valuable.
1069 if (StoreOffset > LoadOffset ||
1070 StoreOffset+StoreSize < LoadOffset+LoadSize)
1071 return -1;
1072
1073 // Okay, we can do this transformation. Return the number of bytes into the
1074 // store that the load is.
1075 return LoadOffset-StoreOffset;
1076}
1077
Chris Lattnercb00f732009-12-06 01:57:02 +00001078/// AnalyzeLoadFromClobberingStore - This function is called when we have a
1079/// memdep query of a load that ends up being a clobbering store.
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001080static int AnalyzeLoadFromClobberingStore(const Type *LoadTy, Value *LoadPtr,
1081 StoreInst *DepSI,
Chris Lattnercb00f732009-12-06 01:57:02 +00001082 const TargetData &TD) {
1083 // Cannot handle reading from store of first-class aggregate yet.
1084 if (isa<StructType>(DepSI->getOperand(0)->getType()) ||
1085 isa<ArrayType>(DepSI->getOperand(0)->getType()))
1086 return -1;
1087
1088 Value *StorePtr = DepSI->getPointerOperand();
Chris Lattnerc97c9a02009-12-10 00:11:45 +00001089 uint64_t StoreSize = TD.getTypeSizeInBits(DepSI->getOperand(0)->getType());
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001090 return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr,
Chris Lattner598abfd2009-12-09 07:34:10 +00001091 StorePtr, StoreSize, TD);
Chris Lattnercb00f732009-12-06 01:57:02 +00001092}
1093
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001094static int AnalyzeLoadFromClobberingMemInst(const Type *LoadTy, Value *LoadPtr,
1095 MemIntrinsic *MI,
Chris Lattnercb00f732009-12-06 01:57:02 +00001096 const TargetData &TD) {
1097 // If the mem operation is a non-constant size, we can't handle it.
1098 ConstantInt *SizeCst = dyn_cast<ConstantInt>(MI->getLength());
1099 if (SizeCst == 0) return -1;
1100 uint64_t MemSizeInBits = SizeCst->getZExtValue()*8;
Chris Lattner4bb632f2009-12-06 05:29:56 +00001101
1102 // If this is memset, we just need to see if the offset is valid in the size
1103 // of the memset..
Chris Lattnercb00f732009-12-06 01:57:02 +00001104 if (MI->getIntrinsicID() == Intrinsic::memset)
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001105 return AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr, MI->getDest(),
1106 MemSizeInBits, TD);
Chris Lattnercb00f732009-12-06 01:57:02 +00001107
Chris Lattner4bb632f2009-12-06 05:29:56 +00001108 // If we have a memcpy/memmove, the only case we can handle is if this is a
1109 // copy from constant memory. In that case, we can read directly from the
1110 // constant memory.
1111 MemTransferInst *MTI = cast<MemTransferInst>(MI);
1112
1113 Constant *Src = dyn_cast<Constant>(MTI->getSource());
1114 if (Src == 0) return -1;
1115
1116 GlobalVariable *GV = dyn_cast<GlobalVariable>(Src->getUnderlyingObject());
1117 if (GV == 0 || !GV->isConstant()) return -1;
1118
1119 // See if the access is within the bounds of the transfer.
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001120 int Offset = AnalyzeLoadFromClobberingWrite(LoadTy, LoadPtr,
1121 MI->getDest(), MemSizeInBits, TD);
Chris Lattner4bb632f2009-12-06 05:29:56 +00001122 if (Offset == -1)
1123 return Offset;
1124
1125 // Otherwise, see if we can constant fold a load from the constant with the
1126 // offset applied as appropriate.
1127 Src = ConstantExpr::getBitCast(Src,
1128 llvm::Type::getInt8PtrTy(Src->getContext()));
1129 Constant *OffsetCst =
1130 ConstantInt::get(Type::getInt64Ty(Src->getContext()), (unsigned)Offset);
1131 Src = ConstantExpr::getGetElementPtr(Src, &OffsetCst, 1);
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001132 Src = ConstantExpr::getBitCast(Src, PointerType::getUnqual(LoadTy));
Chris Lattner4bb632f2009-12-06 05:29:56 +00001133 if (ConstantFoldLoadFromConstPtr(Src, &TD))
1134 return Offset;
Chris Lattnercb00f732009-12-06 01:57:02 +00001135 return -1;
1136}
1137
Chris Lattner8f912082009-09-21 06:24:16 +00001138
1139/// GetStoreValueForLoad - This function is called when we have a
1140/// memdep query of a load that ends up being a clobbering store. This means
1141/// that the store *may* provide bits used by the load but we can't be sure
1142/// because the pointers don't mustalias. Check this case to see if there is
1143/// anything more we can do before we give up.
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001144static Value *GetStoreValueForLoad(Value *SrcVal, unsigned Offset,
1145 const Type *LoadTy,
1146 Instruction *InsertPt, const TargetData &TD){
Chris Lattner8f912082009-09-21 06:24:16 +00001147 LLVMContext &Ctx = SrcVal->getType()->getContext();
1148
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001149 uint64_t StoreSize = TD.getTypeSizeInBits(SrcVal->getType())/8;
1150 uint64_t LoadSize = TD.getTypeSizeInBits(LoadTy)/8;
Chris Lattner8f912082009-09-21 06:24:16 +00001151
Chris Lattner2737cb42009-12-09 18:13:28 +00001152 IRBuilder<> Builder(InsertPt->getParent(), InsertPt);
Chris Lattner8f912082009-09-21 06:24:16 +00001153
1154 // Compute which bits of the stored value are being used by the load. Convert
1155 // to an integer type to start with.
1156 if (isa<PointerType>(SrcVal->getType()))
Chris Lattner2737cb42009-12-09 18:13:28 +00001157 SrcVal = Builder.CreatePtrToInt(SrcVal, TD.getIntPtrType(Ctx), "tmp");
Chris Lattner8f912082009-09-21 06:24:16 +00001158 if (!isa<IntegerType>(SrcVal->getType()))
Chris Lattner2737cb42009-12-09 18:13:28 +00001159 SrcVal = Builder.CreateBitCast(SrcVal, IntegerType::get(Ctx, StoreSize*8),
1160 "tmp");
Chris Lattner8f912082009-09-21 06:24:16 +00001161
1162 // Shift the bits to the least significant depending on endianness.
1163 unsigned ShiftAmt;
Chris Lattnercb00f732009-12-06 01:57:02 +00001164 if (TD.isLittleEndian())
Chris Lattner8f912082009-09-21 06:24:16 +00001165 ShiftAmt = Offset*8;
Chris Lattnercb00f732009-12-06 01:57:02 +00001166 else
Chris Lattner1846fa02009-09-21 17:55:47 +00001167 ShiftAmt = (StoreSize-LoadSize-Offset)*8;
Chris Lattner8f912082009-09-21 06:24:16 +00001168
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001169 if (ShiftAmt)
Chris Lattner2737cb42009-12-09 18:13:28 +00001170 SrcVal = Builder.CreateLShr(SrcVal, ShiftAmt, "tmp");
Chris Lattner8f912082009-09-21 06:24:16 +00001171
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001172 if (LoadSize != StoreSize)
Chris Lattner2737cb42009-12-09 18:13:28 +00001173 SrcVal = Builder.CreateTrunc(SrcVal, IntegerType::get(Ctx, LoadSize*8),
1174 "tmp");
Chris Lattner8f912082009-09-21 06:24:16 +00001175
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001176 return CoerceAvailableValueToLoadType(SrcVal, LoadTy, InsertPt, TD);
Chris Lattner8f912082009-09-21 06:24:16 +00001177}
1178
Chris Lattnercb00f732009-12-06 01:57:02 +00001179/// GetMemInstValueForLoad - This function is called when we have a
1180/// memdep query of a load that ends up being a clobbering mem intrinsic.
1181static Value *GetMemInstValueForLoad(MemIntrinsic *SrcInst, unsigned Offset,
1182 const Type *LoadTy, Instruction *InsertPt,
1183 const TargetData &TD){
1184 LLVMContext &Ctx = LoadTy->getContext();
1185 uint64_t LoadSize = TD.getTypeSizeInBits(LoadTy)/8;
1186
1187 IRBuilder<> Builder(InsertPt->getParent(), InsertPt);
1188
1189 // We know that this method is only called when the mem transfer fully
1190 // provides the bits for the load.
1191 if (MemSetInst *MSI = dyn_cast<MemSetInst>(SrcInst)) {
1192 // memset(P, 'x', 1234) -> splat('x'), even if x is a variable, and
1193 // independently of what the offset is.
1194 Value *Val = MSI->getValue();
1195 if (LoadSize != 1)
1196 Val = Builder.CreateZExt(Val, IntegerType::get(Ctx, LoadSize*8));
1197
1198 Value *OneElt = Val;
1199
1200 // Splat the value out to the right number of bits.
1201 for (unsigned NumBytesSet = 1; NumBytesSet != LoadSize; ) {
1202 // If we can double the number of bytes set, do it.
1203 if (NumBytesSet*2 <= LoadSize) {
1204 Value *ShVal = Builder.CreateShl(Val, NumBytesSet*8);
1205 Val = Builder.CreateOr(Val, ShVal);
1206 NumBytesSet <<= 1;
1207 continue;
1208 }
1209
1210 // Otherwise insert one byte at a time.
1211 Value *ShVal = Builder.CreateShl(Val, 1*8);
1212 Val = Builder.CreateOr(OneElt, ShVal);
1213 ++NumBytesSet;
1214 }
1215
1216 return CoerceAvailableValueToLoadType(Val, LoadTy, InsertPt, TD);
1217 }
Chris Lattner4bb632f2009-12-06 05:29:56 +00001218
1219 // Otherwise, this is a memcpy/memmove from a constant global.
1220 MemTransferInst *MTI = cast<MemTransferInst>(SrcInst);
1221 Constant *Src = cast<Constant>(MTI->getSource());
1222
1223 // Otherwise, see if we can constant fold a load from the constant with the
1224 // offset applied as appropriate.
1225 Src = ConstantExpr::getBitCast(Src,
1226 llvm::Type::getInt8PtrTy(Src->getContext()));
1227 Constant *OffsetCst =
1228 ConstantInt::get(Type::getInt64Ty(Src->getContext()), (unsigned)Offset);
1229 Src = ConstantExpr::getGetElementPtr(Src, &OffsetCst, 1);
1230 Src = ConstantExpr::getBitCast(Src, PointerType::getUnqual(LoadTy));
1231 return ConstantFoldLoadFromConstPtr(Src, &TD);
Chris Lattnercb00f732009-12-06 01:57:02 +00001232}
1233
1234
1235
Chris Lattner19b84b32009-09-21 06:30:24 +00001236struct AvailableValueInBlock {
1237 /// BB - The basic block in question.
1238 BasicBlock *BB;
Chris Lattnera96e53a2009-12-06 04:54:31 +00001239 enum ValType {
1240 SimpleVal, // A simple offsetted value that is accessed.
1241 MemIntrin // A memory intrinsic which is loaded from.
1242 };
1243
Chris Lattner19b84b32009-09-21 06:30:24 +00001244 /// V - The value that is live out of the block.
Chris Lattnera96e53a2009-12-06 04:54:31 +00001245 PointerIntPair<Value *, 1, ValType> Val;
1246
1247 /// Offset - The byte offset in Val that is interesting for the load query.
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001248 unsigned Offset;
Chris Lattner19b84b32009-09-21 06:30:24 +00001249
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001250 static AvailableValueInBlock get(BasicBlock *BB, Value *V,
1251 unsigned Offset = 0) {
Chris Lattner19b84b32009-09-21 06:30:24 +00001252 AvailableValueInBlock Res;
1253 Res.BB = BB;
Chris Lattnera96e53a2009-12-06 04:54:31 +00001254 Res.Val.setPointer(V);
1255 Res.Val.setInt(SimpleVal);
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001256 Res.Offset = Offset;
Chris Lattner19b84b32009-09-21 06:30:24 +00001257 return Res;
1258 }
Chris Lattnera96e53a2009-12-06 04:54:31 +00001259
1260 static AvailableValueInBlock getMI(BasicBlock *BB, MemIntrinsic *MI,
1261 unsigned Offset = 0) {
1262 AvailableValueInBlock Res;
1263 Res.BB = BB;
1264 Res.Val.setPointer(MI);
1265 Res.Val.setInt(MemIntrin);
1266 Res.Offset = Offset;
1267 return Res;
1268 }
1269
1270 bool isSimpleValue() const { return Val.getInt() == SimpleVal; }
1271 Value *getSimpleValue() const {
1272 assert(isSimpleValue() && "Wrong accessor");
1273 return Val.getPointer();
1274 }
1275
1276 MemIntrinsic *getMemIntrinValue() const {
1277 assert(!isSimpleValue() && "Wrong accessor");
1278 return cast<MemIntrinsic>(Val.getPointer());
1279 }
Chris Lattner0a555da2009-12-21 23:04:33 +00001280
1281 /// MaterializeAdjustedValue - Emit code into this block to adjust the value
1282 /// defined here to the specified type. This handles various coercion cases.
1283 Value *MaterializeAdjustedValue(const Type *LoadTy,
1284 const TargetData *TD) const {
1285 Value *Res;
1286 if (isSimpleValue()) {
1287 Res = getSimpleValue();
1288 if (Res->getType() != LoadTy) {
1289 assert(TD && "Need target data to handle type mismatch case");
1290 Res = GetStoreValueForLoad(Res, Offset, LoadTy, BB->getTerminator(),
1291 *TD);
1292
1293 DEBUG(errs() << "GVN COERCED NONLOCAL VAL:\nOffset: " << Offset << " "
1294 << *getSimpleValue() << '\n'
1295 << *Res << '\n' << "\n\n\n");
1296 }
1297 } else {
1298 Res = GetMemInstValueForLoad(getMemIntrinValue(), Offset,
1299 LoadTy, BB->getTerminator(), *TD);
1300 DEBUG(errs() << "GVN COERCED NONLOCAL MEM INTRIN:\nOffset: " << Offset
1301 << " " << *getMemIntrinValue() << '\n'
1302 << *Res << '\n' << "\n\n\n");
1303 }
1304 return Res;
1305 }
Chris Lattner19b84b32009-09-21 06:30:24 +00001306};
1307
Chris Lattner6e5ea272009-10-10 23:50:30 +00001308/// ConstructSSAForLoadSet - Given a set of loads specified by ValuesPerBlock,
1309/// construct SSA form, allowing us to eliminate LI. This returns the value
1310/// that should be used at LI's definition site.
1311static Value *ConstructSSAForLoadSet(LoadInst *LI,
1312 SmallVectorImpl<AvailableValueInBlock> &ValuesPerBlock,
1313 const TargetData *TD,
Chris Lattner1c8dc432009-12-21 23:15:48 +00001314 const DominatorTree &DT,
Chris Lattner6e5ea272009-10-10 23:50:30 +00001315 AliasAnalysis *AA) {
Chris Lattner1c8dc432009-12-21 23:15:48 +00001316 // Check for the fully redundant, dominating load case. In this case, we can
1317 // just use the dominating value directly.
1318 if (ValuesPerBlock.size() == 1 &&
1319 DT.properlyDominates(ValuesPerBlock[0].BB, LI->getParent()))
1320 return ValuesPerBlock[0].MaterializeAdjustedValue(LI->getType(), TD);
1321
1322 // Otherwise, we have to construct SSA form.
Chris Lattner6e5ea272009-10-10 23:50:30 +00001323 SmallVector<PHINode*, 8> NewPHIs;
1324 SSAUpdater SSAUpdate(&NewPHIs);
1325 SSAUpdate.Initialize(LI);
1326
1327 const Type *LoadTy = LI->getType();
1328
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001329 for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i) {
Chris Lattnera96e53a2009-12-06 04:54:31 +00001330 const AvailableValueInBlock &AV = ValuesPerBlock[i];
1331 BasicBlock *BB = AV.BB;
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001332
Chris Lattner6e5ea272009-10-10 23:50:30 +00001333 if (SSAUpdate.HasValueForBlock(BB))
1334 continue;
Chris Lattnera96e53a2009-12-06 04:54:31 +00001335
Chris Lattner0a555da2009-12-21 23:04:33 +00001336 SSAUpdate.AddAvailableValue(BB, AV.MaterializeAdjustedValue(LoadTy, TD));
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001337 }
Chris Lattner6e5ea272009-10-10 23:50:30 +00001338
1339 // Perform PHI construction.
1340 Value *V = SSAUpdate.GetValueInMiddleOfBlock(LI->getParent());
1341
1342 // If new PHI nodes were created, notify alias analysis.
1343 if (isa<PointerType>(V->getType()))
1344 for (unsigned i = 0, e = NewPHIs.size(); i != e; ++i)
1345 AA->copyValue(LI, NewPHIs[i]);
1346
1347 return V;
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001348}
1349
Owen Andersonf187daf2009-12-02 07:35:19 +00001350static bool isLifetimeStart(Instruction *Inst) {
Chris Lattnerbc6fccc2009-12-02 06:44:58 +00001351 if (IntrinsicInst* II = dyn_cast<IntrinsicInst>(Inst))
Owen Andersonf187daf2009-12-02 07:35:19 +00001352 return II->getIntrinsicID() == Intrinsic::lifetime_start;
Chris Lattnerbc6fccc2009-12-02 06:44:58 +00001353 return false;
1354}
1355
Owen Andersone0143452007-08-16 22:02:55 +00001356/// processNonLocalLoad - Attempt to eliminate a load whose dependencies are
1357/// non-local by performing PHI construction.
Chris Lattnerdcded152008-12-02 08:16:11 +00001358bool GVN::processNonLocalLoad(LoadInst *LI,
Chris Lattner7de20452008-03-21 22:01:16 +00001359 SmallVectorImpl<Instruction*> &toErase) {
Chris Lattnerdcded152008-12-02 08:16:11 +00001360 // Find the non-local dependencies of the load.
Chris Lattnerbf2b45e2009-12-22 04:25:02 +00001361 SmallVector<NonLocalDepResult, 64> Deps;
Chris Lattneraf713862008-12-09 19:25:07 +00001362 MD->getNonLocalPointerDependency(LI->getOperand(0), true, LI->getParent(),
1363 Deps);
Dan Gohman7e124382009-07-31 20:24:18 +00001364 //DEBUG(errs() << "INVESTIGATING NONLOCAL LOAD: "
1365 // << Deps.size() << *LI << '\n');
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001366
Owen Anderson90e717d2008-08-26 22:07:42 +00001367 // If we had to process more than one hundred blocks to find the
1368 // dependencies, this load isn't worth worrying about. Optimizing
1369 // it will be too expensive.
Chris Lattneraf713862008-12-09 19:25:07 +00001370 if (Deps.size() > 100)
Owen Anderson90e717d2008-08-26 22:07:42 +00001371 return false;
Chris Lattner8d1686f2008-12-18 00:51:32 +00001372
1373 // If we had a phi translation failure, we'll have a single entry which is a
1374 // clobber in the current block. Reject this early.
Chris Lattner1a957962009-12-09 07:08:01 +00001375 if (Deps.size() == 1 && Deps[0].getResult().isClobber()) {
Edwin Török3ffffac2009-06-17 18:48:18 +00001376 DEBUG(
Dan Gohman0be10b02009-07-25 01:43:01 +00001377 errs() << "GVN: non-local load ";
1378 WriteAsOperand(errs(), LI);
Chris Lattner1a957962009-12-09 07:08:01 +00001379 errs() << " is clobbered by " << *Deps[0].getResult().getInst() << '\n';
Edwin Török3ffffac2009-06-17 18:48:18 +00001380 );
Chris Lattner8d1686f2008-12-18 00:51:32 +00001381 return false;
Edwin Török3ffffac2009-06-17 18:48:18 +00001382 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001383
Chris Lattnerdcded152008-12-02 08:16:11 +00001384 // Filter out useless results (non-locals, etc). Keep track of the blocks
1385 // where we have a value available in repl, also keep track of whether we see
1386 // dependencies that produce an unknown value for the load (such as a call
1387 // that could potentially clobber the load).
Chris Lattner19b84b32009-09-21 06:30:24 +00001388 SmallVector<AvailableValueInBlock, 16> ValuesPerBlock;
Chris Lattnerdcded152008-12-02 08:16:11 +00001389 SmallVector<BasicBlock*, 16> UnavailableBlocks;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001390
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001391 const TargetData *TD = 0;
1392
Chris Lattneraf713862008-12-09 19:25:07 +00001393 for (unsigned i = 0, e = Deps.size(); i != e; ++i) {
Chris Lattner1a957962009-12-09 07:08:01 +00001394 BasicBlock *DepBB = Deps[i].getBB();
1395 MemDepResult DepInfo = Deps[i].getResult();
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001396
Chris Lattner4531da82008-12-05 21:04:20 +00001397 if (DepInfo.isClobber()) {
Chris Lattner091a1d22009-12-09 18:21:46 +00001398 // The address being loaded in this non-local block may not be the same as
1399 // the pointer operand of the load if PHI translation occurs. Make sure
1400 // to consider the right address.
1401 Value *Address = Deps[i].getAddress();
1402
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001403 // If the dependence is to a store that writes to a superset of the bits
1404 // read by the load, we can extract the bits we need for the load from the
1405 // stored value.
1406 if (StoreInst *DepSI = dyn_cast<StoreInst>(DepInfo.getInst())) {
1407 if (TD == 0)
1408 TD = getAnalysisIfAvailable<TargetData>();
Chris Lattner091a1d22009-12-09 18:21:46 +00001409 if (TD && Address) {
1410 int Offset = AnalyzeLoadFromClobberingStore(LI->getType(), Address,
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001411 DepSI, *TD);
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001412 if (Offset != -1) {
1413 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
1414 DepSI->getOperand(0),
1415 Offset));
1416 continue;
1417 }
1418 }
1419 }
Chris Lattnercb00f732009-12-06 01:57:02 +00001420
Chris Lattnercb00f732009-12-06 01:57:02 +00001421 // If the clobbering value is a memset/memcpy/memmove, see if we can
1422 // forward a value on from it.
Chris Lattnera96e53a2009-12-06 04:54:31 +00001423 if (MemIntrinsic *DepMI = dyn_cast<MemIntrinsic>(DepInfo.getInst())) {
Chris Lattnercb00f732009-12-06 01:57:02 +00001424 if (TD == 0)
1425 TD = getAnalysisIfAvailable<TargetData>();
Chris Lattner091a1d22009-12-09 18:21:46 +00001426 if (TD && Address) {
1427 int Offset = AnalyzeLoadFromClobberingMemInst(LI->getType(), Address,
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001428 DepMI, *TD);
Chris Lattnera96e53a2009-12-06 04:54:31 +00001429 if (Offset != -1) {
1430 ValuesPerBlock.push_back(AvailableValueInBlock::getMI(DepBB, DepMI,
1431 Offset));
1432 continue;
1433 }
Chris Lattnercb00f732009-12-06 01:57:02 +00001434 }
1435 }
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001436
Chris Lattner4531da82008-12-05 21:04:20 +00001437 UnavailableBlocks.push_back(DepBB);
1438 continue;
1439 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001440
Chris Lattner4531da82008-12-05 21:04:20 +00001441 Instruction *DepInst = DepInfo.getInst();
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001442
Chris Lattner4531da82008-12-05 21:04:20 +00001443 // Loading the allocation -> undef.
Chris Lattnerbc6fccc2009-12-02 06:44:58 +00001444 if (isa<AllocaInst>(DepInst) || isMalloc(DepInst) ||
Owen Andersonf187daf2009-12-02 07:35:19 +00001445 // Loading immediately after lifetime begin -> undef.
1446 isLifetimeStart(DepInst)) {
Chris Lattner19b84b32009-09-21 06:30:24 +00001447 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
1448 UndefValue::get(LI->getType())));
Chris Lattner46876282008-12-01 01:15:42 +00001449 continue;
1450 }
Owen Andersonc07861a2009-10-28 07:05:35 +00001451
Chris Lattner19b84b32009-09-21 06:30:24 +00001452 if (StoreInst *S = dyn_cast<StoreInst>(DepInst)) {
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001453 // Reject loads and stores that are to the same address but are of
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001454 // different types if we have to.
Chris Lattnerdcded152008-12-02 08:16:11 +00001455 if (S->getOperand(0)->getType() != LI->getType()) {
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001456 if (TD == 0)
1457 TD = getAnalysisIfAvailable<TargetData>();
1458
1459 // If the stored value is larger or equal to the loaded value, we can
1460 // reuse it.
Chris Lattner012b3602009-09-21 17:24:04 +00001461 if (TD == 0 || !CanCoerceMustAliasedValueToLoad(S->getOperand(0),
1462 LI->getType(), *TD)) {
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001463 UnavailableBlocks.push_back(DepBB);
1464 continue;
1465 }
Chris Lattnerdcded152008-12-02 08:16:11 +00001466 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001467
Chris Lattner19b84b32009-09-21 06:30:24 +00001468 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB,
1469 S->getOperand(0)));
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001470 continue;
1471 }
1472
1473 if (LoadInst *LD = dyn_cast<LoadInst>(DepInst)) {
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001474 // If the types mismatch and we can't handle it, reject reuse of the load.
Chris Lattnerdcded152008-12-02 08:16:11 +00001475 if (LD->getType() != LI->getType()) {
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001476 if (TD == 0)
1477 TD = getAnalysisIfAvailable<TargetData>();
1478
1479 // If the stored value is larger or equal to the loaded value, we can
1480 // reuse it.
Chris Lattner012b3602009-09-21 17:24:04 +00001481 if (TD == 0 || !CanCoerceMustAliasedValueToLoad(LD, LI->getType(),*TD)){
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001482 UnavailableBlocks.push_back(DepBB);
1483 continue;
1484 }
Chris Lattnerdcded152008-12-02 08:16:11 +00001485 }
Chris Lattner19b84b32009-09-21 06:30:24 +00001486 ValuesPerBlock.push_back(AvailableValueInBlock::get(DepBB, LD));
Chris Lattnerdcded152008-12-02 08:16:11 +00001487 continue;
Owen Anderson5d72a422007-07-25 19:57:03 +00001488 }
Chris Lattneraae7fcb2009-09-21 06:48:08 +00001489
1490 UnavailableBlocks.push_back(DepBB);
1491 continue;
Chris Lattner3d7103e2008-03-21 21:14:38 +00001492 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001493
Chris Lattnerdcded152008-12-02 08:16:11 +00001494 // If we have no predecessors that produce a known value for this load, exit
1495 // early.
1496 if (ValuesPerBlock.empty()) return false;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001497
Chris Lattnerdcded152008-12-02 08:16:11 +00001498 // If all of the instructions we depend on produce a known value for this
1499 // load, then it is fully redundant and we can use PHI insertion to compute
1500 // its value. Insert PHIs and remove the fully redundant value now.
1501 if (UnavailableBlocks.empty()) {
Dan Gohman7e124382009-07-31 20:24:18 +00001502 DEBUG(errs() << "GVN REMOVING NONLOCAL LOAD: " << *LI << '\n');
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001503
Chris Lattnerdcded152008-12-02 08:16:11 +00001504 // Perform PHI construction.
Chris Lattner1c8dc432009-12-21 23:15:48 +00001505 Value *V = ConstructSSAForLoadSet(LI, ValuesPerBlock, TD, *DT,
Chris Lattner6e5ea272009-10-10 23:50:30 +00001506 VN.getAliasAnalysis());
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001507 LI->replaceAllUsesWith(V);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001508
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001509 if (isa<PHINode>(V))
1510 V->takeName(LI);
1511 if (isa<PointerType>(V->getType()))
1512 MD->invalidateCachedPointerInfo(V);
Chris Lattnerdcded152008-12-02 08:16:11 +00001513 toErase.push_back(LI);
1514 NumGVNLoad++;
1515 return true;
1516 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001517
Chris Lattnerdcded152008-12-02 08:16:11 +00001518 if (!EnablePRE || !EnableLoadPRE)
1519 return false;
1520
1521 // Okay, we have *some* definitions of the value. This means that the value
1522 // is available in some of our (transitive) predecessors. Lets think about
1523 // doing PRE of this load. This will involve inserting a new load into the
1524 // predecessor when it's not available. We could do this in general, but
1525 // prefer to not increase code size. As such, we only do this when we know
1526 // that we only have to insert *one* load (which means we're basically moving
1527 // the load, not inserting a new one).
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001528
Owen Andersondd37b182009-05-31 09:03:40 +00001529 SmallPtrSet<BasicBlock *, 4> Blockers;
1530 for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1531 Blockers.insert(UnavailableBlocks[i]);
1532
1533 // Lets find first basic block with more than one predecessor. Walk backwards
1534 // through predecessors if needed.
Chris Lattnerdcded152008-12-02 08:16:11 +00001535 BasicBlock *LoadBB = LI->getParent();
Owen Andersondd37b182009-05-31 09:03:40 +00001536 BasicBlock *TmpBB = LoadBB;
1537
1538 bool isSinglePred = false;
Dale Johannesena19b67f2009-06-17 20:48:23 +00001539 bool allSingleSucc = true;
Owen Andersondd37b182009-05-31 09:03:40 +00001540 while (TmpBB->getSinglePredecessor()) {
1541 isSinglePred = true;
1542 TmpBB = TmpBB->getSinglePredecessor();
1543 if (!TmpBB) // If haven't found any, bail now.
1544 return false;
1545 if (TmpBB == LoadBB) // Infinite (unreachable) loop.
1546 return false;
1547 if (Blockers.count(TmpBB))
1548 return false;
Dale Johannesena19b67f2009-06-17 20:48:23 +00001549 if (TmpBB->getTerminator()->getNumSuccessors() != 1)
1550 allSingleSucc = false;
Owen Andersondd37b182009-05-31 09:03:40 +00001551 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001552
Owen Andersondd37b182009-05-31 09:03:40 +00001553 assert(TmpBB);
1554 LoadBB = TmpBB;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001555
Chris Lattnerdcded152008-12-02 08:16:11 +00001556 // If we have a repl set with LI itself in it, this means we have a loop where
1557 // at least one of the values is LI. Since this means that we won't be able
1558 // to eliminate LI even if we insert uses in the other predecessors, we will
1559 // end up increasing code size. Reject this by scanning for LI.
1560 for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i)
Chris Lattnera96e53a2009-12-06 04:54:31 +00001561 if (ValuesPerBlock[i].isSimpleValue() &&
1562 ValuesPerBlock[i].getSimpleValue() == LI)
Chris Lattnerdcded152008-12-02 08:16:11 +00001563 return false;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001564
Chris Lattnera96e53a2009-12-06 04:54:31 +00001565 // FIXME: It is extremely unclear what this loop is doing, other than
1566 // artificially restricting loadpre.
Owen Andersondd37b182009-05-31 09:03:40 +00001567 if (isSinglePred) {
1568 bool isHot = false;
Chris Lattnera96e53a2009-12-06 04:54:31 +00001569 for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i) {
1570 const AvailableValueInBlock &AV = ValuesPerBlock[i];
1571 if (AV.isSimpleValue())
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001572 // "Hot" Instruction is in some loop (because it dominates its dep.
1573 // instruction).
Chris Lattnera96e53a2009-12-06 04:54:31 +00001574 if (Instruction *I = dyn_cast<Instruction>(AV.getSimpleValue()))
1575 if (DT->dominates(LI, I)) {
1576 isHot = true;
1577 break;
1578 }
1579 }
Owen Andersondd37b182009-05-31 09:03:40 +00001580
1581 // We are interested only in "hot" instructions. We don't want to do any
1582 // mis-optimizations here.
1583 if (!isHot)
1584 return false;
1585 }
1586
Chris Lattnerdcded152008-12-02 08:16:11 +00001587 // Okay, we have some hope :). Check to see if the loaded value is fully
1588 // available in all but one predecessor.
1589 // FIXME: If we could restructure the CFG, we could make a common pred with
1590 // all the preds that don't have an available LI and insert a new load into
1591 // that one block.
1592 BasicBlock *UnavailablePred = 0;
1593
Chris Lattner159b98f2008-12-05 07:49:08 +00001594 DenseMap<BasicBlock*, char> FullyAvailableBlocks;
Chris Lattnerdcded152008-12-02 08:16:11 +00001595 for (unsigned i = 0, e = ValuesPerBlock.size(); i != e; ++i)
Chris Lattner19b84b32009-09-21 06:30:24 +00001596 FullyAvailableBlocks[ValuesPerBlock[i].BB] = true;
Chris Lattnerdcded152008-12-02 08:16:11 +00001597 for (unsigned i = 0, e = UnavailableBlocks.size(); i != e; ++i)
1598 FullyAvailableBlocks[UnavailableBlocks[i]] = false;
1599
1600 for (pred_iterator PI = pred_begin(LoadBB), E = pred_end(LoadBB);
1601 PI != E; ++PI) {
1602 if (IsValueFullyAvailableInBlock(*PI, FullyAvailableBlocks))
1603 continue;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001604
Chris Lattnerdcded152008-12-02 08:16:11 +00001605 // If this load is not available in multiple predecessors, reject it.
1606 if (UnavailablePred && UnavailablePred != *PI)
1607 return false;
1608 UnavailablePred = *PI;
1609 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001610
Chris Lattnerdcded152008-12-02 08:16:11 +00001611 assert(UnavailablePred != 0 &&
1612 "Fully available value should be eliminated above!");
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001613
Chris Lattnerdcded152008-12-02 08:16:11 +00001614 // We don't currently handle critical edges :(
1615 if (UnavailablePred->getTerminator()->getNumSuccessors() != 1) {
Daniel Dunbar005975c2009-07-25 00:23:56 +00001616 DEBUG(errs() << "COULD NOT PRE LOAD BECAUSE OF CRITICAL EDGE '"
Dan Gohman7e124382009-07-31 20:24:18 +00001617 << UnavailablePred->getName() << "': " << *LI << '\n');
Chris Lattnerdcded152008-12-02 08:16:11 +00001618 return false;
Owen Anderson5b299672007-08-07 23:12:31 +00001619 }
Chris Lattner248818e2009-11-27 08:25:10 +00001620
Chris Lattnera5bef152009-11-27 22:05:15 +00001621 // Do PHI translation to get its value in the predecessor if necessary. The
1622 // returned pointer (if non-null) is guaranteed to dominate UnavailablePred.
1623 //
Chris Lattner1c2de2b2009-11-28 15:39:14 +00001624 SmallVector<Instruction*, 8> NewInsts;
Chris Lattnerde0b0302009-11-27 22:50:07 +00001625
Chris Lattner80c535b2009-11-28 16:08:18 +00001626 // If all preds have a single successor, then we know it is safe to insert the
1627 // load on the pred (?!?), so we can insert code to materialize the pointer if
1628 // it is not available.
Chris Lattnerefff3222009-12-09 01:59:31 +00001629 PHITransAddr Address(LI->getOperand(0), TD);
1630 Value *LoadPtr = 0;
Chris Lattner80c535b2009-11-28 16:08:18 +00001631 if (allSingleSucc) {
Chris Lattnerefff3222009-12-09 01:59:31 +00001632 LoadPtr = Address.PHITranslateWithInsertion(LoadBB, UnavailablePred,
1633 *DT, NewInsts);
Chris Lattner80c535b2009-11-28 16:08:18 +00001634 } else {
Chris Lattnerefff3222009-12-09 01:59:31 +00001635 Address.PHITranslateValue(LoadBB, UnavailablePred);
1636 LoadPtr = Address.getAddr();
1637
1638 // Make sure the value is live in the predecessor.
1639 if (Instruction *Inst = dyn_cast_or_null<Instruction>(LoadPtr))
1640 if (!DT->dominates(Inst->getParent(), UnavailablePred))
1641 LoadPtr = 0;
1642 }
1643
1644 // If we couldn't find or insert a computation of this phi translated value,
1645 // we fail PRE.
1646 if (LoadPtr == 0) {
1647 assert(NewInsts.empty() && "Shouldn't insert insts on failure");
1648 DEBUG(errs() << "COULDN'T INSERT PHI TRANSLATED VALUE OF: "
1649 << *LI->getOperand(0) << "\n");
1650 return false;
Chris Lattner80c535b2009-11-28 16:08:18 +00001651 }
Owen Anderson2c405b92009-12-03 03:43:29 +00001652
1653 // Assign value numbers to these new instructions.
Chris Lattnerefff3222009-12-09 01:59:31 +00001654 for (unsigned i = 0, e = NewInsts.size(); i != e; ++i) {
Owen Anderson2c405b92009-12-03 03:43:29 +00001655 // FIXME: We really _ought_ to insert these value numbers into their
1656 // parent's availability map. However, in doing so, we risk getting into
1657 // ordering issues. If a block hasn't been processed yet, we would be
1658 // marking a value as AVAIL-IN, which isn't what we intend.
Chris Lattnerefff3222009-12-09 01:59:31 +00001659 VN.lookup_or_add(NewInsts[i]);
Chris Lattner248818e2009-11-27 08:25:10 +00001660 }
1661
Dale Johannesena19b67f2009-06-17 20:48:23 +00001662 // Make sure it is valid to move this load here. We have to watch out for:
1663 // @1 = getelementptr (i8* p, ...
1664 // test p and branch if == 0
1665 // load @1
1666 // It is valid to have the getelementptr before the test, even if p can be 0,
1667 // as getelementptr only does address arithmetic.
1668 // If we are not pushing the value through any multiple-successor blocks
1669 // we do not have this case. Otherwise, check that the load is safe to
1670 // put anywhere; this can be improved, but should be conservatively safe.
1671 if (!allSingleSucc &&
Chris Lattner1c2de2b2009-11-28 15:39:14 +00001672 // FIXME: REEVALUTE THIS.
Chris Lattner80c535b2009-11-28 16:08:18 +00001673 !isSafeToLoadUnconditionally(LoadPtr, UnavailablePred->getTerminator())) {
1674 assert(NewInsts.empty() && "Should not have inserted instructions");
Dale Johannesena19b67f2009-06-17 20:48:23 +00001675 return false;
Chris Lattner80c535b2009-11-28 16:08:18 +00001676 }
Dale Johannesena19b67f2009-06-17 20:48:23 +00001677
Chris Lattnerdcded152008-12-02 08:16:11 +00001678 // Okay, we can eliminate this load by inserting a reload in the predecessor
1679 // and using PHI construction to get the value in the other predecessors, do
1680 // it.
Dan Gohman7e124382009-07-31 20:24:18 +00001681 DEBUG(errs() << "GVN REMOVING PRE LOAD: " << *LI << '\n');
Chris Lattner80c535b2009-11-28 16:08:18 +00001682 DEBUG(if (!NewInsts.empty())
1683 errs() << "INSERTED " << NewInsts.size() << " INSTS: "
1684 << *NewInsts.back() << '\n');
1685
Chris Lattnerdcded152008-12-02 08:16:11 +00001686 Value *NewLoad = new LoadInst(LoadPtr, LI->getName()+".pre", false,
1687 LI->getAlignment(),
1688 UnavailablePred->getTerminator());
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001689
Chris Lattner6e5ea272009-10-10 23:50:30 +00001690 // Add the newly created load.
1691 ValuesPerBlock.push_back(AvailableValueInBlock::get(UnavailablePred,NewLoad));
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001692
Chris Lattnerdcded152008-12-02 08:16:11 +00001693 // Perform PHI construction.
Chris Lattner1c8dc432009-12-21 23:15:48 +00001694 Value *V = ConstructSSAForLoadSet(LI, ValuesPerBlock, TD, *DT,
Chris Lattner6e5ea272009-10-10 23:50:30 +00001695 VN.getAliasAnalysis());
Chris Lattnerd6b1d052009-09-20 20:09:34 +00001696 LI->replaceAllUsesWith(V);
1697 if (isa<PHINode>(V))
1698 V->takeName(LI);
1699 if (isa<PointerType>(V->getType()))
1700 MD->invalidateCachedPointerInfo(V);
Chris Lattnerdcded152008-12-02 08:16:11 +00001701 toErase.push_back(LI);
1702 NumPRELoad++;
Owen Anderson5d72a422007-07-25 19:57:03 +00001703 return true;
1704}
1705
Owen Andersone0143452007-08-16 22:02:55 +00001706/// processLoad - Attempt to eliminate a load, first by eliminating it
1707/// locally, and then attempting non-local elimination if that fails.
Chris Lattner4531da82008-12-05 21:04:20 +00001708bool GVN::processLoad(LoadInst *L, SmallVectorImpl<Instruction*> &toErase) {
Dan Gohmanc8d26652009-11-14 02:27:51 +00001709 if (!MD)
1710 return false;
1711
Chris Lattner4531da82008-12-05 21:04:20 +00001712 if (L->isVolatile())
Owen Anderson85c40642007-07-24 17:55:58 +00001713 return false;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001714
Owen Anderson85c40642007-07-24 17:55:58 +00001715 // ... to a pointer that has been loaded from before...
Chris Lattnerff36c952009-09-21 02:42:51 +00001716 MemDepResult Dep = MD->getDependency(L);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001717
Chris Lattner4531da82008-12-05 21:04:20 +00001718 // If the value isn't available, don't do anything!
Chris Lattnerff36c952009-09-21 02:42:51 +00001719 if (Dep.isClobber()) {
Chris Lattner0907b522009-09-21 05:57:11 +00001720 // Check to see if we have something like this:
Chris Lattner7741aa52009-09-20 19:03:47 +00001721 // store i32 123, i32* %P
1722 // %A = bitcast i32* %P to i8*
1723 // %B = gep i8* %A, i32 1
1724 // %C = load i8* %B
1725 //
1726 // We could do that by recognizing if the clobber instructions are obviously
1727 // a common base + constant offset, and if the previous store (or memset)
1728 // completely covers this load. This sort of thing can happen in bitfield
1729 // access code.
Chris Lattnercb00f732009-12-06 01:57:02 +00001730 Value *AvailVal = 0;
Chris Lattner0907b522009-09-21 05:57:11 +00001731 if (StoreInst *DepSI = dyn_cast<StoreInst>(Dep.getInst()))
Chris Lattner41eb59c2009-09-21 06:22:46 +00001732 if (const TargetData *TD = getAnalysisIfAvailable<TargetData>()) {
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001733 int Offset = AnalyzeLoadFromClobberingStore(L->getType(),
1734 L->getPointerOperand(),
1735 DepSI, *TD);
Chris Lattnercb00f732009-12-06 01:57:02 +00001736 if (Offset != -1)
1737 AvailVal = GetStoreValueForLoad(DepSI->getOperand(0), Offset,
1738 L->getType(), L, *TD);
Chris Lattner41eb59c2009-09-21 06:22:46 +00001739 }
Chris Lattner0907b522009-09-21 05:57:11 +00001740
Chris Lattnercb00f732009-12-06 01:57:02 +00001741 // If the clobbering value is a memset/memcpy/memmove, see if we can forward
1742 // a value on from it.
1743 if (MemIntrinsic *DepMI = dyn_cast<MemIntrinsic>(Dep.getInst())) {
1744 if (const TargetData *TD = getAnalysisIfAvailable<TargetData>()) {
Chris Lattnerfd9feaa2009-12-09 07:37:07 +00001745 int Offset = AnalyzeLoadFromClobberingMemInst(L->getType(),
1746 L->getPointerOperand(),
1747 DepMI, *TD);
Chris Lattnercb00f732009-12-06 01:57:02 +00001748 if (Offset != -1)
1749 AvailVal = GetMemInstValueForLoad(DepMI, Offset, L->getType(), L,*TD);
1750 }
1751 }
1752
1753 if (AvailVal) {
1754 DEBUG(errs() << "GVN COERCED INST:\n" << *Dep.getInst() << '\n'
1755 << *AvailVal << '\n' << *L << "\n\n\n");
1756
1757 // Replace the load!
1758 L->replaceAllUsesWith(AvailVal);
1759 if (isa<PointerType>(AvailVal->getType()))
1760 MD->invalidateCachedPointerInfo(AvailVal);
1761 toErase.push_back(L);
1762 NumGVNLoad++;
1763 return true;
1764 }
1765
Edwin Török47cf8842009-05-29 09:46:03 +00001766 DEBUG(
1767 // fast print dep, using operator<< on instruction would be too slow
Dan Gohman0be10b02009-07-25 01:43:01 +00001768 errs() << "GVN: load ";
1769 WriteAsOperand(errs(), L);
Chris Lattnerff36c952009-09-21 02:42:51 +00001770 Instruction *I = Dep.getInst();
Dan Gohman7e124382009-07-31 20:24:18 +00001771 errs() << " is clobbered by " << *I << '\n';
Edwin Török47cf8842009-05-29 09:46:03 +00001772 );
Chris Lattner4531da82008-12-05 21:04:20 +00001773 return false;
Edwin Török47cf8842009-05-29 09:46:03 +00001774 }
Chris Lattner4531da82008-12-05 21:04:20 +00001775
1776 // If it is defined in another block, try harder.
Chris Lattnerff36c952009-09-21 02:42:51 +00001777 if (Dep.isNonLocal())
Chris Lattner4531da82008-12-05 21:04:20 +00001778 return processNonLocalLoad(L, toErase);
Eli Friedman350307f2008-02-12 12:08:14 +00001779
Chris Lattnerff36c952009-09-21 02:42:51 +00001780 Instruction *DepInst = Dep.getInst();
Chris Lattner4531da82008-12-05 21:04:20 +00001781 if (StoreInst *DepSI = dyn_cast<StoreInst>(DepInst)) {
Chris Lattner7741aa52009-09-20 19:03:47 +00001782 Value *StoredVal = DepSI->getOperand(0);
1783
1784 // The store and load are to a must-aliased pointer, but they may not
1785 // actually have the same type. See if we know how to reuse the stored
1786 // value (depending on its type).
1787 const TargetData *TD = 0;
Chris Lattner10460aa2009-10-21 04:11:19 +00001788 if (StoredVal->getType() != L->getType()) {
1789 if ((TD = getAnalysisIfAvailable<TargetData>())) {
1790 StoredVal = CoerceAvailableValueToLoadType(StoredVal, L->getType(),
1791 L, *TD);
1792 if (StoredVal == 0)
1793 return false;
1794
1795 DEBUG(errs() << "GVN COERCED STORE:\n" << *DepSI << '\n' << *StoredVal
1796 << '\n' << *L << "\n\n\n");
1797 }
1798 else
Chris Lattner7741aa52009-09-20 19:03:47 +00001799 return false;
Chris Lattner7741aa52009-09-20 19:03:47 +00001800 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001801
Chris Lattner4531da82008-12-05 21:04:20 +00001802 // Remove it!
Chris Lattner7741aa52009-09-20 19:03:47 +00001803 L->replaceAllUsesWith(StoredVal);
1804 if (isa<PointerType>(StoredVal->getType()))
1805 MD->invalidateCachedPointerInfo(StoredVal);
Chris Lattner4531da82008-12-05 21:04:20 +00001806 toErase.push_back(L);
1807 NumGVNLoad++;
1808 return true;
1809 }
1810
1811 if (LoadInst *DepLI = dyn_cast<LoadInst>(DepInst)) {
Chris Lattner7741aa52009-09-20 19:03:47 +00001812 Value *AvailableVal = DepLI;
1813
1814 // The loads are of a must-aliased pointer, but they may not actually have
1815 // the same type. See if we know how to reuse the previously loaded value
1816 // (depending on its type).
1817 const TargetData *TD = 0;
Chris Lattner10460aa2009-10-21 04:11:19 +00001818 if (DepLI->getType() != L->getType()) {
1819 if ((TD = getAnalysisIfAvailable<TargetData>())) {
1820 AvailableVal = CoerceAvailableValueToLoadType(DepLI, L->getType(), L,*TD);
1821 if (AvailableVal == 0)
1822 return false;
Chris Lattner7741aa52009-09-20 19:03:47 +00001823
Chris Lattner10460aa2009-10-21 04:11:19 +00001824 DEBUG(errs() << "GVN COERCED LOAD:\n" << *DepLI << "\n" << *AvailableVal
1825 << "\n" << *L << "\n\n\n");
1826 }
1827 else
1828 return false;
Chris Lattner7741aa52009-09-20 19:03:47 +00001829 }
1830
Chris Lattner4531da82008-12-05 21:04:20 +00001831 // Remove it!
Chris Lattner7741aa52009-09-20 19:03:47 +00001832 L->replaceAllUsesWith(AvailableVal);
Chris Lattnerf81b0142008-12-09 22:06:23 +00001833 if (isa<PointerType>(DepLI->getType()))
1834 MD->invalidateCachedPointerInfo(DepLI);
Chris Lattner4531da82008-12-05 21:04:20 +00001835 toErase.push_back(L);
1836 NumGVNLoad++;
1837 return true;
1838 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001839
Chris Lattner8ea60462008-11-30 01:39:32 +00001840 // If this load really doesn't depend on anything, then we must be loading an
1841 // undef value. This can happen when loading for a fresh allocation with no
1842 // intervening stores, for example.
Victor Hernandezb1687302009-10-23 21:09:37 +00001843 if (isa<AllocaInst>(DepInst) || isMalloc(DepInst)) {
Owen Andersonb99ecca2009-07-30 23:03:37 +00001844 L->replaceAllUsesWith(UndefValue::get(L->getType()));
Chris Lattner8ea60462008-11-30 01:39:32 +00001845 toErase.push_back(L);
Chris Lattner8ea60462008-11-30 01:39:32 +00001846 NumGVNLoad++;
Chris Lattner4531da82008-12-05 21:04:20 +00001847 return true;
Eli Friedman350307f2008-02-12 12:08:14 +00001848 }
Owen Andersonc07861a2009-10-28 07:05:35 +00001849
Owen Andersonf187daf2009-12-02 07:35:19 +00001850 // If this load occurs either right after a lifetime begin,
Owen Andersonc07861a2009-10-28 07:05:35 +00001851 // then the loaded value is undefined.
1852 if (IntrinsicInst* II = dyn_cast<IntrinsicInst>(DepInst)) {
Owen Andersonf187daf2009-12-02 07:35:19 +00001853 if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
Owen Andersonc07861a2009-10-28 07:05:35 +00001854 L->replaceAllUsesWith(UndefValue::get(L->getType()));
1855 toErase.push_back(L);
1856 NumGVNLoad++;
1857 return true;
1858 }
1859 }
Eli Friedman350307f2008-02-12 12:08:14 +00001860
Chris Lattner4531da82008-12-05 21:04:20 +00001861 return false;
Owen Anderson85c40642007-07-24 17:55:58 +00001862}
1863
Chris Lattnerff36c952009-09-21 02:42:51 +00001864Value *GVN::lookupNumber(BasicBlock *BB, uint32_t num) {
Owen Andersonaef6a922008-06-23 17:49:45 +00001865 DenseMap<BasicBlock*, ValueNumberScope*>::iterator I = localAvail.find(BB);
1866 if (I == localAvail.end())
1867 return 0;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001868
Chris Lattnerff36c952009-09-21 02:42:51 +00001869 ValueNumberScope *Locals = I->second;
1870 while (Locals) {
1871 DenseMap<uint32_t, Value*>::iterator I = Locals->table.find(num);
1872 if (I != Locals->table.end())
Owen Anderson2a412722008-06-20 01:15:47 +00001873 return I->second;
Chris Lattnerff36c952009-09-21 02:42:51 +00001874 Locals = Locals->parent;
Owen Anderson2a412722008-06-20 01:15:47 +00001875 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001876
Owen Anderson2a412722008-06-20 01:15:47 +00001877 return 0;
1878}
1879
Owen Andersona03e7862008-12-15 02:03:00 +00001880
Owen Andersonf631bb62007-08-14 18:16:29 +00001881/// processInstruction - When calculating availability, handle an instruction
Owen Anderson85c40642007-07-24 17:55:58 +00001882/// by inserting it into the appropriate sets
Owen Anderson9334fc62008-06-12 19:25:32 +00001883bool GVN::processInstruction(Instruction *I,
Chris Lattner7de20452008-03-21 22:01:16 +00001884 SmallVectorImpl<Instruction*> &toErase) {
Chris Lattnerff36c952009-09-21 02:42:51 +00001885 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
1886 bool Changed = processLoad(LI, toErase);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001887
Chris Lattnerff36c952009-09-21 02:42:51 +00001888 if (!Changed) {
1889 unsigned Num = VN.lookup_or_add(LI);
1890 localAvail[I->getParent()]->table.insert(std::make_pair(Num, LI));
Owen Andersone6b4ff82008-06-18 21:41:49 +00001891 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001892
Chris Lattnerff36c952009-09-21 02:42:51 +00001893 return Changed;
Owen Andersone6b4ff82008-06-18 21:41:49 +00001894 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001895
Chris Lattnerff36c952009-09-21 02:42:51 +00001896 uint32_t NextNum = VN.getNextUnusedValueNumber();
1897 unsigned Num = VN.lookup_or_add(I);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001898
Chris Lattnerff36c952009-09-21 02:42:51 +00001899 if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
1900 localAvail[I->getParent()]->table.insert(std::make_pair(Num, I));
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001901
Owen Andersonef8bf0f2009-04-01 23:53:49 +00001902 if (!BI->isConditional() || isa<Constant>(BI->getCondition()))
1903 return false;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001904
Chris Lattnerff36c952009-09-21 02:42:51 +00001905 Value *BranchCond = BI->getCondition();
1906 uint32_t CondVN = VN.lookup_or_add(BranchCond);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001907
Chris Lattnerff36c952009-09-21 02:42:51 +00001908 BasicBlock *TrueSucc = BI->getSuccessor(0);
1909 BasicBlock *FalseSucc = BI->getSuccessor(1);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001910
Chris Lattnerff36c952009-09-21 02:42:51 +00001911 if (TrueSucc->getSinglePredecessor())
1912 localAvail[TrueSucc]->table[CondVN] =
1913 ConstantInt::getTrue(TrueSucc->getContext());
1914 if (FalseSucc->getSinglePredecessor())
1915 localAvail[FalseSucc]->table[CondVN] =
1916 ConstantInt::getFalse(TrueSucc->getContext());
Owen Andersonef8bf0f2009-04-01 23:53:49 +00001917
1918 return false;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001919
Owen Andersonced50f82008-04-07 09:59:07 +00001920 // Allocations are always uniquely numbered, so we can save time and memory
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001921 // by fast failing them.
Victor Hernandezb1687302009-10-23 21:09:37 +00001922 } else if (isa<AllocaInst>(I) || isa<TerminatorInst>(I)) {
Chris Lattnerff36c952009-09-21 02:42:51 +00001923 localAvail[I->getParent()]->table.insert(std::make_pair(Num, I));
Owen Andersonced50f82008-04-07 09:59:07 +00001924 return false;
Owen Andersone6b4ff82008-06-18 21:41:49 +00001925 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001926
Owen Andersone0143452007-08-16 22:02:55 +00001927 // Collapse PHI nodes
Owen Anderson98f6a6b2007-08-14 18:33:27 +00001928 if (PHINode* p = dyn_cast<PHINode>(I)) {
Chris Lattnerff36c952009-09-21 02:42:51 +00001929 Value *constVal = CollapsePhi(p);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001930
Owen Anderson98f6a6b2007-08-14 18:33:27 +00001931 if (constVal) {
Owen Andersone02ad522007-08-16 22:51:56 +00001932 p->replaceAllUsesWith(constVal);
Dan Gohmanc8d26652009-11-14 02:27:51 +00001933 if (MD && isa<PointerType>(constVal->getType()))
Chris Lattnerf81b0142008-12-09 22:06:23 +00001934 MD->invalidateCachedPointerInfo(constVal);
Owen Anderson575f2812008-12-23 00:49:51 +00001935 VN.erase(p);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001936
Owen Andersone02ad522007-08-16 22:51:56 +00001937 toErase.push_back(p);
Owen Andersone6b4ff82008-06-18 21:41:49 +00001938 } else {
Chris Lattnerff36c952009-09-21 02:42:51 +00001939 localAvail[I->getParent()]->table.insert(std::make_pair(Num, I));
Owen Anderson98f6a6b2007-08-14 18:33:27 +00001940 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001941
Owen Anderson8a8d13c2008-07-03 17:44:33 +00001942 // If the number we were assigned was a brand new VN, then we don't
1943 // need to do a lookup to see if the number already exists
1944 // somewhere in the domtree: it can't!
Chris Lattnerff36c952009-09-21 02:42:51 +00001945 } else if (Num == NextNum) {
1946 localAvail[I->getParent()]->table.insert(std::make_pair(Num, I));
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001947
Owen Andersona03e7862008-12-15 02:03:00 +00001948 // Perform fast-path value-number based elimination of values inherited from
1949 // dominators.
Chris Lattnerff36c952009-09-21 02:42:51 +00001950 } else if (Value *repl = lookupNumber(I->getParent(), Num)) {
Owen Andersonc772be72007-12-08 01:37:09 +00001951 // Remove it!
Owen Anderson5aff8002007-07-31 23:27:13 +00001952 VN.erase(I);
Owen Anderson85c40642007-07-24 17:55:58 +00001953 I->replaceAllUsesWith(repl);
Dan Gohmanc8d26652009-11-14 02:27:51 +00001954 if (MD && isa<PointerType>(repl->getType()))
Chris Lattnerf81b0142008-12-09 22:06:23 +00001955 MD->invalidateCachedPointerInfo(repl);
Owen Anderson85c40642007-07-24 17:55:58 +00001956 toErase.push_back(I);
1957 return true;
Owen Andersona03e7862008-12-15 02:03:00 +00001958
Owen Anderson8a8d13c2008-07-03 17:44:33 +00001959 } else {
Chris Lattnerff36c952009-09-21 02:42:51 +00001960 localAvail[I->getParent()]->table.insert(std::make_pair(Num, I));
Owen Anderson85c40642007-07-24 17:55:58 +00001961 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001962
Owen Anderson85c40642007-07-24 17:55:58 +00001963 return false;
1964}
1965
Bill Wendling42f17f62008-12-22 22:32:22 +00001966/// runOnFunction - This is the main transformation entry point for a function.
Owen Andersonbe168b32007-08-14 18:04:11 +00001967bool GVN::runOnFunction(Function& F) {
Dan Gohmanc8d26652009-11-14 02:27:51 +00001968 if (!NoLoads)
1969 MD = &getAnalysis<MemoryDependenceAnalysis>();
Chris Lattner02ca4422008-12-01 00:40:32 +00001970 DT = &getAnalysis<DominatorTree>();
Owen Andersonbcf2bd52008-05-12 20:15:55 +00001971 VN.setAliasAnalysis(&getAnalysis<AliasAnalysis>());
Chris Lattner02ca4422008-12-01 00:40:32 +00001972 VN.setMemDep(MD);
1973 VN.setDomTree(DT);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001974
Chris Lattnerff36c952009-09-21 02:42:51 +00001975 bool Changed = false;
1976 bool ShouldContinue = true;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001977
Owen Anderson26ed2572008-07-16 17:52:31 +00001978 // Merge unconditional branches, allowing PRE to catch more
1979 // optimization opportunities.
1980 for (Function::iterator FI = F.begin(), FE = F.end(); FI != FE; ) {
Chris Lattnerff36c952009-09-21 02:42:51 +00001981 BasicBlock *BB = FI;
Owen Anderson26ed2572008-07-16 17:52:31 +00001982 ++FI;
Owen Andersonf59eef82008-07-17 00:01:40 +00001983 bool removedBlock = MergeBlockIntoPredecessor(BB, this);
1984 if (removedBlock) NumGVNBlocks++;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001985
Chris Lattnerff36c952009-09-21 02:42:51 +00001986 Changed |= removedBlock;
Owen Anderson26ed2572008-07-16 17:52:31 +00001987 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001988
Chris Lattner4bab29b2008-12-09 19:21:47 +00001989 unsigned Iteration = 0;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001990
Chris Lattnerff36c952009-09-21 02:42:51 +00001991 while (ShouldContinue) {
Dan Gohman0be10b02009-07-25 01:43:01 +00001992 DEBUG(errs() << "GVN iteration: " << Iteration << "\n");
Chris Lattnerff36c952009-09-21 02:42:51 +00001993 ShouldContinue = iterateOnFunction(F);
1994 Changed |= ShouldContinue;
Chris Lattner4bab29b2008-12-09 19:21:47 +00001995 ++Iteration;
Owen Andersonbe168b32007-08-14 18:04:11 +00001996 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00001997
Owen Anderson916f4732008-07-18 18:03:38 +00001998 if (EnablePRE) {
Owen Anderson9c935902008-09-03 23:06:07 +00001999 bool PREChanged = true;
2000 while (PREChanged) {
2001 PREChanged = performPRE(F);
Chris Lattnerff36c952009-09-21 02:42:51 +00002002 Changed |= PREChanged;
Owen Anderson9c935902008-09-03 23:06:07 +00002003 }
Owen Anderson916f4732008-07-18 18:03:38 +00002004 }
Chris Lattner4bab29b2008-12-09 19:21:47 +00002005 // FIXME: Should perform GVN again after PRE does something. PRE can move
2006 // computations into blocks where they become fully redundant. Note that
2007 // we can't do this until PRE's critical edge splitting updates memdep.
2008 // Actually, when this happens, we should just fully integrate PRE into GVN.
Nuno Lopes274474b2008-10-10 16:25:50 +00002009
2010 cleanupGlobalSets();
2011
Chris Lattnerff36c952009-09-21 02:42:51 +00002012 return Changed;
Owen Andersonbe168b32007-08-14 18:04:11 +00002013}
2014
2015
Chris Lattnerff36c952009-09-21 02:42:51 +00002016bool GVN::processBlock(BasicBlock *BB) {
Chris Lattner4bab29b2008-12-09 19:21:47 +00002017 // FIXME: Kill off toErase by doing erasing eagerly in a helper function (and
2018 // incrementing BI before processing an instruction).
Owen Anderson9334fc62008-06-12 19:25:32 +00002019 SmallVector<Instruction*, 8> toErase;
Chris Lattnerff36c952009-09-21 02:42:51 +00002020 bool ChangedFunction = false;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002021
Owen Anderson9334fc62008-06-12 19:25:32 +00002022 for (BasicBlock::iterator BI = BB->begin(), BE = BB->end();
2023 BI != BE;) {
Chris Lattnerff36c952009-09-21 02:42:51 +00002024 ChangedFunction |= processInstruction(BI, toErase);
Owen Anderson9334fc62008-06-12 19:25:32 +00002025 if (toErase.empty()) {
2026 ++BI;
2027 continue;
2028 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002029
Owen Anderson9334fc62008-06-12 19:25:32 +00002030 // If we need some instructions deleted, do it now.
2031 NumGVNInstr += toErase.size();
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002032
Owen Anderson9334fc62008-06-12 19:25:32 +00002033 // Avoid iterator invalidation.
2034 bool AtStart = BI == BB->begin();
2035 if (!AtStart)
2036 --BI;
2037
2038 for (SmallVector<Instruction*, 4>::iterator I = toErase.begin(),
Chris Lattner02ca4422008-12-01 00:40:32 +00002039 E = toErase.end(); I != E; ++I) {
Dan Gohman7e124382009-07-31 20:24:18 +00002040 DEBUG(errs() << "GVN removed: " << **I << '\n');
Dan Gohmanc8d26652009-11-14 02:27:51 +00002041 if (MD) MD->removeInstruction(*I);
Owen Anderson9334fc62008-06-12 19:25:32 +00002042 (*I)->eraseFromParent();
Bill Wendling84049422008-12-22 21:57:30 +00002043 DEBUG(verifyRemoved(*I));
Chris Lattner02ca4422008-12-01 00:40:32 +00002044 }
Chris Lattner4bab29b2008-12-09 19:21:47 +00002045 toErase.clear();
Owen Anderson9334fc62008-06-12 19:25:32 +00002046
2047 if (AtStart)
2048 BI = BB->begin();
2049 else
2050 ++BI;
Owen Anderson9334fc62008-06-12 19:25:32 +00002051 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002052
Chris Lattnerff36c952009-09-21 02:42:51 +00002053 return ChangedFunction;
Owen Anderson9334fc62008-06-12 19:25:32 +00002054}
2055
Owen Andersone6b4ff82008-06-18 21:41:49 +00002056/// performPRE - Perform a purely local form of PRE that looks for diamond
2057/// control flow patterns and attempts to perform simple PRE at the join point.
Chris Lattner4790cb42009-10-31 22:11:15 +00002058bool GVN::performPRE(Function &F) {
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002059 bool Changed = false;
Owen Andersonec747c42008-06-19 19:54:19 +00002060 SmallVector<std::pair<TerminatorInst*, unsigned>, 4> toSplit;
Chris Lattner3304b562008-12-01 07:29:03 +00002061 DenseMap<BasicBlock*, Value*> predMap;
Owen Andersone6b4ff82008-06-18 21:41:49 +00002062 for (df_iterator<BasicBlock*> DI = df_begin(&F.getEntryBlock()),
2063 DE = df_end(&F.getEntryBlock()); DI != DE; ++DI) {
Chris Lattnerff36c952009-09-21 02:42:51 +00002064 BasicBlock *CurrentBlock = *DI;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002065
Owen Andersone6b4ff82008-06-18 21:41:49 +00002066 // Nothing to PRE in the entry block.
2067 if (CurrentBlock == &F.getEntryBlock()) continue;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002068
Owen Andersone6b4ff82008-06-18 21:41:49 +00002069 for (BasicBlock::iterator BI = CurrentBlock->begin(),
2070 BE = CurrentBlock->end(); BI != BE; ) {
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002071 Instruction *CurInst = BI++;
Duncan Sands2f500832009-05-06 06:49:50 +00002072
Victor Hernandezb1687302009-10-23 21:09:37 +00002073 if (isa<AllocaInst>(CurInst) ||
Victor Hernandez48c3c542009-09-18 22:35:49 +00002074 isa<TerminatorInst>(CurInst) || isa<PHINode>(CurInst) ||
Devang Patele9d08b82009-10-14 17:29:00 +00002075 CurInst->getType()->isVoidTy() ||
Duncan Sands2f500832009-05-06 06:49:50 +00002076 CurInst->mayReadFromMemory() || CurInst->mayHaveSideEffects() ||
John Criswell6e0aa282009-03-10 15:04:53 +00002077 isa<DbgInfoIntrinsic>(CurInst))
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002078 continue;
Duncan Sands2f500832009-05-06 06:49:50 +00002079
Chris Lattnerff36c952009-09-21 02:42:51 +00002080 uint32_t ValNo = VN.lookup(CurInst);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002081
Owen Andersone6b4ff82008-06-18 21:41:49 +00002082 // Look for the predecessors for PRE opportunities. We're
2083 // only trying to solve the basic diamond case, where
2084 // a value is computed in the successor and one predecessor,
2085 // but not the other. We also explicitly disallow cases
2086 // where the successor is its own predecessor, because they're
2087 // more complicated to get right.
Chris Lattnerff36c952009-09-21 02:42:51 +00002088 unsigned NumWith = 0;
2089 unsigned NumWithout = 0;
2090 BasicBlock *PREPred = 0;
Chris Lattner3304b562008-12-01 07:29:03 +00002091 predMap.clear();
2092
Owen Andersone6b4ff82008-06-18 21:41:49 +00002093 for (pred_iterator PI = pred_begin(CurrentBlock),
2094 PE = pred_end(CurrentBlock); PI != PE; ++PI) {
2095 // We're not interested in PRE where the block is its
Owen Anderson2a412722008-06-20 01:15:47 +00002096 // own predecessor, on in blocks with predecessors
2097 // that are not reachable.
2098 if (*PI == CurrentBlock) {
Chris Lattnerff36c952009-09-21 02:42:51 +00002099 NumWithout = 2;
Owen Anderson2a412722008-06-20 01:15:47 +00002100 break;
2101 } else if (!localAvail.count(*PI)) {
Chris Lattnerff36c952009-09-21 02:42:51 +00002102 NumWithout = 2;
Owen Anderson2a412722008-06-20 01:15:47 +00002103 break;
2104 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002105
2106 DenseMap<uint32_t, Value*>::iterator predV =
Chris Lattnerff36c952009-09-21 02:42:51 +00002107 localAvail[*PI]->table.find(ValNo);
Owen Anderson2a412722008-06-20 01:15:47 +00002108 if (predV == localAvail[*PI]->table.end()) {
Owen Andersone6b4ff82008-06-18 21:41:49 +00002109 PREPred = *PI;
Chris Lattnerff36c952009-09-21 02:42:51 +00002110 NumWithout++;
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002111 } else if (predV->second == CurInst) {
Chris Lattnerff36c952009-09-21 02:42:51 +00002112 NumWithout = 2;
Owen Andersone6b4ff82008-06-18 21:41:49 +00002113 } else {
Owen Anderson2a412722008-06-20 01:15:47 +00002114 predMap[*PI] = predV->second;
Chris Lattnerff36c952009-09-21 02:42:51 +00002115 NumWith++;
Owen Andersone6b4ff82008-06-18 21:41:49 +00002116 }
2117 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002118
Owen Andersone6b4ff82008-06-18 21:41:49 +00002119 // Don't do PRE when it might increase code size, i.e. when
2120 // we would need to insert instructions in more than one pred.
Chris Lattnerff36c952009-09-21 02:42:51 +00002121 if (NumWithout != 1 || NumWith == 0)
Owen Andersone6b4ff82008-06-18 21:41:49 +00002122 continue;
Chris Lattner4790cb42009-10-31 22:11:15 +00002123
2124 // Don't do PRE across indirect branch.
2125 if (isa<IndirectBrInst>(PREPred->getTerminator()))
2126 continue;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002127
Owen Andersonec747c42008-06-19 19:54:19 +00002128 // We can't do PRE safely on a critical edge, so instead we schedule
2129 // the edge to be split and perform the PRE the next time we iterate
2130 // on the function.
Chris Lattnerff36c952009-09-21 02:42:51 +00002131 unsigned SuccNum = 0;
Owen Andersonec747c42008-06-19 19:54:19 +00002132 for (unsigned i = 0, e = PREPred->getTerminator()->getNumSuccessors();
2133 i != e; ++i)
Owen Anderson9c935902008-09-03 23:06:07 +00002134 if (PREPred->getTerminator()->getSuccessor(i) == CurrentBlock) {
Chris Lattnerff36c952009-09-21 02:42:51 +00002135 SuccNum = i;
Owen Andersonec747c42008-06-19 19:54:19 +00002136 break;
2137 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002138
Chris Lattnerff36c952009-09-21 02:42:51 +00002139 if (isCriticalEdge(PREPred->getTerminator(), SuccNum)) {
2140 toSplit.push_back(std::make_pair(PREPred->getTerminator(), SuccNum));
Owen Andersonec747c42008-06-19 19:54:19 +00002141 continue;
2142 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002143
Owen Andersone6b4ff82008-06-18 21:41:49 +00002144 // Instantiate the expression the in predecessor that lacked it.
2145 // Because we are going top-down through the block, all value numbers
2146 // will be available in the predecessor by the time we need them. Any
2147 // that weren't original present will have been instantiated earlier
2148 // in this loop.
Nick Lewyckyc94270c2009-09-27 07:38:41 +00002149 Instruction *PREInstr = CurInst->clone();
Owen Andersone6b4ff82008-06-18 21:41:49 +00002150 bool success = true;
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002151 for (unsigned i = 0, e = CurInst->getNumOperands(); i != e; ++i) {
2152 Value *Op = PREInstr->getOperand(i);
2153 if (isa<Argument>(Op) || isa<Constant>(Op) || isa<GlobalValue>(Op))
2154 continue;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002155
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002156 if (Value *V = lookupNumber(PREPred, VN.lookup(Op))) {
2157 PREInstr->setOperand(i, V);
2158 } else {
2159 success = false;
2160 break;
Owen Anderson14c612f2008-07-11 20:05:13 +00002161 }
Owen Andersone6b4ff82008-06-18 21:41:49 +00002162 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002163
Owen Andersone6b4ff82008-06-18 21:41:49 +00002164 // Fail out if we encounter an operand that is not available in
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002165 // the PRE predecessor. This is typically because of loads which
Owen Andersone6b4ff82008-06-18 21:41:49 +00002166 // are not value numbered precisely.
2167 if (!success) {
2168 delete PREInstr;
Bill Wendling3858cae2008-12-22 22:14:07 +00002169 DEBUG(verifyRemoved(PREInstr));
Owen Andersone6b4ff82008-06-18 21:41:49 +00002170 continue;
2171 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002172
Owen Andersone6b4ff82008-06-18 21:41:49 +00002173 PREInstr->insertBefore(PREPred->getTerminator());
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002174 PREInstr->setName(CurInst->getName() + ".pre");
Owen Anderson2a412722008-06-20 01:15:47 +00002175 predMap[PREPred] = PREInstr;
Chris Lattnerff36c952009-09-21 02:42:51 +00002176 VN.add(PREInstr, ValNo);
Owen Andersone6b4ff82008-06-18 21:41:49 +00002177 NumGVNPRE++;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002178
Owen Andersone6b4ff82008-06-18 21:41:49 +00002179 // Update the availability map to include the new instruction.
Chris Lattnerff36c952009-09-21 02:42:51 +00002180 localAvail[PREPred]->table.insert(std::make_pair(ValNo, PREInstr));
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002181
Owen Andersone6b4ff82008-06-18 21:41:49 +00002182 // Create a PHI to make the value available in this block.
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002183 PHINode* Phi = PHINode::Create(CurInst->getType(),
2184 CurInst->getName() + ".pre-phi",
Owen Andersone6b4ff82008-06-18 21:41:49 +00002185 CurrentBlock->begin());
2186 for (pred_iterator PI = pred_begin(CurrentBlock),
2187 PE = pred_end(CurrentBlock); PI != PE; ++PI)
Owen Anderson2a412722008-06-20 01:15:47 +00002188 Phi->addIncoming(predMap[*PI], *PI);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002189
Chris Lattnerff36c952009-09-21 02:42:51 +00002190 VN.add(Phi, ValNo);
2191 localAvail[CurrentBlock]->table[ValNo] = Phi;
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002192
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002193 CurInst->replaceAllUsesWith(Phi);
Dan Gohmanc8d26652009-11-14 02:27:51 +00002194 if (MD && isa<PointerType>(Phi->getType()))
Chris Lattnerf81b0142008-12-09 22:06:23 +00002195 MD->invalidateCachedPointerInfo(Phi);
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002196 VN.erase(CurInst);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002197
Dan Gohman7e124382009-07-31 20:24:18 +00002198 DEBUG(errs() << "GVN PRE removed: " << *CurInst << '\n');
Dan Gohmanc8d26652009-11-14 02:27:51 +00002199 if (MD) MD->removeInstruction(CurInst);
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002200 CurInst->eraseFromParent();
Bill Wendling84049422008-12-22 21:57:30 +00002201 DEBUG(verifyRemoved(CurInst));
Chris Lattner66a3a3e2008-12-01 07:35:54 +00002202 Changed = true;
Owen Andersone6b4ff82008-06-18 21:41:49 +00002203 }
2204 }
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002205
Owen Andersonec747c42008-06-19 19:54:19 +00002206 for (SmallVector<std::pair<TerminatorInst*, unsigned>, 4>::iterator
Anton Korobeynikov2e8710c2008-12-05 19:38:49 +00002207 I = toSplit.begin(), E = toSplit.end(); I != E; ++I)
Owen Andersonec747c42008-06-19 19:54:19 +00002208 SplitCriticalEdge(I->first, I->second, this);
Daniel Dunbar3be44e62009-09-20 02:20:51 +00002209
Anton Korobeynikov2e8710c2008-12-05 19:38:49 +00002210 return Changed || toSplit.size();
Owen Andersone6b4ff82008-06-18 21:41:49 +00002211}
2212
Bill Wendling42f17f62008-12-22 22:32:22 +00002213/// iterateOnFunction - Executes one iteration of GVN
Owen Andersonbe168b32007-08-14 18:04:11 +00002214bool GVN::iterateOnFunction(Function &F) {
Nuno Lopes274474b2008-10-10 16:25:50 +00002215 cleanupGlobalSets();
Chris Lattner98054902008-03-21 21:33:23 +00002216
Owen Andersonef8bf0f2009-04-01 23:53:49 +00002217 for (df_iterator<DomTreeNode*> DI = df_begin(DT->getRootNode()),
2218 DE = df_end(DT->getRootNode()); DI != DE; ++DI) {
2219 if (DI->getIDom())
2220 localAvail[DI->getBlock()] =
2221 new ValueNumberScope(localAvail[DI->getIDom()->getBlock()]);
2222 else
2223 localAvail[DI->getBlock()] = new ValueNumberScope(0);
2224 }
2225
Owen Anderson85c40642007-07-24 17:55:58 +00002226 // Top-down walk of the dominator tree
Chris Lattnerff36c952009-09-21 02:42:51 +00002227 bool Changed = false;
Owen Andersonef136f52008-12-15 03:52:17 +00002228#if 0
2229 // Needed for value numbering with phi construction to work.
Owen Andersona03e7862008-12-15 02:03:00 +00002230 ReversePostOrderTraversal<Function*> RPOT(&F);
2231 for (ReversePostOrderTraversal<Function*>::rpo_iterator RI = RPOT.begin(),
2232 RE = RPOT.end(); RI != RE; ++RI)
Chris Lattnerff36c952009-09-21 02:42:51 +00002233 Changed |= processBlock(*RI);
Owen Andersonef136f52008-12-15 03:52:17 +00002234#else
2235 for (df_iterator<DomTreeNode*> DI = df_begin(DT->getRootNode()),
2236 DE = df_end(DT->getRootNode()); DI != DE; ++DI)
Chris Lattnerff36c952009-09-21 02:42:51 +00002237 Changed |= processBlock(DI->getBlock());
Owen Andersonef136f52008-12-15 03:52:17 +00002238#endif
2239
Chris Lattnerff36c952009-09-21 02:42:51 +00002240 return Changed;
Owen Anderson85c40642007-07-24 17:55:58 +00002241}
Nuno Lopes274474b2008-10-10 16:25:50 +00002242
2243void GVN::cleanupGlobalSets() {
2244 VN.clear();
Nuno Lopes274474b2008-10-10 16:25:50 +00002245
2246 for (DenseMap<BasicBlock*, ValueNumberScope*>::iterator
2247 I = localAvail.begin(), E = localAvail.end(); I != E; ++I)
2248 delete I->second;
2249 localAvail.clear();
2250}
Bill Wendling2a023742008-12-22 21:36:08 +00002251
2252/// verifyRemoved - Verify that the specified instruction does not occur in our
2253/// internal data structures.
Bill Wendlingf9c0e9e2008-12-22 22:28:56 +00002254void GVN::verifyRemoved(const Instruction *Inst) const {
2255 VN.verifyRemoved(Inst);
Bill Wendling3858cae2008-12-22 22:14:07 +00002256
Bill Wendlingf9c0e9e2008-12-22 22:28:56 +00002257 // Walk through the value number scope to make sure the instruction isn't
2258 // ferreted away in it.
Jeffrey Yasskin8154d2e2009-11-10 01:02:17 +00002259 for (DenseMap<BasicBlock*, ValueNumberScope*>::const_iterator
Bill Wendlingf9c0e9e2008-12-22 22:28:56 +00002260 I = localAvail.begin(), E = localAvail.end(); I != E; ++I) {
2261 const ValueNumberScope *VNS = I->second;
2262
2263 while (VNS) {
Jeffrey Yasskin8154d2e2009-11-10 01:02:17 +00002264 for (DenseMap<uint32_t, Value*>::const_iterator
Bill Wendlingf9c0e9e2008-12-22 22:28:56 +00002265 II = VNS->table.begin(), IE = VNS->table.end(); II != IE; ++II) {
2266 assert(II->second != Inst && "Inst still in value numbering scope!");
2267 }
2268
2269 VNS = VNS->parent;
Bill Wendling3858cae2008-12-22 22:14:07 +00002270 }
2271 }
Bill Wendling2a023742008-12-22 21:36:08 +00002272}