'\" t
.\"     Title: perf-annotate
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\"      Date: 2019-12-05
.\"    Manual: perf Manual
.\"    Source: perf
.\"  Language: English
.\"
.TH "PERF_5.4\-ANNOTATE" "1" "2019-12-05" "perf" "perf Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
perf\-annotate \- Read perf.data (created by perf record) and display annotated code
.SH "SYNOPSIS"
.sp
.sp
.nf
\fIperf annotate\fP [\-i <file> | \-\-input=file] [symbol_name]
.fi
.br
.SH "DESCRIPTION"
.sp
This command reads the input file and displays an annotated version of the
code. If the object file has debug symbols then the source code will be
displayed alongside assembly code.
.sp
If there is no debug info in the object, then annotated assembly is displayed.
.SH "OPTIONS"
.sp
\-i, \-\-input=<file>
.RS 4
Input file name. (default: perf.data unless stdin is a fifo)
.RE
.sp
\-d, \-\-dsos=<dso[,dso...]>
.RS 4
Only consider symbols in these dsos.
.RE
.sp
\-s, \-\-symbol=<symbol>
.RS 4
Symbol to annotate.
.RE
.sp
\-f, \-\-force
.RS 4
Don\(cqt do ownership validation.
.RE
.sp
\-v, \-\-verbose
.RS 4
Be more verbose. (Show symbol address, etc)
.RE
.sp
\-q, \-\-quiet
.RS 4
Do not show any message.  (Suppress \-v)
.RE
.sp
\-n, \-\-show\-nr\-samples
.RS 4
Show the number of samples for each symbol
.RE
.sp
\-D, \-\-dump\-raw\-trace
.RS 4
Dump raw trace in ASCII.
.RE
.sp
\-k, \-\-vmlinux=<file>
.RS 4
vmlinux pathname.
.RE
.sp
\-\-ignore\-vmlinux
.RS 4
Ignore vmlinux files.
.RE
.sp
\-m, \-\-modules
.RS 4
Load module symbols. WARNING: use only with \-k and LIVE kernel.
.RE
.sp
\-l, \-\-print\-line
.RS 4
Print matching source lines (may be slow).
.RE
.sp
\-P, \-\-full\-paths
.RS 4
Don\(cqt shorten the displayed pathnames.
.RE
.sp
\-\-stdio
.RS 4
Use the stdio interface.
.RE
.sp
\-\-stdio2
.RS 4
Use the stdio2 interface, non\-interactive, uses the TUI formatting.
.RE
.sp
\-\-stdio\-color=<mode>
.RS 4
\fIalways\fP, \fInever\fP or \fIauto\fP, allowing configuring color output
via the command line, in addition to via "color.ui" .perfconfig.
Use \fI\-\-stdio\-color always\fP to generate color even when redirecting
to a pipe or file. Using just \fI\-\-stdio\-color\fP is equivalent to
using \fIalways\fP.
.RE
.sp
\-\-tui
.RS 4
Use the TUI interface. Use of \-\-tui requires a tty, if one is not
present, as when piping to other commands, the stdio interface is
used. This interfaces starts by centering on the line with more
samples, TAB/UNTAB cycles through the lines with more samples.
.RE
.sp
\-\-gtk
.RS 4
Use the GTK interface.
.RE
.sp
\-C, \-\-cpu=<cpu>
.RS 4
Only report samples for the list of CPUs provided. Multiple CPUs can
be provided as a comma\-separated list with no space: 0,1. Ranges of
CPUs are specified with \-: 0\-2. Default is to report samples on all
CPUs.
.RE
.sp
\-\-asm\-raw
.RS 4
Show raw instruction encoding of assembly instructions.
.RE
.sp
\-\-show\-total\-period
.RS 4
Show a column with the sum of periods.
.RE
.sp
\-\-source
.RS 4
Interleave source code with assembly code. Enabled by default,
disable with \-\-no\-source.
.RE
.sp
\-\-symfs=<directory>
.RS 4
Look for files with symbols relative to this directory.
.RE
.sp
\-M, \-\-disassembler\-style=
.RS 4
Set disassembler style for objdump.
.RE
.sp
\-\-objdump=<path>
.RS 4
Path to objdump binary.
.RE
.sp
\-\-skip\-missing
.RS 4
Skip symbols that cannot be annotated.
.RE
.sp
\-\-group
.RS 4
Show event group information together
.RE
.sp
\-\-percent\-type
.RS 4
Set annotation percent type from following choices:
global\-period, local\-period, global\-hits, local\-hits
.sp
.if n .RS 4
.nf
The local/global keywords set if the percentage is computed
in the scope of the function (local) or the whole data (global).
The period/hits keywords set the base the percentage is computed
on \- the samples period or the number of samples (hits).
.fi
.if n .RE
.RE
.SH "SEE ALSO"
.sp
perf\-record(1), perf\-report(1)