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 modify any <tt>Function</tt>s that are not in
 563 the current SCC.</li>
 564
 565 <li>... <em>not allowed</em> to inspect any Function's other than those in the
 566 current SCC and the direct callees of the SCC.</li>
 567
 568 <li>... <em>required</em> to preserve the current CallGraph object, updating it
 569 to reflect any changes made to the program.</li>
 570
 571 <li>... <em>not allowed</em> to add or remove SCC's from the current Module,
 572 though they may change the contents of an SCC.</li>
 573
 574 <li>... <em>allowed</em> to add or remove global variables from the current
 575 Module.</li>
 576
 577 <li>... <em>allowed</em> to maintain state across invocations of
 578     <a href="#runOnSCC"><tt>runOnSCC</tt></a> (including global data).</li>
 579 </ol>
 580
 581 <p>Implementing a <tt>CallGraphSCCPass</tt> is slightly tricky in some cases
 582 because it has to handle SCCs with more than one node in it.  All of the virtual
 583 methods described below should return true if they modified the program, or
 584 false if they didn't.</p>
 585
 586 </div>
 587
 588 <!-- _______________________________________________________________________ -->
 589 <div class="doc_subsubsection">
 590   <a name="doInitialization_scc">The <tt>doInitialization(CallGraph &amp;)</tt>
 591   method</a>
 592 </div>
 593
 594 <div class="doc_text">
 595
 596 <div class="doc_code"><pre>
 597   <b>virtual bool</b> doInitialization(CallGraph &amp;CG);
 598 </pre></div>
 599
 600 <p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
 601 <tt>CallGraphSCCPass</tt>'s are not allowed to do.  They can add and remove
 602 functions, get pointers to functions, etc.  The <tt>doInitialization</tt> method
 603 is designed to do simple initialization type of stuff that does not depend on
 604 the SCCs being processed.  The <tt>doInitialization</tt> method call is not
 605 scheduled to overlap with any other pass executions (thus it should be very
 606 fast).</p>
 607
 608 </div>
 609
 610 <!-- _______________________________________________________________________ -->
 611 <div class="doc_subsubsection">
 612   <a name="runOnSCC">The <tt>runOnSCC</tt> method</a>
 613 </div>
 614
 615 <div class="doc_text">
 616
 617 <div class="doc_code"><pre>
 618   <b>virtual bool</b> runOnSCC(CallGraphSCC &amp;SCC) = 0;
 619 </pre></div>
 620
 621 <p>The <tt>runOnSCC</tt> method performs the interesting work of the pass, and
 622 should return true if the module was modified by the transformation, false
 623 otherwise.</p>
 624
 625 </div>
 626
 627 <!-- _______________________________________________________________________ -->
 628 <div class="doc_subsubsection">
 629   <a name="doFinalization_scc">The <tt>doFinalization(CallGraph
 630    &amp;)</tt> method</a>
 631 </div>
 632
 633 <div class="doc_text">
 634
 635 <div class="doc_code"><pre>
 636   <b>virtual bool</b> doFinalization(CallGraph &amp;CG);
 637 </pre></div>
 638
 639 <p>The <tt>doFinalization</tt> method is an infrequently used method that is
 640 called when the pass framework has finished calling <a
 641 href="#runOnFunction"><tt>runOnFunction</tt></a> for every function in the
 642 program being compiled.</p>
 643
 644 </div>
 645
 646 <!-- ======================================================================= -->
 647 <div class="doc_subsection">
 648   <a name="FunctionPass">The <tt>FunctionPass</tt> class</a>
 649 </div>
 650
 651 <div class="doc_text">
 652
 653 <p>In contrast to <tt>ModulePass</tt> subclasses, <tt><a
 654 href="http://llvm.org/doxygen/classllvm_1_1Pass.html">FunctionPass</a></tt>
 655 subclasses do have a predictable, local behavior that can be expected by the
 656 system.  All <tt>FunctionPass</tt> execute on each function in the program
 657 independent of all of the other functions in the program.
 658 <tt>FunctionPass</tt>'s do not require that they are executed in a particular
 659 order, and <tt>FunctionPass</tt>'s do not modify external functions.</p>
 660
 661 <p>To be explicit, <tt>FunctionPass</tt> subclasses are not allowed to:</p>
 662
 663 <ol>
 664 <li>Modify a Function other than the one currently being processed.</li>
 665 <li>Add or remove Function's from the current Module.</li>
 666 <li>Add or remove global variables from the current Module.</li>
 667 <li>Maintain state across invocations of
 668     <a href="#runOnFunction"><tt>runOnFunction</tt></a> (including global data)</li>
 669 </ol>
 670
 671 <p>Implementing a <tt>FunctionPass</tt> is usually straightforward (See the <a
 672 href="#basiccode">Hello World</a> pass for example).  <tt>FunctionPass</tt>'s
 673 may overload three virtual methods to do their work.  All of these methods
 674 should return true if they modified the program, or false if they didn't.</p>
 675
 676 </div>
 677
 678 <!-- _______________________________________________________________________ -->
 679 <div class="doc_subsubsection">
 680   <a name="doInitialization_mod">The <tt>doInitialization(Module &amp;)</tt>
 681   method</a>
 682 </div>
 683
 684 <div class="doc_text">
 685
 686 <div class="doc_code"><pre>
 687   <b>virtual bool</b> doInitialization(Module &amp;M);
 688 </pre></div>
 689
 690 <p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
 691 <tt>FunctionPass</tt>'s are not allowed to do.  They can add and remove
 692 functions, get pointers to functions, etc.  The <tt>doInitialization</tt> method
 693 is designed to do simple initialization type of stuff that does not depend on
 694 the functions being processed.  The <tt>doInitialization</tt> method call is not
 695 scheduled to overlap with any other pass executions (thus it should be very
 696 fast).</p>
 697
 698 <p>A good example of how this method should be used is the <a
 699 href="http://llvm.org/doxygen/LowerAllocations_8cpp-source.html">LowerAllocations</a>
 700 pass.  This pass converts <tt>malloc</tt> and <tt>free</tt> instructions into
 701 platform dependent <tt>malloc()</tt> and <tt>free()</tt> function calls.  It
 702 uses the <tt>doInitialization</tt> method to get a reference to the malloc and
 703 free functions that it needs, adding prototypes to the module if necessary.</p>
 704
 705 </div>
 706
 707 <!-- _______________________________________________________________________ -->
 708 <div class="doc_subsubsection">
 709   <a name="runOnFunction">The <tt>runOnFunction</tt> method</a>
 710 </div>
 711
 712 <div class="doc_text">
 713
 714 <div class="doc_code"><pre>
 715   <b>virtual bool</b> runOnFunction(Function &amp;F) = 0;
 716 </pre></div><p>
 717
 718 <p>The <tt>runOnFunction</tt> method must be implemented by your subclass to do
 719 the transformation or analysis work of your pass.  As usual, a true value should
 720 be returned if the function is modified.</p>
 721
 722 </div>
 723
 724 <!-- _______________________________________________________________________ -->
 725 <div class="doc_subsubsection">
 726   <a name="doFinalization_mod">The <tt>doFinalization(Module
 727   &amp;)</tt> method</a>
 728 </div>
 729
 730 <div class="doc_text">
 731
 732 <div class="doc_code"><pre>
 733   <b>virtual bool</b> doFinalization(Module &amp;M);
 734 </pre></div>
 735
 736 <p>The <tt>doFinalization</tt> method is an infrequently used method that is
 737 called when the pass framework has finished calling <a
 738 href="#runOnFunction"><tt>runOnFunction</tt></a> for every function in the
 739 program being compiled.</p>
 740
 741 </div>
 742
 743 <!-- ======================================================================= -->
 744 <div class="doc_subsection">
 745   <a name="LoopPass">The <tt>LoopPass</tt> class </a>
 746 </div>
 747
 748 <div class="doc_text">
 749
 750 <p> All <tt>LoopPass</tt> execute on each loop in the function independent of
 751 all of the other loops in the function. <tt>LoopPass</tt> processes loops in
 752 loop nest order such that outer most loop is processed last. </p>
 753
 754 <p> <tt>LoopPass</tt> subclasses are allowed to update loop nest using
 755 <tt>LPPassManager</tt> interface. Implementing a loop pass is usually
 756 straightforward. <tt>Looppass</tt>'s may overload three virtual methods to
 757 do their work. All these methods should return true if they modified the
 758 program, or false if they didn't. </p>
 759 </div>
 760
 761 <!-- _______________________________________________________________________ -->
 762 <div class="doc_subsubsection">
 763   <a name="doInitialization_loop">The <tt>doInitialization(Loop *,
 764                                                  LPPassManager &amp;)</tt>
 765   method</a>
 766 </div>
 767
 768 <div class="doc_text">
 769
 770 <div class="doc_code"><pre>
 771   <b>virtual bool</b> doInitialization(Loop *, LPPassManager &amp;LPM);
 772 </pre></div>
 773
 774 <p>The <tt>doInitialization</tt> method is designed to do simple initialization
 775 type of stuff that does not depend on the functions being processed.  The
 776 <tt>doInitialization</tt> method call is not scheduled to overlap with any
 777 other pass executions (thus it should be very fast). LPPassManager
 778 interface should be used to access Function or Module level analysis
 779 information.</p>
 780
 781 </div>
 782
 783
 784 <!-- _______________________________________________________________________ -->
 785 <div class="doc_subsubsection">
 786   <a name="runOnLoop">The <tt>runOnLoop</tt> method</a>
 787 </div>
 788
 789 <div class="doc_text">
 790
 791 <div class="doc_code"><pre>
 792   <b>virtual bool</b> runOnLoop(Loop *, LPPassManager &amp;LPM) = 0;
 793 </pre></div><p>
 794
 795 <p>The <tt>runOnLoop</tt> method must be implemented by your subclass to do
 796 the transformation or analysis work of your pass.  As usual, a true value should
 797 be returned if the function is modified. <tt>LPPassManager</tt> interface
 798 should be used to update loop nest.</p>
 799
 800 </div>
 801
 802 <!-- _______________________________________________________________________ -->
 803 <div class="doc_subsubsection">
 804   <a name="doFinalization_loop">The <tt>doFinalization()</tt> method</a>
 805 </div>
 806
 807 <div class="doc_text">
 808
 809 <div class="doc_code"><pre>
 810   <b>virtual bool</b> doFinalization();
 811 </pre></div>
 812
 813 <p>The <tt>doFinalization</tt> method is an infrequently used method that is
 814 called when the pass framework has finished calling <a
 815 href="#runOnLoop"><tt>runOnLoop</tt></a> for every loop in the
 816 program being compiled. </p>
 817
 818 </div>
 819
 820 <!-- ======================================================================= -->
 821 <div class="doc_subsection">
 822   <a name="RegionPass">The <tt>RegionPass</tt> class </a>
 823 </div>
 824
 825 <div class="doc_text">
 826
 827 <p> <tt>RegionPass</tt> is similar to <a href="#LoopPass"><tt>LoopPass</tt></a>,
 828 but executes on each single entry single exit region in the function.
 829 <tt>RegionPass</tt> processes regions in nested order such that the outer most
 830 region is processed last.  </p>
 831
 832 <p> <tt>RegionPass</tt> subclasses are allowed to update the region tree by using
 833 the <tt>RGPassManager</tt> interface. You may overload three virtual methods of
 834 <tt>RegionPass</tt> to implementing your own region pass is usually. All these
 835 methods should return true if they modified the program, or false if they didn not.
 836 </p>
 837 </div>
 838
 839 <!-- _______________________________________________________________________ -->
 840 <div class="doc_subsubsection">
 841   <a name="doInitialization_region">The <tt>doInitialization(Region *,
 842                                                  RGPassManager &amp;)</tt>
 843   method</a>
 844 </div>
 845
 846 <div class="doc_text">
 847
 848 <div class="doc_code"><pre>
 849   <b>virtual bool</b> doInitialization(Region *, RGPassManager &amp;RGM);
 850 </pre></div>
 851
 852 <p>The <tt>doInitialization</tt> method is designed to do simple initialization
 853 type of stuff that does not depend on the functions being processed.  The
 854 <tt>doInitialization</tt> method call is not scheduled to overlap with any
 855 other pass executions (thus it should be very fast). RPPassManager
 856 interface should be used to access Function or Module level analysis
 857 information.</p>
 858
 859 </div>
 860
 861
 862 <!-- _______________________________________________________________________ -->
 863 <div class="doc_subsubsection">
 864   <a name="runOnRegion">The <tt>runOnRegion</tt> method</a>
 865 </div>
 866
 867 <div class="doc_text">
 868
 869 <div class="doc_code"><pre>
 870   <b>virtual bool</b> runOnRegion(Region *, RGPassManager &amp;RGM) = 0;
 871 </pre></div><p>
 872
 873 <p>The <tt>runOnRegion</tt> method must be implemented by your subclass to do
 874 the transformation or analysis work of your pass.  As usual, a true value should
 875 be returned if the region is modified. <tt>RGPassManager</tt> interface
 876 should be used to update region tree.</p>
 877
 878 </div>
 879
 880 <!-- _______________________________________________________________________ -->
 881 <div class="doc_subsubsection">
 882   <a name="doFinalization_region">The <tt>doFinalization()</tt> method</a>
 883 </div>
 884
 885 <div class="doc_text">
 886
 887 <div class="doc_code"><pre>
 888   <b>virtual bool</b> doFinalization();
 889 </pre></div>
 890
 891 <p>The <tt>doFinalization</tt> method is an infrequently used method that is
 892 called when the pass framework has finished calling <a
 893 href="#runOnRegion"><tt>runOnRegion</tt></a> for every region in the
 894 program being compiled. </p>
 895
 896 </div>
 897
 898
 899
 900 <!-- ======================================================================= -->
 901 <div class="doc_subsection">
 902   <a name="BasicBlockPass">The <tt>BasicBlockPass</tt> class</a>
 903 </div>
 904
 905 <div class="doc_text">
 906
 907 <p><tt>BasicBlockPass</tt>'s are just like <a
 908 href="#FunctionPass"><tt>FunctionPass</tt></a>'s, except that they must limit
 909 their scope of inspection and modification to a single basic block at a time.
 910 As such, they are <b>not</b> allowed to do any of the following:</p>
 911
 912 <ol>
 913 <li>Modify or inspect any basic blocks outside of the current one</li>
 914 <li>Maintain state across invocations of
 915     <a href="#runOnBasicBlock"><tt>runOnBasicBlock</tt></a></li>
 916 <li>Modify the control flow graph (by altering terminator instructions)</li>
 917 <li>Any of the things forbidden for
 918     <a href="#FunctionPass"><tt>FunctionPass</tt></a>es.</li>
 919 </ol>
 920
 921 <p><tt>BasicBlockPass</tt>es are useful for traditional local and "peephole"
 922 optimizations.  They may override the same <a
 923 href="#doInitialization_mod"><tt>doInitialization(Module &amp;)</tt></a> and <a
 924 href="#doFinalization_mod"><tt>doFinalization(Module &amp;)</tt></a> methods that <a
 925 href="#FunctionPass"><tt>FunctionPass</tt></a>'s have, but also have the following virtual methods that may also be implemented:</p>
 926
 927 </div>
 928
 929 <!-- _______________________________________________________________________ -->
 930 <div class="doc_subsubsection">
 931   <a name="doInitialization_fn">The <tt>doInitialization(Function
 932   &amp;)</tt> method</a>
 933 </div>
 934
 935 <div class="doc_text">
 936
 937 <div class="doc_code"><pre>
 938   <b>virtual bool</b> doInitialization(Function &amp;F);
 939 </pre></div>
 940
 941 <p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
 942 <tt>BasicBlockPass</tt>'s are not allowed to do, but that
 943 <tt>FunctionPass</tt>'s can.  The <tt>doInitialization</tt> method is designed
 944 to do simple initialization that does not depend on the
 945 BasicBlocks being processed.  The <tt>doInitialization</tt> method call is not
 946 scheduled to overlap with any other pass executions (thus it should be very
 947 fast).</p>
 948
 949 </div>
 950
 951 <!-- _______________________________________________________________________ -->
 952 <div class="doc_subsubsection">
 953   <a name="runOnBasicBlock">The <tt>runOnBasicBlock</tt> method</a>
 954 </div>
 955
 956 <div class="doc_text">
 957
 958 <div class="doc_code"><pre>
 959   <b>virtual bool</b> runOnBasicBlock(BasicBlock &amp;BB) = 0;
 960 </pre></div>
 961
 962 <p>Override this function to do the work of the <tt>BasicBlockPass</tt>.  This
 963 function is not allowed to inspect or modify basic blocks other than the
 964 parameter, and are not allowed to modify the CFG.  A true value must be returned
 965 if the basic block is modified.</p>
 966
 967 </div>
 968
 969 <!-- _______________________________________________________________________ -->
 970 <div class="doc_subsubsection">
 971   <a name="doFinalization_fn">The <tt>doFinalization(Function &amp;)</tt>
 972   method</a>
 973 </div>
 974
 975 <div class="doc_text">
 976
 977 <div class="doc_code"><pre>
 978   <b>virtual bool</b> doFinalization(Function &amp;F);
 979 </pre></div>
 980
 981 <p>The <tt>doFinalization</tt> method is an infrequently used method that is
 982 called when the pass framework has finished calling <a
 983 href="#runOnBasicBlock"><tt>runOnBasicBlock</tt></a> for every BasicBlock in the
 984 program being compiled.  This can be used to perform per-function
 985 finalization.</p>
 986
 987 </div>
 988
 989 <!-- ======================================================================= -->
 990 <div class="doc_subsection">
 991   <a name="MachineFunctionPass">The <tt>MachineFunctionPass</tt> class</a>
 992 </div>
 993
 994 <div class="doc_text">
 995
 996 <p>A <tt>MachineFunctionPass</tt> is a part of the LLVM code generator that
 997 executes on the machine-dependent representation of each LLVM function in the
 998 program.</p>
 999
