lkml.org 
[lkml]   [2014]   [Dec]   [22]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    Date
    From
    SubjectRe: [PATCH v6 4/4] tools/perf: Document parameterized and symbolic events
    Jiri Olsa [jolsa@redhat.com] wrote:

    | > + values for each of 'config', 'config1' and 'config2' are defined by
    | > + corresponding entries in /sys/bus/event_sources/devices/<pmu>/format/*
    | > + param1 and param2 are defined as formats for the PMU in:
    | > + /sys/bus/event_sources/devices/<pmu>/format/*
    |
    | ^^^^ misaligned tab

    Thanks, Fixed the typos and alignment below.
    ---
    From 1fdb5012081903172c11a41f9edb0d51525ba500 Mon Sep 17 00:00:00 2001
    From: Cody P Schafer <cody@linux.vnet.ibm.com>
    Date: Wed, 24 Sep 2014 12:27:23 -0700
    Subject: [PATCH v6 4/4] tools/perf: Document parameterized and symbolic events

    Changelog[v6]:
    - [Sukadev Bhattiprolu]: Update documentation of perf-list and
    perf-record; Added documentation for perf-stat.
    - [Jiri Olsa] Fix some typos/formatting

    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>
    ---
    tools/perf/Documentation/perf-list.txt | 13 +++++++++++++
    tools/perf/Documentation/perf-record.txt | 12 ++++++++++++
    tools/perf/Documentation/perf-stat.txt | 20 ++++++++++++++++----
    3 files changed, 41 insertions(+), 4 deletions(-)

    diff --git a/tools/perf/Documentation/perf-list.txt b/tools/perf/Documentation/perf-list.txt
    index cbb4f74..3e2aec9 100644
    --- a/tools/perf/Documentation/perf-list.txt
    +++ b/tools/perf/Documentation/perf-list.txt
    @@ -89,6 +89,19 @@ raw encoding of 0x1A8 can be used:
    You should refer to the processor specific documentation for getting these
    details. Some of them are referenced in the SEE ALSO section below.

    +PARAMETERIZED EVENTS
    +--------------------
    +
    +Some pmu events listed by 'perf-list' will be displayed with '?' in them. For
    +example:
    +
    + hv_gpci/dtbp_ptitc,phys_processor_idx=?/
    +
    +This means that when provided as an event, a value for '?' must
    +also be supplied. For example:
    +
    + perf stat -C 0 -e 'hv_gpci/dtbp_ptitc,phys_processor_idx=0x2/' ...
    +
    OPTIONS
    -------

    diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
    index af9a54e..7d8df2e 100644
    --- a/tools/perf/Documentation/perf-record.txt
    +++ b/tools/perf/Documentation/perf-record.txt
    @@ -33,6 +33,18 @@ OPTIONS
    - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a
    hexadecimal event descriptor.

    + - a symbolically formed PMU event like 'pmu/param1=0x3,param2/' where
    + 'param1', 'param2', etc are defined as formats for the PMU in
    + /sys/bus/event_sources/devices/<pmu>/format/*.
    +
    + - a symbolically formed event like 'pmu/config=M,config1=N,config3=K/'
    +
    + where M, N, K are numbers (in decimal, hex, octal format). Acceptable
    + values for each of 'config', 'config1' and 'config2' are defined by
    + corresponding entries in /sys/bus/event_sources/devices/<pmu>/format/*
    + param1 and param2 are defined as formats for the PMU in:
    + /sys/bus/event_sources/devices/<pmu>/format/*
    +
    - a hardware breakpoint event in the form of '\mem:addr[:access]'
    where addr is the address in memory you want to break in.
    Access is the memory access type (read, write, execute) it can
    diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
    index 29ee857..04e150d 100644
    --- a/tools/perf/Documentation/perf-stat.txt
    +++ b/tools/perf/Documentation/perf-stat.txt
    @@ -25,10 +25,22 @@ OPTIONS

    -e::
    --event=::
    - Select the PMU event. Selection can be a symbolic event name
    - (use 'perf list' to list all events) or a raw PMU
    - event (eventsel+umask) in the form of rNNN where NNN is a
    - hexadecimal event descriptor.
    + Select the PMU event. Selection can be:
    +
    + - a symbolic event name (use 'perf list' to list all events)
    +
    + - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a
    + hexadecimal event descriptor.
    +
    + - a symbolically formed event like 'pmu/param1=0x3,param2/' where
    + param1 and param2 are defined as formats for the PMU in
    + /sys/bus/event_sources/devices/<pmu>/format/*
    +
    + - a symbolically formed event like 'pmu/config=M,config1=N,config2=K/'
    + where M, N, K are numbers (in decimal, hex, octal format).
    + Acceptable values for each of 'config', 'config1' and 'config2'
    + parameters are defined by corresponding entries in
    + /sys/bus/event_sources/devices/<pmu>/format/*

    -i::
    --no-inherit::
    --
    1.8.3.1


    \
     
     \ /
      Last update: 2014-12-22 21:21    [W:4.239 / U:0.092 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site