DI: Set DILexicalBlock columns >= 65536 to 0/unknown
[oota-llvm.git] / docs / AliasAnalysis.rst
1 ==================================
2 LLVM Alias Analysis Infrastructure
3 ==================================
4
5 .. contents::
6    :local:
7
8 Introduction
9 ============
10
11 Alias Analysis (aka Pointer Analysis) is a class of techniques which attempt to
12 determine whether or not two pointers ever can point to the same object in
13 memory.  There are many different algorithms for alias analysis and many
14 different ways of classifying them: flow-sensitive vs. flow-insensitive,
15 context-sensitive vs. context-insensitive, field-sensitive
16 vs. field-insensitive, unification-based vs. subset-based, etc.  Traditionally,
17 alias analyses respond to a query with a `Must, May, or No`_ alias response,
18 indicating that two pointers always point to the same object, might point to the
19 same object, or are known to never point to the same object.
20
21 The LLVM `AliasAnalysis
22 <http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html>`__ class is the
23 primary interface used by clients and implementations of alias analyses in the
24 LLVM system.  This class is the common interface between clients of alias
25 analysis information and the implementations providing it, and is designed to
26 support a wide range of implementations and clients (but currently all clients
27 are assumed to be flow-insensitive).  In addition to simple alias analysis
28 information, this class exposes Mod/Ref information from those implementations
29 which can provide it, allowing for powerful analyses and transformations to work
30 well together.
31
32 This document contains information necessary to successfully implement this
33 interface, use it, and to test both sides.  It also explains some of the finer
34 points about what exactly results mean.  If you feel that something is unclear
35 or should be added, please `let me know <mailto:sabre@nondot.org>`_.
36
37 ``AliasAnalysis`` Class Overview
38 ================================
39
40 The `AliasAnalysis <http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html>`__
41 class defines the interface that the various alias analysis implementations
42 should support.  This class exports two important enums: ``AliasResult`` and
43 ``ModRefResult`` which represent the result of an alias query or a mod/ref
44 query, respectively.
45
46 The ``AliasAnalysis`` interface exposes information about memory, represented in
47 several different ways.  In particular, memory objects are represented as a
48 starting address and size, and function calls are represented as the actual
49 ``call`` or ``invoke`` instructions that performs the call.  The
50 ``AliasAnalysis`` interface also exposes some helper methods which allow you to
51 get mod/ref information for arbitrary instructions.
52
53 All ``AliasAnalysis`` interfaces require that in queries involving multiple
54 values, values which are not :ref:`constants <constants>` are all
55 defined within the same function.
56
57 Representation of Pointers
58 --------------------------
59
60 Most importantly, the ``AliasAnalysis`` class provides several methods which are
61 used to query whether or not two memory objects alias, whether function calls
62 can modify or read a memory object, etc.  For all of these queries, memory
63 objects are represented as a pair of their starting address (a symbolic LLVM
64 ``Value*``) and a static size.
65
66 Representing memory objects as a starting address and a size is critically
67 important for correct Alias Analyses.  For example, consider this (silly, but
68 possible) C code:
69
70 .. code-block:: c++
71
72   int i;
73   char C[2];
74   char A[10]; 
75   /* ... */
76   for (i = 0; i != 10; ++i) {
77     C[0] = A[i];          /* One byte store */
78     C[1] = A[9-i];        /* One byte store */
79   }
80
81 In this case, the ``basicaa`` pass will disambiguate the stores to ``C[0]`` and
82 ``C[1]`` because they are accesses to two distinct locations one byte apart, and
83 the accesses are each one byte.  In this case, the Loop Invariant Code Motion
84 (LICM) pass can use store motion to remove the stores from the loop.  In
85 constrast, the following code:
86
87 .. code-block:: c++
88
89   int i;
90   char C[2];
91   char A[10]; 
92   /* ... */
93   for (i = 0; i != 10; ++i) {
94     ((short*)C)[0] = A[i];  /* Two byte store! */
95     C[1] = A[9-i];          /* One byte store */
96   }
97
98 In this case, the two stores to C do alias each other, because the access to the
99 ``&C[0]`` element is a two byte access.  If size information wasn't available in
100 the query, even the first case would have to conservatively assume that the
101 accesses alias.
102
103 .. _alias:
104
105 The ``alias`` method
106 --------------------
107   
108 The ``alias`` method is the primary interface used to determine whether or not
109 two memory objects alias each other.  It takes two memory objects as input and
110 returns MustAlias, PartialAlias, MayAlias, or NoAlias as appropriate.
111
112 Like all ``AliasAnalysis`` interfaces, the ``alias`` method requires that either
113 the two pointer values be defined within the same function, or at least one of
114 the values is a :ref:`constant <constants>`.
115
116 .. _Must, May, or No:
117
118 Must, May, and No Alias Responses
119 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
120
121 The ``NoAlias`` response may be used when there is never an immediate dependence
122 between any memory reference *based* on one pointer and any memory reference
123 *based* the other. The most obvious example is when the two pointers point to
124 non-overlapping memory ranges. Another is when the two pointers are only ever
125 used for reading memory. Another is when the memory is freed and reallocated
126 between accesses through one pointer and accesses through the other --- in this
127 case, there is a dependence, but it's mediated by the free and reallocation.
128
129 As an exception to this is with the :ref:`noalias <noalias>` keyword;
130 the "irrelevant" dependencies are ignored.
131
132 The ``MayAlias`` response is used whenever the two pointers might refer to the
133 same object.
134
135 The ``PartialAlias`` response is used when the two memory objects are known to
136 be overlapping in some way, but do not start at the same address.
137
138 The ``MustAlias`` response may only be returned if the two memory objects are
139 guaranteed to always start at exactly the same location. A ``MustAlias``
140 response implies that the pointers compare equal.
141
142 The ``getModRefInfo`` methods
143 -----------------------------
144
145 The ``getModRefInfo`` methods return information about whether the execution of
146 an instruction can read or modify a memory location.  Mod/Ref information is
147 always conservative: if an instruction **might** read or write a location,
148 ``ModRef`` is returned.
149
150 The ``AliasAnalysis`` class also provides a ``getModRefInfo`` method for testing
151 dependencies between function calls.  This method takes two call sites (``CS1``
152 & ``CS2``), returns ``NoModRef`` if neither call writes to memory read or
153 written by the other, ``Ref`` if ``CS1`` reads memory written by ``CS2``,
154 ``Mod`` if ``CS1`` writes to memory read or written by ``CS2``, or ``ModRef`` if
155 ``CS1`` might read or write memory written to by ``CS2``.  Note that this
156 relation is not commutative.
157
158 Other useful ``AliasAnalysis`` methods
159 --------------------------------------
160
161 Several other tidbits of information are often collected by various alias
162 analysis implementations and can be put to good use by various clients.
163
164 The ``pointsToConstantMemory`` method
165 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
166
167 The ``pointsToConstantMemory`` method returns true if and only if the analysis
168 can prove that the pointer only points to unchanging memory locations
169 (functions, constant global variables, and the null pointer).  This information
170 can be used to refine mod/ref information: it is impossible for an unchanging
171 memory location to be modified.
172
173 .. _never access memory or only read memory:
174
175 The ``doesNotAccessMemory`` and  ``onlyReadsMemory`` methods
176 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
177
178 These methods are used to provide very simple mod/ref information for function
179 calls.  The ``doesNotAccessMemory`` method returns true for a function if the
180 analysis can prove that the function never reads or writes to memory, or if the
181 function only reads from constant memory.  Functions with this property are
182 side-effect free and only depend on their input arguments, allowing them to be
183 eliminated if they form common subexpressions or be hoisted out of loops.  Many
184 common functions behave this way (e.g., ``sin`` and ``cos``) but many others do
185 not (e.g., ``acos``, which modifies the ``errno`` variable).
186
187 The ``onlyReadsMemory`` method returns true for a function if analysis can prove
188 that (at most) the function only reads from non-volatile memory.  Functions with
189 this property are side-effect free, only depending on their input arguments and
190 the state of memory when they are called.  This property allows calls to these
191 functions to be eliminated and moved around, as long as there is no store
192 instruction that changes the contents of memory.  Note that all functions that
193 satisfy the ``doesNotAccessMemory`` method also satisfies ``onlyReadsMemory``.
194
195 Writing a new ``AliasAnalysis`` Implementation
196 ==============================================
197
198 Writing a new alias analysis implementation for LLVM is quite straight-forward.
199 There are already several implementations that you can use for examples, and the
200 following information should help fill in any details.  For a examples, take a
201 look at the `various alias analysis implementations`_ included with LLVM.
202
203 Different Pass styles
204 ---------------------
205
206 The first step to determining what type of :doc:`LLVM pass <WritingAnLLVMPass>`
207 you need to use for your Alias Analysis.  As is the case with most other
208 analyses and transformations, the answer should be fairly obvious from what type
209 of problem you are trying to solve:
210
211 #. If you require interprocedural analysis, it should be a ``Pass``.
212 #. If you are a function-local analysis, subclass ``FunctionPass``.
213 #. If you don't need to look at the program at all, subclass ``ImmutablePass``.
214
215 In addition to the pass that you subclass, you should also inherit from the
216 ``AliasAnalysis`` interface, of course, and use the ``RegisterAnalysisGroup``
217 template to register as an implementation of ``AliasAnalysis``.
218
219 Required initialization calls
220 -----------------------------
221
222 Your subclass of ``AliasAnalysis`` is required to invoke two methods on the
223 ``AliasAnalysis`` base class: ``getAnalysisUsage`` and
224 ``InitializeAliasAnalysis``.  In particular, your implementation of
225 ``getAnalysisUsage`` should explicitly call into the
226 ``AliasAnalysis::getAnalysisUsage`` method in addition to doing any declaring
227 any pass dependencies your pass has.  Thus you should have something like this:
228
229 .. code-block:: c++
230
231   void getAnalysisUsage(AnalysisUsage &AU) const {
232     AliasAnalysis::getAnalysisUsage(AU);
233     // declare your dependencies here.
234   }
235
236 Additionally, your must invoke the ``InitializeAliasAnalysis`` method from your
237 analysis run method (``run`` for a ``Pass``, ``runOnFunction`` for a
238 ``FunctionPass``, or ``InitializePass`` for an ``ImmutablePass``).  For example
239 (as part of a ``Pass``):
240
241 .. code-block:: c++
242
243   bool run(Module &M) {
244     InitializeAliasAnalysis(this);
245     // Perform analysis here...
246     return false;
247   }
248
249 Required methods to override
250 ----------------------------
251
252 You must override the ``getAdjustedAnalysisPointer`` method on all subclasses
253 of ``AliasAnalysis``. An example implementation of this method would look like:
254
255 .. code-block:: c++
256
257   void *getAdjustedAnalysisPointer(const void* ID) override {
258     if (ID == &AliasAnalysis::ID)
259       return (AliasAnalysis*)this;
260     return this;
261   }
262
263 Interfaces which may be specified
264 ---------------------------------
265
266 All of the `AliasAnalysis
267 <http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html>`__ virtual methods
268 default to providing :ref:`chaining <aliasanalysis-chaining>` to another alias
269 analysis implementation, which ends up returning conservatively correct
270 information (returning "May" Alias and "Mod/Ref" for alias and mod/ref queries
271 respectively).  Depending on the capabilities of the analysis you are
272 implementing, you just override the interfaces you can improve.
273
274 .. _aliasanalysis-chaining:
275
276 ``AliasAnalysis`` chaining behavior
277 -----------------------------------
278
279 With only one special exception (the :ref:`-no-aa <aliasanalysis-no-aa>` pass)
280 every alias analysis pass chains to another alias analysis implementation (for
281 example, the user can specify "``-basicaa -ds-aa -licm``" to get the maximum
282 benefit from both alias analyses).  The alias analysis class automatically
283 takes care of most of this for methods that you don't override.  For methods
284 that you do override, in code paths that return a conservative MayAlias or
285 Mod/Ref result, simply return whatever the superclass computes.  For example:
286
287 .. code-block:: c++
288
289   AliasResult alias(const Value *V1, unsigned V1Size,
290                     const Value *V2, unsigned V2Size) {
291     if (...)
292       return NoAlias;
293     ...
294
295     // Couldn't determine a must or no-alias result.
296     return AliasAnalysis::alias(V1, V1Size, V2, V2Size);
297   }
298
299 In addition to analysis queries, you must make sure to unconditionally pass LLVM
300 `update notification`_ methods to the superclass as well if you override them,
301 which allows all alias analyses in a change to be updated.
302
303 .. _update notification:
304
305 Updating analysis results for transformations
306 ---------------------------------------------
307
308 Alias analysis information is initially computed for a static snapshot of the
309 program, but clients will use this information to make transformations to the
310 code.  All but the most trivial forms of alias analysis will need to have their
311 analysis results updated to reflect the changes made by these transformations.
312
313 The ``AliasAnalysis`` interface exposes four methods which are used to
314 communicate program changes from the clients to the analysis implementations.
315 Various alias analysis implementations should use these methods to ensure that
316 their internal data structures are kept up-to-date as the program changes (for
317 example, when an instruction is deleted), and clients of alias analysis must be
318 sure to call these interfaces appropriately.
319
320 The ``deleteValue`` method
321 ^^^^^^^^^^^^^^^^^^^^^^^^^^
322
323 The ``deleteValue`` method is called by transformations when they remove an
324 instruction or any other value from the program (including values that do not
325 use pointers).  Typically alias analyses keep data structures that have entries
326 for each value in the program.  When this method is called, they should remove
327 any entries for the specified value, if they exist.
328
329 The ``copyValue`` method
330 ^^^^^^^^^^^^^^^^^^^^^^^^
331
332 The ``copyValue`` method is used when a new value is introduced into the
333 program.  There is no way to introduce a value into the program that did not
334 exist before (this doesn't make sense for a safe compiler transformation), so
335 this is the only way to introduce a new value.  This method indicates that the
336 new value has exactly the same properties as the value being copied.
337
338 The ``replaceWithNewValue`` method
339 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
340
341 This method is a simple helper method that is provided to make clients easier to
342 use.  It is implemented by copying the old analysis information to the new
343 value, then deleting the old value.  This method cannot be overridden by alias
344 analysis implementations.
345
346 The ``addEscapingUse`` method
347 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
348
349 The ``addEscapingUse`` method is used when the uses of a pointer value have
350 changed in ways that may invalidate precomputed analysis information.
351 Implementations may either use this callback to provide conservative responses
352 for points whose uses have change since analysis time, or may recompute some or
353 all of their internal state to continue providing accurate responses.
354
355 In general, any new use of a pointer value is considered an escaping use, and
356 must be reported through this callback, *except* for the uses below:
357
358 * A ``bitcast`` or ``getelementptr`` of the pointer
359 * A ``store`` through the pointer (but not a ``store`` *of* the pointer)
360 * A ``load`` through the pointer
361
362 Efficiency Issues
363 -----------------
364
365 From the LLVM perspective, the only thing you need to do to provide an efficient
366 alias analysis is to make sure that alias analysis **queries** are serviced
367 quickly.  The actual calculation of the alias analysis results (the "run"
368 method) is only performed once, but many (perhaps duplicate) queries may be
369 performed.  Because of this, try to move as much computation to the run method
370 as possible (within reason).
371
372 Limitations
373 -----------
374
375 The AliasAnalysis infrastructure has several limitations which make writing a
376 new ``AliasAnalysis`` implementation difficult.
377
378 There is no way to override the default alias analysis. It would be very useful
379 to be able to do something like "``opt -my-aa -O2``" and have it use ``-my-aa``
380 for all passes which need AliasAnalysis, but there is currently no support for
381 that, short of changing the source code and recompiling. Similarly, there is
382 also no way of setting a chain of analyses as the default.
383
384 There is no way for transform passes to declare that they preserve
385 ``AliasAnalysis`` implementations. The ``AliasAnalysis`` interface includes
386 ``deleteValue`` and ``copyValue`` methods which are intended to allow a pass to
387 keep an AliasAnalysis consistent, however there's no way for a pass to declare
388 in its ``getAnalysisUsage`` that it does so. Some passes attempt to use
389 ``AU.addPreserved<AliasAnalysis>``, however this doesn't actually have any
390 effect.
391
392 ``AliasAnalysisCounter`` (``-count-aa``) are implemented as ``ModulePass``
393 classes, so if your alias analysis uses ``FunctionPass``, it won't be able to
394 use these utilities. If you try to use them, the pass manager will silently
395 route alias analysis queries directly to ``BasicAliasAnalysis`` instead.
396
397 Similarly, the ``opt -p`` option introduces ``ModulePass`` passes between each
398 pass, which prevents the use of ``FunctionPass`` alias analysis passes.
399
400 The ``AliasAnalysis`` API does have functions for notifying implementations when
401 values are deleted or copied, however these aren't sufficient. There are many
402 other ways that LLVM IR can be modified which could be relevant to
403 ``AliasAnalysis`` implementations which can not be expressed.
404
405 The ``AliasAnalysisDebugger`` utility seems to suggest that ``AliasAnalysis``
406 implementations can expect that they will be informed of any relevant ``Value``
407 before it appears in an alias query. However, popular clients such as ``GVN``
408 don't support this, and are known to trigger errors when run with the
409 ``AliasAnalysisDebugger``.
410
411 Due to several of the above limitations, the most obvious use for the
412 ``AliasAnalysisCounter`` utility, collecting stats on all alias queries in a
413 compilation, doesn't work, even if the ``AliasAnalysis`` implementations don't
414 use ``FunctionPass``.  There's no way to set a default, much less a default
415 sequence, and there's no way to preserve it.
416
417 The ``AliasSetTracker`` class (which is used by ``LICM``) makes a
418 non-deterministic number of alias queries. This can cause stats collected by
419 ``AliasAnalysisCounter`` to have fluctuations among identical runs, for
420 example. Another consequence is that debugging techniques involving pausing
421 execution after a predetermined number of queries can be unreliable.
422
423 Many alias queries can be reformulated in terms of other alias queries. When
424 multiple ``AliasAnalysis`` queries are chained together, it would make sense to
425 start those queries from the beginning of the chain, with care taken to avoid
426 infinite looping, however currently an implementation which wants to do this can
427 only start such queries from itself.
428
429 Using alias analysis results
430 ============================
431
432 There are several different ways to use alias analysis results.  In order of
433 preference, these are:
434
435 Using the ``MemoryDependenceAnalysis`` Pass
436 -------------------------------------------
437
438 The ``memdep`` pass uses alias analysis to provide high-level dependence
439 information about memory-using instructions.  This will tell you which store
440 feeds into a load, for example.  It uses caching and other techniques to be
441 efficient, and is used by Dead Store Elimination, GVN, and memcpy optimizations.
442
443 .. _AliasSetTracker:
444
445 Using the ``AliasSetTracker`` class
446 -----------------------------------
447
448 Many transformations need information about alias **sets** that are active in
449 some scope, rather than information about pairwise aliasing.  The
450 `AliasSetTracker <http://llvm.org/doxygen/classllvm_1_1AliasSetTracker.html>`__
451 class is used to efficiently build these Alias Sets from the pairwise alias
452 analysis information provided by the ``AliasAnalysis`` interface.
453
454 First you initialize the AliasSetTracker by using the "``add``" methods to add
455 information about various potentially aliasing instructions in the scope you are
456 interested in.  Once all of the alias sets are completed, your pass should
457 simply iterate through the constructed alias sets, using the ``AliasSetTracker``
458 ``begin()``/``end()`` methods.
459
460 The ``AliasSet``\s formed by the ``AliasSetTracker`` are guaranteed to be
461 disjoint, calculate mod/ref information and volatility for the set, and keep
462 track of whether or not all of the pointers in the set are Must aliases.  The
463 AliasSetTracker also makes sure that sets are properly folded due to call
464 instructions, and can provide a list of pointers in each set.
465
466 As an example user of this, the `Loop Invariant Code Motion
467 <doxygen/structLICM.html>`_ pass uses ``AliasSetTracker``\s to calculate alias
468 sets for each loop nest.  If an ``AliasSet`` in a loop is not modified, then all
469 load instructions from that set may be hoisted out of the loop.  If any alias
470 sets are stored to **and** are must alias sets, then the stores may be sunk
471 to outside of the loop, promoting the memory location to a register for the
472 duration of the loop nest.  Both of these transformations only apply if the
473 pointer argument is loop-invariant.
474
475 The AliasSetTracker implementation
476 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
477
478 The AliasSetTracker class is implemented to be as efficient as possible.  It
479 uses the union-find algorithm to efficiently merge AliasSets when a pointer is
480 inserted into the AliasSetTracker that aliases multiple sets.  The primary data
481 structure is a hash table mapping pointers to the AliasSet they are in.
482
483 The AliasSetTracker class must maintain a list of all of the LLVM ``Value*``\s
484 that are in each AliasSet.  Since the hash table already has entries for each
485 LLVM ``Value*`` of interest, the AliasesSets thread the linked list through
486 these hash-table nodes to avoid having to allocate memory unnecessarily, and to
487 make merging alias sets extremely efficient (the linked list merge is constant
488 time).
489
490 You shouldn't need to understand these details if you are just a client of the
491 AliasSetTracker, but if you look at the code, hopefully this brief description
492 will help make sense of why things are designed the way they are.
493
494 Using the ``AliasAnalysis`` interface directly
495 ----------------------------------------------
496
497 If neither of these utility class are what your pass needs, you should use the
498 interfaces exposed by the ``AliasAnalysis`` class directly.  Try to use the
499 higher-level methods when possible (e.g., use mod/ref information instead of the
500 `alias`_ method directly if possible) to get the best precision and efficiency.
501
502 Existing alias analysis implementations and clients
503 ===================================================
504
505 If you're going to be working with the LLVM alias analysis infrastructure, you
506 should know what clients and implementations of alias analysis are available.
507 In particular, if you are implementing an alias analysis, you should be aware of
508 the `the clients`_ that are useful for monitoring and evaluating different
509 implementations.
510
511 .. _various alias analysis implementations:
512
513 Available ``AliasAnalysis`` implementations
514 -------------------------------------------
515
516 This section lists the various implementations of the ``AliasAnalysis``
517 interface.  With the exception of the :ref:`-no-aa <aliasanalysis-no-aa>`
518 implementation, all of these :ref:`chain <aliasanalysis-chaining>` to other
519 alias analysis implementations.
520
521 .. _aliasanalysis-no-aa:
522
523 The ``-no-aa`` pass
524 ^^^^^^^^^^^^^^^^^^^
525
526 The ``-no-aa`` pass is just like what it sounds: an alias analysis that never
527 returns any useful information.  This pass can be useful if you think that alias
528 analysis is doing something wrong and are trying to narrow down a problem.
529
530 The ``-basicaa`` pass
531 ^^^^^^^^^^^^^^^^^^^^^
532
533 The ``-basicaa`` pass is an aggressive local analysis that *knows* many
534 important facts:
535
536 * Distinct globals, stack allocations, and heap allocations can never alias.
537 * Globals, stack allocations, and heap allocations never alias the null pointer.
538 * Different fields of a structure do not alias.
539 * Indexes into arrays with statically differing subscripts cannot alias.
540 * Many common standard C library functions `never access memory or only read
541   memory`_.
542 * Pointers that obviously point to constant globals "``pointToConstantMemory``".
543 * Function calls can not modify or references stack allocations if they never
544   escape from the function that allocates them (a common case for automatic
545   arrays).
546
547 The ``-globalsmodref-aa`` pass
548 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
549
550 This pass implements a simple context-sensitive mod/ref and alias analysis for
551 internal global variables that don't "have their address taken".  If a global
552 does not have its address taken, the pass knows that no pointers alias the
553 global.  This pass also keeps track of functions that it knows never access
554 memory or never read memory.  This allows certain optimizations (e.g. GVN) to
555 eliminate call instructions entirely.
556
557 The real power of this pass is that it provides context-sensitive mod/ref
558 information for call instructions.  This allows the optimizer to know that calls
559 to a function do not clobber or read the value of the global, allowing loads and
560 stores to be eliminated.
561
562 .. note::
563
564   This pass is somewhat limited in its scope (only support non-address taken
565   globals), but is very quick analysis.
566
567 The ``-steens-aa`` pass
568 ^^^^^^^^^^^^^^^^^^^^^^^
569
570 The ``-steens-aa`` pass implements a variation on the well-known "Steensgaard's
571 algorithm" for interprocedural alias analysis.  Steensgaard's algorithm is a
572 unification-based, flow-insensitive, context-insensitive, and field-insensitive
573 alias analysis that is also very scalable (effectively linear time).
574
575 The LLVM ``-steens-aa`` pass implements a "speculatively field-**sensitive**"
576 version of Steensgaard's algorithm using the Data Structure Analysis framework.
577 This gives it substantially more precision than the standard algorithm while
578 maintaining excellent analysis scalability.
579
580 .. note::
581
582   ``-steens-aa`` is available in the optional "poolalloc" module. It is not part
583   of the LLVM core.
584
585 The ``-ds-aa`` pass
586 ^^^^^^^^^^^^^^^^^^^
587
588 The ``-ds-aa`` pass implements the full Data Structure Analysis algorithm.  Data
589 Structure Analysis is a modular unification-based, flow-insensitive,
590 context-**sensitive**, and speculatively field-**sensitive** alias
591 analysis that is also quite scalable, usually at ``O(n * log(n))``.
592
593 This algorithm is capable of responding to a full variety of alias analysis
594 queries, and can provide context-sensitive mod/ref information as well.  The
595 only major facility not implemented so far is support for must-alias
596 information.
597
598 .. note::
599
600   ``-ds-aa`` is available in the optional "poolalloc" module. It is not part of
601   the LLVM core.
602
603 The ``-scev-aa`` pass
604 ^^^^^^^^^^^^^^^^^^^^^
605
606 The ``-scev-aa`` pass implements AliasAnalysis queries by translating them into
607 ScalarEvolution queries. This gives it a more complete understanding of
608 ``getelementptr`` instructions and loop induction variables than other alias
609 analyses have.
610
611 Alias analysis driven transformations
612 -------------------------------------
613
614 LLVM includes several alias-analysis driven transformations which can be used
615 with any of the implementations above.
616
617 The ``-adce`` pass
618 ^^^^^^^^^^^^^^^^^^
619
620 The ``-adce`` pass, which implements Aggressive Dead Code Elimination uses the
621 ``AliasAnalysis`` interface to delete calls to functions that do not have
622 side-effects and are not used.
623
624 The ``-licm`` pass
625 ^^^^^^^^^^^^^^^^^^
626
627 The ``-licm`` pass implements various Loop Invariant Code Motion related
628 transformations.  It uses the ``AliasAnalysis`` interface for several different
629 transformations:
630
631 * It uses mod/ref information to hoist or sink load instructions out of loops if
632   there are no instructions in the loop that modifies the memory loaded.
633
634 * It uses mod/ref information to hoist function calls out of loops that do not
635   write to memory and are loop-invariant.
636
637 * If uses alias information to promote memory objects that are loaded and stored
638   to in loops to live in a register instead.  It can do this if there are no may
639   aliases to the loaded/stored memory location.
640
641 The ``-argpromotion`` pass
642 ^^^^^^^^^^^^^^^^^^^^^^^^^^
643
644 The ``-argpromotion`` pass promotes by-reference arguments to be passed in
645 by-value instead.  In particular, if pointer arguments are only loaded from it
646 passes in the value loaded instead of the address to the function.  This pass
647 uses alias information to make sure that the value loaded from the argument
648 pointer is not modified between the entry of the function and any load of the
649 pointer.
650
651 The ``-gvn``, ``-memcpyopt``, and ``-dse`` passes
652 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
653
654 These passes use AliasAnalysis information to reason about loads and stores.
655
656 .. _the clients:
657
658 Clients for debugging and evaluation of implementations
659 -------------------------------------------------------
660
661 These passes are useful for evaluating the various alias analysis
662 implementations.  You can use them with commands like:
663
664 .. code-block:: bash
665
666   % opt -ds-aa -aa-eval foo.bc -disable-output -stats
667
668 The ``-print-alias-sets`` pass
669 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
670
671 The ``-print-alias-sets`` pass is exposed as part of the ``opt`` tool to print
672 out the Alias Sets formed by the `AliasSetTracker`_ class.  This is useful if
673 you're using the ``AliasSetTracker`` class.  To use it, use something like:
674
675 .. code-block:: bash
676
677   % opt -ds-aa -print-alias-sets -disable-output
678
679 The ``-count-aa`` pass
680 ^^^^^^^^^^^^^^^^^^^^^^
681
682 The ``-count-aa`` pass is useful to see how many queries a particular pass is
683 making and what responses are returned by the alias analysis.  As an example:
684
685 .. code-block:: bash
686
687   % opt -basicaa -count-aa -ds-aa -count-aa -licm
688
689 will print out how many queries (and what responses are returned) by the
690 ``-licm`` pass (of the ``-ds-aa`` pass) and how many queries are made of the
691 ``-basicaa`` pass by the ``-ds-aa`` pass.  This can be useful when debugging a
692 transformation or an alias analysis implementation.
693
694 The ``-aa-eval`` pass
695 ^^^^^^^^^^^^^^^^^^^^^
696
697 The ``-aa-eval`` pass simply iterates through all pairs of pointers in a
698 function and asks an alias analysis whether or not the pointers alias.  This
699 gives an indication of the precision of the alias analysis.  Statistics are
700 printed indicating the percent of no/may/must aliases found (a more precise
701 algorithm will have a lower number of may aliases).
702
703 Memory Dependence Analysis
704 ==========================
705
706 If you're just looking to be a client of alias analysis information, consider
707 using the Memory Dependence Analysis interface instead.  MemDep is a lazy,
708 caching layer on top of alias analysis that is able to answer the question of
709 what preceding memory operations a given instruction depends on, either at an
710 intra- or inter-block level.  Because of its laziness and caching policy, using
711 MemDep can be a significant performance win over accessing alias analysis
712 directly.