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/Type.h"
  34 #include "llvm/Target/TargetData.h"
  35 using namespace llvm;
  36
  37 // Register the AliasAnalysis interface, providing a nice name to refer to.
  38 static RegisterAnalysisGroup<AliasAnalysis> Z("Alias Analysis");
  39 char AliasAnalysis::ID = 0;
  40
  41 //===----------------------------------------------------------------------===//
  42 // Default chaining methods
  43 //===----------------------------------------------------------------------===//
  44
  45 AliasAnalysis::AliasResult
  46 AliasAnalysis::alias(const Value *V1, unsigned V1Size,
  47                      const Value *V2, unsigned V2Size) {
  48   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  49   return AA->alias(V1, V1Size, V2, V2Size);
  50 }
  51
  52 bool AliasAnalysis::pointsToConstantMemory(const Value *P) {
  53   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  54   return AA->pointsToConstantMemory(P);
  55 }
  56
  57 void AliasAnalysis::deleteValue(Value *V) {
  58   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  59   AA->deleteValue(V);
  60 }
  61
  62 void AliasAnalysis::copyValue(Value *From, Value *To) {
  63   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  64   AA->copyValue(From, To);
  65 }
  66
  67 AliasAnalysis::ModRefResult
  68 AliasAnalysis::getModRefInfo(ImmutableCallSite CS1, ImmutableCallSite CS2) {
  69   // FIXME: we can do better.
  70   assert(AA && "AA didn't call InitializeAliasAnalysis in its run method!");
  71   return AA->getModRefInfo(CS1, CS2);
  72 }
  73
  74
  75 //===----------------------------------------------------------------------===//
  76 // AliasAnalysis non-virtual helper method implementation
  77 //===----------------------------------------------------------------------===//
  78
  79 AliasAnalysis::ModRefResult
  80 AliasAnalysis::getModRefInfo(const LoadInst *L, const Value *P, unsigned Size) {
  81   // If the load address doesn't alias the given address, it doesn't read
  82   // or write the specified memory.
  83   if (!alias(L->getOperand(0), getTypeStoreSize(L->getType()), P, Size))
  84     return NoModRef;
  85
  86   // Be conservative in the face of volatile.
  87   if (L->isVolatile())
  88     return ModRef;
  89
  90   // Otherwise, a load just reads.
  91   return Ref;
  92 }
  93
  94 AliasAnalysis::ModRefResult
  95 AliasAnalysis::getModRefInfo(const StoreInst *S, const Value *P, unsigned Size) {
  96   // If the stored address cannot alias the pointer in question, then the
  97   // pointer cannot be modified by the store.
  98   if (!alias(S->getOperand(1),
  99              getTypeStoreSize(S->getOperand(0)->getType()), P, Size))
 100     return NoModRef;
 101
 102   // Be conservative in the face of volatile.
 103   if (S->isVolatile())
 104     return ModRef;
 105
 106   // If the pointer is a pointer to constant memory, then it could not have been
 107   // modified by this store.
 108   if (pointsToConstantMemory(P))
 109     return NoModRef;
 110
 111   // Otherwise, a store just writes.
 112   return Mod;
 113 }
 114
 115 AliasAnalysis::ModRefBehavior
 116 AliasAnalysis::getModRefBehavior(ImmutableCallSite CS,
 117                                  std::vector<PointerAccessInfo> *Info) {
 118   if (CS.doesNotAccessMemory())
 119     // Can't do better than this.
 120     return DoesNotAccessMemory;
 121   ModRefBehavior MRB = getModRefBehavior(CS.getCalledFunction(), Info);
 122   if (MRB != DoesNotAccessMemory && CS.onlyReadsMemory())
 123     return OnlyReadsMemory;
 124   return MRB;
 125 }
 126
 127 AliasAnalysis::ModRefBehavior
 128 AliasAnalysis::getModRefBehavior(const Function *F,
 129                                  std::vector<PointerAccessInfo> *Info) {
 130   if (F) {
 131     if (F->doesNotAccessMemory())
 132       // Can't do better than this.
 133       return DoesNotAccessMemory;
 134     if (F->onlyReadsMemory())
 135       return OnlyReadsMemory;
 136     if (unsigned id = F->getIntrinsicID())
 137       return getIntrinsicModRefBehavior(id);
 138   }
 139   return UnknownModRefBehavior;
 140 }
 141
 142 AliasAnalysis::ModRefBehavior
 143 AliasAnalysis::getIntrinsicModRefBehavior(unsigned iid) {
 144 #define GET_INTRINSIC_MODREF_BEHAVIOR
 145 #include "llvm/Intrinsics.gen"
 146 #undef GET_INTRINSIC_MODREF_BEHAVIOR
 147 }
 148
 149 AliasAnalysis::ModRefResult
 150 AliasAnalysis::getModRefInfo(ImmutableCallSite CS,
 151                              const Value *P, unsigned Size) {
 152   ModRefBehavior MRB = getModRefBehavior(CS);
 153   if (MRB == DoesNotAccessMemory)
 154     return NoModRef;
 155
 156   ModRefResult Mask = ModRef;
 157   if (MRB == OnlyReadsMemory)
 158     Mask = Ref;
 159   else if (MRB == AliasAnalysis::AccessesArguments) {
 160     bool doesAlias = false;
 161     for (ImmutableCallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
 162          AI != AE; ++AI)
 163       if (!isNoAlias(*AI, ~0U, P, Size)) {
 164         doesAlias = true;
 165         break;
 166       }
 167
 168     if (!doesAlias)
 169       return NoModRef;
 170   }
 171
 172   if (!AA) return Mask;
 173
 174   // If P points to a constant memory location, the call definitely could not
 175   // modify the memory location.
 176   if ((Mask & Mod) && AA->pointsToConstantMemory(P))
 177     Mask = ModRefResult(Mask & ~Mod);
 178
 179   return ModRefResult(Mask & AA->getModRefInfo(CS, P, Size));
 180 }
 181
 182 // AliasAnalysis destructor: DO NOT move this to the header file for
 183 // AliasAnalysis or else clients of the AliasAnalysis class may not depend on
 184 // the AliasAnalysis.o file in the current .a file, causing alias analysis
 185 // support to not be included in the tool correctly!
 186 //
 187 AliasAnalysis::~AliasAnalysis() {}
 188
 189 /// InitializeAliasAnalysis - Subclasses must call this method to initialize the
 190 /// AliasAnalysis interface before any other methods are called.
 191 ///
 192 void AliasAnalysis::InitializeAliasAnalysis(Pass *P) {
 193   TD = P->getAnalysisIfAvailable<TargetData>();
 194   AA = &P->getAnalysis<AliasAnalysis>();
 195 }
 196
 197 // getAnalysisUsage - All alias analysis implementations should invoke this
 198 // directly (using AliasAnalysis::getAnalysisUsage(AU)).
 199 void AliasAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
 200   AU.addRequired<AliasAnalysis>();         // All AA's chain
 201 }
 202
 203 /// getTypeStoreSize - Return the TargetData store size for the given type,
 204 /// if known, or a conservative value otherwise.
 205 ///
 206 unsigned AliasAnalysis::getTypeStoreSize(const Type *Ty) {
 207   return TD ? TD->getTypeStoreSize(Ty) : ~0u;
 208 }
 209
 210 /// canBasicBlockModify - Return true if it is possible for execution of the
 211 /// specified basic block to modify the value pointed to by Ptr.
 212 ///
 213 bool AliasAnalysis::canBasicBlockModify(const BasicBlock &BB,
 214                                         const Value *Ptr, unsigned Size) {
 215   return canInstructionRangeModify(BB.front(), BB.back(), Ptr, Size);
 216 }
 217
 218 /// canInstructionRangeModify - Return true if it is possible for the execution
 219 /// of the specified instructions to modify the value pointed to by Ptr.  The
 220 /// instructions to consider are all of the instructions in the range of [I1,I2]
 221 /// INCLUSIVE.  I1 and I2 must be in the same basic block.
 222 ///
 223 bool AliasAnalysis::canInstructionRangeModify(const Instruction &I1,
 224                                               const Instruction &I2,
 225                                               const Value *Ptr, unsigned Size) {
 226   assert(I1.getParent() == I2.getParent() &&
 227          "Instructions not in same basic block!");
 228   BasicBlock::const_iterator I = &I1;
 229   BasicBlock::const_iterator E = &I2;
 230   ++E;  // Convert from inclusive to exclusive range.
 231
 232   for (; I != E; ++I) // Check every instruction in range
 233     if (getModRefInfo(I, Ptr, Size) & Mod)
 234       return true;
 235   return false;
 236 }
 237
 238 /// isNoAliasCall - Return true if this pointer is returned by a noalias
 239 /// function.
 240 bool llvm::isNoAliasCall(const Value *V) {
 241   if (isa<CallInst>(V) || isa<InvokeInst>(V))
 242     return ImmutableCallSite(cast<Instruction>(V))
 243       .paramHasAttr(0, Attribute::NoAlias);
 244   return false;
 245 }
 246
 247 /// isIdentifiedObject - Return true if this pointer refers to a distinct and
 248 /// identifiable object.  This returns true for:
 249 ///    Global Variables and Functions (but not Global Aliases)
 250 ///    Allocas and Mallocs
 251 ///    ByVal and NoAlias Arguments
 252 ///    NoAlias returns
 253 ///
 254 bool llvm::isIdentifiedObject(const Value *V) {
 255   if (isa<AllocaInst>(V))
 256     return true;
 257   if (isa<GlobalValue>(V) && !isa<GlobalAlias>(V))
 258     return true;
 259   if (isNoAliasCall(V))
 260     return true;
 261   if (const Argument *A = dyn_cast<Argument>(V))
 262     return A->hasNoAliasAttr() || A->hasByValAttr();
 263   return false;
 264 }
 265
 266 // Because of the way .a files work, we must force the BasicAA implementation to
 267 // be pulled in if the AliasAnalysis classes are pulled in.  Otherwise we run
 268 // the risk of AliasAnalysis being used, but the default implementation not
 269 // being linked into the tool that uses it.
 270 DEFINING_FILE_FOR(AliasAnalysis)