From: "David E. Box" <david.e.box@linux.intel.com>
To: linux-kernel@vger.kernel.org, david.e.box@linux.intel.com,
ilpo.jarvinen@linux.intel.com, andriy.shevchenko@linux.intel.com,
platform-driver-x86@vger.kernel.org
Subject: [PATCH 00/17] tools/arch/x86/pmtctl: Add Intel PMT command-line tool
Date: Mon, 25 May 2026 18:46:58 -0700 [thread overview]
Message-ID: <20260526014719.2248380-1-david.e.box@linux.intel.com> (raw)
Intel Platform Monitoring Technology (PMT) exposes per-component telemetry
counters through sysfs via the pmt_telemetry auxiliary bus driver. Each
telemetry device provides a data file that can be read to sample the
underlying hardware telemetry data. The meaning of each field within a
sample is described by platform-specific metric definitions.
This series adds pmtctl, a command-line tool for querying PMT metrics on
x86 Linux systems. It lives under tools/arch/x86/pmtctl/ alongside other
platform-specific userspace tools.
The series introduces approximately 7k lines across the library, CLI
frontend, code generation scripts, and documentation. The changes are
intentionally split into small logical components so the architecture and
dependencies can be reviewed incrementally.
The implementation is split into a reusable library (libpmtctl_core) and a
thin CLI frontend:
libpmtctl_core (lib/)
- Device enumeration: scans /sys/bus/auxiliary/drivers/pmt_telemetry
and reads GUID and telem data path from sysfs attributes.
- Metric definitions: supports two loading modes:
built-in -- a C struct array compiled in at build time, generated
from perf-style JSON by scripts/gen_builtin_defs.py.
runtime -- loaded at invocation via -J/--json-file (requires
libjansson).
- Metric DB: block-based container with flat-index accessors.
- GUID intern table: canonical struct pmt_guid pointers shared between
the built-in and JSON providers.
CLI frontend (src/)
- list: enumerate discovered PMT devices and/or metric definitions,
with optional GUID intersection report (--guids) and device-only
mode (--devices).
- stat: perf-stat-like metric sampling with configurable interval,
count, event selection, and raw-register mode.
Metric JSON files are not included in the tree. Users obtain them from
the Intel-PMT repository using Makefile targets that fetch XML metric
definitions over the network and convert them into the JSON format
expected by the tool.
Testing: functional testing requires a system with PMT-capable hardware
and /sys/bus/auxiliary/drivers/pmt_telemetry populated. Reading telemetry
data (stat) requires elevated privileges (CAP_SYS_ADMIN / sudo); listing
metrics and devices (list) does not.
Summary
1. Infrastructure and meta:
0001: Adds the MAINTAINERS entry for the new tool.
2. Library (libpmtctl_core, under lib/):
0002–0008: Introduce the core library, including shared types, logging,
metric definitions, device enumeration, built-in and JSON
metric providers, public API, and core logic.
0009: Adds the libpmtctl Makefile, pkg-config file, and README for
the library.
0010–0011: Add usage samples and further built-in metric support for the
library.
3. CLI tool (under src/):
0012: Introduces the pmtctl CLI entry point, option parsing, and
pager helpers.
0013: Adds the 'list' command.
0014: Adds the 'stat' command.
4. Scripts/codegen:
0015: Adds the pmtxml2json.py conversion tool for XML→JSON metric
definitions.
5. Documentation and other:
0016: Adds README.md.
0017: Adds the man page.
David E. Box (17):
tools/arch/x86/pmtctl: Add MAINTAINERS entry
tools/arch/x86/pmtctl: Add libpmtctl shared type enumerations
tools/arch/x86/pmtctl: Add libpmtctl internal logging and utility
functions
tools/arch/x86/pmtctl: Add libpmtctl metric definition database
tools/arch/x86/pmtctl: Add libpmtctl device enumeration backend
tools/arch/x86/pmtctl: Add libpmtctl built-in metric provider
tools/arch/x86/pmtctl: Add libpmtctl JSON metric provider
tools/arch/x86/pmtctl: Add libpmtctl public API and context
tools/arch/x86/pmtctl: Add libpmtctl Makefile + pc + README
tools/arch/x86/pmtctl: Add libpmtctl usage sample
tools/arch/x86/pmtctl: Add libpmtctl built-in metric definition
support
tools/arch/x86/pmtctl: Add pmtctl CLI entry point and pager
tools/arch/x86/pmtctl: Add pmtctl 'list' command
tools/arch/x86/pmtctl: Add pmtctl 'stat' command
tools/arch/x86/pmtctl: Add pmtxml2json conversion tool
tools/arch/x86/pmtctl: Add README.md
tools/arch/x86/pmtctl: Add man page
MAINTAINERS | 1 +
tools/arch/x86/pmtctl/Makefile | 204 ++++
tools/arch/x86/pmtctl/README.md | 279 ++++++
tools/arch/x86/pmtctl/include/cmd_stat.h | 75 ++
.../arch/x86/pmtctl/include/cmd_stat_format.h | 11 +
.../x86/pmtctl/include/lib/builtin_defs.h | 14 +
tools/arch/x86/pmtctl/include/lib/common.h | 34 +
tools/arch/x86/pmtctl/include/lib/device.h | 53 ++
tools/arch/x86/pmtctl/include/lib/log.h | 80 ++
.../arch/x86/pmtctl/include/lib/metrics_db.h | 69 ++
.../x86/pmtctl/include/lib/metrics_provider.h | 21 +
tools/arch/x86/pmtctl/include/lib/pmt_guid.h | 63 ++
tools/arch/x86/pmtctl/include/lib/pmtctl.h | 90 ++
.../x86/pmtctl/include/lib/pmtctl_context.h | 21 +
.../x86/pmtctl/include/lib/pmtctl_types.h | 16 +
tools/arch/x86/pmtctl/include/pmtctl_cli.h | 16 +
tools/arch/x86/pmtctl/lib/Makefile | 138 +++
tools/arch/x86/pmtctl/lib/README | 116 +++
.../arch/x86/pmtctl/lib/builtin_defs_empty.c | 13 +
tools/arch/x86/pmtctl/lib/common.c | 178 ++++
tools/arch/x86/pmtctl/lib/device_telem.c | 371 ++++++++
tools/arch/x86/pmtctl/lib/log.c | 80 ++
tools/arch/x86/pmtctl/lib/metrics_db.c | 62 ++
tools/arch/x86/pmtctl/lib/metrics_provider.c | 42 +
.../x86/pmtctl/lib/metrics_provider_json.c | 459 +++++++++
tools/arch/x86/pmtctl/lib/pmt_guid.c | 200 ++++
tools/arch/x86/pmtctl/lib/pmtctl.c | 327 +++++++
tools/arch/x86/pmtctl/libpmtctl-core.pc.in | 11 +
tools/arch/x86/pmtctl/pmtctl.8 | 317 +++++++
.../x86/pmtctl/samples/libpmtctl_sample.c | 30 +
.../x86/pmtctl/scripts/gen_builtin_defs.py | 405 ++++++++
tools/arch/x86/pmtctl/scripts/pmtxml2json.md | 158 ++++
tools/arch/x86/pmtctl/scripts/pmtxml2json.py | 883 ++++++++++++++++++
tools/arch/x86/pmtctl/src/cmd_list.c | 786 ++++++++++++++++
tools/arch/x86/pmtctl/src/cmd_stat.c | 501 ++++++++++
tools/arch/x86/pmtctl/src/cmd_stat_format.c | 205 ++++
tools/arch/x86/pmtctl/src/cmd_stat_run.c | 528 +++++++++++
tools/arch/x86/pmtctl/src/main.c | 151 +++
tools/arch/x86/pmtctl/src/pager.c | 140 +++
39 files changed, 7148 insertions(+)
create mode 100644 tools/arch/x86/pmtctl/Makefile
create mode 100644 tools/arch/x86/pmtctl/README.md
create mode 100644 tools/arch/x86/pmtctl/include/cmd_stat.h
create mode 100644 tools/arch/x86/pmtctl/include/cmd_stat_format.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/builtin_defs.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/common.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/device.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/log.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/metrics_db.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/metrics_provider.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/pmt_guid.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/pmtctl.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/pmtctl_context.h
create mode 100644 tools/arch/x86/pmtctl/include/lib/pmtctl_types.h
create mode 100644 tools/arch/x86/pmtctl/include/pmtctl_cli.h
create mode 100644 tools/arch/x86/pmtctl/lib/Makefile
create mode 100644 tools/arch/x86/pmtctl/lib/README
create mode 100644 tools/arch/x86/pmtctl/lib/builtin_defs_empty.c
create mode 100644 tools/arch/x86/pmtctl/lib/common.c
create mode 100644 tools/arch/x86/pmtctl/lib/device_telem.c
create mode 100644 tools/arch/x86/pmtctl/lib/log.c
create mode 100644 tools/arch/x86/pmtctl/lib/metrics_db.c
create mode 100644 tools/arch/x86/pmtctl/lib/metrics_provider.c
create mode 100644 tools/arch/x86/pmtctl/lib/metrics_provider_json.c
create mode 100644 tools/arch/x86/pmtctl/lib/pmt_guid.c
create mode 100644 tools/arch/x86/pmtctl/lib/pmtctl.c
create mode 100644 tools/arch/x86/pmtctl/libpmtctl-core.pc.in
create mode 100644 tools/arch/x86/pmtctl/pmtctl.8
create mode 100644 tools/arch/x86/pmtctl/samples/libpmtctl_sample.c
create mode 100755 tools/arch/x86/pmtctl/scripts/gen_builtin_defs.py
create mode 100644 tools/arch/x86/pmtctl/scripts/pmtxml2json.md
create mode 100755 tools/arch/x86/pmtctl/scripts/pmtxml2json.py
create mode 100644 tools/arch/x86/pmtctl/src/cmd_list.c
create mode 100644 tools/arch/x86/pmtctl/src/cmd_stat.c
create mode 100644 tools/arch/x86/pmtctl/src/cmd_stat_format.c
create mode 100644 tools/arch/x86/pmtctl/src/cmd_stat_run.c
create mode 100644 tools/arch/x86/pmtctl/src/main.c
create mode 100644 tools/arch/x86/pmtctl/src/pager.c
base-commit: 5200f5f493f79f14bbdc349e402a40dfb32f23c8
--
2.43.0
next reply other threads:[~2026-05-26 1:47 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-26 1:46 David E. Box [this message]
2026-05-26 1:46 ` [PATCH 01/17] tools/arch/x86/pmtctl: Add MAINTAINERS entry David E. Box
2026-05-26 1:47 ` [PATCH 02/17] tools/arch/x86/pmtctl: Add libpmtctl shared type enumerations David E. Box
2026-05-26 9:20 ` Ilpo Järvinen
2026-05-26 1:47 ` [PATCH 03/17] tools/arch/x86/pmtctl: Add libpmtctl internal logging and utility functions David E. Box
2026-05-26 9:59 ` Ilpo Järvinen
2026-05-26 1:47 ` [PATCH 04/17] tools/arch/x86/pmtctl: Add libpmtctl metric definition database David E. Box
2026-05-26 10:06 ` Ilpo Järvinen
2026-05-26 1:47 ` [PATCH 05/17] tools/arch/x86/pmtctl: Add libpmtctl device enumeration backend David E. Box
2026-05-26 10:35 ` Ilpo Järvinen
2026-05-26 1:47 ` [PATCH 06/17] tools/arch/x86/pmtctl: Add libpmtctl built-in metric provider David E. Box
2026-05-26 1:47 ` [PATCH 07/17] tools/arch/x86/pmtctl: Add libpmtctl JSON " David E. Box
2026-05-26 11:04 ` Ilpo Järvinen
2026-05-26 1:47 ` [PATCH 08/17] tools/arch/x86/pmtctl: Add libpmtctl public API and context David E. Box
2026-05-26 11:25 ` Ilpo Järvinen
2026-05-26 17:44 ` David Box
2026-05-26 1:47 ` [PATCH 09/17] tools/arch/x86/pmtctl: Add libpmtctl Makefile + pc + README David E. Box
2026-05-26 1:47 ` [PATCH 10/17] tools/arch/x86/pmtctl: Add libpmtctl usage sample David E. Box
2026-05-26 1:47 ` [PATCH 11/17] tools/arch/x86/pmtctl: Add libpmtctl built-in metric definition support David E. Box
2026-05-26 1:47 ` [PATCH 12/17] tools/arch/x86/pmtctl: Add pmtctl CLI entry point and pager David E. Box
2026-05-26 1:47 ` [PATCH 13/17] tools/arch/x86/pmtctl: Add pmtctl 'list' command David E. Box
2026-05-26 1:47 ` [PATCH 14/17] tools/arch/x86/pmtctl: Add pmtctl 'stat' command David E. Box
2026-05-26 1:47 ` [PATCH 15/17] tools/arch/x86/pmtctl: Add pmtxml2json conversion tool David E. Box
2026-05-26 1:47 ` [PATCH 16/17] tools/arch/x86/pmtctl: Add README.md David E. Box
2026-05-26 1:47 ` [PATCH 17/17] tools/arch/x86/pmtctl: Add man page David E. Box
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=20260526014719.2248380-1-david.e.box@linux.intel.com \
--to=david.e.box@linux.intel.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=ilpo.jarvinen@linux.intel.com \
--cc=linux-kernel@vger.kernel.org \
--cc=platform-driver-x86@vger.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.