2f99df5163ffba2e5c280cb99e47ccda578b1003
[oota-llvm.git] / docs / CommandGuide / llvm-prof.html
1 <html>
2 <title>LLVM: llvm-prof tool</title>
3
4 <body bgcolor=white>
5
6 <center><h1>LLVM: <tt>llvm-prof</tt> tool</h1></center>
7 <HR>
8
9 <h3>NAME</h3>
10 <tt>llvm-prof</tt>
11
12 <h3>SYNOPSIS</h3>
13 <tt>llvm-prof [options] [bytecode file] [LLVM passes]</tt>
14
15 <h3>DESCRIPTION</h3>
16
17 The <tt>llvm-prof</tt> tool reads in an '<tt>llvmprof.out</tt>' file, a bytecode
18 file for the program, and produces a human readable report, suitable for
19 determining where the program hotspots are.<p>
20
21
22 <h3>OPTIONS</h3>
23
24 <ul>
25         <li><tt>-annotated-llvm</tt> or <tt>-A</tt><br>
26
27         In addition to the normal report printed, print out the code for the
28         program, annotated we execution frequency information. This can be
29         particularly useful when trying to visualize how frequently basic blocks
30         are executed.  This is most useful with basic block profiling
31         information or better.<p>
32 </ul>
33
34 <h3>EXIT STATUS</h3>
35
36 <tt>llvm-prof</tt> returns 1 if it cannot load the bytecode file or the profile
37 information, otherwise it exits with zero.
38
39 <HR>
40 Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
41 </body>
42 </html>