blob: a51c5285510656fee833da7f0c15fe2746125cff [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"
Dan Gohmanc1ac0d72010-09-22 21:41:02 +000022#include "llvm/LLVMContext.h"
Owen Anderson78e02f72007-07-06 23:14:35 +000023#include "llvm/Analysis/AliasAnalysis.h"
Chris Lattner6f7b2102009-11-27 22:05:15 +000024#include "llvm/Analysis/Dominators.h"
Chris Lattnere19e4ba2009-11-27 00:34:38 +000025#include "llvm/Analysis/InstructionSimplify.h"
Victor Hernandezf006b182009-10-27 20:05:49 +000026#include "llvm/Analysis/MemoryBuiltins.h"
Chris Lattner05e15f82009-12-09 01:59:31 +000027#include "llvm/Analysis/PHITransAddr.h"
Chris Lattnerbaad8882008-11-28 22:28:27 +000028#include "llvm/ADT/Statistic.h"
Duncan Sands7050f3d2008-12-10 09:38:36 +000029#include "llvm/ADT/STLExtras.h"
Chris Lattner4012fdd2008-12-09 06:28:49 +000030#include "llvm/Support/PredIteratorCache.h"
Chris Lattner0e575f42008-11-28 21:45:17 +000031#include "llvm/Support/Debug.h"
Owen Anderson78e02f72007-07-06 23:14:35 +000032using namespace llvm;
33
Chris Lattnerbf145d62008-12-01 01:15:42 +000034STATISTIC(NumCacheNonLocal, "Number of fully cached non-local responses");
35STATISTIC(NumCacheDirtyNonLocal, "Number of dirty cached non-local responses");
Chris Lattner0ec48dd2008-11-29 22:02:15 +000036STATISTIC(NumUncacheNonLocal, "Number of uncached non-local responses");
Chris Lattner6290f5c2008-12-07 08:50:20 +000037
38STATISTIC(NumCacheNonLocalPtr,
39 "Number of fully cached non-local ptr responses");
40STATISTIC(NumCacheDirtyNonLocalPtr,
41 "Number of cached, but dirty, non-local ptr responses");
42STATISTIC(NumUncacheNonLocalPtr,
43 "Number of uncached non-local ptr responses");
Chris Lattner11dcd8d2008-12-08 07:31:50 +000044STATISTIC(NumCacheCompleteNonLocalPtr,
45 "Number of block queries that were completely cached");
Chris Lattner6290f5c2008-12-07 08:50:20 +000046
Owen Anderson78e02f72007-07-06 23:14:35 +000047char MemoryDependenceAnalysis::ID = 0;
48
Owen Anderson78e02f72007-07-06 23:14:35 +000049// Register this pass...
Owen Anderson2ab36d32010-10-12 19:48:12 +000050INITIALIZE_PASS_BEGIN(MemoryDependenceAnalysis, "memdep",
Owen Andersonce665bd2010-10-07 22:25:06 +000051 "Memory Dependence Analysis", false, true)
Owen Anderson2ab36d32010-10-12 19:48:12 +000052INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
53INITIALIZE_PASS_END(MemoryDependenceAnalysis, "memdep",
54 "Memory Dependence Analysis", false, true)
Owen Anderson78e02f72007-07-06 23:14:35 +000055
Chris Lattner4012fdd2008-12-09 06:28:49 +000056MemoryDependenceAnalysis::MemoryDependenceAnalysis()
Owen Anderson90c579d2010-08-06 18:33:48 +000057: FunctionPass(ID), PredCache(0) {
Chris Lattner4012fdd2008-12-09 06:28:49 +000058}
59MemoryDependenceAnalysis::~MemoryDependenceAnalysis() {
60}
61
62/// Clean up memory in between runs
63void MemoryDependenceAnalysis::releaseMemory() {
64 LocalDeps.clear();
65 NonLocalDeps.clear();
66 NonLocalPointerDeps.clear();
67 ReverseLocalDeps.clear();
68 ReverseNonLocalDeps.clear();
69 ReverseNonLocalPtrDeps.clear();
70 PredCache->clear();
71}
72
73
74
Owen Anderson78e02f72007-07-06 23:14:35 +000075/// getAnalysisUsage - Does not modify anything. It uses Alias Analysis.
76///
77void MemoryDependenceAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
78 AU.setPreservesAll();
79 AU.addRequiredTransitive<AliasAnalysis>();
Owen Anderson78e02f72007-07-06 23:14:35 +000080}
81
Chris Lattnerd777d402008-11-30 19:24:31 +000082bool MemoryDependenceAnalysis::runOnFunction(Function &) {
83 AA = &getAnalysis<AliasAnalysis>();
Chris Lattner4012fdd2008-12-09 06:28:49 +000084 if (PredCache == 0)
85 PredCache.reset(new PredIteratorCache());
Chris Lattnerd777d402008-11-30 19:24:31 +000086 return false;
87}
88
Chris Lattnerd44745d2008-12-07 18:39:13 +000089/// RemoveFromReverseMap - This is a helper function that removes Val from
90/// 'Inst's set in ReverseMap. If the set becomes empty, remove Inst's entry.
91template <typename KeyTy>
92static void RemoveFromReverseMap(DenseMap<Instruction*,
Chris Lattner6a0dcc12009-03-29 00:24:04 +000093 SmallPtrSet<KeyTy, 4> > &ReverseMap,
94 Instruction *Inst, KeyTy Val) {
95 typename DenseMap<Instruction*, SmallPtrSet<KeyTy, 4> >::iterator
Chris Lattnerd44745d2008-12-07 18:39:13 +000096 InstIt = ReverseMap.find(Inst);
97 assert(InstIt != ReverseMap.end() && "Reverse map out of sync?");
98 bool Found = InstIt->second.erase(Val);
99 assert(Found && "Invalid reverse map!"); Found=Found;
100 if (InstIt->second.empty())
101 ReverseMap.erase(InstIt);
102}
103
Chris Lattnerbf145d62008-12-01 01:15:42 +0000104
Chris Lattner8ef57c52008-12-07 00:35:51 +0000105/// getCallSiteDependencyFrom - Private helper for finding the local
106/// dependencies of a call site.
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000107MemDepResult MemoryDependenceAnalysis::
Chris Lattner20d6f092008-12-09 21:19:42 +0000108getCallSiteDependencyFrom(CallSite CS, bool isReadOnlyCall,
109 BasicBlock::iterator ScanIt, BasicBlock *BB) {
Owen Anderson642a9e32007-08-08 22:26:03 +0000110 // Walk backwards through the block, looking for dependencies
Chris Lattner5391a1d2008-11-29 03:47:00 +0000111 while (ScanIt != BB->begin()) {
112 Instruction *Inst = --ScanIt;
Owen Anderson5f323202007-07-10 17:59:22 +0000113
114 // If this inst is a memory op, get the pointer it accessed
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000115 AliasAnalysis::Location Loc;
Chris Lattner00314b32008-11-29 09:15:21 +0000116 if (StoreInst *S = dyn_cast<StoreInst>(Inst)) {
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000117 Loc = AliasAnalysis::Location(S->getPointerOperand(),
118 AA->getTypeStoreSize(S->getValueOperand()
119 ->getType()),
120 S->getMetadata(LLVMContext::MD_tbaa));
Chris Lattner00314b32008-11-29 09:15:21 +0000121 } else if (VAArgInst *V = dyn_cast<VAArgInst>(Inst)) {
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000122 Loc = AliasAnalysis::Location(V->getPointerOperand(),
123 AA->getTypeStoreSize(V->getType()),
124 V->getMetadata(LLVMContext::MD_tbaa));
Gabor Greif8ff72b52010-06-23 22:48:06 +0000125 } else if (const CallInst *CI = isFreeCall(Inst)) {
Victor Hernandez046e78c2009-10-26 23:43:48 +0000126 // calls to free() erase the entire structure
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000127 Loc = AliasAnalysis::Location(CI->getArgOperand(0));
Gabor Greifb344a342010-07-27 22:53:28 +0000128 } else if (CallSite InstCS = cast<Value>(Inst)) {
Owen Andersonf6cec852009-03-09 05:12:38 +0000129 // Debug intrinsics don't cause dependences.
Dale Johannesen497cb6f2009-03-11 21:13:01 +0000130 if (isa<DbgInfoIntrinsic>(Inst)) continue;
Chris Lattnerb51deb92008-12-05 21:04:20 +0000131 // If these two calls do not interfere, look past it.
Chris Lattner20d6f092008-12-09 21:19:42 +0000132 switch (AA->getModRefInfo(CS, InstCS)) {
133 case AliasAnalysis::NoModRef:
Dan Gohman5fa417c2010-08-05 22:09:15 +0000134 // If the two calls are the same, return InstCS as a Def, so that
135 // CS can be found redundant and eliminated.
136 if (isReadOnlyCall && InstCS.onlyReadsMemory() &&
137 CS.getInstruction()->isIdenticalToWhenDefined(Inst))
138 return MemDepResult::getDef(Inst);
139
140 // Otherwise if the two calls don't interact (e.g. InstCS is readnone)
141 // keep scanning.
Chris Lattner00314b32008-11-29 09:15:21 +0000142 continue;
Chris Lattner20d6f092008-12-09 21:19:42 +0000143 default:
Chris Lattnerb51deb92008-12-05 21:04:20 +0000144 return MemDepResult::getClobber(Inst);
Chris Lattner20d6f092008-12-09 21:19:42 +0000145 }
Chris Lattnercfbb6342008-11-30 01:44:00 +0000146 } else {
147 // Non-memory instruction.
Owen Anderson202da142007-07-10 20:39:07 +0000148 continue;
Chris Lattnercfbb6342008-11-30 01:44:00 +0000149 }
Owen Anderson5f323202007-07-10 17:59:22 +0000150
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000151 if (AA->getModRefInfo(CS, Loc) != AliasAnalysis::NoModRef)
Chris Lattnerb51deb92008-12-05 21:04:20 +0000152 return MemDepResult::getClobber(Inst);
Owen Anderson5f323202007-07-10 17:59:22 +0000153 }
154
Chris Lattner7ebcf032008-12-07 02:15:47 +0000155 // No dependence found. If this is the entry block of the function, it is a
156 // clobber, otherwise it is non-local.
157 if (BB != &BB->getParent()->getEntryBlock())
158 return MemDepResult::getNonLocal();
159 return MemDepResult::getClobber(ScanIt);
Owen Anderson5f323202007-07-10 17:59:22 +0000160}
161
Chris Lattnere79be942008-12-07 01:50:16 +0000162/// getPointerDependencyFrom - Return the instruction on which a memory
163/// location depends. If isLoad is true, this routine ignore may-aliases with
164/// read-only operations.
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000165MemDepResult MemoryDependenceAnalysis::
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000166getPointerDependencyFrom(const AliasAnalysis::Location &MemLoc, bool isLoad,
Chris Lattnere79be942008-12-07 01:50:16 +0000167 BasicBlock::iterator ScanIt, BasicBlock *BB) {
Chris Lattner7ebcf032008-12-07 02:15:47 +0000168
Chris Lattner1e8de492009-12-01 21:16:01 +0000169 Value *InvariantTag = 0;
Owen Anderson4bc737c2009-10-28 06:18:42 +0000170
Chris Lattner6290f5c2008-12-07 08:50:20 +0000171 // Walk backwards through the basic block, looking for dependencies.
Chris Lattner5391a1d2008-11-29 03:47:00 +0000172 while (ScanIt != BB->begin()) {
173 Instruction *Inst = --ScanIt;
Chris Lattnera161ab02008-11-29 09:09:48 +0000174
Owen Anderson4bc737c2009-10-28 06:18:42 +0000175 // If we're in an invariant region, no dependencies can be found before
176 // we pass an invariant-begin marker.
Chris Lattner1e8de492009-12-01 21:16:01 +0000177 if (InvariantTag == Inst) {
178 InvariantTag = 0;
Owen Anderson4bc737c2009-10-28 06:18:42 +0000179 continue;
Chris Lattner1ffb70f2009-12-01 21:15:15 +0000180 }
181
182 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
Chris Lattner09981982010-09-06 03:58:04 +0000183 // Debug intrinsics don't (and can't) cause dependences.
Chris Lattnerc5a5cf22010-09-06 01:26:29 +0000184 if (isa<DbgInfoIntrinsic>(II)) continue;
Owen Anderson9ff5a232009-12-02 07:35:19 +0000185
Owen Andersonb62f7922009-10-28 07:05:35 +0000186 // If we pass an invariant-end marker, then we've just entered an
187 // invariant region and can start ignoring dependencies.
Owen Anderson4bc737c2009-10-28 06:18:42 +0000188 if (II->getIntrinsicID() == Intrinsic::invariant_end) {
Owen Anderson9ff5a232009-12-02 07:35:19 +0000189 // FIXME: This only considers queries directly on the invariant-tagged
190 // pointer, not on query pointers that are indexed off of them. It'd
191 // be nice to handle that at some point.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000192 AliasAnalysis::AliasResult R =
193 AA->alias(AliasAnalysis::Location(II->getArgOperand(2)), MemLoc);
Chris Lattner09981982010-09-06 03:58:04 +0000194 if (R == AliasAnalysis::MustAlias)
Gabor Greif8ff72b52010-06-23 22:48:06 +0000195 InvariantTag = II->getArgOperand(0);
Chris Lattner09981982010-09-06 03:58:04 +0000196
197 continue;
198 }
199
Owen Andersonb62f7922009-10-28 07:05:35 +0000200 // If we reach a lifetime begin or end marker, then the query ends here
201 // because the value is undefined.
Chris Lattner09981982010-09-06 03:58:04 +0000202 if (II->getIntrinsicID() == Intrinsic::lifetime_start) {
Owen Anderson9ff5a232009-12-02 07:35:19 +0000203 // FIXME: This only considers queries directly on the invariant-tagged
204 // pointer, not on query pointers that are indexed off of them. It'd
205 // be nice to handle that at some point.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000206 AliasAnalysis::AliasResult R =
207 AA->alias(AliasAnalysis::Location(II->getArgOperand(1)), MemLoc);
Owen Andersonb62f7922009-10-28 07:05:35 +0000208 if (R == AliasAnalysis::MustAlias)
209 return MemDepResult::getDef(II);
Chris Lattner09981982010-09-06 03:58:04 +0000210 continue;
Owen Anderson4bc737c2009-10-28 06:18:42 +0000211 }
212 }
213
214 // If we're querying on a load and we're in an invariant region, we're done
215 // at this point. Nothing a load depends on can live in an invariant region.
Chris Lattner09981982010-09-06 03:58:04 +0000216 //
217 // FIXME: this will prevent us from returning load/load must-aliases, so GVN
218 // won't remove redundant loads.
Chris Lattner1e8de492009-12-01 21:16:01 +0000219 if (isLoad && InvariantTag) continue;
Owen Anderson4bc737c2009-10-28 06:18:42 +0000220
Chris Lattnercfbb6342008-11-30 01:44:00 +0000221 // Values depend on loads if the pointers are must aliased. This means that
222 // a load depends on another must aliased load from the same value.
Chris Lattnerb51deb92008-12-05 21:04:20 +0000223 if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
Chris Lattnerb51deb92008-12-05 21:04:20 +0000224 Value *Pointer = LI->getPointerOperand();
Dan Gohmanf5812132009-07-31 20:53:12 +0000225 uint64_t PointerSize = AA->getTypeStoreSize(LI->getType());
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000226 MDNode *TBAATag = LI->getMetadata(LLVMContext::MD_tbaa);
Chris Lattnerb51deb92008-12-05 21:04:20 +0000227
228 // If we found a pointer, check if it could be the same as our pointer.
Chris Lattnera161ab02008-11-29 09:09:48 +0000229 AliasAnalysis::AliasResult R =
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000230 AA->alias(AliasAnalysis::Location(Pointer, PointerSize, TBAATag),
231 MemLoc);
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.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000251 if (AA->getModRefInfo(SI, MemLoc) == AliasAnalysis::NoModRef)
Chris Lattnerab9cf122009-05-25 21:28:56 +0000252 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());
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000258 MDNode *TBAATag = SI->getMetadata(LLVMContext::MD_tbaa);
Chris Lattnerab9cf122009-05-25 21:28:56 +0000259
Chris Lattnerb51deb92008-12-05 21:04:20 +0000260 // If we found a pointer, check if it could be the same as our pointer.
261 AliasAnalysis::AliasResult R =
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000262 AA->alias(AliasAnalysis::Location(Pointer, PointerSize, TBAATag),
263 MemLoc);
Chris Lattnerb51deb92008-12-05 21:04:20 +0000264
265 if (R == AliasAnalysis::NoAlias)
266 continue;
267 if (R == AliasAnalysis::MayAlias)
268 return MemDepResult::getClobber(Inst);
269 return MemDepResult::getDef(Inst);
Owen Anderson78e02f72007-07-06 23:14:35 +0000270 }
Chris Lattner237a8282008-11-30 01:39:32 +0000271
272 // If this is an allocation, and if we know that the accessed pointer is to
Chris Lattnerb51deb92008-12-05 21:04:20 +0000273 // the allocation, return Def. This means that there is no dependence and
Chris Lattner237a8282008-11-30 01:39:32 +0000274 // the access can be optimized based on that. For example, a load could
275 // turn into undef.
Victor Hernandez5c787362009-10-13 01:42:53 +0000276 // Note: Only determine this to be a malloc if Inst is the malloc call, not
277 // a subsequent bitcast of the malloc call result. There can be stores to
278 // the malloced memory between the malloc call and its bitcast uses, and we
279 // need to continue scanning until the malloc call.
Chris Lattner9b96eca2009-12-22 01:00:32 +0000280 if (isa<AllocaInst>(Inst) ||
281 (isa<CallInst>(Inst) && extractMallocCall(Inst))) {
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000282 const Value *AccessPtr = MemLoc.Ptr->getUnderlyingObject();
Victor Hernandez46e83122009-09-18 21:34:51 +0000283
284 if (AccessPtr == Inst ||
285 AA->alias(Inst, 1, AccessPtr, 1) == AliasAnalysis::MustAlias)
286 return MemDepResult::getDef(Inst);
287 continue;
288 }
289
Chris Lattnerb51deb92008-12-05 21:04:20 +0000290 // See if this instruction (e.g. a call or vaarg) mod/ref's the pointer.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000291 switch (AA->getModRefInfo(Inst, MemLoc)) {
Chris Lattner3579e442008-12-09 19:47:40 +0000292 case AliasAnalysis::NoModRef:
293 // If the call has no effect on the queried pointer, just ignore it.
Chris Lattner25a08142008-11-29 08:51:16 +0000294 continue;
Owen Andersona85a6642009-10-28 06:30:52 +0000295 case AliasAnalysis::Mod:
296 // If we're in an invariant region, we can ignore calls that ONLY
297 // modify the pointer.
Chris Lattner1e8de492009-12-01 21:16:01 +0000298 if (InvariantTag) continue;
Owen Andersona85a6642009-10-28 06:30:52 +0000299 return MemDepResult::getClobber(Inst);
Chris Lattner3579e442008-12-09 19:47:40 +0000300 case AliasAnalysis::Ref:
301 // If the call is known to never store to the pointer, and if this is a
302 // load query, we can safely ignore it (scan past it).
303 if (isLoad)
304 continue;
Chris Lattner3579e442008-12-09 19:47:40 +0000305 default:
306 // Otherwise, there is a potential dependence. Return a clobber.
307 return MemDepResult::getClobber(Inst);
308 }
Owen Anderson78e02f72007-07-06 23:14:35 +0000309 }
310
Chris Lattner7ebcf032008-12-07 02:15:47 +0000311 // No dependence found. If this is the entry block of the function, it is a
312 // clobber, otherwise it is non-local.
313 if (BB != &BB->getParent()->getEntryBlock())
314 return MemDepResult::getNonLocal();
315 return MemDepResult::getClobber(ScanIt);
Owen Anderson78e02f72007-07-06 23:14:35 +0000316}
317
Chris Lattner5391a1d2008-11-29 03:47:00 +0000318/// getDependency - Return the instruction on which a memory operation
319/// depends.
320MemDepResult MemoryDependenceAnalysis::getDependency(Instruction *QueryInst) {
321 Instruction *ScanPos = QueryInst;
322
323 // Check for a cached result
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000324 MemDepResult &LocalCache = LocalDeps[QueryInst];
Chris Lattner5391a1d2008-11-29 03:47:00 +0000325
Chris Lattner0ec48dd2008-11-29 22:02:15 +0000326 // If the cached entry is non-dirty, just return it. Note that this depends
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000327 // on MemDepResult's default constructing to 'dirty'.
328 if (!LocalCache.isDirty())
329 return LocalCache;
Chris Lattner5391a1d2008-11-29 03:47:00 +0000330
331 // Otherwise, if we have a dirty entry, we know we can start the scan at that
332 // instruction, which may save us some work.
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000333 if (Instruction *Inst = LocalCache.getInst()) {
Chris Lattner5391a1d2008-11-29 03:47:00 +0000334 ScanPos = Inst;
Chris Lattner4a69bad2008-11-30 02:52:26 +0000335
Chris Lattnerd44745d2008-12-07 18:39:13 +0000336 RemoveFromReverseMap(ReverseLocalDeps, Inst, QueryInst);
Chris Lattner4a69bad2008-11-30 02:52:26 +0000337 }
Chris Lattner5391a1d2008-11-29 03:47:00 +0000338
Chris Lattnere79be942008-12-07 01:50:16 +0000339 BasicBlock *QueryParent = QueryInst->getParent();
340
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000341 AliasAnalysis::Location MemLoc;
Chris Lattnere79be942008-12-07 01:50:16 +0000342
Chris Lattner5391a1d2008-11-29 03:47:00 +0000343 // Do the scan.
Chris Lattnere79be942008-12-07 01:50:16 +0000344 if (BasicBlock::iterator(QueryInst) == QueryParent->begin()) {
Chris Lattner7ebcf032008-12-07 02:15:47 +0000345 // No dependence found. If this is the entry block of the function, it is a
346 // clobber, otherwise it is non-local.
347 if (QueryParent != &QueryParent->getParent()->getEntryBlock())
348 LocalCache = MemDepResult::getNonLocal();
349 else
350 LocalCache = MemDepResult::getClobber(QueryInst);
Chris Lattnere79be942008-12-07 01:50:16 +0000351 } else if (StoreInst *SI = dyn_cast<StoreInst>(QueryInst)) {
352 // If this is a volatile store, don't mess around with it. Just return the
353 // previous instruction as a clobber.
354 if (SI->isVolatile())
355 LocalCache = MemDepResult::getClobber(--BasicBlock::iterator(ScanPos));
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000356 else
357 MemLoc = AliasAnalysis::Location(SI->getPointerOperand(),
358 AA->getTypeStoreSize(SI->getOperand(0)
359 ->getType()),
360 SI->getMetadata(LLVMContext::MD_tbaa));
Chris Lattnere79be942008-12-07 01:50:16 +0000361 } else if (LoadInst *LI = dyn_cast<LoadInst>(QueryInst)) {
362 // If this is a volatile load, don't mess around with it. Just return the
363 // previous instruction as a clobber.
364 if (LI->isVolatile())
365 LocalCache = MemDepResult::getClobber(--BasicBlock::iterator(ScanPos));
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000366 else
367 MemLoc = AliasAnalysis::Location(LI->getPointerOperand(),
368 AA->getTypeStoreSize(LI->getType()),
369 LI->getMetadata(LLVMContext::MD_tbaa));
Gabor Greif8ff72b52010-06-23 22:48:06 +0000370 } else if (const CallInst *CI = isFreeCall(QueryInst)) {
Victor Hernandez66284e02009-10-24 04:23:03 +0000371 // calls to free() erase the entire structure, not just a field.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000372 MemLoc = AliasAnalysis::Location(CI->getArgOperand(0));
Chris Lattnere79be942008-12-07 01:50:16 +0000373 } else if (isa<CallInst>(QueryInst) || isa<InvokeInst>(QueryInst)) {
Nick Lewyckyd801c102009-11-28 21:27:49 +0000374 int IntrinsicID = 0; // Intrinsic IDs start at 1.
Gabor Greif8ff72b52010-06-23 22:48:06 +0000375 IntrinsicInst *II = dyn_cast<IntrinsicInst>(QueryInst);
376 if (II)
Nick Lewyckyd801c102009-11-28 21:27:49 +0000377 IntrinsicID = II->getIntrinsicID();
378
379 switch (IntrinsicID) {
Nick Lewycky93d33112009-12-05 06:37:24 +0000380 case Intrinsic::lifetime_start:
381 case Intrinsic::lifetime_end:
382 case Intrinsic::invariant_start:
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000383 MemLoc = AliasAnalysis::Location(II->getArgOperand(1),
384 cast<ConstantInt>(II->getArgOperand(0))
385 ->getZExtValue(),
386 II->getMetadata(LLVMContext::MD_tbaa));
Gabor Greif607a7ab2010-04-16 01:16:20 +0000387 break;
Eric Christopher551754c2010-04-16 23:37:20 +0000388 case Intrinsic::invariant_end:
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000389 MemLoc = AliasAnalysis::Location(II->getArgOperand(2),
390 cast<ConstantInt>(II->getArgOperand(1))
391 ->getZExtValue(),
392 II->getMetadata(LLVMContext::MD_tbaa));
Eric Christopher551754c2010-04-16 23:37:20 +0000393 break;
Nick Lewycky93d33112009-12-05 06:37:24 +0000394 default:
Gabor Greif622b7cf2010-07-27 22:02:00 +0000395 CallSite QueryCS(QueryInst);
Nick Lewycky93d33112009-12-05 06:37:24 +0000396 bool isReadOnly = AA->onlyReadsMemory(QueryCS);
397 LocalCache = getCallSiteDependencyFrom(QueryCS, isReadOnly, ScanPos,
398 QueryParent);
399 break;
Nick Lewyckyd801c102009-11-28 21:27:49 +0000400 }
Chris Lattnere79be942008-12-07 01:50:16 +0000401 } else {
402 // Non-memory instruction.
403 LocalCache = MemDepResult::getClobber(--BasicBlock::iterator(ScanPos));
404 }
405
406 // If we need to do a pointer scan, make it happen.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000407 if (MemLoc.Ptr) {
Nick Lewyckyd801c102009-11-28 21:27:49 +0000408 bool isLoad = !QueryInst->mayWriteToMemory();
409 if (IntrinsicInst *II = dyn_cast<MemoryUseIntrinsic>(QueryInst)) {
410 isLoad |= II->getIntrinsicID() == Intrinsic::lifetime_end;
411 }
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000412 LocalCache = getPointerDependencyFrom(MemLoc, isLoad, ScanPos,
Nick Lewyckyd801c102009-11-28 21:27:49 +0000413 QueryParent);
414 }
Chris Lattner5391a1d2008-11-29 03:47:00 +0000415
416 // Remember the result!
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000417 if (Instruction *I = LocalCache.getInst())
Chris Lattner8c465272008-11-29 09:20:15 +0000418 ReverseLocalDeps[I].insert(QueryInst);
Chris Lattner5391a1d2008-11-29 03:47:00 +0000419
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +0000420 return LocalCache;
Chris Lattner5391a1d2008-11-29 03:47:00 +0000421}
422
Chris Lattner12a7db32009-01-22 07:04:01 +0000423#ifndef NDEBUG
424/// AssertSorted - This method is used when -debug is specified to verify that
425/// cache arrays are properly kept sorted.
426static void AssertSorted(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
427 int Count = -1) {
428 if (Count == -1) Count = Cache.size();
429 if (Count == 0) return;
430
431 for (unsigned i = 1; i != unsigned(Count); ++i)
Chris Lattnere18b9712009-12-09 07:08:01 +0000432 assert(!(Cache[i] < Cache[i-1]) && "Cache isn't sorted!");
Chris Lattner12a7db32009-01-22 07:04:01 +0000433}
434#endif
435
Chris Lattner1559b362008-12-09 19:38:05 +0000436/// getNonLocalCallDependency - Perform a full dependency query for the
437/// specified call, returning the set of blocks that the value is
Chris Lattner37d041c2008-11-30 01:18:27 +0000438/// potentially live across. The returned set of results will include a
439/// "NonLocal" result for all blocks where the value is live across.
440///
Chris Lattner1559b362008-12-09 19:38:05 +0000441/// This method assumes the instruction returns a "NonLocal" dependency
Chris Lattner37d041c2008-11-30 01:18:27 +0000442/// within its own block.
443///
Chris Lattner1559b362008-12-09 19:38:05 +0000444/// This returns a reference to an internal data structure that may be
445/// invalidated on the next non-local query or when an instruction is
446/// removed. Clients must copy this data if they want it around longer than
447/// that.
Chris Lattnerbf145d62008-12-01 01:15:42 +0000448const MemoryDependenceAnalysis::NonLocalDepInfo &
Chris Lattner1559b362008-12-09 19:38:05 +0000449MemoryDependenceAnalysis::getNonLocalCallDependency(CallSite QueryCS) {
450 assert(getDependency(QueryCS.getInstruction()).isNonLocal() &&
451 "getNonLocalCallDependency should only be used on calls with non-local deps!");
452 PerInstNLInfo &CacheP = NonLocalDeps[QueryCS.getInstruction()];
Chris Lattnerbf145d62008-12-01 01:15:42 +0000453 NonLocalDepInfo &Cache = CacheP.first;
Chris Lattner37d041c2008-11-30 01:18:27 +0000454
455 /// DirtyBlocks - This is the set of blocks that need to be recomputed. In
456 /// the cached case, this can happen due to instructions being deleted etc. In
457 /// the uncached case, this starts out as the set of predecessors we care
458 /// about.
459 SmallVector<BasicBlock*, 32> DirtyBlocks;
460
461 if (!Cache.empty()) {
Chris Lattnerbf145d62008-12-01 01:15:42 +0000462 // Okay, we have a cache entry. If we know it is not dirty, just return it
463 // with no computation.
464 if (!CacheP.second) {
Dan Gohmanfe601042010-06-22 15:08:57 +0000465 ++NumCacheNonLocal;
Chris Lattnerbf145d62008-12-01 01:15:42 +0000466 return Cache;
467 }
468
Chris Lattner37d041c2008-11-30 01:18:27 +0000469 // If we already have a partially computed set of results, scan them to
Chris Lattnerbf145d62008-12-01 01:15:42 +0000470 // determine what is dirty, seeding our initial DirtyBlocks worklist.
471 for (NonLocalDepInfo::iterator I = Cache.begin(), E = Cache.end();
472 I != E; ++I)
Chris Lattnere18b9712009-12-09 07:08:01 +0000473 if (I->getResult().isDirty())
474 DirtyBlocks.push_back(I->getBB());
Chris Lattner37d041c2008-11-30 01:18:27 +0000475
Chris Lattnerbf145d62008-12-01 01:15:42 +0000476 // Sort the cache so that we can do fast binary search lookups below.
477 std::sort(Cache.begin(), Cache.end());
Chris Lattner37d041c2008-11-30 01:18:27 +0000478
Chris Lattnerbf145d62008-12-01 01:15:42 +0000479 ++NumCacheDirtyNonLocal;
Chris Lattner37d041c2008-11-30 01:18:27 +0000480 //cerr << "CACHED CASE: " << DirtyBlocks.size() << " dirty: "
481 // << Cache.size() << " cached: " << *QueryInst;
482 } else {
483 // Seed DirtyBlocks with each of the preds of QueryInst's block.
Chris Lattner1559b362008-12-09 19:38:05 +0000484 BasicBlock *QueryBB = QueryCS.getInstruction()->getParent();
Chris Lattner511b36c2008-12-09 06:44:17 +0000485 for (BasicBlock **PI = PredCache->GetPreds(QueryBB); *PI; ++PI)
486 DirtyBlocks.push_back(*PI);
Dan Gohmanfe601042010-06-22 15:08:57 +0000487 ++NumUncacheNonLocal;
Chris Lattner37d041c2008-11-30 01:18:27 +0000488 }
489
Chris Lattner20d6f092008-12-09 21:19:42 +0000490 // isReadonlyCall - If this is a read-only call, we can be more aggressive.
491 bool isReadonlyCall = AA->onlyReadsMemory(QueryCS);
Chris Lattner9e59c642008-12-15 03:35:32 +0000492
Chris Lattnerbf145d62008-12-01 01:15:42 +0000493 SmallPtrSet<BasicBlock*, 64> Visited;
494
495 unsigned NumSortedEntries = Cache.size();
Chris Lattner12a7db32009-01-22 07:04:01 +0000496 DEBUG(AssertSorted(Cache));
Chris Lattnerbf145d62008-12-01 01:15:42 +0000497
Chris Lattner37d041c2008-11-30 01:18:27 +0000498 // Iterate while we still have blocks to update.
499 while (!DirtyBlocks.empty()) {
500 BasicBlock *DirtyBB = DirtyBlocks.back();
501 DirtyBlocks.pop_back();
502
Chris Lattnerbf145d62008-12-01 01:15:42 +0000503 // Already processed this block?
504 if (!Visited.insert(DirtyBB))
505 continue;
Chris Lattner37d041c2008-11-30 01:18:27 +0000506
Chris Lattnerbf145d62008-12-01 01:15:42 +0000507 // Do a binary search to see if we already have an entry for this block in
508 // the cache set. If so, find it.
Chris Lattner12a7db32009-01-22 07:04:01 +0000509 DEBUG(AssertSorted(Cache, NumSortedEntries));
Chris Lattnerbf145d62008-12-01 01:15:42 +0000510 NonLocalDepInfo::iterator Entry =
511 std::upper_bound(Cache.begin(), Cache.begin()+NumSortedEntries,
Chris Lattnerdad451c2009-12-09 07:31:04 +0000512 NonLocalDepEntry(DirtyBB));
Chris Lattnere18b9712009-12-09 07:08:01 +0000513 if (Entry != Cache.begin() && prior(Entry)->getBB() == DirtyBB)
Chris Lattnerbf145d62008-12-01 01:15:42 +0000514 --Entry;
515
Chris Lattnere18b9712009-12-09 07:08:01 +0000516 NonLocalDepEntry *ExistingResult = 0;
Chris Lattnerbf145d62008-12-01 01:15:42 +0000517 if (Entry != Cache.begin()+NumSortedEntries &&
Chris Lattnere18b9712009-12-09 07:08:01 +0000518 Entry->getBB() == DirtyBB) {
Chris Lattnerbf145d62008-12-01 01:15:42 +0000519 // If we already have an entry, and if it isn't already dirty, the block
520 // is done.
Chris Lattnere18b9712009-12-09 07:08:01 +0000521 if (!Entry->getResult().isDirty())
Chris Lattnerbf145d62008-12-01 01:15:42 +0000522 continue;
523
524 // Otherwise, remember this slot so we can update the value.
Chris Lattnere18b9712009-12-09 07:08:01 +0000525 ExistingResult = &*Entry;
Chris Lattnerbf145d62008-12-01 01:15:42 +0000526 }
527
Chris Lattner37d041c2008-11-30 01:18:27 +0000528 // If the dirty entry has a pointer, start scanning from it so we don't have
529 // to rescan the entire block.
530 BasicBlock::iterator ScanPos = DirtyBB->end();
Chris Lattnerbf145d62008-12-01 01:15:42 +0000531 if (ExistingResult) {
Chris Lattnere18b9712009-12-09 07:08:01 +0000532 if (Instruction *Inst = ExistingResult->getResult().getInst()) {
Chris Lattnerbf145d62008-12-01 01:15:42 +0000533 ScanPos = Inst;
Chris Lattnerbf145d62008-12-01 01:15:42 +0000534 // We're removing QueryInst's use of Inst.
Chris Lattner1559b362008-12-09 19:38:05 +0000535 RemoveFromReverseMap(ReverseNonLocalDeps, Inst,
536 QueryCS.getInstruction());
Chris Lattnerbf145d62008-12-01 01:15:42 +0000537 }
Chris Lattnerf68f3102008-11-30 02:28:25 +0000538 }
Chris Lattner37d041c2008-11-30 01:18:27 +0000539
Chris Lattner73ec3cd2008-11-30 01:26:32 +0000540 // Find out if this block has a local dependency for QueryInst.
Chris Lattnerd8dd9342008-12-07 01:21:14 +0000541 MemDepResult Dep;
Chris Lattnere79be942008-12-07 01:50:16 +0000542
Chris Lattner1559b362008-12-09 19:38:05 +0000543 if (ScanPos != DirtyBB->begin()) {
Chris Lattner20d6f092008-12-09 21:19:42 +0000544 Dep = getCallSiteDependencyFrom(QueryCS, isReadonlyCall,ScanPos, DirtyBB);
Chris Lattner1559b362008-12-09 19:38:05 +0000545 } else if (DirtyBB != &DirtyBB->getParent()->getEntryBlock()) {
546 // No dependence found. If this is the entry block of the function, it is
547 // a clobber, otherwise it is non-local.
548 Dep = MemDepResult::getNonLocal();
Chris Lattnere79be942008-12-07 01:50:16 +0000549 } else {
Chris Lattner1559b362008-12-09 19:38:05 +0000550 Dep = MemDepResult::getClobber(ScanPos);
Chris Lattnere79be942008-12-07 01:50:16 +0000551 }
552
Chris Lattnerbf145d62008-12-01 01:15:42 +0000553 // If we had a dirty entry for the block, update it. Otherwise, just add
554 // a new entry.
555 if (ExistingResult)
Chris Lattner0ee443d2009-12-22 04:25:02 +0000556 ExistingResult->setResult(Dep);
Chris Lattnerbf145d62008-12-01 01:15:42 +0000557 else
Chris Lattner0ee443d2009-12-22 04:25:02 +0000558 Cache.push_back(NonLocalDepEntry(DirtyBB, Dep));
Chris Lattnerbf145d62008-12-01 01:15:42 +0000559
Chris Lattner37d041c2008-11-30 01:18:27 +0000560 // If the block has a dependency (i.e. it isn't completely transparent to
Chris Lattnerbf145d62008-12-01 01:15:42 +0000561 // the value), remember the association!
562 if (!Dep.isNonLocal()) {
Chris Lattner37d041c2008-11-30 01:18:27 +0000563 // Keep the ReverseNonLocalDeps map up to date so we can efficiently
564 // update this when we remove instructions.
Chris Lattnerbf145d62008-12-01 01:15:42 +0000565 if (Instruction *Inst = Dep.getInst())
Chris Lattner1559b362008-12-09 19:38:05 +0000566 ReverseNonLocalDeps[Inst].insert(QueryCS.getInstruction());
Chris Lattnerbf145d62008-12-01 01:15:42 +0000567 } else {
Chris Lattner37d041c2008-11-30 01:18:27 +0000568
Chris Lattnerbf145d62008-12-01 01:15:42 +0000569 // If the block *is* completely transparent to the load, we need to check
570 // the predecessors of this block. Add them to our worklist.
Chris Lattner511b36c2008-12-09 06:44:17 +0000571 for (BasicBlock **PI = PredCache->GetPreds(DirtyBB); *PI; ++PI)
572 DirtyBlocks.push_back(*PI);
Chris Lattnerbf145d62008-12-01 01:15:42 +0000573 }
Chris Lattner37d041c2008-11-30 01:18:27 +0000574 }
575
Chris Lattnerbf145d62008-12-01 01:15:42 +0000576 return Cache;
Chris Lattner37d041c2008-11-30 01:18:27 +0000577}
578
Chris Lattner7ebcf032008-12-07 02:15:47 +0000579/// getNonLocalPointerDependency - Perform a full dependency query for an
580/// access to the specified (non-volatile) memory location, returning the
581/// set of instructions that either define or clobber the value.
582///
583/// This method assumes the pointer has a "NonLocal" dependency within its
584/// own block.
585///
586void MemoryDependenceAnalysis::
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000587getNonLocalPointerDependency(const AliasAnalysis::Location &Loc, bool isLoad,
588 BasicBlock *FromBB,
Chris Lattner0ee443d2009-12-22 04:25:02 +0000589 SmallVectorImpl<NonLocalDepResult> &Result) {
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000590 assert(Loc.Ptr->getType()->isPointerTy() &&
Chris Lattner3f7eb5b2008-12-07 18:45:15 +0000591 "Can't get pointer deps of a non-pointer!");
Chris Lattner9a193fd2008-12-07 02:56:57 +0000592 Result.clear();
593
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000594 PHITransAddr Address(const_cast<Value *>(Loc.Ptr), TD);
Chris Lattner05e15f82009-12-09 01:59:31 +0000595
Chris Lattner9e59c642008-12-15 03:35:32 +0000596 // This is the set of blocks we've inspected, and the pointer we consider in
597 // each block. Because of critical edges, we currently bail out if querying
598 // a block with multiple different pointers. This can happen during PHI
599 // translation.
600 DenseMap<BasicBlock*, Value*> Visited;
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000601 if (!getNonLocalPointerDepFromBB(Address, Loc, isLoad, FromBB,
Chris Lattner9e59c642008-12-15 03:35:32 +0000602 Result, Visited, true))
603 return;
Chris Lattner3af23f82008-12-15 04:58:29 +0000604 Result.clear();
Chris Lattner0ee443d2009-12-22 04:25:02 +0000605 Result.push_back(NonLocalDepResult(FromBB,
606 MemDepResult::getClobber(FromBB->begin()),
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000607 const_cast<Value *>(Loc.Ptr)));
Chris Lattner9a193fd2008-12-07 02:56:57 +0000608}
609
Chris Lattner9863c3f2008-12-09 07:47:11 +0000610/// GetNonLocalInfoForBlock - Compute the memdep value for BB with
611/// Pointer/PointeeSize using either cached information in Cache or by doing a
612/// lookup (which may use dirty cache info if available). If we do a lookup,
613/// add the result to the cache.
614MemDepResult MemoryDependenceAnalysis::
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000615GetNonLocalInfoForBlock(const AliasAnalysis::Location &Loc,
Chris Lattner9863c3f2008-12-09 07:47:11 +0000616 bool isLoad, BasicBlock *BB,
617 NonLocalDepInfo *Cache, unsigned NumSortedEntries) {
618
619 // Do a binary search to see if we already have an entry for this block in
620 // the cache set. If so, find it.
621 NonLocalDepInfo::iterator Entry =
622 std::upper_bound(Cache->begin(), Cache->begin()+NumSortedEntries,
Chris Lattnerdad451c2009-12-09 07:31:04 +0000623 NonLocalDepEntry(BB));
Chris Lattnere18b9712009-12-09 07:08:01 +0000624 if (Entry != Cache->begin() && (Entry-1)->getBB() == BB)
Chris Lattner9863c3f2008-12-09 07:47:11 +0000625 --Entry;
626
Chris Lattnere18b9712009-12-09 07:08:01 +0000627 NonLocalDepEntry *ExistingResult = 0;
628 if (Entry != Cache->begin()+NumSortedEntries && Entry->getBB() == BB)
629 ExistingResult = &*Entry;
Chris Lattner9863c3f2008-12-09 07:47:11 +0000630
631 // If we have a cached entry, and it is non-dirty, use it as the value for
632 // this dependency.
Chris Lattnere18b9712009-12-09 07:08:01 +0000633 if (ExistingResult && !ExistingResult->getResult().isDirty()) {
Chris Lattner9863c3f2008-12-09 07:47:11 +0000634 ++NumCacheNonLocalPtr;
Chris Lattnere18b9712009-12-09 07:08:01 +0000635 return ExistingResult->getResult();
Chris Lattner9863c3f2008-12-09 07:47:11 +0000636 }
637
638 // Otherwise, we have to scan for the value. If we have a dirty cache
639 // entry, start scanning from its position, otherwise we scan from the end
640 // of the block.
641 BasicBlock::iterator ScanPos = BB->end();
Chris Lattnere18b9712009-12-09 07:08:01 +0000642 if (ExistingResult && ExistingResult->getResult().getInst()) {
643 assert(ExistingResult->getResult().getInst()->getParent() == BB &&
Chris Lattner9863c3f2008-12-09 07:47:11 +0000644 "Instruction invalidated?");
645 ++NumCacheDirtyNonLocalPtr;
Chris Lattnere18b9712009-12-09 07:08:01 +0000646 ScanPos = ExistingResult->getResult().getInst();
Chris Lattner9863c3f2008-12-09 07:47:11 +0000647
648 // Eliminating the dirty entry from 'Cache', so update the reverse info.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000649 ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
Chris Lattner6a0dcc12009-03-29 00:24:04 +0000650 RemoveFromReverseMap(ReverseNonLocalPtrDeps, ScanPos, CacheKey);
Chris Lattner9863c3f2008-12-09 07:47:11 +0000651 } else {
652 ++NumUncacheNonLocalPtr;
653 }
654
655 // Scan the block for the dependency.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000656 MemDepResult Dep = getPointerDependencyFrom(Loc, isLoad, ScanPos, BB);
Chris Lattner9863c3f2008-12-09 07:47:11 +0000657
658 // If we had a dirty entry for the block, update it. Otherwise, just add
659 // a new entry.
660 if (ExistingResult)
Chris Lattner0ee443d2009-12-22 04:25:02 +0000661 ExistingResult->setResult(Dep);
Chris Lattner9863c3f2008-12-09 07:47:11 +0000662 else
Chris Lattner0ee443d2009-12-22 04:25:02 +0000663 Cache->push_back(NonLocalDepEntry(BB, Dep));
Chris Lattner9863c3f2008-12-09 07:47:11 +0000664
665 // If the block has a dependency (i.e. it isn't completely transparent to
666 // the value), remember the reverse association because we just added it
667 // to Cache!
668 if (Dep.isNonLocal())
669 return Dep;
670
671 // Keep the ReverseNonLocalPtrDeps map up to date so we can efficiently
672 // update MemDep when we remove instructions.
673 Instruction *Inst = Dep.getInst();
674 assert(Inst && "Didn't depend on anything?");
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000675 ValueIsLoadPair CacheKey(Loc.Ptr, isLoad);
Chris Lattner6a0dcc12009-03-29 00:24:04 +0000676 ReverseNonLocalPtrDeps[Inst].insert(CacheKey);
Chris Lattner9863c3f2008-12-09 07:47:11 +0000677 return Dep;
678}
679
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000680/// SortNonLocalDepInfoCache - Sort the a NonLocalDepInfo cache, given a certain
681/// number of elements in the array that are already properly ordered. This is
682/// optimized for the case when only a few entries are added.
683static void
684SortNonLocalDepInfoCache(MemoryDependenceAnalysis::NonLocalDepInfo &Cache,
685 unsigned NumSortedEntries) {
686 switch (Cache.size() - NumSortedEntries) {
687 case 0:
688 // done, no new entries.
689 break;
690 case 2: {
691 // Two new entries, insert the last one into place.
Chris Lattnere18b9712009-12-09 07:08:01 +0000692 NonLocalDepEntry Val = Cache.back();
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000693 Cache.pop_back();
694 MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
695 std::upper_bound(Cache.begin(), Cache.end()-1, Val);
696 Cache.insert(Entry, Val);
697 // FALL THROUGH.
698 }
699 case 1:
700 // One new entry, Just insert the new value at the appropriate position.
701 if (Cache.size() != 1) {
Chris Lattnere18b9712009-12-09 07:08:01 +0000702 NonLocalDepEntry Val = Cache.back();
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000703 Cache.pop_back();
704 MemoryDependenceAnalysis::NonLocalDepInfo::iterator Entry =
705 std::upper_bound(Cache.begin(), Cache.end(), Val);
706 Cache.insert(Entry, Val);
707 }
708 break;
709 default:
710 // Added many values, do a full scale sort.
711 std::sort(Cache.begin(), Cache.end());
712 break;
713 }
714}
715
Chris Lattner9e59c642008-12-15 03:35:32 +0000716/// getNonLocalPointerDepFromBB - Perform a dependency query based on
717/// pointer/pointeesize starting at the end of StartBB. Add any clobber/def
718/// results to the results vector and keep track of which blocks are visited in
719/// 'Visited'.
720///
721/// This has special behavior for the first block queries (when SkipFirstBlock
722/// is true). In this special case, it ignores the contents of the specified
723/// block and starts returning dependence info for its predecessors.
724///
725/// This function returns false on success, or true to indicate that it could
726/// not compute dependence information for some reason. This should be treated
727/// as a clobber dependence on the first instruction in the predecessor block.
728bool MemoryDependenceAnalysis::
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000729getNonLocalPointerDepFromBB(const PHITransAddr &Pointer,
730 const AliasAnalysis::Location &Loc,
Chris Lattner9863c3f2008-12-09 07:47:11 +0000731 bool isLoad, BasicBlock *StartBB,
Chris Lattner0ee443d2009-12-22 04:25:02 +0000732 SmallVectorImpl<NonLocalDepResult> &Result,
Chris Lattner9e59c642008-12-15 03:35:32 +0000733 DenseMap<BasicBlock*, Value*> &Visited,
734 bool SkipFirstBlock) {
Chris Lattner66364342009-09-20 22:44:26 +0000735
Chris Lattner6290f5c2008-12-07 08:50:20 +0000736 // Look up the cached info for Pointer.
Chris Lattner05e15f82009-12-09 01:59:31 +0000737 ValueIsLoadPair CacheKey(Pointer.getAddr(), isLoad);
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000738 NonLocalPointerInfo *CacheInfo = &NonLocalPointerDeps[CacheKey];
739
740 // If this query's TBAATag is inconsistent with the cached one, discard the
741 // tag and restart the query.
742 if (CacheInfo->TBAATag != Loc.TBAATag) {
743 CacheInfo->TBAATag = 0;
744 NonLocalPointerDeps.erase(CacheKey);
745 return getNonLocalPointerDepFromBB(Pointer, Loc.getWithoutTBAATag(),
746 isLoad, StartBB, Result, Visited,
747 SkipFirstBlock);
748 }
749
750 NonLocalDepInfo *Cache = &CacheInfo->NonLocalDeps;
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000751
752 // If we have valid cached information for exactly the block we are
753 // investigating, just return it with no recomputation.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000754 if (CacheInfo->Pair == BBSkipFirstBlockPair(StartBB, SkipFirstBlock)) {
Chris Lattnerf4789512008-12-16 07:10:09 +0000755 // We have a fully cached result for this query then we can just return the
756 // cached results and populate the visited set. However, we have to verify
757 // that we don't already have conflicting results for these blocks. Check
758 // to ensure that if a block in the results set is in the visited set that
759 // it was for the same pointer query.
760 if (!Visited.empty()) {
761 for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
762 I != E; ++I) {
Chris Lattnere18b9712009-12-09 07:08:01 +0000763 DenseMap<BasicBlock*, Value*>::iterator VI = Visited.find(I->getBB());
Chris Lattner05e15f82009-12-09 01:59:31 +0000764 if (VI == Visited.end() || VI->second == Pointer.getAddr())
765 continue;
Chris Lattnerf4789512008-12-16 07:10:09 +0000766
767 // We have a pointer mismatch in a block. Just return clobber, saying
768 // that something was clobbered in this result. We could also do a
769 // non-fully cached query, but there is little point in doing this.
770 return true;
771 }
772 }
773
Chris Lattner0ee443d2009-12-22 04:25:02 +0000774 Value *Addr = Pointer.getAddr();
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000775 for (NonLocalDepInfo::iterator I = Cache->begin(), E = Cache->end();
Chris Lattnerf4789512008-12-16 07:10:09 +0000776 I != E; ++I) {
Chris Lattner0ee443d2009-12-22 04:25:02 +0000777 Visited.insert(std::make_pair(I->getBB(), Addr));
Chris Lattnere18b9712009-12-09 07:08:01 +0000778 if (!I->getResult().isNonLocal())
Chris Lattner0ee443d2009-12-22 04:25:02 +0000779 Result.push_back(NonLocalDepResult(I->getBB(), I->getResult(), Addr));
Chris Lattnerf4789512008-12-16 07:10:09 +0000780 }
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000781 ++NumCacheCompleteNonLocalPtr;
Chris Lattner9e59c642008-12-15 03:35:32 +0000782 return false;
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000783 }
784
785 // Otherwise, either this is a new block, a block with an invalid cache
786 // pointer or one that we're about to invalidate by putting more info into it
787 // than its valid cache info. If empty, the result will be valid cache info,
788 // otherwise it isn't.
Chris Lattner9e59c642008-12-15 03:35:32 +0000789 if (Cache->empty())
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000790 CacheInfo->Pair = BBSkipFirstBlockPair(StartBB, SkipFirstBlock);
791 else {
792 CacheInfo->Pair = BBSkipFirstBlockPair();
793 CacheInfo->TBAATag = 0;
794 }
Chris Lattner11dcd8d2008-12-08 07:31:50 +0000795
796 SmallVector<BasicBlock*, 32> Worklist;
797 Worklist.push_back(StartBB);
Chris Lattner6290f5c2008-12-07 08:50:20 +0000798
799 // Keep track of the entries that we know are sorted. Previously cached
800 // entries will all be sorted. The entries we add we only sort on demand (we
801 // don't insert every element into its sorted position). We know that we
802 // won't get any reuse from currently inserted values, because we don't
803 // revisit blocks after we insert info for them.
804 unsigned NumSortedEntries = Cache->size();
Chris Lattner12a7db32009-01-22 07:04:01 +0000805 DEBUG(AssertSorted(*Cache));
Chris Lattner6290f5c2008-12-07 08:50:20 +0000806
Chris Lattner7ebcf032008-12-07 02:15:47 +0000807 while (!Worklist.empty()) {
Chris Lattner9a193fd2008-12-07 02:56:57 +0000808 BasicBlock *BB = Worklist.pop_back_val();
Chris Lattner7ebcf032008-12-07 02:15:47 +0000809
Chris Lattner65633712008-12-09 07:52:59 +0000810 // Skip the first block if we have it.
Chris Lattner9e59c642008-12-15 03:35:32 +0000811 if (!SkipFirstBlock) {
Chris Lattner65633712008-12-09 07:52:59 +0000812 // Analyze the dependency of *Pointer in FromBB. See if we already have
813 // been here.
Chris Lattner9e59c642008-12-15 03:35:32 +0000814 assert(Visited.count(BB) && "Should check 'visited' before adding to WL");
Chris Lattner6290f5c2008-12-07 08:50:20 +0000815
Chris Lattner65633712008-12-09 07:52:59 +0000816 // Get the dependency info for Pointer in BB. If we have cached
817 // information, we will use it, otherwise we compute it.
Chris Lattner12a7db32009-01-22 07:04:01 +0000818 DEBUG(AssertSorted(*Cache, NumSortedEntries));
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000819 MemDepResult Dep = GetNonLocalInfoForBlock(Loc, isLoad, BB, Cache,
Chris Lattner05e15f82009-12-09 01:59:31 +0000820 NumSortedEntries);
Chris Lattner65633712008-12-09 07:52:59 +0000821
822 // If we got a Def or Clobber, add this to the list of results.
823 if (!Dep.isNonLocal()) {
Chris Lattner0ee443d2009-12-22 04:25:02 +0000824 Result.push_back(NonLocalDepResult(BB, Dep, Pointer.getAddr()));
Chris Lattner65633712008-12-09 07:52:59 +0000825 continue;
826 }
Chris Lattner7ebcf032008-12-07 02:15:47 +0000827 }
828
Chris Lattner9e59c642008-12-15 03:35:32 +0000829 // If 'Pointer' is an instruction defined in this block, then we need to do
830 // phi translation to change it into a value live in the predecessor block.
Chris Lattner05e15f82009-12-09 01:59:31 +0000831 // If not, we just add the predecessors to the worklist and scan them with
832 // the same Pointer.
833 if (!Pointer.NeedsPHITranslationFromBlock(BB)) {
Chris Lattner9e59c642008-12-15 03:35:32 +0000834 SkipFirstBlock = false;
835 for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
836 // Verify that we haven't looked at this block yet.
837 std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
Chris Lattner05e15f82009-12-09 01:59:31 +0000838 InsertRes = Visited.insert(std::make_pair(*PI, Pointer.getAddr()));
Chris Lattner9e59c642008-12-15 03:35:32 +0000839 if (InsertRes.second) {
840 // First time we've looked at *PI.
841 Worklist.push_back(*PI);
842 continue;
843 }
844
845 // If we have seen this block before, but it was with a different
846 // pointer then we have a phi translation failure and we have to treat
847 // this as a clobber.
Chris Lattner05e15f82009-12-09 01:59:31 +0000848 if (InsertRes.first->second != Pointer.getAddr())
Chris Lattner9e59c642008-12-15 03:35:32 +0000849 goto PredTranslationFailure;
850 }
851 continue;
852 }
853
Chris Lattner05e15f82009-12-09 01:59:31 +0000854 // We do need to do phi translation, if we know ahead of time we can't phi
855 // translate this value, don't even try.
856 if (!Pointer.IsPotentiallyPHITranslatable())
857 goto PredTranslationFailure;
858
Chris Lattner6fbc1962009-07-13 17:14:23 +0000859 // We may have added values to the cache list before this PHI translation.
860 // If so, we haven't done anything to ensure that the cache remains sorted.
861 // Sort it now (if needed) so that recursive invocations of
862 // getNonLocalPointerDepFromBB and other routines that could reuse the cache
863 // value will only see properly sorted cache arrays.
864 if (Cache && NumSortedEntries != Cache->size()) {
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000865 SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
Chris Lattner6fbc1962009-07-13 17:14:23 +0000866 NumSortedEntries = Cache->size();
867 }
Chris Lattnere95035a2009-11-27 08:37:22 +0000868 Cache = 0;
Chris Lattner05e15f82009-12-09 01:59:31 +0000869
Chris Lattnere95035a2009-11-27 08:37:22 +0000870 for (BasicBlock **PI = PredCache->GetPreds(BB); *PI; ++PI) {
871 BasicBlock *Pred = *PI;
Chris Lattner05e15f82009-12-09 01:59:31 +0000872
873 // Get the PHI translated pointer in this predecessor. This can fail if
874 // not translatable, in which case the getAddr() returns null.
875 PHITransAddr PredPointer(Pointer);
Daniel Dunbar6d8f2ca2010-02-24 08:48:04 +0000876 PredPointer.PHITranslateValue(BB, Pred, 0);
Chris Lattner05e15f82009-12-09 01:59:31 +0000877
878 Value *PredPtrVal = PredPointer.getAddr();
Chris Lattnere95035a2009-11-27 08:37:22 +0000879
880 // Check to see if we have already visited this pred block with another
881 // pointer. If so, we can't do this lookup. This failure can occur
882 // with PHI translation when a critical edge exists and the PHI node in
883 // the successor translates to a pointer value different than the
884 // pointer the block was first analyzed with.
885 std::pair<DenseMap<BasicBlock*,Value*>::iterator, bool>
Chris Lattner05e15f82009-12-09 01:59:31 +0000886 InsertRes = Visited.insert(std::make_pair(Pred, PredPtrVal));
Chris Lattner9e59c642008-12-15 03:35:32 +0000887
Chris Lattnere95035a2009-11-27 08:37:22 +0000888 if (!InsertRes.second) {
889 // If the predecessor was visited with PredPtr, then we already did
890 // the analysis and can ignore it.
Chris Lattner05e15f82009-12-09 01:59:31 +0000891 if (InsertRes.first->second == PredPtrVal)
Chris Lattnere95035a2009-11-27 08:37:22 +0000892 continue;
Chris Lattner9e59c642008-12-15 03:35:32 +0000893
Chris Lattnere95035a2009-11-27 08:37:22 +0000894 // Otherwise, the block was previously analyzed with a different
895 // pointer. We can't represent the result of this case, so we just
896 // treat this as a phi translation failure.
897 goto PredTranslationFailure;
Chris Lattner9e59c642008-12-15 03:35:32 +0000898 }
Chris Lattner6f7b2102009-11-27 22:05:15 +0000899
900 // If PHI translation was unable to find an available pointer in this
901 // predecessor, then we have to assume that the pointer is clobbered in
902 // that predecessor. We can still do PRE of the load, which would insert
903 // a computation of the pointer in this predecessor.
Chris Lattner05e15f82009-12-09 01:59:31 +0000904 if (PredPtrVal == 0) {
Chris Lattner855d9da2009-12-01 07:33:32 +0000905 // Add the entry to the Result list.
Chris Lattner0ee443d2009-12-22 04:25:02 +0000906 NonLocalDepResult Entry(Pred,
907 MemDepResult::getClobber(Pred->getTerminator()),
908 PredPtrVal);
Chris Lattner855d9da2009-12-01 07:33:32 +0000909 Result.push_back(Entry);
910
Chris Lattnerf6481252009-12-19 21:29:22 +0000911 // Since we had a phi translation failure, the cache for CacheKey won't
912 // include all of the entries that we need to immediately satisfy future
913 // queries. Mark this in NonLocalPointerDeps by setting the
914 // BBSkipFirstBlockPair pointer to null. This requires reuse of the
915 // cached value to do more work but not miss the phi trans failure.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000916 NonLocalPointerInfo &NLPI = NonLocalPointerDeps[CacheKey];
917 NLPI.Pair = BBSkipFirstBlockPair();
918 NLPI.TBAATag = 0;
Chris Lattner6f7b2102009-11-27 22:05:15 +0000919 continue;
Chris Lattner6f7b2102009-11-27 22:05:15 +0000920 }
Chris Lattnere95035a2009-11-27 08:37:22 +0000921
922 // FIXME: it is entirely possible that PHI translating will end up with
923 // the same value. Consider PHI translating something like:
924 // X = phi [x, bb1], [y, bb2]. PHI translating for bb1 doesn't *need*
925 // to recurse here, pedantically speaking.
Chris Lattner6fbc1962009-07-13 17:14:23 +0000926
Chris Lattnere95035a2009-11-27 08:37:22 +0000927 // If we have a problem phi translating, fall through to the code below
928 // to handle the failure condition.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000929 if (getNonLocalPointerDepFromBB(PredPointer,
930 Loc.getWithNewPtr(PredPointer.getAddr()),
931 isLoad, Pred,
Chris Lattnere95035a2009-11-27 08:37:22 +0000932 Result, Visited))
933 goto PredTranslationFailure;
Chris Lattner9e59c642008-12-15 03:35:32 +0000934 }
Chris Lattnere95035a2009-11-27 08:37:22 +0000935
936 // Refresh the CacheInfo/Cache pointer so that it isn't invalidated.
937 CacheInfo = &NonLocalPointerDeps[CacheKey];
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000938 Cache = &CacheInfo->NonLocalDeps;
Chris Lattnere95035a2009-11-27 08:37:22 +0000939 NumSortedEntries = Cache->size();
940
941 // Since we did phi translation, the "Cache" set won't contain all of the
942 // 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
944 // results from the set" Clear out the indicator for this.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000945 CacheInfo->Pair = BBSkipFirstBlockPair();
946 CacheInfo->TBAATag = 0;
Chris Lattnere95035a2009-11-27 08:37:22 +0000947 SkipFirstBlock = false;
948 continue;
Chris Lattnerdc593112009-11-26 23:18:49 +0000949
Chris Lattner9e59c642008-12-15 03:35:32 +0000950 PredTranslationFailure:
951
Chris Lattner95900f22009-01-23 07:12:16 +0000952 if (Cache == 0) {
953 // Refresh the CacheInfo/Cache pointer if it got invalidated.
954 CacheInfo = &NonLocalPointerDeps[CacheKey];
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000955 Cache = &CacheInfo->NonLocalDeps;
Chris Lattner95900f22009-01-23 07:12:16 +0000956 NumSortedEntries = Cache->size();
Chris Lattner95900f22009-01-23 07:12:16 +0000957 }
Chris Lattner6fbc1962009-07-13 17:14:23 +0000958
Chris Lattnerf6481252009-12-19 21:29:22 +0000959 // Since we failed phi translation, the "Cache" set won't contain all of the
Chris Lattner9e59c642008-12-15 03:35:32 +0000960 // results for the query. This is ok (we can still use it to accelerate
961 // specific block queries) but we can't do the fastpath "return all
Chris Lattnerf6481252009-12-19 21:29:22 +0000962 // results from the set". Clear out the indicator for this.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +0000963 CacheInfo->Pair = BBSkipFirstBlockPair();
964 CacheInfo->TBAATag = 0;
Chris Lattner9e59c642008-12-15 03:35:32 +0000965
966 // If *nothing* works, mark the pointer as being clobbered by the first
967 // instruction in this block.
968 //
969 // If this is the magic first block, return this as a clobber of the whole
970 // incoming value. Since we can't phi translate to one of the predecessors,
971 // we have to bail out.
972 if (SkipFirstBlock)
973 return true;
974
975 for (NonLocalDepInfo::reverse_iterator I = Cache->rbegin(); ; ++I) {
976 assert(I != Cache->rend() && "Didn't find current block??");
Chris Lattnere18b9712009-12-09 07:08:01 +0000977 if (I->getBB() != BB)
Chris Lattner9e59c642008-12-15 03:35:32 +0000978 continue;
979
Chris Lattnere18b9712009-12-09 07:08:01 +0000980 assert(I->getResult().isNonLocal() &&
Chris Lattner9e59c642008-12-15 03:35:32 +0000981 "Should only be here with transparent block");
Chris Lattner0ee443d2009-12-22 04:25:02 +0000982 I->setResult(MemDepResult::getClobber(BB->begin()));
Chris Lattner6a0dcc12009-03-29 00:24:04 +0000983 ReverseNonLocalPtrDeps[BB->begin()].insert(CacheKey);
Chris Lattner0ee443d2009-12-22 04:25:02 +0000984 Result.push_back(NonLocalDepResult(I->getBB(), I->getResult(),
985 Pointer.getAddr()));
Chris Lattner9e59c642008-12-15 03:35:32 +0000986 break;
Chris Lattner9a193fd2008-12-07 02:56:57 +0000987 }
Chris Lattner7ebcf032008-12-07 02:15:47 +0000988 }
Chris Lattner95900f22009-01-23 07:12:16 +0000989
Chris Lattner9863c3f2008-12-09 07:47:11 +0000990 // Okay, we're done now. If we added new values to the cache, re-sort it.
Chris Lattnera2f55dd2009-07-13 17:20:05 +0000991 SortNonLocalDepInfoCache(*Cache, NumSortedEntries);
Chris Lattner12a7db32009-01-22 07:04:01 +0000992 DEBUG(AssertSorted(*Cache));
Chris Lattner9e59c642008-12-15 03:35:32 +0000993 return false;
Chris Lattner6290f5c2008-12-07 08:50:20 +0000994}
995
996/// RemoveCachedNonLocalPointerDependencies - If P exists in
997/// CachedNonLocalPointerInfo, remove it.
998void MemoryDependenceAnalysis::
999RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair P) {
1000 CachedNonLocalPointerInfo::iterator It =
1001 NonLocalPointerDeps.find(P);
1002 if (It == NonLocalPointerDeps.end()) return;
1003
1004 // Remove all of the entries in the BB->val map. This involves removing
1005 // instructions from the reverse map.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +00001006 NonLocalDepInfo &PInfo = It->second.NonLocalDeps;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001007
1008 for (unsigned i = 0, e = PInfo.size(); i != e; ++i) {
Chris Lattnere18b9712009-12-09 07:08:01 +00001009 Instruction *Target = PInfo[i].getResult().getInst();
Chris Lattner6290f5c2008-12-07 08:50:20 +00001010 if (Target == 0) continue; // Ignore non-local dep results.
Chris Lattnere18b9712009-12-09 07:08:01 +00001011 assert(Target->getParent() == PInfo[i].getBB());
Chris Lattner6290f5c2008-12-07 08:50:20 +00001012
1013 // Eliminating the dirty entry from 'Cache', so update the reverse info.
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001014 RemoveFromReverseMap(ReverseNonLocalPtrDeps, Target, P);
Chris Lattner6290f5c2008-12-07 08:50:20 +00001015 }
1016
1017 // Remove P from NonLocalPointerDeps (which deletes NonLocalDepInfo).
1018 NonLocalPointerDeps.erase(It);
Chris Lattner7ebcf032008-12-07 02:15:47 +00001019}
1020
1021
Chris Lattnerbc99be12008-12-09 22:06:23 +00001022/// invalidateCachedPointerInfo - This method is used to invalidate cached
1023/// information about the specified pointer, because it may be too
1024/// conservative in memdep. This is an optional call that can be used when
1025/// the client detects an equivalence between the pointer and some other
1026/// value and replaces the other value with ptr. This can make Ptr available
1027/// in more places that cached info does not necessarily keep.
1028void MemoryDependenceAnalysis::invalidateCachedPointerInfo(Value *Ptr) {
1029 // If Ptr isn't really a pointer, just ignore it.
Duncan Sands1df98592010-02-16 11:11:14 +00001030 if (!Ptr->getType()->isPointerTy()) return;
Chris Lattnerbc99be12008-12-09 22:06:23 +00001031 // Flush store info for the pointer.
1032 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, false));
1033 // Flush load info for the pointer.
1034 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(Ptr, true));
1035}
1036
Bob Wilson484d4a32010-02-16 19:51:59 +00001037/// invalidateCachedPredecessors - Clear the PredIteratorCache info.
1038/// This needs to be done when the CFG changes, e.g., due to splitting
1039/// critical edges.
1040void MemoryDependenceAnalysis::invalidateCachedPredecessors() {
1041 PredCache->clear();
1042}
1043
Owen Anderson78e02f72007-07-06 23:14:35 +00001044/// removeInstruction - Remove an instruction from the dependence analysis,
1045/// updating the dependence of instructions that previously depended on it.
Owen Anderson642a9e32007-08-08 22:26:03 +00001046/// This method attempts to keep the cache coherent using the reverse map.
Chris Lattner5f589dc2008-11-28 22:04:47 +00001047void MemoryDependenceAnalysis::removeInstruction(Instruction *RemInst) {
Chris Lattner5f589dc2008-11-28 22:04:47 +00001048 // Walk through the Non-local dependencies, removing this one as the value
1049 // for any cached queries.
Chris Lattnerf68f3102008-11-30 02:28:25 +00001050 NonLocalDepMapType::iterator NLDI = NonLocalDeps.find(RemInst);
1051 if (NLDI != NonLocalDeps.end()) {
Chris Lattnerbf145d62008-12-01 01:15:42 +00001052 NonLocalDepInfo &BlockMap = NLDI->second.first;
Chris Lattner25f4b2b2008-11-30 02:30:50 +00001053 for (NonLocalDepInfo::iterator DI = BlockMap.begin(), DE = BlockMap.end();
1054 DI != DE; ++DI)
Chris Lattnere18b9712009-12-09 07:08:01 +00001055 if (Instruction *Inst = DI->getResult().getInst())
Chris Lattnerd44745d2008-12-07 18:39:13 +00001056 RemoveFromReverseMap(ReverseNonLocalDeps, Inst, RemInst);
Chris Lattnerf68f3102008-11-30 02:28:25 +00001057 NonLocalDeps.erase(NLDI);
1058 }
Owen Anderson5fc4aba2007-12-08 01:37:09 +00001059
Chris Lattner5f589dc2008-11-28 22:04:47 +00001060 // If we have a cached local dependence query for this instruction, remove it.
Chris Lattnerbaad8882008-11-28 22:28:27 +00001061 //
Chris Lattner39f372e2008-11-29 01:43:36 +00001062 LocalDepMapType::iterator LocalDepEntry = LocalDeps.find(RemInst);
1063 if (LocalDepEntry != LocalDeps.end()) {
Chris Lattner125ce362008-11-30 01:09:30 +00001064 // Remove us from DepInst's reverse set now that the local dep info is gone.
Chris Lattnerd44745d2008-12-07 18:39:13 +00001065 if (Instruction *Inst = LocalDepEntry->second.getInst())
1066 RemoveFromReverseMap(ReverseLocalDeps, Inst, RemInst);
Chris Lattner125ce362008-11-30 01:09:30 +00001067
Chris Lattnerbaad8882008-11-28 22:28:27 +00001068 // Remove this local dependency info.
Chris Lattner39f372e2008-11-29 01:43:36 +00001069 LocalDeps.erase(LocalDepEntry);
Chris Lattner6290f5c2008-12-07 08:50:20 +00001070 }
1071
1072 // If we have any cached pointer dependencies on this instruction, remove
1073 // them. If the instruction has non-pointer type, then it can't be a pointer
1074 // base.
1075
1076 // Remove it from both the load info and the store info. The instruction
1077 // can't be in either of these maps if it is non-pointer.
Duncan Sands1df98592010-02-16 11:11:14 +00001078 if (RemInst->getType()->isPointerTy()) {
Chris Lattner6290f5c2008-12-07 08:50:20 +00001079 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, false));
1080 RemoveCachedNonLocalPointerDependencies(ValueIsLoadPair(RemInst, true));
1081 }
Chris Lattnerbaad8882008-11-28 22:28:27 +00001082
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001083 // Loop over all of the things that depend on the instruction we're removing.
1084 //
Chris Lattner4f8c18c2008-11-29 23:30:39 +00001085 SmallVector<std::pair<Instruction*, Instruction*>, 8> ReverseDepsToAdd;
Chris Lattner0655f732008-12-07 18:42:51 +00001086
1087 // If we find RemInst as a clobber or Def in any of the maps for other values,
1088 // we need to replace its entry with a dirty version of the instruction after
1089 // it. If RemInst is a terminator, we use a null dirty value.
1090 //
1091 // Using a dirty version of the instruction after RemInst saves having to scan
1092 // the entire block to get to this point.
1093 MemDepResult NewDirtyVal;
1094 if (!RemInst->isTerminator())
1095 NewDirtyVal = MemDepResult::getDirty(++BasicBlock::iterator(RemInst));
Chris Lattner4f8c18c2008-11-29 23:30:39 +00001096
Chris Lattner8c465272008-11-29 09:20:15 +00001097 ReverseDepMapType::iterator ReverseDepIt = ReverseLocalDeps.find(RemInst);
1098 if (ReverseDepIt != ReverseLocalDeps.end()) {
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001099 SmallPtrSet<Instruction*, 4> &ReverseDeps = ReverseDepIt->second;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001100 // RemInst can't be the terminator if it has local stuff depending on it.
Chris Lattner125ce362008-11-30 01:09:30 +00001101 assert(!ReverseDeps.empty() && !isa<TerminatorInst>(RemInst) &&
1102 "Nothing can locally depend on a terminator");
1103
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001104 for (SmallPtrSet<Instruction*, 4>::iterator I = ReverseDeps.begin(),
1105 E = ReverseDeps.end(); I != E; ++I) {
1106 Instruction *InstDependingOnRemInst = *I;
Chris Lattnerf68f3102008-11-30 02:28:25 +00001107 assert(InstDependingOnRemInst != RemInst &&
1108 "Already removed our local dep info");
Chris Lattner125ce362008-11-30 01:09:30 +00001109
Chris Lattner0655f732008-12-07 18:42:51 +00001110 LocalDeps[InstDependingOnRemInst] = NewDirtyVal;
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001111
Chris Lattner125ce362008-11-30 01:09:30 +00001112 // Make sure to remember that new things depend on NewDepInst.
Chris Lattner0655f732008-12-07 18:42:51 +00001113 assert(NewDirtyVal.getInst() && "There is no way something else can have "
1114 "a local dep on this if it is a terminator!");
1115 ReverseDepsToAdd.push_back(std::make_pair(NewDirtyVal.getInst(),
Chris Lattner125ce362008-11-30 01:09:30 +00001116 InstDependingOnRemInst));
Chris Lattnerd3d12ec2008-11-28 22:51:08 +00001117 }
Chris Lattner4f8c18c2008-11-29 23:30:39 +00001118
1119 ReverseLocalDeps.erase(ReverseDepIt);
1120
1121 // Add new reverse deps after scanning the set, to avoid invalidating the
1122 // 'ReverseDeps' reference.
1123 while (!ReverseDepsToAdd.empty()) {
1124 ReverseLocalDeps[ReverseDepsToAdd.back().first]
1125 .insert(ReverseDepsToAdd.back().second);
1126 ReverseDepsToAdd.pop_back();
1127 }
Owen Anderson78e02f72007-07-06 23:14:35 +00001128 }
Owen Anderson4d13de42007-08-16 21:27:05 +00001129
Chris Lattner8c465272008-11-29 09:20:15 +00001130 ReverseDepIt = ReverseNonLocalDeps.find(RemInst);
1131 if (ReverseDepIt != ReverseNonLocalDeps.end()) {
Chris Lattner6290f5c2008-12-07 08:50:20 +00001132 SmallPtrSet<Instruction*, 4> &Set = ReverseDepIt->second;
1133 for (SmallPtrSet<Instruction*, 4>::iterator I = Set.begin(), E = Set.end();
Chris Lattnerf68f3102008-11-30 02:28:25 +00001134 I != E; ++I) {
1135 assert(*I != RemInst && "Already removed NonLocalDep info for RemInst");
1136
Chris Lattner4a69bad2008-11-30 02:52:26 +00001137 PerInstNLInfo &INLD = NonLocalDeps[*I];
Chris Lattner4a69bad2008-11-30 02:52:26 +00001138 // The information is now dirty!
Chris Lattnerbf145d62008-12-01 01:15:42 +00001139 INLD.second = true;
Chris Lattnerf68f3102008-11-30 02:28:25 +00001140
Chris Lattnerbf145d62008-12-01 01:15:42 +00001141 for (NonLocalDepInfo::iterator DI = INLD.first.begin(),
1142 DE = INLD.first.end(); DI != DE; ++DI) {
Chris Lattnere18b9712009-12-09 07:08:01 +00001143 if (DI->getResult().getInst() != RemInst) continue;
Chris Lattnerf68f3102008-11-30 02:28:25 +00001144
1145 // Convert to a dirty entry for the subsequent instruction.
Chris Lattner0ee443d2009-12-22 04:25:02 +00001146 DI->setResult(NewDirtyVal);
Chris Lattner0655f732008-12-07 18:42:51 +00001147
1148 if (Instruction *NextI = NewDirtyVal.getInst())
Chris Lattnerf68f3102008-11-30 02:28:25 +00001149 ReverseDepsToAdd.push_back(std::make_pair(NextI, *I));
Chris Lattnerf68f3102008-11-30 02:28:25 +00001150 }
1151 }
Chris Lattner4f8c18c2008-11-29 23:30:39 +00001152
1153 ReverseNonLocalDeps.erase(ReverseDepIt);
1154
Chris Lattner0ec48dd2008-11-29 22:02:15 +00001155 // Add new reverse deps after scanning the set, to avoid invalidating 'Set'
1156 while (!ReverseDepsToAdd.empty()) {
1157 ReverseNonLocalDeps[ReverseDepsToAdd.back().first]
1158 .insert(ReverseDepsToAdd.back().second);
1159 ReverseDepsToAdd.pop_back();
1160 }
Owen Anderson4d13de42007-08-16 21:27:05 +00001161 }
Owen Anderson5fc4aba2007-12-08 01:37:09 +00001162
Chris Lattner6290f5c2008-12-07 08:50:20 +00001163 // If the instruction is in ReverseNonLocalPtrDeps then it appears as a
1164 // value in the NonLocalPointerDeps info.
1165 ReverseNonLocalPtrDepTy::iterator ReversePtrDepIt =
1166 ReverseNonLocalPtrDeps.find(RemInst);
1167 if (ReversePtrDepIt != ReverseNonLocalPtrDeps.end()) {
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001168 SmallPtrSet<ValueIsLoadPair, 4> &Set = ReversePtrDepIt->second;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001169 SmallVector<std::pair<Instruction*, ValueIsLoadPair>,8> ReversePtrDepsToAdd;
1170
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001171 for (SmallPtrSet<ValueIsLoadPair, 4>::iterator I = Set.begin(),
1172 E = Set.end(); I != E; ++I) {
1173 ValueIsLoadPair P = *I;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001174 assert(P.getPointer() != RemInst &&
1175 "Already removed NonLocalPointerDeps info for RemInst");
1176
Dan Gohmanc1ac0d72010-09-22 21:41:02 +00001177 NonLocalDepInfo &NLPDI = NonLocalPointerDeps[P].NonLocalDeps;
Chris Lattner11dcd8d2008-12-08 07:31:50 +00001178
1179 // The cache is not valid for any specific block anymore.
Dan Gohmanc1ac0d72010-09-22 21:41:02 +00001180 NonLocalPointerDeps[P].Pair = BBSkipFirstBlockPair();
1181 NonLocalPointerDeps[P].TBAATag = 0;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001182
Chris Lattner6290f5c2008-12-07 08:50:20 +00001183 // Update any entries for RemInst to use the instruction after it.
1184 for (NonLocalDepInfo::iterator DI = NLPDI.begin(), DE = NLPDI.end();
1185 DI != DE; ++DI) {
Chris Lattnere18b9712009-12-09 07:08:01 +00001186 if (DI->getResult().getInst() != RemInst) continue;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001187
1188 // Convert to a dirty entry for the subsequent instruction.
Chris Lattner0ee443d2009-12-22 04:25:02 +00001189 DI->setResult(NewDirtyVal);
Chris Lattner6290f5c2008-12-07 08:50:20 +00001190
1191 if (Instruction *NewDirtyInst = NewDirtyVal.getInst())
1192 ReversePtrDepsToAdd.push_back(std::make_pair(NewDirtyInst, P));
1193 }
Chris Lattner95900f22009-01-23 07:12:16 +00001194
1195 // Re-sort the NonLocalDepInfo. Changing the dirty entry to its
1196 // subsequent value may invalidate the sortedness.
1197 std::sort(NLPDI.begin(), NLPDI.end());
Chris Lattner6290f5c2008-12-07 08:50:20 +00001198 }
1199
1200 ReverseNonLocalPtrDeps.erase(ReversePtrDepIt);
1201
1202 while (!ReversePtrDepsToAdd.empty()) {
1203 ReverseNonLocalPtrDeps[ReversePtrDepsToAdd.back().first]
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001204 .insert(ReversePtrDepsToAdd.back().second);
Chris Lattner6290f5c2008-12-07 08:50:20 +00001205 ReversePtrDepsToAdd.pop_back();
1206 }
1207 }
1208
1209
Chris Lattnerf68f3102008-11-30 02:28:25 +00001210 assert(!NonLocalDeps.count(RemInst) && "RemInst got reinserted?");
Chris Lattnerd777d402008-11-30 19:24:31 +00001211 AA->deleteValue(RemInst);
Chris Lattner5f589dc2008-11-28 22:04:47 +00001212 DEBUG(verifyRemoved(RemInst));
Owen Anderson78e02f72007-07-06 23:14:35 +00001213}
Chris Lattner729b2372008-11-29 21:25:10 +00001214/// verifyRemoved - Verify that the specified instruction does not occur
1215/// in our internal data structures.
1216void MemoryDependenceAnalysis::verifyRemoved(Instruction *D) const {
1217 for (LocalDepMapType::const_iterator I = LocalDeps.begin(),
1218 E = LocalDeps.end(); I != E; ++I) {
1219 assert(I->first != D && "Inst occurs in data structures");
Chris Lattnerfd3dcbe2008-11-30 23:17:19 +00001220 assert(I->second.getInst() != D &&
Chris Lattner729b2372008-11-29 21:25:10 +00001221 "Inst occurs in data structures");
1222 }
1223
Chris Lattner6290f5c2008-12-07 08:50:20 +00001224 for (CachedNonLocalPointerInfo::const_iterator I =NonLocalPointerDeps.begin(),
1225 E = NonLocalPointerDeps.end(); I != E; ++I) {
1226 assert(I->first.getPointer() != D && "Inst occurs in NLPD map key");
Dan Gohmanc1ac0d72010-09-22 21:41:02 +00001227 const NonLocalDepInfo &Val = I->second.NonLocalDeps;
Chris Lattner6290f5c2008-12-07 08:50:20 +00001228 for (NonLocalDepInfo::const_iterator II = Val.begin(), E = Val.end();
1229 II != E; ++II)
Chris Lattnere18b9712009-12-09 07:08:01 +00001230 assert(II->getResult().getInst() != D && "Inst occurs as NLPD value");
Chris Lattner6290f5c2008-12-07 08:50:20 +00001231 }
1232
Chris Lattner729b2372008-11-29 21:25:10 +00001233 for (NonLocalDepMapType::const_iterator I = NonLocalDeps.begin(),
1234 E = NonLocalDeps.end(); I != E; ++I) {
1235 assert(I->first != D && "Inst occurs in data structures");
Chris Lattner4a69bad2008-11-30 02:52:26 +00001236 const PerInstNLInfo &INLD = I->second;
Chris Lattnerbf145d62008-12-01 01:15:42 +00001237 for (NonLocalDepInfo::const_iterator II = INLD.first.begin(),
1238 EE = INLD.first.end(); II != EE; ++II)
Chris Lattnere18b9712009-12-09 07:08:01 +00001239 assert(II->getResult().getInst() != D && "Inst occurs in data structures");
Chris Lattner729b2372008-11-29 21:25:10 +00001240 }
1241
1242 for (ReverseDepMapType::const_iterator I = ReverseLocalDeps.begin(),
Chris Lattnerf68f3102008-11-30 02:28:25 +00001243 E = ReverseLocalDeps.end(); I != E; ++I) {
1244 assert(I->first != D && "Inst occurs in data structures");
Chris Lattner729b2372008-11-29 21:25:10 +00001245 for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1246 EE = I->second.end(); II != EE; ++II)
1247 assert(*II != D && "Inst occurs in data structures");
Chris Lattnerf68f3102008-11-30 02:28:25 +00001248 }
Chris Lattner729b2372008-11-29 21:25:10 +00001249
1250 for (ReverseDepMapType::const_iterator I = ReverseNonLocalDeps.begin(),
1251 E = ReverseNonLocalDeps.end();
Chris Lattnerf68f3102008-11-30 02:28:25 +00001252 I != E; ++I) {
1253 assert(I->first != D && "Inst occurs in data structures");
Chris Lattner729b2372008-11-29 21:25:10 +00001254 for (SmallPtrSet<Instruction*, 4>::const_iterator II = I->second.begin(),
1255 EE = I->second.end(); II != EE; ++II)
1256 assert(*II != D && "Inst occurs in data structures");
Chris Lattnerf68f3102008-11-30 02:28:25 +00001257 }
Chris Lattner6290f5c2008-12-07 08:50:20 +00001258
1259 for (ReverseNonLocalPtrDepTy::const_iterator
1260 I = ReverseNonLocalPtrDeps.begin(),
1261 E = ReverseNonLocalPtrDeps.end(); I != E; ++I) {
1262 assert(I->first != D && "Inst occurs in rev NLPD map");
1263
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001264 for (SmallPtrSet<ValueIsLoadPair, 4>::const_iterator II = I->second.begin(),
Chris Lattner6290f5c2008-12-07 08:50:20 +00001265 E = I->second.end(); II != E; ++II)
Chris Lattner6a0dcc12009-03-29 00:24:04 +00001266 assert(*II != ValueIsLoadPair(D, false) &&
1267 *II != ValueIsLoadPair(D, true) &&
Chris Lattner6290f5c2008-12-07 08:50:20 +00001268 "Inst occurs in ReverseNonLocalPtrDeps map");
1269 }
1270
Chris Lattner729b2372008-11-29 21:25:10 +00001271}