1000 <p>Code generator passes are registered and initialized specially by
1001 <tt>TargetMachine::addPassesToEmitFile</tt> and similar routines, so they
1002 cannot generally be run from the <tt>opt</tt> or <tt>bugpoint</tt>
1003 commands.</p>
1004
1005 <p>A <tt>MachineFunctionPass</tt> is also a <tt>FunctionPass</tt>, so all
1006 the restrictions that apply to a <tt>FunctionPass</tt> also apply to it.
1007 <tt>MachineFunctionPass</tt>es also have additional restrictions. In particular,
1008 <tt>MachineFunctionPass</tt>es are not allowed to do any of the following:</p>
1009
1010 <ol>
1011 <li>Modify or create any LLVM IR Instructions, BasicBlocks, Arguments,
1012     Functions, GlobalVariables, GlobalAliases, or Modules.</li>
1013 <li>Modify a MachineFunction other than the one currently being processed.</li>
1014 <li>Maintain state across invocations of <a
1015 href="#runOnMachineFunction"><tt>runOnMachineFunction</tt></a> (including global
1016 data)</li>
1017 </ol>
1018
1019 </div>
1020
1021 <!-- _______________________________________________________________________ -->
1022 <div class="doc_subsubsection">
1023   <a name="runOnMachineFunction">The <tt>runOnMachineFunction(MachineFunction
1024   &amp;MF)</tt> method</a>
1025 </div>
1026
1027 <div class="doc_text">
1028
1029 <div class="doc_code"><pre>
1030   <b>virtual bool</b> runOnMachineFunction(MachineFunction &amp;MF) = 0;
1031 </pre></div>
1032
1033 <p><tt>runOnMachineFunction</tt> can be considered the main entry point of a
1034 <tt>MachineFunctionPass</tt>; that is, you should override this method to do the
1035 work of your <tt>MachineFunctionPass</tt>.</p>
1036
1037 <p>The <tt>runOnMachineFunction</tt> method is called on every
1038 <tt>MachineFunction</tt> in a <tt>Module</tt>, so that the
1039 <tt>MachineFunctionPass</tt> may perform optimizations on the machine-dependent
1040 representation of the function. If you want to get at the LLVM <tt>Function</tt>
1041 for the <tt>MachineFunction</tt> you're working on, use
1042 <tt>MachineFunction</tt>'s <tt>getFunction()</tt> accessor method -- but
1043 remember, you may not modify the LLVM <tt>Function</tt> or its contents from a
1044 <tt>MachineFunctionPass</tt>.</p>
1045
1046 </div>
1047
1048 <!-- *********************************************************************** -->
1049 <div class="doc_section">
1050   <a name="registration">Pass registration</a>
1051 </div>
1052 <!-- *********************************************************************** -->
1053
1054 <div class="doc_text">
1055
1056 <p>In the <a href="#basiccode">Hello World</a> example pass we illustrated how
1057 pass registration works, and discussed some of the reasons that it is used and
1058 what it does.  Here we discuss how and why passes are registered.</p>
1059
1060 <p>As we saw above, passes are registered with the <b><tt>RegisterPass</tt></b>
1061 template.  The template parameter is the name of the pass that is to be used on
1062 the command line to specify that the pass should be added to a program (for
1063 example, with <tt>opt</tt> or <tt>bugpoint</tt>).  The first argument is the
1064 name of the pass, which is to be used for the <tt>-help</tt> output of
1065 programs, as
1066 well as for debug output generated by the <tt>--debug-pass</tt> option.</p>
1067
1068 <p>If you want your pass to be easily dumpable, you should
1069 implement the virtual <tt>print</tt> method:</p>
1070
1071 </div>
1072
1073 <!-- _______________________________________________________________________ -->
1074 <div class="doc_subsubsection">
1075   <a name="print">The <tt>print</tt> method</a>
1076 </div>
1077
1078 <div class="doc_text">
1079
1080 <div class="doc_code"><pre>
1081   <b>virtual void</b> print(std::ostream &amp;O, <b>const</b> Module *M) <b>const</b>;
1082 </pre></div>
1083
1084 <p>The <tt>print</tt> method must be implemented by "analyses" in order to print
1085 a human readable version of the analysis results.  This is useful for debugging
1086 an analysis itself, as well as for other people to figure out how an analysis
1087 works.  Use the <tt>opt -analyze</tt> argument to invoke this method.</p>
1088
1089 <p>The <tt>llvm::OStream</tt> parameter specifies the stream to write the results on,
1090 and the <tt>Module</tt> parameter gives a pointer to the top level module of the
1091 program that has been analyzed.  Note however that this pointer may be null in
1092 certain circumstances (such as calling the <tt>Pass::dump()</tt> from a
1093 debugger), so it should only be used to enhance debug output, it should not be
1094 depended on.</p>
1095
1096 </div>
1097
1098 <!-- *********************************************************************** -->
1099 <div class="doc_section">
1100   <a name="interaction">Specifying interactions between passes</a>
1101 </div>
1102 <!-- *********************************************************************** -->
1103
1104 <div class="doc_text">
1105
1106 <p>One of the main responsibilities of the <tt>PassManager</tt> is to make sure
1107 that passes interact with each other correctly.  Because <tt>PassManager</tt>
1108 tries to <a href="#passmanager">optimize the execution of passes</a> it must
1109 know how the passes interact with each other and what dependencies exist between
1110 the various passes.  To track this, each pass can declare the set of passes that
1111 are required to be executed before the current pass, and the passes which are
1112 invalidated by the current pass.</p>
1113
1114 <p>Typically this functionality is used to require that analysis results are
1115 computed before your pass is run.  Running arbitrary transformation passes can
1116 invalidate the computed analysis results, which is what the invalidation set
1117 specifies.  If a pass does not implement the <tt><a
1118 href="#getAnalysisUsage">getAnalysisUsage</a></tt> method, it defaults to not
1119 having any prerequisite passes, and invalidating <b>all</b> other passes.</p>
1120
1121 </div>
1122
1123 <!-- _______________________________________________________________________ -->
1124 <div class="doc_subsubsection">
1125   <a name="getAnalysisUsage">The <tt>getAnalysisUsage</tt> method</a>
1126 </div>
1127
1128 <div class="doc_text">
1129
1130 <div class="doc_code"><pre>
1131   <b>virtual void</b> getAnalysisUsage(AnalysisUsage &amp;Info) <b>const</b>;
1132 </pre></div>
1133
1134 <p>By implementing the <tt>getAnalysisUsage</tt> method, the required and
1135 invalidated sets may be specified for your transformation.  The implementation
1136 should fill in the <tt><a
1137 href="http://llvm.org/doxygen/classllvm_1_1AnalysisUsage.html">AnalysisUsage</a></tt>
1138 object with information about which passes are required and not invalidated.  To
1139 do this, a pass may call any of the following methods on the AnalysisUsage
1140 object:</p>
1141 </div>
1142
1143 <!-- _______________________________________________________________________ -->
1144 <div class="doc_subsubsection">
1145   <a name="AU::addRequired">The <tt>AnalysisUsage::addRequired&lt;&gt;</tt> and <tt>AnalysisUsage::addRequiredTransitive&lt;&gt;</tt> methods</a>
1146 </div>
1147
1148 <div class="doc_text">
1149 <p>
1150 If your pass requires a previous pass to be executed (an analysis for example),
1151 it can use one of these methods to arrange for it to be run before your pass.
1152 LLVM has many different types of analyses and passes that can be required,
1153 spanning the range from <tt>DominatorSet</tt> to <tt>BreakCriticalEdges</tt>.
1154 Requiring <tt>BreakCriticalEdges</tt>, for example, guarantees that there will
1155 be no critical edges in the CFG when your pass has been run.
1156 </p>
1157
1158 <p>
1159 Some analyses chain to other analyses to do their job.  For example, an <a
1160 href="AliasAnalysis.html">AliasAnalysis</a> implementation is required to <a
1161 href="AliasAnalysis.html#chaining">chain</a> to other alias analysis passes.  In
1162 cases where analyses chain, the <tt>addRequiredTransitive</tt> method should be
1163 used instead of the <tt>addRequired</tt> method.  This informs the PassManager
1164 that the transitively required pass should be alive as long as the requiring
1165 pass is.
1166 </p>
1167 </div>
1168
1169 <!-- _______________________________________________________________________ -->
1170 <div class="doc_subsubsection">
1171   <a name="AU::addPreserved">The <tt>AnalysisUsage::addPreserved&lt;&gt;</tt> method</a>
1172 </div>
1173
1174 <div class="doc_text">
1175 <p>
1176 One of the jobs of the PassManager is to optimize how and when analyses are run.
1177 In particular, it attempts to avoid recomputing data unless it needs to.  For
1178 this reason, passes are allowed to declare that they preserve (i.e., they don't
1179 invalidate) an existing analysis if it's available.  For example, a simple
1180 constant folding pass would not modify the CFG, so it can't possibly affect the
1181 results of dominator analysis.  By default, all passes are assumed to invalidate
1182 all others.
1183 </p>
1184
1185 <p>
1186 The <tt>AnalysisUsage</tt> class provides several methods which are useful in
1187 certain circumstances that are related to <tt>addPreserved</tt>.  In particular,
1188 the <tt>setPreservesAll</tt> method can be called to indicate that the pass does
1189 not modify the LLVM program at all (which is true for analyses), and the
1190 <tt>setPreservesCFG</tt> method can be used by transformations that change
1191 instructions in the program but do not modify the CFG or terminator instructions
1192 (note that this property is implicitly set for <a
1193 href="#BasicBlockPass">BasicBlockPass</a>'s).
1194 </p>
1195
1196 <p>
1197 <tt>addPreserved</tt> is particularly useful for transformations like
1198 <tt>BreakCriticalEdges</tt>.  This pass knows how to update a small set of loop
1199 and dominator related analyses if they exist, so it can preserve them, despite
1200 the fact that it hacks on the CFG.
1201 </p>
1202 </div>
1203
1204 <!-- _______________________________________________________________________ -->
1205 <div class="doc_subsubsection">
1206   <a name="AU::examples">Example implementations of <tt>getAnalysisUsage</tt></a>
1207 </div>
1208
1209 <div class="doc_text">
1210
1211 <div class="doc_code"><pre>
1212   <i>// This is an example implementation from an analysis, which does not modify
1213   // the program at all, yet has a prerequisite.</i>
1214   <b>void</b> <a href="http://llvm.org/doxygen/classllvm_1_1PostDominanceFrontier.html">PostDominanceFrontier</a>::getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
1215     AU.setPreservesAll();
1216     AU.addRequired&lt;<a href="http://llvm.org/doxygen/classllvm_1_1PostDominatorTree.html">PostDominatorTree</a>&gt;();
1217   }
1218 </pre></div>
1219
1220 <p>and:</p>
1221
1222 <div class="doc_code"><pre>
1223   <i>// This example modifies the program, but does not modify the CFG</i>
1224   <b>void</b> <a href="http://llvm.org/doxygen/structLICM.html">LICM</a>::getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
1225     AU.setPreservesCFG();
1226     AU.addRequired&lt;<a href="http://llvm.org/doxygen/classllvm_1_1LoopInfo.html">LoopInfo</a>&gt;();
1227   }
1228 </pre></div>
1229
1230 </div>
1231
1232 <!-- _______________________________________________________________________ -->
1233 <div class="doc_subsubsection">
1234   <a name="getAnalysis">The <tt>getAnalysis&lt;&gt;</tt> and
1235 <tt>getAnalysisIfAvailable&lt;&gt;</tt> methods</a>
1236 </div>
1237
1238 <div class="doc_text">
1239
1240 <p>The <tt>Pass::getAnalysis&lt;&gt;</tt> method is automatically inherited by
1241 your class, providing you with access to the passes that you declared that you
1242 required with the <a href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a>
1243 method.  It takes a single template argument that specifies which pass class you
1244 want, and returns a reference to that pass.  For example:</p>
1245
1246 <div class="doc_code"><pre>
1247    bool LICM::runOnFunction(Function &amp;F) {
1248      LoopInfo &amp;LI = getAnalysis&lt;LoopInfo&gt;();
1249      ...
1250    }
1251 </pre></div>
1252
1253 <p>This method call returns a reference to the pass desired.  You may get a
1254 runtime assertion failure if you attempt to get an analysis that you did not
1255 declare as required in your <a
1256 href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> implementation.  This
1257 method can be called by your <tt>run*</tt> method implementation, or by any
1258 other local method invoked by your <tt>run*</tt> method.
1259
1260 A module level pass can use function level analysis info using this interface.
1261 For example:</p>
1262
1263 <div class="doc_code"><pre>
1264    bool ModuleLevelPass::runOnModule(Module &amp;M) {
1265      ...
1266      DominatorTree &amp;DT = getAnalysis&lt;DominatorTree&gt;(Func);
1267      ...
1268    }
1269 </pre></div>
1270
1271 <p>In above example, runOnFunction for DominatorTree is called by pass manager
1272 before returning a reference to the desired pass.</p>
1273
1274 <p>
1275 If your pass is capable of updating analyses if they exist (e.g.,
1276 <tt>BreakCriticalEdges</tt>, as described above), you can use the
1277 <tt>getAnalysisIfAvailable</tt> method, which returns a pointer to the analysis
1278 if it is active.  For example:</p>
1279
1280 <div class="doc_code"><pre>
1281   ...
1282   if (DominatorSet *DS = getAnalysisIfAvailable&lt;DominatorSet&gt;()) {
1283     <i>// A DominatorSet is active.  This code will update it.</i>
1284   }
1285   ...
1286 </pre></div>
1287
1288 </div>
1289
1290 <!-- *********************************************************************** -->
1291 <div class="doc_section">
1292   <a name="analysisgroup">Implementing Analysis Groups</a>
1293 </div>
1294 <!-- *********************************************************************** -->
1295
1296 <div class="doc_text">
1297
1298 <p>Now that we understand the basics of how passes are defined, how they are
1299 used, and how they are required from other passes, it's time to get a little bit
1300 fancier.  All of the pass relationships that we have seen so far are very
1301 simple: one pass depends on one other specific pass to be run before it can run.
1302 For many applications, this is great, for others, more flexibility is
1303 required.</p>
1304
1305 <p>In particular, some analyses are defined such that there is a single simple
1306 interface to the analysis results, but multiple ways of calculating them.
1307 Consider alias analysis for example.  The most trivial alias analysis returns
1308 "may alias" for any alias query.  The most sophisticated analysis a
1309 flow-sensitive, context-sensitive interprocedural analysis that can take a
1310 significant amount of time to execute (and obviously, there is a lot of room
1311 between these two extremes for other implementations).  To cleanly support
1312 situations like this, the LLVM Pass Infrastructure supports the notion of
1313 Analysis Groups.</p>
1314
1315 </div>
1316
1317 <!-- _______________________________________________________________________ -->
1318 <div class="doc_subsubsection">
1319   <a name="agconcepts">Analysis Group Concepts</a>
1320 </div>
1321
1322 <div class="doc_text">
1323
1324 <p>An Analysis Group is a single simple interface that may be implemented by
1325 multiple different passes.  Analysis Groups can be given human readable names
1326 just like passes, but unlike passes, they need not derive from the <tt>Pass</tt>
1327 class.  An analysis group may have one or more implementations, one of which is
1328 the "default" implementation.</p>
1329
1330 <p>Analysis groups are used by client passes just like other passes are: the
1331 <tt>AnalysisUsage::addRequired()</tt> and <tt>Pass::getAnalysis()</tt> methods.
1332 In order to resolve this requirement, the <a href="#passmanager">PassManager</a>
1333 scans the available passes to see if any implementations of the analysis group
1334 are available.  If none is available, the default implementation is created for
1335 the pass to use.  All standard rules for <A href="#interaction">interaction
1336 between passes</a> still apply.</p>
1337
1338 <p>Although <a href="#registration">Pass Registration</a> is optional for normal
1339 passes, all analysis group implementations must be registered, and must use the
1340 <A href="#registerag"><tt>INITIALIZE_AG_PASS</tt></a> template to join the
1341 implementation pool.  Also, a default implementation of the interface
1342 <b>must</b> be registered with <A
1343 href="#registerag"><tt>RegisterAnalysisGroup</tt></a>.</p>
1344
1345 <p>As a concrete example of an Analysis Group in action, consider the <a
1346 href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>
1347 analysis group.  The default implementation of the alias analysis interface (the
1348 <tt><a
1349 href="http://llvm.org/doxygen/structBasicAliasAnalysis.html">basicaa</a></tt>
1350 pass) just does a few simple checks that don't require significant analysis to
1351 compute (such as: two different globals can never alias each other, etc).
1352 Passes that use the <tt><a
1353 href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a></tt>
1354 interface (for example the <tt><a
1355 href="http://llvm.org/doxygen/structGCSE.html">gcse</a></tt> pass), do
1356 not care which implementation of alias analysis is actually provided, they just
1357 use the designated interface.</p>
1358
1359 <p>From the user's perspective, commands work just like normal.  Issuing the
1360 command '<tt>opt -gcse ...</tt>' will cause the <tt>basicaa</tt> class to be
1361 instantiated and added to the pass sequence.  Issuing the command '<tt>opt
1362 -somefancyaa -gcse ...</tt>' will cause the <tt>gcse</tt> pass to use the
1363 <tt>somefancyaa</tt> alias analysis (which doesn't actually exist, it's just a
1364 hypothetical example) instead.</p>
1365
1366 </div>
1367
1368 <!-- _______________________________________________________________________ -->
1369 <div class="doc_subsubsection">
1370   <a name="registerag">Using <tt>RegisterAnalysisGroup</tt></a>
1371 </div>
1372
1373 <div class="doc_text">
1374
1375 <p>The <tt>RegisterAnalysisGroup</tt> template is used to register the analysis
1376 group itself, while the <tt>INITIALIZE_AG_PASS</tt> is used to add pass
1377 implementations to the analysis group.  First,
1378 an analysis group should be registered, with a human readable name
1379 provided for it.
1380 Unlike registration of passes, there is no command line argument to be specified
1381 for the Analysis Group Interface itself, because it is "abstract":</p>
1382
1383 <div class="doc_code"><pre>
1384   <b>static</b> RegisterAnalysisGroup&lt;<a href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>&gt; A("<i>Alias Analysis</i>");
1385 </pre></div>
1386
1387 <p>Once the analysis is registered, passes can declare that they are valid
1388 implementations of the interface by using the following code:</p>
1389
1390 <div class="doc_code"><pre>
1391 <b>namespace</b> {
1392   //<i> Declare that we implement the AliasAnalysis interface</i>
1393   INITIALIZE_AG_PASS(FancyAA, <a href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>, "<i>somefancyaa</i>",
1394                      "<i>A more complex alias analysis implementation</i>",
1395                      false, // <i>Is CFG Only?</i>
1396                      true,  // <i>Is Analysis?</i>
1397                      false, // <i>Is default Analysis Group implementation?</i>
1398                     );
1399 }
1400 </pre></div>
1401
1402 <p>This just shows a class <tt>FancyAA</tt> that
1403 uses the <tt>INITIALIZE_AG_PASS</tt> macro both to register and
1404 to "join" the <tt><a href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a></tt>
1405 analysis group.  Every implementation of an analysis group should join using
1406 this macro.</p>
1407
1408 <div class="doc_code"><pre>
1409 <b>namespace</b> {
1410   //<i> Declare that we implement the AliasAnalysis interface</i>
1411   INITIALIZE_AG_PASS(BasicAA, <a href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>, "<i>basicaa</i>",
1412                      "<i>Basic Alias Analysis (default AA impl)</i>",
1413                      false, // <i>Is CFG Only?</i>
1414                      true,  // <i>Is Analysis?</i>
1415                      true, // <i>Is default Analysis Group implementation?</i>
1416                     );
1417 }
1418 </pre></div>
1419
1420 <p>Here we show how the default implementation is specified (using the final
1421 argument to the <tt>INITIALIZE_AG_PASS</tt> template).  There must be exactly
1422 one default implementation available at all times for an Analysis Group to be
1423 used.  Only default implementation can derive from <tt>ImmutablePass</tt>.
1424 Here we declare that the
1425  <tt><a href="http://llvm.org/doxygen/structBasicAliasAnalysis.html">BasicAliasAnalysis</a></tt>
1426 pass is the default implementation for the interface.</p>
1427
1428 </div>
1429
1430 <!-- *********************************************************************** -->
1431 <div class="doc_section">
1432   <a name="passStatistics">Pass Statistics</a>
1433 </div>
1434 <!-- *********************************************************************** -->
1435
1436 <div class="doc_text">
1437 <p>The <a
1438 href="http://llvm.org/doxygen/Statistic_8h-source.html"><tt>Statistic</tt></a>
1439 class is designed to be an easy way to expose various success
1440 metrics from passes.  These statistics are printed at the end of a
1441 run, when the -stats command line option is enabled on the command
1442 line. See the <a href="http://llvm.org/docs/ProgrammersManual.html#Statistic">Statistics section</a> in the Programmer's Manual for details.
1443
1444 </div>
1445
1446
1447 <!-- *********************************************************************** -->
1448 <div class="doc_section">
1449   <a name="passmanager">What PassManager does</a>
1450 </div>
1451 <!-- *********************************************************************** -->
1452
1453 <div class="doc_text">
1454
1455 <p>The <a
1456 href="http://llvm.org/doxygen/PassManager_8h-source.html"><tt>PassManager</tt></a>
1457 <a
1458 href="http://llvm.org/doxygen/classllvm_1_1PassManager.html">class</a>
1459 takes a list of passes, ensures their <a href="#interaction">prerequisites</a>
1460 are set up correctly, and then schedules passes to run efficiently.  All of the
1461 LLVM tools that run passes use the <tt>PassManager</tt> for execution of these
1462 passes.</p>
1463
1464 <p>The <tt>PassManager</tt> does two main things to try to reduce the execution
1465 time of a series of passes:</p>
1466
1467 <ol>
1468 <li><b>Share analysis results</b> - The PassManager attempts to avoid
1469 recomputing analysis results as much as possible.  This means keeping track of
1470 which analyses are available already, which analyses get invalidated, and which
1471 analyses are needed to be run for a pass.  An important part of work is that the
1472 <tt>PassManager</tt> tracks the exact lifetime of all analysis results, allowing
1473 it to <a href="#releaseMemory">free memory</a> allocated to holding analysis
1474 results as soon as they are no longer needed.</li>
1475
1476 <li><b>Pipeline the execution of passes on the program</b> - The
1477 <tt>PassManager</tt> attempts to get better cache and memory usage behavior out
1478 of a series of passes by pipelining the passes together.  This means that, given
1479 a series of consequtive <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s, it
1480 will execute all of the <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s on
1481 the first function, then all of the <a
1482 href="#FunctionPass"><tt>FunctionPass</tt></a>es on the second function,
1483 etc... until the entire program has been run through the passes.
1484
1485 <p>This improves the cache behavior of the compiler, because it is only touching
1486 the LLVM program representation for a single function at a time, instead of
1487 traversing the entire program.  It reduces the memory consumption of compiler,
1488 because, for example, only one <a
1489 href="http://llvm.org/doxygen/classllvm_1_1DominatorSet.html"><tt>DominatorSet</tt></a>
1490 needs to be calculated at a time.  This also makes it possible to implement
1491 some <a
1492 href="#SMP">interesting enhancements</a> in the future.</p></li>
1493
1494 </ol>
1495
1496 <p>The effectiveness of the <tt>PassManager</tt> is influenced directly by how
1497 much information it has about the behaviors of the passes it is scheduling.  For
1498 example, the "preserved" set is intentionally conservative in the face of an
1499 unimplemented <a href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> method.
1500 Not implementing when it should be implemented will have the effect of not
1501 allowing any analysis results to live across the execution of your pass.</p>
1502
1503 <p>The <tt>PassManager</tt> class exposes a <tt>--debug-pass</tt> command line
1504 options that is useful for debugging pass execution, seeing how things work, and
1505 diagnosing when you should be preserving more analyses than you currently are
1506 (To get information about all of the variants of the <tt>--debug-pass</tt>
1507 option, just type '<tt>opt -help-hidden</tt>').</p>
1508
1509 <p>By using the <tt>--debug-pass=Structure</tt> option, for example, we can see
1510 how our <a href="#basiccode">Hello World</a> pass interacts with other passes.
1511 Lets try it out with the <tt>gcse</tt> and <tt>licm</tt> passes:</p>
1512
1513 <div class="doc_code"><pre>
1514 $ opt -load ../../../Debug+Asserts/lib/Hello.so -gcse -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
1515 Module Pass Manager
1516   Function Pass Manager
1517     Dominator Set Construction
1518     Immediate Dominators Construction
1519     Global Common Subexpression Elimination
1520 --  Immediate Dominators Construction
1521 --  Global Common Subexpression Elimination
1522     Natural Loop Construction
1523     Loop Invariant Code Motion
1524 --  Natural Loop Construction
1525 --  Loop Invariant Code Motion
1526     Module Verifier
1527 --  Dominator Set Construction
1528 --  Module Verifier
1529   Bitcode Writer
1530 --Bitcode Writer
1531 </pre></div>
1532
1533 <p>This output shows us when passes are constructed and when the analysis
1534 results are known to be dead (prefixed with '<tt>--</tt>').  Here we see that
1535 GCSE uses dominator and immediate dominator information to do its job.  The LICM
1536 pass uses natural loop information, which uses dominator sets, but not immediate
1537 dominators.  Because immediate dominators are no longer useful after the GCSE
1538 pass, it is immediately destroyed.  The dominator sets are then reused to
1539 compute natural loop information, which is then used by the LICM pass.</p>
1540
1541 <p>After the LICM pass, the module verifier runs (which is automatically added
1542 by the '<tt>opt</tt>' tool), which uses the dominator set to check that the
1543 resultant LLVM code is well formed.  After it finishes, the dominator set
1544 information is destroyed, after being computed once, and shared by three
1545 passes.</p>
1546
1547 <p>Lets see how this changes when we run the <a href="#basiccode">Hello
1548 World</a> pass in between the two passes:</p>
1549
1550 <div class="doc_code"><pre>
1551 $ opt -load ../../../Debug+Asserts/lib/Hello.so -gcse -hello -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
1552 Module Pass Manager
1553   Function Pass Manager
1554     Dominator Set Construction
1555     Immediate Dominators Construction
1556     Global Common Subexpression Elimination
1557 <b>--  Dominator Set Construction</b>
1558 --  Immediate Dominators Construction
1559 --  Global Common Subexpression Elimination
1560 <b>    Hello World Pass
1561 --  Hello World Pass
1562     Dominator Set Construction</b>
1563     Natural Loop Construction
1564     Loop Invariant Code Motion
1565 --  Natural Loop Construction
1566 --  Loop Invariant Code Motion
1567     Module Verifier
1568 --  Dominator Set Construction
1569 --  Module Verifier
1570   Bitcode Writer
1571 --Bitcode Writer
1572 Hello: __main
1573 Hello: puts
1574 Hello: main
1575 </pre></div>
1576
1577 <p>Here we see that the <a href="#basiccode">Hello World</a> pass has killed the
1578 Dominator Set pass, even though it doesn't modify the code at all!  To fix this,
1579 we need to add the following <a
1580 href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> method to our pass:</p>
1581
1582 <div class="doc_code"><pre>
1583     <i>// We don't modify the program, so we preserve all analyses</i>
1584     <b>virtual void</b> getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
1585       AU.setPreservesAll();
1586     }
1587 </pre></div>
1588
1589 <p>Now when we run our pass, we get this output:</p>
1590
1591 <div class="doc_code"><pre>
1592 $ opt -load ../../../Debug+Asserts/lib/Hello.so -gcse -hello -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
1593 Pass Arguments:  -gcse -hello -licm
1594 Module Pass Manager
1595   Function Pass Manager
1596     Dominator Set Construction
1597     Immediate Dominators Construction
1598     Global Common Subexpression Elimination
1599 --  Immediate Dominators Construction
1600 --  Global Common Subexpression Elimination
1601     Hello World Pass
1602 --  Hello World Pass
1603     Natural Loop Construction
1604     Loop Invariant Code Motion
1605 --  Loop Invariant Code Motion
1606 --  Natural Loop Construction
1607     Module Verifier
1608 --  Dominator Set Construction
1609 --  Module Verifier
1610   Bitcode Writer
1611 --Bitcode Writer
1612 Hello: __main
1613 Hello: puts
1614 Hello: main
1615 </pre></div>
1616
1617 <p>Which shows that we don't accidentally invalidate dominator information
1618 anymore, and therefore do not have to compute it twice.</p>
1619
1620 </div>
1621
1622 <!-- _______________________________________________________________________ -->
1623 <div class="doc_subsubsection">
1624   <a name="releaseMemory">The <tt>releaseMemory</tt> method</a>
1625 </div>
1626
1627 <div class="doc_text">
1628
1629 <div class="doc_code"><pre>
1630   <b>virtual void</b> releaseMemory();
1631 </pre></div>
1632
1633 <p>The <tt>PassManager</tt> automatically determines when to compute analysis
1634 results, and how long to keep them around for.  Because the lifetime of the pass
1635 object itself is effectively the entire duration of the compilation process, we
1636 need some way to free analysis results when they are no longer useful.  The
1637 <tt>releaseMemory</tt> virtual method is the way to do this.</p>
1638
1639 <p>If you are writing an analysis or any other pass that retains a significant
1640 amount of state (for use by another pass which "requires" your pass and uses the
1641 <a href="#getAnalysis">getAnalysis</a> method) you should implement
1642 <tt>releaseMemory</tt> to, well, release the memory allocated to maintain this
1643 internal state.  This method is called after the <tt>run*</tt> method for the
1644 class, before the next call of <tt>run*</tt> in your pass.</p>
1645
1646 </div>
1647
1648 <!-- *********************************************************************** -->
1649 <div class="doc_section">
1650   <a name="registering">Registering dynamically loaded passes</a>
1651 </div>
1652 <!-- *********************************************************************** -->
1653
1654 <div class="doc_text">
1655
1656 <p><i>Size matters</i> when constructing production quality tools using llvm,
1657 both for the purposes of distribution, and for regulating the resident code size
1658 when running on the target system. Therefore, it becomes desirable to
1659 selectively use some passes, while omitting others and maintain the flexibility
1660 to change configurations later on. You want to be able to do all this, and,
1661 provide feedback to the user. This is where pass registration comes into
1662 play.</p>
1663
1664 <p>The fundamental mechanisms for pass registration are the
1665 <tt>MachinePassRegistry</tt> class and subclasses of
1666 <tt>MachinePassRegistryNode</tt>.</p>
1667
1668 <p>An instance of <tt>MachinePassRegistry</tt> is used to maintain a list of
1669 <tt>MachinePassRegistryNode</tt> objects.  This instance maintains the list and
1670 communicates additions and deletions to the command line interface.</p>
1671
1672 <p>An instance of <tt>MachinePassRegistryNode</tt> subclass is used to maintain
1673 information provided about a particular pass.  This information includes the
1674 command line name, the command help string and the address of the function used
1675 to create an instance of the pass.  A global static constructor of one of these
1676 instances <i>registers</i> with a corresponding <tt>MachinePassRegistry</tt>,
1677 the static destructor <i>unregisters</i>. Thus a pass that is statically linked
1678 in the tool will be registered at start up. A dynamically loaded pass will
1679 register on load and unregister at unload.</p>
1680
1681 </div>
1682
1683 <!-- _______________________________________________________________________ -->
1684 <div class="doc_subsection">
1685   <a name="registering_existing">Using existing registries</a>
1686 </div>
1687
1688 <div class="doc_text">
1689
1690 <p>There are predefined registries to track instruction scheduling
1691 (<tt>RegisterScheduler</tt>) and register allocation (<tt>RegisterRegAlloc</tt>)
1692 machine passes.  Here we will describe how to <i>register</i> a register
1693 allocator machine pass.</p>
1694
1695 <p>Implement your register allocator machine pass.  In your register allocator
1696 .cpp file add the following include;</p>
1697
1698 <div class="doc_code"><pre>
1699   #include "llvm/CodeGen/RegAllocRegistry.h"
1700 </pre></div>
1701
1702 <p>Also in your register allocator .cpp file, define a creator function in the
1703 form; </p>
1704
1705 <div class="doc_code"><pre>
1706   FunctionPass *createMyRegisterAllocator() {
1707     return new MyRegisterAllocator();
1708   }
1709 </pre></div>
1710
1711 <p>Note that the signature of this function should match the type of
1712 <tt>RegisterRegAlloc::FunctionPassCtor</tt>.  In the same file add the
1713 "installing" declaration, in the form;</p>
1714
1715 <div class="doc_code"><pre>
1716   static RegisterRegAlloc myRegAlloc("myregalloc",
1717     "  my register allocator help string",
1718     createMyRegisterAllocator);
1719 </pre></div>
1720
1721 <p>Note the two spaces prior to the help string produces a tidy result on the
1722 -help query.</p>
1723
1724 <div class="doc_code"><pre>
1725 $ llc -help
1726   ...
1727   -regalloc                    - Register allocator to use (default=linearscan)
1728     =linearscan                -   linear scan register allocator
1729     =local                     -   local register allocator
1730     =simple                    -   simple register allocator
1731     =myregalloc                -   my register allocator help string
1732   ...
1733 </pre></div>
1734
1735 <p>And that's it.  The user is now free to use <tt>-regalloc=myregalloc</tt> as
1736 an option.  Registering instruction schedulers is similar except use the
1737 <tt>RegisterScheduler</tt> class.  Note that the
1738 <tt>RegisterScheduler::FunctionPassCtor</tt> is significantly different from
1739 <tt>RegisterRegAlloc::FunctionPassCtor</tt>.</p>
1740
1741 <p>To force the load/linking of your register allocator into the llc/lli tools,
1742 add your creator function's global declaration to "Passes.h" and add a "pseudo"
1743 call line to <tt>llvm/Codegen/LinkAllCodegenComponents.h</tt>.</p>
1744
1745 </div>
1746
1747
1748 <!-- _______________________________________________________________________ -->
1749 <div class="doc_subsection">
1750   <a name="registering_new">Creating new registries</a>
1751 </div>
1752
1753 <div class="doc_text">
1754
1755 <p>The easiest way to get started is to clone one of the existing registries; we
1756 recommend <tt>llvm/CodeGen/RegAllocRegistry.h</tt>.  The key things to modify
1757 are the class name and the <tt>FunctionPassCtor</tt> type.</p>
1758
1759 <p>Then you need to declare the registry.  Example: if your pass registry is
1760 <tt>RegisterMyPasses</tt> then define;</p>
1761
1762 <div class="doc_code"><pre>
1763 MachinePassRegistry RegisterMyPasses::Registry;
1764 </pre></div>
1765
1766 <p>And finally, declare the command line option for your passes.  Example:</p>
1767
1768 <div class="doc_code"><pre>
1769   cl::opt&lt;RegisterMyPasses::FunctionPassCtor, false,
1770           RegisterPassParser&lt;RegisterMyPasses&gt; &gt;
1771   MyPassOpt("mypass",
1772             cl::init(&amp;createDefaultMyPass),
1773             cl::desc("my pass option help"));
1774 </pre></div>
1775
1776 <p>Here the command option is "mypass", with createDefaultMyPass as the default
1777 creator.</p>
1778
1779 </div>
1780
1781 <!-- *********************************************************************** -->
1782 <div class="doc_section">
1783   <a name="debughints">Using GDB with dynamically loaded passes</a>
1784 </div>
1785 <!-- *********************************************************************** -->
1786
1787 <div class="doc_text">
1788
1789 <p>Unfortunately, using GDB with dynamically loaded passes is not as easy as it
1790 should be.  First of all, you can't set a breakpoint in a shared object that has
1791 not been loaded yet, and second of all there are problems with inlined functions
1792 in shared objects.  Here are some suggestions to debugging your pass with
1793 GDB.</p>
1794
1795 <p>For sake of discussion, I'm going to assume that you are debugging a
1796 transformation invoked by <tt>opt</tt>, although nothing described here depends
1797 on that.</p>
1798
1799 </div>
1800
1801 <!-- _______________________________________________________________________ -->
1802 <div class="doc_subsubsection">
1803   <a name="breakpoint">Setting a breakpoint in your pass</a>
1804 </div>
1805
1806 <div class="doc_text">
1807
1808 <p>First thing you do is start <tt>gdb</tt> on the <tt>opt</tt> process:</p>
1809
1810 <div class="doc_code"><pre>
1811 $ <b>gdb opt</b>
1812 GNU gdb 5.0
1813 Copyright 2000 Free Software Foundation, Inc.
1814 GDB is free software, covered by the GNU General Public License, and you are
1815 welcome to change it and/or distribute copies of it under certain conditions.
1816 Type "show copying" to see the conditions.
1817 There is absolutely no warranty for GDB.  Type "show warranty" for details.
1818 This GDB was configured as "sparc-sun-solaris2.6"...
1819 (gdb)
1820 </pre></div>
1821
1822 <p>Note that <tt>opt</tt> has a lot of debugging information in it, so it takes
1823 time to load.  Be patient.  Since we cannot set a breakpoint in our pass yet
1824 (the shared object isn't loaded until runtime), we must execute the process, and
1825 have it stop before it invokes our pass, but after it has loaded the shared
1826 object.  The most foolproof way of doing this is to set a breakpoint in
1827 <tt>PassManager::run</tt> and then run the process with the arguments you
1828 want:</p>
1829
1830 <div class="doc_code"><pre>
1831 (gdb) <b>break llvm::PassManager::run</b>
1832 Breakpoint 1 at 0x2413bc: file Pass.cpp, line 70.
1833 (gdb) <b>run test.bc -load $(LLVMTOP)/llvm/Debug+Asserts/lib/[libname].so -[passoption]</b>
1834 Starting program: opt test.bc -load $(LLVMTOP)/llvm/Debug+Asserts/lib/[libname].so -[passoption]
1835 Breakpoint 1, PassManager::run (this=0xffbef174, M=@0x70b298) at Pass.cpp:70
1836 70      bool PassManager::run(Module &amp;M) { return PM-&gt;run(M); }
1837 (gdb)
1838 </pre></div>
1839
1840 <p>Once the <tt>opt</tt> stops in the <tt>PassManager::run</tt> method you are
1841 now free to set breakpoints in your pass so that you can trace through execution
1842 or do other standard debugging stuff.</p>
1843
1844 </div>
1845
1846 <!-- _______________________________________________________________________ -->
1847 <div class="doc_subsubsection">
1848   <a name="debugmisc">Miscellaneous Problems</a>
1849 </div>
1850
1851 <div class="doc_text">
1852
1853 <p>Once you have the basics down, there are a couple of problems that GDB has,
1854 some with solutions, some without.</p>
1855
1856 <ul>
1857 <li>Inline functions have bogus stack information.  In general, GDB does a
1858 pretty good job getting stack traces and stepping through inline functions.
1859 When a pass is dynamically loaded however, it somehow completely loses this
1860 capability.  The only solution I know of is to de-inline a function (move it
1861 from the body of a class to a .cpp file).</li>
1862
1863 <li>Restarting the program breaks breakpoints.  After following the information
1864 above, you have succeeded in getting some breakpoints planted in your pass.  Nex
1865 thing you know, you restart the program (i.e., you type '<tt>run</tt>' again),
1866 and you start getting errors about breakpoints being unsettable.  The only way I
1867 have found to "fix" this problem is to <tt>delete</tt> the breakpoints that are
1868 already set in your pass, run the program, and re-set the breakpoints once
1869 execution stops in <tt>PassManager::run</tt>.</li>
1870
1871 </ul>
1872
1873 <p>Hopefully these tips will help with common case debugging situations.  If
1874 you'd like to contribute some tips of your own, just contact <a
1875 href="mailto:sabre@nondot.org">Chris</a>.</p>
1876
1877 </div>
1878
1879 <!-- *********************************************************************** -->
1880 <div class="doc_section">
1881   <a name="future">Future extensions planned</a>
1882 </div>
1883 <!-- *********************************************************************** -->
1884
1885 <div class="doc_text">
1886
1887 <p>Although the LLVM Pass Infrastructure is very capable as it stands, and does
1888 some nifty stuff, there are things we'd like to add in the future.  Here is
1889 where we are going:</p>
1890
1891 </div>
1892
1893 <!-- _______________________________________________________________________ -->
1894 <div class="doc_subsubsection">
1895   <a name="SMP">Multithreaded LLVM</a>
1896 </div>
1897
1898 <div class="doc_text">
1899
1900 <p>Multiple CPU machines are becoming more common and compilation can never be
1901 fast enough: obviously we should allow for a multithreaded compiler.  Because of
1902 the semantics defined for passes above (specifically they cannot maintain state
1903 across invocations of their <tt>run*</tt> methods), a nice clean way to
1904 implement a multithreaded compiler would be for the <tt>PassManager</tt> class
1905 to create multiple instances of each pass object, and allow the separate
1906 instances to be hacking on different parts of the program at the same time.</p>
1907
1908 <p>This implementation would prevent each of the passes from having to implement
1909 multithreaded constructs, requiring only the LLVM core to have locking in a few
1910 places (for global resources).  Although this is a simple extension, we simply
1911 haven't had time (or multiprocessor machines, thus a reason) to implement this.
1912 Despite that, we have kept the LLVM passes SMP ready, and you should too.</p>
1913
1914 </div>
1915
1916 <!-- *********************************************************************** -->
1917 <hr>
1918 <address>
1919   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1920   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1921   <a href="http://validator.w3.org/check/referer"><img
1922   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1923
1924   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1925   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
1926   Last modified: $Date$
1927 </address>
1928
1929 </body>
1930 </html>