From e66e73aee5ce61fdd6cd6214224ca5bde8ab23e4 Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Sun, 2 Nov 2003 02:10:54 +0000 Subject: [PATCH] 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 --- docs/CommandGuide/index.html | 25 +++++++++++-------- docs/CommandGuide/llvm-prof.html | 42 ++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 10 deletions(-) create mode 100644 docs/CommandGuide/llvm-prof.html diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html index 9a13f1258e3..a12bfd25e7a 100644 --- a/docs/CommandGuide/index.html +++ b/docs/CommandGuide/index.html @@ -30,11 +30,6 @@ are. Disassemble an LLVM bytecode file into human-readable form.

llvm-nm -

- Print out the names and types of symbols in an LLVM bytecode file. -

analyze

Analyze an LLVM bytecode file. @@ -45,20 +40,30 @@ are. Optimize an LLVM bytecode file.

llc +

+ Compile an LLVM bytecode program into native machine code. + +

lli +

+ Run an LLVM bytecode program using either an interpreter or a + JIT compiler. +

llvm-link

Link several LLVM bytecode files together into one LLVM bytecode file.

llc +

llvm-nm

- Compile an LLVM bytecode program into native machine code. + Print out the names and types of symbols in an LLVM bytecode file. +

lli +

llvm-prof

- Run an LLVM bytecode program using either an interpreter or a - JIT compiler. + Transform raw 'llvmprof.out' data into a human readable report.

diff --git a/docs/CommandGuide/llvm-prof.html b/docs/CommandGuide/llvm-prof.html new file mode 100644 index 00000000000..2f99df5163f --- /dev/null +++ b/docs/CommandGuide/llvm-prof.html @@ -0,0 +1,42 @@ + +LLVM: llvm-prof tool + + + +

LLVM: `llvm-prof` tool

+ +

NAME

+llvm-prof + +

SYNOPSIS

+llvm-prof [options] [bytecode file] [LLVM passes] + +

DESCRIPTION

+ +The llvm-prof tool reads in an 'llvmprof.out' file, a bytecode +file for the program, and produces a human readable report, suitable for +determining where the program hotspots are.

+ + +

OPTIONS

+ +

-annotated-llvm or -A
+ + 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.
+

+ +

EXIT STATUS

+ +llvm-prof returns 1 if it cannot load the bytecode file or the profile +information, otherwise it exits with zero. + +

+Maintained by the LLVM Team. + + -- 2.34.1