whitespace cleanup, tidying
[oota-llvm.git] / lib / Analysis / BasicAliasAnalysis.cpp
1 //===- BasicAliasAnalysis.cpp - Local Alias Analysis Impl -----------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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"
17 #include "llvm/Analysis/CaptureTracking.h"
18 #include "llvm/Analysis/MemoryBuiltins.h"
19 #include "llvm/Analysis/Passes.h"
20 #include "llvm/Constants.h"
21 #include "llvm/DerivedTypes.h"
22 #include "llvm/Function.h"
23 #include "llvm/GlobalVariable.h"
24 #include "llvm/Instructions.h"
25 #include "llvm/IntrinsicInst.h"
26 #include "llvm/Operator.h"
27 #include "llvm/Pass.h"
28 #include "llvm/Target/TargetData.h"
29 #include "llvm/ADT/SmallSet.h"
30 #include "llvm/ADT/SmallVector.h"
31 #include "llvm/ADT/STLExtras.h"
32 #include "llvm/Support/ErrorHandling.h"
33 #include "llvm/Support/GetElementPtrTypeIterator.h"
34 #include <algorithm>
35 using namespace llvm;
36
37 //===----------------------------------------------------------------------===//
38 // Useful predicates
39 //===----------------------------------------------------------------------===//
40
41 static const Value *GetGEPOperands(const Value *V, 
42                                    SmallVector<Value*, 16> &GEPOps) {
43   assert(GEPOps.empty() && "Expect empty list to populate!");
44   GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
45                 cast<User>(V)->op_end());
46
47   // Accumulate all of the chained indexes into the operand array
48   V = cast<User>(V)->getOperand(0);
49
50   while (const GEPOperator *G = dyn_cast<GEPOperator>(V)) {
51     if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
52         !cast<Constant>(GEPOps[0])->isNullValue())
53       break;  // Don't handle folding arbitrary pointer offsets yet...
54     GEPOps.erase(GEPOps.begin());   // Drop the zero index
55     GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
56     V = G->getOperand(0);
57   }
58   return V;
59 }
60
61 /// isKnownNonNull - Return true if we know that the specified value is never
62 /// null.
63 static bool isKnownNonNull(const Value *V) {
64   // Alloca never returns null, malloc might.
65   if (isa<AllocaInst>(V)) return true;
66   
67   // A byval argument is never null.
68   if (const Argument *A = dyn_cast<Argument>(V))
69     return A->hasByValAttr();
70
71   // Global values are not null unless extern weak.
72   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
73     return !GV->hasExternalWeakLinkage();
74   return false;
75 }
76
77 /// isNonEscapingLocalObject - Return true if the pointer is to a function-local
78 /// object that never escapes from the function.
79 static bool isNonEscapingLocalObject(const Value *V) {
80   // If this is a local allocation, check to see if it escapes.
81   if (isa<AllocaInst>(V) || isNoAliasCall(V))
82     // Set StoreCaptures to True so that we can assume in our callers that the
83     // pointer is not the result of a load instruction. Currently
84     // PointerMayBeCaptured doesn't have any special analysis for the
85     // StoreCaptures=false case; if it did, our callers could be refined to be
86     // more precise.
87     return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
88
89   // If this is an argument that corresponds to a byval or noalias argument,
90   // then it has not escaped before entering the function.  Check if it escapes
91   // inside the function.
92   if (const Argument *A = dyn_cast<Argument>(V))
93     if (A->hasByValAttr() || A->hasNoAliasAttr()) {
94       // Don't bother analyzing arguments already known not to escape.
95       if (A->hasNoCaptureAttr())
96         return true;
97       return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
98     }
99   return false;
100 }
101
102
103 /// isObjectSmallerThan - Return true if we can prove that the object specified
104 /// by V is smaller than Size.
105 static bool isObjectSmallerThan(const Value *V, unsigned Size,
106                                 const TargetData &TD) {
107   const Type *AccessTy;
108   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
109     AccessTy = GV->getType()->getElementType();
110   } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(V)) {
111     if (!AI->isArrayAllocation())
112       AccessTy = AI->getType()->getElementType();
113     else
114       return false;
115   } else if (const CallInst* CI = extractMallocCall(V)) {
116     if (!isArrayMalloc(V, &TD))
117       // The size is the argument to the malloc call.
118       if (const ConstantInt* C = dyn_cast<ConstantInt>(CI->getOperand(1)))
119         return (C->getZExtValue() < Size);
120     return false;
121   } else if (const Argument *A = dyn_cast<Argument>(V)) {
122     if (A->hasByValAttr())
123       AccessTy = cast<PointerType>(A->getType())->getElementType();
124     else
125       return false;
126   } else {
127     return false;
128   }
129   
130   if (AccessTy->isSized())
131     return TD.getTypeAllocSize(AccessTy) < Size;
132   return false;
133 }
134
135 //===----------------------------------------------------------------------===//
136 // NoAA Pass
137 //===----------------------------------------------------------------------===//
138
139 namespace {
140   /// NoAA - This class implements the -no-aa pass, which always returns "I
141   /// don't know" for alias queries.  NoAA is unlike other alias analysis
142   /// implementations, in that it does not chain to a previous analysis.  As
143   /// such it doesn't follow many of the rules that other alias analyses must.
144   ///
145   struct NoAA : public ImmutablePass, public AliasAnalysis {
146     static char ID; // Class identification, replacement for typeinfo
147     NoAA() : ImmutablePass(&ID) {}
148     explicit NoAA(void *PID) : ImmutablePass(PID) { }
149
150     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
151     }
152
153     virtual void initializePass() {
154       TD = getAnalysisIfAvailable<TargetData>();
155     }
156
157     virtual AliasResult alias(const Value *V1, unsigned V1Size,
158                               const Value *V2, unsigned V2Size) {
159       return MayAlias;
160     }
161
162     virtual void getArgumentAccesses(Function *F, CallSite CS,
163                                      std::vector<PointerAccessInfo> &Info) {
164       llvm_unreachable("This method may not be called on this function!");
165     }
166
167     virtual bool pointsToConstantMemory(const Value *P) { return false; }
168     virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
169       return ModRef;
170     }
171     virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
172       return ModRef;
173     }
174
175     virtual void deleteValue(Value *V) {}
176     virtual void copyValue(Value *From, Value *To) {}
177   };
178 }  // End of anonymous namespace
179
180 // Register this pass...
181 char NoAA::ID = 0;
182 static RegisterPass<NoAA>
183 U("no-aa", "No Alias Analysis (always returns 'may' alias)", true, true);
184
185 // Declare that we implement the AliasAnalysis interface
186 static RegisterAnalysisGroup<AliasAnalysis> V(U);
187
188 ImmutablePass *llvm::createNoAAPass() { return new NoAA(); }
189
190 //===----------------------------------------------------------------------===//
191 // BasicAA Pass
192 //===----------------------------------------------------------------------===//
193
194 namespace {
195   /// BasicAliasAnalysis - This is the default alias analysis implementation.
196   /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
197   /// derives from the NoAA class.
198   struct BasicAliasAnalysis : public NoAA {
199     static char ID; // Class identification, replacement for typeinfo
200     BasicAliasAnalysis() : NoAA(&ID) {}
201     AliasResult alias(const Value *V1, unsigned V1Size,
202                       const Value *V2, unsigned V2Size) {
203       assert(VisitedPHIs.empty() && "VisitedPHIs must be cleared after use!");
204       AliasResult Alias = aliasCheck(V1, V1Size, V2, V2Size);
205       VisitedPHIs.clear();
206       return Alias;
207     }
208
209     ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
210     ModRefResult getModRefInfo(CallSite CS1, CallSite CS2);
211
212     /// pointsToConstantMemory - Chase pointers until we find a (constant
213     /// global) or not.
214     bool pointsToConstantMemory(const Value *P);
215
216   private:
217     // VisitedPHIs - Track PHI nodes visited by a aliasCheck() call.
218     SmallPtrSet<const Value*, 16> VisitedPHIs;
219
220     // aliasGEP - Provide a bunch of ad-hoc rules to disambiguate a GEP
221     // instruction against another.
222     AliasResult aliasGEP(const Value *V1, unsigned V1Size,
223                          const Value *V2, unsigned V2Size);
224
225     // aliasPHI - Provide a bunch of ad-hoc rules to disambiguate a PHI
226     // instruction against another.
227     AliasResult aliasPHI(const PHINode *PN, unsigned PNSize,
228                          const Value *V2, unsigned V2Size);
229
230     /// aliasSelect - Disambiguate a Select instruction against another value.
231     AliasResult aliasSelect(const SelectInst *SI, unsigned SISize,
232                             const Value *V2, unsigned V2Size);
233
234     AliasResult aliasCheck(const Value *V1, unsigned V1Size,
235                            const Value *V2, unsigned V2Size);
236
237     // CheckGEPInstructions - Check two GEP instructions with known
238     // must-aliasing base pointers.  This checks to see if the index expressions
239     // preclude the pointers from aliasing.
240     AliasResult
241     CheckGEPInstructions(const Type* BasePtr1Ty,
242                          Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1Size,
243                          const Type *BasePtr2Ty,
244                          Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2Size);
245   };
246 }  // End of anonymous namespace
247
248 // Register this pass...
249 char BasicAliasAnalysis::ID = 0;
250 static RegisterPass<BasicAliasAnalysis>
251 X("basicaa", "Basic Alias Analysis (default AA impl)", false, true);
252
253 // Declare that we implement the AliasAnalysis interface
254 static RegisterAnalysisGroup<AliasAnalysis, true> Y(X);
255
256 ImmutablePass *llvm::createBasicAliasAnalysisPass() {
257   return new BasicAliasAnalysis();
258 }
259
260
261 /// pointsToConstantMemory - Chase pointers until we find a (constant
262 /// global) or not.
263 bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
264   if (const GlobalVariable *GV = 
265         dyn_cast<GlobalVariable>(P->getUnderlyingObject()))
266     // FIXME: shouldn't this require GV to be "ODR"?
267     return GV->isConstant();
268   return false;
269 }
270
271
272 /// getModRefInfo - Check to see if the specified callsite can clobber the
273 /// specified memory object.  Since we only look at local properties of this
274 /// function, we really can't say much about this query.  We do, however, use
275 /// simple "address taken" analysis on local objects.
276 AliasAnalysis::ModRefResult
277 BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
278   const Value *Object = P->getUnderlyingObject();
279   
280   // If this is a tail call and P points to a stack location, we know that
281   // the tail call cannot access or modify the local stack.
282   // We cannot exclude byval arguments here; these belong to the caller of
283   // the current function not to the current function, and a tail callee
284   // may reference them.
285   if (isa<AllocaInst>(Object))
286     if (CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
287       if (CI->isTailCall())
288         return NoModRef;
289   
290   // If the pointer is to a locally allocated object that does not escape,
291   // then the call can not mod/ref the pointer unless the call takes the pointer
292   // as an argument, and itself doesn't capture it.
293   if (isNonEscapingLocalObject(Object) && CS.getInstruction() != Object) {
294     bool PassedAsArg = false;
295     unsigned ArgNo = 0;
296     for (CallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
297          CI != CE; ++CI, ++ArgNo) {
298       // Only look at the no-capture pointer arguments.
299       if (!isa<PointerType>((*CI)->getType()) ||
300           !CS.paramHasAttr(ArgNo+1, Attribute::NoCapture))
301         continue;
302       
303       // If  this is a no-capture pointer argument, see if we can tell that it
304       // is impossible to alias the pointer we're checking.  If not, we have to
305       // assume that the call could touch the pointer, even though it doesn't
306       // escape.
307       if (alias(cast<Value>(CI), ~0U, P, ~0U) != NoAlias) {
308         PassedAsArg = true;
309         break;
310       }
311     }
312     
313     if (!PassedAsArg)
314       return NoModRef;
315   }
316
317   // Finally, handle specific knowledge of intrinsics.
318   IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction());
319   if (II == 0)
320     return AliasAnalysis::getModRefInfo(CS, P, Size);
321
322   switch (II->getIntrinsicID()) {
323   default: break;
324   case Intrinsic::memcpy:
325   case Intrinsic::memmove: {
326     unsigned Len = ~0U;
327     if (ConstantInt *LenCI = dyn_cast<ConstantInt>(II->getOperand(3)))
328       Len = LenCI->getZExtValue();
329     Value *Dest = II->getOperand(1);
330     Value *Src = II->getOperand(2);
331     if (alias(Dest, Len, P, Size) == NoAlias) {
332       if (alias(Src, Len, P, Size) == NoAlias)
333         return NoModRef;
334       return Ref;
335     }
336     break;
337   }
338   case Intrinsic::memset:
339     if (ConstantInt *LenCI = dyn_cast<ConstantInt>(II->getOperand(3))) {
340       unsigned Len = LenCI->getZExtValue();
341       Value *Dest = II->getOperand(1);
342       if (alias(Dest, Len, P, Size) == NoAlias)
343         return NoModRef;
344     }
345     break;
346   case Intrinsic::atomic_cmp_swap:
347   case Intrinsic::atomic_swap:
348   case Intrinsic::atomic_load_add:
349   case Intrinsic::atomic_load_sub:
350   case Intrinsic::atomic_load_and:
351   case Intrinsic::atomic_load_nand:
352   case Intrinsic::atomic_load_or:
353   case Intrinsic::atomic_load_xor:
354   case Intrinsic::atomic_load_max:
355   case Intrinsic::atomic_load_min:
356   case Intrinsic::atomic_load_umax:
357   case Intrinsic::atomic_load_umin:
358     if (TD) {
359       Value *Op1 = II->getOperand(1);
360       unsigned Op1Size = TD->getTypeStoreSize(Op1->getType());
361       if (alias(Op1, Op1Size, P, Size) == NoAlias)
362         return NoModRef;
363     }
364     break;
365   case Intrinsic::lifetime_start:
366   case Intrinsic::lifetime_end:
367   case Intrinsic::invariant_start: {
368     unsigned PtrSize = cast<ConstantInt>(II->getOperand(1))->getZExtValue();
369     if (alias(II->getOperand(2), PtrSize, P, Size) == NoAlias)
370       return NoModRef;
371     break;
372   }
373   case Intrinsic::invariant_end: {
374     unsigned PtrSize = cast<ConstantInt>(II->getOperand(2))->getZExtValue();
375     if (alias(II->getOperand(3), PtrSize, P, Size) == NoAlias)
376       return NoModRef;
377     break;
378   }
379   }
380
381   // The AliasAnalysis base class has some smarts, lets use them.
382   return AliasAnalysis::getModRefInfo(CS, P, Size);
383 }
384
385
386 AliasAnalysis::ModRefResult 
387 BasicAliasAnalysis::getModRefInfo(CallSite CS1, CallSite CS2) {
388   // If CS1 or CS2 are readnone, they don't interact.
389   ModRefBehavior CS1B = AliasAnalysis::getModRefBehavior(CS1);
390   if (CS1B == DoesNotAccessMemory) return NoModRef;
391   
392   ModRefBehavior CS2B = AliasAnalysis::getModRefBehavior(CS2);
393   if (CS2B == DoesNotAccessMemory) return NoModRef;
394   
395   // If they both only read from memory, just return ref.
396   if (CS1B == OnlyReadsMemory && CS2B == OnlyReadsMemory)
397     return Ref;
398   
399   // Otherwise, fall back to NoAA (mod+ref).
400   return NoAA::getModRefInfo(CS1, CS2);
401 }
402
403 // aliasGEP - Provide a bunch of ad-hoc rules to disambiguate a GEP instruction
404 // against another.
405 //
406 AliasAnalysis::AliasResult
407 BasicAliasAnalysis::aliasGEP(const Value *V1, unsigned V1Size,
408                              const Value *V2, unsigned V2Size) {
409   // If we have two gep instructions with must-alias'ing base pointers, figure
410   // out if the indexes to the GEP tell us anything about the derived pointer.
411   // Note that we also handle chains of getelementptr instructions as well as
412   // constant expression getelementptrs here.
413   //
414   if (isa<GEPOperator>(V1) && isa<GEPOperator>(V2)) {
415     const User *GEP1 = cast<User>(V1);
416     const User *GEP2 = cast<User>(V2);
417     
418     // If V1 and V2 are identical GEPs, just recurse down on both of them.
419     // This allows us to analyze things like:
420     //   P = gep A, 0, i, 1
421     //   Q = gep B, 0, i, 1
422     // by just analyzing A and B.  This is even safe for variable indices.
423     if (GEP1->getType() == GEP2->getType() &&
424         GEP1->getNumOperands() == GEP2->getNumOperands() &&
425         GEP1->getOperand(0)->getType() == GEP2->getOperand(0)->getType() &&
426         // All operands are the same, ignoring the base.
427         std::equal(GEP1->op_begin()+1, GEP1->op_end(), GEP2->op_begin()+1))
428       return aliasCheck(GEP1->getOperand(0), V1Size,
429                         GEP2->getOperand(0), V2Size);
430     
431     // Drill down into the first non-gep value, to test for must-aliasing of
432     // the base pointers.
433     while (isa<GEPOperator>(GEP1->getOperand(0)) &&
434            GEP1->getOperand(1) ==
435            Constant::getNullValue(GEP1->getOperand(1)->getType()))
436       GEP1 = cast<User>(GEP1->getOperand(0));
437     const Value *BasePtr1 = GEP1->getOperand(0);
438
439     while (isa<GEPOperator>(GEP2->getOperand(0)) &&
440            GEP2->getOperand(1) ==
441            Constant::getNullValue(GEP2->getOperand(1)->getType()))
442       GEP2 = cast<User>(GEP2->getOperand(0));
443     const Value *BasePtr2 = GEP2->getOperand(0);
444
445     // Do the base pointers alias?
446     AliasResult BaseAlias = aliasCheck(BasePtr1, ~0U, BasePtr2, ~0U);
447     if (BaseAlias == NoAlias) return NoAlias;
448     if (BaseAlias == MustAlias) {
449       // If the base pointers alias each other exactly, check to see if we can
450       // figure out anything about the resultant pointers, to try to prove
451       // non-aliasing.
452
453       // Collect all of the chained GEP operands together into one simple place
454       SmallVector<Value*, 16> GEP1Ops, GEP2Ops;
455       BasePtr1 = GetGEPOperands(V1, GEP1Ops);
456       BasePtr2 = GetGEPOperands(V2, GEP2Ops);
457
458       // If GetGEPOperands were able to fold to the same must-aliased pointer,
459       // do the comparison.
460       if (BasePtr1 == BasePtr2) {
461         AliasResult GAlias =
462           CheckGEPInstructions(BasePtr1->getType(),
463                                &GEP1Ops[0], GEP1Ops.size(), V1Size,
464                                BasePtr2->getType(),
465                                &GEP2Ops[0], GEP2Ops.size(), V2Size);
466         if (GAlias != MayAlias)
467           return GAlias;
468       }
469     }
470   }
471
472   // Check to see if these two pointers are related by a getelementptr
473   // instruction.  If one pointer is a GEP with a non-zero index of the other
474   // pointer, we know they cannot alias.
475   //
476   if (V1Size == ~0U || V2Size == ~0U)
477     return MayAlias;
478
479   SmallVector<Value*, 16> GEPOperands;
480   const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
481
482   AliasResult R = aliasCheck(BasePtr, ~0U, V2, V2Size);
483   if (R != MustAlias)
484     // If V2 may alias GEP base pointer, conservatively returns MayAlias.
485     // If V2 is known not to alias GEP base pointer, then the two values
486     // cannot alias per GEP semantics: "A pointer value formed from a
487     // getelementptr instruction is associated with the addresses associated
488     // with the first operand of the getelementptr".
489     return R;
490
491   // If there is at least one non-zero constant index, we know they cannot
492   // alias.
493   bool ConstantFound = false;
494   bool AllZerosFound = true;
495   for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
496     if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
497       if (!C->isNullValue()) {
498         ConstantFound = true;
499         AllZerosFound = false;
500         break;
501       }
502     } else {
503       AllZerosFound = false;
504     }
505
506   // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
507   // the ptr, the end result is a must alias also.
508   if (AllZerosFound)
509     return MustAlias;
510
511   if (ConstantFound) {
512     if (V2Size <= 1 && V1Size <= 1)  // Just pointer check?
513       return NoAlias;
514
515     // Otherwise we have to check to see that the distance is more than
516     // the size of the argument... build an index vector that is equal to
517     // the arguments provided, except substitute 0's for any variable
518     // indexes we find...
519     if (TD &&
520         cast<PointerType>(BasePtr->getType())->getElementType()->isSized()) {
521       for (unsigned i = 0; i != GEPOperands.size(); ++i)
522         if (!isa<ConstantInt>(GEPOperands[i]))
523           GEPOperands[i] = Constant::getNullValue(GEPOperands[i]->getType());
524       int64_t Offset = TD->getIndexedOffset(BasePtr->getType(),
525                                             &GEPOperands[0],
526                                             GEPOperands.size());
527
528       if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
529         return NoAlias;
530     }
531   }
532
533   return MayAlias;
534 }
535
536 /// aliasSelect - Provide a bunch of ad-hoc rules to disambiguate a Select
537 /// instruction against another.
538 AliasAnalysis::AliasResult
539 BasicAliasAnalysis::aliasSelect(const SelectInst *SI, unsigned SISize,
540                                 const Value *V2, unsigned V2Size) {
541   // If the values are Selects with the same condition, we can do a more precise
542   // check: just check for aliases between the values on corresponding arms.
543   if (const SelectInst *SI2 = dyn_cast<SelectInst>(V2))
544     if (SI->getCondition() == SI2->getCondition()) {
545       AliasResult Alias =
546         aliasCheck(SI->getTrueValue(), SISize,
547                    SI2->getTrueValue(), V2Size);
548       if (Alias == MayAlias)
549         return MayAlias;
550       AliasResult ThisAlias =
551         aliasCheck(SI->getFalseValue(), SISize,
552                    SI2->getFalseValue(), V2Size);
553       if (ThisAlias != Alias)
554         return MayAlias;
555       return Alias;
556     }
557
558   // If both arms of the Select node NoAlias or MustAlias V2, then returns
559   // NoAlias / MustAlias. Otherwise, returns MayAlias.
560   AliasResult Alias =
561     aliasCheck(SI->getTrueValue(), SISize, V2, V2Size);
562   if (Alias == MayAlias)
563     return MayAlias;
564   AliasResult ThisAlias =
565     aliasCheck(SI->getFalseValue(), SISize, V2, V2Size);
566   if (ThisAlias != Alias)
567     return MayAlias;
568   return Alias;
569 }
570
571 // aliasPHI - Provide a bunch of ad-hoc rules to disambiguate a PHI instruction
572 // against another.
573 AliasAnalysis::AliasResult
574 BasicAliasAnalysis::aliasPHI(const PHINode *PN, unsigned PNSize,
575                              const Value *V2, unsigned V2Size) {
576   // The PHI node has already been visited, avoid recursion any further.
577   if (!VisitedPHIs.insert(PN))
578     return MayAlias;
579
580   // If the values are PHIs in the same block, we can do a more precise
581   // as well as efficient check: just check for aliases between the values
582   // on corresponding edges.
583   if (const PHINode *PN2 = dyn_cast<PHINode>(V2))
584     if (PN2->getParent() == PN->getParent()) {
585       AliasResult Alias =
586         aliasCheck(PN->getIncomingValue(0), PNSize,
587                    PN2->getIncomingValueForBlock(PN->getIncomingBlock(0)),
588                    V2Size);
589       if (Alias == MayAlias)
590         return MayAlias;
591       for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i) {
592         AliasResult ThisAlias =
593           aliasCheck(PN->getIncomingValue(i), PNSize,
594                      PN2->getIncomingValueForBlock(PN->getIncomingBlock(i)),
595                      V2Size);
596         if (ThisAlias != Alias)
597           return MayAlias;
598       }
599       return Alias;
600     }
601
602   SmallPtrSet<Value*, 4> UniqueSrc;
603   SmallVector<Value*, 4> V1Srcs;
604   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
605     Value *PV1 = PN->getIncomingValue(i);
606     if (isa<PHINode>(PV1))
607       // If any of the source itself is a PHI, return MayAlias conservatively
608       // to avoid compile time explosion. The worst possible case is if both
609       // sides are PHI nodes. In which case, this is O(m x n) time where 'm'
610       // and 'n' are the number of PHI sources.
611       return MayAlias;
612     if (UniqueSrc.insert(PV1))
613       V1Srcs.push_back(PV1);
614   }
615
616   AliasResult Alias = aliasCheck(V2, V2Size, V1Srcs[0], PNSize);
617   // Early exit if the check of the first PHI source against V2 is MayAlias.
618   // Other results are not possible.
619   if (Alias == MayAlias)
620     return MayAlias;
621
622   // If all sources of the PHI node NoAlias or MustAlias V2, then returns
623   // NoAlias / MustAlias. Otherwise, returns MayAlias.
624   for (unsigned i = 1, e = V1Srcs.size(); i != e; ++i) {
625     Value *V = V1Srcs[i];
626
627     // If V2 is a PHI, the recursive case will have been caught in the
628     // above aliasCheck call, so these subsequent calls to aliasCheck
629     // don't need to assume that V2 is being visited recursively.
630     VisitedPHIs.erase(V2);
631
632     AliasResult ThisAlias = aliasCheck(V2, V2Size, V, PNSize);
633     if (ThisAlias != Alias || ThisAlias == MayAlias)
634       return MayAlias;
635   }
636
637   return Alias;
638 }
639
640 // aliasCheck - Provide a bunch of ad-hoc rules to disambiguate in common cases,
641 // such as array references.
642 //
643 AliasAnalysis::AliasResult
644 BasicAliasAnalysis::aliasCheck(const Value *V1, unsigned V1Size,
645                                const Value *V2, unsigned V2Size) {
646   // Strip off any casts if they exist.
647   V1 = V1->stripPointerCasts();
648   V2 = V2->stripPointerCasts();
649
650   // Are we checking for alias of the same value?
651   if (V1 == V2) return MustAlias;
652
653   if (!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType()))
654     return NoAlias;  // Scalars cannot alias each other
655
656   // Figure out what objects these things are pointing to if we can.
657   const Value *O1 = V1->getUnderlyingObject();
658   const Value *O2 = V2->getUnderlyingObject();
659
660   // Null values in the default address space don't point to any object, so they
661   // don't alias any other pointer.
662   if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O1))
663     if (CPN->getType()->getAddressSpace() == 0)
664       return NoAlias;
665   if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O2))
666     if (CPN->getType()->getAddressSpace() == 0)
667       return NoAlias;
668
669   if (O1 != O2) {
670     // If V1/V2 point to two different objects we know that we have no alias.
671     if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
672       return NoAlias;
673
674     // Constant pointers can't alias with non-const isIdentifiedObject objects.
675     if ((isa<Constant>(O1) && isIdentifiedObject(O2) && !isa<Constant>(O2)) ||
676         (isa<Constant>(O2) && isIdentifiedObject(O1) && !isa<Constant>(O1)))
677       return NoAlias;
678
679     // Arguments can't alias with local allocations or noalias calls.
680     if ((isa<Argument>(O1) && (isa<AllocaInst>(O2) || isNoAliasCall(O2))) ||
681         (isa<Argument>(O2) && (isa<AllocaInst>(O1) || isNoAliasCall(O1))))
682       return NoAlias;
683
684     // Most objects can't alias null.
685     if ((isa<ConstantPointerNull>(V2) && isKnownNonNull(O1)) ||
686         (isa<ConstantPointerNull>(V1) && isKnownNonNull(O2)))
687       return NoAlias;
688   }
689   
690   // If the size of one access is larger than the entire object on the other
691   // side, then we know such behavior is undefined and can assume no alias.
692   if (TD)
693     if ((V1Size != ~0U && isObjectSmallerThan(O2, V1Size, *TD)) ||
694         (V2Size != ~0U && isObjectSmallerThan(O1, V2Size, *TD)))
695       return NoAlias;
696   
697   // If one pointer is the result of a call/invoke or load and the other is a
698   // non-escaping local object, then we know the object couldn't escape to a
699   // point where the call could return it. The load case works because
700   // isNonEscapingLocalObject considers all stores to be escapes (it
701   // passes true for the StoreCaptures argument to PointerMayBeCaptured).
702   if (O1 != O2) {
703     if ((isa<CallInst>(O1) || isa<InvokeInst>(O1) || isa<LoadInst>(O1) ||
704          isa<Argument(O1)) &&
705         isNonEscapingLocalObject(O2))
706       return NoAlias;
707     if ((isa<CallInst>(O2) || isa<InvokeInst>(O2) || isa<LoadInst>(O2) ||
708          isa<Argument(O2)) &&
709         isNonEscapingLocalObject(O1))
710       return NoAlias;
711   }
712
713   if (!isa<GEPOperator>(V1) && isa<GEPOperator>(V2)) {
714     std::swap(V1, V2);
715     std::swap(V1Size, V2Size);
716   }
717   if (isa<GEPOperator>(V1))
718     return aliasGEP(V1, V1Size, V2, V2Size);
719
720   if (isa<PHINode>(V2) && !isa<PHINode>(V1)) {
721     std::swap(V1, V2);
722     std::swap(V1Size, V2Size);
723   }
724   if (const PHINode *PN = dyn_cast<PHINode>(V1))
725     return aliasPHI(PN, V1Size, V2, V2Size);
726
727   if (isa<SelectInst>(V2) && !isa<SelectInst>(V1)) {
728     std::swap(V1, V2);
729     std::swap(V1Size, V2Size);
730   }
731   if (const SelectInst *S1 = dyn_cast<SelectInst>(V1))
732     return aliasSelect(S1, V1Size, V2, V2Size);
733
734   return MayAlias;
735 }
736
737 // This function is used to determine if the indices of two GEP instructions are
738 // equal. V1 and V2 are the indices.
739 static bool IndexOperandsEqual(Value *V1, Value *V2) {
740   if (V1->getType() == V2->getType())
741     return V1 == V2;
742   if (Constant *C1 = dyn_cast<Constant>(V1))
743     if (Constant *C2 = dyn_cast<Constant>(V2)) {
744       // Sign extend the constants to long types, if necessary
745       if (C1->getType() != Type::getInt64Ty(C1->getContext()))
746         C1 = ConstantExpr::getSExt(C1, Type::getInt64Ty(C1->getContext()));
747       if (C2->getType() != Type::getInt64Ty(C1->getContext())) 
748         C2 = ConstantExpr::getSExt(C2, Type::getInt64Ty(C1->getContext()));
749       return C1 == C2;
750     }
751   return false;
752 }
753
754 /// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
755 /// base pointers.  This checks to see if the index expressions preclude the
756 /// pointers from aliasing.
757 AliasAnalysis::AliasResult 
758 BasicAliasAnalysis::CheckGEPInstructions(
759   const Type* BasePtr1Ty, Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1S,
760   const Type *BasePtr2Ty, Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2S) {
761   // We currently can't handle the case when the base pointers have different
762   // primitive types.  Since this is uncommon anyway, we are happy being
763   // extremely conservative.
764   if (BasePtr1Ty != BasePtr2Ty)
765     return MayAlias;
766
767   const PointerType *GEPPointerTy = cast<PointerType>(BasePtr1Ty);
768
769   // Find the (possibly empty) initial sequence of equal values... which are not
770   // necessarily constants.
771   unsigned NumGEP1Operands = NumGEP1Ops, NumGEP2Operands = NumGEP2Ops;
772   unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
773   unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
774   unsigned UnequalOper = 0;
775   while (UnequalOper != MinOperands &&
776          IndexOperandsEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper])) {
777     // Advance through the type as we go...
778     ++UnequalOper;
779     if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
780       BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
781     else {
782       // If all operands equal each other, then the derived pointers must
783       // alias each other...
784       BasePtr1Ty = 0;
785       assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
786              "Ran out of type nesting, but not out of operands?");
787       return MustAlias;
788     }
789   }
790
791   // If we have seen all constant operands, and run out of indexes on one of the
792   // getelementptrs, check to see if the tail of the leftover one is all zeros.
793   // If so, return mustalias.
794   if (UnequalOper == MinOperands) {
795     if (NumGEP1Ops < NumGEP2Ops) {
796       std::swap(GEP1Ops, GEP2Ops);
797       std::swap(NumGEP1Ops, NumGEP2Ops);
798     }
799
800     bool AllAreZeros = true;
801     for (unsigned i = UnequalOper; i != MaxOperands; ++i)
802       if (!isa<Constant>(GEP1Ops[i]) ||
803           !cast<Constant>(GEP1Ops[i])->isNullValue()) {
804         AllAreZeros = false;
805         break;
806       }
807     if (AllAreZeros) return MustAlias;
808   }
809
810
811   // So now we know that the indexes derived from the base pointers,
812   // which are known to alias, are different.  We can still determine a
813   // no-alias result if there are differing constant pairs in the index
814   // chain.  For example:
815   //        A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
816   //
817   // We have to be careful here about array accesses.  In particular, consider:
818   //        A[1][0] vs A[0][i]
819   // In this case, we don't *know* that the array will be accessed in bounds:
820   // the index could even be negative.  Because of this, we have to
821   // conservatively *give up* and return may alias.  We disregard differing
822   // array subscripts that are followed by a variable index without going
823   // through a struct.
824   //
825   unsigned SizeMax = std::max(G1S, G2S);
826   if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work.
827
828   // Scan for the first operand that is constant and unequal in the
829   // two getelementptrs...
830   unsigned FirstConstantOper = UnequalOper;
831   for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
832     const Value *G1Oper = GEP1Ops[FirstConstantOper];
833     const Value *G2Oper = GEP2Ops[FirstConstantOper];
834
835     if (G1Oper != G2Oper)   // Found non-equal constant indexes...
836       if (Constant *G1OC = dyn_cast<ConstantInt>(const_cast<Value*>(G1Oper)))
837         if (Constant *G2OC = dyn_cast<ConstantInt>(const_cast<Value*>(G2Oper))){
838           if (G1OC->getType() != G2OC->getType()) {
839             // Sign extend both operands to long.
840             const Type *Int64Ty = Type::getInt64Ty(G1OC->getContext());
841             if (G1OC->getType() != Int64Ty)
842               G1OC = ConstantExpr::getSExt(G1OC, Int64Ty);
843             if (G2OC->getType() != Int64Ty) 
844               G2OC = ConstantExpr::getSExt(G2OC, Int64Ty);
845             GEP1Ops[FirstConstantOper] = G1OC;
846             GEP2Ops[FirstConstantOper] = G2OC;
847           }
848           
849           if (G1OC != G2OC) {
850             // Handle the "be careful" case above: if this is an array/vector
851             // subscript, scan for a subsequent variable array index.
852             if (const SequentialType *STy =
853                   dyn_cast<SequentialType>(BasePtr1Ty)) {
854               const Type *NextTy = STy;
855               bool isBadCase = false;
856               
857               for (unsigned Idx = FirstConstantOper;
858                    Idx != MinOperands && isa<SequentialType>(NextTy); ++Idx) {
859                 const Value *V1 = GEP1Ops[Idx], *V2 = GEP2Ops[Idx];
860                 if (!isa<Constant>(V1) || !isa<Constant>(V2)) {
861                   isBadCase = true;
862                   break;
863                 }
864                 // If the array is indexed beyond the bounds of the static type
865                 // at this level, it will also fall into the "be careful" case.
866                 // It would theoretically be possible to analyze these cases,
867                 // but for now just be conservatively correct.
868                 if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
869                   if (cast<ConstantInt>(G1OC)->getZExtValue() >=
870                         ATy->getNumElements() ||
871                       cast<ConstantInt>(G2OC)->getZExtValue() >=
872                         ATy->getNumElements()) {
873                     isBadCase = true;
874                     break;
875                   }
876                 if (const VectorType *VTy = dyn_cast<VectorType>(STy))
877                   if (cast<ConstantInt>(G1OC)->getZExtValue() >=
878                         VTy->getNumElements() ||
879                       cast<ConstantInt>(G2OC)->getZExtValue() >=
880                         VTy->getNumElements()) {
881                     isBadCase = true;
882                     break;
883                   }
884                 STy = cast<SequentialType>(NextTy);
885                 NextTy = cast<SequentialType>(NextTy)->getElementType();
886               }
887               
888               if (isBadCase) G1OC = 0;
889             }
890
891             // Make sure they are comparable (ie, not constant expressions), and
892             // make sure the GEP with the smaller leading constant is GEP1.
893             if (G1OC) {
894               Constant *Compare = ConstantExpr::getICmp(ICmpInst::ICMP_SGT, 
895                                                         G1OC, G2OC);
896               if (ConstantInt *CV = dyn_cast<ConstantInt>(Compare)) {
897                 if (CV->getZExtValue()) {  // If they are comparable and G2 > G1
898                   std::swap(GEP1Ops, GEP2Ops);  // Make GEP1 < GEP2
899                   std::swap(NumGEP1Ops, NumGEP2Ops);
900                 }
901                 break;
902               }
903             }
904           }
905         }
906     BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
907   }
908
909   // No shared constant operands, and we ran out of common operands.  At this
910   // point, the GEP instructions have run through all of their operands, and we
911   // haven't found evidence that there are any deltas between the GEP's.
912   // However, one GEP may have more operands than the other.  If this is the
913   // case, there may still be hope.  Check this now.
914   if (FirstConstantOper == MinOperands) {
915     // Without TargetData, we won't know what the offsets are.
916     if (!TD)
917       return MayAlias;
918
919     // Make GEP1Ops be the longer one if there is a longer one.
920     if (NumGEP1Ops < NumGEP2Ops) {
921       std::swap(GEP1Ops, GEP2Ops);
922       std::swap(NumGEP1Ops, NumGEP2Ops);
923     }
924
925     // Is there anything to check?
926     if (NumGEP1Ops > MinOperands) {
927       for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
928         if (isa<ConstantInt>(GEP1Ops[i]) && 
929             !cast<ConstantInt>(GEP1Ops[i])->isZero()) {
930           // Yup, there's a constant in the tail.  Set all variables to
931           // constants in the GEP instruction to make it suitable for
932           // TargetData::getIndexedOffset.
933           for (i = 0; i != MaxOperands; ++i)
934             if (!isa<ConstantInt>(GEP1Ops[i]))
935               GEP1Ops[i] = Constant::getNullValue(GEP1Ops[i]->getType());
936           // Okay, now get the offset.  This is the relative offset for the full
937           // instruction.
938           int64_t Offset1 = TD->getIndexedOffset(GEPPointerTy, GEP1Ops,
939                                                  NumGEP1Ops);
940
941           // Now check without any constants at the end.
942           int64_t Offset2 = TD->getIndexedOffset(GEPPointerTy, GEP1Ops,
943                                                  MinOperands);
944
945           // Make sure we compare the absolute difference.
946           if (Offset1 > Offset2)
947             std::swap(Offset1, Offset2);
948
949           // If the tail provided a bit enough offset, return noalias!
950           if ((uint64_t)(Offset2-Offset1) >= SizeMax)
951             return NoAlias;
952           // Otherwise break - we don't look for another constant in the tail.
953           break;
954         }
955     }
956
957     // Couldn't find anything useful.
958     return MayAlias;
959   }
960
961   // If there are non-equal constants arguments, then we can figure
962   // out a minimum known delta between the two index expressions... at
963   // this point we know that the first constant index of GEP1 is less
964   // than the first constant index of GEP2.
965
966   // Advance BasePtr[12]Ty over this first differing constant operand.
967   BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->
968       getTypeAtIndex(GEP2Ops[FirstConstantOper]);
969   BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->
970       getTypeAtIndex(GEP1Ops[FirstConstantOper]);
971
972   // We are going to be using TargetData::getIndexedOffset to determine the
973   // offset that each of the GEP's is reaching.  To do this, we have to convert
974   // all variable references to constant references.  To do this, we convert the
975   // initial sequence of array subscripts into constant zeros to start with.
976   const Type *ZeroIdxTy = GEPPointerTy;
977   for (unsigned i = 0; i != FirstConstantOper; ++i) {
978     if (!isa<StructType>(ZeroIdxTy))
979       GEP1Ops[i] = GEP2Ops[i] = 
980               Constant::getNullValue(Type::getInt32Ty(ZeroIdxTy->getContext()));
981
982     if (const CompositeType *CT = dyn_cast<CompositeType>(ZeroIdxTy))
983       ZeroIdxTy = CT->getTypeAtIndex(GEP1Ops[i]);
984   }
985
986   // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
987
988   // Loop over the rest of the operands...
989   for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
990     const Value *Op1 = i < NumGEP1Ops ? GEP1Ops[i] : 0;
991     const Value *Op2 = i < NumGEP2Ops ? GEP2Ops[i] : 0;
992     // If they are equal, use a zero index...
993     if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
994       if (!isa<ConstantInt>(Op1))
995         GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Op1->getType());
996       // Otherwise, just keep the constants we have.
997     } else {
998       if (Op1) {
999         if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
1000           // If this is an array index, make sure the array element is in range.
1001           if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty)) {
1002             if (Op1C->getZExtValue() >= AT->getNumElements())
1003               return MayAlias;  // Be conservative with out-of-range accesses
1004           } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty)) {
1005             if (Op1C->getZExtValue() >= VT->getNumElements())
1006               return MayAlias;  // Be conservative with out-of-range accesses
1007           }
1008           
1009         } else {
1010           // GEP1 is known to produce a value less than GEP2.  To be
1011           // conservatively correct, we must assume the largest possible
1012           // constant is used in this position.  This cannot be the initial
1013           // index to the GEP instructions (because we know we have at least one
1014           // element before this one with the different constant arguments), so
1015           // we know that the current index must be into either a struct or
1016           // array.  Because we know it's not constant, this cannot be a
1017           // structure index.  Because of this, we can calculate the maximum
1018           // value possible.
1019           //
1020           if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
1021             GEP1Ops[i] =
1022                   ConstantInt::get(Type::getInt64Ty(AT->getContext()), 
1023                                    AT->getNumElements()-1);
1024           else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty))
1025             GEP1Ops[i] = 
1026                   ConstantInt::get(Type::getInt64Ty(VT->getContext()),
1027                                    VT->getNumElements()-1);
1028         }
1029       }
1030
1031       if (Op2) {
1032         if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
1033           // If this is an array index, make sure the array element is in range.
1034           if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr2Ty)) {
1035             if (Op2C->getZExtValue() >= AT->getNumElements())
1036               return MayAlias;  // Be conservative with out-of-range accesses
1037           } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr2Ty)) {
1038             if (Op2C->getZExtValue() >= VT->getNumElements())
1039               return MayAlias;  // Be conservative with out-of-range accesses
1040           }
1041         } else {  // Conservatively assume the minimum value for this index
1042           GEP2Ops[i] = Constant::getNullValue(Op2->getType());
1043         }
1044       }
1045     }
1046
1047     if (BasePtr1Ty && Op1) {
1048       if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
1049         BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
1050       else
1051         BasePtr1Ty = 0;
1052     }
1053
1054     if (BasePtr2Ty && Op2) {
1055       if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
1056         BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
1057       else
1058         BasePtr2Ty = 0;
1059     }
1060   }
1061
1062   if (TD && GEPPointerTy->getElementType()->isSized()) {
1063     int64_t Offset1 =
1064       TD->getIndexedOffset(GEPPointerTy, GEP1Ops, NumGEP1Ops);
1065     int64_t Offset2 = 
1066       TD->getIndexedOffset(GEPPointerTy, GEP2Ops, NumGEP2Ops);
1067     assert(Offset1 != Offset2 &&
1068            "There is at least one different constant here!");
1069     
1070     // Make sure we compare the absolute difference.
1071     if (Offset1 > Offset2)
1072       std::swap(Offset1, Offset2);
1073     
1074     if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
1075       //cerr << "Determined that these two GEP's don't alias ["
1076       //     << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
1077       return NoAlias;
1078     }
1079   }
1080   return MayAlias;
1081 }
1082
1083 // Make sure that anything that uses AliasAnalysis pulls in this file.
1084 DEFINING_FILE_FOR(BasicAliasAnalysis)