Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | llc - LLVM static compiler |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
Misha Brukman | c08937a | 2004-07-02 16:06:19 +0000 | [diff] [blame] | 9 | B<llc> [I<options>] [I<filename>] |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
Daniel Dunbar | 6db36f3 | 2009-09-15 20:31:28 +0000 | [diff] [blame] | 13 | The B<llc> command compiles LLVM source inputs into assembly language for a |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 14 | specified architecture. The assembly language output can then be passed through |
Chris Lattner | 1e6df2e | 2005-05-13 20:01:11 +0000 | [diff] [blame] | 15 | a native assembler and linker to generate a native executable. |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 16 | |
Chris Lattner | 1e6df2e | 2005-05-13 20:01:11 +0000 | [diff] [blame] | 17 | The choice of architecture for the output assembly code is automatically |
Daniel Dunbar | 6db36f3 | 2009-09-15 20:31:28 +0000 | [diff] [blame] | 18 | determined from the input file, unless the B<-march> option is used to override |
| 19 | the default. |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 20 | |
| 21 | =head1 OPTIONS |
| 22 | |
Daniel Dunbar | 6db36f3 | 2009-09-15 20:31:28 +0000 | [diff] [blame] | 23 | If I<filename> is - or omitted, B<llc> reads from standard input. Otherwise, it |
| 24 | will from I<filename>. Inputs can be in either the LLVM assembly language |
| 25 | format (.ll) or the LLVM bitcode format (.bc). |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 26 | |
| 27 | If the B<-o> option is omitted, then B<llc> will send its output to standard |
| 28 | output if the input is from standard input. If the B<-o> option specifies -, |
| 29 | then the output will also be sent to standard output. |
| 30 | |
| 31 | If no B<-o> option is specified and an input file other than - is specified, |
| 32 | then B<llc> creates the output filename by taking the input filename, |
| 33 | removing any existing F<.bc> extension, and adding a F<.s> suffix. |
| 34 | |
| 35 | Other B<llc> options are as follows: |
| 36 | |
Chris Lattner | 1e6df2e | 2005-05-13 20:01:11 +0000 | [diff] [blame] | 37 | =head2 End-user Options |
| 38 | |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 39 | =over |
| 40 | |
Duncan Sands | 7e7ae5a | 2010-02-18 14:08:13 +0000 | [diff] [blame] | 41 | =item B<-help> |
Chris Lattner | 1e6df2e | 2005-05-13 20:01:11 +0000 | [diff] [blame] | 42 | |
| 43 | Print a summary of command line options. |
| 44 | |
Bill Wendling | be8cc2a | 2009-04-29 00:15:41 +0000 | [diff] [blame] | 45 | =item B<-O>=I<uint> |
| 46 | |
| 47 | Generate code at different optimization levels. These correspond to the I<-O0>, |
| 48 | I<-O1>, I<-O2>, I<-O3>, and I<-O4> optimization levels used by B<llvm-gcc> and |
| 49 | B<clang>. |
| 50 | |
Chris Lattner | f495536 | 2005-12-16 05:19:35 +0000 | [diff] [blame] | 51 | =item B<-mtriple>=I<target triple> |
Chris Lattner | 4f501bf | 2005-12-16 05:18:53 +0000 | [diff] [blame] | 52 | |
Daniel Dunbar | 6db36f3 | 2009-09-15 20:31:28 +0000 | [diff] [blame] | 53 | Override the target triple specified in the input file with the specified |
| 54 | string. |
Chris Lattner | 4f501bf | 2005-12-16 05:18:53 +0000 | [diff] [blame] | 55 | |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 56 | =item B<-march>=I<arch> |
| 57 | |
Chris Lattner | 1e6df2e | 2005-05-13 20:01:11 +0000 | [diff] [blame] | 58 | Specify the architecture for which to generate assembly, overriding the target |
Duncan Sands | 7e7ae5a | 2010-02-18 14:08:13 +0000 | [diff] [blame] | 59 | encoded in the input file. See the output of B<llc -help> for a list of |
Chris Lattner | 4f501bf | 2005-12-16 05:18:53 +0000 | [diff] [blame] | 60 | valid architectures. By default this is inferred from the target triple or |
| 61 | autodetected to the current architecture. |
| 62 | |
| 63 | =item B<-mcpu>=I<cpuname> |
| 64 | |
| 65 | Specify a specific chip in the current architecture to generate code for. |
| 66 | By default this is inferred from the target triple and autodetected to |
| 67 | the current architecture. For a list of available CPUs, use: |
| 68 | B<llvm-as E<lt> /dev/null | llc -march=xyz -mcpu=help> |
| 69 | |
| 70 | =item B<-mattr>=I<a1,+a2,-a3,...> |
| 71 | |
| 72 | Override or control specific attributes of the target, such as whether SIMD |
| 73 | operations are enabled or not. The default set of attributes is set by the |
| 74 | current CPU. For a list of available attributes, use: |
| 75 | B<llvm-as E<lt> /dev/null | llc -march=xyz -mattr=help> |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 76 | |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 77 | =item B<--disable-fp-elim> |
| 78 | |
| 79 | Disable frame pointer elimination optimization. |
| 80 | |
Chris Lattner | 1e6df2e | 2005-05-13 20:01:11 +0000 | [diff] [blame] | 81 | =item B<--disable-excess-fp-precision> |
| 82 | |
| 83 | Disable optimizations that may produce excess precision for floating point. |
| 84 | Note that this option can dramatically slow down code on some systems |
| 85 | (e.g. X86). |
| 86 | |
| 87 | =item B<--enable-unsafe-fp-math> |
| 88 | |
| 89 | Enable optimizations that make unsafe assumptions about IEEE math (e.g. that |
| 90 | addition is associative) or may not work for all input ranges. These |
| 91 | optimizations allow the code generator to make use of some instructions which |
| 92 | would otherwise not be usable (such as fsin on X86). |
| 93 | |
Chris Lattner | 0c123df | 2004-12-09 21:16:40 +0000 | [diff] [blame] | 94 | =item B<--enable-correct-eh-support> |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 95 | |
Chris Lattner | 0c123df | 2004-12-09 21:16:40 +0000 | [diff] [blame] | 96 | Instruct the B<lowerinvoke> pass to insert code for correct exception handling |
| 97 | support. This is expensive and is by default omitted for efficiency. |
| 98 | |
Chris Lattner | 0c123df | 2004-12-09 21:16:40 +0000 | [diff] [blame] | 99 | =item B<--stats> |
| 100 | |
| 101 | Print statistics recorded by code-generation passes. |
| 102 | |
| 103 | =item B<--time-passes> |
| 104 | |
| 105 | Record the amount of time needed for each pass and print a report to standard |
| 106 | error. |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 107 | |
Chris Lattner | 1e6df2e | 2005-05-13 20:01:11 +0000 | [diff] [blame] | 108 | =item B<--load>=F<dso_path> |
| 109 | |
| 110 | Dynamically load F<dso_path> (a path to a dynamically shared object) that |
| 111 | implements an LLVM target. This will permit the target name to be used with the |
| 112 | B<-march> option so that code can be generated for that target. |
| 113 | |
| 114 | =back |
| 115 | |
| 116 | =head2 Tuning/Configuration Options |
| 117 | |
| 118 | =over |
| 119 | |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 120 | =item B<--print-machineinstrs> |
| 121 | |
Chris Lattner | 0c123df | 2004-12-09 21:16:40 +0000 | [diff] [blame] | 122 | Print generated machine code between compilation phases (useful for debugging). |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 123 | |
| 124 | =item B<--regalloc>=I<allocator> |
| 125 | |
| 126 | Specify the register allocator to use. The default I<allocator> is I<local>. |
| 127 | Valid register allocators are: |
| 128 | |
| 129 | =over |
| 130 | |
| 131 | =item I<simple> |
| 132 | |
| 133 | Very simple "always spill" register allocator |
| 134 | |
| 135 | =item I<local> |
| 136 | |
| 137 | Local register allocator |
| 138 | |
| 139 | =item I<linearscan> |
| 140 | |
Alkis Evlogimenos | c8dec2c | 2004-07-21 08:18:50 +0000 | [diff] [blame] | 141 | Linear scan global register allocator |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 142 | |
Misha Brukman | 1e635c3 | 2004-07-21 12:53:14 +0000 | [diff] [blame] | 143 | =item I<iterativescan> |
Alkis Evlogimenos | 910d0d6 | 2004-07-21 08:24:35 +0000 | [diff] [blame] | 144 | |
| 145 | Iterative scan global register allocator |
| 146 | |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 147 | =back |
| 148 | |
| 149 | =item B<--spiller>=I<spiller> |
| 150 | |
| 151 | Specify the spiller to use for register allocators that support it. Currently |
| 152 | this option is used only by the linear scan register allocator. The default |
| 153 | I<spiller> is I<local>. Valid spillers are: |
| 154 | |
| 155 | =over |
| 156 | |
| 157 | =item I<simple> |
| 158 | |
| 159 | Simple spiller |
| 160 | |
| 161 | =item I<local> |
| 162 | |
| 163 | Local spiller |
| 164 | |
| 165 | =back |
| 166 | |
| 167 | =back |
| 168 | |
Chris Lattner | 0c123df | 2004-12-09 21:16:40 +0000 | [diff] [blame] | 169 | =head2 Intel IA-32-specific Options |
| 170 | |
| 171 | =over |
| 172 | |
| 173 | =item B<--x86-asm-syntax=att|intel> |
| 174 | |
| 175 | Specify whether to emit assembly code in AT&T syntax (the default) or intel |
| 176 | syntax. |
| 177 | |
| 178 | =back |
| 179 | |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 180 | =head1 EXIT STATUS |
| 181 | |
| 182 | If B<llc> succeeds, it will exit with 0. Otherwise, if an error occurs, |
| 183 | it will exit with a non-zero value. |
| 184 | |
| 185 | =head1 SEE ALSO |
| 186 | |
Misha Brukman | c08937a | 2004-07-02 16:06:19 +0000 | [diff] [blame] | 187 | L<lli|lli> |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 188 | |
| 189 | =head1 AUTHORS |
| 190 | |
Reid Spencer | cd143fc | 2006-03-14 05:42:07 +0000 | [diff] [blame] | 191 | Maintained by the LLVM Team (L<http://llvm.org>). |
Brian Gaeke | e993d20 | 2004-05-14 19:50:33 +0000 | [diff] [blame] | 192 | |
| 193 | =cut |