Skip to contentSkip to conversation

perf stat: Expand events for each cgroup

PATCH Superseded Namhyung Kim 3 participants 10 messages Sep 23, 2020 – Sep 24, 2020 perf events

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore

Namhyung Kim

author maintainer
#0 lore raw

v4 cover perf stat: Expand events for each cgroup

Hello,

When we profile cgroup events with perf stat, it's very annoying to specify events and cgroups on the command line as it requires the mapping between events and cgroups. (Note that perf record can use cgroup sampling but it's not usable for perf stat).

I guess most cases we just want to use a same set of events (N) for all cgroups (M), but we need to specify NxM events and NxM cgroups. This is not good especially when profiling large number of cgroups:
say M=200.

So I added --for-each-cgroup option to make it easy for that case. It will create NxM events from N events and M cgroups. One more upside is that it can handle metrics too.

For example, the following example measures IPC metric for 3 cgroups

  $ cat perf-expand-cgrp.sh
  #!/bin/sh
  METRIC=${1:-IPC}
  CGROUP_DIR=/sys/fs/cgroup/perf_event

sudo mkdir $CGROUP_DIR/A $CGROUP_DIR/B $CGROUP_DIR/C

  # add backgroupd workload for each cgroup
  echo $$ | sudo tee $CGROUP_DIR/A/cgroup.procs > /dev/null
  yes > /dev/null &
  echo $$ | sudo tee $CGROUP_DIR/B/cgroup.procs > /dev/null
  yes > /dev/null &
  echo $$ | sudo tee $CGROUP_DIR/C/cgroup.procs > /dev/null
  yes > /dev/null &
  # run 'perf stat' in the root cgroup
  echo $$ | sudo tee $CGROUP_DIR/cgroup.procs > /dev/null
  perf stat -a -M $METRIC --for-each-cgroup A,B,C sleep 1

kill %1 %2 %3
sudo rmdir $CGROUP_DIR/A $CGROUP_DIR/B $CGROUP_DIR/C

  $ ./perf-expand-cgrp.sh IPC

Performance counter stats for 'system wide':

      11,284,850,010      inst_retired.any          A #     2.71 IPC                    
       4,157,915,982      cpu_clk_unhalted.thread   A                                   
      11,342,188,640      inst_retired.any          B #     2.72 IPC                    
       4,173,014,732      cpu_clk_unhalted.thread   B                                   
      11,135,863,604      inst_retired.any          C #     2.67 IPC                    
       4,171,375,184      cpu_clk_unhalted.thread   C                                   
         1.011948803 seconds time elapsed

* Changes from v3:
- rename to evlist__find_evsel (Jiri)
- add documentation (Arnaldo)
- check -G option together with --for-each-cgroup

* Changes from v2:
- put relevant fields in evsel together (Jiri)
- add various error checks (Jiri)
- split cgroup open patch (Jiri)

* Changes from v1:
- rename the option to --for-each-cgroup (Jiri)
- copy evsel fields explicitly (Jiri)
- add libpfm4 test (Ian)

The code is available at 'perf/cgroup-multiply-v4' branch on

git://git.kernel.org/pub/scm/linux/kernel/git/namhyung/linux-perf.git

Thanks
Namhyung

Namhyung Kim (5):
perf evsel: Add evsel__clone() function
perf stat: Add --for-each-cgroup option
perf tools: Copy metric events properly when expand cgroups perf tools: Allow creation of cgroup without open perf test: Add expand cgroup event test

 tools/perf/Documentation/perf-stat.txt |   5 +
 tools/perf/builtin-stat.c              |  28 ++-
 tools/perf/tests/Build                 |   1 +
 tools/perf/tests/builtin-test.c        |   4 +
 tools/perf/tests/expand-cgroup.c       | 241 +++++++++++++++++++++++++
 tools/perf/tests/tests.h               |   1 +
 tools/perf/util/cgroup.c               | 107 ++++++++++-
 tools/perf/util/cgroup.h               |   3 +
 tools/perf/util/evlist.c               |  11 ++
 tools/perf/util/evlist.h               |   1 +
 tools/perf/util/evsel.c                | 104 +++++++++++
 tools/perf/util/evsel.h                |  93 ++++++----
 tools/perf/util/metricgroup.c          |  85 +++++++++
 tools/perf/util/metricgroup.h          |   6 +
 tools/perf/util/stat.h                 |   1 +
 15 files changed, 646 insertions(+), 45 deletions(-)
 create mode 100644 tools/perf/tests/expand-cgroup.c
Signature · 1 line
2.28.0.681.g6f77f65b4e-goog
author maintainer
#1 lore raw

PATCH v4 1/5 perf evsel: Add evsel__clone() function

The evsel__clone() is to create an exactly same evsel from same attributes. The function assumes the given evsel is not configured yet so it cares fields set during event parsing. Those fields are now moved together as Jiri suggested. Note that metric events will be handled by later patch.

It will be used by perf stat to generate separate events for each cgroup.

---
 tools/perf/util/evsel.c | 104 ++++++++++++++++++++++++++++++++++++++++
 tools/perf/util/evsel.h |  93 ++++++++++++++++++++---------------
 2 files changed, 158 insertions(+), 39 deletions(-)
tools/perf/util/evsel.c +104 -0
index fd865002cbbd..c63dd9f7e9fe 100644
@@ -331,6 +331,110 @@ struct evsel *evsel__new_cycles(bool precise)
 	goto out;
 }
 
