Home | History | Annotate | Download | only in Documentation
      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 inherit counters, only makes sens with -p option.
     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.
     76 
     77 -t <tid>::
     78 --tid=<tid>::
     79         Profile events on existing thread ID.
     80 
     81 -r <priority>::
     82 --realtime=<priority>::
     83 	Collect data with this RT SCHED_FIFO priority.
     84 
     85 -s <symbol>::
     86 --sym-annotate=<symbol>::
     87         Annotate this symbol.
     88 
     89 -K::
     90 --hide_kernel_symbols::
     91         Hide kernel symbols.
     92 
     93 -U::
     94 --hide_user_symbols::
     95         Hide user symbols.
     96 
     97 -D::
     98 --dump-symtab::
     99         Dump the symbol table used for profiling.
    100 
    101 -v::
    102 --verbose::
    103 	Be more verbose (show counter open errors, etc).
    104 
    105 -z::
    106 --zero::
    107 	Zero history across display updates.
    108 
    109 INTERACTIVE PROMPTING KEYS
    110 --------------------------
    111 
    112 [d]::
    113 	Display refresh delay.
    114 
    115 [e]::
    116 	Number of entries to display.
    117 
    118 [E]::
    119 	Event to display when multiple counters are active.
    120 
    121 [f]::
    122 	Profile display filter (>= hit count).
    123 
    124 [F]::
    125 	Annotation display filter (>= % of total).
    126 
    127 [s]::
    128 	Annotate symbol.
    129 
    130 [S]::
    131 	Stop annotation, return to full profile display.
    132 
    133 [w]::
    134 	Toggle between weighted sum and individual count[E]r profile.
    135 
    136 [z]::
    137 	Toggle event count zeroing across display updates.
    138 
    139 [qQ]::
    140 	Quit.
    141 
    142 Pressing any unmapped key displays a menu, and prompts for input.
    143 
    144 
    145 SEE ALSO
    146 --------
    147 linkperf:perf-stat[1], linkperf:perf-list[1]
    148