Appease compilers that have the -Wcovered-switch-default switch.
[llvm-core.git] / docs / CommandGuide / llc.rst
blob5094259f9f952775536709da9287306f691a1d54
1 llc - LLVM static compiler
2 ==========================
4 SYNOPSIS
5 --------
7 :program:`llc` [*options*] [*filename*]
9 DESCRIPTION
10 -----------
12 The :program:`llc` command compiles LLVM source inputs into assembly language
13 for a specified architecture.  The assembly language output can then be passed
14 through a native assembler and linker to generate a native executable.
16 The choice of architecture for the output assembly code is automatically
17 determined from the input file, unless the :option:`-march` option is used to
18 override the default.
20 OPTIONS
21 -------
23 If ``filename`` is "``-``" or omitted, :program:`llc` reads from standard input.
24 Otherwise, it will from ``filename``.  Inputs can be in either the LLVM assembly
25 language format (``.ll``) or the LLVM bitcode format (``.bc``).
27 If the :option:`-o` option is omitted, then :program:`llc` will send its output
28 to standard output if the input is from standard input.  If the :option:`-o`
29 option specifies "``-``", then the output will also be sent to standard output.
31 If no :option:`-o` option is specified and an input file other than "``-``" is
32 specified, then :program:`llc` creates the output filename by taking the input
33 filename, removing any existing ``.bc`` extension, and adding a ``.s`` suffix.
35 Other :program:`llc` options are described below.
37 End-user Options
38 ~~~~~~~~~~~~~~~~
40 .. option:: -help
42  Print a summary of command line options.
44 .. option:: -O=uint
46  Generate code at different optimization levels.  These correspond to the
47  ``-O0``, ``-O1``, ``-O2``, and ``-O3`` optimization levels used by
48  :program:`clang`.
50 .. option:: -mtriple=<target triple>
52  Override the target triple specified in the input file with the specified
53  string.
55 .. option:: -march=<arch>
57  Specify the architecture for which to generate assembly, overriding the target
58  encoded in the input file.  See the output of ``llc -help`` for a list of
59  valid architectures.  By default this is inferred from the target triple or
60  autodetected to the current architecture.
62 .. option:: -mcpu=<cpuname>
64  Specify a specific chip in the current architecture to generate code for.
65  By default this is inferred from the target triple and autodetected to
66  the current architecture.  For a list of available CPUs, use:
68  .. code-block:: none
70    llvm-as < /dev/null | llc -march=xyz -mcpu=help
72 .. option:: -filetype=<output file type>
74  Specify what kind of output ``llc`` should generated.  Options are: ``asm``
75  for textual assembly ( ``'.s'``), ``obj`` for native object files (``'.o'``)
76  and ``null`` for not emitting anything (for performance testing).
78  Note that not all targets support all options.
80 .. option:: -mattr=a1,+a2,-a3,...
82  Override or control specific attributes of the target, such as whether SIMD
83  operations are enabled or not.  The default set of attributes is set by the
84  current CPU.  For a list of available attributes, use:
86  .. code-block:: none
88    llvm-as < /dev/null | llc -march=xyz -mattr=help
90 .. option:: --disable-fp-elim
92  Disable frame pointer elimination optimization.
94 .. option:: --disable-excess-fp-precision
96  Disable optimizations that may produce excess precision for floating point.
97  Note that this option can dramatically slow down code on some systems
98  (e.g. X86).
100 .. option:: --enable-no-infs-fp-math
102  Enable optimizations that assume no Inf values.
104 .. option:: --enable-no-nans-fp-math
106  Enable optimizations that assume no NAN values.
108 .. option:: --enable-unsafe-fp-math
110  Enable optimizations that make unsafe assumptions about IEEE math (e.g. that
111  addition is associative) or may not work for all input ranges.  These
112  optimizations allow the code generator to make use of some instructions which
113  would otherwise not be usable (such as ``fsin`` on X86).
115 .. option:: --stats
117  Print statistics recorded by code-generation passes.
119 .. option:: --time-passes
121  Record the amount of time needed for each pass and print a report to standard
122  error.
124 .. option:: --load=<dso_path>
126  Dynamically load ``dso_path`` (a path to a dynamically shared object) that
127  implements an LLVM target.  This will permit the target name to be used with
128  the :option:`-march` option so that code can be generated for that target.
130 .. option:: -meabi=[default|gnu|4|5]
132  Specify which EABI version should conform to.  Valid EABI versions are *gnu*,
133  *4* and *5*.  Default value (*default*) depends on the triple.
136 Tuning/Configuration Options
137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139 .. option:: --print-machineinstrs
141  Print generated machine code between compilation phases (useful for debugging).
143 .. option:: --regalloc=<allocator>
145  Specify the register allocator to use.
146  Valid register allocators are:
148  *basic*
150   Basic register allocator.
152  *fast*
154   Fast register allocator. It is the default for unoptimized code.
156  *greedy*
158   Greedy register allocator. It is the default for optimized code.
160  *pbqp*
162   Register allocator based on 'Partitioned Boolean Quadratic Programming'.
164 .. option:: --spiller=<spiller>
166  Specify the spiller to use for register allocators that support it.  Currently
167  this option is used only by the linear scan register allocator.  The default
168  ``spiller`` is *local*.  Valid spillers are:
170  *simple*
172   Simple spiller
174  *local*
176   Local spiller
178 Intel IA-32-specific Options
179 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181 .. option:: --x86-asm-syntax=[att|intel]
183  Specify whether to emit assembly code in AT&T syntax (the default) or Intel
184  syntax.
186 EXIT STATUS
187 -----------
189 If :program:`llc` succeeds, it will exit with 0.  Otherwise, if an error
190 occurs, it will exit with a non-zero value.
192 SEE ALSO
193 --------