Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm / 28f0721a79046056ced3b9bd79c319c5c417ec30 / . / tools / perf / Documentation / perf-top.txt
blob: 785b9fc32a46f45559a77c193ed56fdf9bfc7702 [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-----------
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]15This command generates and displays a performance counter profile in realtime.
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
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>::
Thomas Gleixner386b05e2009-06-06 14:56:33 +0200[diff] [blame]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
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]41 hexadecimal event descriptor.
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]42
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]43-E <entries>::
44--entries=<entries>::
45 Display this many functions.
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]46
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]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>::
Kirill Smelkov6cff0e82010-02-03 16:52:08 -0200[diff] [blame]77 Annotate this symbol.
Mike Galbraith83617982009-08-04 10:24:41 +0200[diff] [blame]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
87INTERACTIVE 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
120Pressing any unmapped key displays a menu, and prompts for input.
121
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]122
Ingo Molnar1d8c8b22009-04-20 15:52:29 +0200[diff] [blame]123SEE ALSO
124--------
Thomas Gleixner386b05e2009-06-06 14:56:33 +0200[diff] [blame]125linkperf:perf-stat[1], linkperf:perf-list[1]