2020-09-01 22:00:43

by Kim Phillips

Subject: [PATCH] perf record/stat: Explicitly call out event modifiers in the documentation

Event modifiers are not mentioned in the perf record or perf stat
manpages. Add them to orient new users more effectively by pointing
them to the perf list manpage for details.

Signed-off-by: Kim Phillips <[email protected]>
Fixes: 2055fdaf8703 ("perf list: Document precise event sampling for AMD IBS")
Cc: Peter Zijlstra <[email protected]>
Cc: Ingo Molnar <[email protected]>
Cc: Arnaldo Carvalho de Melo <[email protected]>
Cc: Mark Rutland <[email protected]>
Cc: Alexander Shishkin <[email protected]>
Cc: Jiri Olsa <[email protected]>
Cc: Namhyung Kim <[email protected]>
Cc: Adrian Hunter <[email protected]>
Cc: Stephane Eranian <[email protected]>
Cc: Alexey Budankov <[email protected]>
Cc: Tony Jones <[email protected]>
Cc: Jin Yao <[email protected]>
Cc: Ian Rogers <[email protected]>
Cc: "Paul A. Clarke" <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
---
tools/perf/Documentation/perf-record.txt | 4 ++++
tools/perf/Documentation/perf-stat.txt | 4 ++++
2 files changed, 8 insertions(+)

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

+ - a symbolic or raw PMU event followed by an optional colon
+ and a list of event modifiers, e.g., cpu-cycles:p. See the
+ linkperf:perf-list[1] man page for details on event modifiers.
+
- 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_source/devices/<pmu>/format/*.
diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
index c9bfefc051fb..a4b1d11fefc8 100644
--- a/tools/perf/Documentation/perf-stat.txt
+++ b/tools/perf/Documentation/perf-stat.txt
@@ -39,6 +39,10 @@ report::
- a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a
hexadecimal event descriptor.

+ - a symbolic or raw PMU event followed by an optional colon
+ and a list of event modifiers, e.g., cpu-cycles:p. See the
+ linkperf:perf-list[1] man page for details on event modifiers.
+
- a symbolically formed event like 'pmu/param1=0x3,param2/' where
param1 and param2 are defined as formats for the PMU in
/sys/bus/event_source/devices/<pmu>/format/*
--
2.27.0

2020-09-03 19:04:20

by Arnaldo Carvalho de Melo

Subject: Re: [PATCH] perf record/stat: Explicitly call out event modifiers in the documentation

Em Tue, Sep 01, 2020 at 04:58:53PM -0500, Kim Phillips escreveu:
> Event modifiers are not mentioned in the perf record or perf stat
> manpages. Add them to orient new users more effectively by pointing
> them to the perf list manpage for details.

Thanks, applied.

- Arnaldo

> Signed-off-by: Kim Phillips <[email protected]>
> Fixes: 2055fdaf8703 ("perf list: Document precise event sampling for AMD IBS")
> Cc: Peter Zijlstra <[email protected]>
> Cc: Ingo Molnar <[email protected]>
> Cc: Arnaldo Carvalho de Melo <[email protected]>
> Cc: Mark Rutland <[email protected]>
> Cc: Alexander Shishkin <[email protected]>
> Cc: Jiri Olsa <[email protected]>
> Cc: Namhyung Kim <[email protected]>
> Cc: Adrian Hunter <[email protected]>
> Cc: Stephane Eranian <[email protected]>
> Cc: Alexey Budankov <[email protected]>
> Cc: Tony Jones <[email protected]>
> Cc: Jin Yao <[email protected]>
> Cc: Ian Rogers <[email protected]>
> Cc: "Paul A. Clarke" <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
> ---
> tools/perf/Documentation/perf-record.txt | 4 ++++
> tools/perf/Documentation/perf-stat.txt | 4 ++++
> 2 files changed, 8 insertions(+)
>
> diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
> index 3f72d8e261f3..bd50cdff08a8 100644
> --- a/tools/perf/Documentation/perf-record.txt
> +++ b/tools/perf/Documentation/perf-record.txt
> @@ -33,6 +33,10 @@ OPTIONS
> - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a
> hexadecimal event descriptor.
>
> + - a symbolic or raw PMU event followed by an optional colon
> + and a list of event modifiers, e.g., cpu-cycles:p. See the
> + linkperf:perf-list[1] man page for details on event modifiers.
> +
> - 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_source/devices/<pmu>/format/*.
> diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
> index c9bfefc051fb..a4b1d11fefc8 100644
> --- a/tools/perf/Documentation/perf-stat.txt
> +++ b/tools/perf/Documentation/perf-stat.txt
> @@ -39,6 +39,10 @@ report::
> - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a
> hexadecimal event descriptor.
>
> + - a symbolic or raw PMU event followed by an optional colon
> + and a list of event modifiers, e.g., cpu-cycles:p. See the
> + linkperf:perf-list[1] man page for details on event modifiers.
> +
> - a symbolically formed event like 'pmu/param1=0x3,param2/' where
> param1 and param2 are defined as formats for the PMU in
> /sys/bus/event_source/devices/<pmu>/format/*
> --
> 2.27.0
>

--

- Arnaldo