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/Pass.h"
  29 #include "llvm/BasicBlock.h"
  30 #include "llvm/Function.h"
  31 #include "llvm/IntrinsicInst.h"
  32 #include "llvm/Instructions.h"
  33 #include "llvm/LLVMContext.h"
  34 #include "llvm/Type.h"
  35 #include "llvm/Target/TargetData.h"
  36 using namespace llvm;
  37
  38 // Register the AliasAnalysis interface, providing a nice name to refer to.
  39 INITIALIZE_ANALYSIS_GROUP(AliasAnalysis, "Alias Analysis", NoAA)
  40 char AliasAnalysis::ID = 0;
  41
  42 //===----------------------------------------------------------------------===//
  43 // Default chaining methods
  44 //===----------------------------------------------------------------------===//
  45
  46 AliasAnalysis::AliasResult
  47 AliasAnalysis::alias(const Location &LocA, const Location &LocB) {
  48   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  49   return AA->alias(LocA, LocB);
  50 }
  51
  52 bool AliasAnalysis::pointsToConstantMemory(const Location &Loc,
  53                                            bool OrLocal) {
  54   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  55   return AA->pointsToConstantMemory(Loc, OrLocal);
  56 }
  57
  58 void AliasAnalysis::deleteValue(Value *V) {
  59   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  60   AA->deleteValue(V);
  61 }
  62
  63 void AliasAnalysis::copyValue(Value *From, Value *To) {
  64   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  65   AA->copyValue(From, To);
  66 }
  67
  68 AliasAnalysis::ModRefResult
  69 AliasAnalysis::getModRefInfo(ImmutableCallSite CS,
  70                              const Location &Loc) {
  71   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  72
  73   ModRefBehavior MRB = getModRefBehavior(CS);
  74   if (MRB == DoesNotAccessMemory)
  75     return NoModRef;
  76
  77   ModRefResult Mask = ModRef;
  78   if (onlyReadsMemory(MRB))
  79     Mask = Ref;
  80
  81   if (MRB == AccessesArguments ||
  82       MRB == AccessesArgumentsReadonly) {
  83     bool doesAlias = false;
  84     for (ImmutableCallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
  85          AI != AE; ++AI)
  86       if (!isNoAlias(Location(*AI), Loc)) {
  87         doesAlias = true;
  88         break;
  89       }
  90
  91     if (!doesAlias)
  92       return NoModRef;
  93   }
  94
  95   // If Loc is a constant memory location, the call definitely could not
  96   // modify the memory location.
  97   if ((Mask & Mod) && pointsToConstantMemory(Loc))
  98     Mask = ModRefResult(Mask & ~Mod);
  99
 100   // If this is the end of the chain, don't forward.
 101   if (!AA) return Mask;
 102
 103   // Otherwise, fall back to the next AA in the chain. But we can merge
 104   // in any mask we've managed to compute.
 105   return ModRefResult(AA->getModRefInfo(CS, Loc) & Mask);
 106 }
 107
 108 AliasAnalysis::ModRefResult
 109 AliasAnalysis::getModRefInfo(ImmutableCallSite CS1, ImmutableCallSite CS2) {
 110   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
 111
 112   // If CS1 or CS2 are readnone, they don't interact.
 113   ModRefBehavior CS1B = getModRefBehavior(CS1);
 114   if (CS1B == DoesNotAccessMemory) return NoModRef;
 115
 116   ModRefBehavior CS2B = getModRefBehavior(CS2);
 117   if (CS2B == DoesNotAccessMemory) return NoModRef;
 118
 119   // If they both only read from memory, there is no dependence.
 120   if (onlyReadsMemory(CS1B) && onlyReadsMemory(CS2B))
 121     return NoModRef;
 122
 123   AliasAnalysis::ModRefResult Mask = ModRef;
 124
 125   // If CS1 only reads memory, the only dependence on CS2 can be
 126   // from CS1 reading memory written by CS2.
 127   if (onlyReadsMemory(CS1B))
 128     Mask = ModRefResult(Mask & Ref);
 129
 130   // If CS2 only access memory through arguments, accumulate the mod/ref
 131   // information from CS1's references to the memory referenced by
 132   // CS2's arguments.
 133   if (CS2B == AccessesArguments || CS2B == AccessesArgumentsReadonly) {
 134     AliasAnalysis::ModRefResult R = NoModRef;
 135     for (ImmutableCallSite::arg_iterator
 136          I = CS2.arg_begin(), E = CS2.arg_end(); I != E; ++I) {
 137       R = ModRefResult((R | getModRefInfo(CS1, *I, UnknownSize)) & Mask);
 138       if (R == Mask)
 139         break;
 140     }
 141     return R;
 142   }
 143
 144   // If CS1 only accesses memory through arguments, check if CS2 references
 145   // any of the memory referenced by CS1's arguments. If not, return NoModRef.
 146   if (CS1B == AccessesArguments || CS1B == AccessesArgumentsReadonly) {
 147     AliasAnalysis::ModRefResult R = NoModRef;
 148     for (ImmutableCallSite::arg_iterator
 149          I = CS1.arg_begin(), E = CS1.arg_end(); I != E; ++I)
 150       if (getModRefInfo(CS2, *I, UnknownSize) != NoModRef) {
 151         R = Mask;
 152         break;
 153       }
 154     if (R == NoModRef)
 155       return R;
 156   }
 157
 158   // If this is the end of the chain, don't forward.
 159   if (!AA) return Mask;
 160
 161   // Otherwise, fall back to the next AA in the chain. But we can merge
 162   // in any mask we've managed to compute.
 163   return ModRefResult(AA->getModRefInfo(CS1, CS2) & Mask);
 164 }
 165
 166 AliasAnalysis::ModRefBehavior
 167 AliasAnalysis::getModRefBehavior(ImmutableCallSite CS) {
 168   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
 169
 170   ModRefBehavior Min = UnknownModRefBehavior;
 171
 172   // Call back into the alias analysis with the other form of getModRefBehavior
 173   // to see if it can give a better response.
 174   if (const Function *F = CS.getCalledFunction())
 175     Min = getModRefBehavior(F);
 176
 177   // If this is the end of the chain, don't forward.
 178   if (!AA) return Min;
 179
 180   // Otherwise, fall back to the next AA in the chain. But we can merge
 181   // in any result we've managed to compute.
 182   return std::min(AA->getModRefBehavior(CS), Min);
 183 }
 184
 185 AliasAnalysis::ModRefBehavior
 186 AliasAnalysis::getModRefBehavior(const Function *F) {
 187   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
 188   return AA->getModRefBehavior(F);
 189 }
 190
 191 //===----------------------------------------------------------------------===//
 192 // AliasAnalysis non-virtual helper method implementation
 193 //===----------------------------------------------------------------------===//
 194
 195 AliasAnalysis::ModRefResult
 196 AliasAnalysis::getModRefInfo(const LoadInst *L, const Location &Loc) {
 197   // Be conservative in the face of volatile.
 198   if (L->isVolatile())
 199     return ModRef;
 200
 201   // If the load address doesn't alias the given address, it doesn't read
 202   // or write the specified memory.
 203   if (!alias(Location(L->getOperand(0),
 204                       getTypeStoreSize(L->getType()),
 205                       L->getMetadata(LLVMContext::MD_tbaa)),
 206              Loc))
 207     return NoModRef;
 208
 209   // Otherwise, a load just reads.
 210   return Ref;
 211 }
 212
 213 AliasAnalysis::ModRefResult
 214 AliasAnalysis::getModRefInfo(const StoreInst *S, const Location &Loc) {
 215   // Be conservative in the face of volatile.
 216   if (S->isVolatile())
 217     return ModRef;
 218
 219   // If the store address cannot alias the pointer in question, then the
 220   // specified memory cannot be modified by the store.
 221   if (!alias(Location(S->getOperand(1),
 222                       getTypeStoreSize(S->getOperand(0)->getType()),
 223                       S->getMetadata(LLVMContext::MD_tbaa)),
 224              Loc))
 225     return NoModRef;
 226
 227   // If the pointer is a pointer to constant memory, then it could not have been
 228   // modified by this store.
 229   if (pointsToConstantMemory(Loc))
 230     return NoModRef;
 231
 232   // Otherwise, a store just writes.
 233   return Mod;
 234 }
 235
 236 AliasAnalysis::ModRefResult
 237 AliasAnalysis::getModRefInfo(const VAArgInst *V, const Location &Loc) {
 238   // If the va_arg address cannot alias the pointer in question, then the
 239   // specified memory cannot be accessed by the va_arg.
 240   if (!alias(Location(V->getOperand(0),
 241                       UnknownSize,
 242                       V->getMetadata(LLVMContext::MD_tbaa)),
 243              Loc))
 244     return NoModRef;
 245
 246   // If the pointer is a pointer to constant memory, then it could not have been
 247   // modified by this va_arg.
 248   if (pointsToConstantMemory(Loc))
 249     return NoModRef;
 250
 251   // Otherwise, a va_arg reads and writes.
 252   return ModRef;
 253 }
 254
 255 // AliasAnalysis destructor: DO NOT move this to the header file for
 256 // AliasAnalysis or else clients of the AliasAnalysis class may not depend on
 257 // the AliasAnalysis.o file in the current .a file, causing alias analysis
 258 // support to not be included in the tool correctly!
 259 //
 260 AliasAnalysis::~AliasAnalysis() {}
 261
 262 /// InitializeAliasAnalysis - Subclasses must call this method to initialize the
 263 /// AliasAnalysis interface before any other methods are called.
 264 ///
 265 void AliasAnalysis::InitializeAliasAnalysis(Pass *P) {
 266   TD = P->getAnalysisIfAvailable<TargetData>();
 267   AA = &P->getAnalysis<AliasAnalysis>();
 268 }
 269
 270 // getAnalysisUsage - All alias analysis implementations should invoke this
 271 // directly (using AliasAnalysis::getAnalysisUsage(AU)).
 272 void AliasAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
 273   AU.addRequired<AliasAnalysis>();         // All AA's chain
 274 }
 275
 276 /// getTypeStoreSize - Return the TargetData store size for the given type,
 277 /// if known, or a conservative value otherwise.
 278 ///
 279 uint64_t AliasAnalysis::getTypeStoreSize(const Type *Ty) {
 280   return TD ? TD->getTypeStoreSize(Ty) : UnknownSize;
 281 }
 282
 283 /// canBasicBlockModify - Return true if it is possible for execution of the
 284 /// specified basic block to modify the value pointed to by Ptr.
 285 ///
 286 bool AliasAnalysis::canBasicBlockModify(const BasicBlock &BB,
 287                                         const Location &Loc) {
 288   return canInstructionRangeModify(BB.front(), BB.back(), Loc);
 289 }
 290
 291 /// canInstructionRangeModify - Return true if it is possible for the execution
 292 /// of the specified instructions to modify the value pointed to by Ptr.  The
 293 /// instructions to consider are all of the instructions in the range of [I1,I2]
 294 /// INCLUSIVE.  I1 and I2 must be in the same basic block.
 295 ///
 296 bool AliasAnalysis::canInstructionRangeModify(const Instruction &I1,
 297                                               const Instruction &I2,
 298                                               const Location &Loc) {
 299   assert(I1.getParent() == I2.getParent() &&
 300          "Instructions not in same basic block!");
 301   BasicBlock::const_iterator I = &I1;
 302   BasicBlock::const_iterator E = &I2;
 303   ++E;  // Convert from inclusive to exclusive range.
 304
 305   for (; I != E; ++I) // Check every instruction in range
 306     if (getModRefInfo(I, Loc) & Mod)
 307       return true;
 308   return false;
 309 }
 310
 311 /// isNoAliasCall - Return true if this pointer is returned by a noalias
 312 /// function.
 313 bool llvm::isNoAliasCall(const Value *V) {
 314   if (isa<CallInst>(V) || isa<InvokeInst>(V))
 315     return ImmutableCallSite(cast<Instruction>(V))
 316       .paramHasAttr(0, Attribute::NoAlias);
 317   return false;
 318 }
 319
 320 /// isIdentifiedObject - Return true if this pointer refers to a distinct and
 321 /// identifiable object.  This returns true for:
 322 ///    Global Variables and Functions (but not Global Aliases)
 323 ///    Allocas and Mallocs
 324 ///    ByVal and NoAlias Arguments
 325 ///    NoAlias returns
 326 ///
 327 bool llvm::isIdentifiedObject(const Value *V) {
 328   if (isa<AllocaInst>(V))
 329     return true;
 330   if (isa<GlobalValue>(V) && !isa<GlobalAlias>(V))
 331     return true;
 332   if (isNoAliasCall(V))
 333     return true;
 334   if (const Argument *A = dyn_cast<Argument>(V))
 335     return A->hasNoAliasAttr() || A->hasByValAttr();
 336   return false;
 337 }