blob: b195b25cb5b09ad68593b64ce5fe88f67e1a54c9 [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
51 virtual void getMustAliases(Value *P, std::vector<Value*> &RetVals) { }
52 virtual bool pointsToConstantMemory(const Value *P) { return false; }
53 virtual bool doesNotAccessMemory(Function *F) { return false; }
54 virtual bool onlyReadsMemory(Function *F) { return false; }
55 virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
56 return ModRef;
57 }
58 virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
59 return ModRef;
60 }
61 virtual bool hasNoModRefInfoForCalls() const { return true; }
62
63 virtual void deleteValue(Value *V) {}
64 virtual void copyValue(Value *From, Value *To) {}
Chris Lattnerb52f4402004-05-23 21:15:12 +000065 };
66
67 // Register this pass...
68 RegisterOpt<NoAA>
69 U("no-aa", "No Alias Analysis (always returns 'may' alias)");
70
71 // Declare that we implement the AliasAnalysis interface
72 RegisterAnalysisGroup<AliasAnalysis, NoAA> V;
73} // End of anonymous namespace
74
75
76namespace {
77 /// BasicAliasAnalysis - This is the default alias analysis implementation.
78 /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
79 /// derives from the NoAA class.
80 struct BasicAliasAnalysis : public NoAA {
Chris Lattnerd501c132003-02-26 19:41:54 +000081 AliasResult alias(const Value *V1, unsigned V1Size,
82 const Value *V2, unsigned V2Size);
Chris Lattnerbc1daaa2004-01-30 22:17:24 +000083
Chris Lattner04b75932004-03-12 22:39:00 +000084 ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
85
Chris Lattnere181b942004-07-27 02:13:55 +000086 /// hasNoModRefInfoForCalls - We can provide mod/ref information against
87 /// non-escaping allocations.
88 virtual bool hasNoModRefInfoForCalls() const { return false; }
Chris Lattner65585aa2004-04-11 16:43:07 +000089
Chris Lattnerbc1daaa2004-01-30 22:17:24 +000090 /// pointsToConstantMemory - Chase pointers until we find a (constant
91 /// global) or not.
92 bool pointsToConstantMemory(const Value *P);
93
Chris Lattner4244bb52004-03-15 03:36:49 +000094 virtual bool doesNotAccessMemory(Function *F);
95 virtual bool onlyReadsMemory(Function *F);
96
Chris Lattnerd501c132003-02-26 19:41:54 +000097 private:
Chris Lattnerb307c882003-12-11 22:44:13 +000098 // CheckGEPInstructions - Check two GEP instructions with known
99 // must-aliasing base pointers. This checks to see if the index expressions
Chris Lattnerd501c132003-02-26 19:41:54 +0000100 // preclude the pointers from aliasing...
Chris Lattnerb307c882003-12-11 22:44:13 +0000101 AliasResult
102 CheckGEPInstructions(const Type* BasePtr1Ty, std::vector<Value*> &GEP1Ops,
103 unsigned G1Size,
104 const Type *BasePtr2Ty, std::vector<Value*> &GEP2Ops,
105 unsigned G2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000106 };
107
108 // Register this pass...
109 RegisterOpt<BasicAliasAnalysis>
110 X("basicaa", "Basic Alias Analysis (default AA impl)");
111
112 // Declare that we implement the AliasAnalysis interface
113 RegisterAnalysisGroup<AliasAnalysis, BasicAliasAnalysis, true> Y;
114} // End of anonymous namespace
115
Chris Lattnerc1820032003-09-20 03:08:47 +0000116// hasUniqueAddress - Return true if the specified value points to something
117// with a unique, discernable, address.
Chris Lattnerd501c132003-02-26 19:41:54 +0000118static inline bool hasUniqueAddress(const Value *V) {
Chris Lattnerc1820032003-09-20 03:08:47 +0000119 return isa<GlobalValue>(V) || isa<AllocationInst>(V);
Chris Lattnerd501c132003-02-26 19:41:54 +0000120}
121
Chris Lattnerc1820032003-09-20 03:08:47 +0000122// getUnderlyingObject - This traverses the use chain to figure out what object
123// the specified value points to. If the value points to, or is derived from, a
124// unique object or an argument, return it.
Chris Lattnerd501c132003-02-26 19:41:54 +0000125static const Value *getUnderlyingObject(const Value *V) {
126 if (!isa<PointerType>(V->getType())) return 0;
127
128 // If we are at some type of object... return it.
Chris Lattnerc1820032003-09-20 03:08:47 +0000129 if (hasUniqueAddress(V) || isa<Argument>(V)) return V;
Chris Lattnerd501c132003-02-26 19:41:54 +0000130
131 // Traverse through different addressing mechanisms...
132 if (const Instruction *I = dyn_cast<Instruction>(V)) {
133 if (isa<CastInst>(I) || isa<GetElementPtrInst>(I))
134 return getUnderlyingObject(I->getOperand(0));
Chris Lattner388f6692003-06-17 15:25:37 +0000135 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
136 if (CE->getOpcode() == Instruction::Cast ||
137 CE->getOpcode() == Instruction::GetElementPtr)
138 return getUnderlyingObject(CE->getOperand(0));
Reid Spencere8404342004-07-18 00:18:30 +0000139 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
140 return GV;
Chris Lattnerd501c132003-02-26 19:41:54 +0000141 }
142 return 0;
143}
144
Chris Lattnerb307c882003-12-11 22:44:13 +0000145static const User *isGEP(const Value *V) {
146 if (isa<GetElementPtrInst>(V) ||
147 (isa<ConstantExpr>(V) &&
148 cast<ConstantExpr>(V)->getOpcode() == Instruction::GetElementPtr))
149 return cast<User>(V);
150 return 0;
151}
Chris Lattnerd501c132003-02-26 19:41:54 +0000152
Chris Lattner4a830882003-12-11 23:20:16 +0000153static const Value *GetGEPOperands(const Value *V, std::vector<Value*> &GEPOps){
154 assert(GEPOps.empty() && "Expect empty list to populate!");
155 GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
156 cast<User>(V)->op_end());
157
158 // Accumulate all of the chained indexes into the operand array
159 V = cast<User>(V)->getOperand(0);
160
161 while (const User *G = isGEP(V)) {
Reid Spencere8404342004-07-18 00:18:30 +0000162 if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
Chris Lattner4a830882003-12-11 23:20:16 +0000163 !cast<Constant>(GEPOps[0])->isNullValue())
164 break; // Don't handle folding arbitrary pointer offsets yet...
165 GEPOps.erase(GEPOps.begin()); // Drop the zero index
166 GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
167 V = G->getOperand(0);
168 }
169 return V;
170}
171
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000172/// pointsToConstantMemory - Chase pointers until we find a (constant
173/// global) or not.
174bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
Chris Lattnera4dd6742004-01-30 22:48:02 +0000175 if (const Value *V = getUnderlyingObject(P))
176 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
177 return GV->isConstant();
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000178 return false;
179}
Chris Lattner4a830882003-12-11 23:20:16 +0000180
Chris Lattner04b75932004-03-12 22:39:00 +0000181static bool AddressMightEscape(const Value *V) {
182 for (Value::use_const_iterator UI = V->use_begin(), E = V->use_end();
183 UI != E; ++UI) {
184 const Instruction *I = cast<Instruction>(*UI);
185 switch (I->getOpcode()) {
186 case Instruction::Load: break;
187 case Instruction::Store:
188 if (I->getOperand(0) == V)
189 return true; // Escapes if the pointer is stored.
190 break;
191 case Instruction::GetElementPtr:
192 if (AddressMightEscape(I)) return true;
193 break;
194 case Instruction::Cast:
195 if (!isa<PointerType>(I->getType()))
196 return true;
197 if (AddressMightEscape(I)) return true;
198 break;
Chris Lattnerdb5b80a2004-07-27 02:18:52 +0000199 case Instruction::Ret:
200 // If returned, the address will escape to calling functions, but no
201 // callees could modify it.
202 break;
Chris Lattner04b75932004-03-12 22:39:00 +0000203 default:
204 return true;
205 }
206 }
207 return false;
208}
209
210// getModRefInfo - Check to see if the specified callsite can clobber the
211// specified memory object. Since we only look at local properties of this
212// function, we really can't say much about this query. We do, however, use
213// simple "address taken" analysis on local objects.
214//
215AliasAnalysis::ModRefResult
216BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
Reid Spencere8404342004-07-18 00:18:30 +0000217 if (!isa<Constant>(P))
Chris Lattner04b75932004-03-12 22:39:00 +0000218 if (const AllocationInst *AI =
Chris Lattner7a82ba02004-03-12 23:12:55 +0000219 dyn_cast_or_null<AllocationInst>(getUnderlyingObject(P))) {
Chris Lattner04b75932004-03-12 22:39:00 +0000220 // Okay, the pointer is to a stack allocated object. If we can prove that
221 // the pointer never "escapes", then we know the call cannot clobber it,
222 // because it simply can't get its address.
223 if (!AddressMightEscape(AI))
224 return NoModRef;
225 }
226
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000227 // The AliasAnalysis base class has some smarts, lets use them.
228 return AliasAnalysis::getModRefInfo(CS, P, Size);
Chris Lattner04b75932004-03-12 22:39:00 +0000229}
230
Chris Lattnerd501c132003-02-26 19:41:54 +0000231// alias - Provide a bunch of ad-hoc rules to disambiguate in common cases, such
232// as array references. Note that this function is heavily tail recursive.
233// Hopefully we have a smart C++ compiler. :)
234//
235AliasAnalysis::AliasResult
236BasicAliasAnalysis::alias(const Value *V1, unsigned V1Size,
237 const Value *V2, unsigned V2Size) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000238 // Strip off any constant expression casts if they exist
239 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V1))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000240 if (CE->getOpcode() == Instruction::Cast &&
241 isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000242 V1 = CE->getOperand(0);
243 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V2))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000244 if (CE->getOpcode() == Instruction::Cast &&
245 isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000246 V2 = CE->getOperand(0);
247
Chris Lattnerd501c132003-02-26 19:41:54 +0000248 // Are we checking for alias of the same value?
249 if (V1 == V2) return MustAlias;
250
251 if ((!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType())) &&
252 V1->getType() != Type::LongTy && V2->getType() != Type::LongTy)
253 return NoAlias; // Scalars cannot alias each other
254
255 // Strip off cast instructions...
256 if (const Instruction *I = dyn_cast<CastInst>(V1))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000257 if (isa<PointerType>(I->getOperand(0)->getType()))
258 return alias(I->getOperand(0), V1Size, V2, V2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000259 if (const Instruction *I = dyn_cast<CastInst>(V2))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000260 if (isa<PointerType>(I->getOperand(0)->getType()))
261 return alias(V1, V1Size, I->getOperand(0), V2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000262
263 // Figure out what objects these things are pointing to if we can...
264 const Value *O1 = getUnderlyingObject(V1);
265 const Value *O2 = getUnderlyingObject(V2);
266
Misha Brukman2f2d0652003-09-11 18:14:24 +0000267 // Pointing at a discernible object?
Chris Lattner0a1ac902004-11-26 19:20:01 +0000268 if (O1) {
269 if (O2) {
270 if (isa<Argument>(O1)) {
271 // Incoming argument cannot alias locally allocated object!
272 if (isa<AllocationInst>(O2)) return NoAlias;
273 // Otherwise, nothing is known...
274 } else if (isa<Argument>(O2)) {
275 // Incoming argument cannot alias locally allocated object!
276 if (isa<AllocationInst>(O1)) return NoAlias;
277 // Otherwise, nothing is known...
278 } else if (O1 != O2) {
279 // If they are two different objects, we know that we have no alias...
280 return NoAlias;
281 }
282
283 // If they are the same object, they we can look at the indexes. If they
284 // index off of the object is the same for both pointers, they must alias.
285 // If they are provably different, they must not alias. Otherwise, we
286 // can't tell anything.
Chris Lattnerc1820032003-09-20 03:08:47 +0000287 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000288
Chris Lattner0a1ac902004-11-26 19:20:01 +0000289
290 if (!isa<Argument>(O1) && isa<ConstantPointerNull>(V2))
291 return NoAlias; // Unique values don't alias null
292
Chris Lattner4e616762004-11-26 20:01:48 +0000293 if (isa<GlobalVariable>(O1) || isa<AllocationInst>(O1))
294 if (cast<PointerType>(O1->getType())->getElementType()->isSized()) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000295 // If the size of the other access is larger than the total size of the
Chris Lattner4e616762004-11-26 20:01:48 +0000296 // global/alloca/malloc, it cannot be accessing the global (it's
297 // undefined to load or store bytes before or after an object).
298 const Type *ElTy = cast<PointerType>(O1->getType())->getElementType();
299 unsigned GlobalSize = getTargetData().getTypeSize(ElTy);
Chris Lattner0a1ac902004-11-26 19:20:01 +0000300 if (GlobalSize < V2Size)
301 return NoAlias;
302 }
303 }
304
305 if (O2) {
306 if (!isa<Argument>(O2) && isa<ConstantPointerNull>(V1))
307 return NoAlias; // Unique values don't alias null
308
Chris Lattner4e616762004-11-26 20:01:48 +0000309 if (isa<GlobalVariable>(O2) || isa<AllocationInst>(O2))
310 if (cast<PointerType>(O2->getType())->getElementType()->isSized()) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000311 // If the size of the other access is larger than the total size of the
Chris Lattner4e616762004-11-26 20:01:48 +0000312 // global/alloca/malloc, it cannot be accessing the object (it's
313 // undefined to load or store bytes before or after an object).
314 const Type *ElTy = cast<PointerType>(O2->getType())->getElementType();
315 unsigned GlobalSize = getTargetData().getTypeSize(ElTy);
Chris Lattner0a1ac902004-11-26 19:20:01 +0000316 if (GlobalSize < V1Size)
317 return NoAlias;
318 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000319 }
320
Chris Lattnerb307c882003-12-11 22:44:13 +0000321 // If we have two gep instructions with must-alias'ing base pointers, figure
322 // out if the indexes to the GEP tell us anything about the derived pointer.
323 // Note that we also handle chains of getelementptr instructions as well as
324 // constant expression getelementptrs here.
Chris Lattnerd501c132003-02-26 19:41:54 +0000325 //
Chris Lattnerb307c882003-12-11 22:44:13 +0000326 if (isGEP(V1) && isGEP(V2)) {
327 // Drill down into the first non-gep value, to test for must-aliasing of
328 // the base pointers.
329 const Value *BasePtr1 = V1, *BasePtr2 = V2;
330 do {
331 BasePtr1 = cast<User>(BasePtr1)->getOperand(0);
332 } while (isGEP(BasePtr1) &&
333 cast<User>(BasePtr1)->getOperand(1) ==
334 Constant::getNullValue(cast<User>(BasePtr1)->getOperand(1)->getType()));
335 do {
336 BasePtr2 = cast<User>(BasePtr2)->getOperand(0);
337 } while (isGEP(BasePtr2) &&
338 cast<User>(BasePtr2)->getOperand(1) ==
339 Constant::getNullValue(cast<User>(BasePtr2)->getOperand(1)->getType()));
340
341 // Do the base pointers alias?
342 AliasResult BaseAlias = alias(BasePtr1, V1Size, BasePtr2, V2Size);
343 if (BaseAlias == NoAlias) return NoAlias;
344 if (BaseAlias == MustAlias) {
345 // If the base pointers alias each other exactly, check to see if we can
346 // figure out anything about the resultant pointers, to try to prove
347 // non-aliasing.
348
349 // Collect all of the chained GEP operands together into one simple place
Chris Lattner4a830882003-12-11 23:20:16 +0000350 std::vector<Value*> GEP1Ops, GEP2Ops;
351 BasePtr1 = GetGEPOperands(V1, GEP1Ops);
352 BasePtr2 = GetGEPOperands(V2, GEP2Ops);
Chris Lattnerb307c882003-12-11 22:44:13 +0000353
Chris Lattner730b1ad2004-07-29 07:56:39 +0000354 // If GetGEPOperands were able to fold to the same must-aliased pointer,
355 // do the comparison.
356 if (BasePtr1 == BasePtr2) {
357 AliasResult GAlias =
358 CheckGEPInstructions(BasePtr1->getType(), GEP1Ops, V1Size,
359 BasePtr2->getType(), GEP2Ops, V2Size);
360 if (GAlias != MayAlias)
361 return GAlias;
362 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000363 }
364 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000365
366 // Check to see if these two pointers are related by a getelementptr
367 // instruction. If one pointer is a GEP with a non-zero index of the other
368 // pointer, we know they cannot alias.
369 //
Chris Lattner4a830882003-12-11 23:20:16 +0000370 if (isGEP(V2)) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000371 std::swap(V1, V2);
372 std::swap(V1Size, V2Size);
373 }
374
Chris Lattnerc330ee62003-02-26 21:57:23 +0000375 if (V1Size != ~0U && V2Size != ~0U)
Chris Lattner4a830882003-12-11 23:20:16 +0000376 if (const User *GEP = isGEP(V1)) {
377 std::vector<Value*> GEPOperands;
378 const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
379
380 AliasResult R = alias(BasePtr, V1Size, V2, V2Size);
Chris Lattnerc330ee62003-02-26 21:57:23 +0000381 if (R == MustAlias) {
382 // If there is at least one non-zero constant index, we know they cannot
383 // alias.
384 bool ConstantFound = false;
Chris Lattner88d3e032003-12-11 06:02:00 +0000385 bool AllZerosFound = true;
Chris Lattner4a830882003-12-11 23:20:16 +0000386 for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
387 if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
Chris Lattnerc330ee62003-02-26 21:57:23 +0000388 if (!C->isNullValue()) {
389 ConstantFound = true;
Chris Lattnerc54735e2003-12-11 06:06:28 +0000390 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000391 break;
Chris Lattner88d3e032003-12-11 06:02:00 +0000392 }
393 } else {
394 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000395 }
Chris Lattner88d3e032003-12-11 06:02:00 +0000396
397 // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
398 // the ptr, the end result is a must alias also.
399 if (AllZerosFound)
400 return MustAlias;
401
Chris Lattnerc330ee62003-02-26 21:57:23 +0000402 if (ConstantFound) {
403 if (V2Size <= 1 && V1Size <= 1) // Just pointer check?
Chris Lattnerd501c132003-02-26 19:41:54 +0000404 return NoAlias;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000405
406 // Otherwise we have to check to see that the distance is more than
407 // the size of the argument... build an index vector that is equal to
408 // the arguments provided, except substitute 0's for any variable
409 // indexes we find...
Chris Lattner4a830882003-12-11 23:20:16 +0000410 for (unsigned i = 0; i != GEPOperands.size(); ++i)
Chris Lattnerbc2a99b2004-11-17 17:39:39 +0000411 if (!isa<ConstantInt>(GEPOperands[i]))
Chris Lattner4a830882003-12-11 23:20:16 +0000412 GEPOperands[i] =Constant::getNullValue(GEPOperands[i]->getType());
413 int64_t Offset = getTargetData().getIndexedOffset(BasePtr->getType(),
414 GEPOperands);
415 if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
Chris Lattnerc330ee62003-02-26 21:57:23 +0000416 return NoAlias;
417 }
418 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000419 }
Chris Lattnerc330ee62003-02-26 21:57:23 +0000420
Chris Lattnerd501c132003-02-26 19:41:54 +0000421 return MayAlias;
422}
423
Chris Lattner28977af2004-04-05 01:30:19 +0000424static bool ValuesEqual(Value *V1, Value *V2) {
425 if (V1->getType() == V2->getType())
426 return V1 == V2;
427 if (Constant *C1 = dyn_cast<Constant>(V1))
428 if (Constant *C2 = dyn_cast<Constant>(V2)) {
429 // Sign extend the constants to long types.
430 C1 = ConstantExpr::getSignExtend(C1, Type::LongTy);
431 C2 = ConstantExpr::getSignExtend(C2, Type::LongTy);
432 return C1 == C2;
433 }
434 return false;
435}
436
Chris Lattnerb307c882003-12-11 22:44:13 +0000437/// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
438/// base pointers. This checks to see if the index expressions preclude the
439/// pointers from aliasing...
440AliasAnalysis::AliasResult BasicAliasAnalysis::
441CheckGEPInstructions(const Type* BasePtr1Ty, std::vector<Value*> &GEP1Ops,
442 unsigned G1S,
443 const Type *BasePtr2Ty, std::vector<Value*> &GEP2Ops,
444 unsigned G2S) {
445 // We currently can't handle the case when the base pointers have different
446 // primitive types. Since this is uncommon anyway, we are happy being
447 // extremely conservative.
448 if (BasePtr1Ty != BasePtr2Ty)
449 return MayAlias;
450
451 const Type *GEPPointerTy = BasePtr1Ty;
452
453 // Find the (possibly empty) initial sequence of equal values... which are not
454 // necessarily constants.
455 unsigned NumGEP1Operands = GEP1Ops.size(), NumGEP2Operands = GEP2Ops.size();
456 unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
457 unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
458 unsigned UnequalOper = 0;
459 while (UnequalOper != MinOperands &&
Chris Lattner28977af2004-04-05 01:30:19 +0000460 ValuesEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper])) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000461 // Advance through the type as we go...
462 ++UnequalOper;
463 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
464 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
465 else {
466 // If all operands equal each other, then the derived pointers must
467 // alias each other...
468 BasePtr1Ty = 0;
469 assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
470 "Ran out of type nesting, but not out of operands?");
471 return MustAlias;
Chris Lattner920bd792003-06-02 05:42:39 +0000472 }
473 }
Chris Lattner920bd792003-06-02 05:42:39 +0000474
Chris Lattnerb307c882003-12-11 22:44:13 +0000475 // If we have seen all constant operands, and run out of indexes on one of the
476 // getelementptrs, check to see if the tail of the leftover one is all zeros.
477 // If so, return mustalias.
Chris Lattner4a830882003-12-11 23:20:16 +0000478 if (UnequalOper == MinOperands) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000479 if (GEP1Ops.size() < GEP2Ops.size()) std::swap(GEP1Ops, GEP2Ops);
Chris Lattnerd501c132003-02-26 19:41:54 +0000480
Chris Lattnerb307c882003-12-11 22:44:13 +0000481 bool AllAreZeros = true;
482 for (unsigned i = UnequalOper; i != MaxOperands; ++i)
Chris Lattnera35339d2004-10-16 16:07:10 +0000483 if (!isa<Constant>(GEP1Ops[i]) ||
Chris Lattnerb307c882003-12-11 22:44:13 +0000484 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
485 AllAreZeros = false;
486 break;
487 }
488 if (AllAreZeros) return MustAlias;
489 }
490
Chris Lattnerd501c132003-02-26 19:41:54 +0000491
492 // So now we know that the indexes derived from the base pointers,
493 // which are known to alias, are different. We can still determine a
494 // no-alias result if there are differing constant pairs in the index
495 // chain. For example:
496 // A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
497 //
498 unsigned SizeMax = std::max(G1S, G2S);
499 if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work...
Chris Lattner920bd792003-06-02 05:42:39 +0000500
Chris Lattnerd501c132003-02-26 19:41:54 +0000501 // Scan for the first operand that is constant and unequal in the
Chris Lattner28977af2004-04-05 01:30:19 +0000502 // two getelementptrs...
Chris Lattnerd501c132003-02-26 19:41:54 +0000503 unsigned FirstConstantOper = UnequalOper;
Chris Lattnerb307c882003-12-11 22:44:13 +0000504 for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
505 const Value *G1Oper = GEP1Ops[FirstConstantOper];
506 const Value *G2Oper = GEP2Ops[FirstConstantOper];
507
Chris Lattner6eb88d42004-01-12 17:57:32 +0000508 if (G1Oper != G2Oper) // Found non-equal constant indexes...
Chris Lattnera35339d2004-10-16 16:07:10 +0000509 if (Constant *G1OC = dyn_cast<ConstantInt>(const_cast<Value*>(G1Oper)))
510 if (Constant *G2OC = dyn_cast<ConstantInt>(const_cast<Value*>(G2Oper))){
Chris Lattner28977af2004-04-05 01:30:19 +0000511 if (G1OC->getType() != G2OC->getType()) {
512 // Sign extend both operands to long.
513 G1OC = ConstantExpr::getSignExtend(G1OC, Type::LongTy);
514 G2OC = ConstantExpr::getSignExtend(G2OC, Type::LongTy);
515 GEP1Ops[FirstConstantOper] = G1OC;
516 GEP2Ops[FirstConstantOper] = G2OC;
517 }
518
519 if (G1OC != G2OC) {
Chris Lattnera35339d2004-10-16 16:07:10 +0000520 // Make sure they are comparable (ie, not constant expressions), and
521 // make sure the GEP with the smaller leading constant is GEP1.
Chris Lattner28977af2004-04-05 01:30:19 +0000522 Constant *Compare = ConstantExpr::getSetGT(G1OC, G2OC);
523 if (ConstantBool *CV = dyn_cast<ConstantBool>(Compare)) {
524 if (CV->getValue()) // If they are comparable and G2 > G1
525 std::swap(GEP1Ops, GEP2Ops); // Make GEP1 < GEP2
526 break;
527 }
Chris Lattner6eb88d42004-01-12 17:57:32 +0000528 }
529 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000530 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
Chris Lattnerd501c132003-02-26 19:41:54 +0000531 }
532
Chris Lattnerb307c882003-12-11 22:44:13 +0000533 // No shared constant operands, and we ran out of common operands. At this
534 // point, the GEP instructions have run through all of their operands, and we
535 // haven't found evidence that there are any deltas between the GEP's.
536 // However, one GEP may have more operands than the other. If this is the
Chris Lattner28977af2004-04-05 01:30:19 +0000537 // case, there may still be hope. Check this now.
Chris Lattnerb307c882003-12-11 22:44:13 +0000538 if (FirstConstantOper == MinOperands) {
539 // Make GEP1Ops be the longer one if there is a longer one.
540 if (GEP1Ops.size() < GEP2Ops.size())
541 std::swap(GEP1Ops, GEP2Ops);
542
543 // Is there anything to check?
544 if (GEP1Ops.size() > MinOperands) {
545 for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
Chris Lattnerf70770a2004-07-14 20:27:12 +0000546 if (isa<ConstantInt>(GEP1Ops[i]) &&
Chris Lattnerb307c882003-12-11 22:44:13 +0000547 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
548 // Yup, there's a constant in the tail. Set all variables to
549 // constants in the GEP instruction to make it suiteable for
550 // TargetData::getIndexedOffset.
551 for (i = 0; i != MaxOperands; ++i)
Chris Lattnerf70770a2004-07-14 20:27:12 +0000552 if (!isa<ConstantInt>(GEP1Ops[i]))
Chris Lattnerb307c882003-12-11 22:44:13 +0000553 GEP1Ops[i] = Constant::getNullValue(GEP1Ops[i]->getType());
554 // Okay, now get the offset. This is the relative offset for the full
555 // instruction.
556 const TargetData &TD = getTargetData();
557 int64_t Offset1 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops);
558
559 // Now crop off any constants from the end...
560 GEP1Ops.resize(MinOperands);
561 int64_t Offset2 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops);
562
563 // If the tail provided a bit enough offset, return noalias!
564 if ((uint64_t)(Offset2-Offset1) >= SizeMax)
565 return NoAlias;
566 }
567 }
568
569 // Couldn't find anything useful.
570 return MayAlias;
571 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000572
573 // If there are non-equal constants arguments, then we can figure
574 // out a minimum known delta between the two index expressions... at
575 // this point we know that the first constant index of GEP1 is less
576 // than the first constant index of GEP2.
Chris Lattner1af55e12003-11-25 20:10:07 +0000577
Chris Lattnerb307c882003-12-11 22:44:13 +0000578 // Advance BasePtr[12]Ty over this first differing constant operand.
579 BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(GEP2Ops[FirstConstantOper]);
580 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(GEP1Ops[FirstConstantOper]);
Chris Lattnerd501c132003-02-26 19:41:54 +0000581
Chris Lattnerb307c882003-12-11 22:44:13 +0000582 // We are going to be using TargetData::getIndexedOffset to determine the
583 // offset that each of the GEP's is reaching. To do this, we have to convert
584 // all variable references to constant references. To do this, we convert the
585 // initial equal sequence of variables into constant zeros to start with.
Chris Lattnera35339d2004-10-16 16:07:10 +0000586 for (unsigned i = 0; i != FirstConstantOper; ++i)
587 if (!isa<ConstantInt>(GEP1Ops[i]) || !isa<ConstantInt>(GEP2Ops[i]))
Chris Lattner28977af2004-04-05 01:30:19 +0000588 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Type::UIntTy);
Chris Lattnerb307c882003-12-11 22:44:13 +0000589
590 // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
Chris Lattnerd501c132003-02-26 19:41:54 +0000591
592 // Loop over the rest of the operands...
Chris Lattnerb307c882003-12-11 22:44:13 +0000593 for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
594 const Value *Op1 = i < GEP1Ops.size() ? GEP1Ops[i] : 0;
595 const Value *Op2 = i < GEP2Ops.size() ? GEP2Ops[i] : 0;
596 // If they are equal, use a zero index...
597 if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
Chris Lattnera35339d2004-10-16 16:07:10 +0000598 if (!isa<ConstantInt>(Op1))
Chris Lattnerb307c882003-12-11 22:44:13 +0000599 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Op1->getType());
600 // Otherwise, just keep the constants we have.
Chris Lattnerd501c132003-02-26 19:41:54 +0000601 } else {
Chris Lattnerb307c882003-12-11 22:44:13 +0000602 if (Op1) {
603 if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
604 // If this is an array index, make sure the array element is in range.
605 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
606 if (Op1C->getRawValue() >= AT->getNumElements())
607 return MayAlias; // Be conservative with out-of-range accesses
608
609 } else {
610 // GEP1 is known to produce a value less than GEP2. To be
611 // conservatively correct, we must assume the largest possible
612 // constant is used in this position. This cannot be the initial
613 // index to the GEP instructions (because we know we have at least one
614 // element before this one with the different constant arguments), so
615 // we know that the current index must be into either a struct or
616 // array. Because we know it's not constant, this cannot be a
617 // structure index. Because of this, we can calculate the maximum
618 // value possible.
619 //
620 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
621 GEP1Ops[i] = ConstantSInt::get(Type::LongTy,AT->getNumElements()-1);
622 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000623 }
624
Chris Lattnerb307c882003-12-11 22:44:13 +0000625 if (Op2) {
626 if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
627 // If this is an array index, make sure the array element is in range.
628 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
629 if (Op2C->getRawValue() >= AT->getNumElements())
630 return MayAlias; // Be conservative with out-of-range accesses
631 } else { // Conservatively assume the minimum value for this index
632 GEP2Ops[i] = Constant::getNullValue(Op2->getType());
633 }
Chris Lattner920bd792003-06-02 05:42:39 +0000634 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000635 }
636
637 if (BasePtr1Ty && Op1) {
638 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
639 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
640 else
641 BasePtr1Ty = 0;
642 }
643
644 if (BasePtr2Ty && Op2) {
645 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
646 BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
647 else
648 BasePtr2Ty = 0;
Chris Lattnerd501c132003-02-26 19:41:54 +0000649 }
650 }
651
Chris Lattnerb307c882003-12-11 22:44:13 +0000652 int64_t Offset1 = getTargetData().getIndexedOffset(GEPPointerTy, GEP1Ops);
653 int64_t Offset2 = getTargetData().getIndexedOffset(GEPPointerTy, GEP2Ops);
Chris Lattnerd501c132003-02-26 19:41:54 +0000654 assert(Offset1 < Offset2 &&"There is at least one different constant here!");
655
Chris Lattner807b7052003-04-25 18:03:06 +0000656 if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000657 //std::cerr << "Determined that these two GEP's don't alias ["
658 // << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
659 return NoAlias;
660 }
661 return MayAlias;
662}
663
Chris Lattner4244bb52004-03-15 03:36:49 +0000664namespace {
665 struct StringCompare {
666 bool operator()(const char *LHS, const char *RHS) {
667 return strcmp(LHS, RHS) < 0;
668 }
669 };
670}
671
672// Note that this list cannot contain libm functions (such as acos and sqrt)
673// that set errno on a domain or other error.
674static const char *DoesntAccessMemoryTable[] = {
Chris Lattnerb903fc52004-04-10 06:55:27 +0000675 // LLVM intrinsics:
Chris Lattner4ee623d2004-06-15 21:52:58 +0000676 "llvm.frameaddress", "llvm.returnaddress", "llvm.readport", "llvm.isunordered",
Chris Lattnerb903fc52004-04-10 06:55:27 +0000677
Chris Lattner4244bb52004-03-15 03:36:49 +0000678 "abs", "labs", "llabs", "imaxabs", "fabs", "fabsf", "fabsl",
679 "trunc", "truncf", "truncl", "ldexp",
680
681 "atan", "atanf", "atanl", "atan2", "atan2f", "atan2l",
682 "cbrt",
683 "cos", "cosf", "cosl", "cosh", "coshf", "coshl",
684 "exp", "expf", "expl",
685 "hypot",
686 "sin", "sinf", "sinl", "sinh", "sinhf", "sinhl",
687 "tan", "tanf", "tanl", "tanh", "tanhf", "tanhl",
688
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000689 // ctype.h
Chris Lattner4244bb52004-03-15 03:36:49 +0000690 "isalnum", "isalpha", "iscntrl", "isdigit", "isgraph", "islower", "isprint"
691 "ispunct", "isspace", "isupper", "isxdigit", "tolower", "toupper",
692
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000693 // wctype.h"
Chris Lattner4244bb52004-03-15 03:36:49 +0000694 "iswalnum", "iswalpha", "iswcntrl", "iswdigit", "iswgraph", "iswlower",
695 "iswprint", "iswpunct", "iswspace", "iswupper", "iswxdigit",
696
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000697 "iswctype", "towctrans", "towlower", "towupper",
698
Chris Lattner4244bb52004-03-15 03:36:49 +0000699 "btowc", "wctob",
Chris Lattner002be762004-03-16 03:41:35 +0000700
701 "isinf", "isnan", "finite",
702
703 // C99 math functions
704 "copysign", "copysignf", "copysignd",
705 "nexttoward", "nexttowardf", "nexttowardd",
706 "nextafter", "nextafterf", "nextafterd",
707
708 // glibc functions:
709 "__fpclassify", "__fpclassifyf", "__fpclassifyl",
710 "__signbit", "__signbitf", "__signbitl",
Chris Lattner4244bb52004-03-15 03:36:49 +0000711};
712
713static const unsigned DAMTableSize =
714 sizeof(DoesntAccessMemoryTable)/sizeof(DoesntAccessMemoryTable[0]);
715
716/// doesNotAccessMemory - Return true if we know that the function does not
717/// access memory at all. Since basicaa does no analysis, we can only do simple
718/// things here. In particular, if we have an external function with the name
719/// of a standard C library function, we are allowed to assume it will be
720/// resolved by libc, so we can hardcode some entries in here.
721bool BasicAliasAnalysis::doesNotAccessMemory(Function *F) {
722 if (!F->isExternal()) return false;
723
724 static bool Initialized = false;
725 if (!Initialized) {
726 // Sort the table the first time through.
727 std::sort(DoesntAccessMemoryTable, DoesntAccessMemoryTable+DAMTableSize,
728 StringCompare());
729 Initialized = true;
730 }
731
732 const char **Ptr = std::lower_bound(DoesntAccessMemoryTable,
733 DoesntAccessMemoryTable+DAMTableSize,
734 F->getName().c_str(), StringCompare());
735 return Ptr != DoesntAccessMemoryTable+DAMTableSize && *Ptr == F->getName();
736}
737
738
739static const char *OnlyReadsMemoryTable[] = {
Chris Lattner002be762004-03-16 03:41:35 +0000740 "atoi", "atol", "atof", "atoll", "atoq", "a64l",
741 "bcmp", "memcmp", "memchr", "memrchr", "wmemcmp", "wmemchr",
Chris Lattner4244bb52004-03-15 03:36:49 +0000742
743 // Strings
744 "strcmp", "strcasecmp", "strcoll", "strncmp", "strncasecmp",
745 "strchr", "strcspn", "strlen", "strpbrk", "strrchr", "strspn", "strstr",
Chris Lattner002be762004-03-16 03:41:35 +0000746 "index", "rindex",
Chris Lattner4244bb52004-03-15 03:36:49 +0000747
748 // Wide char strings
749 "wcschr", "wcscmp", "wcscoll", "wcscspn", "wcslen", "wcsncmp", "wcspbrk",
750 "wcsrchr", "wcsspn", "wcsstr",
Chris Lattner002be762004-03-16 03:41:35 +0000751
752 // glibc
753 "alphasort", "alphasort64", "versionsort", "versionsort64",
754
755 // C99
756 "nan", "nanf", "nand",
Chris Lattnerb903fc52004-04-10 06:55:27 +0000757
758 // File I/O
759 "feof", "ferror", "fileno",
760 "feof_unlocked", "ferror_unlocked", "fileno_unlocked"
Chris Lattner4244bb52004-03-15 03:36:49 +0000761};
762
763static const unsigned ORMTableSize =
764 sizeof(OnlyReadsMemoryTable)/sizeof(OnlyReadsMemoryTable[0]);
765
766bool BasicAliasAnalysis::onlyReadsMemory(Function *F) {
767 if (doesNotAccessMemory(F)) return true;
768 if (!F->isExternal()) return false;
769
770 static bool Initialized = false;
771 if (!Initialized) {
772 // Sort the table the first time through.
773 std::sort(OnlyReadsMemoryTable, OnlyReadsMemoryTable+ORMTableSize,
774 StringCompare());
775 Initialized = true;
776 }
777
778 const char **Ptr = std::lower_bound(OnlyReadsMemoryTable,
779 OnlyReadsMemoryTable+ORMTableSize,
780 F->getName().c_str(), StringCompare());
781 return Ptr != OnlyReadsMemoryTable+ORMTableSize && *Ptr == F->getName();
782}
783
784