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