Extend the getDependence query with support for PHI translation.
[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/Passes.h"
18 #include "llvm/Constants.h"
19 #include "llvm/DerivedTypes.h"
20 #include "llvm/Function.h"
21 #include "llvm/GlobalAlias.h"
22 #include "llvm/GlobalVariable.h"
23 #include "llvm/Instructions.h"
24 #include "llvm/IntrinsicInst.h"
25 #include "llvm/Operator.h"
26 #include "llvm/Pass.h"
27 #include "llvm/Analysis/CaptureTracking.h"
28 #include "llvm/Analysis/MemoryBuiltins.h"
29 #include "llvm/Analysis/ValueTracking.h"
30 #include "llvm/Target/TargetData.h"
31 #include "llvm/ADT/SmallPtrSet.h"
32 #include "llvm/ADT/SmallVector.h"
33 #include "llvm/Support/ErrorHandling.h"
34 #include "llvm/Support/GetElementPtrTypeIterator.h"
35 #include <algorithm>
36 using namespace llvm;
37
38 //===----------------------------------------------------------------------===//
39 // Useful predicates
40 //===----------------------------------------------------------------------===//
41
42 /// isKnownNonNull - Return true if we know that the specified value is never
43 /// null.
44 static bool isKnownNonNull(const Value *V) {
45   // Alloca never returns null, malloc might.
46   if (isa<AllocaInst>(V)) return true;
47   
48   // A byval argument is never null.
49   if (const Argument *A = dyn_cast<Argument>(V))
50     return A->hasByValAttr();
51
52   // Global values are not null unless extern weak.
53   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
54     return !GV->hasExternalWeakLinkage();
55   return false;
56 }
57
58 /// isNonEscapingLocalObject - Return true if the pointer is to a function-local
59 /// object that never escapes from the function.
60 static bool isNonEscapingLocalObject(const Value *V) {
61   // If this is a local allocation, check to see if it escapes.
62   if (isa<AllocaInst>(V) || isNoAliasCall(V))
63     // Set StoreCaptures to True so that we can assume in our callers that the
64     // pointer is not the result of a load instruction. Currently
65     // PointerMayBeCaptured doesn't have any special analysis for the
66     // StoreCaptures=false case; if it did, our callers could be refined to be
67     // more precise.
68     return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
69
70   // If this is an argument that corresponds to a byval or noalias argument,
71   // then it has not escaped before entering the function.  Check if it escapes
72   // inside the function.
73   if (const Argument *A = dyn_cast<Argument>(V))
74     if (A->hasByValAttr() || A->hasNoAliasAttr()) {
75       // Don't bother analyzing arguments already known not to escape.
76       if (A->hasNoCaptureAttr())
77         return true;
78       return !PointerMayBeCaptured(V, false, /*StoreCaptures=*/true);
79     }
80   return false;
81 }
82
83 /// isEscapeSource - Return true if the pointer is one which would have
84 /// been considered an escape by isNonEscapingLocalObject.
85 static bool isEscapeSource(const Value *V) {
86   if (isa<CallInst>(V) || isa<InvokeInst>(V) || isa<Argument>(V))
87     return true;
88
89   // The load case works because isNonEscapingLocalObject considers all
90   // stores to be escapes (it passes true for the StoreCaptures argument
91   // to PointerMayBeCaptured).
92   if (isa<LoadInst>(V))
93     return true;
94
95   return false;
96 }
97
98 /// isObjectSmallerThan - Return true if we can prove that the object specified
99 /// by V is smaller than Size.
100 static bool isObjectSmallerThan(const Value *V, unsigned Size,
101                                 const TargetData &TD) {
102   const Type *AccessTy;
103   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
104     AccessTy = GV->getType()->getElementType();
105   } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(V)) {
106     if (!AI->isArrayAllocation())
107       AccessTy = AI->getType()->getElementType();
108     else
109       return false;
110   } else if (const CallInst* CI = extractMallocCall(V)) {
111     if (!isArrayMalloc(V, &TD))
112       // The size is the argument to the malloc call.
113       if (const ConstantInt* C = dyn_cast<ConstantInt>(CI->getArgOperand(0)))
114         return (C->getZExtValue() < Size);
115     return false;
116   } else if (const Argument *A = dyn_cast<Argument>(V)) {
117     if (A->hasByValAttr())
118       AccessTy = cast<PointerType>(A->getType())->getElementType();
119     else
120       return false;
121   } else {
122     return false;
123   }
124   
125   if (AccessTy->isSized())
126     return TD.getTypeAllocSize(AccessTy) < Size;
127   return false;
128 }
129
130 //===----------------------------------------------------------------------===//
131 // NoAA Pass
132 //===----------------------------------------------------------------------===//
133
134 namespace {
135   /// NoAA - This class implements the -no-aa pass, which always returns "I
136   /// don't know" for alias queries.  NoAA is unlike other alias analysis
137   /// implementations, in that it does not chain to a previous analysis.  As
138   /// such it doesn't follow many of the rules that other alias analyses must.
139   ///
140   struct NoAA : public ImmutablePass, public AliasAnalysis {
141     static char ID; // Class identification, replacement for typeinfo
142     NoAA() : ImmutablePass(ID) {}
143     explicit NoAA(char &PID) : ImmutablePass(PID) { }
144
145     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
146     }
147
148     virtual void initializePass() {
149       TD = getAnalysisIfAvailable<TargetData>();
150     }
151
152     virtual AliasResult alias(const Value *V1, unsigned V1Size,
153                               const Value *V2, unsigned V2Size) {
154       return MayAlias;
155     }
156
157     virtual ModRefBehavior getModRefBehavior(ImmutableCallSite CS) {
158       return UnknownModRefBehavior;
159     }
160     virtual ModRefBehavior getModRefBehavior(const Function *F) {
161       return UnknownModRefBehavior;
162     }
163
164     virtual bool pointsToConstantMemory(const Value *P) { return false; }
165     virtual ModRefResult getModRefInfo(ImmutableCallSite CS,
166                                        const Value *P, unsigned Size) {
167       return ModRef;
168     }
169     virtual ModRefResult getModRefInfo(ImmutableCallSite CS1,
170                                        ImmutableCallSite CS2) {
171       return ModRef;
172     }
173
174     virtual DependenceResult getDependence(const Instruction *First,
175                                            const Value *FirstPHITranslatedAddr,
176                                            DependenceQueryFlags FirstFlags,
177                                            const Instruction *Second,
178                                            const Value *SecondPHITranslatedAddr,
179                                            DependenceQueryFlags SecondFlags) {
180       return Unknown;
181     }
182
183     virtual void deleteValue(Value *V) {}
184     virtual void copyValue(Value *From, Value *To) {}
185     
186     /// getAdjustedAnalysisPointer - This method is used when a pass implements
187     /// an analysis interface through multiple inheritance.  If needed, it
188     /// should override this to adjust the this pointer as needed for the
189     /// specified pass info.
190     virtual void *getAdjustedAnalysisPointer(const void *ID) {
191       if (ID == &AliasAnalysis::ID)
192         return (AliasAnalysis*)this;
193       return this;
194     }
195   };
196 }  // End of anonymous namespace
197
198 // Register this pass...
199 char NoAA::ID = 0;
200 INITIALIZE_AG_PASS(NoAA, AliasAnalysis, "no-aa",
201                    "No Alias Analysis (always returns 'may' alias)",
202                    true, true, false);
203
204 ImmutablePass *llvm::createNoAAPass() { return new NoAA(); }
205
206 //===----------------------------------------------------------------------===//
207 // GetElementPtr Instruction Decomposition and Analysis
208 //===----------------------------------------------------------------------===//
209
210 namespace {
211   enum ExtensionKind {
212     EK_NotExtended,
213     EK_SignExt,
214     EK_ZeroExt
215   };
216   
217   struct VariableGEPIndex {
218     const Value *V;
219     ExtensionKind Extension;
220     int64_t Scale;
221   };
222 }
223
224
225 /// GetLinearExpression - Analyze the specified value as a linear expression:
226 /// "A*V + B", where A and B are constant integers.  Return the scale and offset
227 /// values as APInts and return V as a Value*, and return whether we looked
228 /// through any sign or zero extends.  The incoming Value is known to have
229 /// IntegerType and it may already be sign or zero extended.
230 ///
231 /// Note that this looks through extends, so the high bits may not be
232 /// represented in the result.
233 static Value *GetLinearExpression(Value *V, APInt &Scale, APInt &Offset,
234                                   ExtensionKind &Extension,
235                                   const TargetData &TD, unsigned Depth) {
236   assert(V->getType()->isIntegerTy() && "Not an integer value");
237
238   // Limit our recursion depth.
239   if (Depth == 6) {
240     Scale = 1;
241     Offset = 0;
242     return V;
243   }
244   
245   if (BinaryOperator *BOp = dyn_cast<BinaryOperator>(V)) {
246     if (ConstantInt *RHSC = dyn_cast<ConstantInt>(BOp->getOperand(1))) {
247       switch (BOp->getOpcode()) {
248       default: break;
249       case Instruction::Or:
250         // X|C == X+C if all the bits in C are unset in X.  Otherwise we can't
251         // analyze it.
252         if (!MaskedValueIsZero(BOp->getOperand(0), RHSC->getValue(), &TD))
253           break;
254         // FALL THROUGH.
255       case Instruction::Add:
256         V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, Extension,
257                                 TD, Depth+1);
258         Offset += RHSC->getValue();
259         return V;
260       case Instruction::Mul:
261         V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, Extension,
262                                 TD, Depth+1);
263         Offset *= RHSC->getValue();
264         Scale *= RHSC->getValue();
265         return V;
266       case Instruction::Shl:
267         V = GetLinearExpression(BOp->getOperand(0), Scale, Offset, Extension,
268                                 TD, Depth+1);
269         Offset <<= RHSC->getValue().getLimitedValue();
270         Scale <<= RHSC->getValue().getLimitedValue();
271         return V;
272       }
273     }
274   }
275   
276   // Since GEP indices are sign extended anyway, we don't care about the high
277   // bits of a sign or zero extended value - just scales and offsets.  The
278   // extensions have to be consistent though.
279   if ((isa<SExtInst>(V) && Extension != EK_ZeroExt) ||
280       (isa<ZExtInst>(V) && Extension != EK_SignExt)) {
281     Value *CastOp = cast<CastInst>(V)->getOperand(0);
282     unsigned OldWidth = Scale.getBitWidth();
283     unsigned SmallWidth = CastOp->getType()->getPrimitiveSizeInBits();
284     Scale.trunc(SmallWidth);
285     Offset.trunc(SmallWidth);
286     Extension = isa<SExtInst>(V) ? EK_SignExt : EK_ZeroExt;
287
288     Value *Result = GetLinearExpression(CastOp, Scale, Offset, Extension,
289                                         TD, Depth+1);
290     Scale.zext(OldWidth);
291     Offset.zext(OldWidth);
292     
293     return Result;
294   }
295   
296   Scale = 1;
297   Offset = 0;
298   return V;
299 }
300
301 /// DecomposeGEPExpression - If V is a symbolic pointer expression, decompose it
302 /// into a base pointer with a constant offset and a number of scaled symbolic
303 /// offsets.
304 ///
305 /// The scaled symbolic offsets (represented by pairs of a Value* and a scale in
306 /// the VarIndices vector) are Value*'s that are known to be scaled by the
307 /// specified amount, but which may have other unrepresented high bits. As such,
308 /// the gep cannot necessarily be reconstructed from its decomposed form.
309 ///
310 /// When TargetData is around, this function is capable of analyzing everything
311 /// that Value::getUnderlyingObject() can look through.  When not, it just looks
312 /// through pointer casts.
313 ///
314 static const Value *
315 DecomposeGEPExpression(const Value *V, int64_t &BaseOffs,
316                        SmallVectorImpl<VariableGEPIndex> &VarIndices,
317                        const TargetData *TD) {
318   // Limit recursion depth to limit compile time in crazy cases.
319   unsigned MaxLookup = 6;
320   
321   BaseOffs = 0;
322   do {
323     // See if this is a bitcast or GEP.
324     const Operator *Op = dyn_cast<Operator>(V);
325     if (Op == 0) {
326       // The only non-operator case we can handle are GlobalAliases.
327       if (const GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) {
328         if (!GA->mayBeOverridden()) {
329           V = GA->getAliasee();
330           continue;
331         }
332       }
333       return V;
334     }
335     
336     if (Op->getOpcode() == Instruction::BitCast) {
337       V = Op->getOperand(0);
338       continue;
339     }
340     
341     const GEPOperator *GEPOp = dyn_cast<GEPOperator>(Op);
342     if (GEPOp == 0)
343       return V;
344     
345     // Don't attempt to analyze GEPs over unsized objects.
346     if (!cast<PointerType>(GEPOp->getOperand(0)->getType())
347         ->getElementType()->isSized())
348       return V;
349     
350     // If we are lacking TargetData information, we can't compute the offets of
351     // elements computed by GEPs.  However, we can handle bitcast equivalent
352     // GEPs.
353     if (TD == 0) {
354       if (!GEPOp->hasAllZeroIndices())
355         return V;
356       V = GEPOp->getOperand(0);
357       continue;
358     }
359     
360     // Walk the indices of the GEP, accumulating them into BaseOff/VarIndices.
361     gep_type_iterator GTI = gep_type_begin(GEPOp);
362     for (User::const_op_iterator I = GEPOp->op_begin()+1,
363          E = GEPOp->op_end(); I != E; ++I) {
364       Value *Index = *I;
365       // Compute the (potentially symbolic) offset in bytes for this index.
366       if (const StructType *STy = dyn_cast<StructType>(*GTI++)) {
367         // For a struct, add the member offset.
368         unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
369         if (FieldNo == 0) continue;
370         
371         BaseOffs += TD->getStructLayout(STy)->getElementOffset(FieldNo);
372         continue;
373       }
374       
375       // For an array/pointer, add the element offset, explicitly scaled.
376       if (ConstantInt *CIdx = dyn_cast<ConstantInt>(Index)) {
377         if (CIdx->isZero()) continue;
378         BaseOffs += TD->getTypeAllocSize(*GTI)*CIdx->getSExtValue();
379         continue;
380       }
381       
382       uint64_t Scale = TD->getTypeAllocSize(*GTI);
383       ExtensionKind Extension = EK_NotExtended;
384       
385       // If the integer type is smaller than the pointer size, it is implicitly
386       // sign extended to pointer size.
387       unsigned Width = cast<IntegerType>(Index->getType())->getBitWidth();
388       if (TD->getPointerSizeInBits() > Width)
389         Extension = EK_SignExt;
390       
391       // Use GetLinearExpression to decompose the index into a C1*V+C2 form.
392       APInt IndexScale(Width, 0), IndexOffset(Width, 0);
393       Index = GetLinearExpression(Index, IndexScale, IndexOffset, Extension,
394                                   *TD, 0);
395       
396       // The GEP index scale ("Scale") scales C1*V+C2, yielding (C1*V+C2)*Scale.
397       // This gives us an aggregate computation of (C1*Scale)*V + C2*Scale.
398       BaseOffs += IndexOffset.getZExtValue()*Scale;
399       Scale *= IndexScale.getZExtValue();
400       
401       
402       // If we already had an occurrance of this index variable, merge this
403       // scale into it.  For example, we want to handle:
404       //   A[x][x] -> x*16 + x*4 -> x*20
405       // This also ensures that 'x' only appears in the index list once.
406       for (unsigned i = 0, e = VarIndices.size(); i != e; ++i) {
407         if (VarIndices[i].V == Index &&
408             VarIndices[i].Extension == Extension) {
409           Scale += VarIndices[i].Scale;
410           VarIndices.erase(VarIndices.begin()+i);
411           break;
412         }
413       }
414       
415       // Make sure that we have a scale that makes sense for this target's
416       // pointer size.
417       if (unsigned ShiftBits = 64-TD->getPointerSizeInBits()) {
418         Scale <<= ShiftBits;
419         Scale >>= ShiftBits;
420       }
421       
422       if (Scale) {
423         VariableGEPIndex Entry = {Index, Extension, Scale};
424         VarIndices.push_back(Entry);
425       }
426     }
427     
428     // Analyze the base pointer next.
429     V = GEPOp->getOperand(0);
430   } while (--MaxLookup);
431   
432   // If the chain of expressions is too deep, just return early.
433   return V;
434 }
435
436 /// GetIndexDifference - Dest and Src are the variable indices from two
437 /// decomposed GetElementPtr instructions GEP1 and GEP2 which have common base
438 /// pointers.  Subtract the GEP2 indices from GEP1 to find the symbolic
439 /// difference between the two pointers. 
440 static void GetIndexDifference(SmallVectorImpl<VariableGEPIndex> &Dest,
441                                const SmallVectorImpl<VariableGEPIndex> &Src) {
442   if (Src.empty()) return;
443
444   for (unsigned i = 0, e = Src.size(); i != e; ++i) {
445     const Value *V = Src[i].V;
446     ExtensionKind Extension = Src[i].Extension;
447     int64_t Scale = Src[i].Scale;
448     
449     // Find V in Dest.  This is N^2, but pointer indices almost never have more
450     // than a few variable indexes.
451     for (unsigned j = 0, e = Dest.size(); j != e; ++j) {
452       if (Dest[j].V != V || Dest[j].Extension != Extension) continue;
453       
454       // If we found it, subtract off Scale V's from the entry in Dest.  If it
455       // goes to zero, remove the entry.
456       if (Dest[j].Scale != Scale)
457         Dest[j].Scale -= Scale;
458       else
459         Dest.erase(Dest.begin()+j);
460       Scale = 0;
461       break;
462     }
463     
464     // If we didn't consume this entry, add it to the end of the Dest list.
465     if (Scale) {
466       VariableGEPIndex Entry = { V, Extension, -Scale };
467       Dest.push_back(Entry);
468     }
469   }
470 }
471
472 //===----------------------------------------------------------------------===//
473 // BasicAliasAnalysis Pass
474 //===----------------------------------------------------------------------===//
475
476 #ifndef NDEBUG
477 static const Function *getParent(const Value *V) {
478   if (const Instruction *inst = dyn_cast<Instruction>(V))
479     return inst->getParent()->getParent();
480
481   if (const Argument *arg = dyn_cast<Argument>(V))
482     return arg->getParent();
483
484   return NULL;
485 }
486
487 static bool notDifferentParent(const Value *O1, const Value *O2) {
488
489   const Function *F1 = getParent(O1);
490   const Function *F2 = getParent(O2);
491
492   return !F1 || !F2 || F1 == F2;
493 }
494 #endif
495
496 namespace {
497   /// BasicAliasAnalysis - This is the default alias analysis implementation.
498   /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
499   /// derives from the NoAA class.
500   struct BasicAliasAnalysis : public NoAA {
501     static char ID; // Class identification, replacement for typeinfo
502     BasicAliasAnalysis() : NoAA(ID) {}
503
504     virtual AliasResult alias(const Value *V1, unsigned V1Size,
505                               const Value *V2, unsigned V2Size) {
506       assert(Visited.empty() && "Visited must be cleared after use!");
507       assert(notDifferentParent(V1, V2) &&
508              "BasicAliasAnalysis doesn't support interprocedural queries.");
509       AliasResult Alias = aliasCheck(V1, V1Size, V2, V2Size);
510       Visited.clear();
511       return Alias;
512     }
513
514     virtual ModRefResult getModRefInfo(ImmutableCallSite CS,
515                                        const Value *P, unsigned Size);
516
517     virtual ModRefResult getModRefInfo(ImmutableCallSite CS1,
518                                        ImmutableCallSite CS2) {
519       // The AliasAnalysis base class has some smarts, lets use them.
520       return AliasAnalysis::getModRefInfo(CS1, CS2);
521     }
522
523     /// pointsToConstantMemory - Chase pointers until we find a (constant
524     /// global) or not.
525     virtual bool pointsToConstantMemory(const Value *P);
526
527     /// getModRefBehavior - Return the behavior when calling the given
528     /// call site.
529     virtual ModRefBehavior getModRefBehavior(ImmutableCallSite CS);
530
531     /// getModRefBehavior - Return the behavior when calling the given function.
532     /// For use when the call site is not known.
533     virtual ModRefBehavior getModRefBehavior(const Function *F);
534
535     virtual DependenceResult getDependence(const Instruction *First,
536                                            const Value *FirstPHITranslatedAddr,
537                                            DependenceQueryFlags FirstFlags,
538                                            const Instruction *Second,
539                                            const Value *SecondPHITranslatedAddr,
540                                            DependenceQueryFlags SecondFlags);
541
542     /// getAdjustedAnalysisPointer - This method is used when a pass implements
543     /// an analysis interface through multiple inheritance.  If needed, it
544     /// should override this to adjust the this pointer as needed for the
545     /// specified pass info.
546     virtual void *getAdjustedAnalysisPointer(const void *ID) {
547       if (ID == &AliasAnalysis::ID)
548         return (AliasAnalysis*)this;
549       return this;
550     }
551     
552   private:
553     // Visited - Track instructions visited by a aliasPHI, aliasSelect(), and aliasGEP().
554     SmallPtrSet<const Value*, 16> Visited;
555
556     // aliasGEP - Provide a bunch of ad-hoc rules to disambiguate a GEP
557     // instruction against another.
558     AliasResult aliasGEP(const GEPOperator *V1, unsigned V1Size,
559                          const Value *V2, unsigned V2Size,
560                          const Value *UnderlyingV1, const Value *UnderlyingV2);
561
562     // aliasPHI - Provide a bunch of ad-hoc rules to disambiguate a PHI
563     // instruction against another.
564     AliasResult aliasPHI(const PHINode *PN, unsigned PNSize,
565                          const Value *V2, unsigned V2Size);
566
567     /// aliasSelect - Disambiguate a Select instruction against another value.
568     AliasResult aliasSelect(const SelectInst *SI, unsigned SISize,
569                             const Value *V2, unsigned V2Size);
570
571     AliasResult aliasCheck(const Value *V1, unsigned V1Size,
572                            const Value *V2, unsigned V2Size);
573   };
574 }  // End of anonymous namespace
575
576 // Register this pass...
577 char BasicAliasAnalysis::ID = 0;
578 INITIALIZE_AG_PASS(BasicAliasAnalysis, AliasAnalysis, "basicaa",
579                    "Basic Alias Analysis (default AA impl)",
580                    false, true, true);
581
582 ImmutablePass *llvm::createBasicAliasAnalysisPass() {
583   return new BasicAliasAnalysis();
584 }
585
586
587 /// pointsToConstantMemory - Chase pointers until we find a (constant
588 /// global) or not.
589 bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
590   if (const GlobalVariable *GV = 
591         dyn_cast<GlobalVariable>(P->getUnderlyingObject()))
592     // Note: this doesn't require GV to be "ODR" because it isn't legal for a
593     // global to be marked constant in some modules and non-constant in others.
594     // GV may even be a declaration, not a definition.
595     return GV->isConstant();
596
597   return NoAA::pointsToConstantMemory(P);
598 }
599
600 /// getModRefBehavior - Return the behavior when calling the given call site.
601 AliasAnalysis::ModRefBehavior
602 BasicAliasAnalysis::getModRefBehavior(ImmutableCallSite CS) {
603   if (CS.doesNotAccessMemory())
604     // Can't do better than this.
605     return DoesNotAccessMemory;
606
607   ModRefBehavior Min = UnknownModRefBehavior;
608
609   // If the callsite knows it only reads memory, don't return worse
610   // than that.
611   if (CS.onlyReadsMemory())
612     Min = OnlyReadsMemory;
613
614   // The AliasAnalysis base class has some smarts, lets use them.
615   return std::min(AliasAnalysis::getModRefBehavior(CS), Min);
616 }
617
618 /// getModRefBehavior - Return the behavior when calling the given function.
619 /// For use when the call site is not known.
620 AliasAnalysis::ModRefBehavior
621 BasicAliasAnalysis::getModRefBehavior(const Function *F) {
622   if (F->doesNotAccessMemory())
623     // Can't do better than this.
624     return DoesNotAccessMemory;
625   if (F->onlyReadsMemory())
626     return OnlyReadsMemory;
627   if (unsigned id = F->getIntrinsicID())
628     return getIntrinsicModRefBehavior(id);
629
630   return NoAA::getModRefBehavior(F);
631 }
632
633 /// getModRefInfo - Check to see if the specified callsite can clobber the
634 /// specified memory object.  Since we only look at local properties of this
635 /// function, we really can't say much about this query.  We do, however, use
636 /// simple "address taken" analysis on local objects.
637 AliasAnalysis::ModRefResult
638 BasicAliasAnalysis::getModRefInfo(ImmutableCallSite CS,
639                                   const Value *P, unsigned Size) {
640   assert(notDifferentParent(CS.getInstruction(), P) &&
641          "AliasAnalysis query involving multiple functions!");
642
643   const Value *Object = P->getUnderlyingObject();
644   
645   // If this is a tail call and P points to a stack location, we know that
646   // the tail call cannot access or modify the local stack.
647   // We cannot exclude byval arguments here; these belong to the caller of
648   // the current function not to the current function, and a tail callee
649   // may reference them.
650   if (isa<AllocaInst>(Object))
651     if (const CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
652       if (CI->isTailCall())
653         return NoModRef;
654   
655   // If the pointer is to a locally allocated object that does not escape,
656   // then the call can not mod/ref the pointer unless the call takes the pointer
657   // as an argument, and itself doesn't capture it.
658   if (!isa<Constant>(Object) && CS.getInstruction() != Object &&
659       isNonEscapingLocalObject(Object)) {
660     bool PassedAsArg = false;
661     unsigned ArgNo = 0;
662     for (ImmutableCallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
663          CI != CE; ++CI, ++ArgNo) {
664       // Only look at the no-capture pointer arguments.
665       if (!(*CI)->getType()->isPointerTy() ||
666           !CS.paramHasAttr(ArgNo+1, Attribute::NoCapture))
667         continue;
668       
669       // If  this is a no-capture pointer argument, see if we can tell that it
670       // is impossible to alias the pointer we're checking.  If not, we have to
671       // assume that the call could touch the pointer, even though it doesn't
672       // escape.
673       if (!isNoAlias(cast<Value>(CI), UnknownSize, P, UnknownSize)) {
674         PassedAsArg = true;
675         break;
676       }
677     }
678     
679     if (!PassedAsArg)
680       return NoModRef;
681   }
682
683   // Finally, handle specific knowledge of intrinsics.
684   const IntrinsicInst *II = dyn_cast<IntrinsicInst>(CS.getInstruction());
685   if (II != 0)
686     switch (II->getIntrinsicID()) {
687     default: break;
688     case Intrinsic::memcpy:
689     case Intrinsic::memmove: {
690       unsigned Len = UnknownSize;
691       if (ConstantInt *LenCI = dyn_cast<ConstantInt>(II->getArgOperand(2)))
692         Len = LenCI->getZExtValue();
693       Value *Dest = II->getArgOperand(0);
694       Value *Src = II->getArgOperand(1);
695       if (isNoAlias(Dest, Len, P, Size)) {
696         if (isNoAlias(Src, Len, P, Size))
697           return NoModRef;
698         return Ref;
699       }
700       break;
701     }
702     case Intrinsic::memset:
703       // Since memset is 'accesses arguments' only, the AliasAnalysis base class
704       // will handle it for the variable length case.
705       if (ConstantInt *LenCI = dyn_cast<ConstantInt>(II->getArgOperand(2))) {
706         unsigned Len = LenCI->getZExtValue();
707         Value *Dest = II->getArgOperand(0);
708         if (isNoAlias(Dest, Len, P, Size))
709           return NoModRef;
710       }
711       break;
712     case Intrinsic::atomic_cmp_swap:
713     case Intrinsic::atomic_swap:
714     case Intrinsic::atomic_load_add:
715     case Intrinsic::atomic_load_sub:
716     case Intrinsic::atomic_load_and:
717     case Intrinsic::atomic_load_nand:
718     case Intrinsic::atomic_load_or:
719     case Intrinsic::atomic_load_xor:
720     case Intrinsic::atomic_load_max:
721     case Intrinsic::atomic_load_min:
722     case Intrinsic::atomic_load_umax:
723     case Intrinsic::atomic_load_umin:
724       if (TD) {
725         Value *Op1 = II->getArgOperand(0);
726         unsigned Op1Size = TD->getTypeStoreSize(Op1->getType());
727         if (isNoAlias(Op1, Op1Size, P, Size))
728           return NoModRef;
729       }
730       break;
731     case Intrinsic::lifetime_start:
732     case Intrinsic::lifetime_end:
733     case Intrinsic::invariant_start: {
734       unsigned PtrSize =
735         cast<ConstantInt>(II->getArgOperand(0))->getZExtValue();
736       if (isNoAlias(II->getArgOperand(1), PtrSize, P, Size))
737         return NoModRef;
738       break;
739     }
740     case Intrinsic::invariant_end: {
741       unsigned PtrSize =
742         cast<ConstantInt>(II->getArgOperand(1))->getZExtValue();
743       if (isNoAlias(II->getArgOperand(2), PtrSize, P, Size))
744         return NoModRef;
745       break;
746     }
747     }
748
749   // The AliasAnalysis base class has some smarts, lets use them.
750   return AliasAnalysis::getModRefInfo(CS, P, Size);
751 }
752
753 AliasAnalysis::DependenceResult
754 BasicAliasAnalysis::getDependence(const Instruction *First,
755                                   const Value *FirstPHITranslatedAddr,
756                                   DependenceQueryFlags FirstFlags,
757                                   const Instruction *Second,
758                                   const Value *SecondPHITranslatedAddr,
759                                   DependenceQueryFlags SecondFlags) {
760   // We don't have anything special to say yet.
761   return getDependenceViaModRefInfo(First, FirstPHITranslatedAddr, FirstFlags,
762                                     Second, SecondPHITranslatedAddr, SecondFlags);
763 }
764
765 /// aliasGEP - Provide a bunch of ad-hoc rules to disambiguate a GEP instruction
766 /// against another pointer.  We know that V1 is a GEP, but we don't know
767 /// anything about V2.  UnderlyingV1 is GEP1->getUnderlyingObject(),
768 /// UnderlyingV2 is the same for V2.
769 ///
770 AliasAnalysis::AliasResult
771 BasicAliasAnalysis::aliasGEP(const GEPOperator *GEP1, unsigned V1Size,
772                              const Value *V2, unsigned V2Size,
773                              const Value *UnderlyingV1,
774                              const Value *UnderlyingV2) {
775   // If this GEP has been visited before, we're on a use-def cycle.
776   // Such cycles are only valid when PHI nodes are involved or in unreachable
777   // code. The visitPHI function catches cycles containing PHIs, but there
778   // could still be a cycle without PHIs in unreachable code.
779   if (!Visited.insert(GEP1))
780     return MayAlias;
781
782   int64_t GEP1BaseOffset;
783   SmallVector<VariableGEPIndex, 4> GEP1VariableIndices;
784
785   // If we have two gep instructions with must-alias'ing base pointers, figure
786   // out if the indexes to the GEP tell us anything about the derived pointer.
787   if (const GEPOperator *GEP2 = dyn_cast<GEPOperator>(V2)) {
788     // Do the base pointers alias?
789     AliasResult BaseAlias = aliasCheck(UnderlyingV1, UnknownSize,
790                                        UnderlyingV2, UnknownSize);
791     
792     // If we get a No or May, then return it immediately, no amount of analysis
793     // will improve this situation.
794     if (BaseAlias != MustAlias) return BaseAlias;
795     
796     // Otherwise, we have a MustAlias.  Since the base pointers alias each other
797     // exactly, see if the computed offset from the common pointer tells us
798     // about the relation of the resulting pointer.
799     const Value *GEP1BasePtr =
800       DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices, TD);
801     
802     int64_t GEP2BaseOffset;
803     SmallVector<VariableGEPIndex, 4> GEP2VariableIndices;
804     const Value *GEP2BasePtr =
805       DecomposeGEPExpression(GEP2, GEP2BaseOffset, GEP2VariableIndices, TD);
806     
807     // If DecomposeGEPExpression isn't able to look all the way through the
808     // addressing operation, we must not have TD and this is too complex for us
809     // to handle without it.
810     if (GEP1BasePtr != UnderlyingV1 || GEP2BasePtr != UnderlyingV2) {
811       assert(TD == 0 &&
812              "DecomposeGEPExpression and getUnderlyingObject disagree!");
813       return MayAlias;
814     }
815     
816     // Subtract the GEP2 pointer from the GEP1 pointer to find out their
817     // symbolic difference.
818     GEP1BaseOffset -= GEP2BaseOffset;
819     GetIndexDifference(GEP1VariableIndices, GEP2VariableIndices);
820     
821   } else {
822     // Check to see if these two pointers are related by the getelementptr
823     // instruction.  If one pointer is a GEP with a non-zero index of the other
824     // pointer, we know they cannot alias.
825
826     // If both accesses are unknown size, we can't do anything useful here.
827     if (V1Size == UnknownSize && V2Size == UnknownSize)
828       return MayAlias;
829
830     AliasResult R = aliasCheck(UnderlyingV1, UnknownSize, V2, V2Size);
831     if (R != MustAlias)
832       // If V2 may alias GEP base pointer, conservatively returns MayAlias.
833       // If V2 is known not to alias GEP base pointer, then the two values
834       // cannot alias per GEP semantics: "A pointer value formed from a
835       // getelementptr instruction is associated with the addresses associated
836       // with the first operand of the getelementptr".
837       return R;
838
839     const Value *GEP1BasePtr =
840       DecomposeGEPExpression(GEP1, GEP1BaseOffset, GEP1VariableIndices, TD);
841     
842     // If DecomposeGEPExpression isn't able to look all the way through the
843     // addressing operation, we must not have TD and this is too complex for us
844     // to handle without it.
845     if (GEP1BasePtr != UnderlyingV1) {
846       assert(TD == 0 &&
847              "DecomposeGEPExpression and getUnderlyingObject disagree!");
848       return MayAlias;
849     }
850   }
851   
852   // In the two GEP Case, if there is no difference in the offsets of the
853   // computed pointers, the resultant pointers are a must alias.  This
854   // hapens when we have two lexically identical GEP's (for example).
855   //
856   // In the other case, if we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2
857   // must aliases the GEP, the end result is a must alias also.
858   if (GEP1BaseOffset == 0 && GEP1VariableIndices.empty())
859     return MustAlias;
860
861   // If we have a known constant offset, see if this offset is larger than the
862   // access size being queried.  If so, and if no variable indices can remove
863   // pieces of this constant, then we know we have a no-alias.  For example,
864   //   &A[100] != &A.
865   
866   // In order to handle cases like &A[100][i] where i is an out of range
867   // subscript, we have to ignore all constant offset pieces that are a multiple
868   // of a scaled index.  Do this by removing constant offsets that are a
869   // multiple of any of our variable indices.  This allows us to transform
870   // things like &A[i][1] because i has a stride of (e.g.) 8 bytes but the 1
871   // provides an offset of 4 bytes (assuming a <= 4 byte access).
872   for (unsigned i = 0, e = GEP1VariableIndices.size();
873        i != e && GEP1BaseOffset;++i)
874     if (int64_t RemovedOffset = GEP1BaseOffset/GEP1VariableIndices[i].Scale)
875       GEP1BaseOffset -= RemovedOffset*GEP1VariableIndices[i].Scale;
876   
877   // If our known offset is bigger than the access size, we know we don't have
878   // an alias.
879   if (GEP1BaseOffset) {
880     if (GEP1BaseOffset >= (int64_t)V2Size ||
881         GEP1BaseOffset <= -(int64_t)V1Size)
882       return NoAlias;
883   }
884   
885   return MayAlias;
886 }
887
888 /// aliasSelect - Provide a bunch of ad-hoc rules to disambiguate a Select
889 /// instruction against another.
890 AliasAnalysis::AliasResult
891 BasicAliasAnalysis::aliasSelect(const SelectInst *SI, unsigned SISize,
892                                 const Value *V2, unsigned V2Size) {
893   // If this select has been visited before, we're on a use-def cycle.
894   // Such cycles are only valid when PHI nodes are involved or in unreachable
895   // code. The visitPHI function catches cycles containing PHIs, but there
896   // could still be a cycle without PHIs in unreachable code.
897   if (!Visited.insert(SI))
898     return MayAlias;
899
900   // If the values are Selects with the same condition, we can do a more precise
901   // check: just check for aliases between the values on corresponding arms.
902   if (const SelectInst *SI2 = dyn_cast<SelectInst>(V2))
903     if (SI->getCondition() == SI2->getCondition()) {
904       AliasResult Alias =
905         aliasCheck(SI->getTrueValue(), SISize,
906                    SI2->getTrueValue(), V2Size);
907       if (Alias == MayAlias)
908         return MayAlias;
909       AliasResult ThisAlias =
910         aliasCheck(SI->getFalseValue(), SISize,
911                    SI2->getFalseValue(), V2Size);
912       if (ThisAlias != Alias)
913         return MayAlias;
914       return Alias;
915     }
916
917   // If both arms of the Select node NoAlias or MustAlias V2, then returns
918   // NoAlias / MustAlias. Otherwise, returns MayAlias.
919   AliasResult Alias =
920     aliasCheck(V2, V2Size, SI->getTrueValue(), SISize);
921   if (Alias == MayAlias)
922     return MayAlias;
923
924   // If V2 is visited, the recursive case will have been caught in the
925   // above aliasCheck call, so these subsequent calls to aliasCheck
926   // don't need to assume that V2 is being visited recursively.
927   Visited.erase(V2);
928
929   AliasResult ThisAlias =
930     aliasCheck(V2, V2Size, SI->getFalseValue(), SISize);
931   if (ThisAlias != Alias)
932     return MayAlias;
933   return Alias;
934 }
935
936 // aliasPHI - Provide a bunch of ad-hoc rules to disambiguate a PHI instruction
937 // against another.
938 AliasAnalysis::AliasResult
939 BasicAliasAnalysis::aliasPHI(const PHINode *PN, unsigned PNSize,
940                              const Value *V2, unsigned V2Size) {
941   // The PHI node has already been visited, avoid recursion any further.
942   if (!Visited.insert(PN))
943     return MayAlias;
944
945   // If the values are PHIs in the same block, we can do a more precise
946   // as well as efficient check: just check for aliases between the values
947   // on corresponding edges.
948   if (const PHINode *PN2 = dyn_cast<PHINode>(V2))
949     if (PN2->getParent() == PN->getParent()) {
950       AliasResult Alias =
951         aliasCheck(PN->getIncomingValue(0), PNSize,
952                    PN2->getIncomingValueForBlock(PN->getIncomingBlock(0)),
953                    V2Size);
954       if (Alias == MayAlias)
955         return MayAlias;
956       for (unsigned i = 1, e = PN->getNumIncomingValues(); i != e; ++i) {
957         AliasResult ThisAlias =
958           aliasCheck(PN->getIncomingValue(i), PNSize,
959                      PN2->getIncomingValueForBlock(PN->getIncomingBlock(i)),
960                      V2Size);
961         if (ThisAlias != Alias)
962           return MayAlias;
963       }
964       return Alias;
965     }
966
967   SmallPtrSet<Value*, 4> UniqueSrc;
968   SmallVector<Value*, 4> V1Srcs;
969   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
970     Value *PV1 = PN->getIncomingValue(i);
971     if (isa<PHINode>(PV1))
972       // If any of the source itself is a PHI, return MayAlias conservatively
973       // to avoid compile time explosion. The worst possible case is if both
974       // sides are PHI nodes. In which case, this is O(m x n) time where 'm'
975       // and 'n' are the number of PHI sources.
976       return MayAlias;
977     if (UniqueSrc.insert(PV1))
978       V1Srcs.push_back(PV1);
979   }
980
981   AliasResult Alias = aliasCheck(V2, V2Size, V1Srcs[0], PNSize);
982   // Early exit if the check of the first PHI source against V2 is MayAlias.
983   // Other results are not possible.
984   if (Alias == MayAlias)
985     return MayAlias;
986
987   // If all sources of the PHI node NoAlias or MustAlias V2, then returns
988   // NoAlias / MustAlias. Otherwise, returns MayAlias.
989   for (unsigned i = 1, e = V1Srcs.size(); i != e; ++i) {
990     Value *V = V1Srcs[i];
991
992     // If V2 is visited, the recursive case will have been caught in the
993     // above aliasCheck call, so these subsequent calls to aliasCheck
994     // don't need to assume that V2 is being visited recursively.
995     Visited.erase(V2);
996
997     AliasResult ThisAlias = aliasCheck(V2, V2Size, V, PNSize);
998     if (ThisAlias != Alias || ThisAlias == MayAlias)
999       return MayAlias;
1000   }
1001
1002   return Alias;
1003 }
1004
1005 // aliasCheck - Provide a bunch of ad-hoc rules to disambiguate in common cases,
1006 // such as array references.
1007 //
1008 AliasAnalysis::AliasResult
1009 BasicAliasAnalysis::aliasCheck(const Value *V1, unsigned V1Size,
1010                                const Value *V2, unsigned V2Size) {
1011   // If either of the memory references is empty, it doesn't matter what the
1012   // pointer values are.
1013   if (V1Size == 0 || V2Size == 0)
1014     return NoAlias;
1015
1016   // Strip off any casts if they exist.
1017   V1 = V1->stripPointerCasts();
1018   V2 = V2->stripPointerCasts();
1019
1020   // Are we checking for alias of the same value?
1021   if (V1 == V2) return MustAlias;
1022
1023   if (!V1->getType()->isPointerTy() || !V2->getType()->isPointerTy())
1024     return NoAlias;  // Scalars cannot alias each other
1025
1026   // Figure out what objects these things are pointing to if we can.
1027   const Value *O1 = V1->getUnderlyingObject();
1028   const Value *O2 = V2->getUnderlyingObject();
1029
1030   // Null values in the default address space don't point to any object, so they
1031   // don't alias any other pointer.
1032   if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O1))
1033     if (CPN->getType()->getAddressSpace() == 0)
1034       return NoAlias;
1035   if (const ConstantPointerNull *CPN = dyn_cast<ConstantPointerNull>(O2))
1036     if (CPN->getType()->getAddressSpace() == 0)
1037       return NoAlias;
1038
1039   if (O1 != O2) {
1040     // If V1/V2 point to two different objects we know that we have no alias.
1041     if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
1042       return NoAlias;
1043
1044     // Constant pointers can't alias with non-const isIdentifiedObject objects.
1045     if ((isa<Constant>(O1) && isIdentifiedObject(O2) && !isa<Constant>(O2)) ||
1046         (isa<Constant>(O2) && isIdentifiedObject(O1) && !isa<Constant>(O1)))
1047       return NoAlias;
1048
1049     // Arguments can't alias with local allocations or noalias calls
1050     // in the same function.
1051     if (((isa<Argument>(O1) && (isa<AllocaInst>(O2) || isNoAliasCall(O2))) ||
1052          (isa<Argument>(O2) && (isa<AllocaInst>(O1) || isNoAliasCall(O1)))))
1053       return NoAlias;
1054
1055     // Most objects can't alias null.
1056     if ((isa<ConstantPointerNull>(O2) && isKnownNonNull(O1)) ||
1057         (isa<ConstantPointerNull>(O1) && isKnownNonNull(O2)))
1058       return NoAlias;
1059   
1060     // If one pointer is the result of a call/invoke or load and the other is a
1061     // non-escaping local object within the same function, then we know the
1062     // object couldn't escape to a point where the call could return it.
1063     //
1064     // Note that if the pointers are in different functions, there are a
1065     // variety of complications. A call with a nocapture argument may still
1066     // temporary store the nocapture argument's value in a temporary memory
1067     // location if that memory location doesn't escape. Or it may pass a
1068     // nocapture value to other functions as long as they don't capture it.
1069     if (isEscapeSource(O1) && isNonEscapingLocalObject(O2))
1070       return NoAlias;
1071     if (isEscapeSource(O2) && isNonEscapingLocalObject(O1))
1072       return NoAlias;
1073   }
1074
1075   // If the size of one access is larger than the entire object on the other
1076   // side, then we know such behavior is undefined and can assume no alias.
1077   if (TD)
1078     if ((V1Size != UnknownSize && isObjectSmallerThan(O2, V1Size, *TD)) ||
1079         (V2Size != UnknownSize && isObjectSmallerThan(O1, V2Size, *TD)))
1080       return NoAlias;
1081   
1082   // FIXME: This isn't aggressively handling alias(GEP, PHI) for example: if the
1083   // GEP can't simplify, we don't even look at the PHI cases.
1084   if (!isa<GEPOperator>(V1) && isa<GEPOperator>(V2)) {
1085     std::swap(V1, V2);
1086     std::swap(V1Size, V2Size);
1087     std::swap(O1, O2);
1088   }
1089   if (const GEPOperator *GV1 = dyn_cast<GEPOperator>(V1))
1090     return aliasGEP(GV1, V1Size, V2, V2Size, O1, O2);
1091
1092   if (isa<PHINode>(V2) && !isa<PHINode>(V1)) {
1093     std::swap(V1, V2);
1094     std::swap(V1Size, V2Size);
1095   }
1096   if (const PHINode *PN = dyn_cast<PHINode>(V1))
1097     return aliasPHI(PN, V1Size, V2, V2Size);
1098
1099   if (isa<SelectInst>(V2) && !isa<SelectInst>(V1)) {
1100     std::swap(V1, V2);
1101     std::swap(V1Size, V2Size);
1102   }
1103   if (const SelectInst *S1 = dyn_cast<SelectInst>(V1))
1104     return aliasSelect(S1, V1Size, V2, V2Size);
1105
1106   return NoAA::alias(V1, V1Size, V2, V2Size);
1107 }
1108
1109 // Make sure that anything that uses AliasAnalysis pulls in this file.
1110 DEFINING_FILE_FOR(BasicAliasAnalysis)