Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / llvm / 841714214ed276c9a69c471b6c85f6388e8db970 / . / docs / CommandGuide / opt.html
blob: 4bf67a49c2547561364e85dd435699bc0a79190e [file] [log] [blame]
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]1<html>
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]2<title>LLVM: opt tool</title>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]3
Chris Lattner08a04fd2003-10-07 20:12:05 +0000[diff] [blame]4<body bgcolor=white>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]5
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]6<center><h1>LLVM: <tt>opt</tt> tool</h1></center>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]7<HR>
8
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]9<h3>NAME</h3>
10<tt>opt</tt>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]11
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]12<h3>SYNOPSIS</h3>
13<tt>opt [options] [filename]</tt>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]14
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]15<h3>DESCRIPTION</h3>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]16
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]17The <tt>opt</tt> command is the modular LLVM optimizer. It takes LLVM bytecode
18as input, runs the specified optimizations on it, and then outputs the optimized
19LLVM bytecode.
John Criswell62435342003-09-26 16:32:00 +0000[diff] [blame]20<p>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]21
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]22The optimizations available via <tt>opt</tt> depend upon what libraries were
23linked into it as well as any additional libraries that have been loaded with
24the <tt>-load</tt> option. Use the <tt>-help</tt> option to determine what
25optimizations you can use.
John Criswell62435342003-09-26 16:32:00 +0000[diff] [blame]26<p>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]27
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]28If no filename is specified on the command line, <tt>opt</tt> reads its input
29from standard input.
John Criswell62435342003-09-26 16:32:00 +0000[diff] [blame]30<p>
31
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]32If an output filename is not specified with the <tt>-o</tt> option, <tt>opt</tt>
33writes its output to the standard output.
34
35
36<h3>OPTIONS</h3>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]37
38<ul>
39 <li> -f
40 <br>
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]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.
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]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
John Criswell84171422004-03-12 22:45:35 +0000[diff] [blame^]56 <li> -dsa-track-integers
57 <br>
58 Track integers as potential pointers.
59 <p>
60
61 <li> -profile-info-file &lt;filename&gt;
62 <br>
63 Specify the name of the file loaded by the -profile-loader option.
64 <p>
65
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]66 <li> -stats
67 <br>
68 Print statistics.
69 <p>
70
71 <li> -time-passes
72 <br>
73 Record the amount of time needed for each pass and print it to standard
74 error.
75 <p>
76
Chris Lattnera2a628f2003-10-07 16:33:42 +0000[diff] [blame]77 <li> -debug
78 <br>
79 If this is a debug build, this option will enable debug printouts from
80 passes which use the <tt>DEBUG</tt> macro. See the <a
81 href="../ProgrammersManual.html#DEBUG">Programmer's Manual</a> for more
82 information.
83 <p>
84<!--
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]85 <li> -internalize-public-api-file &lt;filename&gt;
86 <br>
87 Preserve the symbol names listed in the file filename.
88 <p>
89
90 <li> -internalize-public-api-list=&lt;list&gt;
91 <br>
92 Perserve the symbol names specified.
93 <p>
Chris Lattnera2a628f2003-10-07 16:33:42 +0000[diff] [blame]94-->
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]95
96 <li> -q
97 <br>
98 Quiet mode. Do not print messages on whether the program was modified.
99 <p>
100
John Criswellf9c78652004-01-26 21:26:54 +0000[diff] [blame]101 <li> -load &lt;plugin&gt;
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]102 <br>
John Criswellf9c78652004-01-26 21:26:54 +0000[diff] [blame]103 Load the dynamic object &lt;plugin&gt;. This object should register new
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]104 optimization passes. Once loaded, the object will add new command line
105 options to enable various optimizations. To see the new complete list
106 of optimizations, use the -help and -load options together:
107 <p>
John Criswellf9c78652004-01-26 21:26:54 +0000[diff] [blame]108 <tt>opt -load &lt;plugin&gt; -help</tt>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]109 <p>
110
111 <li> -p
112 <br>
113 Print module after each transformation.
114 <p>
115</ul>
116
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]117<h3>EXIT STATUS</h3>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]118
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]119If <tt>opt</tt> succeeds, it will exit with 0. Otherwise, if an error occurs,
120it will exit with a non-zero value.
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]121
Chris Lattner26814d02003-10-07 20:17:24 +0000[diff] [blame]122<h3>SEE ALSO</h3>
123
124<a href="analyze.html"><tt>analyze</tt></a>
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]125
126<HR>
Chris Lattner08a04fd2003-10-07 20:12:05 +0000[diff] [blame]127Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
John Criswellecf32e52003-09-11 19:58:03 +0000[diff] [blame]128</body>
129</html>
130