From: Ian Rogers <irogers@google.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Tuan Phan <tuanphan@os.amperecomputing.com>,
Robin Murphy <robin.murphy@arm.com>,
Thomas Richter <tmricht@linux.ibm.com>,
Bhaskara Budiredla <bbudiredla@marvell.com>,
Bharat Bhushan <bbhushan2@marvell.com>,
Peter Zijlstra <peterz@infradead.org>,
Ingo Molnar <mingo@redhat.com>,
Arnaldo Carvalho de Melo <acme@kernel.org>,
Namhyung Kim <namhyung@kernel.org>,
Mark Rutland <mark.rutland@arm.com>,
Alexander Shishkin <alexander.shishkin@linux.intel.com>,
Jiri Olsa <jolsa@kernel.org>,
Adrian Hunter <adrian.hunter@intel.com>,
Kan Liang <kan.liang@linux.intel.com>,
James Clark <james.clark@arm.com>,
Ravi Bangoria <ravi.bangoria@amd.com>,
linux-perf-users@vger.kernel.org, linux-kernel@vger.kernel.org,
Will Deacon <will@kernel.org>,
Stephane Eranian <eranian@google.com>
Subject: Re: [RFC PATCH v1] perf Documentation: Describe the PMU naming convention
Date: Tue, 14 May 2024 11:05:45 -0700 [thread overview]
Message-ID: <CAP-5=fXfUeuouJkW5uiB-6A6M9Ng86QzgNXZjO0C77oL4anWsA@mail.gmail.com> (raw)
In-Reply-To: <793876b1-fd4d-42ef-91e2-88b4a48794b7@infradead.org>
On Mon, May 13, 2024 at 10:40 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Hi,
>
> On 5/13/24 5:58 PM, Ian Rogers wrote:
> > It is an existing convention to use suffixes with PMU names. Try to
> > capture that convention so that future PMU devices may adhere to it.
> >
> > The name of the file and date within the file try to follow existing
> > conventions, particularly sysfs-bus-event_source-devices-events.
> > ---
> > .../testing/sysfs-bus-event_source-devices | 24 +++++++++++++++++++
> > 1 file changed, 24 insertions(+)
> > create mode 100644 Documentation/ABI/testing/sysfs-bus-event_source-devices
> >
> > diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices b/Documentation/ABI/testing/sysfs-bus-event_source-devices
> > new file mode 100644
> > index 000000000000..3f7e53e82de7
> > --- /dev/null
> > +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices
> > @@ -0,0 +1,24 @@
> > +What: /sys/bus/event_source/devices/<pmu>
> > +Date: 2014/02/24
> > +Contact: Linux kernel mailing list <linux-kernel@vger.kernel.org>
> > +Description: Performance Monitoring Unit (<pmu>)
> > +
>
> Mostly looks good to me. I prefer a small change (below).
>
> > + Each <pmu> directory, for a PMU device, is a name
> > + optionally followed by an underscore and then either a
> > + decimal or hexadecimal number. For example, cpu is a
> > + PMU name without a suffix as is intel_bts,
> > + uncore_imc_0 is a PMU name with a 0 numeric suffix,
> > + ddr_pmu_87e1b0000000 is a PMU name with a hex
> > + suffix. The hex suffix must be more than two
> > + characters long to avoid ambiguity with PMUs like the
> > + S390 cpum_cf.
> > +
> > + Tools can treat PMUs with the same name that differ by
> > + suffix as instances of the same PMU for the sake of,
> > + for example, opening an event. For example, the PMUs
> > + uncore_imc_free_running_0 and
> > + uncore_imc_free_running_1 have an event data_read,
>
> s/,/;/
> or: s/,/./ and begin the next sentence with a capital letter.
>
> > + opening the data_read event on a PMU specified as
> > + uncore_imc_free_running should be treated as opening
> > + the data_read event on PMU uncore_imc_free_running_0
> > + and PMU uncore_imc_free_running_1.
>
> With that change, you may add:
>
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
>
> thanks.
Thanks Randy, I'll leave this on the list to bake a little longer and
then send a v2 with your fixes.
Ian
> --
> #Randy
> https://people.kernel.org/tglx/notes-about-netiquette
> https://subspace.kernel.org/etiquette.html
prev parent reply other threads:[~2024-05-14 18:05 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-14 0:58 [RFC PATCH v1] perf Documentation: Describe the PMU naming convention Ian Rogers
2024-05-14 5:40 ` Randy Dunlap
2024-05-14 18:05 ` Ian Rogers [this message]
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='CAP-5=fXfUeuouJkW5uiB-6A6M9Ng86QzgNXZjO0C77oL4anWsA@mail.gmail.com' \
--to=irogers@google.com \
--cc=acme@kernel.org \
--cc=adrian.hunter@intel.com \
--cc=alexander.shishkin@linux.intel.com \
--cc=bbhushan2@marvell.com \
--cc=bbudiredla@marvell.com \
--cc=eranian@google.com \
--cc=james.clark@arm.com \
--cc=jolsa@kernel.org \
--cc=kan.liang@linux.intel.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-perf-users@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=mingo@redhat.com \
--cc=namhyung@kernel.org \
--cc=peterz@infradead.org \
--cc=ravi.bangoria@amd.com \
--cc=rdunlap@infradead.org \
--cc=robin.murphy@arm.com \
--cc=tmricht@linux.ibm.com \
--cc=tuanphan@os.amperecomputing.com \
--cc=will@kernel.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 read-only IMAP folder(s) and NNTP newsgroup(s).