perf pmus: Fake PMU clean up
authorIan Rogers <irogers@google.com>
Sat, 7 Sep 2024 05:08:17 +0000 (22:08 -0700)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Wed, 11 Sep 2024 14:27:42 +0000 (11:27 -0300)
Rather than passing a fake PMU around, just pass that the fake PMU
should be used - true when doing testing. Move the fake PMU into
pmus.[ch] and try to abstract the PMU's properties in pmu.c, ie so
there is less "if fake_pmu" in non-PMU code. Give the fake PMU a made
up type number.

Signed-off-by: Ian Rogers <irogers@google.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Andi Kleen <ak@linux.intel.com>
Cc: Athira Rajeev <atrajeev@linux.vnet.ibm.com>
Cc: Benjamin Gray <bgray@linux.ibm.com>
Cc: Changbin Du <changbin.du@huawei.com>
Cc: Clément Le Goffic <clement.legoffic@foss.st.com>
Cc: Colin Ian King <colin.i.king@gmail.com>
Cc: Dominique Martinet <asmadeus@codewreck.org>
Cc: Dr. David Alan Gilbert <linux@treblig.org>
Cc: Howard Chu <howardchu95@gmail.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: James Clark <james.clark@linaro.org>
Cc: Jing Zhang <renyu.zj@linux.alibaba.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: John Garry <john.g.garry@oracle.com>
Cc: Junhao He <hejunhao3@huawei.com>
Cc: Kan Liang <kan.liang@linux.intel.com>
Cc: Leo Yan <leo.yan@linux.dev>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Mike Leach <mike.leach@linaro.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Ravi Bangoria <ravi.bangoria@amd.com>
Cc: Sandipan Das <sandipan.das@amd.com>
Cc: Sun Haiyong <sunhaiyong@loongson.cn>
Cc: Tiezhu Yang <yangtiezhu@loongson.cn>
Cc: Veronika Molnarova <vmolnaro@redhat.com>
Cc: Weilin Wang <weilin.wang@intel.com>
Cc: Will Deacon <will@kernel.org>
Cc: Xu Yang <xu.yang_2@nxp.com>
Cc: Yang Jihong <yangjihong@bytedance.com>
Cc: Yicong Yang <yangyicong@hisilicon.com>
Cc: Ze Gao <zegao2021@gmail.com>
Cc: linux-arm-kernel@lists.infradead.org
Link: https://lore.kernel.org/r/20240907050830.6752-3-irogers@google.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
tools/perf/tests/parse-events.c
tools/perf/tests/pmu-events.c
tools/perf/util/metricgroup.c
tools/perf/util/parse-events.c
tools/perf/util/parse-events.h
tools/perf/util/pmu.c
tools/perf/util/pmu.h
tools/perf/util/pmus.c
tools/perf/util/pmus.h

index e228511c85a5de8526dcd5d21c334f0e63d47ef7..9e3086d021508913d24abe98bbc94d7a7a54549e 100644 (file)
@@ -2500,7 +2500,7 @@ static int test_event(const struct evlist_test *e)
                return TEST_FAIL;
        }
        parse_events_error__init(&err);
