docs/AliasAnalysis.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>LLVM Alias Analysis Infrastructure</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   LLVM Alias Analysis Infrastructure
  12 </div>
  13
  14 <ol>
  15   <li><a href="#introduction">Introduction</a></li>
  16
  17   <li><a href="#overview"><tt>AliasAnalysis</tt> Class Overview</a>
  18     <ul>
  19     <li><a href="#pointers">Representation of Pointers</a></li>
  20     <li><a href="#alias">The <tt>alias</tt> method</a></li>
  21     <li><a href="#ModRefInfo">The <tt>getModRefInfo</tt> methods</a></li>
  22     <li><a href="#OtherItfs">Other useful <tt>AliasAnalysis</tt> methods</a></li>
  23     </ul>
  24   </li>
  25
  26   <li><a href="#writingnew">Writing a new <tt>AliasAnalysis</tt> Implementation</a>
  27     <ul>
  28     <li><a href="#passsubclasses">Different Pass styles</a></li>
  29     <li><a href="#requiredcalls">Required initialization calls</a></li>
  30     <li><a href="#interfaces">Interfaces which may be specified</a></li>
  31     <li><a href="#chaining"><tt>AliasAnalysis</tt> chaining behavior</a></li>
  32     <li><a href="#updating">Updating analysis results for transformations</a></li>
  33     <li><a href="#implefficiency">Efficiency Issues</a></li>
  34     <li><a href="#passmanager">Pass Manager Issues</a></li>
  35     </ul>
  36   </li>
  37
  38   <li><a href="#using">Using alias analysis results</a>
  39     <ul>
  40     <li><a href="#memdep">Using the <tt>MemoryDependenceAnalysis</tt> Pass</a></li>
  41     <li><a href="#ast">Using the <tt>AliasSetTracker</tt> class</a></li>
  42     <li><a href="#direct">Using the <tt>AliasAnalysis</tt> interface directly</a></li>
  43     </ul>
  44   </li>
  45
  46   <li><a href="#exist">Existing alias analysis implementations and clients</a>
  47     <ul>
  48     <li><a href="#impls">Available <tt>AliasAnalysis</tt> implementations</a></li>
  49     <li><a href="#aliasanalysis-xforms">Alias analysis driven transformations</a></li>
  50     <li><a href="#aliasanalysis-debug">Clients for debugging and evaluation of
  51     implementations</a></li>
  52     </ul>
  53   </li>
  54   <li><a href="#memdep">Memory Dependence Analysis</a></li>
  55 </ol>
  56
  57 <div class="doc_author">
  58   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
  59 </div>
  60
  61 <!-- *********************************************************************** -->
  62 <div class="doc_section">
  63   <a name="introduction">Introduction</a>
  64 </div>
  65 <!-- *********************************************************************** -->
  66
  67 <div class="doc_text">
  68
  69 <p>Alias Analysis (aka Pointer Analysis) is a class of techniques which attempt
  70 to determine whether or not two pointers ever can point to the same object in
  71 memory.  There are many different algorithms for alias analysis and many
  72 different ways of classifying them: flow-sensitive vs flow-insensitive,
  73 context-sensitive vs context-insensitive, field-sensitive vs field-insensitive,
  74 unification-based vs subset-based, etc.  Traditionally, alias analyses respond
  75 to a query with a <a href="#MustMayNo">Must, May, or No</a> alias response,
  76 indicating that two pointers always point to the same object, might point to the
  77 same object, or are known to never point to the same object.</p>
  78
  79 <p>The LLVM <a
  80 href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html"><tt>AliasAnalysis</tt></a>
  81 class is the primary interface used by clients and implementations of alias
  82 analyses in the LLVM system.  This class is the common interface between clients
  83 of alias analysis information and the implementations providing it, and is
  84 designed to support a wide range of implementations and clients (but currently
  85 all clients are assumed to be flow-insensitive).  In addition to simple alias
  86 analysis information, this class exposes Mod/Ref information from those
  87 implementations which can provide it, allowing for powerful analyses and
  88 transformations to work well together.</p>
  89
  90 <p>This document contains information necessary to successfully implement this
  91 interface, use it, and to test both sides.  It also explains some of the finer
  92 points about what exactly results mean.  If you feel that something is unclear
  93 or should be added, please <a href="mailto:sabre@nondot.org">let me
  94 know</a>.</p>
  95
  96 </div>
  97
  98 <!-- *********************************************************************** -->
  99 <div class="doc_section">
 100   <a name="overview"><tt>AliasAnalysis</tt> Class Overview</a>
 101 </div>
 102 <!-- *********************************************************************** -->
 103
 104 <div class="doc_text">
 105
 106 <p>The <a
 107 href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html"><tt>AliasAnalysis</tt></a>
 108 class defines the interface that the various alias analysis implementations
 109 should support.  This class exports two important enums: <tt>AliasResult</tt>
 110 and <tt>ModRefResult</tt> which represent the result of an alias query or a
 111 mod/ref query, respectively.</p>
 112
 113 <p>The <tt>AliasAnalysis</tt> interface exposes information about memory,
 114 represented in several different ways.  In particular, memory objects are
 115 represented as a starting address and size, and function calls are represented
 116 as the actual <tt>call</tt> or <tt>invoke</tt> instructions that performs the
 117 call.  The <tt>AliasAnalysis</tt> interface also exposes some helper methods
 118 which allow you to get mod/ref information for arbitrary instructions.</p>
 119
 120 </div>
 121
 122 <!-- ======================================================================= -->
 123 <div class="doc_subsection">
 124   <a name="pointers">Representation of Pointers</a>
 125 </div>
 126
 127 <div class="doc_text">
 128
 129 <p>Most importantly, the <tt>AliasAnalysis</tt> class provides several methods
 130 which are used to query whether or not two memory objects alias, whether
 131 function calls can modify or read a memory object, etc.  For all of these
 132 queries, memory objects are represented as a pair of their starting address (a
 133 symbolic LLVM <tt>Value*</tt>) and a static size.</p>
 134
 135 <p>Representing memory objects as a starting address and a size is critically
 136 important for correct Alias Analyses.  For example, consider this (silly, but
 137 possible) C code:</p>
 138
 139 <div class="doc_code">
 140 <pre>
 141 int i;
 142 char C[2];
 143 char A[10];
 144 /* ... */
 145 for (i = 0; i != 10; ++i) {
 146   C[0] = A[i];          /* One byte store */
 147   C[1] = A[9-i];        /* One byte store */
 148 }
 149 </pre>
 150 </div>
 151
 152 <p>In this case, the <tt>basicaa</tt> pass will disambiguate the stores to
 153 <tt>C[0]</tt> and <tt>C[1]</tt> because they are accesses to two distinct
 154 locations one byte apart, and the accesses are each one byte.  In this case, the
 155 LICM pass can use store motion to remove the stores from the loop.  In
 156 constrast, the following code:</p>
 157
 158 <div class="doc_code">
 159 <pre>
 160 int i;
 161 char C[2];
 162 char A[10];
 163 /* ... */
 164 for (i = 0; i != 10; ++i) {
 165   ((short*)C)[0] = A[i];  /* Two byte store! */
 166   C[1] = A[9-i];          /* One byte store */
 167 }
 168 </pre>
 169 </div>
 170
 171 <p>In this case, the two stores to C do alias each other, because the access to
 172 the <tt>&amp;C[0]</tt> element is a two byte access.  If size information wasn't
 173 available in the query, even the first case would have to conservatively assume
 174 that the accesses alias.</p>
 175
 176 </div>
 177
 178 <!-- ======================================================================= -->
 179 <div class="doc_subsection">
 180   <a name="alias">The <tt>alias</tt> method</a>
 181 </div>
 182
 183 <div class="doc_text">
 184 The <tt>alias</tt> method is the primary interface used to determine whether or
 185 not two memory objects alias each other.  It takes two memory objects as input
 186 and returns MustAlias, MayAlias, or NoAlias as appropriate.
 187 </div>
 188
 189 <!-- _______________________________________________________________________ -->
 190 <div class="doc_subsubsection">
 191   <a name="MustMayNo">Must, May, and No Alias Responses</a>
 192 </div>
 193
 194 <div class="doc_text">
 195 <p>The NoAlias response may be used when there is never an immediate dependence
 196 between any memory reference <i>based</i> on one pointer and any memory
 197 reference <i>based</i> the other. The most obvious example is when the two
 198 pointers point to non-overlapping memory ranges. Another is when the two
 199 pointers are only ever used for reading memory. Another is when the memory is
 200 freed and reallocated between accesses through one pointer and accesses through
 201 the other -- in this case, there is a dependence, but it's mediated by the free
 202 and reallocation.</p>
 203
 204 <p>As an exception to this is with the
 205 <a href="LangRef.html#noalias"><tt>noalias</tt></a> keyword. AliasAnalysis
 206 implementations may choose to respect the <tt>noalias</tt> keyword and ignore
 207 the "irrelevant" dependencies, provided their clients do not need to be aware
 208 of these dependencies for correctness.</p>
 209
 210 <p>The MayAlias response is used whenever the two pointers might refer to the
 211 same object.  If the two memory objects overlap, but do not start at the same
 212 location, return MayAlias.</p>
 213
 214 <p>The MustAlias response may only be returned if the two memory objects are
 215 guaranteed to always start at exactly the same location. A MustAlias response
 216 implies that the pointers compare equal.</p>
 217
 218 </div>
 219
 220 <!-- ======================================================================= -->
 221 <div class="doc_subsection">
 222   <a name="ModRefInfo">The <tt>getModRefInfo</tt> methods</a>
 223 </div>
 224
 225 <div class="doc_text">
 226
 227 <p>The <tt>getModRefInfo</tt> methods return information about whether the
 228 execution of an instruction can read or modify a memory location.  Mod/Ref
 229 information is always conservative: if an instruction <b>might</b> read or write
 230 a location, ModRef is returned.</p>
 231
 232 <p>The <tt>AliasAnalysis</tt> class also provides a <tt>getModRefInfo</tt>
 233 method for testing dependencies between function calls.  This method takes two
 234 call sites (CS1 &amp; CS2), returns NoModRef if the two calls refer to disjoint
 235 memory locations, Ref if CS1 reads memory written by CS2, Mod if CS1 writes to
 236 memory read or written by CS2, or ModRef if CS1 might read or write memory
 237 accessed by CS2.  Note that this relation is not commutative.</p>
 238
 239 </div>
 240
 241
 242 <!-- ======================================================================= -->
 243 <div class="doc_subsection">
 244   <a name="OtherItfs">Other useful <tt>AliasAnalysis</tt> methods</a>
 245 </div>
 246
 247 <div class="doc_text">
 248
 249 <p>
 250 Several other tidbits of information are often collected by various alias
 251 analysis implementations and can be put to good use by various clients.
 252 </p>
 253
 254 </div>
 255
 256 <!-- _______________________________________________________________________ -->
 257 <div class="doc_subsubsection">
 258   The <tt>pointsToConstantMemory</tt> method
 259 </div>
 260
 261 <div class="doc_text">
 262
 263 <p>The <tt>pointsToConstantMemory</tt> method returns true if and only if the
 264 analysis can prove that the pointer only points to unchanging memory locations
 265 (functions, constant global variables, and the null pointer).  This information
 266 can be used to refine mod/ref information: it is impossible for an unchanging
 267 memory location to be modified.</p>
 268
 269 </div>
 270
 271 <!-- _______________________________________________________________________ -->
 272 <div class="doc_subsubsection">
 273   <a name="simplemodref">The <tt>doesNotAccessMemory</tt> and
 274   <tt>onlyReadsMemory</tt> methods</a>
 275 </div>
 276
 277 <div class="doc_text">
 278
 279 <p>These methods are used to provide very simple mod/ref information for
 280 function calls.  The <tt>doesNotAccessMemory</tt> method returns true for a
 281 function if the analysis can prove that the function never reads or writes to
 282 memory, or if the function only reads from constant memory.  Functions with this
 283 property are side-effect free and only depend on their input arguments, allowing
 284 them to be eliminated if they form common subexpressions or be hoisted out of
 285 loops.  Many common functions behave this way (e.g., <tt>sin</tt> and
 286 <tt>cos</tt>) but many others do not (e.g., <tt>acos</tt>, which modifies the
 287 <tt>errno</tt> variable).</p>
 288
 289 <p>The <tt>onlyReadsMemory</tt> method returns true for a function if analysis
 290 can prove that (at most) the function only reads from non-volatile memory.
 291 Functions with this property are side-effect free, only depending on their input
 292 arguments and the state of memory when they are called.  This property allows
 293 calls to these functions to be eliminated and moved around, as long as there is
 294 no store instruction that changes the contents of memory.  Note that all
 295 functions that satisfy the <tt>doesNotAccessMemory</tt> method also satisfies
 296 <tt>onlyReadsMemory</tt>.</p>
 297
 298 </div>
 299
 300 <!-- *********************************************************************** -->
 301 <div class="doc_section">
 302   <a name="writingnew">Writing a new <tt>AliasAnalysis</tt> Implementation</a>
 303 </div>
 304 <!-- *********************************************************************** -->
 305
 306 <div class="doc_text">
 307
 308 <p>Writing a new alias analysis implementation for LLVM is quite
 309 straight-forward.  There are already several implementations that you can use
 310 for examples, and the following information should help fill in any details.
 311 For a examples, take a look at the <a href="#impls">various alias analysis
 312 implementations</a> included with LLVM.</p>
 313
 314 </div>
 315
 316 <!-- ======================================================================= -->
 317 <div class="doc_subsection">
 318   <a name="passsubclasses">Different Pass styles</a>
 319 </div>
 320
 321 <div class="doc_text">
 322
 323 <p>The first step to determining what type of <a
 324 href="WritingAnLLVMPass.html">LLVM pass</a> you need to use for your Alias
 325 Analysis.  As is the case with most other analyses and transformations, the
 326 answer should be fairly obvious from what type of problem you are trying to
 327 solve:</p>
 328
 329 <ol>
 330   <li>If you require interprocedural analysis, it should be a
 331       <tt>Pass</tt>.</li>
 332   <li>If you are a function-local analysis, subclass <tt>FunctionPass</tt>.</li>
 333   <li>If you don't need to look at the program at all, subclass
 334       <tt>ImmutablePass</tt>.</li>
 335 </ol>
 336
 337 <p>In addition to the pass that you subclass, you should also inherit from the
 338 <tt>AliasAnalysis</tt> interface, of course, and use the
 339 <tt>RegisterAnalysisGroup</tt> template to register as an implementation of
 340 <tt>AliasAnalysis</tt>.</p>
 341
 342 </div>
 343
 344 <!-- ======================================================================= -->
 345 <div class="doc_subsection">
 346   <a name="requiredcalls">Required initialization calls</a>
 347 </div>
 348
 349 <div class="doc_text">
 350
 351 <p>Your subclass of <tt>AliasAnalysis</tt> is required to invoke two methods on
 352 the <tt>AliasAnalysis</tt> base class: <tt>getAnalysisUsage</tt> and
 353 <tt>InitializeAliasAnalysis</tt>.  In particular, your implementation of
 354 <tt>getAnalysisUsage</tt> should explicitly call into the
 355 <tt>AliasAnalysis::getAnalysisUsage</tt> method in addition to doing any
 356 declaring any pass dependencies your pass has.  Thus you should have something
 357 like this:</p>
 358
 359 <div class="doc_code">
 360 <pre>
 361 void getAnalysisUsage(AnalysisUsage &amp;AU) const {
 362   AliasAnalysis::getAnalysisUsage(AU);
 363   <i>// declare your dependencies here.</i>
 364 }
 365 </pre>
 366 </div>
 367
 368 <p>Additionally, your must invoke the <tt>InitializeAliasAnalysis</tt> method
 369 from your analysis run method (<tt>run</tt> for a <tt>Pass</tt>,
 370 <tt>runOnFunction</tt> for a <tt>FunctionPass</tt>, or <tt>InitializePass</tt>
 371 for an <tt>ImmutablePass</tt>).  For example (as part of a <tt>Pass</tt>):</p>
 372
 373 <div class="doc_code">
 374 <pre>
 375 bool run(Module &amp;M) {
 376   InitializeAliasAnalysis(this);
 377   <i>// Perform analysis here...</i>
 378   return false;
 379 }
 380 </pre>
 381 </div>
 382
 383 </div>
 384
 385 <!-- ======================================================================= -->
 386 <div class="doc_subsection">
 387   <a name="interfaces">Interfaces which may be specified</a>
 388 </div>
 389
 390 <div class="doc_text">
 391
 392 <p>All of the <a
 393 href="/doxygen/classllvm_1_1AliasAnalysis.html"><tt>AliasAnalysis</tt></a>
 394 virtual methods default to providing <a href="#chaining">chaining</a> to another
 395 alias analysis implementation, which ends up returning conservatively correct
 396 information (returning "May" Alias and "Mod/Ref" for alias and mod/ref queries
 397 respectively).  Depending on the capabilities of the analysis you are
 398 implementing, you just override the interfaces you can improve.</p>
 399
 400 </div>
 401
 402
 403
 404 <!-- ======================================================================= -->
 405 <div class="doc_subsection">
 406   <a name="chaining"><tt>AliasAnalysis</tt> chaining behavior</a>
 407 </div>
 408
 409 <div class="doc_text">
 410
 411 <p>With only two special exceptions (the <tt><a
 412 href="#basic-aa">basicaa</a></tt> and <a href="#no-aa"><tt>no-aa</tt></a>
 413 passes) every alias analysis pass chains to another alias analysis
 414 implementation (for example, the user can specify "<tt>-basicaa -ds-aa
 415 -licm</tt>" to get the maximum benefit from both alias
 416 analyses).  The alias analysis class automatically takes care of most of this
 417 for methods that you don't override.  For methods that you do override, in code
 418 paths that return a conservative MayAlias or Mod/Ref result, simply return
 419 whatever the superclass computes.  For example:</p>
 420
 421 <div class="doc_code">
 422 <pre>
 423 AliasAnalysis::AliasResult alias(const Value *V1, unsigned V1Size,
 424                                  const Value *V2, unsigned V2Size) {
 425   if (...)
 426     return NoAlias;
 427   ...
 428
 429   <i>// Couldn't determine a must or no-alias result.</i>
 430   return AliasAnalysis::alias(V1, V1Size, V2, V2Size);
 431 }
 432 </pre>
 433 </div>
 434
 435 <p>In addition to analysis queries, you must make sure to unconditionally pass
 436 LLVM <a href="#updating">update notification</a> methods to the superclass as
 437 well if you override them, which allows all alias analyses in a change to be
 438 updated.</p>
 439
 440 </div>
 441
 442
 443 <!-- ======================================================================= -->
 444 <div class="doc_subsection">
 445   <a name="updating">Updating analysis results for transformations</a>
 446 </div>
 447
 448 <div class="doc_text">
 449 <p>
 450 Alias analysis information is initially computed for a static snapshot of the
 451 program, but clients will use this information to make transformations to the
 452 code.  All but the most trivial forms of alias analysis will need to have their
 453 analysis results updated to reflect the changes made by these transformations.
 454 </p>
 455
 456 <p>
 457 The <tt>AliasAnalysis</tt> interface exposes two methods which are used to
 458 communicate program changes from the clients to the analysis implementations.
 459 Various alias analysis implementations should use these methods to ensure that
 460 their internal data structures are kept up-to-date as the program changes (for
 461 example, when an instruction is deleted), and clients of alias analysis must be
 462 sure to call these interfaces appropriately.
 463 </p>
 464 </div>
 465
 466 <!-- _______________________________________________________________________ -->
 467 <div class="doc_subsubsection">The <tt>deleteValue</tt> method</div>
 468
 469 <div class="doc_text">
 470 The <tt>deleteValue</tt> method is called by transformations when they remove an
 471 instruction or any other value from the program (including values that do not
 472 use pointers).  Typically alias analyses keep data structures that have entries
 473 for each value in the program.  When this method is called, they should remove
 474 any entries for the specified value, if they exist.
 475 </div>
 476
 477 <!-- _______________________________________________________________________ -->
 478 <div class="doc_subsubsection">The <tt>copyValue</tt> method</div>
 479
 480 <div class="doc_text">
 481 The <tt>copyValue</tt> method is used when a new value is introduced into the
 482 program.  There is no way to introduce a value into the program that did not
 483 exist before (this doesn't make sense for a safe compiler transformation), so
 484 this is the only way to introduce a new value.  This method indicates that the
 485 new value has exactly the same properties as the value being copied.
 486 </div>
 487
 488 <!-- _______________________________________________________________________ -->
 489 <div class="doc_subsubsection">The <tt>replaceWithNewValue</tt> method</div>
 490
 491 <div class="doc_text">
 492 This method is a simple helper method that is provided to make clients easier to
 493 use.  It is implemented by copying the old analysis information to the new
 494 value, then deleting the old value.  This method cannot be overridden by alias
 495 analysis implementations.
 496 </div>
 497
 498 <!-- ======================================================================= -->
 499 <div class="doc_subsection">
 500   <a name="implefficiency">Efficiency Issues</a>
 501 </div>
 502
 503 <div class="doc_text">
 504
 505 <p>From the LLVM perspective, the only thing you need to do to provide an
 506 efficient alias analysis is to make sure that alias analysis <b>queries</b> are
 507 serviced quickly.  The actual calculation of the alias analysis results (the
 508 "run" method) is only performed once, but many (perhaps duplicate) queries may
 509 be performed.  Because of this, try to move as much computation to the run
 510 method as possible (within reason).</p>
 511
 512 </div>
 513
 514 <!-- ======================================================================= -->
 515 <div class="doc_subsection">
 516   <a name="passmanager">Pass Manager Issues</a>
 517 </div>
 518
 519 <div class="doc_text">
 520
 521 <p>PassManager support for alternative AliasAnalysis implementation
 522 has some issues.</p>
 523
 524 <p>There is no way to override the default alias analysis. It would
 525 be very useful to be able to do something like "opt -my-aa -O2" and
 526 have it use -my-aa for all passes which need AliasAnalysis, but there
 527 is currently no support for that, short of changing the source code
 528 and recompiling. Similarly, there is also no way of setting a chain
 529 of analyses as the default.</p>
 530
 531 <p>There is no way for transform passes to declare that they preserve
 532 <tt>AliasAnalysis</tt> implementations. The <tt>AliasAnalysis</tt>
 533 interface includes <tt>deleteValue</tt> and <tt>copyValue</tt> methods
 534 which are intended to allow a pass to keep an AliasAnalysis consistent,
 535 however there's no way for a pass to declare in its
 536 <tt>getAnalysisUsage</tt> that it does so. Some passes attempt to use
 537 <tt>AU.addPreserved&lt;AliasAnalysis&gt;</tt>, however this doesn't
 538 actually have any effect.</tt>
 539
 540 <p><tt>AliasAnalysisCounter</tt> (<tt>-count-aa</tt>) and <tt>AliasDebugger</tt>
 541 (<tt>-debug-aa</tt>) are implemented as <tt>ModulePass</tt> classes, so if your
 542 alias analysis uses <tt>FunctionPass</tt>, it won't be able to use
 543 these utilities. If you try to use them, the pass manager will
 544 silently route alias analysis queries directly to
 545 <tt>BasicAliasAnalysis</tt> instead.</p>
 546
 547 <p>Similarly, the <tt>opt -p</tt> option introduces <tt>ModulePass</tt>
 548 passes between each pass, which prevents the use of <tt>FunctionPass</tt>
 549 alias analysis passes.</p>
 550
 551 </div>
 552
 553 <!-- *********************************************************************** -->
 554 <div class="doc_section">
 555   <a name="using">Using alias analysis results</a>
 556 </div>
 557 <!-- *********************************************************************** -->
 558
 559 <div class="doc_text">
 560
 561 <p>There are several different ways to use alias analysis results.  In order of
 562 preference, these are...</p>
 563
 564 </div>
 565
 566 <!-- ======================================================================= -->
 567 <div class="doc_subsection">
 568   <a name="memdep">Using the <tt>MemoryDependenceAnalysis</tt> Pass</a>
 569 </div>
 570
 571 <div class="doc_text">
 572
 573 <p>The <tt>memdep</tt> pass uses alias analysis to provide high-level dependence
 574 information about memory-using instructions.  This will tell you which store
 575 feeds into a load, for example.  It uses caching and other techniques to be
 576 efficient, and is used by Dead Store Elimination, GVN, and memcpy optimizations.
 577 </p>
 578
 579 </div>
 580
 581 <!-- ======================================================================= -->
 582 <div class="doc_subsection">
 583   <a name="ast">Using the <tt>AliasSetTracker</tt> class</a>
 584 </div>
 585
 586 <div class="doc_text">
 587
 588 <p>Many transformations need information about alias <b>sets</b> that are active
 589 in some scope, rather than information about pairwise aliasing.  The <tt><a
 590 href="/doxygen/classllvm_1_1AliasSetTracker.html">AliasSetTracker</a></tt> class
 591 is used to efficiently build these Alias Sets from the pairwise alias analysis
 592 information provided by the <tt>AliasAnalysis</tt> interface.</p>
 593
 594 <p>First you initialize the AliasSetTracker by using the "<tt>add</tt>" methods
 595 to add information about various potentially aliasing instructions in the scope
 596 you are interested in.  Once all of the alias sets are completed, your pass
 597 should simply iterate through the constructed alias sets, using the
 598 <tt>AliasSetTracker</tt> <tt>begin()</tt>/<tt>end()</tt> methods.</p>
 599
 600 <p>The <tt>AliasSet</tt>s formed by the <tt>AliasSetTracker</tt> are guaranteed
 601 to be disjoint, calculate mod/ref information and volatility for the set, and
 602 keep track of whether or not all of the pointers in the set are Must aliases.
 603 The AliasSetTracker also makes sure that sets are properly folded due to call
 604 instructions, and can provide a list of pointers in each set.</p>
 605
 606 <p>As an example user of this, the <a href="/doxygen/structLICM.html">Loop
 607 Invariant Code Motion</a> pass uses <tt>AliasSetTracker</tt>s to calculate alias
 608 sets for each loop nest.  If an <tt>AliasSet</tt> in a loop is not modified,
 609 then all load instructions from that set may be hoisted out of the loop.  If any
 610 alias sets are stored to <b>and</b> are must alias sets, then the stores may be
 611 sunk to outside of the loop, promoting the memory location to a register for the
 612 duration of the loop nest.  Both of these transformations only apply if the
 613 pointer argument is loop-invariant.</p>
 614
 615 </div>
 616
 617 <!-- _______________________________________________________________________ -->
 618 <div class="doc_subsubsection">
 619   The AliasSetTracker implementation
 620 </div>
 621
 622 <div class="doc_text">
 623
 624 <p>The AliasSetTracker class is implemented to be as efficient as possible.  It
 625 uses the union-find algorithm to efficiently merge AliasSets when a pointer is
 626 inserted into the AliasSetTracker that aliases multiple sets.  The primary data
 627 structure is a hash table mapping pointers to the AliasSet they are in.</p>
 628
 629 <p>The AliasSetTracker class must maintain a list of all of the LLVM Value*'s
 630 that are in each AliasSet.  Since the hash table already has entries for each
 631 LLVM Value* of interest, the AliasesSets thread the linked list through these
 632 hash-table nodes to avoid having to allocate memory unnecessarily, and to make
 633 merging alias sets extremely efficient (the linked list merge is constant time).
 634 </p>
 635
 636 <p>You shouldn't need to understand these details if you are just a client of
 637 the AliasSetTracker, but if you look at the code, hopefully this brief
 638 description will help make sense of why things are designed the way they
 639 are.</p>
 640
 641 </div>
 642
 643 <!-- ======================================================================= -->
 644 <div class="doc_subsection">
 645   <a name="direct">Using the <tt>AliasAnalysis</tt> interface directly</a>
 646 </div>
 647
 648 <div class="doc_text">
 649
 650 <p>If neither of these utility class are what your pass needs, you should use
 651 the interfaces exposed by the <tt>AliasAnalysis</tt> class directly.  Try to use
 652 the higher-level methods when possible (e.g., use mod/ref information instead of
 653 the <a href="#alias"><tt>alias</tt></a> method directly if possible) to get the
 654 best precision and efficiency.</p>
 655
 656 </div>
 657
 658 <!-- *********************************************************************** -->
 659 <div class="doc_section">
 660   <a name="exist">Existing alias analysis implementations and clients</a>
 661 </div>
 662 <!-- *********************************************************************** -->
 663
 664 <div class="doc_text">
 665
 666 <p>If you're going to be working with the LLVM alias analysis infrastructure,
 667 you should know what clients and implementations of alias analysis are
 668 available.  In particular, if you are implementing an alias analysis, you should
 669 be aware of the <a href="#aliasanalysis-debug">the clients</a> that are useful
 670 for monitoring and evaluating different implementations.</p>
 671
 672 </div>
 673
 674 <!-- ======================================================================= -->
 675 <div class="doc_subsection">
 676   <a name="impls">Available <tt>AliasAnalysis</tt> implementations</a>
 677 </div>
 678
 679 <div class="doc_text">
 680
 681 <p>This section lists the various implementations of the <tt>AliasAnalysis</tt>
 682 interface.  With the exception of the <a href="#no-aa"><tt>-no-aa</tt></a> and
 683 <a href="#basic-aa"><tt>-basicaa</tt></a> implementations, all of these <a
 684 href="#chaining">chain</a> to other alias analysis implementations.</p>
 685
 686 </div>
 687
 688 <!-- _______________________________________________________________________ -->
 689 <div class="doc_subsubsection">
 690   <a name="no-aa">The <tt>-no-aa</tt> pass</a>
 691 </div>
 692
 693 <div class="doc_text">
 694
 695 <p>The <tt>-no-aa</tt> pass is just like what it sounds: an alias analysis that
 696 never returns any useful information.  This pass can be useful if you think that
 697 alias analysis is doing something wrong and are trying to narrow down a
 698 problem.</p>
 699
 700 </div>
 701
 702 <!-- _______________________________________________________________________ -->
 703 <div class="doc_subsubsection">
 704   <a name="basic-aa">The <tt>-basicaa</tt> pass</a>
 705 </div>
 706
 707 <div class="doc_text">
 708
 709 <p>The <tt>-basicaa</tt> pass is the default LLVM alias analysis.  It is an
 710 aggressive local analysis that "knows" many important facts:</p>
 711
 712 <ul>
 713 <li>Distinct globals, stack allocations, and heap allocations can never
 714     alias.</li>
 715 <li>Globals, stack allocations, and heap allocations never alias the null
 716     pointer.</li>
 717 <li>Different fields of a structure do not alias.</li>
 718 <li>Indexes into arrays with statically differing subscripts cannot alias.</li>
 719 <li>Many common standard C library functions <a
 720     href="#simplemodref">never access memory or only read memory</a>.</li>
 721 <li>Pointers that obviously point to constant globals
 722     "<tt>pointToConstantMemory</tt>".</li>
 723 <li>Function calls can not modify or references stack allocations if they never
 724     escape from the function that allocates them (a common case for automatic
 725     arrays).</li>
 726 </ul>
 727
 728 </div>
 729
 730 <!-- _______________________________________________________________________ -->
 731 <div class="doc_subsubsection">
 732   <a name="globalsmodref">The <tt>-globalsmodref-aa</tt> pass</a>
 733 </div>
 734
 735 <div class="doc_text">
 736
 737 <p>This pass implements a simple context-sensitive mod/ref and alias analysis
 738 for internal global variables that don't "have their address taken".  If a
 739 global does not have its address taken, the pass knows that no pointers alias
 740 the global.  This pass also keeps track of functions that it knows never access
 741 memory or never read memory.  This allows certain optimizations (e.g. GVN) to
 742 eliminate call instructions entirely.
 743 </p>
 744
 745 <p>The real power of this pass is that it provides context-sensitive mod/ref
 746 information for call instructions.  This allows the optimizer to know that
 747 calls to a function do not clobber or read the value of the global, allowing
 748 loads and stores to be eliminated.</p>
 749
 750 <p>Note that this pass is somewhat limited in its scope (only support
 751 non-address taken globals), but is very quick analysis.</p>
 752 </div>
 753
 754 <!-- _______________________________________________________________________ -->
 755 <div class="doc_subsubsection">
 756   <a name="steens-aa">The <tt>-steens-aa</tt> pass</a>
 757 </div>
 758
 759 <div class="doc_text">
 760
 761 <p>The <tt>-steens-aa</tt> pass implements a variation on the well-known
 762 "Steensgaard's algorithm" for interprocedural alias analysis.  Steensgaard's
 763 algorithm is a unification-based, flow-insensitive, context-insensitive, and
 764 field-insensitive alias analysis that is also very scalable (effectively linear
 765 time).</p>
 766
 767 <p>The LLVM <tt>-steens-aa</tt> pass implements a "speculatively
 768 field-<b>sensitive</b>" version of Steensgaard's algorithm using the Data
 769 Structure Analysis framework.  This gives it substantially more precision than
 770 the standard algorithm while maintaining excellent analysis scalability.</p>
 771
 772 <p>Note that <tt>-steens-aa</tt> is available in the optional "poolalloc"
 773 module, it is not part of the LLVM core.</p>
 774
 775 </div>
 776
 777 <!-- _______________________________________________________________________ -->
 778 <div class="doc_subsubsection">
 779   <a name="ds-aa">The <tt>-ds-aa</tt> pass</a>
 780 </div>
 781
 782 <div class="doc_text">
 783
 784 <p>The <tt>-ds-aa</tt> pass implements the full Data Structure Analysis
 785 algorithm.  Data Structure Analysis is a modular unification-based,
 786 flow-insensitive, context-<b>sensitive</b>, and speculatively
 787 field-<b>sensitive</b> alias analysis that is also quite scalable, usually at
 788 O(n*log(n)).</p>
 789
 790 <p>This algorithm is capable of responding to a full variety of alias analysis
 791 queries, and can provide context-sensitive mod/ref information as well.  The
 792 only major facility not implemented so far is support for must-alias
 793 information.</p>
 794
 795 <p>Note that <tt>-ds-aa</tt> is available in the optional "poolalloc"
 796 module, it is not part of the LLVM core.</p>
 797
 798 </div>
 799
 800 <!-- _______________________________________________________________________ -->
 801 <div class="doc_subsubsection">
 802   <a name="scev-aa">The <tt>-scev-aa</tt> pass</a>
 803 </div>
 804
 805 <div class="doc_text">
 806
 807 <p>The <tt>-scev-aa</tt> pass implements AliasAnalysis queries by
 808 translating them into ScalarEvolution queries. This gives it a
 809 more complete understanding of <tt>getelementptr</tt> instructions
 810 and loop induction variables than other alias analyses have.</p>
 811
 812 </div>
 813
 814 <!-- ======================================================================= -->
 815 <div class="doc_subsection">
 816   <a name="aliasanalysis-xforms">Alias analysis driven transformations</a>
 817 </div>
 818
 819 <div class="doc_text">
 820 LLVM includes several alias-analysis driven transformations which can be used
 821 with any of the implementations above.
 822 </div>
 823
 824 <!-- _______________________________________________________________________ -->
 825 <div class="doc_subsubsection">
 826   <a name="adce">The <tt>-adce</tt> pass</a>
 827 </div>
 828
 829 <div class="doc_text">
 830
 831 <p>The <tt>-adce</tt> pass, which implements Aggressive Dead Code Elimination
 832 uses the <tt>AliasAnalysis</tt> interface to delete calls to functions that do
 833 not have side-effects and are not used.</p>
 834
 835 </div>
 836
 837
 838 <!-- _______________________________________________________________________ -->
 839 <div class="doc_subsubsection">
 840   <a name="licm">The <tt>-licm</tt> pass</a>
 841 </div>
 842
 843 <div class="doc_text">
 844
 845 <p>The <tt>-licm</tt> pass implements various Loop Invariant Code Motion related
 846 transformations.  It uses the <tt>AliasAnalysis</tt> interface for several
 847 different transformations:</p>
 848
 849 <ul>
 850 <li>It uses mod/ref information to hoist or sink load instructions out of loops
 851 if there are no instructions in the loop that modifies the memory loaded.</li>
 852
 853 <li>It uses mod/ref information to hoist function calls out of loops that do not
 854 write to memory and are loop-invariant.</li>
 855
 856 <li>If uses alias information to promote memory objects that are loaded and
 857 stored to in loops to live in a register instead.  It can do this if there are
 858 no may aliases to the loaded/stored memory location.</li>
 859 </ul>
 860
 861 </div>
 862
 863 <!-- _______________________________________________________________________ -->
 864 <div class="doc_subsubsection">
 865   <a name="argpromotion">The <tt>-argpromotion</tt> pass</a>
 866 </div>
 867
 868 <div class="doc_text">
 869 <p>
 870 The <tt>-argpromotion</tt> pass promotes by-reference arguments to be passed in
 871 by-value instead.  In particular, if pointer arguments are only loaded from it
 872 passes in the value loaded instead of the address to the function.  This pass
 873 uses alias information to make sure that the value loaded from the argument
 874 pointer is not modified between the entry of the function and any load of the
 875 pointer.</p>
 876 </div>
 877
 878 <!-- _______________________________________________________________________ -->
 879 <div class="doc_subsubsection">
 880   <a name="gvn">The <tt>-gvn</tt>, <tt>-memcpyopt</tt>, and <tt>-dse</tt>
 881      passes</a>
 882 </div>
 883
 884 <div class="doc_text">
 885
 886 <p>These passes use AliasAnalysis information to reason about loads and stores.
 887 </p>
 888
 889 </div>
 890
 891 <!-- ======================================================================= -->
 892 <div class="doc_subsection">
 893   <a name="aliasanalysis-debug">Clients for debugging and evaluation of
 894   implementations</a>
 895 </div>
 896
 897 <div class="doc_text">
 898
 899 <p>These passes are useful for evaluating the various alias analysis
 900 implementations.  You can use them with commands like '<tt>opt -ds-aa
 901 -aa-eval foo.bc -disable-output -stats</tt>'.</p>
 902
 903 </div>
 904
 905 <!-- _______________________________________________________________________ -->
 906 <div class="doc_subsubsection">
 907   <a name="print-alias-sets">The <tt>-print-alias-sets</tt> pass</a>
 908 </div>
 909
 910 <div class="doc_text">
 911
 912 <p>The <tt>-print-alias-sets</tt> pass is exposed as part of the
 913 <tt>opt</tt> tool to print out the Alias Sets formed by the <a
 914 href="#ast"><tt>AliasSetTracker</tt></a> class.  This is useful if you're using
 915 the <tt>AliasSetTracker</tt> class.  To use it, use something like:</p>
 916
 917 <div class="doc_code">
 918 <pre>
 919 % opt -ds-aa -print-alias-sets -disable-output
 920 </pre>
 921 </div>
 922
 923 </div>
 924
 925
 926 <!-- _______________________________________________________________________ -->
 927 <div class="doc_subsubsection">
 928   <a name="count-aa">The <tt>-count-aa</tt> pass</a>
 929 </div>
 930
 931 <div class="doc_text">
 932
 933 <p>The <tt>-count-aa</tt> pass is useful to see how many queries a particular
 934 pass is making and what responses are returned by the alias analysis.  As an
 935 example,</p>
 936
 937 <div class="doc_code">
 938 <pre>
 939 % opt -basicaa -count-aa -ds-aa -count-aa -licm
 940 </pre>
 941 </div>
 942
 943 <p>will print out how many queries (and what responses are returned) by the
 944 <tt>-licm</tt> pass (of the <tt>-ds-aa</tt> pass) and how many queries are made
 945 of the <tt>-basicaa</tt> pass by the <tt>-ds-aa</tt> pass.  This can be useful
 946 when debugging a transformation or an alias analysis implementation.</p>
 947
 948 </div>
 949
 950 <!-- _______________________________________________________________________ -->
 951 <div class="doc_subsubsection">
 952   <a name="aa-eval">The <tt>-aa-eval</tt> pass</a>
 953 </div>
 954
 955 <div class="doc_text">
 956
 957 <p>The <tt>-aa-eval</tt> pass simply iterates through all pairs of pointers in a
 958 function and asks an alias analysis whether or not the pointers alias.  This
 959 gives an indication of the precision of the alias analysis.  Statistics are
 960 printed indicating the percent of no/may/must aliases found (a more precise
 961 algorithm will have a lower number of may aliases).</p>
 962
 963 </div>
 964
 965 <!-- *********************************************************************** -->
 966 <div class="doc_section">
 967   <a name="memdep">Memory Dependence Analysis</a>
 968 </div>
 969 <!-- *********************************************************************** -->
 970
 971 <div class="doc_text">
 972
 973 <p>If you're just looking to be a client of alias analysis information, consider
 974 using the Memory Dependence Analysis interface instead.  MemDep is a lazy,
 975 caching layer on top of alias analysis that is able to answer the question of
 976 what preceding memory operations a given instruction depends on, either at an
 977 intra- or inter-block level.  Because of its laziness and caching
 978 policy, using MemDep can be a significant performance win over accessing alias
 979 analysis directly.</p>
 980
 981 </div>
 982
 983 <!-- *********************************************************************** -->
 984
 985 <hr>
 986 <address>
 987   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 988   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
 989   <a href="http://validator.w3.org/check/referer"><img
 990   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 991
 992   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
 993   <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
 994   Last modified: $Date$
 995 </address>
 996
 997 </body>
 998 </html>