+static int evsel__copy_config_terms(struct evsel *dst, struct evsel *src)
+{
+	struct evsel_config_term *pos, *tmp;
+
+	list_for_each_entry(pos, &src->config_terms, list) {
+		tmp = malloc(sizeof(*tmp));
+		if (tmp == NULL)
+			return -ENOMEM;
+
+		*tmp = *pos;
+		if (tmp->free_str) {
+			tmp->val.str = strdup(pos->val.str);
+			if (tmp->val.str == NULL) {
+				free(tmp);
+				return -ENOMEM;
+			}
+		}
+		list_add_tail(&tmp->list, &dst->config_terms);
+	}
+	return 0;
+}
+
+/**
+ * evsel__clone - create a new evsel copied from @orig
+ * @orig: original evsel
+ *
+ * The assumption is that @orig is not configured nor opened yet.
+ * So we only care about the attributes that can be set while it's parsed.
+ */
+struct evsel *evsel__clone(struct evsel *orig)
+{
+	struct evsel *evsel;
+
+	BUG_ON(orig->core.fd);
+	BUG_ON(orig->counts);
+	BUG_ON(orig->priv);
+	BUG_ON(orig->per_pkg_mask);
+
+	/* cannot handle BPF objects for now */
+	if (orig->bpf_obj)
+		return NULL;
+
+	evsel = evsel__new(&orig->core.attr);
+	if (evsel == NULL)
+		return NULL;
+
+	evsel->core.cpus = perf_cpu_map__get(orig->core.cpus);
+	evsel->core.own_cpus = perf_cpu_map__get(orig->core.own_cpus);
+	evsel->core.threads = perf_thread_map__get(orig->core.threads);
+	evsel->core.nr_members = orig->core.nr_members;
+	evsel->core.system_wide = orig->core.system_wide;
+
+	if (orig->name) {
+		evsel->name = strdup(orig->name);
+		if (evsel->name == NULL)
+			goto out_err;
+	}
+	if (orig->group_name) {
+		evsel->group_name = strdup(orig->group_name);
+		if (evsel->group_name == NULL)
+			goto out_err;
+	}
+	if (orig->pmu_name) {
+		evsel->pmu_name = strdup(orig->pmu_name);
+		if (evsel->pmu_name == NULL)
+			goto out_err;
+	}
+	if (orig->filter) {
+		evsel->filter = strdup(orig->filter);
+		if (evsel->filter == NULL)
+			goto out_err;
+	}
+	evsel->cgrp = cgroup__get(orig->cgrp);
+	evsel->tp_format = orig->tp_format;
+	evsel->handler = orig->handler;
+	evsel->leader = orig->leader;
+
+	evsel->max_events = orig->max_events;
+	evsel->tool_event = orig->tool_event;
+	evsel->unit = orig->unit;
+	evsel->scale = orig->scale;
+	evsel->snapshot = orig->snapshot;
+	evsel->per_pkg = orig->per_pkg;
+	evsel->percore = orig->percore;
+	evsel->precise_max = orig->precise_max;
+	evsel->use_uncore_alias = orig->use_uncore_alias;
+	evsel->is_libpfm_event = orig->is_libpfm_event;
+
+	evsel->exclude_GH = orig->exclude_GH;
+	evsel->sample_read = orig->sample_read;
+	evsel->auto_merge_stats = orig->auto_merge_stats;
+	evsel->collect_stat = orig->collect_stat;
+	evsel->weak_group = orig->weak_group;
+
+	if (evsel__copy_config_terms(evsel, orig) < 0)
+		goto out_err;
+
+	return evsel;
+
+out_err:
+	evsel__delete(evsel);
+	return NULL;
+}
+
 /*
  * Returns pointer with encoded error via <linux/err.h> interface.
  */
tools/perf/util/evsel.h +54 -39

125 lines not on this page · raw message

Signature · 1 line
2.28.0.681.g6f77f65b4e-goog
author maintainer
#2 lore raw

PATCH v4 2/5 perf stat: Add --for-each-cgroup option

In reply to Namhyung Kim

The --for-each-cgroup option is a syntax sugar to monitor large number of cgroups easily. Current command line requires to list all the events and cgroups even if users want to monitor same events for each cgroup. This patch addresses that usage by copying given events for each cgroup on user's behalf.

For instance, if they want to monitor 6 events for 200 cgroups each they should write 1200 event names (with -e) AND 1200 cgroup names (with -G) on the command line. But with this change, they can just specify 6 events and 200 cgroups with a new option.

A simpler example below: It wants to measure 3 events for 2 cgroups ('A' and 'B'). The result is that total 6 events are counted like below.

  $ ./perf stat -a -e cpu-clock,cycles,instructions --for-each-cgroup A,B sleep 1

Performance counter stats for 'system wide':

              988.18 msec cpu-clock                 A #    0.987 CPUs utilized
       3,153,761,702      cycles                    A #    3.200 GHz                      (100.00%)
       8,067,769,847      instructions              A #    2.57  insn per cycle           (100.00%)
              982.71 msec cpu-clock                 B #    0.982 CPUs utilized
       3,136,093,298      cycles                    B #    3.182 GHz                      (99.99%)
       8,109,619,327      instructions              B #    2.58  insn per cycle           (99.99%)
         1.001228054 seconds time elapsed
---
 tools/perf/Documentation/perf-stat.txt |  5 ++
 tools/perf/builtin-stat.c              | 27 ++++++++-
 tools/perf/util/cgroup.c               | 79 ++++++++++++++++++++++++++
 tools/perf/util/cgroup.h               |  1 +
 tools/perf/util/stat.h                 |  1 +
 5 files changed, 112 insertions(+), 1 deletion(-)
tools/perf/Documentation/perf-stat.txt +5 -0
index 7d18694e592a..bb17c9caec78 100644
@@ -166,6 +166,11 @@ use '-e e1 -e e2 -G foo,foo' or just use '-e e1 -e e2 -G foo'.
 If wanting to monitor, say, 'cycles' for a cgroup and also for system wide, this
 command line can be used: 'perf stat -e cycles -G cgroup_name -a -e cycles'.
 
+--for-each-cgroup name::
+Expand event list for each cgroup in "name" (allow multiple cgroups separated
+by comma).  This has same effect that repeating -e option and -G option for
+each event x name.  This option cannot be used with -G/--cgroup option.
+
 -o file::
 --output file::
 Print the output into the designated file.
