Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 1 | perf-top(1) |
Ingo Molnar | 6e6b754 | 2008-04-15 22:39:31 +0200 | [diff] [blame] | 2 | =========== |
Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 3 | |
| 4 | NAME |
| 5 | ---- |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 6 | perf-top - System profiling tool. |
Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 7 | |
| 8 | SYNOPSIS |
| 9 | -------- |
| 10 | [verse] |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 11 | 'perf top' [-e <EVENT> | --event=EVENT] [<options>] |
Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 12 | |
| 13 | DESCRIPTION |
| 14 | ----------- |
Shawn Bohrer | 2e7a988 | 2010-11-30 19:57:21 -0600 | [diff] [blame] | 15 | This command generates and displays a performance counter profile in real time. |
Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 16 | |
| 17 | |
| 18 | OPTIONS |
| 19 | ------- |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 20 | -a:: |
| 21 | --all-cpus:: |
| 22 | System-wide collection. (default) |
Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 23 | |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 24 | -c <count>:: |
| 25 | --count=<count>:: |
| 26 | Event period to sample. |
| 27 | |
Stephane Eranian | c45c6ea | 2010-05-28 12:00:01 +0200 | [diff] [blame] | 28 | -C <cpu-list>:: |
| 29 | --cpu=<cpu>:: |
Shawn Bohrer | 2e7a988 | 2010-11-30 19:57:21 -0600 | [diff] [blame] | 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. |
Stephane Eranian | c45c6ea | 2010-05-28 12:00:01 +0200 | [diff] [blame] | 32 | Default is to monitor all CPUS. |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 33 | |
| 34 | -d <seconds>:: |
| 35 | --delay=<seconds>:: |
| 36 | Number of seconds to delay between refreshes. |
| 37 | |
| 38 | -e <event>:: |
| 39 | --event=<event>:: |
Thomas Gleixner | 386b05e | 2009-06-06 14:56:33 +0200 | [diff] [blame] | 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 |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 43 | hexadecimal event descriptor. |
Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 44 | |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 45 | -E <entries>:: |
| 46 | --entries=<entries>:: |
| 47 | Display this many functions. |
Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 48 | |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 49 | -f <count>:: |
| 50 | --count-filter=<count>:: |
| 51 | Only display functions with more events than this. |
| 52 | |
Shawn Bohrer | 2e7a988 | 2010-11-30 19:57:21 -0600 | [diff] [blame] | 53 | --group:: |
| 54 | Put the counters into a counter group. |
| 55 | |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 56 | -F <freq>:: |
| 57 | --freq=<freq>:: |
| 58 | Profile at this frequency. |
| 59 | |
| 60 | -i:: |
| 61 | --inherit:: |
Arnaldo Carvalho de Melo | 2376c67 | 2012-12-11 16:48:41 -0300 | [diff] [blame] | 62 | Child tasks do not inherit counters. |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 63 | |
| 64 | -k <path>:: |
| 65 | --vmlinux=<path>:: |
| 66 | Path to vmlinux. Required for annotation functionality. |
| 67 | |
| 68 | -m <pages>:: |
| 69 | --mmap-pages=<pages>:: |
Jiri Olsa | 27050f5 | 2013-09-01 12:36:13 +0200 | [diff] [blame] | 70 | Number of mmap data pages (must be a power of two) or size |
| 71 | specification with appended unit character - B/K/M/G. The |
| 72 | size is rounded up to have nearest pages power of two value. |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 73 | |
| 74 | -p <pid>:: |
| 75 | --pid=<pid>:: |
David Ahern | b52956c | 2012-02-08 09:32:52 -0700 | [diff] [blame] | 76 | Profile events on existing Process ID (comma separated list). |
Shawn Bohrer | 2e7a988 | 2010-11-30 19:57:21 -0600 | [diff] [blame] | 77 | |
| 78 | -t <tid>:: |
| 79 | --tid=<tid>:: |
David Ahern | b52956c | 2012-02-08 09:32:52 -0700 | [diff] [blame] | 80 | Profile events on existing thread ID (comma separated list). |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 81 | |
Arnaldo Carvalho de Melo | 0d37aa3 | 2012-01-19 14:08:15 -0200 | [diff] [blame] | 82 | -u:: |
| 83 | --uid=:: |
| 84 | Record events in threads owned by uid. Name or number. |
| 85 | |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 86 | -r <priority>:: |
| 87 | --realtime=<priority>:: |
| 88 | Collect data with this RT SCHED_FIFO priority. |
| 89 | |
| 90 | -s <symbol>:: |
| 91 | --sym-annotate=<symbol>:: |
Kirill Smelkov | 6cff0e8 | 2010-02-03 16:52:08 -0200 | [diff] [blame] | 92 | Annotate this symbol. |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 93 | |
Shawn Bohrer | 2e7a988 | 2010-11-30 19:57:21 -0600 | [diff] [blame] | 94 | -K:: |
| 95 | --hide_kernel_symbols:: |
| 96 | Hide kernel symbols. |
| 97 | |
| 98 | -U:: |
| 99 | --hide_user_symbols:: |
| 100 | Hide user symbols. |
| 101 | |
| 102 | -D:: |
| 103 | --dump-symtab:: |
| 104 | Dump the symbol table used for profiling. |
| 105 | |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 106 | -v:: |
| 107 | --verbose:: |
| 108 | Be more verbose (show counter open errors, etc). |
| 109 | |
| 110 | -z:: |
| 111 | --zero:: |
| 112 | Zero history across display updates. |
| 113 | |
Arnaldo Carvalho de Melo | ab81f3f | 2011-10-05 19:16:15 -0300 | [diff] [blame] | 114 | -s:: |
| 115 | --sort:: |
Andi Kleen | f5d05bc | 2013-09-20 07:40:41 -0700 | [diff] [blame] | 116 | Sort by key(s): pid, comm, dso, symbol, parent, srcline, weight, |
Andi Kleen | 475eeab | 2013-09-20 07:40:43 -0700 | [diff] [blame] | 117 | local_weight, abort, in_tx, transaction |
Arnaldo Carvalho de Melo | ab81f3f | 2011-10-05 19:16:15 -0300 | [diff] [blame] | 118 | |
| 119 | -n:: |
| 120 | --show-nr-samples:: |
| 121 | Show a column with the number of samples. |
| 122 | |
| 123 | --show-total-period:: |
| 124 | Show a column with the sum of periods. |
| 125 | |
| 126 | --dsos:: |
| 127 | Only consider symbols in these dsos. |
| 128 | |
| 129 | --comms:: |
| 130 | Only consider symbols in these comms. |
| 131 | |
| 132 | --symbols:: |
| 133 | Only consider these symbols. |
| 134 | |
Arnaldo Carvalho de Melo | 64c6f0c | 2011-10-06 12:48:31 -0300 | [diff] [blame] | 135 | -M:: |
| 136 | --disassembler-style=:: Set disassembler style for objdump. |
| 137 | |
| 138 | --source:: |
| 139 | Interleave source code with assembly code. Enabled by default, |
| 140 | disable with --no-source. |
| 141 | |
| 142 | --asm-raw:: |
| 143 | Show raw instruction encoding of assembly instructions. |
| 144 | |
David Ahern | bf80669 | 2013-11-14 20:51:30 -0700 | [diff] [blame] | 145 | -g:: |
Jiri Olsa | ae779a6 | 2013-10-26 16:25:34 +0200 | [diff] [blame] | 146 | Enables call-graph (stack chain/backtrace) recording. |
| 147 | |
Arnaldo Carvalho de Melo | 19d4ac3 | 2011-10-05 19:30:22 -0300 | [diff] [blame] | 148 | --call-graph:: |
Jiri Olsa | ae779a6 | 2013-10-26 16:25:34 +0200 | [diff] [blame] | 149 | Setup and enable call-graph (stack chain/backtrace) recording, |
David Ahern | bf80669 | 2013-11-14 20:51:30 -0700 | [diff] [blame] | 150 | implies -g. |
Arnaldo Carvalho de Melo | 19d4ac3 | 2011-10-05 19:30:22 -0300 | [diff] [blame] | 151 | |
Waiman Long | 5dbb6e8 | 2013-10-18 10:38:49 -0400 | [diff] [blame] | 152 | --max-stack:: |
| 153 | Set the stack depth limit when parsing the callchain, anything |
| 154 | beyond the specified depth will be ignored. This is a trade-off |
| 155 | between information loss and faster processing especially for |
| 156 | workloads that can have a very long callchain stack. |
| 157 | |
| 158 | Default: 127 |
| 159 | |
Greg Price | b21484f | 2012-12-06 21:48:05 -0800 | [diff] [blame] | 160 | --ignore-callees=<regex>:: |
| 161 | Ignore callees of the function(s) matching the given regex. |
| 162 | This has the effect of collecting the callers of each such |
| 163 | function into one place in the call-graph tree. |
| 164 | |
Namhyung Kim | fa5df94 | 2013-05-14 11:09:05 +0900 | [diff] [blame] | 165 | --percent-limit:: |
| 166 | Do not show entries which have an overhead under that percent. |
| 167 | (Default: 0). |
| 168 | |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 169 | INTERACTIVE PROMPTING KEYS |
| 170 | -------------------------- |
| 171 | |
| 172 | [d]:: |
| 173 | Display refresh delay. |
| 174 | |
| 175 | [e]:: |
| 176 | Number of entries to display. |
| 177 | |
| 178 | [E]:: |
| 179 | Event to display when multiple counters are active. |
| 180 | |
| 181 | [f]:: |
| 182 | Profile display filter (>= hit count). |
| 183 | |
| 184 | [F]:: |
| 185 | Annotation display filter (>= % of total). |
| 186 | |
| 187 | [s]:: |
| 188 | Annotate symbol. |
| 189 | |
| 190 | [S]:: |
| 191 | Stop annotation, return to full profile display. |
| 192 | |
Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 193 | [z]:: |
| 194 | Toggle event count zeroing across display updates. |
| 195 | |
| 196 | [qQ]:: |
| 197 | Quit. |
| 198 | |
| 199 | Pressing any unmapped key displays a menu, and prompts for input. |
| 200 | |
Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 201 | |
Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 202 | SEE ALSO |
| 203 | -------- |
Thomas Gleixner | 386b05e | 2009-06-06 14:56:33 +0200 | [diff] [blame] | 204 | linkperf:perf-stat[1], linkperf:perf-list[1] |