AliasAnalysis.h revision db78c4873ea8c4b3dce90d761a1ad59d5bcdd6e7
1//===- llvm/Analysis/AliasAnalysis.h - Alias Analysis Interface -*- C++ -*-===// 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 generic AliasAnalysis interface, which is used as the 11// common interface used by all clients of alias analysis information, and 12// implemented by all alias analysis implementations. Mod/Ref information is 13// also captured by this interface. 14// 15// Implementations of this interface must implement the various virtual methods, 16// which automatically provides functionality for the entire suite of client 17// APIs. 18// 19// This API represents memory as a (Pointer, Size) pair. The Pointer component 20// specifies the base memory address of the region, the Size specifies how large 21// of an area is being queried, or UnknownSize if the size is not known. 22// Pointers that point to two completely different objects in memory never 23// alias, regardless of the value of the Size component. 24// 25//===----------------------------------------------------------------------===// 26 27#ifndef LLVM_ANALYSIS_ALIAS_ANALYSIS_H 28#define LLVM_ANALYSIS_ALIAS_ANALYSIS_H 29 30#include "llvm/Support/CallSite.h" 31#include <vector> 32 33namespace llvm { 34 35class LoadInst; 36class StoreInst; 37class VAArgInst; 38class TargetData; 39class Pass; 40class AnalysisUsage; 41 42class AliasAnalysis { 43protected: 44 const TargetData *TD; 45 46private: 47 AliasAnalysis *AA; // Previous Alias Analysis to chain to. 48 49protected: 50 /// InitializeAliasAnalysis - Subclasses must call this method to initialize 51 /// the AliasAnalysis interface before any other methods are called. This is 52 /// typically called by the run* methods of these subclasses. This may be 53 /// called multiple times. 54 /// 55 void InitializeAliasAnalysis(Pass *P); 56 57 /// getAnalysisUsage - All alias analysis implementations should invoke this 58 /// directly (using AliasAnalysis::getAnalysisUsage(AU)). 59 virtual void getAnalysisUsage(AnalysisUsage &AU) const; 60 61public: 62 static char ID; // Class identification, replacement for typeinfo 63 AliasAnalysis() : TD(0), AA(0) {} 64 virtual ~AliasAnalysis(); // We want to be subclassed 65 66 /// UnknownSize - This is a special value which can be used with the 67 /// size arguments in alias queries to indicate that the caller does not 68 /// know the sizes of the potential memory references. 69 static uint64_t const UnknownSize = ~UINT64_C(0); 70 71 /// getTargetData - Return a pointer to the current TargetData object, or 72 /// null if no TargetData object is available. 73 /// 74 const TargetData *getTargetData() const { return TD; } 75 76 /// getTypeStoreSize - Return the TargetData store size for the given type, 77 /// if known, or a conservative value otherwise. 78 /// 79 uint64_t getTypeStoreSize(const Type *Ty); 80 81 //===--------------------------------------------------------------------===// 82 /// Alias Queries... 83 /// 84 85 /// Location - A description of a memory location. 86 struct Location { 87 /// Ptr - The address of the start of the location. 88 const Value *Ptr; 89 /// Size - The maximum size of the location, or UnknownSize if the size is 90 /// not known. Note that an unknown size does not mean the pointer aliases 91 /// the entire virtual address space, because there are restrictions on 92 /// stepping out of one object and into another. 93 /// See http://llvm.org/docs/LangRef.html#pointeraliasing 94 uint64_t Size; 95 /// TBAATag - The metadata node which describes the TBAA type of 96 /// the location, or null if there is no known unique tag. 97 const MDNode *TBAATag; 98 99 explicit Location(const Value *P = 0, 100 uint64_t S = UnknownSize, 101 const MDNode *N = 0) 102 : Ptr(P), Size(S), TBAATag(N) {} 103 104 Location getWithNewPtr(const Value *NewPtr) const { 105 Location Copy(*this); 106 Copy.Ptr = NewPtr; 107 return Copy; 108 } 109 110 Location getWithoutTBAATag() const { 111 Location Copy(*this); 112 Copy.TBAATag = 0; 113 return Copy; 114 } 115 }; 116 117 /// Alias analysis result - Either we know for sure that it does not alias, we 118 /// know for sure it must alias, or we don't know anything: The two pointers 119 /// _might_ alias. This enum is designed so you can do things like: 120 /// if (AA.alias(P1, P2)) { ... } 121 /// to check to see if two pointers might alias. 122 /// 123 /// See docs/AliasAnalysis.html for more information on the specific meanings 124 /// of these values. 125 /// 126 enum AliasResult { NoAlias = 0, MayAlias = 1, MustAlias = 2 }; 127 128 /// alias - The main low level interface to the alias analysis implementation. 129 /// Returns an AliasResult indicating whether the two pointers are aliased to 130 /// each other. This is the interface that must be implemented by specific 131 /// alias analysis implementations. 132 virtual AliasResult alias(const Location &LocA, const Location &LocB); 133 134 /// alias - A convenience wrapper. 135 AliasResult alias(const Value *V1, uint64_t V1Size, 136 const Value *V2, uint64_t V2Size) { 137 return alias(Location(V1, V1Size), Location(V2, V2Size)); 138 } 139 140 /// alias - A convenience wrapper. 141 AliasResult alias(const Value *V1, const Value *V2) { 142 return alias(V1, UnknownSize, V2, UnknownSize); 143 } 144 145 /// isNoAlias - A trivial helper function to check to see if the specified 146 /// pointers are no-alias. 147 bool isNoAlias(const Location &LocA, const Location &LocB) { 148 return alias(LocA, LocB) == NoAlias; 149 } 150 151 /// isNoAlias - A convenience wrapper. 152 bool isNoAlias(const Value *V1, uint64_t V1Size, 153 const Value *V2, uint64_t V2Size) { 154 return isNoAlias(Location(V1, V1Size), Location(V2, V2Size)); 155 } 156 157 /// pointsToConstantMemory - If the specified memory location is 158 /// known to be constant, return true. If OrLocal is true and the 159 /// specified memory location is known to be "local" (derived from 160 /// an alloca), return true. Otherwise return false. 161 virtual bool pointsToConstantMemory(const Location &Loc, 162 bool OrLocal = false); 163 164 /// pointsToConstantMemory - A convenient wrapper. 165 bool pointsToConstantMemory(const Value *P, bool OrLocal = false) { 166 return pointsToConstantMemory(Location(P), OrLocal); 167 } 168 169 //===--------------------------------------------------------------------===// 170 /// Simple mod/ref information... 171 /// 172 173 /// ModRefResult - Represent the result of a mod/ref query. Mod and Ref are 174 /// bits which may be or'd together. 175 /// 176 enum ModRefResult { NoModRef = 0, Ref = 1, Mod = 2, ModRef = 3 }; 177 178 179 /// ModRefBehavior - Summary of how a function affects memory in the program. 180 /// Loads from constant globals are not considered memory accesses for this 181 /// interface. Also, functions may freely modify stack space local to their 182 /// invocation without having to report it through these interfaces. 183 enum ModRefBehavior { 184 // DoesNotAccessMemory - This function does not perform any non-local loads 185 // or stores to memory. 186 // 187 // This property corresponds to the GCC 'const' attribute. 188 // This property corresponds to the LLVM IR 'readnone' attribute. 189 // This property corresponds to the IntrNoMem LLVM intrinsic flag. 190 DoesNotAccessMemory, 191 192 // AccessesArgumentsReadonly - This function loads through function 193 // arguments and does not perform any non-local stores or volatile 194 // loads. 195 // 196 // This property corresponds to the IntrReadArgMem LLVM intrinsic flag. 197 AccessesArgumentsReadonly, 198 199 // AccessesArguments - This function accesses function arguments in well 200 // known (possibly volatile) ways, but does not access any other memory. 201 // 202 // This property corresponds to the IntrReadWriteArgMem LLVM intrinsic flag. 203 AccessesArguments, 204 205 // OnlyReadsMemory - This function does not perform any non-local stores or 206 // volatile loads, but may read from any memory location. 207 // 208 // This property corresponds to the GCC 'pure' attribute. 209 // This property corresponds to the LLVM IR 'readonly' attribute. 210 // This property corresponds to the IntrReadMem LLVM intrinsic flag. 211 OnlyReadsMemory, 212 213 // UnknownModRefBehavior - This indicates that the function could not be 214 // classified into one of the behaviors above. 215 UnknownModRefBehavior 216 }; 217 218 /// getModRefBehavior - Return the behavior when calling the given call site. 219 virtual ModRefBehavior getModRefBehavior(ImmutableCallSite CS); 220 221 /// getModRefBehavior - Return the behavior when calling the given function. 222 /// For use when the call site is not known. 223 virtual ModRefBehavior getModRefBehavior(const Function *F); 224 225 /// doesNotAccessMemory - If the specified call is known to never read or 226 /// write memory, return true. If the call only reads from known-constant 227 /// memory, it is also legal to return true. Calls that unwind the stack 228 /// are legal for this predicate. 229 /// 230 /// Many optimizations (such as CSE and LICM) can be performed on such calls 231 /// without worrying about aliasing properties, and many calls have this 232 /// property (e.g. calls to 'sin' and 'cos'). 233 /// 234 /// This property corresponds to the GCC 'const' attribute. 235 /// 236 bool doesNotAccessMemory(ImmutableCallSite CS) { 237 return getModRefBehavior(CS) == DoesNotAccessMemory; 238 } 239 240 /// doesNotAccessMemory - If the specified function is known to never read or 241 /// write memory, return true. For use when the call site is not known. 242 /// 243 bool doesNotAccessMemory(const Function *F) { 244 return getModRefBehavior(F) == DoesNotAccessMemory; 245 } 246 247 /// onlyReadsMemory - If the specified call is known to only read from 248 /// non-volatile memory (or not access memory at all), return true. Calls 249 /// that unwind the stack are legal for this predicate. 250 /// 251 /// This property allows many common optimizations to be performed in the 252 /// absence of interfering store instructions, such as CSE of strlen calls. 253 /// 254 /// This property corresponds to the GCC 'pure' attribute. 255 /// 256 bool onlyReadsMemory(ImmutableCallSite CS) { 257 return onlyReadsMemory(getModRefBehavior(CS)); 258 } 259 260 /// onlyReadsMemory - If the specified function is known to only read from 261 /// non-volatile memory (or not access memory at all), return true. For use 262 /// when the call site is not known. 263 /// 264 bool onlyReadsMemory(const Function *F) { 265 return onlyReadsMemory(getModRefBehavior(F)); 266 } 267 268 /// onlyReadsMemory - If the functions with the specified behavior are known 269 /// to only read from non-volatile memory (or not access memory at all), return 270 /// true. For use when the call site is not known. 271 /// 272 static bool onlyReadsMemory(ModRefBehavior MRB) { 273 return MRB == DoesNotAccessMemory || MRB == OnlyReadsMemory; 274 } 275 276 277 /// getModRefInfo - Return information about whether or not an instruction may 278 /// read or write the specified memory location. An instruction 279 /// that doesn't read or write memory may be trivially LICM'd for example. 280 ModRefResult getModRefInfo(const Instruction *I, 281 const Location &Loc) { 282 switch (I->getOpcode()) { 283 case Instruction::VAArg: return getModRefInfo((const VAArgInst*)I, Loc); 284 case Instruction::Load: return getModRefInfo((const LoadInst*)I, Loc); 285 case Instruction::Store: return getModRefInfo((const StoreInst*)I, Loc); 286 case Instruction::Call: return getModRefInfo((const CallInst*)I, Loc); 287 case Instruction::Invoke: return getModRefInfo((const InvokeInst*)I,Loc); 288 default: return NoModRef; 289 } 290 } 291 292 /// getModRefInfo - A convenience wrapper. 293 ModRefResult getModRefInfo(const Instruction *I, 294 const Value *P, uint64_t Size) { 295 return getModRefInfo(I, Location(P, Size)); 296 } 297 298 /// getModRefInfo (for call sites) - Return whether information about whether 299 /// a particular call site modifies or reads the specified memory location. 300 virtual ModRefResult getModRefInfo(ImmutableCallSite CS, 301 const Location &Loc); 302 303 /// getModRefInfo (for call sites) - A convenience wrapper. 304 ModRefResult getModRefInfo(ImmutableCallSite CS, 305 const Value *P, uint64_t Size) { 306 return getModRefInfo(CS, Location(P, Size)); 307 } 308 309 /// getModRefInfo (for calls) - Return whether information about whether 310 /// a particular call modifies or reads the specified memory location. 311 ModRefResult getModRefInfo(const CallInst *C, const Location &Loc) { 312 return getModRefInfo(ImmutableCallSite(C), Loc); 313 } 314 315 /// getModRefInfo (for calls) - A convenience wrapper. 316 ModRefResult getModRefInfo(const CallInst *C, const Value *P, uint64_t Size) { 317 return getModRefInfo(C, Location(P, Size)); 318 } 319 320 /// getModRefInfo (for invokes) - Return whether information about whether 321 /// a particular invoke modifies or reads the specified memory location. 322 ModRefResult getModRefInfo(const InvokeInst *I, 323 const Location &Loc) { 324 return getModRefInfo(ImmutableCallSite(I), Loc); 325 } 326 327 /// getModRefInfo (for invokes) - A convenience wrapper. 328 ModRefResult getModRefInfo(const InvokeInst *I, 329 const Value *P, uint64_t Size) { 330 return getModRefInfo(I, Location(P, Size)); 331 } 332 333 /// getModRefInfo (for loads) - Return whether information about whether 334 /// a particular load modifies or reads the specified memory location. 335 ModRefResult getModRefInfo(const LoadInst *L, const Location &Loc); 336 337 /// getModRefInfo (for loads) - A convenience wrapper. 338 ModRefResult getModRefInfo(const LoadInst *L, const Value *P, uint64_t Size) { 339 return getModRefInfo(L, Location(P, Size)); 340 } 341 342 /// getModRefInfo (for stores) - Return whether information about whether 343 /// a particular store modifies or reads the specified memory location. 344 ModRefResult getModRefInfo(const StoreInst *S, const Location &Loc); 345 346 /// getModRefInfo (for stores) - A convenience wrapper. 347 ModRefResult getModRefInfo(const StoreInst *S, const Value *P, uint64_t Size) { 348 return getModRefInfo(S, Location(P, Size)); 349 } 350 351 /// getModRefInfo (for va_args) - Return whether information about whether 352 /// a particular va_arg modifies or reads the specified memory location. 353 ModRefResult getModRefInfo(const VAArgInst* I, const Location &Loc); 354 355 /// getModRefInfo (for va_args) - A convenience wrapper. 356 ModRefResult getModRefInfo(const VAArgInst* I, const Value* P, uint64_t Size) { 357 return getModRefInfo(I, Location(P, Size)); 358 } 359 360 /// getModRefInfo - Return information about whether two call sites may refer 361 /// to the same set of memory locations. See 362 /// http://llvm.org/docs/AliasAnalysis.html#ModRefInfo 363 /// for details. 364 virtual ModRefResult getModRefInfo(ImmutableCallSite CS1, 365 ImmutableCallSite CS2); 366 367 //===--------------------------------------------------------------------===// 368 /// Higher level methods for querying mod/ref information. 369 /// 370 371 /// canBasicBlockModify - Return true if it is possible for execution of the 372 /// specified basic block to modify the value pointed to by Ptr. 373 bool canBasicBlockModify(const BasicBlock &BB, const Location &Loc); 374 375 /// canBasicBlockModify - A convenience wrapper. 376 bool canBasicBlockModify(const BasicBlock &BB, const Value *P, uint64_t Size){ 377 return canBasicBlockModify(BB, Location(P, Size)); 378 } 379 380 /// canInstructionRangeModify - Return true if it is possible for the 381 /// execution of the specified instructions to modify the value pointed to by 382 /// Ptr. The instructions to consider are all of the instructions in the 383 /// range of [I1,I2] INCLUSIVE. I1 and I2 must be in the same basic block. 384 bool canInstructionRangeModify(const Instruction &I1, const Instruction &I2, 385 const Location &Loc); 386 387 /// canInstructionRangeModify - A convenience wrapper. 388 bool canInstructionRangeModify(const Instruction &I1, const Instruction &I2, 389 const Value *Ptr, uint64_t Size) { 390 return canInstructionRangeModify(I1, I2, Location(Ptr, Size)); 391 } 392 393 //===--------------------------------------------------------------------===// 394 /// Methods that clients should call when they transform the program to allow 395 /// alias analyses to update their internal data structures. Note that these 396 /// methods may be called on any instruction, regardless of whether or not 397 /// they have pointer-analysis implications. 398 /// 399 400 /// deleteValue - This method should be called whenever an LLVM Value is 401 /// deleted from the program, for example when an instruction is found to be 402 /// redundant and is eliminated. 403 /// 404 virtual void deleteValue(Value *V); 405 406 /// copyValue - This method should be used whenever a preexisting value in the 407 /// program is copied or cloned, introducing a new value. Note that analysis 408 /// implementations should tolerate clients that use this method to introduce 409 /// the same value multiple times: if the analysis already knows about a 410 /// value, it should ignore the request. 411 /// 412 virtual void copyValue(Value *From, Value *To); 413 414 /// replaceWithNewValue - This method is the obvious combination of the two 415 /// above, and it provided as a helper to simplify client code. 416 /// 417 void replaceWithNewValue(Value *Old, Value *New) { 418 copyValue(Old, New); 419 deleteValue(Old); 420 } 421}; 422 423/// isNoAliasCall - Return true if this pointer is returned by a noalias 424/// function. 425bool isNoAliasCall(const Value *V); 426 427/// isIdentifiedObject - Return true if this pointer refers to a distinct and 428/// identifiable object. This returns true for: 429/// Global Variables and Functions (but not Global Aliases) 430/// Allocas and Mallocs 431/// ByVal and NoAlias Arguments 432/// NoAlias returns 433/// 434bool isIdentifiedObject(const Value *V); 435 436} // End llvm namespace 437 438#endif 439