Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756913Ab3GOU7H (ORCPT ); Mon, 15 Jul 2013 16:59:07 -0400 Received: from mail-gh0-f182.google.com ([209.85.160.182]:50031 "EHLO mail-gh0-f182.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1756117Ab3GOU7D (ORCPT ); Mon, 15 Jul 2013 16:59:03 -0400 Date: Mon, 15 Jul 2013 17:04:50 -0400 (EDT) From: Vince Weaver To: linux-kernel@vger.kernel.org cc: Jiri Olsa , linux-perf-users@vger.kernel.org, Peter Zijlstra , mingo@kernel.org, acme@redhat.com, Stephane Eranian Subject: perf documentation: update format and events ABI files Message-ID: User-Agent: Alpine 2.10 (DEB 1266 2009-07-14) MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 4250 Lines: 109 This updates the sysfs-bus-event_source-devices-events and sysfs-bus-event_source-devices-format Documentation to more closely match the values current kernels are exporting. The big change is the allowing of decimal values in the events file; this was an ABI change in the 3.10 kernel. It also documents more completely how non-contiguous values work in the format file. I have to say it would have been much easier for parser writers if the format value had been a simple mask rather than having to take a value, parse it, and then do an arbitracy number of shift/masks to split up the value to pass in. Signed-off-by: Vince Weaver diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-events b/Documentation/ABI/testing/sysfs-bus-event_source-devices-events index 3c1cc24..43aae08 100644 --- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-events +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-events @@ -1,30 +1,51 @@ -What: /sys/devices/cpu/events/ +What: /sys/bus/event_source/devices//events + +Date: 2013/01/08 + +Contact: Linux kernel mailing list + +Description: Generic performance monitoring events + + A collection of performance monitoring events that are + supported by the PMU (performance monitoring unit) + specified by "". These events can be monitored + using the 'perf(1)' tool. + + The contents of each file is a list of attribute names + (as found in the corresponding + /sys/bus/event_source/devices//format + file) separated by commas. Each entry has + an optional value (either hex or decimal). If no + value is specified than it is assumed to be a single-bit + field with a value of 1. + + An example of what you might find: + event=0x2,inv,ldlat=3 + + +What: /sys/devices/cpu/events/branch-instructions /sys/devices/cpu/events/branch-misses - /sys/devices/cpu/events/cache-references + /sys/devices/cpu/events/bus-cycles /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/cache-references /sys/devices/cpu/events/cpu-cycles + /sys/devices/cpu/events/instructions + /sys/devices/cpu/events/stalled-cycles-backend + /sys/devices/cpu/events/stalled-cycles-frontend Date: 2013/01/08 Contact: Linux kernel mailing list -Description: Generic performance monitoring events +Description: Generic CPU 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". + The format of these files matches that of + /sys/bus/event_source/devices//events as described + previously in this file. What: /sys/devices/cpu/events/PM_1PLUS_PPC_CMPL diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-format b/Documentation/ABI/testing/sysfs-bus-event_source-devices-format index 77f47ff..4f7ee5e 100644 --- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-format +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-format @@ -15,6 +15,12 @@ Description: attr2 = 'config:0-7' attr3 = 'config:12-35' - Example: 'config1:1,6-10,44' + Example: event = 'config1:1,6-10,44' Defines contents of attribute that occupies bits 1,6-10,44 of perf_event_attr::config1. + + In this example, the events file would have the value + event=0x7f + to set all of the specified bits (they will be split up). + You would not use 0x10000007c2 (which is what the bits + actually passed into config1 would look like). -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/