1f9687663f2a9cd62d6cff9f597395523b3da931
[linux-2.6.git] / 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-list>::
29 --cpu=<cpu>::
30 Monitor only on the list of cpus provided. Multiple CPUs can be provided as a
31 comma-sperated 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 -F <freq>::
54 --freq=<freq>::
55         Profile at this frequency.
56
57 -i::
58 --inherit::
59         Child tasks inherit counters, only makes sens with -p option.
60
61 -k <path>::
62 --vmlinux=<path>::
63         Path to vmlinux.  Required for annotation functionality.
64
65 -m <pages>::
66 --mmap-pages=<pages>::
67         Number of mmapped data pages.
68
69 -p <pid>::
70 --pid=<pid>::
71         Profile events on existing pid.
72
73 -r <priority>::
74 --realtime=<priority>::
75         Collect data with this RT SCHED_FIFO priority.
76
77 -s <symbol>::
78 --sym-annotate=<symbol>::
79         Annotate this symbol.
80
81 -v::
82 --verbose::
83         Be more verbose (show counter open errors, etc).
84
85 -z::
86 --zero::
87         Zero history across display updates.
88
89 INTERACTIVE PROMPTING KEYS
90 --------------------------
91
92 [d]::
93         Display refresh delay.
94
95 [e]::
96         Number of entries to display.
97
98 [E]::
99         Event to display when multiple counters are active.
100
101 [f]::
102         Profile display filter (>= hit count).
103
104 [F]::
105         Annotation display filter (>= % of total).
106
107 [s]::
108         Annotate symbol.
109
110 [S]::
111         Stop annotation, return to full profile display.
112
113 [w]::
114         Toggle between weighted sum and individual count[E]r profile.
115
116 [z]::
117         Toggle event count zeroing across display updates.
118
119 [qQ]::
120         Quit.
121
122 Pressing any unmapped key displays a menu, and prompts for input.
123
124
125 SEE ALSO
126 --------
127 linkperf:perf-stat[1], linkperf:perf-list[1]