Merge tag 'ktest-v3.17' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt...
[deliverable/linux.git] / tools / perf / Documentation / perf-annotate.txt
CommitLineData
8035e428 1perf-annotate(1)
4778e0e8 2================
8035e428
IM
3
4NAME
5----
0b73da3f 6perf-annotate - Read perf.data (created by perf record) and display annotated code
8035e428
IM
7
8SYNOPSIS
9--------
10[verse]
8b9e74eb 11'perf annotate' [-i <file> | --input=file] [symbol_name]
8035e428
IM
12
13DESCRIPTION
14-----------
0b73da3f
IM
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.
8035e428
IM
20
21OPTIONS
22-------
23-i::
24--input=::
efad1415 25 Input file name. (default: perf.data unless stdin is a fifo)
8035e428 26
1968ad91
SB
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 complain, do it.
37
38-v::
39--verbose::
40 Be more verbose. (Show symbol address, etc)
41
42-D::
43--dump-raw-trace::
44 Dump raw trace in ASCII.
45
46-k::
47--vmlinux=<file>::
48 vmlinux pathname.
49
50-m::
51--modules::
52 Load module symbols. WARNING: use only with -k and LIVE kernel.
53
54-l::
55--print-line::
56 Print matching source lines (may be slow).
57
58-P::
59--full-paths::
60 Don't shorten the displayed pathnames.
61
8b9e74eb
ACM
62--stdio:: Use the stdio interface.
63
2b676bf0 64--tui:: Use the TUI interface. Use of --tui requires a tty, if one is not
8b9e74eb
ACM
65 present, as when piping to other commands, the stdio interface is
66 used. This interfaces starts by centering on the line with more
1968ad91 67 samples, TAB/UNTAB cycles through the lines with more samples.
8b9e74eb 68
2b676bf0
NK
69--gtk:: Use the GTK interface.
70
c8e66720 71-C::
5d67be97
AB
72--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
73 be provided as a comma-separated list with no space: 0,1. Ranges of
74 CPUs are specified with -: 0-2. Default is to report samples on all
75 CPUs.
76
3e6a2a7f 77--asm-raw::
64c6f0c7 78 Show raw instruction encoding of assembly instructions.
3e6a2a7f
SE
79
80--source::
81 Interleave source code with assembly code. Enabled by default,
82 disable with --no-source.
83
e71a0598
SE
84--symfs=<directory>::
85 Look for files with symbols relative to this directory.
86
f69b64f7
AK
87-M::
88--disassembler-style=:: Set disassembler style for objdump.
89
7a4ec938
MB
90--objdump=<path>::
91 Path to objdump binary.
92
18c9e5c5
NK
93--skip-missing::
94 Skip symbols that cannot be annotated.
95
b1dd4432
NK
96--group::
97 Show event group information together
98
8035e428
IM
99SEE ALSO
100--------
8b9e74eb 101linkperf:perf-record[1], linkperf:perf-report[1]
This page took 0.225596 seconds and 5 git commands to generate.