1 //===- llvm/Analysis/AliasAnalysis.h - Alias Analysis Interface -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
15 // Implementations of this interface must implement the various virtual methods,
16 // which automatically provides functionality for the entire suite of client
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.
25 //===----------------------------------------------------------------------===//
27 #ifndef LLVM_ANALYSIS_ALIAS_ANALYSIS_H
28 #define LLVM_ANALYSIS_ALIAS_ANALYSIS_H
30 #include "llvm/Support/CallSite.h"
31 #include "llvm/System/IncludeFile.h"
48 AliasAnalysis *AA; // Previous Alias Analysis to chain to.
51 /// InitializeAliasAnalysis - Subclasses must call this method to initialize
52 /// the AliasAnalysis interface before any other methods are called. This is
53 /// typically called by the run* methods of these subclasses. This may be
54 /// called multiple times.
56 void InitializeAliasAnalysis(Pass *P);
58 /// getAnalysisUsage - All alias analysis implementations should invoke this
59 /// directly (using AliasAnalysis::getAnalysisUsage(AU)).
60 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
63 static char ID; // Class identification, replacement for typeinfo
64 AliasAnalysis() : TD(0), AA(0) {}
65 virtual ~AliasAnalysis(); // We want to be subclassed
67 /// UnknownSize - This is a special value which can be used with the
68 /// size arguments in alias queries to indicate that the caller does not
69 /// know the sizes of the potential memory references.
70 static unsigned const UnknownSize = ~0u;
72 /// getTargetData - Return a pointer to the current TargetData object, or
73 /// null if no TargetData object is available.
75 const TargetData *getTargetData() const { return TD; }
77 /// getTypeStoreSize - Return the TargetData store size for the given type,
78 /// if known, or a conservative value otherwise.
80 unsigned getTypeStoreSize(const Type *Ty);
82 //===--------------------------------------------------------------------===//
86 /// Alias analysis result - Either we know for sure that it does not alias, we
87 /// know for sure it must alias, or we don't know anything: The two pointers
88 /// _might_ alias. This enum is designed so you can do things like:
89 /// if (AA.alias(P1, P2)) { ... }
90 /// to check to see if two pointers might alias.
92 /// See docs/AliasAnalysis.html for more information on the specific meanings
95 enum AliasResult { NoAlias = 0, MayAlias = 1, MustAlias = 2 };
97 /// alias - The main low level interface to the alias analysis implementation.
98 /// Returns a Result indicating whether the two pointers are aliased to each
99 /// other. This is the interface that must be implemented by specific alias
100 /// analysis implementations.
102 virtual AliasResult alias(const Value *V1, unsigned V1Size,
103 const Value *V2, unsigned V2Size);
105 /// alias - A convenience wrapper for the case where the sizes are unknown.
106 AliasResult alias(const Value *V1, const Value *V2) {
107 return alias(V1, UnknownSize, V2, UnknownSize);
110 /// isNoAlias - A trivial helper function to check to see if the specified
111 /// pointers are no-alias.
112 bool isNoAlias(const Value *V1, unsigned V1Size,
113 const Value *V2, unsigned V2Size) {
114 return alias(V1, V1Size, V2, V2Size) == NoAlias;
117 /// pointsToConstantMemory - If the specified pointer is known to point into
118 /// constant global memory, return true. This allows disambiguation of store
119 /// instructions from constant pointers.
121 virtual bool pointsToConstantMemory(const Value *P);
123 //===--------------------------------------------------------------------===//
124 /// Simple mod/ref information...
127 /// ModRefResult - Represent the result of a mod/ref query. Mod and Ref are
128 /// bits which may be or'd together.
130 enum ModRefResult { NoModRef = 0, Ref = 1, Mod = 2, ModRef = 3 };
133 /// ModRefBehavior - Summary of how a function affects memory in the program.
134 /// Loads from constant globals are not considered memory accesses for this
135 /// interface. Also, functions may freely modify stack space local to their
136 /// invocation without having to report it through these interfaces.
137 enum ModRefBehavior {
138 // DoesNotAccessMemory - This function does not perform any non-local loads
139 // or stores to memory.
141 // This property corresponds to the GCC 'const' attribute.
144 // AccessesArguments - This function accesses function arguments in well
145 // known (possibly volatile) ways, but does not access any other memory.
148 // AccessesArgumentsAndGlobals - This function has accesses function
149 // arguments and global variables well known (possibly volatile) ways, but
150 // does not access any other memory.
151 AccessesArgumentsAndGlobals,
153 // OnlyReadsMemory - This function does not perform any non-local stores or
154 // volatile loads, but may read from any memory location.
156 // This property corresponds to the GCC 'pure' attribute.
159 // UnknownModRefBehavior - This indicates that the function could not be
160 // classified into one of the behaviors above.
161 UnknownModRefBehavior
164 /// getModRefBehavior - Return the behavior when calling the given call site.
165 virtual ModRefBehavior getModRefBehavior(ImmutableCallSite CS);
167 /// getModRefBehavior - Return the behavior when calling the given function.
168 /// For use when the call site is not known.
169 virtual ModRefBehavior getModRefBehavior(const Function *F);
171 /// getIntrinsicModRefBehavior - Return the modref behavior of the intrinsic
172 /// with the given id. Most clients won't need this, because the regular
173 /// getModRefBehavior incorporates this information.
174 static ModRefBehavior getIntrinsicModRefBehavior(unsigned iid);
176 /// doesNotAccessMemory - If the specified call is known to never read or
177 /// write memory, return true. If the call only reads from known-constant
178 /// memory, it is also legal to return true. Calls that unwind the stack
179 /// are legal for this predicate.
181 /// Many optimizations (such as CSE and LICM) can be performed on such calls
182 /// without worrying about aliasing properties, and many calls have this
183 /// property (e.g. calls to 'sin' and 'cos').
185 /// This property corresponds to the GCC 'const' attribute.
187 bool doesNotAccessMemory(ImmutableCallSite CS) {
188 return getModRefBehavior(CS) == DoesNotAccessMemory;
191 /// doesNotAccessMemory - If the specified function is known to never read or
192 /// write memory, return true. For use when the call site is not known.
194 bool doesNotAccessMemory(const Function *F) {
195 return getModRefBehavior(F) == DoesNotAccessMemory;
198 /// onlyReadsMemory - If the specified call is known to only read from
199 /// non-volatile memory (or not access memory at all), return true. Calls
200 /// that unwind the stack are legal for this predicate.
202 /// This property allows many common optimizations to be performed in the
203 /// absence of interfering store instructions, such as CSE of strlen calls.
205 /// This property corresponds to the GCC 'pure' attribute.
207 bool onlyReadsMemory(ImmutableCallSite CS) {
208 ModRefBehavior MRB = getModRefBehavior(CS);
209 return MRB == DoesNotAccessMemory || MRB == OnlyReadsMemory;
212 /// onlyReadsMemory - If the specified function is known to only read from
213 /// non-volatile memory (or not access memory at all), return true. For use
214 /// when the call site is not known.
216 bool onlyReadsMemory(const Function *F) {
217 ModRefBehavior MRB = getModRefBehavior(F);
218 return MRB == DoesNotAccessMemory || MRB == OnlyReadsMemory;
222 /// getModRefInfo - Return information about whether or not an instruction may
223 /// read or write memory specified by the pointer operand. An instruction
224 /// that doesn't read or write memory may be trivially LICM'd for example.
226 /// getModRefInfo (for call sites) - Return whether information about whether
227 /// a particular call site modifies or reads the memory specified by the
230 virtual ModRefResult getModRefInfo(ImmutableCallSite CS,
231 const Value *P, unsigned Size);
233 /// getModRefInfo - Return information about whether two call sites may refer
234 /// to the same set of memory locations. This function returns NoModRef if
235 /// the two calls refer to disjoint memory locations, Ref if CS1 reads memory
236 /// written by CS2, Mod if CS1 writes to memory read or written by CS2, or
237 /// ModRef if CS1 might read or write memory accessed by CS2.
239 virtual ModRefResult getModRefInfo(ImmutableCallSite CS1,
240 ImmutableCallSite CS2);
243 /// Convenience functions...
244 ModRefResult getModRefInfo(const LoadInst *L, const Value *P, unsigned Size);
245 ModRefResult getModRefInfo(const StoreInst *S, const Value *P, unsigned Size);
246 ModRefResult getModRefInfo(const VAArgInst* I, const Value* P, unsigned Size);
247 ModRefResult getModRefInfo(const CallInst *C, const Value *P, unsigned Size) {
248 return getModRefInfo(ImmutableCallSite(C), P, Size);
250 ModRefResult getModRefInfo(const InvokeInst *I,
251 const Value *P, unsigned Size) {
252 return getModRefInfo(ImmutableCallSite(I), P, Size);
254 ModRefResult getModRefInfo(const Instruction *I,
255 const Value *P, unsigned Size) {
256 switch (I->getOpcode()) {
257 case Instruction::VAArg: return getModRefInfo((const VAArgInst*)I, P,Size);
258 case Instruction::Load: return getModRefInfo((const LoadInst*)I, P, Size);
259 case Instruction::Store: return getModRefInfo((const StoreInst*)I, P,Size);
260 case Instruction::Call: return getModRefInfo((const CallInst*)I, P, Size);
261 case Instruction::Invoke: return getModRefInfo((const InvokeInst*)I,P,Size);
262 default: return NoModRef;
266 //===--------------------------------------------------------------------===//
267 /// Higher level methods for querying mod/ref information.
270 /// canBasicBlockModify - Return true if it is possible for execution of the
271 /// specified basic block to modify the value pointed to by Ptr.
273 bool canBasicBlockModify(const BasicBlock &BB, const Value *P, unsigned Size);
275 /// canInstructionRangeModify - Return true if it is possible for the
276 /// execution of the specified instructions to modify the value pointed to by
277 /// Ptr. The instructions to consider are all of the instructions in the
278 /// range of [I1,I2] INCLUSIVE. I1 and I2 must be in the same basic block.
280 bool canInstructionRangeModify(const Instruction &I1, const Instruction &I2,
281 const Value *Ptr, unsigned Size);
283 //===--------------------------------------------------------------------===//
284 /// Methods that clients should call when they transform the program to allow
285 /// alias analyses to update their internal data structures. Note that these
286 /// methods may be called on any instruction, regardless of whether or not
287 /// they have pointer-analysis implications.
290 /// deleteValue - This method should be called whenever an LLVM Value is
291 /// deleted from the program, for example when an instruction is found to be
292 /// redundant and is eliminated.
294 virtual void deleteValue(Value *V);
296 /// copyValue - This method should be used whenever a preexisting value in the
297 /// program is copied or cloned, introducing a new value. Note that analysis
298 /// implementations should tolerate clients that use this method to introduce
299 /// the same value multiple times: if the analysis already knows about a
300 /// value, it should ignore the request.
302 virtual void copyValue(Value *From, Value *To);
304 /// replaceWithNewValue - This method is the obvious combination of the two
305 /// above, and it provided as a helper to simplify client code.
307 void replaceWithNewValue(Value *Old, Value *New) {
313 /// isNoAliasCall - Return true if this pointer is returned by a noalias
315 bool isNoAliasCall(const Value *V);
317 /// isIdentifiedObject - Return true if this pointer refers to a distinct and
318 /// identifiable object. This returns true for:
319 /// Global Variables and Functions (but not Global Aliases)
320 /// Allocas and Mallocs
321 /// ByVal and NoAlias Arguments
324 bool isIdentifiedObject(const Value *V);
326 } // End llvm namespace
328 // Because of the way .a files work, we must force the BasicAA implementation to
329 // be pulled in if the AliasAnalysis header is included. Otherwise we run
330 // the risk of AliasAnalysis being used, but the default implementation not
331 // being linked into the tool that uses it.
332 FORCE_DEFINING_FILE_TO_BE_LINKED(AliasAnalysis)
333 FORCE_DEFINING_FILE_TO_BE_LINKED(BasicAliasAnalysis)