blob: 9d73e8678e03eb3d5b23449f24fbd16300343825 [file] [log] [blame]
John Criswell408128d2003-09-11 19:58:03 +00001<html>
2<title>
Chris Lattner29793072003-09-25 19:50:05 +00003LLVM: analyze tool
John Criswell408128d2003-09-11 19:58:03 +00004</title>
5
Chris Lattner7c2b1262003-10-07 20:12:05 +00006<body bgcolor=white>
John Criswell408128d2003-09-11 19:58:03 +00007
8<center>
Chris Lattner29793072003-09-25 19:50:05 +00009<h1>LLVM: analyze tool</h1>
John Criswell408128d2003-09-11 19:58:03 +000010</center>
11<HR>
12
13<h3>
14NAME
15</h3>
16
17analyze
18
19<h3>
20SYNOPSIS
21</h3>
22
John Criswell1cab4fb2003-09-29 14:05:08 +000023analyze [options] [filename]
John Criswell408128d2003-09-11 19:58:03 +000024<h3>
25DESCRIPTION
26</h3>
27
John Criswell1cab4fb2003-09-29 14:05:08 +000028The analyze command performs various analysis of LLVM assembly code or
29bytecode. It will usually print the results on standard output, but in a few
30cases, it will print output to standard error or generate a file with the
31analysis output (which is usually done when the output is meant for another
32program).
33<p>
34If filename is omitted or is -, analyze reads its input from standard input.
35It first attempts to interpret its input as LLVM bytecode. If it encounters an
36error, it then attempts to parse the input as LLVM assembly language.
John Criswell408128d2003-09-11 19:58:03 +000037<h3>
38OPTIONS
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 &lt;plugin.so&gt;
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 Lattner457a95b2003-09-17 15:00:45 +000070 for running the passes made available by plugin.so. Use '<tt>analyze
71 -load &lt;plugin.so&gt; -help</tt>' to see the new list of available
72 analysis passes.
John Criswell408128d2003-09-11 19:58:03 +000073 <p>
74</ul>
75
76<h3>
77EXIT STATUS
78</h3>
79
80If analyze succeeds, it will exit with 0. Otherwise, if an error occurs, it
81will exit with a non-zero value.
82
83<h3>
84SEE ALSO
85</h3>
86opt
87
88<HR>
Chris Lattner7c2b1262003-10-07 20:12:05 +000089Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
John Criswell408128d2003-09-11 19:58:03 +000090</body>
91</html>
92