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