blob: 76c3a35c410f857dce3b7ab8f1f770af4170a70f [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"
Chris Lattnerec4e8082003-11-25 18:33:40 +000025using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000026
Chris Lattnerd501c132003-02-26 19:41:54 +000027// Make sure that anything that uses AliasAnalysis pulls in this file...
Chris Lattner86391452003-12-11 05:44:59 +000028void llvm::BasicAAStub() {}
Chris Lattnerd501c132003-02-26 19:41:54 +000029
Chris Lattnerd501c132003-02-26 19:41:54 +000030namespace {
Chris Lattnerb52f4402004-05-23 21:15:12 +000031 /// NoAA - This class implements the -no-aa pass, which always returns "I
32 /// don't know" for alias queries. NoAA is unlike other alias analysis
33 /// implementations, in that it does not chain to a previous analysis. As
34 /// such it doesn't follow many of the rules that other alias analyses must.
35 ///
36 struct NoAA : public ImmutablePass, public AliasAnalysis {
Chris Lattner689835a2004-06-19 08:05:58 +000037 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
38 AU.addRequired<TargetData>();
39 }
40
41 virtual void initializePass() {
42 TD = &getAnalysis<TargetData>();
43 }
44
Chris Lattnerb52f4402004-05-23 21:15:12 +000045 virtual AliasResult alias(const Value *V1, unsigned V1Size,
46 const Value *V2, unsigned V2Size) {
47 return MayAlias;
48 }
49
50 virtual void getMustAliases(Value *P, std::vector<Value*> &RetVals) { }
51 virtual bool pointsToConstantMemory(const Value *P) { return false; }
52 virtual bool doesNotAccessMemory(Function *F) { return false; }
53 virtual bool onlyReadsMemory(Function *F) { return false; }
54 virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
55 return ModRef;
56 }
57 virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
58 return ModRef;
59 }
60 virtual bool hasNoModRefInfoForCalls() const { return true; }
61
62 virtual void deleteValue(Value *V) {}
63 virtual void copyValue(Value *From, Value *To) {}
Chris Lattnerb52f4402004-05-23 21:15:12 +000064 };
65
66 // Register this pass...
67 RegisterOpt<NoAA>
68 U("no-aa", "No Alias Analysis (always returns 'may' alias)");
69
70 // Declare that we implement the AliasAnalysis interface
71 RegisterAnalysisGroup<AliasAnalysis, NoAA> V;
72} // End of anonymous namespace
73
74
75namespace {
76 /// BasicAliasAnalysis - This is the default alias analysis implementation.
77 /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
78 /// derives from the NoAA class.
79 struct BasicAliasAnalysis : public NoAA {
Chris Lattnerd501c132003-02-26 19:41:54 +000080 AliasResult alias(const Value *V1, unsigned V1Size,
81 const Value *V2, unsigned V2Size);
Chris Lattnerbc1daaa2004-01-30 22:17:24 +000082
Chris Lattner04b75932004-03-12 22:39:00 +000083 ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
84
Chris Lattnere181b942004-07-27 02:13:55 +000085 /// hasNoModRefInfoForCalls - We can provide mod/ref information against
86 /// non-escaping allocations.
87 virtual bool hasNoModRefInfoForCalls() const { return false; }
Chris Lattner65585aa2004-04-11 16:43:07 +000088
Chris Lattnerbc1daaa2004-01-30 22:17:24 +000089 /// pointsToConstantMemory - Chase pointers until we find a (constant
90 /// global) or not.
91 bool pointsToConstantMemory(const Value *P);
92
Chris Lattner4244bb52004-03-15 03:36:49 +000093 virtual bool doesNotAccessMemory(Function *F);
94 virtual bool onlyReadsMemory(Function *F);
95
Chris Lattnerd501c132003-02-26 19:41:54 +000096 private:
Chris Lattnerb307c882003-12-11 22:44:13 +000097 // CheckGEPInstructions - Check two GEP instructions with known
98 // must-aliasing base pointers. This checks to see if the index expressions
Chris Lattnerd501c132003-02-26 19:41:54 +000099 // preclude the pointers from aliasing...
Chris Lattnerb307c882003-12-11 22:44:13 +0000100 AliasResult
101 CheckGEPInstructions(const Type* BasePtr1Ty, std::vector<Value*> &GEP1Ops,
102 unsigned G1Size,
103 const Type *BasePtr2Ty, std::vector<Value*> &GEP2Ops,
104 unsigned G2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000105 };
106
107 // Register this pass...
108 RegisterOpt<BasicAliasAnalysis>
109 X("basicaa", "Basic Alias Analysis (default AA impl)");
110
111 // Declare that we implement the AliasAnalysis interface
112 RegisterAnalysisGroup<AliasAnalysis, BasicAliasAnalysis, true> Y;
113} // End of anonymous namespace
114
Chris Lattnerc1820032003-09-20 03:08:47 +0000115// hasUniqueAddress - Return true if the specified value points to something
116// with a unique, discernable, address.
Chris Lattnerd501c132003-02-26 19:41:54 +0000117static inline bool hasUniqueAddress(const Value *V) {
Chris Lattnerc1820032003-09-20 03:08:47 +0000118 return isa<GlobalValue>(V) || isa<AllocationInst>(V);
Chris Lattnerd501c132003-02-26 19:41:54 +0000119}
120
Chris Lattnerc1820032003-09-20 03:08:47 +0000121// getUnderlyingObject - This traverses the use chain to figure out what object
122// the specified value points to. If the value points to, or is derived from, a
123// unique object or an argument, return it.
Chris Lattnerd501c132003-02-26 19:41:54 +0000124static const Value *getUnderlyingObject(const Value *V) {
125 if (!isa<PointerType>(V->getType())) return 0;
126
127 // If we are at some type of object... return it.
Chris Lattnerc1820032003-09-20 03:08:47 +0000128 if (hasUniqueAddress(V) || isa<Argument>(V)) return V;
Chris Lattnerd501c132003-02-26 19:41:54 +0000129
130 // Traverse through different addressing mechanisms...
131 if (const Instruction *I = dyn_cast<Instruction>(V)) {
132 if (isa<CastInst>(I) || isa<GetElementPtrInst>(I))
133 return getUnderlyingObject(I->getOperand(0));
Chris Lattner388f6692003-06-17 15:25:37 +0000134 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
135 if (CE->getOpcode() == Instruction::Cast ||
136 CE->getOpcode() == Instruction::GetElementPtr)
137 return getUnderlyingObject(CE->getOperand(0));
Reid Spencere8404342004-07-18 00:18:30 +0000138 } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
139 return GV;
Chris Lattnerd501c132003-02-26 19:41:54 +0000140 }
141 return 0;
142}
143
Chris Lattnerb307c882003-12-11 22:44:13 +0000144static const User *isGEP(const Value *V) {
145 if (isa<GetElementPtrInst>(V) ||
146 (isa<ConstantExpr>(V) &&
147 cast<ConstantExpr>(V)->getOpcode() == Instruction::GetElementPtr))
148 return cast<User>(V);
149 return 0;
150}
Chris Lattnerd501c132003-02-26 19:41:54 +0000151
Chris Lattner4a830882003-12-11 23:20:16 +0000152static const Value *GetGEPOperands(const Value *V, std::vector<Value*> &GEPOps){
153 assert(GEPOps.empty() && "Expect empty list to populate!");
154 GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
155 cast<User>(V)->op_end());
156
157 // Accumulate all of the chained indexes into the operand array
158 V = cast<User>(V)->getOperand(0);
159
160 while (const User *G = isGEP(V)) {
Reid Spencere8404342004-07-18 00:18:30 +0000161 if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
Chris Lattner4a830882003-12-11 23:20:16 +0000162 !cast<Constant>(GEPOps[0])->isNullValue())
163 break; // Don't handle folding arbitrary pointer offsets yet...
164 GEPOps.erase(GEPOps.begin()); // Drop the zero index
165 GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
166 V = G->getOperand(0);
167 }
168 return V;
169}
170
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000171/// pointsToConstantMemory - Chase pointers until we find a (constant
172/// global) or not.
173bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
Chris Lattnera4dd6742004-01-30 22:48:02 +0000174 if (const Value *V = getUnderlyingObject(P))
175 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
176 return GV->isConstant();
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000177 return false;
178}
Chris Lattner4a830882003-12-11 23:20:16 +0000179
Chris Lattner04b75932004-03-12 22:39:00 +0000180static bool AddressMightEscape(const Value *V) {
181 for (Value::use_const_iterator UI = V->use_begin(), E = V->use_end();
182 UI != E; ++UI) {
183 const Instruction *I = cast<Instruction>(*UI);
184 switch (I->getOpcode()) {
185 case Instruction::Load: break;
186 case Instruction::Store:
187 if (I->getOperand(0) == V)
188 return true; // Escapes if the pointer is stored.
189 break;
190 case Instruction::GetElementPtr:
191 if (AddressMightEscape(I)) return true;
192 break;
193 case Instruction::Cast:
194 if (!isa<PointerType>(I->getType()))
195 return true;
196 if (AddressMightEscape(I)) return true;
197 break;
Chris Lattnerdb5b80a2004-07-27 02:18:52 +0000198 case Instruction::Ret:
199 // If returned, the address will escape to calling functions, but no
200 // callees could modify it.
201 break;
Chris Lattner04b75932004-03-12 22:39:00 +0000202 default:
203 return true;
204 }
205 }
206 return false;
207}
208
209// getModRefInfo - Check to see if the specified callsite can clobber the
210// specified memory object. Since we only look at local properties of this
211// function, we really can't say much about this query. We do, however, use
212// simple "address taken" analysis on local objects.
213//
214AliasAnalysis::ModRefResult
215BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
Reid Spencere8404342004-07-18 00:18:30 +0000216 if (!isa<Constant>(P))
Chris Lattner04b75932004-03-12 22:39:00 +0000217 if (const AllocationInst *AI =
Chris Lattner7a82ba02004-03-12 23:12:55 +0000218 dyn_cast_or_null<AllocationInst>(getUnderlyingObject(P))) {
Chris Lattner04b75932004-03-12 22:39:00 +0000219 // Okay, the pointer is to a stack allocated object. If we can prove that
220 // the pointer never "escapes", then we know the call cannot clobber it,
221 // because it simply can't get its address.
222 if (!AddressMightEscape(AI))
223 return NoModRef;
224 }
225
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000226 // The AliasAnalysis base class has some smarts, lets use them.
227 return AliasAnalysis::getModRefInfo(CS, P, Size);
Chris Lattner04b75932004-03-12 22:39:00 +0000228}
229
Chris Lattnerd501c132003-02-26 19:41:54 +0000230// alias - Provide a bunch of ad-hoc rules to disambiguate in common cases, such
231// as array references. Note that this function is heavily tail recursive.
232// Hopefully we have a smart C++ compiler. :)
233//
234AliasAnalysis::AliasResult
235BasicAliasAnalysis::alias(const Value *V1, unsigned V1Size,
236 const Value *V2, unsigned V2Size) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000237 // Strip off any constant expression casts if they exist
238 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V1))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000239 if (CE->getOpcode() == Instruction::Cast &&
240 isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000241 V1 = CE->getOperand(0);
242 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V2))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000243 if (CE->getOpcode() == Instruction::Cast &&
244 isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000245 V2 = CE->getOperand(0);
246
Chris Lattnerd501c132003-02-26 19:41:54 +0000247 // Are we checking for alias of the same value?
248 if (V1 == V2) return MustAlias;
249
250 if ((!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType())) &&
251 V1->getType() != Type::LongTy && V2->getType() != Type::LongTy)
252 return NoAlias; // Scalars cannot alias each other
253
254 // Strip off cast instructions...
255 if (const Instruction *I = dyn_cast<CastInst>(V1))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000256 if (isa<PointerType>(I->getOperand(0)->getType()))
257 return alias(I->getOperand(0), V1Size, V2, V2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000258 if (const Instruction *I = dyn_cast<CastInst>(V2))
Chris Lattnerbb8f43c2004-07-21 03:56:54 +0000259 if (isa<PointerType>(I->getOperand(0)->getType()))
260 return alias(V1, V1Size, I->getOperand(0), V2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000261
262 // Figure out what objects these things are pointing to if we can...
263 const Value *O1 = getUnderlyingObject(V1);
264 const Value *O2 = getUnderlyingObject(V2);
265
Misha Brukman2f2d0652003-09-11 18:14:24 +0000266 // Pointing at a discernible object?
Chris Lattnerd501c132003-02-26 19:41:54 +0000267 if (O1 && O2) {
Chris Lattnerc1820032003-09-20 03:08:47 +0000268 if (isa<Argument>(O1)) {
269 // Incoming argument cannot alias locally allocated object!
270 if (isa<AllocationInst>(O2)) return NoAlias;
271 // Otherwise, nothing is known...
272 } else if (isa<Argument>(O2)) {
273 // Incoming argument cannot alias locally allocated object!
274 if (isa<AllocationInst>(O1)) return NoAlias;
275 // Otherwise, nothing is known...
276 } else {
277 // If they are two different objects, we know that we have no alias...
278 if (O1 != O2) return NoAlias;
279 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000280
281 // If they are the same object, they we can look at the indexes. If they
282 // index off of the object is the same for both pointers, they must alias.
283 // If they are provably different, they must not alias. Otherwise, we can't
284 // tell anything.
Chris Lattnerc1820032003-09-20 03:08:47 +0000285 } else if (O1 && !isa<Argument>(O1) && isa<ConstantPointerNull>(V2)) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000286 return NoAlias; // Unique values don't alias null
Chris Lattnerc1820032003-09-20 03:08:47 +0000287 } else if (O2 && !isa<Argument>(O2) && isa<ConstantPointerNull>(V1)) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000288 return NoAlias; // Unique values don't alias null
289 }
290
Chris Lattnerb307c882003-12-11 22:44:13 +0000291 // If we have two gep instructions with must-alias'ing base pointers, figure
292 // out if the indexes to the GEP tell us anything about the derived pointer.
293 // Note that we also handle chains of getelementptr instructions as well as
294 // constant expression getelementptrs here.
Chris Lattnerd501c132003-02-26 19:41:54 +0000295 //
Chris Lattnerb307c882003-12-11 22:44:13 +0000296 if (isGEP(V1) && isGEP(V2)) {
297 // Drill down into the first non-gep value, to test for must-aliasing of
298 // the base pointers.
299 const Value *BasePtr1 = V1, *BasePtr2 = V2;
300 do {
301 BasePtr1 = cast<User>(BasePtr1)->getOperand(0);
302 } while (isGEP(BasePtr1) &&
303 cast<User>(BasePtr1)->getOperand(1) ==
304 Constant::getNullValue(cast<User>(BasePtr1)->getOperand(1)->getType()));
305 do {
306 BasePtr2 = cast<User>(BasePtr2)->getOperand(0);
307 } while (isGEP(BasePtr2) &&
308 cast<User>(BasePtr2)->getOperand(1) ==
309 Constant::getNullValue(cast<User>(BasePtr2)->getOperand(1)->getType()));
310
311 // Do the base pointers alias?
312 AliasResult BaseAlias = alias(BasePtr1, V1Size, BasePtr2, V2Size);
313 if (BaseAlias == NoAlias) return NoAlias;
314 if (BaseAlias == MustAlias) {
315 // If the base pointers alias each other exactly, check to see if we can
316 // figure out anything about the resultant pointers, to try to prove
317 // non-aliasing.
318
319 // Collect all of the chained GEP operands together into one simple place
Chris Lattner4a830882003-12-11 23:20:16 +0000320 std::vector<Value*> GEP1Ops, GEP2Ops;
321 BasePtr1 = GetGEPOperands(V1, GEP1Ops);
322 BasePtr2 = GetGEPOperands(V2, GEP2Ops);
Chris Lattnerb307c882003-12-11 22:44:13 +0000323
Chris Lattner730b1ad2004-07-29 07:56:39 +0000324 // If GetGEPOperands were able to fold to the same must-aliased pointer,
325 // do the comparison.
326 if (BasePtr1 == BasePtr2) {
327 AliasResult GAlias =
328 CheckGEPInstructions(BasePtr1->getType(), GEP1Ops, V1Size,
329 BasePtr2->getType(), GEP2Ops, V2Size);
330 if (GAlias != MayAlias)
331 return GAlias;
332 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000333 }
334 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000335
336 // Check to see if these two pointers are related by a getelementptr
337 // instruction. If one pointer is a GEP with a non-zero index of the other
338 // pointer, we know they cannot alias.
339 //
Chris Lattner4a830882003-12-11 23:20:16 +0000340 if (isGEP(V2)) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000341 std::swap(V1, V2);
342 std::swap(V1Size, V2Size);
343 }
344
Chris Lattnerc330ee62003-02-26 21:57:23 +0000345 if (V1Size != ~0U && V2Size != ~0U)
Chris Lattner4a830882003-12-11 23:20:16 +0000346 if (const User *GEP = isGEP(V1)) {
347 std::vector<Value*> GEPOperands;
348 const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
349
350 AliasResult R = alias(BasePtr, V1Size, V2, V2Size);
Chris Lattnerc330ee62003-02-26 21:57:23 +0000351 if (R == MustAlias) {
352 // If there is at least one non-zero constant index, we know they cannot
353 // alias.
354 bool ConstantFound = false;
Chris Lattner88d3e032003-12-11 06:02:00 +0000355 bool AllZerosFound = true;
Chris Lattner4a830882003-12-11 23:20:16 +0000356 for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
357 if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
Chris Lattnerc330ee62003-02-26 21:57:23 +0000358 if (!C->isNullValue()) {
359 ConstantFound = true;
Chris Lattnerc54735e2003-12-11 06:06:28 +0000360 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000361 break;
Chris Lattner88d3e032003-12-11 06:02:00 +0000362 }
363 } else {
364 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000365 }
Chris Lattner88d3e032003-12-11 06:02:00 +0000366
367 // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
368 // the ptr, the end result is a must alias also.
369 if (AllZerosFound)
370 return MustAlias;
371
Chris Lattnerc330ee62003-02-26 21:57:23 +0000372 if (ConstantFound) {
373 if (V2Size <= 1 && V1Size <= 1) // Just pointer check?
Chris Lattnerd501c132003-02-26 19:41:54 +0000374 return NoAlias;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000375
376 // Otherwise we have to check to see that the distance is more than
377 // the size of the argument... build an index vector that is equal to
378 // the arguments provided, except substitute 0's for any variable
379 // indexes we find...
Chris Lattner4a830882003-12-11 23:20:16 +0000380 for (unsigned i = 0; i != GEPOperands.size(); ++i)
Reid Spencere8404342004-07-18 00:18:30 +0000381 if (!isa<Constant>(GEPOperands[i]) || isa<GlobalValue>(GEPOperands[i]) ||
Chris Lattner4a830882003-12-11 23:20:16 +0000382 isa<ConstantExpr>(GEPOperands[i]))
383 GEPOperands[i] =Constant::getNullValue(GEPOperands[i]->getType());
384 int64_t Offset = getTargetData().getIndexedOffset(BasePtr->getType(),
385 GEPOperands);
386 if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
Chris Lattnerc330ee62003-02-26 21:57:23 +0000387 return NoAlias;
388 }
389 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000390 }
Chris Lattnerc330ee62003-02-26 21:57:23 +0000391
Chris Lattnerd501c132003-02-26 19:41:54 +0000392 return MayAlias;
393}
394
Chris Lattner28977af2004-04-05 01:30:19 +0000395static bool ValuesEqual(Value *V1, Value *V2) {
396 if (V1->getType() == V2->getType())
397 return V1 == V2;
398 if (Constant *C1 = dyn_cast<Constant>(V1))
399 if (Constant *C2 = dyn_cast<Constant>(V2)) {
400 // Sign extend the constants to long types.
401 C1 = ConstantExpr::getSignExtend(C1, Type::LongTy);
402 C2 = ConstantExpr::getSignExtend(C2, Type::LongTy);
403 return C1 == C2;
404 }
405 return false;
406}
407
Chris Lattnerb307c882003-12-11 22:44:13 +0000408/// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
409/// base pointers. This checks to see if the index expressions preclude the
410/// pointers from aliasing...
411AliasAnalysis::AliasResult BasicAliasAnalysis::
412CheckGEPInstructions(const Type* BasePtr1Ty, std::vector<Value*> &GEP1Ops,
413 unsigned G1S,
414 const Type *BasePtr2Ty, std::vector<Value*> &GEP2Ops,
415 unsigned G2S) {
416 // We currently can't handle the case when the base pointers have different
417 // primitive types. Since this is uncommon anyway, we are happy being
418 // extremely conservative.
419 if (BasePtr1Ty != BasePtr2Ty)
420 return MayAlias;
421
422 const Type *GEPPointerTy = BasePtr1Ty;
423
424 // Find the (possibly empty) initial sequence of equal values... which are not
425 // necessarily constants.
426 unsigned NumGEP1Operands = GEP1Ops.size(), NumGEP2Operands = GEP2Ops.size();
427 unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
428 unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
429 unsigned UnequalOper = 0;
430 while (UnequalOper != MinOperands &&
Chris Lattner28977af2004-04-05 01:30:19 +0000431 ValuesEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper])) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000432 // Advance through the type as we go...
433 ++UnequalOper;
434 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
435 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
436 else {
437 // If all operands equal each other, then the derived pointers must
438 // alias each other...
439 BasePtr1Ty = 0;
440 assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
441 "Ran out of type nesting, but not out of operands?");
442 return MustAlias;
Chris Lattner920bd792003-06-02 05:42:39 +0000443 }
444 }
Chris Lattner920bd792003-06-02 05:42:39 +0000445
Chris Lattnerb307c882003-12-11 22:44:13 +0000446 // If we have seen all constant operands, and run out of indexes on one of the
447 // getelementptrs, check to see if the tail of the leftover one is all zeros.
448 // If so, return mustalias.
Chris Lattner4a830882003-12-11 23:20:16 +0000449 if (UnequalOper == MinOperands) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000450 if (GEP1Ops.size() < GEP2Ops.size()) std::swap(GEP1Ops, GEP2Ops);
Chris Lattnerd501c132003-02-26 19:41:54 +0000451
Chris Lattnerb307c882003-12-11 22:44:13 +0000452 bool AllAreZeros = true;
453 for (unsigned i = UnequalOper; i != MaxOperands; ++i)
Reid Spencere8404342004-07-18 00:18:30 +0000454 if (!isa<Constant>(GEP1Ops[i]) ||
Chris Lattnerb307c882003-12-11 22:44:13 +0000455 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
456 AllAreZeros = false;
457 break;
458 }
459 if (AllAreZeros) return MustAlias;
460 }
461
Chris Lattnerd501c132003-02-26 19:41:54 +0000462
463 // So now we know that the indexes derived from the base pointers,
464 // which are known to alias, are different. We can still determine a
465 // no-alias result if there are differing constant pairs in the index
466 // chain. For example:
467 // A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
468 //
469 unsigned SizeMax = std::max(G1S, G2S);
470 if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work...
Chris Lattner920bd792003-06-02 05:42:39 +0000471
Chris Lattnerd501c132003-02-26 19:41:54 +0000472 // Scan for the first operand that is constant and unequal in the
Chris Lattner28977af2004-04-05 01:30:19 +0000473 // two getelementptrs...
Chris Lattnerd501c132003-02-26 19:41:54 +0000474 unsigned FirstConstantOper = UnequalOper;
Chris Lattnerb307c882003-12-11 22:44:13 +0000475 for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
476 const Value *G1Oper = GEP1Ops[FirstConstantOper];
477 const Value *G2Oper = GEP2Ops[FirstConstantOper];
478
Chris Lattner6eb88d42004-01-12 17:57:32 +0000479 if (G1Oper != G2Oper) // Found non-equal constant indexes...
480 if (Constant *G1OC = dyn_cast<Constant>(const_cast<Value*>(G1Oper)))
481 if (Constant *G2OC = dyn_cast<Constant>(const_cast<Value*>(G2Oper))) {
Chris Lattner28977af2004-04-05 01:30:19 +0000482 if (G1OC->getType() != G2OC->getType()) {
483 // Sign extend both operands to long.
484 G1OC = ConstantExpr::getSignExtend(G1OC, Type::LongTy);
485 G2OC = ConstantExpr::getSignExtend(G2OC, Type::LongTy);
486 GEP1Ops[FirstConstantOper] = G1OC;
487 GEP2Ops[FirstConstantOper] = G2OC;
488 }
489
490 if (G1OC != G2OC) {
491 // Make sure they are comparable (ie, not constant expressions)...
492 // and make sure the GEP with the smaller leading constant is GEP1.
493 Constant *Compare = ConstantExpr::getSetGT(G1OC, G2OC);
494 if (ConstantBool *CV = dyn_cast<ConstantBool>(Compare)) {
495 if (CV->getValue()) // If they are comparable and G2 > G1
496 std::swap(GEP1Ops, GEP2Ops); // Make GEP1 < GEP2
497 break;
498 }
Chris Lattner6eb88d42004-01-12 17:57:32 +0000499 }
500 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000501 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
Chris Lattnerd501c132003-02-26 19:41:54 +0000502 }
503
Chris Lattnerb307c882003-12-11 22:44:13 +0000504 // No shared constant operands, and we ran out of common operands. At this
505 // point, the GEP instructions have run through all of their operands, and we
506 // haven't found evidence that there are any deltas between the GEP's.
507 // However, one GEP may have more operands than the other. If this is the
Chris Lattner28977af2004-04-05 01:30:19 +0000508 // case, there may still be hope. Check this now.
Chris Lattnerb307c882003-12-11 22:44:13 +0000509 if (FirstConstantOper == MinOperands) {
510 // Make GEP1Ops be the longer one if there is a longer one.
511 if (GEP1Ops.size() < GEP2Ops.size())
512 std::swap(GEP1Ops, GEP2Ops);
513
514 // Is there anything to check?
515 if (GEP1Ops.size() > MinOperands) {
516 for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
Chris Lattnerf70770a2004-07-14 20:27:12 +0000517 if (isa<ConstantInt>(GEP1Ops[i]) &&
Chris Lattnerb307c882003-12-11 22:44:13 +0000518 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
519 // Yup, there's a constant in the tail. Set all variables to
520 // constants in the GEP instruction to make it suiteable for
521 // TargetData::getIndexedOffset.
522 for (i = 0; i != MaxOperands; ++i)
Chris Lattnerf70770a2004-07-14 20:27:12 +0000523 if (!isa<ConstantInt>(GEP1Ops[i]))
Chris Lattnerb307c882003-12-11 22:44:13 +0000524 GEP1Ops[i] = Constant::getNullValue(GEP1Ops[i]->getType());
525 // Okay, now get the offset. This is the relative offset for the full
526 // instruction.
527 const TargetData &TD = getTargetData();
528 int64_t Offset1 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops);
529
530 // Now crop off any constants from the end...
531 GEP1Ops.resize(MinOperands);
532 int64_t Offset2 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops);
533
534 // If the tail provided a bit enough offset, return noalias!
535 if ((uint64_t)(Offset2-Offset1) >= SizeMax)
536 return NoAlias;
537 }
538 }
539
540 // Couldn't find anything useful.
541 return MayAlias;
542 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000543
544 // If there are non-equal constants arguments, then we can figure
545 // out a minimum known delta between the two index expressions... at
546 // this point we know that the first constant index of GEP1 is less
547 // than the first constant index of GEP2.
Chris Lattner1af55e12003-11-25 20:10:07 +0000548
Chris Lattnerb307c882003-12-11 22:44:13 +0000549 // Advance BasePtr[12]Ty over this first differing constant operand.
550 BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(GEP2Ops[FirstConstantOper]);
551 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(GEP1Ops[FirstConstantOper]);
Chris Lattnerd501c132003-02-26 19:41:54 +0000552
Chris Lattnerb307c882003-12-11 22:44:13 +0000553 // We are going to be using TargetData::getIndexedOffset to determine the
554 // offset that each of the GEP's is reaching. To do this, we have to convert
555 // all variable references to constant references. To do this, we convert the
556 // initial equal sequence of variables into constant zeros to start with.
557 for (unsigned i = 0; i != FirstConstantOper; ++i) {
558 if (!isa<Constant>(GEP1Ops[i]) || isa<ConstantExpr>(GEP1Ops[i]) ||
Chris Lattner28977af2004-04-05 01:30:19 +0000559 !isa<Constant>(GEP2Ops[i]) || isa<ConstantExpr>(GEP2Ops[i]))
560 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Type::UIntTy);
Chris Lattnerb307c882003-12-11 22:44:13 +0000561 }
562
563 // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
Chris Lattnerd501c132003-02-26 19:41:54 +0000564
565 // Loop over the rest of the operands...
Chris Lattnerb307c882003-12-11 22:44:13 +0000566 for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
567 const Value *Op1 = i < GEP1Ops.size() ? GEP1Ops[i] : 0;
568 const Value *Op2 = i < GEP2Ops.size() ? GEP2Ops[i] : 0;
569 // If they are equal, use a zero index...
570 if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
571 if (!isa<Constant>(Op1) || isa<ConstantExpr>(Op1))
572 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Op1->getType());
573 // Otherwise, just keep the constants we have.
Chris Lattnerd501c132003-02-26 19:41:54 +0000574 } else {
Chris Lattnerb307c882003-12-11 22:44:13 +0000575 if (Op1) {
576 if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
577 // If this is an array index, make sure the array element is in range.
578 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
579 if (Op1C->getRawValue() >= AT->getNumElements())
580 return MayAlias; // Be conservative with out-of-range accesses
581
582 } else {
583 // GEP1 is known to produce a value less than GEP2. To be
584 // conservatively correct, we must assume the largest possible
585 // constant is used in this position. This cannot be the initial
586 // index to the GEP instructions (because we know we have at least one
587 // element before this one with the different constant arguments), so
588 // we know that the current index must be into either a struct or
589 // array. Because we know it's not constant, this cannot be a
590 // structure index. Because of this, we can calculate the maximum
591 // value possible.
592 //
593 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
594 GEP1Ops[i] = ConstantSInt::get(Type::LongTy,AT->getNumElements()-1);
595 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000596 }
597
Chris Lattnerb307c882003-12-11 22:44:13 +0000598 if (Op2) {
599 if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
600 // If this is an array index, make sure the array element is in range.
601 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
602 if (Op2C->getRawValue() >= AT->getNumElements())
603 return MayAlias; // Be conservative with out-of-range accesses
604 } else { // Conservatively assume the minimum value for this index
605 GEP2Ops[i] = Constant::getNullValue(Op2->getType());
606 }
Chris Lattner920bd792003-06-02 05:42:39 +0000607 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000608 }
609
610 if (BasePtr1Ty && Op1) {
611 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
612 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
613 else
614 BasePtr1Ty = 0;
615 }
616
617 if (BasePtr2Ty && Op2) {
618 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
619 BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
620 else
621 BasePtr2Ty = 0;
Chris Lattnerd501c132003-02-26 19:41:54 +0000622 }
623 }
624
Chris Lattnerb307c882003-12-11 22:44:13 +0000625 int64_t Offset1 = getTargetData().getIndexedOffset(GEPPointerTy, GEP1Ops);
626 int64_t Offset2 = getTargetData().getIndexedOffset(GEPPointerTy, GEP2Ops);
Chris Lattnerd501c132003-02-26 19:41:54 +0000627 assert(Offset1 < Offset2 &&"There is at least one different constant here!");
628
Chris Lattner807b7052003-04-25 18:03:06 +0000629 if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000630 //std::cerr << "Determined that these two GEP's don't alias ["
631 // << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
632 return NoAlias;
633 }
634 return MayAlias;
635}
636
Chris Lattner4244bb52004-03-15 03:36:49 +0000637namespace {
638 struct StringCompare {
639 bool operator()(const char *LHS, const char *RHS) {
640 return strcmp(LHS, RHS) < 0;
641 }
642 };
643}
644
645// Note that this list cannot contain libm functions (such as acos and sqrt)
646// that set errno on a domain or other error.
647static const char *DoesntAccessMemoryTable[] = {
Chris Lattnerb903fc52004-04-10 06:55:27 +0000648 // LLVM intrinsics:
Chris Lattner4ee623d2004-06-15 21:52:58 +0000649 "llvm.frameaddress", "llvm.returnaddress", "llvm.readport", "llvm.isunordered",
Chris Lattnerb903fc52004-04-10 06:55:27 +0000650
Chris Lattner4244bb52004-03-15 03:36:49 +0000651 "abs", "labs", "llabs", "imaxabs", "fabs", "fabsf", "fabsl",
652 "trunc", "truncf", "truncl", "ldexp",
653
654 "atan", "atanf", "atanl", "atan2", "atan2f", "atan2l",
655 "cbrt",
656 "cos", "cosf", "cosl", "cosh", "coshf", "coshl",
657 "exp", "expf", "expl",
658 "hypot",
659 "sin", "sinf", "sinl", "sinh", "sinhf", "sinhl",
660 "tan", "tanf", "tanl", "tanh", "tanhf", "tanhl",
661
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000662 // ctype.h
Chris Lattner4244bb52004-03-15 03:36:49 +0000663 "isalnum", "isalpha", "iscntrl", "isdigit", "isgraph", "islower", "isprint"
664 "ispunct", "isspace", "isupper", "isxdigit", "tolower", "toupper",
665
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000666 // wctype.h"
Chris Lattner4244bb52004-03-15 03:36:49 +0000667 "iswalnum", "iswalpha", "iswcntrl", "iswdigit", "iswgraph", "iswlower",
668 "iswprint", "iswpunct", "iswspace", "iswupper", "iswxdigit",
669
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000670 "iswctype", "towctrans", "towlower", "towupper",
671
Chris Lattner4244bb52004-03-15 03:36:49 +0000672 "btowc", "wctob",
Chris Lattner002be762004-03-16 03:41:35 +0000673
674 "isinf", "isnan", "finite",
675
676 // C99 math functions
677 "copysign", "copysignf", "copysignd",
678 "nexttoward", "nexttowardf", "nexttowardd",
679 "nextafter", "nextafterf", "nextafterd",
680
681 // glibc functions:
682 "__fpclassify", "__fpclassifyf", "__fpclassifyl",
683 "__signbit", "__signbitf", "__signbitl",
Chris Lattner4244bb52004-03-15 03:36:49 +0000684};
685
686static const unsigned DAMTableSize =
687 sizeof(DoesntAccessMemoryTable)/sizeof(DoesntAccessMemoryTable[0]);
688
689/// doesNotAccessMemory - Return true if we know that the function does not
690/// access memory at all. Since basicaa does no analysis, we can only do simple
691/// things here. In particular, if we have an external function with the name
692/// of a standard C library function, we are allowed to assume it will be
693/// resolved by libc, so we can hardcode some entries in here.
694bool BasicAliasAnalysis::doesNotAccessMemory(Function *F) {
695 if (!F->isExternal()) return false;
696
697 static bool Initialized = false;
698 if (!Initialized) {
699 // Sort the table the first time through.
700 std::sort(DoesntAccessMemoryTable, DoesntAccessMemoryTable+DAMTableSize,
701 StringCompare());
702 Initialized = true;
703 }
704
705 const char **Ptr = std::lower_bound(DoesntAccessMemoryTable,
706 DoesntAccessMemoryTable+DAMTableSize,
707 F->getName().c_str(), StringCompare());
708 return Ptr != DoesntAccessMemoryTable+DAMTableSize && *Ptr == F->getName();
709}
710
711
712static const char *OnlyReadsMemoryTable[] = {
Chris Lattner002be762004-03-16 03:41:35 +0000713 "atoi", "atol", "atof", "atoll", "atoq", "a64l",
714 "bcmp", "memcmp", "memchr", "memrchr", "wmemcmp", "wmemchr",
Chris Lattner4244bb52004-03-15 03:36:49 +0000715
716 // Strings
717 "strcmp", "strcasecmp", "strcoll", "strncmp", "strncasecmp",
718 "strchr", "strcspn", "strlen", "strpbrk", "strrchr", "strspn", "strstr",
Chris Lattner002be762004-03-16 03:41:35 +0000719 "index", "rindex",
Chris Lattner4244bb52004-03-15 03:36:49 +0000720
721 // Wide char strings
722 "wcschr", "wcscmp", "wcscoll", "wcscspn", "wcslen", "wcsncmp", "wcspbrk",
723 "wcsrchr", "wcsspn", "wcsstr",
Chris Lattner002be762004-03-16 03:41:35 +0000724
725 // glibc
726 "alphasort", "alphasort64", "versionsort", "versionsort64",
727
728 // C99
729 "nan", "nanf", "nand",
Chris Lattnerb903fc52004-04-10 06:55:27 +0000730
731 // File I/O
732 "feof", "ferror", "fileno",
733 "feof_unlocked", "ferror_unlocked", "fileno_unlocked"
Chris Lattner4244bb52004-03-15 03:36:49 +0000734};
735
736static const unsigned ORMTableSize =
737 sizeof(OnlyReadsMemoryTable)/sizeof(OnlyReadsMemoryTable[0]);
738
739bool BasicAliasAnalysis::onlyReadsMemory(Function *F) {
740 if (doesNotAccessMemory(F)) return true;
741 if (!F->isExternal()) return false;
742
743 static bool Initialized = false;
744 if (!Initialized) {
745 // Sort the table the first time through.
746 std::sort(OnlyReadsMemoryTable, OnlyReadsMemoryTable+ORMTableSize,
747 StringCompare());
748 Initialized = true;
749 }
750
751 const char **Ptr = std::lower_bound(OnlyReadsMemoryTable,
752 OnlyReadsMemoryTable+ORMTableSize,
753 F->getName().c_str(), StringCompare());
754 return Ptr != OnlyReadsMemoryTable+ORMTableSize && *Ptr == F->getName();
755}
756
757