| Brian Gaeke | 2668291 | 2004-07-01 20:07:15 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | llvm-abcd - bytecode file low-level dumper |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| 9 | llvm-abcd [options] [filename] |
| 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
| 13 | The B<llvm-abcd> command is a small utility for analyzing bytecode files. The |
| 14 | B<abcd> acronym stands for B<a>nalysis of B<b>yteB<c>ode B<d>isplayer. The tool |
| 15 | reads a bytecode file (such as generated with the B<llvm-as> tool) and produces |
| 16 | statistical and low level bytecode format dumps. This tool is probably not of |
| 17 | much interest or utility except for those working directly with the bytecode |
| 18 | format. Most LLVM users can just ignore this tool. |
| 19 | |
| 20 | If filename is omitted or is I<->, then B<llvm-abcd> reads its input from |
| 21 | standard input. This is useful for combining B<llvm-abcd> in a pipeline. |
| 22 | |
| 23 | =head1 OPTIONS |
| 24 | |
| 25 | =over |
| 26 | |
| 27 | =item B<--nodetails> |
| 28 | |
| 29 | Causes B<llvm-abcd> to abbreviate its output by writing out only a module level |
| 30 | summary. The details for individual functions are not displayed. |
| 31 | |
| 32 | =item B<--dump> |
| 33 | |
| 34 | Causes B<llvm-abcd> to dump the bytecode in a human readable format. This format |
| 35 | is significantly different from LLVM assembly and provides details about the |
| 36 | encoding of the bytecode file. |
| 37 | |
| 38 | =item B<--verify> |
| 39 | |
| 40 | Causes B<llvm-abcd> to verify the module produced by by reading the bytecode. |
| 41 | This ensures that the statistics generated are reliable. |
| 42 | |
| 43 | =item B<--help> |
| 44 | |
| 45 | Print a summary of command line options. |
| 46 | |
| 47 | =back |
| 48 | |
| 49 | =head1 EXIT STATUS |
| 50 | |
| 51 | If B<llvm-abcd> succeeds, it will exit with zero exit status. Otherwise, if an |
| 52 | error occurs, it will exit with a non-zero exit status, usually 1. |
| 53 | |
| 54 | =head1 SEE ALSO |
| 55 | |
| 56 | L<llvm-dis>, L<LLVM Bytecode File Format|../docs/BytecodeFormat.html> |
| 57 | |
| 58 | =head1 AUTHOR |
| 59 | |
| 60 | Maintained by L<rspencer@x10sys.com|Reid Spencer>. |
| 61 | |
| 62 | =cut |
| 63 | |