Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / kernel / common / ab81f3fd350c510730adb1ca40ef55c2b2952121 / . / tools / perf / Documentation / perf-top.txt
blob: d146ba33d69114c676cd32f559b0e83cb7a3c02d [file] [log] [blame]
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]1perf-top(1)
Ingo Molnar6e6b7542008-04-15 22:39:31 +0200[diff] [blame]2===========
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]3
4NAME
5----
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]6perf-top - System profiling tool.
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]7
8SYNOPSIS
9--------
10[verse]
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]11'perf top' [-e <EVENT> | --event=EVENT] [<options>]
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]12
13DESCRIPTION
14-----------
Shawn Bohrer2e7a9882010-11-30 19:57:21 -0600[diff] [blame]15This command generates and displays a performance counter profile in real time.
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]16
17
18OPTIONS
19-------
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]20-a::
21--all-cpus::
22 System-wide collection. (default)
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]23
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]24-c <count>::
25--count=<count>::
26 Event period to sample.
27
Stephane Eranianc45c6ea2010-05-28 12:00:01 +0200[diff] [blame]28-C <cpu-list>::
29--cpu=<cpu>::
Shawn Bohrer2e7a9882010-11-30 19:57:21 -0600[diff] [blame]30Monitor only on the list of CPUs provided. Multiple CPUs can be provided as a
31comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2.
Stephane Eranianc45c6ea2010-05-28 12:00:01 +0200[diff] [blame]32Default is to monitor all CPUS.
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]33
34-d <seconds>::
35--delay=<seconds>::
36 Number of seconds to delay between refreshes.
37
38-e <event>::
39--event=<event>::
Thomas Gleixner386b05e2009-06-06 14:56:33 +0200[diff] [blame]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
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]43 hexadecimal event descriptor.
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]44
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]45-E <entries>::
46--entries=<entries>::
47 Display this many functions.
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]48
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]49-f <count>::
50--count-filter=<count>::
51 Only display functions with more events than this.
52
Shawn Bohrer2e7a9882010-11-30 19:57:21 -0600[diff] [blame]53-g::
54--group::
55 Put the counters into a counter group.
56
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]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>::
Shawn Bohrer2e7a9882010-11-30 19:57:21 -0600[diff] [blame]75 Profile events on existing Process ID.
76
77-t <tid>::
78--tid=<tid>::
79 Profile events on existing thread ID.
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]80
81-r <priority>::
82--realtime=<priority>::
83 Collect data with this RT SCHED_FIFO priority.
84
85-s <symbol>::
86--sym-annotate=<symbol>::
Kirill Smelkov6cff0e82010-02-03 16:52:08 -0200[diff] [blame]87 Annotate this symbol.
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]88
Shawn Bohrer2e7a9882010-11-30 19:57:21 -0600[diff] [blame]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
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]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
Arnaldo Carvalho de Meloab81f3fd2011-10-05 19:16:15 -0300[diff] [blame^]109-s::
110--sort::
111 Sort by key(s): pid, comm, dso, symbol, parent
112
113-n::
114--show-nr-samples::
115 Show a column with the number of samples.
116
117--show-total-period::
118 Show a column with the sum of periods.
119
120--dsos::
121 Only consider symbols in these dsos.
122
123--comms::
124 Only consider symbols in these comms.
125
126--symbols::
127 Only consider these symbols.
128
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]129INTERACTIVE PROMPTING KEYS
130--------------------------
131
132[d]::
133 Display refresh delay.
134
135[e]::
136 Number of entries to display.
137
138[E]::
139 Event to display when multiple counters are active.
140
141[f]::
142 Profile display filter (>= hit count).
143
144[F]::
145 Annotation display filter (>= % of total).
146
147[s]::
148 Annotate symbol.
149
150[S]::
151 Stop annotation, return to full profile display.
152
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]153[z]::
154 Toggle event count zeroing across display updates.
155
156[qQ]::
157 Quit.
158
159Pressing any unmapped key displays a menu, and prompts for input.
160
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]161
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]162SEE ALSO
163--------
Thomas Gleixner386b05e2009-06-06 14:56:33 +0200[diff] [blame]164linkperf:perf-stat[1], linkperf:perf-list[1]