usr.bin/clang/opt/opt.1

   1 .\" $FreeBSD$
   2 .\" Man page generated from reStructuredText.
   3 .
   4 .TH "OPT" "1" "2018-08-02" "7" "LLVM"
   5 .SH NAME
   6 opt \- LLVM optimizer
   7 .
   8 .nr rst2man-indent-level 0
   9 .
  10 .de1 rstReportMargin
  11 \\$1 \\n[an-margin]
  12 level \\n[rst2man-indent-level]
  13 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  14 -
  15 \\n[rst2man-indent0]
  16 \\n[rst2man-indent1]
  17 \\n[rst2man-indent2]
  18 ..
  19 .de1 INDENT
  20 .\" .rstReportMargin pre:
  21 . RS \\$1
  22 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  23 . nr rst2man-indent-level +1
  24 .\" .rstReportMargin post:
  25 ..
  26 .de UNINDENT
  27 . RE
  28 .\" indent \\n[an-margin]
  29 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  30 .nr rst2man-indent-level -1
  31 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  32 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  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 \-disable\-inlining
  97 This option simply removes the inlining pass from the standard list.
  98 .UNINDENT
  99 .INDENT 0.0
 100 .TP
 101 .B \-disable\-opt
 102 This option is only meaningful when \fI\-std\-link\-opts\fP is given.  It
 103 disables most passes.
 104 .UNINDENT
 105 .INDENT 0.0
 106 .TP
 107 .B \-strip\-debug
 108 This option causes opt to strip debug information from the module before
 109 applying other optimizations.  It is essentially the same as \fI\-strip\fP
 110 but it ensures that stripping of debug information is done first.
 111 .UNINDENT
 112 .INDENT 0.0
 113 .TP
 114 .B \-verify\-each
 115 This option causes opt to add a verify pass after every pass otherwise
 116 specified on the command line (including \fI\-verify\fP).  This is useful
 117 for cases where it is suspected that a pass is creating an invalid module but
 118 it is not clear which pass is doing it.
 119 .UNINDENT
 120 .INDENT 0.0
 121 .TP
 122 .B \-stats
 123 Print statistics.
 124 .UNINDENT
 125 .INDENT 0.0
 126 .TP
 127 .B \-time\-passes
 128 Record the amount of time needed for each pass and print it to standard
 129 error.
 130 .UNINDENT
 131 .INDENT 0.0
 132 .TP
 133 .B \-debug
 134 If this is a debug build, this option will enable debug printouts from passes
 135 which use the \fBLLVM_DEBUG()\fP macro.  See the \fI\%LLVM Programmer\(aqs Manual\fP, section \fB#DEBUG\fP for more information.
 136 .UNINDENT
 137 .INDENT 0.0
 138 .TP
 139 .B \-load=<plugin>
 140 Load the dynamic object \fBplugin\fP\&.  This object should register new
 141 optimization or analysis passes.  Once loaded, the object will add new command
 142 line options to enable various optimizations or analyses.  To see the new
 143 complete list of optimizations, use the \fI\%\-help\fP and \fI\%\-load\fP
 144 options together.  For example:
 145 .INDENT 7.0
 146 .INDENT 3.5
 147 .sp
 148 .nf
 149 .ft C
 150 opt \-load=plugin.so \-help
 151 .ft P
 152 .fi
 153 .UNINDENT
 154 .UNINDENT
 155 .UNINDENT
 156 .INDENT 0.0
 157 .TP
 158 .B \-p
 159 Print module after each transformation.
 160 .UNINDENT
 161 .SH EXIT STATUS
 162 .sp
 163 If \fBopt\fP succeeds, it will exit with 0.  Otherwise, if an error
 164 occurs, it will exit with a non\-zero value.
 165 .SH AUTHOR
 166 Maintained by The LLVM Team (http://llvm.org/).
 167 .SH COPYRIGHT
 168 2003-2018, LLVM Project
 169 .\" Generated by docutils manpage writer.
 170 .