tools/perf/builtin-stat.c +26 -1
index 7f8d756d9408..23abf14b6e16 100644
@@ -1051,6 +1051,17 @@ static int parse_control_option(const struct option *opt,
 	return evlist__parse_control(str, &config->ctl_fd, &config->ctl_fd_ack, &config->ctl_fd_close);
 }
 
+static int parse_stat_cgroups(const struct option *opt,
+			      const char *str, int unset)
+{
+	if (stat_config.cgroup_list) {
+		pr_err("--cgroup and --for-each-cgroup cannot be used together\n");
+		return -1;
+	}
+
+	return parse_cgroups(opt, str, unset);
+}
+
 static struct option stat_options[] = {
 	OPT_BOOLEAN('T', "transaction", &transaction_run,
 		    "hardware transaction statistics"),
@@ -1094,7 +1105,9 @@ static struct option stat_options[] = {
 	OPT_STRING('x', "field-separator", &stat_config.csv_sep, "separator",
 		   "print counts with custom separator"),
 	OPT_CALLBACK('G', "cgroup", &evsel_list, "name",
-		     "monitor event in cgroup name only", parse_cgroups),
+		     "monitor event in cgroup name only", parse_stat_cgroups),
+	OPT_STRING(0, "for-each-cgroup", &stat_config.cgroup_list, "name",
+		    "expand events for each cgroup"),
 	OPT_STRING('o', "output", &output_name, "file", "output file name"),
 	OPT_BOOLEAN(0, "append", &append_file, "append to the output file"),
 	OPT_INTEGER(0, "log-fd", &output_fd,
@@ -2234,6 +2247,18 @@ int cmd_stat(int argc, const char **argv)
 	if (add_default_attributes())
 		goto out;
 
+	if (stat_config.cgroup_list) {
+		if (nr_cgroups > 0) {
+			pr_err("--cgroup and --for-each-cgroup cannot be used together\n");
+			parse_options_usage(stat_usage, stat_options, "G", 1);
+			parse_options_usage(NULL, stat_options, "for-each-cgroup", 0);
+			goto out;
+		}
+
+		if (evlist__expand_cgroup(evsel_list, stat_config.cgroup_list) < 0)
+			goto out;
+	}
+
 	target__validate(&target);
 
 	if ((stat_config.aggr_mode == AGGR_THREAD) && (target.system_wide))
tools/perf/util/cgroup.c +79 -0

85 lines not on this page · raw message

tools/perf/util/cgroup.h +1 -0
index e98d5975fe55..32893018296f 100644
@@ -24,6 +24,7 @@ void cgroup__put(struct cgroup *cgroup);
 struct evlist;
 
 struct cgroup *evlist__findnew_cgroup(struct evlist *evlist, const char *name);
+int evlist__expand_cgroup(struct evlist *evlist, const char *cgroups);
 
 void evlist__set_default_cgroup(struct evlist *evlist, struct cgroup *cgroup);
 
tools/perf/util/stat.h +1 -0
index 9911fc6adbfd..7325de5bf2a6 100644
@@ -137,6 +137,7 @@ struct perf_stat_config {
 	int			 ctl_fd;
 	int			 ctl_fd_ack;
 	bool			 ctl_fd_close;
+	const char		*cgroup_list;
 };
 
 void perf_stat__set_big_num(int set);
Signature · 1 line
2.28.0.681.g6f77f65b4e-goog
author maintainer
#3 lore raw

PATCH v4 3/5 perf tools: Copy metric events properly when expand cgroups

In reply to Namhyung Kim

The metricgroup__copy_metric_events() is to handle metrics events when expanding event for cgroups. As the metric events keep pointers to evsel, it should be refreshed when events are cloned during the operation.

The perf_stat__collect_metric_expr() is also called in case an event has a metric directly.

During the copy, it references evsel by index as the evlist now has cloned evsels for the given cgroup.

Cc John Garry <[email protected]>
Cc Kajol Jain <[email protected]>
Cc Ian Rogers <[email protected]>
---
 tools/perf/builtin-stat.c     |  3 +-
 tools/perf/util/cgroup.c      | 15 ++++++-
 tools/perf/util/cgroup.h      |  4 +-
 tools/perf/util/evlist.c      | 11 +++++
 tools/perf/util/evlist.h      |  1 +
 tools/perf/util/metricgroup.c | 85 +++++++++++++++++++++++++++++++++++
 tools/perf/util/metricgroup.h |  6 +++
 7 files changed, 122 insertions(+), 3 deletions(-)
tools/perf/builtin-stat.c +2 -1
index 23abf14b6e16..66a33d97192d 100644
@@ -2255,7 +2255,8 @@ int cmd_stat(int argc, const char **argv)
 			goto out;
 		}
 
-		if (evlist__expand_cgroup(evsel_list, stat_config.cgroup_list) < 0)
+		if (evlist__expand_cgroup(evsel_list, stat_config.cgroup_list,
+					  &stat_config.metric_events) < 0)
 			goto out;
 	}
 
tools/perf/util/cgroup.c +14 -1
index 8b6a4fa49082..dcd18ef268a1 100644
@@ -3,6 +3,9 @@
 #include "evsel.h"
 #include "cgroup.h"
 #include "evlist.h"
+#include "rblist.h"
+#include "metricgroup.h"
+#include "stat.h"
 #include <linux/zalloc.h>
 #include <sys/types.h>
 #include <sys/stat.h>
@@ -193,10 +196,12 @@ int parse_cgroups(const struct option *opt, const char *str,
 	return 0;
 }
 
-int evlist__expand_cgroup(struct evlist *evlist, const char *str)
+int evlist__expand_cgroup(struct evlist *evlist, const char *str,
+			  struct rblist *metric_events)
 {
 	struct evlist *orig_list, *tmp_list;
 	struct evsel *pos, *evsel, *leader;
+	struct rblist orig_metric_events;
 	struct cgroup *cgrp = NULL;
 	const char *p, *e, *eos = str + strlen(str);
 	int ret = -1;
@@ -216,6 +221,8 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str)
 	/* save original events and init evlist */
 	perf_evlist__splice_list_tail(orig_list, &evlist->core.entries);
 	evlist->core.nr_entries = 0;
