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