xref: /linux/tools/perf/Documentation/perf-annotate.txt (revision e58e871becec2d3b04ed91c0c16fe8deac9c9dfa)
1perf-annotate(1)
2================
3
4NAME
5----
6perf-annotate - Read perf.data (created by perf record) and display annotated code
7
8SYNOPSIS
9--------
10[verse]
11'perf annotate' [-i <file> | --input=file] [symbol_name]
12
13DESCRIPTION
14-----------
15This command reads the input file and displays an annotated version of the
16code. If the object file has debug symbols then the source code will be
17displayed alongside assembly code.
18
19If there is no debug info in the object, then annotated assembly is displayed.
20
21OPTIONS
22-------
23-i::
24--input=::
25        Input file name. (default: perf.data unless stdin is a fifo)
26
27-d::
28--dsos=<dso[,dso...]>::
29        Only consider symbols in these dsos.
30-s::
31--symbol=<symbol>::
32        Symbol to annotate.
33
34-f::
35--force::
36        Don't do ownership validation.
37
38-v::
39--verbose::
40        Be more verbose. (Show symbol address, etc)
41
42-q::
43--quiet::
44	Do not show any message.  (Suppress -v)
45
46-D::
47--dump-raw-trace::
48        Dump raw trace in ASCII.
49
50-k::
51--vmlinux=<file>::
52        vmlinux pathname.
53
54-m::
55--modules::
56        Load module symbols. WARNING: use only with -k and LIVE kernel.
57
58-l::
59--print-line::
60        Print matching source lines (may be slow).
61
62-P::
63--full-paths::
64        Don't shorten the displayed pathnames.
65
66--stdio:: Use the stdio interface.
67
68--stdio-color::
69	'always', 'never' or 'auto', allowing configuring color output
70	via the command line, in addition to via "color.ui" .perfconfig.
71	Use '--stdio-color always' to generate color even when redirecting
72	to a pipe or file. Using just '--stdio-color' is equivalent to
73	using 'always'.
74
75--tui:: Use the TUI interface. Use of --tui requires a tty, if one is not
76	present, as when piping to other commands, the stdio interface is
77	used. This interfaces starts by centering on the line with more
78	samples, TAB/UNTAB cycles through the lines with more samples.
79
80--gtk:: Use the GTK interface.
81
82-C::
83--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
84	be provided as a comma-separated list with no space: 0,1. Ranges of
85	CPUs are specified with -: 0-2. Default is to report samples on all
86	CPUs.
87
88--asm-raw::
89	Show raw instruction encoding of assembly instructions.
90
91--source::
92	Interleave source code with assembly code. Enabled by default,
93	disable with --no-source.
94
95--symfs=<directory>::
96        Look for files with symbols relative to this directory.
97
98-M::
99--disassembler-style=:: Set disassembler style for objdump.
100
101--objdump=<path>::
102        Path to objdump binary.
103
104--skip-missing::
105	Skip symbols that cannot be annotated.
106
107--group::
108	Show event group information together
109
110SEE ALSO
111--------
112linkperf:perf-record[1], linkperf:perf-report[1]
113