blob: 57d726df2db12e9d594774ddafdef1649a035d41 [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"
17#include "llvm/Analysis/Passes.h"
18#include "llvm/Constants.h"
19#include "llvm/DerivedTypes.h"
20#include "llvm/Function.h"
Christopher Lamb6f9fad52007-08-02 01:18:14 +000021#include "llvm/ParameterAttributes.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000022#include "llvm/GlobalVariable.h"
23#include "llvm/Instructions.h"
Owen Anderson37f3ffb2008-02-17 21:29:08 +000024#include "llvm/IntrinsicInst.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000025#include "llvm/Pass.h"
26#include "llvm/Target/TargetData.h"
27#include "llvm/ADT/SmallVector.h"
Owen Anderson1636de92007-09-07 04:06:50 +000028#include "llvm/ADT/STLExtras.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000029#include "llvm/Support/Compiler.h"
30#include "llvm/Support/GetElementPtrTypeIterator.h"
31#include "llvm/Support/ManagedStatic.h"
32#include <algorithm>
33using namespace llvm;
34
35namespace {
36 /// NoAA - This class implements the -no-aa pass, which always returns "I
37 /// don't know" for alias queries. NoAA is unlike other alias analysis
38 /// implementations, in that it does not chain to a previous analysis. As
39 /// such it doesn't follow many of the rules that other alias analyses must.
40 ///
41 struct VISIBILITY_HIDDEN NoAA : public ImmutablePass, public AliasAnalysis {
42 static char ID; // Class identification, replacement for typeinfo
43 NoAA() : ImmutablePass((intptr_t)&ID) {}
44 explicit NoAA(intptr_t PID) : ImmutablePass(PID) { }
45
46 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
47 AU.addRequired<TargetData>();
48 }
49
50 virtual void initializePass() {
51 TD = &getAnalysis<TargetData>();
52 }
53
54 virtual AliasResult alias(const Value *V1, unsigned V1Size,
55 const Value *V2, unsigned V2Size) {
56 return MayAlias;
57 }
58
59 virtual ModRefBehavior getModRefBehavior(Function *F, CallSite CS,
60 std::vector<PointerAccessInfo> *Info) {
61 return UnknownModRefBehavior;
62 }
63
64 virtual void getArgumentAccesses(Function *F, CallSite CS,
65 std::vector<PointerAccessInfo> &Info) {
66 assert(0 && "This method may not be called on this function!");
67 }
68
69 virtual void getMustAliases(Value *P, std::vector<Value*> &RetVals) { }
70 virtual bool pointsToConstantMemory(const Value *P) { return false; }
71 virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
72 return ModRef;
73 }
74 virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
75 return ModRef;
76 }
77 virtual bool hasNoModRefInfoForCalls() const { return true; }
78
79 virtual void deleteValue(Value *V) {}
80 virtual void copyValue(Value *From, Value *To) {}
81 };
82
83 // Register this pass...
84 char NoAA::ID = 0;
85 RegisterPass<NoAA>
86 U("no-aa", "No Alias Analysis (always returns 'may' alias)");
87
88 // Declare that we implement the AliasAnalysis interface
89 RegisterAnalysisGroup<AliasAnalysis> V(U);
90} // End of anonymous namespace
91
92ImmutablePass *llvm::createNoAAPass() { return new NoAA(); }
93
94namespace {
95 /// BasicAliasAnalysis - This is the default alias analysis implementation.
96 /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
97 /// derives from the NoAA class.
98 struct VISIBILITY_HIDDEN BasicAliasAnalysis : public NoAA {
99 static char ID; // Class identification, replacement for typeinfo
100 BasicAliasAnalysis() : NoAA((intptr_t)&ID) { }
101 AliasResult alias(const Value *V1, unsigned V1Size,
102 const Value *V2, unsigned V2Size);
103
104 ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
105 ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
106 return NoAA::getModRefInfo(CS1,CS2);
107 }
108
109 /// hasNoModRefInfoForCalls - We can provide mod/ref information against
110 /// non-escaping allocations.
111 virtual bool hasNoModRefInfoForCalls() const { return false; }
112
113 /// pointsToConstantMemory - Chase pointers until we find a (constant
114 /// global) or not.
115 bool pointsToConstantMemory(const Value *P);
116
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000117 private:
118 // CheckGEPInstructions - Check two GEP instructions with known
119 // must-aliasing base pointers. This checks to see if the index expressions
120 // preclude the pointers from aliasing...
121 AliasResult
122 CheckGEPInstructions(const Type* BasePtr1Ty,
123 Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1Size,
124 const Type *BasePtr2Ty,
125 Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2Size);
126 };
127
128 // Register this pass...
129 char BasicAliasAnalysis::ID = 0;
130 RegisterPass<BasicAliasAnalysis>
131 X("basicaa", "Basic Alias Analysis (default AA impl)");
132
133 // Declare that we implement the AliasAnalysis interface
134 RegisterAnalysisGroup<AliasAnalysis, true> Y(X);
135} // End of anonymous namespace
136
137ImmutablePass *llvm::createBasicAliasAnalysisPass() {
138 return new BasicAliasAnalysis();
139}
140
Chris Lattner9603f432008-01-24 18:00:32 +0000141/// getUnderlyingObject - This traverses the use chain to figure out what object
142/// the specified value points to. If the value points to, or is derived from,
143/// a unique object or an argument, return it. This returns:
144/// Arguments, GlobalVariables, Functions, Allocas, Mallocs.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000145static const Value *getUnderlyingObject(const Value *V) {
146 if (!isa<PointerType>(V->getType())) return 0;
147
148 // If we are at some type of object, return it. GlobalValues and Allocations
149 // have unique addresses.
150 if (isa<GlobalValue>(V) || isa<AllocationInst>(V) || isa<Argument>(V))
151 return V;
152
153 // Traverse through different addressing mechanisms...
154 if (const Instruction *I = dyn_cast<Instruction>(V)) {
155 if (isa<BitCastInst>(I) || isa<GetElementPtrInst>(I))
156 return getUnderlyingObject(I->getOperand(0));
157 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
158 if (CE->getOpcode() == Instruction::BitCast ||
159 CE->getOpcode() == Instruction::GetElementPtr)
160 return getUnderlyingObject(CE->getOperand(0));
161 }
162 return 0;
163}
164
165static const User *isGEP(const Value *V) {
166 if (isa<GetElementPtrInst>(V) ||
167 (isa<ConstantExpr>(V) &&
168 cast<ConstantExpr>(V)->getOpcode() == Instruction::GetElementPtr))
169 return cast<User>(V);
170 return 0;
171}
172
173static const Value *GetGEPOperands(const Value *V,
174 SmallVector<Value*, 16> &GEPOps){
175 assert(GEPOps.empty() && "Expect empty list to populate!");
176 GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
177 cast<User>(V)->op_end());
178
179 // Accumulate all of the chained indexes into the operand array
180 V = cast<User>(V)->getOperand(0);
181
182 while (const User *G = isGEP(V)) {
183 if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
184 !cast<Constant>(GEPOps[0])->isNullValue())
185 break; // Don't handle folding arbitrary pointer offsets yet...
186 GEPOps.erase(GEPOps.begin()); // Drop the zero index
187 GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
188 V = G->getOperand(0);
189 }
190 return V;
191}
192
193/// pointsToConstantMemory - Chase pointers until we find a (constant
194/// global) or not.
195bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
196 if (const Value *V = getUnderlyingObject(P))
197 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
198 return GV->isConstant();
199 return false;
200}
201
202// Determine if an AllocationInst instruction escapes from the function it is
203// contained in. If it does not escape, there is no way for another function to
204// mod/ref it. We do this by looking at its uses and determining if the uses
205// can escape (recursively).
206static bool AddressMightEscape(const Value *V) {
207 for (Value::use_const_iterator UI = V->use_begin(), E = V->use_end();
208 UI != E; ++UI) {
209 const Instruction *I = cast<Instruction>(*UI);
210 switch (I->getOpcode()) {
211 case Instruction::Load:
212 break; //next use.
213 case Instruction::Store:
214 if (I->getOperand(0) == V)
215 return true; // Escapes if the pointer is stored.
216 break; // next use.
217 case Instruction::GetElementPtr:
218 if (AddressMightEscape(I))
219 return true;
Evan Cheng2e9830d2007-09-05 21:36:14 +0000220 break; // next use.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000221 case Instruction::BitCast:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000222 if (AddressMightEscape(I))
223 return true;
224 break; // next use
225 case Instruction::Ret:
226 // If returned, the address will escape to calling functions, but no
227 // callees could modify it.
228 break; // next use
Owen Anderson37f3ffb2008-02-17 21:29:08 +0000229 case Instruction::Call:
230 // If the call is to a few known safe intrinsics, we know that it does
231 // not escape
Chris Lattner4a27ab82008-02-18 02:11:28 +0000232 if (!isa<MemIntrinsic>(I))
Owen Anderson37f3ffb2008-02-17 21:29:08 +0000233 return true;
Chris Lattner4a27ab82008-02-18 02:11:28 +0000234 break; // next use
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000235 default:
236 return true;
237 }
238 }
239 return false;
240}
241
242// getModRefInfo - Check to see if the specified callsite can clobber the
243// specified memory object. Since we only look at local properties of this
244// function, we really can't say much about this query. We do, however, use
245// simple "address taken" analysis on local objects.
246//
247AliasAnalysis::ModRefResult
248BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
Chris Lattner9603f432008-01-24 18:00:32 +0000249 if (!isa<Constant>(P)) {
250 const Value *Object = getUnderlyingObject(P);
251 // Allocations and byval arguments are "new" objects.
Chris Lattner36d0a1f2008-01-24 19:07:10 +0000252 if (Object &&
Owen Anderson34f007e2008-02-18 02:31:23 +0000253 (isa<AllocationInst>(Object) || isa<Argument>(Object))) {
Owen Anderson37f3ffb2008-02-17 21:29:08 +0000254 // Okay, the pointer is to a stack allocated (or effectively so, for
Owen Andersonf8e7e842008-02-18 03:52:21 +0000255 // for noalias parameters) object. If the address of this object doesn't
256 // escape from this function body to a callee, then we know that no
257 // callees can mod/ref it unless they are actually passed it.
Owen Anderson34f007e2008-02-18 02:31:23 +0000258 if (isa<AllocationInst>(Object) ||
259 cast<Argument>(Object)->hasByValAttr() ||
260 cast<Argument>(Object)->hasNoAliasAttr())
261 if (!AddressMightEscape(Object)) {
Owen Andersonf8e7e842008-02-18 03:52:21 +0000262 bool passedAsArg = false;
Owen Anderson34f007e2008-02-18 02:31:23 +0000263 for (CallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
264 CI != CE; ++CI)
Chris Lattnera9ebe5b2008-02-18 17:28:21 +0000265 if (isa<PointerType>((*CI)->getType()) &&
266 getUnderlyingObject(*CI) == P)
Owen Andersonf8e7e842008-02-18 03:52:21 +0000267 passedAsArg = true;
268
269 if (!passedAsArg)
270 return NoModRef;
Owen Anderson34f007e2008-02-18 02:31:23 +0000271 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000272
273 // If this is a tail call and P points to a stack location, we know that
274 // the tail call cannot access or modify the local stack.
Owen Anderson528ef0d2008-02-18 09:11:02 +0000275 if (isa<AllocaInst>(Object) ||
Owen Anderson3b7b3ed2008-02-18 10:11:00 +0000276 (isa<Argument>(Object) && cast<Argument>(Object)->hasByValAttr()))
Owen Anderson34f007e2008-02-18 02:31:23 +0000277 if (CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
Owen Anderson528ef0d2008-02-18 09:11:02 +0000278 if (CI->isTailCall())
Owen Anderson34f007e2008-02-18 02:31:23 +0000279 return NoModRef;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000280 }
Chris Lattner9603f432008-01-24 18:00:32 +0000281 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000282
283 // The AliasAnalysis base class has some smarts, lets use them.
284 return AliasAnalysis::getModRefInfo(CS, P, Size);
285}
286
287// alias - Provide a bunch of ad-hoc rules to disambiguate in common cases, such
288// as array references. Note that this function is heavily tail recursive.
289// Hopefully we have a smart C++ compiler. :)
290//
291AliasAnalysis::AliasResult
292BasicAliasAnalysis::alias(const Value *V1, unsigned V1Size,
293 const Value *V2, unsigned V2Size) {
294 // Strip off any constant expression casts if they exist
295 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V1))
296 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
297 V1 = CE->getOperand(0);
298 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V2))
299 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
300 V2 = CE->getOperand(0);
301
302 // Are we checking for alias of the same value?
303 if (V1 == V2) return MustAlias;
304
305 if ((!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType())) &&
306 V1->getType() != Type::Int64Ty && V2->getType() != Type::Int64Ty)
307 return NoAlias; // Scalars cannot alias each other
308
309 // Strip off cast instructions...
310 if (const BitCastInst *I = dyn_cast<BitCastInst>(V1))
311 return alias(I->getOperand(0), V1Size, V2, V2Size);
312 if (const BitCastInst *I = dyn_cast<BitCastInst>(V2))
313 return alias(V1, V1Size, I->getOperand(0), V2Size);
314
315 // Figure out what objects these things are pointing to if we can...
316 const Value *O1 = getUnderlyingObject(V1);
317 const Value *O2 = getUnderlyingObject(V2);
318
319 // Pointing at a discernible object?
320 if (O1) {
321 if (O2) {
Christopher Lambcd533cf2007-08-02 17:52:00 +0000322 if (const Argument *O1Arg = dyn_cast<Argument>(O1)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000323 // Incoming argument cannot alias locally allocated object!
324 if (isa<AllocationInst>(O2)) return NoAlias;
Christopher Lamb6f9fad52007-08-02 01:18:14 +0000325
326 // If they are two different objects, and one is a noalias argument
327 // then they do not alias.
Chris Lattner9603f432008-01-24 18:00:32 +0000328 if (O1 != O2 && O1Arg->hasNoAliasAttr())
Christopher Lamb6f9fad52007-08-02 01:18:14 +0000329 return NoAlias;
Chris Lattner9603f432008-01-24 18:00:32 +0000330
331 // Byval arguments can't alias globals or other arguments.
332 if (O1 != O2 && O1Arg->hasByValAttr()) return NoAlias;
333
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000334 // Otherwise, nothing is known...
Christopher Lamb6f9fad52007-08-02 01:18:14 +0000335 }
336
Christopher Lambcd533cf2007-08-02 17:52:00 +0000337 if (const Argument *O2Arg = dyn_cast<Argument>(O2)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000338 // Incoming argument cannot alias locally allocated object!
339 if (isa<AllocationInst>(O1)) return NoAlias;
Christopher Lamb6f9fad52007-08-02 01:18:14 +0000340
341 // If they are two different objects, and one is a noalias argument
342 // then they do not alias.
Chris Lattner9603f432008-01-24 18:00:32 +0000343 if (O1 != O2 && O2Arg->hasNoAliasAttr())
Christopher Lamb6f9fad52007-08-02 01:18:14 +0000344 return NoAlias;
345
Chris Lattner9603f432008-01-24 18:00:32 +0000346 // Byval arguments can't alias globals or other arguments.
347 if (O1 != O2 && O2Arg->hasByValAttr()) return NoAlias;
348
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000349 // Otherwise, nothing is known...
Owen Andersoncd935022007-10-26 03:47:14 +0000350
Chris Lattner9603f432008-01-24 18:00:32 +0000351 } else if (O1 != O2 && !isa<Argument>(O1)) {
352 // If they are two different objects, and neither is an argument,
353 // we know that we have no alias.
354 return NoAlias;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000355 }
Christopher Lambd5fcd572007-07-31 16:18:07 +0000356
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000357 // If they are the same object, they we can look at the indexes. If they
358 // index off of the object is the same for both pointers, they must alias.
359 // If they are provably different, they must not alias. Otherwise, we
360 // can't tell anything.
361 }
362
Chris Lattner9603f432008-01-24 18:00:32 +0000363 // Unique values don't alias null, except non-byval arguments.
364 if (isa<ConstantPointerNull>(V2)) {
365 if (const Argument *O1Arg = dyn_cast<Argument>(O1)) {
366 if (O1Arg->hasByValAttr())
367 return NoAlias;
368 } else {
369 return NoAlias;
370 }
371 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000372
373 if (isa<GlobalVariable>(O1) ||
374 (isa<AllocationInst>(O1) &&
375 !cast<AllocationInst>(O1)->isArrayAllocation()))
376 if (cast<PointerType>(O1->getType())->getElementType()->isSized()) {
377 // If the size of the other access is larger than the total size of the
378 // global/alloca/malloc, it cannot be accessing the global (it's
379 // undefined to load or store bytes before or after an object).
380 const Type *ElTy = cast<PointerType>(O1->getType())->getElementType();
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000381 unsigned GlobalSize = getTargetData().getABITypeSize(ElTy);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000382 if (GlobalSize < V2Size && V2Size != ~0U)
383 return NoAlias;
384 }
385 }
386
387 if (O2) {
388 if (!isa<Argument>(O2) && isa<ConstantPointerNull>(V1))
389 return NoAlias; // Unique values don't alias null
390
391 if (isa<GlobalVariable>(O2) ||
392 (isa<AllocationInst>(O2) &&
393 !cast<AllocationInst>(O2)->isArrayAllocation()))
394 if (cast<PointerType>(O2->getType())->getElementType()->isSized()) {
395 // If the size of the other access is larger than the total size of the
396 // global/alloca/malloc, it cannot be accessing the object (it's
397 // undefined to load or store bytes before or after an object).
398 const Type *ElTy = cast<PointerType>(O2->getType())->getElementType();
Duncan Sandsf99fdc62007-11-01 20:53:16 +0000399 unsigned GlobalSize = getTargetData().getABITypeSize(ElTy);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000400 if (GlobalSize < V1Size && V1Size != ~0U)
401 return NoAlias;
402 }
403 }
404
405 // If we have two gep instructions with must-alias'ing base pointers, figure
406 // out if the indexes to the GEP tell us anything about the derived pointer.
407 // Note that we also handle chains of getelementptr instructions as well as
408 // constant expression getelementptrs here.
409 //
410 if (isGEP(V1) && isGEP(V2)) {
411 // Drill down into the first non-gep value, to test for must-aliasing of
412 // the base pointers.
Wojciech Matyjewicz170707f2007-12-13 16:22:58 +0000413 const User *G = cast<User>(V1);
414 while (isGEP(G->getOperand(0)) &&
415 G->getOperand(1) ==
416 Constant::getNullValue(G->getOperand(1)->getType()))
417 G = cast<User>(G->getOperand(0));
418 const Value *BasePtr1 = G->getOperand(0);
419
420 G = cast<User>(V2);
421 while (isGEP(G->getOperand(0)) &&
422 G->getOperand(1) ==
423 Constant::getNullValue(G->getOperand(1)->getType()))
424 G = cast<User>(G->getOperand(0));
425 const Value *BasePtr2 = G->getOperand(0);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000426
427 // Do the base pointers alias?
428 AliasResult BaseAlias = alias(BasePtr1, ~0U, BasePtr2, ~0U);
429 if (BaseAlias == NoAlias) return NoAlias;
430 if (BaseAlias == MustAlias) {
431 // If the base pointers alias each other exactly, check to see if we can
432 // figure out anything about the resultant pointers, to try to prove
433 // non-aliasing.
434
435 // Collect all of the chained GEP operands together into one simple place
436 SmallVector<Value*, 16> GEP1Ops, GEP2Ops;
437 BasePtr1 = GetGEPOperands(V1, GEP1Ops);
438 BasePtr2 = GetGEPOperands(V2, GEP2Ops);
439
440 // If GetGEPOperands were able to fold to the same must-aliased pointer,
441 // do the comparison.
442 if (BasePtr1 == BasePtr2) {
443 AliasResult GAlias =
444 CheckGEPInstructions(BasePtr1->getType(),
445 &GEP1Ops[0], GEP1Ops.size(), V1Size,
446 BasePtr2->getType(),
447 &GEP2Ops[0], GEP2Ops.size(), V2Size);
448 if (GAlias != MayAlias)
449 return GAlias;
450 }
451 }
452 }
453
454 // Check to see if these two pointers are related by a getelementptr
455 // instruction. If one pointer is a GEP with a non-zero index of the other
456 // pointer, we know they cannot alias.
457 //
458 if (isGEP(V2)) {
459 std::swap(V1, V2);
460 std::swap(V1Size, V2Size);
461 }
462
463 if (V1Size != ~0U && V2Size != ~0U)
464 if (isGEP(V1)) {
465 SmallVector<Value*, 16> GEPOperands;
466 const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
467
468 AliasResult R = alias(BasePtr, V1Size, V2, V2Size);
469 if (R == MustAlias) {
470 // If there is at least one non-zero constant index, we know they cannot
471 // alias.
472 bool ConstantFound = false;
473 bool AllZerosFound = true;
474 for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
475 if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
476 if (!C->isNullValue()) {
477 ConstantFound = true;
478 AllZerosFound = false;
479 break;
480 }
481 } else {
482 AllZerosFound = false;
483 }
484
485 // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
486 // the ptr, the end result is a must alias also.
487 if (AllZerosFound)
488 return MustAlias;
489
490 if (ConstantFound) {
491 if (V2Size <= 1 && V1Size <= 1) // Just pointer check?
492 return NoAlias;
493
494 // Otherwise we have to check to see that the distance is more than
495 // the size of the argument... build an index vector that is equal to
496 // the arguments provided, except substitute 0's for any variable
497 // indexes we find...
498 if (cast<PointerType>(
499 BasePtr->getType())->getElementType()->isSized()) {
500 for (unsigned i = 0; i != GEPOperands.size(); ++i)
501 if (!isa<ConstantInt>(GEPOperands[i]))
502 GEPOperands[i] =
503 Constant::getNullValue(GEPOperands[i]->getType());
504 int64_t Offset =
505 getTargetData().getIndexedOffset(BasePtr->getType(),
506 &GEPOperands[0],
507 GEPOperands.size());
508
509 if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
510 return NoAlias;
511 }
512 }
513 }
514 }
515
516 return MayAlias;
517}
518
519// This function is used to determin if the indices of two GEP instructions are
520// equal. V1 and V2 are the indices.
521static bool IndexOperandsEqual(Value *V1, Value *V2) {
522 if (V1->getType() == V2->getType())
523 return V1 == V2;
524 if (Constant *C1 = dyn_cast<Constant>(V1))
525 if (Constant *C2 = dyn_cast<Constant>(V2)) {
526 // Sign extend the constants to long types, if necessary
527 if (C1->getType() != Type::Int64Ty)
528 C1 = ConstantExpr::getSExt(C1, Type::Int64Ty);
529 if (C2->getType() != Type::Int64Ty)
530 C2 = ConstantExpr::getSExt(C2, Type::Int64Ty);
531 return C1 == C2;
532 }
533 return false;
534}
535
536/// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
537/// base pointers. This checks to see if the index expressions preclude the
538/// pointers from aliasing...
539AliasAnalysis::AliasResult
540BasicAliasAnalysis::CheckGEPInstructions(
541 const Type* BasePtr1Ty, Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1S,
542 const Type *BasePtr2Ty, Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2S) {
543 // We currently can't handle the case when the base pointers have different
544 // primitive types. Since this is uncommon anyway, we are happy being
545 // extremely conservative.
546 if (BasePtr1Ty != BasePtr2Ty)
547 return MayAlias;
548
549 const PointerType *GEPPointerTy = cast<PointerType>(BasePtr1Ty);
550
551 // Find the (possibly empty) initial sequence of equal values... which are not
552 // necessarily constants.
553 unsigned NumGEP1Operands = NumGEP1Ops, NumGEP2Operands = NumGEP2Ops;
554 unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
555 unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
556 unsigned UnequalOper = 0;
557 while (UnequalOper != MinOperands &&
558 IndexOperandsEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper])) {
559 // Advance through the type as we go...
560 ++UnequalOper;
561 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
562 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
563 else {
564 // If all operands equal each other, then the derived pointers must
565 // alias each other...
566 BasePtr1Ty = 0;
567 assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
568 "Ran out of type nesting, but not out of operands?");
569 return MustAlias;
570 }
571 }
572
573 // If we have seen all constant operands, and run out of indexes on one of the
574 // getelementptrs, check to see if the tail of the leftover one is all zeros.
575 // If so, return mustalias.
576 if (UnequalOper == MinOperands) {
577 if (NumGEP1Ops < NumGEP2Ops) {
578 std::swap(GEP1Ops, GEP2Ops);
579 std::swap(NumGEP1Ops, NumGEP2Ops);
580 }
581
582 bool AllAreZeros = true;
583 for (unsigned i = UnequalOper; i != MaxOperands; ++i)
584 if (!isa<Constant>(GEP1Ops[i]) ||
585 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
586 AllAreZeros = false;
587 break;
588 }
589 if (AllAreZeros) return MustAlias;
590 }
591
592
593 // So now we know that the indexes derived from the base pointers,
594 // which are known to alias, are different. We can still determine a
595 // no-alias result if there are differing constant pairs in the index
596 // chain. For example:
597 // A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
598 //
599 // We have to be careful here about array accesses. In particular, consider:
600 // A[1][0] vs A[0][i]
601 // In this case, we don't *know* that the array will be accessed in bounds:
602 // the index could even be negative. Because of this, we have to
603 // conservatively *give up* and return may alias. We disregard differing
604 // array subscripts that are followed by a variable index without going
605 // through a struct.
606 //
607 unsigned SizeMax = std::max(G1S, G2S);
608 if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work.
609
610 // Scan for the first operand that is constant and unequal in the
611 // two getelementptrs...
612 unsigned FirstConstantOper = UnequalOper;
613 for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
614 const Value *G1Oper = GEP1Ops[FirstConstantOper];
615 const Value *G2Oper = GEP2Ops[FirstConstantOper];
616
617 if (G1Oper != G2Oper) // Found non-equal constant indexes...
618 if (Constant *G1OC = dyn_cast<ConstantInt>(const_cast<Value*>(G1Oper)))
619 if (Constant *G2OC = dyn_cast<ConstantInt>(const_cast<Value*>(G2Oper))){
620 if (G1OC->getType() != G2OC->getType()) {
621 // Sign extend both operands to long.
622 if (G1OC->getType() != Type::Int64Ty)
623 G1OC = ConstantExpr::getSExt(G1OC, Type::Int64Ty);
624 if (G2OC->getType() != Type::Int64Ty)
625 G2OC = ConstantExpr::getSExt(G2OC, Type::Int64Ty);
626 GEP1Ops[FirstConstantOper] = G1OC;
627 GEP2Ops[FirstConstantOper] = G2OC;
628 }
629
630 if (G1OC != G2OC) {
631 // Handle the "be careful" case above: if this is an array/vector
632 // subscript, scan for a subsequent variable array index.
633 if (isa<SequentialType>(BasePtr1Ty)) {
634 const Type *NextTy =
635 cast<SequentialType>(BasePtr1Ty)->getElementType();
636 bool isBadCase = false;
637
638 for (unsigned Idx = FirstConstantOper+1;
639 Idx != MinOperands && isa<SequentialType>(NextTy); ++Idx) {
640 const Value *V1 = GEP1Ops[Idx], *V2 = GEP2Ops[Idx];
641 if (!isa<Constant>(V1) || !isa<Constant>(V2)) {
642 isBadCase = true;
643 break;
644 }
645 NextTy = cast<SequentialType>(NextTy)->getElementType();
646 }
647
648 if (isBadCase) G1OC = 0;
649 }
650
651 // Make sure they are comparable (ie, not constant expressions), and
652 // make sure the GEP with the smaller leading constant is GEP1.
653 if (G1OC) {
654 Constant *Compare = ConstantExpr::getICmp(ICmpInst::ICMP_SGT,
655 G1OC, G2OC);
656 if (ConstantInt *CV = dyn_cast<ConstantInt>(Compare)) {
657 if (CV->getZExtValue()) { // If they are comparable and G2 > G1
658 std::swap(GEP1Ops, GEP2Ops); // Make GEP1 < GEP2
659 std::swap(NumGEP1Ops, NumGEP2Ops);
660 }
661 break;
662 }
663 }
664 }
665 }
666 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
667 }
668
669 // No shared constant operands, and we ran out of common operands. At this
670 // point, the GEP instructions have run through all of their operands, and we
671 // haven't found evidence that there are any deltas between the GEP's.
672 // However, one GEP may have more operands than the other. If this is the
673 // case, there may still be hope. Check this now.
674 if (FirstConstantOper == MinOperands) {
675 // Make GEP1Ops be the longer one if there is a longer one.
676 if (NumGEP1Ops < NumGEP2Ops) {
677 std::swap(GEP1Ops, GEP2Ops);
678 std::swap(NumGEP1Ops, NumGEP2Ops);
679 }
680
681 // Is there anything to check?
682 if (NumGEP1Ops > MinOperands) {
683 for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
684 if (isa<ConstantInt>(GEP1Ops[i]) &&
685 !cast<ConstantInt>(GEP1Ops[i])->isZero()) {
686 // Yup, there's a constant in the tail. Set all variables to
687 // constants in the GEP instruction to make it suiteable for
688 // TargetData::getIndexedOffset.
689 for (i = 0; i != MaxOperands; ++i)
690 if (!isa<ConstantInt>(GEP1Ops[i]))
691 GEP1Ops[i] = Constant::getNullValue(GEP1Ops[i]->getType());
692 // Okay, now get the offset. This is the relative offset for the full
693 // instruction.
694 const TargetData &TD = getTargetData();
695 int64_t Offset1 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
696 NumGEP1Ops);
697
698 // Now check without any constants at the end.
699 int64_t Offset2 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
700 MinOperands);
701
702 // If the tail provided a bit enough offset, return noalias!
703 if ((uint64_t)(Offset2-Offset1) >= SizeMax)
704 return NoAlias;
705 }
706 }
707
708 // Couldn't find anything useful.
709 return MayAlias;
710 }
711
712 // If there are non-equal constants arguments, then we can figure
713 // out a minimum known delta between the two index expressions... at
714 // this point we know that the first constant index of GEP1 is less
715 // than the first constant index of GEP2.
716
717 // Advance BasePtr[12]Ty over this first differing constant operand.
718 BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->
719 getTypeAtIndex(GEP2Ops[FirstConstantOper]);
720 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->
721 getTypeAtIndex(GEP1Ops[FirstConstantOper]);
722
723 // We are going to be using TargetData::getIndexedOffset to determine the
724 // offset that each of the GEP's is reaching. To do this, we have to convert
725 // all variable references to constant references. To do this, we convert the
726 // initial sequence of array subscripts into constant zeros to start with.
727 const Type *ZeroIdxTy = GEPPointerTy;
728 for (unsigned i = 0; i != FirstConstantOper; ++i) {
729 if (!isa<StructType>(ZeroIdxTy))
730 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Type::Int32Ty);
731
732 if (const CompositeType *CT = dyn_cast<CompositeType>(ZeroIdxTy))
733 ZeroIdxTy = CT->getTypeAtIndex(GEP1Ops[i]);
734 }
735
736 // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
737
738 // Loop over the rest of the operands...
739 for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
740 const Value *Op1 = i < NumGEP1Ops ? GEP1Ops[i] : 0;
741 const Value *Op2 = i < NumGEP2Ops ? GEP2Ops[i] : 0;
742 // If they are equal, use a zero index...
743 if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
744 if (!isa<ConstantInt>(Op1))
745 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Op1->getType());
746 // Otherwise, just keep the constants we have.
747 } else {
748 if (Op1) {
749 if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
750 // If this is an array index, make sure the array element is in range.
751 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty)) {
752 if (Op1C->getZExtValue() >= AT->getNumElements())
753 return MayAlias; // Be conservative with out-of-range accesses
Chris Lattnereaf7b232007-12-09 07:35:13 +0000754 } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty)) {
755 if (Op1C->getZExtValue() >= VT->getNumElements())
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000756 return MayAlias; // Be conservative with out-of-range accesses
757 }
758
759 } else {
760 // GEP1 is known to produce a value less than GEP2. To be
761 // conservatively correct, we must assume the largest possible
762 // constant is used in this position. This cannot be the initial
763 // index to the GEP instructions (because we know we have at least one
764 // element before this one with the different constant arguments), so
765 // we know that the current index must be into either a struct or
766 // array. Because we know it's not constant, this cannot be a
767 // structure index. Because of this, we can calculate the maximum
768 // value possible.
769 //
770 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
771 GEP1Ops[i] = ConstantInt::get(Type::Int64Ty,AT->getNumElements()-1);
Chris Lattnerc0656ad2007-11-06 05:58:42 +0000772 else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty))
773 GEP1Ops[i] = ConstantInt::get(Type::Int64Ty,VT->getNumElements()-1);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000774 }
775 }
776
777 if (Op2) {
778 if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
779 // If this is an array index, make sure the array element is in range.
Chris Lattnereaf7b232007-12-09 07:35:13 +0000780 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr2Ty)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000781 if (Op2C->getZExtValue() >= AT->getNumElements())
782 return MayAlias; // Be conservative with out-of-range accesses
Chris Lattnereaf7b232007-12-09 07:35:13 +0000783 } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr2Ty)) {
Chris Lattnerc0656ad2007-11-06 05:58:42 +0000784 if (Op2C->getZExtValue() >= VT->getNumElements())
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000785 return MayAlias; // Be conservative with out-of-range accesses
786 }
787 } else { // Conservatively assume the minimum value for this index
788 GEP2Ops[i] = Constant::getNullValue(Op2->getType());
789 }
790 }
791 }
792
793 if (BasePtr1Ty && Op1) {
794 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
795 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
796 else
797 BasePtr1Ty = 0;
798 }
799
800 if (BasePtr2Ty && Op2) {
801 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
802 BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
803 else
804 BasePtr2Ty = 0;
805 }
806 }
807
808 if (GEPPointerTy->getElementType()->isSized()) {
809 int64_t Offset1 =
810 getTargetData().getIndexedOffset(GEPPointerTy, GEP1Ops, NumGEP1Ops);
811 int64_t Offset2 =
812 getTargetData().getIndexedOffset(GEPPointerTy, GEP2Ops, NumGEP2Ops);
Chris Lattnerc0656ad2007-11-06 05:58:42 +0000813 assert(Offset1 != Offset2 &&
814 "There is at least one different constant here!");
815
816 // Make sure we compare the absolute difference.
817 if (Offset1 > Offset2)
818 std::swap(Offset1, Offset2);
819
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000820 if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
821 //cerr << "Determined that these two GEP's don't alias ["
822 // << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
823 return NoAlias;
824 }
825 }
826 return MayAlias;
827}
828
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000829// Make sure that anything that uses AliasAnalysis pulls in this file...
830DEFINING_FILE_FOR(BasicAliasAnalysis)