1PERF-TOP(1) perf Manual PERF-TOP(1)
2
6 perf-top - System profiling tool.
7
9 perf top [-e <EVENT> | --event=EVENT] [<options>]
10
12 This command generates and displays a performance counter profile in
13 real time.
14
16 -a, --all-cpus
17 System-wide collection. (default)
18 -c <count>, --count=<count>
20 Event period to sample.
21 -C <cpu-list>, --cpu=<cpu>
23 Monitor only on the list of CPUs provided. Multiple CPUs can be
24 provided as a comma-separated list with no space: 0,1. Ranges of
25 CPUs are specified with -: 0-2. Default is to monitor all CPUS.
26 -d <seconds>, --delay=<seconds>
28 Number of seconds to delay between refreshes.
29 -e <event>, --event=<event>
31 Select the PMU event. Selection can be a symbolic event name (use
32 perf list to list all events) or a raw PMU event (eventsel+umask)
33 in the form of rNNN where NNN is a hexadecimal event descriptor.
34 -E <entries>, --entries=<entries>
36 Display this many functions.
37 -f <count>, --count-filter=<count>
39 Only display functions with more events than this.
40 --group
42 Put the counters into a counter group.
43 -F <freq>, --freq=<freq>
45 Profile at this frequency. Use max to use the currently maximum
46 allowed frequency, i.e. the value in the
47 kernel.perf_event_max_sample_rate sysctl.
48 -i, --inherit
50 Child tasks do not inherit counters.
51 -k <path>, --vmlinux=<path>
53 Path to vmlinux. Required for annotation functionality.
54 --ignore-vmlinux
56 Ignore vmlinux files.
57 --kallsyms=<file>
59 kallsyms pathname
60 -m <pages>, --mmap-pages=<pages>
62 Number of mmap data pages (must be a power of two) or size
63 specification with appended unit character - B/K/M/G. The size is
64 rounded up to have nearest pages power of two value.
65 -p <pid>, --pid=<pid>
67 Profile events on existing Process ID (comma separated list).
68 -t <tid>, --tid=<tid>
70 Profile events on existing thread ID (comma separated list).
71 -u, --uid=
73 Record events in threads owned by uid. Name or number.
74 -r <priority>, --realtime=<priority>
76 Collect data with this RT SCHED_FIFO priority.
77 --sym-annotate=<symbol>
79 Annotate this symbol.
80 -K, --hide_kernel_symbols
82 Hide kernel symbols.
83 -U, --hide_user_symbols
85 Hide user symbols.
86 --demangle-kernel
88 Demangle kernel symbols.
89 -D, --dump-symtab
91 Dump the symbol table used for profiling.
92 -v, --verbose
94 Be more verbose (show counter open errors, etc).
95 -z, --zero
97 Zero history across display updates.
98 -s, --sort
100 Sort by key(s): pid, comm, dso, symbol, parent, srcline, weight,
101 local_weight, abort, in_tx, transaction, overhead, sample, period.
102 Please see description of --sort in the perf-report man page.
103 --fields=
105 Specify output field - multiple keys can be specified in CSV
106 format. Following fields are available: overhead, overhead_sys,
107 overhead_us, overhead_children, sample and period. Also it can
108 contain any sort key(s).
109 By default, every sort keys not specified in --field will be appended
111 automatically.
112 -n, --show-nr-samples
114 Show a column with the number of samples.
115 --show-total-period
117 Show a column with the sum of periods.
118 --dsos
120 Only consider symbols in these dsos. This option will affect the
121 percentage of the overhead column. See --percentage for more info.
122 --comms
124 Only consider symbols in these comms. This option will affect the
125 percentage of the overhead column. See --percentage for more info.
126 --symbols
128 Only consider these symbols. This option will affect the percentage
129 of the overhead column. See --percentage for more info.
130 -M, --disassembler-style=
132 Set disassembler style for objdump.
133 --source
135 Interleave source code with assembly code. Enabled by default,
136 disable with --no-source.
137 --asm-raw
139 Show raw instruction encoding of assembly instructions.
140 -g
142 Enables call-graph (stack chain/backtrace) recording.
143 --call-graph [mode,type,min[,limit],order[,key][,branch]]
145 Setup and enable call-graph (stack chain/backtrace) recording,
146 implies -g. See --call-graph section in perf-record and perf-report
147 man pages for details.
148 --children
150 Accumulate callchain of children to parent entry so that then can
151 show up in the output. The output will have a new "Children" column
152 and will be sorted on the data. It requires -g/--call-graph option
153 enabled. See the ‘overhead calculation’ section for more details.
154 Enabled by default, disable with --no-children.
155 --max-stack
157 Set the stack depth limit when parsing the callchain, anything
158 beyond the specified depth will be ignored. This is a trade-off
159 between information loss and faster processing especially for
160 workloads that can have a very long callchain stack.
161 Default: /proc/sys/kernel/perf_event_max_stack when present, 127 otherwise.
163 --ignore-callees=<regex>
165 Ignore callees of the function(s) matching the given regex. This
166 has the effect of collecting the callers of each such function into
167 one place in the call-graph tree.
168 --percent-limit
170 Do not show entries which have an overhead under that percent.
171 (Default: 0).
172 --percentage
174 Determine how to display the overhead percentage of filtered
175 entries. Filters can be applied by --comms, --dsos and/or --symbols
176 options and Zoom operations on the TUI (thread, dso, etc).
177 "relative" means it's relative to filtered entries only so that the
179 sum of shown entries will be always 100%. "absolute" means it retains
180 the original value before and after the filter is applied.
181 -w, --column-widths=<width[,width...]>
183 Force each column width to the provided list, for large terminal
184 readability. 0 means no limit (default behavior).
185 --proc-map-timeout
187 When processing pre-existing threads /proc/XXX/mmap, it may take a
188 long time, because the file may be huge. A time out is needed in
189 such cases. This option sets the time out limit. The default value
190 is 500 ms.
191 -b, --branch-any
193 Enable taken branch stack sampling. Any type of taken branch may be
194 sampled. This is a shortcut for --branch-filter any. See
195 --branch-filter for more infos.
196 -j, --branch-filter
198 Enable taken branch stack sampling. Each sample captures a series
199 of consecutive taken branches. The number of branches captured with
200 each sample depends on the underlying hardware, the type of
201 branches of interest, and the executed code. It is possible to
202 select the types of branches captured by enabling filters. For a
203 full list of modifiers please see the perf record manpage.
204 The option requires at least one branch type among any, any_call, any_ret, ind_call, cond.
206 The privilege levels may be omitted, in which case, the privilege levels of the associated
207 event are applied to the branch filter. Both kernel (k) and hypervisor (hv) privilege
208 levels are subject to permissions. When sampling on multiple events, branch stack sampling
209 is enabled for all the sampling events. The sampled branch type is the same for all events.
210 The various filters must be specified as a comma separated list: --branch-filter any_ret,u,k
211 Note that this feature may not be available on all processors.
212 --raw-trace
214 When displaying traceevent output, do not use print fmt or plugins.
215 --hierarchy
217 Enable hierarchy output.
218 --overwrite
220 Enable this to use just the most recent records, which helps in
221 high core count machines such as Knights Landing/Mill, but right
222 now is disabled by default as the pausing used in this technique is
223 leading to loss of metadata events such as PERF_RECORD_MMAP which
224 makes perf top unable to resolve samples, leading to lots of
225 unknown samples appearing on the UI. Enable this if you are in such
226 machines and profiling a workload that doesn’t creates short lived
227 threads and/or doesn’t uses many executable mmap operations. Work
228 is being planed to solve this situation, till then, this will
229 remain disabled by default.
230 --force
232 Don’t do ownership validation.
233 --num-thread-synthesize
235 The number of threads to run when synthesizing events for existing
236 processes. By default, the number of threads equals to the number
237 of online CPUs.
238
240 [d]
241 Display refresh delay.
242 [e]
244 Number of entries to display.
245 [E]
247 Event to display when multiple counters are active.
248 [f]
250 Profile display filter (>= hit count).
251 [F]
253 Annotation display filter (>= % of total).
254 [s]
256 Annotate symbol.
257 [S]
259 Stop annotation, return to full profile display.
260 [K]
262 Hide kernel symbols.
263 [U]
265 Hide user symbols.
266 [z]
268 Toggle event count zeroing across display updates.
269 [qQ]
271 Quit.
272 Pressing any unmapped key displays a menu, and prompts for input.
274
276 The overhead can be shown in two columns as Children and Self when perf
277 collects callchains. The self overhead is simply calculated by adding
278 all period values of the entry - usually a function (symbol). This is
279 the value that perf shows traditionally and sum of all the self
280 overhead values should be 100%.
281 The children overhead is calculated by adding all period values of the
283 child functions so that it can show the total overhead of the higher
284 level functions even if they don’t directly execute much. Children here
285 means functions that are called from another (parent) function.
286 It might be confusing that the sum of all the children overhead values
288 exceeds 100% since each of them is already an accumulation of self
289 overhead of its child functions. But with this enabled, users can find
290 which function has the most overhead even if samples are spread over
291 the children.
292 Consider the following example; there are three functions like below.
294 .ft C
297 void foo(void) {
298 /* do something */
299 }
300 void bar(void) {
302 /* do something */
303 foo();
304 }
305 int main(void) {
307 bar()
308 return 0;
309 }
310 .ft
311 In this case foo is a child of bar, and bar is an immediate child of
314 main so foo also is a child of main. In other words, main is a parent
315 of foo and bar, and bar is a parent of foo.
316 Suppose all samples are recorded in foo and bar only. When it’s
318 recorded with callchains the output will show something like below in
319 the usual (self-overhead-only) output of perf report:
320 .ft C
323 Overhead Symbol
324 ........ .....................
325 60.00% foo
326 |
327 --- foo
328 bar
329 main
330 __libc_start_main
331 40.00% bar
333 |
334 --- bar
335 main
336 __libc_start_main
337 .ft
338 When the --children option is enabled, the self overhead values of
341 child functions (i.e. foo and bar) are added to the parents to
342 calculate the children overhead. In this case the report could be
343 displayed as:
344 .ft C
347 Children Self Symbol
348 ........ ........ ....................
349 100.00% 0.00% __libc_start_main
350 |
351 --- __libc_start_main
352 100.00% 0.00% main
354 |
355 --- main
356 __libc_start_main
357 100.00% 40.00% bar
359 |
360 --- bar
361 main
362 __libc_start_main
363 60.00% 60.00% foo
365 |
366 --- foo
367 bar
368 main
369 __libc_start_main
370 .ft
371 In the above output, the self overhead of foo (60%) was add to the
374 children overhead of bar, main and __libc_start_main. Likewise, the
375 self overhead of bar (40%) was added to the children overhead of main
376 and \_\_libc_start_main.
377 So \_\_libc_start_main and main are shown first since they have same
379 (100%) children overhead (even though they have zero self overhead) and
380 they are the parents of foo and bar.
381 Since v3.16 the children overhead is shown by default and the output is
383 sorted by its values. The children overhead is disabled by specifying
384 --no-children option on the command line or by adding report.children =
385 false or top.children = false in the perf config file.
386
388 perf-stat(1), perf-list(1), perf-report(1)
389perf 06/03/2019 PERF-TOP(1)