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-n::
29--show-nr-samples::
30	Show the number of samples for each symbol
31
32--showcpuutilization::
33        Show sample percentage for different cpu modes.
34
35-T::
36--threads::
37	Show per-thread event counters
38-c::
39--comms=::
40	Only consider symbols in these comms. CSV that understands
41	file://filename entries.  This option will affect the percentage of
42	the overhead column.  See --percentage for more info.
43-d::
44--dsos=::
45	Only consider symbols in these dsos. CSV that understands
46	file://filename entries.  This option will affect the percentage of
47	the overhead column.  See --percentage for more info.
48-S::
49--symbols=::
50	Only consider these symbols. CSV that understands
51	file://filename entries.  This option will affect the percentage of
52	the overhead column.  See --percentage for more info.
53
54--symbol-filter=::
55	Only show symbols that match (partially) with this filter.
56
57-U::
58--hide-unresolved::
59        Only display entries resolved to a symbol.
60
61-s::
62--sort=::
63	Sort histogram entries by given key(s) - multiple keys can be specified
64	in CSV format.  Following sort keys are available:
65	pid, comm, dso, symbol, parent, cpu, srcline, weight, local_weight.
66
67	Each key has following meaning:
68
69	- comm: command (name) of the task which can be read via /proc/<pid>/comm
70	- pid: command and tid of the task
71	- dso: name of library or module executed at the time of sample
72	- symbol: name of function executed at the time of sample
73	- parent: name of function matched to the parent regex filter. Unmatched
74	entries are displayed as "[other]".
75	- cpu: cpu number the task ran at the time of sample
76	- srcline: filename and line number executed at the time of sample.  The
77	DWARF debugging info must be provided.
78	- weight: Event specific weight, e.g. memory latency or transaction
79	abort cost. This is the global weight.
80	- local_weight: Local weight version of the weight above.
81	- transaction: Transaction abort flags.
82	- overhead: Overhead percentage of sample
83	- overhead_sys: Overhead percentage of sample running in system mode
84	- overhead_us: Overhead percentage of sample running in user mode
85	- overhead_guest_sys: Overhead percentage of sample running in system mode
86	on guest machine
87	- overhead_guest_us: Overhead percentage of sample running in user mode on
88	guest machine
89	- sample: Number of sample
90	- period: Raw number of event count of sample
91
92	By default, comm, dso and symbol keys are used.
93	(i.e. --sort comm,dso,symbol)
94
95	If --branch-stack option is used, following sort keys are also
96	available:
97	dso_from, dso_to, symbol_from, symbol_to, mispredict.
98
99	- dso_from: name of library or module branched from
100	- dso_to: name of library or module branched to
101	- symbol_from: name of function branched from
102	- symbol_to: name of function branched to
103	- mispredict: "N" for predicted branch, "Y" for mispredicted branch
104	- in_tx: branch in TSX transaction
105	- abort: TSX transaction abort.
106
107	And default sort keys are changed to comm, dso_from, symbol_from, dso_to
108	and symbol_to, see '--branch-stack'.
109
110-F::
111--fields=::
112	Specify output field - multiple keys can be specified in CSV format.
113	Following fields are available:
114	overhead, overhead_sys, overhead_us, overhead_children, sample and period.
115	Also it can contain any sort key(s).
116
117	By default, every sort keys not specified in -F will be appended
118	automatically.
119
120-p::
121--parent=<regex>::
122        A regex filter to identify parent. The parent is a caller of this
123	function and searched through the callchain, thus it requires callchain
124	information recorded. The pattern is in the exteneded regex format and
125	defaults to "\^sys_|^do_page_fault", see '--sort parent'.
126
127-x::
128--exclude-other::
129        Only display entries with parent-match.
130
131-w::
132--column-widths=<width[,width...]>::
133	Force each column width to the provided list, for large terminal
134	readability.
135
136-t::
137--field-separator=::
138	Use a special separator character and don't pad with spaces, replacing
139	all occurrences of this separator in symbol names (and other output)
140	with a '.' character, that thus it's the only non valid separator.
141
142-D::
143--dump-raw-trace::
144        Dump raw trace in ASCII.
145
146-g [type,min[,limit],order[,key]]::
147--call-graph::
148        Display call chains using type, min percent threshold, optional print
149	limit and order.
150	type can be either:
151	- flat: single column, linear exposure of call chains.
152	- graph: use a graph tree, displaying absolute overhead rates.
153	- fractal: like graph, but displays relative rates. Each branch of
154		 the tree is considered as a new profiled object. +
155
156	order can be either:
157	- callee: callee based call graph.
158	- caller: inverted caller based call graph.
159
160	key can be:
161	- function: compare on functions
162	- address: compare on individual code addresses
163
164	Default: fractal,0.5,callee,function.
165
166--children::
167	Accumulate callchain of children to parent entry so that then can
168	show up in the output.  The output will have a new "Children" column
169	and will be sorted on the data.  It requires callchains are recorded.
170
171--max-stack::
172	Set the stack depth limit when parsing the callchain, anything
173	beyond the specified depth will be ignored. This is a trade-off
174	between information loss and faster processing especially for
175	workloads that can have a very long callchain stack.
176
177	Default: 127
178
179-G::
180--inverted::
181        alias for inverted caller based call graph.
182
183--ignore-callees=<regex>::
184        Ignore callees of the function(s) matching the given regex.
185        This has the effect of collecting the callers of each such
186        function into one place in the call-graph tree.
187
188--pretty=<key>::
189        Pretty printing style.  key: normal, raw
190
191--stdio:: Use the stdio interface.
192
193--tui:: Use the TUI interface, that is integrated with annotate and allows
194        zooming into DSOs or threads, among other features. Use of --tui
195	requires a tty, if one is not present, as when piping to other
196	commands, the stdio interface is used.
197
198--gtk:: Use the GTK2 interface.
199
200-k::
201--vmlinux=<file>::
202        vmlinux pathname
203
204--kallsyms=<file>::
205        kallsyms pathname
206
207-m::
208--modules::
209        Load module symbols. WARNING: This should only be used with -k and
210        a LIVE kernel.
211
212-f::
213--force::
214        Don't complain, do it.
215
216--symfs=<directory>::
217        Look for files with symbols relative to this directory.
218
219-C::
220--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
221	be provided as a comma-separated list with no space: 0,1. Ranges of
222	CPUs are specified with -: 0-2. Default is to report samples on all
223	CPUs.
224
225-M::
226--disassembler-style=:: Set disassembler style for objdump.
227
228--source::
229	Interleave source code with assembly code. Enabled by default,
230	disable with --no-source.
231
232--asm-raw::
233	Show raw instruction encoding of assembly instructions.
234
235--show-total-period:: Show a column with the sum of periods.
236
237-I::
238--show-info::
239	Display extended information about the perf.data file. This adds
240	information which may be very large and thus may clutter the display.
241	It currently includes: cpu and numa topology of the host system.
242
243-b::
244--branch-stack::
245	Use the addresses of sampled taken branches instead of the instruction
246	address to build the histograms. To generate meaningful output, the
247	perf.data file must have been obtained using perf record -b or
248	perf record --branch-filter xxx where xxx is a branch filter option.
249	perf report is able to auto-detect whether a perf.data file contains
250	branch stacks and it will automatically switch to the branch view mode,
251	unless --no-branch-stack is used.
252
253--objdump=<path>::
254        Path to objdump binary.
255
256--group::
257	Show event group information together.
258
259--demangle::
260	Demangle symbol names to human readable form. It's enabled by default,
261	disable with --no-demangle.
262
263--percent-limit::
264	Do not show entries which have an overhead under that percent.
265	(Default: 0).
266
267--percentage::
268	Determine how to display the overhead percentage of filtered entries.
269	Filters can be applied by --comms, --dsos and/or --symbols options and
270	Zoom operations on the TUI (thread, dso, etc).
271
272	"relative" means it's relative to filtered entries only so that the
273	sum of shown entries will be always 100%.  "absolute" means it retains
274	the original value before and after the filter is applied.
275
276--header::
277	Show header information in the perf.data file.  This includes
278	various information like hostname, OS and perf version, cpu/mem
279	info, perf command line, event list and so on.  Currently only
280	--stdio output supports this feature.
281
282--header-only::
283	Show only perf.data header (forces --stdio).
284
285SEE ALSO
286--------
287linkperf:perf-stat[1], linkperf:perf-annotate[1]
288