[PATCH v12 2/2] perf jevents: Fail the build on a key the tables may not carry
From: TAKANO Mitsuhiro
Date: Fri Nov 20 2026 - 08:43:40 EST
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@xxxxxxxxx>
---
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