+	orig_metric_events = *metric_events;
+	rblist__init(metric_events);
 
 	for (;;) {
 		p = strchr(str, ',');
@@ -255,6 +262,11 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str)
 		cgroup__put(cgrp);
 		nr_cgroups++;
 
+		perf_stat__collect_metric_expr(tmp_list);
+		if (metricgroup__copy_metric_events(tmp_list, cgrp, metric_events,
+						    &orig_metric_events) < 0)
+			break;
+
 		perf_evlist__splice_list_tail(evlist, &tmp_list->core.entries);
 		tmp_list->core.nr_entries = 0;
 
@@ -268,6 +280,7 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str)
 out_err:
 	evlist__delete(orig_list);
 	evlist__delete(tmp_list);
+	rblist__exit(&orig_metric_events);
 
 	return ret;
 }
tools/perf/util/cgroup.h +3 -1
index 32893018296f..eea6df8ee373 100644
@@ -22,9 +22,11 @@ struct cgroup *cgroup__get(struct cgroup *cgroup);
 void cgroup__put(struct cgroup *cgroup);
 
 struct evlist;
+struct rblist;
 
 struct cgroup *evlist__findnew_cgroup(struct evlist *evlist, const char *name);
-int evlist__expand_cgroup(struct evlist *evlist, const char *cgroups);
+int evlist__expand_cgroup(struct evlist *evlist, const char *cgroups,
+			  struct rblist *metric_events);
 
 void evlist__set_default_cgroup(struct evlist *evlist, struct cgroup *cgroup);
 
tools/perf/util/evlist.c +11 -0
index ee7b576d3b12..aae79b2b5041 100644
@@ -1964,3 +1964,14 @@ int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd)
 
 	return err;
 }
+
+struct evsel *evlist__find_evsel(struct evlist *evlist, int idx)
+{
+	struct evsel *evsel;
+
+	evlist__for_each_entry(evlist, evsel) {
+		if (evsel->idx == idx)
+			return evsel;
+	}
+	return NULL;
+}
tools/perf/util/evlist.h +1 -0
index bc38a53f6a1a..e1a450322bc5 100644
@@ -386,4 +386,5 @@ int evlist__ctlfd_ack(struct evlist *evlist);
 #define EVLIST_ENABLED_MSG "Events enabled\n"
 #define EVLIST_DISABLED_MSG "Events disabled\n"
 
+struct evsel *evlist__find_evsel(struct evlist *evlist, int idx);
 #endif /* __PERF_EVLIST_H */
tools/perf/util/metricgroup.c +85 -0

94 lines not on this page · raw message

tools/perf/util/metricgroup.h +6 -0
index 491a5d78252d..ed1b9392e624 100644
@@ -7,11 +7,13 @@
 #include <stdbool.h>
 #include "pmu-events/pmu-events.h"
 
+struct evlist;
 struct evsel;
 struct evlist;
 struct option;
 struct rblist;
 struct pmu_events_map;
+struct cgroup;
 
 struct metric_event {
 	struct rb_node nd;
@@ -55,4 +57,8 @@ void metricgroup__print(bool metrics, bool groups, char *filter,
 bool metricgroup__has_metric(const char *metric);
 int arch_get_runtimeparam(struct pmu_event *pe __maybe_unused);
 void metricgroup__rblist_exit(struct rblist *metric_events);
+
+int metricgroup__copy_metric_events(struct evlist *evlist, struct cgroup *cgrp,
+				    struct rblist *new_metric_events,
+				    struct rblist *old_metric_events);
 #endif
Signature · 1 line
2.28.0.681.g6f77f65b4e-goog
#4 lore raw

Re: [PATCH 3/5] perf tools: Copy metric events properly when expand cgroups

On Wed, Sep 23, 2020 at 10:59:43AM +0900, Namhyung Kim wrote:

SNIP

Quoted 38 lines
tools/perf/util/cgroup.c +8 -1
index 8b6a4fa49082..dcd18ef268a1 100644
@@ -3,6 +3,9 @@
 #include "evsel.h"
 #include "cgroup.h"
 #include "evlist.h"
+#include "rblist.h"
+#include "metricgroup.h"
+#include "stat.h"
 #include <linux/zalloc.h>
 #include <sys/types.h>
 #include <sys/stat.h>
@@ -193,10 +196,12 @@ int parse_cgroups(const struct option *opt, const char *str,
 	return 0;
 }
 
-int evlist__expand_cgroup(struct evlist *evlist, const char *str)
+int evlist__expand_cgroup(struct evlist *evlist, const char *str,
+			  struct rblist *metric_events)
 {
 	struct evlist *orig_list, *tmp_list;
 	struct evsel *pos, *evsel, *leader;
+	struct rblist orig_metric_events;
 	struct cgroup *cgrp = NULL;
 	const char *p, *e, *eos = str + strlen(str);
 	int ret = -1;
@@ -216,6 +221,8 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str)
 	/* save original events and init evlist */
 	perf_evlist__splice_list_tail(orig_list, &evlist->core.entries);
 	evlist->core.nr_entries = 0;
+	orig_metric_events = *metric_events;
+	rblist__init(metric_events);
 
 	for (;;) {
 		p = strchr(str, ',');

tools/perf/util/cgroup.c int evlist__expand_cgroup(struct evlist *evlist, const char *str) · line 265

Quoted 4 lines
tools/perf/util/cgroup.c +1 -0
@@ -255,6 +262,11 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str)
 		cgroup__put(cgrp);
 		nr_cgroups++;
 
+		perf_stat__collect_metric_expr(tmp_list);

I know you added the option just for perf stat, not record, but the code looks generic apart from using this function

I wonder if this would cause any issues if it was called in record context.. maybe we could just skip it in that case, but that's for future to worry about ;-)

jirka

Quoted 15 lines
tools/perf/util/cgroup.c +5 -0
+		if (metricgroup__copy_metric_events(tmp_list, cgrp, metric_events,
+						    &orig_metric_events) < 0)
+			break;
+
 		perf_evlist__splice_list_tail(evlist, &tmp_list->core.entries);
 		tmp_list->core.nr_entries = 0;
 
@@ -268,6 +280,7 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str)
 out_err:
 	evlist__delete(orig_list);
 	evlist__delete(tmp_list);
+	rblist__exit(&orig_metric_events);
 
 	return ret;
 }

