1 perf-annotate(1) 1 perf-annotate(1)
2 ================ 2 ================
3 3
4 NAME 4 NAME
5 ---- 5 ----
6 perf-annotate - Read perf.data (created by per 6 perf-annotate - Read perf.data (created by perf record) and display annotated code
7 7
8 SYNOPSIS 8 SYNOPSIS
9 -------- 9 --------
10 [verse] 10 [verse]
11 'perf annotate' [-i <file> | --input=file] [sy 11 'perf annotate' [-i <file> | --input=file] [symbol_name]
12 12
13 DESCRIPTION 13 DESCRIPTION
14 ----------- 14 -----------
15 This command reads the input file and displays 15 This command reads the input file and displays an annotated version of the
16 code. If the object file has debug symbols the 16 code. If the object file has debug symbols then the source code will be
17 displayed alongside assembly code. 17 displayed alongside assembly code.
18 18
19 If there is no debug info in the object, then 19 If there is no debug info in the object, then annotated assembly is displayed.
20 20
21 OPTIONS 21 OPTIONS
22 ------- 22 -------
23 -i:: 23 -i::
24 --input=<file>:: 24 --input=<file>::
25 Input file name. (default: perf.data u 25 Input file name. (default: perf.data unless stdin is a fifo)
26 26
27 -d:: 27 -d::
28 --dsos=<dso[,dso...]>:: 28 --dsos=<dso[,dso...]>::
29 Only consider symbols in these dsos. 29 Only consider symbols in these dsos.
30 -s:: 30 -s::
31 --symbol=<symbol>:: 31 --symbol=<symbol>::
32 Symbol to annotate. 32 Symbol to annotate.
33 33
34 -f:: 34 -f::
35 --force:: 35 --force::
36 Don't do ownership validation. 36 Don't do ownership validation.
37 37
38 -v:: 38 -v::
39 --verbose:: 39 --verbose::
40 Be more verbose. (Show symbol address, 40 Be more verbose. (Show symbol address, etc)
41 41
42 -q:: 42 -q::
43 --quiet:: 43 --quiet::
44 Do not show any warnings or messages. 44 Do not show any warnings or messages. (Suppress -v)
45 45
46 -n:: 46 -n::
47 --show-nr-samples:: 47 --show-nr-samples::
48 Show the number of samples for each sy 48 Show the number of samples for each symbol
49 49
50 -D:: 50 -D::
51 --dump-raw-trace:: 51 --dump-raw-trace::
52 Dump raw trace in ASCII. 52 Dump raw trace in ASCII.
53 53
54 -k:: 54 -k::
55 --vmlinux=<file>:: 55 --vmlinux=<file>::
56 vmlinux pathname. 56 vmlinux pathname.
57 57
58 --ignore-vmlinux:: 58 --ignore-vmlinux::
59 Ignore vmlinux files. 59 Ignore vmlinux files.
60 60
61 --itrace:: 61 --itrace::
62 Options for decoding instruction traci 62 Options for decoding instruction tracing data. The options are:
63 63
64 include::itrace.txt[] 64 include::itrace.txt[]
65 65
66 To disable decoding entirely, use --no 66 To disable decoding entirely, use --no-itrace.
67 67
68 -m:: 68 -m::
69 --modules:: 69 --modules::
70 Load module symbols. WARNING: use only 70 Load module symbols. WARNING: use only with -k and LIVE kernel.
71 71
72 -l:: 72 -l::
73 --print-line:: 73 --print-line::
74 Print matching source lines (may be sl 74 Print matching source lines (may be slow).
75 75
76 -P:: 76 -P::
77 --full-paths:: 77 --full-paths::
78 Don't shorten the displayed pathnames. 78 Don't shorten the displayed pathnames.
79 79
80 --stdio:: Use the stdio interface. 80 --stdio:: Use the stdio interface.
81 81
82 --stdio2:: Use the stdio2 interface, non-inter 82 --stdio2:: Use the stdio2 interface, non-interactive, uses the TUI formatting.
83 83
84 --stdio-color=<mode>:: 84 --stdio-color=<mode>::
85 'always', 'never' or 'auto', allowing 85 'always', 'never' or 'auto', allowing configuring color output
86 via the command line, in addition to v 86 via the command line, in addition to via "color.ui" .perfconfig.
87 Use '--stdio-color always' to generate 87 Use '--stdio-color always' to generate color even when redirecting
88 to a pipe or file. Using just '--stdio 88 to a pipe or file. Using just '--stdio-color' is equivalent to
89 using 'always'. 89 using 'always'.
90 90
91 --tui:: Use the TUI interface. Use of --tui re 91 --tui:: Use the TUI interface. Use of --tui requires a tty, if one is not
92 present, as when piping to other comma 92 present, as when piping to other commands, the stdio interface is
93 used. This interfaces starts by center 93 used. This interfaces starts by centering on the line with more
94 samples, TAB/UNTAB cycles through the 94 samples, TAB/UNTAB cycles through the lines with more samples.
95 95
96 --gtk:: Use the GTK interface. 96 --gtk:: Use the GTK interface.
97 97
98 -C:: 98 -C::
99 --cpu=<cpu>:: Only report samples for the list 99 --cpu=<cpu>:: Only report samples for the list of CPUs provided. Multiple CPUs can
100 be provided as a comma-separated list 100 be provided as a comma-separated list with no space: 0,1. Ranges of
101 CPUs are specified with -: 0-2. Defaul 101 CPUs are specified with -: 0-2. Default is to report samples on all
102 CPUs. 102 CPUs.
103 103
104 --asm-raw:: 104 --asm-raw::
105 Show raw instruction encoding of assem 105 Show raw instruction encoding of assembly instructions.
106 106
107 --show-total-period:: Show a column with the s 107 --show-total-period:: Show a column with the sum of periods.
108 108
109 --source:: 109 --source::
110 Interleave source code with assembly c 110 Interleave source code with assembly code. Enabled by default,
111 disable with --no-source. 111 disable with --no-source.
112 112
113 --symfs=<directory>:: 113 --symfs=<directory>::
114 Look for files with symbols relative t 114 Look for files with symbols relative to this directory.
115 115
116 -M:: 116 -M::
117 --disassembler-style=:: Set disassembler style 117 --disassembler-style=:: Set disassembler style for objdump.
118 118
119 --addr2line=<path>:: 119 --addr2line=<path>::
120 Path to addr2line binary. 120 Path to addr2line binary.
121 121
122 --objdump=<path>:: 122 --objdump=<path>::
123 Path to objdump binary. 123 Path to objdump binary.
124 124
125 --prefix=PREFIX:: 125 --prefix=PREFIX::
126 --prefix-strip=N:: 126 --prefix-strip=N::
127 Remove first N entries from source fil 127 Remove first N entries from source file path names in executables
128 and add PREFIX. This allows to display 128 and add PREFIX. This allows to display source code compiled on systems
129 with different file system layout. 129 with different file system layout.
130 130
131 --skip-missing:: 131 --skip-missing::
132 Skip symbols that cannot be annotated. 132 Skip symbols that cannot be annotated.
133 133
134 --group:: 134 --group::
135 Show event group information together 135 Show event group information together
136 136
137 --demangle:: 137 --demangle::
138 Demangle symbol names to human readabl 138 Demangle symbol names to human readable form. It's enabled by default,
139 disable with --no-demangle. 139 disable with --no-demangle.
140 140
141 --demangle-kernel:: 141 --demangle-kernel::
142 Demangle kernel symbol names to human 142 Demangle kernel symbol names to human readable form (for C++ kernels).
143 143
144 --percent-type:: 144 --percent-type::
145 Set annotation percent type from follo 145 Set annotation percent type from following choices:
146 global-period, local-period, global- 146 global-period, local-period, global-hits, local-hits
147 147
148 The local/global keywords set if the p 148 The local/global keywords set if the percentage is computed
149 in the scope of the function (local) o 149 in the scope of the function (local) or the whole data (global).
150 The period/hits keywords set the base 150 The period/hits keywords set the base the percentage is computed
151 on - the samples period or the number 151 on - the samples period or the number of samples (hits).
152 152
153 --percent-limit:: 153 --percent-limit::
154 Do not show functions which have an ov 154 Do not show functions which have an overhead under that percent on
155 stdio or stdio2 (Default: 0). Note th 155 stdio or stdio2 (Default: 0). Note that this is about selection of
156 functions to display, not about lines 156 functions to display, not about lines within the function.
157 157
158 --data-type[=TYPE_NAME]:: 158 --data-type[=TYPE_NAME]::
159 Display data type annotation instead o 159 Display data type annotation instead of code. It infers data type of
160 samples (if they are memory accessing 160 samples (if they are memory accessing instructions) using DWARF debug
161 information. It can take an optional 161 information. It can take an optional argument of data type name. In
162 that case it'd show annotation for the 162 that case it'd show annotation for the type only, otherwise it'd show
163 all data types it finds. 163 all data types it finds.
164 164
165 --type-stat:: 165 --type-stat::
166 Show stats for the data type annotatio 166 Show stats for the data type annotation.
167 167
168 --skip-empty:: 168 --skip-empty::
169 Do not display empty (or dummy) events 169 Do not display empty (or dummy) events.
170 170
171 171
172 SEE ALSO 172 SEE ALSO
173 -------- 173 --------
174 linkperf:perf-record[1], linkperf:perf-report[ 174 linkperf:perf-record[1], linkperf:perf-report[1]
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.