diff options
Diffstat (limited to 'usr.bin/clang/llvm-prof/llvm-prof.1')
| -rw-r--r-- | usr.bin/clang/llvm-prof/llvm-prof.1 | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/usr.bin/clang/llvm-prof/llvm-prof.1 b/usr.bin/clang/llvm-prof/llvm-prof.1 new file mode 100644 index 0000000..fd34cd7 --- /dev/null +++ b/usr.bin/clang/llvm-prof/llvm-prof.1 @@ -0,0 +1,86 @@ +.\" $FreeBSD$ +.TH "LLVM-PROF" "1" "2012-08-16" "3.2" "LLVM" +.SH NAME +llvm-prof \- print execution profile of LLVM program +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.\" Man page generated from reStructuredText. +. +.SH SYNOPSIS +.sp +\fBllvm\-prof\fP [\fIoptions\fP] [\fIbitcode file\fP] [\fIllvmprof.out\fP] +.SH DESCRIPTION +.sp +The \fBllvm\-prof\fP tool reads in an \fIllvmprof.out\fP file (which can +optionally use a specific file with the third program argument), a bitcode file +for the program, and produces a human readable report, suitable for determining +where the program hotspots are. +.sp +This program is often used in conjunction with the \fIutils/profile.pl\fP +script. This script automatically instruments a program, runs it with the JIT, +then runs \fBllvm\-prof\fP to format a report. To get more information about +\fIutils/profile.pl\fP, execute it with the \fB\-help\fP option. +.SH OPTIONS +.sp +\fB\-\-annotated\-llvm\fP or \fB\-A\fP +.INDENT 0.0 +.INDENT 3.5 +In addition to the normal report printed, print out the code for the +program, annotated with 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. +.UNINDENT +.UNINDENT +.sp +\fB\-\-print\-all\-code\fP +.INDENT 0.0 +.INDENT 3.5 +Using this option enables the \fB\-\-annotated\-llvm\fP option, but it +prints the entire module, instead of just the most commonly executed +functions. +.UNINDENT +.UNINDENT +.sp +\fB\-\-time\-passes\fP +.INDENT 0.0 +.INDENT 3.5 +Record the amount of time needed for each pass and print it to standard +error. +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBllvm\-prof\fP returns 1 if it cannot load the bitcode file or the profile +information. Otherwise, it exits with zero. +.SH AUTHOR +Maintained by The LLVM Team (http://llvm.org/). +.SH COPYRIGHT +2012, LLVM Project +.\" Generated by docutils manpage writer. +. |