SNIP

author maintainer
#5 lore raw

Re: [PATCH 3/5] perf tools: Copy metric events properly when expand cgroups

Quoted 47 lines · Jiri Olsa

On Wed, Sep 23, 2020 at 10:59:43AM +0900, Namhyung Kim wrote:

SNIP

Quoted 41 lines
tools/perf/util/cgroup.c +8 -1
index 8b6a4fa49082..dcd18ef268a1 100644
@@ -3,6 +3,9 @@
 #include "evsel.h"
 #include "cgroup.h"
 #include "evlist.h"
+#include "rblist.h"
+#include "metricgroup.h"
+#include "stat.h"
 #include <linux/zalloc.h>
 #include <sys/types.h>
 #include <sys/stat.h>
@@ -193,10 +196,12 @@ int parse_cgroups(const struct option *opt, const char *str,
      return 0;
 }
 
-int evlist__expand_cgroup(struct evlist *evlist, const char *str)
+int evlist__expand_cgroup(struct evlist *evlist, const char *str,
+                       struct rblist *metric_events)
 {
      struct evlist *orig_list, *tmp_list;
      struct evsel *pos, *evsel, *leader;
+     struct rblist orig_metric_events;
      struct cgroup *cgrp = NULL;
      const char *p, *e, *eos = str + strlen(str);
      int ret = -1;
@@ -216,6 +221,8 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str)
      /* save original events and init evlist */
      perf_evlist__splice_list_tail(orig_list, &evlist->core.entries);
      evlist->core.nr_entries = 0;
+     orig_metric_events = *metric_events;
+     rblist__init(metric_events);
 
      for (;;) {
              p = strchr(str, ',');
@@ -255,6 +262,11 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str)
              cgroup__put(cgrp);
              nr_cgroups++;
 
Quoted 4 lines

tools/perf/util/cgroup.c int evlist__expand_cgroup(struct evlist *evlist, const char *str) · line 265

Quoted 1 line
tools/perf/util/cgroup.c +1 -0
+             perf_stat__collect_metric_expr(tmp_list);

I know you added the option just for perf stat, not record, but the code looks generic apart from using this function

Right. I've tried to make it generic as much as possible. But the above code works for an evlist assuming all the evsels are in the same cgroup as far as I can see. So I put it here to pass the tmp_list for each cgroup separately.

Quoted 4 lines

I wonder if this would cause any issues if it was called in record context.. maybe we could just skip it in that case, but that's for future to worry about ;-)

Yeah, I believe we can just skip as it's all for metrics which is used for perf stat only, I guess?

Thanks
Namhyung

Quoted 19 lines
Quoted 16 lines
tools/perf/util/cgroup.c +5 -0
+             if (metricgroup__copy_metric_events(tmp_list, cgrp, metric_events,
+                                                 &orig_metric_events) < 0)
+                     break;
+
              perf_evlist__splice_list_tail(evlist, &tmp_list->core.entries);
              tmp_list->core.nr_entries = 0;
 
@@ -268,6 +280,7 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str)
 out_err:
      evlist__delete(orig_list);
      evlist__delete(tmp_list);
+     rblist__exit(&orig_metric_events);
 
      return ret;
 }

SNIP

author maintainer
#6 lore raw

PATCH v4 4/5 perf tools: Allow creation of cgroup without open

In reply to Namhyung Kim

This is a preparation for a test case of expanding events for multiple cgroups. Instead of using real system cgroup, the test will use fake cgroups so it needs a way to have them without a open file descriptor.

---
 tools/perf/builtin-stat.c |  2 +-
 tools/perf/util/cgroup.c  | 19 ++++++++++++-------
 tools/perf/util/cgroup.h  |  2 +-
 3 files changed, 14 insertions(+), 9 deletions(-)
tools/perf/builtin-stat.c +1 -1
index 66a33d97192d..d9d5de6f3108 100644
@@ -2256,7 +2256,7 @@ int cmd_stat(int argc, const char **argv)
 		}
 
 		if (evlist__expand_cgroup(evsel_list, stat_config.cgroup_list,
-					  &stat_config.metric_events) < 0)
+					  &stat_config.metric_events, true) < 0)
 			goto out;
 	}
 
tools/perf/util/cgroup.c +12 -7
index dcd18ef268a1..d82f4cad762c 100644
@@ -51,7 +51,7 @@ static struct cgroup *evlist__find_cgroup(struct evlist *evlist, const char *str
 	return NULL;
 }
 
-static struct cgroup *cgroup__new(const char *name)
+static struct cgroup *cgroup__new(const char *name, bool do_open)
 {
 	struct cgroup *cgroup = zalloc(sizeof(*cgroup));
 
@@ -61,9 +61,14 @@ static struct cgroup *cgroup__new(const char *name)
 		cgroup->name = strdup(name);
 		if (!cgroup->name)
 			goto out_err;
-		cgroup->fd = open_cgroup(name);
-		if (cgroup->fd == -1)
-			goto out_free_name;
+
+		if (do_open) {
+			cgroup->fd = open_cgroup(name);
+			if (cgroup->fd == -1)
+				goto out_free_name;
+		} else {
+			cgroup->fd = -1;
+		}
 	}
 
 	return cgroup;
