From: Sukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
To: Arnaldo Carvalho de Melo <acme@kernel.org>,
ak@linux.intel.com, Jiri Olsa <jolsa@redhat.com>,
peterz@infradead.org, eranian@google.com
Cc: linuxppc-dev@lists.ozlabs.org, dev@codyps.com,
linux-kernel@vger.kernel.org,
Michael Ellerman <michaele@au1.ibm.com>,
Anshuman Khandual <khandual@linux.vnet.ibm.com>
Subject: [PATCH v2 03/14] perf Documentation: sysfs events/ interfaces
Date: Fri, 15 Aug 2014 00:26:11 -0700 [thread overview]
Message-ID: <1408087583-32239-3-git-send-email-sukadev@linux.vnet.ibm.com> (raw)
In-Reply-To: <1408087583-32239-1-git-send-email-sukadev@linux.vnet.ibm.com>
From: Cody P Schafer <dev@codyps.com>
Add documentation for the <event>, <event>.scale, and <event>.unit
files in sysfs.
<event>.scale and <event>.unit were undocumented.
<event> was previously documented only for specific powerpc pmu events.
CC: Haren Myneni <hbabu@us.ibm.com>
CC: Cody P Schafer <dev@codyps.com>
Signed-off-by: Cody P Schafer <cody@linux.vnet.ibm.com>
Signed-off-by: Sukadev Bhattiprolu <sukadev@linux.vnet.ibm.com>
---
.../testing/sysfs-bus-event_source-devices-events | 60 ++++++++++++++++++++++
1 file changed, 60 insertions(+)
diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-events b/Documentation/ABI/testing/sysfs-bus-event_source-devices-events
index 7b40a3c..a5226f0 100644
--- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-events
+++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-events
@@ -599,3 +599,63 @@ Description: POWER-systems specific performance monitoring events
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.
+
+What: /sys/bus/event_source/devices/<pmu>/events/<event>
+Date: 2014/02/24
+Contact: Linux kernel mailing list <linux-kernel@vger.kernel.org>
+Description: Per-pmu performance monitoring events specific to the running system
+
+ Each file (except for some of those with a '.' in them, '.unit'
+ and '.scale') in the 'events' directory describes a single
+ performance monitoring event supported by the <pmu>. The name
+ of the file is the name of the event.
+
+ File contents:
+
+ <term>[=<value>][,<term>[=<value>]]...
+
+ Where <term> is one of the terms listed under
+ /sys/bus/event_source/devices/<pmu>/format/ and <value> is
+ a number is base-16 format with a '0x' prefix (lowercase only).
+ If a <term> is specified alone (without an assigned value), it
+ is implied that 0x1 is assigned to that <term>.
+
+ Examples (each of these lines would be in a seperate file):
+
+ event=0x2abc
+ event=0x423,inv,cmask=0x3
+ domain=0x1,offset=0x8,starting_index=0xffff
+
+ Each of the assignments indicates a value to be assigned to a
+ particular set of bits (as defined by the format file
+ corresponding to the <term>) in the perf_event structure passed
+ to the perf_open syscall.
+
+What: /sys/bus/event_source/devices/<pmu>/events/<event>.unit
+Date: 2014/02/24
+Contact: Linux kernel mailing list <linux-kernel@vger.kernel.org>
+Description: Perf event units
+
+ A string specifying the English plural numerical unit that <event>
+ (once multiplied by <event>.scale) represents.
+
+ Example:
+
+ Joules
+
+What: /sys/bus/event_source/devices/<pmu>/events/<event>.scale
+Date: 2014/02/24
+Contact: Linux kernel mailing list <linux-kernel@vger.kernel.org>
+Description: Perf event scaling factors
+
+ A string representing a floating point value expressed in
+ scientific notation to be multiplied by the event count
+ recieved from the kernel to match the unit specified in the
+ <event>.unit file.
+
+ Example:
+
+ 2.3283064365386962890625e-10
+
+ This is provided to avoid performing floating point arithmetic
+ in the kernel.
--
1.8.3.1
next prev parent reply other threads:[~2014-08-15 7:26 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-08-15 7:26 [PATCH v2 00/14] Add support for parameterized events from sysfs Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 01/14] powerpc/perf/hv-24x7: use kmem_cache instead of aligned stack allocations Sukadev Bhattiprolu
2014-08-15 7:26 ` Sukadev Bhattiprolu [this message]
2014-08-15 7:26 ` [PATCH v2 04/14] perf Documentation: remove duplicated docs for powerpc cpu specific events Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 04/14] perf Documentation: add event parameters Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 05/14] tools/perf: annotate list_head with type info Sukadev Bhattiprolu
2014-08-15 13:47 ` Arnaldo Carvalho de Melo
2014-08-15 7:26 ` [PATCH v2 06/14] tools/perf: support parsing parameterized events Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 07/14] tools/perf: extend format_alias() to include event parameters Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 08/14] tools/perf: document parameterized events and note symbolically formed events Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 09/14] perf: provide sysfs_show for struct perf_pmu_events_attr Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 10/14] powerpc/perf/hv-24x7: parse catalog and populate sysfs with events Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 11/14] powerpc/perf/hv-24x7: Documentaion for new sysfs entries which expose descriptions Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 12/14] perf: add PMU_EVENT_ATTR_STRING() helper Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 13/14] powerpc/perf/{hv-gpci, hv-common}: generate requests with counters annotated Sukadev Bhattiprolu
2014-08-15 7:26 ` [PATCH v2 14/14] powerpc/perf/hv-gpci: add the remaining gpci requests Sukadev Bhattiprolu
2014-08-15 7:44 ` [PATCH v2 00/14] Add support for parameterized events from sysfs Peter Zijlstra
2014-08-20 14:15 ` Jiri Olsa
2014-08-23 0:23 ` Sukadev Bhattiprolu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1408087583-32239-3-git-send-email-sukadev@linux.vnet.ibm.com \
--to=sukadev@linux.vnet.ibm.com \
--cc=acme@kernel.org \
--cc=ak@linux.intel.com \
--cc=dev@codyps.com \
--cc=eranian@google.com \
--cc=jolsa@redhat.com \
--cc=khandual@linux.vnet.ibm.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=michaele@au1.ibm.com \
--cc=peterz@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).