Loading...
1perf-list(1)
2============
3
4NAME
5----
6perf-list - List all symbolic event types
7
8SYNOPSIS
9--------
10[verse]
11'perf list' [hw|sw|cache|tracepoint|pmu|event_glob]
12
13DESCRIPTION
14-----------
15This command displays the symbolic event types which can be selected in the
16various perf commands with the -e option.
17
18[[EVENT_MODIFIERS]]
19EVENT MODIFIERS
20---------------
21
22Events can optionally have a modifier by appending a colon and one or
23more modifiers. Modifiers allow the user to restrict the events to be
24counted. The following modifiers exist:
25
26 u - user-space counting
27 k - kernel counting
28 h - hypervisor counting
29 I - non idle counting
30 G - guest counting (in KVM guests)
31 H - host counting (not in KVM guests)
32 p - precise level
33 P - use maximum detected precise level
34 S - read sample value (PERF_SAMPLE_READ)
35 D - pin the event to the PMU
36
37The 'p' modifier can be used for specifying how precise the instruction
38address should be. The 'p' modifier can be specified multiple times:
39
40 0 - SAMPLE_IP can have arbitrary skid
41 1 - SAMPLE_IP must have constant skid
42 2 - SAMPLE_IP requested to have 0 skid
43 3 - SAMPLE_IP must have 0 skid, or uses randomization to avoid
44 sample shadowing effects.
45
46For Intel systems precise event sampling is implemented with PEBS
47which supports up to precise-level 2, and precise level 3 for
48some special cases
49
50On AMD systems it is implemented using IBS (up to precise-level 2).
51The precise modifier works with event types 0x76 (cpu-cycles, CPU
52clocks not halted) and 0xC1 (micro-ops retired). Both events map to
53IBS execution sampling (IBS op) with the IBS Op Counter Control bit
54(IbsOpCntCtl) set respectively (see AMD64 Architecture Programmer’s
55Manual Volume 2: System Programming, 13.3 Instruction-Based
56Sampling). Examples to use IBS:
57
58 perf record -a -e cpu-cycles:p ... # use ibs op counting cycles
59 perf record -a -e r076:p ... # same as -e cpu-cycles:p
60 perf record -a -e r0C1:p ... # use ibs op counting micro-ops
61
62RAW HARDWARE EVENT DESCRIPTOR
63-----------------------------
64Even when an event is not available in a symbolic form within perf right now,
65it can be encoded in a per processor specific way.
66
67For instance For x86 CPUs NNN represents the raw register encoding with the
68layout of IA32_PERFEVTSELx MSRs (see [Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3B: System Programming Guide] Figure 30-1 Layout
69of IA32_PERFEVTSELx MSRs) or AMD's PerfEvtSeln (see [AMD64 Architecture Programmer’s Manual Volume 2: System Programming], Page 344,
70Figure 13-7 Performance Event-Select Register (PerfEvtSeln)).
71
72Note: Only the following bit fields can be set in x86 counter
73registers: event, umask, edge, inv, cmask. Esp. guest/host only and
74OS/user mode flags must be setup using <<EVENT_MODIFIERS, EVENT
75MODIFIERS>>.
76
77Example:
78
79If the Intel docs for a QM720 Core i7 describe an event as:
80
81 Event Umask Event Mask
82 Num. Value Mnemonic Description Comment
83
84 A8H 01H LSD.UOPS Counts the number of micro-ops Use cmask=1 and
85 delivered by loop stream detector invert to count
86 cycles
87
88raw encoding of 0x1A8 can be used:
89
90 perf stat -e r1a8 -a sleep 1
91 perf record -e r1a8 ...
92
93You should refer to the processor specific documentation for getting these
94details. Some of them are referenced in the SEE ALSO section below.
95
96PARAMETERIZED EVENTS
97--------------------
98
99Some pmu events listed by 'perf-list' will be displayed with '?' in them. For
100example:
101
102 hv_gpci/dtbp_ptitc,phys_processor_idx=?/
103
104This means that when provided as an event, a value for '?' must
105also be supplied. For example:
106
107 perf stat -C 0 -e 'hv_gpci/dtbp_ptitc,phys_processor_idx=0x2/' ...
108
109OPTIONS
110-------
111
112Without options all known events will be listed.
113
114To limit the list use:
115
116. 'hw' or 'hardware' to list hardware events such as cache-misses, etc.
117
118. 'sw' or 'software' to list software events such as context switches, etc.
119
120. 'cache' or 'hwcache' to list hardware cache events such as L1-dcache-loads, etc.
121
122. 'tracepoint' to list all tracepoint events, alternatively use
123 'subsys_glob:event_glob' to filter by tracepoint subsystems such as sched,
124 block, etc.
125
126. 'pmu' to print the kernel supplied PMU events.
127
128. If none of the above is matched, it will apply the supplied glob to all
129 events, printing the ones that match.
130
131. As a last resort, it will do a substring search in all event names.
132
133One or more types can be used at the same time, listing the events for the
134types specified.
135
136Support raw format:
137
138. '--raw-dump', shows the raw-dump of all the events.
139. '--raw-dump [hw|sw|cache|tracepoint|pmu|event_glob]', shows the raw-dump of
140 a certain kind of events.
141
142SEE ALSO
143--------
144linkperf:perf-stat[1], linkperf:perf-top[1],
145linkperf:perf-record[1],
146http://www.intel.com/Assets/PDF/manual/253669.pdf[Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3B: System Programming Guide],
147http://support.amd.com/us/Processor_TechDocs/24593_APM_v2.pdf[AMD64 Architecture Programmer’s Manual Volume 2: System Programming]
1perf-list(1)
2============
3
4NAME
5----
6perf-list - List all symbolic event types
7
8SYNOPSIS
9--------
10[verse]
11'perf list' [--no-desc] [--long-desc] [hw|sw|cache|tracepoint|pmu|event_glob]
12
13DESCRIPTION
14-----------
15This command displays the symbolic event types which can be selected in the
16various perf commands with the -e option.
17
18OPTIONS
19-------
20--no-desc::
21Don't print descriptions.
22
23-v::
24--long-desc::
25Print longer event descriptions.
26
27
28[[EVENT_MODIFIERS]]
29EVENT MODIFIERS
30---------------
31
32Events can optionally have a modifier by appending a colon and one or
33more modifiers. Modifiers allow the user to restrict the events to be
34counted. The following modifiers exist:
35
36 u - user-space counting
37 k - kernel counting
38 h - hypervisor counting
39 I - non idle counting
40 G - guest counting (in KVM guests)
41 H - host counting (not in KVM guests)
42 p - precise level
43 P - use maximum detected precise level
44 S - read sample value (PERF_SAMPLE_READ)
45 D - pin the event to the PMU
46
47The 'p' modifier can be used for specifying how precise the instruction
48address should be. The 'p' modifier can be specified multiple times:
49
50 0 - SAMPLE_IP can have arbitrary skid
51 1 - SAMPLE_IP must have constant skid
52 2 - SAMPLE_IP requested to have 0 skid
53 3 - SAMPLE_IP must have 0 skid, or uses randomization to avoid
54 sample shadowing effects.
55
56For Intel systems precise event sampling is implemented with PEBS
57which supports up to precise-level 2, and precise level 3 for
58some special cases
59
60On AMD systems it is implemented using IBS (up to precise-level 2).
61The precise modifier works with event types 0x76 (cpu-cycles, CPU
62clocks not halted) and 0xC1 (micro-ops retired). Both events map to
63IBS execution sampling (IBS op) with the IBS Op Counter Control bit
64(IbsOpCntCtl) set respectively (see AMD64 Architecture Programmer’s
65Manual Volume 2: System Programming, 13.3 Instruction-Based
66Sampling). Examples to use IBS:
67
68 perf record -a -e cpu-cycles:p ... # use ibs op counting cycles
69 perf record -a -e r076:p ... # same as -e cpu-cycles:p
70 perf record -a -e r0C1:p ... # use ibs op counting micro-ops
71
72RAW HARDWARE EVENT DESCRIPTOR
73-----------------------------
74Even when an event is not available in a symbolic form within perf right now,
75it can be encoded in a per processor specific way.
76
77For instance For x86 CPUs NNN represents the raw register encoding with the
78layout of IA32_PERFEVTSELx MSRs (see [Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3B: System Programming Guide] Figure 30-1 Layout
79of IA32_PERFEVTSELx MSRs) or AMD's PerfEvtSeln (see [AMD64 Architecture Programmer’s Manual Volume 2: System Programming], Page 344,
80Figure 13-7 Performance Event-Select Register (PerfEvtSeln)).
81
82Note: Only the following bit fields can be set in x86 counter
83registers: event, umask, edge, inv, cmask. Esp. guest/host only and
84OS/user mode flags must be setup using <<EVENT_MODIFIERS, EVENT
85MODIFIERS>>.
86
87Example:
88
89If the Intel docs for a QM720 Core i7 describe an event as:
90
91 Event Umask Event Mask
92 Num. Value Mnemonic Description Comment
93
94 A8H 01H LSD.UOPS Counts the number of micro-ops Use cmask=1 and
95 delivered by loop stream detector invert to count
96 cycles
97
98raw encoding of 0x1A8 can be used:
99
100 perf stat -e r1a8 -a sleep 1
101 perf record -e r1a8 ...
102
103You should refer to the processor specific documentation for getting these
104details. Some of them are referenced in the SEE ALSO section below.
105
106ARBITRARY PMUS
107--------------
108
109perf also supports an extended syntax for specifying raw parameters
110to PMUs. Using this typically requires looking up the specific event
111in the CPU vendor specific documentation.
112
113The available PMUs and their raw parameters can be listed with
114
115 ls /sys/devices/*/format
116
117For example the raw event "LSD.UOPS" core pmu event above could
118be specified as
119
120 perf stat -e cpu/event=0xa8,umask=0x1,name=LSD.UOPS_CYCLES,cmask=1/ ...
121
122PER SOCKET PMUS
123---------------
124
125Some PMUs are not associated with a core, but with a whole CPU socket.
126Events on these PMUs generally cannot be sampled, but only counted globally
127with perf stat -a. They can be bound to one logical CPU, but will measure
128all the CPUs in the same socket.
129
130This example measures memory bandwidth every second
131on the first memory controller on socket 0 of a Intel Xeon system
132
133 perf stat -C 0 -a uncore_imc_0/cas_count_read/,uncore_imc_0/cas_count_write/ -I 1000 ...
134
135Each memory controller has its own PMU. Measuring the complete system
136bandwidth would require specifying all imc PMUs (see perf list output),
137and adding the values together.
138
139This example measures the combined core power every second
140
141 perf stat -I 1000 -e power/energy-cores/ -a
142
143ACCESS RESTRICTIONS
144-------------------
145
146For non root users generally only context switched PMU events are available.
147This is normally only the events in the cpu PMU, the predefined events
148like cycles and instructions and some software events.
149
150Other PMUs and global measurements are normally root only.
151Some event qualifiers, such as "any", are also root only.
152
153This can be overriden by setting the kernel.perf_event_paranoid
154sysctl to -1, which allows non root to use these events.
155
156For accessing trace point events perf needs to have read access to
157/sys/kernel/debug/tracing, even when perf_event_paranoid is in a relaxed
158setting.
159
160TRACING
161-------
162
163Some PMUs control advanced hardware tracing capabilities, such as Intel PT,
164that allows low overhead execution tracing. These are described in a separate
165intel-pt.txt document.
166
167PARAMETERIZED EVENTS
168--------------------
169
170Some pmu events listed by 'perf-list' will be displayed with '?' in them. For
171example:
172
173 hv_gpci/dtbp_ptitc,phys_processor_idx=?/
174
175This means that when provided as an event, a value for '?' must
176also be supplied. For example:
177
178 perf stat -C 0 -e 'hv_gpci/dtbp_ptitc,phys_processor_idx=0x2/' ...
179
180EVENT GROUPS
181------------
182
183Perf supports time based multiplexing of events, when the number of events
184active exceeds the number of hardware performance counters. Multiplexing
185can cause measurement errors when the workload changes its execution
186profile.
187
188When metrics are computed using formulas from event counts, it is useful to
189ensure some events are always measured together as a group to minimize multiplexing
190errors. Event groups can be specified using { }.
191
192 perf stat -e '{instructions,cycles}' ...
193
194The number of available performance counters depend on the CPU. A group
195cannot contain more events than available counters.
196For example Intel Core CPUs typically have four generic performance counters
197for the core, plus three fixed counters for instructions, cycles and
198ref-cycles. Some special events have restrictions on which counter they
199can schedule, and may not support multiple instances in a single group.
200When too many events are specified in the group none of them will not
201be measured.
202
203Globally pinned events can limit the number of counters available for
204other groups. On x86 systems, the NMI watchdog pins a counter by default.
205The nmi watchdog can be disabled as root with
206
207 echo 0 > /proc/sys/kernel/nmi_watchdog
208
209Events from multiple different PMUs cannot be mixed in a group, with
210some exceptions for software events.
211
212LEADER SAMPLING
213---------------
214
215perf also supports group leader sampling using the :S specifier.
216
217 perf record -e '{cycles,instructions}:S' ...
218 perf report --group
219
220Normally all events in a event group sample, but with :S only
221the first event (the leader) samples, and it only reads the values of the
222other events in the group.
223
224OPTIONS
225-------
226
227Without options all known events will be listed.
228
229To limit the list use:
230
231. 'hw' or 'hardware' to list hardware events such as cache-misses, etc.
232
233. 'sw' or 'software' to list software events such as context switches, etc.
234
235. 'cache' or 'hwcache' to list hardware cache events such as L1-dcache-loads, etc.
236
237. 'tracepoint' to list all tracepoint events, alternatively use
238 'subsys_glob:event_glob' to filter by tracepoint subsystems such as sched,
239 block, etc.
240
241. 'pmu' to print the kernel supplied PMU events.
242
243. If none of the above is matched, it will apply the supplied glob to all
244 events, printing the ones that match.
245
246. As a last resort, it will do a substring search in all event names.
247
248One or more types can be used at the same time, listing the events for the
249types specified.
250
251Support raw format:
252
253. '--raw-dump', shows the raw-dump of all the events.
254. '--raw-dump [hw|sw|cache|tracepoint|pmu|event_glob]', shows the raw-dump of
255 a certain kind of events.
256
257SEE ALSO
258--------
259linkperf:perf-stat[1], linkperf:perf-top[1],
260linkperf:perf-record[1],
261http://www.intel.com/sdm/[Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3B: System Programming Guide],
262http://support.amd.com/us/Processor_TechDocs/24593_APM_v2.pdf[AMD64 Architecture Programmer’s Manual Volume 2: System Programming]