Pileus Git - ~andy/linux/blob - 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 mmap data pages (must be a power of two) or size
  72         specification with appended unit character - B/K/M/G. The
  73         size is rounded up to have nearest pages power of two value.
  74
  75 -p <pid>::
  76 --pid=<pid>::
  77         Profile events on existing Process ID (comma separated list).
  78
  79 -t <tid>::
  80 --tid=<tid>::
  81         Profile events on existing thread ID (comma separated list).
  82
  83 -u::
  84 --uid=::
  85         Record events in threads owned by uid. Name or number.
  86
  87 -r <priority>::
  88 --realtime=<priority>::
  89         Collect data with this RT SCHED_FIFO priority.
  90
  91 -s <symbol>::
  92 --sym-annotate=<symbol>::
  93         Annotate this symbol.
  94
  95 -K::
  96 --hide_kernel_symbols::
  97         Hide kernel symbols.
  98
  99 -U::
 100 --hide_user_symbols::
 101         Hide user symbols.
 102
 103 -D::
 104 --dump-symtab::
 105         Dump the symbol table used for profiling.
 106
 107 -v::
 108 --verbose::
 109         Be more verbose (show counter open errors, etc).
 110
 111 -z::
 112 --zero::
 113         Zero history across display updates.
 114
 115 -s::
 116 --sort::
 117         Sort by key(s): pid, comm, dso, symbol, parent, srcline, weight,
 118         local_weight, abort, in_tx, transaction
 119
 120 -n::
 121 --show-nr-samples::
 122         Show a column with the number of samples.
 123
 124 --show-total-period::
 125         Show a column with the sum of periods.
 126
 127 --dsos::
 128         Only consider symbols in these dsos.
 129
 130 --comms::
 131         Only consider symbols in these comms.
 132
 133 --symbols::
 134         Only consider these symbols.
 135
 136 -M::
 137 --disassembler-style=:: Set disassembler style for objdump.
 138
 139 --source::
 140         Interleave source code with assembly code. Enabled by default,
 141         disable with --no-source.
 142
 143 --asm-raw::
 144         Show raw instruction encoding of assembly instructions.
 145
 146 -G::
 147         Enables call-graph (stack chain/backtrace) recording.
 148
 149 --call-graph::
 150         Setup and enable call-graph (stack chain/backtrace) recording,
 151         implies -G.
 152
 153 --max-stack::
 154         Set the stack depth limit when parsing the callchain, anything
 155         beyond the specified depth will be ignored. This is a trade-off
 156         between information loss and faster processing especially for
 157         workloads that can have a very long callchain stack.
 158
 159         Default: 127
 160
 161 --ignore-callees=<regex>::
 162         Ignore callees of the function(s) matching the given regex.
 163         This has the effect of collecting the callers of each such
 164         function into one place in the call-graph tree.
 165
 166 --percent-limit::
 167         Do not show entries which have an overhead under that percent.
 168         (Default: 0).
 169
 170 INTERACTIVE PROMPTING KEYS
 171 --------------------------
 172
 173 [d]::
 174         Display refresh delay.
 175
 176 [e]::
 177         Number of entries to display.
 178
 179 [E]::
 180         Event to display when multiple counters are active.
 181
 182 [f]::
 183         Profile display filter (>= hit count).
 184
 185 [F]::
 186         Annotation display filter (>= % of total).
 187
 188 [s]::
 189         Annotate symbol.
 190
 191 [S]::
 192         Stop annotation, return to full profile display.
 193
 194 [z]::
 195         Toggle event count zeroing across display updates.
 196
 197 [qQ]::
 198         Quit.
 199
 200 Pressing any unmapped key displays a menu, and prompts for input.
 201
 202
 203 SEE ALSO
 204 --------
 205 linkperf:perf-stat[1], linkperf:perf-list[1]