-       ret = __parse_events(evlist, e->name, /*pmu_filter=*/NULL, &err, /*fake_pmu=*/NULL,
+       ret = __parse_events(evlist, e->name, /*pmu_filter=*/NULL, &err, /*fake_pmu=*/false,
                             /*warn_if_reordered=*/true, /*fake_tp=*/true);
        if (ret) {
                pr_debug("failed to parse event '%s', err %d\n", e->name, ret);
@@ -2529,7 +2529,7 @@ static int test_event_fake_pmu(const char *str)
 
        parse_events_error__init(&err);
        ret = __parse_events(evlist, str, /*pmu_filter=*/NULL, &err,
-                            &perf_pmu__fake, /*warn_if_reordered=*/true,
+                            /*fake_pmu=*/true, /*warn_if_reordered=*/true,
                             /*fake_tp=*/true);
        if (ret) {
                pr_debug("failed to parse event '%s', err %d\n",
index ff3e7bc0a77f73e7849ad3e555f17368c1678c2e..db004d26fcb005f3d91080b769d6b31df159f759 100644 (file)
@@ -819,8 +819,7 @@ static bool is_number(const char *str)
        return errno == 0 && end_ptr != str;
 }
 
-static int check_parse_id(const char *id, struct parse_events_error *error,
-                         struct perf_pmu *fake_pmu)
+static int check_parse_id(const char *id, struct parse_events_error *error)
 {
        struct evlist *evlist;
        int ret;
@@ -841,7 +840,7 @@ static int check_parse_id(const char *id, struct parse_events_error *error,
        for (cur = strchr(dup, '@') ; cur; cur = strchr(++cur, '@'))
                *cur = '/';
 
-       ret = __parse_events(evlist, dup, /*pmu_filter=*/NULL, error, fake_pmu,
+       ret = __parse_events(evlist, dup, /*pmu_filter=*/NULL, error, /*fake_pmu=*/true,
                             /*warn_if_reordered=*/true, /*fake_tp=*/false);
        free(dup);
 
@@ -855,7 +854,7 @@ static int check_parse_fake(const char *id)
        int ret;
 
        parse_events_error__init(&error);
-       ret = check_parse_id(id, &error, &perf_pmu__fake);
+       ret = check_parse_id(id, &error);
        parse_events_error__exit(&error);
        return ret;
 }
@@ -1051,9 +1050,8 @@ static int test__parsing_fake_callback(const struct pmu_metric *pm,
 }
 
 /*
- * Parse all the metrics for current architecture,
- * or all defined cpus via the 'fake_pmu'
- * in parse_events.
+ * Parse all the metrics for current architecture, or all defined cpus via the
+ * 'fake_pmu' in parse_events.
  */
 static int test__parsing_fake(struct test_suite *test __maybe_unused,
                              int subtest __maybe_unused)
index 69f6a46402c3d6ef0eaebdb6dd6eb47b52c4a4a1..4dff3e925a47b38d55d20136df412550e198f914 100644 (file)
@@ -1436,7 +1436,7 @@ err_out:
  * parse_ids - Build the event string for the ids and parse them creating an
  *             evlist. The encoded metric_ids are decoded.
  * @metric_no_merge: is metric sharing explicitly disabled.
- * @fake_pmu: used when testing metrics not supported by the current CPU.
+ * @fake_pmu: use a fake PMU when testing metrics not supported by the current CPU.
  * @ids: the event identifiers parsed from a metric.
  * @modifier: any modifiers added to the events.
  * @group_events: should events be placed in a weak group.
@@ -1444,7 +1444,7 @@ err_out:
  *               the overall list of metrics.
  * @out_evlist: the created list of events.
  */
-static int parse_ids(bool metric_no_merge, struct perf_pmu *fake_pmu,
+static int parse_ids(bool metric_no_merge, bool fake_pmu,
                     struct expr_parse_ctx *ids, const char *modifier,
                     bool group_events, const bool tool_events[PERF_TOOL_MAX],
                     struct evlist **out_evlist)
@@ -1528,7 +1528,7 @@ static int parse_groups(struct evlist *perf_evlist,
                        bool metric_no_threshold,
                        const char *user_requested_cpu_list,
                        bool system_wide,
-                       struct perf_pmu *fake_pmu,
+                       bool fake_pmu,
                        struct rblist *metric_events_list,
                        const struct pmu_metrics_table *table)
 {
@@ -1703,7 +1703,7 @@ int metricgroup__parse_groups(struct evlist *perf_evlist,
 
        return parse_groups(perf_evlist, pmu, str, metric_no_group, metric_no_merge,
                            metric_no_threshold, user_requested_cpu_list, system_wide,
-                           /*fake_pmu=*/NULL, metric_events, table);
+                           /*fake_pmu=*/false, metric_events, table);
 }
 
 int metricgroup__parse_groups_test(struct evlist *evlist,
@@ -1717,7 +1717,7 @@ int metricgroup__parse_groups_test(struct evlist *evlist,
                            /*metric_no_threshold=*/false,
                            /*user_requested_cpu_list=*/NULL,
                            /*system_wide=*/false,
-                           &perf_pmu__fake, metric_events, table);
+                           /*fake_pmu=*/true, metric_events, table);
 }
 
 struct metricgroup__has_metric_data {
index f5eb1af8302c7bacca4b10033e6f9fda8849783f..9a8be1e46d674ec781487715e4823cc72f379238 100644 (file)
@@ -1500,8 +1500,8 @@ static int parse_events_add_pmu(struct parse_events_state *parse_state,
        }
 
        /* Look for event names in the terms and rewrite into format based terms. */
-       if (!parse_state->fake_pmu && perf_pmu__check_alias(pmu, &parsed_terms,
-                                                           &info, &alias_rewrote_terms, err)) {
+       if (perf_pmu__check_alias(pmu, &parsed_terms,
+                                 &info, &alias_rewrote_terms, err)) {
                parse_events_terms__exit(&parsed_terms);
                return -EINVAL;
        }
@@ -1537,8 +1537,7 @@ static int parse_events_add_pmu(struct parse_events_state *parse_state,
                return -ENOMEM;
        }
 
-       if (!parse_state->fake_pmu &&
-           perf_pmu__config(pmu, &attr, &parsed_terms, parse_state->error)) {
+       if (perf_pmu__config(pmu, &attr, &parsed_terms, parse_state->error)) {
                free_config_terms(&config_terms);
                parse_events_terms__exit(&parsed_terms);
                return -EINVAL;
@@ -1558,11 +1557,6 @@ static int parse_events_add_pmu(struct parse_events_state *parse_state,
 
        evsel->percore = config_term_percore(&evsel->config_terms);
 
-       if (parse_state->fake_pmu) {
-               parse_events_terms__exit(&parsed_terms);
-               return 0;
-       }
-
        parse_events_terms__exit(&parsed_terms);
        free((char *)evsel->unit);
        evsel->unit = strdup(info.unit);
@@ -1638,13 +1632,13 @@ int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
        }
 
        if (parse_state->fake_pmu) {
-               if (!parse_events_add_pmu(parse_state, list, parse_state->fake_pmu, &parsed_terms,
+               if (!parse_events_add_pmu(parse_state, list, perf_pmus__fake_pmu(), &parsed_terms,
                                          /*auto_merge_stats=*/true)) {
                        struct strbuf sb;
 
                        strbuf_init(&sb, /*hint=*/ 0);
                        parse_events_terms__to_strbuf(&parsed_terms, &sb);
-                       pr_debug("%s -> %s/%s/\n", event_name, "fake_pmu", sb.buf);
+                       pr_debug("%s -> fake/%s/\n", event_name, sb.buf);
                        strbuf_release(&sb);
                        ok++;
                }
@@ -1678,11 +1672,18 @@ int parse_events_multi_pmu_add_or_add_pmu(struct parse_events_state *parse_state
        INIT_LIST_HEAD(*listp);
 
        /* Attempt to add to list assuming event_or_pmu is a PMU name. */
-       pmu = parse_state->fake_pmu ?: perf_pmus__find(event_or_pmu);
+       pmu = perf_pmus__find(event_or_pmu);
        if (pmu && !parse_events_add_pmu(parse_state, *listp, pmu, const_parsed_terms,
                                        /*auto_merge_stats=*/false))
                return 0;
 
+       if (parse_state->fake_pmu) {
+               if (!parse_events_add_pmu(parse_state, *listp, perf_pmus__fake_pmu(),
+                                         const_parsed_terms,
+                                         /*auto_merge_stats=*/false))
+                       return 0;
+       }
+
        pmu = NULL;
        /* Failed to add, try wildcard expansion of event_or_pmu as a PMU name. */
        while ((pmu = perf_pmus__scan(pmu)) != NULL) {
@@ -1983,8 +1984,8 @@ static int evsel__compute_group_pmu_name(struct evsel *evsel,
                        }
                }
        }
-       /* Assign the actual name taking care that the fake PMU lacks a name. */
-       evsel->group_pmu_name = strdup(group_pmu_name ?: "fake");
+       /* Record computed name. */
+       evsel->group_pmu_name = strdup(group_pmu_name);
        return evsel->group_pmu_name ? 0 : -ENOMEM;
 }
 
@@ -2146,7 +2147,7 @@ static int parse_events__sort_events_and_fix_groups(struct list_head *list)
 }
 
 int __parse_events(struct evlist *evlist, const char *str, const char *pmu_filter,
-                  struct parse_events_error *err, struct perf_pmu *fake_pmu,
+                  struct parse_events_error *err, bool fake_pmu,
                   bool warn_if_reordered, bool fake_tp)
 {
        struct parse_events_state parse_state = {
@@ -2365,7 +2366,7 @@ int parse_events_option(const struct option *opt, const char *str,
 
        parse_events_error__init(&err);
        ret = __parse_events(*args->evlistp, str, args->pmu_filter, &err,
-                            /*fake_pmu=*/NULL, /*warn_if_reordered=*/true,
+                            /*fake_pmu=*/false, /*warn_if_reordered=*/true,
                             /*fake_tp=*/false);
 
        if (ret) {
index 68bfea9ffa7069bd3e2d13731b5e45a59f13bc81..10cc9c433116d673f99ad3e153fca24cb9fb659e 100644 (file)
@@ -31,14 +31,14 @@ int parse_events_option(const struct option *opt, const char *str, int unset);
 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset);
 __attribute__((nonnull(1, 2, 4)))
 int __parse_events(struct evlist *evlist, const char *str, const char *pmu_filter,
-                  struct parse_events_error *error, struct perf_pmu *fake_pmu,
+                  struct parse_events_error *error, bool fake_pmu,
                   bool warn_if_reordered, bool fake_tp);
 
 __attribute__((nonnull(1, 2, 3)))
 static inline int parse_events(struct evlist *evlist, const char *str,
                               struct parse_events_error *err)
 {
-       return __parse_events(evlist, str, /*pmu_filter=*/NULL, err, /*fake_pmu=*/NULL,
+       return __parse_events(evlist, str, /*pmu_filter=*/NULL, err, /*fake_pmu=*/false,
                              /*warn_if_reordered=*/true, /*fake_tp=*/false);
 }
 
@@ -150,8 +150,8 @@ struct parse_events_state {
        struct parse_events_terms *terms;
        /* Start token. */
        int                        stoken;
-       /* Special fake PMU marker for testing. */
-       struct perf_pmu           *fake_pmu;
+       /* Use the fake PMU marker for testing. */
+       bool                       fake_pmu;
        /* Skip actual tracepoint processing for testing. */
        bool                       fake_tp;
        /* If non-null, when wildcard matching only match the given PMU. */
index ef8ab918eaeb973cd06f2e053fdafcdbeb232847..2d85c4482f5ee7210c6d692b63896bcb003ab86f 100644 (file)
 #include "util/evsel_config.h"
 #include <regex.h>
 
-struct perf_pmu perf_pmu__fake = {
-       .name = "fake",
-};
-
 #define UNIT_MAX_LEN   31 /* max length for event unit name */
 
 enum event_source {
@@ -1172,6 +1168,11 @@ struct perf_pmu *perf_pmu__create_placeholder_core_pmu(struct list_head *core_pm
        return pmu;
 }
 
+static bool perf_pmu__is_fake(const struct perf_pmu *pmu)
+{
+       return pmu->type == PERF_PMU_TYPE_FAKE;
+}
+
 void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu)
 {
        struct perf_pmu_format *format;
@@ -1182,7 +1183,7 @@ void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu)
        pmu->formats_checked = true;
 
        /* fake pmu doesn't have format list */
-       if (pmu == &perf_pmu__fake)
+       if (perf_pmu__is_fake(pmu))
                return;
 
        list_for_each_entry(format, &pmu->format, list) {
@@ -1510,6 +1511,10 @@ int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
 {
        bool zero = !!pmu->perf_event_attr_init_default;
 
+       /* Fake PMU doesn't have proper terms so nothing to configure in attr. */
+       if (perf_pmu__is_fake(pmu))
+               return 0;
+
        return perf_pmu__config_terms(pmu, attr, head_terms, zero, err);
 }
 
@@ -1618,6 +1623,10 @@ int perf_pmu__check_alias(struct perf_pmu *pmu, struct parse_events_terms *head_
        info->scale    = 0.0;
        info->snapshot = false;
 
+       /* Fake PMU doesn't rewrite terms. */
+       if (perf_pmu__is_fake(pmu))
+               goto out;
+
        list_for_each_entry_safe(term, h, &head_terms->terms, list) {
                alias = pmu_find_alias(pmu, term);
                if (!alias)
@@ -1640,7 +1649,7 @@ int perf_pmu__check_alias(struct perf_pmu *pmu, struct parse_events_terms *head_
                list_del_init(&term->list);
                parse_events_term__delete(term);
        }
-
+out:
        /*
         * if no unit or scale found in aliases, then
         * set defaults as for evsel
index b2d3fd291f0297f6e7c0c9b91132d4aaa331fc5e..d6f702e55a05dee6848c2e1903955621713f288b 100644 (file)
@@ -36,6 +36,10 @@ struct perf_pmu_caps {
        struct list_head list;
 };
 
+enum {
+       PERF_PMU_TYPE_FAKE = 0xFFFFFFFF,
+};
+
 /**
  * struct perf_pmu
  */
@@ -173,9 +177,6 @@ struct perf_pmu {
        struct perf_mem_event *mem_events;
 };
 
-/** @perf_pmu__fake: A special global PMU used for testing. */
-extern struct perf_pmu perf_pmu__fake;
-
 struct perf_pmu_info {
        const char *unit;
        double scale;
index 769b920d9250d3221c4b0c21df9ddf1026487b0d..7e201e42281224f435fd8042668d9608dd453e72 100644 (file)
@@ -720,3 +720,14 @@ struct perf_pmu *perf_pmus__add_test_pmu(int test_sysfs_dirfd, const char *name)
         */
        return perf_pmu__lookup(&other_pmus, test_sysfs_dirfd, name, /*eager_load=*/true);
 }
+
+struct perf_pmu *perf_pmus__fake_pmu(void)
+{
+       static struct perf_pmu fake = {
+               .name = "fake",
+               .type = PERF_PMU_TYPE_FAKE,
+               .format = LIST_HEAD_INIT(fake.format),
+       };
+
+       return &fake;
+}
index bdbff02324bbeb25bbe3a9bb50fdc6bafed99c13..e1742b56eec77423f037858f3286e57e4ec8b0a8 100644 (file)
@@ -30,5 +30,6 @@ bool perf_pmus__supports_extended_type(void);
 char *perf_pmus__default_pmu_name(void);
 
 struct perf_pmu *perf_pmus__add_test_pmu(int test_sysfs_dirfd, const char *name);
+struct perf_pmu *perf_pmus__fake_pmu(void);
 
 #endif /* __PMUS_H */