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