xref: /linux/Documentation/ABI/testing/sysfs-bus-event_source-devices-events (revision a13926db3e5ea5bbac297f59e9f35061f52892d3)
1What:		/sys/devices/cpu/events/
2		/sys/devices/cpu/events/branch-misses
3		/sys/devices/cpu/events/cache-references
4		/sys/devices/cpu/events/cache-misses
5		/sys/devices/cpu/events/stalled-cycles-frontend
6		/sys/devices/cpu/events/branch-instructions
7		/sys/devices/cpu/events/stalled-cycles-backend
8		/sys/devices/cpu/events/instructions
9		/sys/devices/cpu/events/cpu-cycles
10
11Date:		2013/01/08
12
13Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
14
15Description:	Generic performance monitoring events
16
17		A collection of performance monitoring events that may be
18		supported by many/most CPUs. These events can be monitored
19		using the 'perf(1)' tool.
20
21		The contents of each file would look like:
22
23			event=0xNNNN
24
25		where 'N' is a hex digit and the number '0xNNNN' shows the
26		"raw code" for the perf event identified by the file's
27		"basename".
28
29
30What: /sys/bus/event_source/devices/<pmu>/events/<event>
31Date: 2014/02/24
32Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
33Description:	Per-pmu performance monitoring events specific to the running system
34
35		Each file (except for some of those with a '.' in them, '.unit'
36		and '.scale') in the 'events' directory describes a single
37		performance monitoring event supported by the <pmu>. The name
38		of the file is the name of the event.
39
40		File contents:
41
42			<term>[=<value>][,<term>[=<value>]]...
43
44		Where <term> is one of the terms listed under
45		/sys/bus/event_source/devices/<pmu>/format/ and <value> is
46		a number is base-16 format with a '0x' prefix (lowercase only).
47		If a <term> is specified alone (without an assigned value), it
48		is implied that 0x1 is assigned to that <term>.
49
50		Examples (each of these lines would be in a seperate file):
51
52			event=0x2abc
53			event=0x423,inv,cmask=0x3
54			domain=0x1,offset=0x8,starting_index=0xffff
55
56		Each of the assignments indicates a value to be assigned to a
57		particular set of bits (as defined by the format file
58		corresponding to the <term>) in the perf_event structure passed
59		to the perf_open syscall.
60
61What: /sys/bus/event_source/devices/<pmu>/events/<event>.unit
62Date: 2014/02/24
63Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
64Description:	Perf event units
65
66		A string specifying the English plural numerical unit that <event>
67		(once multiplied by <event>.scale) represents.
68
69		Example:
70
71			Joules
72
73What: /sys/bus/event_source/devices/<pmu>/events/<event>.scale
74Date: 2014/02/24
75Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
76Description:	Perf event scaling factors
77
78		A string representing a floating point value expressed in
79		scientific notation to be multiplied by the event count
80		recieved from the kernel to match the unit specified in the
81		<event>.unit file.
82
83		Example:
84
85			2.3283064365386962890625e-10
86
87		This is provided to avoid performing floating point arithmetic
88		in the kernel.
89