Commit 2ac3634a authored by Sukadev Bhattiprolu's avatar Sukadev Bhattiprolu Committed by Arnaldo Carvalho de Melo
Browse files

perf: Document the ABI of perf sysfs entries 



This patchset addes two new sets of files to sysfs for POWER architecture.

	- perf event config format in /sys/devices/cpu/format/event
	- generic and POWER-specific perf events in /sys/devices/cpu/events/

The format of the first file is already documented in:

	sysfs-bus-event_source-devices-format

Document the format of the second set of files '/sys/devices/cpu/events/*'
which would also become part of the ABI.

Changelog[v4]:
	[Jiri Olsa]: Mention that multiple event= like terms can be specified
	in the 'events' file.
	[Jiri Olsa]: Remove the documentation for the 'config format' file
	as it is already documented in 'Documentation/ABI/testing/'.
	[Jiri Olsa]: Move ABI documentation from 'stable/' to 'testing/'

Changelog[v3]:
	[Greg KH] Include ABI documentation.

Signed-off-by: default avatarSukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
Acked-by: default avatarJiri Olsa <jolsa@redhat.com>
Cc: Andi Kleen <ak@linux.intel.com>
Cc: Anton Blanchard <anton@au1.ibm.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Cc: Robert Richter <robert.richter@amd.com>
Cc: Stephane Eranian <eranian@google.com>
Cc: linuxppc-dev@ozlabs.org
Link: http://lkml.kernel.org/r/20130123062645.GG13720@us.ibm.com


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 886c3b2d

Documentation/ABI/stable/sysfs-devices-cpu-events

deleted100644 → 0
+0 −0

Empty file deleted.

Documentation/ABI/testing/sysfs-bus-event_source-devices-events

0 → 100644
+62 −0
Original line number Diff line number Diff line 
What:		/sys/devices/cpu/events/

		/sys/devices/cpu/events/branch-misses

		/sys/devices/cpu/events/cache-references

		/sys/devices/cpu/events/cache-misses

		/sys/devices/cpu/events/stalled-cycles-frontend

		/sys/devices/cpu/events/branch-instructions

		/sys/devices/cpu/events/stalled-cycles-backend

		/sys/devices/cpu/events/instructions

		/sys/devices/cpu/events/cpu-cycles



Date:		2013/01/08



Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>



Description:	Generic performance monitoring events



		A collection of performance monitoring events that may be

		supported by many/most CPUs. These events can be monitored

		using the 'perf(1)' tool.



		The contents of each file would look like:



			event=0xNNNN



		where 'N' is a hex digit and the number '0xNNNN' shows the

		"raw code" for the perf event identified by the file's

		"basename".





What: 		/sys/devices/cpu/events/PM_LD_MISS_L1

		/sys/devices/cpu/events/PM_LD_REF_L1

		/sys/devices/cpu/events/PM_CYC

		/sys/devices/cpu/events/PM_BRU_FIN

		/sys/devices/cpu/events/PM_GCT_NOSLOT_CYC

		/sys/devices/cpu/events/PM_BRU_MPRED

		/sys/devices/cpu/events/PM_INST_CMPL

		/sys/devices/cpu/events/PM_CMPLU_STALL



Date:		2013/01/08



Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>

		Linux Powerpc mailing list <linuxppc-dev@ozlabs.org>



Description:	POWER-systems specific performance monitoring events



		A collection of performance monitoring events that may be

		supported by the POWER CPU. These events can be monitored

		using the 'perf(1)' tool.



		These events may not be supported by other CPUs.



		The contents of each file would look like:



			event=0xNNNN



		where 'N' is a hex digit and the number '0xNNNN' shows the

		"raw code" for the perf event identified by the file's

		"basename".



		Further, multiple terms like 'event=0xNNNN' can be specified

		and separated with comma. All available terms are defined in

		the /sys/bus/event_source/devices/<dev>/format file.

CRA Git | Maintained and supported by SUSTech CRA and CCSE