* [PATCH v11 0/2] perf jevents: Fail the build on a key the tables may not carry
[not found] <20261113032927.634183-1-takano32@gmail.com>
@ 2026-11-20 6:09 ` TAKANO Mitsuhiro
2026-11-20 6:09 ` [PATCH v11 1/2] perf vendor events: Fix misspelled keys in the event tables TAKANO Mitsuhiro
` (2 more replies)
0 siblings, 3 replies; 7+ messages in thread
From: TAKANO Mitsuhiro @ 2026-11-20 6:09 UTC (permalink / raw)
To: linux-perf-users, Ingo Molnar, Peter Zijlstra,
Arnaldo Carvalho de Melo, Namhyung Kim
Cc: Ian Rogers, James Clark, John Garry, linux-arm-kernel,
Ilkka Koskinen, linux-kernel, TAKANO Mitsuhiro, Will Deacon,
Mike Leach, Leo Yan, Mark Rutland, Alexander Shishkin, Jiri Olsa,
Adrian Hunter
v11. The shape is James's: the check is not an option any more, so a
typo in a key stops the build instead of being dropped without a word.
--check is gone. Every event and metric table goes through
JsonEvent.__init__, so the keys of each object are compared there with
_valid_keys. No new option, no second walk over the directory, and no way
to run the generator without the check. (metricgroups.json is a plain
dictionary of group names and is not checked.) The test is
jevents_bad_key.sh and checks the failing case only.
1/2 is the prerequisite James asked for: the tree carries 19 objects with a
key the tables may not carry, so 2/2 cannot land on an unfixed tree. It is
the two fixes posted on their own, squashed. The AMD one went into
perf-tools-next on 11 November and the arm64 v2 has Ilkka's Acked-by, so if
both are in your tree, 2/2 is all that is left; if the AMD one is in but
the arm64 one is not, 1/2 will need -3 or its AMD hunks dropped.
Measured: on 1/2 + 2/2, the generator run over all architectures, over
x86 alone and over arm64 alone exits 0. Putting BriefDescript6ion back
into one AMD table makes the x86 run exit 1 with "jevents.py: <path>:
unknown key(s): ['BriefDescript6ion']"; the arm64 run does not read the
x86 tables and still exits 0.
TAKANO Mitsuhiro (2):
perf vendor events: Fix misspelled keys in the event tables
perf jevents: Fail the build on a key the tables may not carry
.../arch/arm64/ampere/ampereonex/mmu.json | 32 ++++-----
.../pmu-events/arch/x86/amdzen4/cache.json | 2 +-
.../arch/x86/amdzen5/load-store.json | 2 +-
.../arch/x86/amdzen6/load-store.json | 2 +-
tools/perf/pmu-events/jevents.py | 70 +++++++++++++++----
tools/perf/tests/shell/jevents_bad_key.sh | 43 ++++++++++++
6 files changed, 117 insertions(+), 34 deletions(-)
create mode 100755 tools/perf/tests/shell/jevents_bad_key.sh
base-commit: 7475ea8b58616b33c04afb976cf0fbaad9dd63fb
--
2.53.0
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH v11 1/2] perf vendor events: Fix misspelled keys in the event tables
2026-11-20 6:09 ` [PATCH v11 0/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
@ 2026-11-20 6:09 ` TAKANO Mitsuhiro
2026-11-20 6:09 ` [PATCH v11 2/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
2026-11-20 13:42 ` [PATCH v12 0/2] " TAKANO Mitsuhiro
2 siblings, 0 replies; 7+ messages in thread
From: TAKANO Mitsuhiro @ 2026-11-20 6:09 UTC (permalink / raw)
To: linux-perf-users, Ingo Molnar, Peter Zijlstra,
Arnaldo Carvalho de Melo, Namhyung Kim
Cc: Ian Rogers, James Clark, John Garry, linux-arm-kernel,
Ilkka Koskinen, linux-kernel, TAKANO Mitsuhiro, Will Deacon,
Mike Leach, Leo Yan, Mark Rutland, Alexander Shishkin, Jiri Olsa,
Adrian Hunter
Sixteen objects in arch/arm64/ampere/ampereonex/mmu.json carry
"PublicDescrition" and one object in each of amdzen4/cache.json,
amdzen5/load-store.json and amdzen6/load-store.json carries
"BriefDescript6ion". jevents.py reads only the keys it knows by name, so
these fields have no effect: the text is dropped without a word and never
reaches the generated tables.
For the three AMD events that leaves them with no description at all, and
the text comes back. The AmpereOneX events carry the same text in
BriefDescription and the generator drops a duplicate long description, so
the generated arm64 tables are unchanged.
This is the same change as "perf vendor events arm64 AmpereOneX: Fix
misspelled PublicDescription keys" (Message-ID
<20261113065253.746615-1-takano32@gmail.com>) and "perf vendor events amd:
Fix a misspelled JSON key" (<20261108184600.3810059-1-takano32@gmail.com>),
squashed into one patch so that this series applies on its own.
Written with Hermes Agent, an LLM assistant; the author reviewed it and
ran the generator as described.
Fixes: 16438b652b46 ("perf vendor events arm64 AmpereOneX: Add core PMU events and metrics")
Fixes: 658448281d19 ("perf vendor events amd: Add Zen 4 core events")
Fixes: 45c072f2537a ("perf vendor events amd: Add Zen 5 core events")
Fixes: 2f42fb0661d9 ("perf vendor events amd: Add Zen 6 core events")
Acked-by: Ilkka Koskinen <ilkka@os.amperecomputing.com>
Signed-off-by: TAKANO Mitsuhiro <takano32@gmail.com>
---
.../arch/arm64/ampere/ampereonex/mmu.json | 32 +++++++++----------
.../pmu-events/arch/x86/amdzen4/cache.json | 2 +-
.../arch/x86/amdzen5/load-store.json | 2 +-
.../arch/x86/amdzen6/load-store.json | 2 +-
4 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/tools/perf/pmu-events/arch/arm64/ampere/ampereonex/mmu.json b/tools/perf/pmu-events/arch/arm64/ampere/ampereonex/mmu.json
index 66d83b680651..9457f9be4ecc 100644
--- a/tools/perf/pmu-events/arch/arm64/ampere/ampereonex/mmu.json
+++ b/tools/perf/pmu-events/arch/arm64/ampere/ampereonex/mmu.json
@@ -30,37 +30,37 @@
"BriefDescription": "Data TLB translation cache hit on S2L2 walk cache entry"
},
{
- "PublicDescrition": "Data TLB translation cache hit on S2L1 walk cache entry",
+ "PublicDescription": "Data TLB translation cache hit on S2L1 walk cache entry",
"EventCode": "0xd805",
"EventName": "MMU_D_TRANS_CACHE_HIT_S2L1_WALK",
"BriefDescription": "Data TLB translation cache hit on S2L1 walk cache entry"
},
{
- "PublicDescrition": "Data TLB translation cache hit on S2L0 walk cache entry",
+ "PublicDescription": "Data TLB translation cache hit on S2L0 walk cache entry",
"EventCode": "0xd806",
"EventName": "MMU_D_TRANS_CACHE_HIT_S2L0_WALK",
"BriefDescription": "Data TLB translation cache hit on S2L0 walk cache entry"
},
{
- "PublicDescrition": "Data-side S1 page walk cache lookup",
+ "PublicDescription": "Data-side S1 page walk cache lookup",
"EventCode": "0xd807",
"EventName": "MMU_D_S1_WALK_CACHE_LOOKUP",
"BriefDescription": "Data-side S1 page walk cache lookup"
},
{
- "PublicDescrition": "Data-side S1 page walk cache refill",
+ "PublicDescription": "Data-side S1 page walk cache refill",
"EventCode": "0xd808",
"EventName": "MMU_D_S1_WALK_CACHE_REFILL",
"BriefDescription": "Data-side S1 page walk cache refill"
},
{
- "PublicDescrition": "Data-side S2 page walk cache lookup",
+ "PublicDescription": "Data-side S2 page walk cache lookup",
"EventCode": "0xd809",
"EventName": "MMU_D_S2_WALK_CACHE_LOOKUP",
"BriefDescription": "Data-side S2 page walk cache lookup"
},
{
- "PublicDescrition": "Data-side S2 page walk cache refill",
+ "PublicDescription": "Data-side S2 page walk cache refill",
"EventCode": "0xd80a",
"EventName": "MMU_D_S2_WALK_CACHE_REFILL",
"BriefDescription": "Data-side S2 page walk cache refill"
@@ -90,61 +90,61 @@
"BriefDescription": "Level 2 instruction translation buffer allocation"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S1L2 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S1L2 walk cache entry",
"EventCode": "0xd901",
"EventName": "MMU_I_TRANS_CACHE_HIT_S1L2_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S1L2 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S1L1 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S1L1 walk cache entry",
"EventCode": "0xd902",
"EventName": "MMU_I_TRANS_CACHE_HIT_S1L1_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S1L1 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S1L0 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S1L0 walk cache entry",
"EventCode": "0xd903",
"EventName": "MMU_I_TRANS_CACHE_HIT_S1L0_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S1L0 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S2L2 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S2L2 walk cache entry",
"EventCode": "0xd904",
"EventName": "MMU_I_TRANS_CACHE_HIT_S2L2_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S2L2 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S2L1 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S2L1 walk cache entry",
"EventCode": "0xd905",
"EventName": "MMU_I_TRANS_CACHE_HIT_S2L1_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S2L1 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S2L0 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S2L0 walk cache entry",
"EventCode": "0xd906",
"EventName": "MMU_I_TRANS_CACHE_HIT_S2L0_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S2L0 walk cache entry"
},
{
- "PublicDescrition": "Instruction-side S1 page walk cache lookup",
+ "PublicDescription": "Instruction-side S1 page walk cache lookup",
"EventCode": "0xd907",
"EventName": "MMU_I_S1_WALK_CACHE_LOOKUP",
"BriefDescription": "Instruction-side S1 page walk cache lookup"
},
{
- "PublicDescrition": "Instruction-side S1 page walk cache refill",
+ "PublicDescription": "Instruction-side S1 page walk cache refill",
"EventCode": "0xd908",
"EventName": "MMU_I_S1_WALK_CACHE_REFILL",
"BriefDescription": "Instruction-side S1 page walk cache refill"
},
{
- "PublicDescrition": "Instruction-side S2 page walk cache lookup",
+ "PublicDescription": "Instruction-side S2 page walk cache lookup",
"EventCode": "0xd909",
"EventName": "MMU_I_S2_WALK_CACHE_LOOKUP",
"BriefDescription": "Instruction-side S2 page walk cache lookup"
},
{
- "PublicDescrition": "Instruction-side S2 page walk cache refill",
+ "PublicDescription": "Instruction-side S2 page walk cache refill",
"EventCode": "0xd90a",
"EventName": "MMU_I_S2_WALK_CACHE_REFILL",
"BriefDescription": "Instruction-side S2 page walk cache refill"
diff --git a/tools/perf/pmu-events/arch/x86/amdzen4/cache.json b/tools/perf/pmu-events/arch/x86/amdzen4/cache.json
index e6d710cf3ce2..01c848a9dbb3 100644
--- a/tools/perf/pmu-events/arch/x86/amdzen4/cache.json
+++ b/tools/perf/pmu-events/arch/x86/amdzen4/cache.json
@@ -182,7 +182,7 @@
{
"EventName": "ls_inef_sw_pref.all",
"EventCode": "0x52",
- "BriefDescript6ion": "Software prefetches that did not fetch data outside of the processor core for any reason.",
+ "BriefDescription": "Software prefetches that did not fetch data outside of the processor core for any reason.",
"UMask": "0x03"
},
{
diff --git a/tools/perf/pmu-events/arch/x86/amdzen5/load-store.json b/tools/perf/pmu-events/arch/x86/amdzen5/load-store.json
index b1994539ece8..774da0bfa0dd 100644
--- a/tools/perf/pmu-events/arch/x86/amdzen5/load-store.json
+++ b/tools/perf/pmu-events/arch/x86/amdzen5/load-store.json
@@ -351,7 +351,7 @@
{
"EventName": "ls_inef_sw_pref.all",
"EventCode": "0x52",
- "BriefDescript6ion": "Software prefetches that did not fetch data outside of the processor core for any reason.",
+ "BriefDescription": "Software prefetches that did not fetch data outside of the processor core for any reason.",
"UMask": "0x03"
},
{
diff --git a/tools/perf/pmu-events/arch/x86/amdzen6/load-store.json b/tools/perf/pmu-events/arch/x86/amdzen6/load-store.json
index 4291eb59426f..4adba70bffb1 100644
--- a/tools/perf/pmu-events/arch/x86/amdzen6/load-store.json
+++ b/tools/perf/pmu-events/arch/x86/amdzen6/load-store.json
@@ -351,7 +351,7 @@
{
"EventName": "ls_inef_sw_pref.all",
"EventCode": "0x52",
- "BriefDescript6ion": "Software prefetches that did not fetch data outside of the processor core for any reason.",
+ "BriefDescription": "Software prefetches that did not fetch data outside of the processor core for any reason.",
"UMask": "0x03"
},
{
--
2.53.0
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [PATCH v11 2/2] perf jevents: Fail the build on a key the tables may not carry
2026-11-20 6:09 ` [PATCH v11 0/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
2026-11-20 6:09 ` [PATCH v11 1/2] perf vendor events: Fix misspelled keys in the event tables TAKANO Mitsuhiro
@ 2026-11-20 6:09 ` TAKANO Mitsuhiro
2026-11-20 10:06 ` James Clark
2026-11-20 13:42 ` [PATCH v12 0/2] " TAKANO Mitsuhiro
2 siblings, 1 reply; 7+ messages in thread
From: TAKANO Mitsuhiro @ 2026-11-20 6:09 UTC (permalink / raw)
To: linux-perf-users, Ingo Molnar, Peter Zijlstra,
Arnaldo Carvalho de Melo, Namhyung Kim
Cc: Ian Rogers, James Clark, John Garry, linux-arm-kernel,
Ilkka Koskinen, linux-kernel, TAKANO Mitsuhiro, Will Deacon,
Mike Leach, Leo Yan, Mark Rutland, Alexander Shishkin, Jiri Olsa,
Adrian Hunter
jevents.py takes the fields it wants out of each JSON object by name and
ignores the rest, so a key that is spelled differently is dropped without
a word and the object is built without whatever that field held.
Compare the keys of each object with _valid_keys, the keys a table may
carry, and fail on anything else. The error is one line naming the file
and the key:
jevents.py: <path>: unknown key(s): ['BriefDescript6ion']
Written with Hermes Agent, an LLM assistant; the author reviewed it and
ran the generator on every arch directory, with and without a key the
tables may not carry.
Signed-off-by: TAKANO Mitsuhiro <takano32@gmail.com>
---
tools/perf/pmu-events/jevents.py | 70 ++++++++++++++++++-----
tools/perf/tests/shell/jevents_bad_key.sh | 43 ++++++++++++++
2 files changed, 98 insertions(+), 15 deletions(-)
create mode 100755 tools/perf/tests/shell/jevents_bad_key.sh
diff --git a/tools/perf/pmu-events/jevents.py b/tools/perf/pmu-events/jevents.py
index 080e04b51b8c..65e51dafd42b 100755
--- a/tools/perf/pmu-events/jevents.py
+++ b/tools/perf/pmu-events/jevents.py
@@ -63,6 +63,27 @@ _json_metric_attributes = [
# Attributes that are bools or enum int values, encoded as '0', '1',...
_json_enum_attributes = ['aggr_mode', 'deprecated', 'event_grouping', 'perpkg',
'default_show_events']
+# Keys a table under arch/ may carry. jevents.py takes the fields it wants by
+# name and drops the rest without a word, so a key that is spelled differently
+# is only visible as a field that went missing; a table carrying anything else
+# is an error. The list holds the keys jevents.py reads, plus the ones the
+# tables carry and it does not read: Counter, CountersNumFixed and
+# CountersNumGeneric (read by nothing) and Experimental (read by metric.py).
+_valid_keys: Set[str] = {
+ 'AggregationMode', 'AnyThread', 'ArchStdEvent', 'BriefDescription',
+ 'Compat', 'ConfigCode', 'Counter', 'CounterMask',
+ 'CountersNumFixed', 'CountersNumGeneric', 'Data_LA', 'DefaultMetricgroupName',
+ 'DefaultShowEvents', 'Deprecated', 'EdgeDetect', 'EnAllCores',
+ 'EnAllSlices', 'Errata', 'EventCode', 'EventidCode',
+ 'EventName', 'Experimental', 'ExtSel', 'FCMask',
+ 'Filter', 'Invert', 'LegacyCacheCode', 'LegacyConfigCode',
+ 'MetricConstraint', 'MetricExpr', 'MetricGroup', 'MetricgroupNoGroup',
+ 'MetricName', 'MetricThreshold', 'MSRIndex', 'MSRValue',
+ 'NodeType', 'PEBS', 'PerPkg', 'PortMask',
+ 'PublicDescription', 'RdWrMask', 'RetirementLatencyMax', 'RetirementLatencyMean',
+ 'RetirementLatencyMin', 'SampleAfterValue', 'ScaleUnit', 'SliceId',
+ 'ThreadMask', 'UMask', 'Unit',
+}
def file_name_to_table_name(prefix: str, parents: Sequence[str],
dirname: str) -> str:
@@ -196,6 +217,9 @@ class JsonEvent:
def __init__(self, jd: dict):
"""Constructor passed the dictionary of parsed json values."""
+ if extra := set(jd) - _valid_keys:
+ raise ValueError(f'unknown key(s): {sorted(extra)}')
+
def llx(x: int) -> str:
"""Convert an int to a string similar to a printf modifier of %#llx."""
return str(x) if x >= 0 and x < 10 else hex(x)
@@ -459,6 +483,8 @@ def _read_json_events_impl(path: str, topic: str) -> Sequence[JsonEvent]:
try:
with open(path, encoding='utf-8') as f:
events = json.load(f, object_hook=JsonEvent)
+ except ValueError as exc:
+ raise ValueError(f'{path}: {exc}') from exc
except BaseException:
print(f"Exception processing {path}")
raise
@@ -492,6 +518,8 @@ def preprocess_arch_std_files(archpath: str) -> None:
_arch_std_events[event.name.lower()] = event
if event.metric_name:
_arch_std_events[event.metric_name.lower()] = event
+ except ValueError:
+ raise
except Exception as e:
raise RuntimeError(f'Failure processing \'{item.name}\' in \'{archpath}\'') from e
@@ -643,7 +671,10 @@ def preprocess_one_file(parents: Sequence[str], item: os.DirEntry) -> None:
assert _bcs is not None
if item.name.endswith('metricgroups.json'):
with open(item.path, encoding='utf-8') as f:
- metricgroup_descriptions = json.load(f)
+ try:
+ metricgroup_descriptions = json.load(f)
+ except ValueError as exc:
+ raise ValueError(f'{item.path}: {exc}') from exc
for mgroup in metricgroup_descriptions:
assert len(mgroup) > 1, parents
description = f"{metricgroup_descriptions[mgroup]}\\000"
@@ -1473,6 +1504,8 @@ def main() -> None:
continue
try:
action(parents, item)
+ except ValueError:
+ raise
except Exception as e:
raise RuntimeError(f'Action failure for \'{item.name}\' in {parents}') from e
if item.is_dir():
@@ -1536,20 +1569,27 @@ struct pmu_table_entry {
if item.is_file() and item.name.endswith('.json') and not item.name.endswith('metricgroups.json'):
tasks.append((item.path, get_topic(item.name)))
- for arch in archs:
- arch_path = f'{_args.starting_dir}/{arch}'
- preprocess_arch_std_files(arch_path)
- ftw(arch_path, [], collect_json)
-
- with concurrent.futures.ProcessPoolExecutor(max_workers=_parallel_worker_count(len(tasks)),
- initializer=_init_worker,
- initargs=(_arch_std_events,)) as executor:
- for path, topic, events in executor.map(_parallel_read_json_events, tasks):
- _json_cache[(path, topic)] = events
-
- for arch in archs:
- arch_path = f'{_args.starting_dir}/{arch}'
- ftw(arch_path, [], preprocess_one_file)
+ try:
+ for arch in archs:
+ arch_path = f'{_args.starting_dir}/{arch}'
+ preprocess_arch_std_files(arch_path)
+ ftw(arch_path, [], collect_json)
+
+ with concurrent.futures.ProcessPoolExecutor(max_workers=_parallel_worker_count(len(tasks)),
+ initializer=_init_worker,
+ initargs=(_arch_std_events,)) as executor:
+ for path, topic, events in executor.map(_parallel_read_json_events, tasks):
+ _json_cache[(path, topic)] = events
+
+ for arch in archs:
+ arch_path = f'{_args.starting_dir}/{arch}'
+ ftw(arch_path, [], preprocess_one_file)
+ except ValueError as exc:
+ # A worker's traceback is three levels of ProcessPoolExecutor noise around
+ # the one line that matters, so say it here and stop. make deletes the
+ # target it failed to build (.DELETE_ON_ERROR), so the next run reads the
+ # JSON again rather than a half-written table.
+ sys.exit(f'jevents.py: {exc}')
assert _bcs is not None
_bcs.compute()
diff --git a/tools/perf/tests/shell/jevents_bad_key.sh b/tools/perf/tests/shell/jevents_bad_key.sh
new file mode 100755
index 000000000000..7848e60b8b4a
--- /dev/null
+++ b/tools/perf/tests/shell/jevents_bad_key.sh
@@ -0,0 +1,43 @@
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0
+# Check jevents.py reports unknown keys as errors (no_mlock)
+#
+# A key that is spelled differently is dropped without a word, so jevents.py
+# compares the keys of each object in a table against the keys it reads and
+# fails on anything else.
+
+jevents=$(dirname "$0")/../../pmu-events/jevents.py
+python=${PYTHON:-python3}
+
+# An installed perf has the test but not the generator, and a python that is
+# not there or too old to run it is a skip, not a failure of the check.
+[ -r "${jevents}" ] || exit 2
+[ "$("${python}" -c 'import sys; print(sys.version_info >= (3, 9))' 2>/dev/null)" = True ] \
+ || exit 2
+
+tmp=$(mktemp -d) || exit 2
+trap 'rm -rf "${tmp}"' EXIT HUP INT TERM
+tables="${tmp}/arch/x86/model"
+mkdir -p "${tables}" "${tmp}/arch/common"
+printf '[]\n' > "${tmp}/arch/common/empty.json"
+printf 'Family-model,Version,Filename,EventType\nGenuineIntel-6-97,v1.0,model,core\n' \
+ > "${tmp}/arch/x86/mapfile.csv"
+printf '[{"EventName": "a", "NotAKey": "x"}]\n' > "${tables}/events.json"
+
+if "${python}" -B "${jevents}" x86 all "${tmp}/arch" \
+ "${tmp}/pmu-events.c" "${tmp}/pmu-events-string.c" 2> "${tmp}/err"; then
+ echo "jevents.py accepted a key it does not read" >&2
+ exit 1
+fi
+grep -qF -- "NotAKey" "${tmp}/err" || {
+ echo "jevents.py failed without naming the key" >&2
+ cat "${tmp}/err" >&2
+ exit 1
+}
+grep -qF -- "${tables}/events.json" "${tmp}/err" || {
+ echo "jevents.py failed without naming the file" >&2
+ cat "${tmp}/err" >&2
+ exit 1
+}
+
+exit 0
--
2.53.0
^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [PATCH v11 2/2] perf jevents: Fail the build on a key the tables may not carry
2026-11-20 6:09 ` [PATCH v11 2/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
@ 2026-11-20 10:06 ` James Clark
0 siblings, 0 replies; 7+ messages in thread
From: James Clark @ 2026-11-20 10:06 UTC (permalink / raw)
To: TAKANO Mitsuhiro
Cc: Ian Rogers, John Garry, linux-arm-kernel, Ilkka Koskinen,
linux-kernel, Will Deacon, Mike Leach, Leo Yan, Mark Rutland,
Alexander Shishkin, Jiri Olsa, Adrian Hunter, linux-perf-users,
Ingo Molnar, Peter Zijlstra, Arnaldo Carvalho de Melo,
Namhyung Kim
On 20/11/2026 06:09, TAKANO Mitsuhiro wrote:
> jevents.py takes the fields it wants out of each JSON object by name and
> ignores the rest, so a key that is spelled differently is dropped without
> a word and the object is built without whatever that field held.
>
> Compare the keys of each object with _valid_keys, the keys a table may
> carry, and fail on anything else. The error is one line naming the file
> and the key:
>
> jevents.py: <path>: unknown key(s): ['BriefDescript6ion']
>
> Written with Hermes Agent, an LLM assistant; the author reviewed it and
> ran the generator on every arch directory, with and without a key the
> tables may not carry.
>
> Signed-off-by: TAKANO Mitsuhiro <takano32@gmail.com>
> ---
> tools/perf/pmu-events/jevents.py | 70 ++++++++++++++++++-----
> tools/perf/tests/shell/jevents_bad_key.sh | 43 ++++++++++++++
> 2 files changed, 98 insertions(+), 15 deletions(-)
> create mode 100755 tools/perf/tests/shell/jevents_bad_key.sh
>
> diff --git a/tools/perf/pmu-events/jevents.py b/tools/perf/pmu-events/jevents.py
> index 080e04b51b8c..65e51dafd42b 100755
> --- a/tools/perf/pmu-events/jevents.py
> +++ b/tools/perf/pmu-events/jevents.py
> @@ -63,6 +63,27 @@ _json_metric_attributes = [
> # Attributes that are bools or enum int values, encoded as '0', '1',...
> _json_enum_attributes = ['aggr_mode', 'deprecated', 'event_grouping', 'perpkg',
> 'default_show_events']
> +# Keys a table under arch/ may carry. jevents.py takes the fields it wants by
> +# name and drops the rest without a word, so a key that is spelled differently
> +# is only visible as a field that went missing; a table carrying anything else
> +# is an error. The list holds the keys jevents.py reads, plus the ones the
> +# tables carry and it does not read: Counter, CountersNumFixed and
> +# CountersNumGeneric (read by nothing) and Experimental (read by metric.py).
> +_valid_keys: Set[str] = {
> + 'AggregationMode', 'AnyThread', 'ArchStdEvent', 'BriefDescription',
> + 'Compat', 'ConfigCode', 'Counter', 'CounterMask',
> + 'CountersNumFixed', 'CountersNumGeneric', 'Data_LA', 'DefaultMetricgroupName',
> + 'DefaultShowEvents', 'Deprecated', 'EdgeDetect', 'EnAllCores',
> + 'EnAllSlices', 'Errata', 'EventCode', 'EventidCode',
> + 'EventName', 'Experimental', 'ExtSel', 'FCMask',
> + 'Filter', 'Invert', 'LegacyCacheCode', 'LegacyConfigCode',
> + 'MetricConstraint', 'MetricExpr', 'MetricGroup', 'MetricgroupNoGroup',
> + 'MetricName', 'MetricThreshold', 'MSRIndex', 'MSRValue',
> + 'NodeType', 'PEBS', 'PerPkg', 'PortMask',
> + 'PublicDescription', 'RdWrMask', 'RetirementLatencyMax', 'RetirementLatencyMean',
> + 'RetirementLatencyMin', 'SampleAfterValue', 'ScaleUnit', 'SliceId',
> + 'ThreadMask', 'UMask', 'Unit',
> +}
>
> def file_name_to_table_name(prefix: str, parents: Sequence[str],
> dirname: str) -> str:
> @@ -196,6 +217,9 @@ class JsonEvent:
> def __init__(self, jd: dict):
> """Constructor passed the dictionary of parsed json values."""
>
> + if extra := set(jd) - _valid_keys:
> + raise ValueError(f'unknown key(s): {sorted(extra)}')
> +
All you need is this raise, you don't need any of the other try catch
changes. It already prints the filename, a little bit of stack and then
the missing key as the last line:
Exception processing pmu-events/arch/x86/amdzen1/core.json
...
ValueError: Unknown keys ['EvendtName'] ...
It's perfectly legible as an error as it is and not worth the churn and
extra noise in the code.
> def llx(x: int) -> str:
> """Convert an int to a string similar to a printf modifier of %#llx."""
> return str(x) if x >= 0 and x < 10 else hex(x)
> @@ -459,6 +483,8 @@ def _read_json_events_impl(path: str, topic: str) -> Sequence[JsonEvent]:
> try:
> with open(path, encoding='utf-8') as f:
> events = json.load(f, object_hook=JsonEvent)
> + except ValueError as exc:
> + raise ValueError(f'{path}: {exc}') from exc
> except BaseException:
> print(f"Exception processing {path}")
> raise
> @@ -492,6 +518,8 @@ def preprocess_arch_std_files(archpath: str) -> None:
> _arch_std_events[event.name.lower()] = event
> if event.metric_name:
> _arch_std_events[event.metric_name.lower()] = event
> + except ValueError:
> + raise
> except Exception as e:
> raise RuntimeError(f'Failure processing \'{item.name}\' in \'{archpath}\'') from e
>
> @@ -643,7 +671,10 @@ def preprocess_one_file(parents: Sequence[str], item: os.DirEntry) -> None:
> assert _bcs is not None
> if item.name.endswith('metricgroups.json'):
> with open(item.path, encoding='utf-8') as f:
> - metricgroup_descriptions = json.load(f)
> + try:
> + metricgroup_descriptions = json.load(f)
> + except ValueError as exc:
> + raise ValueError(f'{item.path}: {exc}') from exc
> for mgroup in metricgroup_descriptions:
> assert len(mgroup) > 1, parents
> description = f"{metricgroup_descriptions[mgroup]}\\000"
> @@ -1473,6 +1504,8 @@ def main() -> None:
> continue
> try:
> action(parents, item)
> + except ValueError:
> + raise
> except Exception as e:
> raise RuntimeError(f'Action failure for \'{item.name}\' in {parents}') from e
> if item.is_dir():
> @@ -1536,20 +1569,27 @@ struct pmu_table_entry {
> if item.is_file() and item.name.endswith('.json') and not item.name.endswith('metricgroups.json'):
> tasks.append((item.path, get_topic(item.name)))
>
> - for arch in archs:
> - arch_path = f'{_args.starting_dir}/{arch}'
> - preprocess_arch_std_files(arch_path)
> - ftw(arch_path, [], collect_json)
> -
> - with concurrent.futures.ProcessPoolExecutor(max_workers=_parallel_worker_count(len(tasks)),
> - initializer=_init_worker,
> - initargs=(_arch_std_events,)) as executor:
> - for path, topic, events in executor.map(_parallel_read_json_events, tasks):
> - _json_cache[(path, topic)] = events
> -
> - for arch in archs:
> - arch_path = f'{_args.starting_dir}/{arch}'
> - ftw(arch_path, [], preprocess_one_file)
> + try:
> + for arch in archs:
> + arch_path = f'{_args.starting_dir}/{arch}'
> + preprocess_arch_std_files(arch_path)
> + ftw(arch_path, [], collect_json)
> +
> + with concurrent.futures.ProcessPoolExecutor(max_workers=_parallel_worker_count(len(tasks)),
> + initializer=_init_worker,
> + initargs=(_arch_std_events,)) as executor:
> + for path, topic, events in executor.map(_parallel_read_json_events, tasks):
> + _json_cache[(path, topic)] = events
> +
> + for arch in archs:
> + arch_path = f'{_args.starting_dir}/{arch}'
> + ftw(arch_path, [], preprocess_one_file)
> + except ValueError as exc:
> + # A worker's traceback is three levels of ProcessPoolExecutor noise around
> + # the one line that matters, so say it here and stop. make deletes the
> + # target it failed to build (.DELETE_ON_ERROR), so the next run reads the
> + # JSON again rather than a half-written table.
> + sys.exit(f'jevents.py: {exc}')
>
> assert _bcs is not None
> _bcs.compute()
> diff --git a/tools/perf/tests/shell/jevents_bad_key.sh b/tools/perf/tests/shell/jevents_bad_key.sh
> new file mode 100755
> index 000000000000..7848e60b8b4a
> --- /dev/null
> +++ b/tools/perf/tests/shell/jevents_bad_key.sh
> @@ -0,0 +1,43 @@
> +#!/bin/sh
> +# SPDX-License-Identifier: GPL-2.0
> +# Check jevents.py reports unknown keys as errors (no_mlock)
> +#
> +# A key that is spelled differently is dropped without a word, so jevents.py
> +# compares the keys of each object in a table against the keys it reads and
> +# fails on anything else.
> +
> +jevents=$(dirname "$0")/../../pmu-events/jevents.py
> +python=${PYTHON:-python3}
> +
> +# An installed perf has the test but not the generator, and a python that is
> +# not there or too old to run it is a skip, not a failure of the check.
> +[ -r "${jevents}" ] || exit 2
> +[ "$("${python}" -c 'import sys; print(sys.version_info >= (3, 9))' 2>/dev/null)" = True ] \
> + || exit 2
> +
> +tmp=$(mktemp -d) || exit 2
> +trap 'rm -rf "${tmp}"' EXIT HUP INT TERM
> +tables="${tmp}/arch/x86/model"
> +mkdir -p "${tables}" "${tmp}/arch/common"
> +printf '[]\n' > "${tmp}/arch/common/empty.json"
> +printf 'Family-model,Version,Filename,EventType\nGenuineIntel-6-97,v1.0,model,core\n' \
> + > "${tmp}/arch/x86/mapfile.csv"
> +printf '[{"EventName": "a", "NotAKey": "x"}]\n' > "${tables}/events.json"
> +
> +if "${python}" -B "${jevents}" x86 all "${tmp}/arch" \
> + "${tmp}/pmu-events.c" "${tmp}/pmu-events-string.c" 2> "${tmp}/err"; then
> + echo "jevents.py accepted a key it does not read" >&2
> + exit 1
> +fi
> +grep -qF -- "NotAKey" "${tmp}/err" || {
> + echo "jevents.py failed without naming the key" >&2
> + cat "${tmp}/err" >&2
> + exit 1
> +}
> +grep -qF -- "${tables}/events.json" "${tmp}/err" || {
> + echo "jevents.py failed without naming the file" >&2
> + cat "${tmp}/err" >&2
> + exit 1
> +}
> +
> +exit 0
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH v12 0/2] perf jevents: Fail the build on a key the tables may not carry
2026-11-20 6:09 ` [PATCH v11 0/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
2026-11-20 6:09 ` [PATCH v11 1/2] perf vendor events: Fix misspelled keys in the event tables TAKANO Mitsuhiro
2026-11-20 6:09 ` [PATCH v11 2/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
@ 2026-11-20 13:42 ` TAKANO Mitsuhiro
2026-11-20 13:42 ` [PATCH v12 1/2] perf vendor events: Fix misspelled keys in the event tables TAKANO Mitsuhiro
2026-11-20 13:42 ` [PATCH v12 2/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
2 siblings, 2 replies; 7+ messages in thread
From: TAKANO Mitsuhiro @ 2026-11-20 13:42 UTC (permalink / raw)
To: linux-perf-users, Ingo Molnar, Peter Zijlstra,
Arnaldo Carvalho de Melo, Namhyung Kim
Cc: Ian Rogers, James Clark, John Garry, linux-arm-kernel,
Ilkka Koskinen, linux-kernel, TAKANO Mitsuhiro, Will Deacon,
Mike Leach, Leo Yan, Mark Rutland, Alexander Shishkin, Jiri Olsa,
Adrian Hunter
v12. James asked for the raise and nothing else, so the try/except
plumbing v11 carried is gone: the generator already names the file it was
reading and the exception names the keys it did not expect.
What is left is two hunks in jevents.py: _valid_keys, and the check in
JsonEvent.__init__ that every event and metric table goes through.
(metricgroups.json is a plain dictionary of group names and is not
checked.) The test is jevents_bad_key.sh and checks the failing case only.
1/2 is the prerequisite James asked for: the mainline tree carries 19
objects with a key the tables may not carry, so 2/2 cannot land on an
unfixed tree. It is the two fixes posted on their own, squashed, so the
series stands by itself. The AMD half went into perf-tools-next on
11 November; the arm64 half is acked by Ilkka but not applied. If your
tree has both, 2/2 is all that is left; if it has the AMD half only,
apply 1/2 with -3 (its AMD hunks are already there) and then 2/2.
Measured on 1/2 + 2/2: the generator run over all architectures, over x86
alone and over arm64 alone exits 0. Putting EvendtName into one AMD table
makes the x86 run exit 1, with "Exception processing <path>" on stdout and
a traceback ending in "ValueError: Unknown keys: ['EvendtName']".
Changes since v11:
- the try/except changes and the sys.exit() are dropped (James)
- the message reads "Unknown keys: [...]"; the test comment says the keys
a table may carry, not the keys the generator reads
TAKANO Mitsuhiro (2):
perf vendor events: Fix misspelled keys in the event tables
perf jevents: Fail the build on a key the tables may not carry
.../arch/arm64/ampere/ampereonex/mmu.json | 32 ++++++------
.../pmu-events/arch/x86/amdzen4/cache.json | 2 +-
.../arch/x86/amdzen5/load-store.json | 2 +-
.../arch/x86/amdzen6/load-store.json | 2 +-
tools/perf/pmu-events/jevents.py | 24 +++++++++
tools/perf/tests/shell/jevents_bad_key.sh | 52 +++++++++++++++++++
6 files changed, 95 insertions(+), 19 deletions(-)
create mode 100755 tools/perf/tests/shell/jevents_bad_key.sh
base-commit: 7475ea8b58616b33c04afb976cf0fbaad9dd63fb
--
2.53.0
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH v12 1/2] perf vendor events: Fix misspelled keys in the event tables
2026-11-20 13:42 ` [PATCH v12 0/2] " TAKANO Mitsuhiro
@ 2026-11-20 13:42 ` TAKANO Mitsuhiro
2026-11-20 13:42 ` [PATCH v12 2/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
1 sibling, 0 replies; 7+ messages in thread
From: TAKANO Mitsuhiro @ 2026-11-20 13:42 UTC (permalink / raw)
To: linux-perf-users, Ingo Molnar, Peter Zijlstra,
Arnaldo Carvalho de Melo, Namhyung Kim
Cc: Ian Rogers, James Clark, John Garry, linux-arm-kernel,
Ilkka Koskinen, linux-kernel, TAKANO Mitsuhiro, Will Deacon,
Mike Leach, Leo Yan, Mark Rutland, Alexander Shishkin, Jiri Olsa,
Adrian Hunter
Sixteen objects in arch/arm64/ampere/ampereonex/mmu.json carry
"PublicDescrition" and one object in each of amdzen4/cache.json,
amdzen5/load-store.json and amdzen6/load-store.json carries
"BriefDescript6ion". jevents.py reads only the keys it knows by name, so
these fields have no effect: the text is dropped without a word and never
reaches the generated tables.
For the three AMD events that leaves them with no description at all, and
the text comes back. The AmpereOneX events carry the same text in
BriefDescription and the generator drops a duplicate long description, so
the generated arm64 tables are unchanged.
This is the same change as "perf vendor events arm64 AmpereOneX: Fix
misspelled PublicDescription keys" (Message-ID
<20261113065253.746615-1-takano32@gmail.com>) and "perf vendor events amd:
Fix a misspelled JSON key" (<20261108184600.3810059-1-takano32@gmail.com>),
squashed into one patch so that this series applies on its own.
Written with Hermes Agent, an LLM assistant; the author reviewed it and
ran the generator as described.
Fixes: 16438b652b46 ("perf vendor events arm64 AmpereOneX: Add core PMU events and metrics")
Fixes: 658448281d19 ("perf vendor events amd: Add Zen 4 core events")
Fixes: 45c072f2537a ("perf vendor events amd: Add Zen 5 core events")
Fixes: 2f42fb0661d9 ("perf vendor events amd: Add Zen 6 core events")
Acked-by: Ilkka Koskinen <ilkka@os.amperecomputing.com>
Signed-off-by: TAKANO Mitsuhiro <takano32@gmail.com>
---
.../arch/arm64/ampere/ampereonex/mmu.json | 32 +++++++++----------
.../pmu-events/arch/x86/amdzen4/cache.json | 2 +-
.../arch/x86/amdzen5/load-store.json | 2 +-
.../arch/x86/amdzen6/load-store.json | 2 +-
4 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/tools/perf/pmu-events/arch/arm64/ampere/ampereonex/mmu.json b/tools/perf/pmu-events/arch/arm64/ampere/ampereonex/mmu.json
index 66d83b680651..9457f9be4ecc 100644
--- a/tools/perf/pmu-events/arch/arm64/ampere/ampereonex/mmu.json
+++ b/tools/perf/pmu-events/arch/arm64/ampere/ampereonex/mmu.json
@@ -30,37 +30,37 @@
"BriefDescription": "Data TLB translation cache hit on S2L2 walk cache entry"
},
{
- "PublicDescrition": "Data TLB translation cache hit on S2L1 walk cache entry",
+ "PublicDescription": "Data TLB translation cache hit on S2L1 walk cache entry",
"EventCode": "0xd805",
"EventName": "MMU_D_TRANS_CACHE_HIT_S2L1_WALK",
"BriefDescription": "Data TLB translation cache hit on S2L1 walk cache entry"
},
{
- "PublicDescrition": "Data TLB translation cache hit on S2L0 walk cache entry",
+ "PublicDescription": "Data TLB translation cache hit on S2L0 walk cache entry",
"EventCode": "0xd806",
"EventName": "MMU_D_TRANS_CACHE_HIT_S2L0_WALK",
"BriefDescription": "Data TLB translation cache hit on S2L0 walk cache entry"
},
{
- "PublicDescrition": "Data-side S1 page walk cache lookup",
+ "PublicDescription": "Data-side S1 page walk cache lookup",
"EventCode": "0xd807",
"EventName": "MMU_D_S1_WALK_CACHE_LOOKUP",
"BriefDescription": "Data-side S1 page walk cache lookup"
},
{
- "PublicDescrition": "Data-side S1 page walk cache refill",
+ "PublicDescription": "Data-side S1 page walk cache refill",
"EventCode": "0xd808",
"EventName": "MMU_D_S1_WALK_CACHE_REFILL",
"BriefDescription": "Data-side S1 page walk cache refill"
},
{
- "PublicDescrition": "Data-side S2 page walk cache lookup",
+ "PublicDescription": "Data-side S2 page walk cache lookup",
"EventCode": "0xd809",
"EventName": "MMU_D_S2_WALK_CACHE_LOOKUP",
"BriefDescription": "Data-side S2 page walk cache lookup"
},
{
- "PublicDescrition": "Data-side S2 page walk cache refill",
+ "PublicDescription": "Data-side S2 page walk cache refill",
"EventCode": "0xd80a",
"EventName": "MMU_D_S2_WALK_CACHE_REFILL",
"BriefDescription": "Data-side S2 page walk cache refill"
@@ -90,61 +90,61 @@
"BriefDescription": "Level 2 instruction translation buffer allocation"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S1L2 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S1L2 walk cache entry",
"EventCode": "0xd901",
"EventName": "MMU_I_TRANS_CACHE_HIT_S1L2_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S1L2 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S1L1 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S1L1 walk cache entry",
"EventCode": "0xd902",
"EventName": "MMU_I_TRANS_CACHE_HIT_S1L1_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S1L1 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S1L0 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S1L0 walk cache entry",
"EventCode": "0xd903",
"EventName": "MMU_I_TRANS_CACHE_HIT_S1L0_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S1L0 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S2L2 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S2L2 walk cache entry",
"EventCode": "0xd904",
"EventName": "MMU_I_TRANS_CACHE_HIT_S2L2_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S2L2 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S2L1 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S2L1 walk cache entry",
"EventCode": "0xd905",
"EventName": "MMU_I_TRANS_CACHE_HIT_S2L1_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S2L1 walk cache entry"
},
{
- "PublicDescrition": "Instruction TLB translation cache hit on S2L0 walk cache entry",
+ "PublicDescription": "Instruction TLB translation cache hit on S2L0 walk cache entry",
"EventCode": "0xd906",
"EventName": "MMU_I_TRANS_CACHE_HIT_S2L0_WALK",
"BriefDescription": "Instruction TLB translation cache hit on S2L0 walk cache entry"
},
{
- "PublicDescrition": "Instruction-side S1 page walk cache lookup",
+ "PublicDescription": "Instruction-side S1 page walk cache lookup",
"EventCode": "0xd907",
"EventName": "MMU_I_S1_WALK_CACHE_LOOKUP",
"BriefDescription": "Instruction-side S1 page walk cache lookup"
},
{
- "PublicDescrition": "Instruction-side S1 page walk cache refill",
+ "PublicDescription": "Instruction-side S1 page walk cache refill",
"EventCode": "0xd908",
"EventName": "MMU_I_S1_WALK_CACHE_REFILL",
"BriefDescription": "Instruction-side S1 page walk cache refill"
},
{
- "PublicDescrition": "Instruction-side S2 page walk cache lookup",
+ "PublicDescription": "Instruction-side S2 page walk cache lookup",
"EventCode": "0xd909",
"EventName": "MMU_I_S2_WALK_CACHE_LOOKUP",
"BriefDescription": "Instruction-side S2 page walk cache lookup"
},
{
- "PublicDescrition": "Instruction-side S2 page walk cache refill",
+ "PublicDescription": "Instruction-side S2 page walk cache refill",
"EventCode": "0xd90a",
"EventName": "MMU_I_S2_WALK_CACHE_REFILL",
"BriefDescription": "Instruction-side S2 page walk cache refill"
diff --git a/tools/perf/pmu-events/arch/x86/amdzen4/cache.json b/tools/perf/pmu-events/arch/x86/amdzen4/cache.json
index e6d710cf3ce2..01c848a9dbb3 100644
--- a/tools/perf/pmu-events/arch/x86/amdzen4/cache.json
+++ b/tools/perf/pmu-events/arch/x86/amdzen4/cache.json
@@ -182,7 +182,7 @@
{
"EventName": "ls_inef_sw_pref.all",
"EventCode": "0x52",
- "BriefDescript6ion": "Software prefetches that did not fetch data outside of the processor core for any reason.",
+ "BriefDescription": "Software prefetches that did not fetch data outside of the processor core for any reason.",
"UMask": "0x03"
},
{
diff --git a/tools/perf/pmu-events/arch/x86/amdzen5/load-store.json b/tools/perf/pmu-events/arch/x86/amdzen5/load-store.json
index b1994539ece8..774da0bfa0dd 100644
--- a/tools/perf/pmu-events/arch/x86/amdzen5/load-store.json
+++ b/tools/perf/pmu-events/arch/x86/amdzen5/load-store.json
@@ -351,7 +351,7 @@
{
"EventName": "ls_inef_sw_pref.all",
"EventCode": "0x52",
- "BriefDescript6ion": "Software prefetches that did not fetch data outside of the processor core for any reason.",
+ "BriefDescription": "Software prefetches that did not fetch data outside of the processor core for any reason.",
"UMask": "0x03"
},
{
diff --git a/tools/perf/pmu-events/arch/x86/amdzen6/load-store.json b/tools/perf/pmu-events/arch/x86/amdzen6/load-store.json
index 4291eb59426f..4adba70bffb1 100644
--- a/tools/perf/pmu-events/arch/x86/amdzen6/load-store.json
+++ b/tools/perf/pmu-events/arch/x86/amdzen6/load-store.json
@@ -351,7 +351,7 @@
{
"EventName": "ls_inef_sw_pref.all",
"EventCode": "0x52",
- "BriefDescript6ion": "Software prefetches that did not fetch data outside of the processor core for any reason.",
+ "BriefDescription": "Software prefetches that did not fetch data outside of the processor core for any reason.",
"UMask": "0x03"
},
{
--
2.53.0
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [PATCH v12 2/2] perf jevents: Fail the build on a key the tables may not carry
2026-11-20 13:42 ` [PATCH v12 0/2] " TAKANO Mitsuhiro
2026-11-20 13:42 ` [PATCH v12 1/2] perf vendor events: Fix misspelled keys in the event tables TAKANO Mitsuhiro
@ 2026-11-20 13:42 ` TAKANO Mitsuhiro
1 sibling, 0 replies; 7+ messages in thread
From: TAKANO Mitsuhiro @ 2026-11-20 13:42 UTC (permalink / raw)
To: linux-perf-users, Ingo Molnar, Peter Zijlstra,
Arnaldo Carvalho de Melo, Namhyung Kim
Cc: Ian Rogers, James Clark, John Garry, linux-arm-kernel,
Ilkka Koskinen, linux-kernel, TAKANO Mitsuhiro, Will Deacon,
Mike Leach, Leo Yan, Mark Rutland, Alexander Shishkin, Jiri Olsa,
Adrian Hunter
jevents.py takes the fields it wants out of each JSON object by name and
ignores the rest, so a key that is spelled differently is dropped without
a word and the object is built without whatever that field held.
Compare the keys of each object with _valid_keys, the keys a table may
carry, and fail on anything else. The generator already names the file it
was reading and the exception names the keys it did not expect, so the
build stops with a message that says where to look.
Written with Hermes Agent, an LLM assistant; the author reviewed it and
ran the generator on every arch directory, with and without a key the
tables may not carry.
Signed-off-by: TAKANO Mitsuhiro <takano32@gmail.com>
---
tools/perf/pmu-events/jevents.py | 24 +++++++++++
tools/perf/tests/shell/jevents_bad_key.sh | 52 +++++++++++++++++++++++
2 files changed, 76 insertions(+)
create mode 100755 tools/perf/tests/shell/jevents_bad_key.sh
diff --git a/tools/perf/pmu-events/jevents.py b/tools/perf/pmu-events/jevents.py
index 080e04b51b8c..1baeae76349f 100755
--- a/tools/perf/pmu-events/jevents.py
+++ b/tools/perf/pmu-events/jevents.py
@@ -63,6 +63,27 @@ _json_metric_attributes = [
# Attributes that are bools or enum int values, encoded as '0', '1',...
_json_enum_attributes = ['aggr_mode', 'deprecated', 'event_grouping', 'perpkg',
'default_show_events']
+# Keys a table under arch/ may carry. jevents.py takes the fields it wants by
+# name and drops the rest without a word, so a key that is spelled differently
+# is only visible as a field that went missing; a table carrying anything else
+# is an error. The list holds the keys jevents.py reads, plus the ones the
+# tables carry and it does not read: Counter, CountersNumFixed and
+# CountersNumGeneric (read by nothing) and Experimental (read by metric.py).
+_valid_keys: Set[str] = {
+ 'AggregationMode', 'AnyThread', 'ArchStdEvent', 'BriefDescription',
+ 'Compat', 'ConfigCode', 'Counter', 'CounterMask',
+ 'CountersNumFixed', 'CountersNumGeneric', 'Data_LA', 'DefaultMetricgroupName',
+ 'DefaultShowEvents', 'Deprecated', 'EdgeDetect', 'EnAllCores',
+ 'EnAllSlices', 'Errata', 'EventCode', 'EventidCode',
+ 'EventName', 'Experimental', 'ExtSel', 'FCMask',
+ 'Filter', 'Invert', 'LegacyCacheCode', 'LegacyConfigCode',
+ 'MetricConstraint', 'MetricExpr', 'MetricGroup', 'MetricgroupNoGroup',
+ 'MetricName', 'MetricThreshold', 'MSRIndex', 'MSRValue',
+ 'NodeType', 'PEBS', 'PerPkg', 'PortMask',
+ 'PublicDescription', 'RdWrMask', 'RetirementLatencyMax', 'RetirementLatencyMean',
+ 'RetirementLatencyMin', 'SampleAfterValue', 'ScaleUnit', 'SliceId',
+ 'ThreadMask', 'UMask', 'Unit',
+}
def file_name_to_table_name(prefix: str, parents: Sequence[str],
dirname: str) -> str:
@@ -196,6 +217,9 @@ class JsonEvent:
def __init__(self, jd: dict):
"""Constructor passed the dictionary of parsed json values."""
+ if extra := set(jd) - _valid_keys:
+ raise ValueError(f'Unknown keys: {sorted(extra)}')
+
def llx(x: int) -> str:
"""Convert an int to a string similar to a printf modifier of %#llx."""
return str(x) if x >= 0 and x < 10 else hex(x)
diff --git a/tools/perf/tests/shell/jevents_bad_key.sh b/tools/perf/tests/shell/jevents_bad_key.sh
new file mode 100755
index 000000000000..6084205b5f4d
--- /dev/null
+++ b/tools/perf/tests/shell/jevents_bad_key.sh
@@ -0,0 +1,52 @@
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0
+# Check jevents.py reports unknown keys as errors (no_mlock)
+#
+# A key that is spelled differently is dropped without a word, so jevents.py
+# compares the keys of each object in a table against the keys a table may
+# carry and fails on anything else.
+
+jevents=$(dirname "$0")/../../pmu-events/jevents.py
+python=${PYTHON:-python3}
+
+# An installed perf has the test but not the generator, and a python that is
+# not there or too old to run it is a skip, not a failure of the check.
+[ -r "${jevents}" ] || exit 2
+[ "$("${python}" -c 'import sys; print(sys.version_info >= (3, 9))' 2>/dev/null)" = True ] \
+ || exit 2
+
+tmp=$(mktemp -d) || exit 2
+trap 'rm -rf "${tmp}"' EXIT HUP INT TERM
+tables="${tmp}/arch/x86/model"
+mkdir -p "${tables}" "${tmp}/arch/common"
+printf '[]\n' > "${tmp}/arch/common/empty.json"
+printf 'Family-model,Version,Filename,EventType\nGenuineIntel-6-97,v1.0,model,core\n' \
+ > "${tmp}/arch/x86/mapfile.csv"
+printf '[{"EventName": "a", "NotAKey": "x"}]\n' > "${tables}/events.json"
+
+if "${python}" -B "${jevents}" x86 all "${tmp}/arch" \
+ "${tmp}/pmu-events.c" "${tmp}/pmu-events-string.c" \
+ > "${tmp}/out" 2> "${tmp}/err"; then
+ echo "jevents.py accepted a key it does not read" >&2
+ exit 1
+fi
+
+# The generator says which file it was reading, and the exception says which
+# key it did not expect.
+grep -qF -- "Exception processing" "${tmp}/out" || {
+ echo "jevents.py failed without naming the file" >&2
+ cat "${tmp}/out" "${tmp}/err" >&2
+ exit 1
+}
+grep -qF -- "${tables}/events.json" "${tmp}/out" || {
+ echo "jevents.py failed without naming the path" >&2
+ cat "${tmp}/out" "${tmp}/err" >&2
+ exit 1
+}
+grep -qF -- "NotAKey" "${tmp}/err" || {
+ echo "jevents.py failed without naming the key" >&2
+ cat "${tmp}/out" "${tmp}/err" >&2
+ exit 1
+}
+
+exit 0
--
2.53.0
^ permalink raw reply related [flat|nested] 7+ messages in thread
end of thread, other threads:[~2026-11-20 13:43 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <20261113032927.634183-1-takano32@gmail.com>
2026-11-20 6:09 ` [PATCH v11 0/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
2026-11-20 6:09 ` [PATCH v11 1/2] perf vendor events: Fix misspelled keys in the event tables TAKANO Mitsuhiro
2026-11-20 6:09 ` [PATCH v11 2/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
2026-11-20 10:06 ` James Clark
2026-11-20 13:42 ` [PATCH v12 0/2] " TAKANO Mitsuhiro
2026-11-20 13:42 ` [PATCH v12 1/2] perf vendor events: Fix misspelled keys in the event tables TAKANO Mitsuhiro
2026-11-20 13:42 ` [PATCH v12 2/2] perf jevents: Fail the build on a key the tables may not carry TAKANO Mitsuhiro
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox