perf documentation: update Documentation/ABI/testing with missing perf-related files

perf documentation: update Documentation/ABI/testing with missing perf-related files

[Vince Weaver]

Add documentation for various files perf_event creates under
/sys/bus/event_source/devices/<dev>/

Signed-off-by: Vince Weaver <vincent.weaver@maine.edu>

diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices b/Documentation/ABI/testing/sysfs-bus-event_source-devices
new file mode 100644
index 0000000..ffa2e4b
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices
@@ -0,0 +1,50 @@
+What:		/sys/bus/event_source/devices/<dev>/cpumask
+
+Date:		2012/09/10
+		
+Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
+
+Description:	This value holds a representative core for each
+		socket in a system.  It is meant to help when
+		creating a perf_event event for socket-wide events
+		like uncore and northbridge events.
+
+		The format is a comma separated list of cpu numbers,
+		one for each socket in the system that the PMU in
+		question can run on.
+
+		For example, on a two-socket Sandybridge-EP machine and
+		the cbox0 uncore the value of the file will be:
+			0,8
+		    
+
+
+What:		/sys/bus/event_source/devices/cpu/rdpmc
+
+Date:		2011/11/20
+
+Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
+
+Description:	Indicates whether a CPU allows userspace "rdpmc"
+		instructions (unprivileged reads of the performance
+		counter MSRs).
+
+		You can echo 0 to this value to disable user rdpmc
+		access.
+
+
+
+What:		/sys/bus/event_source/devices/<dev>/type
+
+Date:		2013/01/08
+
+Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
+
+Description:	This value holds the PMU (Performance Monitor Unit) type
+		value that is passed into the perf_event_open()
+		attr:type field when opening an event.
+
+		The value is a decimal integer.
+
+
+

Re: perf documentation: update Documentation/ABI/testing with missing perf-related files

[Jiri Olsa]

On Mon, Jul 15, 2013 at 05:38:15PM -0400, Vince Weaver wrote:
> 
> Add documentation for various files perf_event creates under
> /sys/bus/event_source/devices/<dev>/
> 
> Signed-off-by: Vince Weaver <vincent.weaver@maine.edu>
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices b/Documentation/ABI/testing/sysfs-bus-event_source-devices
> new file mode 100644
> index 0000000..ffa2e4b
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices
> @@ -0,0 +1,50 @@
> +What:		/sys/bus/event_source/devices/<dev>/cpumask
> +
> +Date:		2012/09/10
> +		

nit, white space above

> +Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
> +
> +Description:	This value holds a representative core for each
> +		socket in a system.  It is meant to help when
> +		creating a perf_event event for socket-wide events
> +		like uncore and northbridge events.
> +
> +		The format is a comma separated list of cpu numbers,
> +		one for each socket in the system that the PMU in
> +		question can run on.
> +
> +		For example, on a two-socket Sandybridge-EP machine and
> +		the cbox0 uncore the value of the file will be:
> +			0,8
> +		    

nit, white space above

> +
> +
> +What:		/sys/bus/event_source/devices/cpu/rdpmc
> +
> +Date:		2011/11/20
> +
> +Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
> +
> +Description:	Indicates whether a CPU allows userspace "rdpmc"
> +		instructions (unprivileged reads of the performance
> +		counter MSRs).
> +
> +		You can echo 0 to this value to disable user rdpmc
> +		access.
> +
> +
> +
> +What:		/sys/bus/event_source/devices/<dev>/type
> +
> +Date:		2013/01/08
> +
> +Contact:	Linux kernel mailing list <linux-kernel@vger.kernel.org>
> +
> +Description:	This value holds the PMU (Performance Monitor Unit) type
> +		value that is passed into the perf_event_open()
> +		attr:type field when opening an event.
> +
> +		The value is a decimal integer.
> +
> +
> +

Acked-by: Jiri Olsa <jolsa@redhat.com>

thanks,
jirka