Skip to contentSkip to conversation

perf jevents: Autogenerate empty-pmu-events.c

PATCH In review Ian Rogers 2 participants 3 messages May 20, 2024 – May 21, 2024 perf events

lore
Share & tools
lore

Ian Rogers

author reviewer
#0 lore raw

PATCH 1/1 perf jevents: Autogenerate empty-pmu-events.c

empty-pmu-events.c exists so that builds may occur without python being installed on a system. Manually updating empty-pmu-events.c to be in sync with jevents.py is a pain, let's use jevents.py to generate empty-pmu-events.c.

1) change jevents.py so that an arch and model of none cause generation of a pmu-events.c without any json. Add a SPDX and autogenerated warning to the start of the file.

2) change Build so that if a generated pmu-events.c for arch none and model none doesn't match empty-pmu-events.c the build fails with a cat of the differences. Update Makefile.perf to clean up the files used for this.

3) update empty-pmu-events.c to match the output of jevents.py with arch and mode of none.

---
 tools/perf/Makefile.perf                 |   2 +
 tools/perf/pmu-events/Build              |  12 +-
 tools/perf/pmu-events/empty-pmu-events.c | 892 ++++++++++++++---------
 tools/perf/pmu-events/jevents.py         |   6 +-
 4 files changed, 561 insertions(+), 351 deletions(-)
tools/perf/Makefile.perf +2 -0
index 5c35c0d89306..4369c57a1d12 100644
@@ -1210,6 +1210,8 @@ clean:: $(LIBAPI)-clean $(LIBBPF)-clean $(LIBSUBCMD)-clean $(LIBSYMBOL)-clean $(
 		$(OUTPUT)util/intel-pt-decoder/inat-tables.c \
 		$(OUTPUT)tests/llvm-src-{base,kbuild,prologue,relocation}.c \
 		$(OUTPUT)pmu-events/pmu-events.c \
+		$(OUTPUT)pmu-events/test-empty-pmu-events.c \
+		$(OUTPUT)pmu-events/empty-pmu-events.log \
 		$(OUTPUT)pmu-events/metric_test.log \
 		$(OUTPUT)$(fadvise_advice_array) \
 		$(OUTPUT)$(fsconfig_arrays) \
tools/perf/pmu-events/Build +11 -1
index 1d18bb89402e..c3fa43c49706 100644
@@ -11,6 +11,8 @@ METRIC_TEST_PY	=  pmu-events/metric_test.py
 EMPTY_PMU_EVENTS_C = pmu-events/empty-pmu-events.c
 PMU_EVENTS_C	=  $(OUTPUT)pmu-events/pmu-events.c
 METRIC_TEST_LOG	=  $(OUTPUT)pmu-events/metric_test.log
+TEST_EMPTY_PMU_EVENTS_C = $(OUTPUT)pmu-events/test-empty-pmu-events.c
+EMPTY_PMU_EVENTS_TEST_LOG = $(OUTPUT)pmu-events/empty-pmu-events.log
 
 ifeq ($(JEVENTS_ARCH),)
 JEVENTS_ARCH=$(SRCARCH)
@@ -31,7 +33,15 @@ $(METRIC_TEST_LOG): $(METRIC_TEST_PY) $(METRIC_PY)
 	$(call rule_mkdir)
 	$(Q)$(call echo-cmd,test)$(PYTHON) $< 2> $@ || (cat $@ && false)
 
-$(PMU_EVENTS_C): $(JSON) $(JSON_TEST) $(JEVENTS_PY) $(METRIC_PY) $(METRIC_TEST_LOG)
+$(TEST_EMPTY_PMU_EVENTS_C): $(JSON) $(JSON_TEST) $(JEVENTS_PY) $(METRIC_PY) $(METRIC_TEST_LOG)
+	$(call rule_mkdir)
+	$(Q)$(call echo-cmd,gen)$(PYTHON) $(JEVENTS_PY) none none pmu-events/arch $@
+
+$(EMPTY_PMU_EVENTS_TEST_LOG): $(EMPTY_PMU_EVENTS_C) $(TEST_EMPTY_PMU_EVENTS_C)
+	$(call rule_mkdir)
+	$(Q)$(call echo-cmd,test)diff -u $? 2> $@ || (cat $@ && false)
+
+$(PMU_EVENTS_C): $(JSON) $(JSON_TEST) $(JEVENTS_PY) $(METRIC_PY) $(METRIC_TEST_LOG) $(EMPTY_PMU_EVENTS_TEST_LOG)
 	$(call rule_mkdir)
 	$(Q)$(call echo-cmd,gen)$(PYTHON) $(JEVENTS_PY) $(JEVENTS_ARCH) $(JEVENTS_MODEL) pmu-events/arch $@
 endif
tools/perf/pmu-events/empty-pmu-events.c +543 -349

1,004 lines not on this page · raw message

tools/perf/pmu-events/jevents.py +5 -1
index e42efc16723e..8f733b061d5d 100755
@@ -1255,6 +1255,10 @@ such as "arm/cortex-a34".''',
       'output_file', type=argparse.FileType('w', encoding='utf-8'), nargs='?', default=sys.stdout)
   _args = ap.parse_args()
 
+  _args.output_file.write(f"""
+/* SPDX-License-Identifier: GPL-2.0 */
+/* THIS FILE WAS AUTOGENERATED BY jevents.py arch={_args.arch} model={_args.model} ! */
+""")
   _args.output_file.write("""
 #include <pmu-events/pmu-events.h>
 #include "util/header.h"
@@ -1280,7 +1284,7 @@ struct pmu_table_entry {
     if item.name == _args.arch or _args.arch == 'all' or item.name == 'test':
       archs.append(item.name)
 
-  if len(archs) < 2:
+  if len(archs) < 2 and _args.arch != 'none':
     raise IOError(f'Missing architecture directory \'{_args.arch}\'')
 
   archs.sort()
Signature · 1 line
2.45.0.rc1.225.g2a3ae87e7f-goog
#1 lore raw

tools/perf/pmu-events/empty-pmu-events.c int pmu_events_table__find_event(const struct pmu_events_table *table, · line 407

Quoted 6 lines · Ian Rogers
	}
tools/perf/pmu-events/empty-pmu-events.c +4 -0
+                ret = pmu_events_table__find_event_pmu(table, table_pmu, name, fn, data);
+                if (ret != -1000)
+                        return ret;
+        }
          return -1000;

what's -1000 meaning? It would be nice to use some standard error codes.

Thanks,
John

author reviewer
#2 lore raw
Quoted 10 lines · John Garry

tools/perf/pmu-events/empty-pmu-events.c int pmu_events_table__find_event(const struct pmu_events_table *table, · line 407

Quoted 6 lines · Ian Rogers
      }
tools/perf/pmu-events/empty-pmu-events.c +4 -0
+                ret = pmu_events_table__find_event_pmu(table, table_pmu, name, fn, data);
+                if (ret != -1000)
+                        return ret;
+        }
          return -1000;

what's -1000 meaning? It would be nice to use some standard error codes.

This is a pre-existing thing. 0 means continue and anything else generally aborts a search, -1000 is used when searching multiple tables to indicate not found in 1 table but potentially not all.

Commit 3d5045492ab2 ("perf pmu-events: Add pmu_events_table__find_event()") added this [1], you were on the cc list ;-) I think moving to a named constant would make this more intention revealing so I'll add this to a v2 set.

Thanks,
Ian

[1] https://lore.kernel.org/r/[email protected]

Quoted 4 lines

Thanks,
John