lib/Analysis/BasicAliasAnalysis.cpp

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