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