usr.bin/clang/opt/opt.1

   1 .\" $FreeBSD$
   2 .TH "OPT" "1" "2013-06-10" "3.3" "LLVM"
   3 .SH NAME
   4 opt \- LLVM optimizer
   5 .
   6 .nr rst2man-indent-level 0
   7 .
   8 .de1 rstReportMargin
   9 \\$1 \\n[an-margin]
  10 level \\n[rst2man-indent-level]
  11 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  12 -
  13 \\n[rst2man-indent0]
  14 \\n[rst2man-indent1]
  15 \\n[rst2man-indent2]
  16 ..
  17 .de1 INDENT
  18 .\" .rstReportMargin pre:
  19 . RS \\$1
  20 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  21 . nr rst2man-indent-level +1
  22 .\" .rstReportMargin post:
  23 ..
  24 .de UNINDENT
  25 . RE
  26 .\" indent \\n[an-margin]
  27 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28 .nr rst2man-indent-level -1
  29 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  30 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  31 ..
  32 .\" Man page generated from reStructuredText.
  33 .
  34 .SH SYNOPSIS
  35 .sp
  36 \fBopt\fP [\fIoptions\fP] [\fIfilename\fP]
  37 .SH DESCRIPTION
  38 .sp
  39 The \fBopt\fP command is the modular LLVM optimizer and analyzer.  It
  40 takes LLVM source files as input, runs the specified optimizations or analyses
  41 on it, and then outputs the optimized file or the analysis results.  The
  42 function of \fBopt\fP depends on whether the \fI\-analyze\fP option is
  43 given.
  44 .sp
  45 When \fI\-analyze\fP is specified, \fBopt\fP performs various analyses
  46 of the input source.  It will usually print the results on standard output, but
  47 in a few cases, it will print output to standard error or generate a file with
  48 the analysis output, which is usually done when the output is meant for another
  49 program.
  50 .sp
  51 While \fI\-analyze\fP is \fInot\fP given, \fBopt\fP attempts to produce an
  52 optimized output file.  The optimizations available via \fBopt\fP depend
  53 upon what libraries were linked into it as well as any additional libraries
  54 that have been loaded with the \fI\%-load\fP option.  Use the \fI\%-help\fP
  55 option to determine what optimizations you can use.
  56 .sp
  57 If \fBfilename\fP is omitted from the command line or is "\fB\-\fP", \fBopt\fP
  58 reads its input from standard input.  Inputs can be in either the LLVM assembly
  59 language format (\fB.ll\fP) or the LLVM bitcode format (\fB.bc\fP).
  60 .sp
  61 If an output filename is not specified with the \fI\%-o\fP option,
  62 \fBopt\fP writes its output to the standard output.
  63 .SH OPTIONS
  64 .INDENT 0.0
  65 .TP
  66 .B \-f
  67 Enable binary output on terminals.  Normally, \fBopt\fP will refuse to
  68 write raw bitcode output if the output stream is a terminal.  With this option,
  69 \fBopt\fP will write raw bitcode regardless of the output device.
  70 .UNINDENT
  71 .INDENT 0.0
  72 .TP
  73 .B \-help
  74 Print a summary of command line options.
  75 .UNINDENT
  76 .INDENT 0.0
  77 .TP
  78 .B \-o <filename>
  79 Specify the output filename.
  80 .UNINDENT
  81 .INDENT 0.0
  82 .TP
  83 .B \-S
  84 Write output in LLVM intermediate language (instead of bitcode).
  85 .UNINDENT
  86 .INDENT 0.0
  87 .TP
  88 .B \-{passname}
  89 \fBopt\fP provides the ability to run any of LLVM\(aqs optimization or
  90 analysis passes in any order.  The \fI\%-help\fP option lists all the passes
  91 available.  The order in which the options occur on the command line are the
  92 order in which they are executed (within pass constraints).
  93 .UNINDENT
  94 .INDENT 0.0
  95 .TP
  96 .B \-std\-compile\-opts
  97 This is short hand for a standard list of \fIcompile time optimization\fP passes.
  98 This is typically used to optimize the output from the llvm\-gcc front end.  It
  99 might be useful for other front end compilers as well.  To discover the full
 100 set of options available, use the following command:
 101 .INDENT 7.0
 102 .INDENT 3.5
 103 .sp
 104 .nf
 105 .ft C
 106 llvm\-as < /dev/null | opt \-std\-compile\-opts \-disable\-output \-debug\-pass=Arguments
 107 .ft P
 108 .fi
 109 .UNINDENT
 110 .UNINDENT
 111 .UNINDENT
 112 .INDENT 0.0
 113 .TP
 114 .B \-disable\-inlining
 115 This option is only meaningful when \fI\%-std-compile-opts\fP is given.  It
 116 simply removes the inlining pass from the standard list.
 117 .UNINDENT
 118 .INDENT 0.0
 119 .TP
 120 .B \-disable\-opt
 121 This option is only meaningful when \fI\%-std-compile-opts\fP is given.  It
 122 disables most, but not all, of the \fI\%-std-compile-opts\fP.  The ones that
 123 remain are \fI\-verify\fP, \fI\-lower\-setjmp\fP, and
 124 \fI\-funcresolve\fP.
 125 .UNINDENT
 126 .INDENT 0.0
 127 .TP
 128 .B \-strip\-debug
 129 This option causes opt to strip debug information from the module before
 130 applying other optimizations.  It is essentially the same as \fI\-strip\fP
 131 but it ensures that stripping of debug information is done first.
 132 .UNINDENT
 133 .INDENT 0.0
 134 .TP
 135 .B \-verify\-each
 136 This option causes opt to add a verify pass after every pass otherwise
 137 specified on the command line (including \fI\-verify\fP).  This is useful
 138 for cases where it is suspected that a pass is creating an invalid module but
 139 it is not clear which pass is doing it.  The combination of
 140 \fI\%-std-compile-opts\fP and \fI\%-verify-each\fP can quickly track down
 141 this kind of problem.
 142 .UNINDENT
 143 .INDENT 0.0
 144 .TP
 145 .B \-profile\-info\-file <filename>
 146 Specify the name of the file loaded by the \fB\-profile\-loader\fP option.
 147 .UNINDENT
 148 .INDENT 0.0
 149 .TP
 150 .B \-stats
 151 Print statistics.
 152 .UNINDENT
 153 .INDENT 0.0
 154 .TP
 155 .B \-time\-passes
 156 Record the amount of time needed for each pass and print it to standard
 157 error.
 158 .UNINDENT
 159 .INDENT 0.0
 160 .TP
 161 .B \-debug
 162 If this is a debug build, this option will enable debug printouts from passes
 163 which use the \fBDEBUG()\fP macro.  See the \fI\%LLVM Programmer's Manual\fP, section \fB#DEBUG\fP for more information.
 164 .UNINDENT
 165 .INDENT 0.0
 166 .TP
 167 .B \-load=<plugin>
 168 Load the dynamic object \fBplugin\fP.  This object should register new
 169 optimization or analysis passes.  Once loaded, the object will add new command
 170 line options to enable various optimizations or analyses.  To see the new
 171 complete list of optimizations, use the \fI\%-help\fP and \fI\%-load\fP
 172 options together.  For example:
 173 .INDENT 7.0
 174 .INDENT 3.5
 175 .sp
 176 .nf
 177 .ft C
 178 opt \-load=plugin.so \-help
 179 .ft P
 180 .fi
 181 .UNINDENT
 182 .UNINDENT
 183 .UNINDENT
 184 .INDENT 0.0
 185 .TP
 186 .B \-p
 187 Print module after each transformation.
 188 .UNINDENT
 189 .SH EXIT STATUS
 190 .sp
 191 If \fBopt\fP succeeds, it will exit with 0.  Otherwise, if an error
 192 occurs, it will exit with a non\-zero value.
 193 .SH AUTHOR
 194 Maintained by The LLVM Team (http://llvm.org/).
 195 .SH COPYRIGHT
 196 2003-2013, LLVM Project
 197 .\" Generated by docutils manpage writer.
 198 .