docs/CommandGuide/opt.html

   1 <html>
   2 <title>LLVM: opt tool</title>
   3
   4 <body bgcolor=white>
   5
   6 <center><h1>LLVM: <tt>opt</tt> tool</h1></center>
   7 <HR>
   8
   9 <h3>NAME</h3>
  10 <tt>opt</tt>
  11
  12 <h3>SYNOPSIS</h3>
  13 <tt>opt [options] [filename]</tt>
  14
  15 <h3>DESCRIPTION</h3>
  16
  17 The <tt>opt</tt> command is the modular LLVM optimizer.  It takes LLVM bytecode
  18 as input, runs the specified optimizations on it, and then outputs the optimized
  19 LLVM bytecode.
  20 <p>
  21
  22 The optimizations available via <tt>opt</tt> depend upon what libraries were
  23 linked into it as well as any additional libraries that have been loaded with
  24 the <tt>-load</tt> option.  Use the <tt>-help</tt> option to determine what
  25 optimizations you can use.
  26 <p>
  27
  28 If no filename is specified on the command line, <tt>opt</tt> reads its input
  29 from standard input.
  30 <p>
  31
  32 If an output filename is not specified with the <tt>-o</tt> option, <tt>opt</tt>
  33 writes its output to the standard output.
  34
  35
  36 <h3>OPTIONS</h3>
  37
  38 <ul>
  39         <li> -f
  40         <br>
  41         Force overwrite.  Normally, <tt>opt</tt> will refuse to overwrite an
  42         output file that already exists.  With this option, <tt>opt</tt> will
  43         overwrite the output file and replace it with new bytecode.
  44         <p>
  45
  46         <li> -help
  47         <br>
  48         Print a summary of command line options.
  49         <p>
  50
  51         <li> -o &lt;filename&gt;
  52         <br>
  53         Specify the output filename.
  54         <p>
  55
  56         <li> -profile-info-file &lt;filename&gt;
  57         <br>
  58         Specify the name of the file loaded by the -profile-loader option.
  59         <p>
  60
  61         <li> -stats
  62         <br>
  63         Print statistics.
  64         <p>
  65
  66         <li> -time-passes
  67         <br>
  68         Record the amount of time needed for each pass and print it to standard
  69         error.
  70         <p>
  71
  72         <li> -debug
  73         <br>
  74         If this is a debug build, this option will enable debug printouts from
  75         passes which use the <tt>DEBUG</tt> macro.  See the <a
  76         href="../ProgrammersManual.html#DEBUG">Programmer's Manual</a> for more
  77         information.
  78         <p>
  79
  80         <li> -load &lt;plugin&gt;
  81         <br>
  82         Load the dynamic object &lt;plugin&gt;.  This object should register new
  83         optimization passes.  Once loaded, the object will add new command line
  84         options to enable various optimizations.  To see the new complete list
  85         of optimizations, use the -help and -load options together:
  86         <p>
  87         <tt>opt -load  &lt;plugin&gt; -help</tt>
  88         <p>
  89
  90         <li> -p
  91         <br>
  92         Print module after each transformation.
  93         <p>
  94 </ul>
  95
  96 <h3>EXIT STATUS</h3>
  97
  98 If <tt>opt</tt> succeeds, it will exit with 0.  Otherwise, if an error occurs,
  99 it will exit with a non-zero value.
 100
 101 <h3>SEE ALSO</h3>
 102
 103 <a href="analyze.html"><tt>analyze</tt></a>
 104
 105 <HR>
 106 Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
 107 </body>
 108 </html>
 109