@@ -79,7 +84,7 @@ struct cgroup *evlist__findnew_cgroup(struct evlist *evlist, const char *name)
 {
 	struct cgroup *cgroup = evlist__find_cgroup(evlist, name);
 
-	return cgroup ?: cgroup__new(name);
+	return cgroup ?: cgroup__new(name, true);
 }
 
 static int add_cgroup(struct evlist *evlist, const char *str)
@@ -197,7 +202,7 @@ int parse_cgroups(const struct option *opt, const char *str,
 }
 
 int evlist__expand_cgroup(struct evlist *evlist, const char *str,
-			  struct rblist *metric_events)
+			  struct rblist *metric_events, bool open_cgroup)
 {
 	struct evlist *orig_list, *tmp_list;
 	struct evsel *pos, *evsel, *leader;
@@ -235,7 +240,7 @@ int evlist__expand_cgroup(struct evlist *evlist, const char *str,
 			if (!name)
 				goto out_err;
 
-			cgrp = cgroup__new(name);
+			cgrp = cgroup__new(name, open_cgroup);
 			free(name);
 			if (cgrp == NULL)
 				goto out_err;
tools/perf/util/cgroup.h +1 -1
index eea6df8ee373..162906f3412a 100644
@@ -26,7 +26,7 @@ struct rblist;
 
 struct cgroup *evlist__findnew_cgroup(struct evlist *evlist, const char *name);
 int evlist__expand_cgroup(struct evlist *evlist, const char *cgroups,
-			  struct rblist *metric_events);
+			  struct rblist *metric_events, bool open_cgroup);
 
 void evlist__set_default_cgroup(struct evlist *evlist, struct cgroup *cgroup);
 
Signature · 1 line
2.28.0.681.g6f77f65b4e-goog
author maintainer
#7 lore raw

PATCH v4 5/5 perf test: Add expand cgroup event test

In reply to Namhyung Kim

It'll expand given events for cgroups A, B and C.

  $ ./perf test -v expansion
  69: Event expansion for cgroups                      :
  --- start ---
  test child forked, pid 983140
  metric expr 1 / IPC for CPI
  metric expr instructions / cycles for IPC
  found event instructions
  found event cycles
  adding {instructions,cycles}:W
  copying metric event for cgroup 'A': instructions (idx=0)
  copying metric event for cgroup 'B': instructions (idx=0)
  copying metric event for cgroup 'C': instructions (idx=0)
  test child finished with 0
  ---- end ----
  Event expansion for cgroups: Ok
---
 tools/perf/tests/Build           |   1 +
 tools/perf/tests/builtin-test.c  |   4 +
 tools/perf/tests/expand-cgroup.c | 241 +++++++++++++++++++++++++++++++
 tools/perf/tests/tests.h         |   1 +
 4 files changed, 247 insertions(+)
 create mode 100644 tools/perf/tests/expand-cgroup.c
tools/perf/tests/Build +1 -0
index 69bea7996f18..4d15bf6041fb 100644
@@ -61,6 +61,7 @@ perf-y += demangle-java-test.o
 perf-y += pfm.o
 perf-y += parse-metric.o
 perf-y += pe-file-parsing.o
+perf-y += expand-cgroup.o
 
 $(OUTPUT)tests/llvm-src-base.c: tests/bpf-script-example.c tests/Build
 	$(call rule_mkdir)
tools/perf/tests/builtin-test.c +4 -0
index 651b8ea3354a..132bdb3e6c31 100644
@@ -345,6 +345,10 @@ static struct test generic_tests[] = {
 		.desc = "PE file support",
 		.func = test__pe_file_parsing,
 	},
+	{
+		.desc = "Event expansion for cgroups",
+		.func = test__expand_cgroup_events,
+	},
 	{
 		.func = NULL,
 	},
tools/perf/tests/expand-cgroup.c new file +241 -0

241 lines not on this page · raw message

tools/perf/tests/tests.h +1 -0
index ef0f33c6ba23..c85a2c08e407 100644
@@ -123,6 +123,7 @@ const char *test__pfm_subtest_get_desc(int subtest);
 int test__pfm_subtest_get_nr(void);
 int test__parse_metric(struct test *test, int subtest);
 int test__pe_file_parsing(struct test *test, int subtest);
+int test__expand_cgroup_events(struct test *test, int subtest);
 
 bool test__bp_signal_is_supported(void);
 bool test__bp_account_is_supported(void);
Signature · 1 line
2.28.0.681.g6f77f65b4e-goog
reviewer
#8 lore raw

Re: [PATCH 5/5] perf test: Add expand cgroup event test

Quoted 194 lines · Namhyung Kim

It'll expand given events for cgroups A, B and C.

  $ ./perf test -v expansion
  69: Event expansion for cgroups                      :
  --- start ---
  test child forked, pid 983140
  metric expr 1 / IPC for CPI
  metric expr instructions / cycles for IPC
  found event instructions
  found event cycles
  adding {instructions,cycles}:W
  copying metric event for cgroup 'A': instructions (idx=0)
  copying metric event for cgroup 'B': instructions (idx=0)
  copying metric event for cgroup 'C': instructions (idx=0)
  test child finished with 0
  ---- end ----
  Event expansion for cgroups: Ok
---
 tools/perf/tests/Build           |   1 +
 tools/perf/tests/builtin-test.c  |   4 +
 tools/perf/tests/expand-cgroup.c | 241 +++++++++++++++++++++++++++++++
 tools/perf/tests/tests.h         |   1 +
 4 files changed, 247 insertions(+)
 create mode 100644 tools/perf/tests/expand-cgroup.c
tools/perf/tests/Build +1 -0
index 69bea7996f18..4d15bf6041fb 100644
@@ -61,6 +61,7 @@ perf-y += demangle-java-test.o
 perf-y += pfm.o
 perf-y += parse-metric.o
 perf-y += pe-file-parsing.o
+perf-y += expand-cgroup.o
 
 $(OUTPUT)tests/llvm-src-base.c: tests/bpf-script-example.c tests/Build
        $(call rule_mkdir)
tools/perf/tests/builtin-test.c +4 -0
index 651b8ea3354a..132bdb3e6c31 100644
@@ -345,6 +345,10 @@ static struct test generic_tests[] = {
                .desc = "PE file support",
                .func = test__pe_file_parsing,
        },
+       {
+               .desc = "Event expansion for cgroups",
+               .func = test__expand_cgroup_events,
+       },
        {
                .func = NULL,
        },
tools/perf/tests/expand-cgroup.c new file +132 -0
new file mode 100644
index 000000000000..d5771e4d094f
@@ -0,0 +1,241 @@
+// SPDX-License-Identifier: GPL-2.0
+#include "tests.h"
+#include "debug.h"
+#include "evlist.h"
+#include "cgroup.h"
+#include "rblist.h"
+#include "metricgroup.h"
+#include "parse-events.h"
+#include "pmu-events/pmu-events.h"
+#include "pfm.h"
+#include <subcmd/parse-options.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+static int test_expand_events(struct evlist *evlist,
+                             struct rblist *metric_events)
+{
+       int i, ret = TEST_FAIL;
+       int nr_events;
+       bool was_group_event;
+       int nr_members;  /* for the first evsel only */
+       const char cgrp_str[] = "A,B,C";
+       const char *cgrp_name[] = { "A", "B", "C" };
+       int nr_cgrps = ARRAY_SIZE(cgrp_name);
+       char **ev_name;
+       struct evsel *evsel;
+
+       TEST_ASSERT_VAL("evlist is empty", !perf_evlist__empty(evlist));
+
+       nr_events = evlist->core.nr_entries;
+       ev_name = calloc(nr_events, sizeof(*ev_name));
+       if (ev_name == NULL) {
+               pr_debug("memory allocation failure\n");
+               return TEST_FAIL;
+       }
+       i = 0;
+       evlist__for_each_entry(evlist, evsel) {
+               ev_name[i] = strdup(evsel->name);
+               if (ev_name[i] == NULL) {
+                       pr_debug("memory allocation failure\n");
+                       goto out;
+               }
+               i++;
+       }
+       /* remember grouping info */
+       was_group_event = evsel__is_group_event(evlist__first(evlist));
+       nr_members = evlist__first(evlist)->core.nr_members;
+
+       ret = evlist__expand_cgroup(evlist, cgrp_str, metric_events, false);
+       if (ret < 0) {
+               pr_debug("failed to expand events for cgroups\n");
+               goto out;
+       }
+
+       ret = TEST_FAIL;
+       if (evlist->core.nr_entries != nr_events * nr_cgrps) {
+               pr_debug("event count doesn't match\n");
+               goto out;
+       }
+
+       i = 0;
+       evlist__for_each_entry(evlist, evsel) {
+               if (strcmp(evsel->name, ev_name[i % nr_events])) {
+                       pr_debug("event name doesn't match:\n");
+                       pr_debug("  evsel[%d]: %s\n  expected: %s\n",
+                                i, evsel->name, ev_name[i % nr_events]);
+                       goto out;
+               }
+               if (strcmp(evsel->cgrp->name, cgrp_name[i / nr_events])) {
+                       pr_debug("cgroup name doesn't match:\n");
+                       pr_debug("  evsel[%d]: %s\n  expected: %s\n",
+                                i, evsel->cgrp->name, cgrp_name[i / nr_events]);
+                       goto out;
+               }
+
+               if ((i % nr_events) == 0) {
+                       if (evsel__is_group_event(evsel) != was_group_event) {
+                               pr_debug("event group doesn't match: got %s, expect %s\n",
+                                        evsel__is_group_event(evsel) ? "true" : "false",
+                                        was_group_event ? "true" : "false");
+                               goto out;
+                       }
+                       if (evsel->core.nr_members != nr_members) {
+                               pr_debug("event group member doesn't match: %d vs %d\n",
+                                        evsel->core.nr_members, nr_members);
+                               goto out;
+                       }
+               }
+               i++;
+       }
+       ret = TEST_OK;
+
+out:   for (i = 0; i < nr_events; i++)
+               free(ev_name[i]);
+       free(ev_name);
+       return ret;
+}
+
+static int expand_default_events(void)
+{
+       int ret;
+       struct evlist *evlist;
+       struct rblist metric_events;
+
+       evlist = perf_evlist__new_default();
+       TEST_ASSERT_VAL("failed to get evlist", evlist);
+
+       rblist__init(&metric_events);
+       ret = test_expand_events(evlist, &metric_events);
+       evlist__delete(evlist);
+       return ret;
+}
+
+static int expand_group_events(void)
+{
+       int ret;
+       struct evlist *evlist;
+       struct rblist metric_events;
+       struct parse_events_error err;
+       const char event_str[] = "{cycles,instructions}";
+
+       symbol_conf.event_group = true;
+
+       evlist = evlist__new();
+       TEST_ASSERT_VAL("failed to get evlist", evlist);
+
+       ret = parse_events(evlist, event_str, &err);
+       if (ret < 0) {
+               pr_debug("failed to parse event '%s', err %d, str '%s'\n",
+                        event_str, ret, err.str);
+               parse_events_print_error(&err, event_str);

tools/perf/tests/expand-cgroup.c line 142

Quoted 10 lines
tools/perf/tests/expand-cgroup.c new file +10 -0
+               goto out;
+       }
+
+       rblist__init(&metric_events);
+       ret = test_expand_events(evlist, &metric_events);
+out:
+       evlist__delete(evlist);
+       return ret;
+}
+

