| Reid Spencer | 1cf0e32 | 2004-07-02 03:44:14 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | llvm-bcanalyzer - LLVM bytecode analyzer |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| Misha Brukman | c08937a | 2004-07-02 16:06:19 +0000 | [diff] [blame] | 9 | B<llvm-bcanalyzer> [I<options>] [I<filename>] |
| Reid Spencer | 1cf0e32 | 2004-07-02 03:44:14 +0000 | [diff] [blame] | 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
| 13 | The B<llvm-bcanalyzer> command is a small utility for analyzing bytecode files. |
| 14 | The tool reads a bytecode file (such as generated with the B<llvm-as> tool) and |
| 15 | produces a statistical report on the contents of the byteocde file. The tool |
| 16 | will also dump a low level but human readable version of the bytecode file. |
| 17 | This tool is probably not of much interest or utility except for those working |
| 18 | directly with the bytecode file format. Most LLVM users can just ignore |
| 19 | this tool. |
| 20 | |
| 21 | If F<filename> is omitted or is C<->, then B<llvm-bcanalyzer> reads its input |
| 22 | from standard input. This is useful for combining the tool into a pipeline. |
| 23 | |
| 24 | Output is written to the standard output. |
| 25 | |
| 26 | =head1 OPTIONS |
| 27 | |
| 28 | =over |
| 29 | |
| 30 | =item B<-nodetails> |
| 31 | |
| 32 | Causes B<llvm-bcanalyzer> to abbreviate its output by writing out only a module |
| 33 | level summary. The details for individual functions are not displayed. |
| 34 | |
| 35 | =item B<-dump> |
| 36 | |
| 37 | Causes B<llvm-bcanalyzer> to dump the bytecode in a human readable format. This |
| 38 | format is significantly different from LLVM assembly and provides details about |
| 39 | the encoding of the bytecode file. |
| 40 | |
| 41 | =item B<-verify> |
| 42 | |
| 43 | Causes B<llvm-bcanalyzer> to verify the module produced by by reading the |
| 44 | bytecode. This ensures that the statistics generated are based on a consistent |
| 45 | module. |
| 46 | |
| 47 | =item B<--help> |
| 48 | |
| 49 | Print a summary of command line options. |
| 50 | |
| 51 | =back |
| 52 | |
| 53 | =head1 EXIT STATUS |
| 54 | |
| 55 | If B<llvm-bcanalyzer> succeeds, it will exit with 0. Otherwise, if an error |
| 56 | occurs, it will exit with a non-zero value, usually 1. |
| 57 | |
| 58 | =head1 SEE ALSO |
| 59 | |
| Misha Brukman | c08937a | 2004-07-02 16:06:19 +0000 | [diff] [blame] | 60 | L<llvm-dis|llvm-dis>, L<http://llvm.cs.uiuc.edu/docs/BytecodeFormat.html> |
| Reid Spencer | 1cf0e32 | 2004-07-02 03:44:14 +0000 | [diff] [blame] | 61 | |
| 62 | =head1 AUTHORS |
| 63 | |
| 64 | Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>). |
| 65 | |
| 66 | =cut |