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