lib/Analysis/BasicAliasAnalysis.cpp

   1 //===- BasicAliasAnalysis.cpp - Local Alias Analysis Impl -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the default implementation of the Alias Analysis interface
  11 // that simply implements a few identities (two different globals cannot alias,
  12 // etc), but otherwise does no analysis.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/Analysis/AliasAnalysis.h"
  17 #include "llvm/Analysis/CaptureTracking.h"
  18 #include "llvm/Analysis/Passes.h"
  19 #include "llvm/Constants.h"
  20 #include "llvm/DerivedTypes.h"
  21 #include "llvm/Function.h"
  22 #include "llvm/GlobalVariable.h"
  23 #include "llvm/Instructions.h"
  24 #include "llvm/IntrinsicInst.h"
  25 #include "llvm/Pass.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/ADT/SmallVector.h"
  28 #include "llvm/ADT/STLExtras.h"
  29 #include "llvm/Support/Compiler.h"
  30 #include "llvm/Support/GetElementPtrTypeIterator.h"
  31 #include "llvm/Support/ManagedStatic.h"
  32 #include <algorithm>
  33 using namespace llvm;
  34
  35 //===----------------------------------------------------------------------===//
  36 // Useful predicates
  37 //===----------------------------------------------------------------------===//
  38
  39 static const User *isGEP(const Value *V) {
  40   if (isa<GetElementPtrInst>(V) ||
  41       (isa<ConstantExpr>(V) &&
  42        cast<ConstantExpr>(V)->getOpcode() == Instruction::GetElementPtr))
  43     return cast<User>(V);
  44   return 0;
  45 }
  46
  47 static const Value *GetGEPOperands(const Value *V,
  48                                    SmallVector<Value*, 16> &GEPOps) {
  49   assert(GEPOps.empty() && "Expect empty list to populate!");
  50   GEPOps.insert(GEPOps.end(), cast<User>(V)->op_begin()+1,
  51                 cast<User>(V)->op_end());
  52
  53   // Accumulate all of the chained indexes into the operand array
  54   V = cast<User>(V)->getOperand(0);
  55
  56   while (const User *G = isGEP(V)) {
  57     if (!isa<Constant>(GEPOps[0]) || isa<GlobalValue>(GEPOps[0]) ||
  58         !cast<Constant>(GEPOps[0])->isNullValue())
  59       break;  // Don't handle folding arbitrary pointer offsets yet...
  60     GEPOps.erase(GEPOps.begin());   // Drop the zero index
  61     GEPOps.insert(GEPOps.begin(), G->op_begin()+1, G->op_end());
  62     V = G->getOperand(0);
  63   }
  64   return V;
  65 }
  66
  67 /// isKnownNonNull - Return true if we know that the specified value is never
  68 /// null.
  69 static bool isKnownNonNull(const Value *V) {
  70   // Alloca never returns null, malloc might.
  71   if (isa<AllocaInst>(V)) return true;
  72
  73   // A byval argument is never null.
  74   if (const Argument *A = dyn_cast<Argument>(V))
  75     return A->hasByValAttr();
  76
  77   // Global values are not null unless extern weak.
  78   if (const GlobalValue *GV = dyn_cast<GlobalValue>(V))
  79     return !GV->hasExternalWeakLinkage();
  80   return false;
  81 }
  82
  83 /// isNonEscapingLocalObject - Return true if the pointer is to a function-local
  84 /// object that never escapes from the function.
  85 static bool isNonEscapingLocalObject(const Value *V) {
  86   // If this is a local allocation, check to see if it escapes.
  87   if (isa<AllocationInst>(V) || isNoAliasCall(V))
  88     return !PointerMayBeCaptured(V, false);
  89
  90   // If this is an argument that corresponds to a byval or noalias argument,
  91   // then it has not escaped before entering the function.  Check if it escapes
  92   // inside the function.
  93   if (const Argument *A = dyn_cast<Argument>(V))
  94     if (A->hasByValAttr() || A->hasNoAliasAttr()) {
  95       // Don't bother analyzing arguments already known not to escape.
  96       if (A->hasNoCaptureAttr())
  97         return true;
  98       return !PointerMayBeCaptured(V, false);
  99     }
 100   return false;
 101 }
 102
 103
 104 /// isObjectSmallerThan - Return true if we can prove that the object specified
 105 /// by V is smaller than Size.
 106 static bool isObjectSmallerThan(const Value *V, unsigned Size,
 107                                 const TargetData &TD) {
 108   const Type *AccessTy;
 109   if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
 110     AccessTy = GV->getType()->getElementType();
 111   } else if (const AllocationInst *AI = dyn_cast<AllocationInst>(V)) {
 112     if (!AI->isArrayAllocation())
 113       AccessTy = AI->getType()->getElementType();
 114     else
 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.getTypePaddedSize(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 VISIBILITY_HIDDEN NoAA : public ImmutablePass, public AliasAnalysis {
 141     static char ID; // Class identification, replacement for typeinfo
 142     NoAA() : ImmutablePass(&ID) {}
 143     explicit NoAA(void *PID) : ImmutablePass(PID) { }
 144
 145     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 146       AU.addRequired<TargetData>();
 147     }
 148
 149     virtual void initializePass() {
 150       TD = &getAnalysis<TargetData>();
 151     }
 152
 153     virtual AliasResult alias(const Value *V1, unsigned V1Size,
 154                               const Value *V2, unsigned V2Size) {
 155       return MayAlias;
 156     }
 157
 158     virtual void getArgumentAccesses(Function *F, CallSite CS,
 159                                      std::vector<PointerAccessInfo> &Info) {
 160       assert(0 && "This method may not be called on this function!");
 161     }
 162
 163     virtual void getMustAliases(Value *P, std::vector<Value*> &RetVals) { }
 164     virtual bool pointsToConstantMemory(const Value *P) { return false; }
 165     virtual ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size) {
 166       return ModRef;
 167     }
 168     virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
 169       return ModRef;
 170     }
 171     virtual bool hasNoModRefInfoForCalls() const { return true; }
 172
 173     virtual void deleteValue(Value *V) {}
 174     virtual void copyValue(Value *From, Value *To) {}
 175   };
 176 }  // End of anonymous namespace
 177
 178 // Register this pass...
 179 char NoAA::ID = 0;
 180 static RegisterPass<NoAA>
 181 U("no-aa", "No Alias Analysis (always returns 'may' alias)", true, true);
 182
 183 // Declare that we implement the AliasAnalysis interface
 184 static RegisterAnalysisGroup<AliasAnalysis> V(U);
 185
 186 ImmutablePass *llvm::createNoAAPass() { return new NoAA(); }
 187
 188 //===----------------------------------------------------------------------===//
 189 // BasicAA Pass
 190 //===----------------------------------------------------------------------===//
 191
 192 namespace {
 193   /// BasicAliasAnalysis - This is the default alias analysis implementation.
 194   /// Because it doesn't chain to a previous alias analysis (like -no-aa), it
 195   /// derives from the NoAA class.
 196   struct VISIBILITY_HIDDEN BasicAliasAnalysis : public NoAA {
 197     static char ID; // Class identification, replacement for typeinfo
 198     BasicAliasAnalysis() : NoAA(&ID) {}
 199     AliasResult alias(const Value *V1, unsigned V1Size,
 200                       const Value *V2, unsigned V2Size);
 201
 202     ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
 203     ModRefResult getModRefInfo(CallSite CS1, CallSite CS2);
 204
 205     virtual ModRefBehavior getModRefBehavior(CallSite CS,
 206                                      std::vector<PointerAccessInfo> *Info = 0);
 207
 208     virtual ModRefBehavior getModRefBehavior(Function *F,
 209                                      std::vector<PointerAccessInfo> *Info = 0);
 210
 211     /// hasNoModRefInfoForCalls - We can provide mod/ref information against
 212     /// non-escaping allocations.
 213     virtual bool hasNoModRefInfoForCalls() const { return false; }
 214
 215     /// pointsToConstantMemory - Chase pointers until we find a (constant
 216     /// global) or not.
 217     bool pointsToConstantMemory(const Value *P);
 218
 219   private:
 220     // CheckGEPInstructions - Check two GEP instructions with known
 221     // must-aliasing base pointers.  This checks to see if the index expressions
 222     // preclude the pointers from aliasing...
 223     AliasResult
 224     CheckGEPInstructions(const Type* BasePtr1Ty,
 225                          Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1Size,
 226                          const Type *BasePtr2Ty,
 227                          Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2Size);
 228   };
 229 }  // End of anonymous namespace
 230
 231 // Register this pass...
 232 char BasicAliasAnalysis::ID = 0;
 233 static RegisterPass<BasicAliasAnalysis>
 234 X("basicaa", "Basic Alias Analysis (default AA impl)", false, true);
 235
 236 // Declare that we implement the AliasAnalysis interface
 237 static RegisterAnalysisGroup<AliasAnalysis, true> Y(X);
 238
 239 ImmutablePass *llvm::createBasicAliasAnalysisPass() {
 240   return new BasicAliasAnalysis();
 241 }
 242
 243
 244 /// pointsToConstantMemory - Chase pointers until we find a (constant
 245 /// global) or not.
 246 bool BasicAliasAnalysis::pointsToConstantMemory(const Value *P) {
 247   if (const GlobalVariable *GV =
 248         dyn_cast<GlobalVariable>(P->getUnderlyingObject()))
 249     return GV->isConstant();
 250   return false;
 251 }
 252
 253
 254 static bool isAtomicRMW(Function* F) {
 255   if (!F) return false;
 256   if (F->isIntrinsic()) {
 257     switch (F->getIntrinsicID()) {
 258       case Intrinsic::atomic_cmp_swap:
 259       case Intrinsic::atomic_load_add:
 260       case Intrinsic::atomic_load_and:
 261       case Intrinsic::atomic_load_max:
 262       case Intrinsic::atomic_load_min:
 263       case Intrinsic::atomic_load_nand:
 264       case Intrinsic::atomic_load_or:
 265       case Intrinsic::atomic_load_sub:
 266       case Intrinsic::atomic_load_umax:
 267       case Intrinsic::atomic_load_umin:
 268       case Intrinsic::atomic_load_xor:
 269       case Intrinsic::atomic_swap:
 270         return true;
 271       default:
 272         return false;
 273     }
 274   }
 275
 276   return false;
 277 }
 278
 279 AliasAnalysis::ModRefBehavior
 280 BasicAliasAnalysis::getModRefBehavior(CallSite CS,
 281                                  std::vector<PointerAccessInfo> *Info) {
 282   if (isAtomicRMW(CS.getCalledFunction()))
 283     // CAS and related intrinsics only access their arguments.
 284     return AliasAnalysis::AccessesArguments;
 285
 286   return AliasAnalysis::getModRefBehavior(CS, Info);
 287 }
 288
 289 AliasAnalysis::ModRefBehavior
 290 BasicAliasAnalysis::getModRefBehavior(Function *F,
 291                                  std::vector<PointerAccessInfo> *Info) {
 292   if (isAtomicRMW(F))
 293     // CAS and related intrinsics only access their arguments.
 294     return AliasAnalysis::AccessesArguments;
 295
 296   return AliasAnalysis::getModRefBehavior(F, Info);
 297 }
 298
 299 // getModRefInfo - Check to see if the specified callsite can clobber the
 300 // specified memory object.  Since we only look at local properties of this
 301 // function, we really can't say much about this query.  We do, however, use
 302 // simple "address taken" analysis on local objects.
 303 //
 304 AliasAnalysis::ModRefResult
 305 BasicAliasAnalysis::getModRefInfo(CallSite CS, Value *P, unsigned Size) {
 306   if (!isa<Constant>(P)) {
 307     const Value *Object = P->getUnderlyingObject();
 308
 309     // If this is a tail call and P points to a stack location, we know that
 310     // the tail call cannot access or modify the local stack.
 311     // We cannot exclude byval arguments here; these belong to the caller of
 312     // the current function not to the current function, and a tail callee
 313     // may reference them.
 314     if (isa<AllocaInst>(Object))
 315       if (CallInst *CI = dyn_cast<CallInst>(CS.getInstruction()))
 316         if (CI->isTailCall())
 317           return NoModRef;
 318
 319     // If the pointer is to a locally allocated object that does not escape,
 320     // then the call can not mod/ref the pointer unless the call takes the
 321     // argument without capturing it.
 322     if (isNonEscapingLocalObject(Object)) {
 323       bool passedAsArg = false;
 324       // TODO: Eventually only check 'nocapture' arguments.
 325       for (CallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
 326            CI != CE; ++CI)
 327         if (isa<PointerType>((*CI)->getType()) &&
 328             alias(cast<Value>(CI), ~0U, P, ~0U) != NoAlias)
 329           passedAsArg = true;
 330
 331       if (!passedAsArg)
 332         return NoModRef;
 333     }
 334   }
 335
 336   // The AliasAnalysis base class has some smarts, lets use them.
 337   return AliasAnalysis::getModRefInfo(CS, P, Size);
 338 }
 339
 340
 341 AliasAnalysis::ModRefResult
 342 BasicAliasAnalysis::getModRefInfo(CallSite CS1, CallSite CS2) {
 343   // If CS1 or CS2 are readnone, they don't interact.
 344   ModRefBehavior CS1B = AliasAnalysis::getModRefBehavior(CS1);
 345   if (CS1B == DoesNotAccessMemory) return NoModRef;
 346
 347   ModRefBehavior CS2B = AliasAnalysis::getModRefBehavior(CS2);
 348   if (CS2B == DoesNotAccessMemory) return NoModRef;
 349
 350   // If they both only read from memory, just return ref.
 351   if (CS1B == OnlyReadsMemory && CS2B == OnlyReadsMemory)
 352     return Ref;
 353
 354   // Otherwise, fall back to NoAA (mod+ref).
 355   return NoAA::getModRefInfo(CS1, CS2);
 356 }
 357
 358
 359 // alias - Provide a bunch of ad-hoc rules to disambiguate in common cases, such
 360 // as array references.
 361 //
 362 AliasAnalysis::AliasResult
 363 BasicAliasAnalysis::alias(const Value *V1, unsigned V1Size,
 364                           const Value *V2, unsigned V2Size) {
 365   // Strip off any constant expression casts if they exist
 366   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V1))
 367     if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
 368       V1 = CE->getOperand(0);
 369   if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V2))
 370     if (CE->isCast() && isa<PointerType>(CE->getOperand(0)->getType()))
 371       V2 = CE->getOperand(0);
 372
 373   // Are we checking for alias of the same value?
 374   if (V1 == V2) return MustAlias;
 375
 376   if (!isa<PointerType>(V1->getType()) || !isa<PointerType>(V2->getType()))
 377     return NoAlias;  // Scalars cannot alias each other
 378
 379   // Strip off cast instructions.   Since V1 and V2 are pointers, they must be
 380   // pointer<->pointer bitcasts.
 381   if (const BitCastInst *I = dyn_cast<BitCastInst>(V1))
 382     return alias(I->getOperand(0), V1Size, V2, V2Size);
 383   if (const BitCastInst *I = dyn_cast<BitCastInst>(V2))
 384     return alias(V1, V1Size, I->getOperand(0), V2Size);
 385
 386   // Figure out what objects these things are pointing to if we can.
 387   const Value *O1 = V1->getUnderlyingObject();
 388   const Value *O2 = V2->getUnderlyingObject();
 389
 390   if (O1 != O2) {
 391     // If V1/V2 point to two different objects we know that we have no alias.
 392     if (isIdentifiedObject(O1) && isIdentifiedObject(O2))
 393       return NoAlias;
 394
 395     // Arguments can't alias with local allocations or noalias calls.
 396     if ((isa<Argument>(O1) && (isa<AllocationInst>(O2) || isNoAliasCall(O2))) ||
 397         (isa<Argument>(O2) && (isa<AllocationInst>(O1) || isNoAliasCall(O1))))
 398       return NoAlias;
 399
 400     // Most objects can't alias null.
 401     if ((isa<ConstantPointerNull>(V2) && isKnownNonNull(O1)) ||
 402         (isa<ConstantPointerNull>(V1) && isKnownNonNull(O2)))
 403       return NoAlias;
 404   }
 405
 406   // If the size of one access is larger than the entire object on the other
 407   // side, then we know such behavior is undefined and can assume no alias.
 408   const TargetData &TD = getTargetData();
 409   if ((V1Size != ~0U && isObjectSmallerThan(O2, V1Size, TD)) ||
 410       (V2Size != ~0U && isObjectSmallerThan(O1, V2Size, TD)))
 411     return NoAlias;
 412
 413   // If one pointer is the result of a call/invoke and the other is a
 414   // non-escaping local object, then we know the object couldn't escape to a
 415   // point where the call could return it.
 416   if ((isa<CallInst>(O1) || isa<InvokeInst>(O1)) &&
 417       isNonEscapingLocalObject(O2))
 418     return NoAlias;
 419   if ((isa<CallInst>(O2) || isa<InvokeInst>(O2)) &&
 420       isNonEscapingLocalObject(O1))
 421     return NoAlias;
 422
 423   // If we have two gep instructions with must-alias'ing base pointers, figure
 424   // out if the indexes to the GEP tell us anything about the derived pointer.
 425   // Note that we also handle chains of getelementptr instructions as well as
 426   // constant expression getelementptrs here.
 427   //
 428   if (isGEP(V1) && isGEP(V2)) {
 429     const User *GEP1 = cast<User>(V1);
 430     const User *GEP2 = cast<User>(V2);
 431
 432     // If V1 and V2 are identical GEPs, just recurse down on both of them.
 433     // This allows us to analyze things like:
 434     //   P = gep A, 0, i, 1
 435     //   Q = gep B, 0, i, 1
 436     // by just analyzing A and B.  This is even safe for variable indices.
 437     if (GEP1->getType() == GEP2->getType() &&
 438         GEP1->getNumOperands() == GEP2->getNumOperands() &&
 439         GEP1->getOperand(0)->getType() == GEP2->getOperand(0)->getType() &&
 440         // All operands are the same, ignoring the base.
 441         std::equal(GEP1->op_begin()+1, GEP1->op_end(), GEP2->op_begin()+1))
 442       return alias(GEP1->getOperand(0), V1Size, GEP2->getOperand(0), V2Size);
 443
 444
 445     // Drill down into the first non-gep value, to test for must-aliasing of
 446     // the base pointers.
 447     while (isGEP(GEP1->getOperand(0)) &&
 448            GEP1->getOperand(1) ==
 449            Constant::getNullValue(GEP1->getOperand(1)->getType()))
 450       GEP1 = cast<User>(GEP1->getOperand(0));
 451     const Value *BasePtr1 = GEP1->getOperand(0);
 452
 453     while (isGEP(GEP2->getOperand(0)) &&
 454            GEP2->getOperand(1) ==
 455            Constant::getNullValue(GEP2->getOperand(1)->getType()))
 456       GEP2 = cast<User>(GEP2->getOperand(0));
 457     const Value *BasePtr2 = GEP2->getOperand(0);
 458
 459     // Do the base pointers alias?
 460     AliasResult BaseAlias = alias(BasePtr1, ~0U, BasePtr2, ~0U);
 461     if (BaseAlias == NoAlias) return NoAlias;
 462     if (BaseAlias == MustAlias) {
 463       // If the base pointers alias each other exactly, check to see if we can
 464       // figure out anything about the resultant pointers, to try to prove
 465       // non-aliasing.
 466
 467       // Collect all of the chained GEP operands together into one simple place
 468       SmallVector<Value*, 16> GEP1Ops, GEP2Ops;
 469       BasePtr1 = GetGEPOperands(V1, GEP1Ops);
 470       BasePtr2 = GetGEPOperands(V2, GEP2Ops);
 471
 472       // If GetGEPOperands were able to fold to the same must-aliased pointer,
 473       // do the comparison.
 474       if (BasePtr1 == BasePtr2) {
 475         AliasResult GAlias =
 476           CheckGEPInstructions(BasePtr1->getType(),
 477                                &GEP1Ops[0], GEP1Ops.size(), V1Size,
 478                                BasePtr2->getType(),
 479                                &GEP2Ops[0], GEP2Ops.size(), V2Size);
 480         if (GAlias != MayAlias)
 481           return GAlias;
 482       }
 483     }
 484   }
 485
 486   // Check to see if these two pointers are related by a getelementptr
 487   // instruction.  If one pointer is a GEP with a non-zero index of the other
 488   // pointer, we know they cannot alias.
 489   //
 490   if (isGEP(V2)) {
 491     std::swap(V1, V2);
 492     std::swap(V1Size, V2Size);
 493   }
 494
 495   if (V1Size != ~0U && V2Size != ~0U)
 496     if (isGEP(V1)) {
 497       SmallVector<Value*, 16> GEPOperands;
 498       const Value *BasePtr = GetGEPOperands(V1, GEPOperands);
 499
 500       AliasResult R = alias(BasePtr, V1Size, V2, V2Size);
 501       if (R == MustAlias) {
 502         // If there is at least one non-zero constant index, we know they cannot
 503         // alias.
 504         bool ConstantFound = false;
 505         bool AllZerosFound = true;
 506         for (unsigned i = 0, e = GEPOperands.size(); i != e; ++i)
 507           if (const Constant *C = dyn_cast<Constant>(GEPOperands[i])) {
 508             if (!C->isNullValue()) {
 509               ConstantFound = true;
 510               AllZerosFound = false;
 511               break;
 512             }
 513           } else {
 514             AllZerosFound = false;
 515           }
 516
 517         // If we have getelementptr <ptr>, 0, 0, 0, 0, ... and V2 must aliases
 518         // the ptr, the end result is a must alias also.
 519         if (AllZerosFound)
 520           return MustAlias;
 521
 522         if (ConstantFound) {
 523           if (V2Size <= 1 && V1Size <= 1)  // Just pointer check?
 524             return NoAlias;
 525
 526           // Otherwise we have to check to see that the distance is more than
 527           // the size of the argument... build an index vector that is equal to
 528           // the arguments provided, except substitute 0's for any variable
 529           // indexes we find...
 530           if (cast<PointerType>(
 531                 BasePtr->getType())->getElementType()->isSized()) {
 532             for (unsigned i = 0; i != GEPOperands.size(); ++i)
 533               if (!isa<ConstantInt>(GEPOperands[i]))
 534                 GEPOperands[i] =
 535                   Constant::getNullValue(GEPOperands[i]->getType());
 536             int64_t Offset =
 537               getTargetData().getIndexedOffset(BasePtr->getType(),
 538                                                &GEPOperands[0],
 539                                                GEPOperands.size());
 540
 541             if (Offset >= (int64_t)V2Size || Offset <= -(int64_t)V1Size)
 542               return NoAlias;
 543           }
 544         }
 545       }
 546     }
 547
 548   return MayAlias;
 549 }
 550
 551 // This function is used to determine if the indices of two GEP instructions are
 552 // equal. V1 and V2 are the indices.
 553 static bool IndexOperandsEqual(Value *V1, Value *V2) {
 554   if (V1->getType() == V2->getType())
 555     return V1 == V2;
 556   if (Constant *C1 = dyn_cast<Constant>(V1))
 557     if (Constant *C2 = dyn_cast<Constant>(V2)) {
 558       // Sign extend the constants to long types, if necessary
 559       if (C1->getType() != Type::Int64Ty)
 560         C1 = ConstantExpr::getSExt(C1, Type::Int64Ty);
 561       if (C2->getType() != Type::Int64Ty)
 562         C2 = ConstantExpr::getSExt(C2, Type::Int64Ty);
 563       return C1 == C2;
 564     }
 565   return false;
 566 }
 567
 568 /// CheckGEPInstructions - Check two GEP instructions with known must-aliasing
 569 /// base pointers.  This checks to see if the index expressions preclude the
 570 /// pointers from aliasing...
 571 AliasAnalysis::AliasResult
 572 BasicAliasAnalysis::CheckGEPInstructions(
 573   const Type* BasePtr1Ty, Value **GEP1Ops, unsigned NumGEP1Ops, unsigned G1S,
 574   const Type *BasePtr2Ty, Value **GEP2Ops, unsigned NumGEP2Ops, unsigned G2S) {
 575   // We currently can't handle the case when the base pointers have different
 576   // primitive types.  Since this is uncommon anyway, we are happy being
 577   // extremely conservative.
 578   if (BasePtr1Ty != BasePtr2Ty)
 579     return MayAlias;
 580
 581   const PointerType *GEPPointerTy = cast<PointerType>(BasePtr1Ty);
 582
 583   // Find the (possibly empty) initial sequence of equal values... which are not
 584   // necessarily constants.
 585   unsigned NumGEP1Operands = NumGEP1Ops, NumGEP2Operands = NumGEP2Ops;
 586   unsigned MinOperands = std::min(NumGEP1Operands, NumGEP2Operands);
 587   unsigned MaxOperands = std::max(NumGEP1Operands, NumGEP2Operands);
 588   unsigned UnequalOper = 0;
 589   while (UnequalOper != MinOperands &&
 590          IndexOperandsEqual(GEP1Ops[UnequalOper], GEP2Ops[UnequalOper])) {
 591     // Advance through the type as we go...
 592     ++UnequalOper;
 593     if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
 594       BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[UnequalOper-1]);
 595     else {
 596       // If all operands equal each other, then the derived pointers must
 597       // alias each other...
 598       BasePtr1Ty = 0;
 599       assert(UnequalOper == NumGEP1Operands && UnequalOper == NumGEP2Operands &&
 600              "Ran out of type nesting, but not out of operands?");
 601       return MustAlias;
 602     }
 603   }
 604
 605   // If we have seen all constant operands, and run out of indexes on one of the
 606   // getelementptrs, check to see if the tail of the leftover one is all zeros.
 607   // If so, return mustalias.
 608   if (UnequalOper == MinOperands) {
 609     if (NumGEP1Ops < NumGEP2Ops) {
 610       std::swap(GEP1Ops, GEP2Ops);
 611       std::swap(NumGEP1Ops, NumGEP2Ops);
 612     }
 613
 614     bool AllAreZeros = true;
 615     for (unsigned i = UnequalOper; i != MaxOperands; ++i)
 616       if (!isa<Constant>(GEP1Ops[i]) ||
 617           !cast<Constant>(GEP1Ops[i])->isNullValue()) {
 618         AllAreZeros = false;
 619         break;
 620       }
 621     if (AllAreZeros) return MustAlias;
 622   }
 623
 624
 625   // So now we know that the indexes derived from the base pointers,
 626   // which are known to alias, are different.  We can still determine a
 627   // no-alias result if there are differing constant pairs in the index
 628   // chain.  For example:
 629   //        A[i][0] != A[j][1] iff (&A[0][1]-&A[0][0] >= std::max(G1S, G2S))
 630   //
 631   // We have to be careful here about array accesses.  In particular, consider:
 632   //        A[1][0] vs A[0][i]
 633   // In this case, we don't *know* that the array will be accessed in bounds:
 634   // the index could even be negative.  Because of this, we have to
 635   // conservatively *give up* and return may alias.  We disregard differing
 636   // array subscripts that are followed by a variable index without going
 637   // through a struct.
 638   //
 639   unsigned SizeMax = std::max(G1S, G2S);
 640   if (SizeMax == ~0U) return MayAlias; // Avoid frivolous work.
 641
 642   // Scan for the first operand that is constant and unequal in the
 643   // two getelementptrs...
 644   unsigned FirstConstantOper = UnequalOper;
 645   for (; FirstConstantOper != MinOperands; ++FirstConstantOper) {
 646     const Value *G1Oper = GEP1Ops[FirstConstantOper];
 647     const Value *G2Oper = GEP2Ops[FirstConstantOper];
 648
 649     if (G1Oper != G2Oper)   // Found non-equal constant indexes...
 650       if (Constant *G1OC = dyn_cast<ConstantInt>(const_cast<Value*>(G1Oper)))
 651         if (Constant *G2OC = dyn_cast<ConstantInt>(const_cast<Value*>(G2Oper))){
 652           if (G1OC->getType() != G2OC->getType()) {
 653             // Sign extend both operands to long.
 654             if (G1OC->getType() != Type::Int64Ty)
 655               G1OC = ConstantExpr::getSExt(G1OC, Type::Int64Ty);
 656             if (G2OC->getType() != Type::Int64Ty)
 657               G2OC = ConstantExpr::getSExt(G2OC, Type::Int64Ty);
 658             GEP1Ops[FirstConstantOper] = G1OC;
 659             GEP2Ops[FirstConstantOper] = G2OC;
 660           }
 661
 662           if (G1OC != G2OC) {
 663             // Handle the "be careful" case above: if this is an array/vector
 664             // subscript, scan for a subsequent variable array index.
 665             if (isa<SequentialType>(BasePtr1Ty))  {
 666               const Type *NextTy =
 667                 cast<SequentialType>(BasePtr1Ty)->getElementType();
 668               bool isBadCase = false;
 669
 670               for (unsigned Idx = FirstConstantOper+1;
 671                    Idx != MinOperands && isa<SequentialType>(NextTy); ++Idx) {
 672                 const Value *V1 = GEP1Ops[Idx], *V2 = GEP2Ops[Idx];
 673                 if (!isa<Constant>(V1) || !isa<Constant>(V2)) {
 674                   isBadCase = true;
 675                   break;
 676                 }
 677                 NextTy = cast<SequentialType>(NextTy)->getElementType();
 678               }
 679
 680               if (isBadCase) G1OC = 0;
 681             }
 682
 683             // Make sure they are comparable (ie, not constant expressions), and
 684             // make sure the GEP with the smaller leading constant is GEP1.
 685             if (G1OC) {
 686               Constant *Compare = ConstantExpr::getICmp(ICmpInst::ICMP_SGT,
 687                                                         G1OC, G2OC);
 688               if (ConstantInt *CV = dyn_cast<ConstantInt>(Compare)) {
 689                 if (CV->getZExtValue()) {  // If they are comparable and G2 > G1
 690                   std::swap(GEP1Ops, GEP2Ops);  // Make GEP1 < GEP2
 691                   std::swap(NumGEP1Ops, NumGEP2Ops);
 692                 }
 693                 break;
 694               }
 695             }
 696           }
 697         }
 698     BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->getTypeAtIndex(G1Oper);
 699   }
 700
 701   // No shared constant operands, and we ran out of common operands.  At this
 702   // point, the GEP instructions have run through all of their operands, and we
 703   // haven't found evidence that there are any deltas between the GEP's.
 704   // However, one GEP may have more operands than the other.  If this is the
 705   // case, there may still be hope.  Check this now.
 706   if (FirstConstantOper == MinOperands) {
 707     // Make GEP1Ops be the longer one if there is a longer one.
 708     if (NumGEP1Ops < NumGEP2Ops) {
 709       std::swap(GEP1Ops, GEP2Ops);
 710       std::swap(NumGEP1Ops, NumGEP2Ops);
 711     }
 712
 713     // Is there anything to check?
 714     if (NumGEP1Ops > MinOperands) {
 715       for (unsigned i = FirstConstantOper; i != MaxOperands; ++i)
 716         if (isa<ConstantInt>(GEP1Ops[i]) &&
 717             !cast<ConstantInt>(GEP1Ops[i])->isZero()) {
 718           // Yup, there's a constant in the tail.  Set all variables to
 719           // constants in the GEP instruction to make it suitable for
 720           // TargetData::getIndexedOffset.
 721           for (i = 0; i != MaxOperands; ++i)
 722             if (!isa<ConstantInt>(GEP1Ops[i]))
 723               GEP1Ops[i] = Constant::getNullValue(GEP1Ops[i]->getType());
 724           // Okay, now get the offset.  This is the relative offset for the full
 725           // instruction.
 726           const TargetData &TD = getTargetData();
 727           int64_t Offset1 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
 728                                                 NumGEP1Ops);
 729
 730           // Now check without any constants at the end.
 731           int64_t Offset2 = TD.getIndexedOffset(GEPPointerTy, GEP1Ops,
 732                                                 MinOperands);
 733
 734           // Make sure we compare the absolute difference.
 735           if (Offset1 > Offset2)
 736             std::swap(Offset1, Offset2);
 737
 738           // If the tail provided a bit enough offset, return noalias!
 739           if ((uint64_t)(Offset2-Offset1) >= SizeMax)
 740             return NoAlias;
 741           // Otherwise break - we don't look for another constant in the tail.
 742           break;
 743         }
 744     }
 745
 746     // Couldn't find anything useful.
 747     return MayAlias;
 748   }
 749
 750   // If there are non-equal constants arguments, then we can figure
 751   // out a minimum known delta between the two index expressions... at
 752   // this point we know that the first constant index of GEP1 is less
 753   // than the first constant index of GEP2.
 754
 755   // Advance BasePtr[12]Ty over this first differing constant operand.
 756   BasePtr2Ty = cast<CompositeType>(BasePtr1Ty)->
 757       getTypeAtIndex(GEP2Ops[FirstConstantOper]);
 758   BasePtr1Ty = cast<CompositeType>(BasePtr1Ty)->
 759       getTypeAtIndex(GEP1Ops[FirstConstantOper]);
 760
 761   // We are going to be using TargetData::getIndexedOffset to determine the
 762   // offset that each of the GEP's is reaching.  To do this, we have to convert
 763   // all variable references to constant references.  To do this, we convert the
 764   // initial sequence of array subscripts into constant zeros to start with.
 765   const Type *ZeroIdxTy = GEPPointerTy;
 766   for (unsigned i = 0; i != FirstConstantOper; ++i) {
 767     if (!isa<StructType>(ZeroIdxTy))
 768       GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Type::Int32Ty);
 769
 770     if (const CompositeType *CT = dyn_cast<CompositeType>(ZeroIdxTy))
 771       ZeroIdxTy = CT->getTypeAtIndex(GEP1Ops[i]);
 772   }
 773
 774   // We know that GEP1Ops[FirstConstantOper] & GEP2Ops[FirstConstantOper] are ok
 775
 776   // Loop over the rest of the operands...
 777   for (unsigned i = FirstConstantOper+1; i != MaxOperands; ++i) {
 778     const Value *Op1 = i < NumGEP1Ops ? GEP1Ops[i] : 0;
 779     const Value *Op2 = i < NumGEP2Ops ? GEP2Ops[i] : 0;
 780     // If they are equal, use a zero index...
 781     if (Op1 == Op2 && BasePtr1Ty == BasePtr2Ty) {
 782       if (!isa<ConstantInt>(Op1))
 783         GEP1Ops[i] = GEP2Ops[i] = Constant::getNullValue(Op1->getType());
 784       // Otherwise, just keep the constants we have.
 785     } else {
 786       if (Op1) {
 787         if (const ConstantInt *Op1C = dyn_cast<ConstantInt>(Op1)) {
 788           // If this is an array index, make sure the array element is in range.
 789           if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty)) {
 790             if (Op1C->getZExtValue() >= AT->getNumElements())
 791               return MayAlias;  // Be conservative with out-of-range accesses
 792           } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty)) {
 793             if (Op1C->getZExtValue() >= VT->getNumElements())
 794               return MayAlias;  // Be conservative with out-of-range accesses
 795           }
 796
 797         } else {
 798           // GEP1 is known to produce a value less than GEP2.  To be
 799           // conservatively correct, we must assume the largest possible
 800           // constant is used in this position.  This cannot be the initial
 801           // index to the GEP instructions (because we know we have at least one
 802           // element before this one with the different constant arguments), so
 803           // we know that the current index must be into either a struct or
 804           // array.  Because we know it's not constant, this cannot be a
 805           // structure index.  Because of this, we can calculate the maximum
 806           // value possible.
 807           //
 808           if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr1Ty))
 809             GEP1Ops[i] = ConstantInt::get(Type::Int64Ty,AT->getNumElements()-1);
 810           else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr1Ty))
 811             GEP1Ops[i] = ConstantInt::get(Type::Int64Ty,VT->getNumElements()-1);
 812         }
 813       }
 814
 815       if (Op2) {
 816         if (const ConstantInt *Op2C = dyn_cast<ConstantInt>(Op2)) {
 817           // If this is an array index, make sure the array element is in range.
 818           if (const ArrayType *AT = dyn_cast<ArrayType>(BasePtr2Ty)) {
 819             if (Op2C->getZExtValue() >= AT->getNumElements())
 820               return MayAlias;  // Be conservative with out-of-range accesses
 821           } else if (const VectorType *VT = dyn_cast<VectorType>(BasePtr2Ty)) {
 822             if (Op2C->getZExtValue() >= VT->getNumElements())
 823               return MayAlias;  // Be conservative with out-of-range accesses
 824           }
 825         } else {  // Conservatively assume the minimum value for this index
 826           GEP2Ops[i] = Constant::getNullValue(Op2->getType());
 827         }
 828       }
 829     }
 830
 831     if (BasePtr1Ty && Op1) {
 832       if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr1Ty))
 833         BasePtr1Ty = CT->getTypeAtIndex(GEP1Ops[i]);
 834       else
 835         BasePtr1Ty = 0;
 836     }
 837
 838     if (BasePtr2Ty && Op2) {
 839       if (const CompositeType *CT = dyn_cast<CompositeType>(BasePtr2Ty))
 840         BasePtr2Ty = CT->getTypeAtIndex(GEP2Ops[i]);
 841       else
 842         BasePtr2Ty = 0;
 843     }
 844   }
 845
 846   if (GEPPointerTy->getElementType()->isSized()) {
 847     int64_t Offset1 =
 848       getTargetData().getIndexedOffset(GEPPointerTy, GEP1Ops, NumGEP1Ops);
 849     int64_t Offset2 =
 850       getTargetData().getIndexedOffset(GEPPointerTy, GEP2Ops, NumGEP2Ops);
 851     assert(Offset1 != Offset2 &&
 852            "There is at least one different constant here!");
 853
 854     // Make sure we compare the absolute difference.
 855     if (Offset1 > Offset2)
 856       std::swap(Offset1, Offset2);
 857
 858     if ((uint64_t)(Offset2-Offset1) >= SizeMax) {
 859       //cerr << "Determined that these two GEP's don't alias ["
 860       //     << SizeMax << " bytes]: \n" << *GEP1 << *GEP2;
 861       return NoAlias;
 862     }
 863   }
 864   return MayAlias;
 865 }
 866
 867 // Make sure that anything that uses AliasAnalysis pulls in this file...
 868 DEFINING_FILE_FOR(BasicAliasAnalysis)