Commit | Line | Data |
---|---|---|
1d8c8b20 | 1 | perf-top(1) |
6e6b754f | 2 | =========== |
1d8c8b20 IM |
3 | |
4 | NAME | |
5 | ---- | |
83617983 | 6 | perf-top - System profiling tool. |
1d8c8b20 IM |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
83617983 | 11 | 'perf top' [-e <EVENT> | --event=EVENT] [<options>] |
1d8c8b20 IM |
12 | |
13 | DESCRIPTION | |
14 | ----------- | |
2e7a9881 | 15 | This command generates and displays a performance counter profile in real time. |
1d8c8b20 IM |
16 | |
17 | ||
18 | OPTIONS | |
19 | ------- | |
83617983 MG |
20 | -a:: |
21 | --all-cpus:: | |
22 | System-wide collection. (default) | |
23 | ||
24 | -c <count>:: | |
25 | --count=<count>:: | |
26 | Event period to sample. | |
27 | ||
c45c6ea2 SE |
28 | -C <cpu-list>:: |
29 | --cpu=<cpu>:: | |
2e7a9881 SB |
30 | Monitor only on the list of CPUs provided. Multiple CPUs can be provided as a |
31 | comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2. | |
c45c6ea2 | 32 | Default is to monitor all CPUS. |
83617983 MG |
33 | |
34 | -d <seconds>:: | |
35 | --delay=<seconds>:: | |
36 | Number of seconds to delay between refreshes. | |
1d8c8b20 | 37 | |
83617983 MG |
38 | -e <event>:: |
39 | --event=<event>:: | |
386b05e3 TG |
40 | Select the PMU event. Selection can be a symbolic event name |
41 | (use 'perf list' to list all events) or a raw PMU | |
42 | event (eventsel+umask) in the form of rNNN where NNN is a | |
83617983 | 43 | hexadecimal event descriptor. |
1d8c8b20 | 44 | |
83617983 MG |
45 | -E <entries>:: |
46 | --entries=<entries>:: | |
47 | Display this many functions. | |
48 | ||
49 | -f <count>:: | |
50 | --count-filter=<count>:: | |
51 | Only display functions with more events than this. | |
52 | ||
2e7a9881 SB |
53 | --group:: |
54 | Put the counters into a counter group. | |
55 | ||
83617983 MG |
56 | -F <freq>:: |
57 | --freq=<freq>:: | |
7831bf23 ACM |
58 | Profile at this frequency. Use 'max' to use the currently maximum |
59 | allowed frequency, i.e. the value in the kernel.perf_event_max_sample_rate | |
60 | sysctl. | |
83617983 MG |
61 | |
62 | -i:: | |
63 | --inherit:: | |
2376c67a | 64 | Child tasks do not inherit counters. |
83617983 MG |
65 | |
66 | -k <path>:: | |
67 | --vmlinux=<path>:: | |
68 | Path to vmlinux. Required for annotation functionality. | |
69 | ||
a8403912 ACM |
70 | --ignore-vmlinux:: |
71 | Ignore vmlinux files. | |
72 | ||
83617983 MG |
73 | -m <pages>:: |
74 | --mmap-pages=<pages>:: | |
27050f53 JO |
75 | Number of mmap data pages (must be a power of two) or size |
76 | specification with appended unit character - B/K/M/G. The | |
77 | size is rounded up to have nearest pages power of two value. | |
83617983 MG |
78 | |
79 | -p <pid>:: | |
80 | --pid=<pid>:: | |
b52956c9 | 81 | Profile events on existing Process ID (comma separated list). |
2e7a9881 SB |
82 | |
83 | -t <tid>:: | |
84 | --tid=<tid>:: | |
b52956c9 | 85 | Profile events on existing thread ID (comma separated list). |
83617983 | 86 | |
0d37aa34 ACM |
87 | -u:: |
88 | --uid=:: | |
89 | Record events in threads owned by uid. Name or number. | |
90 | ||
83617983 MG |
91 | -r <priority>:: |
92 | --realtime=<priority>:: | |
93 | Collect data with this RT SCHED_FIFO priority. | |
94 | ||
83617983 | 95 | --sym-annotate=<symbol>:: |
6cff0e8d | 96 | Annotate this symbol. |
83617983 | 97 | |
2e7a9881 SB |
98 | -K:: |
99 | --hide_kernel_symbols:: | |
100 | Hide kernel symbols. | |
101 | ||
102 | -U:: | |
103 | --hide_user_symbols:: | |
104 | Hide user symbols. | |
105 | ||
763122ad AK |
106 | --demangle-kernel:: |
107 | Demangle kernel symbols. | |
108 | ||
2e7a9881 SB |
109 | -D:: |
110 | --dump-symtab:: | |
111 | Dump the symbol table used for profiling. | |
112 | ||
83617983 MG |
113 | -v:: |
114 | --verbose:: | |
115 | Be more verbose (show counter open errors, etc). | |
116 | ||
117 | -z:: | |
118 | --zero:: | |
119 | Zero history across display updates. | |
120 | ||
ab81f3fd ACM |
121 | -s:: |
122 | --sort:: | |
f5d05bce | 123 | Sort by key(s): pid, comm, dso, symbol, parent, srcline, weight, |
a2ce067e NK |
124 | local_weight, abort, in_tx, transaction, overhead, sample, period. |
125 | Please see description of --sort in the perf-report man page. | |
ab81f3fd | 126 | |
6fe8c26d NK |
127 | --fields=:: |
128 | Specify output field - multiple keys can be specified in CSV format. | |
129 | Following fields are available: | |
1432ec34 | 130 | overhead, overhead_sys, overhead_us, overhead_children, sample and period. |
6fe8c26d NK |
131 | Also it can contain any sort key(s). |
132 | ||
133 | By default, every sort keys not specified in --field will be appended | |
134 | automatically. | |
135 | ||
ab81f3fd ACM |
136 | -n:: |
137 | --show-nr-samples:: | |
138 | Show a column with the number of samples. | |
139 | ||
140 | --show-total-period:: | |
141 | Show a column with the sum of periods. | |
142 | ||
143 | --dsos:: | |
33db4568 NK |
144 | Only consider symbols in these dsos. This option will affect the |
145 | percentage of the overhead column. See --percentage for more info. | |
ab81f3fd ACM |
146 | |
147 | --comms:: | |
33db4568 NK |
148 | Only consider symbols in these comms. This option will affect the |
149 | percentage of the overhead column. See --percentage for more info. | |
ab81f3fd ACM |
150 | |
151 | --symbols:: | |
33db4568 NK |
152 | Only consider these symbols. This option will affect the |
153 | percentage of the overhead column. See --percentage for more info. | |
ab81f3fd | 154 | |
64c6f0c7 ACM |
155 | -M:: |
156 | --disassembler-style=:: Set disassembler style for objdump. | |
157 | ||
158 | --source:: | |
159 | Interleave source code with assembly code. Enabled by default, | |
160 | disable with --no-source. | |
161 | ||
162 | --asm-raw:: | |
163 | Show raw instruction encoding of assembly instructions. | |
164 | ||
bf80669e | 165 | -g:: |
ae779a63 JO |
166 | Enables call-graph (stack chain/backtrace) recording. |
167 | ||
a2c10d39 | 168 | --call-graph [mode,type,min[,limit],order[,key][,branch]]:: |
ae779a63 | 169 | Setup and enable call-graph (stack chain/backtrace) recording, |
a2c10d39 NK |
170 | implies -g. See `--call-graph` section in perf-record and |
171 | perf-report man pages for details. | |
19d4ac3c | 172 | |
1432ec34 NK |
173 | --children:: |
174 | Accumulate callchain of children to parent entry so that then can | |
175 | show up in the output. The output will have a new "Children" column | |
176 | and will be sorted on the data. It requires -g/--call-graph option | |
dd309207 | 177 | enabled. See the `overhead calculation' section for more details. |
108a7c10 | 178 | Enabled by default, disable with --no-children. |
1432ec34 | 179 | |
5dbb6e81 WL |
180 | --max-stack:: |
181 | Set the stack depth limit when parsing the callchain, anything | |
182 | beyond the specified depth will be ignored. This is a trade-off | |
183 | between information loss and faster processing especially for | |
184 | workloads that can have a very long callchain stack. | |
185 | ||
4cb93446 | 186 | Default: /proc/sys/kernel/perf_event_max_stack when present, 127 otherwise. |
5dbb6e81 | 187 | |
b21484f1 GP |
188 | --ignore-callees=<regex>:: |
189 | Ignore callees of the function(s) matching the given regex. | |
190 | This has the effect of collecting the callers of each such | |
191 | function into one place in the call-graph tree. | |
192 | ||
fa5df943 NK |
193 | --percent-limit:: |
194 | Do not show entries which have an overhead under that percent. | |
195 | (Default: 0). | |
196 | ||
33db4568 NK |
197 | --percentage:: |
198 | Determine how to display the overhead percentage of filtered entries. | |
199 | Filters can be applied by --comms, --dsos and/or --symbols options and | |
200 | Zoom operations on the TUI (thread, dso, etc). | |
201 | ||
202 | "relative" means it's relative to filtered entries only so that the | |
203 | sum of shown entries will be always 100%. "absolute" means it retains | |
204 | the original value before and after the filter is applied. | |
205 | ||
cf59002f NK |
206 | -w:: |
207 | --column-widths=<width[,width...]>:: | |
208 | Force each column width to the provided list, for large terminal | |
209 | readability. 0 means no limit (default behavior). | |
210 | ||
9d9cad76 KL |
211 | --proc-map-timeout:: |
212 | When processing pre-existing threads /proc/XXX/mmap, it may take | |
213 | a long time, because the file may be huge. A time out is needed | |
214 | in such cases. | |
215 | This option sets the time out limit. The default value is 500 ms. | |
216 | ||
cf59002f | 217 | |
a18b027e AK |
218 | -b:: |
219 | --branch-any:: | |
220 | Enable taken branch stack sampling. Any type of taken branch may be sampled. | |
221 | This is a shortcut for --branch-filter any. See --branch-filter for more infos. | |
222 | ||
223 | -j:: | |
224 | --branch-filter:: | |
225 | Enable taken branch stack sampling. Each sample captures a series of consecutive | |
226 | taken branches. The number of branches captured with each sample depends on the | |
227 | underlying hardware, the type of branches of interest, and the executed code. | |
228 | It is possible to select the types of branches captured by enabling filters. | |
229 | For a full list of modifiers please see the perf record manpage. | |
230 | ||
231 | The option requires at least one branch type among any, any_call, any_ret, ind_call, cond. | |
232 | The privilege levels may be omitted, in which case, the privilege levels of the associated | |
233 | event are applied to the branch filter. Both kernel (k) and hypervisor (hv) privilege | |
234 | levels are subject to permissions. When sampling on multiple events, branch stack sampling | |
235 | is enabled for all the sampling events. The sampled branch type is the same for all events. | |
236 | The various filters must be specified as a comma separated list: --branch-filter any_ret,u,k | |
237 | Note that this feature may not be available on all processors. | |
238 | ||
053a3989 NK |
239 | --raw-trace:: |
240 | When displaying traceevent output, do not use print fmt or plugins. | |
241 | ||
c92fcfde NK |
242 | --hierarchy:: |
243 | Enable hierarchy output. | |
244 | ||
4e303fbe | 245 | --overwrite:: |
218d6111 ACM |
246 | Enable this to use just the most recent records, which helps in high core count |
247 | machines such as Knights Landing/Mill, but right now is disabled by default as | |
248 | the pausing used in this technique is leading to loss of metadata events such | |
249 | as PERF_RECORD_MMAP which makes 'perf top' unable to resolve samples, leading | |
250 | to lots of unknown samples appearing on the UI. Enable this if you are in such | |
251 | machines and profiling a workload that doesn't creates short lived threads and/or | |
252 | doesn't uses many executable mmap operations. Work is being planed to solve | |
253 | this situation, till then, this will remain disabled by default. | |
4e303fbe | 254 | |
868a8329 KJ |
255 | --force:: |
256 | Don't do ownership validation. | |
257 | ||
0c6b4994 KL |
258 | --num-thread-synthesize:: |
259 | The number of threads to run when synthesizing events for existing processes. | |
260 | By default, the number of threads equals to the number of online CPUs. | |
868a8329 | 261 | |
83617983 MG |
262 | INTERACTIVE PROMPTING KEYS |
263 | -------------------------- | |
264 | ||
265 | [d]:: | |
266 | Display refresh delay. | |
267 | ||
268 | [e]:: | |
269 | Number of entries to display. | |
270 | ||
271 | [E]:: | |
272 | Event to display when multiple counters are active. | |
273 | ||
274 | [f]:: | |
275 | Profile display filter (>= hit count). | |
276 | ||
277 | [F]:: | |
278 | Annotation display filter (>= % of total). | |
279 | ||
280 | [s]:: | |
281 | Annotate symbol. | |
282 | ||
283 | [S]:: | |
284 | Stop annotation, return to full profile display. | |
285 | ||
958964f8 SJ |
286 | [K]:: |
287 | Hide kernel symbols. | |
288 | ||
289 | [U]:: | |
290 | Hide user symbols. | |
291 | ||
83617983 MG |
292 | [z]:: |
293 | Toggle event count zeroing across display updates. | |
294 | ||
295 | [qQ]:: | |
296 | Quit. | |
297 | ||
298 | Pressing any unmapped key displays a menu, and prompts for input. | |
1d8c8b20 | 299 | |
dd309207 | 300 | include::callchain-overhead-calculation.txt[] |
1d8c8b20 | 301 | |
1d8c8b20 IM |
302 | SEE ALSO |
303 | -------- | |
a2ce067e | 304 | linkperf:perf-stat[1], linkperf:perf-list[1], linkperf:perf-report[1] |