lib/Analysis/AliasAnalysis.cpp

   1 //===- AliasAnalysis.cpp - Generic Alias Analysis Interface Implementation -==//
   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 implements the generic AliasAnalysis interface which is used as the
  11 // common interface used by all clients and implementations of alias analysis.
  12 //
  13 // This file also implements the default version of the AliasAnalysis interface
  14 // that is to be used when no other implementation is specified.  This does some
  15 // simple tests that detect obvious cases: two different global pointers cannot
  16 // alias, a global cannot alias a malloc, two different mallocs cannot alias,
  17 // etc.
  18 //
  19 // This alias analysis implementation really isn't very good for anything, but
  20 // it is very fast, and makes a nice clean default implementation.  Because it
  21 // handles lots of little corner cases, other, more complex, alias analysis
  22 // implementations may choose to rely on this pass to resolve these simple and
  23 // easy cases.
  24 //
  25 //===----------------------------------------------------------------------===//
  26
  27 #include "llvm/Analysis/AliasAnalysis.h"
  28 #include "llvm/Analysis/CFG.h"
  29 #include "llvm/Analysis/CaptureTracking.h"
  30 #include "llvm/Analysis/ValueTracking.h"
  31 #include "llvm/IR/BasicBlock.h"
  32 #include "llvm/IR/DataLayout.h"
  33 #include "llvm/IR/Dominators.h"
  34 #include "llvm/IR/Function.h"
  35 #include "llvm/IR/Instructions.h"
  36 #include "llvm/IR/IntrinsicInst.h"
  37 #include "llvm/IR/LLVMContext.h"
  38 #include "llvm/IR/Type.h"
  39 #include "llvm/Pass.h"
  40 #include "llvm/Target/TargetLibraryInfo.h"
  41 using namespace llvm;
  42
  43 // Register the AliasAnalysis interface, providing a nice name to refer to.
  44 INITIALIZE_ANALYSIS_GROUP(AliasAnalysis, "Alias Analysis", NoAA)
  45 char AliasAnalysis::ID = 0;
  46
  47 //===----------------------------------------------------------------------===//
  48 // Default chaining methods
  49 //===----------------------------------------------------------------------===//
  50
  51 AliasAnalysis::AliasResult
  52 AliasAnalysis::alias(const Location &LocA, const Location &LocB) {
  53   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  54   return AA->alias(LocA, LocB);
  55 }
  56
  57 bool AliasAnalysis::pointsToConstantMemory(const Location &Loc,
  58                                            bool OrLocal) {
  59   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  60   return AA->pointsToConstantMemory(Loc, OrLocal);
  61 }
  62
  63 AliasAnalysis::Location
  64 AliasAnalysis::getArgLocation(ImmutableCallSite CS, unsigned ArgIdx,
  65                               AliasAnalysis::ModRefResult &Mask) {
  66   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  67   return AA->getArgLocation(CS, ArgIdx, Mask);
  68 }
  69
  70 void AliasAnalysis::deleteValue(Value *V) {
  71   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  72   AA->deleteValue(V);
  73 }
  74
  75 void AliasAnalysis::copyValue(Value *From, Value *To) {
  76   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  77   AA->copyValue(From, To);
  78 }
  79
  80 void AliasAnalysis::addEscapingUse(Use &U) {
  81   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  82   AA->addEscapingUse(U);
  83 }
  84
  85
  86 AliasAnalysis::ModRefResult
  87 AliasAnalysis::getModRefInfo(ImmutableCallSite CS,
  88                              const Location &Loc) {
  89   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  90
  91   ModRefBehavior MRB = getModRefBehavior(CS);
  92   if (MRB == DoesNotAccessMemory)
  93     return NoModRef;
  94
  95   ModRefResult Mask = ModRef;
  96   if (onlyReadsMemory(MRB))
  97     Mask = Ref;
  98
  99   if (onlyAccessesArgPointees(MRB)) {
 100     bool doesAlias = false;
 101     ModRefResult AllArgsMask = NoModRef;
 102     if (doesAccessArgPointees(MRB)) {
 103       for (ImmutableCallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
 104            AI != AE; ++AI) {
 105         const Value *Arg = *AI;
 106         if (!Arg->getType()->isPointerTy())
 107           continue;
 108         ModRefResult ArgMask;
 109         Location CSLoc =
 110           getArgLocation(CS, (unsigned) std::distance(CS.arg_begin(), AI),
 111                          ArgMask);
 112         if (!isNoAlias(CSLoc, Loc)) {
 113           doesAlias = true;
 114           AllArgsMask = ModRefResult(AllArgsMask | ArgMask);
 115         }
 116       }
 117     }
 118     if (!doesAlias)
 119       return NoModRef;
 120     Mask = ModRefResult(Mask & AllArgsMask);
 121   }
 122
 123   // If Loc is a constant memory location, the call definitely could not
 124   // modify the memory location.
 125   if ((Mask & Mod) && pointsToConstantMemory(Loc))
 126     Mask = ModRefResult(Mask & ~Mod);
 127
 128   // If this is the end of the chain, don't forward.
 129   if (!AA) return Mask;
 130
 131   // Otherwise, fall back to the next AA in the chain. But we can merge
 132   // in any mask we've managed to compute.
 133   return ModRefResult(AA->getModRefInfo(CS, Loc) & Mask);
 134 }
 135
 136 AliasAnalysis::ModRefResult
 137 AliasAnalysis::getModRefInfo(ImmutableCallSite CS1, ImmutableCallSite CS2) {
 138   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
 139
 140   // If CS1 or CS2 are readnone, they don't interact.
 141   ModRefBehavior CS1B = getModRefBehavior(CS1);
 142   if (CS1B == DoesNotAccessMemory) return NoModRef;
 143
 144   ModRefBehavior CS2B = getModRefBehavior(CS2);
 145   if (CS2B == DoesNotAccessMemory) return NoModRef;
 146
 147   // If they both only read from memory, there is no dependence.
 148   if (onlyReadsMemory(CS1B) && onlyReadsMemory(CS2B))
 149     return NoModRef;
 150
 151   AliasAnalysis::ModRefResult Mask = ModRef;
 152
 153   // If CS1 only reads memory, the only dependence on CS2 can be
 154   // from CS1 reading memory written by CS2.
 155   if (onlyReadsMemory(CS1B))
 156     Mask = ModRefResult(Mask & Ref);
 157
 158   // If CS2 only access memory through arguments, accumulate the mod/ref
 159   // information from CS1's references to the memory referenced by
 160   // CS2's arguments.
 161   if (onlyAccessesArgPointees(CS2B)) {
 162     AliasAnalysis::ModRefResult R = NoModRef;
 163     if (doesAccessArgPointees(CS2B)) {
 164       for (ImmutableCallSite::arg_iterator
 165            I = CS2.arg_begin(), E = CS2.arg_end(); I != E; ++I) {
 166         const Value *Arg = *I;
 167         if (!Arg->getType()->isPointerTy())
 168           continue;
 169         ModRefResult ArgMask;
 170         Location CS2Loc =
 171           getArgLocation(CS2, (unsigned) std::distance(CS2.arg_begin(), I),
 172                          ArgMask);
 173         // ArgMask indicates what CS2 might do to CS2Loc, and the dependence of
 174         // CS1 on that location is the inverse.
 175         if (ArgMask == Mod)
 176           ArgMask = ModRef;
 177         else if (ArgMask == Ref)
 178           ArgMask = Mod;
 179
 180         R = ModRefResult((R | (getModRefInfo(CS1, CS2Loc) & ArgMask)) & Mask);
 181         if (R == Mask)
 182           break;
 183       }
 184     }
 185     return R;
 186   }
 187
 188   // If CS1 only accesses memory through arguments, check if CS2 references
 189   // any of the memory referenced by CS1's arguments. If not, return NoModRef.
 190   if (onlyAccessesArgPointees(CS1B)) {
 191     AliasAnalysis::ModRefResult R = NoModRef;
 192     if (doesAccessArgPointees(CS1B)) {
 193       for (ImmutableCallSite::arg_iterator
 194            I = CS1.arg_begin(), E = CS1.arg_end(); I != E; ++I) {
 195         const Value *Arg = *I;
 196         if (!Arg->getType()->isPointerTy())
 197           continue;
 198         ModRefResult ArgMask;
 199         Location CS1Loc =
 200           getArgLocation(CS1, (unsigned) std::distance(CS1.arg_begin(), I),
 201                          ArgMask);
 202         // ArgMask indicates what CS1 might do to CS1Loc; if CS1 might Mod
 203         // CS1Loc, then we care about either a Mod or a Ref by CS2. If CS1
 204         // might Ref, then we care only about a Mod by CS2.
 205         ModRefResult ArgR = getModRefInfo(CS2, CS1Loc);
 206         if (((ArgMask & Mod) != NoModRef && (ArgR & ModRef) != NoModRef) ||
 207             ((ArgMask & Ref) != NoModRef && (ArgR & Mod)    != NoModRef))
 208           R = ModRefResult((R | ArgMask) & Mask);
 209
 210         if (R == Mask)
 211           break;
 212       }
 213     }
 214     return R;
 215   }
 216
 217   // If this is the end of the chain, don't forward.
 218   if (!AA) return Mask;
 219
 220   // Otherwise, fall back to the next AA in the chain. But we can merge
 221   // in any mask we've managed to compute.
 222   return ModRefResult(AA->getModRefInfo(CS1, CS2) & Mask);
 223 }
 224
 225 AliasAnalysis::ModRefBehavior
 226 AliasAnalysis::getModRefBehavior(ImmutableCallSite CS) {
 227   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
 228
 229   ModRefBehavior Min = UnknownModRefBehavior;
 230
 231   // Call back into the alias analysis with the other form of getModRefBehavior
 232   // to see if it can give a better response.
 233   if (const Function *F = CS.getCalledFunction())
 234     Min = getModRefBehavior(F);
 235
 236   // If this is the end of the chain, don't forward.
 237   if (!AA) return Min;
 238
 239   // Otherwise, fall back to the next AA in the chain. But we can merge
 240   // in any result we've managed to compute.
 241   return ModRefBehavior(AA->getModRefBehavior(CS) & Min);
 242 }
 243
 244 AliasAnalysis::ModRefBehavior
 245 AliasAnalysis::getModRefBehavior(const Function *F) {
 246   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
 247   return AA->getModRefBehavior(F);
 248 }
 249
 250 //===----------------------------------------------------------------------===//
 251 // AliasAnalysis non-virtual helper method implementation
 252 //===----------------------------------------------------------------------===//
 253
 254 AliasAnalysis::Location AliasAnalysis::getLocation(const LoadInst *LI) {
 255   AAMDNodes AATags;
 256   LI->getAAMetadata(AATags);
 257
 258   return Location(LI->getPointerOperand(),
 259                   getTypeStoreSize(LI->getType()), AATags);
 260 }
 261
 262 AliasAnalysis::Location AliasAnalysis::getLocation(const StoreInst *SI) {
 263   AAMDNodes AATags;
 264   SI->getAAMetadata(AATags);
 265
 266   return Location(SI->getPointerOperand(),
 267                   getTypeStoreSize(SI->getValueOperand()->getType()), AATags);
 268 }
 269
 270 AliasAnalysis::Location AliasAnalysis::getLocation(const VAArgInst *VI) {
 271   AAMDNodes AATags;
 272   VI->getAAMetadata(AATags);
 273
 274   return Location(VI->getPointerOperand(), UnknownSize, AATags);
 275 }
 276
 277 AliasAnalysis::Location
 278 AliasAnalysis::getLocation(const AtomicCmpXchgInst *CXI) {
 279   AAMDNodes AATags;
 280   CXI->getAAMetadata(AATags);
 281
 282   return Location(CXI->getPointerOperand(),
 283                   getTypeStoreSize(CXI->getCompareOperand()->getType()),
 284                   AATags);
 285 }
 286
 287 AliasAnalysis::Location
 288 AliasAnalysis::getLocation(const AtomicRMWInst *RMWI) {
 289   AAMDNodes AATags;
 290   RMWI->getAAMetadata(AATags);
 291
 292   return Location(RMWI->getPointerOperand(),
 293                   getTypeStoreSize(RMWI->getValOperand()->getType()), AATags);
 294 }
 295
 296 AliasAnalysis::Location
 297 AliasAnalysis::getLocationForSource(const MemTransferInst *MTI) {
 298   uint64_t Size = UnknownSize;
 299   if (ConstantInt *C = dyn_cast<ConstantInt>(MTI->getLength()))
 300     Size = C->getValue().getZExtValue();
 301
 302   // memcpy/memmove can have AA tags. For memcpy, they apply
 303   // to both the source and the destination.
 304   AAMDNodes AATags;
 305   MTI->getAAMetadata(AATags);
 306
 307   return Location(MTI->getRawSource(), Size, AATags);
 308 }
 309
 310 AliasAnalysis::Location
 311 AliasAnalysis::getLocationForDest(const MemIntrinsic *MTI) {
 312   uint64_t Size = UnknownSize;
 313   if (ConstantInt *C = dyn_cast<ConstantInt>(MTI->getLength()))
 314     Size = C->getValue().getZExtValue();
 315
 316   // memcpy/memmove can have AA tags. For memcpy, they apply
 317   // to both the source and the destination.
 318   AAMDNodes AATags;
 319   MTI->getAAMetadata(AATags);
 320
 321   return Location(MTI->getRawDest(), Size, AATags);
 322 }
 323
 324
 325
 326 AliasAnalysis::ModRefResult
 327 AliasAnalysis::getModRefInfo(const LoadInst *L, const Location &Loc) {
 328   // Be conservative in the face of volatile/atomic.
 329   if (!L->isUnordered())
 330     return ModRef;
 331
 332   // If the load address doesn't alias the given address, it doesn't read
 333   // or write the specified memory.
 334   if (!alias(getLocation(L), Loc))
 335     return NoModRef;
 336
 337   // Otherwise, a load just reads.
 338   return Ref;
 339 }
 340
 341 AliasAnalysis::ModRefResult
 342 AliasAnalysis::getModRefInfo(const StoreInst *S, const Location &Loc) {
 343   // Be conservative in the face of volatile/atomic.
 344   if (!S->isUnordered())
 345     return ModRef;
 346
 347   // If the store address cannot alias the pointer in question, then the
 348   // specified memory cannot be modified by the store.
 349   if (!alias(getLocation(S), Loc))
 350     return NoModRef;
 351
 352   // If the pointer is a pointer to constant memory, then it could not have been
 353   // modified by this store.
 354   if (pointsToConstantMemory(Loc))
 355     return NoModRef;
 356
 357   // Otherwise, a store just writes.
 358   return Mod;
 359 }
 360
 361 AliasAnalysis::ModRefResult
 362 AliasAnalysis::getModRefInfo(const VAArgInst *V, const Location &Loc) {
 363   // If the va_arg address cannot alias the pointer in question, then the
 364   // specified memory cannot be accessed by the va_arg.
 365   if (!alias(getLocation(V), Loc))
 366     return NoModRef;
 367
 368   // If the pointer is a pointer to constant memory, then it could not have been
 369   // modified by this va_arg.
 370   if (pointsToConstantMemory(Loc))
 371     return NoModRef;
 372
 373   // Otherwise, a va_arg reads and writes.
 374   return ModRef;
 375 }
 376
 377 AliasAnalysis::ModRefResult
 378 AliasAnalysis::getModRefInfo(const AtomicCmpXchgInst *CX, const Location &Loc) {
 379   // Acquire/Release cmpxchg has properties that matter for arbitrary addresses.
 380   if (CX->getSuccessOrdering() > Monotonic)
 381     return ModRef;
 382
 383   // If the cmpxchg address does not alias the location, it does not access it.
 384   if (!alias(getLocation(CX), Loc))
 385     return NoModRef;
 386
 387   return ModRef;
 388 }
 389
 390 AliasAnalysis::ModRefResult
 391 AliasAnalysis::getModRefInfo(const AtomicRMWInst *RMW, const Location &Loc) {
 392   // Acquire/Release atomicrmw has properties that matter for arbitrary addresses.
 393   if (RMW->getOrdering() > Monotonic)
 394     return ModRef;
 395
 396   // If the atomicrmw address does not alias the location, it does not access it.
 397   if (!alias(getLocation(RMW), Loc))
 398     return NoModRef;
 399
 400   return ModRef;
 401 }
 402
 403 // FIXME: this is really just shoring-up a deficiency in alias analysis.
 404 // BasicAA isn't willing to spend linear time determining whether an alloca
 405 // was captured before or after this particular call, while we are. However,
 406 // with a smarter AA in place, this test is just wasting compile time.
 407 AliasAnalysis::ModRefResult
 408 AliasAnalysis::callCapturesBefore(const Instruction *I,
 409                                   const AliasAnalysis::Location &MemLoc,
 410                                   DominatorTree *DT) {
 411   if (!DT || !DL) return AliasAnalysis::ModRef;
 412
 413   const Value *Object = GetUnderlyingObject(MemLoc.Ptr, DL);
 414   if (!isIdentifiedObject(Object) || isa<GlobalValue>(Object) ||
 415       isa<Constant>(Object))
 416     return AliasAnalysis::ModRef;
 417
 418   ImmutableCallSite CS(I);
 419   if (!CS.getInstruction() || CS.getInstruction() == Object)
 420     return AliasAnalysis::ModRef;
 421
 422   if (llvm::PointerMayBeCapturedBefore(Object, /* ReturnCaptures */ true,
 423                                        /* StoreCaptures */ true, I, DT,
 424                                        /* include Object */ true))
 425     return AliasAnalysis::ModRef;
 426
 427   unsigned ArgNo = 0;
 428   AliasAnalysis::ModRefResult R = AliasAnalysis::NoModRef;
 429   for (ImmutableCallSite::arg_iterator CI = CS.arg_begin(), CE = CS.arg_end();
 430        CI != CE; ++CI, ++ArgNo) {
 431     // Only look at the no-capture or byval pointer arguments.  If this
 432     // pointer were passed to arguments that were neither of these, then it
 433     // couldn't be no-capture.
 434     if (!(*CI)->getType()->isPointerTy() ||
 435         (!CS.doesNotCapture(ArgNo) && !CS.isByValArgument(ArgNo)))
 436       continue;
 437
 438     // If this is a no-capture pointer argument, see if we can tell that it
 439     // is impossible to alias the pointer we're checking.  If not, we have to
 440     // assume that the call could touch the pointer, even though it doesn't
 441     // escape.
 442     if (isNoAlias(AliasAnalysis::Location(*CI),
 443                   AliasAnalysis::Location(Object)))
 444       continue;
 445     if (CS.doesNotAccessMemory(ArgNo))
 446       continue;
 447     if (CS.onlyReadsMemory(ArgNo)) {
 448       R = AliasAnalysis::Ref;
 449       continue;
 450     }
 451     return AliasAnalysis::ModRef;
 452   }
 453   return R;
 454 }
 455
 456 // AliasAnalysis destructor: DO NOT move this to the header file for
 457 // AliasAnalysis or else clients of the AliasAnalysis class may not depend on
 458 // the AliasAnalysis.o file in the current .a file, causing alias analysis
 459 // support to not be included in the tool correctly!
 460 //
 461 AliasAnalysis::~AliasAnalysis() {}
 462
 463 /// InitializeAliasAnalysis - Subclasses must call this method to initialize the
 464 /// AliasAnalysis interface before any other methods are called.
 465 ///
 466 void AliasAnalysis::InitializeAliasAnalysis(Pass *P) {
 467   DataLayoutPass *DLP = P->getAnalysisIfAvailable<DataLayoutPass>();
 468   DL = DLP ? &DLP->getDataLayout() : nullptr;
 469   TLI = P->getAnalysisIfAvailable<TargetLibraryInfo>();
 470   AA = &P->getAnalysis<AliasAnalysis>();
 471 }
 472
 473 // getAnalysisUsage - All alias analysis implementations should invoke this
 474 // directly (using AliasAnalysis::getAnalysisUsage(AU)).
 475 void AliasAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
 476   AU.addRequired<AliasAnalysis>();         // All AA's chain
 477 }
 478
 479 /// getTypeStoreSize - Return the DataLayout store size for the given type,
 480 /// if known, or a conservative value otherwise.
 481 ///
 482 uint64_t AliasAnalysis::getTypeStoreSize(Type *Ty) {
 483   return DL ? DL->getTypeStoreSize(Ty) : UnknownSize;
 484 }
 485
 486 /// canBasicBlockModify - Return true if it is possible for execution of the
 487 /// specified basic block to modify the value pointed to by Ptr.
 488 ///
 489 bool AliasAnalysis::canBasicBlockModify(const BasicBlock &BB,
 490                                         const Location &Loc) {
 491   return canInstructionRangeModify(BB.front(), BB.back(), Loc);
 492 }
 493
 494 /// canInstructionRangeModify - Return true if it is possible for the execution
 495 /// of the specified instructions to modify the value pointed to by Ptr.  The
 496 /// instructions to consider are all of the instructions in the range of [I1,I2]
 497 /// INCLUSIVE.  I1 and I2 must be in the same basic block.
 498 ///
 499 bool AliasAnalysis::canInstructionRangeModify(const Instruction &I1,
 500                                               const Instruction &I2,
 501                                               const Location &Loc) {
 502   assert(I1.getParent() == I2.getParent() &&
 503          "Instructions not in same basic block!");
 504   BasicBlock::const_iterator I = &I1;
 505   BasicBlock::const_iterator E = &I2;
 506   ++E;  // Convert from inclusive to exclusive range.
 507
 508   for (; I != E; ++I) // Check every instruction in range
 509     if (getModRefInfo(I, Loc) & Mod)
 510       return true;
 511   return false;
 512 }
 513
 514 /// isNoAliasCall - Return true if this pointer is returned by a noalias
 515 /// function.
 516 bool llvm::isNoAliasCall(const Value *V) {
 517   if (isa<CallInst>(V) || isa<InvokeInst>(V))
 518     return ImmutableCallSite(cast<Instruction>(V))
 519       .paramHasAttr(0, Attribute::NoAlias);
 520   return false;
 521 }
 522
 523 /// isNoAliasArgument - Return true if this is an argument with the noalias
 524 /// attribute.
 525 bool llvm::isNoAliasArgument(const Value *V)
 526 {
 527   if (const Argument *A = dyn_cast<Argument>(V))
 528     return A->hasNoAliasAttr();
 529   return false;
 530 }
 531
 532 /// isIdentifiedObject - Return true if this pointer refers to a distinct and
 533 /// identifiable object.  This returns true for:
 534 ///    Global Variables and Functions (but not Global Aliases)
 535 ///    Allocas and Mallocs
 536 ///    ByVal and NoAlias Arguments
 537 ///    NoAlias returns
 538 ///
 539 bool llvm::isIdentifiedObject(const Value *V) {
 540   if (isa<AllocaInst>(V))
 541     return true;
 542   if (isa<GlobalValue>(V) && !isa<GlobalAlias>(V))
 543     return true;
 544   if (isNoAliasCall(V))
 545     return true;
 546   if (const Argument *A = dyn_cast<Argument>(V))
 547     return A->hasNoAliasAttr() || A->hasByValAttr();
 548   return false;
 549 }
 550
 551 /// isIdentifiedFunctionLocal - Return true if V is umabigously identified
 552 /// at the function-level. Different IdentifiedFunctionLocals can't alias.
 553 /// Further, an IdentifiedFunctionLocal can not alias with any function
 554 /// arguments other than itself, which is not necessarily true for
 555 /// IdentifiedObjects.
 556 bool llvm::isIdentifiedFunctionLocal(const Value *V)
 557 {
 558   return isa<AllocaInst>(V) || isNoAliasCall(V) || isNoAliasArgument(V);
 559 }
 560