Blame - docs/CommandGuide/opt.html - platform/external/llvm

blob: 75b93602e4c171c2616c35a7496201a7d13321d0 [file] [log] [blame]

John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	1	<html>
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	2	<title>LLVM: opt tool</title>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	3
Chris Lattner	08a04fd	2003-10-07 20:12:05 +0000	[diff] [blame]	4	<body bgcolor=white>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	5
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	6	<center><h1>LLVM: <tt>opt</tt> tool</h1></center>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	7	<HR>
				8
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	9	<h3>NAME</h3>
				10	<tt>opt</tt>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	11
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	12	<h3>SYNOPSIS</h3>
				13	<tt>opt [options] [filename]</tt>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	14
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	15	<h3>DESCRIPTION</h3>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	16
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	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.
John Criswell	6243534	2003-09-26 16:32:00 +0000	[diff] [blame]	20	<p>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	21
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	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.
John Criswell	6243534	2003-09-26 16:32:00 +0000	[diff] [blame]	26	<p>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	27
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	28	If no filename is specified on the command line, <tt>opt</tt> reads its input
				29	from standard input.
John Criswell	6243534	2003-09-26 16:32:00 +0000	[diff] [blame]	30	<p>
				31
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	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>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	37
				38	<ul>
				39	<li> -f
				40	<br>
Chris Lattner	26814d0	2003-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 Criswell	ecf32e5	2003-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 <filename>
				52	<br>
				53	Specify the output filename.
				54	<p>
				55
John Criswell	8417142	2004-03-12 22:45:35 +0000	[diff] [blame]	56	<li> -profile-info-file <filename>
				57	<br>
				58	Specify the name of the file loaded by the -profile-loader option.
				59	<p>
				60
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	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
Chris Lattner	a2a628f	2003-10-07 16:33:42 +0000	[diff] [blame]	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>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	79
John Criswell	f9c7865	2004-01-26 21:26:54 +0000	[diff] [blame]	80	<li> -load <plugin>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	81	<br>
John Criswell	f9c7865	2004-01-26 21:26:54 +0000	[diff] [blame]	82	Load the dynamic object <plugin>. This object should register new
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	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>
John Criswell	f9c7865	2004-01-26 21:26:54 +0000	[diff] [blame]	87	<tt>opt -load <plugin> -help</tt>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	88	<p>
				89
				90	<li> -p
				91	<br>
				92	Print module after each transformation.
				93	<p>
				94	</ul>
				95
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	96	<h3>EXIT STATUS</h3>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	97
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	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.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	100
Chris Lattner	26814d0	2003-10-07 20:17:24 +0000	[diff] [blame]	101	<h3>SEE ALSO</h3>
				102
				103	<a href="analyze.html"><tt>analyze</tt></a>
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	104
				105	<HR>
Chris Lattner	08a04fd	2003-10-07 20:12:05 +0000	[diff] [blame]	106	Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
John Criswell	ecf32e5	2003-09-11 19:58:03 +0000	[diff] [blame]	107	</body>
				108	</html>
				109