2012-05-08 18:50:35 +02:00
|
|
|
lli - directly execute programs from LLVM bitcode
|
|
|
|
=================================================
|
|
|
|
|
[docs][tools] Add missing "program" tags to rst files
Sphinx allows for definitions of command-line options using
`.. option <name>` and references to those options via `:option:<name>`.
However, it looks like there is no scoping of these options by default,
meaning that links can end up pointing to incorrect documents. See for
example the llvm-mca document, which contains references to -o that,
prior to this patch, pointed to a different document. What's worse is
that these links appear to be non-deterministic in which one is picked
(on my machine, some references end up pointing to opt, whereas on the
live docs, they point to llvm-dwarfdump, for example).
The fix is to add the .. program <name> tag. This essentially namespaces
the options (definitions and references) to the named program, ensuring
that the links are kept correct.
Reviwed by: andreadb
Differential Revision: https://reviews.llvm.org/D63873
llvm-svn: 364538
2019-06-27 15:24:46 +02:00
|
|
|
.. program:: lli
|
|
|
|
|
2012-05-08 18:50:35 +02:00
|
|
|
SYNOPSIS
|
|
|
|
--------
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
:program:`lli` [*options*] [*filename*] [*program args*]
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
:program:`lli` directly executes programs in LLVM bitcode format. It takes a program
|
|
|
|
in LLVM bitcode format and executes it using a just-in-time compiler or an
|
|
|
|
interpreter.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
:program:`lli` is *not* an emulator. It will not execute IR of different architectures
|
|
|
|
and it can only interpret (or JIT-compile) for the host architecture.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
The JIT compiler takes the same arguments as other tools, like :program:`llc`,
|
|
|
|
but they don't necessarily work for the interpreter.
|
|
|
|
|
|
|
|
If `filename` is not specified, then :program:`lli` reads the LLVM bitcode for the
|
2012-05-08 18:50:35 +02:00
|
|
|
program from standard input.
|
|
|
|
|
|
|
|
The optional *args* specified on the command line are passed to the program as
|
|
|
|
arguments.
|
|
|
|
|
|
|
|
GENERAL OPTIONS
|
|
|
|
---------------
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -fake-argv0=executable
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Override the ``argv[0]`` value passed into the executing program.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -force-interpreter={false,true}
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
If set to true, use the interpreter even if a just-in-time compiler is available
|
|
|
|
for this architecture. Defaults to false.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -help
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Print a summary of command line options.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -load=pluginfilename
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
Causes :program:`lli` to load the plugin (shared object) named *pluginfilename* and use
|
2012-05-08 18:50:35 +02:00
|
|
|
it for optimization.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -stats
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Print statistics from the code-generation passes. This is only meaningful for
|
|
|
|
the just-in-time compiler, at present.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -time-passes
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Record the amount of time needed for each code-generation pass and print it to
|
|
|
|
standard error.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -version
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
Print out the version of :program:`lli` and exit without doing anything else.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
TARGET OPTIONS
|
|
|
|
--------------
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -mtriple=target triple
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Override the target triple specified in the input bitcode file with the
|
|
|
|
specified string. This may result in a crash if you pick an
|
|
|
|
architecture which is not compatible with the current system.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -march=arch
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Specify the architecture for which to generate assembly, overriding the target
|
|
|
|
encoded in the bitcode file. See the output of **llc -help** for a list of
|
|
|
|
valid architectures. By default this is inferred from the target triple or
|
|
|
|
autodetected to the current architecture.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -mcpu=cpuname
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Specify a specific chip in the current architecture to generate code for.
|
|
|
|
By default this is inferred from the target triple and autodetected to
|
|
|
|
the current architecture. For a list of available CPUs, use:
|
|
|
|
**llvm-as < /dev/null | llc -march=xyz -mcpu=help**
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -mattr=a1,+a2,-a3,...
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Override or control specific attributes of the target, such as whether SIMD
|
|
|
|
operations are enabled or not. The default set of attributes is set by the
|
|
|
|
current CPU. For a list of available attributes, use:
|
|
|
|
**llvm-as < /dev/null | llc -march=xyz -mattr=help**
|
|
|
|
|
|
|
|
FLOATING POINT OPTIONS
|
|
|
|
----------------------
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -disable-excess-fp-precision
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Disable optimizations that may increase floating point precision.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -enable-no-infs-fp-math
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Enable optimizations that assume no Inf values.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -enable-no-nans-fp-math
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Enable optimizations that assume no NAN values.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -enable-unsafe-fp-math
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
Causes :program:`lli` to enable optimizations that may decrease floating point
|
2012-05-08 18:50:35 +02:00
|
|
|
precision.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -soft-float
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
Causes :program:`lli` to generate software floating point library calls instead of
|
2012-05-08 18:50:35 +02:00
|
|
|
equivalent hardware instructions.
|
|
|
|
|
|
|
|
CODE GENERATION OPTIONS
|
|
|
|
-----------------------
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -code-model=model
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Choose the code model from:
|
|
|
|
|
2017-11-06 12:47:24 +01:00
|
|
|
.. code-block:: text
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
default: Target default code model
|
2018-08-22 13:31:39 +02:00
|
|
|
tiny: Tiny code model
|
2012-05-08 18:50:35 +02:00
|
|
|
small: Small code model
|
|
|
|
kernel: Kernel code model
|
|
|
|
medium: Medium code model
|
|
|
|
large: Large code model
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -disable-post-RA-scheduler
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Disable scheduling after register allocation.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -disable-spill-fusing
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Disable fusing of spill code into instructions.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -jit-enable-eh
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Exception handling should be enabled in the just-in-time compiler.
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -join-liveintervals
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Coalesce copies (default=true).
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -nozero-initialized-in-bss
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
Don't place zero-initialized symbols into the BSS section.
|
2012-05-08 18:50:35 +02:00
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -pre-RA-sched=scheduler
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Instruction schedulers available (before register allocation):
|
|
|
|
|
2017-11-06 12:47:24 +01:00
|
|
|
.. code-block:: text
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
=default: Best scheduler for the target
|
|
|
|
=none: No scheduling: breadth first sequencing
|
|
|
|
=simple: Simple two pass scheduling: minimize critical path and maximize processor utilization
|
|
|
|
=simple-noitin: Simple two pass scheduling: Same as simple except using generic latency
|
|
|
|
=list-burr: Bottom-up register reduction list scheduling
|
|
|
|
=list-tdrr: Top-down register reduction list scheduling
|
|
|
|
=list-td: Top-down list scheduler -print-machineinstrs - Print generated machine code
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -regalloc=allocator
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Register allocator to use (default=linearscan)
|
|
|
|
|
2017-11-06 12:47:24 +01:00
|
|
|
.. code-block:: text
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
=bigblock: Big-block register allocator
|
|
|
|
=linearscan: linear scan register allocator =local - local register allocator
|
|
|
|
=simple: simple register allocator
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -relocation-model=model
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Choose relocation model from:
|
|
|
|
|
2017-11-06 12:47:24 +01:00
|
|
|
.. code-block:: text
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
=default: Target default relocation model
|
|
|
|
=static: Non-relocatable code =pic - Fully relocatable, position independent code
|
|
|
|
=dynamic-no-pic: Relocatable external references, non-relocatable code
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -spiller
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Spiller to use (default=local)
|
|
|
|
|
2017-11-06 12:47:24 +01:00
|
|
|
.. code-block:: text
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
=simple: simple spiller
|
|
|
|
=local: local spiller
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
.. option:: -x86-asm-syntax=syntax
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
Choose style of code to emit from X86 backend:
|
|
|
|
|
2017-11-06 12:47:24 +01:00
|
|
|
.. code-block:: text
|
2012-05-08 18:50:35 +02:00
|
|
|
|
|
|
|
=att: Emit AT&T-style assembly
|
|
|
|
=intel: Emit Intel-style assembly
|
|
|
|
|
|
|
|
EXIT STATUS
|
|
|
|
-----------
|
|
|
|
|
2015-07-28 12:24:11 +02:00
|
|
|
If :program:`lli` fails to load the program, it will exit with an exit code of 1.
|
2012-05-08 18:50:35 +02:00
|
|
|
Otherwise, it will return the exit code of the program it executes.
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
--------
|
|
|
|
|
2019-07-04 23:19:05 +02:00
|
|
|
:manpage:`llc(1)`
|