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 --group::
  54         Put the counters into a counter group.
  55
  56 -F <freq>::
  57 --freq=<freq>::
  58         Profile at this frequency.
  59
  60 -i::
  61 --inherit::
  62         Child tasks do not inherit counters.
  63
  64 -k <path>::
  65 --vmlinux=<path>::
  66         Path to vmlinux.  Required for annotation functionality.
  67
  68 -m <pages>::
  69 --mmap-pages=<pages>::
  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.
  73
  74 -p <pid>::
  75 --pid=<pid>::
  76         Profile events on existing Process ID (comma separated list).
  77
  78 -t <tid>::
  79 --tid=<tid>::
  80         Profile events on existing thread ID (comma separated list).
  81
  82 -u::
  83 --uid=::
  84         Record events in threads owned by uid. Name or number.
  85
  86 -r <priority>::
  87 --realtime=<priority>::
  88         Collect data with this RT SCHED_FIFO priority.
  89
  90 -s <symbol>::
  91 --sym-annotate=<symbol>::
  92         Annotate this symbol.
  93
  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
 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
 114 -s::
 115 --sort::
 116         Sort by key(s): pid, comm, dso, symbol, parent, srcline, weight,
 117         local_weight, abort, in_tx, transaction
 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
 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
 145 -g::
 146         Enables call-graph (stack chain/backtrace) recording.
 147
 148 --call-graph::
 149         Setup and enable call-graph (stack chain/backtrace) recording,
 150         implies -g.
 151
 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
 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
 165 --percent-limit::
 166         Do not show entries which have an overhead under that percent.
 167         (Default: 0).
 168
 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
 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
 201
 202 SEE ALSO
 203 --------
 204 linkperf:perf-stat[1], linkperf:perf-list[1]