blob: cb9b5bebc5c77c46fed035b797d83d8ffa03de9e [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"
Owen Anderson3f338972008-07-28 16:14:26 +000027#include "llvm/Analysis/Dominators.h"
Victor Hernandezf390e042009-10-27 20:05:49 +000028#include "llvm/Analysis/MemoryBuiltins.h"
Owen Anderson5e72db32007-07-11 00:46:18 +000029#include "llvm/Analysis/MemoryDependenceAnalysis.h"
Chris Lattnerc0f33792010-11-30 23:05:20 +000030#include "llvm/Analysis/ValueTracking.h"
Owen Andersonaa071722007-07-11 23:19:17 +000031#include "llvm/Target/TargetData.h"
Owen Anderson5e72db32007-07-11 00:46:18 +000032#include "llvm/Transforms/Utils/Local.h"
Chris Lattnerca335e32010-12-06 21:13:51 +000033#include "llvm/Support/Debug.h"
34#include "llvm/ADT/SmallPtrSet.h"
35#include "llvm/ADT/Statistic.h"
Owen Anderson5e72db32007-07-11 00:46:18 +000036using namespace llvm;
37
38STATISTIC(NumFastStores, "Number of stores deleted");
39STATISTIC(NumFastOther , "Number of other instrs removed");
40
41namespace {
Chris Lattner2dd09db2009-09-02 06:11:42 +000042 struct DSE : public FunctionPass {
Chris Lattner51c28a92010-11-30 19:34:42 +000043 AliasAnalysis *AA;
44 MemoryDependenceAnalysis *MD;
45
Owen Anderson5e72db32007-07-11 00:46:18 +000046 static char ID; // Pass identification, replacement for typeid
Chris Lattner51c28a92010-11-30 19:34:42 +000047 DSE() : FunctionPass(ID), AA(0), MD(0) {
Owen Anderson6c18d1a2010-10-19 17:21:58 +000048 initializeDSEPass(*PassRegistry::getPassRegistry());
49 }
Owen Anderson5e72db32007-07-11 00:46:18 +000050
51 virtual bool runOnFunction(Function &F) {
Chris Lattner51c28a92010-11-30 19:34:42 +000052 AA = &getAnalysis<AliasAnalysis>();
53 MD = &getAnalysis<MemoryDependenceAnalysis>();
Chris Lattnerc053cbb2010-02-11 05:11:54 +000054 DominatorTree &DT = getAnalysis<DominatorTree>();
55
Chris Lattner51c28a92010-11-30 19:34:42 +000056 bool Changed = false;
Owen Anderson5e72db32007-07-11 00:46:18 +000057 for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
Chris Lattnerc053cbb2010-02-11 05:11:54 +000058 // Only check non-dead blocks. Dead blocks may have strange pointer
59 // cycles that will confuse alias analysis.
60 if (DT.isReachableFromEntry(I))
61 Changed |= runOnBasicBlock(*I);
Chris Lattner51c28a92010-11-30 19:34:42 +000062
63 AA = 0; MD = 0;
Owen Anderson5e72db32007-07-11 00:46:18 +000064 return Changed;
65 }
Chris Lattnerde04e112008-11-29 01:43:36 +000066
Owen Anderson5e72db32007-07-11 00:46:18 +000067 bool runOnBasicBlock(BasicBlock &BB);
Chris Lattner9d179d92010-11-30 01:28:33 +000068 bool HandleFree(CallInst *F);
Chris Lattner1adb6752008-11-28 00:27:14 +000069 bool handleEndBlock(BasicBlock &BB);
Chris Lattner51d67ce2010-11-30 21:47:58 +000070 void RemoveAccessedObjects(const AliasAnalysis::Location &LoadedLoc,
71 SmallPtrSet<Value*, 16> &DeadStackObjects);
Owen Anderson5e72db32007-07-11 00:46:18 +000072
Owen Anderson5e72db32007-07-11 00:46:18 +000073 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
74 AU.setPreservesCFG();
Owen Anderson3f338972008-07-28 16:14:26 +000075 AU.addRequired<DominatorTree>();
Owen Andersonaa071722007-07-11 23:19:17 +000076 AU.addRequired<AliasAnalysis>();
Owen Anderson5e72db32007-07-11 00:46:18 +000077 AU.addRequired<MemoryDependenceAnalysis>();
Chris Lattner51c28a92010-11-30 19:34:42 +000078 AU.addPreserved<AliasAnalysis>();
Owen Anderson3f338972008-07-28 16:14:26 +000079 AU.addPreserved<DominatorTree>();
Owen Anderson5e72db32007-07-11 00:46:18 +000080 AU.addPreserved<MemoryDependenceAnalysis>();
81 }
82 };
Owen Anderson5e72db32007-07-11 00:46:18 +000083}
84
Dan Gohmand78c4002008-05-13 00:00:25 +000085char DSE::ID = 0;
Owen Anderson8ac477f2010-10-12 19:48:12 +000086INITIALIZE_PASS_BEGIN(DSE, "dse", "Dead Store Elimination", false, false)
87INITIALIZE_PASS_DEPENDENCY(DominatorTree)
88INITIALIZE_PASS_DEPENDENCY(MemoryDependenceAnalysis)
89INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
90INITIALIZE_PASS_END(DSE, "dse", "Dead Store Elimination", false, false)
Dan Gohmand78c4002008-05-13 00:00:25 +000091
Owen Anderson10e52ed2007-08-01 06:36:51 +000092FunctionPass *llvm::createDeadStoreEliminationPass() { return new DSE(); }
Owen Anderson5e72db32007-07-11 00:46:18 +000093
Chris Lattner67122512010-11-30 21:58:14 +000094//===----------------------------------------------------------------------===//
95// Helper functions
96//===----------------------------------------------------------------------===//
97
98/// DeleteDeadInstruction - Delete this instruction. Before we do, go through
99/// and zero out all the operands of this instruction. If any of them become
100/// dead, delete them and the computation tree that feeds them.
101///
102/// If ValueSet is non-null, remove any deleted instructions from it as well.
103///
104static void DeleteDeadInstruction(Instruction *I,
105 MemoryDependenceAnalysis &MD,
106 SmallPtrSet<Value*, 16> *ValueSet = 0) {
107 SmallVector<Instruction*, 32> NowDeadInsts;
108
109 NowDeadInsts.push_back(I);
110 --NumFastOther;
111
112 // Before we touch this instruction, remove it from memdep!
113 do {
114 Instruction *DeadInst = NowDeadInsts.pop_back_val();
115 ++NumFastOther;
116
117 // This instruction is dead, zap it, in stages. Start by removing it from
118 // MemDep, which needs to know the operands and needs it to be in the
119 // function.
120 MD.removeInstruction(DeadInst);
121
122 for (unsigned op = 0, e = DeadInst->getNumOperands(); op != e; ++op) {
123 Value *Op = DeadInst->getOperand(op);
124 DeadInst->setOperand(op, 0);
125
126 // If this operand just became dead, add it to the NowDeadInsts list.
127 if (!Op->use_empty()) continue;
128
129 if (Instruction *OpI = dyn_cast<Instruction>(Op))
130 if (isInstructionTriviallyDead(OpI))
131 NowDeadInsts.push_back(OpI);
132 }
133
134 DeadInst->eraseFromParent();
135
136 if (ValueSet) ValueSet->erase(DeadInst);
137 } while (!NowDeadInsts.empty());
138}
139
140
Chris Lattner2227a8a2010-11-30 01:37:52 +0000141/// hasMemoryWrite - Does this instruction write some memory? This only returns
142/// true for things that we can analyze with other helpers below.
143static bool hasMemoryWrite(Instruction *I) {
Nick Lewycky90271472009-11-10 06:46:40 +0000144 if (isa<StoreInst>(I))
145 return true;
146 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
147 switch (II->getIntrinsicID()) {
Chris Lattner2764b4d2009-12-02 06:35:55 +0000148 default:
149 return false;
150 case Intrinsic::memset:
151 case Intrinsic::memmove:
152 case Intrinsic::memcpy:
153 case Intrinsic::init_trampoline:
154 case Intrinsic::lifetime_end:
155 return true;
Nick Lewycky90271472009-11-10 06:46:40 +0000156 }
157 }
158 return false;
159}
160
Chris Lattner58b779e2010-11-30 07:23:21 +0000161/// getLocForWrite - Return a Location stored to by the specified instruction.
162static AliasAnalysis::Location
163getLocForWrite(Instruction *Inst, AliasAnalysis &AA) {
164 if (StoreInst *SI = dyn_cast<StoreInst>(Inst))
165 return AA.getLocation(SI);
166
167 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(Inst)) {
168 // memcpy/memmove/memset.
169 AliasAnalysis::Location Loc = AA.getLocationForDest(MI);
170 // If we don't have target data around, an unknown size in Location means
171 // that we should use the size of the pointee type. This isn't valid for
172 // memset/memcpy, which writes more than an i8.
173 if (Loc.Size == AliasAnalysis::UnknownSize && AA.getTargetData() == 0)
174 return AliasAnalysis::Location();
175 return Loc;
176 }
177
178 IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst);
179 if (II == 0) return AliasAnalysis::Location();
180
181 switch (II->getIntrinsicID()) {
182 default: return AliasAnalysis::Location(); // Unhandled intrinsic.
183 case Intrinsic::init_trampoline:
184 // If we don't have target data around, an unknown size in Location means
185 // that we should use the size of the pointee type. This isn't valid for
186 // init.trampoline, which writes more than an i8.
187 if (AA.getTargetData() == 0) return AliasAnalysis::Location();
188
189 // FIXME: We don't know the size of the trampoline, so we can't really
190 // handle it here.
191 return AliasAnalysis::Location(II->getArgOperand(0));
192 case Intrinsic::lifetime_end: {
193 uint64_t Len = cast<ConstantInt>(II->getArgOperand(0))->getZExtValue();
194 return AliasAnalysis::Location(II->getArgOperand(1), Len);
195 }
196 }
197}
198
Chris Lattner94fbdf32010-12-06 01:48:06 +0000199/// getLocForRead - Return the location read by the specified "hasMemoryWrite"
200/// instruction if any.
201static AliasAnalysis::Location
202getLocForRead(Instruction *Inst, AliasAnalysis &AA) {
203 assert(hasMemoryWrite(Inst) && "Unknown instruction case");
204
205 // The only instructions that both read and write are the mem transfer
206 // instructions (memcpy/memmove).
207 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(Inst))
208 return AA.getLocationForSource(MTI);
209 return AliasAnalysis::Location();
210}
211
212
Chris Lattner3590ef82010-11-30 05:30:45 +0000213/// isRemovable - If the value of this instruction and the memory it writes to
214/// is unused, may we delete this instruction?
215static bool isRemovable(Instruction *I) {
Chris Lattnerb63ba732010-11-30 19:12:10 +0000216 // Don't remove volatile stores.
Nick Lewycky90271472009-11-10 06:46:40 +0000217 if (StoreInst *SI = dyn_cast<StoreInst>(I))
218 return !SI->isVolatile();
Chris Lattnerb63ba732010-11-30 19:12:10 +0000219
220 IntrinsicInst *II = cast<IntrinsicInst>(I);
221 switch (II->getIntrinsicID()) {
222 default: assert(0 && "doesn't pass 'hasMemoryWrite' predicate");
223 case Intrinsic::lifetime_end:
224 // Never remove dead lifetime_end's, e.g. because it is followed by a
225 // free.
226 return false;
227 case Intrinsic::init_trampoline:
228 // Always safe to remove init_trampoline.
229 return true;
230
231 case Intrinsic::memset:
232 case Intrinsic::memmove:
233 case Intrinsic::memcpy:
234 // Don't remove volatile memory intrinsics.
235 return !cast<MemIntrinsic>(II)->isVolatile();
236 }
Nick Lewycky90271472009-11-10 06:46:40 +0000237}
238
Chris Lattner67122512010-11-30 21:58:14 +0000239/// getStoredPointerOperand - Return the pointer that is being written to.
240static Value *getStoredPointerOperand(Instruction *I) {
Nick Lewycky90271472009-11-10 06:46:40 +0000241 if (StoreInst *SI = dyn_cast<StoreInst>(I))
242 return SI->getPointerOperand();
243 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(I))
Chris Lattner67122512010-11-30 21:58:14 +0000244 return MI->getDest();
Gabor Greif91f95892010-06-24 12:03:56 +0000245
246 IntrinsicInst *II = cast<IntrinsicInst>(I);
247 switch (II->getIntrinsicID()) {
Chris Lattner2764b4d2009-12-02 06:35:55 +0000248 default: assert(false && "Unexpected intrinsic!");
249 case Intrinsic::init_trampoline:
Gabor Greif91f95892010-06-24 12:03:56 +0000250 return II->getArgOperand(0);
Duncan Sands1925d3a2009-11-10 13:49:50 +0000251 }
Nick Lewycky90271472009-11-10 06:46:40 +0000252}
253
Chris Lattner51c28a92010-11-30 19:34:42 +0000254static uint64_t getPointerSize(Value *V, AliasAnalysis &AA) {
255 const TargetData *TD = AA.getTargetData();
256 if (TD == 0)
257 return AliasAnalysis::UnknownSize;
258
259 if (AllocaInst *A = dyn_cast<AllocaInst>(V)) {
260 // Get size information for the alloca
261 if (ConstantInt *C = dyn_cast<ConstantInt>(A->getArraySize()))
262 return C->getZExtValue() * TD->getTypeAllocSize(A->getAllocatedType());
263 return AliasAnalysis::UnknownSize;
264 }
265
266 assert(isa<Argument>(V) && "Expected AllocaInst or Argument!");
267 const PointerType *PT = cast<PointerType>(V->getType());
268 return TD->getTypeAllocSize(PT->getElementType());
269}
270
Chris Lattner903add82010-11-30 23:43:23 +0000271/// isObjectPointerWithTrustworthySize - Return true if the specified Value* is
272/// pointing to an object with a pointer size we can trust.
273static bool isObjectPointerWithTrustworthySize(const Value *V) {
274 if (const AllocaInst *AI = dyn_cast<AllocaInst>(V))
275 return !AI->isArrayAllocation();
276 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
Chris Lattner4dc53e32010-12-06 21:48:10 +0000277 return !GV->mayBeOverridden();
Chris Lattner903add82010-11-30 23:43:23 +0000278 if (const Argument *A = dyn_cast<Argument>(V))
279 return A->hasByValAttr();
280 return false;
281}
Chris Lattner51c28a92010-11-30 19:34:42 +0000282
Chris Lattner58b779e2010-11-30 07:23:21 +0000283/// isCompleteOverwrite - Return true if a store to the 'Later' location
284/// completely overwrites a store to the 'Earlier' location.
285static bool isCompleteOverwrite(const AliasAnalysis::Location &Later,
286 const AliasAnalysis::Location &Earlier,
Chris Lattner77d79fa2010-11-30 19:28:23 +0000287 AliasAnalysis &AA) {
Chris Lattnerc0f33792010-11-30 23:05:20 +0000288 const Value *P1 = Earlier.Ptr->stripPointerCasts();
289 const Value *P2 = Later.Ptr->stripPointerCasts();
Chris Lattner58b779e2010-11-30 07:23:21 +0000290
Chris Lattnerc0f33792010-11-30 23:05:20 +0000291 // If the start pointers are the same, we just have to compare sizes to see if
292 // the later store was larger than the earlier store.
293 if (P1 == P2) {
294 // If we don't know the sizes of either access, then we can't do a
295 // comparison.
296 if (Later.Size == AliasAnalysis::UnknownSize ||
297 Earlier.Size == AliasAnalysis::UnknownSize) {
298 // If we have no TargetData information around, then the size of the store
299 // is inferrable from the pointee type. If they are the same type, then
300 // we know that the store is safe.
301 if (AA.getTargetData() == 0)
302 return Later.Ptr->getType() == Earlier.Ptr->getType();
303 return false;
304 }
305
306 // Make sure that the Later size is >= the Earlier size.
307 if (Later.Size < Earlier.Size)
308 return false;
309 return true;
Chris Lattner77d79fa2010-11-30 19:28:23 +0000310 }
Chris Lattner58b779e2010-11-30 07:23:21 +0000311
Chris Lattnerc0f33792010-11-30 23:05:20 +0000312 // Otherwise, we have to have size information, and the later store has to be
313 // larger than the earlier one.
314 if (Later.Size == AliasAnalysis::UnknownSize ||
315 Earlier.Size == AliasAnalysis::UnknownSize ||
Chris Lattner903add82010-11-30 23:43:23 +0000316 Later.Size <= Earlier.Size || AA.getTargetData() == 0)
Chris Lattner58b779e2010-11-30 07:23:21 +0000317 return false;
318
Chris Lattner903add82010-11-30 23:43:23 +0000319 // Check to see if the later store is to the entire object (either a global,
320 // an alloca, or a byval argument). If so, then it clearly overwrites any
321 // other store to the same object.
Chris Lattnerc0f33792010-11-30 23:05:20 +0000322 const TargetData &TD = *AA.getTargetData();
323
Dan Gohman0f124e12011-01-24 18:53:32 +0000324 const Value *UO1 = GetUnderlyingObject(P1, &TD),
325 *UO2 = GetUnderlyingObject(P2, &TD);
Chris Lattner903add82010-11-30 23:43:23 +0000326
327 // If we can't resolve the same pointers to the same object, then we can't
328 // analyze them at all.
329 if (UO1 != UO2)
330 return false;
331
332 // If the "Later" store is to a recognizable object, get its size.
333 if (isObjectPointerWithTrustworthySize(UO2)) {
334 uint64_t ObjectSize =
335 TD.getTypeAllocSize(cast<PointerType>(UO2->getType())->getElementType());
336 if (ObjectSize == Later.Size)
337 return true;
338 }
339
Chris Lattnerc0f33792010-11-30 23:05:20 +0000340 // Okay, we have stores to two completely different pointers. Try to
341 // decompose the pointer into a "base + constant_offset" form. If the base
342 // pointers are equal, then we can reason about the two stores.
Bill Wendling19f33b92011-03-26 08:02:59 +0000343 int64_t EarlierOff = 0, LaterOff = 0;
344 const Value *BP1 = GetPointerBaseWithConstantOffset(P1, EarlierOff, TD);
345 const Value *BP2 = GetPointerBaseWithConstantOffset(P2, LaterOff, TD);
Chris Lattnerc0f33792010-11-30 23:05:20 +0000346
347 // If the base pointers still differ, we have two completely different stores.
348 if (BP1 != BP2)
349 return false;
Bill Wendlingdb40b5c2011-03-26 01:20:37 +0000350
Bill Wendling19f33b92011-03-26 08:02:59 +0000351 // The later store completely overlaps the earlier store if:
352 //
353 // 1. Both start at the same offset and the later one's size is greater than
354 // or equal to the earlier one's, or
355 //
356 // |--earlier--|
357 // |-- later --|
358 //
359 // 2. The earlier store has an offset greater than the later offset, but which
360 // still lies completely within the later store.
361 //
362 // |--earlier--|
363 // |----- later ------|
Bill Wendling50341592011-03-30 21:37:19 +0000364 //
365 // We have to be careful here as *Off is signed while *.Size is unsigned.
Bill Wendlingb5139922011-03-26 09:32:07 +0000366 if (EarlierOff >= LaterOff &&
Bill Wendling50341592011-03-30 21:37:19 +0000367 uint64_t(EarlierOff - LaterOff) + Earlier.Size <= Later.Size)
Bill Wendling19f33b92011-03-26 08:02:59 +0000368 return true;
369
370 // Otherwise, they don't completely overlap.
371 return false;
Nick Lewycky90271472009-11-10 06:46:40 +0000372}
373
Chris Lattner94fbdf32010-12-06 01:48:06 +0000374/// isPossibleSelfRead - If 'Inst' might be a self read (i.e. a noop copy of a
375/// memory region into an identical pointer) then it doesn't actually make its
376/// input dead in the traditional sense. Consider this case:
377///
378/// memcpy(A <- B)
379/// memcpy(A <- A)
380///
381/// In this case, the second store to A does not make the first store to A dead.
382/// The usual situation isn't an explicit A<-A store like this (which can be
383/// trivially removed) but a case where two pointers may alias.
384///
385/// This function detects when it is unsafe to remove a dependent instruction
386/// because the DSE inducing instruction may be a self-read.
387static bool isPossibleSelfRead(Instruction *Inst,
388 const AliasAnalysis::Location &InstStoreLoc,
389 Instruction *DepWrite, AliasAnalysis &AA) {
390 // Self reads can only happen for instructions that read memory. Get the
391 // location read.
392 AliasAnalysis::Location InstReadLoc = getLocForRead(Inst, AA);
393 if (InstReadLoc.Ptr == 0) return false; // Not a reading instruction.
394
395 // If the read and written loc obviously don't alias, it isn't a read.
396 if (AA.isNoAlias(InstReadLoc, InstStoreLoc)) return false;
397
398 // Okay, 'Inst' may copy over itself. However, we can still remove a the
399 // DepWrite instruction if we can prove that it reads from the same location
400 // as Inst. This handles useful cases like:
401 // memcpy(A <- B)
402 // memcpy(A <- B)
403 // Here we don't know if A/B may alias, but we do know that B/B are must
404 // aliases, so removing the first memcpy is safe (assuming it writes <= #
405 // bytes as the second one.
406 AliasAnalysis::Location DepReadLoc = getLocForRead(DepWrite, AA);
407
408 if (DepReadLoc.Ptr && AA.isMustAlias(InstReadLoc.Ptr, DepReadLoc.Ptr))
409 return false;
410
411 // If DepWrite doesn't read memory or if we can't prove it is a must alias,
412 // then it can't be considered dead.
413 return true;
414}
415
Chris Lattner67122512010-11-30 21:58:14 +0000416
417//===----------------------------------------------------------------------===//
418// DSE Pass
419//===----------------------------------------------------------------------===//
420
Owen Anderson10e52ed2007-08-01 06:36:51 +0000421bool DSE::runOnBasicBlock(BasicBlock &BB) {
Owen Anderson5e72db32007-07-11 00:46:18 +0000422 bool MadeChange = false;
423
Chris Lattner49162672009-09-02 06:31:02 +0000424 // Do a top-down walk on the BB.
Chris Lattnerf2a8ba42008-11-28 21:29:52 +0000425 for (BasicBlock::iterator BBI = BB.begin(), BBE = BB.end(); BBI != BBE; ) {
426 Instruction *Inst = BBI++;
427
Chris Lattner9d179d92010-11-30 01:28:33 +0000428 // Handle 'free' calls specially.
429 if (CallInst *F = isFreeCall(Inst)) {
430 MadeChange |= HandleFree(F);
431 continue;
432 }
433
Chris Lattner2227a8a2010-11-30 01:37:52 +0000434 // If we find something that writes memory, get its memory dependence.
435 if (!hasMemoryWrite(Inst))
Owen Anderson0aecf0e2007-08-08 04:52:29 +0000436 continue;
Chris Lattnerd4f10902010-11-30 00:01:19 +0000437
Chris Lattner51c28a92010-11-30 19:34:42 +0000438 MemDepResult InstDep = MD->getDependency(Inst);
Chris Lattnerf2a8ba42008-11-28 21:29:52 +0000439
Eli Friedman7d58bc72011-06-15 00:47:34 +0000440 // Ignore any store where we can't find a local dependence.
Chris Lattner57e91ea2008-12-06 00:53:22 +0000441 // FIXME: cross-block DSE would be fun. :)
Eli Friedman7d58bc72011-06-15 00:47:34 +0000442 if (InstDep.isNonLocal() || InstDep.isUnknown())
Chris Lattner58b779e2010-11-30 07:23:21 +0000443 continue;
Chris Lattner9d179d92010-11-30 01:28:33 +0000444
Chris Lattner57e91ea2008-12-06 00:53:22 +0000445 // If we're storing the same value back to a pointer that we just
446 // loaded from, then the store can be removed.
Nick Lewycky90271472009-11-10 06:46:40 +0000447 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
448 if (LoadInst *DepLoad = dyn_cast<LoadInst>(InstDep.getInst())) {
449 if (SI->getPointerOperand() == DepLoad->getPointerOperand() &&
Chris Lattnerc3c754f2010-11-30 00:12:39 +0000450 SI->getOperand(0) == DepLoad && !SI->isVolatile()) {
Chris Lattnerca335e32010-12-06 21:13:51 +0000451 DEBUG(dbgs() << "DSE: Remove Store Of Load from same pointer:\n "
452 << "LOAD: " << *DepLoad << "\n STORE: " << *SI << '\n');
453
Nick Lewycky90271472009-11-10 06:46:40 +0000454 // DeleteDeadInstruction can delete the current instruction. Save BBI
455 // in case we need it.
456 WeakVH NextInst(BBI);
457
Chris Lattner67122512010-11-30 21:58:14 +0000458 DeleteDeadInstruction(SI, *MD);
Nick Lewycky90271472009-11-10 06:46:40 +0000459
460 if (NextInst == 0) // Next instruction deleted.
461 BBI = BB.begin();
462 else if (BBI != BB.begin()) // Revisit this instruction if possible.
463 --BBI;
Dan Gohmand2d1ae12010-06-22 15:08:57 +0000464 ++NumFastStores;
Nick Lewycky90271472009-11-10 06:46:40 +0000465 MadeChange = true;
466 continue;
467 }
Chris Lattner0e3d6332008-12-05 21:04:20 +0000468 }
Owen Anderson5e72db32007-07-11 00:46:18 +0000469 }
Chris Lattner3590ef82010-11-30 05:30:45 +0000470
Chris Lattner58b779e2010-11-30 07:23:21 +0000471 // Figure out what location is being stored to.
Chris Lattner51c28a92010-11-30 19:34:42 +0000472 AliasAnalysis::Location Loc = getLocForWrite(Inst, *AA);
Chris Lattner58b779e2010-11-30 07:23:21 +0000473
474 // If we didn't get a useful location, fail.
475 if (Loc.Ptr == 0)
476 continue;
477
Eli Friedman7d58bc72011-06-15 00:47:34 +0000478 while (!InstDep.isNonLocal() && !InstDep.isUnknown()) {
Chris Lattner58b779e2010-11-30 07:23:21 +0000479 // Get the memory clobbered by the instruction we depend on. MemDep will
480 // skip any instructions that 'Loc' clearly doesn't interact with. If we
481 // end up depending on a may- or must-aliased load, then we can't optimize
482 // away the store and we bail out. However, if we depend on on something
483 // that overwrites the memory location we *can* potentially optimize it.
484 //
Chris Lattner0ab5e2c2011-04-15 05:18:47 +0000485 // Find out what memory location the dependent instruction stores.
Chris Lattner58b779e2010-11-30 07:23:21 +0000486 Instruction *DepWrite = InstDep.getInst();
Chris Lattner51c28a92010-11-30 19:34:42 +0000487 AliasAnalysis::Location DepLoc = getLocForWrite(DepWrite, *AA);
Chris Lattner58b779e2010-11-30 07:23:21 +0000488 // If we didn't get a useful location, or if it isn't a size, bail out.
489 if (DepLoc.Ptr == 0)
490 break;
491
Chris Lattner94fbdf32010-12-06 01:48:06 +0000492 // If we find a write that is a) removable (i.e., non-volatile), b) is
493 // completely obliterated by the store to 'Loc', and c) which we know that
494 // 'Inst' doesn't load from, then we can remove it.
495 if (isRemovable(DepWrite) && isCompleteOverwrite(Loc, DepLoc, *AA) &&
496 !isPossibleSelfRead(Inst, Loc, DepWrite, *AA)) {
Chris Lattnerca335e32010-12-06 21:13:51 +0000497 DEBUG(dbgs() << "DSE: Remove Dead Store:\n DEAD: "
498 << *DepWrite << "\n KILLER: " << *Inst << '\n');
499
Chris Lattner58b779e2010-11-30 07:23:21 +0000500 // Delete the store and now-dead instructions that feed it.
Chris Lattner67122512010-11-30 21:58:14 +0000501 DeleteDeadInstruction(DepWrite, *MD);
Chris Lattner58b779e2010-11-30 07:23:21 +0000502 ++NumFastStores;
503 MadeChange = true;
504
505 // DeleteDeadInstruction can delete the current instruction in loop
506 // cases, reset BBI.
507 BBI = Inst;
508 if (BBI != BB.begin())
509 --BBI;
510 break;
511 }
512
Chris Lattnerd4f10902010-11-30 00:01:19 +0000513 // If this is a may-aliased store that is clobbering the store value, we
514 // can keep searching past it for another must-aliased pointer that stores
515 // to the same location. For example, in:
516 // store -> P
517 // store -> Q
518 // store -> P
519 // we can remove the first store to P even though we don't know if P and Q
520 // alias.
Chris Lattner58b779e2010-11-30 07:23:21 +0000521 if (DepWrite == &BB.front()) break;
522
523 // Can't look past this instruction if it might read 'Loc'.
Chris Lattner51c28a92010-11-30 19:34:42 +0000524 if (AA->getModRefInfo(DepWrite, Loc) & AliasAnalysis::Ref)
Chris Lattner58b779e2010-11-30 07:23:21 +0000525 break;
Chris Lattner3590ef82010-11-30 05:30:45 +0000526
Chris Lattner51c28a92010-11-30 19:34:42 +0000527 InstDep = MD->getPointerDependencyFrom(Loc, false, DepWrite, &BB);
Owen Anderson2b2bd282009-10-28 07:05:35 +0000528 }
Owen Anderson5e72db32007-07-11 00:46:18 +0000529 }
530
Chris Lattnerf2a8ba42008-11-28 21:29:52 +0000531 // If this block ends in a return, unwind, or unreachable, all allocas are
532 // dead at its end, which means stores to them are also dead.
Owen Anderson32c4a052007-07-12 21:41:30 +0000533 if (BB.getTerminator()->getNumSuccessors() == 0)
Chris Lattner1adb6752008-11-28 00:27:14 +0000534 MadeChange |= handleEndBlock(BB);
Owen Anderson5e72db32007-07-11 00:46:18 +0000535
536 return MadeChange;
537}
538
Chris Lattner9d179d92010-11-30 01:28:33 +0000539/// HandleFree - Handle frees of entire structures whose dependency is a store
540/// to a field of that structure.
541bool DSE::HandleFree(CallInst *F) {
Eli Friedman7d58bc72011-06-15 00:47:34 +0000542 bool MadeChange = false;
543
Chris Lattner51c28a92010-11-30 19:34:42 +0000544 MemDepResult Dep = MD->getDependency(F);
Eli Friedman7d58bc72011-06-15 00:47:34 +0000545
546 while (!Dep.isNonLocal() && !Dep.isUnknown()) {
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000547 Instruction *Dependency = Dep.getInst();
Chris Lattner3590ef82010-11-30 05:30:45 +0000548 if (!hasMemoryWrite(Dependency) || !isRemovable(Dependency))
Eli Friedman7d58bc72011-06-15 00:47:34 +0000549 return MadeChange;
Owen Andersond4451de2007-07-12 18:08:51 +0000550
Chris Lattner67122512010-11-30 21:58:14 +0000551 Value *DepPointer =
Dan Gohmana4fcd242010-12-15 20:02:24 +0000552 GetUnderlyingObject(getStoredPointerOperand(Dependency));
Duncan Sandsfe3bef02008-01-20 10:49:23 +0000553
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000554 // Check for aliasing.
Chris Lattner94fbdf32010-12-06 01:48:06 +0000555 if (!AA->isMustAlias(F->getArgOperand(0), DepPointer))
Eli Friedman7d58bc72011-06-15 00:47:34 +0000556 return MadeChange;
Owen Andersonaa071722007-07-11 23:19:17 +0000557
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000558 // DCE instructions only used to calculate that store
Chris Lattner67122512010-11-30 21:58:14 +0000559 DeleteDeadInstruction(Dependency, *MD);
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000560 ++NumFastStores;
Eli Friedman7d58bc72011-06-15 00:47:34 +0000561 MadeChange = true;
Dan Gohmand4b7fff2010-11-12 02:19:17 +0000562
563 // Inst's old Dependency is now deleted. Compute the next dependency,
564 // which may also be dead, as in
565 // s[0] = 0;
566 // s[1] = 0; // This has just been deleted.
567 // free(s);
Chris Lattner51c28a92010-11-30 19:34:42 +0000568 Dep = MD->getDependency(F);
Eli Friedman7d58bc72011-06-15 00:47:34 +0000569 };
Chris Lattner9d179d92010-11-30 01:28:33 +0000570
Eli Friedman7d58bc72011-06-15 00:47:34 +0000571 return MadeChange;
Owen Andersonaa071722007-07-11 23:19:17 +0000572}
573
Owen Andersone3590582007-08-02 18:11:11 +0000574/// handleEndBlock - Remove dead stores to stack-allocated locations in the
Owen Anderson52aaabf2007-08-08 17:50:09 +0000575/// function end block. Ex:
576/// %A = alloca i32
577/// ...
578/// store i32 1, i32* %A
579/// ret void
Chris Lattner1adb6752008-11-28 00:27:14 +0000580bool DSE::handleEndBlock(BasicBlock &BB) {
Owen Anderson32c4a052007-07-12 21:41:30 +0000581 bool MadeChange = false;
582
Chris Lattner7fe08b62010-11-30 21:32:12 +0000583 // Keep track of all of the stack objects that are dead at the end of the
584 // function.
585 SmallPtrSet<Value*, 16> DeadStackObjects;
Owen Anderson32c4a052007-07-12 21:41:30 +0000586
Chris Lattner1adb6752008-11-28 00:27:14 +0000587 // Find all of the alloca'd pointers in the entry block.
Owen Anderson32c4a052007-07-12 21:41:30 +0000588 BasicBlock *Entry = BB.getParent()->begin();
589 for (BasicBlock::iterator I = Entry->begin(), E = Entry->end(); I != E; ++I)
590 if (AllocaInst *AI = dyn_cast<AllocaInst>(I))
Chris Lattner7fe08b62010-11-30 21:32:12 +0000591 DeadStackObjects.insert(AI);
Chris Lattner1adb6752008-11-28 00:27:14 +0000592
593 // Treat byval arguments the same, stores to them are dead at the end of the
594 // function.
Owen Anderson48d37802008-01-29 06:18:36 +0000595 for (Function::arg_iterator AI = BB.getParent()->arg_begin(),
596 AE = BB.getParent()->arg_end(); AI != AE; ++AI)
597 if (AI->hasByValAttr())
Chris Lattner7fe08b62010-11-30 21:32:12 +0000598 DeadStackObjects.insert(AI);
Owen Anderson32c4a052007-07-12 21:41:30 +0000599
600 // Scan the basic block backwards
601 for (BasicBlock::iterator BBI = BB.end(); BBI != BB.begin(); ){
602 --BBI;
603
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000604 // If we find a store, check to see if it points into a dead stack value.
605 if (hasMemoryWrite(BBI) && isRemovable(BBI)) {
606 // See through pointer-to-pointer bitcasts
Dan Gohmana4fcd242010-12-15 20:02:24 +0000607 Value *Pointer = GetUnderlyingObject(getStoredPointerOperand(BBI));
Duncan Sandsd65a4da2008-10-01 15:25:41 +0000608
Chris Lattner67122512010-11-30 21:58:14 +0000609 // Stores to stack values are valid candidates for removal.
Chris Lattner7fe08b62010-11-30 21:32:12 +0000610 if (DeadStackObjects.count(Pointer)) {
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000611 Instruction *Dead = BBI++;
Chris Lattnerca335e32010-12-06 21:13:51 +0000612
613 DEBUG(dbgs() << "DSE: Dead Store at End of Block:\n DEAD: "
614 << *Dead << "\n Object: " << *Pointer << '\n');
615
616 // DCE instructions only used to calculate that store.
Chris Lattner67122512010-11-30 21:58:14 +0000617 DeleteDeadInstruction(Dead, *MD, &DeadStackObjects);
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000618 ++NumFastStores;
619 MadeChange = true;
Owen Anderson48d37802008-01-29 06:18:36 +0000620 continue;
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000621 }
Owen Anderson52aaabf2007-08-08 17:50:09 +0000622 }
623
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000624 // Remove any dead non-memory-mutating instructions.
625 if (isInstructionTriviallyDead(BBI)) {
626 Instruction *Inst = BBI++;
Chris Lattner67122512010-11-30 21:58:14 +0000627 DeleteDeadInstruction(Inst, *MD, &DeadStackObjects);
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000628 ++NumFastOther;
629 MadeChange = true;
630 continue;
631 }
632
633 if (AllocaInst *A = dyn_cast<AllocaInst>(BBI)) {
Chris Lattner7fe08b62010-11-30 21:32:12 +0000634 DeadStackObjects.erase(A);
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000635 continue;
636 }
637
Chris Lattner127818d2010-11-30 21:18:46 +0000638 if (CallSite CS = cast<Value>(BBI)) {
639 // If this call does not access memory, it can't be loading any of our
640 // pointers.
641 if (AA->doesNotAccessMemory(CS))
642 continue;
643
Chris Lattner127818d2010-11-30 21:18:46 +0000644 // If the call might load from any of our allocas, then any store above
645 // the call is live.
646 SmallVector<Value*, 8> LiveAllocas;
Chris Lattner7fe08b62010-11-30 21:32:12 +0000647 for (SmallPtrSet<Value*, 16>::iterator I = DeadStackObjects.begin(),
648 E = DeadStackObjects.end(); I != E; ++I) {
Chris Lattner127818d2010-11-30 21:18:46 +0000649 // See if the call site touches it.
650 AliasAnalysis::ModRefResult A =
651 AA->getModRefInfo(CS, *I, getPointerSize(*I, *AA));
652
Chris Lattner127818d2010-11-30 21:18:46 +0000653 if (A == AliasAnalysis::ModRef || A == AliasAnalysis::Ref)
654 LiveAllocas.push_back(*I);
655 }
656
657 for (SmallVector<Value*, 8>::iterator I = LiveAllocas.begin(),
658 E = LiveAllocas.end(); I != E; ++I)
Chris Lattner7fe08b62010-11-30 21:32:12 +0000659 DeadStackObjects.erase(*I);
Chris Lattner127818d2010-11-30 21:18:46 +0000660
661 // If all of the allocas were clobbered by the call then we're not going
662 // to find anything else to process.
Chris Lattner7fe08b62010-11-30 21:32:12 +0000663 if (DeadStackObjects.empty())
Chris Lattner127818d2010-11-30 21:18:46 +0000664 return MadeChange;
665
666 continue;
667 }
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000668
Chris Lattner51d67ce2010-11-30 21:47:58 +0000669 AliasAnalysis::Location LoadedLoc;
Owen Anderson32c4a052007-07-12 21:41:30 +0000670
671 // If we encounter a use of the pointer, it is no longer considered dead
Chris Lattner1adb6752008-11-28 00:27:14 +0000672 if (LoadInst *L = dyn_cast<LoadInst>(BBI)) {
Chris Lattner51d67ce2010-11-30 21:47:58 +0000673 LoadedLoc = AA->getLocation(L);
Nick Lewycky475d3d12010-01-03 04:39:07 +0000674 } else if (VAArgInst *V = dyn_cast<VAArgInst>(BBI)) {
Chris Lattner51d67ce2010-11-30 21:47:58 +0000675 LoadedLoc = AA->getLocation(V);
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000676 } else if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(BBI)) {
Chris Lattner51d67ce2010-11-30 21:47:58 +0000677 LoadedLoc = AA->getLocationForSource(MTI);
Chris Lattner60a8b3d2010-11-30 19:48:15 +0000678 } else {
679 // Not a loading instruction.
Chris Lattner1adb6752008-11-28 00:27:14 +0000680 continue;
Owen Anderson32c4a052007-07-12 21:41:30 +0000681 }
Duncan Sandsd65a4da2008-10-01 15:25:41 +0000682
Chris Lattner7fe08b62010-11-30 21:32:12 +0000683 // Remove any allocas from the DeadPointer set that are loaded, as this
684 // makes any stores above the access live.
Chris Lattner51d67ce2010-11-30 21:47:58 +0000685 RemoveAccessedObjects(LoadedLoc, DeadStackObjects);
Duncan Sandsd65a4da2008-10-01 15:25:41 +0000686
Chris Lattner7fe08b62010-11-30 21:32:12 +0000687 // If all of the allocas were clobbered by the access then we're not going
688 // to find anything else to process.
689 if (DeadStackObjects.empty())
690 break;
Owen Anderson32c4a052007-07-12 21:41:30 +0000691 }
692
693 return MadeChange;
694}
695
Chris Lattner7fe08b62010-11-30 21:32:12 +0000696/// RemoveAccessedObjects - Check to see if the specified location may alias any
697/// of the stack objects in the DeadStackObjects set. If so, they become live
698/// because the location is being loaded.
Chris Lattner51d67ce2010-11-30 21:47:58 +0000699void DSE::RemoveAccessedObjects(const AliasAnalysis::Location &LoadedLoc,
Chris Lattner7fe08b62010-11-30 21:32:12 +0000700 SmallPtrSet<Value*, 16> &DeadStackObjects) {
Dan Gohmana4fcd242010-12-15 20:02:24 +0000701 const Value *UnderlyingPointer = GetUnderlyingObject(LoadedLoc.Ptr);
Chris Lattner7fe08b62010-11-30 21:32:12 +0000702
703 // A constant can't be in the dead pointer set.
704 if (isa<Constant>(UnderlyingPointer))
Chris Lattnerf80b3992010-11-30 21:38:30 +0000705 return;
Chris Lattner7fe08b62010-11-30 21:32:12 +0000706
707 // If the kill pointer can be easily reduced to an alloca, don't bother doing
708 // extraneous AA queries.
Chris Lattnerf80b3992010-11-30 21:38:30 +0000709 if (isa<AllocaInst>(UnderlyingPointer) || isa<Argument>(UnderlyingPointer)) {
Chris Lattner51d67ce2010-11-30 21:47:58 +0000710 DeadStackObjects.erase(const_cast<Value*>(UnderlyingPointer));
Chris Lattnerf80b3992010-11-30 21:38:30 +0000711 return;
Owen Andersonddf4aee2007-08-08 18:38:28 +0000712 }
713
Chris Lattner7fe08b62010-11-30 21:32:12 +0000714 SmallVector<Value*, 16> NowLive;
Chris Lattner7fe08b62010-11-30 21:32:12 +0000715 for (SmallPtrSet<Value*, 16>::iterator I = DeadStackObjects.begin(),
716 E = DeadStackObjects.end(); I != E; ++I) {
Chris Lattner51d67ce2010-11-30 21:47:58 +0000717 // See if the loaded location could alias the stack location.
718 AliasAnalysis::Location StackLoc(*I, getPointerSize(*I, *AA));
719 if (!AA->isNoAlias(StackLoc, LoadedLoc))
Chris Lattner7fe08b62010-11-30 21:32:12 +0000720 NowLive.push_back(*I);
Owen Anderson32c4a052007-07-12 21:41:30 +0000721 }
722
Chris Lattner7fe08b62010-11-30 21:32:12 +0000723 for (SmallVector<Value*, 16>::iterator I = NowLive.begin(), E = NowLive.end();
Owen Anderson32c4a052007-07-12 21:41:30 +0000724 I != E; ++I)
Chris Lattner7fe08b62010-11-30 21:32:12 +0000725 DeadStackObjects.erase(*I);
Owen Anderson32c4a052007-07-12 21:41:30 +0000726}
727