Add the code generation options.
[oota-llvm.git] / docs / CommandGuide / lli.pod
1 =pod
2
3 =head1 NAME
4
5 lli - directly execute programs from LLVM bitcode
6
7 =head1 SYNOPSIS
8
9 B<lli> [I<options>] [I<filename>] [I<program args>]
10
11 =head1 DESCRIPTION
12
13 B<lli> directly executes programs in LLVM bitcode format.  It takes a program
14 in LLVM bitcode format and executes it using a just-in-time compiler, if one is
15 available for the current architecture, or an interpreter.  B<lli> takes all of
16 the same code generator options as L<llc|llc>, but they are only effective when
17 B<lli> is using the just-in-time compiler.
18
19 If I<filename> is not specified, then B<lli> reads the LLVM bitcode for the
20 program from standard input.
21
22 The optional I<args> specified on the command line are passed to the program as
23 arguments.
24
25 =head1 GENERAL OPTIONS
26
27 =over
28
29 =item B<-fake-argv0>=I<executable>
30
31 Override the C<argv[0]> value passed into the executing program.
32
33 =item B<-force-interpreter>=I<{false,true}>
34
35 If set to true, use the interpreter even if a just-in-time compiler is available
36 for this architecture. Defaults to false.
37
38 =item B<-help>
39
40 Print a summary of command line options.
41
42 =item B<-load>=I<puginfilename>
43
44 Causes B<lli> to load the plugin (shared object) named I<pluginfilename> and use
45 it for optimization.
46
47 =item B<-stats>
48
49 Print statistics from the code-generation passes. This is only meaningful for
50 the just-in-time compiler, at present.
51
52 =item B<-time-passes>
53
54 Record the amount of time needed for each code-generation pass and print it to
55 standard error.
56
57 =back 
58
59 =head1 TARGET OPTIONS
60
61 =over 
62
63 =item B<-mtriple>=I<target triple>
64
65 Override the target triple specified in the input bitcode file with the 
66 specified string.  This may result in a crash if you pick an
67 architecture which is not compatible with the current system.
68
69 =item B<-march>=I<arch>
70
71 Specify the architecture for which to generate assembly, overriding the target
72 encoded in the bitcode file.  See the output of B<llc --help> for a list of
73 valid architectures.  By default this is inferred from the target triple or
74 autodetected to the current architecture.
75
76 =item B<-mcpu>=I<cpuname>
77
78 Specify a specific chip in the current architecture to generate code for.
79 By default this is inferred from the target triple and autodetected to 
80 the current architecture.  For a list of available CPUs, use:
81 B<llvm-as E<lt> /dev/null | llc -march=xyz -mcpu=help>
82
83 =item B<-mattr>=I<a1,+a2,-a3,...>
84
85 Override or control specific attributes of the target, such as whether SIMD
86 operations are enabled or not.  The default set of attributes is set by the
87 current CPU.  For a list of available attributes, use:
88 B<llvm-as E<lt> /dev/null | llc -march=xyz -mattr=help>
89
90 =back
91
92
93 =head1 FLOATING POINT OPTIONS
94
95 =over 
96
97 =item B<-disable-excess-fp-precision>
98
99 Disable optimizations that may increase floating point precision.
100
101 =item B<-enable-finite-only-fp-math>
102
103 Enable optimizations that assumes only finite floating point math. That is,
104 there is no NAN or Inf values.
105
106 =item B<-enable-unsafe-fp-math>
107
108 Causes B<lli> to enable optimizations that may decrease floating point
109 precision.
110
111 =item B<-soft-float>
112
113 Causes B<lli> to generate software floating point library calls instead of
114 equivalent hardware instructions.
115
116 =back
117
118 =head1 CODE GENERATION OPTIONS
119
120 =over
121
122 =item B<-code-model>=I<model>
123
124 Choose the code model from:
125
126 =over
127
128 =item I<default>: Target default code model
129
130 =item I<small>: Small code model
131
132 =item I<kernel>: Kernel code model
133 =item I<medium>: Medium code model
134 =item I<large>: Large code model
135
136 =back
137
138 =item B<-disable-post-RA-scheduler>
139
140 Disable scheduling after register allocation.
141
142 =item B<-disable-spill-fusing>
143
144 Disable fusing of spill code into instructions.
145
146 =item B<-enable-correct-eh-support> 
147
148 Make the -lowerinvoke pass insert expensive, but correct, EH code.
149
150 =item B<-enable-eh> 
151
152 Exception handling should be emitted.
153
154 =item B<-join-liveintervals> 
155
156 Coalesce copies (default=true).
157
158 =item B<-nozero-initialized-in-bss>
159 Don't place zero-initialized symbols into the BSS section.
160
161 =item B<-pre-RA-sched>=I<scheduler>
162
163 Instruction schedulers available (before register allocation):
164
165 =over
166
167 =item I<=default>: Best scheduler for the target 
168
169 =item I<=none>: No scheduling: breadth first sequencing 
170
171 =item I<=simple>: Simple two pass scheduling: minimize critical path and maximize processor utilization 
172
173 =item I<=simple-noitin>: Simple two pass scheduling: Same as simple except using generic latency 
174
175 =item I<=list-burr>: Bottom-up register reduction list scheduling 
176
177 =item I<=list-tdrr>: Top-down register reduction list scheduling 
178
179 =item I<=list-td>: Top-down list scheduler -print-machineinstrs - Print generated machine code
180
181 =back
182
183 =item B<-regalloc>=I<allocator>
184
185 Register allocator to use: (default = linearscan)
186
187 =over
188
189 =item I<=bigblock>: Big-block register allocator 
190
191 =item I<=linearscan>: linear scan register allocator =local -   local register allocator 
192
193 =item I<=simple>: simple register allocator 
194
195 =back
196
197 =item B<-relocation-model>=I<model> 
198
199 Choose relocation model from:
200
201 =over
202
203 =item I<=default>: Target default relocation model 
204
205 =item I<=static>: Non-relocatable code =pic -   Fully relocatable, position independent code 
206
207 =item I<=dynamic-no-pic>: Relocatable external references, non-relocatable code 
208
209 =back
210
211 =item B<-spiller>
212
213 Spiller to use: (default: local) 
214
215 =over
216
217 =item I<=simple>: simple spiller 
218
219 =item I<=local>: local spiller 
220
221 =back
222
223 =item B<-x86-asm-syntax>=I<syntax>
224
225 Choose style of code to emit from X86 backend: 
226
227 =over
228
229 =item I<=att>: Emit AT&T-style assembly 
230
231 =item I<=intel>: Emit Intel-style assembly
232
233 =back
234
235 =back
236
237 =head1 EXIT STATUS
238
239 If B<lli> fails to load the program, it will exit with an exit code of 1.
240 Otherwise, it will return the exit code of the program it executes.
241
242 =head1 SEE ALSO
243
244 L<llc|llc>
245
246 =head1 AUTHOR
247
248 Maintained by the LLVM Team (L<http://llvm.org>).
249
250 =cut