Should this be #ifdef HAVE_LIBPFM ?

Thanks,
Ian

Quoted 114 lines
tools/perf/tests/expand-cgroup.c new file +99 -0
+static int expand_libpfm_events(void)
+{
+       int ret;
+       struct evlist *evlist;
+       struct rblist metric_events;
+       const char event_str[] = "UNHALTED_CORE_CYCLES";
+       struct option opt = {
+               .value = &evlist,
+       };
+
+       symbol_conf.event_group = true;
+
+       evlist = evlist__new();
+       TEST_ASSERT_VAL("failed to get evlist", evlist);
+
+       ret = parse_libpfm_events_option(&opt, event_str, 0);
+       if (ret < 0) {
+               pr_debug("failed to parse libpfm event '%s', err %d\n",
+                        event_str, ret);
+               goto out;
+       }
+       if (perf_evlist__empty(evlist)) {
+               pr_debug("libpfm was not enabled\n");
+               goto out;
+       }
+
+       rblist__init(&metric_events);
+       ret = test_expand_events(evlist, &metric_events);
+out:
+       evlist__delete(evlist);
+       return ret;
+}
+
+static int expand_metric_events(void)
+{
+       int ret;
+       struct evlist *evlist;
+       struct rblist metric_events;
+       const char metric_str[] = "CPI";
+
+       struct pmu_event pme_test[] = {
+               {
+                       .metric_expr    = "instructions / cycles",
+                       .metric_name    = "IPC",
+               },
+               {
+                       .metric_expr    = "1 / IPC",
+                       .metric_name    = "CPI",
+               },
+               {
+                       .metric_expr    = NULL,
+                       .metric_name    = NULL,
+               },
+       };
+       struct pmu_events_map ev_map = {
+               .cpuid          = "test",
+               .version        = "1",
+               .type           = "core",
+               .table          = pme_test,
+       };
+
+       evlist = evlist__new();
+       TEST_ASSERT_VAL("failed to get evlist", evlist);
+
+       rblist__init(&metric_events);
+       ret = metricgroup__parse_groups_test(evlist, &ev_map, metric_str,
+                                            false, false, &metric_events);
+       if (ret < 0) {
+               pr_debug("failed to parse '%s' metric\n", metric_str);
+               goto out;
+       }
+
+       ret = test_expand_events(evlist, &metric_events);
+
+out:
+       metricgroup__rblist_exit(&metric_events);
+       evlist__delete(evlist);
+       return ret;
+}
+
+int test__expand_cgroup_events(struct test *test __maybe_unused,
+                              int subtest __maybe_unused)
+{
+       int ret;
+
+       ret = expand_default_events();
+       TEST_ASSERT_EQUAL("failed to expand default events", ret, 0);
+
+       ret = expand_group_events();
+       TEST_ASSERT_EQUAL("failed to expand event group", ret, 0);
+
+       ret = expand_libpfm_events();
+       TEST_ASSERT_EQUAL("failed to expand event group", ret, 0);
+
+       ret = expand_metric_events();
+       TEST_ASSERT_EQUAL("failed to expand metric events", ret, 0);
+
+       return ret;
+}
tools/perf/tests/tests.h +1 -1
index ef0f33c6ba23..c85a2c08e407 100644
@@ -123,6 +123,7 @@ const char *test__pfm_subtest_get_desc(int subtest);
 int test__pfm_subtest_get_nr(void);
 int test__parse_metric(struct test *test, int subtest);
 int test__pe_file_parsing(struct test *test, int subtest);
