blob: 82f3c57afd7c49e5a36d9817131df15f595b3bc5 [file] [log] [blame]
Chris Lattner9d7c9ea2003-11-25 20:11:47 +00001//===- BasicAliasAnalysis.cpp - Local Alias Analysis Impl -----------------===//
Misha Brukman2b37d7c2005-04-21 21:13:18 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
Misha Brukman2b37d7c2005-04-21 21:13:18 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerd501c132003-02-26 19:41:54 +00009//
10// This file defines the default implementation of the Alias Analysis interface
11// that simply implements a few identities (two different globals cannot alias,
12// etc), but otherwise does no analysis.
13//
14//===----------------------------------------------------------------------===//
15
16#include "llvm/Analysis/AliasAnalysis.h"
Jeff Cohen534927d2005-01-08 22:01:16 +000017#include "llvm/Analysis/Passes.h"
Chris Lattner4244bb52004-03-15 03:36:49 +000018#include "llvm/Constants.h"
19#include "llvm/DerivedTypes.h"
20#include "llvm/Function.h"
Christopher Lamb406bfa32007-08-02 01:18:14 +000021#include "llvm/ParameterAttributes.h"
Chris Lattner4244bb52004-03-15 03:36:49 +000022#include "llvm/GlobalVariable.h"
Alkis Evlogimenoseb62bc72004-07-29 12:17:34 +000023#include "llvm/Instructions.h"
Chandler Carrutha5839902007-08-06 20:57:16 +000024#include "llvm/Intrinsics.h"
Chris Lattner4244bb52004-03-15 03:36:49 +000025#include "llvm/Pass.h"
Chris Lattnerd501c132003-02-26 19:41:54 +000026#include "llvm/Target/TargetData.h"
Chris Lattnera77600e2007-02-10 22:15:31 +000027#include "llvm/ADT/SmallVector.h"
Chris Lattner8c528702007-08-05 07:50:06 +000028#include "llvm/ADT/StringMap.h"
Chandler Carrutha5839902007-08-06 20:57:16 +000029#include "llvm/ADT/BitVector.h"
Chris Lattnera4f0b3a2006-08-27 12:54:02 +000030#include "llvm/Support/Compiler.h"
Chris Lattner90aa8392006-10-04 21:52:35 +000031#include "llvm/Support/GetElementPtrTypeIterator.h"
32#include "llvm/Support/ManagedStatic.h"
Alkis Evlogimenos20aa4742004-09-03 18:19:51 +000033#include <algorithm>
Chris Lattnerec4e8082003-11-25 18:33:40 +000034using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000035
Chris Lattnerd501c132003-02-26 19:41:54 +000036namespace {
Chris Lattnerb52f4402004-05-23 21:15:12 +000037 /// NoAA - This class implements the -no-aa pass, which always returns "I
38 /// don't know" for alias queries. NoAA is unlike other alias analysis
39 /// implementations, in that it does not chain to a previous analysis. As
40 /// such it doesn't follow many of the rules that other alias analyses must.
41 ///
Chris Lattner95255282006-06-28 23:17:24 +000042 struct VISIBILITY_HIDDEN NoAA : public ImmutablePass, public AliasAnalysis {
Devang Patel19974732007-05-03 01:11:54 +000043 static char ID; // Class identification, replacement for typeinfo
Devang Patel794fd752007-05-01 21:15:47 +000044 NoAA() : ImmutablePass((intptr_t)&ID) {}
Dan Gohmana6900c72007-07-02 14:53:37 +000045 explicit NoAA(intptr_t PID) : ImmutablePass(PID) { }
Devang Patel794fd752007-05-01 21:15:47 +000046
Chris Lattner689835a2004-06-19 08:05:58 +000047 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
48 AU.addRequired<TargetData>();
49 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +000050
Chris Lattner689835a2004-06-19 08:05:58 +000051 virtual void initializePass() {
52 TD = &getAnalysis<TargetData>();
53 }
54
Chris Lattnerb52f4402004-05-23 21:15:12 +000055 virtual AliasResult alias(const Value *V1, unsigned V1Size,
56 const Value *V2, unsigned V2Size) {
57 return MayAlias;
58 }
59
Chris Lattner5226f6a2004-12-15 17:13:24 +000060 virtual ModRefBehavior getModRefBehavior(Function *F, CallSite CS,
61 std::vector<PointerAccessInfo> *Info) {
Chris Lattner0af024c2004-12-15 07:22:13 +000062 return UnknownModRefBehavior;
63 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +000064
Chris Lattner0af024c2004-12-15 07:22:13 +000065 virtual void getArgumentAccesses(Function *F, CallSite CS,
66 std::vector<PointerAccessInfo> &Info) {
67 assert(0 && "This method may not be called on this function!");
68 }
69
Chris Lattnerb52f4402004-05-23 21:15:12 +000070 virtual void getMustAliases(Value *P, std::vector<Value*> &RetVals) { }
71 virtual bool pointsToConstantMemory(const Value *P) { return false; }
Chris Lattnerb52f4402004-05-23 21:15:12 +000072 virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
73 return ModRef;
74 }
75 virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
76 return ModRef;
77 }
78 virtual bool hasNoModRefInfoForCalls() const { return true; }
79
80 virtual void deleteValue(Value *V) {}
81 virtual void copyValue(Value *From, Value *To) {}
Chris Lattnerb52f4402004-05-23 21:15:12 +000082 };
Misha Brukman2b37d7c2005-04-21 21:13:18 +000083
Chris Lattnerb52f4402004-05-23 21:15:12 +000084 // Register this pass...
Devang Patel19974732007-05-03 01:11:54 +000085 char NoAA::ID = 0;
Chris Lattner7f8897f2006-08-27 22:42:52 +000086 RegisterPass<NoAA>
Chris Lattnerb52f4402004-05-23 21:15:12 +000087 U("no-aa", "No Alias Analysis (always returns 'may' alias)");
88
89 // Declare that we implement the AliasAnalysis interface
Chris Lattnera5370172006-08-28 00:42:29 +000090 RegisterAnalysisGroup<AliasAnalysis> V(U);
Chris Lattnerb52f4402004-05-23 21:15:12 +000091} // End of anonymous namespace
92
Jeff Cohen534927d2005-01-08 22:01:16 +000093ImmutablePass *llvm::createNoAAPass() { return new NoAA(); }
Chris Lattnerb52f4402004-05-23 21:15:12 +000094
95namespace {
96 /// BasicAliasAnalysis - This is the default alias analysis implementation.
97 /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
98 /// derives from the NoAA class.
Chris Lattner95255282006-06-28 23:17:24 +000099 struct VISIBILITY_HIDDEN BasicAliasAnalysis : public NoAA {
Devang Patel19974732007-05-03 01:11:54 +0000100 static char ID; // Class identification, replacement for typeinfo
Anton Korobeynikov03265f92007-06-18 17:13:29 +0000101 BasicAliasAnalysis() : NoAA((intptr_t)&ID) { }
Chris Lattnerd501c132003-02-26 19:41:54 +0000102 AliasResult alias(const Value *V1, unsigned V1Size,
103 const Value *V2, unsigned V2Size);
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000104
Chris Lattner04b75932004-03-12 22:39:00 +0000105 ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
Reid Spencer4a7ebfa2004-12-07 08:11:24 +0000106 ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
107 return NoAA::getModRefInfo(CS1,CS2);
108 }
Chris Lattner04b75932004-03-12 22:39:00 +0000109
Chris Lattnere181b942004-07-27 02:13:55 +0000110 /// hasNoModRefInfoForCalls - We can provide mod/ref information against
111 /// non-escaping allocations.
112 virtual bool hasNoModRefInfoForCalls() const { return false; }
Chris Lattner65585aa2004-04-11 16:43:07 +0000113
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000114 /// pointsToConstantMemory - Chase pointers until we find a (constant
115 /// global) or not.
116 bool pointsToConstantMemory(const Value *P);
117
Chris Lattner0af024c2004-12-15 07:22:13 +0000118 virtual ModRefBehavior getModRefBehavior(Function *F, CallSite CS,
Chris Lattner241607d2007-01-14 05:57:53 +0000119 std::vector<PointerAccessInfo> *Info);
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000120
Chris Lattnerd501c132003-02-26 19:41:54 +0000121 private:
Chris Lattnerb307c882003-12-11 22:44:13 +0000122 // CheckGEPInstructions - Check two GEP instructions with known
123 // must-aliasing base pointers. This checks to see if the index expressions
Chris Lattnerd501c132003-02-26 19:41:54 +0000124 // preclude the pointers from aliasing...
Chris Lattnerb307c882003-12-11 22:44:13 +0000125 AliasResult
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000126 CheckGEPInstructions(const Type* BasePtr1Ty,
127 Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1Size,
128 const Type *BasePtr2Ty,
129 Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000130 };
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000131
Chris Lattnerd501c132003-02-26 19:41:54 +0000132 // Register this pass...
Devang Patel19974732007-05-03 01:11:54 +0000133 char BasicAliasAnalysis::ID = 0;
Chris Lattner7f8897f2006-08-27 22:42:52 +0000134 RegisterPass<BasicAliasAnalysis>
Chris Lattnerd501c132003-02-26 19:41:54 +0000135 X("basicaa", "Basic Alias Analysis (default AA impl)");
136
137 // Declare that we implement the AliasAnalysis interface
Chris Lattnera5370172006-08-28 00:42:29 +0000138 RegisterAnalysisGroup<AliasAnalysis, true> Y(X);
Chris Lattnerd501c132003-02-26 19:41:54 +0000139} // End of anonymous namespace
140
Jeff Cohen534927d2005-01-08 22:01:16 +0000141ImmutablePass *llvm::createBasicAliasAnalysisPass() {
142 return new BasicAliasAnalysis();
143}
144
Chris Lattnerc1820032003-09-20 03:08:47 +0000145// getUnderlyingObject - This traverses the use chain to figure out what object
146// the specified value points to. If the value points to, or is derived from, a
147// unique object or an argument, return it.
Chris Lattnerd501c132003-02-26 19:41:54 +0000148static const Value *getUnderlyingObject(const Value *V) {
149 if (!isa<PointerType>(V->getType())) return 0;
150
Reid Spencer3da59db2006-11-27 01:05:10 +0000151 // If we are at some type of object, return it. GlobalValues and Allocations
152 // have unique addresses.
153 if (isa<GlobalValue>(V) || isa<AllocationInst>(V) || isa<Argument>(V))
154 return V;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000155
Chris Lattnerd501c132003-02-26 19:41:54 +0000156 // Traverse through different addressing mechanisms...
157 if (const Instruction *I = dyn_cast<Instruction>(V)) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000158 if (isa<BitCastInst>(I) || isa<GetElementPtrInst>(I))
Chris Lattnerd501c132003-02-26 19:41:54 +0000159 return getUnderlyingObject(I->getOperand(0));
Chris Lattner388f6692003-06-17 15:25:37 +0000160 } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000161 if (CE->getOpcode() == Instruction::BitCast ||
Chris Lattner388f6692003-06-17 15:25:37 +0000162 CE->getOpcode() == Instruction::GetElementPtr)
163 return getUnderlyingObject(CE->getOperand(0));
Chris Lattnerd501c132003-02-26 19:41:54 +0000164 }
165 return 0;
166}
167
Chris Lattnerb307c882003-12-11 22:44:13 +0000168static const User *isGEP(const Value *V) {
169 if (isa<GetElementPtrInst>(V) ||
170 (isa<ConstantExpr>(V) &&
171 cast<ConstantExpr>(V)->getOpcode() == Instruction::GetElementPtr))
172 return cast<User>(V);
173 return 0;
174}
Chris Lattnerd501c132003-02-26 19:41:54 +0000175
Chris Lattnera77600e2007-02-10 22:15:31 +0000176static const Value *GetGEPOperands(const Value *V,
177 SmallVector<Value*, 16> &GEPOps){
Chris Lattner4a830882003-12-11 23:20:16 +0000178 assert(GEPOps.empty() && "Expect empty list to populate!");
179 GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
180 cast<User>(V)->op_end());
181
182 // Accumulate all of the chained indexes into the operand array
183 V = cast<User>(V)->getOperand(0);
184
185 while (const User *G = isGEP(V)) {
Reid Spencere8404342004-07-18 00:18:30 +0000186 if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
Chris Lattner4a830882003-12-11 23:20:16 +0000187 !cast<Constant>(GEPOps[0])->isNullValue())
188 break; // Don't handle folding arbitrary pointer offsets yet...
189 GEPOps.erase(GEPOps.begin()); // Drop the zero index
190 GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
191 V = G->getOperand(0);
192 }
193 return V;
194}
195
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000196/// pointsToConstantMemory - Chase pointers until we find a (constant
197/// global) or not.
198bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
Chris Lattnera4dd6742004-01-30 22:48:02 +0000199 if (const Value *V = getUnderlyingObject(P))
200 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
201 return GV->isConstant();
Chris Lattnerbc1daaa2004-01-30 22:17:24 +0000202 return false;
203}
Chris Lattner4a830882003-12-11 23:20:16 +0000204
Reid Spencer3da59db2006-11-27 01:05:10 +0000205// Determine if an AllocationInst instruction escapes from the function it is
206// contained in. If it does not escape, there is no way for another function to
207// mod/ref it. We do this by looking at its uses and determining if the uses
208// can escape (recursively).
Chris Lattner04b75932004-03-12 22:39:00 +0000209static bool AddressMightEscape(const Value *V) {
210 for (Value::use_const_iterator UI = V->use_begin(), E = V->use_end();
211 UI != E; ++UI) {
212 const Instruction *I = cast<Instruction>(*UI);
213 switch (I->getOpcode()) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000214 case Instruction::Load:
215 break; //next use.
Chris Lattner04b75932004-03-12 22:39:00 +0000216 case Instruction::Store:
217 if (I->getOperand(0) == V)
218 return true; // Escapes if the pointer is stored.
Reid Spencer3da59db2006-11-27 01:05:10 +0000219 break; // next use.
Chris Lattner04b75932004-03-12 22:39:00 +0000220 case Instruction::GetElementPtr:
Reid Spencer3da59db2006-11-27 01:05:10 +0000221 if (AddressMightEscape(I))
222 return true;
Evan Chengdf344fe2007-09-05 21:36:14 +0000223 break; // next use.
Reid Spencer3da59db2006-11-27 01:05:10 +0000224 case Instruction::BitCast:
Chris Lattner04b75932004-03-12 22:39:00 +0000225 if (!isa<PointerType>(I->getType()))
226 return true;
Reid Spencer3da59db2006-11-27 01:05:10 +0000227 if (AddressMightEscape(I))
228 return true;
229 break; // next use
Chris Lattnerdb5b80a2004-07-27 02:18:52 +0000230 case Instruction::Ret:
231 // If returned, the address will escape to calling functions, but no
232 // callees could modify it.
Reid Spencer3da59db2006-11-27 01:05:10 +0000233 break; // next use
Chris Lattner04b75932004-03-12 22:39:00 +0000234 default:
235 return true;
236 }
237 }
238 return false;
239}
240
241// getModRefInfo - Check to see if the specified callsite can clobber the
242// specified memory object. Since we only look at local properties of this
243// function, we really can't say much about this query. We do, however, use
244// simple "address taken" analysis on local objects.
245//
246AliasAnalysis::ModRefResult
247BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
Reid Spencere8404342004-07-18 00:18:30 +0000248 if (!isa<Constant>(P))
Chris Lattner04b75932004-03-12 22:39:00 +0000249 if (const AllocationInst *AI =
Chris Lattner7a82ba02004-03-12 23:12:55 +0000250 dyn_cast_or_null<AllocationInst>(getUnderlyingObject(P))) {
Chris Lattner04b75932004-03-12 22:39:00 +0000251 // Okay, the pointer is to a stack allocated object. If we can prove that
252 // the pointer never "escapes", then we know the call cannot clobber it,
253 // because it simply can't get its address.
254 if (!AddressMightEscape(AI))
255 return NoModRef;
Chris Lattner42e3c812005-05-08 23:58:12 +0000256
257 // If this is a tail call and P points to a stack location, we know that
258 // the tail call cannot access or modify the local stack.
259 if (CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
260 if (CI->isTailCall() && isa<AllocaInst>(AI))
261 return NoModRef;
Chris Lattner04b75932004-03-12 22:39:00 +0000262 }
263
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000264 // The AliasAnalysis base class has some smarts, lets use them.
265 return AliasAnalysis::getModRefInfo(CS, P, Size);
Chris Lattner04b75932004-03-12 22:39:00 +0000266}
267
Christopher Lamb406bfa32007-08-02 01:18:14 +0000268static bool isNoAliasArgument(const Argument *Arg) {
269 const Function *Func = Arg->getParent();
270 const ParamAttrsList *Attr = Func->getFunctionType()->getParamAttrs();
271 if (Attr) {
272 unsigned Idx = 1;
273 for (Function::const_arg_iterator I = Func->arg_begin(),
274 E = Func->arg_end(); I != E; ++I, ++Idx) {
275 if (&(*I) == Arg &&
276 Attr->paramHasAttr(Idx, ParamAttr::NoAlias))
277 return true;
278 }
279 }
280 return false;
281}
282
Chris Lattnerd501c132003-02-26 19:41:54 +0000283// alias - Provide a bunch of ad-hoc rules to disambiguate in common cases, such
284// as array references. Note that this function is heavily tail recursive.
285// Hopefully we have a smart C++ compiler. :)
286//
287AliasAnalysis::AliasResult
288BasicAliasAnalysis::alias(const Value *V1, unsigned V1Size,
289 const Value *V2, unsigned V2Size) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000290 // Strip off any constant expression casts if they exist
291 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V1))
Reid Spencer3da59db2006-11-27 01:05:10 +0000292 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000293 V1 = CE->getOperand(0);
294 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V2))
Reid Spencer3da59db2006-11-27 01:05:10 +0000295 if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
Chris Lattnerb307c882003-12-11 22:44:13 +0000296 V2 = CE->getOperand(0);
297
Chris Lattnerd501c132003-02-26 19:41:54 +0000298 // Are we checking for alias of the same value?
299 if (V1 == V2) return MustAlias;
300
301 if ((!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType())) &&
Reid Spencerc5b206b2006-12-31 05:48:39 +0000302 V1->getType() != Type::Int64Ty && V2->getType() != Type::Int64Ty)
Chris Lattnerd501c132003-02-26 19:41:54 +0000303 return NoAlias; // Scalars cannot alias each other
304
305 // Strip off cast instructions...
Reid Spencer3da59db2006-11-27 01:05:10 +0000306 if (const BitCastInst *I = dyn_cast<BitCastInst>(V1))
Chris Lattner241607d2007-01-14 05:57:53 +0000307 return alias(I->getOperand(0), V1Size, V2, V2Size);
Reid Spencer3da59db2006-11-27 01:05:10 +0000308 if (const BitCastInst *I = dyn_cast<BitCastInst>(V2))
Chris Lattner241607d2007-01-14 05:57:53 +0000309 return alias(V1, V1Size, I->getOperand(0), V2Size);
Chris Lattnerd501c132003-02-26 19:41:54 +0000310
311 // Figure out what objects these things are pointing to if we can...
312 const Value *O1 = getUnderlyingObject(V1);
313 const Value *O2 = getUnderlyingObject(V2);
314
Misha Brukman2f2d0652003-09-11 18:14:24 +0000315 // Pointing at a discernible object?
Chris Lattner0a1ac902004-11-26 19:20:01 +0000316 if (O1) {
317 if (O2) {
Christopher Lamba326b5d2007-08-02 17:52:00 +0000318 if (const Argument *O1Arg = dyn_cast<Argument>(O1)) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000319 // Incoming argument cannot alias locally allocated object!
320 if (isa<AllocationInst>(O2)) return NoAlias;
Christopher Lamb406bfa32007-08-02 01:18:14 +0000321
322 // If they are two different objects, and one is a noalias argument
323 // then they do not alias.
Christopher Lamba326b5d2007-08-02 17:52:00 +0000324 if (O1 != O2 && isNoAliasArgument(O1Arg))
Christopher Lamb406bfa32007-08-02 01:18:14 +0000325 return NoAlias;
326
Chris Lattner0a1ac902004-11-26 19:20:01 +0000327 // Otherwise, nothing is known...
Christopher Lamb406bfa32007-08-02 01:18:14 +0000328 }
329
Christopher Lamba326b5d2007-08-02 17:52:00 +0000330 if (const Argument *O2Arg = dyn_cast<Argument>(O2)) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000331 // Incoming argument cannot alias locally allocated object!
332 if (isa<AllocationInst>(O1)) return NoAlias;
Christopher Lamb406bfa32007-08-02 01:18:14 +0000333
334 // If they are two different objects, and one is a noalias argument
335 // then they do not alias.
Christopher Lamba326b5d2007-08-02 17:52:00 +0000336 if (O1 != O2 && isNoAliasArgument(O2Arg))
Christopher Lamb406bfa32007-08-02 01:18:14 +0000337 return NoAlias;
338
Chris Lattner0a1ac902004-11-26 19:20:01 +0000339 // Otherwise, nothing is known...
340 } else if (O1 != O2) {
341 // If they are two different objects, we know that we have no alias...
342 return NoAlias;
343 }
Christopher Lamb321ff4e2007-07-31 16:18:07 +0000344
Chris Lattner0a1ac902004-11-26 19:20:01 +0000345 // If they are the same object, they we can look at the indexes. If they
346 // index off of the object is the same for both pointers, they must alias.
347 // If they are provably different, they must not alias. Otherwise, we
348 // can't tell anything.
Chris Lattnerc1820032003-09-20 03:08:47 +0000349 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000350
Chris Lattner0a1ac902004-11-26 19:20:01 +0000351
352 if (!isa<Argument>(O1) && isa<ConstantPointerNull>(V2))
353 return NoAlias; // Unique values don't alias null
354
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000355 if (isa<GlobalVariable>(O1) ||
Chris Lattner50bc9ef2005-03-09 16:29:52 +0000356 (isa<AllocationInst>(O1) &&
357 !cast<AllocationInst>(O1)->isArrayAllocation()))
Chris Lattner4e616762004-11-26 20:01:48 +0000358 if (cast<PointerType>(O1->getType())->getElementType()->isSized()) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000359 // If the size of the other access is larger than the total size of the
Chris Lattner4e616762004-11-26 20:01:48 +0000360 // global/alloca/malloc, it cannot be accessing the global (it's
361 // undefined to load or store bytes before or after an object).
362 const Type *ElTy = cast<PointerType>(O1->getType())->getElementType();
363 unsigned GlobalSize = getTargetData().getTypeSize(ElTy);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000364 if (GlobalSize < V2Size && V2Size != ~0U)
Chris Lattner0a1ac902004-11-26 19:20:01 +0000365 return NoAlias;
366 }
367 }
368
369 if (O2) {
370 if (!isa<Argument>(O2) && isa<ConstantPointerNull>(V1))
371 return NoAlias; // Unique values don't alias null
372
Chris Lattner50bc9ef2005-03-09 16:29:52 +0000373 if (isa<GlobalVariable>(O2) ||
374 (isa<AllocationInst>(O2) &&
375 !cast<AllocationInst>(O2)->isArrayAllocation()))
Chris Lattner4e616762004-11-26 20:01:48 +0000376 if (cast<PointerType>(O2->getType())->getElementType()->isSized()) {
Chris Lattner0a1ac902004-11-26 19:20:01 +0000377 // If the size of the other access is larger than the total size of the
Chris Lattner4e616762004-11-26 20:01:48 +0000378 // global/alloca/malloc, it cannot be accessing the object (it's
379 // undefined to load or store bytes before or after an object).
380 const Type *ElTy = cast<PointerType>(O2->getType())->getElementType();
381 unsigned GlobalSize = getTargetData().getTypeSize(ElTy);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000382 if (GlobalSize < V1Size && V1Size != ~0U)
Chris Lattner0a1ac902004-11-26 19:20:01 +0000383 return NoAlias;
384 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000385 }
386
Chris Lattnerb307c882003-12-11 22:44:13 +0000387 // If we have two gep instructions with must-alias'ing base pointers, figure
388 // out if the indexes to the GEP tell us anything about the derived pointer.
389 // Note that we also handle chains of getelementptr instructions as well as
390 // constant expression getelementptrs here.
Chris Lattnerd501c132003-02-26 19:41:54 +0000391 //
Chris Lattnerb307c882003-12-11 22:44:13 +0000392 if (isGEP(V1) && isGEP(V2)) {
393 // Drill down into the first non-gep value, to test for must-aliasing of
394 // the base pointers.
395 const Value *BasePtr1 = V1, *BasePtr2 = V2;
396 do {
397 BasePtr1 = cast<User>(BasePtr1)->getOperand(0);
398 } while (isGEP(BasePtr1) &&
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000399 cast<User>(BasePtr1)->getOperand(1) ==
Chris Lattnerb307c882003-12-11 22:44:13 +0000400 Constant::getNullValue(cast<User>(BasePtr1)->getOperand(1)->getType()));
401 do {
402 BasePtr2 = cast<User>(BasePtr2)->getOperand(0);
403 } while (isGEP(BasePtr2) &&
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000404 cast<User>(BasePtr2)->getOperand(1) ==
Chris Lattnerb307c882003-12-11 22:44:13 +0000405 Constant::getNullValue(cast<User>(BasePtr2)->getOperand(1)->getType()));
406
407 // Do the base pointers alias?
Chris Lattner241607d2007-01-14 05:57:53 +0000408 AliasResult BaseAlias = alias(BasePtr1, ~0U, BasePtr2, ~0U);
Chris Lattnerb307c882003-12-11 22:44:13 +0000409 if (BaseAlias == NoAlias) return NoAlias;
410 if (BaseAlias == MustAlias) {
411 // If the base pointers alias each other exactly, check to see if we can
412 // figure out anything about the resultant pointers, to try to prove
413 // non-aliasing.
414
415 // Collect all of the chained GEP operands together into one simple place
Chris Lattnera77600e2007-02-10 22:15:31 +0000416 SmallVector<Value*, 16> GEP1Ops, GEP2Ops;
Chris Lattner4a830882003-12-11 23:20:16 +0000417 BasePtr1 = GetGEPOperands(V1, GEP1Ops);
418 BasePtr2 = GetGEPOperands(V2, GEP2Ops);
Chris Lattnerb307c882003-12-11 22:44:13 +0000419
Chris Lattner730b1ad2004-07-29 07:56:39 +0000420 // If GetGEPOperands were able to fold to the same must-aliased pointer,
421 // do the comparison.
422 if (BasePtr1 == BasePtr2) {
423 AliasResult GAlias =
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000424 CheckGEPInstructions(BasePtr1->getType(),
425 &GEP1Ops[0], GEP1Ops.size(), V1Size,
426 BasePtr2->getType(),
427 &GEP2Ops[0], GEP2Ops.size(), V2Size);
Chris Lattner730b1ad2004-07-29 07:56:39 +0000428 if (GAlias != MayAlias)
429 return GAlias;
430 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000431 }
432 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000433
434 // Check to see if these two pointers are related by a getelementptr
435 // instruction. If one pointer is a GEP with a non-zero index of the other
436 // pointer, we know they cannot alias.
437 //
Chris Lattner4a830882003-12-11 23:20:16 +0000438 if (isGEP(V2)) {
Chris Lattnerd501c132003-02-26 19:41:54 +0000439 std::swap(V1, V2);
440 std::swap(V1Size, V2Size);
441 }
442
Chris Lattnerc330ee62003-02-26 21:57:23 +0000443 if (V1Size != ~0U && V2Size != ~0U)
Reid Spencer3ed469c2006-11-02 20:25:50 +0000444 if (isGEP(V1)) {
Chris Lattnera77600e2007-02-10 22:15:31 +0000445 SmallVector<Value*, 16> GEPOperands;
Chris Lattner4a830882003-12-11 23:20:16 +0000446 const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
447
448 AliasResult R = alias(BasePtr, V1Size, V2, V2Size);
Chris Lattnerc330ee62003-02-26 21:57:23 +0000449 if (R == MustAlias) {
450 // If there is at least one non-zero constant index, we know they cannot
451 // alias.
452 bool ConstantFound = false;
Chris Lattner88d3e032003-12-11 06:02:00 +0000453 bool AllZerosFound = true;
Chris Lattner4a830882003-12-11 23:20:16 +0000454 for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
455 if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
Chris Lattnerc330ee62003-02-26 21:57:23 +0000456 if (!C->isNullValue()) {
457 ConstantFound = true;
Chris Lattnerc54735e2003-12-11 06:06:28 +0000458 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000459 break;
Chris Lattner88d3e032003-12-11 06:02:00 +0000460 }
461 } else {
462 AllZerosFound = false;
Chris Lattnerc330ee62003-02-26 21:57:23 +0000463 }
Chris Lattner88d3e032003-12-11 06:02:00 +0000464
465 // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
466 // the ptr, the end result is a must alias also.
467 if (AllZerosFound)
468 return MustAlias;
469
Chris Lattnerc330ee62003-02-26 21:57:23 +0000470 if (ConstantFound) {
471 if (V2Size <= 1 && V1Size <= 1) // Just pointer check?
Chris Lattnerd501c132003-02-26 19:41:54 +0000472 return NoAlias;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000473
Chris Lattnerc330ee62003-02-26 21:57:23 +0000474 // Otherwise we have to check to see that the distance is more than
475 // the size of the argument... build an index vector that is equal to
476 // the arguments provided, except substitute 0's for any variable
477 // indexes we find...
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000478 if (cast<PointerType>(
479 BasePtr->getType())->getElementType()->isSized()) {
480 for (unsigned i = 0; i != GEPOperands.size(); ++i)
Chris Lattner0bb38312007-01-12 18:20:48 +0000481 if (!isa<ConstantInt>(GEPOperands[i]))
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000482 GEPOperands[i] =
483 Constant::getNullValue(GEPOperands[i]->getType());
484 int64_t Offset =
Chris Lattner829621c2007-02-10 20:35:22 +0000485 getTargetData().getIndexedOffset(BasePtr->getType(),
486 &GEPOperands[0],
487 GEPOperands.size());
Alkis Evlogimenosa95cf302004-12-08 23:42:11 +0000488
489 if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
490 return NoAlias;
491 }
Chris Lattnerc330ee62003-02-26 21:57:23 +0000492 }
493 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000494 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000495
Chris Lattnerd501c132003-02-26 19:41:54 +0000496 return MayAlias;
497}
498
Reid Spencer3da59db2006-11-27 01:05:10 +0000499// This function is used to determin if the indices of two GEP instructions are
500// equal. V1 and V2 are the indices.
501static bool IndexOperandsEqual(Value *V1, Value *V2) {
Chris Lattner28977af2004-04-05 01:30:19 +0000502 if (V1->getType() == V2->getType())
503 return V1 == V2;
504 if (Constant *C1 = dyn_cast<Constant>(V1))
505 if (Constant *C2 = dyn_cast<Constant>(V2)) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000506 // Sign extend the constants to long types, if necessary
Reid Spencerc5b206b2006-12-31 05:48:39 +0000507 if (C1->getType() != Type::Int64Ty)
508 C1 = ConstantExpr::getSExt(C1, Type::Int64Ty);
509 if (C2->getType() != Type::Int64Ty)
510 C2 = ConstantExpr::getSExt(C2, Type::Int64Ty);
Chris Lattner28977af2004-04-05 01:30:19 +0000511 return C1 == C2;
512 }
513 return false;
514}
515
Chris Lattnerb307c882003-12-11 22:44:13 +0000516/// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
517/// base pointers. This checks to see if the index expressions preclude the
518/// pointers from aliasing...
Reid Spencerb83eb642006-10-20 07:07:24 +0000519AliasAnalysis::AliasResult
520BasicAliasAnalysis::CheckGEPInstructions(
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000521 const Type* BasePtr1Ty, Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1S,
522 const Type *BasePtr2Ty, Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2S) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000523 // We currently can't handle the case when the base pointers have different
524 // primitive types. Since this is uncommon anyway, we are happy being
525 // extremely conservative.
526 if (BasePtr1Ty != BasePtr2Ty)
527 return MayAlias;
528
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000529 const PointerType *GEPPointerTy = cast<PointerType>(BasePtr1Ty);
Chris Lattnerb307c882003-12-11 22:44:13 +0000530
531 // Find the (possibly empty) initial sequence of equal values... which are not
532 // necessarily constants.
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000533 unsigned NumGEP1Operands = NumGEP1Ops, NumGEP2Operands = NumGEP2Ops;
Chris Lattnerb307c882003-12-11 22:44:13 +0000534 unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
535 unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
536 unsigned UnequalOper = 0;
537 while (UnequalOper != MinOperands &&
Reid Spencer3da59db2006-11-27 01:05:10 +0000538 IndexOperandsEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper])) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000539 // Advance through the type as we go...
540 ++UnequalOper;
541 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
542 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
543 else {
544 // If all operands equal each other, then the derived pointers must
545 // alias each other...
546 BasePtr1Ty = 0;
547 assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
548 "Ran out of type nesting, but not out of operands?");
549 return MustAlias;
Chris Lattner920bd792003-06-02 05:42:39 +0000550 }
551 }
Chris Lattner920bd792003-06-02 05:42:39 +0000552
Chris Lattnerb307c882003-12-11 22:44:13 +0000553 // If we have seen all constant operands, and run out of indexes on one of the
554 // getelementptrs, check to see if the tail of the leftover one is all zeros.
555 // If so, return mustalias.
Chris Lattner4a830882003-12-11 23:20:16 +0000556 if (UnequalOper == MinOperands) {
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000557 if (NumGEP1Ops < NumGEP2Ops) {
558 std::swap(GEP1Ops, GEP2Ops);
559 std::swap(NumGEP1Ops, NumGEP2Ops);
560 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000561
Chris Lattnerb307c882003-12-11 22:44:13 +0000562 bool AllAreZeros = true;
563 for (unsigned i = UnequalOper; i != MaxOperands; ++i)
Chris Lattnera35339d2004-10-16 16:07:10 +0000564 if (!isa<Constant>(GEP1Ops[i]) ||
Chris Lattnerb307c882003-12-11 22:44:13 +0000565 !cast<Constant>(GEP1Ops[i])->isNullValue()) {
566 AllAreZeros = false;
567 break;
568 }
569 if (AllAreZeros) return MustAlias;
570 }
571
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000572
Chris Lattnerd501c132003-02-26 19:41:54 +0000573 // So now we know that the indexes derived from the base pointers,
574 // which are known to alias, are different. We can still determine a
575 // no-alias result if there are differing constant pairs in the index
576 // chain. For example:
577 // A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
578 //
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000579 // We have to be careful here about array accesses. In particular, consider:
580 // A[1][0] vs A[0][i]
581 // In this case, we don't *know* that the array will be accessed in bounds:
582 // the index could even be negative. Because of this, we have to
583 // conservatively *give up* and return may alias. We disregard differing
584 // array subscripts that are followed by a variable index without going
585 // through a struct.
586 //
Chris Lattnerd501c132003-02-26 19:41:54 +0000587 unsigned SizeMax = std::max(G1S, G2S);
Chris Lattnereaf8f9c2004-11-28 20:30:15 +0000588 if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work.
Chris Lattner920bd792003-06-02 05:42:39 +0000589
Chris Lattnerd501c132003-02-26 19:41:54 +0000590 // Scan for the first operand that is constant and unequal in the
Chris Lattner28977af2004-04-05 01:30:19 +0000591 // two getelementptrs...
Chris Lattnerd501c132003-02-26 19:41:54 +0000592 unsigned FirstConstantOper = UnequalOper;
Chris Lattnerb307c882003-12-11 22:44:13 +0000593 for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
594 const Value *G1Oper = GEP1Ops[FirstConstantOper];
595 const Value *G2Oper = GEP2Ops[FirstConstantOper];
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000596
Chris Lattner6eb88d42004-01-12 17:57:32 +0000597 if (G1Oper != G2Oper) // Found non-equal constant indexes...
Chris Lattnera35339d2004-10-16 16:07:10 +0000598 if (Constant *G1OC = dyn_cast<ConstantInt>(const_cast<Value*>(G1Oper)))
599 if (Constant *G2OC = dyn_cast<ConstantInt>(const_cast<Value*>(G2Oper))){
Chris Lattner28977af2004-04-05 01:30:19 +0000600 if (G1OC->getType() != G2OC->getType()) {
601 // Sign extend both operands to long.
Reid Spencerc5b206b2006-12-31 05:48:39 +0000602 if (G1OC->getType() != Type::Int64Ty)
603 G1OC = ConstantExpr::getSExt(G1OC, Type::Int64Ty);
604 if (G2OC->getType() != Type::Int64Ty)
605 G2OC = ConstantExpr::getSExt(G2OC, Type::Int64Ty);
Chris Lattner28977af2004-04-05 01:30:19 +0000606 GEP1Ops[FirstConstantOper] = G1OC;
607 GEP2Ops[FirstConstantOper] = G2OC;
608 }
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000609
Chris Lattner28977af2004-04-05 01:30:19 +0000610 if (G1OC != G2OC) {
Dan Gohman07a96762007-07-16 14:29:03 +0000611 // Handle the "be careful" case above: if this is an array/vector
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000612 // subscript, scan for a subsequent variable array index.
Chris Lattner7765d712006-11-03 21:58:48 +0000613 if (isa<SequentialType>(BasePtr1Ty)) {
614 const Type *NextTy =
615 cast<SequentialType>(BasePtr1Ty)->getElementType();
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000616 bool isBadCase = false;
617
618 for (unsigned Idx = FirstConstantOper+1;
Chris Lattner7765d712006-11-03 21:58:48 +0000619 Idx != MinOperands && isa<SequentialType>(NextTy); ++Idx) {
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000620 const Value *V1 = GEP1Ops[Idx], *V2 = GEP2Ops[Idx];
621 if (!isa<Constant>(V1) || !isa<Constant>(V2)) {
622 isBadCase = true;
623 break;
624 }
Chris Lattner7765d712006-11-03 21:58:48 +0000625 NextTy = cast<SequentialType>(NextTy)->getElementType();
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000626 }
627
628 if (isBadCase) G1OC = 0;
629 }
630
Chris Lattnera35339d2004-10-16 16:07:10 +0000631 // Make sure they are comparable (ie, not constant expressions), and
632 // make sure the GEP with the smaller leading constant is GEP1.
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000633 if (G1OC) {
Reid Spencere4d87aa2006-12-23 06:05:41 +0000634 Constant *Compare = ConstantExpr::getICmp(ICmpInst::ICMP_SGT,
635 G1OC, G2OC);
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +0000636 if (ConstantInt *CV = dyn_cast<ConstantInt>(Compare)) {
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000637 if (CV->getZExtValue()) { // If they are comparable and G2 > G1
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000638 std::swap(GEP1Ops, GEP2Ops); // Make GEP1 < GEP2
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000639 std::swap(NumGEP1Ops, NumGEP2Ops);
640 }
Chris Lattner5a3cf8d2006-03-04 02:06:34 +0000641 break;
642 }
Chris Lattner28977af2004-04-05 01:30:19 +0000643 }
Chris Lattner6eb88d42004-01-12 17:57:32 +0000644 }
645 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000646 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
Chris Lattnerd501c132003-02-26 19:41:54 +0000647 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000648
Chris Lattnerb307c882003-12-11 22:44:13 +0000649 // No shared constant operands, and we ran out of common operands. At this
650 // point, the GEP instructions have run through all of their operands, and we
651 // haven't found evidence that there are any deltas between the GEP's.
652 // However, one GEP may have more operands than the other. If this is the
Chris Lattner28977af2004-04-05 01:30:19 +0000653 // case, there may still be hope. Check this now.
Chris Lattnerb307c882003-12-11 22:44:13 +0000654 if (FirstConstantOper == MinOperands) {
655 // Make GEP1Ops be the longer one if there is a longer one.
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000656 if (NumGEP1Ops < NumGEP2Ops) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000657 std::swap(GEP1Ops, GEP2Ops);
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000658 std::swap(NumGEP1Ops, NumGEP2Ops);
659 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000660
661 // Is there anything to check?
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000662 if (NumGEP1Ops > MinOperands) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000663 for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +0000664 if (isa<ConstantInt>(GEP1Ops[i]) &&
Zhou Sheng843f07672007-04-19 05:39:12 +0000665 !cast<ConstantInt>(GEP1Ops[i])->isZero()) {
Chris Lattnerb307c882003-12-11 22:44:13 +0000666 // Yup, there's a constant in the tail. Set all variables to
667 // constants in the GEP instruction to make it suiteable for
668 // TargetData::getIndexedOffset.
669 for (i = 0; i != MaxOperands; ++i)
Chris Lattner0bb38312007-01-12 18:20:48 +0000670 if (!isa<ConstantInt>(GEP1Ops[i]))
Chris Lattnerb307c882003-12-11 22:44:13 +0000671 GEP1Ops[i] = Constant::getNullValue(GEP1Ops[i]->getType());
672 // Okay, now get the offset. This is the relative offset for the full
673 // instruction.
674 const TargetData &TD = getTargetData();
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000675 int64_t Offset1 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
676 NumGEP1Ops);
Chris Lattnerb307c882003-12-11 22:44:13 +0000677
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000678 // Now check without any constants at the end.
679 int64_t Offset2 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
680 MinOperands);
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000681
Chris Lattnerb307c882003-12-11 22:44:13 +0000682 // If the tail provided a bit enough offset, return noalias!
683 if ((uint64_t)(Offset2-Offset1) >= SizeMax)
684 return NoAlias;
685 }
686 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000687
Chris Lattnerb307c882003-12-11 22:44:13 +0000688 // Couldn't find anything useful.
689 return MayAlias;
690 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000691
692 // If there are non-equal constants arguments, then we can figure
693 // out a minimum known delta between the two index expressions... at
694 // this point we know that the first constant index of GEP1 is less
695 // than the first constant index of GEP2.
Chris Lattner1af55e12003-11-25 20:10:07 +0000696
Chris Lattnerb307c882003-12-11 22:44:13 +0000697 // Advance BasePtr[12]Ty over this first differing constant operand.
Chris Lattner2cfdd282006-03-04 21:48:01 +0000698 BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->
699 getTypeAtIndex(GEP2Ops[FirstConstantOper]);
700 BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->
701 getTypeAtIndex(GEP1Ops[FirstConstantOper]);
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000702
Chris Lattnerb307c882003-12-11 22:44:13 +0000703 // We are going to be using TargetData::getIndexedOffset to determine the
704 // offset that each of the GEP's is reaching. To do this, we have to convert
705 // all variable references to constant references. To do this, we convert the
Chris Lattner2cfdd282006-03-04 21:48:01 +0000706 // initial sequence of array subscripts into constant zeros to start with.
707 const Type *ZeroIdxTy = GEPPointerTy;
708 for (unsigned i = 0; i != FirstConstantOper; ++i) {
709 if (!isa<StructType>(ZeroIdxTy))
Reid Spencerc5b206b2006-12-31 05:48:39 +0000710 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Type::Int32Ty);
Chris Lattnerb307c882003-12-11 22:44:13 +0000711
Chris Lattner2cfdd282006-03-04 21:48:01 +0000712 if (const CompositeType *CT = dyn_cast<CompositeType>(ZeroIdxTy))
713 ZeroIdxTy = CT->getTypeAtIndex(GEP1Ops[i]);
714 }
715
Chris Lattnerb307c882003-12-11 22:44:13 +0000716 // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000717
Chris Lattnerd501c132003-02-26 19:41:54 +0000718 // Loop over the rest of the operands...
Chris Lattnerb307c882003-12-11 22:44:13 +0000719 for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000720 const Value *Op1 = i < NumGEP1Ops ? GEP1Ops[i] : 0;
721 const Value *Op2 = i < NumGEP2Ops ? GEP2Ops[i] : 0;
Chris Lattnerb307c882003-12-11 22:44:13 +0000722 // If they are equal, use a zero index...
723 if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
Chris Lattner0bb38312007-01-12 18:20:48 +0000724 if (!isa<ConstantInt>(Op1))
Chris Lattnerb307c882003-12-11 22:44:13 +0000725 GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Op1->getType());
726 // Otherwise, just keep the constants we have.
Chris Lattnerd501c132003-02-26 19:41:54 +0000727 } else {
Chris Lattnerb307c882003-12-11 22:44:13 +0000728 if (Op1) {
729 if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
730 // If this is an array index, make sure the array element is in range.
Chris Lattner7765d712006-11-03 21:58:48 +0000731 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty)) {
Reid Spencerb83eb642006-10-20 07:07:24 +0000732 if (Op1C->getZExtValue() >= AT->getNumElements())
Chris Lattnerb307c882003-12-11 22:44:13 +0000733 return MayAlias; // Be conservative with out-of-range accesses
Reid Spencer9d6565a2007-02-15 02:26:10 +0000734 } else if (const VectorType *PT = dyn_cast<VectorType>(BasePtr1Ty)) {
Chris Lattner7765d712006-11-03 21:58:48 +0000735 if (Op1C->getZExtValue() >= PT->getNumElements())
736 return MayAlias; // Be conservative with out-of-range accesses
737 }
738
Chris Lattnerb307c882003-12-11 22:44:13 +0000739 } else {
740 // GEP1 is known to produce a value less than GEP2. To be
741 // conservatively correct, we must assume the largest possible
742 // constant is used in this position. This cannot be the initial
743 // index to the GEP instructions (because we know we have at least one
744 // element before this one with the different constant arguments), so
745 // we know that the current index must be into either a struct or
746 // array. Because we know it's not constant, this cannot be a
747 // structure index. Because of this, we can calculate the maximum
748 // value possible.
749 //
750 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
Chris Lattner241607d2007-01-14 05:57:53 +0000751 GEP1Ops[i] = ConstantInt::get(Type::Int64Ty,AT->getNumElements()-1);
Reid Spencer9d6565a2007-02-15 02:26:10 +0000752 else if (const VectorType *PT = dyn_cast<VectorType>(BasePtr1Ty))
Chris Lattner241607d2007-01-14 05:57:53 +0000753 GEP1Ops[i] = ConstantInt::get(Type::Int64Ty,PT->getNumElements()-1);
Chris Lattner7765d712006-11-03 21:58:48 +0000754
Chris Lattnerb307c882003-12-11 22:44:13 +0000755 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000756 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000757
Chris Lattnerb307c882003-12-11 22:44:13 +0000758 if (Op2) {
759 if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
760 // If this is an array index, make sure the array element is in range.
Chris Lattner7765d712006-11-03 21:58:48 +0000761 if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty)) {
Reid Spencerb83eb642006-10-20 07:07:24 +0000762 if (Op2C->getZExtValue() >= AT->getNumElements())
Chris Lattnerb307c882003-12-11 22:44:13 +0000763 return MayAlias; // Be conservative with out-of-range accesses
Reid Spencer9d6565a2007-02-15 02:26:10 +0000764 } else if (const VectorType *PT = dyn_cast<VectorType>(BasePtr1Ty)) {
Chris Lattner7765d712006-11-03 21:58:48 +0000765 if (Op2C->getZExtValue() >= PT->getNumElements())
766 return MayAlias; // Be conservative with out-of-range accesses
767 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000768 } else { // Conservatively assume the minimum value for this index
769 GEP2Ops[i] = Constant::getNullValue(Op2->getType());
770 }
Chris Lattner920bd792003-06-02 05:42:39 +0000771 }
Chris Lattnerb307c882003-12-11 22:44:13 +0000772 }
773
774 if (BasePtr1Ty && Op1) {
775 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
776 BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
777 else
778 BasePtr1Ty = 0;
779 }
780
781 if (BasePtr2Ty && Op2) {
782 if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
783 BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
784 else
785 BasePtr2Ty = 0;
Chris Lattnerd501c132003-02-26 19:41:54 +0000786 }
787 }
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000788
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000789 if (GEPPointerTy->getElementType()->isSized()) {
Chris Lattner829621c2007-02-10 20:35:22 +0000790 int64_t Offset1 =
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000791 getTargetData().getIndexedOffset(GEPPointerTy, GEP1Ops, NumGEP1Ops);
Chris Lattner829621c2007-02-10 20:35:22 +0000792 int64_t Offset2 =
Chris Lattnerfd1ad3b2007-02-10 22:12:53 +0000793 getTargetData().getIndexedOffset(GEPPointerTy, GEP2Ops, NumGEP2Ops);
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000794 assert(Offset1<Offset2 && "There is at least one different constant here!");
Chris Lattnerd501c132003-02-26 19:41:54 +0000795
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000796 if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000797 //cerr << "Determined that these two GEP's don't alias ["
798 // << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
Alkis Evlogimenosc49741d2004-12-08 23:56:15 +0000799 return NoAlias;
800 }
Chris Lattnerd501c132003-02-26 19:41:54 +0000801 }
802 return MayAlias;
803}
804
Chris Lattner4244bb52004-03-15 03:36:49 +0000805namespace {
Reid Spencerd7d83db2007-02-05 23:42:17 +0000806 struct VISIBILITY_HIDDEN StringCompare {
Chris Lattner4244bb52004-03-15 03:36:49 +0000807 bool operator()(const char *LHS, const char *RHS) {
808 return strcmp(LHS, RHS) < 0;
809 }
810 };
811}
812
813// Note that this list cannot contain libm functions (such as acos and sqrt)
814// that set errno on a domain or other error.
Chris Lattnercad25372006-03-09 22:31:29 +0000815static const char *DoesntAccessMemoryFns[] = {
Chris Lattner4244bb52004-03-15 03:36:49 +0000816 "abs", "labs", "llabs", "imaxabs", "fabs", "fabsf", "fabsl",
817 "trunc", "truncf", "truncl", "ldexp",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000818
Chris Lattner4244bb52004-03-15 03:36:49 +0000819 "atan", "atanf", "atanl", "atan2", "atan2f", "atan2l",
820 "cbrt",
Chris Lattner5b103c22005-04-28 21:52:31 +0000821 "cos", "cosf", "cosl",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000822 "exp", "expf", "expl",
Chris Lattner4244bb52004-03-15 03:36:49 +0000823 "hypot",
Chris Lattner5b103c22005-04-28 21:52:31 +0000824 "sin", "sinf", "sinl",
Chris Lattner4244bb52004-03-15 03:36:49 +0000825 "tan", "tanf", "tanl", "tanh", "tanhf", "tanhl",
Chris Lattnerab466d72005-08-24 16:58:56 +0000826
827 "floor", "floorf", "floorl", "ceil", "ceilf", "ceill",
Chris Lattner4244bb52004-03-15 03:36:49 +0000828
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000829 // ctype.h
Chris Lattner4244bb52004-03-15 03:36:49 +0000830 "isalnum", "isalpha", "iscntrl", "isdigit", "isgraph", "islower", "isprint"
831 "ispunct", "isspace", "isupper", "isxdigit", "tolower", "toupper",
832
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000833 // wctype.h"
Chris Lattner4244bb52004-03-15 03:36:49 +0000834 "iswalnum", "iswalpha", "iswcntrl", "iswdigit", "iswgraph", "iswlower",
835 "iswprint", "iswpunct", "iswspace", "iswupper", "iswxdigit",
836
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000837 "iswctype", "towctrans", "towlower", "towupper",
Chris Lattnerbbcc1472004-03-15 04:18:28 +0000838
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000839 "btowc", "wctob",
Chris Lattner002be762004-03-16 03:41:35 +0000840
841 "isinf", "isnan", "finite",
842
843 // C99 math functions
844 "copysign", "copysignf", "copysignd",
845 "nexttoward", "nexttowardf", "nexttowardd",
846 "nextafter", "nextafterf", "nextafterd",
847
Andrew Lenharthd3513e02005-07-11 20:35:20 +0000848 // ISO C99:
Chris Lattner002be762004-03-16 03:41:35 +0000849 "__signbit", "__signbitf", "__signbitl",
Chris Lattner4244bb52004-03-15 03:36:49 +0000850};
851
Chris Lattner4244bb52004-03-15 03:36:49 +0000852
Chris Lattnercad25372006-03-09 22:31:29 +0000853static const char *OnlyReadsMemoryFns[] = {
Chris Lattner002be762004-03-16 03:41:35 +0000854 "atoi", "atol", "atof", "atoll", "atoq", "a64l",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000855 "bcmp", "memcmp", "memchr", "memrchr", "wmemcmp", "wmemchr",
Chris Lattner4244bb52004-03-15 03:36:49 +0000856
857 // Strings
858 "strcmp", "strcasecmp", "strcoll", "strncmp", "strncasecmp",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000859 "strchr", "strcspn", "strlen", "strpbrk", "strrchr", "strspn", "strstr",
Chris Lattner002be762004-03-16 03:41:35 +0000860 "index", "rindex",
Chris Lattner4244bb52004-03-15 03:36:49 +0000861
862 // Wide char strings
863 "wcschr", "wcscmp", "wcscoll", "wcscspn", "wcslen", "wcsncmp", "wcspbrk",
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000864 "wcsrchr", "wcsspn", "wcsstr",
Chris Lattner002be762004-03-16 03:41:35 +0000865
866 // glibc
867 "alphasort", "alphasort64", "versionsort", "versionsort64",
868
869 // C99
870 "nan", "nanf", "nand",
Chris Lattnerb903fc52004-04-10 06:55:27 +0000871
872 // File I/O
873 "feof", "ferror", "fileno",
874 "feof_unlocked", "ferror_unlocked", "fileno_unlocked"
Chris Lattner4244bb52004-03-15 03:36:49 +0000875};
876
Chris Lattner90aa8392006-10-04 21:52:35 +0000877static ManagedStatic<std::vector<const char*> > NoMemoryTable;
878static ManagedStatic<std::vector<const char*> > OnlyReadsMemoryTable;
879
Chandler Carrutha5839902007-08-06 20:57:16 +0000880static ManagedStatic<BitVector> NoMemoryIntrinsics;
881static ManagedStatic<BitVector> OnlyReadsMemoryIntrinsics;
882
Chris Lattner90aa8392006-10-04 21:52:35 +0000883
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000884AliasAnalysis::ModRefBehavior
Chris Lattner0af024c2004-12-15 07:22:13 +0000885BasicAliasAnalysis::getModRefBehavior(Function *F, CallSite CS,
886 std::vector<PointerAccessInfo> *Info) {
Reid Spencer5cbf9852007-01-30 20:08:39 +0000887 if (!F->isDeclaration()) return UnknownModRefBehavior;
Chris Lattner4244bb52004-03-15 03:36:49 +0000888
889 static bool Initialized = false;
890 if (!Initialized) {
Chris Lattner90aa8392006-10-04 21:52:35 +0000891 NoMemoryTable->insert(NoMemoryTable->end(),
892 DoesntAccessMemoryFns,
893 DoesntAccessMemoryFns+
Chris Lattnercad25372006-03-09 22:31:29 +0000894 sizeof(DoesntAccessMemoryFns)/sizeof(DoesntAccessMemoryFns[0]));
895
Chris Lattner90aa8392006-10-04 21:52:35 +0000896 OnlyReadsMemoryTable->insert(OnlyReadsMemoryTable->end(),
Chris Lattnercad25372006-03-09 22:31:29 +0000897 OnlyReadsMemoryFns,
898 OnlyReadsMemoryFns+
899 sizeof(OnlyReadsMemoryFns)/sizeof(OnlyReadsMemoryFns[0]));
Chandler Carrutha5839902007-08-06 20:57:16 +0000900
Chris Lattner4244bb52004-03-15 03:36:49 +0000901 // Sort the table the first time through.
Chris Lattner90aa8392006-10-04 21:52:35 +0000902 std::sort(NoMemoryTable->begin(), NoMemoryTable->end(), StringCompare());
903 std::sort(OnlyReadsMemoryTable->begin(), OnlyReadsMemoryTable->end(),
Chris Lattner4244bb52004-03-15 03:36:49 +0000904 StringCompare());
Chandler Carrutha5839902007-08-06 20:57:16 +0000905
906 NoMemoryIntrinsics->resize(Intrinsic::num_intrinsics);
907 OnlyReadsMemoryIntrinsics->resize(Intrinsic::num_intrinsics);
908#define GET_MODREF_BEHAVIOR
909#include "llvm/Intrinsics.gen"
910#undef GET_MODREF_BEHAVIOR
911
Chris Lattner4244bb52004-03-15 03:36:49 +0000912 Initialized = true;
913 }
Chandler Carrutha5839902007-08-06 20:57:16 +0000914
915 // If this is an intrinsic, we can use lookup tables
916 if (unsigned id = F->getIntrinsicID()) {
917 if (NoMemoryIntrinsics->test(id))
918 return DoesNotAccessMemory;
919 if (OnlyReadsMemoryIntrinsics->test(id))
920 return OnlyReadsMemory;
921
922 return UnknownModRefBehavior;
923 }
Chris Lattner8c528702007-08-05 07:50:06 +0000924
925 ValueName *Name = F->getValueName();
926 unsigned NameLen = Name->getKeyLength();
927 const char *NamePtr = Name->getKeyData();
928
929 // If there is an embedded nul character in the function name, we can never
930 // match it.
931 if (strlen(NamePtr) != NameLen)
932 return UnknownModRefBehavior;
Chris Lattner4244bb52004-03-15 03:36:49 +0000933
Chris Lattnercad25372006-03-09 22:31:29 +0000934 std::vector<const char*>::iterator Ptr =
Chris Lattner90aa8392006-10-04 21:52:35 +0000935 std::lower_bound(NoMemoryTable->begin(), NoMemoryTable->end(),
Chris Lattner8c528702007-08-05 07:50:06 +0000936 NamePtr, StringCompare());
937 if (Ptr != NoMemoryTable->end() && strcmp(*Ptr, NamePtr) == 0)
Chris Lattner0af024c2004-12-15 07:22:13 +0000938 return DoesNotAccessMemory;
Misha Brukman2b37d7c2005-04-21 21:13:18 +0000939
Chris Lattner90aa8392006-10-04 21:52:35 +0000940 Ptr = std::lower_bound(OnlyReadsMemoryTable->begin(),
941 OnlyReadsMemoryTable->end(),
Chris Lattner8c528702007-08-05 07:50:06 +0000942 NamePtr, StringCompare());
943 if (Ptr != OnlyReadsMemoryTable->end() && strcmp(*Ptr, NamePtr) == 0)
Chris Lattner0af024c2004-12-15 07:22:13 +0000944 return OnlyReadsMemory;
945
946 return UnknownModRefBehavior;
Chris Lattner4244bb52004-03-15 03:36:49 +0000947}
Reid Spencer4f1bd9e2006-06-07 22:00:26 +0000948
949// Make sure that anything that uses AliasAnalysis pulls in this file...
950DEFINING_FILE_FOR(BasicAliasAnalysis)