2009-06-06 20:56:33 +08:00
|
|
|
|
perf-list(1)
|
2008-04-16 04:39:31 +08:00
|
|
|
|
============
|
2009-06-06 20:56:33 +08:00
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
perf-list - List all symbolic event types
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
|
|
|
|
[verse]
|
2017-09-01 03:40:32 +08:00
|
|
|
|
'perf list' [--no-desc] [--long-desc]
|
|
|
|
|
[hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob]
|
2009-06-06 20:56:33 +08:00
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
This command displays the symbolic event types which can be selected in the
|
|
|
|
|
various perf commands with the -e option.
|
|
|
|
|
|
2016-09-16 06:24:45 +08:00
|
|
|
|
OPTIONS
|
|
|
|
|
-------
|
|
|
|
|
--no-desc::
|
|
|
|
|
Don't print descriptions.
|
|
|
|
|
|
2016-09-16 06:24:48 +08:00
|
|
|
|
-v::
|
|
|
|
|
--long-desc::
|
|
|
|
|
Print longer event descriptions.
|
|
|
|
|
|
2017-03-21 04:17:11 +08:00
|
|
|
|
--details::
|
|
|
|
|
Print how named events are resolved internally into perf events, and also
|
|
|
|
|
any extra expressions computed by perf stat.
|
|
|
|
|
|
2016-09-16 06:24:45 +08:00
|
|
|
|
|
2012-08-08 01:43:15 +08:00
|
|
|
|
[[EVENT_MODIFIERS]]
|
2010-10-15 09:51:00 +08:00
|
|
|
|
EVENT MODIFIERS
|
|
|
|
|
---------------
|
|
|
|
|
|
2014-09-09 23:18:50 +08:00
|
|
|
|
Events can optionally have a modifier by appending a colon and one or
|
2012-08-08 01:43:16 +08:00
|
|
|
|
more modifiers. Modifiers allow the user to restrict the events to be
|
|
|
|
|
counted. The following modifiers exist:
|
|
|
|
|
|
|
|
|
|
u - user-space counting
|
|
|
|
|
k - kernel counting
|
|
|
|
|
h - hypervisor counting
|
2015-04-08 05:25:14 +08:00
|
|
|
|
I - non idle counting
|
2012-08-08 01:43:16 +08:00
|
|
|
|
G - guest counting (in KVM guests)
|
|
|
|
|
H - host counting (not in KVM guests)
|
|
|
|
|
p - precise level
|
perf tools: Introduce 'P' modifier to request max precision
The 'P' will cause the event to get maximum possible detected precise
level.
Following record:
$ perf record -e cycles:P ...
will detect maximum precise level for 'cycles' event and use it.
Commiter note:
Testing it:
$ perf record -e cycles:P usleep 1
[ perf record: Woken up 1 times to write data ]
[ perf record: Captured and wrote 0.013 MB perf.data (9 samples) ]
$ perf evlist
cycles:P
$ perf evlist -v
cycles:P: size: 112, { sample_period, sample_freq }: 4000, sample_type:
IP|TID|TIME|PERIOD, disabled: 1, inherit: 1, mmap: 1, comm: 1, freq: 1,
enable_on_exec: 1, task: 1, precise_ip: 2, sample_id_all: 1, mmap2: 1,
comm_exec: 1
$
Signed-off-by: Jiri Olsa <jolsa@kernel.org>
Tested-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Cc: David Ahern <dsahern@gmail.com>
Cc: Don Zickus <dzickus@redhat.com>
Cc: Kan Liang <kan.liang@intel.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Link: http://lkml.kernel.org/r/1444068369-20978-6-git-send-email-jolsa@kernel.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2015-10-06 02:06:05 +08:00
|
|
|
|
P - use maximum detected precise level
|
2012-10-10 23:39:03 +08:00
|
|
|
|
S - read sample value (PERF_SAMPLE_READ)
|
perf tools: Add support for pinned modifier
This commit adds support for a new modifier "D", which requests that the
event, or group of events, be pinned to the PMU.
The "p" modifier is already taken for precise, and "P" may be used in
future to mean "fully precise".
So we use "D", which stands for pinneD - and looks like a padlock, or if
you're using the ":D" syntax perf smiles at you.
This is an oft-requested feature from our HW folks, who want to be able
to run a large number of events, but also want 100% accurate results for
instructions per cycle.
Comparison of results with and without pinning:
$ perf stat -e '{cycles,instructions}:D' -e cycles,instructions,...
79,590,480,683 cycles # 0.000 GHz
166,123,716,524 instructions # 2.09 insns per cycle
# 0.11 stalled cycles per insn
79,352,134,463 cycles # 0.000 GHz [11.11%]
165,178,301,818 instructions # 2.08 insns per cycle
# 0.11 stalled cycles per insn [11.13%]
As you can see although perf does a very good job of scaling the values
in the non-pinned case, there is some small discrepancy.
The patch is fairly straight forward, the one detail is that we need to
make sure we only request pinning for the group leader when we have a
group.
Signed-off-by: Michael Ellerman <michael@ellerman.id.au>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Acked-by: Jiri Olsa <jolsa@redhat.com>
Tested-by: Jiri Olsa <jolsa@redhat.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Link: http://lkml.kernel.org/r/1375795686-4226-1-git-send-email-michael@ellerman.id.au
[ Use perf_evsel__is_group_leader instead of open coded equivalent, as
suggested by Jiri Olsa ]
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2013-08-06 21:28:05 +08:00
|
|
|
|
D - pin the event to the PMU
|
perf tools: Support weak groups in 'perf stat'
Setting up groups can be complicated due to the complicated scheduling
restrictions of different PMUs.
User tools usually don't understand all these restrictions.
Still in many cases it is useful to set up groups and they work most of
the time. However if the group is set up wrong some members will not
report any value because they never get scheduled.
Add a concept of a 'weak group': try to set up a group, but if it's not
schedulable fallback to not using a group. That gives us the best of
both worlds: groups if they work, but still a usable fallback if they
don't.
In theory it would be possible to have more complex fallback strategies
(e.g. try to split the group in half), but the simple fallback of not
using a group seems to work for now.
So far the weak group is only implemented for perf stat, not for record.
Here's an unschedulable group (on IvyBridge with SMT on)
% perf stat -e '{branches,branch-misses,l1d.replacement,l2_lines_in.all,l2_rqsts.all_code_rd}' -a sleep 1
73,806,067 branches
4,848,144 branch-misses # 6.57% of all branches
14,754,458 l1d.replacement
24,905,558 l2_lines_in.all
<not supported> l2_rqsts.all_code_rd <------- will never report anything
With the weak group:
% perf stat -e '{branches,branch-misses,l1d.replacement,l2_lines_in.all,l2_rqsts.all_code_rd}:W' -a sleep 1
125,366,055 branches (80.02%)
9,208,402 branch-misses # 7.35% of all branches (80.01%)
24,560,249 l1d.replacement (80.00%)
43,174,971 l2_lines_in.all (80.05%)
31,891,457 l2_rqsts.all_code_rd (79.92%)
The extra event scheduled with some extra multiplexing
v2: Move fallback code to separate function.
Add comment on for_each_group_member
Adjust to new perf_evsel__close interface
v3: Fix debug print out.
Committer testing:
Before:
# perf stat -e '{branches,branch-misses,l1d.replacement,l2_lines_in.all,l2_rqsts.all_code_rd}' -a sleep 1
Performance counter stats for 'system wide':
<not counted> branches
<not counted> branch-misses
<not counted> l1d.replacement
<not counted> l2_lines_in.all
<not supported> l2_rqsts.all_code_rd
1.002147212 seconds time elapsed
# perf stat -e '{branches,l1d.replacement,l2_lines_in.all,l2_rqsts.all_code_rd}' -a sleep 1
Performance counter stats for 'system wide':
83,207,892 branches
11,065,444 l1d.replacement
28,484,024 l2_lines_in.all
12,186,179 l2_rqsts.all_code_rd
1.001739493 seconds time elapsed
After:
# perf stat -e '{branches,branch-misses,l1d.replacement,l2_lines_in.all,l2_rqsts.all_code_rd}':W -a sleep 1
Performance counter stats for 'system wide':
543,323,909 branches (80.01%)
27,100,512 branch-misses # 4.99% of all branches (80.02%)
50,402,905 l1d.replacement (80.03%)
67,385,892 l2_lines_in.all (80.01%)
21,352,885 l2_rqsts.all_code_rd (79.94%)
1.001086658 seconds time elapsed
#
Signed-off-by: Andi Kleen <ak@linux.intel.com>
Acked-by: Jiri Olsa <jolsa@kernel.org>
Tested-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Link: http://lkml.kernel.org/r/20170831194036.30146-2-andi@firstfloor.org
[ Add a "'perf stat' only, for now" comment in the man page, suggested by Jiri ]
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2017-09-01 03:40:26 +08:00
|
|
|
|
W - group is weak and will fallback to non-group if not schedulable,
|
|
|
|
|
only supported in 'perf stat' for now.
|
2010-10-15 09:51:00 +08:00
|
|
|
|
|
|
|
|
|
The 'p' modifier can be used for specifying how precise the instruction
|
2012-08-08 01:43:16 +08:00
|
|
|
|
address should be. The 'p' modifier can be specified multiple times:
|
|
|
|
|
|
|
|
|
|
0 - SAMPLE_IP can have arbitrary skid
|
|
|
|
|
1 - SAMPLE_IP must have constant skid
|
|
|
|
|
2 - SAMPLE_IP requested to have 0 skid
|
2016-03-21 23:56:33 +08:00
|
|
|
|
3 - SAMPLE_IP must have 0 skid, or uses randomization to avoid
|
|
|
|
|
sample shadowing effects.
|
2012-08-08 01:43:16 +08:00
|
|
|
|
|
|
|
|
|
For Intel systems precise event sampling is implemented with PEBS
|
2016-03-21 23:56:33 +08:00
|
|
|
|
which supports up to precise-level 2, and precise level 3 for
|
|
|
|
|
some special cases
|
2012-08-08 01:43:16 +08:00
|
|
|
|
|
|
|
|
|
On AMD systems it is implemented using IBS (up to precise-level 2).
|
|
|
|
|
The precise modifier works with event types 0x76 (cpu-cycles, CPU
|
|
|
|
|
clocks not halted) and 0xC1 (micro-ops retired). Both events map to
|
|
|
|
|
IBS execution sampling (IBS op) with the IBS Op Counter Control bit
|
|
|
|
|
(IbsOpCntCtl) set respectively (see AMD64 Architecture Programmer’s
|
|
|
|
|
Manual Volume 2: System Programming, 13.3 Instruction-Based
|
|
|
|
|
Sampling). Examples to use IBS:
|
2010-10-15 09:51:00 +08:00
|
|
|
|
|
2012-08-08 01:43:16 +08:00
|
|
|
|
perf record -a -e cpu-cycles:p ... # use ibs op counting cycles
|
|
|
|
|
perf record -a -e r076:p ... # same as -e cpu-cycles:p
|
|
|
|
|
perf record -a -e r0C1:p ... # use ibs op counting micro-ops
|
2010-10-15 09:51:00 +08:00
|
|
|
|
|
2010-05-05 22:20:05 +08:00
|
|
|
|
RAW HARDWARE EVENT DESCRIPTOR
|
|
|
|
|
-----------------------------
|
|
|
|
|
Even when an event is not available in a symbolic form within perf right now,
|
2010-05-08 01:07:05 +08:00
|
|
|
|
it can be encoded in a per processor specific way.
|
|
|
|
|
|
|
|
|
|
For instance For x86 CPUs NNN represents the raw register encoding with the
|
|
|
|
|
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
|
|
|
|
|
of IA32_PERFEVTSELx MSRs) or AMD's PerfEvtSeln (see [AMD64 Architecture Programmer’s Manual Volume 2: System Programming], Page 344,
|
|
|
|
|
Figure 13-7 Performance Event-Select Register (PerfEvtSeln)).
|
|
|
|
|
|
2012-08-08 01:43:15 +08:00
|
|
|
|
Note: Only the following bit fields can be set in x86 counter
|
|
|
|
|
registers: event, umask, edge, inv, cmask. Esp. guest/host only and
|
|
|
|
|
OS/user mode flags must be setup using <<EVENT_MODIFIERS, EVENT
|
|
|
|
|
MODIFIERS>>.
|
|
|
|
|
|
2010-05-08 01:07:05 +08:00
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
If the Intel docs for a QM720 Core i7 describe an event as:
|
2010-05-05 22:20:05 +08:00
|
|
|
|
|
|
|
|
|
Event Umask Event Mask
|
|
|
|
|
Num. Value Mnemonic Description Comment
|
|
|
|
|
|
|
|
|
|
A8H 01H LSD.UOPS Counts the number of micro-ops Use cmask=1 and
|
|
|
|
|
delivered by loop stream detector invert to count
|
|
|
|
|
cycles
|
|
|
|
|
|
|
|
|
|
raw encoding of 0x1A8 can be used:
|
|
|
|
|
|
|
|
|
|
perf stat -e r1a8 -a sleep 1
|
|
|
|
|
perf record -e r1a8 ...
|
|
|
|
|
|
2010-05-08 01:07:05 +08:00
|
|
|
|
You should refer to the processor specific documentation for getting these
|
|
|
|
|
details. Some of them are referenced in the SEE ALSO section below.
|
|
|
|
|
|
2016-04-05 06:58:06 +08:00
|
|
|
|
ARBITRARY PMUS
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
perf also supports an extended syntax for specifying raw parameters
|
|
|
|
|
to PMUs. Using this typically requires looking up the specific event
|
|
|
|
|
in the CPU vendor specific documentation.
|
|
|
|
|
|
|
|
|
|
The available PMUs and their raw parameters can be listed with
|
|
|
|
|
|
|
|
|
|
ls /sys/devices/*/format
|
|
|
|
|
|
|
|
|
|
For example the raw event "LSD.UOPS" core pmu event above could
|
|
|
|
|
be specified as
|
|
|
|
|
|
|
|
|
|
perf stat -e cpu/event=0xa8,umask=0x1,name=LSD.UOPS_CYCLES,cmask=1/ ...
|
|
|
|
|
|
|
|
|
|
PER SOCKET PMUS
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Some PMUs are not associated with a core, but with a whole CPU socket.
|
|
|
|
|
Events on these PMUs generally cannot be sampled, but only counted globally
|
|
|
|
|
with perf stat -a. They can be bound to one logical CPU, but will measure
|
|
|
|
|
all the CPUs in the same socket.
|
|
|
|
|
|
|
|
|
|
This example measures memory bandwidth every second
|
|
|
|
|
on the first memory controller on socket 0 of a Intel Xeon system
|
|
|
|
|
|
|
|
|
|
perf stat -C 0 -a uncore_imc_0/cas_count_read/,uncore_imc_0/cas_count_write/ -I 1000 ...
|
|
|
|
|
|
|
|
|
|
Each memory controller has its own PMU. Measuring the complete system
|
|
|
|
|
bandwidth would require specifying all imc PMUs (see perf list output),
|
|
|
|
|
and adding the values together.
|
|
|
|
|
|
|
|
|
|
This example measures the combined core power every second
|
|
|
|
|
|
|
|
|
|
perf stat -I 1000 -e power/energy-cores/ -a
|
|
|
|
|
|
|
|
|
|
ACCESS RESTRICTIONS
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
For non root users generally only context switched PMU events are available.
|
|
|
|
|
This is normally only the events in the cpu PMU, the predefined events
|
|
|
|
|
like cycles and instructions and some software events.
|
|
|
|
|
|
|
|
|
|
Other PMUs and global measurements are normally root only.
|
|
|
|
|
Some event qualifiers, such as "any", are also root only.
|
|
|
|
|
|
|
|
|
|
This can be overriden by setting the kernel.perf_event_paranoid
|
|
|
|
|
sysctl to -1, which allows non root to use these events.
|
|
|
|
|
|
|
|
|
|
For accessing trace point events perf needs to have read access to
|
|
|
|
|
/sys/kernel/debug/tracing, even when perf_event_paranoid is in a relaxed
|
|
|
|
|
setting.
|
|
|
|
|
|
|
|
|
|
TRACING
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Some PMUs control advanced hardware tracing capabilities, such as Intel PT,
|
|
|
|
|
that allows low overhead execution tracing. These are described in a separate
|
|
|
|
|
intel-pt.txt document.
|
|
|
|
|
|
2015-01-08 09:13:53 +08:00
|
|
|
|
PARAMETERIZED EVENTS
|
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
|
|
Some pmu events listed by 'perf-list' will be displayed with '?' in them. For
|
|
|
|
|
example:
|
|
|
|
|
|
|
|
|
|
hv_gpci/dtbp_ptitc,phys_processor_idx=?/
|
|
|
|
|
|
|
|
|
|
This means that when provided as an event, a value for '?' must
|
|
|
|
|
also be supplied. For example:
|
|
|
|
|
|
|
|
|
|
perf stat -C 0 -e 'hv_gpci/dtbp_ptitc,phys_processor_idx=0x2/' ...
|
|
|
|
|
|
2016-04-05 06:58:06 +08:00
|
|
|
|
EVENT GROUPS
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Perf supports time based multiplexing of events, when the number of events
|
|
|
|
|
active exceeds the number of hardware performance counters. Multiplexing
|
|
|
|
|
can cause measurement errors when the workload changes its execution
|
|
|
|
|
profile.
|
|
|
|
|
|
|
|
|
|
When metrics are computed using formulas from event counts, it is useful to
|
|
|
|
|
ensure some events are always measured together as a group to minimize multiplexing
|
|
|
|
|
errors. Event groups can be specified using { }.
|
|
|
|
|
|
|
|
|
|
perf stat -e '{instructions,cycles}' ...
|
|
|
|
|
|
|
|
|
|
The number of available performance counters depend on the CPU. A group
|
|
|
|
|
cannot contain more events than available counters.
|
|
|
|
|
For example Intel Core CPUs typically have four generic performance counters
|
|
|
|
|
for the core, plus three fixed counters for instructions, cycles and
|
|
|
|
|
ref-cycles. Some special events have restrictions on which counter they
|
|
|
|
|
can schedule, and may not support multiple instances in a single group.
|
2017-10-11 06:43:22 +08:00
|
|
|
|
When too many events are specified in the group some of them will not
|
2016-04-05 06:58:06 +08:00
|
|
|
|
be measured.
|
|
|
|
|
|
|
|
|
|
Globally pinned events can limit the number of counters available for
|
|
|
|
|
other groups. On x86 systems, the NMI watchdog pins a counter by default.
|
|
|
|
|
The nmi watchdog can be disabled as root with
|
|
|
|
|
|
|
|
|
|
echo 0 > /proc/sys/kernel/nmi_watchdog
|
|
|
|
|
|
|
|
|
|
Events from multiple different PMUs cannot be mixed in a group, with
|
|
|
|
|
some exceptions for software events.
|
|
|
|
|
|
|
|
|
|
LEADER SAMPLING
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
perf also supports group leader sampling using the :S specifier.
|
|
|
|
|
|
|
|
|
|
perf record -e '{cycles,instructions}:S' ...
|
|
|
|
|
perf report --group
|
|
|
|
|
|
|
|
|
|
Normally all events in a event group sample, but with :S only
|
|
|
|
|
the first event (the leader) samples, and it only reads the values of the
|
|
|
|
|
other events in the group.
|
|
|
|
|
|
2009-06-06 20:56:33 +08:00
|
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2011-02-18 01:38:58 +08:00
|
|
|
|
|
|
|
|
|
Without options all known events will be listed.
|
|
|
|
|
|
|
|
|
|
To limit the list use:
|
|
|
|
|
|
|
|
|
|
. 'hw' or 'hardware' to list hardware events such as cache-misses, etc.
|
|
|
|
|
|
|
|
|
|
. 'sw' or 'software' to list software events such as context switches, etc.
|
|
|
|
|
|
|
|
|
|
. 'cache' or 'hwcache' to list hardware cache events such as L1-dcache-loads, etc.
|
|
|
|
|
|
|
|
|
|
. 'tracepoint' to list all tracepoint events, alternatively use
|
|
|
|
|
'subsys_glob:event_glob' to filter by tracepoint subsystems such as sched,
|
|
|
|
|
block, etc.
|
|
|
|
|
|
2013-04-21 02:02:29 +08:00
|
|
|
|
. 'pmu' to print the kernel supplied PMU events.
|
|
|
|
|
|
2017-03-27 10:55:38 +08:00
|
|
|
|
. 'sdt' to list all Statically Defined Tracepoint events.
|
|
|
|
|
|
2017-09-01 03:40:32 +08:00
|
|
|
|
. 'metric' to list metrics
|
|
|
|
|
|
|
|
|
|
. 'metricgroup' to list metricgroups with metrics.
|
|
|
|
|
|
2011-02-18 01:38:58 +08:00
|
|
|
|
. If none of the above is matched, it will apply the supplied glob to all
|
|
|
|
|
events, printing the ones that match.
|
|
|
|
|
|
2015-10-01 23:12:22 +08:00
|
|
|
|
. As a last resort, it will do a substring search in all event names.
|
|
|
|
|
|
2011-02-18 01:38:58 +08:00
|
|
|
|
One or more types can be used at the same time, listing the events for the
|
|
|
|
|
types specified.
|
2009-06-06 20:56:33 +08:00
|
|
|
|
|
2015-02-27 18:21:28 +08:00
|
|
|
|
Support raw format:
|
|
|
|
|
|
|
|
|
|
. '--raw-dump', shows the raw-dump of all the events.
|
|
|
|
|
. '--raw-dump [hw|sw|cache|tracepoint|pmu|event_glob]', shows the raw-dump of
|
|
|
|
|
a certain kind of events.
|
|
|
|
|
|
2009-06-06 20:56:33 +08:00
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
linkperf:perf-stat[1], linkperf:perf-top[1],
|
2010-05-08 01:07:05 +08:00
|
|
|
|
linkperf:perf-record[1],
|
2016-04-05 06:58:06 +08:00
|
|
|
|
http://www.intel.com/sdm/[Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3B: System Programming Guide],
|
2012-08-08 01:43:16 +08:00
|
|
|
|
http://support.amd.com/us/Processor_TechDocs/24593_APM_v2.pdf[AMD64 Architecture Programmer’s Manual Volume 2: System Programming]
|