'\" t
.\"     Title: perf-annotate
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2024-03-13
.\"    Manual: perf Manual
.\"    Source: perf
.\"  Language: English
.\"
.TH "PERF\-ANNOTATE" "1" "2024-03-13" "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
.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 warnings or messages.  (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
\-\-itrace
.RS 4
Options for decoding instruction tracing data. The options are:
.sp
.if n .RS 4
.nf
.fam C
i        synthesize instructions events
y        synthesize cycles events
b        synthesize branches events (branch misses for Arm SPE)
c        synthesize branches events (calls only)
r        synthesize branches events (returns only)
x        synthesize transactions events
w        synthesize ptwrite events
p        synthesize power events (incl. PSB events for Intel PT)
o        synthesize other events recorded due to the use
        of aux\-output (refer to perf record)
I        synthesize interrupt or similar (asynchronous) events
        (e.g. Intel PT Event Trace)
e        synthesize error events
d        create a debug log
f        synthesize first level cache events
m        synthesize last level cache events
M        synthesize memory events
t        synthesize TLB events
a        synthesize remote access events
g        synthesize a call chain (use with i or x)
G        synthesize a call chain on existing event records
l        synthesize last branch entries (use with i or x)
L        synthesize last branch entries on existing event records
s       skip initial number of events
q        quicker (less detailed) decoding
A        approximate IPC
Z        prefer to ignore timestamps (so\-called "timeless" decoding)
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
The default is all events i.e. the same as \-\-itrace=iybxwpe,
except for perf script where it is \-\-itrace=ce
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
In addition, the period (default 100000, except for perf script where it is 1)
for instructions events can be specified in units of:
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
i        instructions
t        ticks
ms        milliseconds
us        microseconds
ns        nanoseconds (default)
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
Also the call chain size (default 16, max. 1024) for instructions or
transactions events can be specified.
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
Also the number of last branch entries (default 64, max. 1024) for
instructions or transactions events can be specified.
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
Similar to options g and l, size may also be specified for options G and L.
On x86, note that G and L work poorly when data has been recorded with
large PEBS. Refer linkperf:perf\-intel\-pt[1] man page for details.
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
It is also possible to skip events generated (instructions, branches, transactions,
ptwrite, power) at the beginning. This is useful to ignore initialization code.
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
\-\-itrace=i0nss1000000
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
skips the first million instructions.
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
The \*(Aqe\*(Aq option may be followed by flags which affect what errors will or
will not be reported. Each flag must be preceded by either \*(Aq+\*(Aq or \*(Aq\-\*(Aq.
The flags are:
        o        overflow
        l        trace data lost
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
If supported, the \*(Aqd\*(Aq option may be followed by flags which affect what
debug messages will or will not be logged. Each flag must be preceded
by either \*(Aq+\*(Aq or \*(Aq\-\*(Aq. The flags are:
        a        all perf events
        e        output only on errors (size configurable \- see linkperf:perf\-config[1])
        o        output to stdout
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
If supported, the \*(Aqq\*(Aq option may be repeated to increase the effect.
.fam
.fi
.if n .RE
.sp
.if n .RS 4
.nf
.fam C
To disable decoding entirely, use \-\-no\-itrace.
.fam
.fi
.if n .RE
.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
\-\-addr2line=<path>
.RS 4
Path to addr2line binary.
.RE
.sp
\-\-objdump=<path>
.RS 4
Path to objdump binary.
.RE
.sp
\-\-prefix=PREFIX, \-\-prefix\-strip=N
.RS 4
Remove first N entries from source file path names in executables
and add PREFIX. This allows to display source code compiled on systems
with different file system layout.
.RE
.sp
\-\-skip\-missing
.RS 4
Skip symbols that cannot be annotated.
.RE
.sp
\-\-group
.RS 4
Show event group information together
.RE
.sp
\-\-demangle
.RS 4
Demangle symbol names to human readable form. It\(cqs enabled by default,
disable with \-\-no\-demangle.
.RE
.sp
\-\-demangle\-kernel
.RS 4
Demangle kernel symbol names to human readable form (for C++ kernels).
.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
.fam C
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).
.fam
.fi
.if n .RE
.RE
.sp
\-\-percent\-limit
.RS 4
Do not show functions which have an overhead under that percent on
stdio or stdio2 (Default: 0).  Note that this is about selection of
functions to display, not about lines within the function.
.RE
.SH "SEE ALSO"
.sp
perf\-record(1), perf\-report(1)