blob: ac24aab4ff6b570187d65d6d0d92b046720f9802 [file] [log] [blame]
Brian Gaekee993d202004-05-14 19:50:33 +00001=pod
2
3=head1 NAME
4
5llc - LLVM static compiler
6
7=head1 SYNOPSIS
8
Misha Brukmanc08937a2004-07-02 16:06:19 +00009B<llc> [I<options>] [I<filename>]
Brian Gaekee993d202004-05-14 19:50:33 +000010
11=head1 DESCRIPTION
12
Daniel Dunbar6db36f32009-09-15 20:31:28 +000013The B<llc> command compiles LLVM source inputs into assembly language for a
Brian Gaekee993d202004-05-14 19:50:33 +000014specified architecture. The assembly language output can then be passed through
Chris Lattner1e6df2e2005-05-13 20:01:11 +000015a native assembler and linker to generate a native executable.
Brian Gaekee993d202004-05-14 19:50:33 +000016
Chris Lattner1e6df2e2005-05-13 20:01:11 +000017The choice of architecture for the output assembly code is automatically
Daniel Dunbar6db36f32009-09-15 20:31:28 +000018determined from the input file, unless the B<-march> option is used to override
19the default.
Brian Gaekee993d202004-05-14 19:50:33 +000020
21=head1 OPTIONS
22
Daniel Dunbar6db36f32009-09-15 20:31:28 +000023If I<filename> is - or omitted, B<llc> reads from standard input. Otherwise, it
24will from I<filename>. Inputs can be in either the LLVM assembly language
25format (.ll) or the LLVM bitcode format (.bc).
Brian Gaekee993d202004-05-14 19:50:33 +000026
27If the B<-o> option is omitted, then B<llc> will send its output to standard
28output if the input is from standard input. If the B<-o> option specifies -,
29then the output will also be sent to standard output.
30
31If no B<-o> option is specified and an input file other than - is specified,
32then B<llc> creates the output filename by taking the input filename,
33removing any existing F<.bc> extension, and adding a F<.s> suffix.
34
35Other B<llc> options are as follows:
36
Chris Lattner1e6df2e2005-05-13 20:01:11 +000037=head2 End-user Options
38
Brian Gaekee993d202004-05-14 19:50:33 +000039=over
40
Duncan Sands7e7ae5a2010-02-18 14:08:13 +000041=item B<-help>
Chris Lattner1e6df2e2005-05-13 20:01:11 +000042
43Print a summary of command line options.
44
Bill Wendlingbe8cc2a2009-04-29 00:15:41 +000045=item B<-O>=I<uint>
46
47Generate code at different optimization levels. These correspond to the I<-O0>,
48I<-O1>, I<-O2>, I<-O3>, and I<-O4> optimization levels used by B<llvm-gcc> and
49B<clang>.
50
Chris Lattnerf4955362005-12-16 05:19:35 +000051=item B<-mtriple>=I<target triple>
Chris Lattner4f501bf2005-12-16 05:18:53 +000052
Daniel Dunbar6db36f32009-09-15 20:31:28 +000053Override the target triple specified in the input file with the specified
54string.
Chris Lattner4f501bf2005-12-16 05:18:53 +000055
Brian Gaekee993d202004-05-14 19:50:33 +000056=item B<-march>=I<arch>
57
Chris Lattner1e6df2e2005-05-13 20:01:11 +000058Specify the architecture for which to generate assembly, overriding the target
Duncan Sands7e7ae5a2010-02-18 14:08:13 +000059encoded in the input file. See the output of B<llc -help> for a list of
Chris Lattner4f501bf2005-12-16 05:18:53 +000060valid architectures. By default this is inferred from the target triple or
61autodetected to the current architecture.
62
63=item B<-mcpu>=I<cpuname>
64
65Specify a specific chip in the current architecture to generate code for.
66By default this is inferred from the target triple and autodetected to
67the current architecture. For a list of available CPUs, use:
68B<llvm-as E<lt> /dev/null | llc -march=xyz -mcpu=help>
69
70=item B<-mattr>=I<a1,+a2,-a3,...>
71
72Override or control specific attributes of the target, such as whether SIMD
73operations are enabled or not. The default set of attributes is set by the
74current CPU. For a list of available attributes, use:
75B<llvm-as E<lt> /dev/null | llc -march=xyz -mattr=help>
Brian Gaekee993d202004-05-14 19:50:33 +000076
Brian Gaekee993d202004-05-14 19:50:33 +000077=item B<--disable-fp-elim>
78
79Disable frame pointer elimination optimization.
80
Chris Lattner1e6df2e2005-05-13 20:01:11 +000081=item B<--disable-excess-fp-precision>
82
83Disable optimizations that may produce excess precision for floating point.
84Note that this option can dramatically slow down code on some systems
85(e.g. X86).
86
87=item B<--enable-unsafe-fp-math>
88
89Enable optimizations that make unsafe assumptions about IEEE math (e.g. that
90addition is associative) or may not work for all input ranges. These
91optimizations allow the code generator to make use of some instructions which
92would otherwise not be usable (such as fsin on X86).
93
Chris Lattner0c123df2004-12-09 21:16:40 +000094=item B<--enable-correct-eh-support>
Brian Gaekee993d202004-05-14 19:50:33 +000095
Chris Lattner0c123df2004-12-09 21:16:40 +000096Instruct the B<lowerinvoke> pass to insert code for correct exception handling
97support. This is expensive and is by default omitted for efficiency.
98
Chris Lattner0c123df2004-12-09 21:16:40 +000099=item B<--stats>
100
101Print statistics recorded by code-generation passes.
102
103=item B<--time-passes>
104
105Record the amount of time needed for each pass and print a report to standard
106error.
Brian Gaekee993d202004-05-14 19:50:33 +0000107
Chris Lattner1e6df2e2005-05-13 20:01:11 +0000108=item B<--load>=F<dso_path>
109
110Dynamically load F<dso_path> (a path to a dynamically shared object) that
111implements an LLVM target. This will permit the target name to be used with the
112B<-march> option so that code can be generated for that target.
113
114=back
115
116=head2 Tuning/Configuration Options
117
118=over
119
Brian Gaekee993d202004-05-14 19:50:33 +0000120=item B<--print-machineinstrs>
121
Chris Lattner0c123df2004-12-09 21:16:40 +0000122Print generated machine code between compilation phases (useful for debugging).
Brian Gaekee993d202004-05-14 19:50:33 +0000123
124=item B<--regalloc>=I<allocator>
125
126Specify the register allocator to use. The default I<allocator> is I<local>.
127Valid register allocators are:
128
129=over
130
131=item I<simple>
132
133Very simple "always spill" register allocator
134
135=item I<local>
136
137Local register allocator
138
139=item I<linearscan>
140
Alkis Evlogimenosc8dec2c2004-07-21 08:18:50 +0000141Linear scan global register allocator
Brian Gaekee993d202004-05-14 19:50:33 +0000142
Misha Brukman1e635c32004-07-21 12:53:14 +0000143=item I<iterativescan>
Alkis Evlogimenos910d0d62004-07-21 08:24:35 +0000144
145Iterative scan global register allocator
146
Brian Gaekee993d202004-05-14 19:50:33 +0000147=back
148
149=item B<--spiller>=I<spiller>
150
151Specify the spiller to use for register allocators that support it. Currently
152this option is used only by the linear scan register allocator. The default
153I<spiller> is I<local>. Valid spillers are:
154
155=over
156
157=item I<simple>
158
159Simple spiller
160
161=item I<local>
162
163Local spiller
164
165=back
166
167=back
168
Chris Lattner0c123df2004-12-09 21:16:40 +0000169=head2 Intel IA-32-specific Options
170
171=over
172
173=item B<--x86-asm-syntax=att|intel>
174
175Specify whether to emit assembly code in AT&T syntax (the default) or intel
176syntax.
177
178=back
179
Brian Gaekee993d202004-05-14 19:50:33 +0000180=head1 EXIT STATUS
181
182If B<llc> succeeds, it will exit with 0. Otherwise, if an error occurs,
183it will exit with a non-zero value.
184
185=head1 SEE ALSO
186
Misha Brukmanc08937a2004-07-02 16:06:19 +0000187L<lli|lli>
Brian Gaekee993d202004-05-14 19:50:33 +0000188
189=head1 AUTHORS
190
Reid Spencercd143fc2006-03-14 05:42:07 +0000191Maintained by the LLVM Team (L<http://llvm.org>).
Brian Gaekee993d202004-05-14 19:50:33 +0000192
193=cut