[PATCH 3/3] perf stat: Add --metrics-file option
From: Jiri Olsa
Date: Tue Apr 21 2020 - 14:14:09 EST
Adding --metrics-file option that allows to specify metrics
in the file.
It's now possible to define metrics in file and use them like:
$ cat metrics
# IPC
mine1 = instructions / cycles;
/* DECODED_ICACHE_UOPS% */
mine2 = 100 * (idq.dsb_uops / \ (idq.ms_uops + idq.mite_uops + idq.dsb_uops + lsd.uops));
$ sudo perf stat --metrics-file ./metrics -M mine1,mine2 --metric-only -a -I 1000
# time insn per cycle mine1 mine2
1.000536263 0.71 0.7 41.4
2.002069025 0.31 0.3 14.1
3.003427684 0.27 0.3 14.8
4.004807132 0.25 0.2 12.1
...
Signed-off-by: Jiri Olsa <jolsa@xxxxxxxxxx>
---
tools/perf/Documentation/perf-stat.txt | 3 ++
tools/perf/builtin-stat.c | 7 ++-
tools/perf/util/metricgroup.c | 66 +++++++++++++++++++++++---
tools/perf/util/metricgroup.h | 3 +-
tools/perf/util/stat.h | 1 +
5 files changed, 70 insertions(+), 10 deletions(-)
diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
index 4d56586b2fb9..263b0d2bb835 100644
--- a/tools/perf/Documentation/perf-stat.txt
+++ b/tools/perf/Documentation/perf-stat.txt
@@ -264,6 +264,9 @@ For a group all metrics from the group are added.
The events from the metrics are automatically measured.
See perf list output for the possble metrics and metricgroups.
+--metrics-file file::
+Read metrics definitions from file in addition to compiled in metrics.
+
-A::
--no-aggr::
Do not aggregate counts across all monitored CPUs.
diff --git a/tools/perf/builtin-stat.c b/tools/perf/builtin-stat.c
index 9207b6c45475..81c2b2f8ec53 100644
--- a/tools/perf/builtin-stat.c
+++ b/tools/perf/builtin-stat.c
@@ -841,7 +841,8 @@ static int parse_metric_groups(const struct option *opt,
const char *str,
int unset __maybe_unused)
{
- return metricgroup__parse_groups(opt, str, &stat_config.metric_events);
+ return metricgroup__parse_groups(opt, str, &stat_config.metric_events,
+ stat_config.metrics_file);
}
static struct option stat_options[] = {
@@ -926,6 +927,8 @@ static struct option stat_options[] = {
OPT_CALLBACK('M', "metrics", &evsel_list, "metric/metric group list",
"monitor specified metrics or metric groups (separated by ,)",
parse_metric_groups),
+ OPT_STRING(0, "metrics-file", &stat_config.metrics_file, "file path",
+ "file with metrics definitions"),
OPT_BOOLEAN_FLAG(0, "all-kernel", &stat_config.all_kernel,
"Configure all used events to run in kernel space.",
PARSE_OPT_EXCLUSIVE),
@@ -1443,7 +1446,7 @@ static int add_default_attributes(void)
struct option opt = { .value = &evsel_list };
return metricgroup__parse_groups(&opt, "transaction",
- &stat_config.metric_events);
+ &stat_config.metric_events, NULL);
}
if (pmu_have_event("cpu", "cycles-ct") &&
diff --git a/tools/perf/util/metricgroup.c b/tools/perf/util/metricgroup.c
index 7ad81c8177ea..99e0ef725a6f 100644
--- a/tools/perf/util/metricgroup.c
+++ b/tools/perf/util/metricgroup.c
@@ -519,17 +519,17 @@ static int __metricgroup__add_metric(struct strbuf *events,
}
static int metricgroup__add_metric(const char *metric, struct strbuf *events,
- struct list_head *group_list)
+ struct list_head *group_list,
+ struct expr_parse_ctx *ctx)
{
struct pmu_events_map *map = perf_pmu__find_map(NULL);
- struct pmu_event *pe;
int i, ret = -EINVAL;
if (!map)
return 0;
for (i = 0; ; i++) {
- pe = &map->table[i];
+ struct pmu_event *pe = &map->table[i];
if (!pe->name && !pe->metric_group && !pe->metric_name)
break;
@@ -545,15 +545,56 @@ static int metricgroup__add_metric(const char *metric, struct strbuf *events,
break;
}
}
+
+ if (!ctx->num_custom || ret == -ENOMEM)
+ return ret;
+
+ for (i = 0; i < ctx->num_custom; i++) {
+ struct pmu_event pe = { 0 };
+
+ if (!match_metric(ctx->custom[i].name, metric))
+ continue;
+
+ pe.metric_name = strdup(ctx->custom[i].name);
+ pe.metric_expr = strdup(ctx->custom[i].expr);
+
+ if (!pe.metric_name && !pe.metric_expr)
+ return -ENOMEM;
+
+ ret = __metricgroup__add_metric(events, group_list, &pe);
+ if (ret) {
+ free((char *) pe.metric_name);
+ free((char *) pe.metric_expr);
+ break;
+ }
+ }
+
return ret;
}
static int metricgroup__add_metric_list(const char *list, struct strbuf *events,
- struct list_head *group_list)
+ struct list_head *group_list,
+ const char *metrics_file)
{
+ struct expr_parse_ctx ctx = { 0 };
char *llist, *nlist, *p;
int ret = -EINVAL;
+ if (metrics_file) {
+ size_t size;
+ char *buf;
+
+ if (filename__read_str(metrics_file, &buf, &size)) {
+ pr_err("failed to read metrics file: %s\n", metrics_file);
+ return -1;
+ }
+
+ expr__ctx_init(&ctx);
+ expr__parse_custom(&ctx, buf);
+
+ free(buf);
+ }
+
nlist = strdup(list);
if (!nlist)
return -ENOMEM;
@@ -563,7 +604,7 @@ static int metricgroup__add_metric_list(const char *list, struct strbuf *events,
strbuf_addf(events, "%s", "");
while ((p = strsep(&llist, ",")) != NULL) {
- ret = metricgroup__add_metric(p, events, group_list);
+ ret = metricgroup__add_metric(p, events, group_list, &ctx);
if (ret == -EINVAL) {
fprintf(stderr, "Cannot find metric or group `%s'\n",
p);
@@ -575,6 +616,15 @@ static int metricgroup__add_metric_list(const char *list, struct strbuf *events,
if (!ret)
metricgroup___watchdog_constraint_hint(NULL, true);
+ if (metrics_file) {
+ int i;
+
+ for (i = 0; i < ctx.num_custom; i++) {
+ zfree(&ctx.custom[i].name);
+ zfree(&ctx.custom[i].expr);
+ }
+ }
+
return ret;
}
@@ -594,7 +644,8 @@ static void metricgroup__free_egroups(struct list_head *group_list)
int metricgroup__parse_groups(const struct option *opt,
const char *str,
- struct rblist *metric_events)
+ struct rblist *metric_events,
+ const char *metrics_file)
{
struct parse_events_error parse_error;
struct evlist *perf_evlist = *(struct evlist **)opt->value;
@@ -604,7 +655,8 @@ int metricgroup__parse_groups(const struct option *opt,
if (metric_events->nr_entries == 0)
metricgroup__rblist_init(metric_events);
- ret = metricgroup__add_metric_list(str, &extra_events, &group_list);
+ ret = metricgroup__add_metric_list(str, &extra_events, &group_list,
+ metrics_file);
if (ret)
return ret;
pr_debug("adding %s\n", extra_events.buf);
diff --git a/tools/perf/util/metricgroup.h b/tools/perf/util/metricgroup.h
index 475c7f912864..bf6e4281915f 100644
--- a/tools/perf/util/metricgroup.h
+++ b/tools/perf/util/metricgroup.h
@@ -29,7 +29,8 @@ struct metric_event *metricgroup__lookup(struct rblist *metric_events,
bool create);
int metricgroup__parse_groups(const struct option *opt,
const char *str,
- struct rblist *metric_events);
+ struct rblist *metric_events,
+ const char *metrics_file);
void metricgroup__print(bool metrics, bool groups, char *filter,
bool raw, bool details);
diff --git a/tools/perf/util/stat.h b/tools/perf/util/stat.h
index b4fdfaa7f2c0..57c4c7695aaf 100644
--- a/tools/perf/util/stat.h
+++ b/tools/perf/util/stat.h
@@ -123,6 +123,7 @@ struct perf_stat_config {
struct runtime_stat *stats;
int stats_num;
const char *csv_sep;
+ const char *metrics_file;
struct stats *walltime_nsecs_stats;
struct rusage ru_data;
struct perf_cpu_map *aggr_map;
--
2.25.3