blob: 9b8eb42545019bd88ce02bf69f1bdd492bfb3eb2 [file] [log] [blame]
Chris Lattner9d7c9ea2003-11-25 20:11:47 +00001//===- BasicAliasAnalysis.cpp - Local Alias Analysis Impl -----------------===//
John Criswellb576c942003-10-20 19:43:21 +00002//
3// 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.
7//
8//===----------------------------------------------------------------------===//
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"
Chris Lattner4244bb52004-03-15 03:36:49 +000017#include "llvm/Constants.h"
18#include "llvm/DerivedTypes.h"
19#include "llvm/Function.h"
20#include "llvm/GlobalVariable.h"
Alkis Evlogimenoseb62bc72004-07-29 12:17:34 +000021#include "llvm/Instructions.h"
Chris Lattner4244bb52004-03-15 03:36:49 +000022#include "llvm/Pass.h"
Chris Lattnerd501c132003-02-26 19:41:54 +000023#include "llvm/Target/TargetData.h"
Chris Lattner1af55e12003-11-25 20:10:07 +000024#include "llvm/Support/GetElementPtrTypeIterator.h"
Alkis Evlogimenos20aa4742004-09-03 18:19:51 +000025#include <algorithm>
Chris Lattnerec4e8082003-11-25 18:33:40 +000026using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000027
Chris Lattnerd501c132003-02-26 19:41:54 +000028// Make sure that anything that uses AliasAnalysis pulls in this file...
Chris Lattner86391452003-12-11 05:44:59 +000029void llvm::BasicAAStub() {}
Chris Lattnerd501c132003-02-26 19:41:54 +000030
Chris Lattnerd501c132003-02-26 19:41:54 +000031namespace {
Chris Lattnerb52f4402004-05-23 21:15:12 +000032 /// NoAA - This class implements the -no-aa pass, which always returns "I
33 /// don't know" for alias queries. NoAA is unlike other alias analysis
34 /// implementations, in that it does not chain to a previous analysis. As
35 /// such it doesn't follow many of the rules that other alias analyses must.
36 ///
37 struct NoAA : public ImmutablePass, public AliasAnalysis {
Chris Lattner689835a2004-06-19 08:05:58 +000038 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
39 AU.addRequired<TargetData>();
40 }
41
42 virtual void initializePass() {
43 TD = &getAnalysis<TargetData>();
44 }
45
Chris Lattnerb52f4402004-05-23 21:15:12 +000046 virtual AliasResult alias(const Value *V1, unsigned V1Size,
47 const Value *V2, unsigned V2Size) {
48 return MayAlias;
49 }
50
Chris Lattner5226f6a2004-12-15 17:13:24 +000051 virtual ModRefBehavior getModRefBehavior(Function *F, CallSite CS,
52 std::vector<PointerAccessInfo> *Info) {
Chris Lattner0af024c2004-12-15 07:22:13 +000053 return UnknownModRefBehavior;
54 }
55
56 virtual void getArgumentAccesses(Function *F, CallSite CS,
57 std::vector<PointerAccessInfo> &Info) {
58 assert(0 && "This method may not be called on this function!");
59 }
60
Chris Lattnerb52f4402004-05-23 21:15:12 +000061 virtual void getMustAliases(Value *P, std::vector<Value*> &RetVals) { }
62 virtual bool pointsToConstantMemory(const Value *P) { return false; }
Chris Lattnerb52f4402004-05-23 21:15:12 +000063 virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
64 return ModRef;
65 }
66 virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
67 return ModRef;
68 }
69 virtual bool hasNoModRefInfoForCalls() const { return true; }
70
71 virtual void deleteValue(Value *V) {}
72 virtual void copyValue(Value *From, Value *To) {}
Chris Lattnerb52f4402004-05-23 21:15:12 +000073 };
74
75 // Register this pass...
76 RegisterOpt<NoAA>
77 U("no-aa", "No Alias Analysis (always returns 'may' alias)");
78
79 // Declare that we implement the AliasAnalysis interface
80 RegisterAnalysisGroup<AliasAnalysis, NoAA> V;
81} // End of anonymous namespace
82
83
84namespace {
85 /// BasicAliasAnalysis - This is the default alias analysis implementation.
86 /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
87 /// derives from the NoAA class.
88 struct BasicAliasAnalysis : public NoAA {
Chris Lattnerd501c132003-02-26 19:41:54 +000089 AliasResult alias(const Value *V1, unsigned V1Size,
90 const Value *V2, unsigned V2Size);
Chris Lattnerbc1daaa2004-01-30 22:17:24 +000091
Chris Lattner04b75932004-03-12 22:39:00 +000092 ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
Reid Spencer4a7ebfa2004-12-07 08:11:24 +000093 ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
94 return NoAA::getModRefInfo(CS1,CS2);
95 }
Chris Lattner04b75932004-03-12 22:39:00 +000096
Chris Lattnere181b942004-07-27 02:13:55 +000097 /// hasNoModRefInfoForCalls - We can provide mod/ref information against
98 /// non-escaping allocations.
99 virtual bool hasNoModRefInfoForCalls() const { return false; }
Chris Lattner65585aa2004-04-11 16:43:07 +0000100
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000101 /// pointsToConstantMemory - Chase pointers until we find a (constant
102 /// global) or not.
103 bool pointsToConstantMemory(const Value *P);
104
Chris Lattner0af024c2004-12-15 07:22:13 +0000105 virtual ModRefBehavior getModRefBehavior(Function *F, CallSite CS,
106 std::vector<PointerAccessInfo> *Info);
107
Chris Lattnerd501c132003-02-26 19:41:54 +0000108 private:
Chris Lattnerb307c882003-12-11 22:44:13 +0000109 // CheckGEPInstructions - Check two GEP instructions with known
110 // must-aliasing base pointers. This checks to see if the index expressions
Chris Lattnerd501c132003-02-26 19:41:54 +0000111 // preclude the pointers from aliasing...
Chris Lattnerb307c882003-12-11 22:44:13 +0000112 AliasResult
113 CheckGEPInstructions(const Type* BasePtr1Ty, std::vector<Value*> &GEP1Ops,
114 unsigned G1Size,
115 const Type *BasePtr2Ty, std::vector<Value*> &GEP2Ops,
116 unsigned G2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000117 };
118
119 // Register this pass...
120 RegisterOpt<BasicAliasAnalysis>
121 X("basicaa", "Basic Alias Analysis (default AA impl)");
122
123 // Declare that we implement the AliasAnalysis interface
124 RegisterAnalysisGroup<AliasAnalysis, BasicAliasAnalysis, true> Y;
125} // End of anonymous namespace
126
Chris Lattnerc1820032003-09-20 03:08:47 +0000127// hasUniqueAddress - Return true if the specified value points to something
128// with a unique, discernable, address.
Chris Lattnerd501c132003-02-26 19:41:54 +0000129static inline bool hasUniqueAddress(const Value *V) {
Chris Lattnerc1820032003-09-20 03:08:47 +0000130 return isa<GlobalValue>(V) || isa<AllocationInst>(V);
Chris Lattnerd501c132003-02-26 19:41:54 +0000131}
132
Chris Lattnerc1820032003-09-20 03:08:47 +0000133// getUnderlyingObject - This traverses the use chain to figure out what object
134// the specified value points to. If the value points to, or is derived from, a
135// unique object or an argument, return it.
Chris Lattnerd501c132003-02-26 19:41:54 +0000136static const Value *getUnderlyingObject(const Value *V) {
137 if (!isa<PointerType>(V->getType())) return 0;
138
139 // If we are at some type of object... return it.
Chris Lattnerc1820032003-09-20 03:08:47 +0000140 if (hasUniqueAddress(V) || isa<Argument>(V)) return V;
Chris Lattnerd501c132003-02-26 19:41:54 +0000141
142 // Traverse through different addressing mechanisms...
143 if (const Instruction *I = dyn_cast<Instruction>(V)) {
144 if (isa<CastInst>(I) || isa<GetElementPtrInst>(I))
145 return getUnderlyingObject(I->getOperand(0));
Chris Lattner388f6692003-06-17 15:25:37 +0000146 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
147 if (CE->getOpcode() == Instruction::Cast ||
148 CE->getOpcode() == Instruction::GetElementPtr)
149 return getUnderlyingObject(CE->getOperand(0));
Reid Spencere8404342004-07-18 00:18:30 +0000150 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
151 return GV;
Chris Lattnerd501c132003-02-26 19:41:54 +0000152 }
153 return 0;
154}
155
Chris Lattnerb307c882003-12-11 22:44:13 +0000156static const User *isGEP(const Value *V) {
157 if (isa<GetElementPtrInst>(V) ||
158 (isa<ConstantExpr>(V) &&
159 cast<ConstantExpr>(V)->getOpcode() == Instruction::GetElementPtr))
160 return cast<User>(V);
161 return 0;
162}
Chris Lattnerd501c132003-02-26 19:41:54 +0000163
Chris Lattner4a830882003-12-11 23:20:16 +0000164static const Value *GetGEPOperands(const Value *V, std::vector<Value*> &GEPOps){
165 assert(GEPOps.empty() && "Expect empty list to populate!");
166 GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
167 cast<User>(V)->op_end());
168
169 // Accumulate all of the chained indexes into the operand array
170 V = cast<User>(V)->getOperand(0);
171
172 while (const User *G = isGEP(V)) {
Reid Spencere8404342004-07-18 00:18:30 +0000173 if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
Chris Lattner4a830882003-12-11 23:20:16 +0000174 !cast<Constant>(GEPOps[0])->isNullValue())
175 break; // Don't handle folding arbitrary pointer offsets yet...
176 GEPOps.erase(GEPOps.begin()); // Drop the zero index
177 GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
178 V = G->getOperand(0);
179 }
180 return V;
181}
182
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000183/// pointsToConstantMemory - Chase pointers until we find a (constant
184/// global) or not.
185bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
Chris Lattnera4dd6742004-01-30 22:48:02 +0000186 if (const Value *V = getUnderlyingObject(P))
187 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
188 return GV->isConstant();
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000189 return false;
190}
Chris Lattner4a830882003-12-11 23:20:16 +0000191
Chris Lattner04b75932004-03-12 22:39:00 +0000192static bool AddressMightEscape(const Value *V) {
193 for (Value::use_const_iterator UI = V->use_begin(), E = V->use_end();
194 UI != E; ++UI) {
195 const Instruction *I = cast<Instruction>(*UI);
196 switch (I->getOpcode()) {
197 case Instruction::Load: break;
198 case Instruction::Store:
199 if (I->getOperand(0) == V)
200 return true; // Escapes if the pointer is stored.
201 break;
202 case Instruction::GetElementPtr:
203 if (AddressMightEscape(I)) return true;
204 break;
205 case Instruction::Cast:
206 if (!isa<PointerType>(I->getType()))
207 return true;
208 if (AddressMightEscape(I)) return true;
209 break;
Chris Lattnerdb5b80a2004-07-27 02:18:52 +0000210 case Instruction::Ret:
211 // If returned, the address will escape to calling functions, but no
212 // callees could modify it.
213 break;
Chris Lattner04b75932004-03-12 22:39:00 +0000214 default:
215 return true;
216 }
217 }
218 return false;
219}
220
221// getModRefInfo - Check to see if the specified callsite can clobber the
222// specified memory object. Since we only look at local properties of this
223// function, we really can't say much about this query. We do, however, use
224// simple "address taken" analysis on local objects.
225//
226AliasAnalysis::ModRefResult
227BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
Reid Spencere8404342004-07-18 00:18:30 +0000228 if (!isa<Constant>(P))
Chris Lattner04b75932004-03-12 22:39:00 +0000229 if (const AllocationInst *AI =
Chris Lattner7a82ba02004-03-12 23:12:55 +0000230 dyn_cast_or_null<AllocationInst>(getUnderlyingObject(P))) {
Chris Lattner04b75932004-03-12 22:39:00 +0000231 // Okay, the pointer is to a stack allocated object. If we can prove that
232 // the pointer never "escapes", then we know the call cannot clobber it,
233 // because it simply can't get its address.
234 if (!AddressMightEscape(AI))
235 return NoModRef;
236 }
237
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000238 // The AliasAnalysis base class has some smarts, lets use them.
239 return AliasAnalysis::getModRefInfo(CS, P, Size);
Chris Lattner04b75932004-03-12 22:39:00 +0000240}
241
Chris Lattnerd501c132003-02-26 19:41:54 +0000242// alias - Provide a bunch of ad-hoc rules to disambiguate in common cases, such
243// as array references. Note that this function is heavily tail recursive.
244// Hopefully we have a smart C++ compiler. :)
245//
246AliasAnalysis::AliasResult
247BasicAliasAnalysis::alias(const Value *V1, unsigned V1Size,
248 const Value *V2, unsigned V2Size) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000249 // Strip off any constant expression casts if they exist
250 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V1))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000251 if (CE->getOpcode() == Instruction::Cast &&
252 isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000253 V1 = CE->getOperand(0);
254 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V2))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000255 if (CE->getOpcode() == Instruction::Cast &&
256 isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000257 V2 = CE->getOperand(0);
258
Chris Lattnerd501c132003-02-26 19:41:54 +0000259 // Are we checking for alias of the same value?
260 if (V1 == V2) return MustAlias;
261
262 if ((!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType())) &&
263 V1->getType() != Type::LongTy && V2->getType() != Type::LongTy)
264 return NoAlias; // Scalars cannot alias each other
265
266 // Strip off cast instructions...
267 if (const Instruction *I = dyn_cast<CastInst>(V1))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000268 if (isa<PointerType>(I->getOperand(0)->getType()))
269 return alias(I->getOperand(0), V1Size, V2, V2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000270 if (const Instruction *I = dyn_cast<CastInst>(V2))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000271 if (isa<PointerType>(I->getOperand(0)->getType()))
272 return alias(V1, V1Size, I->getOperand(0), V2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000273
274 // Figure out what objects these things are pointing to if we can...
275 const Value *O1 = getUnderlyingObject(V1);
276 const Value *O2 = getUnderlyingObject(V2);
277
Misha Brukman2f2d0652003-09-11 18:14:24 +0000278 // Pointing at a discernible object?
Chris Lattner0a1ac902004-11-26 19:20:01 +0000279 if (O1) {
280 if (O2) {
281 if (isa<Argument>(O1)) {
282 // Incoming argument cannot alias locally allocated object!
283 if (isa<AllocationInst>(O2)) return NoAlias;
284 // Otherwise, nothing is known...
285 } else if (isa<Argument>(O2)) {
286 // Incoming argument cannot alias locally allocated object!
287 if (isa<AllocationInst>(O1)) return NoAlias;
288 // Otherwise, nothing is known...
289 } else if (O1 != O2) {
290 // If they are two different objects, we know that we have no alias...
291 return NoAlias;
292 }
293
294 // If they are the same object, they we can look at the indexes. If they
295 // index off of the object is the same for both pointers, they must alias.
296 // If they are provably different, they must not alias. Otherwise, we
297 // can't tell anything.
Chris Lattnerc1820032003-09-20 03:08:47 +0000298 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000299
Chris Lattner0a1ac902004-11-26 19:20:01 +0000300
301 if (!isa<Argument>(O1) && isa<ConstantPointerNull>(V2))
302 return NoAlias; // Unique values don't alias null
303
Chris Lattner4e616762004-11-26 20:01:48 +0000304 if (isa<GlobalVariable>(O1) || isa<AllocationInst>(O1))
305 if (cast<PointerType>(O1->getType())->getElementType()->isSized()) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000306 // If the size of the other access is larger than the total size of the
Chris Lattner4e616762004-11-26 20:01:48 +0000307 // global/alloca/malloc, it cannot be accessing the global (it's
308 // undefined to load or store bytes before or after an object).
309 const Type *ElTy = cast<PointerType>(O1->getType())->getElementType();
310 unsigned GlobalSize = getTargetData().getTypeSize(ElTy);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000311 if (GlobalSize < V2Size && V2Size != ~0U)
Chris Lattner0a1ac902004-11-26 19:20:01 +0000312 return NoAlias;
313 }
314 }
315
316 if (O2) {
317 if (!isa<Argument>(O2) && isa<ConstantPointerNull>(V1))
318 return NoAlias; // Unique values don't alias null
319
Chris Lattner4e616762004-11-26 20:01:48 +0000320 if (isa<GlobalVariable>(O2) || isa<AllocationInst>(O2))
321 if (cast<PointerType>(O2->getType())->getElementType()->isSized()) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000322 // If the size of the other access is larger than the total size of the
Chris Lattner4e616762004-11-26 20:01:48 +0000323 // global/alloca/malloc, it cannot be accessing the object (it's
324 // undefined to load or store bytes before or after an object).
325 const Type *ElTy = cast<PointerType>(O2->getType())->getElementType();
326 unsigned GlobalSize = getTargetData().getTypeSize(ElTy);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000327 if (GlobalSize < V1Size && V1Size != ~0U)
Chris Lattner0a1ac902004-11-26 19:20:01 +0000328 return NoAlias;
329 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000330 }
331
Chris Lattnerb307c882003-12-11 22:44:13 +0000332 // If we have two gep instructions with must-alias'ing base pointers, figure
333 // out if the indexes to the GEP tell us anything about the derived pointer.
334 // Note that we also handle chains of getelementptr instructions as well as
335 // constant expression getelementptrs here.
Chris Lattnerd501c132003-02-26 19:41:54 +0000336 //
Chris Lattnerb307c882003-12-11 22:44:13 +0000337 if (isGEP(V1) && isGEP(V2)) {
338 // Drill down into the first non-gep value, to test for must-aliasing of
339 // the base pointers.
340 const Value *BasePtr1 = V1, *BasePtr2 = V2;
341 do {
342 BasePtr1 = cast<User>(BasePtr1)->getOperand(0);
343 } while (isGEP(BasePtr1) &&
344 cast<User>(BasePtr1)->getOperand(1) ==
345 Constant::getNullValue(cast<User>(BasePtr1)->getOperand(1)->getType()));
346 do {
347 BasePtr2 = cast<User>(BasePtr2)->getOperand(0);
348 } while (isGEP(BasePtr2) &&
349 cast<User>(BasePtr2)->getOperand(1) ==
350 Constant::getNullValue(cast<User>(BasePtr2)->getOperand(1)->getType()));
351
352 // Do the base pointers alias?
353 AliasResult BaseAlias = alias(BasePtr1, V1Size, BasePtr2, V2Size);
354 if (BaseAlias == NoAlias) return NoAlias;
355 if (BaseAlias == MustAlias) {
356 // If the base pointers alias each other exactly, check to see if we can
357 // figure out anything about the resultant pointers, to try to prove
358 // non-aliasing.
359
360 // Collect all of the chained GEP operands together into one simple place
Chris Lattner4a830882003-12-11 23:20:16 +0000361 std::vector<Value*> GEP1Ops, GEP2Ops;
362 BasePtr1 = GetGEPOperands(V1, GEP1Ops);
363 BasePtr2 = GetGEPOperands(V2, GEP2Ops);
Chris Lattnerb307c882003-12-11 22:44:13 +0000364
Chris Lattner730b1ad2004-07-29 07:56:39 +0000365 // If GetGEPOperands were able to fold to the same must-aliased pointer,
366 // do the comparison.
367 if (BasePtr1 == BasePtr2) {
368 AliasResult GAlias =
369 CheckGEPInstructions(BasePtr1->getType(), GEP1Ops, V1Size,
370 BasePtr2->getType(), GEP2Ops, V2Size);
371 if (GAlias != MayAlias)
372 return GAlias;
373 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000374 }
375 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000376
377 // Check to see if these two pointers are related by a getelementptr
378 // instruction. If one pointer is a GEP with a non-zero index of the other
379 // pointer, we know they cannot alias.
380 //
Chris Lattner4a830882003-12-11 23:20:16 +0000381 if (isGEP(V2)) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000382 std::swap(V1, V2);
383 std::swap(V1Size, V2Size);
384 }
385
Chris Lattnerc330ee62003-02-26 21:57:23 +0000386 if (V1Size != ~0U && V2Size != ~0U)
Chris Lattner4a830882003-12-11 23:20:16 +0000387 if (const User *GEP = isGEP(V1)) {
388 std::vector<Value*> GEPOperands;
389 const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
390
391 AliasResult R = alias(BasePtr, V1Size, V2, V2Size);
Chris Lattnerc330ee62003-02-26 21:57:23 +0000392 if (R == MustAlias) {
393 // If there is at least one non-zero constant index, we know they cannot
394 // alias.
395 bool ConstantFound = false;
Chris Lattner88d3e032003-12-11 06:02:00 +0000396 bool AllZerosFound = true;
Chris Lattner4a830882003-12-11 23:20:16 +0000397 for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
398 if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
Chris Lattnerc330ee62003-02-26 21:57:23 +0000399 if (!C->isNullValue()) {
400 ConstantFound = true;
Chris Lattnerc54735e2003-12-11 06:06:28 +0000401 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000402 break;
Chris Lattner88d3e032003-12-11 06:02:00 +0000403 }
404 } else {
405 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000406 }
Chris Lattner88d3e032003-12-11 06:02:00 +0000407
408 // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
409 // the ptr, the end result is a must alias also.
410 if (AllZerosFound)
411 return MustAlias;
412
Chris Lattnerc330ee62003-02-26 21:57:23 +0000413 if (ConstantFound) {
414 if (V2Size <= 1 && V1Size <= 1) // Just pointer check?
Chris Lattnerd501c132003-02-26 19:41:54 +0000415 return NoAlias;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000416
417 // Otherwise we have to check to see that the distance is more than
418 // the size of the argument... build an index vector that is equal to
419 // the arguments provided, except substitute 0's for any variable
420 // indexes we find...
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000421 if (cast<PointerType>(
422 BasePtr->getType())->getElementType()->isSized()) {
423 for (unsigned i = 0; i != GEPOperands.size(); ++i)
424 if (!isa<ConstantInt>(GEPOperands[i]))
425 GEPOperands[i] =
426 Constant::getNullValue(GEPOperands[i]->getType());
427 int64_t Offset =
428 getTargetData().getIndexedOffset(BasePtr->getType(), GEPOperands);
429
430 if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
431 return NoAlias;
432 }
Chris Lattnerc330ee62003-02-26 21:57:23 +0000433 }
434 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000435 }
Chris Lattnerc330ee62003-02-26 21:57:23 +0000436
Chris Lattnerd501c132003-02-26 19:41:54 +0000437 return MayAlias;
438}
439
Chris Lattner28977af2004-04-05 01:30:19 +0000440static bool ValuesEqual(Value *V1, Value *V2) {
441 if (V1->getType() == V2->getType())
442 return V1 == V2;
443 if (Constant *C1 = dyn_cast<Constant>(V1))
444 if (Constant *C2 = dyn_cast<Constant>(V2)) {
445 // Sign extend the constants to long types.
446 C1 = ConstantExpr::getSignExtend(C1, Type::LongTy);
447 C2 = ConstantExpr::getSignExtend(C2, Type::LongTy);
448 return C1 == C2;
449 }
450 return false;
451}
452
Chris Lattnerb307c882003-12-11 22:44:13 +0000453/// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
454/// base pointers. This checks to see if the index expressions preclude the
455/// pointers from aliasing...
456AliasAnalysis::AliasResult BasicAliasAnalysis::
457CheckGEPInstructions(const Type* BasePtr1Ty, std::vector<Value*> &GEP1Ops,
458 unsigned G1S,
459 const Type *BasePtr2Ty, std::vector<Value*> &GEP2Ops,
460 unsigned G2S) {
461 // We currently can't handle the case when the base pointers have different
462 // primitive types. Since this is uncommon anyway, we are happy being
463 // extremely conservative.
464 if (BasePtr1Ty != BasePtr2Ty)
465 return MayAlias;
466
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000467 const PointerType *GEPPointerTy = cast<PointerType>(BasePtr1Ty);
Chris Lattnerb307c882003-12-11 22:44:13 +0000468
469 // Find the (possibly empty) initial sequence of equal values... which are not
470 // necessarily constants.
471 unsigned NumGEP1Operands = GEP1Ops.size(), NumGEP2Operands = GEP2Ops.size();
472 unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
473 unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
474 unsigned UnequalOper = 0;
475 while (UnequalOper != MinOperands &&
Chris Lattner28977af2004-04-05 01:30:19 +0000476 ValuesEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper])) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000477 // Advance through the type as we go...
478 ++UnequalOper;
479 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
480 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
481 else {
482 // If all operands equal each other, then the derived pointers must
483 // alias each other...
484 BasePtr1Ty = 0;
485 assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
486 "Ran out of type nesting, but not out of operands?");
487 return MustAlias;
Chris Lattner920bd792003-06-02 05:42:39 +0000488 }
489 }
Chris Lattner920bd792003-06-02 05:42:39 +0000490
Chris Lattnerb307c882003-12-11 22:44:13 +0000491 // If we have seen all constant operands, and run out of indexes on one of the
492 // getelementptrs, check to see if the tail of the leftover one is all zeros.
493 // If so, return mustalias.
Chris Lattner4a830882003-12-11 23:20:16 +0000494 if (UnequalOper == MinOperands) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000495 if (GEP1Ops.size() < GEP2Ops.size()) std::swap(GEP1Ops, GEP2Ops);
Chris Lattnerd501c132003-02-26 19:41:54 +0000496
Chris Lattnerb307c882003-12-11 22:44:13 +0000497 bool AllAreZeros = true;
498 for (unsigned i = UnequalOper; i != MaxOperands; ++i)
Chris Lattnera35339d2004-10-16 16:07:10 +0000499 if (!isa<Constant>(GEP1Ops[i]) ||
Chris Lattnerb307c882003-12-11 22:44:13 +0000500 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
501 AllAreZeros = false;
502 break;
503 }
504 if (AllAreZeros) return MustAlias;
505 }
506
Chris Lattnerd501c132003-02-26 19:41:54 +0000507
508 // So now we know that the indexes derived from the base pointers,
509 // which are known to alias, are different. We can still determine a
510 // no-alias result if there are differing constant pairs in the index
511 // chain. For example:
512 // A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
513 //
514 unsigned SizeMax = std::max(G1S, G2S);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000515 if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work.
Chris Lattner920bd792003-06-02 05:42:39 +0000516
Chris Lattnerd501c132003-02-26 19:41:54 +0000517 // Scan for the first operand that is constant and unequal in the
Chris Lattner28977af2004-04-05 01:30:19 +0000518 // two getelementptrs...
Chris Lattnerd501c132003-02-26 19:41:54 +0000519 unsigned FirstConstantOper = UnequalOper;
Chris Lattnerb307c882003-12-11 22:44:13 +0000520 for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
521 const Value *G1Oper = GEP1Ops[FirstConstantOper];
522 const Value *G2Oper = GEP2Ops[FirstConstantOper];
523
Chris Lattner6eb88d42004-01-12 17:57:32 +0000524 if (G1Oper != G2Oper) // Found non-equal constant indexes...
Chris Lattnera35339d2004-10-16 16:07:10 +0000525 if (Constant *G1OC = dyn_cast<ConstantInt>(const_cast<Value*>(G1Oper)))
526 if (Constant *G2OC = dyn_cast<ConstantInt>(const_cast<Value*>(G2Oper))){
Chris Lattner28977af2004-04-05 01:30:19 +0000527 if (G1OC->getType() != G2OC->getType()) {
528 // Sign extend both operands to long.
529 G1OC = ConstantExpr::getSignExtend(G1OC, Type::LongTy);
530 G2OC = ConstantExpr::getSignExtend(G2OC, Type::LongTy);
531 GEP1Ops[FirstConstantOper] = G1OC;
532 GEP2Ops[FirstConstantOper] = G2OC;
533 }
534
535 if (G1OC != G2OC) {
Chris Lattnera35339d2004-10-16 16:07:10 +0000536 // Make sure they are comparable (ie, not constant expressions), and
537 // make sure the GEP with the smaller leading constant is GEP1.
Chris Lattner28977af2004-04-05 01:30:19 +0000538 Constant *Compare = ConstantExpr::getSetGT(G1OC, G2OC);
539 if (ConstantBool *CV = dyn_cast<ConstantBool>(Compare)) {
540 if (CV->getValue()) // If they are comparable and G2 > G1
541 std::swap(GEP1Ops, GEP2Ops); // Make GEP1 < GEP2
542 break;
543 }
Chris Lattner6eb88d42004-01-12 17:57:32 +0000544 }
545 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000546 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
Chris Lattnerd501c132003-02-26 19:41:54 +0000547 }
548
Chris Lattnerb307c882003-12-11 22:44:13 +0000549 // No shared constant operands, and we ran out of common operands. At this
550 // point, the GEP instructions have run through all of their operands, and we
551 // haven't found evidence that there are any deltas between the GEP's.
552 // However, one GEP may have more operands than the other. If this is the
Chris Lattner28977af2004-04-05 01:30:19 +0000553 // case, there may still be hope. Check this now.
Chris Lattnerb307c882003-12-11 22:44:13 +0000554 if (FirstConstantOper == MinOperands) {
555 // Make GEP1Ops be the longer one if there is a longer one.
556 if (GEP1Ops.size() < GEP2Ops.size())
557 std::swap(GEP1Ops, GEP2Ops);
558
559 // Is there anything to check?
560 if (GEP1Ops.size() > MinOperands) {
561 for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
Chris Lattnerf70770a2004-07-14 20:27:12 +0000562 if (isa<ConstantInt>(GEP1Ops[i]) &&
Chris Lattnerb307c882003-12-11 22:44:13 +0000563 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
564 // Yup, there's a constant in the tail. Set all variables to
565 // constants in the GEP instruction to make it suiteable for
566 // TargetData::getIndexedOffset.
567 for (i = 0; i != MaxOperands; ++i)
Chris Lattnerf70770a2004-07-14 20:27:12 +0000568 if (!isa<ConstantInt>(GEP1Ops[i]))
Chris Lattnerb307c882003-12-11 22:44:13 +0000569 GEP1Ops[i] = Constant::getNullValue(GEP1Ops[i]->getType());
570 // Okay, now get the offset. This is the relative offset for the full
571 // instruction.
572 const TargetData &TD = getTargetData();
573 int64_t Offset1 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops);
574
575 // Now crop off any constants from the end...
576 GEP1Ops.resize(MinOperands);
577 int64_t Offset2 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops);
578
579 // If the tail provided a bit enough offset, return noalias!
580 if ((uint64_t)(Offset2-Offset1) >= SizeMax)
581 return NoAlias;
582 }
583 }
584
585 // Couldn't find anything useful.
586 return MayAlias;
587 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000588
589 // If there are non-equal constants arguments, then we can figure
590 // out a minimum known delta between the two index expressions... at
591 // this point we know that the first constant index of GEP1 is less
592 // than the first constant index of GEP2.
Chris Lattner1af55e12003-11-25 20:10:07 +0000593
Chris Lattnerb307c882003-12-11 22:44:13 +0000594 // Advance BasePtr[12]Ty over this first differing constant operand.
595 BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(GEP2Ops[FirstConstantOper]);
596 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(GEP1Ops[FirstConstantOper]);
Chris Lattnerd501c132003-02-26 19:41:54 +0000597
Chris Lattnerb307c882003-12-11 22:44:13 +0000598 // We are going to be using TargetData::getIndexedOffset to determine the
599 // offset that each of the GEP's is reaching. To do this, we have to convert
600 // all variable references to constant references. To do this, we convert the
601 // initial equal sequence of variables into constant zeros to start with.
Chris Lattnera35339d2004-10-16 16:07:10 +0000602 for (unsigned i = 0; i != FirstConstantOper; ++i)
603 if (!isa<ConstantInt>(GEP1Ops[i]) || !isa<ConstantInt>(GEP2Ops[i]))
Chris Lattner28977af2004-04-05 01:30:19 +0000604 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Type::UIntTy);
Chris Lattnerb307c882003-12-11 22:44:13 +0000605
606 // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
Chris Lattnerd501c132003-02-26 19:41:54 +0000607
608 // Loop over the rest of the operands...
Chris Lattnerb307c882003-12-11 22:44:13 +0000609 for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
610 const Value *Op1 = i < GEP1Ops.size() ? GEP1Ops[i] : 0;
611 const Value *Op2 = i < GEP2Ops.size() ? GEP2Ops[i] : 0;
612 // If they are equal, use a zero index...
613 if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
Chris Lattnera35339d2004-10-16 16:07:10 +0000614 if (!isa<ConstantInt>(Op1))
Chris Lattnerb307c882003-12-11 22:44:13 +0000615 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Op1->getType());
616 // Otherwise, just keep the constants we have.
Chris Lattnerd501c132003-02-26 19:41:54 +0000617 } else {
Chris Lattnerb307c882003-12-11 22:44:13 +0000618 if (Op1) {
619 if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
620 // If this is an array index, make sure the array element is in range.
621 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
622 if (Op1C->getRawValue() >= AT->getNumElements())
623 return MayAlias; // Be conservative with out-of-range accesses
624
625 } else {
626 // GEP1 is known to produce a value less than GEP2. To be
627 // conservatively correct, we must assume the largest possible
628 // constant is used in this position. This cannot be the initial
629 // index to the GEP instructions (because we know we have at least one
630 // element before this one with the different constant arguments), so
631 // we know that the current index must be into either a struct or
632 // array. Because we know it's not constant, this cannot be a
633 // structure index. Because of this, we can calculate the maximum
634 // value possible.
635 //
636 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
637 GEP1Ops[i] = ConstantSInt::get(Type::LongTy,AT->getNumElements()-1);
638 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000639 }
640
Chris Lattnerb307c882003-12-11 22:44:13 +0000641 if (Op2) {
642 if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
643 // If this is an array index, make sure the array element is in range.
644 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
645 if (Op2C->getRawValue() >= AT->getNumElements())
646 return MayAlias; // Be conservative with out-of-range accesses
647 } else { // Conservatively assume the minimum value for this index
648 GEP2Ops[i] = Constant::getNullValue(Op2->getType());
649 }
Chris Lattner920bd792003-06-02 05:42:39 +0000650 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000651 }
652
653 if (BasePtr1Ty && Op1) {
654 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
655 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
656 else
657 BasePtr1Ty = 0;
658 }
659
660 if (BasePtr2Ty && Op2) {
661 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
662 BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
663 else
664 BasePtr2Ty = 0;
Chris Lattnerd501c132003-02-26 19:41:54 +0000665 }
666 }
667
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000668 if (GEPPointerTy->getElementType()->isSized()) {
669 int64_t Offset1 = getTargetData().getIndexedOffset(GEPPointerTy, GEP1Ops);
670 int64_t Offset2 = getTargetData().getIndexedOffset(GEPPointerTy, GEP2Ops);
671 assert(Offset1<Offset2 && "There is at least one different constant here!");
Chris Lattnerd501c132003-02-26 19:41:54 +0000672
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000673 if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
674 //std::cerr << "Determined that these two GEP's don't alias ["
675 // << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
676 return NoAlias;
677 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000678 }
679 return MayAlias;
680}
681
Chris Lattner4244bb52004-03-15 03:36:49 +0000682namespace {
683 struct StringCompare {
684 bool operator()(const char *LHS, const char *RHS) {
685 return strcmp(LHS, RHS) < 0;
686 }
687 };
688}
689
690// Note that this list cannot contain libm functions (such as acos and sqrt)
691// that set errno on a domain or other error.
692static const char *DoesntAccessMemoryTable[] = {
Chris Lattnerb903fc52004-04-10 06:55:27 +0000693 // LLVM intrinsics:
Chris Lattner0af024c2004-12-15 07:22:13 +0000694 "llvm.frameaddress", "llvm.returnaddress", "llvm.readport",
695 "llvm.isunordered",
Chris Lattnerb903fc52004-04-10 06:55:27 +0000696
Chris Lattner4244bb52004-03-15 03:36:49 +0000697 "abs", "labs", "llabs", "imaxabs", "fabs", "fabsf", "fabsl",
698 "trunc", "truncf", "truncl", "ldexp",
699
700 "atan", "atanf", "atanl", "atan2", "atan2f", "atan2l",
701 "cbrt",
702 "cos", "cosf", "cosl", "cosh", "coshf", "coshl",
703 "exp", "expf", "expl",
704 "hypot",
705 "sin", "sinf", "sinl", "sinh", "sinhf", "sinhl",
706 "tan", "tanf", "tanl", "tanh", "tanhf", "tanhl",
707
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000708 // ctype.h
Chris Lattner4244bb52004-03-15 03:36:49 +0000709 "isalnum", "isalpha", "iscntrl", "isdigit", "isgraph", "islower", "isprint"
710 "ispunct", "isspace", "isupper", "isxdigit", "tolower", "toupper",
711
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000712 // wctype.h"
Chris Lattner4244bb52004-03-15 03:36:49 +0000713 "iswalnum", "iswalpha", "iswcntrl", "iswdigit", "iswgraph", "iswlower",
714 "iswprint", "iswpunct", "iswspace", "iswupper", "iswxdigit",
715
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000716 "iswctype", "towctrans", "towlower", "towupper",
717
Chris Lattner4244bb52004-03-15 03:36:49 +0000718 "btowc", "wctob",
Chris Lattner002be762004-03-16 03:41:35 +0000719
720 "isinf", "isnan", "finite",
721
722 // C99 math functions
723 "copysign", "copysignf", "copysignd",
724 "nexttoward", "nexttowardf", "nexttowardd",
725 "nextafter", "nextafterf", "nextafterd",
726
727 // glibc functions:
728 "__fpclassify", "__fpclassifyf", "__fpclassifyl",
729 "__signbit", "__signbitf", "__signbitl",
Chris Lattner4244bb52004-03-15 03:36:49 +0000730};
731
732static const unsigned DAMTableSize =
733 sizeof(DoesntAccessMemoryTable)/sizeof(DoesntAccessMemoryTable[0]);
734
Chris Lattner4244bb52004-03-15 03:36:49 +0000735static const char *OnlyReadsMemoryTable[] = {
Chris Lattner002be762004-03-16 03:41:35 +0000736 "atoi", "atol", "atof", "atoll", "atoq", "a64l",
737 "bcmp", "memcmp", "memchr", "memrchr", "wmemcmp", "wmemchr",
Chris Lattner4244bb52004-03-15 03:36:49 +0000738
739 // Strings
740 "strcmp", "strcasecmp", "strcoll", "strncmp", "strncasecmp",
741 "strchr", "strcspn", "strlen", "strpbrk", "strrchr", "strspn", "strstr",
Chris Lattner002be762004-03-16 03:41:35 +0000742 "index", "rindex",
Chris Lattner4244bb52004-03-15 03:36:49 +0000743
744 // Wide char strings
745 "wcschr", "wcscmp", "wcscoll", "wcscspn", "wcslen", "wcsncmp", "wcspbrk",
746 "wcsrchr", "wcsspn", "wcsstr",
Chris Lattner002be762004-03-16 03:41:35 +0000747
748 // glibc
749 "alphasort", "alphasort64", "versionsort", "versionsort64",
750
751 // C99
752 "nan", "nanf", "nand",
Chris Lattnerb903fc52004-04-10 06:55:27 +0000753
754 // File I/O
755 "feof", "ferror", "fileno",
756 "feof_unlocked", "ferror_unlocked", "fileno_unlocked"
Chris Lattner4244bb52004-03-15 03:36:49 +0000757};
758
759static const unsigned ORMTableSize =
760 sizeof(OnlyReadsMemoryTable)/sizeof(OnlyReadsMemoryTable[0]);
Chris Lattner0af024c2004-12-15 07:22:13 +0000761
762AliasAnalysis::ModRefBehavior
763BasicAliasAnalysis::getModRefBehavior(Function *F, CallSite CS,
764 std::vector<PointerAccessInfo> *Info) {
765 if (!F->isExternal()) return UnknownModRefBehavior;
Chris Lattner4244bb52004-03-15 03:36:49 +0000766
767 static bool Initialized = false;
768 if (!Initialized) {
769 // Sort the table the first time through.
Chris Lattner0af024c2004-12-15 07:22:13 +0000770 std::sort(DoesntAccessMemoryTable, DoesntAccessMemoryTable+DAMTableSize,
771 StringCompare());
Chris Lattner4244bb52004-03-15 03:36:49 +0000772 std::sort(OnlyReadsMemoryTable, OnlyReadsMemoryTable+ORMTableSize,
773 StringCompare());
774 Initialized = true;
775 }
776
Chris Lattner0af024c2004-12-15 07:22:13 +0000777 const char **Ptr = std::lower_bound(DoesntAccessMemoryTable,
778 DoesntAccessMemoryTable+DAMTableSize,
Chris Lattner4244bb52004-03-15 03:36:49 +0000779 F->getName().c_str(), StringCompare());
Chris Lattner0af024c2004-12-15 07:22:13 +0000780 if (Ptr != DoesntAccessMemoryTable+DAMTableSize && *Ptr == F->getName())
781 return DoesNotAccessMemory;
782
783 Ptr = std::lower_bound(OnlyReadsMemoryTable,
784 OnlyReadsMemoryTable+ORMTableSize,
785 F->getName().c_str(), StringCompare());
786 if (Ptr != OnlyReadsMemoryTable+ORMTableSize && *Ptr == F->getName())
787 return OnlyReadsMemory;
788
789 return UnknownModRefBehavior;
Chris Lattner4244bb52004-03-15 03:36:49 +0000790}