blob: 1132ac3e6be8aa1cce002d4ad65b87728b7ffc96 [file] [log] [blame]
Daniel Dunbar3b709d52012-05-08 16:50:35 +00001lli - directly execute programs from LLVM bitcode
2=================================================
3
Daniel Dunbar3b709d52012-05-08 16:50:35 +00004SYNOPSIS
5--------
6
Renato Golind6254522015-07-28 10:24:11 +00007:program:`lli` [*options*] [*filename*] [*program args*]
Daniel Dunbar3b709d52012-05-08 16:50:35 +00008
9DESCRIPTION
10-----------
11
Renato Golind6254522015-07-28 10:24:11 +000012:program:`lli` directly executes programs in LLVM bitcode format. It takes a program
13in LLVM bitcode format and executes it using a just-in-time compiler or an
14interpreter.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000015
Renato Golind6254522015-07-28 10:24:11 +000016:program:`lli` is *not* an emulator. It will not execute IR of different architectures
17and it can only interpret (or JIT-compile) for the host architecture.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000018
Renato Golind6254522015-07-28 10:24:11 +000019The JIT compiler takes the same arguments as other tools, like :program:`llc`,
20but they don't necessarily work for the interpreter.
21
22If `filename` is not specified, then :program:`lli` reads the LLVM bitcode for the
Daniel Dunbar3b709d52012-05-08 16:50:35 +000023program from standard input.
24
25The optional *args* specified on the command line are passed to the program as
26arguments.
27
Daniel Dunbar3b709d52012-05-08 16:50:35 +000028GENERAL OPTIONS
29---------------
30
Renato Golind6254522015-07-28 10:24:11 +000031.. option:: -fake-argv0=executable
Daniel Dunbar3b709d52012-05-08 16:50:35 +000032
33 Override the ``argv[0]`` value passed into the executing program.
34
Renato Golind6254522015-07-28 10:24:11 +000035.. option:: -force-interpreter={false,true}
Daniel Dunbar3b709d52012-05-08 16:50:35 +000036
37 If set to true, use the interpreter even if a just-in-time compiler is available
38 for this architecture. Defaults to false.
39
Renato Golind6254522015-07-28 10:24:11 +000040.. option:: -help
Daniel Dunbar3b709d52012-05-08 16:50:35 +000041
42 Print a summary of command line options.
43
Renato Golind6254522015-07-28 10:24:11 +000044.. option:: -load=pluginfilename
Daniel Dunbar3b709d52012-05-08 16:50:35 +000045
Renato Golind6254522015-07-28 10:24:11 +000046 Causes :program:`lli` to load the plugin (shared object) named *pluginfilename* and use
Daniel Dunbar3b709d52012-05-08 16:50:35 +000047 it for optimization.
48
Renato Golind6254522015-07-28 10:24:11 +000049.. option:: -stats
Daniel Dunbar3b709d52012-05-08 16:50:35 +000050
51 Print statistics from the code-generation passes. This is only meaningful for
52 the just-in-time compiler, at present.
53
Renato Golind6254522015-07-28 10:24:11 +000054.. option:: -time-passes
Daniel Dunbar3b709d52012-05-08 16:50:35 +000055
56 Record the amount of time needed for each code-generation pass and print it to
57 standard error.
58
Renato Golind6254522015-07-28 10:24:11 +000059.. option:: -version
Daniel Dunbar3b709d52012-05-08 16:50:35 +000060
Renato Golind6254522015-07-28 10:24:11 +000061 Print out the version of :program:`lli` and exit without doing anything else.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000062
63TARGET OPTIONS
64--------------
65
Renato Golind6254522015-07-28 10:24:11 +000066.. option:: -mtriple=target triple
Daniel Dunbar3b709d52012-05-08 16:50:35 +000067
68 Override the target triple specified in the input bitcode file with the
69 specified string. This may result in a crash if you pick an
70 architecture which is not compatible with the current system.
71
Renato Golind6254522015-07-28 10:24:11 +000072.. option:: -march=arch
Daniel Dunbar3b709d52012-05-08 16:50:35 +000073
74 Specify the architecture for which to generate assembly, overriding the target
75 encoded in the bitcode file. See the output of **llc -help** for a list of
76 valid architectures. By default this is inferred from the target triple or
77 autodetected to the current architecture.
78
Renato Golind6254522015-07-28 10:24:11 +000079.. option:: -mcpu=cpuname
Daniel Dunbar3b709d52012-05-08 16:50:35 +000080
81 Specify a specific chip in the current architecture to generate code for.
82 By default this is inferred from the target triple and autodetected to
83 the current architecture. For a list of available CPUs, use:
84 **llvm-as < /dev/null | llc -march=xyz -mcpu=help**
85
Renato Golind6254522015-07-28 10:24:11 +000086.. option:: -mattr=a1,+a2,-a3,...
Daniel Dunbar3b709d52012-05-08 16:50:35 +000087
88 Override or control specific attributes of the target, such as whether SIMD
89 operations are enabled or not. The default set of attributes is set by the
90 current CPU. For a list of available attributes, use:
91 **llvm-as < /dev/null | llc -march=xyz -mattr=help**
92
Daniel Dunbar3b709d52012-05-08 16:50:35 +000093FLOATING POINT OPTIONS
94----------------------
95
Renato Golind6254522015-07-28 10:24:11 +000096.. option:: -disable-excess-fp-precision
Daniel Dunbar3b709d52012-05-08 16:50:35 +000097
98 Disable optimizations that may increase floating point precision.
99
Renato Golind6254522015-07-28 10:24:11 +0000100.. option:: -enable-no-infs-fp-math
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000101
102 Enable optimizations that assume no Inf values.
103
Renato Golind6254522015-07-28 10:24:11 +0000104.. option:: -enable-no-nans-fp-math
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000105
106 Enable optimizations that assume no NAN values.
107
Renato Golind6254522015-07-28 10:24:11 +0000108.. option:: -enable-unsafe-fp-math
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000109
Renato Golind6254522015-07-28 10:24:11 +0000110 Causes :program:`lli` to enable optimizations that may decrease floating point
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000111 precision.
112
Renato Golind6254522015-07-28 10:24:11 +0000113.. option:: -soft-float
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000114
Renato Golind6254522015-07-28 10:24:11 +0000115 Causes :program:`lli` to generate software floating point library calls instead of
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000116 equivalent hardware instructions.
117
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000118CODE GENERATION OPTIONS
119-----------------------
120
Renato Golind6254522015-07-28 10:24:11 +0000121.. option:: -code-model=model
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000122
123 Choose the code model from:
124
Jonas Devlieghere2b2534c2017-11-06 11:47:24 +0000125 .. code-block:: text
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000126
127 default: Target default code model
David Green3d765ce2018-08-22 11:31:39 +0000128 tiny: Tiny code model
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000129 small: Small code model
130 kernel: Kernel code model
131 medium: Medium code model
132 large: Large code model
133
Renato Golind6254522015-07-28 10:24:11 +0000134.. option:: -disable-post-RA-scheduler
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000135
136 Disable scheduling after register allocation.
137
Renato Golind6254522015-07-28 10:24:11 +0000138.. option:: -disable-spill-fusing
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000139
140 Disable fusing of spill code into instructions.
141
Renato Golind6254522015-07-28 10:24:11 +0000142.. option:: -jit-enable-eh
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000143
144 Exception handling should be enabled in the just-in-time compiler.
145
Renato Golind6254522015-07-28 10:24:11 +0000146.. option:: -join-liveintervals
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000147
148 Coalesce copies (default=true).
149
Renato Golind6254522015-07-28 10:24:11 +0000150.. option:: -nozero-initialized-in-bss
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000151
Renato Golind6254522015-07-28 10:24:11 +0000152 Don't place zero-initialized symbols into the BSS section.
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000153
Renato Golind6254522015-07-28 10:24:11 +0000154.. option:: -pre-RA-sched=scheduler
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000155
156 Instruction schedulers available (before register allocation):
157
Jonas Devlieghere2b2534c2017-11-06 11:47:24 +0000158 .. code-block:: text
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000159
160 =default: Best scheduler for the target
161 =none: No scheduling: breadth first sequencing
162 =simple: Simple two pass scheduling: minimize critical path and maximize processor utilization
163 =simple-noitin: Simple two pass scheduling: Same as simple except using generic latency
164 =list-burr: Bottom-up register reduction list scheduling
165 =list-tdrr: Top-down register reduction list scheduling
166 =list-td: Top-down list scheduler -print-machineinstrs - Print generated machine code
167
Renato Golind6254522015-07-28 10:24:11 +0000168.. option:: -regalloc=allocator
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000169
170 Register allocator to use (default=linearscan)
171
Jonas Devlieghere2b2534c2017-11-06 11:47:24 +0000172 .. code-block:: text
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000173
174 =bigblock: Big-block register allocator
175 =linearscan: linear scan register allocator =local - local register allocator
176 =simple: simple register allocator
177
Renato Golind6254522015-07-28 10:24:11 +0000178.. option:: -relocation-model=model
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000179
180 Choose relocation model from:
181
Jonas Devlieghere2b2534c2017-11-06 11:47:24 +0000182 .. code-block:: text
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000183
184 =default: Target default relocation model
185 =static: Non-relocatable code =pic - Fully relocatable, position independent code
186 =dynamic-no-pic: Relocatable external references, non-relocatable code
187
Renato Golind6254522015-07-28 10:24:11 +0000188.. option:: -spiller
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000189
190 Spiller to use (default=local)
191
Jonas Devlieghere2b2534c2017-11-06 11:47:24 +0000192 .. code-block:: text
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000193
194 =simple: simple spiller
195 =local: local spiller
196
Renato Golind6254522015-07-28 10:24:11 +0000197.. option:: -x86-asm-syntax=syntax
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000198
199 Choose style of code to emit from X86 backend:
200
Jonas Devlieghere2b2534c2017-11-06 11:47:24 +0000201 .. code-block:: text
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000202
203 =att: Emit AT&T-style assembly
204 =intel: Emit Intel-style assembly
205
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000206EXIT STATUS
207-----------
208
Renato Golind6254522015-07-28 10:24:11 +0000209If :program:`lli` fails to load the program, it will exit with an exit code of 1.
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000210Otherwise, it will return the exit code of the program it executes.
211
Daniel Dunbar3b709d52012-05-08 16:50:35 +0000212SEE ALSO
213--------
214
Renato Golind6254522015-07-28 10:24:11 +0000215:program:`llc`