linux-kernel - perf/Documentation/ABI -- add some documentation for perf

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <alpine.DEB.2.10.1307031527390.12584@vincent-weaver-1.um.maine.edu>
Date:	Wed, 3 Jul 2013 15:39:10 -0400 (EDT)
From:	Vince Weaver <vincent.weaver@...ne.edu>
To:	linux-kernel@...r.kernel.org
cc:	Jiri Olsa <jolsa@...hat.com>,
	Peter Zijlstra <a.p.zijlstra@...llo.nl>,
	Paul Mackerras <paulus@...ba.org>,
	Ingo Molnar <mingo@...hat.com>,
	Arnaldo Carvalho de Melo <acme@...stprotocols.net>,
	Stephane Eranian <eranian@...il.com>,
	Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Subject: perf/Documentation/ABI -- add some documentation for perf_event
 sysfs usage


Add some documentation for the perf_event related
  /sys/bus/event_source/bus/devices/
files, since in theory it's a stable interface and the only
current documentation is some lex and yacc files in the
perf tools directory.

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

diff --git a/Documentation/ABI/stable/sysfs-bus-event_source-devices b/Documentation/ABI/stable/sysfs-bus-event_source-devices
new file mode 100644
index 0000000..9ef862f
--- /dev/null
+++ b/Documentation/ABI/stable/sysfs-bus-event_source-devices
@@ -0,0 +1,39 @@
+What:		/sys/bus/event_source/bus/devices/*/events/*
+Date:		Oct 2012
+KernelVersion:	3.8
+Contact:	Jiri Olsa <jolsa@...hat.com>
+Description:
+		Each file in /sys/bus/event_source/bus/devices/*/events/
+		represents a predefined perf_event event.
+
+		The contents of the file are a string describing
+		fields to set when generating raw events for
+		the perf_event_open() system call.
+
+		The layout of the file is
+			attr=value[,attr=value]...
+		Where attr is the name of a bitfield described
+		in /sys/bus/event_source/bus/devices/*/format/*
+		and value is either a hex (starting with 0x) or decimal
+		value.
+
+
+What:		/sys/bus/event_source/bus/devices/*/format/*
+Date:		Oct 2012
+KernelVersion:	3.8
+Contact:	Jiri Olsa <jolsa@...hat.com>
+Description:
+		Each file in /sys/bus/event_source/bus/devices/*/format/
+		represents a description of a bitfield used when 
+		constructing raw perf_event_open() raw events.
+
+		The contents of the file are a string describing
+		the name of the field and its range.
+
+		The layout of the file is
+			field:low[-high]
+		Where field is the field name, low is the low bit
+		of the range, and the optional high value is the high
+		bit of the range.  The low and high values are base-10
+		integers.
+
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/