blob: 49d771a42d70836920ca1909a66b18215bdc1f40 [file] [log] [blame]
Chris Lattner9d7c9ea2003-11-25 20:11:47 +00001//===- BasicAliasAnalysis.cpp - Local Alias Analysis Impl -----------------===//
Misha Brukman2b37d7c2005-04-21 21:13:18 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// 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.
Misha Brukman2b37d7c2005-04-21 21:13:18 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerd501c132003-02-26 19:41:54 +00009//
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 Sands8556d2a2009-01-18 12:19:30 +000017#include "llvm/Analysis/CaptureTracking.h"
Jeff Cohen534927d2005-01-08 22:01:16 +000018#include "llvm/Analysis/Passes.h"
Chris Lattner4244bb52004-03-15 03:36:49 +000019#include "llvm/Constants.h"
20#include "llvm/DerivedTypes.h"
21#include "llvm/Function.h"
22#include "llvm/GlobalVariable.h"
Alkis Evlogimenoseb62bc72004-07-29 12:17:34 +000023#include "llvm/Instructions.h"
Owen Anderson9b636cb2008-02-17 21:29:08 +000024#include "llvm/IntrinsicInst.h"
Owen Anderson50895512009-07-06 18:42:36 +000025#include "llvm/LLVMContext.h"
Dan Gohman3a7a68c2009-07-17 22:25:10 +000026#include "llvm/Operator.h"
Chris Lattner4244bb52004-03-15 03:36:49 +000027#include "llvm/Pass.h"
Chris Lattnerd501c132003-02-26 19:41:54 +000028#include "llvm/Target/TargetData.h"
Chris Lattnera77600e2007-02-10 22:15:31 +000029#include "llvm/ADT/SmallVector.h"
Owen Anderson718cb662007-09-07 04:06:50 +000030#include "llvm/ADT/STLExtras.h"
Chris Lattnera4f0b3a2006-08-27 12:54:02 +000031#include "llvm/Support/Compiler.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000032#include "llvm/Support/ErrorHandling.h"
Chris Lattner90aa8392006-10-04 21:52:35 +000033#include "llvm/Support/GetElementPtrTypeIterator.h"
Alkis Evlogimenos20aa4742004-09-03 18:19:51 +000034#include <algorithm>
Chris Lattnerec4e8082003-11-25 18:33:40 +000035using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000036
Chris Lattnerdefa1c82008-06-16 06:30:22 +000037//===----------------------------------------------------------------------===//
38// Useful predicates
39//===----------------------------------------------------------------------===//
Devang Patel794fd752007-05-01 21:15:47 +000040
Dan Gohmanf2411742009-07-20 17:43:30 +000041static const GEPOperator *isGEP(const Value *V) {
42 return dyn_cast<GEPOperator>(V);
Chris Lattnerb307c882003-12-11 22:44:13 +000043}
Chris Lattnerd501c132003-02-26 19:41:54 +000044
Chris Lattnera77600e2007-02-10 22:15:31 +000045static const Value *GetGEPOperands(const Value *V,
Chris Lattnerb957bda2008-12-10 01:04:47 +000046 SmallVector<Value*, 16> &GEPOps) {
Chris Lattner4a830882003-12-11 23:20:16 +000047 assert(GEPOps.empty() && "Expect empty list to populate!");
48 GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
49 cast<User>(V)->op_end());
50
51 // Accumulate all of the chained indexes into the operand array
52 V = cast<User>(V)->getOperand(0);
53
54 while (const User *G = isGEP(V)) {
Reid Spencere8404342004-07-18 00:18:30 +000055 if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
Chris Lattner4a830882003-12-11 23:20:16 +000056 !cast<Constant>(GEPOps[0])->isNullValue())
57 break; // Don't handle folding arbitrary pointer offsets yet...
58 GEPOps.erase(GEPOps.begin()); // Drop the zero index
59 GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
60 V = G->getOperand(0);
61 }
62 return V;
63}
64
Chris Lattnera4139602008-06-16 06:10:11 +000065/// isKnownNonNull - Return true if we know that the specified value is never
66/// null.
67static bool isKnownNonNull(const Value *V) {
68 // Alloca never returns null, malloc might.
69 if (isa<AllocaInst>(V)) return true;
70
71 // A byval argument is never null.
72 if (const Argument *A = dyn_cast<Argument>(V))
73 return A->hasByValAttr();
74
75 // Global values are not null unless extern weak.
76 if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
77 return !GV->hasExternalWeakLinkage();
78 return false;
79}
80
Chris Lattner845f0d22008-06-16 06:19:11 +000081/// isNonEscapingLocalObject - Return true if the pointer is to a function-local
82/// object that never escapes from the function.
83static bool isNonEscapingLocalObject(const Value *V) {
Chris Lattnere7275792008-06-16 06:28:01 +000084 // If this is a local allocation, check to see if it escapes.
Nick Lewycky02ff3082008-11-24 03:41:24 +000085 if (isa<AllocationInst>(V) || isNoAliasCall(V))
Duncan Sands8556d2a2009-01-18 12:19:30 +000086 return !PointerMayBeCaptured(V, false);
Duncan Sands91c9c3102009-01-05 21:19:53 +000087
Chris Lattnere7275792008-06-16 06:28:01 +000088 // If this is an argument that corresponds to a byval or noalias argument,
Duncan Sands91c9c3102009-01-05 21:19:53 +000089 // then it has not escaped before entering the function. Check if it escapes
90 // inside the function.
Chris Lattnere7275792008-06-16 06:28:01 +000091 if (const Argument *A = dyn_cast<Argument>(V))
Duncan Sands91c9c3102009-01-05 21:19:53 +000092 if (A->hasByValAttr() || A->hasNoAliasAttr()) {
93 // Don't bother analyzing arguments already known not to escape.
94 if (A->hasNoCaptureAttr())
95 return true;
Duncan Sands8556d2a2009-01-18 12:19:30 +000096 return !PointerMayBeCaptured(V, false);
Duncan Sands91c9c3102009-01-05 21:19:53 +000097 }
Chris Lattner845f0d22008-06-16 06:19:11 +000098 return false;
99}
100
101
Chris Lattnera4139602008-06-16 06:10:11 +0000102/// isObjectSmallerThan - Return true if we can prove that the object specified
103/// by V is smaller than Size.
104static bool isObjectSmallerThan(const Value *V, unsigned Size,
105 const TargetData &TD) {
Chris Lattner295d4e92008-12-08 06:28:54 +0000106 const Type *AccessTy;
107 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
Chris Lattnera4139602008-06-16 06:10:11 +0000108 AccessTy = GV->getType()->getElementType();
Chris Lattner295d4e92008-12-08 06:28:54 +0000109 } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(V)) {
Chris Lattnera4139602008-06-16 06:10:11 +0000110 if (!AI->isArrayAllocation())
111 AccessTy = AI->getType()->getElementType();
Chris Lattner295d4e92008-12-08 06:28:54 +0000112 else
113 return false;
114 } else if (const Argument *A = dyn_cast<Argument>(V)) {
Chris Lattnera4139602008-06-16 06:10:11 +0000115 if (A->hasByValAttr())
116 AccessTy = cast<PointerType>(A->getType())->getElementType();
Chris Lattner295d4e92008-12-08 06:28:54 +0000117 else
118 return false;
119 } else {
120 return false;
121 }
Chris Lattnera4139602008-06-16 06:10:11 +0000122
Chris Lattner295d4e92008-12-08 06:28:54 +0000123 if (AccessTy->isSized())
Duncan Sands777d2302009-05-09 07:06:46 +0000124 return TD.getTypeAllocSize(AccessTy) < Size;
Chris Lattnera4139602008-06-16 06:10:11 +0000125 return false;
126}
127
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000128//===----------------------------------------------------------------------===//
129// NoAA Pass
130//===----------------------------------------------------------------------===//
131
132namespace {
133 /// NoAA - This class implements the -no-aa pass, which always returns "I
134 /// don't know" for alias queries. NoAA is unlike other alias analysis
135 /// implementations, in that it does not chain to a previous analysis. As
136 /// such it doesn't follow many of the rules that other alias analyses must.
137 ///
138 struct VISIBILITY_HIDDEN NoAA : public ImmutablePass, public AliasAnalysis {
139 static char ID; // Class identification, replacement for typeinfo
Dan Gohmanae73dc12008-09-04 17:05:41 +0000140 NoAA() : ImmutablePass(&ID) {}
141 explicit NoAA(void *PID) : ImmutablePass(PID) { }
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000142
143 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
144 AU.addRequired<TargetData>();
145 }
146
147 virtual void initializePass() {
148 TD = &getAnalysis<TargetData>();
149 }
150
151 virtual AliasResult alias(const Value *V1, unsigned V1Size,
152 const Value *V2, unsigned V2Size) {
153 return MayAlias;
154 }
155
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000156 virtual void getArgumentAccesses(Function *F, CallSite CS,
157 std::vector<PointerAccessInfo> &Info) {
Torok Edwinc23197a2009-07-14 16:55:14 +0000158 llvm_unreachable("This method may not be called on this function!");
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000159 }
160
161 virtual void getMustAliases(Value *P, std::vector<Value*> &RetVals) { }
162 virtual bool pointsToConstantMemory(const Value *P) { return false; }
163 virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
164 return ModRef;
165 }
166 virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
167 return ModRef;
168 }
169 virtual bool hasNoModRefInfoForCalls() const { return true; }
170
171 virtual void deleteValue(Value *V) {}
172 virtual void copyValue(Value *From, Value *To) {}
173 };
174} // End of anonymous namespace
175
176// Register this pass...
177char NoAA::ID = 0;
178static RegisterPass<NoAA>
179U("no-aa", "No Alias Analysis (always returns 'may' alias)", true, true);
180
181// Declare that we implement the AliasAnalysis interface
182static RegisterAnalysisGroup<AliasAnalysis> V(U);
183
184ImmutablePass *llvm::createNoAAPass() { return new NoAA(); }
185
186//===----------------------------------------------------------------------===//
187// BasicAA Pass
188//===----------------------------------------------------------------------===//
189
190namespace {
191 /// BasicAliasAnalysis - This is the default alias analysis implementation.
192 /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
193 /// derives from the NoAA class.
194 struct VISIBILITY_HIDDEN BasicAliasAnalysis : public NoAA {
195 static char ID; // Class identification, replacement for typeinfo
Dan Gohmanae73dc12008-09-04 17:05:41 +0000196 BasicAliasAnalysis() : NoAA(&ID) {}
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000197 AliasResult alias(const Value *V1, unsigned V1Size,
198 const Value *V2, unsigned V2Size);
199
200 ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
Chris Lattner20d6f092008-12-09 21:19:42 +0000201 ModRefResult getModRefInfo(CallSite CS1, CallSite CS2);
Owen Andersone7942202009-02-05 23:36:27 +0000202
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000203 /// hasNoModRefInfoForCalls - We can provide mod/ref information against
204 /// non-escaping allocations.
205 virtual bool hasNoModRefInfoForCalls() const { return false; }
206
207 /// pointsToConstantMemory - Chase pointers until we find a (constant
208 /// global) or not.
209 bool pointsToConstantMemory(const Value *P);
210
211 private:
212 // CheckGEPInstructions - Check two GEP instructions with known
213 // must-aliasing base pointers. This checks to see if the index expressions
214 // preclude the pointers from aliasing...
215 AliasResult
216 CheckGEPInstructions(const Type* BasePtr1Ty,
217 Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1Size,
218 const Type *BasePtr2Ty,
219 Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2Size);
220 };
221} // End of anonymous namespace
222
223// Register this pass...
224char BasicAliasAnalysis::ID = 0;
225static RegisterPass<BasicAliasAnalysis>
226X("basicaa", "Basic Alias Analysis (default AA impl)", false, true);
227
228// Declare that we implement the AliasAnalysis interface
229static RegisterAnalysisGroup<AliasAnalysis, true> Y(X);
230
231ImmutablePass *llvm::createBasicAliasAnalysisPass() {
232 return new BasicAliasAnalysis();
233}
234
235
236/// pointsToConstantMemory - Chase pointers until we find a (constant
237/// global) or not.
238bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
239 if (const GlobalVariable *GV =
Duncan Sands5d0392c2008-10-01 15:25:41 +0000240 dyn_cast<GlobalVariable>(P->getUnderlyingObject()))
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000241 return GV->isConstant();
242 return false;
243}
244
Owen Andersone7942202009-02-05 23:36:27 +0000245
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000246// getModRefInfo - Check to see if the specified callsite can clobber the
247// specified memory object. Since we only look at local properties of this
248// function, we really can't say much about this query. We do, however, use
249// simple "address taken" analysis on local objects.
250//
251AliasAnalysis::ModRefResult
252BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
253 if (!isa<Constant>(P)) {
Duncan Sands5d0392c2008-10-01 15:25:41 +0000254 const Value *Object = P->getUnderlyingObject();
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000255
256 // If this is a tail call and P points to a stack location, we know that
257 // the tail call cannot access or modify the local stack.
258 // We cannot exclude byval arguments here; these belong to the caller of
259 // the current function not to the current function, and a tail callee
260 // may reference them.
261 if (isa<AllocaInst>(Object))
262 if (CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
263 if (CI->isTailCall())
264 return NoModRef;
265
Chris Lattner25df20f2008-06-16 06:38:26 +0000266 // If the pointer is to a locally allocated object that does not escape,
267 // then the call can not mod/ref the pointer unless the call takes the
268 // argument without capturing it.
Nick Lewycky826f7ce2009-02-13 07:06:27 +0000269 if (isNonEscapingLocalObject(Object) && CS.getInstruction() != Object) {
Chris Lattner25df20f2008-06-16 06:38:26 +0000270 bool passedAsArg = false;
271 // TODO: Eventually only check 'nocapture' arguments.
272 for (CallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
273 CI != CE; ++CI)
274 if (isa<PointerType>((*CI)->getType()) &&
275 alias(cast<Value>(CI), ~0U, P, ~0U) != NoAlias)
276 passedAsArg = true;
277
278 if (!passedAsArg)
279 return NoModRef;
Chris Lattnerdefa1c82008-06-16 06:30:22 +0000280 }
281 }
282
283 // The AliasAnalysis base class has some smarts, lets use them.
284 return AliasAnalysis::getModRefInfo(CS, P, Size);
285}
286
287
Chris Lattner20d6f092008-12-09 21:19:42 +0000288AliasAnalysis::ModRefResult
289BasicAliasAnalysis::getModRefInfo(CallSite CS1, CallSite CS2) {
290 // If CS1 or CS2 are readnone, they don't interact.
291 ModRefBehavior CS1B = AliasAnalysis::getModRefBehavior(CS1);
292 if (CS1B == DoesNotAccessMemory) return NoModRef;
293
294 ModRefBehavior CS2B = AliasAnalysis::getModRefBehavior(CS2);
295 if (CS2B == DoesNotAccessMemory) return NoModRef;
296
297 // If they both only read from memory, just return ref.
298 if (CS1B == OnlyReadsMemory && CS2B == OnlyReadsMemory)
299 return Ref;
300
301 // Otherwise, fall back to NoAA (mod+ref).
302 return NoAA::getModRefInfo(CS1, CS2);
303}
304
305
Chris Lattnerd501c132003-02-26 19:41:54 +0000306// alias - Provide a bunch of ad-hoc rules to disambiguate in common cases, such
Chris Lattnerb957bda2008-12-10 01:04:47 +0000307// as array references.
Chris Lattnerd501c132003-02-26 19:41:54 +0000308//
309AliasAnalysis::AliasResult
310BasicAliasAnalysis::alias(const Value *V1, unsigned V1Size,
311 const Value *V2, unsigned V2Size) {
Owen Andersone922c022009-07-22 00:24:57 +0000312 LLVMContext &Context = V1->getType()->getContext();
Owen Anderson001dbfe2009-07-16 18:04:31 +0000313
Chris Lattnerb307c882003-12-11 22:44:13 +0000314 // Strip off any constant expression casts if they exist
315 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V1))
Reid Spencer3da59db2006-11-27 01:05:10 +0000316 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000317 V1 = CE->getOperand(0);
318 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V2))
Reid Spencer3da59db2006-11-27 01:05:10 +0000319 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000320 V2 = CE->getOperand(0);
321
Chris Lattnerd501c132003-02-26 19:41:54 +0000322 // Are we checking for alias of the same value?
323 if (V1 == V2) return MustAlias;
324
Nick Lewycky02ff3082008-11-24 03:41:24 +0000325 if (!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType()))
Chris Lattnerd501c132003-02-26 19:41:54 +0000326 return NoAlias; // Scalars cannot alias each other
327
Chris Lattnerb957bda2008-12-10 01:04:47 +0000328 // Strip off cast instructions. Since V1 and V2 are pointers, they must be
329 // pointer<->pointer bitcasts.
Reid Spencer3da59db2006-11-27 01:05:10 +0000330 if (const BitCastInst *I = dyn_cast<BitCastInst>(V1))
Chris Lattner241607d2007-01-14 05:57:53 +0000331 return alias(I->getOperand(0), V1Size, V2, V2Size);
Reid Spencer3da59db2006-11-27 01:05:10 +0000332 if (const BitCastInst *I = dyn_cast<BitCastInst>(V2))
Chris Lattner241607d2007-01-14 05:57:53 +0000333 return alias(V1, V1Size, I->getOperand(0), V2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000334
Chris Lattnerb957bda2008-12-10 01:04:47 +0000335 // Figure out what objects these things are pointing to if we can.
Duncan Sands5d0392c2008-10-01 15:25:41 +0000336 const Value *O1 = V1->getUnderlyingObject();
337 const Value *O2 = V2->getUnderlyingObject();
Chris Lattnerd501c132003-02-26 19:41:54 +0000338
Chris Lattnera4139602008-06-16 06:10:11 +0000339 if (O1 != O2) {
340 // If V1/V2 point to two different objects we know that we have no alias.
341 if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
342 return NoAlias;
343
Nick Lewyckyb2b32fd2008-11-24 05:00:44 +0000344 // Arguments can't alias with local allocations or noalias calls.
345 if ((isa<Argument>(O1) && (isa<AllocationInst>(O2) || isNoAliasCall(O2))) ||
346 (isa<Argument>(O2) && (isa<AllocationInst>(O1) || isNoAliasCall(O1))))
Chris Lattnera4139602008-06-16 06:10:11 +0000347 return NoAlias;
Nick Lewycky02ff3082008-11-24 03:41:24 +0000348
Chris Lattnera4139602008-06-16 06:10:11 +0000349 // Most objects can't alias null.
350 if ((isa<ConstantPointerNull>(V2) && isKnownNonNull(O1)) ||
351 (isa<ConstantPointerNull>(V1) && isKnownNonNull(O2)))
352 return NoAlias;
Chris Lattner0a1ac902004-11-26 19:20:01 +0000353 }
Chris Lattnera4139602008-06-16 06:10:11 +0000354
355 // If the size of one access is larger than the entire object on the other
356 // side, then we know such behavior is undefined and can assume no alias.
357 const TargetData &TD = getTargetData();
358 if ((V1Size != ~0U && isObjectSmallerThan(O2, V1Size, TD)) ||
359 (V2Size != ~0U && isObjectSmallerThan(O1, V2Size, TD)))
360 return NoAlias;
361
Chris Lattner845f0d22008-06-16 06:19:11 +0000362 // If one pointer is the result of a call/invoke and the other is a
363 // non-escaping local object, then we know the object couldn't escape to a
364 // point where the call could return it.
365 if ((isa<CallInst>(O1) || isa<InvokeInst>(O1)) &&
Nick Lewycky826f7ce2009-02-13 07:06:27 +0000366 isNonEscapingLocalObject(O2) && O1 != O2)
Chris Lattner845f0d22008-06-16 06:19:11 +0000367 return NoAlias;
368 if ((isa<CallInst>(O2) || isa<InvokeInst>(O2)) &&
Nick Lewycky826f7ce2009-02-13 07:06:27 +0000369 isNonEscapingLocalObject(O1) && O1 != O2)
Chris Lattner845f0d22008-06-16 06:19:11 +0000370 return NoAlias;
Chris Lattnera4139602008-06-16 06:10:11 +0000371
Chris Lattnerb307c882003-12-11 22:44:13 +0000372 // If we have two gep instructions with must-alias'ing base pointers, figure
373 // out if the indexes to the GEP tell us anything about the derived pointer.
374 // Note that we also handle chains of getelementptr instructions as well as
375 // constant expression getelementptrs here.
Chris Lattnerd501c132003-02-26 19:41:54 +0000376 //
Chris Lattnerb307c882003-12-11 22:44:13 +0000377 if (isGEP(V1) && isGEP(V2)) {
Chris Lattnerb957bda2008-12-10 01:04:47 +0000378 const User *GEP1 = cast<User>(V1);
379 const User *GEP2 = cast<User>(V2);
380
381 // If V1 and V2 are identical GEPs, just recurse down on both of them.
382 // This allows us to analyze things like:
383 // P = gep A, 0, i, 1
384 // Q = gep B, 0, i, 1
385 // by just analyzing A and B. This is even safe for variable indices.
386 if (GEP1->getType() == GEP2->getType() &&
387 GEP1->getNumOperands() == GEP2->getNumOperands() &&
388 GEP1->getOperand(0)->getType() == GEP2->getOperand(0)->getType() &&
389 // All operands are the same, ignoring the base.
390 std::equal(GEP1->op_begin()+1, GEP1->op_end(), GEP2->op_begin()+1))
391 return alias(GEP1->getOperand(0), V1Size, GEP2->getOperand(0), V2Size);
392
393
Chris Lattnerb307c882003-12-11 22:44:13 +0000394 // Drill down into the first non-gep value, to test for must-aliasing of
395 // the base pointers.
Chris Lattnerb957bda2008-12-10 01:04:47 +0000396 while (isGEP(GEP1->getOperand(0)) &&
397 GEP1->getOperand(1) ==
Owen Andersone922c022009-07-22 00:24:57 +0000398 Context.getNullValue(GEP1->getOperand(1)->getType()))
Chris Lattnerb957bda2008-12-10 01:04:47 +0000399 GEP1 = cast<User>(GEP1->getOperand(0));
400 const Value *BasePtr1 = GEP1->getOperand(0);
Wojciech Matyjewicz4ba8cfc2007-12-13 16:22:58 +0000401
Chris Lattnerb957bda2008-12-10 01:04:47 +0000402 while (isGEP(GEP2->getOperand(0)) &&
403 GEP2->getOperand(1) ==
Owen Andersone922c022009-07-22 00:24:57 +0000404 Context.getNullValue(GEP2->getOperand(1)->getType()))
Chris Lattnerb957bda2008-12-10 01:04:47 +0000405 GEP2 = cast<User>(GEP2->getOperand(0));
406 const Value *BasePtr2 = GEP2->getOperand(0);
Chris Lattnerb307c882003-12-11 22:44:13 +0000407
408 // Do the base pointers alias?
Chris Lattner241607d2007-01-14 05:57:53 +0000409 AliasResult BaseAlias = alias(BasePtr1, ~0U, BasePtr2, ~0U);
Chris Lattnerb307c882003-12-11 22:44:13 +0000410 if (BaseAlias == NoAlias) return NoAlias;
411 if (BaseAlias == MustAlias) {
412 // If the base pointers alias each other exactly, check to see if we can
413 // figure out anything about the resultant pointers, to try to prove
414 // non-aliasing.
415
416 // Collect all of the chained GEP operands together into one simple place
Chris Lattnera77600e2007-02-10 22:15:31 +0000417 SmallVector<Value*, 16> GEP1Ops, GEP2Ops;
Chris Lattner4a830882003-12-11 23:20:16 +0000418 BasePtr1 = GetGEPOperands(V1, GEP1Ops);
419 BasePtr2 = GetGEPOperands(V2, GEP2Ops);
Chris Lattnerb307c882003-12-11 22:44:13 +0000420
Chris Lattner730b1ad2004-07-29 07:56:39 +0000421 // If GetGEPOperands were able to fold to the same must-aliased pointer,
422 // do the comparison.
423 if (BasePtr1 == BasePtr2) {
424 AliasResult GAlias =
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000425 CheckGEPInstructions(BasePtr1->getType(),
426 &GEP1Ops[0], GEP1Ops.size(), V1Size,
427 BasePtr2->getType(),
428 &GEP2Ops[0], GEP2Ops.size(), V2Size);
Chris Lattner730b1ad2004-07-29 07:56:39 +0000429 if (GAlias != MayAlias)
430 return GAlias;
431 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000432 }
433 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000434
435 // Check to see if these two pointers are related by a getelementptr
436 // instruction. If one pointer is a GEP with a non-zero index of the other
437 // pointer, we know they cannot alias.
438 //
Chris Lattner4a830882003-12-11 23:20:16 +0000439 if (isGEP(V2)) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000440 std::swap(V1, V2);
441 std::swap(V1Size, V2Size);
442 }
443
Chris Lattnerc330ee62003-02-26 21:57:23 +0000444 if (V1Size != ~0U && V2Size != ~0U)
Reid Spencer3ed469c2006-11-02 20:25:50 +0000445 if (isGEP(V1)) {
Chris Lattnera77600e2007-02-10 22:15:31 +0000446 SmallVector<Value*, 16> GEPOperands;
Chris Lattner4a830882003-12-11 23:20:16 +0000447 const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
448
449 AliasResult R = alias(BasePtr, V1Size, V2, V2Size);
Chris Lattnerc330ee62003-02-26 21:57:23 +0000450 if (R == MustAlias) {
451 // If there is at least one non-zero constant index, we know they cannot
452 // alias.
453 bool ConstantFound = false;
Chris Lattner88d3e032003-12-11 06:02:00 +0000454 bool AllZerosFound = true;
Chris Lattner4a830882003-12-11 23:20:16 +0000455 for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
456 if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
Chris Lattnerc330ee62003-02-26 21:57:23 +0000457 if (!C->isNullValue()) {
458 ConstantFound = true;
Chris Lattnerc54735e2003-12-11 06:06:28 +0000459 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000460 break;
Chris Lattner88d3e032003-12-11 06:02:00 +0000461 }
462 } else {
463 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000464 }
Chris Lattner88d3e032003-12-11 06:02:00 +0000465
466 // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
467 // the ptr, the end result is a must alias also.
468 if (AllZerosFound)
469 return MustAlias;
470
Chris Lattnerc330ee62003-02-26 21:57:23 +0000471 if (ConstantFound) {
472 if (V2Size <= 1 && V1Size <= 1) // Just pointer check?
Chris Lattnerd501c132003-02-26 19:41:54 +0000473 return NoAlias;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000474
Chris Lattnerc330ee62003-02-26 21:57:23 +0000475 // Otherwise we have to check to see that the distance is more than
476 // the size of the argument... build an index vector that is equal to
477 // the arguments provided, except substitute 0's for any variable
478 // indexes we find...
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000479 if (cast<PointerType>(
480 BasePtr->getType())->getElementType()->isSized()) {
481 for (unsigned i = 0; i != GEPOperands.size(); ++i)
Chris Lattner0bb38312007-01-12 18:20:48 +0000482 if (!isa<ConstantInt>(GEPOperands[i]))
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000483 GEPOperands[i] =
Owen Andersone922c022009-07-22 00:24:57 +0000484 Context.getNullValue(GEPOperands[i]->getType());
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000485 int64_t Offset =
Chris Lattner829621c2007-02-10 20:35:22 +0000486 getTargetData().getIndexedOffset(BasePtr->getType(),
487 &GEPOperands[0],
488 GEPOperands.size());
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000489
490 if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
491 return NoAlias;
492 }
Chris Lattnerc330ee62003-02-26 21:57:23 +0000493 }
494 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000495 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000496
Chris Lattnerd501c132003-02-26 19:41:54 +0000497 return MayAlias;
498}
499
Duncan Sands18327052008-12-08 14:01:59 +0000500// This function is used to determine if the indices of two GEP instructions are
Reid Spencer3da59db2006-11-27 01:05:10 +0000501// equal. V1 and V2 are the indices.
Owen Andersone922c022009-07-22 00:24:57 +0000502static bool IndexOperandsEqual(Value *V1, Value *V2, LLVMContext &Context) {
Chris Lattner28977af2004-04-05 01:30:19 +0000503 if (V1->getType() == V2->getType())
504 return V1 == V2;
505 if (Constant *C1 = dyn_cast<Constant>(V1))
506 if (Constant *C2 = dyn_cast<Constant>(V2)) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000507 // Sign extend the constants to long types, if necessary
Reid Spencerc5b206b2006-12-31 05:48:39 +0000508 if (C1->getType() != Type::Int64Ty)
Owen Andersone922c022009-07-22 00:24:57 +0000509 C1 = Context.getConstantExprSExt(C1, Type::Int64Ty);
Reid Spencerc5b206b2006-12-31 05:48:39 +0000510 if (C2->getType() != Type::Int64Ty)
Owen Andersone922c022009-07-22 00:24:57 +0000511 C2 = Context.getConstantExprSExt(C2, Type::Int64Ty);
Chris Lattner28977af2004-04-05 01:30:19 +0000512 return C1 == C2;
513 }
514 return false;
515}
516
Chris Lattnerb307c882003-12-11 22:44:13 +0000517/// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
518/// base pointers. This checks to see if the index expressions preclude the
519/// pointers from aliasing...
Reid Spencerb83eb642006-10-20 07:07:24 +0000520AliasAnalysis::AliasResult
521BasicAliasAnalysis::CheckGEPInstructions(
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000522 const Type* BasePtr1Ty, Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1S,
523 const Type *BasePtr2Ty, Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2S) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000524 // We currently can't handle the case when the base pointers have different
525 // primitive types. Since this is uncommon anyway, we are happy being
526 // extremely conservative.
527 if (BasePtr1Ty != BasePtr2Ty)
528 return MayAlias;
529
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000530 const PointerType *GEPPointerTy = cast<PointerType>(BasePtr1Ty);
Chris Lattnerb307c882003-12-11 22:44:13 +0000531
Owen Andersone922c022009-07-22 00:24:57 +0000532 LLVMContext &Context = GEPPointerTy->getContext();
Owen Anderson001dbfe2009-07-16 18:04:31 +0000533
Chris Lattnerb307c882003-12-11 22:44:13 +0000534 // Find the (possibly empty) initial sequence of equal values... which are not
535 // necessarily constants.
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000536 unsigned NumGEP1Operands = NumGEP1Ops, NumGEP2Operands = NumGEP2Ops;
Chris Lattnerb307c882003-12-11 22:44:13 +0000537 unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
538 unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
539 unsigned UnequalOper = 0;
540 while (UnequalOper != MinOperands &&
Owen Anderson50895512009-07-06 18:42:36 +0000541 IndexOperandsEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper],
542 Context)) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000543 // Advance through the type as we go...
544 ++UnequalOper;
545 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
546 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
547 else {
548 // If all operands equal each other, then the derived pointers must
549 // alias each other...
550 BasePtr1Ty = 0;
551 assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
552 "Ran out of type nesting, but not out of operands?");
553 return MustAlias;
Chris Lattner920bd792003-06-02 05:42:39 +0000554 }
555 }
Chris Lattner920bd792003-06-02 05:42:39 +0000556
Chris Lattnerb307c882003-12-11 22:44:13 +0000557 // If we have seen all constant operands, and run out of indexes on one of the
558 // getelementptrs, check to see if the tail of the leftover one is all zeros.
559 // If so, return mustalias.
Chris Lattner4a830882003-12-11 23:20:16 +0000560 if (UnequalOper == MinOperands) {
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000561 if (NumGEP1Ops < NumGEP2Ops) {
562 std::swap(GEP1Ops, GEP2Ops);
563 std::swap(NumGEP1Ops, NumGEP2Ops);
564 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000565
Chris Lattnerb307c882003-12-11 22:44:13 +0000566 bool AllAreZeros = true;
567 for (unsigned i = UnequalOper; i != MaxOperands; ++i)
Chris Lattnera35339d2004-10-16 16:07:10 +0000568 if (!isa<Constant>(GEP1Ops[i]) ||
Chris Lattnerb307c882003-12-11 22:44:13 +0000569 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
570 AllAreZeros = false;
571 break;
572 }
573 if (AllAreZeros) return MustAlias;
574 }
575
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000576
Chris Lattnerd501c132003-02-26 19:41:54 +0000577 // So now we know that the indexes derived from the base pointers,
578 // which are known to alias, are different. We can still determine a
579 // no-alias result if there are differing constant pairs in the index
580 // chain. For example:
581 // A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
582 //
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000583 // We have to be careful here about array accesses. In particular, consider:
584 // A[1][0] vs A[0][i]
585 // In this case, we don't *know* that the array will be accessed in bounds:
586 // the index could even be negative. Because of this, we have to
587 // conservatively *give up* and return may alias. We disregard differing
588 // array subscripts that are followed by a variable index without going
589 // through a struct.
590 //
Chris Lattnerd501c132003-02-26 19:41:54 +0000591 unsigned SizeMax = std::max(G1S, G2S);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000592 if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work.
Chris Lattner920bd792003-06-02 05:42:39 +0000593
Chris Lattnerd501c132003-02-26 19:41:54 +0000594 // Scan for the first operand that is constant and unequal in the
Chris Lattner28977af2004-04-05 01:30:19 +0000595 // two getelementptrs...
Chris Lattnerd501c132003-02-26 19:41:54 +0000596 unsigned FirstConstantOper = UnequalOper;
Chris Lattnerb307c882003-12-11 22:44:13 +0000597 for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
598 const Value *G1Oper = GEP1Ops[FirstConstantOper];
599 const Value *G2Oper = GEP2Ops[FirstConstantOper];
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000600
Chris Lattner6eb88d42004-01-12 17:57:32 +0000601 if (G1Oper != G2Oper) // Found non-equal constant indexes...
Chris Lattnera35339d2004-10-16 16:07:10 +0000602 if (Constant *G1OC = dyn_cast<ConstantInt>(const_cast<Value*>(G1Oper)))
603 if (Constant *G2OC = dyn_cast<ConstantInt>(const_cast<Value*>(G2Oper))){
Chris Lattner28977af2004-04-05 01:30:19 +0000604 if (G1OC->getType() != G2OC->getType()) {
605 // Sign extend both operands to long.
Reid Spencerc5b206b2006-12-31 05:48:39 +0000606 if (G1OC->getType() != Type::Int64Ty)
Owen Andersone922c022009-07-22 00:24:57 +0000607 G1OC = Context.getConstantExprSExt(G1OC, Type::Int64Ty);
Reid Spencerc5b206b2006-12-31 05:48:39 +0000608 if (G2OC->getType() != Type::Int64Ty)
Owen Andersone922c022009-07-22 00:24:57 +0000609 G2OC = Context.getConstantExprSExt(G2OC, Type::Int64Ty);
Chris Lattner28977af2004-04-05 01:30:19 +0000610 GEP1Ops[FirstConstantOper] = G1OC;
611 GEP2Ops[FirstConstantOper] = G2OC;
612 }
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000613
Chris Lattner28977af2004-04-05 01:30:19 +0000614 if (G1OC != G2OC) {
Dan Gohman07a96762007-07-16 14:29:03 +0000615 // Handle the "be careful" case above: if this is an array/vector
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000616 // subscript, scan for a subsequent variable array index.
Dan Gohman72776d22009-05-27 01:48:27 +0000617 if (const SequentialType *STy =
618 dyn_cast<SequentialType>(BasePtr1Ty)) {
619 const Type *NextTy = STy;
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000620 bool isBadCase = false;
621
Dan Gohman72776d22009-05-27 01:48:27 +0000622 for (unsigned Idx = FirstConstantOper;
Chris Lattner7765d712006-11-03 21:58:48 +0000623 Idx != MinOperands && isa<SequentialType>(NextTy); ++Idx) {
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000624 const Value *V1 = GEP1Ops[Idx], *V2 = GEP2Ops[Idx];
625 if (!isa<Constant>(V1) || !isa<Constant>(V2)) {
626 isBadCase = true;
627 break;
628 }
Dan Gohman72776d22009-05-27 01:48:27 +0000629 // If the array is indexed beyond the bounds of the static type
630 // at this level, it will also fall into the "be careful" case.
631 // It would theoretically be possible to analyze these cases,
632 // but for now just be conservatively correct.
633 if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
634 if (cast<ConstantInt>(G1OC)->getZExtValue() >=
635 ATy->getNumElements() ||
636 cast<ConstantInt>(G2OC)->getZExtValue() >=
637 ATy->getNumElements()) {
638 isBadCase = true;
639 break;
640 }
641 if (const VectorType *VTy = dyn_cast<VectorType>(STy))
642 if (cast<ConstantInt>(G1OC)->getZExtValue() >=
643 VTy->getNumElements() ||
644 cast<ConstantInt>(G2OC)->getZExtValue() >=
645 VTy->getNumElements()) {
646 isBadCase = true;
647 break;
648 }
649 STy = cast<SequentialType>(NextTy);
Chris Lattner7765d712006-11-03 21:58:48 +0000650 NextTy = cast<SequentialType>(NextTy)->getElementType();
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000651 }
652
653 if (isBadCase) G1OC = 0;
654 }
655
Chris Lattnera35339d2004-10-16 16:07:10 +0000656 // Make sure they are comparable (ie, not constant expressions), and
657 // make sure the GEP with the smaller leading constant is GEP1.
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000658 if (G1OC) {
Reid Spencere4d87aa2006-12-23 06:05:41 +0000659 Constant *Compare = ConstantExpr::getICmp(ICmpInst::ICMP_SGT,
660 G1OC, G2OC);
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +0000661 if (ConstantInt *CV = dyn_cast<ConstantInt>(Compare)) {
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000662 if (CV->getZExtValue()) { // If they are comparable and G2 > G1
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000663 std::swap(GEP1Ops, GEP2Ops); // Make GEP1 < GEP2
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000664 std::swap(NumGEP1Ops, NumGEP2Ops);
665 }
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000666 break;
667 }
Chris Lattner28977af2004-04-05 01:30:19 +0000668 }
Chris Lattner6eb88d42004-01-12 17:57:32 +0000669 }
670 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000671 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
Chris Lattnerd501c132003-02-26 19:41:54 +0000672 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000673
Chris Lattnerb307c882003-12-11 22:44:13 +0000674 // No shared constant operands, and we ran out of common operands. At this
675 // point, the GEP instructions have run through all of their operands, and we
676 // haven't found evidence that there are any deltas between the GEP's.
677 // However, one GEP may have more operands than the other. If this is the
Chris Lattner28977af2004-04-05 01:30:19 +0000678 // case, there may still be hope. Check this now.
Chris Lattnerb307c882003-12-11 22:44:13 +0000679 if (FirstConstantOper == MinOperands) {
680 // Make GEP1Ops be the longer one if there is a longer one.
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000681 if (NumGEP1Ops < NumGEP2Ops) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000682 std::swap(GEP1Ops, GEP2Ops);
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000683 std::swap(NumGEP1Ops, NumGEP2Ops);
684 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000685
686 // Is there anything to check?
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000687 if (NumGEP1Ops > MinOperands) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000688 for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +0000689 if (isa<ConstantInt>(GEP1Ops[i]) &&
Zhou Sheng843f07672007-04-19 05:39:12 +0000690 !cast<ConstantInt>(GEP1Ops[i])->isZero()) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000691 // Yup, there's a constant in the tail. Set all variables to
Wojciech Matyjewicz98e3a682008-06-02 17:26:12 +0000692 // constants in the GEP instruction to make it suitable for
Chris Lattnerb307c882003-12-11 22:44:13 +0000693 // TargetData::getIndexedOffset.
694 for (i = 0; i != MaxOperands; ++i)
Chris Lattner0bb38312007-01-12 18:20:48 +0000695 if (!isa<ConstantInt>(GEP1Ops[i]))
Owen Andersone922c022009-07-22 00:24:57 +0000696 GEP1Ops[i] = Context.getNullValue(GEP1Ops[i]->getType());
Chris Lattnerb307c882003-12-11 22:44:13 +0000697 // Okay, now get the offset. This is the relative offset for the full
698 // instruction.
699 const TargetData &TD = getTargetData();
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000700 int64_t Offset1 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
701 NumGEP1Ops);
Chris Lattnerb307c882003-12-11 22:44:13 +0000702
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000703 // Now check without any constants at the end.
704 int64_t Offset2 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
705 MinOperands);
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000706
Wojciech Matyjewicz98e3a682008-06-02 17:26:12 +0000707 // Make sure we compare the absolute difference.
708 if (Offset1 > Offset2)
709 std::swap(Offset1, Offset2);
710
Chris Lattnerb307c882003-12-11 22:44:13 +0000711 // If the tail provided a bit enough offset, return noalias!
712 if ((uint64_t)(Offset2-Offset1) >= SizeMax)
713 return NoAlias;
Wojciech Matyjewicz98e3a682008-06-02 17:26:12 +0000714 // Otherwise break - we don't look for another constant in the tail.
715 break;
Chris Lattnerb307c882003-12-11 22:44:13 +0000716 }
717 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000718
Chris Lattnerb307c882003-12-11 22:44:13 +0000719 // Couldn't find anything useful.
720 return MayAlias;
721 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000722
723 // If there are non-equal constants arguments, then we can figure
724 // out a minimum known delta between the two index expressions... at
725 // this point we know that the first constant index of GEP1 is less
726 // than the first constant index of GEP2.
Chris Lattner1af55e12003-11-25 20:10:07 +0000727
Chris Lattnerb307c882003-12-11 22:44:13 +0000728 // Advance BasePtr[12]Ty over this first differing constant operand.
Chris Lattner2cfdd282006-03-04 21:48:01 +0000729 BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->
730 getTypeAtIndex(GEP2Ops[FirstConstantOper]);
731 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->
732 getTypeAtIndex(GEP1Ops[FirstConstantOper]);
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000733
Chris Lattnerb307c882003-12-11 22:44:13 +0000734 // We are going to be using TargetData::getIndexedOffset to determine the
735 // offset that each of the GEP's is reaching. To do this, we have to convert
736 // all variable references to constant references. To do this, we convert the
Chris Lattner2cfdd282006-03-04 21:48:01 +0000737 // initial sequence of array subscripts into constant zeros to start with.
738 const Type *ZeroIdxTy = GEPPointerTy;
739 for (unsigned i = 0; i != FirstConstantOper; ++i) {
740 if (!isa<StructType>(ZeroIdxTy))
Owen Andersone922c022009-07-22 00:24:57 +0000741 GEP1Ops[i] = GEP2Ops[i] = Context.getNullValue(Type::Int32Ty);
Chris Lattnerb307c882003-12-11 22:44:13 +0000742
Chris Lattner2cfdd282006-03-04 21:48:01 +0000743 if (const CompositeType *CT = dyn_cast<CompositeType>(ZeroIdxTy))
744 ZeroIdxTy = CT->getTypeAtIndex(GEP1Ops[i]);
745 }
746
Chris Lattnerb307c882003-12-11 22:44:13 +0000747 // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000748
Chris Lattnerd501c132003-02-26 19:41:54 +0000749 // Loop over the rest of the operands...
Chris Lattnerb307c882003-12-11 22:44:13 +0000750 for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000751 const Value *Op1 = i < NumGEP1Ops ? GEP1Ops[i] : 0;
752 const Value *Op2 = i < NumGEP2Ops ? GEP2Ops[i] : 0;
Chris Lattnerb307c882003-12-11 22:44:13 +0000753 // If they are equal, use a zero index...
754 if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
Chris Lattner0bb38312007-01-12 18:20:48 +0000755 if (!isa<ConstantInt>(Op1))
Owen Andersone922c022009-07-22 00:24:57 +0000756 GEP1Ops[i] = GEP2Ops[i] = Context.getNullValue(Op1->getType());
Chris Lattnerb307c882003-12-11 22:44:13 +0000757 // Otherwise, just keep the constants we have.
Chris Lattnerd501c132003-02-26 19:41:54 +0000758 } else {
Chris Lattnerb307c882003-12-11 22:44:13 +0000759 if (Op1) {
760 if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
761 // If this is an array index, make sure the array element is in range.
Chris Lattner7765d712006-11-03 21:58:48 +0000762 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty)) {
Reid Spencerb83eb642006-10-20 07:07:24 +0000763 if (Op1C->getZExtValue() >= AT->getNumElements())
Chris Lattnerb307c882003-12-11 22:44:13 +0000764 return MayAlias; // Be conservative with out-of-range accesses
Chris Lattnerf88380b2007-12-09 07:35:13 +0000765 } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty)) {
766 if (Op1C->getZExtValue() >= VT->getNumElements())
Chris Lattner7765d712006-11-03 21:58:48 +0000767 return MayAlias; // Be conservative with out-of-range accesses
768 }
769
Chris Lattnerb307c882003-12-11 22:44:13 +0000770 } else {
771 // GEP1 is known to produce a value less than GEP2. To be
772 // conservatively correct, we must assume the largest possible
773 // constant is used in this position. This cannot be the initial
774 // index to the GEP instructions (because we know we have at least one
775 // element before this one with the different constant arguments), so
776 // we know that the current index must be into either a struct or
777 // array. Because we know it's not constant, this cannot be a
778 // structure index. Because of this, we can calculate the maximum
779 // value possible.
780 //
781 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
Owen Anderson50895512009-07-06 18:42:36 +0000782 GEP1Ops[i] =
Owen Andersone922c022009-07-22 00:24:57 +0000783 Context.getConstantInt(Type::Int64Ty,AT->getNumElements()-1);
Chris Lattner9907cb12007-11-06 05:58:42 +0000784 else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty))
Owen Anderson50895512009-07-06 18:42:36 +0000785 GEP1Ops[i] =
Owen Andersone922c022009-07-22 00:24:57 +0000786 Context.getConstantInt(Type::Int64Ty,VT->getNumElements()-1);
Chris Lattnerb307c882003-12-11 22:44:13 +0000787 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000788 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000789
Chris Lattnerb307c882003-12-11 22:44:13 +0000790 if (Op2) {
791 if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
792 // If this is an array index, make sure the array element is in range.
Chris Lattnerf88380b2007-12-09 07:35:13 +0000793 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr2Ty)) {
Reid Spencerb83eb642006-10-20 07:07:24 +0000794 if (Op2C->getZExtValue() >= AT->getNumElements())
Chris Lattnerb307c882003-12-11 22:44:13 +0000795 return MayAlias; // Be conservative with out-of-range accesses
Chris Lattnerf88380b2007-12-09 07:35:13 +0000796 } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr2Ty)) {
Chris Lattner9907cb12007-11-06 05:58:42 +0000797 if (Op2C->getZExtValue() >= VT->getNumElements())
Chris Lattner7765d712006-11-03 21:58:48 +0000798 return MayAlias; // Be conservative with out-of-range accesses
799 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000800 } else { // Conservatively assume the minimum value for this index
Owen Andersone922c022009-07-22 00:24:57 +0000801 GEP2Ops[i] = Context.getNullValue(Op2->getType());
Chris Lattnerb307c882003-12-11 22:44:13 +0000802 }
Chris Lattner920bd792003-06-02 05:42:39 +0000803 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000804 }
805
806 if (BasePtr1Ty && Op1) {
807 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
808 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
809 else
810 BasePtr1Ty = 0;
811 }
812
813 if (BasePtr2Ty && Op2) {
814 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
815 BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
816 else
817 BasePtr2Ty = 0;
Chris Lattnerd501c132003-02-26 19:41:54 +0000818 }
819 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000820
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000821 if (GEPPointerTy->getElementType()->isSized()) {
Chris Lattner829621c2007-02-10 20:35:22 +0000822 int64_t Offset1 =
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000823 getTargetData().getIndexedOffset(GEPPointerTy, GEP1Ops, NumGEP1Ops);
Chris Lattner829621c2007-02-10 20:35:22 +0000824 int64_t Offset2 =
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000825 getTargetData().getIndexedOffset(GEPPointerTy, GEP2Ops, NumGEP2Ops);
Chris Lattner9907cb12007-11-06 05:58:42 +0000826 assert(Offset1 != Offset2 &&
827 "There is at least one different constant here!");
828
829 // Make sure we compare the absolute difference.
830 if (Offset1 > Offset2)
831 std::swap(Offset1, Offset2);
832
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000833 if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000834 //cerr << "Determined that these two GEP's don't alias ["
835 // << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000836 return NoAlias;
837 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000838 }
839 return MayAlias;
840}
841
Reid Spencer4f1bd9e2006-06-07 22:00:26 +0000842// Make sure that anything that uses AliasAnalysis pulls in this file...
843DEFINING_FILE_FOR(BasicAliasAnalysis)