| Misha Brukman | 6998517 | 2004-07-01 15:25:04 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | analyze - LLVM program analyzer |
| 6 | |
| 7 | =head1 SYNOPSIS |
| 8 | |
| Misha Brukman | c08937a | 2004-07-02 16:06:19 +0000 | [diff] [blame] | 9 | B<analyze> [I<options>] [I<filename>] |
| Misha Brukman | 6998517 | 2004-07-01 15:25:04 +0000 | [diff] [blame] | 10 | |
| 11 | =head1 DESCRIPTION |
| 12 | |
| 13 | The B<analyze> command performs various analysis of LLVM assembly |
| 14 | code or bytecode. It will usually print the results on standard |
| 15 | output, but in a few cases, it will print output to standard error |
| 16 | or generate a file with the analysis output, which is usually done |
| 17 | when the output is meant for another program. |
| 18 | |
| 19 | If filename is omitted or is I<->, B<analyze> reads its input from |
| 20 | standard input. It first attempts to interpret its input as LLVM |
| 21 | bytecode. If it encounters an error, it then attempts to parse the |
| 22 | input as LLVM assembly language. |
| 23 | |
| 24 | =head1 OPTIONS |
| 25 | |
| 26 | =over |
| 27 | |
| 28 | =item B<-help> |
| 29 | |
| 30 | Print a summary of command line options. |
| 31 | |
| 32 | =item B<-q> |
| 33 | |
| 34 | Quiet mode. With this option, analysis pass names are not printed. |
| 35 | |
| 36 | =item B<-load> I<plugin> |
| 37 | |
| 38 | Load the specified dynamic object with name I<plugin>. This file |
| 39 | should contain additional analysis passes that register themselves |
| 40 | with the B<analyze> program after being loaded. |
| 41 | |
| 42 | After being loaded, additional command line options are made |
| 43 | available for running the passes made available by I<plugin>. Use |
| 44 | B<analyze -load> I<plugin> B<-help> to see the new list of available |
| 45 | analysis passes. |
| 46 | |
| 47 | =item B<-profile-info-file> I<filename> |
| 48 | |
| 49 | Specify the name of the file loaded by the -profile-loader option. |
| 50 | |
| 51 | =item B<-stats> |
| 52 | |
| 53 | Print statistics. |
| 54 | |
| 55 | =item B<-time-passes> |
| 56 | |
| 57 | Record the amount of time needed for each pass and print it to standard |
| 58 | error. |
| 59 | |
| 60 | =back |
| 61 | |
| 62 | =head1 EXIT STATUS |
| 63 | |
| 64 | If B<analyze> succeeds, it will exit with 0. Otherwise, if an error |
| 65 | occurs, it will exit with a non-zero value. |
| 66 | |
| 67 | =head1 SEE ALSO |
| 68 | |
| Misha Brukman | c08937a | 2004-07-02 16:06:19 +0000 | [diff] [blame] | 69 | L<opt|opt> |
| Misha Brukman | 6998517 | 2004-07-01 15:25:04 +0000 | [diff] [blame] | 70 | |
| 71 | =head1 AUTHORS |
| 72 | |
| Reid Spencer | cd143fc | 2006-03-14 05:42:07 +0000 | [diff] [blame] | 73 | Maintained by the LLVM Team (L<http://llvm.org>). |
| Misha Brukman | 6998517 | 2004-07-01 15:25:04 +0000 | [diff] [blame] | 74 | |
| 75 | =cut |