blob: 3ef9b2a400de65e24e928ca7755dc779308e911f [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001=pod
2
3=head1 NAME
4
5lli - directly execute programs from LLVM bitcode
6
7=head1 SYNOPSIS
8
9B<lli> [I<options>] [I<filename>] [I<program args>]
10
11=head1 DESCRIPTION
12
13B<lli> directly executes programs in LLVM bitcode format. It takes a program
14in LLVM bitcode format and executes it using a just-in-time compiler, if one is
15available for the current architecture, or an interpreter. B<lli> takes all of
16the same code generator options as L<llc|llc>, but they are only effective when
17B<lli> is using the just-in-time compiler.
18
19If I<filename> is not specified, then B<lli> reads the LLVM bitcode for the
20program from standard input.
21
22The optional I<args> specified on the command line are passed to the program as
23arguments.
24
Reid Spencer0d955612007-08-07 16:29:57 +000025=head1 GENERAL OPTIONS
Dan Gohmanf17a25c2007-07-18 16:29:46 +000026
27=over
28
Reid Spencer0d955612007-08-07 16:29:57 +000029=item B<-fake-argv0>=I<executable>
30
31Override the C<argv[0]> value passed into the executing program.
32
33=item B<-force-interpreter>=I<{false,true}>
34
35If set to true, use the interpreter even if a just-in-time compiler is available
36for this architecture. Defaults to false.
37
Dan Gohmanf17a25c2007-07-18 16:29:46 +000038=item B<-help>
39
40Print a summary of command line options.
41
Reid Spencer0d955612007-08-07 16:29:57 +000042=item B<-load>=I<puginfilename>
43
44Causes B<lli> to load the plugin (shared object) named I<pluginfilename> and use
45it for optimization.
46
Dan Gohmanf17a25c2007-07-18 16:29:46 +000047=item B<-stats>
48
49Print statistics from the code-generation passes. This is only meaningful for
50the just-in-time compiler, at present.
51
52=item B<-time-passes>
53
54Record the amount of time needed for each code-generation pass and print it to
55standard error.
56
Reid Spencer0d955612007-08-07 16:29:57 +000057=back
58
59=head1 TARGET OPTIONS
60
61=over
62
Dan Gohmanf17a25c2007-07-18 16:29:46 +000063=item B<-mtriple>=I<target triple>
64
65Override the target triple specified in the input bitcode file with the
66specified string. This may result in a crash if you pick an
67architecture which is not compatible with the current system.
68
69=item B<-march>=I<arch>
70
71Specify the architecture for which to generate assembly, overriding the target
72encoded in the bitcode file. See the output of B<llc --help> for a list of
73valid architectures. By default this is inferred from the target triple or
74autodetected to the current architecture.
75
76=item B<-mcpu>=I<cpuname>
77
78Specify a specific chip in the current architecture to generate code for.
79By default this is inferred from the target triple and autodetected to
80the current architecture. For a list of available CPUs, use:
81B<llvm-as E<lt> /dev/null | llc -march=xyz -mcpu=help>
82
83=item B<-mattr>=I<a1,+a2,-a3,...>
84
85Override or control specific attributes of the target, such as whether SIMD
86operations are enabled or not. The default set of attributes is set by the
87current CPU. For a list of available attributes, use:
88B<llvm-as E<lt> /dev/null | llc -march=xyz -mattr=help>
89
Reid Spencer0d955612007-08-07 16:29:57 +000090=back
Reid Spencer666dcb52007-08-07 16:11:57 +000091
Reid Spencer666dcb52007-08-07 16:11:57 +000092
Reid Spencer0d955612007-08-07 16:29:57 +000093=head1 FLOATING POINT OPTIONS
Dan Gohmanf17a25c2007-07-18 16:29:46 +000094
Reid Spencer0d955612007-08-07 16:29:57 +000095=over
Dan Gohmanf17a25c2007-07-18 16:29:46 +000096
Reid Spencer0d955612007-08-07 16:29:57 +000097=item B<-disable-excess-fp-precision>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000098
Reid Spencer0d955612007-08-07 16:29:57 +000099Disable optimizations that may increase floating point precision.
Reid Spencer666dcb52007-08-07 16:11:57 +0000100
Reid Spencer0d955612007-08-07 16:29:57 +0000101=item B<-enable-finite-only-fp-math>
Reid Spencer666dcb52007-08-07 16:11:57 +0000102
Reid Spencer0d955612007-08-07 16:29:57 +0000103Enable optimizations that assumes only finite floating point math. That is,
104there is no NAN or Inf values.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000105
Reid Spencer26817692007-08-07 16:21:52 +0000106=item B<-enable-unsafe-fp-math>
107
108Causes B<lli> to enable optimizations that may decrease floating point
109precision.
110
Reid Spencer0d955612007-08-07 16:29:57 +0000111=item B<-soft-float>
Reid Spencer98044742007-08-07 16:23:42 +0000112
Reid Spencer0d955612007-08-07 16:29:57 +0000113Causes B<lli> to generate software floating point library calls instead of
114equivalent hardware instructions.
Reid Spencer98044742007-08-07 16:23:42 +0000115
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000116=back
117
118=head1 EXIT STATUS
119
120If B<lli> fails to load the program, it will exit with an exit code of 1.
121Otherwise, it will return the exit code of the program it executes.
122
123=head1 SEE ALSO
124
125L<llc|llc>
126
127=head1 AUTHOR
128
129Maintained by the LLVM Team (L<http://llvm.org>).
130
131=cut