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