John Criswell | ecf32e5 | 2003-09-11 19:58:03 +0000 | [diff] [blame] | 1 | <html> |
| 2 | <title> |
Chris Lattner | ee43b69 | 2003-09-25 19:50:05 +0000 | [diff] [blame] | 3 | LLVM: analyze tool |
John Criswell | ecf32e5 | 2003-09-11 19:58:03 +0000 | [diff] [blame] | 4 | </title> |
| 5 | |
| 6 | <body> |
| 7 | |
| 8 | <center> |
Chris Lattner | ee43b69 | 2003-09-25 19:50:05 +0000 | [diff] [blame] | 9 | <h1>LLVM: analyze tool</h1> |
John Criswell | ecf32e5 | 2003-09-11 19:58:03 +0000 | [diff] [blame] | 10 | </center> |
| 11 | <HR> |
| 12 | |
| 13 | <h3> |
| 14 | NAME |
| 15 | </h3> |
| 16 | |
| 17 | analyze |
| 18 | |
| 19 | <h3> |
| 20 | SYNOPSIS |
| 21 | </h3> |
| 22 | |
John Criswell | fa4f181 | 2003-09-29 14:05:08 +0000 | [diff] [blame^] | 23 | analyze [options] [filename] |
John Criswell | ecf32e5 | 2003-09-11 19:58:03 +0000 | [diff] [blame] | 24 | <h3> |
| 25 | DESCRIPTION |
| 26 | </h3> |
| 27 | |
John Criswell | fa4f181 | 2003-09-29 14:05:08 +0000 | [diff] [blame^] | 28 | The analyze command performs various analysis of LLVM assembly code or |
| 29 | bytecode. It will usually print the results on standard output, but in a few |
| 30 | cases, it will print output to standard error or generate a file with the |
| 31 | analysis output (which is usually done when the output is meant for another |
| 32 | program). |
| 33 | <p> |
| 34 | If filename is omitted or is -, analyze reads its input from standard input. |
| 35 | It first attempts to interpret its input as LLVM bytecode. If it encounters an |
| 36 | error, it then attempts to parse the input as LLVM assembly language. |
John Criswell | ecf32e5 | 2003-09-11 19:58:03 +0000 | [diff] [blame] | 37 | <h3> |
| 38 | OPTIONS |
| 39 | </h3> |
| 40 | |
| 41 | <ul> |
| 42 | <li> -help |
| 43 | <br> |
| 44 | Print a summary of command line options. |
| 45 | <p> |
| 46 | |
| 47 | <li> -stats |
| 48 | <br> |
| 49 | Print statistics. |
| 50 | <p> |
| 51 | |
| 52 | <li> -time-passes |
| 53 | <br> |
| 54 | Record the amount of time needed for each pass and print it to standard |
| 55 | error. |
| 56 | <p> |
| 57 | |
| 58 | <li> -q |
| 59 | <br> |
| 60 | Quiet mode. With this option, analysis pass names are not printed. |
| 61 | <p> |
| 62 | |
| 63 | <li> -load <plugin.so> |
| 64 | <br> |
| 65 | Load the specified dynamic object with name plugin.so. This file |
| 66 | should contain additional analysis passes that register themselves with |
| 67 | the analyze program after being loaded. |
| 68 | <p> |
| 69 | After being loaded, additional command line options are made available |
Chris Lattner | 35f474a | 2003-09-17 15:00:45 +0000 | [diff] [blame] | 70 | for running the passes made available by plugin.so. Use '<tt>analyze |
| 71 | -load <plugin.so> -help</tt>' to see the new list of available |
| 72 | analysis passes. |
John Criswell | ecf32e5 | 2003-09-11 19:58:03 +0000 | [diff] [blame] | 73 | <p> |
| 74 | </ul> |
| 75 | |
| 76 | <h3> |
| 77 | EXIT STATUS |
| 78 | </h3> |
| 79 | |
| 80 | If analyze succeeds, it will exit with 0. Otherwise, if an error occurs, it |
| 81 | will exit with a non-zero value. |
| 82 | |
| 83 | <h3> |
| 84 | SEE ALSO |
| 85 | </h3> |
| 86 | opt |
| 87 | |
| 88 | <HR> |
John Criswell | 3200330 | 2003-09-11 20:23:52 +0000 | [diff] [blame] | 89 | <a href="http://llvm.cs.uiuc.edu">LLVM Team</a> |
John Criswell | ecf32e5 | 2003-09-11 19:58:03 +0000 | [diff] [blame] | 90 | </body> |
| 91 | </html> |
| 92 | |