blob: 762fef1d60518d2ce60eb43ec89298505ad600a7 [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//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source 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"
Jeff Cohen534927d2005-01-08 22:01:16 +000017#include "llvm/Analysis/Passes.h"
Chris Lattner4244bb52004-03-15 03:36:49 +000018#include "llvm/Constants.h"
19#include "llvm/DerivedTypes.h"
20#include "llvm/Function.h"
21#include "llvm/GlobalVariable.h"
Alkis Evlogimenoseb62bc72004-07-29 12:17:34 +000022#include "llvm/Instructions.h"
Chris Lattner4244bb52004-03-15 03:36:49 +000023#include "llvm/Pass.h"
Chris Lattnerd501c132003-02-26 19:41:54 +000024#include "llvm/Target/TargetData.h"
Chris Lattnera77600e2007-02-10 22:15:31 +000025#include "llvm/ADT/SmallVector.h"
Chris Lattnera4f0b3a2006-08-27 12:54:02 +000026#include "llvm/Support/Compiler.h"
Chris Lattner90aa8392006-10-04 21:52:35 +000027#include "llvm/Support/GetElementPtrTypeIterator.h"
28#include "llvm/Support/ManagedStatic.h"
Alkis Evlogimenos20aa4742004-09-03 18:19:51 +000029#include <algorithm>
Chris Lattnerec4e8082003-11-25 18:33:40 +000030using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000031
Chris Lattnerd501c132003-02-26 19:41:54 +000032namespace {
Chris Lattnerb52f4402004-05-23 21:15:12 +000033 /// NoAA - This class implements the -no-aa pass, which always returns "I
34 /// don't know" for alias queries. NoAA is unlike other alias analysis
35 /// implementations, in that it does not chain to a previous analysis. As
36 /// such it doesn't follow many of the rules that other alias analyses must.
37 ///
Chris Lattner95255282006-06-28 23:17:24 +000038 struct VISIBILITY_HIDDEN NoAA : public ImmutablePass, public AliasAnalysis {
Devang Patel19974732007-05-03 01:11:54 +000039 static char ID; // Class identification, replacement for typeinfo
Devang Patel794fd752007-05-01 21:15:47 +000040 NoAA() : ImmutablePass((intptr_t)&ID) {}
Anton Korobeynikov03265f92007-06-18 17:13:29 +000041 NoAA(intptr_t PID) : ImmutablePass(PID) { }
Devang Patel794fd752007-05-01 21:15:47 +000042
Chris Lattner689835a2004-06-19 08:05:58 +000043 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
44 AU.addRequired<TargetData>();
45 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +000046
Chris Lattner689835a2004-06-19 08:05:58 +000047 virtual void initializePass() {
48 TD = &getAnalysis<TargetData>();
49 }
50
Chris Lattnerb52f4402004-05-23 21:15:12 +000051 virtual AliasResult alias(const Value *V1, unsigned V1Size,
52 const Value *V2, unsigned V2Size) {
53 return MayAlias;
54 }
55
Chris Lattner5226f6a2004-12-15 17:13:24 +000056 virtual ModRefBehavior getModRefBehavior(Function *F, CallSite CS,
57 std::vector<PointerAccessInfo> *Info) {
Chris Lattner0af024c2004-12-15 07:22:13 +000058 return UnknownModRefBehavior;
59 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +000060
Chris Lattner0af024c2004-12-15 07:22:13 +000061 virtual void getArgumentAccesses(Function *F, CallSite CS,
62 std::vector<PointerAccessInfo> &Info) {
63 assert(0 && "This method may not be called on this function!");
64 }
65
Chris Lattnerb52f4402004-05-23 21:15:12 +000066 virtual void getMustAliases(Value *P, std::vector<Value*> &RetVals) { }
67 virtual bool pointsToConstantMemory(const Value *P) { return false; }
Chris Lattnerb52f4402004-05-23 21:15:12 +000068 virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
69 return ModRef;
70 }
71 virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
72 return ModRef;
73 }
74 virtual bool hasNoModRefInfoForCalls() const { return true; }
75
76 virtual void deleteValue(Value *V) {}
77 virtual void copyValue(Value *From, Value *To) {}
Chris Lattnerb52f4402004-05-23 21:15:12 +000078 };
Misha Brukman2b37d7c2005-04-21 21:13:18 +000079
Chris Lattnerb52f4402004-05-23 21:15:12 +000080 // Register this pass...
Devang Patel19974732007-05-03 01:11:54 +000081 char NoAA::ID = 0;
Chris Lattner7f8897f2006-08-27 22:42:52 +000082 RegisterPass<NoAA>
Chris Lattnerb52f4402004-05-23 21:15:12 +000083 U("no-aa", "No Alias Analysis (always returns 'may' alias)");
84
85 // Declare that we implement the AliasAnalysis interface
Chris Lattnera5370172006-08-28 00:42:29 +000086 RegisterAnalysisGroup<AliasAnalysis> V(U);
Chris Lattnerb52f4402004-05-23 21:15:12 +000087} // End of anonymous namespace
88
Jeff Cohen534927d2005-01-08 22:01:16 +000089ImmutablePass *llvm::createNoAAPass() { return new NoAA(); }
Chris Lattnerb52f4402004-05-23 21:15:12 +000090
91namespace {
92 /// BasicAliasAnalysis - This is the default alias analysis implementation.
93 /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
94 /// derives from the NoAA class.
Chris Lattner95255282006-06-28 23:17:24 +000095 struct VISIBILITY_HIDDEN BasicAliasAnalysis : public NoAA {
Devang Patel19974732007-05-03 01:11:54 +000096 static char ID; // Class identification, replacement for typeinfo
Anton Korobeynikov03265f92007-06-18 17:13:29 +000097 BasicAliasAnalysis() : NoAA((intptr_t)&ID) { }
Chris Lattnerd501c132003-02-26 19:41:54 +000098 AliasResult alias(const Value *V1, unsigned V1Size,
99 const Value *V2, unsigned V2Size);
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000100
Chris Lattner04b75932004-03-12 22:39:00 +0000101 ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
Reid Spencer4a7ebfa2004-12-07 08:11:24 +0000102 ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
103 return NoAA::getModRefInfo(CS1,CS2);
104 }
Chris Lattner04b75932004-03-12 22:39:00 +0000105
Chris Lattnere181b942004-07-27 02:13:55 +0000106 /// hasNoModRefInfoForCalls - We can provide mod/ref information against
107 /// non-escaping allocations.
108 virtual bool hasNoModRefInfoForCalls() const { return false; }
Chris Lattner65585aa2004-04-11 16:43:07 +0000109
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000110 /// pointsToConstantMemory - Chase pointers until we find a (constant
111 /// global) or not.
112 bool pointsToConstantMemory(const Value *P);
113
Chris Lattner0af024c2004-12-15 07:22:13 +0000114 virtual ModRefBehavior getModRefBehavior(Function *F, CallSite CS,
Chris Lattner241607d2007-01-14 05:57:53 +0000115 std::vector<PointerAccessInfo> *Info);
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000116
Chris Lattnerd501c132003-02-26 19:41:54 +0000117 private:
Chris Lattnerb307c882003-12-11 22:44:13 +0000118 // CheckGEPInstructions - Check two GEP instructions with known
119 // must-aliasing base pointers. This checks to see if the index expressions
Chris Lattnerd501c132003-02-26 19:41:54 +0000120 // preclude the pointers from aliasing...
Chris Lattnerb307c882003-12-11 22:44:13 +0000121 AliasResult
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000122 CheckGEPInstructions(const Type* BasePtr1Ty,
123 Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1Size,
124 const Type *BasePtr2Ty,
125 Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000126 };
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000127
Chris Lattnerd501c132003-02-26 19:41:54 +0000128 // Register this pass...
Devang Patel19974732007-05-03 01:11:54 +0000129 char BasicAliasAnalysis::ID = 0;
Chris Lattner7f8897f2006-08-27 22:42:52 +0000130 RegisterPass<BasicAliasAnalysis>
Chris Lattnerd501c132003-02-26 19:41:54 +0000131 X("basicaa", "Basic Alias Analysis (default AA impl)");
132
133 // Declare that we implement the AliasAnalysis interface
Chris Lattnera5370172006-08-28 00:42:29 +0000134 RegisterAnalysisGroup<AliasAnalysis, true> Y(X);
Chris Lattnerd501c132003-02-26 19:41:54 +0000135} // End of anonymous namespace
136
Jeff Cohen534927d2005-01-08 22:01:16 +0000137ImmutablePass *llvm::createBasicAliasAnalysisPass() {
138 return new BasicAliasAnalysis();
139}
140
Chris Lattnerc1820032003-09-20 03:08:47 +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, a
143// unique object or an argument, return it.
Chris Lattnerd501c132003-02-26 19:41:54 +0000144static const Value *getUnderlyingObject(const Value *V) {
145 if (!isa<PointerType>(V->getType())) return 0;
146
Reid Spencer3da59db2006-11-27 01:05:10 +0000147 // If we are at some type of object, return it. GlobalValues and Allocations
148 // have unique addresses.
149 if (isa<GlobalValue>(V) || isa<AllocationInst>(V) || isa<Argument>(V))
150 return V;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000151
Chris Lattnerd501c132003-02-26 19:41:54 +0000152 // Traverse through different addressing mechanisms...
153 if (const Instruction *I = dyn_cast<Instruction>(V)) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000154 if (isa<BitCastInst>(I) || isa<GetElementPtrInst>(I))
Chris Lattnerd501c132003-02-26 19:41:54 +0000155 return getUnderlyingObject(I->getOperand(0));
Chris Lattner388f6692003-06-17 15:25:37 +0000156 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000157 if (CE->getOpcode() == Instruction::BitCast ||
Chris Lattner388f6692003-06-17 15:25:37 +0000158 CE->getOpcode() == Instruction::GetElementPtr)
159 return getUnderlyingObject(CE->getOperand(0));
Chris Lattnerd501c132003-02-26 19:41:54 +0000160 }
161 return 0;
162}
163
Chris Lattnerb307c882003-12-11 22:44:13 +0000164static const User *isGEP(const Value *V) {
165 if (isa<GetElementPtrInst>(V) ||
166 (isa<ConstantExpr>(V) &&
167 cast<ConstantExpr>(V)->getOpcode() == Instruction::GetElementPtr))
168 return cast<User>(V);
169 return 0;
170}
Chris Lattnerd501c132003-02-26 19:41:54 +0000171
Chris Lattnera77600e2007-02-10 22:15:31 +0000172static const Value *GetGEPOperands(const Value *V,
173 SmallVector<Value*, 16> &GEPOps){
Chris Lattner4a830882003-12-11 23:20:16 +0000174 assert(GEPOps.empty() && "Expect empty list to populate!");
175 GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
176 cast<User>(V)->op_end());
177
178 // Accumulate all of the chained indexes into the operand array
179 V = cast<User>(V)->getOperand(0);
180
181 while (const User *G = isGEP(V)) {
Reid Spencere8404342004-07-18 00:18:30 +0000182 if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
Chris Lattner4a830882003-12-11 23:20:16 +0000183 !cast<Constant>(GEPOps[0])->isNullValue())
184 break; // Don't handle folding arbitrary pointer offsets yet...
185 GEPOps.erase(GEPOps.begin()); // Drop the zero index
186 GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
187 V = G->getOperand(0);
188 }
189 return V;
190}
191
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000192/// pointsToConstantMemory - Chase pointers until we find a (constant
193/// global) or not.
194bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
Chris Lattnera4dd6742004-01-30 22:48:02 +0000195 if (const Value *V = getUnderlyingObject(P))
196 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
197 return GV->isConstant();
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000198 return false;
199}
Chris Lattner4a830882003-12-11 23:20:16 +0000200
Reid Spencer3da59db2006-11-27 01:05:10 +0000201// Determine if an AllocationInst instruction escapes from the function it is
202// contained in. If it does not escape, there is no way for another function to
203// mod/ref it. We do this by looking at its uses and determining if the uses
204// can escape (recursively).
Chris Lattner04b75932004-03-12 22:39:00 +0000205static bool AddressMightEscape(const Value *V) {
206 for (Value::use_const_iterator UI = V->use_begin(), E = V->use_end();
207 UI != E; ++UI) {
208 const Instruction *I = cast<Instruction>(*UI);
209 switch (I->getOpcode()) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000210 case Instruction::Load:
211 break; //next use.
Chris Lattner04b75932004-03-12 22:39:00 +0000212 case Instruction::Store:
213 if (I->getOperand(0) == V)
214 return true; // Escapes if the pointer is stored.
Reid Spencer3da59db2006-11-27 01:05:10 +0000215 break; // next use.
Chris Lattner04b75932004-03-12 22:39:00 +0000216 case Instruction::GetElementPtr:
Reid Spencer3da59db2006-11-27 01:05:10 +0000217 if (AddressMightEscape(I))
218 return true;
219 case Instruction::BitCast:
Chris Lattner04b75932004-03-12 22:39:00 +0000220 if (!isa<PointerType>(I->getType()))
221 return true;
Reid Spencer3da59db2006-11-27 01:05:10 +0000222 if (AddressMightEscape(I))
223 return true;
224 break; // next use
Chris Lattnerdb5b80a2004-07-27 02:18:52 +0000225 case Instruction::Ret:
226 // If returned, the address will escape to calling functions, but no
227 // callees could modify it.
Reid Spencer3da59db2006-11-27 01:05:10 +0000228 break; // next use
Chris Lattner04b75932004-03-12 22:39:00 +0000229 default:
230 return true;
231 }
232 }
233 return false;
234}
235
236// getModRefInfo - Check to see if the specified callsite can clobber the
237// specified memory object. Since we only look at local properties of this
238// function, we really can't say much about this query. We do, however, use
239// simple "address taken" analysis on local objects.
240//
241AliasAnalysis::ModRefResult
242BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
Reid Spencere8404342004-07-18 00:18:30 +0000243 if (!isa<Constant>(P))
Chris Lattner04b75932004-03-12 22:39:00 +0000244 if (const AllocationInst *AI =
Chris Lattner7a82ba02004-03-12 23:12:55 +0000245 dyn_cast_or_null<AllocationInst>(getUnderlyingObject(P))) {
Chris Lattner04b75932004-03-12 22:39:00 +0000246 // Okay, the pointer is to a stack allocated object. If we can prove that
247 // the pointer never "escapes", then we know the call cannot clobber it,
248 // because it simply can't get its address.
249 if (!AddressMightEscape(AI))
250 return NoModRef;
Chris Lattner42e3c812005-05-08 23:58:12 +0000251
252 // If this is a tail call and P points to a stack location, we know that
253 // the tail call cannot access or modify the local stack.
254 if (CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
255 if (CI->isTailCall() && isa<AllocaInst>(AI))
256 return NoModRef;
Chris Lattner04b75932004-03-12 22:39:00 +0000257 }
258
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000259 // The AliasAnalysis base class has some smarts, lets use them.
260 return AliasAnalysis::getModRefInfo(CS, P, Size);
Chris Lattner04b75932004-03-12 22:39:00 +0000261}
262
Chris Lattnerd501c132003-02-26 19:41:54 +0000263// alias - Provide a bunch of ad-hoc rules to disambiguate in common cases, such
264// as array references. Note that this function is heavily tail recursive.
265// Hopefully we have a smart C++ compiler. :)
266//
267AliasAnalysis::AliasResult
268BasicAliasAnalysis::alias(const Value *V1, unsigned V1Size,
269 const Value *V2, unsigned V2Size) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000270 // Strip off any constant expression casts if they exist
271 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V1))
Reid Spencer3da59db2006-11-27 01:05:10 +0000272 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000273 V1 = CE->getOperand(0);
274 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V2))
Reid Spencer3da59db2006-11-27 01:05:10 +0000275 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000276 V2 = CE->getOperand(0);
277
Chris Lattnerd501c132003-02-26 19:41:54 +0000278 // Are we checking for alias of the same value?
279 if (V1 == V2) return MustAlias;
280
281 if ((!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType())) &&
Reid Spencerc5b206b2006-12-31 05:48:39 +0000282 V1->getType() != Type::Int64Ty && V2->getType() != Type::Int64Ty)
Chris Lattnerd501c132003-02-26 19:41:54 +0000283 return NoAlias; // Scalars cannot alias each other
284
285 // Strip off cast instructions...
Reid Spencer3da59db2006-11-27 01:05:10 +0000286 if (const BitCastInst *I = dyn_cast<BitCastInst>(V1))
Chris Lattner241607d2007-01-14 05:57:53 +0000287 return alias(I->getOperand(0), V1Size, V2, V2Size);
Reid Spencer3da59db2006-11-27 01:05:10 +0000288 if (const BitCastInst *I = dyn_cast<BitCastInst>(V2))
Chris Lattner241607d2007-01-14 05:57:53 +0000289 return alias(V1, V1Size, I->getOperand(0), V2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000290
291 // Figure out what objects these things are pointing to if we can...
292 const Value *O1 = getUnderlyingObject(V1);
293 const Value *O2 = getUnderlyingObject(V2);
294
Misha Brukman2f2d0652003-09-11 18:14:24 +0000295 // Pointing at a discernible object?
Chris Lattner0a1ac902004-11-26 19:20:01 +0000296 if (O1) {
297 if (O2) {
298 if (isa<Argument>(O1)) {
299 // Incoming argument cannot alias locally allocated object!
300 if (isa<AllocationInst>(O2)) return NoAlias;
301 // Otherwise, nothing is known...
302 } else if (isa<Argument>(O2)) {
303 // Incoming argument cannot alias locally allocated object!
304 if (isa<AllocationInst>(O1)) return NoAlias;
305 // Otherwise, nothing is known...
306 } else if (O1 != O2) {
307 // If they are two different objects, we know that we have no alias...
308 return NoAlias;
309 }
310
311 // If they are the same object, they we can look at the indexes. If they
312 // index off of the object is the same for both pointers, they must alias.
313 // If they are provably different, they must not alias. Otherwise, we
314 // can't tell anything.
Chris Lattnerc1820032003-09-20 03:08:47 +0000315 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000316
Chris Lattner0a1ac902004-11-26 19:20:01 +0000317
318 if (!isa<Argument>(O1) && isa<ConstantPointerNull>(V2))
319 return NoAlias; // Unique values don't alias null
320
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000321 if (isa<GlobalVariable>(O1) ||
Chris Lattner50bc9ef2005-03-09 16:29:52 +0000322 (isa<AllocationInst>(O1) &&
323 !cast<AllocationInst>(O1)->isArrayAllocation()))
Chris Lattner4e616762004-11-26 20:01:48 +0000324 if (cast<PointerType>(O1->getType())->getElementType()->isSized()) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000325 // If the size of the other access is larger than the total size of the
Chris Lattner4e616762004-11-26 20:01:48 +0000326 // global/alloca/malloc, it cannot be accessing the global (it's
327 // undefined to load or store bytes before or after an object).
328 const Type *ElTy = cast<PointerType>(O1->getType())->getElementType();
329 unsigned GlobalSize = getTargetData().getTypeSize(ElTy);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000330 if (GlobalSize < V2Size && V2Size != ~0U)
Chris Lattner0a1ac902004-11-26 19:20:01 +0000331 return NoAlias;
332 }
333 }
334
335 if (O2) {
336 if (!isa<Argument>(O2) && isa<ConstantPointerNull>(V1))
337 return NoAlias; // Unique values don't alias null
338
Chris Lattner50bc9ef2005-03-09 16:29:52 +0000339 if (isa<GlobalVariable>(O2) ||
340 (isa<AllocationInst>(O2) &&
341 !cast<AllocationInst>(O2)->isArrayAllocation()))
Chris Lattner4e616762004-11-26 20:01:48 +0000342 if (cast<PointerType>(O2->getType())->getElementType()->isSized()) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000343 // If the size of the other access is larger than the total size of the
Chris Lattner4e616762004-11-26 20:01:48 +0000344 // global/alloca/malloc, it cannot be accessing the object (it's
345 // undefined to load or store bytes before or after an object).
346 const Type *ElTy = cast<PointerType>(O2->getType())->getElementType();
347 unsigned GlobalSize = getTargetData().getTypeSize(ElTy);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000348 if (GlobalSize < V1Size && V1Size != ~0U)
Chris Lattner0a1ac902004-11-26 19:20:01 +0000349 return NoAlias;
350 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000351 }
352
Chris Lattnerb307c882003-12-11 22:44:13 +0000353 // If we have two gep instructions with must-alias'ing base pointers, figure
354 // out if the indexes to the GEP tell us anything about the derived pointer.
355 // Note that we also handle chains of getelementptr instructions as well as
356 // constant expression getelementptrs here.
Chris Lattnerd501c132003-02-26 19:41:54 +0000357 //
Chris Lattnerb307c882003-12-11 22:44:13 +0000358 if (isGEP(V1) && isGEP(V2)) {
359 // Drill down into the first non-gep value, to test for must-aliasing of
360 // the base pointers.
361 const Value *BasePtr1 = V1, *BasePtr2 = V2;
362 do {
363 BasePtr1 = cast<User>(BasePtr1)->getOperand(0);
364 } while (isGEP(BasePtr1) &&
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000365 cast<User>(BasePtr1)->getOperand(1) ==
Chris Lattnerb307c882003-12-11 22:44:13 +0000366 Constant::getNullValue(cast<User>(BasePtr1)->getOperand(1)->getType()));
367 do {
368 BasePtr2 = cast<User>(BasePtr2)->getOperand(0);
369 } while (isGEP(BasePtr2) &&
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000370 cast<User>(BasePtr2)->getOperand(1) ==
Chris Lattnerb307c882003-12-11 22:44:13 +0000371 Constant::getNullValue(cast<User>(BasePtr2)->getOperand(1)->getType()));
372
373 // Do the base pointers alias?
Chris Lattner241607d2007-01-14 05:57:53 +0000374 AliasResult BaseAlias = alias(BasePtr1, ~0U, BasePtr2, ~0U);
Chris Lattnerb307c882003-12-11 22:44:13 +0000375 if (BaseAlias == NoAlias) return NoAlias;
376 if (BaseAlias == MustAlias) {
377 // If the base pointers alias each other exactly, check to see if we can
378 // figure out anything about the resultant pointers, to try to prove
379 // non-aliasing.
380
381 // Collect all of the chained GEP operands together into one simple place
Chris Lattnera77600e2007-02-10 22:15:31 +0000382 SmallVector<Value*, 16> GEP1Ops, GEP2Ops;
Chris Lattner4a830882003-12-11 23:20:16 +0000383 BasePtr1 = GetGEPOperands(V1, GEP1Ops);
384 BasePtr2 = GetGEPOperands(V2, GEP2Ops);
Chris Lattnerb307c882003-12-11 22:44:13 +0000385
Chris Lattner730b1ad2004-07-29 07:56:39 +0000386 // If GetGEPOperands were able to fold to the same must-aliased pointer,
387 // do the comparison.
388 if (BasePtr1 == BasePtr2) {
389 AliasResult GAlias =
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000390 CheckGEPInstructions(BasePtr1->getType(),
391 &GEP1Ops[0], GEP1Ops.size(), V1Size,
392 BasePtr2->getType(),
393 &GEP2Ops[0], GEP2Ops.size(), V2Size);
Chris Lattner730b1ad2004-07-29 07:56:39 +0000394 if (GAlias != MayAlias)
395 return GAlias;
396 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000397 }
398 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000399
400 // Check to see if these two pointers are related by a getelementptr
401 // instruction. If one pointer is a GEP with a non-zero index of the other
402 // pointer, we know they cannot alias.
403 //
Chris Lattner4a830882003-12-11 23:20:16 +0000404 if (isGEP(V2)) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000405 std::swap(V1, V2);
406 std::swap(V1Size, V2Size);
407 }
408
Chris Lattnerc330ee62003-02-26 21:57:23 +0000409 if (V1Size != ~0U && V2Size != ~0U)
Reid Spencer3ed469c2006-11-02 20:25:50 +0000410 if (isGEP(V1)) {
Chris Lattnera77600e2007-02-10 22:15:31 +0000411 SmallVector<Value*, 16> GEPOperands;
Chris Lattner4a830882003-12-11 23:20:16 +0000412 const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
413
414 AliasResult R = alias(BasePtr, V1Size, V2, V2Size);
Chris Lattnerc330ee62003-02-26 21:57:23 +0000415 if (R == MustAlias) {
416 // If there is at least one non-zero constant index, we know they cannot
417 // alias.
418 bool ConstantFound = false;
Chris Lattner88d3e032003-12-11 06:02:00 +0000419 bool AllZerosFound = true;
Chris Lattner4a830882003-12-11 23:20:16 +0000420 for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
421 if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
Chris Lattnerc330ee62003-02-26 21:57:23 +0000422 if (!C->isNullValue()) {
423 ConstantFound = true;
Chris Lattnerc54735e2003-12-11 06:06:28 +0000424 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000425 break;
Chris Lattner88d3e032003-12-11 06:02:00 +0000426 }
427 } else {
428 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000429 }
Chris Lattner88d3e032003-12-11 06:02:00 +0000430
431 // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
432 // the ptr, the end result is a must alias also.
433 if (AllZerosFound)
434 return MustAlias;
435
Chris Lattnerc330ee62003-02-26 21:57:23 +0000436 if (ConstantFound) {
437 if (V2Size <= 1 && V1Size <= 1) // Just pointer check?
Chris Lattnerd501c132003-02-26 19:41:54 +0000438 return NoAlias;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000439
Chris Lattnerc330ee62003-02-26 21:57:23 +0000440 // Otherwise we have to check to see that the distance is more than
441 // the size of the argument... build an index vector that is equal to
442 // the arguments provided, except substitute 0's for any variable
443 // indexes we find...
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000444 if (cast<PointerType>(
445 BasePtr->getType())->getElementType()->isSized()) {
446 for (unsigned i = 0; i != GEPOperands.size(); ++i)
Chris Lattner0bb38312007-01-12 18:20:48 +0000447 if (!isa<ConstantInt>(GEPOperands[i]))
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000448 GEPOperands[i] =
449 Constant::getNullValue(GEPOperands[i]->getType());
450 int64_t Offset =
Chris Lattner829621c2007-02-10 20:35:22 +0000451 getTargetData().getIndexedOffset(BasePtr->getType(),
452 &GEPOperands[0],
453 GEPOperands.size());
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000454
455 if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
456 return NoAlias;
457 }
Chris Lattnerc330ee62003-02-26 21:57:23 +0000458 }
459 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000460 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000461
Chris Lattnerd501c132003-02-26 19:41:54 +0000462 return MayAlias;
463}
464
Reid Spencer3da59db2006-11-27 01:05:10 +0000465// This function is used to determin if the indices of two GEP instructions are
466// equal. V1 and V2 are the indices.
467static bool IndexOperandsEqual(Value *V1, Value *V2) {
Chris Lattner28977af2004-04-05 01:30:19 +0000468 if (V1->getType() == V2->getType())
469 return V1 == V2;
470 if (Constant *C1 = dyn_cast<Constant>(V1))
471 if (Constant *C2 = dyn_cast<Constant>(V2)) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000472 // Sign extend the constants to long types, if necessary
Reid Spencerc5b206b2006-12-31 05:48:39 +0000473 if (C1->getType() != Type::Int64Ty)
474 C1 = ConstantExpr::getSExt(C1, Type::Int64Ty);
475 if (C2->getType() != Type::Int64Ty)
476 C2 = ConstantExpr::getSExt(C2, Type::Int64Ty);
Chris Lattner28977af2004-04-05 01:30:19 +0000477 return C1 == C2;
478 }
479 return false;
480}
481
Chris Lattnerb307c882003-12-11 22:44:13 +0000482/// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
483/// base pointers. This checks to see if the index expressions preclude the
484/// pointers from aliasing...
Reid Spencerb83eb642006-10-20 07:07:24 +0000485AliasAnalysis::AliasResult
486BasicAliasAnalysis::CheckGEPInstructions(
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000487 const Type* BasePtr1Ty, Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1S,
488 const Type *BasePtr2Ty, Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2S) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000489 // We currently can't handle the case when the base pointers have different
490 // primitive types. Since this is uncommon anyway, we are happy being
491 // extremely conservative.
492 if (BasePtr1Ty != BasePtr2Ty)
493 return MayAlias;
494
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000495 const PointerType *GEPPointerTy = cast<PointerType>(BasePtr1Ty);
Chris Lattnerb307c882003-12-11 22:44:13 +0000496
497 // Find the (possibly empty) initial sequence of equal values... which are not
498 // necessarily constants.
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000499 unsigned NumGEP1Operands = NumGEP1Ops, NumGEP2Operands = NumGEP2Ops;
Chris Lattnerb307c882003-12-11 22:44:13 +0000500 unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
501 unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
502 unsigned UnequalOper = 0;
503 while (UnequalOper != MinOperands &&
Reid Spencer3da59db2006-11-27 01:05:10 +0000504 IndexOperandsEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper])) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000505 // Advance through the type as we go...
506 ++UnequalOper;
507 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
508 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
509 else {
510 // If all operands equal each other, then the derived pointers must
511 // alias each other...
512 BasePtr1Ty = 0;
513 assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
514 "Ran out of type nesting, but not out of operands?");
515 return MustAlias;
Chris Lattner920bd792003-06-02 05:42:39 +0000516 }
517 }
Chris Lattner920bd792003-06-02 05:42:39 +0000518
Chris Lattnerb307c882003-12-11 22:44:13 +0000519 // If we have seen all constant operands, and run out of indexes on one of the
520 // getelementptrs, check to see if the tail of the leftover one is all zeros.
521 // If so, return mustalias.
Chris Lattner4a830882003-12-11 23:20:16 +0000522 if (UnequalOper == MinOperands) {
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000523 if (NumGEP1Ops < NumGEP2Ops) {
524 std::swap(GEP1Ops, GEP2Ops);
525 std::swap(NumGEP1Ops, NumGEP2Ops);
526 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000527
Chris Lattnerb307c882003-12-11 22:44:13 +0000528 bool AllAreZeros = true;
529 for (unsigned i = UnequalOper; i != MaxOperands; ++i)
Chris Lattnera35339d2004-10-16 16:07:10 +0000530 if (!isa<Constant>(GEP1Ops[i]) ||
Chris Lattnerb307c882003-12-11 22:44:13 +0000531 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
532 AllAreZeros = false;
533 break;
534 }
535 if (AllAreZeros) return MustAlias;
536 }
537
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000538
Chris Lattnerd501c132003-02-26 19:41:54 +0000539 // So now we know that the indexes derived from the base pointers,
540 // which are known to alias, are different. We can still determine a
541 // no-alias result if there are differing constant pairs in the index
542 // chain. For example:
543 // A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
544 //
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000545 // We have to be careful here about array accesses. In particular, consider:
546 // A[1][0] vs A[0][i]
547 // In this case, we don't *know* that the array will be accessed in bounds:
548 // the index could even be negative. Because of this, we have to
549 // conservatively *give up* and return may alias. We disregard differing
550 // array subscripts that are followed by a variable index without going
551 // through a struct.
552 //
Chris Lattnerd501c132003-02-26 19:41:54 +0000553 unsigned SizeMax = std::max(G1S, G2S);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000554 if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work.
Chris Lattner920bd792003-06-02 05:42:39 +0000555
Chris Lattnerd501c132003-02-26 19:41:54 +0000556 // Scan for the first operand that is constant and unequal in the
Chris Lattner28977af2004-04-05 01:30:19 +0000557 // two getelementptrs...
Chris Lattnerd501c132003-02-26 19:41:54 +0000558 unsigned FirstConstantOper = UnequalOper;
Chris Lattnerb307c882003-12-11 22:44:13 +0000559 for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
560 const Value *G1Oper = GEP1Ops[FirstConstantOper];
561 const Value *G2Oper = GEP2Ops[FirstConstantOper];
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000562
Chris Lattner6eb88d42004-01-12 17:57:32 +0000563 if (G1Oper != G2Oper) // Found non-equal constant indexes...
Chris Lattnera35339d2004-10-16 16:07:10 +0000564 if (Constant *G1OC = dyn_cast<ConstantInt>(const_cast<Value*>(G1Oper)))
565 if (Constant *G2OC = dyn_cast<ConstantInt>(const_cast<Value*>(G2Oper))){
Chris Lattner28977af2004-04-05 01:30:19 +0000566 if (G1OC->getType() != G2OC->getType()) {
567 // Sign extend both operands to long.
Reid Spencerc5b206b2006-12-31 05:48:39 +0000568 if (G1OC->getType() != Type::Int64Ty)
569 G1OC = ConstantExpr::getSExt(G1OC, Type::Int64Ty);
570 if (G2OC->getType() != Type::Int64Ty)
571 G2OC = ConstantExpr::getSExt(G2OC, Type::Int64Ty);
Chris Lattner28977af2004-04-05 01:30:19 +0000572 GEP1Ops[FirstConstantOper] = G1OC;
573 GEP2Ops[FirstConstantOper] = G2OC;
574 }
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000575
Chris Lattner28977af2004-04-05 01:30:19 +0000576 if (G1OC != G2OC) {
Chris Lattner7765d712006-11-03 21:58:48 +0000577 // Handle the "be careful" case above: if this is an array/packed
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000578 // subscript, scan for a subsequent variable array index.
Chris Lattner7765d712006-11-03 21:58:48 +0000579 if (isa<SequentialType>(BasePtr1Ty)) {
580 const Type *NextTy =
581 cast<SequentialType>(BasePtr1Ty)->getElementType();
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000582 bool isBadCase = false;
583
584 for (unsigned Idx = FirstConstantOper+1;
Chris Lattner7765d712006-11-03 21:58:48 +0000585 Idx != MinOperands && isa<SequentialType>(NextTy); ++Idx) {
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000586 const Value *V1 = GEP1Ops[Idx], *V2 = GEP2Ops[Idx];
587 if (!isa<Constant>(V1) || !isa<Constant>(V2)) {
588 isBadCase = true;
589 break;
590 }
Chris Lattner7765d712006-11-03 21:58:48 +0000591 NextTy = cast<SequentialType>(NextTy)->getElementType();
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000592 }
593
594 if (isBadCase) G1OC = 0;
595 }
596
Chris Lattnera35339d2004-10-16 16:07:10 +0000597 // Make sure they are comparable (ie, not constant expressions), and
598 // make sure the GEP with the smaller leading constant is GEP1.
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000599 if (G1OC) {
Reid Spencere4d87aa2006-12-23 06:05:41 +0000600 Constant *Compare = ConstantExpr::getICmp(ICmpInst::ICMP_SGT,
601 G1OC, G2OC);
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +0000602 if (ConstantInt *CV = dyn_cast<ConstantInt>(Compare)) {
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000603 if (CV->getZExtValue()) { // If they are comparable and G2 > G1
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000604 std::swap(GEP1Ops, GEP2Ops); // Make GEP1 < GEP2
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000605 std::swap(NumGEP1Ops, NumGEP2Ops);
606 }
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000607 break;
608 }
Chris Lattner28977af2004-04-05 01:30:19 +0000609 }
Chris Lattner6eb88d42004-01-12 17:57:32 +0000610 }
611 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000612 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
Chris Lattnerd501c132003-02-26 19:41:54 +0000613 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000614
Chris Lattnerb307c882003-12-11 22:44:13 +0000615 // No shared constant operands, and we ran out of common operands. At this
616 // point, the GEP instructions have run through all of their operands, and we
617 // haven't found evidence that there are any deltas between the GEP's.
618 // However, one GEP may have more operands than the other. If this is the
Chris Lattner28977af2004-04-05 01:30:19 +0000619 // case, there may still be hope. Check this now.
Chris Lattnerb307c882003-12-11 22:44:13 +0000620 if (FirstConstantOper == MinOperands) {
621 // Make GEP1Ops be the longer one if there is a longer one.
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000622 if (NumGEP1Ops < NumGEP2Ops) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000623 std::swap(GEP1Ops, GEP2Ops);
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000624 std::swap(NumGEP1Ops, NumGEP2Ops);
625 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000626
627 // Is there anything to check?
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000628 if (NumGEP1Ops > MinOperands) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000629 for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +0000630 if (isa<ConstantInt>(GEP1Ops[i]) &&
Zhou Sheng843f07672007-04-19 05:39:12 +0000631 !cast<ConstantInt>(GEP1Ops[i])->isZero()) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000632 // Yup, there's a constant in the tail. Set all variables to
633 // constants in the GEP instruction to make it suiteable for
634 // TargetData::getIndexedOffset.
635 for (i = 0; i != MaxOperands; ++i)
Chris Lattner0bb38312007-01-12 18:20:48 +0000636 if (!isa<ConstantInt>(GEP1Ops[i]))
Chris Lattnerb307c882003-12-11 22:44:13 +0000637 GEP1Ops[i] = Constant::getNullValue(GEP1Ops[i]->getType());
638 // Okay, now get the offset. This is the relative offset for the full
639 // instruction.
640 const TargetData &TD = getTargetData();
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000641 int64_t Offset1 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
642 NumGEP1Ops);
Chris Lattnerb307c882003-12-11 22:44:13 +0000643
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000644 // Now check without any constants at the end.
645 int64_t Offset2 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
646 MinOperands);
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000647
Chris Lattnerb307c882003-12-11 22:44:13 +0000648 // If the tail provided a bit enough offset, return noalias!
649 if ((uint64_t)(Offset2-Offset1) >= SizeMax)
650 return NoAlias;
651 }
652 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000653
Chris Lattnerb307c882003-12-11 22:44:13 +0000654 // Couldn't find anything useful.
655 return MayAlias;
656 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000657
658 // If there are non-equal constants arguments, then we can figure
659 // out a minimum known delta between the two index expressions... at
660 // this point we know that the first constant index of GEP1 is less
661 // than the first constant index of GEP2.
Chris Lattner1af55e12003-11-25 20:10:07 +0000662
Chris Lattnerb307c882003-12-11 22:44:13 +0000663 // Advance BasePtr[12]Ty over this first differing constant operand.
Chris Lattner2cfdd282006-03-04 21:48:01 +0000664 BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->
665 getTypeAtIndex(GEP2Ops[FirstConstantOper]);
666 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->
667 getTypeAtIndex(GEP1Ops[FirstConstantOper]);
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000668
Chris Lattnerb307c882003-12-11 22:44:13 +0000669 // We are going to be using TargetData::getIndexedOffset to determine the
670 // offset that each of the GEP's is reaching. To do this, we have to convert
671 // all variable references to constant references. To do this, we convert the
Chris Lattner2cfdd282006-03-04 21:48:01 +0000672 // initial sequence of array subscripts into constant zeros to start with.
673 const Type *ZeroIdxTy = GEPPointerTy;
674 for (unsigned i = 0; i != FirstConstantOper; ++i) {
675 if (!isa<StructType>(ZeroIdxTy))
Reid Spencerc5b206b2006-12-31 05:48:39 +0000676 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Type::Int32Ty);
Chris Lattnerb307c882003-12-11 22:44:13 +0000677
Chris Lattner2cfdd282006-03-04 21:48:01 +0000678 if (const CompositeType *CT = dyn_cast<CompositeType>(ZeroIdxTy))
679 ZeroIdxTy = CT->getTypeAtIndex(GEP1Ops[i]);
680 }
681
Chris Lattnerb307c882003-12-11 22:44:13 +0000682 // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000683
Chris Lattnerd501c132003-02-26 19:41:54 +0000684 // Loop over the rest of the operands...
Chris Lattnerb307c882003-12-11 22:44:13 +0000685 for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000686 const Value *Op1 = i < NumGEP1Ops ? GEP1Ops[i] : 0;
687 const Value *Op2 = i < NumGEP2Ops ? GEP2Ops[i] : 0;
Chris Lattnerb307c882003-12-11 22:44:13 +0000688 // If they are equal, use a zero index...
689 if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
Chris Lattner0bb38312007-01-12 18:20:48 +0000690 if (!isa<ConstantInt>(Op1))
Chris Lattnerb307c882003-12-11 22:44:13 +0000691 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Op1->getType());
692 // Otherwise, just keep the constants we have.
Chris Lattnerd501c132003-02-26 19:41:54 +0000693 } else {
Chris Lattnerb307c882003-12-11 22:44:13 +0000694 if (Op1) {
695 if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
696 // If this is an array index, make sure the array element is in range.
Chris Lattner7765d712006-11-03 21:58:48 +0000697 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty)) {
Reid Spencerb83eb642006-10-20 07:07:24 +0000698 if (Op1C->getZExtValue() >= AT->getNumElements())
Chris Lattnerb307c882003-12-11 22:44:13 +0000699 return MayAlias; // Be conservative with out-of-range accesses
Reid Spencer9d6565a2007-02-15 02:26:10 +0000700 } else if (const VectorType *PT = dyn_cast<VectorType>(BasePtr1Ty)) {
Chris Lattner7765d712006-11-03 21:58:48 +0000701 if (Op1C->getZExtValue() >= PT->getNumElements())
702 return MayAlias; // Be conservative with out-of-range accesses
703 }
704
Chris Lattnerb307c882003-12-11 22:44:13 +0000705 } else {
706 // GEP1 is known to produce a value less than GEP2. To be
707 // conservatively correct, we must assume the largest possible
708 // constant is used in this position. This cannot be the initial
709 // index to the GEP instructions (because we know we have at least one
710 // element before this one with the different constant arguments), so
711 // we know that the current index must be into either a struct or
712 // array. Because we know it's not constant, this cannot be a
713 // structure index. Because of this, we can calculate the maximum
714 // value possible.
715 //
716 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
Chris Lattner241607d2007-01-14 05:57:53 +0000717 GEP1Ops[i] = ConstantInt::get(Type::Int64Ty,AT->getNumElements()-1);
Reid Spencer9d6565a2007-02-15 02:26:10 +0000718 else if (const VectorType *PT = dyn_cast<VectorType>(BasePtr1Ty))
Chris Lattner241607d2007-01-14 05:57:53 +0000719 GEP1Ops[i] = ConstantInt::get(Type::Int64Ty,PT->getNumElements()-1);
Chris Lattner7765d712006-11-03 21:58:48 +0000720
Chris Lattnerb307c882003-12-11 22:44:13 +0000721 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000722 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000723
Chris Lattnerb307c882003-12-11 22:44:13 +0000724 if (Op2) {
725 if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
726 // If this is an array index, make sure the array element is in range.
Chris Lattner7765d712006-11-03 21:58:48 +0000727 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty)) {
Reid Spencerb83eb642006-10-20 07:07:24 +0000728 if (Op2C->getZExtValue() >= AT->getNumElements())
Chris Lattnerb307c882003-12-11 22:44:13 +0000729 return MayAlias; // Be conservative with out-of-range accesses
Reid Spencer9d6565a2007-02-15 02:26:10 +0000730 } else if (const VectorType *PT = dyn_cast<VectorType>(BasePtr1Ty)) {
Chris Lattner7765d712006-11-03 21:58:48 +0000731 if (Op2C->getZExtValue() >= PT->getNumElements())
732 return MayAlias; // Be conservative with out-of-range accesses
733 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000734 } else { // Conservatively assume the minimum value for this index
735 GEP2Ops[i] = Constant::getNullValue(Op2->getType());
736 }
Chris Lattner920bd792003-06-02 05:42:39 +0000737 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000738 }
739
740 if (BasePtr1Ty && Op1) {
741 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
742 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
743 else
744 BasePtr1Ty = 0;
745 }
746
747 if (BasePtr2Ty && Op2) {
748 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
749 BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
750 else
751 BasePtr2Ty = 0;
Chris Lattnerd501c132003-02-26 19:41:54 +0000752 }
753 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000754
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000755 if (GEPPointerTy->getElementType()->isSized()) {
Chris Lattner829621c2007-02-10 20:35:22 +0000756 int64_t Offset1 =
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000757 getTargetData().getIndexedOffset(GEPPointerTy, GEP1Ops, NumGEP1Ops);
Chris Lattner829621c2007-02-10 20:35:22 +0000758 int64_t Offset2 =
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000759 getTargetData().getIndexedOffset(GEPPointerTy, GEP2Ops, NumGEP2Ops);
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000760 assert(Offset1<Offset2 && "There is at least one different constant here!");
Chris Lattnerd501c132003-02-26 19:41:54 +0000761
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000762 if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000763 //cerr << "Determined that these two GEP's don't alias ["
764 // << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000765 return NoAlias;
766 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000767 }
768 return MayAlias;
769}
770
Chris Lattner4244bb52004-03-15 03:36:49 +0000771namespace {
Reid Spencerd7d83db2007-02-05 23:42:17 +0000772 struct VISIBILITY_HIDDEN StringCompare {
Chris Lattner4244bb52004-03-15 03:36:49 +0000773 bool operator()(const char *LHS, const char *RHS) {
774 return strcmp(LHS, RHS) < 0;
775 }
776 };
777}
778
779// Note that this list cannot contain libm functions (such as acos and sqrt)
780// that set errno on a domain or other error.
Chris Lattnercad25372006-03-09 22:31:29 +0000781static const char *DoesntAccessMemoryFns[] = {
Chris Lattner4244bb52004-03-15 03:36:49 +0000782 "abs", "labs", "llabs", "imaxabs", "fabs", "fabsf", "fabsl",
783 "trunc", "truncf", "truncl", "ldexp",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000784
Chris Lattner4244bb52004-03-15 03:36:49 +0000785 "atan", "atanf", "atanl", "atan2", "atan2f", "atan2l",
786 "cbrt",
Chris Lattner5b103c22005-04-28 21:52:31 +0000787 "cos", "cosf", "cosl",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000788 "exp", "expf", "expl",
Chris Lattner4244bb52004-03-15 03:36:49 +0000789 "hypot",
Chris Lattner5b103c22005-04-28 21:52:31 +0000790 "sin", "sinf", "sinl",
Chris Lattner4244bb52004-03-15 03:36:49 +0000791 "tan", "tanf", "tanl", "tanh", "tanhf", "tanhl",
Chris Lattnerab466d72005-08-24 16:58:56 +0000792
793 "floor", "floorf", "floorl", "ceil", "ceilf", "ceill",
Chris Lattner4244bb52004-03-15 03:36:49 +0000794
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000795 // ctype.h
Chris Lattner4244bb52004-03-15 03:36:49 +0000796 "isalnum", "isalpha", "iscntrl", "isdigit", "isgraph", "islower", "isprint"
797 "ispunct", "isspace", "isupper", "isxdigit", "tolower", "toupper",
798
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000799 // wctype.h"
Chris Lattner4244bb52004-03-15 03:36:49 +0000800 "iswalnum", "iswalpha", "iswcntrl", "iswdigit", "iswgraph", "iswlower",
801 "iswprint", "iswpunct", "iswspace", "iswupper", "iswxdigit",
802
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000803 "iswctype", "towctrans", "towlower", "towupper",
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000804
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000805 "btowc", "wctob",
Chris Lattner002be762004-03-16 03:41:35 +0000806
807 "isinf", "isnan", "finite",
808
809 // C99 math functions
810 "copysign", "copysignf", "copysignd",
811 "nexttoward", "nexttowardf", "nexttowardd",
812 "nextafter", "nextafterf", "nextafterd",
813
Andrew Lenharthd3513e02005-07-11 20:35:20 +0000814 // ISO C99:
Chris Lattner002be762004-03-16 03:41:35 +0000815 "__signbit", "__signbitf", "__signbitl",
Chris Lattner4244bb52004-03-15 03:36:49 +0000816};
817
Chris Lattner4244bb52004-03-15 03:36:49 +0000818
Chris Lattnercad25372006-03-09 22:31:29 +0000819static const char *OnlyReadsMemoryFns[] = {
Chris Lattner002be762004-03-16 03:41:35 +0000820 "atoi", "atol", "atof", "atoll", "atoq", "a64l",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000821 "bcmp", "memcmp", "memchr", "memrchr", "wmemcmp", "wmemchr",
Chris Lattner4244bb52004-03-15 03:36:49 +0000822
823 // Strings
824 "strcmp", "strcasecmp", "strcoll", "strncmp", "strncasecmp",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000825 "strchr", "strcspn", "strlen", "strpbrk", "strrchr", "strspn", "strstr",
Chris Lattner002be762004-03-16 03:41:35 +0000826 "index", "rindex",
Chris Lattner4244bb52004-03-15 03:36:49 +0000827
828 // Wide char strings
829 "wcschr", "wcscmp", "wcscoll", "wcscspn", "wcslen", "wcsncmp", "wcspbrk",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000830 "wcsrchr", "wcsspn", "wcsstr",
Chris Lattner002be762004-03-16 03:41:35 +0000831
832 // glibc
833 "alphasort", "alphasort64", "versionsort", "versionsort64",
834
835 // C99
836 "nan", "nanf", "nand",
Chris Lattnerb903fc52004-04-10 06:55:27 +0000837
838 // File I/O
839 "feof", "ferror", "fileno",
840 "feof_unlocked", "ferror_unlocked", "fileno_unlocked"
Chris Lattner4244bb52004-03-15 03:36:49 +0000841};
842
Chris Lattner90aa8392006-10-04 21:52:35 +0000843static ManagedStatic<std::vector<const char*> > NoMemoryTable;
844static ManagedStatic<std::vector<const char*> > OnlyReadsMemoryTable;
845
846
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000847AliasAnalysis::ModRefBehavior
Chris Lattner0af024c2004-12-15 07:22:13 +0000848BasicAliasAnalysis::getModRefBehavior(Function *F, CallSite CS,
849 std::vector<PointerAccessInfo> *Info) {
Reid Spencer5cbf9852007-01-30 20:08:39 +0000850 if (!F->isDeclaration()) return UnknownModRefBehavior;
Chris Lattner4244bb52004-03-15 03:36:49 +0000851
852 static bool Initialized = false;
853 if (!Initialized) {
Chris Lattner90aa8392006-10-04 21:52:35 +0000854 NoMemoryTable->insert(NoMemoryTable->end(),
855 DoesntAccessMemoryFns,
856 DoesntAccessMemoryFns+
Chris Lattnercad25372006-03-09 22:31:29 +0000857 sizeof(DoesntAccessMemoryFns)/sizeof(DoesntAccessMemoryFns[0]));
858
Chris Lattner90aa8392006-10-04 21:52:35 +0000859 OnlyReadsMemoryTable->insert(OnlyReadsMemoryTable->end(),
Chris Lattnercad25372006-03-09 22:31:29 +0000860 OnlyReadsMemoryFns,
861 OnlyReadsMemoryFns+
862 sizeof(OnlyReadsMemoryFns)/sizeof(OnlyReadsMemoryFns[0]));
863#define GET_MODREF_BEHAVIOR
864#include "llvm/Intrinsics.gen"
865#undef GET_MODREF_BEHAVIOR
866
Chris Lattner4244bb52004-03-15 03:36:49 +0000867 // Sort the table the first time through.
Chris Lattner90aa8392006-10-04 21:52:35 +0000868 std::sort(NoMemoryTable->begin(), NoMemoryTable->end(), StringCompare());
869 std::sort(OnlyReadsMemoryTable->begin(), OnlyReadsMemoryTable->end(),
Chris Lattner4244bb52004-03-15 03:36:49 +0000870 StringCompare());
871 Initialized = true;
872 }
873
Chris Lattnercad25372006-03-09 22:31:29 +0000874 std::vector<const char*>::iterator Ptr =
Chris Lattner90aa8392006-10-04 21:52:35 +0000875 std::lower_bound(NoMemoryTable->begin(), NoMemoryTable->end(),
Chris Lattnercad25372006-03-09 22:31:29 +0000876 F->getName().c_str(), StringCompare());
Chris Lattner90aa8392006-10-04 21:52:35 +0000877 if (Ptr != NoMemoryTable->end() && *Ptr == F->getName())
Chris Lattner0af024c2004-12-15 07:22:13 +0000878 return DoesNotAccessMemory;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000879
Chris Lattner90aa8392006-10-04 21:52:35 +0000880 Ptr = std::lower_bound(OnlyReadsMemoryTable->begin(),
881 OnlyReadsMemoryTable->end(),
Chris Lattner0af024c2004-12-15 07:22:13 +0000882 F->getName().c_str(), StringCompare());
Chris Lattner90aa8392006-10-04 21:52:35 +0000883 if (Ptr != OnlyReadsMemoryTable->end() && *Ptr == F->getName())
Chris Lattner0af024c2004-12-15 07:22:13 +0000884 return OnlyReadsMemory;
885
886 return UnknownModRefBehavior;
Chris Lattner4244bb52004-03-15 03:36:49 +0000887}
Reid Spencer4f1bd9e2006-06-07 22:00:26 +0000888
889// Make sure that anything that uses AliasAnalysis pulls in this file...
890DEFINING_FILE_FOR(BasicAliasAnalysis)