tools/perf/Documentation/perf-list.txt

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