Add missing newline to debug statement.
[llvm.git] / docs / CommandGuide / lli.pod
blobd368bec8660a4d34198d2491404119bf521a9b96
1 =pod
3 =head1 NAME
5 lli - directly execute programs from LLVM bitcode
7 =head1 SYNOPSIS
9 B<lli> [I<options>] [I<filename>] [I<program args>]
11 =head1 DESCRIPTION
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.
19 If I<filename> is not specified, then B<lli> reads the LLVM bitcode for the
20 program from standard input.
22 The optional I<args> specified on the command line are passed to the program as
23 arguments.
25 =head1 GENERAL OPTIONS
27 =over
29 =item B<-fake-argv0>=I<executable>
31 Override the C<argv[0]> value passed into the executing program.
33 =item B<-force-interpreter>=I<{false,true}>
35 If set to true, use the interpreter even if a just-in-time compiler is available
36 for this architecture. Defaults to false.
38 =item B<-help>
40 Print a summary of command line options.
42 =item B<-load>=I<puginfilename>
44 Causes B<lli> to load the plugin (shared object) named I<pluginfilename> and use
45 it for optimization.
47 =item B<-stats>
49 Print statistics from the code-generation passes. This is only meaningful for
50 the just-in-time compiler, at present.
52 =item B<-time-passes>
54 Record the amount of time needed for each code-generation pass and print it to
55 standard error.
57 =item B<-version>
59 Print out the version of B<lli> and exit without doing anything else.
61 =back 
63 =head1 TARGET OPTIONS
65 =over 
67 =item B<-mtriple>=I<target triple>
69 Override the target triple specified in the input bitcode file with the 
70 specified string.  This may result in a crash if you pick an
71 architecture which is not compatible with the current system.
73 =item B<-march>=I<arch>
75 Specify the architecture for which to generate assembly, overriding the target
76 encoded in the bitcode file.  See the output of B<llc -help> for a list of
77 valid architectures.  By default this is inferred from the target triple or
78 autodetected to the current architecture.
80 =item B<-mcpu>=I<cpuname>
82 Specify a specific chip in the current architecture to generate code for.
83 By default this is inferred from the target triple and autodetected to 
84 the current architecture.  For a list of available CPUs, use:
85 B<llvm-as E<lt> /dev/null | llc -march=xyz -mcpu=help>
87 =item B<-mattr>=I<a1,+a2,-a3,...>
89 Override or control specific attributes of the target, such as whether SIMD
90 operations are enabled or not.  The default set of attributes is set by the
91 current CPU.  For a list of available attributes, use:
92 B<llvm-as E<lt> /dev/null | llc -march=xyz -mattr=help>
94 =back
97 =head1 FLOATING POINT OPTIONS
99 =over 
101 =item B<-disable-excess-fp-precision>
103 Disable optimizations that may increase floating point precision.
105 =item B<-enable-finite-only-fp-math>
107 Enable optimizations that assumes only finite floating point math. That is,
108 there is no NAN or Inf values.
110 =item B<-enable-unsafe-fp-math>
112 Causes B<lli> to enable optimizations that may decrease floating point
113 precision.
115 =item B<-soft-float>
117 Causes B<lli> to generate software floating point library calls instead of
118 equivalent hardware instructions.
120 =back
122 =head1 CODE GENERATION OPTIONS
124 =over
126 =item B<-code-model>=I<model>
128 Choose the code model from:
130     default: Target default code model
131     small: Small code model
132     kernel: Kernel code model
133     medium: Medium code model
134     large: Large code model
136 =item B<-disable-post-RA-scheduler>
138 Disable scheduling after register allocation.
140 =item B<-disable-spill-fusing>
142 Disable fusing of spill code into instructions.
144 =item B<-enable-correct-eh-support> 
146 Make the -lowerinvoke pass insert expensive, but correct, EH code.
148 =item B<-jit-enable-eh> 
150 Exception handling should be enabled in the just-in-time compiler.
152 =item B<-join-liveintervals> 
154 Coalesce copies (default=true).
156 =item B<-nozero-initialized-in-bss>
157 Don't place zero-initialized symbols into the BSS section.
159 =item B<-pre-RA-sched>=I<scheduler>
161 Instruction schedulers available (before register allocation):
163     =default: Best scheduler for the target 
164     =none: No scheduling: breadth first sequencing 
165     =simple: Simple two pass scheduling: minimize critical path and maximize processor utilization 
166     =simple-noitin: Simple two pass scheduling: Same as simple except using generic latency 
167     =list-burr: Bottom-up register reduction list scheduling 
168     =list-tdrr: Top-down register reduction list scheduling 
169     =list-td: Top-down list scheduler -print-machineinstrs - Print generated machine code
171 =item B<-regalloc>=I<allocator>
173 Register allocator to use (default=linearscan)
175     =bigblock: Big-block register allocator 
176     =linearscan: linear scan register allocator =local -   local register allocator 
177     =simple: simple register allocator 
179 =item B<-relocation-model>=I<model> 
181 Choose relocation model from:
183     =default: Target default relocation model 
184     =static: Non-relocatable code =pic -   Fully relocatable, position independent code 
185     =dynamic-no-pic: Relocatable external references, non-relocatable code 
187 =item B<-spiller>
189 Spiller to use (default=local) 
191     =simple: simple spiller 
192     =local: local spiller 
194 =item B<-x86-asm-syntax>=I<syntax>
196 Choose style of code to emit from X86 backend: 
198     =att: Emit AT&T-style assembly 
199     =intel: Emit Intel-style assembly
201 =back
203 =head1 EXIT STATUS
205 If B<lli> fails to load the program, it will exit with an exit code of 1.
206 Otherwise, it will return the exit code of the program it executes.
208 =head1 SEE ALSO
210 L<llc|llc>
212 =head1 AUTHOR
214 Maintained by the LLVM Team (L<http://llvm.org>).
216 =cut