+int test__expand_cgroup_events(struct test *test, int subtest);
 
 bool test__bp_signal_is_supported(void);
 bool test__bp_account_is_supported(void);
--

2.28.0.681.g6f77f65b4e-goog

author maintainer
#9 lore raw

Re: [PATCH 5/5] perf test: Add expand cgroup event test

Quoted 24 lines · Ian Rogers
Quoted 22 lines · Namhyung Kim

It'll expand given events for cgroups A, B and C.

  $ ./perf test -v expansion
  69: Event expansion for cgroups                      :
  --- start ---
  test child forked, pid 983140
  metric expr 1 / IPC for CPI
  metric expr instructions / cycles for IPC
  found event instructions
  found event cycles
  adding {instructions,cycles}:W
  copying metric event for cgroup 'A': instructions (idx=0)
  copying metric event for cgroup 'B': instructions (idx=0)
  copying metric event for cgroup 'C': instructions (idx=0)
  test child finished with 0
  ---- end ----
  Event expansion for cgroups: Ok

---

[SNIP]

Quoted 1 line

Should this be #ifdef HAVE_LIBPFM ?

Do you mean the below function?
Actually I thought about it and ended up not using it. Please see below..

Quoted 18 lines
Quoted 18 lines
tools/perf/tests/expand-cgroup.c new file +17 -0
+static int expand_libpfm_events(void)
+{
+       int ret;
+       struct evlist *evlist;
+       struct rblist metric_events;
+       const char event_str[] = "UNHALTED_CORE_CYCLES";
+       struct option opt = {
+               .value = &evlist,
+       };
+
+       symbol_conf.event_group = true;
+
+       evlist = evlist__new();
+       TEST_ASSERT_VAL("failed to get evlist", evlist);
+
+       ret = parse_libpfm_events_option(&opt, event_str, 0);
+       if (ret < 0) {
Quoted 8 lines

tools/perf/tests/expand-cgroup.c line 167

Quoted 8 lines
tools/perf/tests/expand-cgroup.c new file +8 -0
+               pr_debug("failed to parse libpfm event '%s', err %d\n",
+                        event_str, ret);
+               goto out;
+       }
+       if (perf_evlist__empty(evlist)) {
+               pr_debug("libpfm was not enabled\n");
+               goto out;
+       }

That's handled here. The parse_libpfm_events_option() will return 0 if HAVE_LIBPFM is not defined so evlist will be empty.

Thanks
Namhyung

Quoted 8 lines
Quoted 8 lines
tools/perf/tests/expand-cgroup.c new file +8 -0
+
+       rblist__init(&metric_events);
+       ret = test_expand_events(evlist, &metric_events);
+out:
+       evlist__delete(evlist);
+       return ret;
+}
+