910dfad450f594ced6970a73cac2bd23095eaffd
[oota-llvm.git] / docs / CommandGuide / llc.pod
1 =pod
2
3 =head1 NAME
4
5 llc - LLVM static compiler
6
7 =head1 SYNOPSIS
8
9 B<llc> [I<options>] [I<filename>]
10
11 =head1 DESCRIPTION
12
13 The B<llc> command compiles LLVM bytecode into assembly language for a
14 specified architecture.  The assembly language output can then be passed through
15 a native assembler and linker to generate a native executable.
16
17 The choice of architecture for the output assembly code is automatically
18 determined from the input bytecode file, unless the B<-march> option is used to
19 override the default.
20
21 =head1 OPTIONS
22
23 If I<filename> is - or omitted, B<llc> reads LLVM bytecode from standard input.
24 Otherwise, it will read LLVM bytecode from I<filename>.
25
26 If the B<-o> option is omitted, then B<llc> will send its output to standard
27 output if the input is from standard input.  If the B<-o> option specifies -,
28 then the output will also be sent to standard output.
29
30 If no B<-o> option is specified and an input file other than - is specified,
31 then B<llc> creates the output filename by taking the input filename,
32 removing any existing F<.bc> extension, and adding a F<.s> suffix.
33
34 Other B<llc> options are as follows:
35
36 =head2 End-user Options
37
38 =over
39
40 =item B<--help>
41
42 Print a summary of command line options.
43
44 =item B<-f>
45
46 Overwrite output files. By default, B<llc> will refuse to overwrite
47 an output file which already exists.
48
49 =item B<-march>=I<arch>
50
51 Specify the architecture for which to generate assembly, overriding the target
52 encoded in the bytecode file.  See the output of B<llc --help> for a list of
53 valid architectures.
54
55 =item B<--disable-fp-elim>
56
57 Disable frame pointer elimination optimization.
58
59 =item B<--disable-excess-fp-precision>
60
61 Disable optimizations that may produce excess precision for floating point.
62 Note that this option can dramatically slow down code on some systems
63 (e.g. X86).
64
65 =item B<--enable-unsafe-fp-math>
66
67 Enable optimizations that make unsafe assumptions about IEEE math (e.g. that
68 addition is associative) or may not work for all input ranges.  These
69 optimizations allow the code generator to make use of some instructions which
70 would otherwise not be usable (such as fsin on X86).
71
72 =item B<--enable-correct-eh-support>
73
74 Instruct the B<lowerinvoke> pass to insert code for correct exception handling
75 support.  This is expensive and is by default omitted for efficiency.
76
77 =item B<--stats>
78
79 Print statistics recorded by code-generation passes.
80
81 =item B<--time-passes>
82
83 Record the amount of time needed for each pass and print a report to standard
84 error.
85
86 =item B<--load>=F<dso_path>
87
88 Dynamically load F<dso_path> (a path to a dynamically shared object) that
89 implements an LLVM target. This will permit the target name to be used with the
90 B<-march> option so that code can be generated for that target.
91
92 =back
93
94 =head2 Tuning/Configuration Options
95
96 =over
97
98 =item B<--print-machineinstrs>
99
100 Print generated machine code between compilation phases (useful for debugging).
101
102 =item B<--regalloc>=I<allocator>
103
104 Specify the register allocator to use. The default I<allocator> is I<local>.
105 Valid register allocators are:
106
107 =over
108
109 =item I<simple>
110
111 Very simple "always spill" register allocator
112
113 =item I<local>
114
115 Local register allocator
116
117 =item I<linearscan>
118
119 Linear scan global register allocator
120
121 =item I<iterativescan>
122
123 Iterative scan global register allocator
124
125 =back
126
127 =item B<--spiller>=I<spiller>
128
129 Specify the spiller to use for register allocators that support it.  Currently
130 this option is used only by the linear scan register allocator. The default
131 I<spiller> is I<local>.  Valid spillers are:
132
133 =over
134
135 =item I<simple>
136
137 Simple spiller
138
139 =item I<local>
140
141 Local spiller
142
143 =back
144
145 =back
146
147 =head2 Intel IA-32-specific Options
148
149 =over
150
151 =item B<--x86-asm-syntax=att|intel>
152
153 Specify whether to emit assembly code in AT&T syntax (the default) or intel
154 syntax.
155
156 =back
157
158 =head2 SPARCV9-specific Options
159
160 =over
161
162 =item B<--disable-peephole>
163
164 Disable peephole optimization pass.
165
166 =item B<--disable-sched>
167
168 Disable local scheduling pass.
169
170 =back
171
172 =head1 EXIT STATUS
173
174 If B<llc> succeeds, it will exit with 0.  Otherwise, if an error occurs,
175 it will exit with a non-zero value.
176
177 =head1 SEE ALSO
178
179 L<lli|lli>
180
181 =head1 AUTHORS
182
183 Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
184
185 =cut