Loading...
1perf-report(1)
2==============
3
4NAME
5----
6perf-report - Read perf.data (created by perf record) and display the profile
7
8SYNOPSIS
9--------
10[verse]
11'perf report' [-i <file> | --input=file]
12
13DESCRIPTION
14-----------
15This command displays the performance counter profile information recorded
16via perf record.
17
18OPTIONS
19-------
20-i::
21--input=::
22 Input file name. (default: perf.data unless stdin is a fifo)
23
24-v::
25--verbose::
26 Be more verbose. (show symbol address, etc)
27
28-q::
29--quiet::
30 Do not show any message. (Suppress -v)
31
32-n::
33--show-nr-samples::
34 Show the number of samples for each symbol
35
36--show-cpu-utilization::
37 Show sample percentage for different cpu modes.
38
39-T::
40--threads::
41 Show per-thread event counters. The input data file should be recorded
42 with -s option.
43-c::
44--comms=::
45 Only consider symbols in these comms. CSV that understands
46 file://filename entries. This option will affect the percentage of
47 the overhead column. See --percentage for more info.
48--pid=::
49 Only show events for given process ID (comma separated list).
50
51--tid=::
52 Only show events for given thread ID (comma separated list).
53-d::
54--dsos=::
55 Only consider symbols in these dsos. CSV that understands
56 file://filename entries. This option will affect the percentage of
57 the overhead column. See --percentage for more info.
58-S::
59--symbols=::
60 Only consider these symbols. CSV that understands
61 file://filename entries. This option will affect the percentage of
62 the overhead column. See --percentage for more info.
63
64--symbol-filter=::
65 Only show symbols that match (partially) with this filter.
66
67-U::
68--hide-unresolved::
69 Only display entries resolved to a symbol.
70
71-s::
72--sort=::
73 Sort histogram entries by given key(s) - multiple keys can be specified
74 in CSV format. Following sort keys are available:
75 pid, comm, dso, symbol, parent, cpu, socket, srcline, weight,
76 local_weight, cgroup_id.
77
78 Each key has following meaning:
79
80 - comm: command (name) of the task which can be read via /proc/<pid>/comm
81 - pid: command and tid of the task
82 - dso: name of library or module executed at the time of sample
83 - dso_size: size of library or module executed at the time of sample
84 - symbol: name of function executed at the time of sample
85 - symbol_size: size of function executed at the time of sample
86 - parent: name of function matched to the parent regex filter. Unmatched
87 entries are displayed as "[other]".
88 - cpu: cpu number the task ran at the time of sample
89 - socket: processor socket number the task ran at the time of sample
90 - srcline: filename and line number executed at the time of sample. The
91 DWARF debugging info must be provided.
92 - srcfile: file name of the source file of the samples. Requires dwarf
93 information.
94 - weight: Event specific weight, e.g. memory latency or transaction
95 abort cost. This is the global weight.
96 - local_weight: Local weight version of the weight above.
97 - cgroup_id: ID derived from cgroup namespace device and inode numbers.
98 - transaction: Transaction abort flags.
99 - overhead: Overhead percentage of sample
100 - overhead_sys: Overhead percentage of sample running in system mode
101 - overhead_us: Overhead percentage of sample running in user mode
102 - overhead_guest_sys: Overhead percentage of sample running in system mode
103 on guest machine
104 - overhead_guest_us: Overhead percentage of sample running in user mode on
105 guest machine
106 - sample: Number of sample
107 - period: Raw number of event count of sample
108 - time: Separate the samples by time stamp with the resolution specified by
109 --time-quantum (default 100ms). Specify with overhead and before it.
110
111 By default, comm, dso and symbol keys are used.
112 (i.e. --sort comm,dso,symbol)
113
114 If --branch-stack option is used, following sort keys are also
115 available:
116
117 - dso_from: name of library or module branched from
118 - dso_to: name of library or module branched to
119 - symbol_from: name of function branched from
120 - symbol_to: name of function branched to
121 - srcline_from: source file and line branched from
122 - srcline_to: source file and line branched to
123 - mispredict: "N" for predicted branch, "Y" for mispredicted branch
124 - in_tx: branch in TSX transaction
125 - abort: TSX transaction abort.
126 - cycles: Cycles in basic block
127
128 And default sort keys are changed to comm, dso_from, symbol_from, dso_to
129 and symbol_to, see '--branch-stack'.
130
131 When the sort key symbol is specified, columns "IPC" and "IPC Coverage"
132 are enabled automatically. Column "IPC" reports the average IPC per function
133 and column "IPC coverage" reports the percentage of instructions with
134 sampled IPC in this function. IPC means Instruction Per Cycle. If it's low,
135 it indicates there may be a performance bottleneck when the function is
136 executed, such as a memory access bottleneck. If a function has high overhead
137 and low IPC, it's worth further analyzing it to optimize its performance.
138
139 If the --mem-mode option is used, the following sort keys are also available
140 (incompatible with --branch-stack):
141 symbol_daddr, dso_daddr, locked, tlb, mem, snoop, dcacheline.
142
143 - symbol_daddr: name of data symbol being executed on at the time of sample
144 - dso_daddr: name of library or module containing the data being executed
145 on at the time of the sample
146 - locked: whether the bus was locked at the time of the sample
147 - tlb: type of tlb access for the data at the time of the sample
148 - mem: type of memory access for the data at the time of the sample
149 - snoop: type of snoop (if any) for the data at the time of the sample
150 - dcacheline: the cacheline the data address is on at the time of the sample
151 - phys_daddr: physical address of data being executed on at the time of sample
152
153 And the default sort keys are changed to local_weight, mem, sym, dso,
154 symbol_daddr, dso_daddr, snoop, tlb, locked, see '--mem-mode'.
155
156 If the data file has tracepoint event(s), following (dynamic) sort keys
157 are also available:
158 trace, trace_fields, [<event>.]<field>[/raw]
159
160 - trace: pretty printed trace output in a single column
161 - trace_fields: fields in tracepoints in separate columns
162 - <field name>: optional event and field name for a specific field
163
164 The last form consists of event and field names. If event name is
165 omitted, it searches all events for matching field name. The matched
166 field will be shown only for the event has the field. The event name
167 supports substring match so user doesn't need to specify full subsystem
168 and event name everytime. For example, 'sched:sched_switch' event can
169 be shortened to 'switch' as long as it's not ambiguous. Also event can
170 be specified by its index (starting from 1) preceded by the '%'.
171 So '%1' is the first event, '%2' is the second, and so on.
172
173 The field name can have '/raw' suffix which disables pretty printing
174 and shows raw field value like hex numbers. The --raw-trace option
175 has the same effect for all dynamic sort keys.
176
177 The default sort keys are changed to 'trace' if all events in the data
178 file are tracepoint.
179
180-F::
181--fields=::
182 Specify output field - multiple keys can be specified in CSV format.
183 Following fields are available:
184 overhead, overhead_sys, overhead_us, overhead_children, sample and period.
185 Also it can contain any sort key(s).
186
187 By default, every sort keys not specified in -F will be appended
188 automatically.
189
190 If the keys starts with a prefix '+', then it will append the specified
191 field(s) to the default field order. For example: perf report -F +period,sample.
192
193-p::
194--parent=<regex>::
195 A regex filter to identify parent. The parent is a caller of this
196 function and searched through the callchain, thus it requires callchain
197 information recorded. The pattern is in the extended regex format and
198 defaults to "\^sys_|^do_page_fault", see '--sort parent'.
199
200-x::
201--exclude-other::
202 Only display entries with parent-match.
203
204-w::
205--column-widths=<width[,width...]>::
206 Force each column width to the provided list, for large terminal
207 readability. 0 means no limit (default behavior).
208
209-t::
210--field-separator=::
211 Use a special separator character and don't pad with spaces, replacing
212 all occurrences of this separator in symbol names (and other output)
213 with a '.' character, that thus it's the only non valid separator.
214
215-D::
216--dump-raw-trace::
217 Dump raw trace in ASCII.
218
219-g::
220--call-graph=<print_type,threshold[,print_limit],order,sort_key[,branch],value>::
221 Display call chains using type, min percent threshold, print limit,
222 call order, sort key, optional branch and value. Note that ordering
223 is not fixed so any parameter can be given in an arbitrary order.
224 One exception is the print_limit which should be preceded by threshold.
225
226 print_type can be either:
227 - flat: single column, linear exposure of call chains.
228 - graph: use a graph tree, displaying absolute overhead rates. (default)
229 - fractal: like graph, but displays relative rates. Each branch of
230 the tree is considered as a new profiled object.
231 - folded: call chains are displayed in a line, separated by semicolons
232 - none: disable call chain display.
233
234 threshold is a percentage value which specifies a minimum percent to be
235 included in the output call graph. Default is 0.5 (%).
236
237 print_limit is only applied when stdio interface is used. It's to limit
238 number of call graph entries in a single hist entry. Note that it needs
239 to be given after threshold (but not necessarily consecutive).
240 Default is 0 (unlimited).
241
242 order can be either:
243 - callee: callee based call graph.
244 - caller: inverted caller based call graph.
245 Default is 'caller' when --children is used, otherwise 'callee'.
246
247 sort_key can be:
248 - function: compare on functions (default)
249 - address: compare on individual code addresses
250 - srcline: compare on source filename and line number
251
252 branch can be:
253 - branch: include last branch information in callgraph when available.
254 Usually more convenient to use --branch-history for this.
255
256 value can be:
257 - percent: display overhead percent (default)
258 - period: display event period
259 - count: display event count
260
261--children::
262 Accumulate callchain of children to parent entry so that then can
263 show up in the output. The output will have a new "Children" column
264 and will be sorted on the data. It requires callchains are recorded.
265 See the `overhead calculation' section for more details. Enabled by
266 default, disable with --no-children.
267
268--max-stack::
269 Set the stack depth limit when parsing the callchain, anything
270 beyond the specified depth will be ignored. This is a trade-off
271 between information loss and faster processing especially for
272 workloads that can have a very long callchain stack.
273 Note that when using the --itrace option the synthesized callchain size
274 will override this value if the synthesized callchain size is bigger.
275
276 Default: 127
277
278-G::
279--inverted::
280 alias for inverted caller based call graph.
281
282--ignore-callees=<regex>::
283 Ignore callees of the function(s) matching the given regex.
284 This has the effect of collecting the callers of each such
285 function into one place in the call-graph tree.
286
287--pretty=<key>::
288 Pretty printing style. key: normal, raw
289
290--stdio:: Use the stdio interface.
291
292--stdio-color::
293 'always', 'never' or 'auto', allowing configuring color output
294 via the command line, in addition to via "color.ui" .perfconfig.
295 Use '--stdio-color always' to generate color even when redirecting
296 to a pipe or file. Using just '--stdio-color' is equivalent to
297 using 'always'.
298
299--tui:: Use the TUI interface, that is integrated with annotate and allows
300 zooming into DSOs or threads, among other features. Use of --tui
301 requires a tty, if one is not present, as when piping to other
302 commands, the stdio interface is used.
303
304--gtk:: Use the GTK2 interface.
305
306-k::
307--vmlinux=<file>::
308 vmlinux pathname
309
310--ignore-vmlinux::
311 Ignore vmlinux files.
312
313--kallsyms=<file>::
314 kallsyms pathname
315
316-m::
317--modules::
318 Load module symbols. WARNING: This should only be used with -k and
319 a LIVE kernel.
320
321-f::
322--force::
323 Don't do ownership validation.
324
325--symfs=<directory>::
326 Look for files with symbols relative to this directory.
327
328-C::
329--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
330 be provided as a comma-separated list with no space: 0,1. Ranges of
331 CPUs are specified with -: 0-2. Default is to report samples on all
332 CPUs.
333
334-M::
335--disassembler-style=:: Set disassembler style for objdump.
336
337--source::
338 Interleave source code with assembly code. Enabled by default,
339 disable with --no-source.
340
341--asm-raw::
342 Show raw instruction encoding of assembly instructions.
343
344--show-total-period:: Show a column with the sum of periods.
345
346-I::
347--show-info::
348 Display extended information about the perf.data file. This adds
349 information which may be very large and thus may clutter the display.
350 It currently includes: cpu and numa topology of the host system.
351
352-b::
353--branch-stack::
354 Use the addresses of sampled taken branches instead of the instruction
355 address to build the histograms. To generate meaningful output, the
356 perf.data file must have been obtained using perf record -b or
357 perf record --branch-filter xxx where xxx is a branch filter option.
358 perf report is able to auto-detect whether a perf.data file contains
359 branch stacks and it will automatically switch to the branch view mode,
360 unless --no-branch-stack is used.
361
362--branch-history::
363 Add the addresses of sampled taken branches to the callstack.
364 This allows to examine the path the program took to each sample.
365 The data collection must have used -b (or -j) and -g.
366
367--objdump=<path>::
368 Path to objdump binary.
369
370--group::
371 Show event group information together. It forces group output also
372 if there are no groups defined in data file.
373
374--demangle::
375 Demangle symbol names to human readable form. It's enabled by default,
376 disable with --no-demangle.
377
378--demangle-kernel::
379 Demangle kernel symbol names to human readable form (for C++ kernels).
380
381--mem-mode::
382 Use the data addresses of samples in addition to instruction addresses
383 to build the histograms. To generate meaningful output, the perf.data
384 file must have been obtained using perf record -d -W and using a
385 special event -e cpu/mem-loads/p or -e cpu/mem-stores/p. See
386 'perf mem' for simpler access.
387
388--percent-limit::
389 Do not show entries which have an overhead under that percent.
390 (Default: 0). Note that this option also sets the percent limit (threshold)
391 of callchains. However the default value of callchain threshold is
392 different than the default value of hist entries. Please see the
393 --call-graph option for details.
394
395--percentage::
396 Determine how to display the overhead percentage of filtered entries.
397 Filters can be applied by --comms, --dsos and/or --symbols options and
398 Zoom operations on the TUI (thread, dso, etc).
399
400 "relative" means it's relative to filtered entries only so that the
401 sum of shown entries will be always 100%. "absolute" means it retains
402 the original value before and after the filter is applied.
403
404--header::
405 Show header information in the perf.data file. This includes
406 various information like hostname, OS and perf version, cpu/mem
407 info, perf command line, event list and so on. Currently only
408 --stdio output supports this feature.
409
410--header-only::
411 Show only perf.data header (forces --stdio).
412
413--time::
414 Only analyze samples within given time window: <start>,<stop>. Times
415 have the format seconds.nanoseconds. If start is not given (i.e. time
416 string is ',x.y') then analysis starts at the beginning of the file. If
417 stop time is not given (i.e. time string is 'x.y,') then analysis goes
418 to end of file. Multiple ranges can be separated by spaces, which
419 requires the argument to be quoted e.g. --time "1234.567,1234.789 1235,"
420
421 Also support time percent with multiple time ranges. Time string is
422 'a%/n,b%/m,...' or 'a%-b%,c%-%d,...'.
423
424 For example:
425 Select the second 10% time slice:
426
427 perf report --time 10%/2
428
429 Select from 0% to 10% time slice:
430
431 perf report --time 0%-10%
432
433 Select the first and second 10% time slices:
434
435 perf report --time 10%/1,10%/2
436
437 Select from 0% to 10% and 30% to 40% slices:
438
439 perf report --time 0%-10%,30%-40%
440
441--switch-on EVENT_NAME::
442 Only consider events after this event is found.
443
444 This may be interesting to measure a workload only after some initialization
445 phase is over, i.e. insert a perf probe at that point and then using this
446 option with that probe.
447
448--switch-off EVENT_NAME::
449 Stop considering events after this event is found.
450
451--show-on-off-events::
452 Show the --switch-on/off events too. This has no effect in 'perf report' now
453 but probably we'll make the default not to show the switch-on/off events
454 on the --group mode and if there is only one event besides the off/on ones,
455 go straight to the histogram browser, just like 'perf report' with no events
456 explicitely specified does.
457
458--itrace::
459 Options for decoding instruction tracing data. The options are:
460
461include::itrace.txt[]
462
463 To disable decoding entirely, use --no-itrace.
464
465--full-source-path::
466 Show the full path for source files for srcline output.
467
468--show-ref-call-graph::
469 When multiple events are sampled, it may not be needed to collect
470 callgraphs for all of them. The sample sites are usually nearby,
471 and it's enough to collect the callgraphs on a reference event.
472 So user can use "call-graph=no" event modifier to disable callgraph
473 for other events to reduce the overhead.
474 However, perf report cannot show callgraphs for the event which
475 disable the callgraph.
476 This option extends the perf report to show reference callgraphs,
477 which collected by reference event, in no callgraph event.
478
479--socket-filter::
480 Only report the samples on the processor socket that match with this filter
481
482--samples=N::
483 Save N individual samples for each histogram entry to show context in perf
484 report tui browser.
485
486--raw-trace::
487 When displaying traceevent output, do not use print fmt or plugins.
488
489--hierarchy::
490 Enable hierarchical output.
491
492--inline::
493 If a callgraph address belongs to an inlined function, the inline stack
494 will be printed. Each entry is function name or file/line. Enabled by
495 default, disable with --no-inline.
496
497--mmaps::
498 Show --tasks output plus mmap information in a format similar to
499 /proc/<PID>/maps.
500
501 Please note that not all mmaps are stored, options affecting which ones
502 are include 'perf record --data', for instance.
503
504--ns::
505 Show time stamps in nanoseconds.
506
507--stats::
508 Display overall events statistics without any further processing.
509 (like the one at the end of the perf report -D command)
510
511--tasks::
512 Display monitored tasks stored in perf data. Displaying pid/tid/ppid
513 plus the command string aligned to distinguish parent and child tasks.
514
515--percent-type::
516 Set annotation percent type from following choices:
517 global-period, local-period, global-hits, local-hits
518
519 The local/global keywords set if the percentage is computed
520 in the scope of the function (local) or the whole data (global).
521 The period/hits keywords set the base the percentage is computed
522 on - the samples period or the number of samples (hits).
523
524--time-quantum::
525 Configure time quantum for time sort key. Default 100ms.
526 Accepts s, us, ms, ns units.
527
528include::callchain-overhead-calculation.txt[]
529
530SEE ALSO
531--------
532linkperf:perf-stat[1], linkperf:perf-annotate[1], linkperf:perf-record[1]
1perf-report(1)
2==============
3
4NAME
5----
6perf-report - Read perf.data (created by perf record) and display the profile
7
8SYNOPSIS
9--------
10[verse]
11'perf report' [-i <file> | --input=file]
12
13DESCRIPTION
14-----------
15This command displays the performance counter profile information recorded
16via perf record.
17
18OPTIONS
19-------
20-i::
21--input=::
22 Input file name. (default: perf.data unless stdin is a fifo)
23
24-v::
25--verbose::
26 Be more verbose. (show symbol address, etc)
27
28-q::
29--quiet::
30 Do not show any message. (Suppress -v)
31
32-n::
33--show-nr-samples::
34 Show the number of samples for each symbol
35
36--show-cpu-utilization::
37 Show sample percentage for different cpu modes.
38
39-T::
40--threads::
41 Show per-thread event counters. The input data file should be recorded
42 with -s option.
43-c::
44--comms=::
45 Only consider symbols in these comms. CSV that understands
46 file://filename entries. This option will affect the percentage of
47 the overhead column. See --percentage for more info.
48--pid=::
49 Only show events for given process ID (comma separated list).
50
51--tid=::
52 Only show events for given thread ID (comma separated list).
53-d::
54--dsos=::
55 Only consider symbols in these dsos. CSV that understands
56 file://filename entries. This option will affect the percentage of
57 the overhead column. See --percentage for more info.
58-S::
59--symbols=::
60 Only consider these symbols. CSV that understands
61 file://filename entries. This option will affect the percentage of
62 the overhead column. See --percentage for more info.
63
64--symbol-filter=::
65 Only show symbols that match (partially) with this filter.
66
67-U::
68--hide-unresolved::
69 Only display entries resolved to a symbol.
70
71-s::
72--sort=::
73 Sort histogram entries by given key(s) - multiple keys can be specified
74 in CSV format. Following sort keys are available:
75 pid, comm, dso, symbol, parent, cpu, socket, srcline, weight,
76 local_weight, cgroup_id.
77
78 Each key has following meaning:
79
80 - comm: command (name) of the task which can be read via /proc/<pid>/comm
81 - pid: command and tid of the task
82 - dso: name of library or module executed at the time of sample
83 - dso_size: size of library or module executed at the time of sample
84 - symbol: name of function executed at the time of sample
85 - symbol_size: size of function executed at the time of sample
86 - parent: name of function matched to the parent regex filter. Unmatched
87 entries are displayed as "[other]".
88 - cpu: cpu number the task ran at the time of sample
89 - socket: processor socket number the task ran at the time of sample
90 - srcline: filename and line number executed at the time of sample. The
91 DWARF debugging info must be provided.
92 - srcfile: file name of the source file of the samples. Requires dwarf
93 information.
94 - weight: Event specific weight, e.g. memory latency or transaction
95 abort cost. This is the global weight.
96 - local_weight: Local weight version of the weight above.
97 - cgroup_id: ID derived from cgroup namespace device and inode numbers.
98 - cgroup: cgroup pathname in the cgroupfs.
99 - transaction: Transaction abort flags.
100 - overhead: Overhead percentage of sample
101 - overhead_sys: Overhead percentage of sample running in system mode
102 - overhead_us: Overhead percentage of sample running in user mode
103 - overhead_guest_sys: Overhead percentage of sample running in system mode
104 on guest machine
105 - overhead_guest_us: Overhead percentage of sample running in user mode on
106 guest machine
107 - sample: Number of sample
108 - period: Raw number of event count of sample
109 - time: Separate the samples by time stamp with the resolution specified by
110 --time-quantum (default 100ms). Specify with overhead and before it.
111
112 By default, comm, dso and symbol keys are used.
113 (i.e. --sort comm,dso,symbol)
114
115 If --branch-stack option is used, following sort keys are also
116 available:
117
118 - dso_from: name of library or module branched from
119 - dso_to: name of library or module branched to
120 - symbol_from: name of function branched from
121 - symbol_to: name of function branched to
122 - srcline_from: source file and line branched from
123 - srcline_to: source file and line branched to
124 - mispredict: "N" for predicted branch, "Y" for mispredicted branch
125 - in_tx: branch in TSX transaction
126 - abort: TSX transaction abort.
127 - cycles: Cycles in basic block
128
129 And default sort keys are changed to comm, dso_from, symbol_from, dso_to
130 and symbol_to, see '--branch-stack'.
131
132 When the sort key symbol is specified, columns "IPC" and "IPC Coverage"
133 are enabled automatically. Column "IPC" reports the average IPC per function
134 and column "IPC coverage" reports the percentage of instructions with
135 sampled IPC in this function. IPC means Instruction Per Cycle. If it's low,
136 it indicates there may be a performance bottleneck when the function is
137 executed, such as a memory access bottleneck. If a function has high overhead
138 and low IPC, it's worth further analyzing it to optimize its performance.
139
140 If the --mem-mode option is used, the following sort keys are also available
141 (incompatible with --branch-stack):
142 symbol_daddr, dso_daddr, locked, tlb, mem, snoop, dcacheline.
143
144 - symbol_daddr: name of data symbol being executed on at the time of sample
145 - dso_daddr: name of library or module containing the data being executed
146 on at the time of the sample
147 - locked: whether the bus was locked at the time of the sample
148 - tlb: type of tlb access for the data at the time of the sample
149 - mem: type of memory access for the data at the time of the sample
150 - snoop: type of snoop (if any) for the data at the time of the sample
151 - dcacheline: the cacheline the data address is on at the time of the sample
152 - phys_daddr: physical address of data being executed on at the time of sample
153
154 And the default sort keys are changed to local_weight, mem, sym, dso,
155 symbol_daddr, dso_daddr, snoop, tlb, locked, see '--mem-mode'.
156
157 If the data file has tracepoint event(s), following (dynamic) sort keys
158 are also available:
159 trace, trace_fields, [<event>.]<field>[/raw]
160
161 - trace: pretty printed trace output in a single column
162 - trace_fields: fields in tracepoints in separate columns
163 - <field name>: optional event and field name for a specific field
164
165 The last form consists of event and field names. If event name is
166 omitted, it searches all events for matching field name. The matched
167 field will be shown only for the event has the field. The event name
168 supports substring match so user doesn't need to specify full subsystem
169 and event name everytime. For example, 'sched:sched_switch' event can
170 be shortened to 'switch' as long as it's not ambiguous. Also event can
171 be specified by its index (starting from 1) preceded by the '%'.
172 So '%1' is the first event, '%2' is the second, and so on.
173
174 The field name can have '/raw' suffix which disables pretty printing
175 and shows raw field value like hex numbers. The --raw-trace option
176 has the same effect for all dynamic sort keys.
177
178 The default sort keys are changed to 'trace' if all events in the data
179 file are tracepoint.
180
181-F::
182--fields=::
183 Specify output field - multiple keys can be specified in CSV format.
184 Following fields are available:
185 overhead, overhead_sys, overhead_us, overhead_children, sample and period.
186 Also it can contain any sort key(s).
187
188 By default, every sort keys not specified in -F will be appended
189 automatically.
190
191 If the keys starts with a prefix '+', then it will append the specified
192 field(s) to the default field order. For example: perf report -F +period,sample.
193
194-p::
195--parent=<regex>::
196 A regex filter to identify parent. The parent is a caller of this
197 function and searched through the callchain, thus it requires callchain
198 information recorded. The pattern is in the extended regex format and
199 defaults to "\^sys_|^do_page_fault", see '--sort parent'.
200
201-x::
202--exclude-other::
203 Only display entries with parent-match.
204
205-w::
206--column-widths=<width[,width...]>::
207 Force each column width to the provided list, for large terminal
208 readability. 0 means no limit (default behavior).
209
210-t::
211--field-separator=::
212 Use a special separator character and don't pad with spaces, replacing
213 all occurrences of this separator in symbol names (and other output)
214 with a '.' character, that thus it's the only non valid separator.
215
216-D::
217--dump-raw-trace::
218 Dump raw trace in ASCII.
219
220-g::
221--call-graph=<print_type,threshold[,print_limit],order,sort_key[,branch],value>::
222 Display call chains using type, min percent threshold, print limit,
223 call order, sort key, optional branch and value. Note that ordering
224 is not fixed so any parameter can be given in an arbitrary order.
225 One exception is the print_limit which should be preceded by threshold.
226
227 print_type can be either:
228 - flat: single column, linear exposure of call chains.
229 - graph: use a graph tree, displaying absolute overhead rates. (default)
230 - fractal: like graph, but displays relative rates. Each branch of
231 the tree is considered as a new profiled object.
232 - folded: call chains are displayed in a line, separated by semicolons
233 - none: disable call chain display.
234
235 threshold is a percentage value which specifies a minimum percent to be
236 included in the output call graph. Default is 0.5 (%).
237
238 print_limit is only applied when stdio interface is used. It's to limit
239 number of call graph entries in a single hist entry. Note that it needs
240 to be given after threshold (but not necessarily consecutive).
241 Default is 0 (unlimited).
242
243 order can be either:
244 - callee: callee based call graph.
245 - caller: inverted caller based call graph.
246 Default is 'caller' when --children is used, otherwise 'callee'.
247
248 sort_key can be:
249 - function: compare on functions (default)
250 - address: compare on individual code addresses
251 - srcline: compare on source filename and line number
252
253 branch can be:
254 - branch: include last branch information in callgraph when available.
255 Usually more convenient to use --branch-history for this.
256
257 value can be:
258 - percent: display overhead percent (default)
259 - period: display event period
260 - count: display event count
261
262--children::
263 Accumulate callchain of children to parent entry so that then can
264 show up in the output. The output will have a new "Children" column
265 and will be sorted on the data. It requires callchains are recorded.
266 See the `overhead calculation' section for more details. Enabled by
267 default, disable with --no-children.
268
269--max-stack::
270 Set the stack depth limit when parsing the callchain, anything
271 beyond the specified depth will be ignored. This is a trade-off
272 between information loss and faster processing especially for
273 workloads that can have a very long callchain stack.
274 Note that when using the --itrace option the synthesized callchain size
275 will override this value if the synthesized callchain size is bigger.
276
277 Default: 127
278
279-G::
280--inverted::
281 alias for inverted caller based call graph.
282
283--ignore-callees=<regex>::
284 Ignore callees of the function(s) matching the given regex.
285 This has the effect of collecting the callers of each such
286 function into one place in the call-graph tree.
287
288--pretty=<key>::
289 Pretty printing style. key: normal, raw
290
291--stdio:: Use the stdio interface.
292
293--stdio-color::
294 'always', 'never' or 'auto', allowing configuring color output
295 via the command line, in addition to via "color.ui" .perfconfig.
296 Use '--stdio-color always' to generate color even when redirecting
297 to a pipe or file. Using just '--stdio-color' is equivalent to
298 using 'always'.
299
300--tui:: Use the TUI interface, that is integrated with annotate and allows
301 zooming into DSOs or threads, among other features. Use of --tui
302 requires a tty, if one is not present, as when piping to other
303 commands, the stdio interface is used.
304
305--gtk:: Use the GTK2 interface.
306
307-k::
308--vmlinux=<file>::
309 vmlinux pathname
310
311--ignore-vmlinux::
312 Ignore vmlinux files.
313
314--kallsyms=<file>::
315 kallsyms pathname
316
317-m::
318--modules::
319 Load module symbols. WARNING: This should only be used with -k and
320 a LIVE kernel.
321
322-f::
323--force::
324 Don't do ownership validation.
325
326--symfs=<directory>::
327 Look for files with symbols relative to this directory.
328
329-C::
330--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
331 be provided as a comma-separated list with no space: 0,1. Ranges of
332 CPUs are specified with -: 0-2. Default is to report samples on all
333 CPUs.
334
335-M::
336--disassembler-style=:: Set disassembler style for objdump.
337
338--source::
339 Interleave source code with assembly code. Enabled by default,
340 disable with --no-source.
341
342--asm-raw::
343 Show raw instruction encoding of assembly instructions.
344
345--show-total-period:: Show a column with the sum of periods.
346
347-I::
348--show-info::
349 Display extended information about the perf.data file. This adds
350 information which may be very large and thus may clutter the display.
351 It currently includes: cpu and numa topology of the host system.
352
353-b::
354--branch-stack::
355 Use the addresses of sampled taken branches instead of the instruction
356 address to build the histograms. To generate meaningful output, the
357 perf.data file must have been obtained using perf record -b or
358 perf record --branch-filter xxx where xxx is a branch filter option.
359 perf report is able to auto-detect whether a perf.data file contains
360 branch stacks and it will automatically switch to the branch view mode,
361 unless --no-branch-stack is used.
362
363--branch-history::
364 Add the addresses of sampled taken branches to the callstack.
365 This allows to examine the path the program took to each sample.
366 The data collection must have used -b (or -j) and -g.
367
368--objdump=<path>::
369 Path to objdump binary.
370
371--prefix=PREFIX::
372--prefix-strip=N::
373 Remove first N entries from source file path names in executables
374 and add PREFIX. This allows to display source code compiled on systems
375 with different file system layout.
376
377--group::
378 Show event group information together. It forces group output also
379 if there are no groups defined in data file.
380
381--group-sort-idx::
382 Sort the output by the event at the index n in group. If n is invalid,
383 sort by the first event. It can support multiple groups with different
384 amount of events. WARNING: This should be used on grouped events.
385
386--demangle::
387 Demangle symbol names to human readable form. It's enabled by default,
388 disable with --no-demangle.
389
390--demangle-kernel::
391 Demangle kernel symbol names to human readable form (for C++ kernels).
392
393--mem-mode::
394 Use the data addresses of samples in addition to instruction addresses
395 to build the histograms. To generate meaningful output, the perf.data
396 file must have been obtained using perf record -d -W and using a
397 special event -e cpu/mem-loads/p or -e cpu/mem-stores/p. See
398 'perf mem' for simpler access.
399
400--percent-limit::
401 Do not show entries which have an overhead under that percent.
402 (Default: 0). Note that this option also sets the percent limit (threshold)
403 of callchains. However the default value of callchain threshold is
404 different than the default value of hist entries. Please see the
405 --call-graph option for details.
406
407--percentage::
408 Determine how to display the overhead percentage of filtered entries.
409 Filters can be applied by --comms, --dsos and/or --symbols options and
410 Zoom operations on the TUI (thread, dso, etc).
411
412 "relative" means it's relative to filtered entries only so that the
413 sum of shown entries will be always 100%. "absolute" means it retains
414 the original value before and after the filter is applied.
415
416--header::
417 Show header information in the perf.data file. This includes
418 various information like hostname, OS and perf version, cpu/mem
419 info, perf command line, event list and so on. Currently only
420 --stdio output supports this feature.
421
422--header-only::
423 Show only perf.data header (forces --stdio).
424
425--time::
426 Only analyze samples within given time window: <start>,<stop>. Times
427 have the format seconds.nanoseconds. If start is not given (i.e. time
428 string is ',x.y') then analysis starts at the beginning of the file. If
429 stop time is not given (i.e. time string is 'x.y,') then analysis goes
430 to end of file. Multiple ranges can be separated by spaces, which
431 requires the argument to be quoted e.g. --time "1234.567,1234.789 1235,"
432
433 Also support time percent with multiple time ranges. Time string is
434 'a%/n,b%/m,...' or 'a%-b%,c%-%d,...'.
435
436 For example:
437 Select the second 10% time slice:
438
439 perf report --time 10%/2
440
441 Select from 0% to 10% time slice:
442
443 perf report --time 0%-10%
444
445 Select the first and second 10% time slices:
446
447 perf report --time 10%/1,10%/2
448
449 Select from 0% to 10% and 30% to 40% slices:
450
451 perf report --time 0%-10%,30%-40%
452
453--switch-on EVENT_NAME::
454 Only consider events after this event is found.
455
456 This may be interesting to measure a workload only after some initialization
457 phase is over, i.e. insert a perf probe at that point and then using this
458 option with that probe.
459
460--switch-off EVENT_NAME::
461 Stop considering events after this event is found.
462
463--show-on-off-events::
464 Show the --switch-on/off events too. This has no effect in 'perf report' now
465 but probably we'll make the default not to show the switch-on/off events
466 on the --group mode and if there is only one event besides the off/on ones,
467 go straight to the histogram browser, just like 'perf report' with no events
468 explicitely specified does.
469
470--itrace::
471 Options for decoding instruction tracing data. The options are:
472
473include::itrace.txt[]
474
475 To disable decoding entirely, use --no-itrace.
476
477--full-source-path::
478 Show the full path for source files for srcline output.
479
480--show-ref-call-graph::
481 When multiple events are sampled, it may not be needed to collect
482 callgraphs for all of them. The sample sites are usually nearby,
483 and it's enough to collect the callgraphs on a reference event.
484 So user can use "call-graph=no" event modifier to disable callgraph
485 for other events to reduce the overhead.
486 However, perf report cannot show callgraphs for the event which
487 disable the callgraph.
488 This option extends the perf report to show reference callgraphs,
489 which collected by reference event, in no callgraph event.
490
491--stitch-lbr::
492 Show callgraph with stitched LBRs, which may have more complete
493 callgraph. The perf.data file must have been obtained using
494 perf record --call-graph lbr.
495 Disabled by default. In common cases with call stack overflows,
496 it can recreate better call stacks than the default lbr call stack
497 output. But this approach is not full proof. There can be cases
498 where it creates incorrect call stacks from incorrect matches.
499 The known limitations include exception handing such as
500 setjmp/longjmp will have calls/returns not match.
501
502--socket-filter::
503 Only report the samples on the processor socket that match with this filter
504
505--samples=N::
506 Save N individual samples for each histogram entry to show context in perf
507 report tui browser.
508
509--raw-trace::
510 When displaying traceevent output, do not use print fmt or plugins.
511
512--hierarchy::
513 Enable hierarchical output.
514
515--inline::
516 If a callgraph address belongs to an inlined function, the inline stack
517 will be printed. Each entry is function name or file/line. Enabled by
518 default, disable with --no-inline.
519
520--mmaps::
521 Show --tasks output plus mmap information in a format similar to
522 /proc/<PID>/maps.
523
524 Please note that not all mmaps are stored, options affecting which ones
525 are include 'perf record --data', for instance.
526
527--ns::
528 Show time stamps in nanoseconds.
529
530--stats::
531 Display overall events statistics without any further processing.
532 (like the one at the end of the perf report -D command)
533
534--tasks::
535 Display monitored tasks stored in perf data. Displaying pid/tid/ppid
536 plus the command string aligned to distinguish parent and child tasks.
537
538--percent-type::
539 Set annotation percent type from following choices:
540 global-period, local-period, global-hits, local-hits
541
542 The local/global keywords set if the percentage is computed
543 in the scope of the function (local) or the whole data (global).
544 The period/hits keywords set the base the percentage is computed
545 on - the samples period or the number of samples (hits).
546
547--time-quantum::
548 Configure time quantum for time sort key. Default 100ms.
549 Accepts s, us, ms, ns units.
550
551--total-cycles::
552 When --total-cycles is specified, it supports sorting for all blocks by
553 'Sampled Cycles%'. This is useful to concentrate on the globally hottest
554 blocks. In output, there are some new columns:
555
556 'Sampled Cycles%' - block sampled cycles aggregation / total sampled cycles
557 'Sampled Cycles' - block sampled cycles aggregation
558 'Avg Cycles%' - block average sampled cycles / sum of total block average
559 sampled cycles
560 'Avg Cycles' - block average sampled cycles
561
562include::callchain-overhead-calculation.txt[]
563
564SEE ALSO
565--------
566linkperf:perf-stat[1], linkperf:perf-annotate[1], linkperf:perf-record[1],
567linkperf:perf-intel-pt[1]