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 realtime.
  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>::
  29 --CPU=<cpu>::
  30         CPU to profile.
  31
  32 -d <seconds>::
  33 --delay=<seconds>::
  34         Number of seconds to delay between refreshes.
  35
  36 -e <event>::
  37 --event=<event>::
  38         Select the PMU event. Selection can be a symbolic event name
  39         (use 'perf list' to list all events) or a raw PMU
  40         event (eventsel+umask) in the form of rNNN where NNN is a
  41         hexadecimal event descriptor.
  42
  43 -E <entries>::
  44 --entries=<entries>::
  45         Display this many functions.
  46
  47 -f <count>::
  48 --count-filter=<count>::
  49         Only display functions with more events than this.
  50
  51 -F <freq>::
  52 --freq=<freq>::
  53         Profile at this frequency.
  54
  55 -i::
  56 --inherit::
  57         Child tasks inherit counters, only makes sens with -p option.
  58
  59 -k <path>::
  60 --vmlinux=<path>::
  61         Path to vmlinux.  Required for annotation functionality.
  62
  63 -m <pages>::
  64 --mmap-pages=<pages>::
  65         Number of mmapped data pages.
  66
  67 -p <pid>::
  68 --pid=<pid>::
  69         Profile events on existing pid.
  70
  71 -r <priority>::
  72 --realtime=<priority>::
  73         Collect data with this RT SCHED_FIFO priority.
  74
  75 -s <symbol>::
  76 --sym-annotate=<symbol>::
  77         Annotate this symbol.  Requires -k option.
  78
  79 -v::
  80 --verbose::
  81         Be more verbose (show counter open errors, etc).
  82
  83 -z::
  84 --zero::
  85         Zero history across display updates.
  86
  87 INTERACTIVE PROMPTING KEYS
  88 --------------------------
  89
  90 [d]::
  91         Display refresh delay.
  92
  93 [e]::
  94         Number of entries to display.
  95
  96 [E]::
  97         Event to display when multiple counters are active.
  98
  99 [f]::
 100         Profile display filter (>= hit count).
 101
 102 [F]::
 103         Annotation display filter (>= % of total).
 104
 105 [s]::
 106         Annotate symbol.
 107
 108 [S]::
 109         Stop annotation, return to full profile display.
 110
 111 [w]::
 112         Toggle between weighted sum and individual count[E]r profile.
 113
 114 [z]::
 115         Toggle event count zeroing across display updates.
 116
 117 [qQ]::
 118         Quit.
 119
 120 Pressing any unmapped key displays a menu, and prompts for input.
 121
 122
 123 SEE ALSO
 124 --------
 125 linkperf:perf-stat[1], linkperf:perf-list[1]