blob: e9cd39a92dc220dcfb4cef0ee0a8c98dc4b93199 [file] [log] [blame]
Ingo Molnar8035e422009-06-06 15:19:13 +02001perf-annotate(1)
Arnaldo Carvalho de Melo4778e0e2010-05-05 11:23:27 -03002================
Ingo Molnar8035e422009-06-06 15:19:13 +02003
4NAME
5----
Ingo Molnar0b73da32009-06-06 15:48:52 +02006perf-annotate - Read perf.data (created by perf record) and display annotated code
Ingo Molnar8035e422009-06-06 15:19:13 +02007
8SYNOPSIS
9--------
10[verse]
Arnaldo Carvalho de Melo8b9e74e2010-08-21 10:38:16 -030011'perf annotate' [-i <file> | --input=file] [symbol_name]
Ingo Molnar8035e422009-06-06 15:19:13 +020012
13DESCRIPTION
14-----------
Ingo Molnar0b73da32009-06-06 15:48:52 +020015This 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.
Ingo Molnar8035e422009-06-06 15:19:13 +020020
21OPTIONS
22-------
23-i::
24--input=::
Robert Richterefad1412011-12-07 10:02:54 +010025 Input file name. (default: perf.data unless stdin is a fifo)
Ingo Molnar8035e422009-06-06 15:19:13 +020026
Shawn Bohrer1968ad92010-11-30 19:57:09 -060027-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
Arnaldo Carvalho de Melo8b9e74e2010-08-21 10:38:16 -030062--stdio:: Use the stdio interface.
63
Namhyung Kim2b676bf2013-02-07 18:02:08 +090064--tui:: Use the TUI interface. Use of --tui requires a tty, if one is not
Arnaldo Carvalho de Melo8b9e74e2010-08-21 10:38:16 -030065 present, as when piping to other commands, the stdio interface is
66 used. This interfaces starts by centering on the line with more
Shawn Bohrer1968ad92010-11-30 19:57:09 -060067 samples, TAB/UNTAB cycles through the lines with more samples.
Arnaldo Carvalho de Melo8b9e74e2010-08-21 10:38:16 -030068
Namhyung Kim2b676bf2013-02-07 18:02:08 +090069--gtk:: Use the GTK interface.
70
David Ahernc8e66722011-11-13 11:30:08 -070071-C::
Anton Blanchard5d67be92011-07-04 21:57:50 +100072--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
Stephane Eranian3e6a2a72011-05-17 17:32:07 +020077--asm-raw::
Arnaldo Carvalho de Melo64c6f0c2011-10-06 12:48:31 -030078 Show raw instruction encoding of assembly instructions.
Stephane Eranian3e6a2a72011-05-17 17:32:07 +020079
80--source::
81 Interleave source code with assembly code. Enabled by default,
82 disable with --no-source.
83
Stephane Eraniane71a0592011-07-30 01:20:40 +020084--symfs=<directory>::
85 Look for files with symbols relative to this directory.
86
Andi Kleenf69b64f2011-09-15 14:31:41 -070087-M::
88--disassembler-style=:: Set disassembler style for objdump.
89
Maciek Borzecki7a4ec932012-09-04 12:32:30 +020090--objdump=<path>::
91 Path to objdump binary.
92
Namhyung Kim18c9e5c2013-02-07 18:02:14 +090093--skip-missing::
94 Skip symbols that cannot be annotated.
95
Namhyung Kimb1dd4432013-03-05 14:53:25 +090096--group::
97 Show event group information together
98
Ingo Molnar8035e422009-06-06 15:19:13 +020099SEE ALSO
100--------
Arnaldo Carvalho de Melo8b9e74e2010-08-21 10:38:16 -0300101linkperf:perf-record[1], linkperf:perf-report[1]