blob: d7b0b64ea979355f3fbe8180323d27b580600675 [file] [log] [blame]
Owen Anderson78e02f72007-07-06 23:14:35 +00001//===- MemoryDependenceAnalysis.cpp - Mem Deps Implementation --*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Owen Anderson78e02f72007-07-06 23:14:35 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements an analysis that determines, for a given memory
11// operation, what preceding memory operations it depends on. It builds on
Owen Anderson80b1f092007-08-08 22:01:54 +000012// alias analysis information, and tries to provide a lazy, caching interface to
Owen Anderson78e02f72007-07-06 23:14:35 +000013// a common kind of alias information query.
14//
15//===----------------------------------------------------------------------===//
16
Chris Lattner0e575f42008-11-28 21:45:17 +000017#define DEBUG_TYPE "memdep"
Owen Anderson78e02f72007-07-06 23:14:35 +000018#include "llvm/Analysis/MemoryDependenceAnalysis.h"
19#include "llvm/Instructions.h"
Owen Andersonf6cec852009-03-09 05:12:38 +000020#include "llvm/IntrinsicInst.h"
Owen Anderson78e02f72007-07-06 23:14:35 +000021#include "llvm/Function.h"
22#include "llvm/Analysis/AliasAnalysis.h"
Chris Lattner6f7b2102009-11-27 22:05:15 +000023#include "llvm/Analysis/Dominators.h"
Chris Lattnere19e4ba2009-11-27 00:34:38 +000024#include "llvm/Analysis/InstructionSimplify.h"
Victor Hernandezf006b182009-10-27 20:05:49 +000025#include "llvm/Analysis/MemoryBuiltins.h"
Chris Lattner05e15f82009-12-09 01:59:31 +000026#include "llvm/Analysis/PHITransAddr.h"
Chris Lattnerbaad8882008-11-28 22:28:27 +000027#include "llvm/ADT/Statistic.h"
Duncan Sands7050f3d2008-12-10 09:38:36 +000028#include "llvm/ADT/STLExtras.h"
Chris Lattner4012fdd2008-12-09 06:28:49 +000029#include "llvm/Support/PredIteratorCache.h"
Chris Lattner0e575f42008-11-28 21:45:17 +000030#include "llvm/Support/Debug.h"
Owen Anderson78e02f72007-07-06 23:14:35 +000031using namespace llvm;
32
Chris Lattnerbf145d62008-12-01 01:15:42 +000033STATISTIC(NumCacheNonLocal, "Number of fully cached non-local responses");
34STATISTIC(NumCacheDirtyNonLocal, "Number of dirty cached non-local responses");
Chris Lattner0ec48dd2008-11-29 22:02:15 +000035STATISTIC(NumUncacheNonLocal, "Number of uncached non-local responses");
Chris Lattner6290f5c2008-12-07 08:50:20 +000036
37STATISTIC(NumCacheNonLocalPtr,
38 "Number of fully cached non-local ptr responses");
39STATISTIC(NumCacheDirtyNonLocalPtr,
40 "Number of cached, but dirty, non-local ptr responses");
41STATISTIC(NumUncacheNonLocalPtr,
42 "Number of uncached non-local ptr responses");
Chris Lattner11dcd8d2008-12-08 07:31:50 +000043STATISTIC(NumCacheCompleteNonLocalPtr,
44 "Number of block queries that were completely cached");
Chris Lattner6290f5c2008-12-07 08:50:20 +000045
Owen Anderson78e02f72007-07-06 23:14:35 +000046char MemoryDependenceAnalysis::ID = 0;
47
Owen Anderson78e02f72007-07-06 23:14:35 +000048// Register this pass...
Owen Anderson776ee1f2007-07-10 20:21:08 +000049static RegisterPass<MemoryDependenceAnalysis> X("memdep",
Chris Lattner0e575f42008-11-28 21:45:17 +000050 "Memory Dependence Analysis", false, true);
Owen Anderson78e02f72007-07-06 23:14:35 +000051
Chris Lattner4012fdd2008-12-09 06:28:49 +000052MemoryDependenceAnalysis::MemoryDependenceAnalysis()
53: FunctionPass(&ID), PredCache(0) {
54}
55MemoryDependenceAnalysis::~MemoryDependenceAnalysis() {
56}
57
58/// Clean up memory in between runs
59void MemoryDependenceAnalysis::releaseMemory() {
60 LocalDeps.clear();
61 NonLocalDeps.clear();
62 NonLocalPointerDeps.clear();
63 ReverseLocalDeps.clear();
64 ReverseNonLocalDeps.clear();
65 ReverseNonLocalPtrDeps.clear();
66 PredCache->clear();
67}
68
69
70
Owen Anderson78e02f72007-07-06 23:14:35 +000071/// getAnalysisUsage - Does not modify anything. It uses Alias Analysis.
72///
73void MemoryDependenceAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
74 AU.setPreservesAll();
75 AU.addRequiredTransitive<AliasAnalysis>();
Owen Anderson78e02f72007-07-06 23:14:35 +000076}
77
Chris Lattnerd777d402008-11-30 19:24:31 +000078bool MemoryDependenceAnalysis::runOnFunction(Function &) {
79 AA = &getAnalysis<AliasAnalysis>();
Chris Lattner4012fdd2008-12-09 06:28:49 +000080 if (PredCache == 0)
81 PredCache.reset(new PredIteratorCache());
Chris Lattnerd777d402008-11-30 19:24:31 +000082 return false;
83}
84
Chris Lattnerd44745d2008-12-07 18:39:13 +000085/// RemoveFromReverseMap - This is a helper function that removes Val from
86/// 'Inst's set in ReverseMap. If the set becomes empty, remove Inst's entry.
87template <typename KeyTy>
88static void RemoveFromReverseMap(DenseMap<Instruction*,
Chris Lattner6a0dcc12009-03-29 00:24:04 +000089 SmallPtrSet<KeyTy, 4> > &ReverseMap,
90 Instruction *Inst, KeyTy Val) {
91 typename DenseMap<Instruction*, SmallPtrSet<KeyTy, 4> >::iterator
Chris Lattnerd44745d2008-12-07 18:39:13 +000092 InstIt = ReverseMap.find(Inst);
93 assert(InstIt != ReverseMap.end() && "Reverse map out of sync?");
94 bool Found = InstIt->second.erase(Val);
95 assert(Found && "Invalid reverse map!"); Found=Found;
96 if (InstIt->second.empty())
97 ReverseMap.erase(InstIt);
98}
99
Chris Lattnerbf145d62008-12-01 01:15:42 +0000100
Chris Lattner8ef57c52008-12-07 00:35:51 +0000101/// getCallSiteDependencyFrom - Private helper for finding the local
102/// dependencies of a call site.
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000103MemDepResult MemoryDependenceAnalysis::
Chris Lattner20d6f092008-12-09 21:19:42 +0000104getCallSiteDependencyFrom(CallSite CS, bool isReadOnlyCall,
105 BasicBlock::iterator ScanIt, BasicBlock *BB) {
Owen Anderson642a9e32007-08-08 22:26:03 +0000106 // Walk backwards through the block, looking for dependencies
Chris Lattner5391a1d2008-11-29 03:47:00 +0000107 while (ScanIt != BB->begin()) {
108 Instruction *Inst = --ScanIt;
Owen Anderson5f323202007-07-10 17:59:22 +0000109
110 // If this inst is a memory op, get the pointer it accessed
Chris Lattner00314b32008-11-29 09:15:21 +0000111 Value *Pointer = 0;
112 uint64_t PointerSize = 0;
113 if (StoreInst *S = dyn_cast<StoreInst>(Inst)) {
114 Pointer = S->getPointerOperand();
Dan Gohmanf5812132009-07-31 20:53:12 +0000115 PointerSize = AA->getTypeStoreSize(S->getOperand(0)->getType());
Chris Lattner00314b32008-11-29 09:15:21 +0000116 } else if (VAArgInst *V = dyn_cast<VAArgInst>(Inst)) {
117 Pointer = V->getOperand(0);
Dan Gohmanf5812132009-07-31 20:53:12 +0000118 PointerSize = AA->getTypeStoreSize(V->getType());
Victor Hernandez046e78c2009-10-26 23:43:48 +0000119 } else if (isFreeCall(Inst)) {
120 Pointer = Inst->getOperand(1);
121 // calls to free() erase the entire structure
Chris Lattner6290f5c2008-12-07 08:50:20 +0000122 PointerSize = ~0ULL;
Chris Lattner00314b32008-11-29 09:15:21 +0000123 } else if (isa<CallInst>(Inst) || isa<InvokeInst>(Inst)) {
Owen Andersonf6cec852009-03-09 05:12:38 +0000124 // Debug intrinsics don't cause dependences.
Dale Johannesen497cb6f2009-03-11 21:13:01 +0000125 if (isa<DbgInfoIntrinsic>(Inst)) continue;
Chris Lattnerb51deb92008-12-05 21:04:20 +0000126 CallSite InstCS = CallSite::get(Inst);
127 // If these two calls do not interfere, look past it.
Chris Lattner20d6f092008-12-09 21:19:42 +0000128 switch (AA->getModRefInfo(CS, InstCS)) {
129 case AliasAnalysis::NoModRef:
130 // If the two calls don't interact (e.g. InstCS is readnone) keep
131 // scanning.
Chris Lattner00314b32008-11-29 09:15:21 +0000132 continue;
Chris Lattner20d6f092008-12-09 21:19:42 +0000133 case AliasAnalysis::Ref:
134 // If the two calls read the same memory locations and CS is a readonly
135 // function, then we have two cases: 1) the calls may not interfere with
136 // each other at all. 2) the calls may produce the same value. In case
137 // #1 we want to ignore the values, in case #2, we want to return Inst
138 // as a Def dependence. This allows us to CSE in cases like:
139 // X = strlen(P);
140 // memchr(...);
141 // Y = strlen(P); // Y = X
142 if (isReadOnlyCall) {
143 if (CS.getCalledFunction() != 0 &&
144 CS.getCalledFunction() == InstCS.getCalledFunction())
145 return MemDepResult::getDef(Inst);
146 // Ignore unrelated read/read call dependences.
147 continue;
148 }
149 // FALL THROUGH
150 default:
Chris Lattnerb51deb92008-12-05 21:04:20 +0000151 return MemDepResult::getClobber(Inst);
Chris Lattner20d6f092008-12-09 21:19:42 +0000152 }
Chris Lattnercfbb6342008-11-30 01:44:00 +0000153 } else {
154 // Non-memory instruction.
Owen Anderson202da142007-07-10 20:39:07 +0000155 continue;
Chris Lattnercfbb6342008-11-30 01:44:00 +0000156 }
Owen Anderson5f323202007-07-10 17:59:22 +0000157
Chris Lattnerb51deb92008-12-05 21:04:20 +0000158 if (AA->getModRefInfo(CS, Pointer, PointerSize) != AliasAnalysis::NoModRef)
159 return MemDepResult::getClobber(Inst);
Owen Anderson5f323202007-07-10 17:59:22 +0000160 }
161
Chris Lattner7ebcf032008-12-07 02:15:47 +0000162 // No dependence found. If this is the entry block of the function, it is a
163 // clobber, otherwise it is non-local.
164 if (BB != &BB->getParent()->getEntryBlock())
165 return MemDepResult::getNonLocal();
166 return MemDepResult::getClobber(ScanIt);
Owen Anderson5f323202007-07-10 17:59:22 +0000167}
168
Chris Lattnere79be942008-12-07 01:50:16 +0000169/// getPointerDependencyFrom - Return the instruction on which a memory
170/// location depends. If isLoad is true, this routine ignore may-aliases with
171/// read-only operations.
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000172MemDepResult MemoryDependenceAnalysis::
Owen Anderson4bc737c2009-10-28 06:18:42 +0000173getPointerDependencyFrom(Value *MemPtr, uint64_t MemSize, bool isLoad,
Chris Lattnere79be942008-12-07 01:50:16 +0000174 BasicBlock::iterator ScanIt, BasicBlock *BB) {
Chris Lattner7ebcf032008-12-07 02:15:47 +0000175
Chris Lattner1e8de492009-12-01 21:16:01 +0000176 Value *InvariantTag = 0;
Owen Anderson4bc737c2009-10-28 06:18:42 +0000177
Chris Lattner6290f5c2008-12-07 08:50:20 +0000178 // Walk backwards through the basic block, looking for dependencies.
Chris Lattner5391a1d2008-11-29 03:47:00 +0000179 while (ScanIt != BB->begin()) {
180 Instruction *Inst = --ScanIt;
Chris Lattnera161ab02008-11-29 09:09:48 +0000181
Owen Anderson4bc737c2009-10-28 06:18:42 +0000182 // If we're in an invariant region, no dependencies can be found before
183 // we pass an invariant-begin marker.
Chris Lattner1e8de492009-12-01 21:16:01 +0000184 if (InvariantTag == Inst) {
185 InvariantTag = 0;
Owen Anderson4bc737c2009-10-28 06:18:42 +0000186 continue;
Chris Lattner1ffb70f2009-12-01 21:15:15 +0000187 }
188
189 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
Owen Anderson9ff5a232009-12-02 07:35:19 +0000190 // Debug intrinsics don't cause dependences.
191 if (isa<DbgInfoIntrinsic>(Inst)) continue;
192
Owen Andersonb62f7922009-10-28 07:05:35 +0000193 // If we pass an invariant-end marker, then we've just entered an
194 // invariant region and can start ignoring dependencies.
Owen Anderson4bc737c2009-10-28 06:18:42 +0000195 if (II->getIntrinsicID() == Intrinsic::invariant_end) {
Owen Anderson9ff5a232009-12-02 07:35:19 +0000196 // FIXME: This only considers queries directly on the invariant-tagged
197 // pointer, not on query pointers that are indexed off of them. It'd
198 // be nice to handle that at some point.
199 AliasAnalysis::AliasResult R =
Benjamin Kramer0fea11a2009-12-02 15:33:44 +0000200 AA->alias(II->getOperand(3), ~0U, MemPtr, ~0U);
Owen Anderson4bc737c2009-10-28 06:18:42 +0000201 if (R == AliasAnalysis::MustAlias) {
Chris Lattner1e8de492009-12-01 21:16:01 +0000202 InvariantTag = II->getOperand(1);
Owen Anderson4bc737c2009-10-28 06:18:42 +0000203 continue;
204 }
Owen Andersonb62f7922009-10-28 07:05:35 +0000205
206 // If we reach a lifetime begin or end marker, then the query ends here
207 // because the value is undefined.
Owen Anderson9ff5a232009-12-02 07:35:19 +0000208 } else if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
209 // FIXME: This only considers queries directly on the invariant-tagged
210 // pointer, not on query pointers that are indexed off of them. It'd
211 // be nice to handle that at some point.
Owen Andersonb62f7922009-10-28 07:05:35 +0000212 AliasAnalysis::AliasResult R =
Benjamin Kramer0fea11a2009-12-02 15:33:44 +0000213 AA->alias(II->getOperand(2), ~0U, MemPtr, ~0U);
Owen Andersonb62f7922009-10-28 07:05:35 +0000214 if (R == AliasAnalysis::MustAlias)
215 return MemDepResult::getDef(II);
Owen Anderson4bc737c2009-10-28 06:18:42 +0000216 }
217 }
218
219 // If we're querying on a load and we're in an invariant region, we're done
220 // at this point. Nothing a load depends on can live in an invariant region.
Chris Lattner1e8de492009-12-01 21:16:01 +0000221 if (isLoad && InvariantTag) continue;
Owen Anderson4bc737c2009-10-28 06:18:42 +0000222
Chris Lattnercfbb6342008-11-30 01:44:00 +0000223 // Values depend on loads if the pointers are must aliased. This means that
224 // a load depends on another must aliased load from the same value.
Chris Lattnerb51deb92008-12-05 21:04:20 +0000225 if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
Chris Lattnerb51deb92008-12-05 21:04:20 +0000226 Value *Pointer = LI->getPointerOperand();
Dan Gohmanf5812132009-07-31 20:53:12 +0000227 uint64_t PointerSize = AA->getTypeStoreSize(LI->getType());
Chris Lattnerb51deb92008-12-05 21:04:20 +0000228
229 // If we found a pointer, check if it could be the same as our pointer.
Chris Lattnera161ab02008-11-29 09:09:48 +0000230 AliasAnalysis::AliasResult R =
Chris Lattnerd777d402008-11-30 19:24:31 +0000231 AA->alias(Pointer, PointerSize, MemPtr, MemSize);
Chris Lattnera161ab02008-11-29 09:09:48 +0000232 if (R == AliasAnalysis::NoAlias)
233 continue;
234
235 // May-alias loads don't depend on each other without a dependence.
Chris Lattnere79be942008-12-07 01:50:16 +0000236 if (isLoad && R == AliasAnalysis::MayAlias)
Chris Lattnera161ab02008-11-29 09:09:48 +0000237 continue;
Chris Lattner6290f5c2008-12-07 08:50:20 +0000238 // Stores depend on may and must aliased loads, loads depend on must-alias
239 // loads.
Chris Lattnerb51deb92008-12-05 21:04:20 +0000240 return MemDepResult::getDef(Inst);
241 }
242
243 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Owen Andersona85a6642009-10-28 06:30:52 +0000244 // There can't be stores to the value we care about inside an
245 // invariant region.
Chris Lattner1e8de492009-12-01 21:16:01 +0000246 if (InvariantTag) continue;
Owen Andersona85a6642009-10-28 06:30:52 +0000247
Chris Lattnerab9cf122009-05-25 21:28:56 +0000248 // If alias analysis can tell that this store is guaranteed to not modify
249 // the query pointer, ignore it. Use getModRefInfo to handle cases where
250 // the query pointer points to constant memory etc.
251 if (AA->getModRefInfo(SI, MemPtr, MemSize) == AliasAnalysis::NoModRef)
252 continue;
253
254 // Ok, this store might clobber the query pointer. Check to see if it is
255 // a must alias: in this case, we want to return this as a def.
Chris Lattnerb51deb92008-12-05 21:04:20 +0000256 Value *Pointer = SI->getPointerOperand();
Dan Gohmanf5812132009-07-31 20:53:12 +0000257 uint64_t PointerSize = AA->getTypeStoreSize(SI->getOperand(0)->getType());
Chris Lattnerab9cf122009-05-25 21:28:56 +0000258
Chris Lattnerb51deb92008-12-05 21:04:20 +0000259 // If we found a pointer, check if it could be the same as our pointer.
260 AliasAnalysis::AliasResult R =
261 AA->alias(Pointer, PointerSize, MemPtr, MemSize);
262
263 if (R == AliasAnalysis::NoAlias)
264 continue;
265 if (R == AliasAnalysis::MayAlias)
266 return MemDepResult::getClobber(Inst);
267 return MemDepResult::getDef(Inst);
Owen Anderson78e02f72007-07-06 23:14:35 +0000268 }
Chris Lattner237a8282008-11-30 01:39:32 +0000269
270 // If this is an allocation, and if we know that the accessed pointer is to
Chris Lattnerb51deb92008-12-05 21:04:20 +0000271 // the allocation, return Def. This means that there is no dependence and
Chris Lattner237a8282008-11-30 01:39:32 +0000272 // the access can be optimized based on that. For example, a load could
273 // turn into undef.
Victor Hernandez5c787362009-10-13 01:42:53 +0000274 // Note: Only determine this to be a malloc if Inst is the malloc call, not
275 // a subsequent bitcast of the malloc call result. There can be stores to
276 // the malloced memory between the malloc call and its bitcast uses, and we
277 // need to continue scanning until the malloc call.
Chris Lattner9b96eca2009-12-22 01:00:32 +0000278 if (isa<AllocaInst>(Inst) ||
279 (isa<CallInst>(Inst) && extractMallocCall(Inst))) {
Victor Hernandez46e83122009-09-18 21:34:51 +0000280 Value *AccessPtr = MemPtr->getUnderlyingObject();
281
282 if (AccessPtr == Inst ||
283 AA->alias(Inst, 1, AccessPtr, 1) == AliasAnalysis::MustAlias)
284 return MemDepResult::getDef(Inst);
285 continue;
286 }
287
Chris Lattnerb51deb92008-12-05 21:04:20 +0000288 // See if this instruction (e.g. a call or vaarg) mod/ref's the pointer.
Chris Lattner3579e442008-12-09 19:47:40 +0000289 switch (AA->getModRefInfo(Inst, MemPtr, MemSize)) {
290 case AliasAnalysis::NoModRef:
291 // If the call has no effect on the queried pointer, just ignore it.
Chris Lattner25a08142008-11-29 08:51:16 +0000292 continue;
Owen Andersona85a6642009-10-28 06:30:52 +0000293 case AliasAnalysis::Mod:
294 // If we're in an invariant region, we can ignore calls that ONLY
295 // modify the pointer.
Chris Lattner1e8de492009-12-01 21:16:01 +0000296 if (InvariantTag) continue;
Owen Andersona85a6642009-10-28 06:30:52 +0000297 return MemDepResult::getClobber(Inst);
Chris Lattner3579e442008-12-09 19:47:40 +0000298 case AliasAnalysis::Ref:
299 // If the call is known to never store to the pointer, and if this is a
300 // load query, we can safely ignore it (scan past it).
301 if (isLoad)
302 continue;
Chris Lattner3579e442008-12-09 19:47:40 +0000303 default:
304 // Otherwise, there is a potential dependence. Return a clobber.
305 return MemDepResult::getClobber(Inst);
306 }
Owen Anderson78e02f72007-07-06 23:14:35 +0000307 }
308
Chris Lattner7ebcf032008-12-07 02:15:47 +0000309 // No dependence found. If this is the entry block of the function, it is a
310 // clobber, otherwise it is non-local.
311 if (BB != &BB->getParent()->getEntryBlock())
312 return MemDepResult::getNonLocal();
313 return MemDepResult::getClobber(ScanIt);
Owen Anderson78e02f72007-07-06 23:14:35 +0000314}
315
Chris Lattner5391a1d2008-11-29 03:47:00 +0000316/// getDependency - Return the instruction on which a memory operation
317/// depends.
318MemDepResult MemoryDependenceAnalysis::getDependency(Instruction *QueryInst) {
319 Instruction *ScanPos = QueryInst;
320
321 // Check for a cached result
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000322 MemDepResult &LocalCache = LocalDeps[QueryInst];
Chris Lattner5391a1d2008-11-29 03:47:00 +0000323
Chris Lattner0ec48dd2008-11-29 22:02:15 +0000324 // If the cached entry is non-dirty, just return it. Note that this depends
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000325 // on MemDepResult's default constructing to 'dirty'.
326 if (!LocalCache.isDirty())
327 return LocalCache;
Chris Lattner5391a1d2008-11-29 03:47:00 +0000328
329 // Otherwise, if we have a dirty entry, we know we can start the scan at that
330 // instruction, which may save us some work.
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000331 if (Instruction *Inst = LocalCache.getInst()) {
Chris Lattner5391a1d2008-11-29 03:47:00 +0000332 ScanPos = Inst;
Chris Lattner4a69bad2008-11-30 02:52:26 +0000333
Chris Lattnerd44745d2008-12-07 18:39:13 +0000334 RemoveFromReverseMap(ReverseLocalDeps, Inst, QueryInst);
Chris Lattner4a69bad2008-11-30 02:52:26 +0000335 }
Chris Lattner5391a1d2008-11-29 03:47:00 +0000336
Chris Lattnere79be942008-12-07 01:50:16 +0000337 BasicBlock *QueryParent = QueryInst->getParent();
338
339 Value *MemPtr = 0;
340 uint64_t MemSize = 0;
341
Chris Lattner5391a1d2008-11-29 03:47:00 +0000342 // Do the scan.
Chris Lattnere79be942008-12-07 01:50:16 +0000343 if (BasicBlock::iterator(QueryInst) == QueryParent->begin()) {
Chris Lattner7ebcf032008-12-07 02:15:47 +0000344 // No dependence found. If this is the entry block of the function, it is a
345 // clobber, otherwise it is non-local.
346 if (QueryParent != &QueryParent->getParent()->getEntryBlock())
347 LocalCache = MemDepResult::getNonLocal();
348 else
349 LocalCache = MemDepResult::getClobber(QueryInst);
Chris Lattnere79be942008-12-07 01:50:16 +0000350 } else if (StoreInst *SI = dyn_cast<StoreInst>(QueryInst)) {
351 // If this is a volatile store, don't mess around with it. Just return the
352 // previous instruction as a clobber.
353 if (SI->isVolatile())
354 LocalCache = MemDepResult::getClobber(--BasicBlock::iterator(ScanPos));
355 else {
356 MemPtr = SI->getPointerOperand();
Dan Gohmanf5812132009-07-31 20:53:12 +0000357 MemSize = AA->getTypeStoreSize(SI->getOperand(0)->getType());
Chris Lattnere79be942008-12-07 01:50:16 +0000358 }
359 } else if (LoadInst *LI = dyn_cast<LoadInst>(QueryInst)) {
360 // If this is a volatile load, don't mess around with it. Just return the
361 // previous instruction as a clobber.
362 if (LI->isVolatile())
363 LocalCache = MemDepResult::getClobber(--BasicBlock::iterator(ScanPos));
364 else {
365 MemPtr = LI->getPointerOperand();
Dan Gohmanf5812132009-07-31 20:53:12 +0000366 MemSize = AA->getTypeStoreSize(LI->getType());
Chris Lattnere79be942008-12-07 01:50:16 +0000367 }
Victor Hernandez66284e02009-10-24 04:23:03 +0000368 } else if (isFreeCall(QueryInst)) {
Victor Hernandez046e78c2009-10-26 23:43:48 +0000369 MemPtr = QueryInst->getOperand(1);
Victor Hernandez66284e02009-10-24 04:23:03 +0000370 // calls to free() erase the entire structure, not just a field.
371 MemSize = ~0UL;
Chris Lattnere79be942008-12-07 01:50:16 +0000372 } else if (isa<CallInst>(QueryInst) || isa<InvokeInst>(QueryInst)) {
Nick Lewyckyd801c102009-11-28 21:27:49 +0000373 int IntrinsicID = 0; // Intrinsic IDs start at 1.
374 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(QueryInst))
375 IntrinsicID = II->getIntrinsicID();
376
377 switch (IntrinsicID) {
Nick Lewycky93d33112009-12-05 06:37:24 +0000378 case Intrinsic::lifetime_start:
379 case Intrinsic::lifetime_end:
380 case Intrinsic::invariant_start:
381 MemPtr = QueryInst->getOperand(2);
382 MemSize = cast<ConstantInt>(QueryInst->getOperand(1))->getZExtValue();
383 break;
384 case Intrinsic::invariant_end:
385 MemPtr = QueryInst->getOperand(3);
386 MemSize = cast<ConstantInt>(QueryInst->getOperand(2))->getZExtValue();
387 break;
388 default:
389 CallSite QueryCS = CallSite::get(QueryInst);
390 bool isReadOnly = AA->onlyReadsMemory(QueryCS);
391 LocalCache = getCallSiteDependencyFrom(QueryCS, isReadOnly, ScanPos,
392 QueryParent);
393 break;
Nick Lewyckyd801c102009-11-28 21:27:49 +0000394 }
Chris Lattnere79be942008-12-07 01:50:16 +0000395 } else {
396 // Non-memory instruction.
397 LocalCache = MemDepResult::getClobber(--BasicBlock::iterator(ScanPos));
398 }
399
400 // If we need to do a pointer scan, make it happen.
Nick Lewyckyd801c102009-11-28 21:27:49 +0000401 if (MemPtr) {
402 bool isLoad = !QueryInst->mayWriteToMemory();
403 if (IntrinsicInst *II = dyn_cast<MemoryUseIntrinsic>(QueryInst)) {
404 isLoad |= II->getIntrinsicID() == Intrinsic::lifetime_end;
405 }
406 LocalCache = getPointerDependencyFrom(MemPtr, MemSize, isLoad, ScanPos,
407 QueryParent);
408 }
Chris Lattner5391a1d2008-11-29 03:47:00 +0000409
410 // Remember the result!
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000411 if (Instruction *I = LocalCache.getInst())
Chris Lattner8c465272008-11-29 09:20:15 +0000412 ReverseLocalDeps[I].insert(QueryInst);
Chris Lattner5391a1d2008-11-29 03:47:00 +0000413
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000414 return LocalCache;
Chris Lattner5391a1d2008-11-29 03:47:00 +0000415}
416
Chris Lattner12a7db32009-01-22 07:04:01 +0000417#ifndef NDEBUG
418/// AssertSorted - This method is used when -debug is specified to verify that
419/// cache arrays are properly kept sorted.
420static void AssertSorted(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
421 int Count = -1) {
422 if (Count == -1) Count = Cache.size();
423 if (Count == 0) return;
424
425 for (unsigned i = 1; i != unsigned(Count); ++i)
Chris Lattnere18b9712009-12-09 07:08:01 +0000426 assert(!(Cache[i] < Cache[i-1]) && "Cache isn't sorted!");
Chris Lattner12a7db32009-01-22 07:04:01 +0000427}
428#endif
429
Chris Lattner1559b362008-12-09 19:38:05 +0000430/// getNonLocalCallDependency - Perform a full dependency query for the
431/// specified call, returning the set of blocks that the value is
Chris Lattner37d041c2008-11-30 01:18:27 +0000432/// potentially live across. The returned set of results will include a
433/// "NonLocal" result for all blocks where the value is live across.
434///
Chris Lattner1559b362008-12-09 19:38:05 +0000435/// This method assumes the instruction returns a "NonLocal" dependency
Chris Lattner37d041c2008-11-30 01:18:27 +0000436/// within its own block.
437///
Chris Lattner1559b362008-12-09 19:38:05 +0000438/// This returns a reference to an internal data structure that may be
439/// invalidated on the next non-local query or when an instruction is
440/// removed. Clients must copy this data if they want it around longer than
441/// that.
Chris Lattnerbf145d62008-12-01 01:15:42 +0000442const MemoryDependenceAnalysis::NonLocalDepInfo &
Chris Lattner1559b362008-12-09 19:38:05 +0000443MemoryDependenceAnalysis::getNonLocalCallDependency(CallSite QueryCS) {
444 assert(getDependency(QueryCS.getInstruction()).isNonLocal() &&
445 "getNonLocalCallDependency should only be used on calls with non-local deps!");
446 PerInstNLInfo &CacheP = NonLocalDeps[QueryCS.getInstruction()];
Chris Lattnerbf145d62008-12-01 01:15:42 +0000447 NonLocalDepInfo &Cache = CacheP.first;
Chris Lattner37d041c2008-11-30 01:18:27 +0000448
449 /// DirtyBlocks - This is the set of blocks that need to be recomputed. In
450 /// the cached case, this can happen due to instructions being deleted etc. In
451 /// the uncached case, this starts out as the set of predecessors we care
452 /// about.
453 SmallVector<BasicBlock*, 32> DirtyBlocks;
454
455 if (!Cache.empty()) {
Chris Lattnerbf145d62008-12-01 01:15:42 +0000456 // Okay, we have a cache entry. If we know it is not dirty, just return it
457 // with no computation.
458 if (!CacheP.second) {
459 NumCacheNonLocal++;
460 return Cache;
461 }
462
Chris Lattner37d041c2008-11-30 01:18:27 +0000463 // If we already have a partially computed set of results, scan them to
Chris Lattnerbf145d62008-12-01 01:15:42 +0000464 // determine what is dirty, seeding our initial DirtyBlocks worklist.
465 for (NonLocalDepInfo::iterator I = Cache.begin(), E = Cache.end();
466 I != E; ++I)
Chris Lattnere18b9712009-12-09 07:08:01 +0000467 if (I->getResult().isDirty())
468 DirtyBlocks.push_back(I->getBB());
Chris Lattner37d041c2008-11-30 01:18:27 +0000469
Chris Lattnerbf145d62008-12-01 01:15:42 +0000470 // Sort the cache so that we can do fast binary search lookups below.
471 std::sort(Cache.begin(), Cache.end());
Chris Lattner37d041c2008-11-30 01:18:27 +0000472
Chris Lattnerbf145d62008-12-01 01:15:42 +0000473 ++NumCacheDirtyNonLocal;
Chris Lattner37d041c2008-11-30 01:18:27 +0000474 //cerr << "CACHED CASE: " << DirtyBlocks.size() << " dirty: "
475 // << Cache.size() << " cached: " << *QueryInst;
476 } else {
477 // Seed DirtyBlocks with each of the preds of QueryInst's block.
Chris Lattner1559b362008-12-09 19:38:05 +0000478 BasicBlock *QueryBB = QueryCS.getInstruction()->getParent();
Chris Lattner511b36c2008-12-09 06:44:17 +0000479 for (BasicBlock **PI = PredCache->GetPreds(QueryBB); *PI; ++PI)
480 DirtyBlocks.push_back(*PI);
Chris Lattner37d041c2008-11-30 01:18:27 +0000481 NumUncacheNonLocal++;
482 }
483
Chris Lattner20d6f092008-12-09 21:19:42 +0000484 // isReadonlyCall - If this is a read-only call, we can be more aggressive.
485 bool isReadonlyCall = AA->onlyReadsMemory(QueryCS);
Chris Lattner9e59c642008-12-15 03:35:32 +0000486
Chris Lattnerbf145d62008-12-01 01:15:42 +0000487 SmallPtrSet<BasicBlock*, 64> Visited;
488
489 unsigned NumSortedEntries = Cache.size();
Chris Lattner12a7db32009-01-22 07:04:01 +0000490 DEBUG(AssertSorted(Cache));
Chris Lattnerbf145d62008-12-01 01:15:42 +0000491
Chris Lattner37d041c2008-11-30 01:18:27 +0000492 // Iterate while we still have blocks to update.
493 while (!DirtyBlocks.empty()) {
494 BasicBlock *DirtyBB = DirtyBlocks.back();
495 DirtyBlocks.pop_back();
496
Chris Lattnerbf145d62008-12-01 01:15:42 +0000497 // Already processed this block?
498 if (!Visited.insert(DirtyBB))
499 continue;
Chris Lattner37d041c2008-11-30 01:18:27 +0000500
Chris Lattnerbf145d62008-12-01 01:15:42 +0000501 // Do a binary search to see if we already have an entry for this block in
502 // the cache set. If so, find it.
Chris Lattner12a7db32009-01-22 07:04:01 +0000503 DEBUG(AssertSorted(Cache, NumSortedEntries));
Chris Lattnerbf145d62008-12-01 01:15:42 +0000504 NonLocalDepInfo::iterator Entry =
505 std::upper_bound(Cache.begin(), Cache.begin()+NumSortedEntries,
Chris Lattnerdad451c2009-12-09 07:31:04 +0000506 NonLocalDepEntry(DirtyBB));
Chris Lattnere18b9712009-12-09 07:08:01 +0000507 if (Entry != Cache.begin() && prior(Entry)->getBB() == DirtyBB)
Chris Lattnerbf145d62008-12-01 01:15:42 +0000508 --Entry;
509
Chris Lattnere18b9712009-12-09 07:08:01 +0000510 NonLocalDepEntry *ExistingResult = 0;
Chris Lattnerbf145d62008-12-01 01:15:42 +0000511 if (Entry != Cache.begin()+NumSortedEntries &&
Chris Lattnere18b9712009-12-09 07:08:01 +0000512 Entry->getBB() == DirtyBB) {
Chris Lattnerbf145d62008-12-01 01:15:42 +0000513 // If we already have an entry, and if it isn't already dirty, the block
514 // is done.
Chris Lattnere18b9712009-12-09 07:08:01 +0000515 if (!Entry->getResult().isDirty())
Chris Lattnerbf145d62008-12-01 01:15:42 +0000516 continue;
517
518 // Otherwise, remember this slot so we can update the value.
Chris Lattnere18b9712009-12-09 07:08:01 +0000519 ExistingResult = &*Entry;
Chris Lattnerbf145d62008-12-01 01:15:42 +0000520 }
521
Chris Lattner37d041c2008-11-30 01:18:27 +0000522 // If the dirty entry has a pointer, start scanning from it so we don't have
523 // to rescan the entire block.
524 BasicBlock::iterator ScanPos = DirtyBB->end();
Chris Lattnerbf145d62008-12-01 01:15:42 +0000525 if (ExistingResult) {
Chris Lattnere18b9712009-12-09 07:08:01 +0000526 if (Instruction *Inst = ExistingResult->getResult().getInst()) {
Chris Lattnerbf145d62008-12-01 01:15:42 +0000527 ScanPos = Inst;
Chris Lattnerbf145d62008-12-01 01:15:42 +0000528 // We're removing QueryInst's use of Inst.
Chris Lattner1559b362008-12-09 19:38:05 +0000529 RemoveFromReverseMap(ReverseNonLocalDeps, Inst,
530 QueryCS.getInstruction());
Chris Lattnerbf145d62008-12-01 01:15:42 +0000531 }
Chris Lattnerf68f3102008-11-30 02:28:25 +0000532 }
Chris Lattner37d041c2008-11-30 01:18:27 +0000533
Chris Lattner73ec3cd2008-11-30 01:26:32 +0000534 // Find out if this block has a local dependency for QueryInst.
Chris Lattnerd8dd9342008-12-07 01:21:14 +0000535 MemDepResult Dep;
Chris Lattnere79be942008-12-07 01:50:16 +0000536
Chris Lattner1559b362008-12-09 19:38:05 +0000537 if (ScanPos != DirtyBB->begin()) {
Chris Lattner20d6f092008-12-09 21:19:42 +0000538 Dep = getCallSiteDependencyFrom(QueryCS, isReadonlyCall,ScanPos, DirtyBB);
Chris Lattner1559b362008-12-09 19:38:05 +0000539 } else if (DirtyBB != &DirtyBB->getParent()->getEntryBlock()) {
540 // No dependence found. If this is the entry block of the function, it is
541 // a clobber, otherwise it is non-local.
542 Dep = MemDepResult::getNonLocal();
Chris Lattnere79be942008-12-07 01:50:16 +0000543 } else {
Chris Lattner1559b362008-12-09 19:38:05 +0000544 Dep = MemDepResult::getClobber(ScanPos);
Chris Lattnere79be942008-12-07 01:50:16 +0000545 }
546
Chris Lattnerbf145d62008-12-01 01:15:42 +0000547 // If we had a dirty entry for the block, update it. Otherwise, just add
548 // a new entry.
549 if (ExistingResult)
Chris Lattnerdad451c2009-12-09 07:31:04 +0000550 ExistingResult->setResult(Dep, 0);
Chris Lattnerbf145d62008-12-01 01:15:42 +0000551 else
Chris Lattnerdad451c2009-12-09 07:31:04 +0000552 Cache.push_back(NonLocalDepEntry(DirtyBB, Dep, 0));
Chris Lattnerbf145d62008-12-01 01:15:42 +0000553
Chris Lattner37d041c2008-11-30 01:18:27 +0000554 // If the block has a dependency (i.e. it isn't completely transparent to
Chris Lattnerbf145d62008-12-01 01:15:42 +0000555 // the value), remember the association!
556 if (!Dep.isNonLocal()) {
Chris Lattner37d041c2008-11-30 01:18:27 +0000557 // Keep the ReverseNonLocalDeps map up to date so we can efficiently
558 // update this when we remove instructions.
Chris Lattnerbf145d62008-12-01 01:15:42 +0000559 if (Instruction *Inst = Dep.getInst())
Chris Lattner1559b362008-12-09 19:38:05 +0000560 ReverseNonLocalDeps[Inst].insert(QueryCS.getInstruction());
Chris Lattnerbf145d62008-12-01 01:15:42 +0000561 } else {
Chris Lattner37d041c2008-11-30 01:18:27 +0000562
Chris Lattnerbf145d62008-12-01 01:15:42 +0000563 // If the block *is* completely transparent to the load, we need to check
564 // the predecessors of this block. Add them to our worklist.
Chris Lattner511b36c2008-12-09 06:44:17 +0000565 for (BasicBlock **PI = PredCache->GetPreds(DirtyBB); *PI; ++PI)
566 DirtyBlocks.push_back(*PI);
Chris Lattnerbf145d62008-12-01 01:15:42 +0000567 }
Chris Lattner37d041c2008-11-30 01:18:27 +0000568 }
569
Chris Lattnerbf145d62008-12-01 01:15:42 +0000570 return Cache;
Chris Lattner37d041c2008-11-30 01:18:27 +0000571}
572
Chris Lattner7ebcf032008-12-07 02:15:47 +0000573/// getNonLocalPointerDependency - Perform a full dependency query for an
574/// access to the specified (non-volatile) memory location, returning the
575/// set of instructions that either define or clobber the value.
576///
577/// This method assumes the pointer has a "NonLocal" dependency within its
578/// own block.
579///
580void MemoryDependenceAnalysis::
581getNonLocalPointerDependency(Value *Pointer, bool isLoad, BasicBlock *FromBB,
582 SmallVectorImpl<NonLocalDepEntry> &Result) {
Chris Lattner3f7eb5b2008-12-07 18:45:15 +0000583 assert(isa<PointerType>(Pointer->getType()) &&
584 "Can't get pointer deps of a non-pointer!");
Chris Lattner9a193fd2008-12-07 02:56:57 +0000585 Result.clear();
586
Chris Lattner7ebcf032008-12-07 02:15:47 +0000587 // We know that the pointer value is live into FromBB find the def/clobbers
588 // from presecessors.
Chris Lattner7ebcf032008-12-07 02:15:47 +0000589 const Type *EltTy = cast<PointerType>(Pointer->getType())->getElementType();
Dan Gohmanf5812132009-07-31 20:53:12 +0000590 uint64_t PointeeSize = AA->getTypeStoreSize(EltTy);
Chris Lattner7ebcf032008-12-07 02:15:47 +0000591
Chris Lattner05e15f82009-12-09 01:59:31 +0000592 PHITransAddr Address(Pointer, TD);
593
Chris Lattner9e59c642008-12-15 03:35:32 +0000594 // This is the set of blocks we've inspected, and the pointer we consider in
595 // each block. Because of critical edges, we currently bail out if querying
596 // a block with multiple different pointers. This can happen during PHI
597 // translation.
598 DenseMap<BasicBlock*, Value*> Visited;
Chris Lattner05e15f82009-12-09 01:59:31 +0000599 if (!getNonLocalPointerDepFromBB(Address, PointeeSize, isLoad, FromBB,
Chris Lattner9e59c642008-12-15 03:35:32 +0000600 Result, Visited, true))
601 return;
Chris Lattner3af23f82008-12-15 04:58:29 +0000602 Result.clear();
Chris Lattnere18b9712009-12-09 07:08:01 +0000603 Result.push_back(NonLocalDepEntry(FromBB,
Chris Lattnerdad451c2009-12-09 07:31:04 +0000604 MemDepResult::getClobber(FromBB->begin()),
605 Pointer));
Chris Lattner9a193fd2008-12-07 02:56:57 +0000606}
607
Chris Lattner9863c3f2008-12-09 07:47:11 +0000608/// GetNonLocalInfoForBlock - Compute the memdep value for BB with
609/// Pointer/PointeeSize using either cached information in Cache or by doing a
610/// lookup (which may use dirty cache info if available). If we do a lookup,
611/// add the result to the cache.
612MemDepResult MemoryDependenceAnalysis::
613GetNonLocalInfoForBlock(Value *Pointer, uint64_t PointeeSize,
614 bool isLoad, BasicBlock *BB,
615 NonLocalDepInfo *Cache, unsigned NumSortedEntries) {
616
617 // Do a binary search to see if we already have an entry for this block in
618 // the cache set. If so, find it.
619 NonLocalDepInfo::iterator Entry =
620 std::upper_bound(Cache->begin(), Cache->begin()+NumSortedEntries,
Chris Lattnerdad451c2009-12-09 07:31:04 +0000621 NonLocalDepEntry(BB));
Chris Lattnere18b9712009-12-09 07:08:01 +0000622 if (Entry != Cache->begin() && (Entry-1)->getBB() == BB)
Chris Lattner9863c3f2008-12-09 07:47:11 +0000623 --Entry;
624
Chris Lattnere18b9712009-12-09 07:08:01 +0000625 NonLocalDepEntry *ExistingResult = 0;
626 if (Entry != Cache->begin()+NumSortedEntries && Entry->getBB() == BB)
627 ExistingResult = &*Entry;
Chris Lattner9863c3f2008-12-09 07:47:11 +0000628
629 // If we have a cached entry, and it is non-dirty, use it as the value for
630 // this dependency.
Chris Lattnere18b9712009-12-09 07:08:01 +0000631 if (ExistingResult && !ExistingResult->getResult().isDirty()) {
Chris Lattner9863c3f2008-12-09 07:47:11 +0000632 ++NumCacheNonLocalPtr;
Chris Lattnere18b9712009-12-09 07:08:01 +0000633 return ExistingResult->getResult();
Chris Lattner9863c3f2008-12-09 07:47:11 +0000634 }
635
636 // Otherwise, we have to scan for the value. If we have a dirty cache
637 // entry, start scanning from its position, otherwise we scan from the end
638 // of the block.
639 BasicBlock::iterator ScanPos = BB->end();
Chris Lattnere18b9712009-12-09 07:08:01 +0000640 if (ExistingResult && ExistingResult->getResult().getInst()) {
641 assert(ExistingResult->getResult().getInst()->getParent() == BB &&
Chris Lattner9863c3f2008-12-09 07:47:11 +0000642 "Instruction invalidated?");
643 ++NumCacheDirtyNonLocalPtr;
Chris Lattnere18b9712009-12-09 07:08:01 +0000644 ScanPos = ExistingResult->getResult().getInst();
Chris Lattner9863c3f2008-12-09 07:47:11 +0000645
646 // Eliminating the dirty entry from 'Cache', so update the reverse info.
647 ValueIsLoadPair CacheKey(Pointer, isLoad);
Chris Lattner6a0dcc12009-03-29 00:24:04 +0000648 RemoveFromReverseMap(ReverseNonLocalPtrDeps, ScanPos, CacheKey);
Chris Lattner9863c3f2008-12-09 07:47:11 +0000649 } else {
650 ++NumUncacheNonLocalPtr;
651 }
652
653 // Scan the block for the dependency.
654 MemDepResult Dep = getPointerDependencyFrom(Pointer, PointeeSize, isLoad,
655 ScanPos, BB);
656
657 // If we had a dirty entry for the block, update it. Otherwise, just add
658 // a new entry.
659 if (ExistingResult)
Chris Lattnerdad451c2009-12-09 07:31:04 +0000660 ExistingResult->setResult(Dep, Pointer);
Chris Lattner9863c3f2008-12-09 07:47:11 +0000661 else
Chris Lattnerdad451c2009-12-09 07:31:04 +0000662 Cache->push_back(NonLocalDepEntry(BB, Dep, Pointer));
Chris Lattner9863c3f2008-12-09 07:47:11 +0000663
664 // If the block has a dependency (i.e. it isn't completely transparent to
665 // the value), remember the reverse association because we just added it
666 // to Cache!
667 if (Dep.isNonLocal())
668 return Dep;
669
670 // Keep the ReverseNonLocalPtrDeps map up to date so we can efficiently
671 // update MemDep when we remove instructions.
672 Instruction *Inst = Dep.getInst();
673 assert(Inst && "Didn't depend on anything?");
674 ValueIsLoadPair CacheKey(Pointer, isLoad);
Chris Lattner6a0dcc12009-03-29 00:24:04 +0000675 ReverseNonLocalPtrDeps[Inst].insert(CacheKey);
Chris Lattner9863c3f2008-12-09 07:47:11 +0000676 return Dep;
677}
678
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000679/// SortNonLocalDepInfoCache - Sort the a NonLocalDepInfo cache, given a certain
680/// number of elements in the array that are already properly ordered. This is
681/// optimized for the case when only a few entries are added.
682static void
683SortNonLocalDepInfoCache(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
684 unsigned NumSortedEntries) {
685 switch (Cache.size() - NumSortedEntries) {
686 case 0:
687 // done, no new entries.
688 break;
689 case 2: {
690 // Two new entries, insert the last one into place.
Chris Lattnere18b9712009-12-09 07:08:01 +0000691 NonLocalDepEntry Val = Cache.back();
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000692 Cache.pop_back();
693 MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
694 std::upper_bound(Cache.begin(), Cache.end()-1, Val);
695 Cache.insert(Entry, Val);
696 // FALL THROUGH.
697 }
698 case 1:
699 // One new entry, Just insert the new value at the appropriate position.
700 if (Cache.size() != 1) {
Chris Lattnere18b9712009-12-09 07:08:01 +0000701 NonLocalDepEntry Val = Cache.back();
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000702 Cache.pop_back();
703 MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
704 std::upper_bound(Cache.begin(), Cache.end(), Val);
705 Cache.insert(Entry, Val);
706 }
707 break;
708 default:
709 // Added many values, do a full scale sort.
710 std::sort(Cache.begin(), Cache.end());
711 break;
712 }
713}
714
Chris Lattner9e59c642008-12-15 03:35:32 +0000715/// getNonLocalPointerDepFromBB - Perform a dependency query based on
716/// pointer/pointeesize starting at the end of StartBB. Add any clobber/def
717/// results to the results vector and keep track of which blocks are visited in
718/// 'Visited'.
719///
720/// This has special behavior for the first block queries (when SkipFirstBlock
721/// is true). In this special case, it ignores the contents of the specified
722/// block and starts returning dependence info for its predecessors.
723///
724/// This function returns false on success, or true to indicate that it could
725/// not compute dependence information for some reason. This should be treated
726/// as a clobber dependence on the first instruction in the predecessor block.
727bool MemoryDependenceAnalysis::
Chris Lattner05e15f82009-12-09 01:59:31 +0000728getNonLocalPointerDepFromBB(const PHITransAddr &Pointer, uint64_t PointeeSize,
Chris Lattner9863c3f2008-12-09 07:47:11 +0000729 bool isLoad, BasicBlock *StartBB,
730 SmallVectorImpl<NonLocalDepEntry> &Result,
Chris Lattner9e59c642008-12-15 03:35:32 +0000731 DenseMap<BasicBlock*, Value*> &Visited,
732 bool SkipFirstBlock) {
Chris Lattner66364342009-09-20 22:44:26 +0000733
Chris Lattner6290f5c2008-12-07 08:50:20 +0000734 // Look up the cached info for Pointer.
Chris Lattner05e15f82009-12-09 01:59:31 +0000735 ValueIsLoadPair CacheKey(Pointer.getAddr(), isLoad);
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000736
Chris Lattner9e59c642008-12-15 03:35:32 +0000737 std::pair<BBSkipFirstBlockPair, NonLocalDepInfo> *CacheInfo =
738 &NonLocalPointerDeps[CacheKey];
739 NonLocalDepInfo *Cache = &CacheInfo->second;
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000740
741 // If we have valid cached information for exactly the block we are
742 // investigating, just return it with no recomputation.
Chris Lattner9e59c642008-12-15 03:35:32 +0000743 if (CacheInfo->first == BBSkipFirstBlockPair(StartBB, SkipFirstBlock)) {
Chris Lattnerf4789512008-12-16 07:10:09 +0000744 // We have a fully cached result for this query then we can just return the
745 // cached results and populate the visited set. However, we have to verify
746 // that we don't already have conflicting results for these blocks. Check
747 // to ensure that if a block in the results set is in the visited set that
748 // it was for the same pointer query.
749 if (!Visited.empty()) {
750 for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
751 I != E; ++I) {
Chris Lattnere18b9712009-12-09 07:08:01 +0000752 DenseMap<BasicBlock*, Value*>::iterator VI = Visited.find(I->getBB());
Chris Lattner05e15f82009-12-09 01:59:31 +0000753 if (VI == Visited.end() || VI->second == Pointer.getAddr())
754 continue;
Chris Lattnerf4789512008-12-16 07:10:09 +0000755
756 // We have a pointer mismatch in a block. Just return clobber, saying
757 // that something was clobbered in this result. We could also do a
758 // non-fully cached query, but there is little point in doing this.
759 return true;
760 }
761 }
762
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000763 for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
Chris Lattnerf4789512008-12-16 07:10:09 +0000764 I != E; ++I) {
Chris Lattnere18b9712009-12-09 07:08:01 +0000765 Visited.insert(std::make_pair(I->getBB(), Pointer.getAddr()));
766 if (!I->getResult().isNonLocal())
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000767 Result.push_back(*I);
Chris Lattnerf4789512008-12-16 07:10:09 +0000768 }
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000769 ++NumCacheCompleteNonLocalPtr;
Chris Lattner9e59c642008-12-15 03:35:32 +0000770 return false;
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000771 }
772
773 // Otherwise, either this is a new block, a block with an invalid cache
774 // pointer or one that we're about to invalidate by putting more info into it
775 // than its valid cache info. If empty, the result will be valid cache info,
776 // otherwise it isn't.
Chris Lattner9e59c642008-12-15 03:35:32 +0000777 if (Cache->empty())
778 CacheInfo->first = BBSkipFirstBlockPair(StartBB, SkipFirstBlock);
779 else
780 CacheInfo->first = BBSkipFirstBlockPair();
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000781
782 SmallVector<BasicBlock*, 32> Worklist;
783 Worklist.push_back(StartBB);
Chris Lattner6290f5c2008-12-07 08:50:20 +0000784
785 // Keep track of the entries that we know are sorted. Previously cached
786 // entries will all be sorted. The entries we add we only sort on demand (we
787 // don't insert every element into its sorted position). We know that we
788 // won't get any reuse from currently inserted values, because we don't
789 // revisit blocks after we insert info for them.
790 unsigned NumSortedEntries = Cache->size();
Chris Lattner12a7db32009-01-22 07:04:01 +0000791 DEBUG(AssertSorted(*Cache));
Chris Lattner6290f5c2008-12-07 08:50:20 +0000792
Chris Lattner7ebcf032008-12-07 02:15:47 +0000793 while (!Worklist.empty()) {
Chris Lattner9a193fd2008-12-07 02:56:57 +0000794 BasicBlock *BB = Worklist.pop_back_val();
Chris Lattner7ebcf032008-12-07 02:15:47 +0000795
Chris Lattner65633712008-12-09 07:52:59 +0000796 // Skip the first block if we have it.
Chris Lattner9e59c642008-12-15 03:35:32 +0000797 if (!SkipFirstBlock) {
Chris Lattner65633712008-12-09 07:52:59 +0000798 // Analyze the dependency of *Pointer in FromBB. See if we already have
799 // been here.
Chris Lattner9e59c642008-12-15 03:35:32 +0000800 assert(Visited.count(BB) && "Should check 'visited' before adding to WL");
Chris Lattner6290f5c2008-12-07 08:50:20 +0000801
Chris Lattner65633712008-12-09 07:52:59 +0000802 // Get the dependency info for Pointer in BB. If we have cached
803 // information, we will use it, otherwise we compute it.
Chris Lattner12a7db32009-01-22 07:04:01 +0000804 DEBUG(AssertSorted(*Cache, NumSortedEntries));
Chris Lattner05e15f82009-12-09 01:59:31 +0000805 MemDepResult Dep = GetNonLocalInfoForBlock(Pointer.getAddr(), PointeeSize,
806 isLoad, BB, Cache,
807 NumSortedEntries);
Chris Lattner65633712008-12-09 07:52:59 +0000808
809 // If we got a Def or Clobber, add this to the list of results.
810 if (!Dep.isNonLocal()) {
Chris Lattnerdad451c2009-12-09 07:31:04 +0000811 Result.push_back(NonLocalDepEntry(BB, Dep, Pointer.getAddr()));
Chris Lattner65633712008-12-09 07:52:59 +0000812 continue;
813 }
Chris Lattner7ebcf032008-12-07 02:15:47 +0000814 }
815
Chris Lattner9e59c642008-12-15 03:35:32 +0000816 // If 'Pointer' is an instruction defined in this block, then we need to do
817 // phi translation to change it into a value live in the predecessor block.
Chris Lattner05e15f82009-12-09 01:59:31 +0000818 // If not, we just add the predecessors to the worklist and scan them with
819 // the same Pointer.
820 if (!Pointer.NeedsPHITranslationFromBlock(BB)) {
Chris Lattner9e59c642008-12-15 03:35:32 +0000821 SkipFirstBlock = false;
822 for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
823 // Verify that we haven't looked at this block yet.
824 std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
Chris Lattner05e15f82009-12-09 01:59:31 +0000825 InsertRes = Visited.insert(std::make_pair(*PI, Pointer.getAddr()));
Chris Lattner9e59c642008-12-15 03:35:32 +0000826 if (InsertRes.second) {
827 // First time we've looked at *PI.
828 Worklist.push_back(*PI);
829 continue;
830 }
831
832 // If we have seen this block before, but it was with a different
833 // pointer then we have a phi translation failure and we have to treat
834 // this as a clobber.
Chris Lattner05e15f82009-12-09 01:59:31 +0000835 if (InsertRes.first->second != Pointer.getAddr())
Chris Lattner9e59c642008-12-15 03:35:32 +0000836 goto PredTranslationFailure;
837 }
838 continue;
839 }
840
Chris Lattner05e15f82009-12-09 01:59:31 +0000841 // We do need to do phi translation, if we know ahead of time we can't phi
842 // translate this value, don't even try.
843 if (!Pointer.IsPotentiallyPHITranslatable())
844 goto PredTranslationFailure;
845
Chris Lattner6fbc1962009-07-13 17:14:23 +0000846 // We may have added values to the cache list before this PHI translation.
847 // If so, we haven't done anything to ensure that the cache remains sorted.
848 // Sort it now (if needed) so that recursive invocations of
849 // getNonLocalPointerDepFromBB and other routines that could reuse the cache
850 // value will only see properly sorted cache arrays.
851 if (Cache && NumSortedEntries != Cache->size()) {
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000852 SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
Chris Lattner6fbc1962009-07-13 17:14:23 +0000853 NumSortedEntries = Cache->size();
854 }
Chris Lattnere95035a2009-11-27 08:37:22 +0000855 Cache = 0;
Chris Lattner05e15f82009-12-09 01:59:31 +0000856
Chris Lattnere95035a2009-11-27 08:37:22 +0000857 for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
858 BasicBlock *Pred = *PI;
Chris Lattner05e15f82009-12-09 01:59:31 +0000859
860 // Get the PHI translated pointer in this predecessor. This can fail if
861 // not translatable, in which case the getAddr() returns null.
862 PHITransAddr PredPointer(Pointer);
863 PredPointer.PHITranslateValue(BB, Pred);
864
865 Value *PredPtrVal = PredPointer.getAddr();
Chris Lattnere95035a2009-11-27 08:37:22 +0000866
867 // Check to see if we have already visited this pred block with another
868 // pointer. If so, we can't do this lookup. This failure can occur
869 // with PHI translation when a critical edge exists and the PHI node in
870 // the successor translates to a pointer value different than the
871 // pointer the block was first analyzed with.
872 std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
Chris Lattner05e15f82009-12-09 01:59:31 +0000873 InsertRes = Visited.insert(std::make_pair(Pred, PredPtrVal));
Chris Lattner9e59c642008-12-15 03:35:32 +0000874
Chris Lattnere95035a2009-11-27 08:37:22 +0000875 if (!InsertRes.second) {
876 // If the predecessor was visited with PredPtr, then we already did
877 // the analysis and can ignore it.
Chris Lattner05e15f82009-12-09 01:59:31 +0000878 if (InsertRes.first->second == PredPtrVal)
Chris Lattnere95035a2009-11-27 08:37:22 +0000879 continue;
Chris Lattner9e59c642008-12-15 03:35:32 +0000880
Chris Lattnere95035a2009-11-27 08:37:22 +0000881 // Otherwise, the block was previously analyzed with a different
882 // pointer. We can't represent the result of this case, so we just
883 // treat this as a phi translation failure.
884 goto PredTranslationFailure;
Chris Lattner9e59c642008-12-15 03:35:32 +0000885 }
Chris Lattner6f7b2102009-11-27 22:05:15 +0000886
887 // If PHI translation was unable to find an available pointer in this
888 // predecessor, then we have to assume that the pointer is clobbered in
889 // that predecessor. We can still do PRE of the load, which would insert
890 // a computation of the pointer in this predecessor.
Chris Lattner05e15f82009-12-09 01:59:31 +0000891 if (PredPtrVal == 0) {
Chris Lattner855d9da2009-12-01 07:33:32 +0000892 // Add the entry to the Result list.
893 NonLocalDepEntry Entry(Pred,
Chris Lattnerdad451c2009-12-09 07:31:04 +0000894 MemDepResult::getClobber(Pred->getTerminator()),
895 PredPtrVal);
Chris Lattner855d9da2009-12-01 07:33:32 +0000896 Result.push_back(Entry);
897
Chris Lattnerf6481252009-12-19 21:29:22 +0000898 // Since we had a phi translation failure, the cache for CacheKey won't
899 // include all of the entries that we need to immediately satisfy future
900 // queries. Mark this in NonLocalPointerDeps by setting the
901 // BBSkipFirstBlockPair pointer to null. This requires reuse of the
902 // cached value to do more work but not miss the phi trans failure.
903 NonLocalPointerDeps[CacheKey].first = BBSkipFirstBlockPair();
Chris Lattner6f7b2102009-11-27 22:05:15 +0000904 continue;
Chris Lattner6f7b2102009-11-27 22:05:15 +0000905 }
Chris Lattnere95035a2009-11-27 08:37:22 +0000906
907 // FIXME: it is entirely possible that PHI translating will end up with
908 // the same value. Consider PHI translating something like:
909 // X = phi [x, bb1], [y, bb2]. PHI translating for bb1 doesn't *need*
910 // to recurse here, pedantically speaking.
Chris Lattner6fbc1962009-07-13 17:14:23 +0000911
Chris Lattnere95035a2009-11-27 08:37:22 +0000912 // If we have a problem phi translating, fall through to the code below
913 // to handle the failure condition.
Chris Lattner05e15f82009-12-09 01:59:31 +0000914 if (getNonLocalPointerDepFromBB(PredPointer, PointeeSize, isLoad, Pred,
Chris Lattnere95035a2009-11-27 08:37:22 +0000915 Result, Visited))
916 goto PredTranslationFailure;
Chris Lattner9e59c642008-12-15 03:35:32 +0000917 }
Chris Lattnere95035a2009-11-27 08:37:22 +0000918
919 // Refresh the CacheInfo/Cache pointer so that it isn't invalidated.
920 CacheInfo = &NonLocalPointerDeps[CacheKey];
921 Cache = &CacheInfo->second;
922 NumSortedEntries = Cache->size();
923
924 // Since we did phi translation, the "Cache" set won't contain all of the
925 // results for the query. This is ok (we can still use it to accelerate
926 // specific block queries) but we can't do the fastpath "return all
927 // results from the set" Clear out the indicator for this.
928 CacheInfo->first = BBSkipFirstBlockPair();
929 SkipFirstBlock = false;
930 continue;
Chris Lattnerdc593112009-11-26 23:18:49 +0000931
Chris Lattner9e59c642008-12-15 03:35:32 +0000932 PredTranslationFailure:
933
Chris Lattner95900f22009-01-23 07:12:16 +0000934 if (Cache == 0) {
935 // Refresh the CacheInfo/Cache pointer if it got invalidated.
936 CacheInfo = &NonLocalPointerDeps[CacheKey];
937 Cache = &CacheInfo->second;
938 NumSortedEntries = Cache->size();
Chris Lattner95900f22009-01-23 07:12:16 +0000939 }
Chris Lattner6fbc1962009-07-13 17:14:23 +0000940
Chris Lattnerf6481252009-12-19 21:29:22 +0000941 // Since we failed phi translation, the "Cache" set won't contain all of the
Chris Lattner9e59c642008-12-15 03:35:32 +0000942 // results for the query. This is ok (we can still use it to accelerate
943 // specific block queries) but we can't do the fastpath "return all
Chris Lattnerf6481252009-12-19 21:29:22 +0000944 // results from the set". Clear out the indicator for this.
Chris Lattner9e59c642008-12-15 03:35:32 +0000945 CacheInfo->first = BBSkipFirstBlockPair();
946
947 // If *nothing* works, mark the pointer as being clobbered by the first
948 // instruction in this block.
949 //
950 // If this is the magic first block, return this as a clobber of the whole
951 // incoming value. Since we can't phi translate to one of the predecessors,
952 // we have to bail out.
953 if (SkipFirstBlock)
954 return true;
955
956 for (NonLocalDepInfo::reverse_iterator I = Cache->rbegin(); ; ++I) {
957 assert(I != Cache->rend() && "Didn't find current block??");
Chris Lattnere18b9712009-12-09 07:08:01 +0000958 if (I->getBB() != BB)
Chris Lattner9e59c642008-12-15 03:35:32 +0000959 continue;
960
Chris Lattnere18b9712009-12-09 07:08:01 +0000961 assert(I->getResult().isNonLocal() &&
Chris Lattner9e59c642008-12-15 03:35:32 +0000962 "Should only be here with transparent block");
Chris Lattnerdad451c2009-12-09 07:31:04 +0000963 I->setResult(MemDepResult::getClobber(BB->begin()), Pointer.getAddr());
Chris Lattner6a0dcc12009-03-29 00:24:04 +0000964 ReverseNonLocalPtrDeps[BB->begin()].insert(CacheKey);
Chris Lattner9e59c642008-12-15 03:35:32 +0000965 Result.push_back(*I);
966 break;
Chris Lattner9a193fd2008-12-07 02:56:57 +0000967 }
Chris Lattner7ebcf032008-12-07 02:15:47 +0000968 }
Chris Lattner95900f22009-01-23 07:12:16 +0000969
Chris Lattner9863c3f2008-12-09 07:47:11 +0000970 // Okay, we're done now. If we added new values to the cache, re-sort it.
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000971 SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
Chris Lattner12a7db32009-01-22 07:04:01 +0000972 DEBUG(AssertSorted(*Cache));
Chris Lattner9e59c642008-12-15 03:35:32 +0000973 return false;
Chris Lattner6290f5c2008-12-07 08:50:20 +0000974}
975
976/// RemoveCachedNonLocalPointerDependencies - If P exists in
977/// CachedNonLocalPointerInfo, remove it.
978void MemoryDependenceAnalysis::
979RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair P) {
980 CachedNonLocalPointerInfo::iterator It =
981 NonLocalPointerDeps.find(P);
982 if (It == NonLocalPointerDeps.end()) return;
983
984 // Remove all of the entries in the BB->val map. This involves removing
985 // instructions from the reverse map.
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000986 NonLocalDepInfo &PInfo = It->second.second;
Chris Lattner6290f5c2008-12-07 08:50:20 +0000987
988 for (unsigned i = 0, e = PInfo.size(); i != e; ++i) {
Chris Lattnere18b9712009-12-09 07:08:01 +0000989 Instruction *Target = PInfo[i].getResult().getInst();
Chris Lattner6290f5c2008-12-07 08:50:20 +0000990 if (Target == 0) continue; // Ignore non-local dep results.
Chris Lattnere18b9712009-12-09 07:08:01 +0000991 assert(Target->getParent() == PInfo[i].getBB());
Chris Lattner6290f5c2008-12-07 08:50:20 +0000992
993 // Eliminating the dirty entry from 'Cache', so update the reverse info.
Chris Lattner6a0dcc12009-03-29 00:24:04 +0000994 RemoveFromReverseMap(ReverseNonLocalPtrDeps, Target, P);
Chris Lattner6290f5c2008-12-07 08:50:20 +0000995 }
996
997 // Remove P from NonLocalPointerDeps (which deletes NonLocalDepInfo).
998 NonLocalPointerDeps.erase(It);
Chris Lattner7ebcf032008-12-07 02:15:47 +0000999}
1000
1001
Chris Lattnerbc99be12008-12-09 22:06:23 +00001002/// invalidateCachedPointerInfo - This method is used to invalidate cached
1003/// information about the specified pointer, because it may be too
1004/// conservative in memdep. This is an optional call that can be used when
1005/// the client detects an equivalence between the pointer and some other
1006/// value and replaces the other value with ptr. This can make Ptr available
1007/// in more places that cached info does not necessarily keep.
1008void MemoryDependenceAnalysis::invalidateCachedPointerInfo(Value *Ptr) {
1009 // If Ptr isn't really a pointer, just ignore it.
1010 if (!isa<PointerType>(Ptr->getType())) return;
1011 // Flush store info for the pointer.
1012 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, false));
1013 // Flush load info for the pointer.
1014 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, true));
1015}
1016
Owen Anderson78e02f72007-07-06 23:14:35 +00001017/// removeInstruction - Remove an instruction from the dependence analysis,
1018/// updating the dependence of instructions that previously depended on it.
Owen Anderson642a9e32007-08-08 22:26:03 +00001019/// This method attempts to keep the cache coherent using the reverse map.
Chris Lattner5f589dc2008-11-28 22:04:47 +00001020void MemoryDependenceAnalysis::removeInstruction(Instruction *RemInst) {
Chris Lattner5f589dc2008-11-28 22:04:47 +00001021 // Walk through the Non-local dependencies, removing this one as the value
1022 // for any cached queries.
Chris Lattnerf68f3102008-11-30 02:28:25 +00001023 NonLocalDepMapType::iterator NLDI = NonLocalDeps.find(RemInst);
1024 if (NLDI != NonLocalDeps.end()) {
Chris Lattnerbf145d62008-12-01 01:15:42 +00001025 NonLocalDepInfo &BlockMap = NLDI->second.first;
Chris Lattner25f4b2b2008-11-30 02:30:50 +00001026 for (NonLocalDepInfo::iterator DI = BlockMap.begin(), DE = BlockMap.end();
1027 DI != DE; ++DI)
Chris Lattnere18b9712009-12-09 07:08:01 +00001028 if (Instruction *Inst = DI->getResult().getInst())
Chris Lattnerd44745d2008-12-07 18:39:13 +00001029 RemoveFromReverseMap(ReverseNonLocalDeps, Inst, RemInst);
Chris Lattnerf68f3102008-11-30 02:28:25 +00001030 NonLocalDeps.erase(NLDI);
1031 }
Owen Anderson5fc4aba2007-12-08 01:37:09 +00001032
Chris Lattner5f589dc2008-11-28 22:04:47 +00001033 // If we have a cached local dependence query for this instruction, remove it.
Chris Lattnerbaad8882008-11-28 22:28:27 +00001034 //
Chris Lattner39f372e2008-11-29 01:43:36 +00001035 LocalDepMapType::iterator LocalDepEntry = LocalDeps.find(RemInst);
1036 if (LocalDepEntry != LocalDeps.end()) {
Chris Lattner125ce362008-11-30 01:09:30 +00001037 // Remove us from DepInst's reverse set now that the local dep info is gone.
Chris Lattnerd44745d2008-12-07 18:39:13 +00001038 if (Instruction *Inst = LocalDepEntry->second.getInst())
1039 RemoveFromReverseMap(ReverseLocalDeps, Inst, RemInst);
Chris Lattner125ce362008-11-30 01:09:30 +00001040
Chris Lattnerbaad8882008-11-28 22:28:27 +00001041 // Remove this local dependency info.
Chris Lattner39f372e2008-11-29 01:43:36 +00001042 LocalDeps.erase(LocalDepEntry);
Chris Lattner6290f5c2008-12-07 08:50:20 +00001043 }
1044
1045 // If we have any cached pointer dependencies on this instruction, remove
1046 // them. If the instruction has non-pointer type, then it can't be a pointer
1047 // base.
1048
1049 // Remove it from both the load info and the store info. The instruction
1050 // can't be in either of these maps if it is non-pointer.
1051 if (isa<PointerType>(RemInst->getType())) {
1052 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, false));
1053 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, true));
1054 }
Chris Lattnerbaad8882008-11-28 22:28:27 +00001055
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001056 // Loop over all of the things that depend on the instruction we're removing.
1057 //
Chris Lattner4f8c18c2008-11-29 23:30:39 +00001058 SmallVector<std::pair<Instruction*, Instruction*>, 8> ReverseDepsToAdd;
Chris Lattner0655f732008-12-07 18:42:51 +00001059
1060 // If we find RemInst as a clobber or Def in any of the maps for other values,
1061 // we need to replace its entry with a dirty version of the instruction after
1062 // it. If RemInst is a terminator, we use a null dirty value.
1063 //
1064 // Using a dirty version of the instruction after RemInst saves having to scan
1065 // the entire block to get to this point.
1066 MemDepResult NewDirtyVal;
1067 if (!RemInst->isTerminator())
1068 NewDirtyVal = MemDepResult::getDirty(++BasicBlock::iterator(RemInst));
Chris Lattner4f8c18c2008-11-29 23:30:39 +00001069
Chris Lattner8c465272008-11-29 09:20:15 +00001070 ReverseDepMapType::iterator ReverseDepIt = ReverseLocalDeps.find(RemInst);
1071 if (ReverseDepIt != ReverseLocalDeps.end()) {
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001072 SmallPtrSet<Instruction*, 4> &ReverseDeps = ReverseDepIt->second;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001073 // RemInst can't be the terminator if it has local stuff depending on it.
Chris Lattner125ce362008-11-30 01:09:30 +00001074 assert(!ReverseDeps.empty() && !isa<TerminatorInst>(RemInst) &&
1075 "Nothing can locally depend on a terminator");
1076
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001077 for (SmallPtrSet<Instruction*, 4>::iterator I = ReverseDeps.begin(),
1078 E = ReverseDeps.end(); I != E; ++I) {
1079 Instruction *InstDependingOnRemInst = *I;
Chris Lattnerf68f3102008-11-30 02:28:25 +00001080 assert(InstDependingOnRemInst != RemInst &&
1081 "Already removed our local dep info");
Chris Lattner125ce362008-11-30 01:09:30 +00001082
Chris Lattner0655f732008-12-07 18:42:51 +00001083 LocalDeps[InstDependingOnRemInst] = NewDirtyVal;
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001084
Chris Lattner125ce362008-11-30 01:09:30 +00001085 // Make sure to remember that new things depend on NewDepInst.
Chris Lattner0655f732008-12-07 18:42:51 +00001086 assert(NewDirtyVal.getInst() && "There is no way something else can have "
1087 "a local dep on this if it is a terminator!");
1088 ReverseDepsToAdd.push_back(std::make_pair(NewDirtyVal.getInst(),
Chris Lattner125ce362008-11-30 01:09:30 +00001089 InstDependingOnRemInst));
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001090 }
Chris Lattner4f8c18c2008-11-29 23:30:39 +00001091
1092 ReverseLocalDeps.erase(ReverseDepIt);
1093
1094 // Add new reverse deps after scanning the set, to avoid invalidating the
1095 // 'ReverseDeps' reference.
1096 while (!ReverseDepsToAdd.empty()) {
1097 ReverseLocalDeps[ReverseDepsToAdd.back().first]
1098 .insert(ReverseDepsToAdd.back().second);
1099 ReverseDepsToAdd.pop_back();
1100 }
Owen Anderson78e02f72007-07-06 23:14:35 +00001101 }
Owen Anderson4d13de42007-08-16 21:27:05 +00001102
Chris Lattner8c465272008-11-29 09:20:15 +00001103 ReverseDepIt = ReverseNonLocalDeps.find(RemInst);
1104 if (ReverseDepIt != ReverseNonLocalDeps.end()) {
Chris Lattner6290f5c2008-12-07 08:50:20 +00001105 SmallPtrSet<Instruction*, 4> &Set = ReverseDepIt->second;
1106 for (SmallPtrSet<Instruction*, 4>::iterator I = Set.begin(), E = Set.end();
Chris Lattnerf68f3102008-11-30 02:28:25 +00001107 I != E; ++I) {
1108 assert(*I != RemInst && "Already removed NonLocalDep info for RemInst");
1109
Chris Lattner4a69bad2008-11-30 02:52:26 +00001110 PerInstNLInfo &INLD = NonLocalDeps[*I];
Chris Lattner4a69bad2008-11-30 02:52:26 +00001111 // The information is now dirty!
Chris Lattnerbf145d62008-12-01 01:15:42 +00001112 INLD.second = true;
Chris Lattnerf68f3102008-11-30 02:28:25 +00001113
Chris Lattnerbf145d62008-12-01 01:15:42 +00001114 for (NonLocalDepInfo::iterator DI = INLD.first.begin(),
1115 DE = INLD.first.end(); DI != DE; ++DI) {
Chris Lattnere18b9712009-12-09 07:08:01 +00001116 if (DI->getResult().getInst() != RemInst) continue;
Chris Lattnerf68f3102008-11-30 02:28:25 +00001117
1118 // Convert to a dirty entry for the subsequent instruction.
Chris Lattnerdad451c2009-12-09 07:31:04 +00001119 DI->setResult(NewDirtyVal, DI->getAddress());
Chris Lattner0655f732008-12-07 18:42:51 +00001120
1121 if (Instruction *NextI = NewDirtyVal.getInst())
Chris Lattnerf68f3102008-11-30 02:28:25 +00001122 ReverseDepsToAdd.push_back(std::make_pair(NextI, *I));
Chris Lattnerf68f3102008-11-30 02:28:25 +00001123 }
1124 }
Chris Lattner4f8c18c2008-11-29 23:30:39 +00001125
1126 ReverseNonLocalDeps.erase(ReverseDepIt);
1127
Chris Lattner0ec48dd2008-11-29 22:02:15 +00001128 // Add new reverse deps after scanning the set, to avoid invalidating 'Set'
1129 while (!ReverseDepsToAdd.empty()) {
1130 ReverseNonLocalDeps[ReverseDepsToAdd.back().first]
1131 .insert(ReverseDepsToAdd.back().second);
1132 ReverseDepsToAdd.pop_back();
1133 }
Owen Anderson4d13de42007-08-16 21:27:05 +00001134 }
Owen Anderson5fc4aba2007-12-08 01:37:09 +00001135
Chris Lattner6290f5c2008-12-07 08:50:20 +00001136 // If the instruction is in ReverseNonLocalPtrDeps then it appears as a
1137 // value in the NonLocalPointerDeps info.
1138 ReverseNonLocalPtrDepTy::iterator ReversePtrDepIt =
1139 ReverseNonLocalPtrDeps.find(RemInst);
1140 if (ReversePtrDepIt != ReverseNonLocalPtrDeps.end()) {
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001141 SmallPtrSet<ValueIsLoadPair, 4> &Set = ReversePtrDepIt->second;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001142 SmallVector<std::pair<Instruction*, ValueIsLoadPair>,8> ReversePtrDepsToAdd;
1143
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001144 for (SmallPtrSet<ValueIsLoadPair, 4>::iterator I = Set.begin(),
1145 E = Set.end(); I != E; ++I) {
1146 ValueIsLoadPair P = *I;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001147 assert(P.getPointer() != RemInst &&
1148 "Already removed NonLocalPointerDeps info for RemInst");
1149
Chris Lattner11dcd8d2008-12-08 07:31:50 +00001150 NonLocalDepInfo &NLPDI = NonLocalPointerDeps[P].second;
1151
1152 // The cache is not valid for any specific block anymore.
Chris Lattner9e59c642008-12-15 03:35:32 +00001153 NonLocalPointerDeps[P].first = BBSkipFirstBlockPair();
Chris Lattner6290f5c2008-12-07 08:50:20 +00001154
Chris Lattner6290f5c2008-12-07 08:50:20 +00001155 // Update any entries for RemInst to use the instruction after it.
1156 for (NonLocalDepInfo::iterator DI = NLPDI.begin(), DE = NLPDI.end();
1157 DI != DE; ++DI) {
Chris Lattnere18b9712009-12-09 07:08:01 +00001158 if (DI->getResult().getInst() != RemInst) continue;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001159
1160 // Convert to a dirty entry for the subsequent instruction.
Chris Lattnerdad451c2009-12-09 07:31:04 +00001161 DI->setResult(NewDirtyVal, DI->getAddress());
Chris Lattner6290f5c2008-12-07 08:50:20 +00001162
1163 if (Instruction *NewDirtyInst = NewDirtyVal.getInst())
1164 ReversePtrDepsToAdd.push_back(std::make_pair(NewDirtyInst, P));
1165 }
Chris Lattner95900f22009-01-23 07:12:16 +00001166
1167 // Re-sort the NonLocalDepInfo. Changing the dirty entry to its
1168 // subsequent value may invalidate the sortedness.
1169 std::sort(NLPDI.begin(), NLPDI.end());
Chris Lattner6290f5c2008-12-07 08:50:20 +00001170 }
1171
1172 ReverseNonLocalPtrDeps.erase(ReversePtrDepIt);
1173
1174 while (!ReversePtrDepsToAdd.empty()) {
1175 ReverseNonLocalPtrDeps[ReversePtrDepsToAdd.back().first]
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001176 .insert(ReversePtrDepsToAdd.back().second);
Chris Lattner6290f5c2008-12-07 08:50:20 +00001177 ReversePtrDepsToAdd.pop_back();
1178 }
1179 }
1180
1181
Chris Lattnerf68f3102008-11-30 02:28:25 +00001182 assert(!NonLocalDeps.count(RemInst) && "RemInst got reinserted?");
Chris Lattnerd777d402008-11-30 19:24:31 +00001183 AA->deleteValue(RemInst);
Chris Lattner5f589dc2008-11-28 22:04:47 +00001184 DEBUG(verifyRemoved(RemInst));
Owen Anderson78e02f72007-07-06 23:14:35 +00001185}
Chris Lattner729b2372008-11-29 21:25:10 +00001186/// verifyRemoved - Verify that the specified instruction does not occur
1187/// in our internal data structures.
1188void MemoryDependenceAnalysis::verifyRemoved(Instruction *D) const {
1189 for (LocalDepMapType::const_iterator I = LocalDeps.begin(),
1190 E = LocalDeps.end(); I != E; ++I) {
1191 assert(I->first != D && "Inst occurs in data structures");
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +00001192 assert(I->second.getInst() != D &&
Chris Lattner729b2372008-11-29 21:25:10 +00001193 "Inst occurs in data structures");
1194 }
1195
Chris Lattner6290f5c2008-12-07 08:50:20 +00001196 for (CachedNonLocalPointerInfo::const_iterator I =NonLocalPointerDeps.begin(),
1197 E = NonLocalPointerDeps.end(); I != E; ++I) {
1198 assert(I->first.getPointer() != D && "Inst occurs in NLPD map key");
Chris Lattner11dcd8d2008-12-08 07:31:50 +00001199 const NonLocalDepInfo &Val = I->second.second;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001200 for (NonLocalDepInfo::const_iterator II = Val.begin(), E = Val.end();
1201 II != E; ++II)
Chris Lattnere18b9712009-12-09 07:08:01 +00001202 assert(II->getResult().getInst() != D && "Inst occurs as NLPD value");
Chris Lattner6290f5c2008-12-07 08:50:20 +00001203 }
1204
Chris Lattner729b2372008-11-29 21:25:10 +00001205 for (NonLocalDepMapType::const_iterator I = NonLocalDeps.begin(),
1206 E = NonLocalDeps.end(); I != E; ++I) {
1207 assert(I->first != D && "Inst occurs in data structures");
Chris Lattner4a69bad2008-11-30 02:52:26 +00001208 const PerInstNLInfo &INLD = I->second;
Chris Lattnerbf145d62008-12-01 01:15:42 +00001209 for (NonLocalDepInfo::const_iterator II = INLD.first.begin(),
1210 EE = INLD.first.end(); II != EE; ++II)
Chris Lattnere18b9712009-12-09 07:08:01 +00001211 assert(II->getResult().getInst() != D && "Inst occurs in data structures");
Chris Lattner729b2372008-11-29 21:25:10 +00001212 }
1213
1214 for (ReverseDepMapType::const_iterator I = ReverseLocalDeps.begin(),
Chris Lattnerf68f3102008-11-30 02:28:25 +00001215 E = ReverseLocalDeps.end(); I != E; ++I) {
1216 assert(I->first != D && "Inst occurs in data structures");
Chris Lattner729b2372008-11-29 21:25:10 +00001217 for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1218 EE = I->second.end(); II != EE; ++II)
1219 assert(*II != D && "Inst occurs in data structures");
Chris Lattnerf68f3102008-11-30 02:28:25 +00001220 }
Chris Lattner729b2372008-11-29 21:25:10 +00001221
1222 for (ReverseDepMapType::const_iterator I = ReverseNonLocalDeps.begin(),
1223 E = ReverseNonLocalDeps.end();
Chris Lattnerf68f3102008-11-30 02:28:25 +00001224 I != E; ++I) {
1225 assert(I->first != D && "Inst occurs in data structures");
Chris Lattner729b2372008-11-29 21:25:10 +00001226 for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1227 EE = I->second.end(); II != EE; ++II)
1228 assert(*II != D && "Inst occurs in data structures");
Chris Lattnerf68f3102008-11-30 02:28:25 +00001229 }
Chris Lattner6290f5c2008-12-07 08:50:20 +00001230
1231 for (ReverseNonLocalPtrDepTy::const_iterator
1232 I = ReverseNonLocalPtrDeps.begin(),
1233 E = ReverseNonLocalPtrDeps.end(); I != E; ++I) {
1234 assert(I->first != D && "Inst occurs in rev NLPD map");
1235
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001236 for (SmallPtrSet<ValueIsLoadPair, 4>::const_iterator II = I->second.begin(),
Chris Lattner6290f5c2008-12-07 08:50:20 +00001237 E = I->second.end(); II != E; ++II)
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001238 assert(*II != ValueIsLoadPair(D, false) &&
1239 *II != ValueIsLoadPair(D, true) &&
Chris Lattner6290f5c2008-12-07 08:50:20 +00001240 "Inst occurs in ReverseNonLocalPtrDeps map");
1241 }
1242
Chris Lattner729b2372008-11-29 21:25:10 +00001243}