docs/WritingAnLLVMPass.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>Writing an LLVM Pass</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   Writing an LLVM Pass
  12 </div>
  13
  14 <ol>
  15   <li><a href="#introduction">Introduction - What is a pass?</a></li>
  16   <li><a href="#quickstart">Quick Start - Writing hello world</a>
  17     <ul>
  18     <li><a href="#makefile">Setting up the build environment</a></li>
  19     <li><a href="#basiccode">Basic code required</a></li>
  20     <li><a href="#running">Running a pass with <tt>opt</tt>
  21                  or <tt>analyze</tt></a></li>
  22     </ul></li>
  23   <li><a href="#passtype">Pass classes and requirements</a>
  24      <ul>
  25      <li><a href="#ImmutablePass">The <tt>ImmutablePass</tt> class</a></li>
  26      <li><a href="#ModulePass">The <tt>ModulePass</tt> class</a>
  27         <ul>
  28         <li><a href="#runOnModule">The <tt>runOnModule</tt> method</a></li>
  29         </ul></li>
  30      <li><a href="#CallGraphSCCPass">The <tt>CallGraphSCCPass</tt> class</a>
  31         <ul>
  32         <li><a href="#doInitialization_scc">The <tt>doInitialization(Module
  33                                            &amp;)</tt> method</a></li>
  34         <li><a href="#runOnSCC">The <tt>runOnSCC</tt> method</a></li>
  35         <li><a href="#doFinalization_scc">The <tt>doFinalization(Module
  36                                            &amp;)</tt> method</a></li>
  37         </ul></li>
  38      <li><a href="#FunctionPass">The <tt>FunctionPass</tt> class</a>
  39         <ul>
  40         <li><a href="#doInitialization_mod">The <tt>doInitialization(Module
  41                                             &amp;)</tt> method</a></li>
  42         <li><a href="#runOnFunction">The <tt>runOnFunction</tt> method</a></li>
  43         <li><a href="#doFinalization_mod">The <tt>doFinalization(Module
  44                                             &amp;)</tt> method</a></li>
  45         </ul></li>
  46      <li><a href="#BasicBlockPass">The <tt>BasicBlockPass</tt> class</a>
  47         <ul>
  48         <li><a href="#doInitialization_fn">The <tt>doInitialization(Function
  49                                              &amp;)</tt> method</a></li>
  50         <li><a href="#runOnBasicBlock">The <tt>runOnBasicBlock</tt>
  51                                        method</a></li>
  52         <li><a href="#doFinalization_fn">The <tt>doFinalization(Function
  53                                          &amp;)</tt> method</a></li>
  54         </ul></li>
  55      <li><a href="#MachineFunctionPass">The <tt>MachineFunctionPass</tt>
  56                                         class</a>
  57         <ul>
  58         <li><a href="#runOnMachineFunction">The
  59             <tt>runOnMachineFunction(MachineFunction &amp;)</tt> method</a></li>
  60         </ul></li>
  61      </ul>
  62   <li><a href="#registration">Pass Registration</a>
  63      <ul>
  64      <li><a href="#print">The <tt>print</tt> method</a></li>
  65      </ul></li>
  66   <li><a href="#interaction">Specifying interactions between passes</a>
  67      <ul>
  68      <li><a href="#getAnalysisUsage">The <tt>getAnalysisUsage</tt>
  69                                      method</a></li>
  70      <li><a href="#AU::addRequired">The <tt>AnalysisUsage::addRequired&lt;&gt;</tt> and <tt>AnalysisUsage::addRequiredTransitive&lt;&gt;</tt> methods</a></li>
  71      <li><a href="#AU::addPreserved">The <tt>AnalysisUsage::addPreserved&lt;&gt;</tt> method</a></li>
  72      <li><a href="#AU::examples">Example implementations of <tt>getAnalysisUsage</tt></a></li>
  73      <li><a href="#getAnalysis">The <tt>getAnalysis&lt;&gt;</tt> and <tt>getAnalysisToUpdate&lt;&gt;</tt> methods</a></li>
  74      </ul></li>
  75   <li><a href="#analysisgroup">Implementing Analysis Groups</a>
  76      <ul>
  77      <li><a href="#agconcepts">Analysis Group Concepts</a></li>
  78      <li><a href="#registerag">Using <tt>RegisterAnalysisGroup</tt></a></li>
  79      </ul></li>
  80   <li><a href="#passmanager">What PassManager does</a>
  81     <ul>
  82     <li><a href="#releaseMemory">The <tt>releaseMemory</tt> method</a></li>
  83     </ul></li>
  84   <li><a href="#debughints">Using GDB with dynamically loaded passes</a>
  85     <ul>
  86     <li><a href="#breakpoint">Setting a breakpoint in your pass</a></li>
  87     <li><a href="#debugmisc">Miscellaneous Problems</a></li>
  88     </ul></li>
  89   <li><a href="#future">Future extensions planned</a>
  90     <ul>
  91     <li><a href="#SMP">Multithreaded LLVM</a></li>
  92     <li><a href="#PassFunctionPass"><tt>ModulePass</tt>es requiring
  93                                     <tt>FunctionPass</tt>es</a></li>
  94     </ul></li>
  95 </ol>
  96
  97 <div class="doc_author">
  98   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
  99 </div>
 100
 101 <!-- *********************************************************************** -->
 102 <div class="doc_section">
 103   <a name="introduction">Introduction - What is a pass?</a>
 104 </div>
 105 <!-- *********************************************************************** -->
 106
 107 <div class="doc_text">
 108
 109 <p>The LLVM Pass Framework is an important part of the LLVM system, because LLVM
 110 passes are where most of the interesting parts of the compiler exist.  Passes
 111 perform the transformations and optimizations that make up the compiler, they
 112 build the analysis results that are used by these transformations, and they are,
 113 above all, a structuring technique for compiler code.</p>
 114
 115 <p>All LLVM passes are subclasses of the <tt><a
 116 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1Pass.html">Pass</a></tt>
 117 class, which implement functionality by overriding virtual methods inherited
 118 from <tt>Pass</tt>.  Depending on how your pass works, you should inherit from
 119 the <tt><a href="#ModulePass">ModulePass</a></tt>, <tt><a
 120 href="#CallGraphSCCPass">CallGraphSCCPass</a></tt>, <tt><a
 121 href="#FunctionPass">FunctionPass</a></tt>, or <tt><a
 122 href="#BasicBlockPass">BasicBlockPass</a></tt> classes, which gives the system
 123 more information about what your pass does, and how it can be combined with
 124 other passes.  One of the main features of the LLVM Pass Framework is that it
 125 schedules passes to run in an efficient way based on the constraints that your
 126 pass meets (which are indicated by which class they derive from).</p>
 127
 128 <p>We start by showing you how to construct a pass, everything from setting up
 129 the code, to compiling, loading, and executing it.  After the basics are down,
 130 more advanced features are discussed.</p>
 131
 132 </div>
 133
 134 <!-- *********************************************************************** -->
 135 <div class="doc_section">
 136   <a name="quickstart">Quick Start - Writing hello world</a>
 137 </div>
 138 <!-- *********************************************************************** -->
 139
 140 <div class="doc_text">
 141
 142 <p>Here we describe how to write the "hello world" of passes.  The "Hello" pass
 143 is designed to simply print out the name of non-external functions that exist in
 144 the program being compiled.  It does not modify the program at all, it just
 145 inspects it.  The source code and files for this pass are available in the LLVM
 146 source tree in the <tt>lib/Transforms/Hello</tt> directory.</p>
 147
 148 </div>
 149
 150 <!-- ======================================================================= -->
 151 <div class="doc_subsection">
 152   <a name="makefile">Setting up the build environment</a>
 153 </div>
 154
 155 <div class="doc_text">
 156
 157 <p>First thing you need to do is create a new directory somewhere in the LLVM
 158 source base.  For this example, we'll assume that you made
 159 "<tt>lib/Transforms/Hello</tt>".  The first thing you must do is set up a build
 160 script (Makefile) that will compile the source code for the new pass.  To do
 161 this, copy this into "<tt>Makefile</tt>":</p>
 162
 163 <hr>
 164
 165 <pre>
 166 # Makefile for hello pass
 167
 168 # Path to top level of LLVM heirarchy
 169 LEVEL = ../../..
 170
 171 # Name of the library to build
 172 LIBRARYNAME = hello
 173
 174 # Build a dynamically loadable shared object
 175 SHARED_LIBRARY = 1
 176
 177 # Include the makefile implementation stuff
 178 include $(LEVEL)/Makefile.common
 179 </pre>
 180
 181 <p>This makefile specifies that all of the <tt>.cpp</tt> files in the current
 182 directory are to be compiled and linked together into a
 183 <tt>lib/Debug/libhello.so</tt> shared object that can be dynamically loaded by
 184 the <tt>opt</tt> or <tt>analyze</tt> tools.  If your operating system uses a
 185 suffix other than .so (such as windows or Mac OS/X), the appropriate extension
 186 will be used.</p>
 187
 188 <p>Now that we have the build scripts set up, we just need to write the code for
 189 the pass itself.</p>
 190
 191 </div>
 192
 193 <!-- ======================================================================= -->
 194 <div class="doc_subsection">
 195   <a name="basiccode">Basic code required</a>
 196 </div>
 197
 198 <div class="doc_text">
 199
 200 <p>Now that we have a way to compile our new pass, we just have to write it.
 201 Start out with:</p>
 202
 203 <pre>
 204 <b>#include</b> "<a href="http://llvm.cs.uiuc.edu/doxygen/Pass_8h-source.html">llvm/Pass.h</a>"
 205 <b>#include</b> "<a href="http://llvm.cs.uiuc.edu/doxygen/Function_8h-source.html">llvm/Function.h</a>"
 206 </pre>
 207
 208 <p>Which are needed because we are writing a <tt><a
 209 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1Pass.html">Pass</a></tt>, and
 210 we are operating on <tt><a
 211 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1Function.html">Function</a></tt>'s.</p>
 212
 213 <p>Next we have:</p>
 214 <pre>
 215 <b>using namespace llvm;</b>
 216 </pre>
 217 <p>... which is required because the functions from the include files
 218 live in the llvm namespace.
 219 </p>
 220
 221 <p>Next we have:</p>
 222
 223 <pre>
 224 <b>namespace</b> {
 225 </pre>
 226
 227 <p>... which starts out an anonymous namespace.  Anonymous namespaces are to C++
 228 what the "<tt>static</tt>" keyword is to C (at global scope).  It makes the
 229 things declared inside of the anonymous namespace only visible to the current
 230 file.  If you're not familiar with them, consult a decent C++ book for more
 231 information.</p>
 232
 233 <p>Next, we declare our pass itself:</p>
 234
 235 <pre>
 236   <b>struct</b> Hello : <b>public</b> <a href="#FunctionPass">FunctionPass</a> {
 237 </pre><p>
 238
 239 <p>This declares a "<tt>Hello</tt>" class that is a subclass of <tt><a
 240 href="http://llvm.cs.uiuc.edu/doxygen/structllvm_1_1FunctionPass.html">FunctionPass</a></tt>.
 241 The different builtin pass subclasses are described in detail <a
 242 href="#passtype">later</a>, but for now, know that <a
 243 href="#FunctionPass"><tt>FunctionPass</tt></a>'s operate a function at a
 244 time.</p>
 245
 246 <pre>
 247     <b>virtual bool</b> <a href="#runOnFunction">runOnFunction</a>(Function &amp;F) {
 248       std::cerr &lt;&lt; "<i>Hello: </i>" &lt;&lt; F.getName() &lt;&lt; "\n";
 249       <b>return false</b>;
 250     }
 251   };  <i>// end of struct Hello</i>
 252 </pre>
 253
 254 <p>We declare a "<a href="#runOnFunction"><tt>runOnFunction</tt></a>" method,
 255 which overloads an abstract virtual method inherited from <a
 256 href="#FunctionPass"><tt>FunctionPass</tt></a>.  This is where we are supposed
 257 to do our thing, so we just print out our message with the name of each
 258 function.</p>
 259
 260 <pre>
 261   RegisterOpt&lt;Hello&gt; X("<i>hello</i>", "<i>Hello World Pass</i>");
 262 }  <i>// end of anonymous namespace</i>
 263 </pre>
 264
 265 <p>Lastly, we register our class <tt>Hello</tt>, giving it a command line
 266 argument "<tt>hello</tt>", and a name "<tt>Hello World Pass</tt>".  There are
 267 several different ways of <a href="#registration">registering your pass</a>,
 268 depending on what it is to be used for.  For "optimizations" we use the
 269 <tt>RegisterOpt</tt> template.</p>
 270
 271 <p>As a whole, the <tt>.cpp</tt> file looks like:</p>
 272
 273 <pre>
 274 <b>#include</b> "<a href="http://llvm.cs.uiuc.edu/doxygen/Pass_8h-source.html">llvm/Pass.h</a>"
 275 <b>#include</b> "<a href="http://llvm.cs.uiuc.edu/doxygen/Function_8h-source.html">llvm/Function.h</a>"
 276
 277 <b>using namespace llvm;</b>
 278
 279 <b>namespace</b> {
 280   <b>struct Hello</b> : <b>public</b> <a href="#FunctionPass">FunctionPass</a> {
 281     <b>virtual bool</b> <a href="#runOnFunction">runOnFunction</a>(Function &amp;F) {
 282       std::cerr &lt;&lt; "<i>Hello: </i>" &lt;&lt; F.getName() &lt;&lt; "\n";
 283       <b>return false</b>;
 284     }
 285   };
 286
 287   RegisterOpt&lt;Hello&gt; X("<i>hello</i>", "<i>Hello World Pass</i>");
 288 }
 289 </pre>
 290
 291 <p>Now that it's all together, compile the file with a simple "<tt>gmake</tt>"
 292 command in the local directory and you should get a new
 293 "<tt>lib/Debug/libhello.so</tt> file.  Note that everything in this file is
 294 contained in an anonymous namespace: this reflects the fact that passes are self
 295 contained units that do not need external interfaces (although they can have
 296 them) to be useful.</p>
 297
 298 </div>
 299
 300 <!-- ======================================================================= -->
 301 <div class="doc_subsection">
 302   <a name="running">Running a pass with <tt>opt</tt> or <tt>analyze</tt></a>
 303 </div>
 304
 305 <div class="doc_text">
 306
 307 <p>Now that you have a brand new shiny shared object file, we can use the
 308 <tt>opt</tt> command to run an LLVM program through your pass.  Because you
 309 registered your pass with the <tt>RegisterOpt</tt> template, you will be able to
 310 use the <tt>opt</tt> tool to access it, once loaded.</p>
 311
 312 <p>To test it, follow the example at the end of the <a
 313 href="GettingStarted.html">Getting Started Guide</a> to compile "Hello World" to
 314 LLVM.  We can now run the bytecode file (<tt>hello.bc</tt>) for the program
 315 through our transformation like this (or course, any bytecode file will
 316 work):</p>
 317
 318 <pre>
 319 $ opt -load ../../../lib/Debug/libhello.so -hello &lt; hello.bc &gt; /dev/null
 320 Hello: __main
 321 Hello: puts
 322 Hello: main
 323 </pre>
 324
 325 <p>The '<tt>-load</tt>' option specifies that '<tt>opt</tt>' should load your
 326 pass as a shared object, which makes '<tt>-hello</tt>' a valid command line
 327 argument (which is one reason you need to <a href="#registration">register your
 328 pass</a>).  Because the hello pass does not modify the program in any
 329 interesting way, we just throw away the result of <tt>opt</tt> (sending it to
 330 <tt>/dev/null</tt>).</p>
 331
 332 <p>To see what happened to the other string you registered, try running
 333 <tt>opt</tt> with the <tt>--help</tt> option:</p>
 334
 335 <pre>
 336 $ opt -load ../../../lib/Debug/libhello.so --help
 337 OVERVIEW: llvm .bc -&gt; .bc modular optimizer
 338
 339 USAGE: opt [options] &lt;input bytecode&gt;
 340
 341 OPTIONS:
 342   Optimizations available:
 343 ...
 344     -funcresolve    - Resolve Functions
 345     -gcse           - Global Common Subexpression Elimination
 346     -globaldce      - Dead Global Elimination
 347     <b>-hello          - Hello World Pass</b>
 348     -indvars        - Canonicalize Induction Variables
 349     -inline         - Function Integration/Inlining
 350     -instcombine    - Combine redundant instructions
 351 ...
 352 </pre>
 353
 354 <p>The pass name get added as the information string for your pass, giving some
 355 documentation to users of <tt>opt</tt>.  Now that you have a working pass, you
 356 would go ahead and make it do the cool transformations you want.  Once you get
 357 it all working and tested, it may become useful to find out how fast your pass
 358 is.  The <a href="#passManager"><tt>PassManager</tt></a> provides a nice command
 359 line option (<tt>--time-passes</tt>) that allows you to get information about
 360 the execution time of your pass along with the other passes you queue up.  For
 361 example:</p>
 362
 363 <pre>
 364 $ opt -load ../../../lib/Debug/libhello.so -hello -time-passes &lt; hello.bc &gt; /dev/null
 365 Hello: __main
 366 Hello: puts
 367 Hello: main
 368 ===============================================================================
 369                       ... Pass execution timing report ...
 370 ===============================================================================
 371   Total Execution Time: 0.02 seconds (0.0479059 wall clock)
 372
 373    ---User Time---   --System Time--   --User+System--   ---Wall Time---  --- Pass Name ---
 374    0.0100 (100.0%)   0.0000 (  0.0%)   0.0100 ( 50.0%)   0.0402 ( 84.0%)  Bytecode Writer
 375    0.0000 (  0.0%)   0.0100 (100.0%)   0.0100 ( 50.0%)   0.0031 (  6.4%)  Dominator Set Construction
 376    0.0000 (  0.0%)   0.0000 (  0.0%)   0.0000 (  0.0%)   0.0013 (  2.7%)  Module Verifier
 377  <b>  0.0000 (  0.0%)   0.0000 (  0.0%)   0.0000 (  0.0%)   0.0033 (  6.9%)  Hello World Pass</b>
 378    0.0100 (100.0%)   0.0100 (100.0%)   0.0200 (100.0%)   0.0479 (100.0%)  TOTAL
 379 </pre>
 380
 381 <p>As you can see, our implementation above is pretty fast :).  The additional
 382 passes listed are automatically inserted by the '<tt>opt</tt>' tool to verify
 383 that the LLVM emitted by your pass is still valid and well formed LLVM, which
 384 hasn't been broken somehow.</p>
 385
 386 <p>Now that you have seen the basics of the mechanics behind passes, we can talk
 387 about some more details of how they work and how to use them.</p>
 388
 389 </div>
 390
 391 <!-- *********************************************************************** -->
 392 <div class="doc_section">
 393   <a name="passtype">Pass classes and requirements</a>
 394 </div>
 395 <!-- *********************************************************************** -->
 396
 397 <div class="doc_text">
 398
 399 <p>One of the first things that you should do when designing a new pass is to
 400 decide what class you should subclass for your pass.  The <a
 401 href="#basiccode">Hello World</a> example uses the <tt><a
 402 href="#FunctionPass">FunctionPass</a></tt> class for its implementation, but we
 403 did not discuss why or when this should occur.  Here we talk about the classes
 404 available, from the most general to the most specific.</p>
 405
 406 <p>When choosing a superclass for your Pass, you should choose the <b>most
 407 specific</b> class possible, while still being able to meet the requirements
 408 listed.  This gives the LLVM Pass Infrastructure information necessary to
 409 optimize how passes are run, so that the resultant compiler isn't unneccesarily
 410 slow.</p>
 411
 412 </div>
 413
 414 <!-- ======================================================================= -->
 415 <div class="doc_subsection">
 416   <a name="ImmutablePass">The <tt>ImmutablePass</tt> class</a>
 417 </div>
 418
 419 <div class="doc_text">
 420
 421 <p>The most plain and boring type of pass is the "<tt><a
 422 href="http://llvm.cs.uiuc.edu/doxygen/structllvm_1_1ImmutablePass.html">ImmutablePass</a></tt>"
 423 class.  This pass type is used for passes that do not have to be run, do not
 424 change state, and never need to be updated.  This is not a normal type of
 425 transformation or analysis, but can provide information about the current
 426 compiler configuration.</p>
 427
 428 <p>Although this pass class is very infrequently used, it is important for
 429 providing information about the current target machine being compiled for, and
 430 other static information that can affect the various transformations.</p>
 431
 432 <p><tt>ImmutablePass</tt>es never invalidate other transformations, are never
 433 invalidated, and are never "run".</p>
 434
 435 </div>
 436
 437 <!-- ======================================================================= -->
 438 <div class="doc_subsection">
 439   <a name="ModulePass">The <tt>ModulePass</tt> class</a>
 440 </div>
 441
 442 <div class="doc_text">
 443
 444 <p>The "<tt><a
 445 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1ModulePass.html">ModulePass</a></tt>"
 446 class is the most general of all superclasses that you can use.  Deriving from
 447 <tt>ModulePass</tt> indicates that your pass uses the entire program as a unit,
 448 refering to function bodies in no predictable order, or adding and removing
 449 functions.  Because nothing is known about the behavior of <tt>ModulePass</tt>
 450 subclasses, no optimization can be done for their execution.</p>
 451
 452 <p>To write a correct <tt>ModulePass</tt> subclass, derive from
 453 <tt>ModulePass</tt> and overload the <tt>runOnModule</tt> method with the
 454 following signature:</p>
 455
 456 </div>
 457
 458 <!-- _______________________________________________________________________ -->
 459 <div class="doc_subsubsection">
 460   <a name="runOnModule">The <tt>runOnModule</tt> method</a>
 461 </div>
 462
 463 <div class="doc_text">
 464
 465 <pre>
 466   <b>virtual bool</b> runOnModule(Module &amp;M) = 0;
 467 </pre>
 468
 469 <p>The <tt>runOnModule</tt> method performs the interesting work of the pass,
 470 and should return true if the module was modified by the transformation, false
 471 otherwise.</p>
 472
 473 </div>
 474
 475 <!-- ======================================================================= -->
 476 <div class="doc_subsection">
 477   <a name="CallGraphSCCPass">The <tt>CallGraphSCCPass</tt> class</a>
 478 </div>
 479
 480 <div class="doc_text">
 481
 482 <p>The "<tt><a
 483 href="http://llvm.cs.uiuc.edu/doxygen/structllvm_1_1CallGraphSCCPass.html">CallGraphSCCPass</a></tt>"
 484 is used by passes that need to traverse the program bottom-up on the call graph
 485 (callees before callers).  Deriving from CallGraphSCCPass provides some
 486 mechanics for building and traversing the CallGraph, but also allows the system
 487 to optimize execution of CallGraphSCCPass's.  If your pass meets the
 488 requirements outlined below, and doesn't meet the requirements of a <tt><a
 489 href="#FunctionPass">FunctionPass</a></tt> or <tt><a
 490 href="#BasicBlockPass">BasicBlockPass</a></tt>, you should derive from
 491 <tt>CallGraphSCCPass</tt>.</p>
 492
 493 <p><b>TODO</b>: explain briefly what SCC, Tarjan's algo, and B-U mean.</p>
 494
 495 <p>To be explicit, <tt>CallGraphSCCPass</tt> subclasses are:</p>
 496
 497 <ol>
 498
 499 <li>... <em>not allowed</em> to modify any <tt>Function</tt>s that are not in
 500 the current SCC.</li>
 501
 502 <li>... <em>allowed</em> to inspect any Function's other than those in the
 503 current SCC and the direct callees of the SCC.</li>
 504
 505 <li>... <em>required</em> to preserve the current CallGraph object, updating it
 506 to reflect any changes made to the program.</li>
 507
 508 <li>... <em>not allowed</em> to add or remove SCC's from the current Module,
 509 though they may change the contents of an SCC.</li>
 510
 511 <li>... <em>allowed</em> to add or remove global variables from the current
 512 Module.</li>
 513
 514 <li>... <em>allowed</em> to maintain state across invocations of
 515     <a href="#runOnSCC"><tt>runOnSCC</tt></a> (including global data).</li>
 516 </ol>
 517
 518 <p>Implementing a <tt>CallGraphSCCPass</tt> is slightly tricky in some cases
 519 because it has to handle SCCs with more than one node in it.  All of the virtual
 520 methods described below should return true if they modified the program, or
 521 false if they didn't.</p>
 522
 523 </div>
 524
 525 <!-- _______________________________________________________________________ -->
 526 <div class="doc_subsubsection">
 527   <a name="doInitialization_scc">The <tt>doInitialization(Module &amp;)</tt>
 528   method</a>
 529 </div>
 530
 531 <div class="doc_text">
 532
 533 <pre>
 534   <b>virtual bool</b> doInitialization(Module &amp;M);
 535 </pre>
 536
 537 <p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
 538 <tt>CallGraphSCCPass</tt>'s are not allowed to do.  They can add and remove
 539 functions, get pointers to functions, etc.  The <tt>doInitialization</tt> method
 540 is designed to do simple initialization type of stuff that does not depend on
 541 the SCCs being processed.  The <tt>doInitialization</tt> method call is not
 542 scheduled to overlap with any other pass executions (thus it should be very
 543 fast).</p>
 544
 545 </div>
 546
 547 <!-- _______________________________________________________________________ -->
 548 <div class="doc_subsubsection">
 549   <a name="runOnSCC">The <tt>runOnSCC</tt> method</a>
 550 </div>
 551
 552 <div class="doc_text">
 553
 554 <pre>
 555   <b>virtual bool</b> runOnSCC(const std::vector&lt;CallGraphNode *&gt; &amp;SCCM) = 0;
 556 </pre>
 557
 558 <p>The <tt>runOnSCC</tt> method performs the interesting work of the pass, and
 559 should return true if the module was modified by the transformation, false
 560 otherwise.</p>
 561
 562 </div>
 563
 564 <!-- _______________________________________________________________________ -->
 565 <div class="doc_subsubsection">
 566   <a name="doFinalization_scc">The <tt>doFinalization(Module
 567    &amp;)</tt> method</a>
 568 </div>
 569
 570 <div class="doc_text">
 571
 572 <pre>
 573   <b>virtual bool</b> doFinalization(Module &amp;M);
 574 </pre>
 575
 576 <p>The <tt>doFinalization</tt> method is an infrequently used method that is
 577 called when the pass framework has finished calling <a
 578 href="#runOnFunction"><tt>runOnFunction</tt></a> for every function in the
 579 program being compiled.</p>
 580
 581 </div>
 582
 583 <!-- ======================================================================= -->
 584 <div class="doc_subsection">
 585   <a name="FunctionPass">The <tt>FunctionPass</tt> class</a>
 586 </div>
 587
 588 <div class="doc_text">
 589
 590 <p>In contrast to <tt>ModulePass</tt> subclasses, <tt><a
 591 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1Pass.html">FunctionPass</a></tt>
 592 subclasses do have a predictable, local behavior that can be expected by the
 593 system.  All <tt>FunctionPass</tt> execute on each function in the program
 594 independent of all of the other functions in the program.
 595 <tt>FunctionPass</tt>'s do not require that they are executed in a particular
 596 order, and <tt>FunctionPass</tt>'s do not modify external functions.</p>
 597
 598 <p>To be explicit, <tt>FunctionPass</tt> subclasses are not allowed to:</p>
 599
 600 <ol>
 601 <li>Modify a Function other than the one currently being processed.</li>
 602 <li>Add or remove Function's from the current Module.</li>
 603 <li>Add or remove global variables from the current Module.</li>
 604 <li>Maintain state across invocations of
 605     <a href="#runOnFunction"><tt>runOnFunction</tt></a> (including global data)</li>
 606 </ol>
 607
 608 <p>Implementing a <tt>FunctionPass</tt> is usually straightforward (See the <a
 609 href="#basiccode">Hello World</a> pass for example).  <tt>FunctionPass</tt>'s
 610 may overload three virtual methods to do their work.  All of these methods
 611 should return true if they modified the program, or false if they didn't.</p>
 612
 613 </div>
 614
 615 <!-- _______________________________________________________________________ -->
 616 <div class="doc_subsubsection">
 617   <a name="doInitialization_mod">The <tt>doInitialization(Module &amp;)</tt>
 618   method</a>
 619 </div>
 620
 621 <div class="doc_text">
 622
 623 <pre>
 624   <b>virtual bool</b> doInitialization(Module &amp;M);
 625 </pre>
 626
 627 <p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
 628 <tt>FunctionPass</tt>'s are not allowed to do.  They can add and remove
 629 functions, get pointers to functions, etc.  The <tt>doInitialization</tt> method
 630 is designed to do simple initialization type of stuff that does not depend on
 631 the functions being processed.  The <tt>doInitialization</tt> method call is not
 632 scheduled to overlap with any other pass executions (thus it should be very
 633 fast).</p>
 634
 635 <p>A good example of how this method should be used is the <a
 636 href="http://llvm.cs.uiuc.edu/doxygen/LowerAllocations_8cpp-source.html">LowerAllocations</a>
 637 pass.  This pass converts <tt>malloc</tt> and <tt>free</tt> instructions into
 638 platform dependent <tt>malloc()</tt> and <tt>free()</tt> function calls.  It
 639 uses the <tt>doInitialization</tt> method to get a reference to the malloc and
 640 free functions that it needs, adding prototypes to the module if necessary.</p>
 641
 642 </div>
 643
 644 <!-- _______________________________________________________________________ -->
 645 <div class="doc_subsubsection">
 646   <a name="runOnFunction">The <tt>runOnFunction</tt> method</a>
 647 </div>
 648
 649 <div class="doc_text">
 650
 651 <pre>
 652   <b>virtual bool</b> runOnFunction(Function &amp;F) = 0;
 653 </pre><p>
 654
 655 <p>The <tt>runOnFunction</tt> method must be implemented by your subclass to do
 656 the transformation or analysis work of your pass.  As usual, a true value should
 657 be returned if the function is modified.</p>
 658
 659 </div>
 660
 661 <!-- _______________________________________________________________________ -->
 662 <div class="doc_subsubsection">
 663   <a name="doFinalization_mod">The <tt>doFinalization(Module
 664   &amp;)</tt> method</a>
 665 </div>
 666
 667 <div class="doc_text">
 668
 669 <pre>
 670   <b>virtual bool</b> doFinalization(Module &amp;M);
 671 </pre>
 672
 673 <p>The <tt>doFinalization</tt> method is an infrequently used method that is
 674 called when the pass framework has finished calling <a
 675 href="#runOnFunction"><tt>runOnFunction</tt></a> for every function in the
 676 program being compiled.</p>
 677
 678 </div>
 679
 680 <!-- ======================================================================= -->
 681 <div class="doc_subsection">
 682   <a name="BasicBlockPass">The <tt>BasicBlockPass</tt> class</a>
 683 </div>
 684
 685 <div class="doc_text">
 686
 687 <p><tt>BasicBlockPass</tt>'s are just like <a
 688 href="#FunctionPass"><tt>FunctionPass</tt></a>'s, except that they must limit
 689 their scope of inspection and modification to a single basic block at a time.
 690 As such, they are <b>not</b> allowed to do any of the following:</p>
 691
 692 <ol>
 693 <li>Modify or inspect any basic blocks outside of the current one</li>
 694 <li>Maintain state across invocations of
 695     <a href="#runOnBasicBlock"><tt>runOnBasicBlock</tt></a></li>
 696 <li>Modify the constrol flow graph (by altering terminator instructions)</li>
 697 <li>Any of the things verboten for
 698     <a href="#FunctionPass"><tt>FunctionPass</tt></a>es.</li>
 699 </ol>
 700
 701 <p><tt>BasicBlockPass</tt>es are useful for traditional local and "peephole"
 702 optimizations.  They may override the same <a
 703 href="#doInitialization_mod"><tt>doInitialization(Module &amp;)</tt></a> and <a
 704 href="#doFinalization_mod"><tt>doFinalization(Module &amp;)</tt></a> methods that <a
 705 href="#FunctionPass"><tt>FunctionPass</tt></a>'s have, but also have the following virtual methods that may also be implemented:</p>
 706
 707 </div>
 708
 709 <!-- _______________________________________________________________________ -->
 710 <div class="doc_subsubsection">
 711   <a name="doInitialization_fn">The <tt>doInitialization(Function
 712   &amp;)</tt> method</a>
 713 </div>
 714
 715 <div class="doc_text">
 716
 717 <pre>
 718   <b>virtual bool</b> doInitialization(Function &amp;F);
 719 </pre>
 720
 721 <p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
 722 <tt>BasicBlockPass</tt>'s are not allowed to do, but that
 723 <tt>FunctionPass</tt>'s can.  The <tt>doInitialization</tt> method is designed
 724 to do simple initialization type of stuff that does not depend on the
 725 BasicBlocks being processed.  The <tt>doInitialization</tt> method call is not
 726 scheduled to overlap with any other pass executions (thus it should be very
 727 fast).</p>
 728
 729 </div>
 730
 731 <!-- _______________________________________________________________________ -->
 732 <div class="doc_subsubsection">
 733   <a name="runOnBasicBlock">The <tt>runOnBasicBlock</tt> method</a>
 734 </div>
 735
 736 <div class="doc_text">
 737
 738 <pre>
 739   <b>virtual bool</b> runOnBasicBlock(BasicBlock &amp;BB) = 0;
 740 </pre>
 741
 742 <p>Override this function to do the work of the <tt>BasicBlockPass</tt>.  This
 743 function is not allowed to inspect or modify basic blocks other than the
 744 parameter, and are not allowed to modify the CFG.  A true value must be returned
 745 if the basic block is modified.</p>
 746
 747 </div>
 748
 749 <!-- _______________________________________________________________________ -->
 750 <div class="doc_subsubsection">
 751   <a name="doFinalization_fn">The <tt>doFinalization(Function &amp;)</tt>
 752   method</a>
 753 </div>
 754
 755 <div class="doc_text">
 756
 757 <pre>
 758   <b>virtual bool</b> doFinalization(Function &amp;F);
 759 </pre>
 760
 761 <p>The <tt>doFinalization</tt> method is an infrequently used method that is
 762 called when the pass framework has finished calling <a
 763 href="#runOnBasicBlock"><tt>runOnBasicBlock</tt></a> for every BasicBlock in the
 764 program being compiled.  This can be used to perform per-function
 765 finalization.</p>
 766
 767 </div>
 768
 769 <!-- ======================================================================= -->
 770 <div class="doc_subsection">
 771   <a name="MachineFunctionPass">The <tt>MachineFunctionPass</tt> class</a>
 772 </div>
 773
 774 <div class="doc_text">
 775
 776 <p>A <tt>MachineFunctionPass</tt> is a part of the LLVM code generator that
 777 executes on the machine-dependent representation of each LLVM function in the
 778 program.  A <tt>MachineFunctionPass</tt> is also a <tt>FunctionPass</tt>, so all
 779 the restrictions that apply to a <tt>FunctionPass</tt> also apply to it.
 780 <tt>MachineFunctionPass</tt>es also have additional restrictions. In particular,
 781 <tt>MachineFunctionPass</tt>es are not allowed to do any of the following:</p>
 782
 783 <ol>
 784 <li>Modify any LLVM Instructions, BasicBlocks or Functions.</li>
 785 <li>Modify a MachineFunction other than the one currently being processed.</li>
 786 <li>Add or remove MachineFunctions from the current Module.</li>
 787 <li>Add or remove global variables from the current Module.</li>
 788 <li>Maintain state across invocations of <a
 789 href="#runOnMachineFunction"><tt>runOnMachineFunction</tt></a> (including global
 790 data)</li>
 791 </ol>
 792
 793 </div>
 794
 795 <!-- _______________________________________________________________________ -->
 796 <div class="doc_subsubsection">
 797   <a name="runOnMachineFunction">The <tt>runOnMachineFunction(MachineFunction
 798   &amp;MF)</tt> method</a>
 799 </div>
 800
 801 <div class="doc_text">
 802
 803 <pre>
 804   <b>virtual bool</b> runOnMachineFunction(MachineFunction &amp;MF) = 0;
 805 </pre>
 806
 807 <p><tt>runOnMachineFunction</tt> can be considered the main entry point of a
 808 <tt>MachineFunctionPass</tt>; that is, you should override this method to do the
 809 work of your <tt>MachineFunctionPass</tt>.</p>
 810
 811 <p>The <tt>runOnMachineFunction</tt> method is called on every
 812 <tt>MachineFunction</tt> in a <tt>Module</tt>, so that the
 813 <tt>MachineFunctionPass</tt> may perform optimizations on the machine-dependent
 814 representation of the function. If you want to get at the LLVM <tt>Function</tt>
 815 for the <tt>MachineFunction</tt> you're working on, use
 816 <tt>MachineFunction</tt>'s <tt>getFunction()</tt> accessor method -- but
 817 remember, you may not modify the LLVM <tt>Function</tt> or its contents from a
 818 <tt>MachineFunctionPass</tt>.</p>
 819
 820 </div>
 821
 822 <!-- *********************************************************************** -->
 823 <div class="doc_section">
 824   <a name="registration">Pass registration</a>
 825 </div>
 826 <!-- *********************************************************************** -->
 827
 828 <div class="doc_text">
 829
 830 <p>In the <a href="#basiccode">Hello World</a> example pass we illustrated how
 831 pass registration works, and discussed some of the reasons that it is used and
 832 what it does.  Here we discuss how and why passes are registered.</p>
 833
 834 <p>Passes can be registered in several different ways.  Depending on the general
 835 classification of the pass, you should use one of the following templates to
 836 register the pass:</p>
 837
 838 <ul>
 839 <li><b><tt>RegisterOpt</tt></b> - This template should be used when you are
 840 registering a pass that logically should be available for use in the
 841 '<tt>opt</tt>' utility.</li>
 842
 843 <li><b><tt>RegisterAnalysis</tt></b> - This template should be used when you are
 844 registering a pass that logically should be available for use in the
 845 '<tt>analyze</tt>' utility.</li>
 846
 847 <li><b><tt>RegisterPass</tt></b> - This is the generic form of the
 848 <tt>Register*</tt> templates that should be used if you want your pass listed by
 849 multiple or no utilities.  This template takes an extra third argument that
 850 specifies which tools it should be listed in.  See the <a
 851 href="http://llvm.cs.uiuc.edu/doxygen/PassSupport_8h-source.html">PassSupport.h</a>
 852 file for more information.</li>
 853
 854 </ul>
 855
 856 <p>Regardless of how you register your pass, you must specify at least two
 857 parameters.  The first parameter is the name of the pass that is to be used on
 858 the command line to specify that the pass should be added to a program (for
 859 example <tt>opt</tt> or <tt>analyze</tt>).  The second argument is the name of
 860 the pass, which is to be used for the <tt>--help</tt> output of programs, as
 861 well as for debug output generated by the <tt>--debug-pass</tt> option.</p>
 862
 863 <p>If a pass is registered to be used by the <tt>analyze</tt> utility, you
 864 should implement the virtual <tt>print</tt> method:</p>
 865
 866 </div>
 867
 868 <!-- _______________________________________________________________________ -->
 869 <div class="doc_subsubsection">
 870   <a name="print">The <tt>print</tt> method</a>
 871 </div>
 872
 873 <div class="doc_text">
 874
 875 <pre>
 876   <b>virtual void</b> print(std::ostream &amp;O, <b>const</b> Module *M) <b>const</b>;
 877 </pre>
 878
 879 <p>The <tt>print</tt> method must be implemented by "analyses" in order to print
 880 a human readable version of the analysis results.  This is useful for debugging
 881 an analysis itself, as well as for other people to figure out how an analysis
 882 works.  The <tt>analyze</tt> tool uses this method to generate its output.</p>
 883
 884 <p>The <tt>ostream</tt> parameter specifies the stream to write the results on,
 885 and the <tt>Module</tt> parameter gives a pointer to the top level module of the
 886 program that has been analyzed.  Note however that this pointer may be null in
 887 certain circumstances (such as calling the <tt>Pass::dump()</tt> from a
 888 debugger), so it should only be used to enhance debug output, it should not be
 889 depended on.</p>
 890
 891 </div>
 892
 893 <!-- *********************************************************************** -->
 894 <div class="doc_section">
 895   <a name="interaction">Specifying interactions between passes</a>
 896 </div>
 897 <!-- *********************************************************************** -->
 898
 899 <div class="doc_text">
 900
 901 <p>One of the main responsibilities of the <tt>PassManager</tt> is the make sure
 902 that passes interact with each other correctly.  Because <tt>PassManager</tt>
 903 tries to <a href="#passmanager">optimize the execution of passes</a> it must
 904 know how the passes interact with each other and what dependencies exist between
 905 the various passes.  To track this, each pass can declare the set of passes that
 906 are required to be executed before the current pass, and the passes which are
 907 invalidated by the current pass.</p>
 908
 909 <p>Typically this functionality is used to require that analysis results are
 910 computed before your pass is run.  Running arbitrary transformation passes can
 911 invalidate the computed analysis results, which is what the invalidation set
 912 specifies.  If a pass does not implement the <tt><a
 913 href="#getAnalysisUsage">getAnalysisUsage</a></tt> method, it defaults to not
 914 having any prerequisite passes, and invalidating <b>all</b> other passes.</p>
 915
 916 </div>
 917
 918 <!-- _______________________________________________________________________ -->
 919 <div class="doc_subsubsection">
 920   <a name="getAnalysisUsage">The <tt>getAnalysisUsage</tt> method</a>
 921 </div>
 922
 923 <div class="doc_text">
 924
 925 <pre>
 926   <b>virtual void</b> getAnalysisUsage(AnalysisUsage &amp;Info) <b>const</b>;
 927 </pre>
 928
 929 <p>By implementing the <tt>getAnalysisUsage</tt> method, the required and
 930 invalidated sets may be specified for your transformation.  The implementation
 931 should fill in the <tt><a
 932 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AnalysisUsage.html">AnalysisUsage</a></tt>
 933 object with information about which passes are required and not invalidated.  To
 934 do this, a pass may call any of the following methods on the AnalysisUsage
 935 object:</p>
 936 </div>
 937
 938 <!-- _______________________________________________________________________ -->
 939 <div class="doc_subsubsection">
 940   <a name="AU::addRequired">The <tt>AnalysisUsage::addRequired&lt;&gt;</tt> and <tt>AnalysisUsage::addRequiredTransitive&lt;&gt;</tt> methods</a>
 941 </div>
 942
 943 <div class="doc_text">
 944 <p>
 945 If you pass requires a previous pass to be executed (an analysis for example),
 946 it can use one of these methods to arrange for it to be run before your pass.
 947 LLVM has many different types of analyses and passes that can be required,
 948 spaning the range from <tt>DominatorSet</tt> to <tt>BreakCriticalEdges</tt>.
 949 requiring <tt>BreakCriticalEdges</tt>, for example, guarantees that there will
 950 be no critical edges in the CFG when your pass has been run.
 951 </p>
 952
 953 <p>
 954 Some analyses chain to other analyses to do their job.  For example, an <a
 955 href="AliasAnalysis.html">AliasAnalysis</a> implementation is required to <a
 956 href="AliasAnalysis.html#chaining">chain</a> to other alias analysis passes.  In
 957 cases where analyses chain, the <tt>addRequiredTransitive</tt> method should be
 958 used instead of the <tt>addRequired</tt> method.  This informs the PassManager
 959 that the transitively required pass should be alive as long as the requiring
 960 pass is.
 961 </p>
 962 </div>
 963
 964 <!-- _______________________________________________________________________ -->
 965 <div class="doc_subsubsection">
 966   <a name="AU::addPreserved">The <tt>AnalysisUsage::addPreserved&lt;&gt;</tt> method</a>
 967 </div>
 968
 969 <div class="doc_text">
 970 <p>
 971 One of the jobs of the PassManager is to optimize how and when analyses are run.
 972 In particular, it attempts to avoid recomputing data unless it needs to.  For
 973 this reason, passes are allowed to declare that they preserve (i.e., they don't
 974 invalidate) an existing analysis if it's available.  For example, a simple
 975 constant folding pass would not modify the CFG, so it can't possible effect the
 976 results of dominator analysis.  By default, all passes are assumed to invalidate
 977 all others.
 978 </p>
 979
 980 <p>
 981 The <tt>AnalysisUsage</tt> class provides several methods which are useful in
 982 certain circumstances that are related to <tt>addPreserved</tt>.  In particular,
 983 the <tt>setPreservesAll</tt> method can be called to indicate that the pass does
 984 not modify the LLVM program at all (which is true for analyses), and the
 985 <tt>setPreservesCFG</tt> method can be used by transformations that change
 986 instructions in the program but do not modify the CFG or terminator instructions
 987 (note that this property is implicitly set for <a
 988 href="#BasicBlockPass">BasicBlockPass</a>'s).
 989 </p>
 990
 991 <p>
 992 <tt>addPreserved</tt> is particularly useful for transformations like
 993 <tt>BreakCriticalEdges</tt>.  This pass knows how to update a small set of loop
 994 and dominator related analyses if they exist, so it can preserve them, despite
 995 the fact that it hacks on the CFG.
 996 </p>
 997 </div>
 998
 999 <!-- _______________________________________________________________________ -->
1000 <div class="doc_subsubsection">
1001   <a name="AU::examples">Example implementations of <tt>getAnalysisUsage</tt></a>
1002 </div>
1003
1004 <div class="doc_text">
1005
1006 <pre>
1007   <i>// This is an example implementation from an analysis, which does not modify
1008   // the program at all, yet has a prerequisite.</i>
1009   <b>void</b> <a href="http://llvm.cs.uiuc.edu/doxygen/structllvm_1_1PostDominanceFrontier.html">PostDominanceFrontier</a>::getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
1010     AU.setPreservesAll();
1011     AU.addRequired&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/structllvm_1_1PostDominatorTree.html">PostDominatorTree</a>&gt;();
1012   }
1013 </pre>
1014
1015 <p>and:</p>
1016
1017 <pre>
1018   <i>// This example modifies the program, but does not modify the CFG</i>
1019   <b>void</b> <a href="http://llvm.cs.uiuc.edu/doxygen/structLICM.html">LICM</a>::getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
1020     AU.setPreservesCFG();
1021     AU.addRequired&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1LoopInfo.html">LoopInfo</a>&gt;();
1022   }
1023 </pre>
1024
1025 </div>
1026
1027 <!-- _______________________________________________________________________ -->
1028 <div class="doc_subsubsection">
1029   <a name="getAnalysis">The <tt>getAnalysis&lt;&gt;</tt> and <tt>getAnalysisToUpdate&lt;&gt;</tt> methods</a>
1030 </div>
1031
1032 <div class="doc_text">
1033
1034 <p>The <tt>Pass::getAnalysis&lt;&gt;</tt> method is automatically inherited by
1035 your class, providing you with access to the passes that you declared that you
1036 required with the <a href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a>
1037 method.  It takes a single template argument that specifies which pass class you
1038 want, and returns a reference to that pass.  For example:</p>
1039
1040 <pre>
1041    bool LICM::runOnFunction(Function &amp;F) {
1042      LoopInfo &amp;LI = getAnalysis&lt;LoopInfo&gt;();
1043      ...
1044    }
1045 </pre>
1046
1047 <p>This method call returns a reference to the pass desired.  You may get a
1048 runtime assertion failure if you attempt to get an analysis that you did not
1049 declare as required in your <a
1050 href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> implementation.  This
1051 method can be called by your <tt>run*</tt> method implementation, or by any
1052 other local method invoked by your <tt>run*</tt> method.</p>
1053
1054 <p>
1055 If your pass is capable of updating analyses if they exist (e.g.,
1056 <tt>BreakCriticalEdges</tt>, as described above), you can use the
1057 <tt>getAnalysisToUpdate</tt> method, which returns a pointer to the analysis if
1058 it is active.  For example:</p>
1059
1060 <pre>
1061   ...
1062   if (DominatorSet *DS = getAnalysisToUpdate&lt;DominatorSet&gt;()) {
1063     <i>// A DominatorSet is active.  This code will update it.</i>
1064   }
1065   ...
1066 </pre>
1067
1068 </div>
1069
1070 <!-- *********************************************************************** -->
1071 <div class="doc_section">
1072   <a name="analysisgroup">Implementing Analysis Groups</a>
1073 </div>
1074 <!-- *********************************************************************** -->
1075
1076 <div class="doc_text">
1077
1078 <p>Now that we understand the basics of how passes are defined, how the are
1079 used, and how they are required from other passes, it's time to get a little bit
1080 fancier.  All of the pass relationships that we have seen so far are very
1081 simple: one pass depends on one other specific pass to be run before it can run.
1082 For many applications, this is great, for others, more flexibility is
1083 required.</p>
1084
1085 <p>In particular, some analyses are defined such that there is a single simple
1086 interface to the analysis results, but multiple ways of calculating them.
1087 Consider alias analysis for example.  The most trivial alias analysis returns
1088 "may alias" for any alias query.  The most sophisticated analysis a
1089 flow-sensitive, context-sensitive interprocedural analysis that can take a
1090 significant amount of time to execute (and obviously, there is a lot of room
1091 between these two extremes for other implementations).  To cleanly support
1092 situations like this, the LLVM Pass Infrastructure supports the notion of
1093 Analysis Groups.</p>
1094
1095 </div>
1096
1097 <!-- _______________________________________________________________________ -->
1098 <div class="doc_subsubsection">
1099   <a name="agconcepts">Analysis Group Concepts</a>
1100 </div>
1101
1102 <div class="doc_text">
1103
1104 <p>An Analysis Group is a single simple interface that may be implemented by
1105 multiple different passes.  Analysis Groups can be given human readable names
1106 just like passes, but unlike passes, they need not derive from the <tt>Pass</tt>
1107 class.  An analysis group may have one or more implementations, one of which is
1108 the "default" implementation.</p>
1109
1110 <p>Analysis groups are used by client passes just like other passes are: the
1111 <tt>AnalysisUsage::addRequired()</tt> and <tt>Pass::getAnalysis()</tt> methods.
1112 In order to resolve this requirement, the <a href="#passmanager">PassManager</a>
1113 scans the available passes to see if any implementations of the analysis group
1114 are available.  If none is available, the default implementation is created for
1115 the pass to use.  All standard rules for <A href="#interaction">interaction
1116 between passes</a> still apply.</p>
1117
1118 <p>Although <a href="#registration">Pass Registration</a> is optional for normal
1119 passes, all analysis group implementations must be registered, and must use the
1120 <A href="#registerag"><tt>RegisterAnalysisGroup</tt></a> template to join the
1121 implementation pool.  Also, a default implementation of the interface
1122 <b>must</b> be registered with <A
1123 href="#registerag"><tt>RegisterAnalysisGroup</tt></a>.</p>
1124
1125 <p>As a concrete example of an Analysis Group in action, consider the <a
1126 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>
1127 analysis group.  The default implementation of the alias analysis interface (the
1128 <tt><a
1129 href="http://llvm.cs.uiuc.edu/doxygen/structBasicAliasAnalysis.html">basicaa</a></tt>
1130 pass) just does a few simple checks that don't require significant analysis to
1131 compute (such as: two different globals can never alias each other, etc).
1132 Passes that use the <tt><a
1133 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a></tt>
1134 interface (for example the <tt><a
1135 href="http://llvm.cs.uiuc.edu/doxygen/structGCSE.html">gcse</a></tt> pass), do
1136 not care which implementation of alias analysis is actually provided, they just
1137 use the designated interface.</p>
1138
1139 <p>From the user's perspective, commands work just like normal.  Issuing the
1140 command '<tt>opt -gcse ...</tt>' will cause the <tt>basicaa</tt> class to be
1141 instantiated and added to the pass sequence.  Issuing the command '<tt>opt
1142 -somefancyaa -gcse ...</tt>' will cause the <tt>gcse</tt> pass to use the
1143 <tt>somefancyaa</tt> alias analysis (which doesn't actually exist, it's just a
1144 hypothetical example) instead.</p>
1145
1146 </div>
1147
1148 <!-- _______________________________________________________________________ -->
1149 <div class="doc_subsubsection">
1150   <a name="registerag">Using <tt>RegisterAnalysisGroup</tt></a>
1151 </div>
1152
1153 <div class="doc_text">
1154
1155 <p>The <tt>RegisterAnalysisGroup</tt> template is used to register the analysis
1156 group itself as well as add pass implementations to the analysis group.  First,
1157 an analysis should be registered, with a human readable name provided for it.
1158 Unlike registration of passes, there is no command line argument to be specified
1159 for the Analysis Group Interface itself, because it is "abstract":</p>
1160
1161 <pre>
1162   <b>static</b> RegisterAnalysisGroup&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>&gt; A("<i>Alias Analysis</i>");
1163 </pre>
1164
1165 <p>Once the analysis is registered, passes can declare that they are valid
1166 implementations of the interface by using the following code:</p>
1167
1168 <pre>
1169 <b>namespace</b> {
1170   //<i> Analysis Group implementations <b>must</b> be registered normally...</i>
1171   RegisterOpt&lt;FancyAA&gt;
1172   B("<i>somefancyaa</i>", "<i>A more complex alias analysis implementation</i>");
1173
1174   //<i> Declare that we implement the AliasAnalysis interface</i>
1175   RegisterAnalysisGroup&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>, FancyAA&gt; C;
1176 }
1177 </pre>
1178
1179 <p>This just shows a class <tt>FancyAA</tt> that is registered normally, then
1180 uses the <tt>RegisterAnalysisGroup</tt> template to "join" the <tt><a
1181 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a></tt>
1182 analysis group.  Every implementation of an analysis group should join using
1183 this template.  A single pass may join multiple different analysis groups with
1184 no problem.</p>
1185
1186 <pre>
1187 <b>namespace</b> {
1188   //<i> Analysis Group implementations <b>must</b> be registered normally...</i>
1189   RegisterOpt&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/structBasicAliasAnalysis.html">BasicAliasAnalysis</a>&gt;
1190   D("<i>basicaa</i>", "<i>Basic Alias Analysis (default AA impl)</i>");
1191
1192   //<i> Declare that we implement the AliasAnalysis interface</i>
1193   RegisterAnalysisGroup&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>, <a href="http://llvm.cs.uiuc.edu/doxygen/structBasicAliasAnalysis.html">BasicAliasAnalysis</a>, <b>true</b>&gt; E;
1194 }
1195 </pre>
1196
1197 <p>Here we show how the default implementation is specified (using the extra
1198 argument to the <tt>RegisterAnalysisGroup</tt> template).  There must be exactly
1199 one default implementation available at all times for an Analysis Group to be
1200 used.  Here we declare that the <tt><a
1201 href="http://llvm.cs.uiuc.edu/doxygen/structBasicAliasAnalysis.html">BasicAliasAnalysis</a></tt>
1202 pass is the default implementation for the interface.</p>
1203
1204 </div>
1205
1206 <!-- *********************************************************************** -->
1207 <div class="doc_section">
1208   <a name="passmanager">What PassManager does</a>
1209 </div>
1210 <!-- *********************************************************************** -->
1211
1212 <div class="doc_text">
1213
1214 <p>The <a
1215 href="http://llvm.cs.uiuc.edu/doxygen/PassManager_8h-source.html"><tt>PassManager</tt></a>
1216 <a
1217 href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1PassManager.html">class</a>
1218 takes a list of passes, ensures their <a href="#interaction">prerequisites</a>
1219 are set up correctly, and then schedules passes to run efficiently.  All of the
1220 LLVM tools that run passes use the <tt>PassManager</tt> for execution of these
1221 passes.</p>
1222
1223 <p>The <tt>PassManager</tt> does two main things to try to reduce the execution
1224 time of a series of passes:</p>
1225
1226 <ol>
1227 <li><b>Share analysis results</b> - The PassManager attempts to avoid
1228 recomputing analysis results as much as possible.  This means keeping track of
1229 which analyses are available already, which analyses get invalidated, and which
1230 analyses are needed to be run for a pass.  An important part of work is that the
1231 <tt>PassManager</tt> tracks the exact lifetime of all analysis results, allowing
1232 it to <a href="#releaseMemory">free memory</a> allocated to holding analysis
1233 results as soon as they are no longer needed.</li>
1234
1235 <li><b>Pipeline the execution of passes on the program</b> - The
1236 <tt>PassManager</tt> attempts to get better cache and memory usage behavior out
1237 of a series of passes by pipelining the passes together.  This means that, given
1238 a series of consequtive <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s, it
1239 will execute all of the <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s on
1240 the first function, then all of the <a
1241 href="#FunctionPass"><tt>FunctionPass</tt></a>es on the second function,
1242 etc... until the entire program has been run through the passes.
1243
1244 <p>This improves the cache behavior of the compiler, because it is only touching
1245 the LLVM program representation for a single function at a time, instead of
1246 traversing the entire program.  It reduces the memory consumption of compiler,
1247 because, for example, only one <a
1248 href="http://llvm.cs.uiuc.edu/doxygen/structllvm_1_1DominatorSet.html"><tt>DominatorSet</tt></a>
1249 needs to be calculated at a time.  This also makes it possible some <a
1250 href="#SMP">interesting enhancements</a> in the future.</p></li>
1251
1252 </ol>
1253
1254 <p>The effectiveness of the <tt>PassManager</tt> is influenced directly by how
1255 much information it has about the behaviors of the passes it is scheduling.  For
1256 example, the "preserved" set is intentionally conservative in the face of an
1257 unimplemented <a href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> method.
1258 Not implementing when it should be implemented will have the effect of not
1259 allowing any analysis results to live across the execution of your pass.</p>
1260
1261 <p>The <tt>PassManager</tt> class exposes a <tt>--debug-pass</tt> command line
1262 options that is useful for debugging pass execution, seeing how things work, and
1263 diagnosing when you should be preserving more analyses than you currently are
1264 (To get information about all of the variants of the <tt>--debug-pass</tt>
1265 option, just type '<tt>opt --help-hidden</tt>').</p>
1266
1267 <p>By using the <tt>--debug-pass=Structure</tt> option, for example, we can see
1268 how our <a href="#basiccode">Hello World</a> pass interacts with other passes.
1269 Lets try it out with the <tt>gcse</tt> and <tt>licm</tt> passes:</p>
1270
1271 <pre>
1272 $ opt -load ../../../lib/Debug/libhello.so -gcse -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
1273 Module Pass Manager
1274   Function Pass Manager
1275     Dominator Set Construction
1276     Immediate Dominators Construction
1277     Global Common Subexpression Elimination
1278 --  Immediate Dominators Construction
1279 --  Global Common Subexpression Elimination
1280     Natural Loop Construction
1281     Loop Invariant Code Motion
1282 --  Natural Loop Construction
1283 --  Loop Invariant Code Motion
1284     Module Verifier
1285 --  Dominator Set Construction
1286 --  Module Verifier
1287   Bytecode Writer
1288 --Bytecode Writer
1289 </pre>
1290
1291 <p>This output shows us when passes are constructed and when the analysis
1292 results are known to be dead (prefixed with '<tt>--</tt>').  Here we see that
1293 GCSE uses dominator and immediate dominator information to do its job.  The LICM
1294 pass uses natural loop information, which uses dominator sets, but not immediate
1295 dominators.  Because immediate dominators are no longer useful after the GCSE
1296 pass, it is immediately destroyed.  The dominator sets are then reused to
1297 compute natural loop information, which is then used by the LICM pass.</p>
1298
1299 <p>After the LICM pass, the module verifier runs (which is automatically added
1300 by the '<tt>opt</tt>' tool), which uses the dominator set to check that the
1301 resultant LLVM code is well formed.  After it finishes, the dominator set
1302 information is destroyed, after being computed once, and shared by three
1303 passes.</p>
1304
1305 <p>Lets see how this changes when we run the <a href="#basiccode">Hello
1306 World</a> pass in between the two passes:</p>
1307
1308 <pre>
1309 $ opt -load ../../../lib/Debug/libhello.so -gcse -hello -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
1310 Module Pass Manager
1311   Function Pass Manager
1312     Dominator Set Construction
1313     Immediate Dominators Construction
1314     Global Common Subexpression Elimination
1315 <b>--  Dominator Set Construction</b>
1316 --  Immediate Dominators Construction
1317 --  Global Common Subexpression Elimination
1318 <b>    Hello World Pass
1319 --  Hello World Pass
1320     Dominator Set Construction</b>
1321     Natural Loop Construction
1322     Loop Invariant Code Motion
1323 --  Natural Loop Construction
1324 --  Loop Invariant Code Motion
1325     Module Verifier
1326 --  Dominator Set Construction
1327 --  Module Verifier
1328   Bytecode Writer
1329 --Bytecode Writer
1330 Hello: __main
1331 Hello: puts
1332 Hello: main
1333 </pre>
1334
1335 <p>Here we see that the <a href="#basiccode">Hello World</a> pass has killed the
1336 Dominator Set pass, even though it doesn't modify the code at all!  To fix this,
1337 we need to add the following <a
1338 href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> method to our pass:</p>
1339
1340 <pre>
1341     <i>// We don't modify the program, so we preserve all analyses</i>
1342     <b>virtual void</b> getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
1343       AU.setPreservesAll();
1344     }
1345 </pre>
1346
1347 <p>Now when we run our pass, we get this output:</p>
1348
1349 <pre>
1350 $ opt -load ../../../lib/Debug/libhello.so -gcse -hello -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
1351 Pass Arguments:  -gcse -hello -licm
1352 Module Pass Manager
1353   Function Pass Manager
1354     Dominator Set Construction
1355     Immediate Dominators Construction
1356     Global Common Subexpression Elimination
1357 --  Immediate Dominators Construction
1358 --  Global Common Subexpression Elimination
1359     Hello World Pass
1360 --  Hello World Pass
1361     Natural Loop Construction
1362     Loop Invariant Code Motion
1363 --  Loop Invariant Code Motion
1364 --  Natural Loop Construction
1365     Module Verifier
1366 --  Dominator Set Construction
1367 --  Module Verifier
1368   Bytecode Writer
1369 --Bytecode Writer
1370 Hello: __main
1371 Hello: puts
1372 Hello: main
1373 </pre>
1374
1375 <p>Which shows that we don't accidentally invalidate dominator information
1376 anymore, and therefore do not have to compute it twice.</p>
1377
1378 </div>
1379
1380 <!-- _______________________________________________________________________ -->
1381 <div class="doc_subsubsection">
1382   <a name="releaseMemory">The <tt>releaseMemory</tt> method</a>
1383 </div>
1384
1385 <div class="doc_text">
1386
1387 <pre>
1388   <b>virtual void</b> releaseMemory();
1389 </pre>
1390
1391 <p>The <tt>PassManager</tt> automatically determines when to compute analysis
1392 results, and how long to keep them around for.  Because the lifetime of the pass
1393 object itself is effectively the entire duration of the compilation process, we
1394 need some way to free analysis results when they are no longer useful.  The
1395 <tt>releaseMemory</tt> virtual method is the way to do this.</p>
1396
1397 <p>If you are writing an analysis or any other pass that retains a significant
1398 amount of state (for use by another pass which "requires" your pass and uses the
1399 <a href="#getAnalysis">getAnalysis</a> method) you should implement
1400 <tt>releaseMEmory</tt> to, well, release the memory allocated to maintain this
1401 internal state.  This method is called after the <tt>run*</tt> method for the
1402 class, before the next call of <tt>run*</tt> in your pass.</p>
1403
1404 </div>
1405
1406 <!-- *********************************************************************** -->
1407 <div class="doc_section">
1408   <a name="debughints">Using GDB with dynamically loaded passes</a>
1409 </div>
1410 <!-- *********************************************************************** -->
1411
1412 <div class="doc_text">
1413
1414 <p>Unfortunately, using GDB with dynamically loaded passes is not as easy as it
1415 should be.  First of all, you can't set a breakpoint in a shared object that has
1416 not been loaded yet, and second of all there are problems with inlined functions
1417 in shared objects.  Here are some suggestions to debugging your pass with
1418 GDB.</p>
1419
1420 <p>For sake of discussion, I'm going to assume that you are debugging a
1421 transformation invoked by <tt>opt</tt>, although nothing described here depends
1422 on that.</p>
1423
1424 </div>
1425
1426 <!-- _______________________________________________________________________ -->
1427 <div class="doc_subsubsection">
1428   <a name="breakpoint">Setting a breakpoint in your pass</a>
1429 </div>
1430
1431 <div class="doc_text">
1432
1433 <p>First thing you do is start <tt>gdb</tt> on the <tt>opt</tt> process:</p>
1434
1435 <pre>
1436 $ <b>gdb opt</b>
1437 GNU gdb 5.0
1438 Copyright 2000 Free Software Foundation, Inc.
1439 GDB is free software, covered by the GNU General Public License, and you are
1440 welcome to change it and/or distribute copies of it under certain conditions.
1441 Type "show copying" to see the conditions.
1442 There is absolutely no warranty for GDB.  Type "show warranty" for details.
1443 This GDB was configured as "sparc-sun-solaris2.6"...
1444 (gdb)
1445 </pre>
1446
1447 <p>Note that <tt>opt</tt> has a lot of debugging information in it, so it takes
1448 time to load.  Be patient.  Since we cannot set a breakpoint in our pass yet
1449 (the shared object isn't loaded until runtime), we must execute the process, and
1450 have it stop before it invokes our pass, but after it has loaded the shared
1451 object.  The most foolproof way of doing this is to set a breakpoint in
1452 <tt>PassManager::run</tt> and then run the process with the arguments you
1453 want:</p>
1454
1455 <pre>
1456 (gdb) <b>break PassManager::run</b>
1457 Breakpoint 1 at 0x2413bc: file Pass.cpp, line 70.
1458 (gdb) <b>run test.bc -load $(LLVMTOP)/llvm/lib/Debug/[libname].so -[passoption]</b>
1459 Starting program: opt test.bc -load $(LLVMTOP)/llvm/lib/Debug/[libname].so -[passoption]
1460 Breakpoint 1, PassManager::run (this=0xffbef174, M=@0x70b298) at Pass.cpp:70
1461 70      bool PassManager::run(Module &amp;M) { return PM-&gt;run(M); }
1462 (gdb)
1463 </pre>
1464
1465 <p>Once the <tt>opt</tt> stops in the <tt>PassManager::run</tt> method you are
1466 now free to set breakpoints in your pass so that you can trace through execution
1467 or do other standard debugging stuff.</p>
1468
1469 </div>
1470
1471 <!-- _______________________________________________________________________ -->
1472 <div class="doc_subsubsection">
1473   <a name="debugmisc">Miscellaneous Problems</a>
1474 </div>
1475
1476 <div class="doc_text">
1477
1478 <p>Once you have the basics down, there are a couple of problems that GDB has,
1479 some with solutions, some without.</p>
1480
1481 <ul>
1482 <li>Inline functions have bogus stack information.  In general, GDB does a
1483 pretty good job getting stack traces and stepping through inline functions.
1484 When a pass is dynamically loaded however, it somehow completely loses this
1485 capability.  The only solution I know of is to de-inline a function (move it
1486 from the body of a class to a .cpp file).</li>
1487
1488 <li>Restarting the program breaks breakpoints.  After following the information
1489 above, you have succeeded in getting some breakpoints planted in your pass.  Nex
1490 thing you know, you restart the program (i.e., you type '<tt>run</tt>' again),
1491 and you start getting errors about breakpoints being unsettable.  The only way I
1492 have found to "fix" this problem is to <tt>delete</tt> the breakpoints that are
1493 already set in your pass, run the program, and re-set the breakpoints once
1494 execution stops in <tt>PassManager::run</tt>.</li>
1495
1496 </ul>
1497
1498 <p>Hopefully these tips will help with common case debugging situations.  If
1499 you'd like to contribute some tips of your own, just contact <a
1500 href="mailto:sabre@nondot.org">Chris</a>.</p>
1501
1502 </div>
1503
1504 <!-- *********************************************************************** -->
1505 <div class="doc_section">
1506   <a name="future">Future extensions planned</a>
1507 </div>
1508 <!-- *********************************************************************** -->
1509
1510 <div class="doc_text">
1511
1512 <p>Although the LLVM Pass Infrastructure is very capable as it stands, and does
1513 some nifty stuff, there are things we'd like to add in the future.  Here is
1514 where we are going:</p>
1515
1516 </div>
1517
1518 <!-- _______________________________________________________________________ -->
1519 <div class="doc_subsubsection">
1520   <a name="SMP">Multithreaded LLVM</a>
1521 </div>
1522
1523 <div class="doc_text">
1524
1525 <p>Multiple CPU machines are becoming more common and compilation can never be
1526 fast enough: obviously we should allow for a multithreaded compiler.  Because of
1527 the semantics defined for passes above (specifically they cannot maintain state
1528 across invocations of their <tt>run*</tt> methods), a nice clean way to
1529 implement a multithreaded compiler would be for the <tt>PassManager</tt> class
1530 to create multiple instances of each pass object, and allow the separate
1531 instances to be hacking on different parts of the program at the same time.</p>
1532
1533 <p>This implementation would prevent each of the passes from having to implement
1534 multithreaded constructs, requiring only the LLVM core to have locking in a few
1535 places (for global resources).  Although this is a simple extension, we simply
1536 haven't had time (or multiprocessor machines, thus a reason) to implement this.
1537 Despite that, we have kept the LLVM passes SMP ready, and you should too.</p>
1538
1539 </div>
1540
1541 <!-- _______________________________________________________________________ -->
1542 <div class="doc_subsubsection">
1543 <a name="PassFunctionPass"><tt>ModulePass</tt>es requiring <tt>FunctionPass</tt>es</a>
1544 </div>
1545
1546 <div class="doc_text">
1547
1548 <p>Currently it is illegal for a <a href="#ModulePass"><tt>ModulePass</tt></a>
1549 to require a <a href="#FunctionPass"><tt>FunctionPass</tt></a>.  This is because
1550 there is only one instance of the <a
1551 href="#FunctionPass"><tt>FunctionPass</tt></a> object ever created, thus nowhere
1552 to store information for all of the functions in the program at the same time.
1553 Although this has come up a couple of times before, this has always been worked
1554 around by factoring one big complicated pass into a global and an
1555 interprocedural part, both of which are distinct.  In the future, it would be
1556 nice to have this though.</p>
1557
1558 <p>Note that it is no problem for a <a
1559 href="#FunctionPass"><tt>FunctionPass</tt></a> to require the results of a <a
1560 href="#ModulePass"><tt>ModulePass</tt></a>, only the other way around.</p>
1561
1562 </div>
1563
1564 <!-- *********************************************************************** -->
1565 <hr>
1566 <address>
1567   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1568   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1569   <a href="http://validator.w3.org/check/referer"><img
1570   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
1571
1572   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1573   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
1574   Last modified: $Date$
1575 </address>
1576
1577 </body>
1578 </html>