blob: 59839e8c8bbca4ca1d7bad5c4ebb9649156c7fe4 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===- BasicAliasAnalysis.cpp - Local Alias Analysis Impl -----------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file defines the default implementation of the Alias Analysis interface
11// that simply implements a few identities (two different globals cannot alias,
12// etc), but otherwise does no analysis.
13//
14//===----------------------------------------------------------------------===//
15
16#include "llvm/Analysis/AliasAnalysis.h"
Duncan Sandsb233fb52009-01-18 12:19:30 +000017#include "llvm/Analysis/CaptureTracking.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000018#include "llvm/Analysis/Passes.h"
19#include "llvm/Constants.h"
20#include "llvm/DerivedTypes.h"
21#include "llvm/Function.h"
22#include "llvm/GlobalVariable.h"
23#include "llvm/Instructions.h"
Owen Anderson37f3ffb2008-02-17 21:29:08 +000024#include "llvm/IntrinsicInst.h"
Owen Andersond4d90a02009-07-06 18:42:36 +000025#include "llvm/LLVMContext.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000026#include "llvm/Pass.h"
27#include "llvm/Target/TargetData.h"
28#include "llvm/ADT/SmallVector.h"
Owen Anderson1636de92007-09-07 04:06:50 +000029#include "llvm/ADT/STLExtras.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000030#include "llvm/Support/Compiler.h"
Edwin Török675d5622009-07-11 20:10:48 +000031#include "llvm/Support/ErrorHandling.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000032#include "llvm/Support/GetElementPtrTypeIterator.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000033#include <algorithm>
34using namespace llvm;
35
Chris Lattner21c4fd12008-06-16 06:30:22 +000036//===----------------------------------------------------------------------===//
37// Useful predicates
38//===----------------------------------------------------------------------===//
Dan Gohmanf17a25c2007-07-18 16:29:46 +000039
Dan Gohmanf17a25c2007-07-18 16:29:46 +000040static const User *isGEP(const Value *V) {
41 if (isa<GetElementPtrInst>(V) ||
42 (isa<ConstantExpr>(V) &&
43 cast<ConstantExpr>(V)->getOpcode() == Instruction::GetElementPtr))
44 return cast<User>(V);
45 return 0;
46}
47
48static const Value *GetGEPOperands(const Value *V,
Chris Lattner2d34c6c2008-12-10 01:04:47 +000049 SmallVector<Value*, 16> &GEPOps) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +000050 assert(GEPOps.empty() && "Expect empty list to populate!");
51 GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
52 cast<User>(V)->op_end());
53
54 // Accumulate all of the chained indexes into the operand array
55 V = cast<User>(V)->getOperand(0);
56
57 while (const User *G = isGEP(V)) {
58 if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
59 !cast<Constant>(GEPOps[0])->isNullValue())
60 break; // Don't handle folding arbitrary pointer offsets yet...
61 GEPOps.erase(GEPOps.begin()); // Drop the zero index
62 GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
63 V = G->getOperand(0);
64 }
65 return V;
66}
67
Chris Lattnerfc2026e2008-06-16 06:10:11 +000068/// isKnownNonNull - Return true if we know that the specified value is never
69/// null.
70static bool isKnownNonNull(const Value *V) {
71 // Alloca never returns null, malloc might.
72 if (isa<AllocaInst>(V)) return true;
73
74 // A byval argument is never null.
75 if (const Argument *A = dyn_cast<Argument>(V))
76 return A->hasByValAttr();
77
78 // Global values are not null unless extern weak.
79 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
80 return !GV->hasExternalWeakLinkage();
81 return false;
82}
83
Chris Lattnerd26e5d82008-06-16 06:19:11 +000084/// isNonEscapingLocalObject - Return true if the pointer is to a function-local
85/// object that never escapes from the function.
86static bool isNonEscapingLocalObject(const Value *V) {
Chris Lattner7ce67392008-06-16 06:28:01 +000087 // If this is a local allocation, check to see if it escapes.
Nick Lewyckyff384472008-11-24 03:41:24 +000088 if (isa<AllocationInst>(V) || isNoAliasCall(V))
Duncan Sandsb233fb52009-01-18 12:19:30 +000089 return !PointerMayBeCaptured(V, false);
Duncan Sands75378432009-01-05 21:19:53 +000090
Chris Lattner7ce67392008-06-16 06:28:01 +000091 // If this is an argument that corresponds to a byval or noalias argument,
Duncan Sands75378432009-01-05 21:19:53 +000092 // then it has not escaped before entering the function. Check if it escapes
93 // inside the function.
Chris Lattner7ce67392008-06-16 06:28:01 +000094 if (const Argument *A = dyn_cast<Argument>(V))
Duncan Sands75378432009-01-05 21:19:53 +000095 if (A->hasByValAttr() || A->hasNoAliasAttr()) {
96 // Don't bother analyzing arguments already known not to escape.
97 if (A->hasNoCaptureAttr())
98 return true;
Duncan Sandsb233fb52009-01-18 12:19:30 +000099 return !PointerMayBeCaptured(V, false);
Duncan Sands75378432009-01-05 21:19:53 +0000100 }
Chris Lattnerd26e5d82008-06-16 06:19:11 +0000101 return false;
102}
103
104
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000105/// isObjectSmallerThan - Return true if we can prove that the object specified
106/// by V is smaller than Size.
107static bool isObjectSmallerThan(const Value *V, unsigned Size,
108 const TargetData &TD) {
Chris Lattner194ae9d2008-12-08 06:28:54 +0000109 const Type *AccessTy;
110 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000111 AccessTy = GV->getType()->getElementType();
Chris Lattner194ae9d2008-12-08 06:28:54 +0000112 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(V)) {
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000113 if (!AI->isArrayAllocation())
114 AccessTy = AI->getType()->getElementType();
Chris Lattner194ae9d2008-12-08 06:28:54 +0000115 else
116 return false;
117 } else if (const Argument *A = dyn_cast<Argument>(V)) {
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000118 if (A->hasByValAttr())
119 AccessTy = cast<PointerType>(A->getType())->getElementType();
Chris Lattner194ae9d2008-12-08 06:28:54 +0000120 else
121 return false;
122 } else {
123 return false;
124 }
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000125
Chris Lattner194ae9d2008-12-08 06:28:54 +0000126 if (AccessTy->isSized())
Duncan Sandsec4f97d2009-05-09 07:06:46 +0000127 return TD.getTypeAllocSize(AccessTy) < Size;
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000128 return false;
129}
130
Chris Lattner21c4fd12008-06-16 06:30:22 +0000131//===----------------------------------------------------------------------===//
132// NoAA Pass
133//===----------------------------------------------------------------------===//
134
135namespace {
136 /// NoAA - This class implements the -no-aa pass, which always returns "I
137 /// don't know" for alias queries. NoAA is unlike other alias analysis
138 /// implementations, in that it does not chain to a previous analysis. As
139 /// such it doesn't follow many of the rules that other alias analyses must.
140 ///
141 struct VISIBILITY_HIDDEN NoAA : public ImmutablePass, public AliasAnalysis {
142 static char ID; // Class identification, replacement for typeinfo
Dan Gohman26f8c272008-09-04 17:05:41 +0000143 NoAA() : ImmutablePass(&ID) {}
144 explicit NoAA(void *PID) : ImmutablePass(PID) { }
Chris Lattner21c4fd12008-06-16 06:30:22 +0000145
146 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
147 AU.addRequired<TargetData>();
148 }
149
150 virtual void initializePass() {
151 TD = &getAnalysis<TargetData>();
152 }
153
154 virtual AliasResult alias(const Value *V1, unsigned V1Size,
155 const Value *V2, unsigned V2Size) {
156 return MayAlias;
157 }
158
Chris Lattner21c4fd12008-06-16 06:30:22 +0000159 virtual void getArgumentAccesses(Function *F, CallSite CS,
160 std::vector<PointerAccessInfo> &Info) {
Edwin Törökbd448e32009-07-14 16:55:14 +0000161 llvm_unreachable("This method may not be called on this function!");
Chris Lattner21c4fd12008-06-16 06:30:22 +0000162 }
163
164 virtual void getMustAliases(Value *P, std::vector<Value*> &RetVals) { }
165 virtual bool pointsToConstantMemory(const Value *P) { return false; }
166 virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
167 return ModRef;
168 }
169 virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
170 return ModRef;
171 }
172 virtual bool hasNoModRefInfoForCalls() const { return true; }
173
174 virtual void deleteValue(Value *V) {}
175 virtual void copyValue(Value *From, Value *To) {}
176 };
177} // End of anonymous namespace
178
179// Register this pass...
180char NoAA::ID = 0;
181static RegisterPass<NoAA>
182U("no-aa", "No Alias Analysis (always returns 'may' alias)", true, true);
183
184// Declare that we implement the AliasAnalysis interface
185static RegisterAnalysisGroup<AliasAnalysis> V(U);
186
187ImmutablePass *llvm::createNoAAPass() { return new NoAA(); }
188
189//===----------------------------------------------------------------------===//
190// BasicAA Pass
191//===----------------------------------------------------------------------===//
192
193namespace {
194 /// BasicAliasAnalysis - This is the default alias analysis implementation.
195 /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
196 /// derives from the NoAA class.
197 struct VISIBILITY_HIDDEN BasicAliasAnalysis : public NoAA {
198 static char ID; // Class identification, replacement for typeinfo
Dan Gohman26f8c272008-09-04 17:05:41 +0000199 BasicAliasAnalysis() : NoAA(&ID) {}
Chris Lattner21c4fd12008-06-16 06:30:22 +0000200 AliasResult alias(const Value *V1, unsigned V1Size,
201 const Value *V2, unsigned V2Size);
202
203 ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
Chris Lattner7e0f4462008-12-09 21:19:42 +0000204 ModRefResult getModRefInfo(CallSite CS1, CallSite CS2);
Owen Andersonab465642009-02-05 23:36:27 +0000205
Chris Lattner21c4fd12008-06-16 06:30:22 +0000206 /// hasNoModRefInfoForCalls - We can provide mod/ref information against
207 /// non-escaping allocations.
208 virtual bool hasNoModRefInfoForCalls() const { return false; }
209
210 /// pointsToConstantMemory - Chase pointers until we find a (constant
211 /// global) or not.
212 bool pointsToConstantMemory(const Value *P);
213
214 private:
215 // CheckGEPInstructions - Check two GEP instructions with known
216 // must-aliasing base pointers. This checks to see if the index expressions
217 // preclude the pointers from aliasing...
218 AliasResult
219 CheckGEPInstructions(const Type* BasePtr1Ty,
220 Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1Size,
221 const Type *BasePtr2Ty,
222 Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2Size);
223 };
224} // End of anonymous namespace
225
226// Register this pass...
227char BasicAliasAnalysis::ID = 0;
228static RegisterPass<BasicAliasAnalysis>
229X("basicaa", "Basic Alias Analysis (default AA impl)", false, true);
230
231// Declare that we implement the AliasAnalysis interface
232static RegisterAnalysisGroup<AliasAnalysis, true> Y(X);
233
234ImmutablePass *llvm::createBasicAliasAnalysisPass() {
235 return new BasicAliasAnalysis();
236}
237
238
239/// pointsToConstantMemory - Chase pointers until we find a (constant
240/// global) or not.
241bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
242 if (const GlobalVariable *GV =
Duncan Sands52fb8732008-10-01 15:25:41 +0000243 dyn_cast<GlobalVariable>(P->getUnderlyingObject()))
Chris Lattner21c4fd12008-06-16 06:30:22 +0000244 return GV->isConstant();
245 return false;
246}
247
Owen Andersonab465642009-02-05 23:36:27 +0000248
Chris Lattner21c4fd12008-06-16 06:30:22 +0000249// getModRefInfo - Check to see if the specified callsite can clobber the
250// specified memory object. Since we only look at local properties of this
251// function, we really can't say much about this query. We do, however, use
252// simple "address taken" analysis on local objects.
253//
254AliasAnalysis::ModRefResult
255BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
256 if (!isa<Constant>(P)) {
Duncan Sands52fb8732008-10-01 15:25:41 +0000257 const Value *Object = P->getUnderlyingObject();
Chris Lattner21c4fd12008-06-16 06:30:22 +0000258
259 // If this is a tail call and P points to a stack location, we know that
260 // the tail call cannot access or modify the local stack.
261 // We cannot exclude byval arguments here; these belong to the caller of
262 // the current function not to the current function, and a tail callee
263 // may reference them.
264 if (isa<AllocaInst>(Object))
265 if (CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
266 if (CI->isTailCall())
267 return NoModRef;
268
Chris Lattnerb46b9752008-06-16 06:38:26 +0000269 // If the pointer is to a locally allocated object that does not escape,
270 // then the call can not mod/ref the pointer unless the call takes the
271 // argument without capturing it.
Nick Lewyckydf872b82009-02-13 07:06:27 +0000272 if (isNonEscapingLocalObject(Object) && CS.getInstruction() != Object) {
Chris Lattnerb46b9752008-06-16 06:38:26 +0000273 bool passedAsArg = false;
274 // TODO: Eventually only check 'nocapture' arguments.
275 for (CallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
276 CI != CE; ++CI)
277 if (isa<PointerType>((*CI)->getType()) &&
278 alias(cast<Value>(CI), ~0U, P, ~0U) != NoAlias)
279 passedAsArg = true;
280
281 if (!passedAsArg)
282 return NoModRef;
Chris Lattner21c4fd12008-06-16 06:30:22 +0000283 }
284 }
285
286 // The AliasAnalysis base class has some smarts, lets use them.
287 return AliasAnalysis::getModRefInfo(CS, P, Size);
288}
289
290
Chris Lattner7e0f4462008-12-09 21:19:42 +0000291AliasAnalysis::ModRefResult
292BasicAliasAnalysis::getModRefInfo(CallSite CS1, CallSite CS2) {
293 // If CS1 or CS2 are readnone, they don't interact.
294 ModRefBehavior CS1B = AliasAnalysis::getModRefBehavior(CS1);
295 if (CS1B == DoesNotAccessMemory) return NoModRef;
296
297 ModRefBehavior CS2B = AliasAnalysis::getModRefBehavior(CS2);
298 if (CS2B == DoesNotAccessMemory) return NoModRef;
299
300 // If they both only read from memory, just return ref.
301 if (CS1B == OnlyReadsMemory && CS2B == OnlyReadsMemory)
302 return Ref;
303
304 // Otherwise, fall back to NoAA (mod+ref).
305 return NoAA::getModRefInfo(CS1, CS2);
306}
307
308
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000309// alias - Provide a bunch of ad-hoc rules to disambiguate in common cases, such
Chris Lattner2d34c6c2008-12-10 01:04:47 +0000310// as array references.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000311//
312AliasAnalysis::AliasResult
313BasicAliasAnalysis::alias(const Value *V1, unsigned V1Size,
314 const Value *V2, unsigned V2Size) {
315 // Strip off any constant expression casts if they exist
316 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V1))
317 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
318 V1 = CE->getOperand(0);
319 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V2))
320 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
321 V2 = CE->getOperand(0);
322
323 // Are we checking for alias of the same value?
324 if (V1 == V2) return MustAlias;
325
Nick Lewyckyff384472008-11-24 03:41:24 +0000326 if (!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType()))
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000327 return NoAlias; // Scalars cannot alias each other
328
Chris Lattner2d34c6c2008-12-10 01:04:47 +0000329 // Strip off cast instructions. Since V1 and V2 are pointers, they must be
330 // pointer<->pointer bitcasts.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000331 if (const BitCastInst *I = dyn_cast<BitCastInst>(V1))
332 return alias(I->getOperand(0), V1Size, V2, V2Size);
333 if (const BitCastInst *I = dyn_cast<BitCastInst>(V2))
334 return alias(V1, V1Size, I->getOperand(0), V2Size);
335
Chris Lattner2d34c6c2008-12-10 01:04:47 +0000336 // Figure out what objects these things are pointing to if we can.
Duncan Sands52fb8732008-10-01 15:25:41 +0000337 const Value *O1 = V1->getUnderlyingObject();
338 const Value *O2 = V2->getUnderlyingObject();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000339
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000340 if (O1 != O2) {
341 // If V1/V2 point to two different objects we know that we have no alias.
342 if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
343 return NoAlias;
344
Nick Lewyckya604a942008-11-24 05:00:44 +0000345 // Arguments can't alias with local allocations or noalias calls.
346 if ((isa<Argument>(O1) && (isa<AllocationInst>(O2) || isNoAliasCall(O2))) ||
347 (isa<Argument>(O2) && (isa<AllocationInst>(O1) || isNoAliasCall(O1))))
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000348 return NoAlias;
Nick Lewyckyff384472008-11-24 03:41:24 +0000349
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000350 // Most objects can't alias null.
351 if ((isa<ConstantPointerNull>(V2) && isKnownNonNull(O1)) ||
352 (isa<ConstantPointerNull>(V1) && isKnownNonNull(O2)))
353 return NoAlias;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000354 }
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000355
356 // If the size of one access is larger than the entire object on the other
357 // side, then we know such behavior is undefined and can assume no alias.
358 const TargetData &TD = getTargetData();
359 if ((V1Size != ~0U && isObjectSmallerThan(O2, V1Size, TD)) ||
360 (V2Size != ~0U && isObjectSmallerThan(O1, V2Size, TD)))
361 return NoAlias;
362
Chris Lattnerd26e5d82008-06-16 06:19:11 +0000363 // If one pointer is the result of a call/invoke and the other is a
364 // non-escaping local object, then we know the object couldn't escape to a
365 // point where the call could return it.
366 if ((isa<CallInst>(O1) || isa<InvokeInst>(O1)) &&
Nick Lewyckydf872b82009-02-13 07:06:27 +0000367 isNonEscapingLocalObject(O2) && O1 != O2)
Chris Lattnerd26e5d82008-06-16 06:19:11 +0000368 return NoAlias;
369 if ((isa<CallInst>(O2) || isa<InvokeInst>(O2)) &&
Nick Lewyckydf872b82009-02-13 07:06:27 +0000370 isNonEscapingLocalObject(O1) && O1 != O2)
Chris Lattnerd26e5d82008-06-16 06:19:11 +0000371 return NoAlias;
Chris Lattnerfc2026e2008-06-16 06:10:11 +0000372
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000373 // If we have two gep instructions with must-alias'ing base pointers, figure
374 // out if the indexes to the GEP tell us anything about the derived pointer.
375 // Note that we also handle chains of getelementptr instructions as well as
376 // constant expression getelementptrs here.
377 //
378 if (isGEP(V1) && isGEP(V2)) {
Chris Lattner2d34c6c2008-12-10 01:04:47 +0000379 const User *GEP1 = cast<User>(V1);
380 const User *GEP2 = cast<User>(V2);
381
382 // If V1 and V2 are identical GEPs, just recurse down on both of them.
383 // This allows us to analyze things like:
384 // P = gep A, 0, i, 1
385 // Q = gep B, 0, i, 1
386 // by just analyzing A and B. This is even safe for variable indices.
387 if (GEP1->getType() == GEP2->getType() &&
388 GEP1->getNumOperands() == GEP2->getNumOperands() &&
389 GEP1->getOperand(0)->getType() == GEP2->getOperand(0)->getType() &&
390 // All operands are the same, ignoring the base.
391 std::equal(GEP1->op_begin()+1, GEP1->op_end(), GEP2->op_begin()+1))
392 return alias(GEP1->getOperand(0), V1Size, GEP2->getOperand(0), V2Size);
393
394
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000395 // Drill down into the first non-gep value, to test for must-aliasing of
396 // the base pointers.
Chris Lattner2d34c6c2008-12-10 01:04:47 +0000397 while (isGEP(GEP1->getOperand(0)) &&
398 GEP1->getOperand(1) ==
Owen Andersond4d90a02009-07-06 18:42:36 +0000399 Context->getNullValue(GEP1->getOperand(1)->getType()))
Chris Lattner2d34c6c2008-12-10 01:04:47 +0000400 GEP1 = cast<User>(GEP1->getOperand(0));
401 const Value *BasePtr1 = GEP1->getOperand(0);
Wojciech Matyjewicz170707f2007-12-13 16:22:58 +0000402
Chris Lattner2d34c6c2008-12-10 01:04:47 +0000403 while (isGEP(GEP2->getOperand(0)) &&
404 GEP2->getOperand(1) ==
Owen Andersond4d90a02009-07-06 18:42:36 +0000405 Context->getNullValue(GEP2->getOperand(1)->getType()))
Chris Lattner2d34c6c2008-12-10 01:04:47 +0000406 GEP2 = cast<User>(GEP2->getOperand(0));
407 const Value *BasePtr2 = GEP2->getOperand(0);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000408
409 // Do the base pointers alias?
410 AliasResult BaseAlias = alias(BasePtr1, ~0U, BasePtr2, ~0U);
411 if (BaseAlias == NoAlias) return NoAlias;
412 if (BaseAlias == MustAlias) {
413 // If the base pointers alias each other exactly, check to see if we can
414 // figure out anything about the resultant pointers, to try to prove
415 // non-aliasing.
416
417 // Collect all of the chained GEP operands together into one simple place
418 SmallVector<Value*, 16> GEP1Ops, GEP2Ops;
419 BasePtr1 = GetGEPOperands(V1, GEP1Ops);
420 BasePtr2 = GetGEPOperands(V2, GEP2Ops);
421
422 // If GetGEPOperands were able to fold to the same must-aliased pointer,
423 // do the comparison.
424 if (BasePtr1 == BasePtr2) {
425 AliasResult GAlias =
426 CheckGEPInstructions(BasePtr1->getType(),
427 &GEP1Ops[0], GEP1Ops.size(), V1Size,
428 BasePtr2->getType(),
429 &GEP2Ops[0], GEP2Ops.size(), V2Size);
430 if (GAlias != MayAlias)
431 return GAlias;
432 }
433 }
434 }
435
436 // Check to see if these two pointers are related by a getelementptr
437 // instruction. If one pointer is a GEP with a non-zero index of the other
438 // pointer, we know they cannot alias.
439 //
440 if (isGEP(V2)) {
441 std::swap(V1, V2);
442 std::swap(V1Size, V2Size);
443 }
444
445 if (V1Size != ~0U && V2Size != ~0U)
446 if (isGEP(V1)) {
447 SmallVector<Value*, 16> GEPOperands;
448 const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
449
450 AliasResult R = alias(BasePtr, V1Size, V2, V2Size);
451 if (R == MustAlias) {
452 // If there is at least one non-zero constant index, we know they cannot
453 // alias.
454 bool ConstantFound = false;
455 bool AllZerosFound = true;
456 for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
457 if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
458 if (!C->isNullValue()) {
459 ConstantFound = true;
460 AllZerosFound = false;
461 break;
462 }
463 } else {
464 AllZerosFound = false;
465 }
466
467 // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
468 // the ptr, the end result is a must alias also.
469 if (AllZerosFound)
470 return MustAlias;
471
472 if (ConstantFound) {
473 if (V2Size <= 1 && V1Size <= 1) // Just pointer check?
474 return NoAlias;
475
476 // Otherwise we have to check to see that the distance is more than
477 // the size of the argument... build an index vector that is equal to
478 // the arguments provided, except substitute 0's for any variable
479 // indexes we find...
480 if (cast<PointerType>(
481 BasePtr->getType())->getElementType()->isSized()) {
482 for (unsigned i = 0; i != GEPOperands.size(); ++i)
483 if (!isa<ConstantInt>(GEPOperands[i]))
484 GEPOperands[i] =
Owen Andersond4d90a02009-07-06 18:42:36 +0000485 Context->getNullValue(GEPOperands[i]->getType());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000486 int64_t Offset =
487 getTargetData().getIndexedOffset(BasePtr->getType(),
488 &GEPOperands[0],
489 GEPOperands.size());
490
491 if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
492 return NoAlias;
493 }
494 }
495 }
496 }
497
498 return MayAlias;
499}
500
Duncan Sandsa52b7542008-12-08 14:01:59 +0000501// This function is used to determine if the indices of two GEP instructions are
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000502// equal. V1 and V2 are the indices.
Owen Anderson5349f052009-07-06 23:00:19 +0000503static bool IndexOperandsEqual(Value *V1, Value *V2, LLVMContext *Context) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000504 if (V1->getType() == V2->getType())
505 return V1 == V2;
506 if (Constant *C1 = dyn_cast<Constant>(V1))
507 if (Constant *C2 = dyn_cast<Constant>(V2)) {
508 // Sign extend the constants to long types, if necessary
509 if (C1->getType() != Type::Int64Ty)
Owen Andersond4d90a02009-07-06 18:42:36 +0000510 C1 = Context->getConstantExprSExt(C1, Type::Int64Ty);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000511 if (C2->getType() != Type::Int64Ty)
Owen Andersond4d90a02009-07-06 18:42:36 +0000512 C2 = Context->getConstantExprSExt(C2, Type::Int64Ty);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000513 return C1 == C2;
514 }
515 return false;
516}
517
518/// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
519/// base pointers. This checks to see if the index expressions preclude the
520/// pointers from aliasing...
521AliasAnalysis::AliasResult
522BasicAliasAnalysis::CheckGEPInstructions(
523 const Type* BasePtr1Ty, Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1S,
524 const Type *BasePtr2Ty, Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2S) {
525 // We currently can't handle the case when the base pointers have different
526 // primitive types. Since this is uncommon anyway, we are happy being
527 // extremely conservative.
528 if (BasePtr1Ty != BasePtr2Ty)
529 return MayAlias;
530
531 const PointerType *GEPPointerTy = cast<PointerType>(BasePtr1Ty);
532
533 // Find the (possibly empty) initial sequence of equal values... which are not
534 // necessarily constants.
535 unsigned NumGEP1Operands = NumGEP1Ops, NumGEP2Operands = NumGEP2Ops;
536 unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
537 unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
538 unsigned UnequalOper = 0;
539 while (UnequalOper != MinOperands &&
Owen Andersond4d90a02009-07-06 18:42:36 +0000540 IndexOperandsEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper],
541 Context)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000542 // Advance through the type as we go...
543 ++UnequalOper;
544 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
545 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
546 else {
547 // If all operands equal each other, then the derived pointers must
548 // alias each other...
549 BasePtr1Ty = 0;
550 assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
551 "Ran out of type nesting, but not out of operands?");
552 return MustAlias;
553 }
554 }
555
556 // If we have seen all constant operands, and run out of indexes on one of the
557 // getelementptrs, check to see if the tail of the leftover one is all zeros.
558 // If so, return mustalias.
559 if (UnequalOper == MinOperands) {
560 if (NumGEP1Ops < NumGEP2Ops) {
561 std::swap(GEP1Ops, GEP2Ops);
562 std::swap(NumGEP1Ops, NumGEP2Ops);
563 }
564
565 bool AllAreZeros = true;
566 for (unsigned i = UnequalOper; i != MaxOperands; ++i)
567 if (!isa<Constant>(GEP1Ops[i]) ||
568 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
569 AllAreZeros = false;
570 break;
571 }
572 if (AllAreZeros) return MustAlias;
573 }
574
575
576 // So now we know that the indexes derived from the base pointers,
577 // which are known to alias, are different. We can still determine a
578 // no-alias result if there are differing constant pairs in the index
579 // chain. For example:
580 // A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
581 //
582 // We have to be careful here about array accesses. In particular, consider:
583 // A[1][0] vs A[0][i]
584 // In this case, we don't *know* that the array will be accessed in bounds:
585 // the index could even be negative. Because of this, we have to
586 // conservatively *give up* and return may alias. We disregard differing
587 // array subscripts that are followed by a variable index without going
588 // through a struct.
589 //
590 unsigned SizeMax = std::max(G1S, G2S);
591 if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work.
592
593 // Scan for the first operand that is constant and unequal in the
594 // two getelementptrs...
595 unsigned FirstConstantOper = UnequalOper;
596 for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
597 const Value *G1Oper = GEP1Ops[FirstConstantOper];
598 const Value *G2Oper = GEP2Ops[FirstConstantOper];
599
600 if (G1Oper != G2Oper) // Found non-equal constant indexes...
601 if (Constant *G1OC = dyn_cast<ConstantInt>(const_cast<Value*>(G1Oper)))
602 if (Constant *G2OC = dyn_cast<ConstantInt>(const_cast<Value*>(G2Oper))){
603 if (G1OC->getType() != G2OC->getType()) {
604 // Sign extend both operands to long.
605 if (G1OC->getType() != Type::Int64Ty)
Owen Andersond4d90a02009-07-06 18:42:36 +0000606 G1OC = Context->getConstantExprSExt(G1OC, Type::Int64Ty);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000607 if (G2OC->getType() != Type::Int64Ty)
Owen Andersond4d90a02009-07-06 18:42:36 +0000608 G2OC = Context->getConstantExprSExt(G2OC, Type::Int64Ty);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000609 GEP1Ops[FirstConstantOper] = G1OC;
610 GEP2Ops[FirstConstantOper] = G2OC;
611 }
612
613 if (G1OC != G2OC) {
614 // Handle the "be careful" case above: if this is an array/vector
615 // subscript, scan for a subsequent variable array index.
Dan Gohmanb86a18b2009-05-27 01:48:27 +0000616 if (const SequentialType *STy =
617 dyn_cast<SequentialType>(BasePtr1Ty)) {
618 const Type *NextTy = STy;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000619 bool isBadCase = false;
620
Dan Gohmanb86a18b2009-05-27 01:48:27 +0000621 for (unsigned Idx = FirstConstantOper;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000622 Idx != MinOperands && isa<SequentialType>(NextTy); ++Idx) {
623 const Value *V1 = GEP1Ops[Idx], *V2 = GEP2Ops[Idx];
624 if (!isa<Constant>(V1) || !isa<Constant>(V2)) {
625 isBadCase = true;
626 break;
627 }
Dan Gohmanb86a18b2009-05-27 01:48:27 +0000628 // If the array is indexed beyond the bounds of the static type
629 // at this level, it will also fall into the "be careful" case.
630 // It would theoretically be possible to analyze these cases,
631 // but for now just be conservatively correct.
632 if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
633 if (cast<ConstantInt>(G1OC)->getZExtValue() >=
634 ATy->getNumElements() ||
635 cast<ConstantInt>(G2OC)->getZExtValue() >=
636 ATy->getNumElements()) {
637 isBadCase = true;
638 break;
639 }
640 if (const VectorType *VTy = dyn_cast<VectorType>(STy))
641 if (cast<ConstantInt>(G1OC)->getZExtValue() >=
642 VTy->getNumElements() ||
643 cast<ConstantInt>(G2OC)->getZExtValue() >=
644 VTy->getNumElements()) {
645 isBadCase = true;
646 break;
647 }
648 STy = cast<SequentialType>(NextTy);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000649 NextTy = cast<SequentialType>(NextTy)->getElementType();
650 }
651
652 if (isBadCase) G1OC = 0;
653 }
654
655 // Make sure they are comparable (ie, not constant expressions), and
656 // make sure the GEP with the smaller leading constant is GEP1.
657 if (G1OC) {
658 Constant *Compare = ConstantExpr::getICmp(ICmpInst::ICMP_SGT,
659 G1OC, G2OC);
660 if (ConstantInt *CV = dyn_cast<ConstantInt>(Compare)) {
661 if (CV->getZExtValue()) { // If they are comparable and G2 > G1
662 std::swap(GEP1Ops, GEP2Ops); // Make GEP1 < GEP2
663 std::swap(NumGEP1Ops, NumGEP2Ops);
664 }
665 break;
666 }
667 }
668 }
669 }
670 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
671 }
672
673 // No shared constant operands, and we ran out of common operands. At this
674 // point, the GEP instructions have run through all of their operands, and we
675 // haven't found evidence that there are any deltas between the GEP's.
676 // However, one GEP may have more operands than the other. If this is the
677 // case, there may still be hope. Check this now.
678 if (FirstConstantOper == MinOperands) {
679 // Make GEP1Ops be the longer one if there is a longer one.
680 if (NumGEP1Ops < NumGEP2Ops) {
681 std::swap(GEP1Ops, GEP2Ops);
682 std::swap(NumGEP1Ops, NumGEP2Ops);
683 }
684
685 // Is there anything to check?
686 if (NumGEP1Ops > MinOperands) {
687 for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
688 if (isa<ConstantInt>(GEP1Ops[i]) &&
689 !cast<ConstantInt>(GEP1Ops[i])->isZero()) {
690 // Yup, there's a constant in the tail. Set all variables to
Wojciech Matyjewicze1709452008-06-02 17:26:12 +0000691 // constants in the GEP instruction to make it suitable for
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000692 // TargetData::getIndexedOffset.
693 for (i = 0; i != MaxOperands; ++i)
694 if (!isa<ConstantInt>(GEP1Ops[i]))
Owen Andersond4d90a02009-07-06 18:42:36 +0000695 GEP1Ops[i] = Context->getNullValue(GEP1Ops[i]->getType());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000696 // Okay, now get the offset. This is the relative offset for the full
697 // instruction.
698 const TargetData &TD = getTargetData();
699 int64_t Offset1 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
700 NumGEP1Ops);
701
702 // Now check without any constants at the end.
703 int64_t Offset2 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
704 MinOperands);
705
Wojciech Matyjewicze1709452008-06-02 17:26:12 +0000706 // Make sure we compare the absolute difference.
707 if (Offset1 > Offset2)
708 std::swap(Offset1, Offset2);
709
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000710 // If the tail provided a bit enough offset, return noalias!
711 if ((uint64_t)(Offset2-Offset1) >= SizeMax)
712 return NoAlias;
Wojciech Matyjewicze1709452008-06-02 17:26:12 +0000713 // Otherwise break - we don't look for another constant in the tail.
714 break;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000715 }
716 }
717
718 // Couldn't find anything useful.
719 return MayAlias;
720 }
721
722 // If there are non-equal constants arguments, then we can figure
723 // out a minimum known delta between the two index expressions... at
724 // this point we know that the first constant index of GEP1 is less
725 // than the first constant index of GEP2.
726
727 // Advance BasePtr[12]Ty over this first differing constant operand.
728 BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->
729 getTypeAtIndex(GEP2Ops[FirstConstantOper]);
730 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->
731 getTypeAtIndex(GEP1Ops[FirstConstantOper]);
732
733 // We are going to be using TargetData::getIndexedOffset to determine the
734 // offset that each of the GEP's is reaching. To do this, we have to convert
735 // all variable references to constant references. To do this, we convert the
736 // initial sequence of array subscripts into constant zeros to start with.
737 const Type *ZeroIdxTy = GEPPointerTy;
738 for (unsigned i = 0; i != FirstConstantOper; ++i) {
739 if (!isa<StructType>(ZeroIdxTy))
Owen Andersond4d90a02009-07-06 18:42:36 +0000740 GEP1Ops[i] = GEP2Ops[i] = Context->getNullValue(Type::Int32Ty);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000741
742 if (const CompositeType *CT = dyn_cast<CompositeType>(ZeroIdxTy))
743 ZeroIdxTy = CT->getTypeAtIndex(GEP1Ops[i]);
744 }
745
746 // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
747
748 // Loop over the rest of the operands...
749 for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
750 const Value *Op1 = i < NumGEP1Ops ? GEP1Ops[i] : 0;
751 const Value *Op2 = i < NumGEP2Ops ? GEP2Ops[i] : 0;
752 // If they are equal, use a zero index...
753 if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
754 if (!isa<ConstantInt>(Op1))
Owen Andersond4d90a02009-07-06 18:42:36 +0000755 GEP1Ops[i] = GEP2Ops[i] = Context->getNullValue(Op1->getType());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000756 // Otherwise, just keep the constants we have.
757 } else {
758 if (Op1) {
759 if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
760 // If this is an array index, make sure the array element is in range.
761 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty)) {
762 if (Op1C->getZExtValue() >= AT->getNumElements())
763 return MayAlias; // Be conservative with out-of-range accesses
Chris Lattnereaf7b232007-12-09 07:35:13 +0000764 } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty)) {
765 if (Op1C->getZExtValue() >= VT->getNumElements())
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000766 return MayAlias; // Be conservative with out-of-range accesses
767 }
768
769 } else {
770 // GEP1 is known to produce a value less than GEP2. To be
771 // conservatively correct, we must assume the largest possible
772 // constant is used in this position. This cannot be the initial
773 // index to the GEP instructions (because we know we have at least one
774 // element before this one with the different constant arguments), so
775 // we know that the current index must be into either a struct or
776 // array. Because we know it's not constant, this cannot be a
777 // structure index. Because of this, we can calculate the maximum
778 // value possible.
779 //
780 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
Owen Andersond4d90a02009-07-06 18:42:36 +0000781 GEP1Ops[i] =
782 Context->getConstantInt(Type::Int64Ty,AT->getNumElements()-1);
Chris Lattnerc0656ad2007-11-06 05:58:42 +0000783 else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty))
Owen Andersond4d90a02009-07-06 18:42:36 +0000784 GEP1Ops[i] =
785 Context->getConstantInt(Type::Int64Ty,VT->getNumElements()-1);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000786 }
787 }
788
789 if (Op2) {
790 if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
791 // If this is an array index, make sure the array element is in range.
Chris Lattnereaf7b232007-12-09 07:35:13 +0000792 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr2Ty)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000793 if (Op2C->getZExtValue() >= AT->getNumElements())
794 return MayAlias; // Be conservative with out-of-range accesses
Chris Lattnereaf7b232007-12-09 07:35:13 +0000795 } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr2Ty)) {
Chris Lattnerc0656ad2007-11-06 05:58:42 +0000796 if (Op2C->getZExtValue() >= VT->getNumElements())
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000797 return MayAlias; // Be conservative with out-of-range accesses
798 }
799 } else { // Conservatively assume the minimum value for this index
Owen Andersond4d90a02009-07-06 18:42:36 +0000800 GEP2Ops[i] = Context->getNullValue(Op2->getType());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000801 }
802 }
803 }
804
805 if (BasePtr1Ty && Op1) {
806 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
807 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
808 else
809 BasePtr1Ty = 0;
810 }
811
812 if (BasePtr2Ty && Op2) {
813 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
814 BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
815 else
816 BasePtr2Ty = 0;
817 }
818 }
819
820 if (GEPPointerTy->getElementType()->isSized()) {
821 int64_t Offset1 =
822 getTargetData().getIndexedOffset(GEPPointerTy, GEP1Ops, NumGEP1Ops);
823 int64_t Offset2 =
824 getTargetData().getIndexedOffset(GEPPointerTy, GEP2Ops, NumGEP2Ops);
Chris Lattnerc0656ad2007-11-06 05:58:42 +0000825 assert(Offset1 != Offset2 &&
826 "There is at least one different constant here!");
827
828 // Make sure we compare the absolute difference.
829 if (Offset1 > Offset2)
830 std::swap(Offset1, Offset2);
831
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000832 if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
833 //cerr << "Determined that these two GEP's don't alias ["
834 // << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
835 return NoAlias;
836 }
837 }
838 return MayAlias;
839}
840
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000841// Make sure that anything that uses AliasAnalysis pulls in this file...
842DEFINING_FILE_FOR(BasicAliasAnalysis)