docs/Passes.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>LLVM's Analysis and Transform Passes</title>
   6   <link rel="stylesheet" href="_static/llvm.css" type="text/css">
   7   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   8 </head>
   9 <body>
  10
  11 <!--
  12
  13 If Passes.html is up to date, the following "one-liner" should print
  14 an empty diff.
  15
  16 egrep -e '^<tr><td><a href="#.*">-.*</a></td><td>.*</td></tr>$' \
  17       -e '^  <a name=".*">.*</a>$' < Passes.html >html; \
  18 perl >help <<'EOT' && diff -u help html; rm -f help html
  19 open HTML, "<Passes.html" or die "open: Passes.html: $!\n";
  20 while (<HTML>) {
  21   m:^<tr><td><a href="#(.*)">-.*</a></td><td>.*</td></tr>$: or next;
  22   $order{$1} = sprintf("%03d", 1 + int %order);
  23 }
  24 open HELP, "../Release/bin/opt -help|" or die "open: opt -help: $!\n";
  25 while (<HELP>) {
  26   m:^    -([^ ]+) +- (.*)$: or next;
  27   my $o = $order{$1};
  28   $o = "000" unless defined $o;
  29   push @x, "$o<tr><td><a href=\"#$1\">-$1</a></td><td>$2</td></tr>\n";
  30   push @y, "$o  <a name=\"$1\">-$1: $2</a>\n";
  31 }
  32 @x = map { s/^\d\d\d//; $_ } sort @x;
  33 @y = map { s/^\d\d\d//; $_ } sort @y;
  34 print @x, @y;
  35 EOT
  36
  37 This (real) one-liner can also be helpful when converting comments to HTML:
  38
  39 perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print "  <p>\n" if !$on && $_ =~ /\S/; print "  </p>\n" if $on && $_ =~ /^\s*$/; print "  $_\n"; $on = ($_ =~ /\S/); } print "  </p>\n" if $on'
  40
  41   -->
  42
  43 <h1>LLVM's Analysis and Transform Passes</h1>
  44
  45 <ol>
  46   <li><a href="#intro">Introduction</a></li>
  47   <li><a href="#analyses">Analysis Passes</a>
  48   <li><a href="#transforms">Transform Passes</a></li>
  49   <li><a href="#utilities">Utility Passes</a></li>
  50 </ol>
  51
  52 <div class="doc_author">
  53   <p>Written by <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>
  54             and Gordon Henriksen</p>
  55 </div>
  56
  57 <!-- ======================================================================= -->
  58 <h2><a name="intro">Introduction</a></h2>
  59 <div>
  60   <p>This document serves as a high level summary of the optimization features
  61   that LLVM provides. Optimizations are implemented as Passes that traverse some
  62   portion of a program to either collect information or transform the program.
  63   The table below divides the passes that LLVM provides into three categories.
  64   Analysis passes compute information that other passes can use or for debugging
  65   or program visualization purposes. Transform passes can use (or invalidate)
  66   the analysis passes. Transform passes all mutate the program in some way.
  67   Utility passes provides some utility but don't otherwise fit categorization.
  68   For example passes to extract functions to bitcode or write a module to
  69   bitcode are neither analysis nor transform passes.
  70   <p>The table below provides a quick summary of each pass and links to the more
  71   complete pass description later in the document.</p>
  72
  73 <table>
  74 <tr><th colspan="2"><b>ANALYSIS PASSES</b></th></tr>
  75 <tr><th>Option</th><th>Name</th></tr>
  76 <tr><td><a href="#aa-eval">-aa-eval</a></td><td>Exhaustive Alias Analysis Precision Evaluator</td></tr>
  77 <tr><td><a href="#basicaa">-basicaa</a></td><td>Basic Alias Analysis (stateless AA impl)</td></tr>
  78 <tr><td><a href="#basiccg">-basiccg</a></td><td>Basic CallGraph Construction</td></tr>
  79 <tr><td><a href="#count-aa">-count-aa</a></td><td>Count Alias Analysis Query Responses</td></tr>
  80 <tr><td><a href="#da">-da</a></td><td>Dependence Analysis</td></tr>
  81 <tr><td><a href="#debug-aa">-debug-aa</a></td><td>AA use debugger</td></tr>
  82 <tr><td><a href="#domfrontier">-domfrontier</a></td><td>Dominance Frontier Construction</td></tr>
  83 <tr><td><a href="#domtree">-domtree</a></td><td>Dominator Tree Construction</td></tr>
  84 <tr><td><a href="#dot-callgraph">-dot-callgraph</a></td><td>Print Call Graph to 'dot' file</td></tr>
  85 <tr><td><a href="#dot-cfg">-dot-cfg</a></td><td>Print CFG of function to 'dot' file</td></tr>
  86 <tr><td><a href="#dot-cfg-only">-dot-cfg-only</a></td><td>Print CFG of function to 'dot' file (with no function bodies)</td></tr>
  87 <tr><td><a href="#dot-dom">-dot-dom</a></td><td>Print dominance tree of function to 'dot' file</td></tr>
  88 <tr><td><a href="#dot-dom-only">-dot-dom-only</a></td><td>Print dominance tree of function to 'dot' file (with no function bodies)</td></tr>
  89 <tr><td><a href="#dot-postdom">-dot-postdom</a></td><td>Print postdominance tree of function to 'dot' file</td></tr>
  90 <tr><td><a href="#dot-postdom-only">-dot-postdom-only</a></td><td>Print postdominance tree of function to 'dot' file (with no function bodies)</td></tr>
  91 <tr><td><a href="#globalsmodref-aa">-globalsmodref-aa</a></td><td>Simple mod/ref analysis for globals</td></tr>
  92 <tr><td><a href="#instcount">-instcount</a></td><td>Counts the various types of Instructions</td></tr>
  93 <tr><td><a href="#intervals">-intervals</a></td><td>Interval Partition Construction</td></tr>
  94 <tr><td><a href="#iv-users">-iv-users</a></td><td>Induction Variable Users</td></tr>
  95 <tr><td><a href="#lazy-value-info">-lazy-value-info</a></td><td>Lazy Value Information Analysis</td></tr>
  96 <tr><td><a href="#libcall-aa">-libcall-aa</a></td><td>LibCall Alias Analysis</td></tr>
  97 <tr><td><a href="#lint">-lint</a></td><td>Statically lint-checks LLVM IR</td></tr>
  98 <tr><td><a href="#loops">-loops</a></td><td>Natural Loop Information</td></tr>
  99 <tr><td><a href="#memdep">-memdep</a></td><td>Memory Dependence Analysis</td></tr>
 100 <tr><td><a href="#module-debuginfo">-module-debuginfo</a></td><td>Decodes module-level debug info</td></tr>
 101 <tr><td><a href="#no-aa">-no-aa</a></td><td>No Alias Analysis (always returns 'may' alias)</td></tr>
 102 <tr><td><a href="#no-profile">-no-profile</a></td><td>No Profile Information</td></tr>
 103 <tr><td><a href="#postdomtree">-postdomtree</a></td><td>Post-Dominator Tree Construction</td></tr>
 104 <tr><td><a href="#print-alias-sets">-print-alias-sets</a></td><td>Alias Set Printer</td></tr>
 105 <tr><td><a href="#print-callgraph">-print-callgraph</a></td><td>Print a call graph</td></tr>
 106 <tr><td><a href="#print-callgraph-sccs">-print-callgraph-sccs</a></td><td>Print SCCs of the Call Graph</td></tr>
 107 <tr><td><a href="#print-cfg-sccs">-print-cfg-sccs</a></td><td>Print SCCs of each function CFG</td></tr>
 108 <tr><td><a href="#print-dbginfo">-print-dbginfo</a></td><td>Print debug info in human readable form</td></tr>
 109 <tr><td><a href="#print-dom-info">-print-dom-info</a></td><td>Dominator Info Printer</td></tr>
 110 <tr><td><a href="#print-externalfnconstants">-print-externalfnconstants</a></td><td>Print external fn callsites passed constants</td></tr>
 111 <tr><td><a href="#print-function">-print-function</a></td><td>Print function to stderr</td></tr>
 112 <tr><td><a href="#print-module">-print-module</a></td><td>Print module to stderr</td></tr>
 113 <tr><td><a href="#print-used-types">-print-used-types</a></td><td>Find Used Types</td></tr>
 114 <tr><td><a href="#profile-estimator">-profile-estimator</a></td><td>Estimate profiling information</td></tr>
 115 <tr><td><a href="#profile-loader">-profile-loader</a></td><td>Load profile information from llvmprof.out</td></tr>
 116 <tr><td><a href="#profile-verifier">-profile-verifier</a></td><td>Verify profiling information</td></tr>
 117 <tr><td><a href="#regions">-regions</a></td><td>Detect single entry single exit regions</td></tr>
 118 <tr><td><a href="#scalar-evolution">-scalar-evolution</a></td><td>Scalar Evolution Analysis</td></tr>
 119 <tr><td><a href="#scev-aa">-scev-aa</a></td><td>ScalarEvolution-based Alias Analysis</td></tr>
 120 <tr><td><a href="#targetdata">-targetdata</a></td><td>Target Data Layout</td></tr>
 121
 122
 123 <tr><th colspan="2"><b>TRANSFORM PASSES</b></th></tr>
 124 <tr><th>Option</th><th>Name</th></tr>
 125 <tr><td><a href="#adce">-adce</a></td><td>Aggressive Dead Code Elimination</td></tr>
 126 <tr><td><a href="#always-inline">-always-inline</a></td><td>Inliner for always_inline functions</td></tr>
 127 <tr><td><a href="#argpromotion">-argpromotion</a></td><td>Promote 'by reference' arguments to scalars</td></tr>
 128 <tr><td><a href="#bb-vectorize">-bb-vectorize</a></td><td>Combine instructions to form vector instructions within basic blocks</td></tr>
 129 <tr><td><a href="#block-placement">-block-placement</a></td><td>Profile Guided Basic Block Placement</td></tr>
 130 <tr><td><a href="#break-crit-edges">-break-crit-edges</a></td><td>Break critical edges in CFG</td></tr>
 131 <tr><td><a href="#codegenprepare">-codegenprepare</a></td><td>Optimize for code generation</td></tr>
 132 <tr><td><a href="#constmerge">-constmerge</a></td><td>Merge Duplicate Global Constants</td></tr>
 133 <tr><td><a href="#constprop">-constprop</a></td><td>Simple constant propagation</td></tr>
 134 <tr><td><a href="#dce">-dce</a></td><td>Dead Code Elimination</td></tr>
 135 <tr><td><a href="#deadargelim">-deadargelim</a></td><td>Dead Argument Elimination</td></tr>
 136 <tr><td><a href="#deadtypeelim">-deadtypeelim</a></td><td>Dead Type Elimination</td></tr>
 137 <tr><td><a href="#die">-die</a></td><td>Dead Instruction Elimination</td></tr>
 138 <tr><td><a href="#dse">-dse</a></td><td>Dead Store Elimination</td></tr>
 139 <tr><td><a href="#functionattrs">-functionattrs</a></td><td>Deduce function attributes</td></tr>
 140 <tr><td><a href="#globaldce">-globaldce</a></td><td>Dead Global Elimination</td></tr>
 141 <tr><td><a href="#globalopt">-globalopt</a></td><td>Global Variable Optimizer</td></tr>
 142 <tr><td><a href="#gvn">-gvn</a></td><td>Global Value Numbering</td></tr>
 143 <tr><td><a href="#indvars">-indvars</a></td><td>Canonicalize Induction Variables</td></tr>
 144 <tr><td><a href="#inline">-inline</a></td><td>Function Integration/Inlining</td></tr>
 145 <tr><td><a href="#insert-edge-profiling">-insert-edge-profiling</a></td><td>Insert instrumentation for edge profiling</td></tr>
 146 <tr><td><a href="#insert-optimal-edge-profiling">-insert-optimal-edge-profiling</a></td><td>Insert optimal instrumentation for edge profiling</td></tr>
 147 <tr><td><a href="#instcombine">-instcombine</a></td><td>Combine redundant instructions</td></tr>
 148 <tr><td><a href="#internalize">-internalize</a></td><td>Internalize Global Symbols</td></tr>
 149 <tr><td><a href="#ipconstprop">-ipconstprop</a></td><td>Interprocedural constant propagation</td></tr>
 150 <tr><td><a href="#ipsccp">-ipsccp</a></td><td>Interprocedural Sparse Conditional Constant Propagation</td></tr>
 151 <tr><td><a href="#jump-threading">-jump-threading</a></td><td>Jump Threading</td></tr>
 152 <tr><td><a href="#lcssa">-lcssa</a></td><td>Loop-Closed SSA Form Pass</td></tr>
 153 <tr><td><a href="#licm">-licm</a></td><td>Loop Invariant Code Motion</td></tr>
 154 <tr><td><a href="#loop-deletion">-loop-deletion</a></td><td>Delete dead loops</td></tr>
 155 <tr><td><a href="#loop-extract">-loop-extract</a></td><td>Extract loops into new functions</td></tr>
 156 <tr><td><a href="#loop-extract-single">-loop-extract-single</a></td><td>Extract at most one loop into a new function</td></tr>
 157 <tr><td><a href="#loop-reduce">-loop-reduce</a></td><td>Loop Strength Reduction</td></tr>
 158 <tr><td><a href="#loop-rotate">-loop-rotate</a></td><td>Rotate Loops</td></tr>
 159 <tr><td><a href="#loop-simplify">-loop-simplify</a></td><td>Canonicalize natural loops</td></tr>
 160 <tr><td><a href="#loop-unroll">-loop-unroll</a></td><td>Unroll loops</td></tr>
 161 <tr><td><a href="#loop-unswitch">-loop-unswitch</a></td><td>Unswitch loops</td></tr>
 162 <tr><td><a href="#loweratomic">-loweratomic</a></td><td>Lower atomic intrinsics to non-atomic form</td></tr>
 163 <tr><td><a href="#lowerinvoke">-lowerinvoke</a></td><td>Lower invoke and unwind, for unwindless code generators</td></tr>
 164 <tr><td><a href="#lowerswitch">-lowerswitch</a></td><td>Lower SwitchInst's to branches</td></tr>
 165 <tr><td><a href="#mem2reg">-mem2reg</a></td><td>Promote Memory to Register</td></tr>
 166 <tr><td><a href="#memcpyopt">-memcpyopt</a></td><td>MemCpy Optimization</td></tr>
 167 <tr><td><a href="#mergefunc">-mergefunc</a></td><td>Merge Functions</td></tr>
 168 <tr><td><a href="#mergereturn">-mergereturn</a></td><td>Unify function exit nodes</td></tr>
 169 <tr><td><a href="#partial-inliner">-partial-inliner</a></td><td>Partial Inliner</td></tr>
 170 <tr><td><a href="#prune-eh">-prune-eh</a></td><td>Remove unused exception handling info</td></tr>
 171 <tr><td><a href="#reassociate">-reassociate</a></td><td>Reassociate expressions</td></tr>
 172 <tr><td><a href="#reg2mem">-reg2mem</a></td><td>Demote all values to stack slots</td></tr>
 173 <tr><td><a href="#scalarrepl">-scalarrepl</a></td><td>Scalar Replacement of Aggregates (DT)</td></tr>
 174 <tr><td><a href="#sccp">-sccp</a></td><td>Sparse Conditional Constant Propagation</td></tr>
 175 <tr><td><a href="#simplify-libcalls">-simplify-libcalls</a></td><td>Simplify well-known library calls</td></tr>
 176 <tr><td><a href="#simplifycfg">-simplifycfg</a></td><td>Simplify the CFG</td></tr>
 177 <tr><td><a href="#sink">-sink</a></td><td>Code sinking</td></tr>
 178 <tr><td><a href="#sretpromotion">-sretpromotion</a></td><td>Promote sret arguments to multiple ret values</td></tr>
 179 <tr><td><a href="#strip">-strip</a></td><td>Strip all symbols from a module</td></tr>
 180 <tr><td><a href="#strip-dead-debug-info">-strip-dead-debug-info</a></td><td>Strip debug info for unused symbols</td></tr>
 181 <tr><td><a href="#strip-dead-prototypes">-strip-dead-prototypes</a></td><td>Strip Unused Function Prototypes</td></tr>
 182 <tr><td><a href="#strip-debug-declare">-strip-debug-declare</a></td><td>Strip all llvm.dbg.declare intrinsics</td></tr>
 183 <tr><td><a href="#strip-nondebug">-strip-nondebug</a></td><td>Strip all symbols, except dbg symbols, from a module</td></tr>
 184 <tr><td><a href="#tailcallelim">-tailcallelim</a></td><td>Tail Call Elimination</td></tr>
 185
 186
 187 <tr><th colspan="2"><b>UTILITY PASSES</b></th></tr>
 188 <tr><th>Option</th><th>Name</th></tr>
 189 <tr><td><a href="#deadarghaX0r">-deadarghaX0r</a></td><td>Dead Argument Hacking (BUGPOINT USE ONLY; DO NOT USE)</td></tr>
 190 <tr><td><a href="#extract-blocks">-extract-blocks</a></td><td>Extract Basic Blocks From Module (for bugpoint use)</td></tr>
 191 <tr><td><a href="#instnamer">-instnamer</a></td><td>Assign names to anonymous instructions</td></tr>
 192 <tr><td><a href="#preverify">-preverify</a></td><td>Preliminary module verification</td></tr>
 193 <tr><td><a href="#verify">-verify</a></td><td>Module Verifier</td></tr>
 194 <tr><td><a href="#view-cfg">-view-cfg</a></td><td>View CFG of function</td></tr>
 195 <tr><td><a href="#view-cfg-only">-view-cfg-only</a></td><td>View CFG of function (with no function bodies)</td></tr>
 196 <tr><td><a href="#view-dom">-view-dom</a></td><td>View dominance tree of function</td></tr>
 197 <tr><td><a href="#view-dom-only">-view-dom-only</a></td><td>View dominance tree of function (with no function bodies)</td></tr>
 198 <tr><td><a href="#view-postdom">-view-postdom</a></td><td>View postdominance tree of function</td></tr>
 199 <tr><td><a href="#view-postdom-only">-view-postdom-only</a></td><td>View postdominance tree of function (with no function bodies)</td></tr>
 200 </table>
 201
 202 </div>
 203
 204 <!-- ======================================================================= -->
 205 <h2><a name="analyses">Analysis Passes</a></h2>
 206 <div>
 207   <p>This section describes the LLVM Analysis Passes.</p>
 208
 209 <!-------------------------------------------------------------------------- -->
 210 <h3>
 211   <a name="aa-eval">-aa-eval: Exhaustive Alias Analysis Precision Evaluator</a>
 212 </h3>
 213 <div>
 214   <p>This is a simple N^2 alias analysis accuracy evaluator.
 215   Basically, for each function in the program, it simply queries to see how the
 216   alias analysis implementation answers alias queries between each pair of
 217   pointers in the function.</p>
 218
 219   <p>This is inspired and adapted from code by: Naveen Neelakantam, Francesco
 220   Spadini, and Wojciech Stryjewski.</p>
 221 </div>
 222
 223 <!-------------------------------------------------------------------------- -->
 224 <h3>
 225   <a name="basicaa">-basicaa: Basic Alias Analysis (stateless AA impl)</a>
 226 </h3>
 227 <div>
 228   <p>A basic alias analysis pass that implements identities (two different
 229   globals cannot alias, etc), but does no stateful analysis.</p>
 230 </div>
 231
 232 <!-------------------------------------------------------------------------- -->
 233 <h3>
 234   <a name="basiccg">-basiccg: Basic CallGraph Construction</a>
 235 </h3>
 236 <div>
 237   <p>Yet to be written.</p>
 238 </div>
 239
 240 <!-------------------------------------------------------------------------- -->
 241 <h3>
 242   <a name="count-aa">-count-aa: Count Alias Analysis Query Responses</a>
 243 </h3>
 244 <div>
 245   <p>
 246   A pass which can be used to count how many alias queries
 247   are being made and how the alias analysis implementation being used responds.
 248   </p>
 249 </div>
 250
 251 <!-------------------------------------------------------------------------- -->
 252 <h3>
 253   <a name="da">-da: Dependence Analysis</a>
 254 </h3>
 255 <div>
 256   <p>Dependence analysis framework, which is used to detect dependences in
 257   memory accesses.</p>
 258 </div>
 259
 260 <!-------------------------------------------------------------------------- -->
 261 <h3>
 262   <a name="debug-aa">-debug-aa: AA use debugger</a>
 263 </h3>
 264 <div>
 265   <p>
 266   This simple pass checks alias analysis users to ensure that if they
 267   create a new value, they do not query AA without informing it of the value.
 268   It acts as a shim over any other AA pass you want.
 269   </p>
 270
 271   <p>
 272   Yes keeping track of every value in the program is expensive, but this is
 273   a debugging pass.
 274   </p>
 275 </div>
 276
 277 <!-------------------------------------------------------------------------- -->
 278 <h3>
 279   <a name="domfrontier">-domfrontier: Dominance Frontier Construction</a>
 280 </h3>
 281 <div>
 282   <p>
 283   This pass is a simple dominator construction algorithm for finding forward
 284   dominator frontiers.
 285   </p>
 286 </div>
 287
 288 <!-------------------------------------------------------------------------- -->
 289 <h3>
 290   <a name="domtree">-domtree: Dominator Tree Construction</a>
 291 </h3>
 292 <div>
 293   <p>
 294   This pass is a simple dominator construction algorithm for finding forward
 295   dominators.
 296   </p>
 297 </div>
 298
 299 <!-------------------------------------------------------------------------- -->
 300 <h3>
 301   <a name="dot-callgraph">-dot-callgraph: Print Call Graph to 'dot' file</a>
 302 </h3>
 303 <div>
 304   <p>
 305   This pass, only available in <code>opt</code>, prints the call graph into a
 306   <code>.dot</code> graph.  This graph can then be processed with the "dot" tool
 307   to convert it to postscript or some other suitable format.
 308   </p>
 309 </div>
 310
 311 <!-------------------------------------------------------------------------- -->
 312 <h3>
 313   <a name="dot-cfg">-dot-cfg: Print CFG of function to 'dot' file</a>
 314 </h3>
 315 <div>
 316   <p>
 317   This pass, only available in <code>opt</code>, prints the control flow graph
 318   into a <code>.dot</code> graph.  This graph can then be processed with the
 319   "dot" tool to convert it to postscript or some other suitable format.
 320   </p>
 321 </div>
 322
 323 <!-------------------------------------------------------------------------- -->
 324 <h3>
 325   <a name="dot-cfg-only">-dot-cfg-only: Print CFG of function to 'dot' file (with no function bodies)</a>
 326 </h3>
 327 <div>
 328   <p>
 329   This pass, only available in <code>opt</code>, prints the control flow graph
 330   into a <code>.dot</code> graph, omitting the function bodies.  This graph can
 331   then be processed with the "dot" tool to convert it to postscript or some
 332   other suitable format.
 333   </p>
 334 </div>
 335
 336 <!-------------------------------------------------------------------------- -->
 337 <h3>
 338   <a name="dot-dom">-dot-dom: Print dominance tree of function to 'dot' file</a>
 339 </h3>
 340 <div>
 341   <p>
 342   This pass, only available in <code>opt</code>, prints the dominator tree
 343   into a <code>.dot</code> graph.  This graph can then be processed with the
 344   "dot" tool to convert it to postscript or some other suitable format.
 345   </p>
 346 </div>
 347
 348 <!-------------------------------------------------------------------------- -->
 349 <h3>
 350   <a name="dot-dom-only">-dot-dom-only: Print dominance tree of function to 'dot' file (with no function bodies)</a>
 351 </h3>
 352 <div>
 353   <p>
 354   This pass, only available in <code>opt</code>, prints the dominator tree
 355   into a <code>.dot</code> graph, omitting the function bodies.  This graph can
 356   then be processed with the "dot" tool to convert it to postscript or some
 357   other suitable format.
 358   </p>
 359 </div>
 360
 361 <!-------------------------------------------------------------------------- -->
 362 <h3>
 363   <a name="dot-postdom">-dot-postdom: Print postdominance tree of function to 'dot' file</a>
 364 </h3>
 365 <div>
 366   <p>
 367   This pass, only available in <code>opt</code>, prints the post dominator tree
 368   into a <code>.dot</code> graph.  This graph can then be processed with the
 369   "dot" tool to convert it to postscript or some other suitable format.
 370   </p>
 371 </div>
 372
 373 <!-------------------------------------------------------------------------- -->
 374 <h3>
 375   <a name="dot-postdom-only">-dot-postdom-only: Print postdominance tree of function to 'dot' file (with no function bodies)</a>
 376 </h3>
 377 <div>
 378   <p>
 379   This pass, only available in <code>opt</code>, prints the post dominator tree
 380   into a <code>.dot</code> graph, omitting the function bodies.  This graph can
 381   then be processed with the "dot" tool to convert it to postscript or some
 382   other suitable format.
 383   </p>
 384 </div>
 385
 386 <!-------------------------------------------------------------------------- -->
 387 <h3>
 388   <a name="globalsmodref-aa">-globalsmodref-aa: Simple mod/ref analysis for globals</a>
 389 </h3>
 390 <div>
 391   <p>
 392   This simple pass provides alias and mod/ref information for global values
 393   that do not have their address taken, and keeps track of whether functions
 394   read or write memory (are "pure").  For this simple (but very common) case,
 395   we can provide pretty accurate and useful information.
 396   </p>
 397 </div>
 398
 399 <!-------------------------------------------------------------------------- -->
 400 <h3>
 401   <a name="instcount">-instcount: Counts the various types of Instructions</a>
 402 </h3>
 403 <div>
 404   <p>
 405   This pass collects the count of all instructions and reports them
 406   </p>
 407 </div>
 408
 409 <!-------------------------------------------------------------------------- -->
 410 <h3>
 411   <a name="intervals">-intervals: Interval Partition Construction</a>
 412 </h3>
 413 <div>
 414   <p>
 415   This analysis calculates and represents the interval partition of a function,
 416   or a preexisting interval partition.
 417   </p>
 418
 419   <p>
 420   In this way, the interval partition may be used to reduce a flow graph down
 421   to its degenerate single node interval partition (unless it is irreducible).
 422   </p>
 423 </div>
 424
 425 <!-------------------------------------------------------------------------- -->
 426 <h3>
 427   <a name="iv-users">-iv-users: Induction Variable Users</a>
 428 </h3>
 429 <div>
 430   <p>Bookkeeping for "interesting" users of expressions computed from
 431   induction variables.</p>
 432 </div>
 433
 434 <!-------------------------------------------------------------------------- -->
 435 <h3>
 436   <a name="lazy-value-info">-lazy-value-info: Lazy Value Information Analysis</a>
 437 </h3>
 438 <div>
 439   <p>Interface for lazy computation of value constraint information.</p>
 440 </div>
 441
 442 <!-------------------------------------------------------------------------- -->
 443 <h3>
 444   <a name="libcall-aa">-libcall-aa: LibCall Alias Analysis</a>
 445 </h3>
 446 <div>
 447   <p>LibCall Alias Analysis.</p>
 448 </div>
 449
 450 <!-------------------------------------------------------------------------- -->
 451 <h3>
 452   <a name="lint">-lint: Statically lint-checks LLVM IR</a>
 453 </h3>
 454 <div>
 455   <p>This pass statically checks for common and easily-identified constructs
 456   which produce undefined or likely unintended behavior in LLVM IR.</p>
 457
 458   <p>It is not a guarantee of correctness, in two ways. First, it isn't
 459   comprehensive. There are checks which could be done statically which are
 460   not yet implemented. Some of these are indicated by TODO comments, but
 461   those aren't comprehensive either. Second, many conditions cannot be
 462   checked statically. This pass does no dynamic instrumentation, so it
 463   can't check for all possible problems.</p>
 464
 465   <p>Another limitation is that it assumes all code will be executed. A store
 466   through a null pointer in a basic block which is never reached is harmless,
 467   but this pass will warn about it anyway.</p>
 468
 469   <p>Optimization passes may make conditions that this pass checks for more or
 470   less obvious. If an optimization pass appears to be introducing a warning,
 471   it may be that the optimization pass is merely exposing an existing
 472   condition in the code.</p>
 473
 474   <p>This code may be run before instcombine. In many cases, instcombine checks
 475   for the same kinds of things and turns instructions with undefined behavior
 476   into unreachable (or equivalent). Because of this, this pass makes some
 477   effort to look through bitcasts and so on.
 478   </p>
 479 </div>
 480
 481 <!-------------------------------------------------------------------------- -->
 482 <h3>
 483   <a name="loops">-loops: Natural Loop Information</a>
 484 </h3>
 485 <div>
 486   <p>
 487   This analysis is used to identify natural loops and determine the loop depth
 488   of various nodes of the CFG.  Note that the loops identified may actually be
 489   several natural loops that share the same header node... not just a single
 490   natural loop.
 491   </p>
 492 </div>
 493
 494 <!-------------------------------------------------------------------------- -->
 495 <h3>
 496   <a name="memdep">-memdep: Memory Dependence Analysis</a>
 497 </h3>
 498 <div>
 499   <p>
 500   An analysis that determines, for a given memory operation, what preceding
 501   memory operations it depends on.  It builds on alias analysis information, and
 502   tries to provide a lazy, caching interface to a common kind of alias
 503   information query.
 504   </p>
 505 </div>
 506
 507 <!-------------------------------------------------------------------------- -->
 508 <h3>
 509   <a name="module-debuginfo">-module-debuginfo: Decodes module-level debug info</a>
 510 </h3>
 511 <div>
 512   <p>This pass decodes the debug info metadata in a module and prints in a
 513  (sufficiently-prepared-) human-readable form.
 514
 515  For example, run this pass from opt along with the -analyze option, and
 516  it'll print to standard output.
 517   </p>
 518 </div>
 519
 520 <!-------------------------------------------------------------------------- -->
 521 <h3>
 522   <a name="no-aa">-no-aa: No Alias Analysis (always returns 'may' alias)</a>
 523 </h3>
 524 <div>
 525   <p>
 526   This is the default implementation of the Alias Analysis interface. It always
 527   returns "I don't know" for alias queries.  NoAA is unlike other alias analysis
 528   implementations, in that it does not chain to a previous analysis. As such it
 529   doesn't follow many of the rules that other alias analyses must.
 530   </p>
 531 </div>
 532
 533 <!-------------------------------------------------------------------------- -->
 534 <h3>
 535   <a name="no-profile">-no-profile: No Profile Information</a>
 536 </h3>
 537 <div>
 538   <p>
 539   The default "no profile" implementation of the abstract
 540   <code>ProfileInfo</code> interface.
 541   </p>
 542 </div>
 543
 544 <!-------------------------------------------------------------------------- -->
 545 <h3>
 546   <a name="postdomfrontier">-postdomfrontier: Post-Dominance Frontier Construction</a>
 547 </h3>
 548 <div>
 549   <p>
 550   This pass is a simple post-dominator construction algorithm for finding
 551   post-dominator frontiers.
 552   </p>
 553 </div>
 554
 555 <!-------------------------------------------------------------------------- -->
 556 <h3>
 557   <a name="postdomtree">-postdomtree: Post-Dominator Tree Construction</a>
 558 </h3>
 559 <div>
 560   <p>
 561   This pass is a simple post-dominator construction algorithm for finding
 562   post-dominators.
 563   </p>
 564 </div>
 565
 566 <!-------------------------------------------------------------------------- -->
 567 <h3>
 568   <a name="print-alias-sets">-print-alias-sets: Alias Set Printer</a>
 569 </h3>
 570 <div>
 571   <p>Yet to be written.</p>
 572 </div>
 573
 574 <!-------------------------------------------------------------------------- -->
 575 <h3>
 576   <a name="print-callgraph">-print-callgraph: Print a call graph</a>
 577 </h3>
 578 <div>
 579   <p>
 580   This pass, only available in <code>opt</code>, prints the call graph to
 581   standard error in a human-readable form.
 582   </p>
 583 </div>
 584
 585 <!-------------------------------------------------------------------------- -->
 586 <h3>
 587   <a name="print-callgraph-sccs">-print-callgraph-sccs: Print SCCs of the Call Graph</a>
 588 </h3>
 589 <div>
 590   <p>
 591   This pass, only available in <code>opt</code>, prints the SCCs of the call
 592   graph to standard error in a human-readable form.
 593   </p>
 594 </div>
 595
 596 <!-------------------------------------------------------------------------- -->
 597 <h3>
 598   <a name="print-cfg-sccs">-print-cfg-sccs: Print SCCs of each function CFG</a>
 599 </h3>
 600 <div>
 601   <p>
 602   This pass, only available in <code>opt</code>, prints the SCCs of each
 603   function CFG to standard error in a human-readable form.
 604   </p>
 605 </div>
 606
 607 <!-------------------------------------------------------------------------- -->
 608 <h3>
 609   <a name="print-dbginfo">-print-dbginfo: Print debug info in human readable form</a>
 610 </h3>
 611 <div>
 612   <p>Pass that prints instructions, and associated debug info:</p>
 613   <ul>
 614
 615   <li>source/line/col information</li>
 616   <li>original variable name</li>
 617   <li>original type name</li>
 618   </ul>
 619 </div>
 620
 621 <!-------------------------------------------------------------------------- -->
 622 <h3>
 623   <a name="print-dom-info">-print-dom-info: Dominator Info Printer</a>
 624 </h3>
 625 <div>
 626   <p>Dominator Info Printer.</p>
 627 </div>
 628
 629 <!-------------------------------------------------------------------------- -->
 630 <h3>
 631   <a name="print-externalfnconstants">-print-externalfnconstants: Print external fn callsites passed constants</a>
 632 </h3>
 633 <div>
 634   <p>
 635   This pass, only available in <code>opt</code>, prints out call sites to
 636   external functions that are called with constant arguments.  This can be
 637   useful when looking for standard library functions we should constant fold
 638   or handle in alias analyses.
 639   </p>
 640 </div>
 641
 642 <!-------------------------------------------------------------------------- -->
 643 <h3>
 644   <a name="print-function">-print-function: Print function to stderr</a>
 645 </h3>
 646 <div>
 647   <p>
 648   The <code>PrintFunctionPass</code> class is designed to be pipelined with
 649   other <code>FunctionPass</code>es, and prints out the functions of the module
 650   as they are processed.
 651   </p>
 652 </div>
 653
 654 <!-------------------------------------------------------------------------- -->
 655 <h3>
 656   <a name="print-module">-print-module: Print module to stderr</a>
 657 </h3>
 658 <div>
 659   <p>
 660   This pass simply prints out the entire module when it is executed.
 661   </p>
 662 </div>
 663
 664 <!-------------------------------------------------------------------------- -->
 665 <h3>
 666   <a name="print-used-types">-print-used-types: Find Used Types</a>
 667 </h3>
 668 <div>
 669   <p>
 670   This pass is used to seek out all of the types in use by the program.  Note
 671   that this analysis explicitly does not include types only used by the symbol
 672   table.
 673 </div>
 674
 675 <!-------------------------------------------------------------------------- -->
 676 <h3>
 677   <a name="profile-estimator">-profile-estimator: Estimate profiling information</a>
 678 </h3>
 679 <div>
 680   <p>Profiling information that estimates the profiling information
 681   in a very crude and unimaginative way.
 682   </p>
 683 </div>
 684
 685 <!-------------------------------------------------------------------------- -->
 686 <h3>
 687   <a name="profile-loader">-profile-loader: Load profile information from llvmprof.out</a>
 688 </h3>
 689 <div>
 690   <p>
 691   A concrete implementation of profiling information that loads the information
 692   from a profile dump file.
 693   </p>
 694 </div>
 695
 696 <!-------------------------------------------------------------------------- -->
 697 <h3>
 698   <a name="profile-verifier">-profile-verifier: Verify profiling information</a>
 699 </h3>
 700 <div>
 701   <p>Pass that checks profiling information for plausibility.</p>
 702 </div>
 703 <h3>
 704   <a name="regions">-regions: Detect single entry single exit regions</a>
 705 </h3>
 706 <div>
 707   <p>
 708   The <code>RegionInfo</code> pass detects single entry single exit regions in a
 709   function, where a region is defined as any subgraph that is connected to the
 710   remaining graph at only two spots. Furthermore, an hierarchical region tree is
 711   built.
 712   </p>
 713 </div>
 714
 715 <!-------------------------------------------------------------------------- -->
 716 <h3>
 717   <a name="scalar-evolution">-scalar-evolution: Scalar Evolution Analysis</a>
 718 </h3>
 719 <div>
 720   <p>
 721   The <code>ScalarEvolution</code> analysis can be used to analyze and
 722   catagorize scalar expressions in loops.  It specializes in recognizing general
 723   induction variables, representing them with the abstract and opaque
 724   <code>SCEV</code> class.  Given this analysis, trip counts of loops and other
 725   important properties can be obtained.
 726   </p>
 727
 728   <p>
 729   This analysis is primarily useful for induction variable substitution and
 730   strength reduction.
 731   </p>
 732 </div>
 733
 734 <!-------------------------------------------------------------------------- -->
 735 <h3>
 736   <a name="scev-aa">-scev-aa: ScalarEvolution-based Alias Analysis</a>
 737 </h3>
 738 <div>
 739   <p>Simple alias analysis implemented in terms of ScalarEvolution queries.
 740
 741   This differs from traditional loop dependence analysis in that it tests
 742   for dependencies within a single iteration of a loop, rather than
 743   dependencies between different iterations.
 744
 745   ScalarEvolution has a more complete understanding of pointer arithmetic
 746   than BasicAliasAnalysis' collection of ad-hoc analyses.
 747   </p>
 748 </div>
 749
 750 <!-------------------------------------------------------------------------- -->
 751 <h3>
 752   <a name="targetdata">-targetdata: Target Data Layout</a>
 753 </h3>
 754 <div>
 755   <p>Provides other passes access to information on how the size and alignment
 756   required by the target ABI for various data types.</p>
 757 </div>
 758
 759 </div>
 760
 761 <!-- ======================================================================= -->
 762 <h2><a name="transforms">Transform Passes</a></h2>
 763 <div>
 764   <p>This section describes the LLVM Transform Passes.</p>
 765
 766 <!-------------------------------------------------------------------------- -->
 767 <h3>
 768   <a name="adce">-adce: Aggressive Dead Code Elimination</a>
 769 </h3>
 770 <div>
 771   <p>ADCE aggressively tries to eliminate code. This pass is similar to
 772   <a href="#dce">DCE</a> but it assumes that values are dead until proven
 773   otherwise. This is similar to <a href="#sccp">SCCP</a>, except applied to
 774   the liveness of values.</p>
 775 </div>
 776
 777 <!-------------------------------------------------------------------------- -->
 778 <h3>
 779   <a name="always-inline">-always-inline: Inliner for always_inline functions</a>
 780 </h3>
 781 <div>
 782   <p>A custom inliner that handles only functions that are marked as
 783   "always inline".</p>
 784 </div>
 785
 786 <!-------------------------------------------------------------------------- -->
 787 <h3>
 788   <a name="argpromotion">-argpromotion: Promote 'by reference' arguments to scalars</a>
 789 </h3>
 790 <div>
 791   <p>
 792   This pass promotes "by reference" arguments to be "by value" arguments.  In
 793   practice, this means looking for internal functions that have pointer
 794   arguments.  If it can prove, through the use of alias analysis, that an
 795   argument is *only* loaded, then it can pass the value into the function
 796   instead of the address of the value.  This can cause recursive simplification
 797   of code and lead to the elimination of allocas (especially in C++ template
 798   code like the STL).
 799   </p>
 800
 801   <p>
 802   This pass also handles aggregate arguments that are passed into a function,
 803   scalarizing them if the elements of the aggregate are only loaded.  Note that
 804   it refuses to scalarize aggregates which would require passing in more than
 805   three operands to the function, because passing thousands of operands for a
 806   large array or structure is unprofitable!
 807   </p>
 808
 809   <p>
 810   Note that this transformation could also be done for arguments that are only
 811   stored to (returning the value instead), but does not currently.  This case
 812   would be best handled when and if LLVM starts supporting multiple return
 813   values from functions.
 814   </p>
 815 </div>
 816
 817 <!-------------------------------------------------------------------------- -->
 818 <h3>
 819   <a name="bb-vectorize">-bb-vectorize: Basic-Block Vectorization</a>
 820 </h3>
 821 <div>
 822   <p>This pass combines instructions inside basic blocks to form vector
 823   instructions. It iterates over each basic block, attempting to pair
 824   compatible instructions, repeating this process until no additional
 825   pairs are selected for vectorization. When the outputs of some pair
 826   of compatible instructions are used as inputs by some other pair of
 827   compatible instructions, those pairs are part of a potential
 828   vectorization chain. Instruction pairs are only fused into vector
 829   instructions when they are part of a chain longer than some
 830   threshold length. Moreover, the pass attempts to find the best
 831   possible chain for each pair of compatible instructions. These
 832   heuristics are intended to prevent vectorization in cases where
 833   it would not yield a performance increase of the resulting code.
 834   </p>
 835 </div>
 836
 837 <!-------------------------------------------------------------------------- -->
 838 <h3>
 839   <a name="block-placement">-block-placement: Profile Guided Basic Block Placement</a>
 840 </h3>
 841 <div>
 842   <p>This pass is a very simple profile guided basic block placement algorithm.
 843   The idea is to put frequently executed blocks together at the start of the
 844   function and hopefully increase the number of fall-through conditional
 845   branches.  If there is no profile information for a particular function, this
 846   pass basically orders blocks in depth-first order.</p>
 847 </div>
 848
 849 <!-------------------------------------------------------------------------- -->
 850 <h3>
 851   <a name="break-crit-edges">-break-crit-edges: Break critical edges in CFG</a>
 852 </h3>
 853 <div>
 854   <p>
 855   Break all of the critical edges in the CFG by inserting a dummy basic block.
 856   It may be "required" by passes that cannot deal with critical edges. This
 857   transformation obviously invalidates the CFG, but can update forward dominator
 858   (set, immediate dominators, tree, and frontier) information.
 859   </p>
 860 </div>
 861
 862 <!-------------------------------------------------------------------------- -->
 863 <h3>
 864   <a name="codegenprepare">-codegenprepare: Optimize for code generation</a>
 865 </h3>
 866 <div>
 867   This pass munges the code in the input function to better prepare it for
 868   SelectionDAG-based code generation. This works around limitations in it's
 869   basic-block-at-a-time approach. It should eventually be removed.
 870 </div>
 871
 872 <!-------------------------------------------------------------------------- -->
 873 <h3>
 874   <a name="constmerge">-constmerge: Merge Duplicate Global Constants</a>
 875 </h3>
 876 <div>
 877   <p>
 878   Merges duplicate global constants together into a single constant that is
 879   shared.  This is useful because some passes (ie TraceValues) insert a lot of
 880   string constants into the program, regardless of whether or not an existing
 881   string is available.
 882   </p>
 883 </div>
 884
 885 <!-------------------------------------------------------------------------- -->
 886 <h3>
 887   <a name="constprop">-constprop: Simple constant propagation</a>
 888 </h3>
 889 <div>
 890   <p>This file implements constant propagation and merging. It looks for
 891   instructions involving only constant operands and replaces them with a
 892   constant value instead of an instruction. For example:</p>
 893   <blockquote><pre>add i32 1, 2</pre></blockquote>
 894   <p>becomes</p>
 895   <blockquote><pre>i32 3</pre></blockquote>
 896   <p>NOTE: this pass has a habit of making definitions be dead.  It is a good
 897   idea to to run a <a href="#die">DIE</a> (Dead Instruction Elimination) pass
 898   sometime after running this pass.</p>
 899 </div>
 900
 901 <!-------------------------------------------------------------------------- -->
 902 <h3>
 903   <a name="dce">-dce: Dead Code Elimination</a>
 904 </h3>
 905 <div>
 906   <p>
 907   Dead code elimination is similar to <a href="#die">dead instruction
 908   elimination</a>, but it rechecks instructions that were used by removed
 909   instructions to see if they are newly dead.
 910   </p>
 911 </div>
 912
 913 <!-------------------------------------------------------------------------- -->
 914 <h3>
 915   <a name="deadargelim">-deadargelim: Dead Argument Elimination</a>
 916 </h3>
 917 <div>
 918   <p>
 919   This pass deletes dead arguments from internal functions.  Dead argument
 920   elimination removes arguments which are directly dead, as well as arguments
 921   only passed into function calls as dead arguments of other functions.  This
 922   pass also deletes dead arguments in a similar way.
 923   </p>
 924
 925   <p>
 926   This pass is often useful as a cleanup pass to run after aggressive
 927   interprocedural passes, which add possibly-dead arguments.
 928   </p>
 929 </div>
 930
 931 <!-------------------------------------------------------------------------- -->
 932 <h3>
 933   <a name="deadtypeelim">-deadtypeelim: Dead Type Elimination</a>
 934 </h3>
 935 <div>
 936   <p>
 937   This pass is used to cleanup the output of GCC.  It eliminate names for types
 938   that are unused in the entire translation unit, using the <a
 939   href="#findusedtypes">find used types</a> pass.
 940   </p>
 941 </div>
 942
 943 <!-------------------------------------------------------------------------- -->
 944 <h3>
 945   <a name="die">-die: Dead Instruction Elimination</a>
 946 </h3>
 947 <div>
 948   <p>
 949   Dead instruction elimination performs a single pass over the function,
 950   removing instructions that are obviously dead.
 951   </p>
 952 </div>
 953
 954 <!-------------------------------------------------------------------------- -->
 955 <h3>
 956   <a name="dse">-dse: Dead Store Elimination</a>
 957 </h3>
 958 <div>
 959   <p>
 960   A trivial dead store elimination that only considers basic-block local
 961   redundant stores.
 962   </p>
 963 </div>
 964
 965 <!-------------------------------------------------------------------------- -->
 966 <h3>
 967   <a name="functionattrs">-functionattrs: Deduce function attributes</a>
 968 </h3>
 969 <div>
 970   <p>A simple interprocedural pass which walks the call-graph, looking for
 971   functions which do not access or only read non-local memory, and marking them
 972   readnone/readonly.  In addition, it marks function arguments (of pointer type)
 973   'nocapture' if a call to the function does not create any copies of the pointer
 974   value that outlive the call. This more or less means that the pointer is only
 975   dereferenced, and not returned from the function or stored in a global.
 976   This pass is implemented as a bottom-up traversal of the call-graph.
 977   </p>
 978 </div>
 979
 980 <!-------------------------------------------------------------------------- -->
 981 <h3>
 982   <a name="globaldce">-globaldce: Dead Global Elimination</a>
 983 </h3>
 984 <div>
 985   <p>
 986   This transform is designed to eliminate unreachable internal globals from the
 987   program.  It uses an aggressive algorithm, searching out globals that are
 988   known to be alive.  After it finds all of the globals which are needed, it
 989   deletes whatever is left over.  This allows it to delete recursive chunks of
 990   the program which are unreachable.
 991   </p>
 992 </div>
 993
 994 <!-------------------------------------------------------------------------- -->
 995 <h3>
 996   <a name="globalopt">-globalopt: Global Variable Optimizer</a>
 997 </h3>
 998 <div>
 999   <p>
1000   This pass transforms simple global variables that never have their address
1001   taken.  If obviously true, it marks read/write globals as constant, deletes
1002   variables only stored to, etc.
1003   </p>
1004 </div>
1005
1006 <!-------------------------------------------------------------------------- -->
1007 <h3>
1008   <a name="gvn">-gvn: Global Value Numbering</a>
1009 </h3>
1010 <div>
1011   <p>
1012   This pass performs global value numbering to eliminate fully and partially
1013   redundant instructions.  It also performs redundant load elimination.
1014   </p>
1015 </div>
1016
1017 <!-------------------------------------------------------------------------- -->
1018 <h3>
1019   <a name="indvars">-indvars: Canonicalize Induction Variables</a>
1020 </h3>
1021 <div>
1022   <p>
1023   This transformation analyzes and transforms the induction variables (and
1024   computations derived from them) into simpler forms suitable for subsequent
1025   analysis and transformation.
1026   </p>
1027
1028   <p>
1029   This transformation makes the following changes to each loop with an
1030   identifiable induction variable:
1031   </p>
1032
1033   <ol>
1034     <li>All loops are transformed to have a <em>single</em> canonical
1035         induction variable which starts at zero and steps by one.</li>
1036     <li>The canonical induction variable is guaranteed to be the first PHI node
1037         in the loop header block.</li>
1038     <li>Any pointer arithmetic recurrences are raised to use array
1039         subscripts.</li>
1040   </ol>
1041
1042   <p>
1043   If the trip count of a loop is computable, this pass also makes the following
1044   changes:
1045   </p>
1046
1047   <ol>
1048     <li>The exit condition for the loop is canonicalized to compare the
1049         induction value against the exit value.  This turns loops like:
1050         <blockquote><pre>for (i = 7; i*i < 1000; ++i)</pre></blockquote>
1051         into
1052         <blockquote><pre>for (i = 0; i != 25; ++i)</pre></blockquote></li>
1053     <li>Any use outside of the loop of an expression derived from the indvar
1054         is changed to compute the derived value outside of the loop, eliminating
1055         the dependence on the exit value of the induction variable.  If the only
1056         purpose of the loop is to compute the exit value of some derived
1057         expression, this transformation will make the loop dead.</li>
1058   </ol>
1059
1060   <p>
1061   This transformation should be followed by strength reduction after all of the
1062   desired loop transformations have been performed.  Additionally, on targets
1063   where it is profitable, the loop could be transformed to count down to zero
1064   (the "do loop" optimization).
1065   </p>
1066 </div>
1067
1068 <!-------------------------------------------------------------------------- -->
1069 <h3>
1070   <a name="inline">-inline: Function Integration/Inlining</a>
1071 </h3>
1072 <div>
1073   <p>
1074   Bottom-up inlining of functions into callees.
1075   </p>
1076 </div>
1077
1078 <!-------------------------------------------------------------------------- -->
1079 <h3>
1080   <a name="insert-edge-profiling">-insert-edge-profiling: Insert instrumentation for edge profiling</a>
1081 </h3>
1082 <div>
1083   <p>
1084   This pass instruments the specified program with counters for edge profiling.
1085   Edge profiling can give a reasonable approximation of the hot paths through a
1086   program, and is used for a wide variety of program transformations.
1087   </p>
1088
1089   <p>
1090   Note that this implementation is very naïve.  It inserts a counter for
1091   <em>every</em> edge in the program, instead of using control flow information
1092   to prune the number of counters inserted.
1093   </p>
1094 </div>
1095
1096 <!-------------------------------------------------------------------------- -->
1097 <h3>
1098   <a name="insert-optimal-edge-profiling">-insert-optimal-edge-profiling: Insert optimal instrumentation for edge profiling</a>
1099 </h3>
1100 <div>
1101   <p>This pass instruments the specified program with counters for edge profiling.
1102   Edge profiling can give a reasonable approximation of the hot paths through a
1103   program, and is used for a wide variety of program transformations.
1104   </p>
1105 </div>
1106
1107 <!-------------------------------------------------------------------------- -->
1108 <h3>
1109   <a name="instcombine">-instcombine: Combine redundant instructions</a>
1110 </h3>
1111 <div>
1112   <p>
1113   Combine instructions to form fewer, simple
1114   instructions.  This pass does not modify the CFG This pass is where algebraic
1115   simplification happens.
1116   </p>
1117
1118   <p>
1119   This pass combines things like:
1120   </p>
1121
1122 <blockquote><pre
1123 >%Y = add i32 %X, 1
1124 %Z = add i32 %Y, 1</pre></blockquote>
1125
1126   <p>
1127   into:
1128   </p>
1129
1130 <blockquote><pre
1131 >%Z = add i32 %X, 2</pre></blockquote>
1132
1133   <p>
1134   This is a simple worklist driven algorithm.
1135   </p>
1136
1137   <p>
1138   This pass guarantees that the following canonicalizations are performed on
1139   the program:
1140   </p>
1141
1142   <ul>
1143     <li>If a binary operator has a constant operand, it is moved to the right-
1144         hand side.</li>
1145     <li>Bitwise operators with constant operands are always grouped so that
1146         shifts are performed first, then <code>or</code>s, then
1147         <code>and</code>s, then <code>xor</code>s.</li>
1148     <li>Compare instructions are converted from <code>&lt;</code>,
1149         <code>&gt;</code>, <code>≤</code>, or <code>≥</code> to
1150         <code>=</code> or <code>≠</code> if possible.</li>
1151     <li>All <code>cmp</code> instructions on boolean values are replaced with
1152         logical operations.</li>
1153     <li><code>add <var>X</var>, <var>X</var></code> is represented as
1154         <code>mul <var>X</var>, 2</code> ⇒ <code>shl <var>X</var>, 1</code></li>
1155     <li>Multiplies with a constant power-of-two argument are transformed into
1156         shifts.</li>
1157     <li>… etc.</li>
1158   </ul>
1159 </div>
1160
1161 <!-------------------------------------------------------------------------- -->
1162 <h3>
1163   <a name="internalize">-internalize: Internalize Global Symbols</a>
1164 </h3>
1165 <div>
1166   <p>
1167   This pass loops over all of the functions in the input module, looking for a
1168   main function.  If a main function is found, all other functions and all
1169   global variables with initializers are marked as internal.
1170   </p>
1171 </div>
1172
1173 <!-------------------------------------------------------------------------- -->
1174 <h3>
1175   <a name="ipconstprop">-ipconstprop: Interprocedural constant propagation</a>
1176 </h3>
1177 <div>
1178   <p>
1179   This pass implements an <em>extremely</em> simple interprocedural constant
1180   propagation pass.  It could certainly be improved in many different ways,
1181   like using a worklist.  This pass makes arguments dead, but does not remove
1182   them.  The existing dead argument elimination pass should be run after this
1183   to clean up the mess.
1184   </p>
1185 </div>
1186
1187 <!-------------------------------------------------------------------------- -->
1188 <h3>
1189   <a name="ipsccp">-ipsccp: Interprocedural Sparse Conditional Constant Propagation</a>
1190 </h3>
1191 <div>
1192   <p>
1193   An interprocedural variant of <a href="#sccp">Sparse Conditional Constant
1194   Propagation</a>.
1195   </p>
1196 </div>
1197
1198 <!-------------------------------------------------------------------------- -->
1199 <h3>
1200   <a name="jump-threading">-jump-threading: Jump Threading</a>
1201 </h3>
1202 <div>
1203   <p>
1204   Jump threading tries to find distinct threads of control flow running through
1205   a basic block. This pass looks at blocks that have multiple predecessors and
1206   multiple successors.  If one or more of the predecessors of the block can be
1207   proven to always cause a jump to one of the successors, we forward the edge
1208   from the predecessor to the successor by duplicating the contents of this
1209   block.
1210   </p>
1211   <p>
1212   An example of when this can occur is code like this:
1213   </p>
1214
1215   <pre
1216 >if () { ...
1217   X = 4;
1218 }
1219 if (X &lt; 3) {</pre>
1220
1221   <p>
1222   In this case, the unconditional branch at the end of the first if can be
1223   revectored to the false side of the second if.
1224   </p>
1225 </div>
1226
1227 <!-------------------------------------------------------------------------- -->
1228 <h3>
1229   <a name="lcssa">-lcssa: Loop-Closed SSA Form Pass</a>
1230 </h3>
1231 <div>
1232   <p>
1233   This pass transforms loops by placing phi nodes at the end of the loops for
1234   all values that are live across the loop boundary.  For example, it turns
1235   the left into the right code:
1236   </p>
1237
1238   <pre
1239 >for (...)                for (...)
1240   if (c)                   if (c)
1241     X1 = ...                 X1 = ...
1242   else                     else
1243     X2 = ...                 X2 = ...
1244   X3 = phi(X1, X2)         X3 = phi(X1, X2)
1245 ... = X3 + 4              X4 = phi(X3)
1246                           ... = X4 + 4</pre>
1247
1248   <p>
1249   This is still valid LLVM; the extra phi nodes are purely redundant, and will
1250   be trivially eliminated by <code>InstCombine</code>.  The major benefit of
1251   this transformation is that it makes many other loop optimizations, such as
1252   LoopUnswitching, simpler.
1253   </p>
1254 </div>
1255
1256 <!-------------------------------------------------------------------------- -->
1257 <h3>
1258   <a name="licm">-licm: Loop Invariant Code Motion</a>
1259 </h3>
1260 <div>
1261   <p>
1262   This pass performs loop invariant code motion, attempting to remove as much
1263   code from the body of a loop as possible.  It does this by either hoisting
1264   code into the preheader block, or by sinking code to the exit blocks if it is
1265   safe.  This pass also promotes must-aliased memory locations in the loop to
1266   live in registers, thus hoisting and sinking "invariant" loads and stores.
1267   </p>
1268
1269   <p>
1270   This pass uses alias analysis for two purposes:
1271   </p>
1272
1273   <ul>
1274     <li>Moving loop invariant loads and calls out of loops.  If we can determine
1275         that a load or call inside of a loop never aliases anything stored to,
1276         we can hoist it or sink it like any other instruction.</li>
1277     <li>Scalar Promotion of Memory - If there is a store instruction inside of
1278         the loop, we try to move the store to happen AFTER the loop instead of
1279         inside of the loop.  This can only happen if a few conditions are true:
1280         <ul>
1281           <li>The pointer stored through is loop invariant.</li>
1282           <li>There are no stores or loads in the loop which <em>may</em> alias
1283               the pointer.  There are no calls in the loop which mod/ref the
1284               pointer.</li>
1285         </ul>
1286         If these conditions are true, we can promote the loads and stores in the
1287         loop of the pointer to use a temporary alloca'd variable.  We then use
1288         the mem2reg functionality to construct the appropriate SSA form for the
1289         variable.</li>
1290   </ul>
1291 </div>
1292
1293 <!-------------------------------------------------------------------------- -->
1294 <h3>
1295   <a name="loop-deletion">-loop-deletion: Delete dead loops</a>
1296 </h3>
1297 <div>
1298   <p>
1299   This file implements the Dead Loop Deletion Pass.  This pass is responsible
1300   for eliminating loops with non-infinite computable trip counts that have no
1301   side effects or volatile instructions, and do not contribute to the
1302   computation of the function's return value.
1303   </p>
1304 </div>
1305
1306 <!-------------------------------------------------------------------------- -->
1307 <h3>
1308   <a name="loop-extract">-loop-extract: Extract loops into new functions</a>
1309 </h3>
1310 <div>
1311   <p>
1312   A pass wrapper around the <code>ExtractLoop()</code> scalar transformation to
1313   extract each top-level loop into its own new function. If the loop is the
1314   <em>only</em> loop in a given function, it is not touched. This is a pass most
1315   useful for debugging via bugpoint.
1316   </p>
1317 </div>
1318
1319 <!-------------------------------------------------------------------------- -->
1320 <h3>
1321   <a name="loop-extract-single">-loop-extract-single: Extract at most one loop into a new function</a>
1322 </h3>
1323 <div>
1324   <p>
1325   Similar to <a href="#loop-extract">Extract loops into new functions</a>,
1326   this pass extracts one natural loop from the program into a function if it
1327   can. This is used by bugpoint.
1328   </p>
1329 </div>
1330
1331 <!-------------------------------------------------------------------------- -->
1332 <h3>
1333   <a name="loop-reduce">-loop-reduce: Loop Strength Reduction</a>
1334 </h3>
1335 <div>
1336   <p>
1337   This pass performs a strength reduction on array references inside loops that
1338   have as one or more of their components the loop induction variable.  This is
1339   accomplished by creating a new value to hold the initial value of the array
1340   access for the first iteration, and then creating a new GEP instruction in
1341   the loop to increment the value by the appropriate amount.
1342   </p>
1343 </div>
1344
1345 <!-------------------------------------------------------------------------- -->
1346 <h3>
1347   <a name="loop-rotate">-loop-rotate: Rotate Loops</a>
1348 </h3>
1349 <div>
1350   <p>A simple loop rotation transformation.</p>
1351 </div>
1352
1353 <!-------------------------------------------------------------------------- -->
1354 <h3>
1355   <a name="loop-simplify">-loop-simplify: Canonicalize natural loops</a>
1356 </h3>
1357 <div>
1358   <p>
1359   This pass performs several transformations to transform natural loops into a
1360   simpler form, which makes subsequent analyses and transformations simpler and
1361   more effective.
1362   </p>
1363
1364   <p>
1365   Loop pre-header insertion guarantees that there is a single, non-critical
1366   entry edge from outside of the loop to the loop header.  This simplifies a
1367   number of analyses and transformations, such as LICM.
1368   </p>
1369
1370   <p>
1371   Loop exit-block insertion guarantees that all exit blocks from the loop
1372   (blocks which are outside of the loop that have predecessors inside of the
1373   loop) only have predecessors from inside of the loop (and are thus dominated
1374   by the loop header).  This simplifies transformations such as store-sinking
1375   that are built into LICM.
1376   </p>
1377
1378   <p>
1379   This pass also guarantees that loops will have exactly one backedge.
1380   </p>
1381
1382   <p>
1383   Note that the simplifycfg pass will clean up blocks which are split out but
1384   end up being unnecessary, so usage of this pass should not pessimize
1385   generated code.
1386   </p>
1387
1388   <p>
1389   This pass obviously modifies the CFG, but updates loop information and
1390   dominator information.
1391   </p>
1392 </div>
1393
1394 <!-------------------------------------------------------------------------- -->
1395 <h3>
1396   <a name="loop-unroll">-loop-unroll: Unroll loops</a>
1397 </h3>
1398 <div>
1399   <p>
1400   This pass implements a simple loop unroller.  It works best when loops have
1401   been canonicalized by the <a href="#indvars"><tt>-indvars</tt></a> pass,
1402   allowing it to determine the trip counts of loops easily.
1403   </p>
1404 </div>
1405
1406 <!-------------------------------------------------------------------------- -->
1407 <h3>
1408   <a name="loop-unswitch">-loop-unswitch: Unswitch loops</a>
1409 </h3>
1410 <div>
1411   <p>
1412   This pass transforms loops that contain branches on loop-invariant conditions
1413   to have multiple loops.  For example, it turns the left into the right code:
1414   </p>
1415
1416   <pre
1417 >for (...)                  if (lic)
1418   A                          for (...)
1419   if (lic)                     A; B; C
1420     B                      else
1421   C                          for (...)
1422                                A; C</pre>
1423
1424   <p>
1425   This can increase the size of the code exponentially (doubling it every time
1426   a loop is unswitched) so we only unswitch if the resultant code will be
1427   smaller than a threshold.
1428   </p>
1429
1430   <p>
1431   This pass expects LICM to be run before it to hoist invariant conditions out
1432   of the loop, to make the unswitching opportunity obvious.
1433   </p>
1434 </div>
1435
1436 <!-------------------------------------------------------------------------- -->
1437 <h3>
1438   <a name="loweratomic">-loweratomic: Lower atomic intrinsics to non-atomic form</a>
1439 </h3>
1440 <div>
1441   <p>
1442   This pass lowers atomic intrinsics to non-atomic form for use in a known
1443   non-preemptible environment.
1444   </p>
1445
1446   <p>
1447   The pass does not verify that the environment is non-preemptible (in
1448   general this would require knowledge of the entire call graph of the
1449   program including any libraries which may not be available in bitcode form);
1450   it simply lowers every atomic intrinsic.
1451   </p>
1452 </div>
1453
1454 <!-------------------------------------------------------------------------- -->
1455 <h3>
1456   <a name="lowerinvoke">-lowerinvoke: Lower invoke and unwind, for unwindless code generators</a>
1457 </h3>
1458 <div>
1459   <p>
1460   This transformation is designed for use by code generators which do not yet
1461   support stack unwinding.  This pass supports two models of exception handling
1462   lowering, the 'cheap' support and the 'expensive' support.
1463   </p>
1464
1465   <p>
1466   'Cheap' exception handling support gives the program the ability to execute
1467   any program which does not "throw an exception", by turning 'invoke'
1468   instructions into calls and by turning 'unwind' instructions into calls to
1469   abort().  If the program does dynamically use the unwind instruction, the
1470   program will print a message then abort.
1471   </p>
1472
1473   <p>
1474   'Expensive' exception handling support gives the full exception handling
1475   support to the program at the cost of making the 'invoke' instruction
1476   really expensive.  It basically inserts setjmp/longjmp calls to emulate the
1477   exception handling as necessary.
1478   </p>
1479
1480   <p>
1481   Because the 'expensive' support slows down programs a lot, and EH is only
1482   used for a subset of the programs, it must be specifically enabled by the
1483   <tt>-enable-correct-eh-support</tt> option.
1484   </p>
1485
1486   <p>
1487   Note that after this pass runs the CFG is not entirely accurate (exceptional
1488   control flow edges are not correct anymore) so only very simple things should
1489   be done after the lowerinvoke pass has run (like generation of native code).
1490   This should not be used as a general purpose "my LLVM-to-LLVM pass doesn't
1491   support the invoke instruction yet" lowering pass.
1492   </p>
1493 </div>
1494
1495 <!-------------------------------------------------------------------------- -->
1496 <h3>
1497   <a name="lowerswitch">-lowerswitch: Lower SwitchInst's to branches</a>
1498 </h3>
1499 <div>
1500   <p>
1501   Rewrites <tt>switch</tt> instructions with a sequence of branches, which
1502   allows targets to get away with not implementing the switch instruction until
1503   it is convenient.
1504   </p>
1505 </div>
1506
1507 <!-------------------------------------------------------------------------- -->
1508 <h3>
1509   <a name="mem2reg">-mem2reg: Promote Memory to Register</a>
1510 </h3>
1511 <div>
1512   <p>
1513   This file promotes memory references to be register references.  It promotes
1514   <tt>alloca</tt> instructions which only have <tt>load</tt>s and
1515   <tt>store</tt>s as uses.  An <tt>alloca</tt> is transformed by using dominator
1516   frontiers to place <tt>phi</tt> nodes, then traversing the function in
1517   depth-first order to rewrite <tt>load</tt>s and <tt>store</tt>s as
1518   appropriate. This is just the standard SSA construction algorithm to construct
1519   "pruned" SSA form.
1520   </p>
1521 </div>
1522
1523 <!-------------------------------------------------------------------------- -->
1524 <h3>
1525   <a name="memcpyopt">-memcpyopt: MemCpy Optimization</a>
1526 </h3>
1527 <div>
1528   <p>
1529   This pass performs various transformations related to eliminating memcpy
1530   calls, or transforming sets of stores into memset's.
1531   </p>
1532 </div>
1533
1534 <!-------------------------------------------------------------------------- -->
1535 <h3>
1536   <a name="mergefunc">-mergefunc: Merge Functions</a>
1537 </h3>
1538 <div>
1539   <p>This pass looks for equivalent functions that are mergable and folds them.
1540
1541   A hash is computed from the function, based on its type and number of
1542   basic blocks.
1543
1544   Once all hashes are computed, we perform an expensive equality comparison
1545   on each function pair. This takes n^2/2 comparisons per bucket, so it's
1546   important that the hash function be high quality. The equality comparison
1547   iterates through each instruction in each basic block.
1548
1549   When a match is found the functions are folded. If both functions are
1550   overridable, we move the functionality into a new internal function and
1551   leave two overridable thunks to it.
1552   </p>
1553 </div>
1554
1555 <!-------------------------------------------------------------------------- -->
1556 <h3>
1557   <a name="mergereturn">-mergereturn: Unify function exit nodes</a>
1558 </h3>
1559 <div>
1560   <p>
1561   Ensure that functions have at most one <tt>ret</tt> instruction in them.
1562   Additionally, it keeps track of which node is the new exit node of the CFG.
1563   </p>
1564 </div>
1565
1566 <!-------------------------------------------------------------------------- -->
1567 <h3>
1568   <a name="partial-inliner">-partial-inliner: Partial Inliner</a>
1569 </h3>
1570 <div>
1571   <p>This pass performs partial inlining, typically by inlining an if
1572   statement that surrounds the body of the function.
1573   </p>
1574 </div>
1575
1576 <!-------------------------------------------------------------------------- -->
1577 <h3>
1578   <a name="prune-eh">-prune-eh: Remove unused exception handling info</a>
1579 </h3>
1580 <div>
1581   <p>
1582   This file implements a simple interprocedural pass which walks the call-graph,
1583   turning <tt>invoke</tt> instructions into <tt>call</tt> instructions if and
1584   only if the callee cannot throw an exception. It implements this as a
1585   bottom-up traversal of the call-graph.
1586   </p>
1587 </div>
1588
1589 <!-------------------------------------------------------------------------- -->
1590 <h3>
1591   <a name="reassociate">-reassociate: Reassociate expressions</a>
1592 </h3>
1593 <div>
1594   <p>
1595   This pass reassociates commutative expressions in an order that is designed
1596   to promote better constant propagation, GCSE, LICM, PRE, etc.
1597   </p>
1598
1599   <p>
1600   For example: 4 + (<var>x</var> + 5) ⇒ <var>x</var> + (4 + 5)
1601   </p>
1602
1603   <p>
1604   In the implementation of this algorithm, constants are assigned rank = 0,
1605   function arguments are rank = 1, and other values are assigned ranks
1606   corresponding to the reverse post order traversal of current function
1607   (starting at 2), which effectively gives values in deep loops higher rank
1608   than values not in loops.
1609   </p>
1610 </div>
1611
1612 <!-------------------------------------------------------------------------- -->
1613 <h3>
1614   <a name="reg2mem">-reg2mem: Demote all values to stack slots</a>
1615 </h3>
1616 <div>
1617   <p>
1618   This file demotes all registers to memory references.  It is intended to be
1619   the inverse of <a href="#mem2reg"><tt>-mem2reg</tt></a>.  By converting to
1620   <tt>load</tt> instructions, the only values live across basic blocks are
1621   <tt>alloca</tt> instructions and <tt>load</tt> instructions before
1622   <tt>phi</tt> nodes. It is intended that this should make CFG hacking much
1623   easier. To make later hacking easier, the entry block is split into two, such
1624   that all introduced <tt>alloca</tt> instructions (and nothing else) are in the
1625   entry block.
1626   </p>
1627 </div>
1628
1629 <!-------------------------------------------------------------------------- -->
1630 <h3>
1631   <a name="scalarrepl">-scalarrepl: Scalar Replacement of Aggregates (DT)</a>
1632 </h3>
1633 <div>
1634   <p>
1635   The well-known scalar replacement of aggregates transformation.  This
1636   transform breaks up <tt>alloca</tt> instructions of aggregate type (structure
1637   or array) into individual <tt>alloca</tt> instructions for each member if
1638   possible.  Then, if possible, it transforms the individual <tt>alloca</tt>
1639   instructions into nice clean scalar SSA form.
1640   </p>
1641
1642   <p>
1643   This combines a simple scalar replacement of aggregates algorithm with the <a
1644   href="#mem2reg"><tt>mem2reg</tt></a> algorithm because often interact,
1645   especially for C++ programs.  As such, iterating between <tt>scalarrepl</tt>,
1646   then <a href="#mem2reg"><tt>mem2reg</tt></a> until we run out of things to
1647   promote works well.
1648   </p>
1649 </div>
1650
1651 <!-------------------------------------------------------------------------- -->
1652 <h3>
1653   <a name="sccp">-sccp: Sparse Conditional Constant Propagation</a>
1654 </h3>
1655 <div>
1656   <p>
1657   Sparse conditional constant propagation and merging, which can be summarized
1658   as:
1659   </p>
1660
1661   <ol>
1662     <li>Assumes values are constant unless proven otherwise</li>
1663     <li>Assumes BasicBlocks are dead unless proven otherwise</li>
1664     <li>Proves values to be constant, and replaces them with constants</li>
1665     <li>Proves conditional branches to be unconditional</li>
1666   </ol>
1667
1668   <p>
1669   Note that this pass has a habit of making definitions be dead.  It is a good
1670   idea to to run a DCE pass sometime after running this pass.
1671   </p>
1672 </div>
1673
1674 <!-------------------------------------------------------------------------- -->
1675 <h3>
1676   <a name="simplify-libcalls">-simplify-libcalls: Simplify well-known library calls</a>
1677 </h3>
1678 <div>
1679   <p>
1680   Applies a variety of small optimizations for calls to specific well-known
1681   function calls (e.g. runtime library functions). For example, a call
1682    <tt>exit(3)</tt> that occurs within the <tt>main()</tt> function can be
1683    transformed into simply <tt>return 3</tt>.
1684   </p>
1685 </div>
1686
1687 <!-------------------------------------------------------------------------- -->
1688 <h3>
1689   <a name="simplifycfg">-simplifycfg: Simplify the CFG</a>
1690 </h3>
1691 <div>
1692   <p>
1693   Performs dead code elimination and basic block merging. Specifically:
1694   </p>
1695
1696   <ol>
1697     <li>Removes basic blocks with no predecessors.</li>
1698     <li>Merges a basic block into its predecessor if there is only one and the
1699         predecessor only has one successor.</li>
1700     <li>Eliminates PHI nodes for basic blocks with a single predecessor.</li>
1701     <li>Eliminates a basic block that only contains an unconditional
1702         branch.</li>
1703   </ol>
1704 </div>
1705
1706 <!-------------------------------------------------------------------------- -->
1707 <h3>
1708   <a name="sink">-sink: Code sinking</a>
1709 </h3>
1710 <div>
1711   <p>This pass moves instructions into successor blocks, when possible, so that
1712  they aren't executed on paths where their results aren't needed.
1713   </p>
1714 </div>
1715
1716 <!-------------------------------------------------------------------------- -->
1717 <h3>
1718   <a name="sretpromotion">-sretpromotion: Promote sret arguments to multiple ret values</a>
1719 </h3>
1720 <div>
1721   <p>
1722   This pass finds functions that return a struct (using a pointer to the struct
1723   as the first argument of the function, marked with the '<tt>sret</tt>' attribute) and
1724   replaces them with a new function that simply returns each of the elements of
1725   that struct (using multiple return values).
1726   </p>
1727
1728   <p>
1729   This pass works under a number of conditions:
1730   </p>
1731
1732   <ul>
1733   <li>The returned struct must not contain other structs</li>
1734   <li>The returned struct must only be used to load values from</li>
1735   <li>The placeholder struct passed in is the result of an <tt>alloca</tt></li>
1736   </ul>
1737 </div>
1738
1739 <!-------------------------------------------------------------------------- -->
1740 <h3>
1741   <a name="strip">-strip: Strip all symbols from a module</a>
1742 </h3>
1743 <div>
1744   <p>
1745   performs code stripping. this transformation can delete:
1746   </p>
1747
1748   <ol>
1749     <li>names for virtual registers</li>
1750     <li>symbols for internal globals and functions</li>
1751     <li>debug information</li>
1752   </ol>
1753
1754   <p>
1755   note that this transformation makes code much less readable, so it should
1756   only be used in situations where the <tt>strip</tt> utility would be used,
1757   such as reducing code size or making it harder to reverse engineer code.
1758   </p>
1759 </div>
1760
1761 <!-------------------------------------------------------------------------- -->
1762 <h3>
1763   <a name="strip-dead-debug-info">-strip-dead-debug-info: Strip debug info for unused symbols</a>
1764 </h3>
1765 <div>
1766   <p>
1767   performs code stripping. this transformation can delete:
1768   </p>
1769
1770   <ol>
1771     <li>names for virtual registers</li>
1772     <li>symbols for internal globals and functions</li>
1773     <li>debug information</li>
1774   </ol>
1775
1776   <p>
1777   note that this transformation makes code much less readable, so it should
1778   only be used in situations where the <tt>strip</tt> utility would be used,
1779   such as reducing code size or making it harder to reverse engineer code.
1780   </p>
1781 </div>
1782
1783 <!-------------------------------------------------------------------------- -->
1784 <h3>
1785   <a name="strip-dead-prototypes">-strip-dead-prototypes: Strip Unused Function Prototypes</a>
1786 </h3>
1787 <div>
1788   <p>
1789   This pass loops over all of the functions in the input module, looking for
1790   dead declarations and removes them. Dead declarations are declarations of
1791   functions for which no implementation is available (i.e., declarations for
1792   unused library functions).
1793   </p>
1794 </div>
1795
1796 <!-------------------------------------------------------------------------- -->
1797 <h3>
1798   <a name="strip-debug-declare">-strip-debug-declare: Strip all llvm.dbg.declare intrinsics</a>
1799 </h3>
1800 <div>
1801   <p>This pass implements code stripping. Specifically, it can delete:</p>
1802   <ul>
1803   <li>names for virtual registers</li>
1804   <li>symbols for internal globals and functions</li>
1805   <li>debug information</li>
1806   </ul>
1807   <p>
1808   Note that this transformation makes code much less readable, so it should
1809   only be used in situations where the 'strip' utility would be used, such as
1810   reducing code size or making it harder to reverse engineer code.
1811   </p>
1812 </div>
1813
1814 <!-------------------------------------------------------------------------- -->
1815 <h3>
1816   <a name="strip-nondebug">-strip-nondebug: Strip all symbols, except dbg symbols, from a module</a>
1817 </h3>
1818 <div>
1819   <p>This pass implements code stripping. Specifically, it can delete:</p>
1820   <ul>
1821   <li>names for virtual registers</li>
1822   <li>symbols for internal globals and functions</li>
1823   <li>debug information</li>
1824   </ul>
1825   <p>
1826   Note that this transformation makes code much less readable, so it should
1827   only be used in situations where the 'strip' utility would be used, such as
1828   reducing code size or making it harder to reverse engineer code.
1829   </p>
1830 </div>
1831
1832 <!-------------------------------------------------------------------------- -->
1833 <h3>
1834   <a name="tailcallelim">-tailcallelim: Tail Call Elimination</a>
1835 </h3>
1836 <div>
1837   <p>
1838   This file transforms calls of the current function (self recursion) followed
1839   by a return instruction with a branch to the entry of the function, creating
1840   a loop.  This pass also implements the following extensions to the basic
1841   algorithm:
1842   </p>
1843
1844   <ul>
1845   <li>Trivial instructions between the call and return do not prevent the
1846       transformation from taking place, though currently the analysis cannot
1847       support moving any really useful instructions (only dead ones).
1848   <li>This pass transforms functions that are prevented from being tail
1849       recursive by an associative expression to use an accumulator variable,
1850       thus compiling the typical naive factorial or <tt>fib</tt> implementation
1851       into efficient code.
1852   <li>TRE is performed if the function returns void, if the return
1853       returns the result returned by the call, or if the function returns a
1854       run-time constant on all exits from the function.  It is possible, though
1855       unlikely, that the return returns something else (like constant 0), and
1856       can still be TRE'd.  It can be TRE'd if <em>all other</em> return
1857       instructions in the function return the exact same value.
1858   <li>If it can prove that callees do not access theier caller stack frame,
1859       they are marked as eligible for tail call elimination (by the code
1860       generator).
1861   </ul>
1862 </div>
1863
1864 <!-- ======================================================================= -->
1865 <h2><a name="utilities">Utility Passes</a></h2>
1866 <div>
1867   <p>This section describes the LLVM Utility Passes.</p>
1868
1869 <!-------------------------------------------------------------------------- -->
1870 <h3>
1871   <a name="deadarghaX0r">-deadarghaX0r: Dead Argument Hacking (BUGPOINT USE ONLY; DO NOT USE)</a>
1872 </h3>
1873 <div>
1874   <p>
1875   Same as dead argument elimination, but deletes arguments to functions which
1876   are external.  This is only for use by <a
1877   href="Bugpoint.html">bugpoint</a>.</p>
1878 </div>
1879
1880 <!-------------------------------------------------------------------------- -->
1881 <h3>
1882   <a name="extract-blocks">-extract-blocks: Extract Basic Blocks From Module (for bugpoint use)</a>
1883 </h3>
1884 <div>
1885   <p>
1886   This pass is used by bugpoint to extract all blocks from the module into their
1887   own functions.</p>
1888 </div>
1889
1890 <!-------------------------------------------------------------------------- -->
1891 <h3>
1892   <a name="instnamer">-instnamer: Assign names to anonymous instructions</a>
1893 </h3>
1894 <div>
1895   <p>This is a little utility pass that gives instructions names, this is mostly
1896  useful when diffing the effect of an optimization because deleting an
1897  unnamed instruction can change all other instruction numbering, making the
1898  diff very noisy.
1899   </p>
1900 </div>
1901
1902 <!-------------------------------------------------------------------------- -->
1903 <h3>
1904   <a name="preverify">-preverify: Preliminary module verification</a>
1905 </h3>
1906 <div>
1907   <p>
1908   Ensures that the module is in the form required by the <a
1909   href="#verifier">Module Verifier</a> pass.
1910   </p>
1911
1912   <p>
1913   Running the verifier runs this pass automatically, so there should be no need
1914   to use it directly.
1915   </p>
1916 </div>
1917
1918 <!-------------------------------------------------------------------------- -->
1919 <h3>
1920   <a name="verify">-verify: Module Verifier</a>
1921 </h3>
1922 <div>
1923   <p>
1924   Verifies an LLVM IR code. This is useful to run after an optimization which is
1925   undergoing testing. Note that <tt>llvm-as</tt> verifies its input before
1926   emitting bitcode, and also that malformed bitcode is likely to make LLVM
1927   crash. All language front-ends are therefore encouraged to verify their output
1928   before performing optimizing transformations.
1929   </p>
1930
1931   <ul>
1932     <li>Both of a binary operator's parameters are of the same type.</li>
1933     <li>Verify that the indices of mem access instructions match other
1934         operands.</li>
1935     <li>Verify that arithmetic and other things are only performed on
1936         first-class types.  Verify that shifts and logicals only happen on
1937         integrals f.e.</li>
1938     <li>All of the constants in a switch statement are of the correct type.</li>
1939     <li>The code is in valid SSA form.</li>
1940     <li>It is illegal to put a label into any other type (like a structure) or
1941         to return one.</li>
1942     <li>Only phi nodes can be self referential: <tt>%x = add i32 %x, %x</tt> is
1943         invalid.</li>
1944     <li>PHI nodes must have an entry for each predecessor, with no extras.</li>
1945     <li>PHI nodes must be the first thing in a basic block, all grouped
1946         together.</li>
1947     <li>PHI nodes must have at least one entry.</li>
1948     <li>All basic blocks should only end with terminator insts, not contain
1949         them.</li>
1950     <li>The entry node to a function must not have predecessors.</li>
1951     <li>All Instructions must be embedded into a basic block.</li>
1952     <li>Functions cannot take a void-typed parameter.</li>
1953     <li>Verify that a function's argument list agrees with its declared
1954         type.</li>
1955     <li>It is illegal to specify a name for a void value.</li>
1956     <li>It is illegal to have an internal global value with no initializer.</li>
1957     <li>It is illegal to have a ret instruction that returns a value that does
1958         not agree with the function return value type.</li>
1959     <li>Function call argument types match the function prototype.</li>
1960     <li>All other things that are tested by asserts spread about the code.</li>
1961   </ul>
1962
1963   <p>
1964   Note that this does not provide full security verification (like Java), but
1965   instead just tries to ensure that code is well-formed.
1966   </p>
1967 </div>
1968
1969 <!-------------------------------------------------------------------------- -->
1970 <h3>
1971   <a name="view-cfg">-view-cfg: View CFG of function</a>
1972 </h3>
1973 <div>
1974   <p>
1975   Displays the control flow graph using the GraphViz tool.
1976   </p>
1977 </div>
1978
1979 <!-------------------------------------------------------------------------- -->
1980 <h3>
1981   <a name="view-cfg-only">-view-cfg-only: View CFG of function (with no function bodies)</a>
1982 </h3>
1983 <div>
1984   <p>
1985   Displays the control flow graph using the GraphViz tool, but omitting function
1986   bodies.
1987   </p>
1988 </div>
1989
1990 <!-------------------------------------------------------------------------- -->
1991 <h3>
1992   <a name="view-dom">-view-dom: View dominance tree of function</a>
1993 </h3>
1994 <div>
1995   <p>
1996   Displays the dominator tree using the GraphViz tool.
1997   </p>
1998 </div>
1999
2000 <!-------------------------------------------------------------------------- -->
2001 <h3>
2002   <a name="view-dom-only">-view-dom-only: View dominance tree of function (with no function bodies)</a>
2003 </h3>
2004 <div>
2005   <p>
2006   Displays the dominator tree using the GraphViz tool, but omitting function
2007   bodies.
2008   </p>
2009 </div>
2010
2011 <!-------------------------------------------------------------------------- -->
2012 <h3>
2013   <a name="view-postdom">-view-postdom: View postdominance tree of function</a>
2014 </h3>
2015 <div>
2016   <p>
2017   Displays the post dominator tree using the GraphViz tool.
2018   </p>
2019 </div>
2020
2021 <!-------------------------------------------------------------------------- -->
2022 <h3>
2023   <a name="view-postdom-only">-view-postdom-only: View postdominance tree of function (with no function bodies)</a>
2024 </h3>
2025 <div>
2026   <p>
2027   Displays the post dominator tree using the GraphViz tool, but omitting
2028   function bodies.
2029   </p>
2030 </div>
2031
2032 </div>
2033
2034 <!-- *********************************************************************** -->
2035
2036 <hr>
2037 <address>
2038   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
2039   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
2040   <a href="http://validator.w3.org/check/referer"><img
2041   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
2042
2043   <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br>
2044   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
2045   Last modified: $Date: 2012-10-31 18:25:31 +0100 (Wed, 31 Oct 2012) $
2046 </address>
2047
2048 </body>
2049 </html>