| 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 | ----------- |
| Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 15 | This command generates and displays a performance counter profile in realtime. |
| 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>:: |
| 30 | Monitor only on the list of cpus provided. Multiple CPUs can be provided as a |
| 31 | comma-sperated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2. |
| 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 | |
| 53 | -F <freq>:: |
| 54 | --freq=<freq>:: |
| 55 | Profile at this frequency. |
| 56 | |
| 57 | -i:: |
| 58 | --inherit:: |
| 59 | Child tasks inherit counters, only makes sens with -p option. |
| 60 | |
| 61 | -k <path>:: |
| 62 | --vmlinux=<path>:: |
| 63 | Path to vmlinux. Required for annotation functionality. |
| 64 | |
| 65 | -m <pages>:: |
| 66 | --mmap-pages=<pages>:: |
| 67 | Number of mmapped data pages. |
| 68 | |
| 69 | -p <pid>:: |
| 70 | --pid=<pid>:: |
| 71 | Profile events on existing pid. |
| 72 | |
| 73 | -r <priority>:: |
| 74 | --realtime=<priority>:: |
| 75 | Collect data with this RT SCHED_FIFO priority. |
| 76 | |
| 77 | -s <symbol>:: |
| 78 | --sym-annotate=<symbol>:: |
| Kirill Smelkov | 6cff0e8 | 2010-02-03 16:52:08 -0200 | [diff] [blame] | 79 | Annotate this symbol. |
| Mike Galbraith | 8361798 | 2009-08-04 10:24:41 +0200 | [diff] [blame] | 80 | |
| 81 | -v:: |
| 82 | --verbose:: |
| 83 | Be more verbose (show counter open errors, etc). |
| 84 | |
| 85 | -z:: |
| 86 | --zero:: |
| 87 | Zero history across display updates. |
| 88 | |
| 89 | INTERACTIVE PROMPTING KEYS |
| 90 | -------------------------- |
| 91 | |
| 92 | [d]:: |
| 93 | Display refresh delay. |
| 94 | |
| 95 | [e]:: |
| 96 | Number of entries to display. |
| 97 | |
| 98 | [E]:: |
| 99 | Event to display when multiple counters are active. |
| 100 | |
| 101 | [f]:: |
| 102 | Profile display filter (>= hit count). |
| 103 | |
| 104 | [F]:: |
| 105 | Annotation display filter (>= % of total). |
| 106 | |
| 107 | [s]:: |
| 108 | Annotate symbol. |
| 109 | |
| 110 | [S]:: |
| 111 | Stop annotation, return to full profile display. |
| 112 | |
| 113 | [w]:: |
| 114 | Toggle between weighted sum and individual count[E]r profile. |
| 115 | |
| 116 | [z]:: |
| 117 | Toggle event count zeroing across display updates. |
| 118 | |
| 119 | [qQ]:: |
| 120 | Quit. |
| 121 | |
| 122 | Pressing any unmapped key displays a menu, and prompts for input. |
| 123 | |
| Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 124 | |
| Ingo Molnar | 1d8c8b2 | 2009-04-20 15:52:29 +0200 | [diff] [blame] | 125 | SEE ALSO |
| 126 | -------- |
| Thomas Gleixner | 386b05e | 2009-06-06 14:56:33 +0200 | [diff] [blame] | 127 | linkperf:perf-stat[1], linkperf:perf-list[1] |