docs/CommandGuide/analyze.html

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