tools/perf/Documentation/perf-top.txt

   1 perf-top(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 perf-top - System profiling tool.
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'perf top' [-e <EVENT> | --event=EVENT] [<options>]
  12
  13 DESCRIPTION
  14 -----------
  15 This command generates and displays a performance counter profile in real time.
  16
  17
  18 OPTIONS
  19 -------
  20 -a::
  21 --all-cpus::
  22         System-wide collection.  (default)
  23
  24 -c <count>::
  25 --count=<count>::
  26         Event period to sample.
  27
  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-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2.
  32 Default is to monitor all CPUS.
  33
  34 -d <seconds>::
  35 --delay=<seconds>::
  36         Number of seconds to delay between refreshes.
  37
  38 -e <event>::
  39 --event=<event>::
  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
  43         hexadecimal event descriptor.
  44
  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
  53 -g::
  54 --group::
  55         Put the counters into a counter group.
  56
  57 -F <freq>::
  58 --freq=<freq>::
  59         Profile at this frequency.
  60
  61 -i::
  62 --inherit::
  63         Child tasks do not inherit counters.
  64
  65 -k <path>::
  66 --vmlinux=<path>::
  67         Path to vmlinux.  Required for annotation functionality.
  68
  69 -m <pages>::
  70 --mmap-pages=<pages>::
  71         Number of mmapped data pages.
  72
  73 -p <pid>::
  74 --pid=<pid>::
  75         Profile events on existing Process ID (comma separated list).
  76
  77 -t <tid>::
  78 --tid=<tid>::
  79         Profile events on existing thread ID (comma separated list).
  80
  81 -u::
  82 --uid=::
  83         Record events in threads owned by uid. Name or number.
  84
  85 -r <priority>::
  86 --realtime=<priority>::
  87         Collect data with this RT SCHED_FIFO priority.
  88
  89 -s <symbol>::
  90 --sym-annotate=<symbol>::
  91         Annotate this symbol.
  92
  93 -K::
  94 --hide_kernel_symbols::
  95         Hide kernel symbols.
  96
  97 -U::
  98 --hide_user_symbols::
  99         Hide user symbols.
 100
 101 -D::
 102 --dump-symtab::
 103         Dump the symbol table used for profiling.
 104
 105 -v::
 106 --verbose::
 107         Be more verbose (show counter open errors, etc).
 108
 109 -z::
 110 --zero::
 111         Zero history across display updates.
 112
 113 -s::
 114 --sort::
 115         Sort by key(s): pid, comm, dso, symbol, parent, srcline, weight, local_weight.
 116
 117 -n::
 118 --show-nr-samples::
 119         Show a column with the number of samples.
 120
 121 --show-total-period::
 122         Show a column with the sum of periods.
 123
 124 --dsos::
 125         Only consider symbols in these dsos.
 126
 127 --comms::
 128         Only consider symbols in these comms.
 129
 130 --symbols::
 131         Only consider these symbols.
 132
 133 -M::
 134 --disassembler-style=:: Set disassembler style for objdump.
 135
 136 --source::
 137         Interleave source code with assembly code. Enabled by default,
 138         disable with --no-source.
 139
 140 --asm-raw::
 141         Show raw instruction encoding of assembly instructions.
 142
 143 -G::
 144         Enables call-graph (stack chain/backtrace) recording.
 145
 146 --call-graph::
 147         Setup and enable call-graph (stack chain/backtrace) recording,
 148         implies -G.
 149
 150 --ignore-callees=<regex>::
 151         Ignore callees of the function(s) matching the given regex.
 152         This has the effect of collecting the callers of each such
 153         function into one place in the call-graph tree.
 154
 155 --percent-limit::
 156         Do not show entries which have an overhead under that percent.
 157         (Default: 0).
 158
 159 INTERACTIVE PROMPTING KEYS
 160 --------------------------
 161
 162 [d]::
 163         Display refresh delay.
 164
 165 [e]::
 166         Number of entries to display.
 167
 168 [E]::
 169         Event to display when multiple counters are active.
 170
 171 [f]::
 172         Profile display filter (>= hit count).
 173
 174 [F]::
 175         Annotation display filter (>= % of total).
 176
 177 [s]::
 178         Annotate symbol.
 179
 180 [S]::
 181         Stop annotation, return to full profile display.
 182
 183 [z]::
 184         Toggle event count zeroing across display updates.
 185
 186 [qQ]::
 187         Quit.
 188
 189 Pressing any unmapped key displays a menu, and prompts for input.
 190
 191
 192 SEE ALSO
 193 --------
 194 linkperf:perf-stat[1], linkperf:perf-list[1]