| Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | llvm-extract - extract a function from an LLVM module |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | B<llvm-extract> [I<options>] B<--func> I<function-name> [I<filename>] |
| 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
| 13 | The B<llvm-extract> command takes the name of a function and extracts it from |
| 14 | the specified LLVM bitcode file. It is primarily used as a debugging tool to |
| 15 | reduce test cases from larger programs that are triggering a bug. |
| 16 | |
| 17 | In addition to extracting the bitcode of the specified function, |
| 18 | B<llvm-extract> will also remove unreachable global variables, prototypes, and |
| 19 | unused types. |
| 20 | |
| 21 | The B<llvm-extract> command reads its input from standard input if filename is |
| 22 | omitted or if filename is -. The output is always written to standard output, |
| 23 | unless the B<-o> option is specified (see below). |
| 24 | |
| 25 | =head1 OPTIONS |
| 26 | |
| 27 | =over |
| 28 | |
| 29 | =item B<-f> |
| 30 | |
| Dan Gohman | 87489cf | 2009-08-25 15:54:01 +0000 | [diff] [blame] | 31 | Enable binary output on terminals. Normally, B<llvm-extract> will refuse to |
| 32 | write raw bitcode output if the output stream is a terminal. With this option, |
| 33 | B<llvm-extract> will write raw bitcode regardless of the output device. |
| Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 34 | |
| 35 | =item B<--func> I<function-name> |
| 36 | |
| Dan Gohman | 59aa5d4 | 2010-02-10 23:58:53 +0000 | [diff] [blame^] | 37 | Extract the function named I<function-name> from the LLVM bitcode. May be |
| 38 | specified multiple times to extract multiple functions at once. |
| 39 | |
| 40 | =item B<--glob> I<global-name> |
| 41 | |
| 42 | Extract the global variable named I<global-name> from the LLVM bitcode. May be |
| 43 | specified multiple times to extract multiple global variables at once. |
| Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 44 | |
| 45 | =item B<--help> |
| 46 | |
| 47 | Print a summary of command line options. |
| 48 | |
| 49 | =item B<-o> I<filename> |
| 50 | |
| 51 | Specify the output filename. If filename is "-" (the default), then |
| 52 | B<llvm-extract> sends its output to standard output. |
| 53 | |
| Dan Gohman | 31b20c7 | 2009-09-11 20:46:33 +0000 | [diff] [blame] | 54 | =item B<-S> |
| 55 | |
| 56 | Write output in LLVM intermediate language (instead of bitcode). |
| 57 | |
| Dan Gohman | f17a25c | 2007-07-18 16:29:46 +0000 | [diff] [blame] | 58 | =back |
| 59 | |
| 60 | =head1 EXIT STATUS |
| 61 | |
| 62 | If B<llvm-extract> succeeds, it will exit with 0. Otherwise, if an error |
| 63 | occurs, it will exit with a non-zero value. |
| 64 | |
| 65 | =head1 SEE ALSO |
| 66 | |
| 67 | L<bugpoint|bugpoint> |
| 68 | |
| 69 | =head1 AUTHORS |
| 70 | |
| 71 | Maintained by the LLVM Team (L<http://llvm.org>). |
| 72 | |
| 73 | =cut |