blob: c0738a951c4b6408cdcda6233a6ccbd18d941a3b [file] [log] [blame]
Owen Andersone3590582007-08-02 18:11:11 +00001//===- DeadStoreElimination.cpp - Fast Dead Store Elimination -------------===//
Owen Anderson5e72db32007-07-11 00:46:18 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Owen Anderson5e72db32007-07-11 00:46:18 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements a trivial dead store elimination that only considers
11// basic-block local redundant stores.
12//
13// FIXME: This should eventually be extended to be a post-dominator tree
14// traversal. Doing so would be pretty trivial.
15//
16//===----------------------------------------------------------------------===//
17
Owen Anderson10e52ed2007-08-01 06:36:51 +000018#define DEBUG_TYPE "dse"
Owen Anderson5e72db32007-07-11 00:46:18 +000019#include "llvm/Transforms/Scalar.h"
Owen Anderson32c4a052007-07-12 21:41:30 +000020#include "llvm/Constants.h"
Owen Anderson5e72db32007-07-11 00:46:18 +000021#include "llvm/Function.h"
Chris Lattner903add82010-11-30 23:43:23 +000022#include "llvm/GlobalVariable.h"
Owen Anderson5e72db32007-07-11 00:46:18 +000023#include "llvm/Instructions.h"
Owen Anderson48d37802008-01-29 06:18:36 +000024#include "llvm/IntrinsicInst.h"
Owen Anderson5e72db32007-07-11 00:46:18 +000025#include "llvm/Pass.h"
Owen Andersonaa071722007-07-11 23:19:17 +000026#include "llvm/Analysis/AliasAnalysis.h"
Nick Lewycky32f80512011-10-22 21:59:35 +000027#include "llvm/Analysis/CaptureTracking.h"
Owen Anderson3f338972008-07-28 16:14:26 +000028#include "llvm/Analysis/Dominators.h"
Victor Hernandezf390e042009-10-27 20:05:49 +000029#include "llvm/Analysis/MemoryBuiltins.h"
Owen Anderson5e72db32007-07-11 00:46:18 +000030#include "llvm/Analysis/MemoryDependenceAnalysis.h"
Chris Lattnerc0f33792010-11-30 23:05:20 +000031#include "llvm/Analysis/ValueTracking.h"
Owen Andersonaa071722007-07-11 23:19:17 +000032#include "llvm/Target/TargetData.h"
Owen Anderson5e72db32007-07-11 00:46:18 +000033#include "llvm/Transforms/Utils/Local.h"
Chris Lattnerca335e32010-12-06 21:13:51 +000034#include "llvm/Support/Debug.h"
35#include "llvm/ADT/SmallPtrSet.h"
36#include "llvm/ADT/Statistic.h"
Owen Anderson5e72db32007-07-11 00:46:18 +000037using namespace llvm;
38
39STATISTIC(NumFastStores, "Number of stores deleted");
40STATISTIC(NumFastOther , "Number of other instrs removed");
41
42namespace {
Chris Lattner2dd09db2009-09-02 06:11:42 +000043 struct DSE : public FunctionPass {
Chris Lattner51c28a92010-11-30 19:34:42 +000044 AliasAnalysis *AA;
45 MemoryDependenceAnalysis *MD;
46
Owen Anderson5e72db32007-07-11 00:46:18 +000047 static char ID; // Pass identification, replacement for typeid
Chris Lattner51c28a92010-11-30 19:34:42 +000048 DSE() : FunctionPass(ID), AA(0), MD(0) {
Owen Anderson6c18d1a2010-10-19 17:21:58 +000049 initializeDSEPass(*PassRegistry::getPassRegistry());
50 }
Owen Anderson5e72db32007-07-11 00:46:18 +000051
52 virtual bool runOnFunction(Function &F) {
Chris Lattner51c28a92010-11-30 19:34:42 +000053 AA = &getAnalysis<AliasAnalysis>();
54 MD = &getAnalysis<MemoryDependenceAnalysis>();
Chris Lattnerc053cbb2010-02-11 05:11:54 +000055 DominatorTree &DT = getAnalysis<DominatorTree>();
Owen Anderson58704ee2011-09-06 18:14:09 +000056
Chris Lattner51c28a92010-11-30 19:34:42 +000057 bool Changed = false;
Owen Anderson5e72db32007-07-11 00:46:18 +000058 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
Chris Lattnerc053cbb2010-02-11 05:11:54 +000059 // Only check non-dead blocks. Dead blocks may have strange pointer
60 // cycles that will confuse alias analysis.
61 if (DT.isReachableFromEntry(I))
62 Changed |= runOnBasicBlock(*I);
Owen Anderson58704ee2011-09-06 18:14:09 +000063
Chris Lattner51c28a92010-11-30 19:34:42 +000064 AA = 0; MD = 0;
Owen Anderson5e72db32007-07-11 00:46:18 +000065 return Changed;
66 }
Owen Anderson58704ee2011-09-06 18:14:09 +000067
Owen Anderson5e72db32007-07-11 00:46:18 +000068 bool runOnBasicBlock(BasicBlock &BB);
Chris Lattner9d179d92010-11-30 01:28:33 +000069 bool HandleFree(CallInst *F);
Chris Lattner1adb6752008-11-28 00:27:14 +000070 bool handleEndBlock(BasicBlock &BB);
Chris Lattner51d67ce2010-11-30 21:47:58 +000071 void RemoveAccessedObjects(const AliasAnalysis::Location &LoadedLoc,
72 SmallPtrSet<Value*, 16> &DeadStackObjects);
Owen Anderson5e72db32007-07-11 00:46:18 +000073
Owen Anderson5e72db32007-07-11 00:46:18 +000074 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
75 AU.setPreservesCFG();
Owen Anderson3f338972008-07-28 16:14:26 +000076 AU.addRequired<DominatorTree>();
Owen Andersonaa071722007-07-11 23:19:17 +000077 AU.addRequired<AliasAnalysis>();
Owen Anderson5e72db32007-07-11 00:46:18 +000078 AU.addRequired<MemoryDependenceAnalysis>();
Chris Lattner51c28a92010-11-30 19:34:42 +000079 AU.addPreserved<AliasAnalysis>();
Owen Anderson3f338972008-07-28 16:14:26 +000080 AU.addPreserved<DominatorTree>();
Owen Anderson5e72db32007-07-11 00:46:18 +000081 AU.addPreserved<MemoryDependenceAnalysis>();
82 }
83 };
Owen Anderson5e72db32007-07-11 00:46:18 +000084}
85
Dan Gohmand78c4002008-05-13 00:00:25 +000086char DSE::ID = 0;
Owen Anderson8ac477f2010-10-12 19:48:12 +000087INITIALIZE_PASS_BEGIN(DSE, "dse", "Dead Store Elimination", false, false)
88INITIALIZE_PASS_DEPENDENCY(DominatorTree)
89INITIALIZE_PASS_DEPENDENCY(MemoryDependenceAnalysis)
90INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
91INITIALIZE_PASS_END(DSE, "dse", "Dead Store Elimination", false, false)
Dan Gohmand78c4002008-05-13 00:00:25 +000092
Owen Anderson10e52ed2007-08-01 06:36:51 +000093FunctionPass *llvm::createDeadStoreEliminationPass() { return new DSE(); }
Owen Anderson5e72db32007-07-11 00:46:18 +000094
Chris Lattner67122512010-11-30 21:58:14 +000095//===----------------------------------------------------------------------===//
96// Helper functions
97//===----------------------------------------------------------------------===//
98
99/// DeleteDeadInstruction - Delete this instruction. Before we do, go through
100/// and zero out all the operands of this instruction. If any of them become
101/// dead, delete them and the computation tree that feeds them.
102///
103/// If ValueSet is non-null, remove any deleted instructions from it as well.
104///
105static void DeleteDeadInstruction(Instruction *I,
106 MemoryDependenceAnalysis &MD,
107 SmallPtrSet<Value*, 16> *ValueSet = 0) {
108 SmallVector<Instruction*, 32> NowDeadInsts;
Owen Anderson58704ee2011-09-06 18:14:09 +0000109
Chris Lattner67122512010-11-30 21:58:14 +0000110 NowDeadInsts.push_back(I);
111 --NumFastOther;
Owen Anderson58704ee2011-09-06 18:14:09 +0000112
Chris Lattner67122512010-11-30 21:58:14 +0000113 // Before we touch this instruction, remove it from memdep!
114 do {
115 Instruction *DeadInst = NowDeadInsts.pop_back_val();
116 ++NumFastOther;
Owen Anderson58704ee2011-09-06 18:14:09 +0000117
Chris Lattner67122512010-11-30 21:58:14 +0000118 // This instruction is dead, zap it, in stages. Start by removing it from
119 // MemDep, which needs to know the operands and needs it to be in the
120 // function.
121 MD.removeInstruction(DeadInst);
Owen Anderson58704ee2011-09-06 18:14:09 +0000122
Chris Lattner67122512010-11-30 21:58:14 +0000123 for (unsigned op = 0, e = DeadInst->getNumOperands(); op != e; ++op) {
124 Value *Op = DeadInst->getOperand(op);
125 DeadInst->setOperand(op, 0);
Owen Anderson58704ee2011-09-06 18:14:09 +0000126
Chris Lattner67122512010-11-30 21:58:14 +0000127 // If this operand just became dead, add it to the NowDeadInsts list.
128 if (!Op->use_empty()) continue;
Owen Anderson58704ee2011-09-06 18:14:09 +0000129
Chris Lattner67122512010-11-30 21:58:14 +0000130 if (Instruction *OpI = dyn_cast<Instruction>(Op))
131 if (isInstructionTriviallyDead(OpI))
132 NowDeadInsts.push_back(OpI);
133 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000134
Chris Lattner67122512010-11-30 21:58:14 +0000135 DeadInst->eraseFromParent();
Owen Anderson58704ee2011-09-06 18:14:09 +0000136
Chris Lattner67122512010-11-30 21:58:14 +0000137 if (ValueSet) ValueSet->erase(DeadInst);
138 } while (!NowDeadInsts.empty());
139}
140
141
Chris Lattner2227a8a2010-11-30 01:37:52 +0000142/// hasMemoryWrite - Does this instruction write some memory? This only returns
143/// true for things that we can analyze with other helpers below.
144static bool hasMemoryWrite(Instruction *I) {
Nick Lewycky90271472009-11-10 06:46:40 +0000145 if (isa<StoreInst>(I))
146 return true;
147 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
148 switch (II->getIntrinsicID()) {
Chris Lattner2764b4d2009-12-02 06:35:55 +0000149 default:
150 return false;
151 case Intrinsic::memset:
152 case Intrinsic::memmove:
153 case Intrinsic::memcpy:
154 case Intrinsic::init_trampoline:
155 case Intrinsic::lifetime_end:
156 return true;
Nick Lewycky90271472009-11-10 06:46:40 +0000157 }
158 }
159 return false;
160}
161
Chris Lattner58b779e2010-11-30 07:23:21 +0000162/// getLocForWrite - Return a Location stored to by the specified instruction.
Eli Friedman72a93e52011-09-13 01:28:59 +0000163/// If isRemovable returns true, this function and getLocForRead completely
164/// describe the memory operations for this instruction.
Chris Lattner58b779e2010-11-30 07:23:21 +0000165static AliasAnalysis::Location
166getLocForWrite(Instruction *Inst, AliasAnalysis &AA) {
167 if (StoreInst *SI = dyn_cast<StoreInst>(Inst))
168 return AA.getLocation(SI);
Owen Anderson58704ee2011-09-06 18:14:09 +0000169
Chris Lattner58b779e2010-11-30 07:23:21 +0000170 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(Inst)) {
171 // memcpy/memmove/memset.
172 AliasAnalysis::Location Loc = AA.getLocationForDest(MI);
173 // If we don't have target data around, an unknown size in Location means
174 // that we should use the size of the pointee type. This isn't valid for
175 // memset/memcpy, which writes more than an i8.
176 if (Loc.Size == AliasAnalysis::UnknownSize && AA.getTargetData() == 0)
177 return AliasAnalysis::Location();
178 return Loc;
179 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000180
Chris Lattner58b779e2010-11-30 07:23:21 +0000181 IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst);
182 if (II == 0) return AliasAnalysis::Location();
Owen Anderson58704ee2011-09-06 18:14:09 +0000183
Chris Lattner58b779e2010-11-30 07:23:21 +0000184 switch (II->getIntrinsicID()) {
185 default: return AliasAnalysis::Location(); // Unhandled intrinsic.
186 case Intrinsic::init_trampoline:
187 // If we don't have target data around, an unknown size in Location means
188 // that we should use the size of the pointee type. This isn't valid for
189 // init.trampoline, which writes more than an i8.
190 if (AA.getTargetData() == 0) return AliasAnalysis::Location();
Owen Anderson58704ee2011-09-06 18:14:09 +0000191
Chris Lattner58b779e2010-11-30 07:23:21 +0000192 // FIXME: We don't know the size of the trampoline, so we can't really
193 // handle it here.
194 return AliasAnalysis::Location(II->getArgOperand(0));
195 case Intrinsic::lifetime_end: {
196 uint64_t Len = cast<ConstantInt>(II->getArgOperand(0))->getZExtValue();
197 return AliasAnalysis::Location(II->getArgOperand(1), Len);
198 }
199 }
200}
201
Chris Lattner94fbdf32010-12-06 01:48:06 +0000202/// getLocForRead - Return the location read by the specified "hasMemoryWrite"
203/// instruction if any.
Owen Anderson58704ee2011-09-06 18:14:09 +0000204static AliasAnalysis::Location
Chris Lattner94fbdf32010-12-06 01:48:06 +0000205getLocForRead(Instruction *Inst, AliasAnalysis &AA) {
206 assert(hasMemoryWrite(Inst) && "Unknown instruction case");
Owen Anderson58704ee2011-09-06 18:14:09 +0000207
Chris Lattner94fbdf32010-12-06 01:48:06 +0000208 // The only instructions that both read and write are the mem transfer
209 // instructions (memcpy/memmove).
210 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(Inst))
211 return AA.getLocationForSource(MTI);
212 return AliasAnalysis::Location();
213}
214
215
Chris Lattner3590ef82010-11-30 05:30:45 +0000216/// isRemovable - If the value of this instruction and the memory it writes to
217/// is unused, may we delete this instruction?
218static bool isRemovable(Instruction *I) {
Eli Friedman9a468152011-08-17 22:22:24 +0000219 // Don't remove volatile/atomic stores.
Nick Lewycky90271472009-11-10 06:46:40 +0000220 if (StoreInst *SI = dyn_cast<StoreInst>(I))
Eli Friedman9a468152011-08-17 22:22:24 +0000221 return SI->isUnordered();
Owen Anderson58704ee2011-09-06 18:14:09 +0000222
Chris Lattnerb63ba732010-11-30 19:12:10 +0000223 IntrinsicInst *II = cast<IntrinsicInst>(I);
224 switch (II->getIntrinsicID()) {
225 default: assert(0 && "doesn't pass 'hasMemoryWrite' predicate");
226 case Intrinsic::lifetime_end:
227 // Never remove dead lifetime_end's, e.g. because it is followed by a
228 // free.
229 return false;
230 case Intrinsic::init_trampoline:
231 // Always safe to remove init_trampoline.
232 return true;
Owen Anderson58704ee2011-09-06 18:14:09 +0000233
Chris Lattnerb63ba732010-11-30 19:12:10 +0000234 case Intrinsic::memset:
235 case Intrinsic::memmove:
236 case Intrinsic::memcpy:
237 // Don't remove volatile memory intrinsics.
238 return !cast<MemIntrinsic>(II)->isVolatile();
239 }
Nick Lewycky90271472009-11-10 06:46:40 +0000240}
241
Chris Lattner67122512010-11-30 21:58:14 +0000242/// getStoredPointerOperand - Return the pointer that is being written to.
243static Value *getStoredPointerOperand(Instruction *I) {
Nick Lewycky90271472009-11-10 06:46:40 +0000244 if (StoreInst *SI = dyn_cast<StoreInst>(I))
245 return SI->getPointerOperand();
246 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(I))
Chris Lattner67122512010-11-30 21:58:14 +0000247 return MI->getDest();
Gabor Greif91f95892010-06-24 12:03:56 +0000248
249 IntrinsicInst *II = cast<IntrinsicInst>(I);
250 switch (II->getIntrinsicID()) {
Chris Lattner2764b4d2009-12-02 06:35:55 +0000251 default: assert(false && "Unexpected intrinsic!");
252 case Intrinsic::init_trampoline:
Gabor Greif91f95892010-06-24 12:03:56 +0000253 return II->getArgOperand(0);
Duncan Sands1925d3a2009-11-10 13:49:50 +0000254 }
Nick Lewycky90271472009-11-10 06:46:40 +0000255}
256
Chris Lattner51c28a92010-11-30 19:34:42 +0000257static uint64_t getPointerSize(Value *V, AliasAnalysis &AA) {
258 const TargetData *TD = AA.getTargetData();
Nick Lewycky32f80512011-10-22 21:59:35 +0000259
260 if (CallInst *CI = dyn_cast<CallInst>(V)) {
261 assert(isMalloc(CI) && "Expected Malloc call!");
262 if (ConstantInt *C = dyn_cast<ConstantInt>(CI->getArgOperand(0)))
263 return C->getZExtValue();
264 return AliasAnalysis::UnknownSize;
265 }
266
Chris Lattner51c28a92010-11-30 19:34:42 +0000267 if (TD == 0)
268 return AliasAnalysis::UnknownSize;
Owen Anderson58704ee2011-09-06 18:14:09 +0000269
Chris Lattner51c28a92010-11-30 19:34:42 +0000270 if (AllocaInst *A = dyn_cast<AllocaInst>(V)) {
271 // Get size information for the alloca
272 if (ConstantInt *C = dyn_cast<ConstantInt>(A->getArraySize()))
273 return C->getZExtValue() * TD->getTypeAllocSize(A->getAllocatedType());
274 return AliasAnalysis::UnknownSize;
275 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000276
Nick Lewycky32f80512011-10-22 21:59:35 +0000277 assert(isa<Argument>(V) && "Expected AllocaInst, malloc call or Argument!");
Chris Lattner229907c2011-07-18 04:54:35 +0000278 PointerType *PT = cast<PointerType>(V->getType());
Chris Lattner51c28a92010-11-30 19:34:42 +0000279 return TD->getTypeAllocSize(PT->getElementType());
280}
281
Chris Lattner903add82010-11-30 23:43:23 +0000282/// isObjectPointerWithTrustworthySize - Return true if the specified Value* is
283/// pointing to an object with a pointer size we can trust.
284static bool isObjectPointerWithTrustworthySize(const Value *V) {
285 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
286 return !AI->isArrayAllocation();
287 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
Chris Lattner4dc53e32010-12-06 21:48:10 +0000288 return !GV->mayBeOverridden();
Chris Lattner903add82010-11-30 23:43:23 +0000289 if (const Argument *A = dyn_cast<Argument>(V))
290 return A->hasByValAttr();
Nick Lewycky32f80512011-10-22 21:59:35 +0000291 if (isMalloc(V))
292 return true;
Chris Lattner903add82010-11-30 23:43:23 +0000293 return false;
294}
Chris Lattner51c28a92010-11-30 19:34:42 +0000295
Chris Lattner58b779e2010-11-30 07:23:21 +0000296/// isCompleteOverwrite - Return true if a store to the 'Later' location
297/// completely overwrites a store to the 'Earlier' location.
298static bool isCompleteOverwrite(const AliasAnalysis::Location &Later,
299 const AliasAnalysis::Location &Earlier,
Chris Lattner77d79fa2010-11-30 19:28:23 +0000300 AliasAnalysis &AA) {
Chris Lattnerc0f33792010-11-30 23:05:20 +0000301 const Value *P1 = Earlier.Ptr->stripPointerCasts();
302 const Value *P2 = Later.Ptr->stripPointerCasts();
Owen Anderson58704ee2011-09-06 18:14:09 +0000303
Chris Lattnerc0f33792010-11-30 23:05:20 +0000304 // If the start pointers are the same, we just have to compare sizes to see if
305 // the later store was larger than the earlier store.
306 if (P1 == P2) {
307 // If we don't know the sizes of either access, then we can't do a
308 // comparison.
309 if (Later.Size == AliasAnalysis::UnknownSize ||
310 Earlier.Size == AliasAnalysis::UnknownSize) {
311 // If we have no TargetData information around, then the size of the store
312 // is inferrable from the pointee type. If they are the same type, then
313 // we know that the store is safe.
314 if (AA.getTargetData() == 0)
315 return Later.Ptr->getType() == Earlier.Ptr->getType();
316 return false;
317 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000318
Chris Lattnerc0f33792010-11-30 23:05:20 +0000319 // Make sure that the Later size is >= the Earlier size.
320 if (Later.Size < Earlier.Size)
321 return false;
322 return true;
Chris Lattner77d79fa2010-11-30 19:28:23 +0000323 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000324
Chris Lattnerc0f33792010-11-30 23:05:20 +0000325 // Otherwise, we have to have size information, and the later store has to be
326 // larger than the earlier one.
327 if (Later.Size == AliasAnalysis::UnknownSize ||
328 Earlier.Size == AliasAnalysis::UnknownSize ||
Chris Lattner903add82010-11-30 23:43:23 +0000329 Later.Size <= Earlier.Size || AA.getTargetData() == 0)
Chris Lattner58b779e2010-11-30 07:23:21 +0000330 return false;
Owen Anderson58704ee2011-09-06 18:14:09 +0000331
Chris Lattner903add82010-11-30 23:43:23 +0000332 // Check to see if the later store is to the entire object (either a global,
333 // an alloca, or a byval argument). If so, then it clearly overwrites any
334 // other store to the same object.
Chris Lattnerc0f33792010-11-30 23:05:20 +0000335 const TargetData &TD = *AA.getTargetData();
Owen Anderson58704ee2011-09-06 18:14:09 +0000336
Dan Gohman0f124e12011-01-24 18:53:32 +0000337 const Value *UO1 = GetUnderlyingObject(P1, &TD),
338 *UO2 = GetUnderlyingObject(P2, &TD);
Owen Anderson58704ee2011-09-06 18:14:09 +0000339
Chris Lattner903add82010-11-30 23:43:23 +0000340 // If we can't resolve the same pointers to the same object, then we can't
341 // analyze them at all.
342 if (UO1 != UO2)
343 return false;
Owen Anderson58704ee2011-09-06 18:14:09 +0000344
Chris Lattner903add82010-11-30 23:43:23 +0000345 // If the "Later" store is to a recognizable object, get its size.
346 if (isObjectPointerWithTrustworthySize(UO2)) {
347 uint64_t ObjectSize =
348 TD.getTypeAllocSize(cast<PointerType>(UO2->getType())->getElementType());
349 if (ObjectSize == Later.Size)
350 return true;
351 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000352
Chris Lattnerc0f33792010-11-30 23:05:20 +0000353 // Okay, we have stores to two completely different pointers. Try to
354 // decompose the pointer into a "base + constant_offset" form. If the base
355 // pointers are equal, then we can reason about the two stores.
Bill Wendling19f33b92011-03-26 08:02:59 +0000356 int64_t EarlierOff = 0, LaterOff = 0;
357 const Value *BP1 = GetPointerBaseWithConstantOffset(P1, EarlierOff, TD);
358 const Value *BP2 = GetPointerBaseWithConstantOffset(P2, LaterOff, TD);
Owen Anderson58704ee2011-09-06 18:14:09 +0000359
Chris Lattnerc0f33792010-11-30 23:05:20 +0000360 // If the base pointers still differ, we have two completely different stores.
361 if (BP1 != BP2)
362 return false;
Bill Wendlingdb40b5c2011-03-26 01:20:37 +0000363
Bill Wendling19f33b92011-03-26 08:02:59 +0000364 // The later store completely overlaps the earlier store if:
Owen Anderson58704ee2011-09-06 18:14:09 +0000365 //
Bill Wendling19f33b92011-03-26 08:02:59 +0000366 // 1. Both start at the same offset and the later one's size is greater than
367 // or equal to the earlier one's, or
368 //
369 // |--earlier--|
370 // |-- later --|
Owen Anderson58704ee2011-09-06 18:14:09 +0000371 //
Bill Wendling19f33b92011-03-26 08:02:59 +0000372 // 2. The earlier store has an offset greater than the later offset, but which
373 // still lies completely within the later store.
374 //
375 // |--earlier--|
376 // |----- later ------|
Bill Wendling50341592011-03-30 21:37:19 +0000377 //
378 // We have to be careful here as *Off is signed while *.Size is unsigned.
Bill Wendlingb5139922011-03-26 09:32:07 +0000379 if (EarlierOff >= LaterOff &&
Bill Wendling50341592011-03-30 21:37:19 +0000380 uint64_t(EarlierOff - LaterOff) + Earlier.Size <= Later.Size)
Bill Wendling19f33b92011-03-26 08:02:59 +0000381 return true;
382
383 // Otherwise, they don't completely overlap.
384 return false;
Nick Lewycky90271472009-11-10 06:46:40 +0000385}
386
Chris Lattner94fbdf32010-12-06 01:48:06 +0000387/// isPossibleSelfRead - If 'Inst' might be a self read (i.e. a noop copy of a
388/// memory region into an identical pointer) then it doesn't actually make its
Owen Anderson58704ee2011-09-06 18:14:09 +0000389/// input dead in the traditional sense. Consider this case:
Chris Lattner94fbdf32010-12-06 01:48:06 +0000390///
391/// memcpy(A <- B)
392/// memcpy(A <- A)
393///
394/// In this case, the second store to A does not make the first store to A dead.
395/// The usual situation isn't an explicit A<-A store like this (which can be
396/// trivially removed) but a case where two pointers may alias.
397///
398/// This function detects when it is unsafe to remove a dependent instruction
399/// because the DSE inducing instruction may be a self-read.
400static bool isPossibleSelfRead(Instruction *Inst,
401 const AliasAnalysis::Location &InstStoreLoc,
402 Instruction *DepWrite, AliasAnalysis &AA) {
403 // Self reads can only happen for instructions that read memory. Get the
404 // location read.
405 AliasAnalysis::Location InstReadLoc = getLocForRead(Inst, AA);
406 if (InstReadLoc.Ptr == 0) return false; // Not a reading instruction.
Owen Anderson58704ee2011-09-06 18:14:09 +0000407
Chris Lattner94fbdf32010-12-06 01:48:06 +0000408 // If the read and written loc obviously don't alias, it isn't a read.
409 if (AA.isNoAlias(InstReadLoc, InstStoreLoc)) return false;
Owen Anderson58704ee2011-09-06 18:14:09 +0000410
Chris Lattner94fbdf32010-12-06 01:48:06 +0000411 // Okay, 'Inst' may copy over itself. However, we can still remove a the
412 // DepWrite instruction if we can prove that it reads from the same location
413 // as Inst. This handles useful cases like:
414 // memcpy(A <- B)
415 // memcpy(A <- B)
416 // Here we don't know if A/B may alias, but we do know that B/B are must
417 // aliases, so removing the first memcpy is safe (assuming it writes <= #
418 // bytes as the second one.
419 AliasAnalysis::Location DepReadLoc = getLocForRead(DepWrite, AA);
Owen Anderson58704ee2011-09-06 18:14:09 +0000420
Chris Lattner94fbdf32010-12-06 01:48:06 +0000421 if (DepReadLoc.Ptr && AA.isMustAlias(InstReadLoc.Ptr, DepReadLoc.Ptr))
422 return false;
Owen Anderson58704ee2011-09-06 18:14:09 +0000423
Chris Lattner94fbdf32010-12-06 01:48:06 +0000424 // If DepWrite doesn't read memory or if we can't prove it is a must alias,
425 // then it can't be considered dead.
426 return true;
427}
428
Chris Lattner67122512010-11-30 21:58:14 +0000429
430//===----------------------------------------------------------------------===//
431// DSE Pass
432//===----------------------------------------------------------------------===//
433
Owen Anderson10e52ed2007-08-01 06:36:51 +0000434bool DSE::runOnBasicBlock(BasicBlock &BB) {
Owen Anderson5e72db32007-07-11 00:46:18 +0000435 bool MadeChange = false;
Owen Anderson58704ee2011-09-06 18:14:09 +0000436
Chris Lattner49162672009-09-02 06:31:02 +0000437 // Do a top-down walk on the BB.
Chris Lattnerf2a8ba42008-11-28 21:29:52 +0000438 for (BasicBlock::iterator BBI = BB.begin(), BBE = BB.end(); BBI != BBE; ) {
439 Instruction *Inst = BBI++;
Owen Anderson58704ee2011-09-06 18:14:09 +0000440
Chris Lattner9d179d92010-11-30 01:28:33 +0000441 // Handle 'free' calls specially.
442 if (CallInst *F = isFreeCall(Inst)) {
443 MadeChange |= HandleFree(F);
444 continue;
445 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000446
Chris Lattner2227a8a2010-11-30 01:37:52 +0000447 // If we find something that writes memory, get its memory dependence.
448 if (!hasMemoryWrite(Inst))
Owen Anderson0aecf0e2007-08-08 04:52:29 +0000449 continue;
Chris Lattnerd4f10902010-11-30 00:01:19 +0000450
Chris Lattner51c28a92010-11-30 19:34:42 +0000451 MemDepResult InstDep = MD->getDependency(Inst);
Owen Anderson58704ee2011-09-06 18:14:09 +0000452
Eli Friedman7d58bc72011-06-15 00:47:34 +0000453 // Ignore any store where we can't find a local dependence.
Chris Lattner57e91ea2008-12-06 00:53:22 +0000454 // FIXME: cross-block DSE would be fun. :)
Eli Friedmanc1702c82011-10-13 22:14:57 +0000455 if (!InstDep.isDef() && !InstDep.isClobber())
Chris Lattner58b779e2010-11-30 07:23:21 +0000456 continue;
Owen Anderson58704ee2011-09-06 18:14:09 +0000457
Chris Lattner57e91ea2008-12-06 00:53:22 +0000458 // If we're storing the same value back to a pointer that we just
459 // loaded from, then the store can be removed.
Nick Lewycky90271472009-11-10 06:46:40 +0000460 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
461 if (LoadInst *DepLoad = dyn_cast<LoadInst>(InstDep.getInst())) {
462 if (SI->getPointerOperand() == DepLoad->getPointerOperand() &&
Eli Friedman9a468152011-08-17 22:22:24 +0000463 SI->getOperand(0) == DepLoad && isRemovable(SI)) {
Chris Lattnerca335e32010-12-06 21:13:51 +0000464 DEBUG(dbgs() << "DSE: Remove Store Of Load from same pointer:\n "
465 << "LOAD: " << *DepLoad << "\n STORE: " << *SI << '\n');
Owen Anderson58704ee2011-09-06 18:14:09 +0000466
Nick Lewycky90271472009-11-10 06:46:40 +0000467 // DeleteDeadInstruction can delete the current instruction. Save BBI
468 // in case we need it.
469 WeakVH NextInst(BBI);
Owen Anderson58704ee2011-09-06 18:14:09 +0000470
Chris Lattner67122512010-11-30 21:58:14 +0000471 DeleteDeadInstruction(SI, *MD);
Owen Anderson58704ee2011-09-06 18:14:09 +0000472
Nick Lewycky90271472009-11-10 06:46:40 +0000473 if (NextInst == 0) // Next instruction deleted.
474 BBI = BB.begin();
475 else if (BBI != BB.begin()) // Revisit this instruction if possible.
476 --BBI;
Dan Gohmand2d1ae12010-06-22 15:08:57 +0000477 ++NumFastStores;
Nick Lewycky90271472009-11-10 06:46:40 +0000478 MadeChange = true;
479 continue;
480 }
Chris Lattner0e3d6332008-12-05 21:04:20 +0000481 }
Owen Anderson5e72db32007-07-11 00:46:18 +0000482 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000483
Chris Lattner58b779e2010-11-30 07:23:21 +0000484 // Figure out what location is being stored to.
Chris Lattner51c28a92010-11-30 19:34:42 +0000485 AliasAnalysis::Location Loc = getLocForWrite(Inst, *AA);
Chris Lattner58b779e2010-11-30 07:23:21 +0000486
487 // If we didn't get a useful location, fail.
488 if (Loc.Ptr == 0)
489 continue;
Owen Anderson58704ee2011-09-06 18:14:09 +0000490
Eli Friedmanc1702c82011-10-13 22:14:57 +0000491 while (InstDep.isDef() || InstDep.isClobber()) {
Chris Lattner58b779e2010-11-30 07:23:21 +0000492 // Get the memory clobbered by the instruction we depend on. MemDep will
493 // skip any instructions that 'Loc' clearly doesn't interact with. If we
494 // end up depending on a may- or must-aliased load, then we can't optimize
495 // away the store and we bail out. However, if we depend on on something
496 // that overwrites the memory location we *can* potentially optimize it.
497 //
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000498 // Find out what memory location the dependent instruction stores.
Chris Lattner58b779e2010-11-30 07:23:21 +0000499 Instruction *DepWrite = InstDep.getInst();
Chris Lattner51c28a92010-11-30 19:34:42 +0000500 AliasAnalysis::Location DepLoc = getLocForWrite(DepWrite, *AA);
Chris Lattner58b779e2010-11-30 07:23:21 +0000501 // If we didn't get a useful location, or if it isn't a size, bail out.
502 if (DepLoc.Ptr == 0)
503 break;
504
Chris Lattner94fbdf32010-12-06 01:48:06 +0000505 // If we find a write that is a) removable (i.e., non-volatile), b) is
506 // completely obliterated by the store to 'Loc', and c) which we know that
507 // 'Inst' doesn't load from, then we can remove it.
508 if (isRemovable(DepWrite) && isCompleteOverwrite(Loc, DepLoc, *AA) &&
509 !isPossibleSelfRead(Inst, Loc, DepWrite, *AA)) {
Chris Lattnerca335e32010-12-06 21:13:51 +0000510 DEBUG(dbgs() << "DSE: Remove Dead Store:\n DEAD: "
511 << *DepWrite << "\n KILLER: " << *Inst << '\n');
Owen Anderson58704ee2011-09-06 18:14:09 +0000512
Chris Lattner58b779e2010-11-30 07:23:21 +0000513 // Delete the store and now-dead instructions that feed it.
Chris Lattner67122512010-11-30 21:58:14 +0000514 DeleteDeadInstruction(DepWrite, *MD);
Chris Lattner58b779e2010-11-30 07:23:21 +0000515 ++NumFastStores;
516 MadeChange = true;
Owen Anderson58704ee2011-09-06 18:14:09 +0000517
Chris Lattner58b779e2010-11-30 07:23:21 +0000518 // DeleteDeadInstruction can delete the current instruction in loop
519 // cases, reset BBI.
520 BBI = Inst;
521 if (BBI != BB.begin())
522 --BBI;
523 break;
524 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000525
Chris Lattnerd4f10902010-11-30 00:01:19 +0000526 // If this is a may-aliased store that is clobbering the store value, we
527 // can keep searching past it for another must-aliased pointer that stores
528 // to the same location. For example, in:
529 // store -> P
530 // store -> Q
531 // store -> P
532 // we can remove the first store to P even though we don't know if P and Q
533 // alias.
Chris Lattner58b779e2010-11-30 07:23:21 +0000534 if (DepWrite == &BB.front()) break;
Owen Anderson58704ee2011-09-06 18:14:09 +0000535
Chris Lattner58b779e2010-11-30 07:23:21 +0000536 // Can't look past this instruction if it might read 'Loc'.
Chris Lattner51c28a92010-11-30 19:34:42 +0000537 if (AA->getModRefInfo(DepWrite, Loc) & AliasAnalysis::Ref)
Chris Lattner58b779e2010-11-30 07:23:21 +0000538 break;
Owen Anderson58704ee2011-09-06 18:14:09 +0000539
Chris Lattner51c28a92010-11-30 19:34:42 +0000540 InstDep = MD->getPointerDependencyFrom(Loc, false, DepWrite, &BB);
Owen Anderson2b2bd282009-10-28 07:05:35 +0000541 }
Owen Anderson5e72db32007-07-11 00:46:18 +0000542 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000543
Chris Lattnerf2a8ba42008-11-28 21:29:52 +0000544 // If this block ends in a return, unwind, or unreachable, all allocas are
545 // dead at its end, which means stores to them are also dead.
Owen Anderson32c4a052007-07-12 21:41:30 +0000546 if (BB.getTerminator()->getNumSuccessors() == 0)
Chris Lattner1adb6752008-11-28 00:27:14 +0000547 MadeChange |= handleEndBlock(BB);
Owen Anderson58704ee2011-09-06 18:14:09 +0000548
Owen Anderson5e72db32007-07-11 00:46:18 +0000549 return MadeChange;
550}
551
Chris Lattner9d179d92010-11-30 01:28:33 +0000552/// HandleFree - Handle frees of entire structures whose dependency is a store
553/// to a field of that structure.
554bool DSE::HandleFree(CallInst *F) {
Eli Friedman7d58bc72011-06-15 00:47:34 +0000555 bool MadeChange = false;
556
Chris Lattner51c28a92010-11-30 19:34:42 +0000557 MemDepResult Dep = MD->getDependency(F);
Eli Friedman7d58bc72011-06-15 00:47:34 +0000558
Eli Friedmanc1702c82011-10-13 22:14:57 +0000559 while (Dep.isDef() || Dep.isClobber()) {
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000560 Instruction *Dependency = Dep.getInst();
Chris Lattner3590ef82010-11-30 05:30:45 +0000561 if (!hasMemoryWrite(Dependency) || !isRemovable(Dependency))
Eli Friedman7d58bc72011-06-15 00:47:34 +0000562 return MadeChange;
Owen Anderson58704ee2011-09-06 18:14:09 +0000563
Chris Lattner67122512010-11-30 21:58:14 +0000564 Value *DepPointer =
Dan Gohmana4fcd242010-12-15 20:02:24 +0000565 GetUnderlyingObject(getStoredPointerOperand(Dependency));
Duncan Sandsfe3bef02008-01-20 10:49:23 +0000566
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000567 // Check for aliasing.
Chris Lattner94fbdf32010-12-06 01:48:06 +0000568 if (!AA->isMustAlias(F->getArgOperand(0), DepPointer))
Eli Friedman7d58bc72011-06-15 00:47:34 +0000569 return MadeChange;
Owen Anderson58704ee2011-09-06 18:14:09 +0000570
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000571 // DCE instructions only used to calculate that store
Chris Lattner67122512010-11-30 21:58:14 +0000572 DeleteDeadInstruction(Dependency, *MD);
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000573 ++NumFastStores;
Eli Friedman7d58bc72011-06-15 00:47:34 +0000574 MadeChange = true;
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000575
576 // Inst's old Dependency is now deleted. Compute the next dependency,
577 // which may also be dead, as in
578 // s[0] = 0;
579 // s[1] = 0; // This has just been deleted.
580 // free(s);
Chris Lattner51c28a92010-11-30 19:34:42 +0000581 Dep = MD->getDependency(F);
Eli Friedman7d58bc72011-06-15 00:47:34 +0000582 };
Owen Anderson58704ee2011-09-06 18:14:09 +0000583
Eli Friedman7d58bc72011-06-15 00:47:34 +0000584 return MadeChange;
Owen Andersonaa071722007-07-11 23:19:17 +0000585}
586
Owen Andersone3590582007-08-02 18:11:11 +0000587/// handleEndBlock - Remove dead stores to stack-allocated locations in the
Owen Anderson52aaabf2007-08-08 17:50:09 +0000588/// function end block. Ex:
589/// %A = alloca i32
590/// ...
591/// store i32 1, i32* %A
592/// ret void
Chris Lattner1adb6752008-11-28 00:27:14 +0000593bool DSE::handleEndBlock(BasicBlock &BB) {
Owen Anderson32c4a052007-07-12 21:41:30 +0000594 bool MadeChange = false;
Owen Anderson58704ee2011-09-06 18:14:09 +0000595
Chris Lattner7fe08b62010-11-30 21:32:12 +0000596 // Keep track of all of the stack objects that are dead at the end of the
597 // function.
598 SmallPtrSet<Value*, 16> DeadStackObjects;
Owen Anderson58704ee2011-09-06 18:14:09 +0000599
Chris Lattner1adb6752008-11-28 00:27:14 +0000600 // Find all of the alloca'd pointers in the entry block.
Owen Anderson32c4a052007-07-12 21:41:30 +0000601 BasicBlock *Entry = BB.getParent()->begin();
Nick Lewycky32f80512011-10-22 21:59:35 +0000602 for (BasicBlock::iterator I = Entry->begin(), E = Entry->end(); I != E; ++I) {
Owen Anderson32c4a052007-07-12 21:41:30 +0000603 if (AllocaInst *AI = dyn_cast<AllocaInst>(I))
Chris Lattner7fe08b62010-11-30 21:32:12 +0000604 DeadStackObjects.insert(AI);
Owen Anderson58704ee2011-09-06 18:14:09 +0000605
Nick Lewycky32f80512011-10-22 21:59:35 +0000606 // Okay, so these are dead heap objects, but if the pointer never escapes
607 // then it's leaked by this function anyways.
608 if (CallInst *CI = extractMallocCall(I))
609 if (!PointerMayBeCaptured(CI, true, true))
610 DeadStackObjects.insert(CI);
611 }
612
Chris Lattner1adb6752008-11-28 00:27:14 +0000613 // Treat byval arguments the same, stores to them are dead at the end of the
614 // function.
Owen Anderson48d37802008-01-29 06:18:36 +0000615 for (Function::arg_iterator AI = BB.getParent()->arg_begin(),
616 AE = BB.getParent()->arg_end(); AI != AE; ++AI)
617 if (AI->hasByValAttr())
Chris Lattner7fe08b62010-11-30 21:32:12 +0000618 DeadStackObjects.insert(AI);
Owen Anderson58704ee2011-09-06 18:14:09 +0000619
Owen Anderson32c4a052007-07-12 21:41:30 +0000620 // Scan the basic block backwards
621 for (BasicBlock::iterator BBI = BB.end(); BBI != BB.begin(); ){
622 --BBI;
Owen Anderson58704ee2011-09-06 18:14:09 +0000623
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000624 // If we find a store, check to see if it points into a dead stack value.
625 if (hasMemoryWrite(BBI) && isRemovable(BBI)) {
626 // See through pointer-to-pointer bitcasts
Dan Gohmana4fcd242010-12-15 20:02:24 +0000627 Value *Pointer = GetUnderlyingObject(getStoredPointerOperand(BBI));
Duncan Sandsd65a4da2008-10-01 15:25:41 +0000628
Chris Lattner67122512010-11-30 21:58:14 +0000629 // Stores to stack values are valid candidates for removal.
Chris Lattner7fe08b62010-11-30 21:32:12 +0000630 if (DeadStackObjects.count(Pointer)) {
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000631 Instruction *Dead = BBI++;
Owen Anderson58704ee2011-09-06 18:14:09 +0000632
Chris Lattnerca335e32010-12-06 21:13:51 +0000633 DEBUG(dbgs() << "DSE: Dead Store at End of Block:\n DEAD: "
634 << *Dead << "\n Object: " << *Pointer << '\n');
Owen Anderson58704ee2011-09-06 18:14:09 +0000635
Chris Lattnerca335e32010-12-06 21:13:51 +0000636 // DCE instructions only used to calculate that store.
Chris Lattner67122512010-11-30 21:58:14 +0000637 DeleteDeadInstruction(Dead, *MD, &DeadStackObjects);
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000638 ++NumFastStores;
639 MadeChange = true;
Owen Andersone316e5b2011-08-30 21:11:06 +0000640 continue;
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000641 }
Owen Anderson52aaabf2007-08-08 17:50:09 +0000642 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000643
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000644 // Remove any dead non-memory-mutating instructions.
645 if (isInstructionTriviallyDead(BBI)) {
646 Instruction *Inst = BBI++;
Chris Lattner67122512010-11-30 21:58:14 +0000647 DeleteDeadInstruction(Inst, *MD, &DeadStackObjects);
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000648 ++NumFastOther;
649 MadeChange = true;
650 continue;
651 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000652
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000653 if (AllocaInst *A = dyn_cast<AllocaInst>(BBI)) {
Chris Lattner7fe08b62010-11-30 21:32:12 +0000654 DeadStackObjects.erase(A);
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000655 continue;
656 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000657
Nick Lewycky32f80512011-10-22 21:59:35 +0000658 if (CallInst *CI = extractMallocCall(BBI)) {
659 DeadStackObjects.erase(CI);
660 continue;
661 }
662
Chris Lattner127818d2010-11-30 21:18:46 +0000663 if (CallSite CS = cast<Value>(BBI)) {
664 // If this call does not access memory, it can't be loading any of our
665 // pointers.
666 if (AA->doesNotAccessMemory(CS))
667 continue;
Owen Anderson58704ee2011-09-06 18:14:09 +0000668
Chris Lattner127818d2010-11-30 21:18:46 +0000669 // If the call might load from any of our allocas, then any store above
670 // the call is live.
671 SmallVector<Value*, 8> LiveAllocas;
Chris Lattner7fe08b62010-11-30 21:32:12 +0000672 for (SmallPtrSet<Value*, 16>::iterator I = DeadStackObjects.begin(),
673 E = DeadStackObjects.end(); I != E; ++I) {
Chris Lattner127818d2010-11-30 21:18:46 +0000674 // See if the call site touches it.
Owen Anderson58704ee2011-09-06 18:14:09 +0000675 AliasAnalysis::ModRefResult A =
Chris Lattner127818d2010-11-30 21:18:46 +0000676 AA->getModRefInfo(CS, *I, getPointerSize(*I, *AA));
Owen Anderson58704ee2011-09-06 18:14:09 +0000677
Chris Lattner127818d2010-11-30 21:18:46 +0000678 if (A == AliasAnalysis::ModRef || A == AliasAnalysis::Ref)
679 LiveAllocas.push_back(*I);
680 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000681
Chris Lattner127818d2010-11-30 21:18:46 +0000682 for (SmallVector<Value*, 8>::iterator I = LiveAllocas.begin(),
683 E = LiveAllocas.end(); I != E; ++I)
Chris Lattner7fe08b62010-11-30 21:32:12 +0000684 DeadStackObjects.erase(*I);
Owen Anderson58704ee2011-09-06 18:14:09 +0000685
Chris Lattner127818d2010-11-30 21:18:46 +0000686 // If all of the allocas were clobbered by the call then we're not going
687 // to find anything else to process.
Chris Lattner7fe08b62010-11-30 21:32:12 +0000688 if (DeadStackObjects.empty())
Chris Lattner127818d2010-11-30 21:18:46 +0000689 return MadeChange;
Owen Anderson58704ee2011-09-06 18:14:09 +0000690
Chris Lattner127818d2010-11-30 21:18:46 +0000691 continue;
692 }
Eli Friedman89b694b2011-07-27 01:08:30 +0000693
Chris Lattner51d67ce2010-11-30 21:47:58 +0000694 AliasAnalysis::Location LoadedLoc;
Owen Anderson58704ee2011-09-06 18:14:09 +0000695
Owen Anderson32c4a052007-07-12 21:41:30 +0000696 // If we encounter a use of the pointer, it is no longer considered dead
Chris Lattner1adb6752008-11-28 00:27:14 +0000697 if (LoadInst *L = dyn_cast<LoadInst>(BBI)) {
Eli Friedman9a468152011-08-17 22:22:24 +0000698 if (!L->isUnordered()) // Be conservative with atomic/volatile load
699 break;
Chris Lattner51d67ce2010-11-30 21:47:58 +0000700 LoadedLoc = AA->getLocation(L);
Nick Lewycky475d3d12010-01-03 04:39:07 +0000701 } else if (VAArgInst *V = dyn_cast<VAArgInst>(BBI)) {
Chris Lattner51d67ce2010-11-30 21:47:58 +0000702 LoadedLoc = AA->getLocation(V);
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000703 } else if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(BBI)) {
Chris Lattner51d67ce2010-11-30 21:47:58 +0000704 LoadedLoc = AA->getLocationForSource(MTI);
Owen Anderson58704ee2011-09-06 18:14:09 +0000705 } else if (!BBI->mayReadFromMemory()) {
706 // Instruction doesn't read memory. Note that stores that weren't removed
707 // above will hit this case.
Chris Lattner1adb6752008-11-28 00:27:14 +0000708 continue;
Eli Friedman89b694b2011-07-27 01:08:30 +0000709 } else {
710 // Unknown inst; assume it clobbers everything.
711 break;
Owen Anderson32c4a052007-07-12 21:41:30 +0000712 }
Duncan Sandsd65a4da2008-10-01 15:25:41 +0000713
Chris Lattner7fe08b62010-11-30 21:32:12 +0000714 // Remove any allocas from the DeadPointer set that are loaded, as this
715 // makes any stores above the access live.
Chris Lattner51d67ce2010-11-30 21:47:58 +0000716 RemoveAccessedObjects(LoadedLoc, DeadStackObjects);
Duncan Sandsd65a4da2008-10-01 15:25:41 +0000717
Chris Lattner7fe08b62010-11-30 21:32:12 +0000718 // If all of the allocas were clobbered by the access then we're not going
719 // to find anything else to process.
720 if (DeadStackObjects.empty())
721 break;
Owen Anderson32c4a052007-07-12 21:41:30 +0000722 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000723
Owen Anderson32c4a052007-07-12 21:41:30 +0000724 return MadeChange;
725}
726
Chris Lattner7fe08b62010-11-30 21:32:12 +0000727/// RemoveAccessedObjects - Check to see if the specified location may alias any
728/// of the stack objects in the DeadStackObjects set. If so, they become live
729/// because the location is being loaded.
Chris Lattner51d67ce2010-11-30 21:47:58 +0000730void DSE::RemoveAccessedObjects(const AliasAnalysis::Location &LoadedLoc,
Chris Lattner7fe08b62010-11-30 21:32:12 +0000731 SmallPtrSet<Value*, 16> &DeadStackObjects) {
Dan Gohmana4fcd242010-12-15 20:02:24 +0000732 const Value *UnderlyingPointer = GetUnderlyingObject(LoadedLoc.Ptr);
Chris Lattner7fe08b62010-11-30 21:32:12 +0000733
734 // A constant can't be in the dead pointer set.
735 if (isa<Constant>(UnderlyingPointer))
Chris Lattnerf80b3992010-11-30 21:38:30 +0000736 return;
Owen Anderson58704ee2011-09-06 18:14:09 +0000737
Chris Lattner7fe08b62010-11-30 21:32:12 +0000738 // If the kill pointer can be easily reduced to an alloca, don't bother doing
739 // extraneous AA queries.
Chris Lattnerf80b3992010-11-30 21:38:30 +0000740 if (isa<AllocaInst>(UnderlyingPointer) || isa<Argument>(UnderlyingPointer)) {
Chris Lattner51d67ce2010-11-30 21:47:58 +0000741 DeadStackObjects.erase(const_cast<Value*>(UnderlyingPointer));
Chris Lattnerf80b3992010-11-30 21:38:30 +0000742 return;
Owen Andersonddf4aee2007-08-08 18:38:28 +0000743 }
Owen Anderson58704ee2011-09-06 18:14:09 +0000744
Chris Lattner7fe08b62010-11-30 21:32:12 +0000745 SmallVector<Value*, 16> NowLive;
Chris Lattner7fe08b62010-11-30 21:32:12 +0000746 for (SmallPtrSet<Value*, 16>::iterator I = DeadStackObjects.begin(),
747 E = DeadStackObjects.end(); I != E; ++I) {
Chris Lattner51d67ce2010-11-30 21:47:58 +0000748 // See if the loaded location could alias the stack location.
749 AliasAnalysis::Location StackLoc(*I, getPointerSize(*I, *AA));
750 if (!AA->isNoAlias(StackLoc, LoadedLoc))
Chris Lattner7fe08b62010-11-30 21:32:12 +0000751 NowLive.push_back(*I);
Owen Anderson32c4a052007-07-12 21:41:30 +0000752 }
753
Chris Lattner7fe08b62010-11-30 21:32:12 +0000754 for (SmallVector<Value*, 16>::iterator I = NowLive.begin(), E = NowLive.end();
Owen Anderson32c4a052007-07-12 21:41:30 +0000755 I != E; ++I)
Chris Lattner7fe08b62010-11-30 21:32:12 +0000756 DeadStackObjects.erase(*I);
Owen Anderson32c4a052007-07-12 21:41:30 +0000757}
758