aboutsummaryrefslogtreecommitdiff
path: root/docs/CommandGuide/llvm-prof.html
diff options
context:
space:
mode:
authorChris Lattner <sabre@nondot.org>2003-11-02 02:10:54 +0000
committerChris Lattner <sabre@nondot.org>2003-11-02 02:10:54 +0000
commite66e73aee5ce61fdd6cd6214224ca5bde8ab23e4 (patch)
tree10fe917465f82d5dc2ee46636faec9834ca19143 /docs/CommandGuide/llvm-prof.html
parentd6d0d8c18d64c5f212cd6c2b42b9bcde5acebf72 (diff)
Checkin an initial version of the llvm-prof documentation
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@9649 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide/llvm-prof.html')
-rw-r--r--docs/CommandGuide/llvm-prof.html42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/CommandGuide/llvm-prof.html b/docs/CommandGuide/llvm-prof.html
new file mode 100644
index 0000000000..2f99df5163
--- /dev/null
+++ b/docs/CommandGuide/llvm-prof.html
@@ -0,0 +1,42 @@
+<html>
+<title>LLVM: llvm-prof tool</title>
+
+<body bgcolor=white>
+
+<center><h1>LLVM: <tt>llvm-prof</tt> tool</h1></center>
+<HR>
+
+<h3>NAME</h3>
+<tt>llvm-prof</tt>
+
+<h3>SYNOPSIS</h3>
+<tt>llvm-prof [options] [bytecode file] [LLVM passes]</tt>
+
+<h3>DESCRIPTION</h3>
+
+The <tt>llvm-prof</tt> tool reads in an '<tt>llvmprof.out</tt>' file, a bytecode
+file for the program, and produces a human readable report, suitable for
+determining where the program hotspots are.<p>
+
+
+<h3>OPTIONS</h3>
+
+<ul>
+ <li><tt>-annotated-llvm</tt> or <tt>-A</tt><br>
+
+ In addition to the normal report printed, print out the code for the
+ program, annotated we execution frequency information. This can be
+ particularly useful when trying to visualize how frequently basic blocks
+ are executed. This is most useful with basic block profiling
+ information or better.<p>
+</ul>
+
+<h3>EXIT STATUS</h3>
+
+<tt>llvm-prof</tt> returns 1 if it cannot load the bytecode file or the profile
+information, otherwise it exits with zero.
+
+<HR>
+Maintained by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a>.
+</body>
+</html>