Skip to contentSkip to conversation

Restructure perf list and add json output

PATCH Superseded Ian Rogers 4 participants 24 messages Nov 14, 2022 perf events

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Ian Rogers

author reviewer
#0 lore raw

cover Restructure perf list and add json output

Restructure perf list so that it uses callbacks to print events and metrics. Use the callbacks to implement json output. In the process add documentation to pmu.h, avoid some sorting of events, fix some command line and output bugs.

Ian Rogers (9):
perf pmu: Add documentation
tools lib api fs tracing_path: Add scandir alphasort perf tracepoint: Sort events in iterator perf list: Generalize limiting to a PMU name perf list: Simplify cache event printing perf list: Simplify symbol event printing perf pmu: Restructure print_pmu_events
perf list: Reorganize to use callbacks
perf list: Add json output option

 tools/lib/api/fs/tracing_path.c        |  16 +
 tools/lib/api/fs/tracing_path.h        |   1 +
 tools/perf/Documentation/perf-list.txt |  10 +-
 tools/perf/builtin-list.c              | 503 +++++++++++++++++---
 tools/perf/util/metricgroup.c          | 238 +++-------
 tools/perf/util/metricgroup.h          |   4 +-
 tools/perf/util/pmu.c                  | 277 +++++------
 tools/perf/util/pmu.h                  | 110 ++++-
 tools/perf/util/print-events.c         | 630 ++++++++++---------------
 tools/perf/util/print-events.h         |  40 +-
 10 files changed, 1034 insertions(+), 795 deletions(-)
Signature · 1 line
2.38.1.431.g37b22c650d-goog
author reviewer
#1 lore raw

PATCH 1/9 perf pmu: Add documentation

Add documentation to struct perf_pmu and the associated structs of perf_pmu_alias and perf_pmu_format.

---
 tools/perf/util/pmu.c |  14 ++++++
 tools/perf/util/pmu.h | 105 +++++++++++++++++++++++++++++++++++++++---
 2 files changed, 113 insertions(+), 6 deletions(-)
tools/perf/util/pmu.c +14 -0
index 6a86e6af0903..a8f9f47c6ed9 100644
@@ -31,10 +31,24 @@
 
 struct perf_pmu perf_pmu__fake;
 
+/**
+ * Values from a format file read from <sysfs>/devices/cpu/format/ held in
+ * struct perf_pmu. For example, the contents of
+ * <sysfs>/devices/cpu/format/event may be "config:0-7" and will be represented
+ * here as name="event", value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will
+ * be set.
+ */
 struct perf_pmu_format {
+	/** The modifier/file name. */
 	char *name;
+	/**
+	 * Which config value the format relates to. Supported values are from
+	 * PERF_PMU_FORMAT_VALUE_CONFIG to PERF_PMU_FORMAT_VALUE_CONFIG_END.
+	 */
 	int value;
+	/** Which config bits are set by this format value. */
 	DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
+	/** Element on list within struct perf_pmu. */
 	struct list_head list;
 };
 
tools/perf/util/pmu.h +99 -6

150 lines not on this page · raw message

Signature · 1 line
2.38.1.431.g37b22c650d-goog
reviewer
#2 lore raw

Re: [PATCH v1 1/9] perf pmu: Add documentation

Quoted 4 lines · Ian Rogers

Add documentation to struct perf_pmu and the associated structs of perf_pmu_alias and perf_pmu_format.

Should this be kernel-doc format?

$ ./scripts/kernel-doc -man tools/perf/util/pmu.* > /tmp/manout
tools/perf/util/pmu.c:35: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Values from a format file read from <sysfs>/devices/cpu/format/ held in
tools/perf/util/pmu.c:1: warning: no structured comments found
tools/perf/util/pmu.h:140: warning: cannot understand function prototype: 'struct perf_pmu_alias '
tools/perf/util/pmu.h:1: warning: no structured comments found
tools/perf/util/pmu.l:1: warning: no structured comments found
tools/perf/util/pmu.o:1: warning: no structured comments found
tools/perf/util/pmu.y:1: warning: no structured comments found
$ man -l /tmp/manout | cat
$
Quoted 190 lines
---
 tools/perf/util/pmu.c |  14 ++++++
 tools/perf/util/pmu.h | 105 +++++++++++++++++++++++++++++++++++++++---
 2 files changed, 113 insertions(+), 6 deletions(-)
tools/perf/util/pmu.c +14 -0
index 6a86e6af0903..a8f9f47c6ed9 100644
@@ -31,10 +31,24 @@
 
 struct perf_pmu perf_pmu__fake;
 
+/**
+ * Values from a format file read from <sysfs>/devices/cpu/format/ held in
+ * struct perf_pmu. For example, the contents of
+ * <sysfs>/devices/cpu/format/event may be "config:0-7" and will be represented
+ * here as name="event", value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will
+ * be set.
+ */
 struct perf_pmu_format {
+	/** The modifier/file name. */
 	char *name;
+	/**
+	 * Which config value the format relates to. Supported values are from
+	 * PERF_PMU_FORMAT_VALUE_CONFIG to PERF_PMU_FORMAT_VALUE_CONFIG_END.
+	 */
 	int value;
+	/** Which config bits are set by this format value. */
 	DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
+	/** Element on list within struct perf_pmu. */
 	struct list_head list;
 };
 
tools/perf/util/pmu.h +99 -6
index 68e15c38ae71..29571c0f9d15 100644
@@ -34,30 +34,91 @@ struct perf_pmu_caps {
 };
 
 struct perf_pmu {
+	/** The name of the PMU such as "cpu". */
 	char *name;
+	/**
+	 * Optional alternate name for the PMU determined in architecture
+	 * specific code.
+	 */
 	char *alias_name;
+	/**
+	 * Optional PMU identifier read from
+	 * <sysfs>/bus/event_source/devices/<name>/identifier.
+	 */
 	char *id;
+	/**
+	 * Perf event attributed type value, read from
+	 * <sysfs>/bus/event_source/devices/<name>/type.
+	 */
 	__u32 type;
+	/**
+	 * Can the PMU name be selected as if it were an event?
+	 */
 	bool selectable;
+	/**
+	 * Is the PMU not within the CPU core? Determined by the presence of
+	 * <sysfs>/bus/event_source/devices/<name>/cpumask.
+	 */
 	bool is_uncore;
+	/** Is the PMU name either cpu_core or cpu_atom. */
 	bool is_hybrid;
+	/**
+	 * Are events auxiliary events? Determined in architecture specific
+	 * code.
+	 */
 	bool auxtrace;
+	/**
+	 * Number of levels of :ppp precision supported by the PMU, read from
+	 * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.
+	 */
 	int max_precise;
+	/**
+	 * Optional default perf_event_attr determined in architecture specific
+	 * code.
+	 */
 	struct perf_event_attr *default_config;
+	/**
+	 * Empty or the contents of either of:
+	 * <sysfs>/bus/event_source/devices/<name>/cpumask.
+	 * <sysfs>/bus/event_source/devices/<cpu>/cpus.
+	 */
 	struct perf_cpu_map *cpus;
-	struct list_head format;  /* HEAD struct perf_pmu_format -> list */
-	struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
+	/**
+	 * Holds the contents of files read from
+	 * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify
+	 * which event parameter changes what config, config1 or config2 bits.
+	 */
+	struct list_head format;
+	/**
+	 * List of struct perf_pmu_alias. Each alias corresponds to an event
+	 * read from <sysfs>/bus/event_source/devices/<name>/events/ or from
+	 * json events in pmu-events.c.
+	 */
+	struct list_head aliases;
+	/** Has the list caps been initialized? */
 	bool caps_initialized;
+	/** The length of the list caps. */
 	u32 nr_caps;
-	struct list_head caps;    /* HEAD struct perf_pmu_caps -> list */
-	struct list_head list;    /* ELEM */
+	/**
+	 * Holds the contents of files read from
+	 * <sysfs>/bus/event_source/devices/<name>/caps/. The contents are pairs
+	 * of the filename with the value of its contents, for example,
+	 * max_precise (see above) may have a value of 3.
+	 */
+	struct list_head caps;
+	/** Element on pmus list in pmu.c. */
+	struct list_head list;
+	/** Element on perf_pmu__hybrid_pmus. */
 	struct list_head hybrid_list;
 
+	/** Features to inhibit when events on this PMU are opened. */
 	struct {
+		/** Disables perf_event_attr exclude_guest and exclude_host. */
 		bool exclude_guest;
 	} missing_features;
 };
 
+/** A special global PMU used for testing. */
 extern struct perf_pmu perf_pmu__fake;
 
 struct perf_pmu_info {
@@ -71,21 +132,53 @@ struct perf_pmu_info {
 
 #define UNIT_MAX_LEN	31 /* max length for event unit name */
 
+/**
+ * An event either read from sysfs or builtin in pmu-events.c, created by
+ * parsing the pmu-events json files.
+ */
 struct perf_pmu_alias {
 	char *name;
+	/** Optional short description of the event. */
 	char *desc;
+	/** Optional long description. */
 	char *long_desc;
+	/**
+	 * Optional topic such as cache or pipeline, particularly for json
+	 * events.
+	 */
 	char *topic;
+	/** Comma separated parameter list. */
 	char *str;
-	struct list_head terms; /* HEAD struct parse_events_term -> list */
-	struct list_head list;  /* ELEM */
+	/** Owned list of the original parsed parameters. */
+	struct list_head terms;
+	/** List element of struct perf_pmu aliases. */
+	struct list_head list;
+	/** Units for the event, such as bytes or cache lines. */
 	char unit[UNIT_MAX_LEN+1];
+	/** Value to scale read counter values by. */
 	double scale;
+	/**
+	 * Does the file
+	 * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or
+	 * equivalent json value exist and have the value 1.
+	 */
 	bool per_pkg;
+	/**
+	 * Does the file
+	 * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot
+	 * exist and have the value 1.
+	 */
 	bool snapshot;
+	/** Is the event hidden and so not shown in perf list by default. */
 	bool deprecated;
+	/**
+	 * A metric expression associated with an event. Doing this makes little
+	 * sense due to scale and unit applying to both.
+	 */
 	char *metric_expr;
+	/** A name for the metric. unit applying to both. */
 	char *metric_name;
+	/** The name copied from struct perf_pmu. */
 	char *pmu_name;
 };
 
author reviewer
#3 lore raw

Re: [PATCH v1 1/9] perf pmu: Add documentation

Quoted 9 lines · Adrian Hunter
Quoted 4 lines · Ian Rogers

Add documentation to struct perf_pmu and the associated structs of perf_pmu_alias and perf_pmu_format.

Should this be kernel-doc format?

Quoted 11 lines
$ ./scripts/kernel-doc -man tools/perf/util/pmu.* > /tmp/manout
tools/perf/util/pmu.c:35: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Values from a format file read from <sysfs>/devices/cpu/format/ held in
tools/perf/util/pmu.c:1: warning: no structured comments found
tools/perf/util/pmu.h:140: warning: cannot understand function prototype: 'struct perf_pmu_alias '
tools/perf/util/pmu.h:1: warning: no structured comments found
tools/perf/util/pmu.l:1: warning: no structured comments found
tools/perf/util/pmu.o:1: warning: no structured comments found
tools/perf/util/pmu.y:1: warning: no structured comments found
$ man -l /tmp/manout | cat
$

Thanks, I'll take a look into fixing this.

Ian

Quoted 191 lines
Quoted 190 lines
---
 tools/perf/util/pmu.c |  14 ++++++
 tools/perf/util/pmu.h | 105 +++++++++++++++++++++++++++++++++++++++---
 2 files changed, 113 insertions(+), 6 deletions(-)
tools/perf/util/pmu.c +14 -0
index 6a86e6af0903..a8f9f47c6ed9 100644
@@ -31,10 +31,24 @@
 
 struct perf_pmu perf_pmu__fake;
 
+/**
+ * Values from a format file read from <sysfs>/devices/cpu/format/ held in
+ * struct perf_pmu. For example, the contents of
+ * <sysfs>/devices/cpu/format/event may be "config:0-7" and will be represented
+ * here as name="event", value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will
+ * be set.
+ */
 struct perf_pmu_format {
+     /** The modifier/file name. */
      char *name;
+     /**
+      * Which config value the format relates to. Supported values are from
+      * PERF_PMU_FORMAT_VALUE_CONFIG to PERF_PMU_FORMAT_VALUE_CONFIG_END.
+      */
      int value;
+     /** Which config bits are set by this format value. */
      DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
+     /** Element on list within struct perf_pmu. */
      struct list_head list;
 };
 
tools/perf/util/pmu.h +99 -6
index 68e15c38ae71..29571c0f9d15 100644
@@ -34,30 +34,91 @@ struct perf_pmu_caps {
 };
 
 struct perf_pmu {
+     /** The name of the PMU such as "cpu". */
      char *name;
+     /**
+      * Optional alternate name for the PMU determined in architecture
+      * specific code.
+      */
      char *alias_name;
+     /**
+      * Optional PMU identifier read from
+      * <sysfs>/bus/event_source/devices/<name>/identifier.
+      */
      char *id;
+     /**
+      * Perf event attributed type value, read from
+      * <sysfs>/bus/event_source/devices/<name>/type.
+      */
      __u32 type;
+     /**
+      * Can the PMU name be selected as if it were an event?
+      */
      bool selectable;
+     /**
+      * Is the PMU not within the CPU core? Determined by the presence of
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      */
      bool is_uncore;
+     /** Is the PMU name either cpu_core or cpu_atom. */
      bool is_hybrid;
+     /**
+      * Are events auxiliary events? Determined in architecture specific
+      * code.
+      */
      bool auxtrace;
+     /**
+      * Number of levels of :ppp precision supported by the PMU, read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.
+      */
      int max_precise;
+     /**
+      * Optional default perf_event_attr determined in architecture specific
+      * code.
+      */
      struct perf_event_attr *default_config;
+     /**
+      * Empty or the contents of either of:
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      * <sysfs>/bus/event_source/devices/<cpu>/cpus.
+      */
      struct perf_cpu_map *cpus;
-     struct list_head format;  /* HEAD struct perf_pmu_format -> list */
-     struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify
+      * which event parameter changes what config, config1 or config2 bits.
+      */
+     struct list_head format;
+     /**
+      * List of struct perf_pmu_alias. Each alias corresponds to an event
+      * read from <sysfs>/bus/event_source/devices/<name>/events/ or from
+      * json events in pmu-events.c.
+      */
+     struct list_head aliases;
+     /** Has the list caps been initialized? */
      bool caps_initialized;
+     /** The length of the list caps. */
      u32 nr_caps;
-     struct list_head caps;    /* HEAD struct perf_pmu_caps -> list */
-     struct list_head list;    /* ELEM */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/. The contents are pairs
+      * of the filename with the value of its contents, for example,
+      * max_precise (see above) may have a value of 3.
+      */
+     struct list_head caps;
+     /** Element on pmus list in pmu.c. */
+     struct list_head list;
+     /** Element on perf_pmu__hybrid_pmus. */
      struct list_head hybrid_list;
 
+     /** Features to inhibit when events on this PMU are opened. */
      struct {
+             /** Disables perf_event_attr exclude_guest and exclude_host. */
              bool exclude_guest;
      } missing_features;
 };
 
+/** A special global PMU used for testing. */
 extern struct perf_pmu perf_pmu__fake;
 
 struct perf_pmu_info {
@@ -71,21 +132,53 @@ struct perf_pmu_info {
 
 #define UNIT_MAX_LEN 31 /* max length for event unit name */
 
+/**
+ * An event either read from sysfs or builtin in pmu-events.c, created by
+ * parsing the pmu-events json files.
+ */
 struct perf_pmu_alias {
      char *name;
+     /** Optional short description of the event. */
      char *desc;
+     /** Optional long description. */
      char *long_desc;
+     /**
+      * Optional topic such as cache or pipeline, particularly for json
+      * events.
+      */
      char *topic;
+     /** Comma separated parameter list. */
      char *str;
-     struct list_head terms; /* HEAD struct parse_events_term -> list */
-     struct list_head list;  /* ELEM */
+     /** Owned list of the original parsed parameters. */
+     struct list_head terms;
+     /** List element of struct perf_pmu aliases. */
+     struct list_head list;
+     /** Units for the event, such as bytes or cache lines. */
      char unit[UNIT_MAX_LEN+1];
+     /** Value to scale read counter values by. */
      double scale;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or
+      * equivalent json value exist and have the value 1.
+      */
      bool per_pkg;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot
+      * exist and have the value 1.
+      */
      bool snapshot;
+     /** Is the event hidden and so not shown in perf list by default. */
      bool deprecated;
+     /**
+      * A metric expression associated with an event. Doing this makes little
+      * sense due to scale and unit applying to both.
+      */
      char *metric_expr;
+     /** A name for the metric. unit applying to both. */
      char *metric_name;
+     /** The name copied from struct perf_pmu. */
      char *pmu_name;
 };
 
#4 lore raw

Re: [PATCH v1 1/9] perf pmu: Add documentation

In reply to Ian Rogers
Quoted 63 lines · Ian Rogers

Add documentation to struct perf_pmu and the associated structs of perf_pmu_alias and perf_pmu_format.

---
 tools/perf/util/pmu.c |  14 ++++++
 tools/perf/util/pmu.h | 105 +++++++++++++++++++++++++++++++++++++++---
 2 files changed, 113 insertions(+), 6 deletions(-)
tools/perf/util/pmu.c +14 -0
index 6a86e6af0903..a8f9f47c6ed9 100644
@@ -31,10 +31,24 @@
 
 struct perf_pmu perf_pmu__fake;
 
+/**
+ * Values from a format file read from <sysfs>/devices/cpu/format/ held in
+ * struct perf_pmu. For example, the contents of
+ * <sysfs>/devices/cpu/format/event may be "config:0-7" and will be represented
+ * here as name="event", value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will
+ * be set.
+ */
 struct perf_pmu_format {
+	/** The modifier/file name. */
 	char *name;
+	/**
+	 * Which config value the format relates to. Supported values are from
+	 * PERF_PMU_FORMAT_VALUE_CONFIG to PERF_PMU_FORMAT_VALUE_CONFIG_END.
+	 */
 	int value;
+	/** Which config bits are set by this format value. */
 	DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
+	/** Element on list within struct perf_pmu. */
 	struct list_head list;
 };
 
tools/perf/util/pmu.h +13 -0
index 68e15c38ae71..29571c0f9d15 100644
@@ -34,30 +34,91 @@ struct perf_pmu_caps {
 };
 
 struct perf_pmu {
+	/** The name of the PMU such as "cpu". */
 	char *name;
+	/**
+	 * Optional alternate name for the PMU determined in architecture
+	 * specific code.
+	 */
 	char *alias_name;
+	/**
+	 * Optional PMU identifier read from
+	 * <sysfs>/bus/event_source/devices/<name>/identifier.
+	 */
 	char *id;
+	/**
+	 * Perf event attributed type value, read from
+	 * <sysfs>/bus/event_source/devices/<name>/type.
+	 */
 	__u32 type;

tools/perf/util/pmu.h struct perf_pmu_caps { · line 63

Quoted 10 lines
tools/perf/util/pmu.h +8 -0
+	/**
+	 * Can the PMU name be selected as if it were an event?
+	 */
 	bool selectable;
+	/**
+	 * Is the PMU not within the CPU core? Determined by the presence of
+	 * <sysfs>/bus/event_source/devices/<name>/cpumask.
+	 */
 	bool is_uncore;
+	/** Is the PMU name either cpu_core or cpu_atom. */

I don't think we want to limit the hybrid names only to cpu_core or cpu_atom. Maybe something as below?
/* Is a hybrid CPU PMU, e.g., cpu_core, cpu_atom. */

Thanks,
Kan

Quoted 121 lines
tools/perf/util/pmu.h +78 -6
 	bool is_hybrid;
+	/**
+	 * Are events auxiliary events? Determined in architecture specific
+	 * code.
+	 */
 	bool auxtrace;
+	/**
+	 * Number of levels of :ppp precision supported by the PMU, read from
+	 * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.
+	 */
 	int max_precise;
+	/**
+	 * Optional default perf_event_attr determined in architecture specific
+	 * code.
+	 */
 	struct perf_event_attr *default_config;
+	/**
+	 * Empty or the contents of either of:
+	 * <sysfs>/bus/event_source/devices/<name>/cpumask.
+	 * <sysfs>/bus/event_source/devices/<cpu>/cpus.
+	 */
 	struct perf_cpu_map *cpus;
-	struct list_head format;  /* HEAD struct perf_pmu_format -> list */
-	struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
+	/**
+	 * Holds the contents of files read from
+	 * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify
+	 * which event parameter changes what config, config1 or config2 bits.
+	 */
+	struct list_head format;
+	/**
+	 * List of struct perf_pmu_alias. Each alias corresponds to an event
+	 * read from <sysfs>/bus/event_source/devices/<name>/events/ or from
+	 * json events in pmu-events.c.
+	 */
+	struct list_head aliases;
+	/** Has the list caps been initialized? */
 	bool caps_initialized;
+	/** The length of the list caps. */
 	u32 nr_caps;
-	struct list_head caps;    /* HEAD struct perf_pmu_caps -> list */
-	struct list_head list;    /* ELEM */
+	/**
+	 * Holds the contents of files read from
+	 * <sysfs>/bus/event_source/devices/<name>/caps/. The contents are pairs
+	 * of the filename with the value of its contents, for example,
+	 * max_precise (see above) may have a value of 3.
+	 */
+	struct list_head caps;
+	/** Element on pmus list in pmu.c. */
+	struct list_head list;
+	/** Element on perf_pmu__hybrid_pmus. */
 	struct list_head hybrid_list;
 
+	/** Features to inhibit when events on this PMU are opened. */
 	struct {
+		/** Disables perf_event_attr exclude_guest and exclude_host. */
 		bool exclude_guest;
 	} missing_features;
 };
 
+/** A special global PMU used for testing. */
 extern struct perf_pmu perf_pmu__fake;
 
 struct perf_pmu_info {
@@ -71,21 +132,53 @@ struct perf_pmu_info {
 
 #define UNIT_MAX_LEN	31 /* max length for event unit name */
 
+/**
+ * An event either read from sysfs or builtin in pmu-events.c, created by
+ * parsing the pmu-events json files.
+ */
 struct perf_pmu_alias {
 	char *name;
+	/** Optional short description of the event. */
 	char *desc;
+	/** Optional long description. */
 	char *long_desc;
+	/**
+	 * Optional topic such as cache or pipeline, particularly for json
+	 * events.
+	 */
 	char *topic;
+	/** Comma separated parameter list. */
 	char *str;
-	struct list_head terms; /* HEAD struct parse_events_term -> list */
-	struct list_head list;  /* ELEM */
+	/** Owned list of the original parsed parameters. */
+	struct list_head terms;
+	/** List element of struct perf_pmu aliases. */
+	struct list_head list;
+	/** Units for the event, such as bytes or cache lines. */
 	char unit[UNIT_MAX_LEN+1];
+	/** Value to scale read counter values by. */
 	double scale;
+	/**
+	 * Does the file
+	 * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or
+	 * equivalent json value exist and have the value 1.
+	 */
 	bool per_pkg;
+	/**
+	 * Does the file
+	 * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot
+	 * exist and have the value 1.
+	 */
 	bool snapshot;
+	/** Is the event hidden and so not shown in perf list by default. */
 	bool deprecated;
+	/**
+	 * A metric expression associated with an event. Doing this makes little
+	 * sense due to scale and unit applying to both.
+	 */
 	char *metric_expr;
+	/** A name for the metric. unit applying to both. */
 	char *metric_name;
+	/** The name copied from struct perf_pmu. */
 	char *pmu_name;
 };
 
author reviewer
#5 lore raw

Re: [PATCH v1 1/9] perf pmu: Add documentation

Quoted 73 lines · Kan
Quoted 69 lines · Ian Rogers

Add documentation to struct perf_pmu and the associated structs of perf_pmu_alias and perf_pmu_format.

---
 tools/perf/util/pmu.c |  14 ++++++
 tools/perf/util/pmu.h | 105 +++++++++++++++++++++++++++++++++++++++---
 2 files changed, 113 insertions(+), 6 deletions(-)
tools/perf/util/pmu.c +14 -0
index 6a86e6af0903..a8f9f47c6ed9 100644
@@ -31,10 +31,24 @@
 
 struct perf_pmu perf_pmu__fake;
 
+/**
+ * Values from a format file read from <sysfs>/devices/cpu/format/ held in
+ * struct perf_pmu. For example, the contents of
+ * <sysfs>/devices/cpu/format/event may be "config:0-7" and will be represented
+ * here as name="event", value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will
+ * be set.
+ */
 struct perf_pmu_format {
+     /** The modifier/file name. */
      char *name;
+     /**
+      * Which config value the format relates to. Supported values are from
+      * PERF_PMU_FORMAT_VALUE_CONFIG to PERF_PMU_FORMAT_VALUE_CONFIG_END.
+      */
      int value;
+     /** Which config bits are set by this format value. */
      DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
+     /** Element on list within struct perf_pmu. */
      struct list_head list;
 };
 
tools/perf/util/pmu.h +18 -0
index 68e15c38ae71..29571c0f9d15 100644
@@ -34,30 +34,91 @@ struct perf_pmu_caps {
 };
 
 struct perf_pmu {
+     /** The name of the PMU such as "cpu". */
      char *name;
+     /**
+      * Optional alternate name for the PMU determined in architecture
+      * specific code.
+      */
      char *alias_name;
+     /**
+      * Optional PMU identifier read from
+      * <sysfs>/bus/event_source/devices/<name>/identifier.
+      */
      char *id;
+     /**
+      * Perf event attributed type value, read from
+      * <sysfs>/bus/event_source/devices/<name>/type.
+      */
      __u32 type;
+     /**
+      * Can the PMU name be selected as if it were an event?
+      */
      bool selectable;
+     /**
+      * Is the PMU not within the CPU core? Determined by the presence of
Quoted 8 lines

tools/perf/util/pmu.h struct perf_pmu_caps { · line 63

Quoted 4 lines
tools/perf/util/pmu.h +3 -0
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      */
      bool is_uncore;
+     /** Is the PMU name either cpu_core or cpu_atom. */

I don't think we want to limit the hybrid names only to cpu_core or cpu_atom. Maybe something as below?
/* Is a hybrid CPU PMU, e.g., cpu_core, cpu_atom. */

Currently the hybrid code only works for cpu_core or cpu_atom, a limitation of its implementation. As pointed out in a later patch, this bool isn't being used when it could be and I think we can work to remove it. It would be possible to remove all uses of this with perf_pmu__is_hybrid. As such I think it may be useful to mark the hybrid variables in struct perf_pmu as deprecated while we work to replace their use with more generic just any PMU code.

Thanks,
Ian

Quoted 124 lines

Thanks,
Kan

Quoted 121 lines
tools/perf/util/pmu.h +78 -6
      bool is_hybrid;
+     /**
+      * Are events auxiliary events? Determined in architecture specific
+      * code.
+      */
      bool auxtrace;
+     /**
+      * Number of levels of :ppp precision supported by the PMU, read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.
+      */
      int max_precise;
+     /**
+      * Optional default perf_event_attr determined in architecture specific
+      * code.
+      */
      struct perf_event_attr *default_config;
+     /**
+      * Empty or the contents of either of:
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      * <sysfs>/bus/event_source/devices/<cpu>/cpus.
+      */
      struct perf_cpu_map *cpus;
-     struct list_head format;  /* HEAD struct perf_pmu_format -> list */
-     struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify
+      * which event parameter changes what config, config1 or config2 bits.
+      */
+     struct list_head format;
+     /**
+      * List of struct perf_pmu_alias. Each alias corresponds to an event
+      * read from <sysfs>/bus/event_source/devices/<name>/events/ or from
+      * json events in pmu-events.c.
+      */
+     struct list_head aliases;
+     /** Has the list caps been initialized? */
      bool caps_initialized;
+     /** The length of the list caps. */
      u32 nr_caps;
-     struct list_head caps;    /* HEAD struct perf_pmu_caps -> list */
-     struct list_head list;    /* ELEM */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/. The contents are pairs
+      * of the filename with the value of its contents, for example,
+      * max_precise (see above) may have a value of 3.
+      */
+     struct list_head caps;
+     /** Element on pmus list in pmu.c. */
+     struct list_head list;
+     /** Element on perf_pmu__hybrid_pmus. */
      struct list_head hybrid_list;
 
+     /** Features to inhibit when events on this PMU are opened. */
      struct {
+             /** Disables perf_event_attr exclude_guest and exclude_host. */
              bool exclude_guest;
      } missing_features;
 };
 
+/** A special global PMU used for testing. */
 extern struct perf_pmu perf_pmu__fake;
 
 struct perf_pmu_info {
@@ -71,21 +132,53 @@ struct perf_pmu_info {
 
 #define UNIT_MAX_LEN 31 /* max length for event unit name */
 
+/**
+ * An event either read from sysfs or builtin in pmu-events.c, created by
+ * parsing the pmu-events json files.
+ */
 struct perf_pmu_alias {
      char *name;
+     /** Optional short description of the event. */
      char *desc;
+     /** Optional long description. */
      char *long_desc;
+     /**
+      * Optional topic such as cache or pipeline, particularly for json
+      * events.
+      */
      char *topic;
+     /** Comma separated parameter list. */
      char *str;
-     struct list_head terms; /* HEAD struct parse_events_term -> list */
-     struct list_head list;  /* ELEM */
+     /** Owned list of the original parsed parameters. */
+     struct list_head terms;
+     /** List element of struct perf_pmu aliases. */
+     struct list_head list;
+     /** Units for the event, such as bytes or cache lines. */
      char unit[UNIT_MAX_LEN+1];
+     /** Value to scale read counter values by. */
      double scale;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or
+      * equivalent json value exist and have the value 1.
+      */
      bool per_pkg;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot
+      * exist and have the value 1.
+      */
      bool snapshot;
+     /** Is the event hidden and so not shown in perf list by default. */
      bool deprecated;
+     /**
+      * A metric expression associated with an event. Doing this makes little
+      * sense due to scale and unit applying to both.
+      */
      char *metric_expr;
+     /** A name for the metric. unit applying to both. */
      char *metric_name;
+     /** The name copied from struct perf_pmu. */
      char *pmu_name;
 };
 
#6 lore raw

Re: [PATCH v1 1/9] perf pmu: Add documentation

Quoted 83 lines · Ian Rogers
Quoted 73 lines · Kan
Quoted 69 lines · Ian Rogers

Add documentation to struct perf_pmu and the associated structs of perf_pmu_alias and perf_pmu_format.

---
 tools/perf/util/pmu.c |  14 ++++++
 tools/perf/util/pmu.h | 105 +++++++++++++++++++++++++++++++++++++++---
 2 files changed, 113 insertions(+), 6 deletions(-)
tools/perf/util/pmu.c +14 -0
index 6a86e6af0903..a8f9f47c6ed9 100644
@@ -31,10 +31,24 @@
 
 struct perf_pmu perf_pmu__fake;
 
+/**
+ * Values from a format file read from <sysfs>/devices/cpu/format/ held in
+ * struct perf_pmu. For example, the contents of
+ * <sysfs>/devices/cpu/format/event may be "config:0-7" and will be represented
+ * here as name="event", value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will
+ * be set.
+ */
 struct perf_pmu_format {
+     /** The modifier/file name. */
      char *name;
+     /**
+      * Which config value the format relates to. Supported values are from
+      * PERF_PMU_FORMAT_VALUE_CONFIG to PERF_PMU_FORMAT_VALUE_CONFIG_END.
+      */
      int value;
+     /** Which config bits are set by this format value. */
      DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
+     /** Element on list within struct perf_pmu. */
      struct list_head list;
 };
 
tools/perf/util/pmu.h +18 -0
index 68e15c38ae71..29571c0f9d15 100644
@@ -34,30 +34,91 @@ struct perf_pmu_caps {
 };
 
 struct perf_pmu {
+     /** The name of the PMU such as "cpu". */
      char *name;
+     /**
+      * Optional alternate name for the PMU determined in architecture
+      * specific code.
+      */
      char *alias_name;
+     /**
+      * Optional PMU identifier read from
+      * <sysfs>/bus/event_source/devices/<name>/identifier.
+      */
      char *id;
+     /**
+      * Perf event attributed type value, read from
+      * <sysfs>/bus/event_source/devices/<name>/type.
+      */
      __u32 type;
+     /**
+      * Can the PMU name be selected as if it were an event?
+      */
      bool selectable;
+     /**
+      * Is the PMU not within the CPU core? Determined by the presence of
Quoted 8 lines

tools/perf/util/pmu.h struct perf_pmu_caps { · line 63

Quoted 4 lines
tools/perf/util/pmu.h +3 -0
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      */
      bool is_uncore;
+     /** Is the PMU name either cpu_core or cpu_atom. */

I don't think we want to limit the hybrid names only to cpu_core or cpu_atom. Maybe something as below?
/* Is a hybrid CPU PMU, e.g., cpu_core, cpu_atom. */

Quoted 2 lines

Currently the hybrid code only works for cpu_core or cpu_atom, a limitation of its implementation.

I don't think so. See perf_pmu__hybrid_mounted(). If a PMU is named as "cpu_", we treat it as a hybrid CPU PMU. The cpu_core or cpu_atom should only be hard coded to specially handle some model-specific cases, e.g., mem-loads-aux event.

Thanks,
Kan

Quoted 134 lines

As pointed out in a later patch,
this bool isn't being used when it could be and I think we can work to remove it. It would be possible to remove all uses of this with perf_pmu__is_hybrid. As such I think it may be useful to mark the hybrid variables in struct perf_pmu as deprecated while we work to replace their use with more generic just any PMU code.

Thanks,
Ian

Quoted 124 lines

Thanks,
Kan

Quoted 121 lines
tools/perf/util/pmu.h +78 -6
      bool is_hybrid;
+     /**
+      * Are events auxiliary events? Determined in architecture specific
+      * code.
+      */
      bool auxtrace;
+     /**
+      * Number of levels of :ppp precision supported by the PMU, read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.
+      */
      int max_precise;
+     /**
+      * Optional default perf_event_attr determined in architecture specific
+      * code.
+      */
      struct perf_event_attr *default_config;
+     /**
+      * Empty or the contents of either of:
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      * <sysfs>/bus/event_source/devices/<cpu>/cpus.
+      */
      struct perf_cpu_map *cpus;
-     struct list_head format;  /* HEAD struct perf_pmu_format -> list */
-     struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify
+      * which event parameter changes what config, config1 or config2 bits.
+      */
+     struct list_head format;
+     /**
+      * List of struct perf_pmu_alias. Each alias corresponds to an event
+      * read from <sysfs>/bus/event_source/devices/<name>/events/ or from
+      * json events in pmu-events.c.
+      */
+     struct list_head aliases;
+     /** Has the list caps been initialized? */
      bool caps_initialized;
+     /** The length of the list caps. */
      u32 nr_caps;
-     struct list_head caps;    /* HEAD struct perf_pmu_caps -> list */
-     struct list_head list;    /* ELEM */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/. The contents are pairs
+      * of the filename with the value of its contents, for example,
+      * max_precise (see above) may have a value of 3.
+      */
+     struct list_head caps;
+     /** Element on pmus list in pmu.c. */
+     struct list_head list;
+     /** Element on perf_pmu__hybrid_pmus. */
      struct list_head hybrid_list;
 
+     /** Features to inhibit when events on this PMU are opened. */
      struct {
+             /** Disables perf_event_attr exclude_guest and exclude_host. */
              bool exclude_guest;
      } missing_features;
 };
 
+/** A special global PMU used for testing. */
 extern struct perf_pmu perf_pmu__fake;
 
 struct perf_pmu_info {
@@ -71,21 +132,53 @@ struct perf_pmu_info {
 
 #define UNIT_MAX_LEN 31 /* max length for event unit name */
 
+/**
+ * An event either read from sysfs or builtin in pmu-events.c, created by
+ * parsing the pmu-events json files.
+ */
 struct perf_pmu_alias {
      char *name;
+     /** Optional short description of the event. */
      char *desc;
+     /** Optional long description. */
      char *long_desc;
+     /**
+      * Optional topic such as cache or pipeline, particularly for json
+      * events.
+      */
      char *topic;
+     /** Comma separated parameter list. */
      char *str;
-     struct list_head terms; /* HEAD struct parse_events_term -> list */
-     struct list_head list;  /* ELEM */
+     /** Owned list of the original parsed parameters. */
+     struct list_head terms;
+     /** List element of struct perf_pmu aliases. */
+     struct list_head list;
+     /** Units for the event, such as bytes or cache lines. */
      char unit[UNIT_MAX_LEN+1];
+     /** Value to scale read counter values by. */
      double scale;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or
+      * equivalent json value exist and have the value 1.
+      */
      bool per_pkg;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot
+      * exist and have the value 1.
+      */
      bool snapshot;
+     /** Is the event hidden and so not shown in perf list by default. */
      bool deprecated;
+     /**
+      * A metric expression associated with an event. Doing this makes little
+      * sense due to scale and unit applying to both.
+      */
      char *metric_expr;
+     /** A name for the metric. unit applying to both. */
      char *metric_name;
+     /** The name copied from struct perf_pmu. */
      char *pmu_name;
 };
 
author reviewer
#7 lore raw

Re: [PATCH v1 1/9] perf pmu: Add documentation

Quoted 87 lines · Kan
Quoted 83 lines · Ian Rogers
Quoted 81 lines · Kan
Quoted 63 lines · Ian Rogers

Add documentation to struct perf_pmu and the associated structs of perf_pmu_alias and perf_pmu_format.

---
 tools/perf/util/pmu.c |  14 ++++++
 tools/perf/util/pmu.h | 105 +++++++++++++++++++++++++++++++++++++++---
 2 files changed, 113 insertions(+), 6 deletions(-)
tools/perf/util/pmu.c +14 -0
index 6a86e6af0903..a8f9f47c6ed9 100644
@@ -31,10 +31,24 @@
 
 struct perf_pmu perf_pmu__fake;
 
+/**
+ * Values from a format file read from <sysfs>/devices/cpu/format/ held in
+ * struct perf_pmu. For example, the contents of
+ * <sysfs>/devices/cpu/format/event may be "config:0-7" and will be represented
+ * here as name="event", value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will
+ * be set.
+ */
 struct perf_pmu_format {
+     /** The modifier/file name. */
      char *name;
+     /**
+      * Which config value the format relates to. Supported values are from
+      * PERF_PMU_FORMAT_VALUE_CONFIG to PERF_PMU_FORMAT_VALUE_CONFIG_END.
+      */
      int value;
+     /** Which config bits are set by this format value. */
      DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
+     /** Element on list within struct perf_pmu. */
      struct list_head list;
 };
 
tools/perf/util/pmu.h +13 -0
index 68e15c38ae71..29571c0f9d15 100644
@@ -34,30 +34,91 @@ struct perf_pmu_caps {
 };
 
 struct perf_pmu {
+     /** The name of the PMU such as "cpu". */
      char *name;
+     /**
+      * Optional alternate name for the PMU determined in architecture
+      * specific code.
+      */
      char *alias_name;
+     /**
+      * Optional PMU identifier read from
+      * <sysfs>/bus/event_source/devices/<name>/identifier.
+      */
      char *id;
+     /**
+      * Perf event attributed type value, read from
+      * <sysfs>/bus/event_source/devices/<name>/type.
+      */
      __u32 type;

tools/perf/util/pmu.h struct perf_pmu_caps { · line 63

Quoted 10 lines
tools/perf/util/pmu.h +8 -0
+     /**
+      * Can the PMU name be selected as if it were an event?
+      */
      bool selectable;
+     /**
+      * Is the PMU not within the CPU core? Determined by the presence of
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      */
      bool is_uncore;
+     /** Is the PMU name either cpu_core or cpu_atom. */

I don't think we want to limit the hybrid names only to cpu_core or cpu_atom. Maybe something as below?
/* Is a hybrid CPU PMU, e.g., cpu_core, cpu_atom. */

Quoted 7 lines
Quoted 2 lines

Currently the hybrid code only works for cpu_core or cpu_atom, a limitation of its implementation.

I don't think so. See perf_pmu__hybrid_mounted(). If a PMU is named as "cpu_", we treat it as a hybrid CPU PMU. The cpu_core or cpu_atom should only be hard coded to specially handle some model-specific cases, e.g., mem-loads-aux event.

Ugh.. Why is a property about something being a CPU named in an Intel specific term for big little? Why wasn't this generalized? Why are CPU PMUs assumed to be prefixed cpu_* .. ? The comment is factually correct, we can hold off deprecating it on the assumption that it'd be renamed to something more appropriate like is_cpu.

Thanks,
Ian

Quoted 137 lines

Thanks,
Kan

Quoted 134 lines

As pointed out in a later patch,
this bool isn't being used when it could be and I think we can work to remove it. It would be possible to remove all uses of this with perf_pmu__is_hybrid. As such I think it may be useful to mark the hybrid variables in struct perf_pmu as deprecated while we work to replace their use with more generic just any PMU code.

Thanks,
Ian

Quoted 124 lines

Thanks,
Kan

Quoted 121 lines
tools/perf/util/pmu.h +78 -6
      bool is_hybrid;
+     /**
+      * Are events auxiliary events? Determined in architecture specific
+      * code.
+      */
      bool auxtrace;
+     /**
+      * Number of levels of :ppp precision supported by the PMU, read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.
+      */
      int max_precise;
+     /**
+      * Optional default perf_event_attr determined in architecture specific
+      * code.
+      */
      struct perf_event_attr *default_config;
+     /**
+      * Empty or the contents of either of:
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      * <sysfs>/bus/event_source/devices/<cpu>/cpus.
+      */
      struct perf_cpu_map *cpus;
-     struct list_head format;  /* HEAD struct perf_pmu_format -> list */
-     struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify
+      * which event parameter changes what config, config1 or config2 bits.
+      */
+     struct list_head format;
+     /**
+      * List of struct perf_pmu_alias. Each alias corresponds to an event
+      * read from <sysfs>/bus/event_source/devices/<name>/events/ or from
+      * json events in pmu-events.c.
+      */
+     struct list_head aliases;
+     /** Has the list caps been initialized? */
      bool caps_initialized;
+     /** The length of the list caps. */
      u32 nr_caps;
-     struct list_head caps;    /* HEAD struct perf_pmu_caps -> list */
-     struct list_head list;    /* ELEM */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/. The contents are pairs
+      * of the filename with the value of its contents, for example,
+      * max_precise (see above) may have a value of 3.
+      */
+     struct list_head caps;
+     /** Element on pmus list in pmu.c. */
+     struct list_head list;
+     /** Element on perf_pmu__hybrid_pmus. */
      struct list_head hybrid_list;
 
+     /** Features to inhibit when events on this PMU are opened. */
      struct {
+             /** Disables perf_event_attr exclude_guest and exclude_host. */
              bool exclude_guest;
      } missing_features;
 };
 
+/** A special global PMU used for testing. */
 extern struct perf_pmu perf_pmu__fake;
 
 struct perf_pmu_info {
@@ -71,21 +132,53 @@ struct perf_pmu_info {
 
 #define UNIT_MAX_LEN 31 /* max length for event unit name */
 
+/**
+ * An event either read from sysfs or builtin in pmu-events.c, created by
+ * parsing the pmu-events json files.
+ */
 struct perf_pmu_alias {
      char *name;
+     /** Optional short description of the event. */
      char *desc;
+     /** Optional long description. */
      char *long_desc;
+     /**
+      * Optional topic such as cache or pipeline, particularly for json
+      * events.
+      */
      char *topic;
+     /** Comma separated parameter list. */
      char *str;
-     struct list_head terms; /* HEAD struct parse_events_term -> list */
-     struct list_head list;  /* ELEM */
+     /** Owned list of the original parsed parameters. */
+     struct list_head terms;
+     /** List element of struct perf_pmu aliases. */
+     struct list_head list;
+     /** Units for the event, such as bytes or cache lines. */
      char unit[UNIT_MAX_LEN+1];
+     /** Value to scale read counter values by. */
      double scale;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or
+      * equivalent json value exist and have the value 1.
+      */
      bool per_pkg;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot
+      * exist and have the value 1.
+      */
      bool snapshot;
+     /** Is the event hidden and so not shown in perf list by default. */
      bool deprecated;
+     /**
+      * A metric expression associated with an event. Doing this makes little
+      * sense due to scale and unit applying to both.
+      */
      char *metric_expr;
+     /** A name for the metric. unit applying to both. */
      char *metric_name;
+     /** The name copied from struct perf_pmu. */
      char *pmu_name;
 };
 
#8 lore raw

Re: [PATCH v1 1/9] perf pmu: Add documentation

Quoted 96 lines · Ian Rogers
Quoted 87 lines · Kan
Quoted 83 lines · Ian Rogers
Quoted 81 lines · Kan
Quoted 63 lines · Ian Rogers

Add documentation to struct perf_pmu and the associated structs of perf_pmu_alias and perf_pmu_format.

---
 tools/perf/util/pmu.c |  14 ++++++
 tools/perf/util/pmu.h | 105 +++++++++++++++++++++++++++++++++++++++---
 2 files changed, 113 insertions(+), 6 deletions(-)
tools/perf/util/pmu.c +14 -0
index 6a86e6af0903..a8f9f47c6ed9 100644
@@ -31,10 +31,24 @@
 
 struct perf_pmu perf_pmu__fake;
 
+/**
+ * Values from a format file read from <sysfs>/devices/cpu/format/ held in
+ * struct perf_pmu. For example, the contents of
+ * <sysfs>/devices/cpu/format/event may be "config:0-7" and will be represented
+ * here as name="event", value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will
+ * be set.
+ */
 struct perf_pmu_format {
+     /** The modifier/file name. */
      char *name;
+     /**
+      * Which config value the format relates to. Supported values are from
+      * PERF_PMU_FORMAT_VALUE_CONFIG to PERF_PMU_FORMAT_VALUE_CONFIG_END.
+      */
      int value;
+     /** Which config bits are set by this format value. */
      DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
+     /** Element on list within struct perf_pmu. */
      struct list_head list;
 };
 
tools/perf/util/pmu.h +13 -0
index 68e15c38ae71..29571c0f9d15 100644
@@ -34,30 +34,91 @@ struct perf_pmu_caps {
 };
 
 struct perf_pmu {
+     /** The name of the PMU such as "cpu". */
      char *name;
+     /**
+      * Optional alternate name for the PMU determined in architecture
+      * specific code.
+      */
      char *alias_name;
+     /**
+      * Optional PMU identifier read from
+      * <sysfs>/bus/event_source/devices/<name>/identifier.
+      */
      char *id;
+     /**
+      * Perf event attributed type value, read from
+      * <sysfs>/bus/event_source/devices/<name>/type.
+      */
      __u32 type;

tools/perf/util/pmu.h struct perf_pmu_caps { · line 63

Quoted 10 lines
tools/perf/util/pmu.h +8 -0
+     /**
+      * Can the PMU name be selected as if it were an event?
+      */
      bool selectable;
+     /**
+      * Is the PMU not within the CPU core? Determined by the presence of
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      */
      bool is_uncore;
+     /** Is the PMU name either cpu_core or cpu_atom. */

I don't think we want to limit the hybrid names only to cpu_core or cpu_atom. Maybe something as below?
/* Is a hybrid CPU PMU, e.g., cpu_core, cpu_atom. */

Quoted 7 lines
Quoted 2 lines

Currently the hybrid code only works for cpu_core or cpu_atom, a limitation of its implementation.

I don't think so. See perf_pmu__hybrid_mounted(). If a PMU is named as "cpu_", we treat it as a hybrid CPU PMU. The cpu_core or cpu_atom should only be hard coded to specially handle some model-specific cases, e.g., mem-loads-aux event.

Quoted 5 lines

Ugh.. Why is a property about something being a CPU named in an Intel specific term for big little? Why wasn't this generalized? Why are CPU PMUs assumed to be prefixed cpu_* .. ? The comment is factually correct, we can hold off deprecating it on the assumption that it'd be renamed to something more appropriate like is_cpu.

Does any code really use the pmu->is_hybrid?
From what I read, it's only used in the pmu_lookup(), where it's assigned. It looks like we don't need it in the struct perf_pmu. If so, let's remove it completely from struct perf_pmu.

Thanks,
Kan

Quoted 141 lines

Thanks,
Ian

Quoted 137 lines

Thanks,
Kan

Quoted 134 lines

As pointed out in a later patch,
this bool isn't being used when it could be and I think we can work to remove it. It would be possible to remove all uses of this with perf_pmu__is_hybrid. As such I think it may be useful to mark the hybrid variables in struct perf_pmu as deprecated while we work to replace their use with more generic just any PMU code.

Thanks,
Ian

Quoted 124 lines

Thanks,
Kan

Quoted 121 lines
tools/perf/util/pmu.h +78 -6
      bool is_hybrid;
+     /**
+      * Are events auxiliary events? Determined in architecture specific
+      * code.
+      */
      bool auxtrace;
+     /**
+      * Number of levels of :ppp precision supported by the PMU, read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.
+      */
      int max_precise;
+     /**
+      * Optional default perf_event_attr determined in architecture specific
+      * code.
+      */
      struct perf_event_attr *default_config;
+     /**
+      * Empty or the contents of either of:
+      * <sysfs>/bus/event_source/devices/<name>/cpumask.
+      * <sysfs>/bus/event_source/devices/<cpu>/cpus.
+      */
      struct perf_cpu_map *cpus;
-     struct list_head format;  /* HEAD struct perf_pmu_format -> list */
-     struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify
+      * which event parameter changes what config, config1 or config2 bits.
+      */
+     struct list_head format;
+     /**
+      * List of struct perf_pmu_alias. Each alias corresponds to an event
+      * read from <sysfs>/bus/event_source/devices/<name>/events/ or from
+      * json events in pmu-events.c.
+      */
+     struct list_head aliases;
+     /** Has the list caps been initialized? */
      bool caps_initialized;
+     /** The length of the list caps. */
      u32 nr_caps;
-     struct list_head caps;    /* HEAD struct perf_pmu_caps -> list */
-     struct list_head list;    /* ELEM */
+     /**
+      * Holds the contents of files read from
+      * <sysfs>/bus/event_source/devices/<name>/caps/. The contents are pairs
+      * of the filename with the value of its contents, for example,
+      * max_precise (see above) may have a value of 3.
+      */
+     struct list_head caps;
+     /** Element on pmus list in pmu.c. */
+     struct list_head list;
+     /** Element on perf_pmu__hybrid_pmus. */
      struct list_head hybrid_list;
 
+     /** Features to inhibit when events on this PMU are opened. */
      struct {
+             /** Disables perf_event_attr exclude_guest and exclude_host. */
              bool exclude_guest;
      } missing_features;
 };
 
+/** A special global PMU used for testing. */
 extern struct perf_pmu perf_pmu__fake;
 
 struct perf_pmu_info {
@@ -71,21 +132,53 @@ struct perf_pmu_info {
 
 #define UNIT_MAX_LEN 31 /* max length for event unit name */
 
+/**
+ * An event either read from sysfs or builtin in pmu-events.c, created by
+ * parsing the pmu-events json files.
+ */
 struct perf_pmu_alias {
      char *name;
+     /** Optional short description of the event. */
      char *desc;
+     /** Optional long description. */
      char *long_desc;
+     /**
+      * Optional topic such as cache or pipeline, particularly for json
+      * events.
+      */
      char *topic;
+     /** Comma separated parameter list. */
      char *str;
-     struct list_head terms; /* HEAD struct parse_events_term -> list */
-     struct list_head list;  /* ELEM */
+     /** Owned list of the original parsed parameters. */
+     struct list_head terms;
+     /** List element of struct perf_pmu aliases. */
+     struct list_head list;
+     /** Units for the event, such as bytes or cache lines. */
      char unit[UNIT_MAX_LEN+1];
+     /** Value to scale read counter values by. */
      double scale;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or
+      * equivalent json value exist and have the value 1.
+      */
      bool per_pkg;
+     /**
+      * Does the file
+      * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot
+      * exist and have the value 1.
+      */
      bool snapshot;
+     /** Is the event hidden and so not shown in perf list by default. */
      bool deprecated;
+     /**
+      * A metric expression associated with an event. Doing this makes little
+      * sense due to scale and unit applying to both.
+      */
      char *metric_expr;
+     /** A name for the metric. unit applying to both. */
      char *metric_name;
+     /** The name copied from struct perf_pmu. */
      char *pmu_name;
 };
 
author reviewer
#9 lore raw

PATCH 2/9 tools lib api fs tracing_path: Add scandir alphasort

In reply to Ian Rogers

tracing_events__opendir allows iteration over files in <debugfs>/tracing/events but with an arbitrary sort order. Add a scandir alternative where the results are alphabetically sorted.

---
 tools/lib/api/fs/tracing_path.c | 16 ++++++++++++++++
 tools/lib/api/fs/tracing_path.h |  1 +
 2 files changed, 17 insertions(+)
tools/lib/api/fs/tracing_path.c +16 -0
index 5afb11b30fca..b8e457c841ab 100644
@@ -113,6 +113,22 @@ DIR *tracing_events__opendir(void)
 	return dir;
 }
 
+int tracing_events__scandir_alphasort(struct dirent ***namelist)
+{
+	char *path = get_tracing_file("events");
+	int ret;
+
+	if (!path) {
+		*namelist = NULL;
+		return 0;
+	}
+
+	ret = scandir(path, namelist, NULL, alphasort);
+	put_events_file(path);
+
+	return ret;
+}
+
 int tracing_path__strerror_open_tp(int err, char *buf, size_t size,
 				   const char *sys, const char *name)
 {
tools/lib/api/fs/tracing_path.h +1 -0
index a19136b086dc..fc6347c11deb 100644
@@ -6,6 +6,7 @@
 #include <dirent.h>
 
 DIR *tracing_events__opendir(void);
+int tracing_events__scandir_alphasort(struct dirent ***namelist);
 
 void tracing_path_set(const char *mountpoint);
 const char *tracing_path_mount(void);
Signature · 1 line
2.38.1.431.g37b22c650d-goog
author reviewer
#10 lore raw

PATCH 3/9 perf tracepoint: Sort events in iterator

In reply to Ian Rogers

In print_tracepoint_events use tracing_events__scandir_alphasort and scandir alphasort so that the subsystem and events are sorted and don't need a secondary qsort. Locally this results in the following change:

...

   ext4:ext4_zero_range                               [Tracepoint event]
-  fib6:fib6_table_lookup                             [Tracepoint event]
   fib:fib_table_lookup                               [Tracepoint event]
+  fib6:fib6_table_lookup                             [Tracepoint event]
   filelock:break_lease_block                         [Tracepoint event]

...

ie fib6 now is after fib and not before it. This is more consistent with how numbers are more generally sorted, such as:

...
syscalls:sys_enter_renameat [Tracepoint event]
syscalls:sys_enter_renameat2 [Tracepoint event]
...

and so an improvement over the qsort approach.

---
 tools/perf/util/print-events.c | 108 +++++++++++----------------------
 1 file changed, 37 insertions(+), 71 deletions(-)
tools/perf/util/print-events.c +37 -71
index c4d5d87fae2f..fefc025bc259 100644
@@ -66,26 +66,21 @@ static int cmp_string(const void *a, const void *b)
 void print_tracepoint_events(const char *subsys_glob,
 			     const char *event_glob, bool name_only)
 {
-	DIR *sys_dir, *evt_dir;
-	struct dirent *sys_dirent, *evt_dirent;
-	char evt_path[MAXPATHLEN];
-	char *dir_path;
-	char **evt_list = NULL;
-	unsigned int evt_i = 0, evt_num = 0;
-	bool evt_num_known = false;
-
-restart:
-	sys_dir = tracing_events__opendir();
-	if (!sys_dir)
-		return;
-
-	if (evt_num_known) {
-		evt_list = zalloc(sizeof(char *) * evt_num);
-		if (!evt_list)
-			goto out_close_sys_dir;
-	}
+	struct dirent **sys_namelist = NULL;
+	bool printed = false;
+	int sys_items = tracing_events__scandir_alphasort(&sys_namelist);
+
+	for (int i = 0; i < sys_items; i++) {
+		struct dirent *sys_dirent = sys_namelist[i];
+		struct dirent **evt_namelist = NULL;
+		char *dir_path;
+		int evt_items;
+
+		if (sys_dirent->d_type != DT_DIR ||
+		    !strcmp(sys_dirent->d_name, ".") ||
+		    !strcmp(sys_dirent->d_name, ".."))
+			continue;
 
-	for_each_subsystem(sys_dir, sys_dirent) {
 		if (subsys_glob != NULL &&
 		    !strglobmatch(sys_dirent->d_name, subsys_glob))
 			continue;
@@ -93,69 +88,40 @@ void print_tracepoint_events(const char *subsys_glob,
 		dir_path = get_events_file(sys_dirent->d_name);
 		if (!dir_path)
 			continue;
-		evt_dir = opendir(dir_path);
-		if (!evt_dir)
-			goto next;
 
-		for_each_event(dir_path, evt_dir, evt_dirent) {
-			if (event_glob != NULL &&
-			    !strglobmatch(evt_dirent->d_name, event_glob))
+		evt_items = scandir(dir_path, &evt_namelist, NULL, alphasort);
+		for (int j = 0; j < evt_items; j++) {
+			struct dirent *evt_dirent = evt_namelist[j];
+			char evt_path[MAXPATHLEN];
+
+			if (evt_dirent->d_type != DT_DIR ||
+			    !strcmp(evt_dirent->d_name, ".") ||
+			    !strcmp(evt_dirent->d_name, ".."))
 				continue;
 
-			if (!evt_num_known) {
-				evt_num++;
+			if (tp_event_has_id(dir_path, evt_dirent) != 0)
+				continue;
+
+			if (event_glob != NULL &&
+			    !strglobmatch(evt_dirent->d_name, event_glob))
 				continue;
-			}
 
 			snprintf(evt_path, MAXPATHLEN, "%s:%s",
 				 sys_dirent->d_name, evt_dirent->d_name);
-
-			evt_list[evt_i] = strdup(evt_path);
-			if (evt_list[evt_i] == NULL) {
-				put_events_file(dir_path);
-				goto out_close_evt_dir;
+			if (name_only)
+				printf("%s ", evt_path);
+			else {
+				printf("  %-50s [%s]\n", evt_path,
+				       event_type_descriptors[PERF_TYPE_TRACEPOINT]);
 			}
-			evt_i++;
+			printed = true;
 		}
-		closedir(evt_dir);
-next:
-		put_events_file(dir_path);
+		free(dir_path);
+		free(evt_namelist);
 	}
-	closedir(sys_dir);
-
-	if (!evt_num_known) {
-		evt_num_known = true;
-		goto restart;
-	}
-	qsort(evt_list, evt_num, sizeof(char *), cmp_string);
-	evt_i = 0;
-	while (evt_i < evt_num) {
-		if (name_only) {
-			printf("%s ", evt_list[evt_i++]);
-			continue;
-		}
-		printf("  %-50s [%s]\n", evt_list[evt_i++],
-				event_type_descriptors[PERF_TYPE_TRACEPOINT]);
-	}
-	if (evt_num && pager_in_use())
+	free(sys_namelist);
+	if (printed && pager_in_use())
 		printf("\n");
-
-out_free:
-	evt_num = evt_i;
-	for (evt_i = 0; evt_i < evt_num; evt_i++)
-		zfree(&evt_list[evt_i]);
-	zfree(&evt_list);
-	return;
-
-out_close_evt_dir:
-	closedir(evt_dir);
-out_close_sys_dir:
-	closedir(sys_dir);
-
-	printf("FATAL: not enough memory to print %s\n",
-			event_type_descriptors[PERF_TYPE_TRACEPOINT]);
-	if (evt_list)
-		goto out_free;
 }
 
 void print_sdt_events(const char *subsys_glob, const char *event_glob,
Signature · 1 line
2.38.1.431.g37b22c650d-goog
author reviewer
#11 lore raw

PATCH 4/9 perf list: Generalize limiting to a PMU name

In reply to Ian Rogers

Deprecate the --cputype option and add a --unit option where '--unit cpu_atom' behaves like '--cputype atom'. The --unit option can be used with arbitrary PMUs, for example:

```
$ perf list --unit msr pmu

List of pre-defined events (to be used in -e or -M):

  msr/aperf/                                         [Kernel PMU event]
  msr/cpu_thermal_margin/                            [Kernel PMU event]
  msr/mperf/                                         [Kernel PMU event]
  msr/pperf/                                         [Kernel PMU event]
  msr/smi/                                           [Kernel PMU event]
  msr/tsc/                                           [Kernel PMU event]
```
---
 tools/perf/Documentation/perf-list.txt |  6 +++---
 tools/perf/builtin-list.c              | 18 ++++++++++++------
 tools/perf/util/metricgroup.c          |  3 ++-
 tools/perf/util/pmu.c                  |  4 +---
 4 files changed, 18 insertions(+), 13 deletions(-)
tools/perf/Documentation/perf-list.txt +3 -3
index 57384a97c04f..44a819af573d 100644
@@ -39,9 +39,9 @@ any extra expressions computed by perf stat.
 --deprecated::
 Print deprecated events. By default the deprecated events are hidden.
 
---cputype::
-Print events applying cpu with this type for hybrid platform
-(e.g. --cputype core or --cputype atom)
+--unit::
+Print PMU events and metrics limited to the specific PMU name.
+(e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom)
 
 [[EVENT_MODIFIERS]]
 EVENT MODIFIERS
tools/perf/builtin-list.c +12 -6
index 58e1ec1654ef..cc84ced6da26 100644
@@ -21,7 +21,6 @@
 
 static bool desc_flag = true;
 static bool details_flag;
-static const char *hybrid_type;
 
 int cmd_list(int argc, const char **argv)
 {
@@ -30,6 +29,8 @@ int cmd_list(int argc, const char **argv)
 	bool long_desc_flag = false;
 	bool deprecated = false;
 	char *pmu_name = NULL;
+	const char *hybrid_name = NULL;
+	const char *unit_name = NULL;
 	struct option list_options[] = {
 		OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
 		OPT_BOOLEAN('d', "desc", &desc_flag,
@@ -40,9 +41,10 @@ int cmd_list(int argc, const char **argv)
 			    "Print information on the perf event names and expressions used internally by events."),
 		OPT_BOOLEAN(0, "deprecated", &deprecated,
 			    "Print deprecated events."),
-		OPT_STRING(0, "cputype", &hybrid_type, "hybrid cpu type",
-			   "Print events applying cpu with this type for hybrid platform "
-			   "(e.g. core or atom)"),
+		OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
+			   "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
+		OPT_STRING(0, "unit", &unit_name, "PMU name",
+			   "Limit PMU or metric printing to the specified PMU."),
 		OPT_INCR(0, "debug", &verbose,
 			     "Enable debugging output"),
 		OPT_END()
@@ -53,6 +55,8 @@ int cmd_list(int argc, const char **argv)
 	};
 
 	set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
+	/* Hide hybrid flag for the more generic 'unit' flag. */
+	set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
 
 	argc = parse_options(argc, argv, list_options, list_usage,
 			     PARSE_OPT_STOP_AT_NON_OPTION);
@@ -62,8 +66,10 @@ int cmd_list(int argc, const char **argv)
 	if (!raw_dump && pager_in_use())
 		printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
 
-	if (hybrid_type) {
-		pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_type);
+	if (unit_name)
+		pmu_name = strdup(unit_name);
+	else if (hybrid_name) {
+		pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_name);
 		if (!pmu_name)
 			pr_warning("WARNING: hybrid cputype is not supported!\n");
 	}
tools/perf/util/metricgroup.c +2 -1
index 4c98ac29ee13..1943fed9b6d9 100644
@@ -556,11 +556,12 @@ static int metricgroup__print_callback(const struct pmu_event *pe,
 				       void *vdata)
 {
 	struct metricgroup_print_data *data = vdata;
+	const char *pmu = pe->pmu ?: "cpu";
 
 	if (!pe->metric_expr)
 		return 0;
 
-	if (data->pmu_name && perf_pmu__is_hybrid(pe->pmu) && strcmp(data->pmu_name, pe->pmu))
+	if (data->pmu_name && strcmp(data->pmu_name, pmu))
 		return 0;
 
 	return metricgroup__print_pmu_event(pe, data->metricgroups, data->filter,
tools/perf/util/pmu.c +1 -3
index a8f9f47c6ed9..9c771f136b81 100644
@@ -1694,10 +1694,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
 	pmu = NULL;
 	j = 0;
 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
-		if (pmu_name && perf_pmu__is_hybrid(pmu->name) &&
-		    strcmp(pmu_name, pmu->name)) {
+		if (pmu_name && pmu->name && strcmp(pmu_name, pmu->name))
 			continue;
-		}
 
 		list_for_each_entry(alias, &pmu->aliases, list) {
 			char *name = alias->desc ? alias->name :
Signature · 1 line
2.38.1.431.g37b22c650d-goog
#12 lore raw

Re: [PATCH v1 4/9] perf list: Generalize limiting to a PMU name

Quoted 122 lines · Ian Rogers

Deprecate the --cputype option and add a --unit option where '--unit cpu_atom' behaves like '--cputype atom'. The --unit option can be used with arbitrary PMUs, for example:

```
$ perf list --unit msr pmu

List of pre-defined events (to be used in -e or -M):

   msr/aperf/                                         [Kernel PMU event]
   msr/cpu_thermal_margin/                            [Kernel PMU event]
   msr/mperf/                                         [Kernel PMU event]
   msr/pperf/                                         [Kernel PMU event]
   msr/smi/                                           [Kernel PMU event]
   msr/tsc/                                           [Kernel PMU event]
```
---
  tools/perf/Documentation/perf-list.txt |  6 +++---
  tools/perf/builtin-list.c              | 18 ++++++++++++------
  tools/perf/util/metricgroup.c          |  3 ++-
  tools/perf/util/pmu.c                  |  4 +---
  4 files changed, 18 insertions(+), 13 deletions(-)
tools/perf/Documentation/perf-list.txt +3 -3
index 57384a97c04f..44a819af573d 100644
@@ -39,9 +39,9 @@ any extra expressions computed by perf stat.
  --deprecated::
  Print deprecated events. By default the deprecated events are hidden.
 
---cputype::
-Print events applying cpu with this type for hybrid platform
-(e.g. --cputype core or --cputype atom)
+--unit::
+Print PMU events and metrics limited to the specific PMU name.
+(e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom)
 
  [[EVENT_MODIFIERS]]
  EVENT MODIFIERS
tools/perf/builtin-list.c +12 -6
index 58e1ec1654ef..cc84ced6da26 100644
@@ -21,7 +21,6 @@
 
  static bool desc_flag = true;
  static bool details_flag;
-static const char *hybrid_type;
 
  int cmd_list(int argc, const char **argv)
  {
@@ -30,6 +29,8 @@ int cmd_list(int argc, const char **argv)
  	bool long_desc_flag = false;
  	bool deprecated = false;
  	char *pmu_name = NULL;
+	const char *hybrid_name = NULL;
+	const char *unit_name = NULL;
  	struct option list_options[] = {
  		OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
  		OPT_BOOLEAN('d', "desc", &desc_flag,
@@ -40,9 +41,10 @@ int cmd_list(int argc, const char **argv)
  			    "Print information on the perf event names and expressions used internally by events."),
  		OPT_BOOLEAN(0, "deprecated", &deprecated,
  			    "Print deprecated events."),
-		OPT_STRING(0, "cputype", &hybrid_type, "hybrid cpu type",
-			   "Print events applying cpu with this type for hybrid platform "
-			   "(e.g. core or atom)"),
+		OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
+			   "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
+		OPT_STRING(0, "unit", &unit_name, "PMU name",
+			   "Limit PMU or metric printing to the specified PMU."),
  		OPT_INCR(0, "debug", &verbose,
  			     "Enable debugging output"),
  		OPT_END()
@@ -53,6 +55,8 @@ int cmd_list(int argc, const char **argv)
  	};
 
  	set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
+	/* Hide hybrid flag for the more generic 'unit' flag. */
+	set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
 
  	argc = parse_options(argc, argv, list_options, list_usage,
  			     PARSE_OPT_STOP_AT_NON_OPTION);
@@ -62,8 +66,10 @@ int cmd_list(int argc, const char **argv)
  	if (!raw_dump && pager_in_use())
  		printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
 
-	if (hybrid_type) {
-		pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_type);
+	if (unit_name)
+		pmu_name = strdup(unit_name);
+	else if (hybrid_name) {
+		pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_name);
  		if (!pmu_name)
  			pr_warning("WARNING: hybrid cputype is not supported!\n");
  	}
tools/perf/util/metricgroup.c +2 -1
index 4c98ac29ee13..1943fed9b6d9 100644
@@ -556,11 +556,12 @@ static int metricgroup__print_callback(const struct pmu_event *pe,
  				       void *vdata)
  {
  	struct metricgroup_print_data *data = vdata;
+	const char *pmu = pe->pmu ?: "cpu";
 
  	if (!pe->metric_expr)
  		return 0;
 
-	if (data->pmu_name && perf_pmu__is_hybrid(pe->pmu) && strcmp(data->pmu_name, pe->pmu))
+	if (data->pmu_name && strcmp(data->pmu_name, pmu))
  		return 0;
 
  	return metricgroup__print_pmu_event(pe, data->metricgroups, data->filter,
tools/perf/util/pmu.c +0 -0
index a8f9f47c6ed9..9c771f136b81 100644

tools/perf/util/pmu.c void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag, · line 1697

Quoted 6 lines
tools/perf/util/pmu.c +1 -2
@@ -1694,10 +1694,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
  	pmu = NULL;
  	j = 0;
  	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
-		if (pmu_name && perf_pmu__is_hybrid(pmu->name) &&
-		    strcmp(pmu_name, pmu->name)) {
+		if (pmu_name && pmu->name && strcmp(pmu_name, pmu->name))

Why remove perf_pmu__is_hybrid check?

Quoted 5 lines
tools/perf/util/pmu.c +0 -1
  			continue;
-		}
 
  		list_for_each_entry(alias, &pmu->aliases, list) {
  			char *name = alias->desc ? alias->name :
Signature · 1 line
Zhengjun Xing
author reviewer
#13 lore raw

Re: [PATCH v1 4/9] perf list: Generalize limiting to a PMU name

Quoted 120 lines · Xing Zhengjun
Quoted 116 lines · Ian Rogers

Deprecate the --cputype option and add a --unit option where '--unit cpu_atom' behaves like '--cputype atom'. The --unit option can be used with arbitrary PMUs, for example:

```
$ perf list --unit msr pmu

List of pre-defined events (to be used in -e or -M):

   msr/aperf/                                         [Kernel PMU event]
   msr/cpu_thermal_margin/                            [Kernel PMU event]
   msr/mperf/                                         [Kernel PMU event]
   msr/pperf/                                         [Kernel PMU event]
   msr/smi/                                           [Kernel PMU event]
   msr/tsc/                                           [Kernel PMU event]
```
---
  tools/perf/Documentation/perf-list.txt |  6 +++---
  tools/perf/builtin-list.c              | 18 ++++++++++++------
  tools/perf/util/metricgroup.c          |  3 ++-
  tools/perf/util/pmu.c                  |  4 +---
  4 files changed, 18 insertions(+), 13 deletions(-)
tools/perf/Documentation/perf-list.txt +3 -3
index 57384a97c04f..44a819af573d 100644
@@ -39,9 +39,9 @@ any extra expressions computed by perf stat.
  --deprecated::
  Print deprecated events. By default the deprecated events are hidden.
 
---cputype::
-Print events applying cpu with this type for hybrid platform
-(e.g. --cputype core or --cputype atom)
+--unit::
+Print PMU events and metrics limited to the specific PMU name.
+(e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom)
 
  [[EVENT_MODIFIERS]]
  EVENT MODIFIERS
tools/perf/builtin-list.c +12 -6
index 58e1ec1654ef..cc84ced6da26 100644
@@ -21,7 +21,6 @@
 
  static bool desc_flag = true;
  static bool details_flag;
-static const char *hybrid_type;
 
  int cmd_list(int argc, const char **argv)
  {
@@ -30,6 +29,8 @@ int cmd_list(int argc, const char **argv)
      bool long_desc_flag = false;
      bool deprecated = false;
      char *pmu_name = NULL;
+     const char *hybrid_name = NULL;
+     const char *unit_name = NULL;
      struct option list_options[] = {
              OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
              OPT_BOOLEAN('d', "desc", &desc_flag,
@@ -40,9 +41,10 @@ int cmd_list(int argc, const char **argv)
                          "Print information on the perf event names and expressions used internally by events."),
              OPT_BOOLEAN(0, "deprecated", &deprecated,
                          "Print deprecated events."),
-             OPT_STRING(0, "cputype", &hybrid_type, "hybrid cpu type",
-                        "Print events applying cpu with this type for hybrid platform "
-                        "(e.g. core or atom)"),
+             OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
+                        "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
+             OPT_STRING(0, "unit", &unit_name, "PMU name",
+                        "Limit PMU or metric printing to the specified PMU."),
              OPT_INCR(0, "debug", &verbose,
                           "Enable debugging output"),
              OPT_END()
@@ -53,6 +55,8 @@ int cmd_list(int argc, const char **argv)
      };
 
      set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
+     /* Hide hybrid flag for the more generic 'unit' flag. */
+     set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
 
      argc = parse_options(argc, argv, list_options, list_usage,
                           PARSE_OPT_STOP_AT_NON_OPTION);
@@ -62,8 +66,10 @@ int cmd_list(int argc, const char **argv)
      if (!raw_dump && pager_in_use())
              printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
 
-     if (hybrid_type) {
-             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_type);
+     if (unit_name)
+             pmu_name = strdup(unit_name);
+     else if (hybrid_name) {
+             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_name);
              if (!pmu_name)
                      pr_warning("WARNING: hybrid cputype is not supported!\n");
      }
tools/perf/util/metricgroup.c +2 -1
index 4c98ac29ee13..1943fed9b6d9 100644
@@ -556,11 +556,12 @@ static int metricgroup__print_callback(const struct pmu_event *pe,
                                     void *vdata)
  {
      struct metricgroup_print_data *data = vdata;
+     const char *pmu = pe->pmu ?: "cpu";
 
      if (!pe->metric_expr)
              return 0;
 
-     if (data->pmu_name && perf_pmu__is_hybrid(pe->pmu) && strcmp(data->pmu_name, pe->pmu))
+     if (data->pmu_name && strcmp(data->pmu_name, pmu))
              return 0;
 
Quoted 14 lines

tools/perf/util/pmu.c void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag, · line 1697

Quoted 12 lines
tools/perf/util/metricgroup.c +0 -0
      return metricgroup__print_pmu_event(pe, data->metricgroups, data->filter,
tools/perf/util/pmu.c +1 -2
index a8f9f47c6ed9..9c771f136b81 100644
@@ -1694,10 +1694,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
      pmu = NULL;
      j = 0;
      while ((pmu = perf_pmu__scan(pmu)) != NULL) {
-             if (pmu_name && perf_pmu__is_hybrid(pmu->name) &&
-                 strcmp(pmu_name, pmu->name)) {
+             if (pmu_name && pmu->name && strcmp(pmu_name, pmu->name))

Why remove perf_pmu__is_hybrid check?

Thanks for checking! If you have the perf_pmu__is_hybrid check then the filter only applies PMUs that are hybrid. Firstly, why have is_hybrid in struct perf_pmu if you use this function that searches a list? Secondly, the point of this change is to make the PMU name filtering a generic feature rather than one limited to specifically PMUs called cpu_core and cpu_atom.

Thanks,
Ian

Quoted 9 lines

tools/perf/util/pmu.c void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag, · line 1701

Quoted 6 lines
tools/perf/util/pmu.c +0 -1
                      continue;
-             }
 
              list_for_each_entry(alias, &pmu->aliases, list) {
                      char *name = alias->desc ? alias->name :

--
Zhengjun Xing

#14 lore raw

Re: [PATCH v1 4/9] perf list: Generalize limiting to a PMU name

In reply to Ian Rogers
Quoted 30 lines · Ian Rogers

Deprecate the --cputype option and add a --unit option where '--unit cpu_atom' behaves like '--cputype atom'. The --unit option can be used with arbitrary PMUs, for example:

```
$ perf list --unit msr pmu

List of pre-defined events (to be used in -e or -M):

  msr/aperf/                                         [Kernel PMU event]
  msr/cpu_thermal_margin/                            [Kernel PMU event]
  msr/mperf/                                         [Kernel PMU event]
  msr/pperf/                                         [Kernel PMU event]
  msr/smi/                                           [Kernel PMU event]
  msr/tsc/                                           [Kernel PMU event]
```
---
 tools/perf/Documentation/perf-list.txt |  6 +++---
 tools/perf/builtin-list.c              | 18 ++++++++++++------
 tools/perf/util/metricgroup.c          |  3 ++-
 tools/perf/util/pmu.c                  |  4 +---
 4 files changed, 18 insertions(+), 13 deletions(-)
tools/perf/Documentation/perf-list.txt +0 -0
index 57384a97c04f..44a819af573d 100644

tools/perf/Documentation/perf-list.txt any extra expressions computed by perf stat. · line 44

Quoted 6 lines
tools/perf/Documentation/perf-list.txt +0 -3
@@ -39,9 +39,9 @@ any extra expressions computed by perf stat.
 --deprecated::
 Print deprecated events. By default the deprecated events are hidden.
 
---cputype::
-Print events applying cpu with this type for hybrid platform
-(e.g. --cputype core or --cputype atom)

The "--cputype" is removed from the documentation, but the code is still available. It sounds weird.

Can we still keep the "--cputype" in the documentation? Just say that it's a deprecated option, please use the --unit cpu_atom instead. I think even better if we can throw a warning and point to --unit when the "--cputype" is used.

Thanks,
Kan

Quoted 97 lines
tools/perf/Documentation/perf-list.txt +3 -0
+--unit::
+Print PMU events and metrics limited to the specific PMU name.
+(e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom)
 
 [[EVENT_MODIFIERS]]
 EVENT MODIFIERS
tools/perf/builtin-list.c +12 -6
index 58e1ec1654ef..cc84ced6da26 100644
@@ -21,7 +21,6 @@
 
 static bool desc_flag = true;
 static bool details_flag;
-static const char *hybrid_type;
 
 int cmd_list(int argc, const char **argv)
 {
@@ -30,6 +29,8 @@ int cmd_list(int argc, const char **argv)
 	bool long_desc_flag = false;
 	bool deprecated = false;
 	char *pmu_name = NULL;
+	const char *hybrid_name = NULL;
+	const char *unit_name = NULL;
 	struct option list_options[] = {
 		OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
 		OPT_BOOLEAN('d', "desc", &desc_flag,
@@ -40,9 +41,10 @@ int cmd_list(int argc, const char **argv)
 			    "Print information on the perf event names and expressions used internally by events."),
 		OPT_BOOLEAN(0, "deprecated", &deprecated,
 			    "Print deprecated events."),
-		OPT_STRING(0, "cputype", &hybrid_type, "hybrid cpu type",
-			   "Print events applying cpu with this type for hybrid platform "
-			   "(e.g. core or atom)"),
+		OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
+			   "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
+		OPT_STRING(0, "unit", &unit_name, "PMU name",
+			   "Limit PMU or metric printing to the specified PMU."),
 		OPT_INCR(0, "debug", &verbose,
 			     "Enable debugging output"),
 		OPT_END()
@@ -53,6 +55,8 @@ int cmd_list(int argc, const char **argv)
 	};
 
 	set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
+	/* Hide hybrid flag for the more generic 'unit' flag. */
+	set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
 
 	argc = parse_options(argc, argv, list_options, list_usage,
 			     PARSE_OPT_STOP_AT_NON_OPTION);
@@ -62,8 +66,10 @@ int cmd_list(int argc, const char **argv)
 	if (!raw_dump && pager_in_use())
 		printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
 
-	if (hybrid_type) {
-		pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_type);
+	if (unit_name)
+		pmu_name = strdup(unit_name);
+	else if (hybrid_name) {
+		pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_name);
 		if (!pmu_name)
 			pr_warning("WARNING: hybrid cputype is not supported!\n");
 	}
tools/perf/util/metricgroup.c +2 -1
index 4c98ac29ee13..1943fed9b6d9 100644
@@ -556,11 +556,12 @@ static int metricgroup__print_callback(const struct pmu_event *pe,
 				       void *vdata)
 {
 	struct metricgroup_print_data *data = vdata;
+	const char *pmu = pe->pmu ?: "cpu";
 
 	if (!pe->metric_expr)
 		return 0;
 
-	if (data->pmu_name && perf_pmu__is_hybrid(pe->pmu) && strcmp(data->pmu_name, pe->pmu))
+	if (data->pmu_name && strcmp(data->pmu_name, pmu))
 		return 0;
 
 	return metricgroup__print_pmu_event(pe, data->metricgroups, data->filter,
tools/perf/util/pmu.c +1 -3
index a8f9f47c6ed9..9c771f136b81 100644
@@ -1694,10 +1694,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
 	pmu = NULL;
 	j = 0;
 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
-		if (pmu_name && perf_pmu__is_hybrid(pmu->name) &&
-		    strcmp(pmu_name, pmu->name)) {
+		if (pmu_name && pmu->name && strcmp(pmu_name, pmu->name))
 			continue;
-		}
 
 		list_for_each_entry(alias, &pmu->aliases, list) {
 			char *name = alias->desc ? alias->name :
author reviewer
#15 lore raw

Re: [PATCH v1 4/9] perf list: Generalize limiting to a PMU name

Quoted 44 lines · Kan
Quoted 30 lines · Ian Rogers

Deprecate the --cputype option and add a --unit option where '--unit cpu_atom' behaves like '--cputype atom'. The --unit option can be used with arbitrary PMUs, for example:

```
$ perf list --unit msr pmu

List of pre-defined events (to be used in -e or -M):

  msr/aperf/                                         [Kernel PMU event]
  msr/cpu_thermal_margin/                            [Kernel PMU event]
  msr/mperf/                                         [Kernel PMU event]
  msr/pperf/                                         [Kernel PMU event]
  msr/smi/                                           [Kernel PMU event]
  msr/tsc/                                           [Kernel PMU event]
```
---
 tools/perf/Documentation/perf-list.txt |  6 +++---
 tools/perf/builtin-list.c              | 18 ++++++++++++------
 tools/perf/util/metricgroup.c          |  3 ++-
 tools/perf/util/pmu.c                  |  4 +---
 4 files changed, 18 insertions(+), 13 deletions(-)
tools/perf/Documentation/perf-list.txt +0 -0
index 57384a97c04f..44a819af573d 100644

tools/perf/Documentation/perf-list.txt any extra expressions computed by perf stat. · line 44

Quoted 6 lines
tools/perf/Documentation/perf-list.txt +0 -3
@@ -39,9 +39,9 @@ any extra expressions computed by perf stat.
 --deprecated::
 Print deprecated events. By default the deprecated events are hidden.
 
---cputype::
-Print events applying cpu with this type for hybrid platform
-(e.g. --cputype core or --cputype atom)

The "--cputype" is removed from the documentation, but the code is still available. It sounds weird.

Quoted 4 lines

Can we still keep the "--cputype" in the documentation? Just say that it's a deprecated option, please use the --unit cpu_atom instead. I think even better if we can throw a warning and point to --unit when the "--cputype" is used.

I think we want to remove --cputype widely in the code and replace what it does with specifying a PMU name. Advertising a flag but then warning seems strange and is a behavioral change from what is currently done. For raw-dump we don't document it in the man page and hide the flag, this is the pattern being followed here.

Thanks,
Ian

Quoted 99 lines

Thanks,
Kan

Quoted 97 lines
tools/perf/Documentation/perf-list.txt +3 -0
+--unit::
+Print PMU events and metrics limited to the specific PMU name.
+(e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom)
 
 [[EVENT_MODIFIERS]]
 EVENT MODIFIERS
tools/perf/builtin-list.c +12 -6
index 58e1ec1654ef..cc84ced6da26 100644
@@ -21,7 +21,6 @@
 
 static bool desc_flag = true;
 static bool details_flag;
-static const char *hybrid_type;
 
 int cmd_list(int argc, const char **argv)
 {
@@ -30,6 +29,8 @@ int cmd_list(int argc, const char **argv)
      bool long_desc_flag = false;
      bool deprecated = false;
      char *pmu_name = NULL;
+     const char *hybrid_name = NULL;
+     const char *unit_name = NULL;
      struct option list_options[] = {
              OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
              OPT_BOOLEAN('d', "desc", &desc_flag,
@@ -40,9 +41,10 @@ int cmd_list(int argc, const char **argv)
                          "Print information on the perf event names and expressions used internally by events."),
              OPT_BOOLEAN(0, "deprecated", &deprecated,
                          "Print deprecated events."),
-             OPT_STRING(0, "cputype", &hybrid_type, "hybrid cpu type",
-                        "Print events applying cpu with this type for hybrid platform "
-                        "(e.g. core or atom)"),
+             OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
+                        "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
+             OPT_STRING(0, "unit", &unit_name, "PMU name",
+                        "Limit PMU or metric printing to the specified PMU."),
              OPT_INCR(0, "debug", &verbose,
                           "Enable debugging output"),
              OPT_END()
@@ -53,6 +55,8 @@ int cmd_list(int argc, const char **argv)
      };
 
      set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
+     /* Hide hybrid flag for the more generic 'unit' flag. */
+     set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
 
      argc = parse_options(argc, argv, list_options, list_usage,
                           PARSE_OPT_STOP_AT_NON_OPTION);
@@ -62,8 +66,10 @@ int cmd_list(int argc, const char **argv)
      if (!raw_dump && pager_in_use())
              printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
 
-     if (hybrid_type) {
-             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_type);
+     if (unit_name)
+             pmu_name = strdup(unit_name);
+     else if (hybrid_name) {
+             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_name);
              if (!pmu_name)
                      pr_warning("WARNING: hybrid cputype is not supported!\n");
      }
tools/perf/util/metricgroup.c +2 -1
index 4c98ac29ee13..1943fed9b6d9 100644
@@ -556,11 +556,12 @@ static int metricgroup__print_callback(const struct pmu_event *pe,
                                     void *vdata)
 {
      struct metricgroup_print_data *data = vdata;
+     const char *pmu = pe->pmu ?: "cpu";
 
      if (!pe->metric_expr)
              return 0;
 
-     if (data->pmu_name && perf_pmu__is_hybrid(pe->pmu) && strcmp(data->pmu_name, pe->pmu))
+     if (data->pmu_name && strcmp(data->pmu_name, pmu))
              return 0;
 
      return metricgroup__print_pmu_event(pe, data->metricgroups, data->filter,
tools/perf/util/pmu.c +1 -3
index a8f9f47c6ed9..9c771f136b81 100644
@@ -1694,10 +1694,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
      pmu = NULL;
      j = 0;
      while ((pmu = perf_pmu__scan(pmu)) != NULL) {
-             if (pmu_name && perf_pmu__is_hybrid(pmu->name) &&
-                 strcmp(pmu_name, pmu->name)) {
+             if (pmu_name && pmu->name && strcmp(pmu_name, pmu->name))
                      continue;
-             }
 
              list_for_each_entry(alias, &pmu->aliases, list) {
                      char *name = alias->desc ? alias->name :
#16 lore raw

Re: [PATCH v1 4/9] perf list: Generalize limiting to a PMU name

Quoted 50 lines · Ian Rogers
Quoted 44 lines · Kan
Quoted 30 lines · Ian Rogers

Deprecate the --cputype option and add a --unit option where '--unit cpu_atom' behaves like '--cputype atom'. The --unit option can be used with arbitrary PMUs, for example:

```
$ perf list --unit msr pmu

List of pre-defined events (to be used in -e or -M):

  msr/aperf/                                         [Kernel PMU event]
  msr/cpu_thermal_margin/                            [Kernel PMU event]
  msr/mperf/                                         [Kernel PMU event]
  msr/pperf/                                         [Kernel PMU event]
  msr/smi/                                           [Kernel PMU event]
  msr/tsc/                                           [Kernel PMU event]
```
---
 tools/perf/Documentation/perf-list.txt |  6 +++---
 tools/perf/builtin-list.c              | 18 ++++++++++++------
 tools/perf/util/metricgroup.c          |  3 ++-
 tools/perf/util/pmu.c                  |  4 +---
 4 files changed, 18 insertions(+), 13 deletions(-)
tools/perf/Documentation/perf-list.txt +0 -0
index 57384a97c04f..44a819af573d 100644

tools/perf/Documentation/perf-list.txt any extra expressions computed by perf stat. · line 44

Quoted 6 lines
tools/perf/Documentation/perf-list.txt +0 -3
@@ -39,9 +39,9 @@ any extra expressions computed by perf stat.
 --deprecated::
 Print deprecated events. By default the deprecated events are hidden.
 
---cputype::
-Print events applying cpu with this type for hybrid platform
-(e.g. --cputype core or --cputype atom)

The "--cputype" is removed from the documentation, but the code is still available. It sounds weird.

Quoted 4 lines

Can we still keep the "--cputype" in the documentation? Just say that it's a deprecated option, please use the --unit cpu_atom instead. I think even better if we can throw a warning and point to --unit when the "--cputype" is used.

Quoted 5 lines

I think we want to remove --cputype widely in the code and replace what it does with specifying a PMU name. Advertising a flag but then warning seems strange and is a behavioral change from what is currently done. For raw-dump we don't document it in the man page and hide the flag, this is the pattern being followed here.

I see. So the --cputype is still supported, but only be hidden in the default. Sure, we can follow the pattern.

Quoted 60 lines

Thanks,
Ian

Quoted 56 lines

Thanks,
Kan

Quoted 54 lines
tools/perf/Documentation/perf-list.txt +3 -0
+--unit::
+Print PMU events and metrics limited to the specific PMU name.
+(e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom)
 
 [[EVENT_MODIFIERS]]
 EVENT MODIFIERS
tools/perf/builtin-list.c +8 -4
index 58e1ec1654ef..cc84ced6da26 100644
@@ -21,7 +21,6 @@
 
 static bool desc_flag = true;
 static bool details_flag;
-static const char *hybrid_type;
 
 int cmd_list(int argc, const char **argv)
 {
@@ -30,6 +29,8 @@ int cmd_list(int argc, const char **argv)
      bool long_desc_flag = false;
      bool deprecated = false;
      char *pmu_name = NULL;
+     const char *hybrid_name = NULL;
+     const char *unit_name = NULL;
      struct option list_options[] = {
              OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
              OPT_BOOLEAN('d', "desc", &desc_flag,
@@ -40,9 +41,10 @@ int cmd_list(int argc, const char **argv)
                          "Print information on the perf event names and expressions used internally by events."),
              OPT_BOOLEAN(0, "deprecated", &deprecated,
                          "Print deprecated events."),
-             OPT_STRING(0, "cputype", &hybrid_type, "hybrid cpu type",
-                        "Print events applying cpu with this type for hybrid platform "
-                        "(e.g. core or atom)"),
+             OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
+                        "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
+             OPT_STRING(0, "unit", &unit_name, "PMU name",
+                        "Limit PMU or metric printing to the specified PMU."),
              OPT_INCR(0, "debug", &verbose,
                           "Enable debugging output"),
              OPT_END()
@@ -53,6 +55,8 @@ int cmd_list(int argc, const char **argv)
      };
 
      set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
+     /* Hide hybrid flag for the more generic 'unit' flag. */
+     set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
 
      argc = parse_options(argc, argv, list_options, list_usage,
                           PARSE_OPT_STOP_AT_NON_OPTION);
@@ -62,8 +66,10 @@ int cmd_list(int argc, const char **argv)
      if (!raw_dump && pager_in_use())
              printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
 
Quoted 9 lines
Quoted 9 lines

tools/perf/builtin-list.c int cmd_list(int argc, const char **argv) · line 75

Quoted 9 lines
tools/perf/builtin-list.c +4 -2
-     if (hybrid_type) {
-             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_type);
+     if (unit_name)
+             pmu_name = strdup(unit_name);
+     else if (hybrid_name) {
+             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_name);
              if (!pmu_name)
                      pr_warning("WARNING: hybrid cputype is not supported!\n");
      }

Can the tool implicitly convert the --cputype to --unit at the very beginning? (Just need to append a prefix "cpu_".). Here we only need to handle the unit_name.
The same logic may be applied for other tools if someone implements the --unit for the stat or record later.

BTW: we may want to check the existence of a PMU here, just like what we did for the hybrid. If a user perf list a nonexistence PMU, we can warn here.

Thanks,
Kan

Quoted 34 lines
Quoted 34 lines
Quoted 34 lines
tools/perf/util/metricgroup.c +2 -1
index 4c98ac29ee13..1943fed9b6d9 100644
@@ -556,11 +556,12 @@ static int metricgroup__print_callback(const struct pmu_event *pe,
                                     void *vdata)
 {
      struct metricgroup_print_data *data = vdata;
+     const char *pmu = pe->pmu ?: "cpu";
 
      if (!pe->metric_expr)
              return 0;
 
-     if (data->pmu_name && perf_pmu__is_hybrid(pe->pmu) && strcmp(data->pmu_name, pe->pmu))
+     if (data->pmu_name && strcmp(data->pmu_name, pmu))
              return 0;
 
      return metricgroup__print_pmu_event(pe, data->metricgroups, data->filter,
tools/perf/util/pmu.c +1 -3
index a8f9f47c6ed9..9c771f136b81 100644
@@ -1694,10 +1694,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
      pmu = NULL;
      j = 0;
      while ((pmu = perf_pmu__scan(pmu)) != NULL) {
-             if (pmu_name && perf_pmu__is_hybrid(pmu->name) &&
-                 strcmp(pmu_name, pmu->name)) {
+             if (pmu_name && pmu->name && strcmp(pmu_name, pmu->name))
                      continue;
-             }
 
              list_for_each_entry(alias, &pmu->aliases, list) {
                      char *name = alias->desc ? alias->name :
author reviewer
#17 lore raw

Re: [PATCH v1 4/9] perf list: Generalize limiting to a PMU name

Quoted 139 lines · Kan
Quoted 50 lines · Ian Rogers
Quoted 44 lines · Kan
Quoted 30 lines · Ian Rogers

Deprecate the --cputype option and add a --unit option where '--unit cpu_atom' behaves like '--cputype atom'. The --unit option can be used with arbitrary PMUs, for example:

```
$ perf list --unit msr pmu

List of pre-defined events (to be used in -e or -M):

  msr/aperf/                                         [Kernel PMU event]
  msr/cpu_thermal_margin/                            [Kernel PMU event]
  msr/mperf/                                         [Kernel PMU event]
  msr/pperf/                                         [Kernel PMU event]
  msr/smi/                                           [Kernel PMU event]
  msr/tsc/                                           [Kernel PMU event]
```
---
 tools/perf/Documentation/perf-list.txt |  6 +++---
 tools/perf/builtin-list.c              | 18 ++++++++++++------
 tools/perf/util/metricgroup.c          |  3 ++-
 tools/perf/util/pmu.c                  |  4 +---
 4 files changed, 18 insertions(+), 13 deletions(-)
tools/perf/Documentation/perf-list.txt +0 -0
index 57384a97c04f..44a819af573d 100644

tools/perf/Documentation/perf-list.txt any extra expressions computed by perf stat. · line 44

Quoted 6 lines
tools/perf/Documentation/perf-list.txt +0 -3
@@ -39,9 +39,9 @@ any extra expressions computed by perf stat.
 --deprecated::
 Print deprecated events. By default the deprecated events are hidden.
 
---cputype::
-Print events applying cpu with this type for hybrid platform
-(e.g. --cputype core or --cputype atom)

The "--cputype" is removed from the documentation, but the code is still available. It sounds weird.

Quoted 4 lines

Can we still keep the "--cputype" in the documentation? Just say that it's a deprecated option, please use the --unit cpu_atom instead. I think even better if we can throw a warning and point to --unit when the "--cputype" is used.

Quoted 5 lines

I think we want to remove --cputype widely in the code and replace what it does with specifying a PMU name. Advertising a flag but then warning seems strange and is a behavioral change from what is currently done. For raw-dump we don't document it in the man page and hide the flag, this is the pattern being followed here.

I see. So the --cputype is still supported, but only be hidden in the default. Sure, we can follow the pattern.

Quoted 60 lines

Thanks,
Ian

Quoted 56 lines

Thanks,
Kan

Quoted 54 lines
tools/perf/Documentation/perf-list.txt +3 -0
+--unit::
+Print PMU events and metrics limited to the specific PMU name.
+(e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom)
 
 [[EVENT_MODIFIERS]]
 EVENT MODIFIERS
tools/perf/builtin-list.c +8 -4
index 58e1ec1654ef..cc84ced6da26 100644
@@ -21,7 +21,6 @@
 
 static bool desc_flag = true;
 static bool details_flag;
-static const char *hybrid_type;
 
 int cmd_list(int argc, const char **argv)
 {
@@ -30,6 +29,8 @@ int cmd_list(int argc, const char **argv)
      bool long_desc_flag = false;
      bool deprecated = false;
      char *pmu_name = NULL;
+     const char *hybrid_name = NULL;
+     const char *unit_name = NULL;
      struct option list_options[] = {
              OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
              OPT_BOOLEAN('d', "desc", &desc_flag,
@@ -40,9 +41,10 @@ int cmd_list(int argc, const char **argv)
                          "Print information on the perf event names and expressions used internally by events."),
              OPT_BOOLEAN(0, "deprecated", &deprecated,
                          "Print deprecated events."),
-             OPT_STRING(0, "cputype", &hybrid_type, "hybrid cpu type",
-                        "Print events applying cpu with this type for hybrid platform "
-                        "(e.g. core or atom)"),
+             OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
+                        "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
+             OPT_STRING(0, "unit", &unit_name, "PMU name",
+                        "Limit PMU or metric printing to the specified PMU."),
              OPT_INCR(0, "debug", &verbose,
                           "Enable debugging output"),
              OPT_END()
@@ -53,6 +55,8 @@ int cmd_list(int argc, const char **argv)
      };
 
      set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
+     /* Hide hybrid flag for the more generic 'unit' flag. */
+     set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
 
      argc = parse_options(argc, argv, list_options, list_usage,
                           PARSE_OPT_STOP_AT_NON_OPTION);
@@ -62,8 +66,10 @@ int cmd_list(int argc, const char **argv)
      if (!raw_dump && pager_in_use())
              printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
 
Quoted 9 lines
Quoted 9 lines

tools/perf/builtin-list.c int cmd_list(int argc, const char **argv) · line 75

Quoted 9 lines
tools/perf/builtin-list.c +4 -2
-     if (hybrid_type) {
-             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_type);
+     if (unit_name)
+             pmu_name = strdup(unit_name);
+     else if (hybrid_name) {
+             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_name);
              if (!pmu_name)
                      pr_warning("WARNING: hybrid cputype is not supported!\n");
      }

Can the tool implicitly convert the --cputype to --unit at the very beginning? (Just need to append a prefix "cpu_".). Here we only need to handle the unit_name.
The same logic may be applied for other tools if someone implements the --unit for the stat or record later.

Quoted 3 lines

BTW: we may want to check the existence of a PMU here, just like what we did for the hybrid. If a user perf list a nonexistence PMU, we can warn here.

That'd be a fine follow up. I think it would be problematic as it would warn because of a lack of permissions.

Thanks,
Ian

Quoted 37 lines

Thanks,
Kan

Quoted 34 lines
Quoted 34 lines
Quoted 34 lines
tools/perf/util/metricgroup.c +2 -1
index 4c98ac29ee13..1943fed9b6d9 100644
@@ -556,11 +556,12 @@ static int metricgroup__print_callback(const struct pmu_event *pe,
                                     void *vdata)
 {
      struct metricgroup_print_data *data = vdata;
+     const char *pmu = pe->pmu ?: "cpu";
 
      if (!pe->metric_expr)
              return 0;
 
-     if (data->pmu_name && perf_pmu__is_hybrid(pe->pmu) && strcmp(data->pmu_name, pe->pmu))
+     if (data->pmu_name && strcmp(data->pmu_name, pmu))
              return 0;
 
      return metricgroup__print_pmu_event(pe, data->metricgroups, data->filter,
tools/perf/util/pmu.c +1 -3
index a8f9f47c6ed9..9c771f136b81 100644
@@ -1694,10 +1694,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
      pmu = NULL;
      j = 0;
      while ((pmu = perf_pmu__scan(pmu)) != NULL) {
-             if (pmu_name && perf_pmu__is_hybrid(pmu->name) &&
-                 strcmp(pmu_name, pmu->name)) {
+             if (pmu_name && pmu->name && strcmp(pmu_name, pmu->name))
                      continue;
-             }
 
              list_for_each_entry(alias, &pmu->aliases, list) {
                      char *name = alias->desc ? alias->name :
#18 lore raw

Re: [PATCH v1 4/9] perf list: Generalize limiting to a PMU name

Quoted 140 lines · Ian Rogers
Quoted 139 lines · Kan
Quoted 50 lines · Ian Rogers
Quoted 44 lines · Kan
Quoted 30 lines · Ian Rogers

Deprecate the --cputype option and add a --unit option where '--unit cpu_atom' behaves like '--cputype atom'. The --unit option can be used with arbitrary PMUs, for example:

```
$ perf list --unit msr pmu

List of pre-defined events (to be used in -e or -M):

  msr/aperf/                                         [Kernel PMU event]
  msr/cpu_thermal_margin/                            [Kernel PMU event]
  msr/mperf/                                         [Kernel PMU event]
  msr/pperf/                                         [Kernel PMU event]
  msr/smi/                                           [Kernel PMU event]
  msr/tsc/                                           [Kernel PMU event]
```
---
 tools/perf/Documentation/perf-list.txt |  6 +++---
 tools/perf/builtin-list.c              | 18 ++++++++++++------
 tools/perf/util/metricgroup.c          |  3 ++-
 tools/perf/util/pmu.c                  |  4 +---
 4 files changed, 18 insertions(+), 13 deletions(-)
tools/perf/Documentation/perf-list.txt +0 -0
index 57384a97c04f..44a819af573d 100644

tools/perf/Documentation/perf-list.txt any extra expressions computed by perf stat. · line 44

Quoted 6 lines
tools/perf/Documentation/perf-list.txt +0 -3
@@ -39,9 +39,9 @@ any extra expressions computed by perf stat.
 --deprecated::
 Print deprecated events. By default the deprecated events are hidden.
 
---cputype::
-Print events applying cpu with this type for hybrid platform
-(e.g. --cputype core or --cputype atom)

The "--cputype" is removed from the documentation, but the code is still available. It sounds weird.

Quoted 4 lines

Can we still keep the "--cputype" in the documentation? Just say that it's a deprecated option, please use the --unit cpu_atom instead. I think even better if we can throw a warning and point to --unit when the "--cputype" is used.

Quoted 5 lines

I think we want to remove --cputype widely in the code and replace what it does with specifying a PMU name. Advertising a flag but then warning seems strange and is a behavioral change from what is currently done. For raw-dump we don't document it in the man page and hide the flag, this is the pattern being followed here.

I see. So the --cputype is still supported, but only be hidden in the default. Sure, we can follow the pattern.

Quoted 60 lines

Thanks,
Ian

Quoted 56 lines

Thanks,
Kan

Quoted 54 lines
tools/perf/Documentation/perf-list.txt +3 -0
+--unit::
+Print PMU events and metrics limited to the specific PMU name.
+(e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom)
 
 [[EVENT_MODIFIERS]]
 EVENT MODIFIERS
tools/perf/builtin-list.c +8 -4
index 58e1ec1654ef..cc84ced6da26 100644
@@ -21,7 +21,6 @@
 
 static bool desc_flag = true;
 static bool details_flag;
-static const char *hybrid_type;
 
 int cmd_list(int argc, const char **argv)
 {
@@ -30,6 +29,8 @@ int cmd_list(int argc, const char **argv)
      bool long_desc_flag = false;
      bool deprecated = false;
      char *pmu_name = NULL;
+     const char *hybrid_name = NULL;
+     const char *unit_name = NULL;
      struct option list_options[] = {
              OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
              OPT_BOOLEAN('d', "desc", &desc_flag,
@@ -40,9 +41,10 @@ int cmd_list(int argc, const char **argv)
                          "Print information on the perf event names and expressions used internally by events."),
              OPT_BOOLEAN(0, "deprecated", &deprecated,
                          "Print deprecated events."),
-             OPT_STRING(0, "cputype", &hybrid_type, "hybrid cpu type",
-                        "Print events applying cpu with this type for hybrid platform "
-                        "(e.g. core or atom)"),
+             OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
+                        "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
+             OPT_STRING(0, "unit", &unit_name, "PMU name",
+                        "Limit PMU or metric printing to the specified PMU."),
              OPT_INCR(0, "debug", &verbose,
                           "Enable debugging output"),
              OPT_END()
@@ -53,6 +55,8 @@ int cmd_list(int argc, const char **argv)
      };
 
      set_option_flag(list_options, 0, "raw-dump", PARSE_OPT_HIDDEN);
+     /* Hide hybrid flag for the more generic 'unit' flag. */
+     set_option_flag(list_options, 0, "cputype", PARSE_OPT_HIDDEN);
 
      argc = parse_options(argc, argv, list_options, list_usage,
                           PARSE_OPT_STOP_AT_NON_OPTION);
@@ -62,8 +66,10 @@ int cmd_list(int argc, const char **argv)
      if (!raw_dump && pager_in_use())
              printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
 
Quoted 9 lines
Quoted 9 lines

tools/perf/builtin-list.c int cmd_list(int argc, const char **argv) · line 75

Quoted 9 lines
tools/perf/builtin-list.c +4 -2
-     if (hybrid_type) {
-             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_type);
+     if (unit_name)
+             pmu_name = strdup(unit_name);
+     else if (hybrid_name) {
+             pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_name);
              if (!pmu_name)
                      pr_warning("WARNING: hybrid cputype is not supported!\n");
      }

Can the tool implicitly convert the --cputype to --unit at the very beginning? (Just need to append a prefix "cpu_".). Here we only need to handle the unit_name.
The same logic may be applied for other tools if someone implements the --unit for the stat or record later.

Quoted 7 lines
Quoted 3 lines

BTW: we may want to check the existence of a PMU here, just like what we did for the hybrid. If a user perf list a nonexistence PMU, we can warn here.

That'd be a fine follow up. I think it would be problematic as it would warn because of a lack of permissions.

Just check whether the PMU folder exists in the sysfs. I don't think it has a permission issue.

Thanks,
Kan

Quoted 40 lines

Thanks,
Ian

Quoted 37 lines

Thanks,
Kan

Quoted 34 lines
Quoted 34 lines
Quoted 34 lines
tools/perf/util/metricgroup.c +2 -1
index 4c98ac29ee13..1943fed9b6d9 100644
@@ -556,11 +556,12 @@ static int metricgroup__print_callback(const struct pmu_event *pe,
                                     void *vdata)
 {
      struct metricgroup_print_data *data = vdata;
+     const char *pmu = pe->pmu ?: "cpu";
 
      if (!pe->metric_expr)
              return 0;
 
-     if (data->pmu_name && perf_pmu__is_hybrid(pe->pmu) && strcmp(data->pmu_name, pe->pmu))
+     if (data->pmu_name && strcmp(data->pmu_name, pmu))
              return 0;
 
      return metricgroup__print_pmu_event(pe, data->metricgroups, data->filter,
tools/perf/util/pmu.c +1 -3
index a8f9f47c6ed9..9c771f136b81 100644
@@ -1694,10 +1694,8 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
      pmu = NULL;
      j = 0;
      while ((pmu = perf_pmu__scan(pmu)) != NULL) {
-             if (pmu_name && perf_pmu__is_hybrid(pmu->name) &&
-                 strcmp(pmu_name, pmu->name)) {
+             if (pmu_name && pmu->name && strcmp(pmu_name, pmu->name))
                      continue;
-             }
 
              list_for_each_entry(alias, &pmu->aliases, list) {
                      char *name = alias->desc ? alias->name :
author reviewer
#19 lore raw

PATCH 5/9 perf list: Simplify cache event printing

In reply to Ian Rogers

The current code computes an array of cache names then sorts and prints them. Use a strlist to create a list of names that is sorted. Keep the hybrid names, it is unclear how to generalize it, but drop the computation of evt_pmus that is never used.

---
 tools/perf/util/print-events.c | 132 +++++++--------------------------
 1 file changed, 27 insertions(+), 105 deletions(-)
tools/perf/util/print-events.c +27 -105
index fefc025bc259..ff7793944246 100644
@@ -206,137 +206,59 @@ void print_sdt_events(const char *subsys_glob, const char *event_glob,
 
 int print_hwcache_events(const char *event_glob, bool name_only)
 {
-	unsigned int type, op, i, evt_i = 0, evt_num = 0, npmus = 0;
-	char name[64], new_name[128];
-	char **evt_list = NULL, **evt_pmus = NULL;
-	bool evt_num_known = false;
-	struct perf_pmu *pmu = NULL;
-
-	if (perf_pmu__has_hybrid()) {
-		npmus = perf_pmu__hybrid_pmu_num();
-		evt_pmus = zalloc(sizeof(char *) * npmus);
-		if (!evt_pmus)
-			goto out_enomem;
-	}
+	struct strlist *evt_name_list = strlist__new(NULL, NULL);
+	struct str_node *nd;
 
-restart:
-	if (evt_num_known) {
-		evt_list = zalloc(sizeof(char *) * evt_num);
-		if (!evt_list)
-			goto out_enomem;
+	if (!evt_name_list) {
+		pr_debug("Failed to allocate new strlist for hwcache events\n");
+		return -ENOMEM;
 	}
-
-	for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
-		for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
+	for (int type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
+		for (int op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
 			/* skip invalid cache type */
 			if (!evsel__is_cache_op_valid(type, op))
 				continue;
 
-			for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
-				unsigned int hybrid_supported = 0, j;
-				bool supported;
+			for (int i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
+				struct perf_pmu *pmu = NULL;
+				char name[64];
 
 				__evsel__hw_cache_type_op_res_name(type, op, i, name, sizeof(name));
 				if (event_glob != NULL && !strglobmatch(name, event_glob))
 					continue;
 
 				if (!perf_pmu__has_hybrid()) {
-					if (!is_event_supported(PERF_TYPE_HW_CACHE,
-								type | (op << 8) | (i << 16))) {
-						continue;
-					}
-				} else {
-					perf_pmu__for_each_hybrid_pmu(pmu) {
-						if (!evt_num_known) {
-							evt_num++;
-							continue;
-						}
-
-						supported = is_event_supported(
-							PERF_TYPE_HW_CACHE,
-							type | (op << 8) | (i << 16) |
-							((__u64)pmu->type << PERF_PMU_TYPE_SHIFT));
-						if (supported) {
-							snprintf(new_name, sizeof(new_name),
-								 "%s/%s/", pmu->name, name);
-							evt_pmus[hybrid_supported] =
-								strdup(new_name);
-							hybrid_supported++;
-						}
-					}
-
-					if (hybrid_supported == 0)
-						continue;
-				}
-
-				if (!evt_num_known) {
-					evt_num++;
+					if (is_event_supported(PERF_TYPE_HW_CACHE,
+							       type | (op << 8) | (i << 16)))
+						strlist__add(evt_name_list, name);
 					continue;
 				}
-
-				if ((hybrid_supported == 0) ||
-				    (hybrid_supported == npmus)) {
-					evt_list[evt_i] = strdup(name);
-					if (npmus > 0) {
-						for (j = 0; j < npmus; j++)
-							zfree(&evt_pmus[j]);
-					}
-				} else {
-					for (j = 0; j < hybrid_supported; j++) {
-						evt_list[evt_i++] = evt_pmus[j];
-						evt_pmus[j] = NULL;
+				perf_pmu__for_each_hybrid_pmu(pmu) {
+					if (is_event_supported(PERF_TYPE_HW_CACHE,
+					    type | (op << 8) | (i << 16) |
+					    ((__u64)pmu->type << PERF_PMU_TYPE_SHIFT))) {
+						char new_name[128];
+							snprintf(new_name, sizeof(new_name),
+								 "%s/%s/", pmu->name, name);
+							strlist__add(evt_name_list, new_name);
 					}
-					continue;
 				}
-
-				if (evt_list[evt_i] == NULL)
-					goto out_enomem;
-				evt_i++;
 			}
 		}
 	}
 
-	if (!evt_num_known) {
-		evt_num_known = true;
-		goto restart;
-	}
-
-	for (evt_i = 0; evt_i < evt_num; evt_i++) {
-		if (!evt_list[evt_i])
-			break;
-	}
-
-	evt_num = evt_i;
-	qsort(evt_list, evt_num, sizeof(char *), cmp_string);
-	evt_i = 0;
-	while (evt_i < evt_num) {
+	strlist__for_each_entry(nd, evt_name_list) {
 		if (name_only) {
-			printf("%s ", evt_list[evt_i++]);
+			printf("%s ", nd->s);
 			continue;
 		}
-		printf("  %-50s [%s]\n", evt_list[evt_i++],
-				event_type_descriptors[PERF_TYPE_HW_CACHE]);
+		printf("  %-50s [%s]\n", nd->s, event_type_descriptors[PERF_TYPE_HW_CACHE]);
 	}
-	if (evt_num && pager_in_use())
+	if (!strlist__empty(evt_name_list) && pager_in_use())
 		printf("\n");
 
-out_free:
-	evt_num = evt_i;
-	for (evt_i = 0; evt_i < evt_num; evt_i++)
-		zfree(&evt_list[evt_i]);
-	zfree(&evt_list);
-
-	for (evt_i = 0; evt_i < npmus; evt_i++)
-		zfree(&evt_pmus[evt_i]);
-	zfree(&evt_pmus);
-	return evt_num;
-
-out_enomem:
-	printf("FATAL: not enough memory to print %s\n",
-		event_type_descriptors[PERF_TYPE_HW_CACHE]);
-	if (evt_list)
-		goto out_free;
-	return evt_num;
+	strlist__delete(evt_name_list);
+	return 0;
 }
 
 static void print_tool_event(const struct event_symbol *syms, const char *event_glob,
Signature · 1 line
2.38.1.431.g37b22c650d-goog
author reviewer
#20 lore raw

PATCH 6/9 perf list: Simplify symbol event printing

In reply to Ian Rogers

The current code computes an array of symbol names then sorts and prints them. Use a strlist to create a list of names that is sorted and then print it.

---
 tools/perf/util/print-events.c | 79 +++++++++-------------------------
 1 file changed, 21 insertions(+), 58 deletions(-)
tools/perf/util/print-events.c +21 -58
index ff7793944246..d53dba033597 100644
@@ -52,14 +52,6 @@ static const struct event_symbol event_symbols_tool[PERF_TOOL_MAX] = {
 	},
 };
 
-static int cmp_string(const void *a, const void *b)
-{
-	const char * const *as = a;
-	const char * const *bs = b;
-
-	return strcmp(*as, *bs);
-}
-
 /*
  * Print the events from <debugfs_mount_point>/tracing/events
  */
@@ -298,77 +290,48 @@ void print_symbol_events(const char *event_glob, unsigned int type,
 			 struct event_symbol *syms, unsigned int max,
 			 bool name_only)
 {
-	unsigned int i, evt_i = 0, evt_num = 0;
-	char name[MAX_NAME_LEN];
-	char **evt_list = NULL;
-	bool evt_num_known = false;
-
-restart:
-	if (evt_num_known) {
-		evt_list = zalloc(sizeof(char *) * evt_num);
-		if (!evt_list)
-			goto out_enomem;
-		syms -= max;
-	}
+	struct strlist *evt_name_list = strlist__new(NULL, NULL);
+	struct str_node *nd;
 
-	for (i = 0; i < max; i++, syms++) {
+	if (!evt_name_list) {
+		pr_debug("Failed to allocate new strlist for symbol events\n");
+		return;
+	}
+	for (unsigned int i = 0; i < max; i++) {
 		/*
 		 * New attr.config still not supported here, the latest
 		 * example was PERF_COUNT_SW_CGROUP_SWITCHES
 		 */
-		if (syms->symbol == NULL)
+		if (syms[i].symbol == NULL)
 			continue;
 
-		if (event_glob != NULL && !(strglobmatch(syms->symbol, event_glob) ||
-		      (syms->alias && strglobmatch(syms->alias, event_glob))))
+		if (event_glob != NULL && !(strglobmatch(syms[i].symbol, event_glob) ||
+		      (syms[i].alias && strglobmatch(syms[i].alias, event_glob))))
 			continue;
 
 		if (!is_event_supported(type, i))
 			continue;
 
-		if (!evt_num_known) {
-			evt_num++;
-			continue;
-		}
-
-		if (!name_only && strlen(syms->alias))
-			snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
-		else
-			strlcpy(name, syms->symbol, MAX_NAME_LEN);
+		if (strlen(syms[i].alias)) {
+			char name[MAX_NAME_LEN];
 
-		evt_list[evt_i] = strdup(name);
-		if (evt_list[evt_i] == NULL)
-			goto out_enomem;
-		evt_i++;
+			snprintf(name, MAX_NAME_LEN, "%s OR %s", syms[i].symbol, syms[i].alias);
+			strlist__add(evt_name_list, name);
+		} else
+			strlist__add(evt_name_list, syms[i].symbol);
 	}
 
-	if (!evt_num_known) {
-		evt_num_known = true;
-		goto restart;
-	}
-	qsort(evt_list, evt_num, sizeof(char *), cmp_string);
-	evt_i = 0;
-	while (evt_i < evt_num) {
+	strlist__for_each_entry(nd, evt_name_list) {
 		if (name_only) {
-			printf("%s ", evt_list[evt_i++]);
+			printf("%s ", nd->s);
 			continue;
 		}
-		printf("  %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
+		printf("  %-50s [%s]\n", nd->s, event_type_descriptors[type]);
 	}
-	if (evt_num && pager_in_use())
+	if (!strlist__empty(evt_name_list) && pager_in_use())
 		printf("\n");
 
-out_free:
-	evt_num = evt_i;
-	for (evt_i = 0; evt_i < evt_num; evt_i++)
-		zfree(&evt_list[evt_i]);
-	zfree(&evt_list);
-	return;
-
-out_enomem:
-	printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
-	if (evt_list)
-		goto out_free;
+	strlist__delete(evt_name_list);
 }
 
 /*
Signature · 1 line
2.38.1.431.g37b22c650d-goog
author reviewer
#21 lore raw

PATCH 7/9 perf pmu: Restructure print_pmu_events

In reply to Ian Rogers

Previously print_pmu_events would compute the values to be printed, place them in struct sevent, sort them and then print them. Modify the code so that struct sevent holds just the PMU and event, sort these and then in the main print loop calculate aliases for names, etc. This avoids memory allocations for copied values as they are computed then printed.

---
 tools/perf/util/pmu.c | 208 ++++++++++++++++++++++--------------------
 1 file changed, 110 insertions(+), 98 deletions(-)
tools/perf/util/pmu.c +110 -98
index 9c771f136b81..8322395c9cf7 100644
@@ -1552,8 +1552,8 @@ static int sub_non_neg(int a, int b)
 	return a - b;
 }
 
-static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
-			  struct perf_pmu_alias *alias)
+static char *format_alias(char *buf, int len, const struct perf_pmu *pmu,
+			  const struct perf_pmu_alias *alias)
 {
 	struct parse_events_term *term;
 	int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
@@ -1578,51 +1578,67 @@ static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
 	return buf;
 }
 
-static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
-			     struct perf_pmu_alias *alias)
+static char *format_alias_or(char *buf, int len, const struct perf_pmu *pmu,
+			     const struct perf_pmu_alias *alias)
 {
 	snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
 	return buf;
 }
 
+/** Struct for ordering events as output in perf list. */
 struct sevent {
-	char *name;
-	char *desc;
-	char *topic;
-	char *str;
-	char *pmu;
-	char *metric_expr;
-	char *metric_name;
-	int is_cpu;
+	/** PMU for event. */
+	const struct perf_pmu *pmu;
+	/**
+	 * Optional event for name, desc, etc. If not present then this is a
+	 * selectable PMU and the event name is shown as "//".
+	 */
+	const struct perf_pmu_alias *event;
+	/** Is the PMU for the CPU? */
+	bool is_cpu;
 };
 
 static int cmp_sevent(const void *a, const void *b)
 {
 	const struct sevent *as = a;
 	const struct sevent *bs = b;
+	const char *a_pmu_name, *b_pmu_name;
+	const char *a_name = "//", *a_desc = NULL, *a_topic = "";
+	const char *b_name = "//", *b_desc = NULL, *b_topic = "";
 	int ret;
 
-	/* Put extra events last */
-	if (!!as->desc != !!bs->desc)
-		return !!as->desc - !!bs->desc;
-	if (as->topic && bs->topic) {
-		int n = strcmp(as->topic, bs->topic);
-
-		if (n)
-			return n;
+	if (as->event) {
+		a_name = as->event->name;
+		a_desc = as->event->desc;
+		a_topic = as->event->topic ?: "";
 	}
+	if (bs->event) {
+		b_name = bs->event->name;
+		b_desc = bs->event->desc;
+		b_topic = bs->event->topic ?: "";
+	}
+	/* Put extra events last. */
+	if (!!a_desc != !!b_desc)
+		return !!a_desc - !!b_desc;
+
+	/* Order by topics. */
+	ret = strcmp(a_topic, b_topic);
+	if (ret)
+		return ret;
 
 	/* Order CPU core events to be first */
 	if (as->is_cpu != bs->is_cpu)
 		return bs->is_cpu - as->is_cpu;
 
-	ret = strcmp(as->name, bs->name);
-	if (!ret) {
-		if (as->pmu && bs->pmu)
-			return strcmp(as->pmu, bs->pmu);
-	}
+	/* Order by PMU name. */
+	a_pmu_name = as->pmu->name ?: "";
+	b_pmu_name = bs->pmu->name ?: "";
+	ret = strcmp(a_pmu_name, b_pmu_name);
+	if (ret)
+		return ret;
 
-	return ret;
+	/* Order by event name. */
+	return strcmp(a_name, b_name);
 }
 
 static void wordwrap(char *s, int start, int max, int corr)
@@ -1654,16 +1670,18 @@ bool is_pmu_core(const char *name)
 static bool pmu_alias_is_duplicate(struct sevent *alias_a,
 				   struct sevent *alias_b)
 {
-	/* Different names -> never duplicates */
-	if (strcmp(alias_a->name, alias_b->name))
-		return false;
+	const char *a_pmu_name, *b_pmu_name;
+	const char *a_name = alias_a->event ? alias_a->event->name : "//";
+	const char *b_name = alias_b->event ? alias_b->event->name : "//";
 
-	/* Don't remove duplicates for hybrid PMUs */
-	if (perf_pmu__is_hybrid(alias_a->pmu) &&
-	    perf_pmu__is_hybrid(alias_b->pmu))
+	/* Different names -> never duplicates */
+	if (strcmp(a_name, b_name))
 		return false;
 
-	return true;
+	/* Don't remove duplicates for different PMUs */
+	a_pmu_name = alias_a->pmu->name ?: "";
+	b_pmu_name = alias_b->pmu->name ?: "";
+	return strcmp(a_pmu_name, b_pmu_name) == 0;
 }
 
 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
@@ -1689,110 +1707,104 @@ void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
 			len++;
 	}
 	aliases = zalloc(sizeof(struct sevent) * len);
-	if (!aliases)
-		goto out_enomem;
+	if (!aliases) {
+		pr_err("FATAL: not enough memory to print PMU events\n");
+		return;
+	}
 	pmu = NULL;
 	j = 0;
 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
+		bool is_cpu;
+
 		if (pmu_name && pmu->name && strcmp(pmu_name, pmu->name))
 			continue;
 
-		list_for_each_entry(alias, &pmu->aliases, list) {
-			char *name = alias->desc ? alias->name :
-				format_alias(buf, sizeof(buf), pmu, alias);
-			bool is_cpu = is_pmu_core(pmu->name) ||
-				      perf_pmu__is_hybrid(pmu->name);
+		is_cpu = is_pmu_core(pmu->name) || pmu->is_hybrid;
 
+		list_for_each_entry(alias, &pmu->aliases, list) {
 			if (alias->deprecated && !deprecated)
 				continue;
 
 			if (event_glob != NULL &&
-			    !(strglobmatch_nocase(name, event_glob) ||
-			      (!is_cpu && strglobmatch_nocase(alias->name,
-						       event_glob)) ||
+			    !(strglobmatch_nocase(alias->name, event_glob) ||
+			      (!is_cpu &&
+			       strglobmatch_nocase(alias->name, event_glob)) ||
 			      (alias->topic &&
 			       strglobmatch_nocase(alias->topic, event_glob))))
 				continue;
 
-			if (is_cpu && !name_only && !alias->desc)
-				name = format_alias_or(buf, sizeof(buf), pmu, alias);
-
-			aliases[j].name = name;
-			if (is_cpu && !name_only && !alias->desc)
-				aliases[j].name = format_alias_or(buf,
-								  sizeof(buf),
-								  pmu, alias);
-			aliases[j].name = strdup(aliases[j].name);
-			if (!aliases[j].name)
-				goto out_enomem;
-
-			aliases[j].desc = long_desc ? alias->long_desc :
-						alias->desc;
-			aliases[j].topic = alias->topic;
-			aliases[j].str = alias->str;
-			aliases[j].pmu = pmu->name;
-			aliases[j].metric_expr = alias->metric_expr;
-			aliases[j].metric_name = alias->metric_name;
+			aliases[j].event = alias;
+			aliases[j].pmu = pmu;
 			aliases[j].is_cpu = is_cpu;
 			j++;
 		}
 		if (pmu->selectable &&
 		    (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
-			char *s;
-			if (asprintf(&s, "%s//", pmu->name) < 0)
-				goto out_enomem;
-			aliases[j].name = s;
+			aliases[j].event = NULL;
+			aliases[j].pmu = pmu;
+			aliases[j].is_cpu = is_cpu;
 			j++;
 		}
 	}
 	len = j;
 	qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
 	for (j = 0; j < len; j++) {
+		char *name, *desc;
+
 		/* Skip duplicates */
 		if (j > 0 && pmu_alias_is_duplicate(&aliases[j], &aliases[j - 1]))
 			continue;
 
+		if (!aliases[j].event) {
+			/* A selectable event. */
+			snprintf(buf, sizeof(buf), "%s//", aliases[j].pmu->name);
+			name = buf;
+		} else if (aliases[j].event->desc) {
+			name = aliases[j].event->name;
+		} else {
+			if (!name_only && aliases[j].is_cpu) {
+				name = format_alias_or(buf, sizeof(buf), aliases[j].pmu,
+						       aliases[j].event);
+			} else {
+				name = format_alias(buf, sizeof(buf), aliases[j].pmu,
+						    aliases[j].event);
+			}
+		}
 		if (name_only) {
-			printf("%s ", aliases[j].name);
+			printf("%s ", name);
 			continue;
 		}
-		if (aliases[j].desc && !quiet_flag) {
-			if (numdesc++ == 0)
-				printf("\n");
-			if (aliases[j].topic && (!topic ||
-					strcmp(topic, aliases[j].topic))) {
-				printf("%s%s:\n", topic ? "\n" : "",
-						aliases[j].topic);
-				topic = aliases[j].topic;
-			}
-			printf("  %-50s\n", aliases[j].name);
-			printf("%*s", 8, "[");
-			wordwrap(aliases[j].desc, 8, columns, 0);
-			printf("]\n");
-			if (details_flag) {
-				printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
-				if (aliases[j].metric_name)
-					printf(" MetricName: %s", aliases[j].metric_name);
-				if (aliases[j].metric_expr)
-					printf(" MetricExpr: %s", aliases[j].metric_expr);
-				putchar('\n');
-			}
-		} else
-			printf("  %-50s [Kernel PMU event]\n", aliases[j].name);
 		printed++;
+		if (!aliases[j].event || !aliases[j].event->desc || quiet_flag) {
+			printf("  %-50s [Kernel PMU event]\n", name);
+			continue;
+		}
+		if (numdesc++ == 0)
+			printf("\n");
+		if (aliases[j].event->topic && (!topic ||
+						strcmp(topic, aliases[j].event->topic))) {
+			printf("%s%s:\n", topic ? "\n" : "", aliases[j].event->topic);
+			topic = aliases[j].event->topic;
+		}
+		printf("  %-50s\n", name);
+		printf("%*s", 8, "[");
+		desc = long_desc ? aliases[j].event->long_desc : aliases[j].event->desc;
+		wordwrap(desc, 8, columns, 0);
+		printf("]\n");
+		if (details_flag) {
+			printf("%*s%s/%s/ ", 8, "", aliases[j].pmu->name, aliases[j].event->str);
+			if (aliases[j].event->metric_name)
+				printf(" MetricName: %s", aliases[j].event->metric_name);
+			if (aliases[j].event->metric_expr)
+				printf(" MetricExpr: %s", aliases[j].event->metric_expr);
+			putchar('\n');
+		}
 	}
 	if (printed && pager_in_use())
 		printf("\n");
-out_free:
-	for (j = 0; j < len; j++)
-		zfree(&aliases[j].name);
+
 	zfree(&aliases);
 	return;
-
-out_enomem:
-	printf("FATAL: not enough memory to print PMU events\n");
-	if (aliases)
-		goto out_free;
 }
 
 bool pmu_have_event(const char *pname, const char *name)
Signature · 1 line
2.38.1.431.g37b22c650d-goog
author reviewer
#22 lore raw

PATCH 8/9 perf list: Reorganize to use callbacks

In reply to Ian Rogers

Rather than controlling the list output with passed flags, add callbacks that are called when an event or metric are encountered. State is passed to the callback so that command line options can be respected, alternatively the callbacks can be changed.

Fix a few bugs:
- wordwrap to columns metric descriptions and expressions;
- remove unnecessary whitespace after PMU event names;
- the metric filter is a glob but matched using strstr which will always fail, switch to using a proper globmatch,
- the detail flag gives details for extra kernel PMU events like branch-instructions.

In metricgroup.c switch from struct mep being a rbtree of metricgroups containing a list of metrics, to the tree directly containing all the metrics. In general the alias for a name is passed to the print routine rather than being contained in the name with OR.

---
 tools/perf/builtin-list.c      | 320 ++++++++++++++++++++++++-----
 tools/perf/util/metricgroup.c  | 239 ++++++----------------
 tools/perf/util/metricgroup.h  |   4 +-
 tools/perf/util/pmu.c          | 137 ++++---------
 tools/perf/util/pmu.h          |   5 +-
 tools/perf/util/print-events.c | 355 +++++++++++++++++----------------
 tools/perf/util/print-events.h |  40 ++--
 7 files changed, 588 insertions(+), 512 deletions(-)
tools/perf/builtin-list.c +268 -52
index cc84ced6da26..91e2b6f52548 100644
@@ -15,31 +15,229 @@
 #include "util/pmu-hybrid.h"
 #include "util/debug.h"
 #include "util/metricgroup.h"
+#include "util/string2.h"
+#include "util/strlist.h"
 #include <subcmd/pager.h>
 #include <subcmd/parse-options.h>
 #include <stdio.h>
 
-static bool desc_flag = true;
-static bool details_flag;
+struct print_state {
+	/**
+	 * Optionally restrict PMU and metric matching to PMU or debugfs
+	 * subsystem name.
+	 */
+	char *pmu_glob;
+	/** Optional pattern matching glob. */
+	char *event_glob;
+	/** Print event or metric names only. */
+	bool name_only;
+	/** Print the event or metric description. */
+	bool desc;
+	/** Print longer event or metric description. */
+	bool long_desc;
+	/** Print deprecated events or metrics. */
+	bool deprecated;
+	/**
+	 * Print extra information on the perf event such as names and
+	 * expressions used internally by events.
+	 */
+	bool detailed;
+	bool metrics;
+	bool metricgroups;
+	char *last_topic;
+	char *last_metricgroups;
+	struct strlist *visited_metrics;
+};
+
+static void default_print_start(void *ps)
+{
+	struct print_state *print_state = ps;
+
+	if (!print_state->name_only && pager_in_use())
+		printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
+}
+
+static void default_print_end(void *print_state __maybe_unused) {}
+
+static void wordwrap(const char *s, int start, int max, int corr)
+{
+	int column = start;
+	int n;
+
+	while (*s) {
+		int wlen = strcspn(s, " \t");
+
+		if (column + wlen >= max && column > start) {
+			printf("\n%*s", start, "");
+			column = start + corr;
+		}
+		n = printf("%s%.*s", column > start ? " " : "", wlen, s);
+		if (n <= 0)
+			break;
+		s += wlen;
+		column += n;
+		s = skip_spaces(s);
+	}
+}
+
+static void default_print_event(void *ps, const char *pmu_name, const char *topic,
+				const char *event_name, const char *event_alias,
+				bool deprecated, const char *event_type_desc,
+				const char *desc, const char *long_desc,
+				const char *encoding_desc,
+				const char *metric_name, const char *metric_expr)
+{
+	struct print_state *print_state = ps;
+	int pos;
+
+	if (deprecated && !print_state->deprecated)
+		return;
+
+	if (print_state->pmu_glob && !strglobmatch(pmu_name, print_state->pmu_glob))
+		return;
+
+	if (print_state->event_glob &&
+	    (!event_name || !strglobmatch(event_name, print_state->event_glob)) &&
+	    (!event_alias || !strglobmatch(event_alias, print_state->event_glob)) &&
+	    (!topic || !strglobmatch_nocase(topic, print_state->event_glob)))
+		return;
+
+	if (print_state->name_only) {
+		if (event_alias && strlen(event_alias))
+			printf("%s ", event_alias);
+		else
+			printf("%s ", event_name);
+		return;
+	}
+
+	if (strcmp(print_state->last_topic, topic ?: "")) {
+		if (topic)
+			printf("\n%s:\n", topic);
+		free(print_state->last_topic);
+		print_state->last_topic = strdup(topic ?: "");
+	}
+
+	if (event_alias && strlen(event_alias))
+		pos = printf("  %s OR %s", event_name, event_alias);
+	else
+		pos = printf("  %s", event_name);
+
+	if (!topic && event_type_desc) {
+		for (; pos < 53; pos++)
+			putchar(' ');
+		printf("[%s]\n", event_type_desc);
+	} else
+		putchar('\n');
+
+	if (desc && print_state->desc) {
+		printf("%*s", 8, "[");
+		wordwrap(desc, 8, pager_get_columns(), 0);
+		printf("]\n");
+	}
+
+	if (long_desc && print_state->long_desc) {
+		printf("%*s", 8, "[");
+		wordwrap(long_desc, 8, pager_get_columns(), 0);
+		printf("]\n");
+	}
+
+	if (print_state->detailed && encoding_desc) {
+		printf("%*s%s", 8, "", encoding_desc);
+		if (metric_name)
+			printf(" MetricName: %s", metric_name);
+		if (metric_expr)
+			printf(" MetricExpr: %s", metric_expr);
+		putchar('\n');
+	}
+}
+
+static void default_print_metric(void *ps,
+				const char *group,
+				const char *name,
+				const char *desc,
+				const char *long_desc,
+				const char *expr)
+{
+	struct print_state *print_state = ps;
+
+	if (print_state->event_glob &&
+	    (!print_state->metrics || !name || !strglobmatch(name, print_state->event_glob)) &&
+	    (!print_state->metricgroups || !group || !strglobmatch(group, print_state->event_glob)))
+		return;
+
+	if (!print_state->name_only && !print_state->last_metricgroups) {
+		if (print_state->metricgroups) {
+			printf("\nMetric Groups:\n");
+			if (!print_state->metrics)
+				putchar('\n');
+		} else {
+			printf("\nMetrics:\n\n");
+		}
+	}
+	if (!print_state->last_metricgroups ||
+	    strcmp(print_state->last_metricgroups, group ?: "")) {
+		if (group && print_state->metricgroups) {
+			if (print_state->name_only)
+				printf("%s ", group);
+			else if (print_state->metrics)
+				printf("\n%s:\n", group);
+			else
+				printf("%s\n", group);
+		}
+		free(print_state->last_metricgroups);
+		print_state->last_metricgroups = strdup(group ?: "");
+	}
+	if (!print_state->metrics)
+		return;
+
+	if (print_state->name_only) {
+		if (print_state->metrics &&
+		    !strlist__has_entry(print_state->visited_metrics, name)) {
+			printf("%s ", name);
+			strlist__add(print_state->visited_metrics, name);
+		}
+		return;
+	}
+	printf("  %s\n", name);
+
+	if (desc && print_state->desc) {
+		printf("%*s", 8, "[");
+		wordwrap(desc, 8, pager_get_columns(), 0);
+		printf("]\n");
+	}
+	if (long_desc && print_state->long_desc) {
+		printf("%*s", 8, "[");
+		wordwrap(long_desc, 8, pager_get_columns(), 0);
+		printf("]\n");
+	}
+	if (expr && print_state->detailed) {
+		printf("%*s", 8, "[");
+		wordwrap(expr, 8, pager_get_columns(), 0);
+		printf("]\n");
+	}
+}
 
 int cmd_list(int argc, const char **argv)
 {
 	int i, ret = 0;
-	bool raw_dump = false;
-	bool long_desc_flag = false;
-	bool deprecated = false;
-	char *pmu_name = NULL;
+	struct print_state ps = {};
+	struct print_callbacks print_cb = {
+		.print_start = default_print_start,
+		.print_end = default_print_end,
+		.print_event = default_print_event,
+		.print_metric = default_print_metric,
+	};
 	const char *hybrid_name = NULL;
 	const char *unit_name = NULL;
 	struct option list_options[] = {
-		OPT_BOOLEAN(0, "raw-dump", &raw_dump, "Dump raw events"),
-		OPT_BOOLEAN('d', "desc", &desc_flag,
+		OPT_BOOLEAN(0, "raw-dump", &ps.name_only, "Dump raw events"),
+		OPT_BOOLEAN('d', "desc", &ps.desc,
 			    "Print extra event descriptions. --no-desc to not print."),
-		OPT_BOOLEAN('v', "long-desc", &long_desc_flag,
+		OPT_BOOLEAN('v', "long-desc", &ps.long_desc,
 			    "Print longer event descriptions."),
-		OPT_BOOLEAN(0, "details", &details_flag,
+		OPT_BOOLEAN(0, "details", &ps.detailed,
 			    "Print information on the perf event names and expressions used internally by events."),
-		OPT_BOOLEAN(0, "deprecated", &deprecated,
+		OPT_BOOLEAN(0, "deprecated", &ps.deprecated,
 			    "Print deprecated events."),
 		OPT_STRING(0, "cputype", &hybrid_name, "hybrid cpu type",
 			   "Limit PMU or metric printing to the given hybrid PMU (e.g. core or atom)."),
@@ -63,20 +261,28 @@ int cmd_list(int argc, const char **argv)
 
 	setup_pager();
 
-	if (!raw_dump && pager_in_use())
-		printf("\nList of pre-defined events (to be used in -e or -M):\n\n");
+	if (!ps.name_only)
+		setup_pager();
 
+	ps.desc = !ps.long_desc;
+	ps.last_topic = strdup("");
+	assert(ps.last_topic);
+	ps.visited_metrics = strlist__new(NULL, NULL);
+	assert(ps.visited_metrics);
 	if (unit_name)
-		pmu_name = strdup(unit_name);
+		ps.pmu_glob = strdup(unit_name);
 	else if (hybrid_name) {
-		pmu_name = perf_pmu__hybrid_type_to_pmu(hybrid_name);
-		if (!pmu_name)
+		ps.pmu_glob = perf_pmu__hybrid_type_to_pmu(hybrid_name);
+		if (!ps.pmu_glob)
 			pr_warning("WARNING: hybrid cputype is not supported!\n");
 	}
 
+	print_cb.print_start(&ps);
+
 	if (argc == 0) {
-		print_events(NULL, raw_dump, !desc_flag, long_desc_flag,
-				details_flag, deprecated, pmu_name);
+		ps.metrics = true;
+		ps.metricgroups = true;
+		print_events(&print_cb, &ps);
 		goto out;
 	}
 
@@ -84,30 +290,33 @@ int cmd_list(int argc, const char **argv)
 		char *sep, *s;
 
 		if (strcmp(argv[i], "tracepoint") == 0)
-			print_tracepoint_events(NULL, NULL, raw_dump);
+			print_tracepoint_events(&print_cb, &ps);
 		else if (strcmp(argv[i], "hw") == 0 ||
 			 strcmp(argv[i], "hardware") == 0)
-			print_symbol_events(NULL, PERF_TYPE_HARDWARE,
-					event_symbols_hw, PERF_COUNT_HW_MAX, raw_dump);
+			print_symbol_events(&print_cb, &ps, PERF_TYPE_HARDWARE,
+					event_symbols_hw, PERF_COUNT_HW_MAX);
 		else if (strcmp(argv[i], "sw") == 0 ||
 			 strcmp(argv[i], "software") == 0) {
-			print_symbol_events(NULL, PERF_TYPE_SOFTWARE,
-					event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
-			print_tool_events(NULL, raw_dump);
+			print_symbol_events(&print_cb, &ps, PERF_TYPE_SOFTWARE,
+					event_symbols_sw, PERF_COUNT_SW_MAX);
+			print_tool_events(&print_cb, &ps);
 		} else if (strcmp(argv[i], "cache") == 0 ||
 			 strcmp(argv[i], "hwcache") == 0)
-			print_hwcache_events(NULL, raw_dump);
+			print_hwcache_events(&print_cb, &ps);
 		else if (strcmp(argv[i], "pmu") == 0)
-			print_pmu_events(NULL, raw_dump, !desc_flag,
-						long_desc_flag, details_flag,
-						deprecated, pmu_name);
+			print_pmu_events(&print_cb, &ps);
 		else if (strcmp(argv[i], "sdt") == 0)
-			print_sdt_events(NULL, NULL, raw_dump);
-		else if (strcmp(argv[i], "metric") == 0 || strcmp(argv[i], "metrics") == 0)
-			metricgroup__print(true, false, NULL, raw_dump, details_flag, pmu_name);
-		else if (strcmp(argv[i], "metricgroup") == 0 || strcmp(argv[i], "metricgroups") == 0)
-			metricgroup__print(false, true, NULL, raw_dump, details_flag, pmu_name);
-		else if ((sep = strchr(argv[i], ':')) != NULL) {
+			print_sdt_events(&print_cb, &ps);
+		else if (strcmp(argv[i], "metric") == 0 || strcmp(argv[i], "metrics") == 0) {
+			ps.metricgroups = false;
+			ps.metrics = true;
+			metricgroup__print(&print_cb, &ps);
+		} else if (strcmp(argv[i], "metricgroup") == 0 ||
+			   strcmp(argv[i], "metricgroups") == 0) {
+			ps.metricgroups = true;
+			ps.metrics = false;
+			metricgroup__print(&print_cb, &ps);
+		} else if ((sep = strchr(argv[i], ':')) != NULL) {
 			int sep_idx;
 
 			sep_idx = sep - argv[i];
@@ -118,34 +327,41 @@ int cmd_list(int argc, const char **argv)
 			}
 
 			s[sep_idx] = '\0';
-			print_tracepoint_events(s, s + sep_idx + 1, raw_dump);
-			print_sdt_events(s, s + sep_idx + 1, raw_dump);
-			metricgroup__print(true, true, s, raw_dump, details_flag, pmu_name);
+			ps.pmu_glob = s;
+			ps.event_glob = s + sep_idx + 1;
+			print_tracepoint_events(&print_cb, &ps);
+			print_sdt_events(&print_cb, &ps);
+			ps.metrics = true;
+			ps.metricgroups = true;
+			metricgroup__print(&print_cb, &ps);
 			free(s);
 		} else {
 			if (asprintf(&s, "*%s*", argv[i]) < 0) {
 				printf("Critical: Not enough memory! Trying to continue...\n");
 				continue;
 			}
-			print_symbol_events(s, PERF_TYPE_HARDWARE,
-					    event_symbols_hw, PERF_COUNT_HW_MAX, raw_dump);
-			print_symbol_events(s, PERF_TYPE_SOFTWARE,
-					    event_symbols_sw, PERF_COUNT_SW_MAX, raw_dump);
-			print_tool_events(s, raw_dump);
-			print_hwcache_events(s, raw_dump);
-			print_pmu_events(s, raw_dump, !desc_flag,
-						long_desc_flag,
-						details_flag,
-						deprecated,
-						pmu_name);
-			print_tracepoint_events(NULL, s, raw_dump);
-			print_sdt_events(NULL, s, raw_dump);
-			metricgroup__print(true, true, s, raw_dump, details_flag, pmu_name);
+			ps.event_glob = s;
+			print_symbol_events(&print_cb, &ps, PERF_TYPE_HARDWARE,
+					event_symbols_hw, PERF_COUNT_HW_MAX);
+			print_symbol_events(&print_cb, &ps, PERF_TYPE_SOFTWARE,
+					event_symbols_sw, PERF_COUNT_SW_MAX);
+			print_tool_events(&print_cb, &ps);
+			print_hwcache_events(&print_cb, &ps);
+			print_pmu_events(&print_cb, &ps);
+			print_tracepoint_events(&print_cb, &ps);
+			print_sdt_events(&print_cb, &ps);
+			ps.metrics = true;
+			ps.metricgroups = true;
+			metricgroup__print(&print_cb, &ps);
 			free(s);
 		}
 	}
 
 out:
-	free(pmu_name);
+	print_cb.print_end(&ps);
+	free(ps.pmu_glob);
+	free(ps.last_topic);
+	free(ps.last_metricgroups);
+	strlist__delete(ps.visited_metrics);
 	return ret;
 }
tools/perf/util/metricgroup.c +60 -179

341 lines not on this page · raw message

tools/perf/util/metricgroup.h +2 -2
index 732d3a0d3334..0013cf582173 100644
@@ -10,6 +10,7 @@
 struct evlist;
 struct evsel;
 struct option;
+struct print_callbacks;
 struct rblist;
 struct cgroup;
 
@@ -78,8 +79,7 @@ int metricgroup__parse_groups_test(struct evlist *evlist,
 				   bool metric_no_merge,
 				   struct rblist *metric_events);
 
-void metricgroup__print(bool metrics, bool groups, char *filter,
-			bool raw, bool details, const char *pmu_name);
+void metricgroup__print(const struct print_callbacks *print_cb, void *print_state);
 bool metricgroup__has_metric(const char *metric);
 int arch_get_runtimeparam(const struct pmu_event *pe __maybe_unused);
 void metricgroup__rblist_exit(struct rblist *metric_events);
tools/perf/util/pmu.c +44 -93

208 lines not on this page · raw message

tools/perf/util/pmu.h +2 -3
index 29571c0f9d15..4f9b0202be2d 100644
@@ -12,6 +12,7 @@
 
 struct evsel_config_term;
 struct perf_cpu_map;
+struct print_callbacks;
 
 enum {
 	PERF_PMU_FORMAT_VALUE_CONFIG,
@@ -209,9 +210,7 @@ void perf_pmu__del_formats(struct list_head *formats);
 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu);
 
 bool is_pmu_core(const char *name);
-void print_pmu_events(const char *event_glob, bool name_only, bool quiet,
-		      bool long_desc, bool details_flag,
-		      bool deprecated, const char *pmu_name);
+void print_pmu_events(const struct print_callbacks *print_cb, void *print_state);
 bool pmu_have_event(const char *pname, const char *name);
 
 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt, ...) __scanf(3, 4);
tools/perf/util/print-events.c +184 -171

454 lines not on this page · raw message

tools/perf/util/print-events.h +28 -12
index 1da9910d83a6..235c3e123079 100644
@@ -2,21 +2,37 @@
 #ifndef __PERF_PRINT_EVENTS_H
 #define __PERF_PRINT_EVENTS_H
 
+#include <linux/perf_event.h>
 #include <stdbool.h>
 
 struct event_symbol;
 
-void print_events(const char *event_glob, bool name_only, bool quiet_flag,
-		  bool long_desc, bool details_flag, bool deprecated,
-		  const char *pmu_name);
-int print_hwcache_events(const char *event_glob, bool name_only);
-void print_sdt_events(const char *subsys_glob, const char *event_glob,
-		      bool name_only);
-void print_symbol_events(const char *event_glob, unsigned int type,
-			 struct event_symbol *syms, unsigned int max,
-			 bool name_only);
-void print_tool_events(const char *event_glob, bool name_only);
-void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
-			     bool name_only);
+struct print_callbacks {
+	void (*print_start)(void *print_state);
+	void (*print_end)(void *print_state);
+	void (*print_event)(void *print_state, const char *topic,
+			const char *pmu_name,
+			const char *event_name, const char *event_alias,
+			bool deprecated, const char *event_type_desc,
+			const char *desc, const char *long_desc,
+			const char *encoding_desc,
+			const char *metric_name, const char *metric_expr);
+	void (*print_metric)(void *print_state,
+			const char *group,
+			const char *name,
+			const char *desc,
+			const char *long_desc,
+			const char *expr);
+};
+
+/** Print all events, the default when no options are specified. */
+void print_events(const struct print_callbacks *print_cb, void *print_state);
+int print_hwcache_events(const struct print_callbacks *print_cb, void *print_state);
+void print_sdt_events(const struct print_callbacks *print_cb, void *print_state);
+void print_symbol_events(const struct print_callbacks *print_cb, void *print_state,
+			 unsigned int type, const struct event_symbol *syms,
+			 unsigned int max);
+void print_tool_events(const struct print_callbacks *print_cb, void *print_state);
+void print_tracepoint_events(const struct print_callbacks *print_cb, void *print_state);
 
 #endif /* __PERF_PRINT_EVENTS_H */
Signature · 1 line
2.38.1.431.g37b22c650d-goog
author reviewer
#23 lore raw

PATCH 9/9 perf list: Add json output option

In reply to Ian Rogers

Output events and metrics in a json format by overriding the print callbacks. Currently other command line options aren't supported and metrics are repeated once per metric group.

---
 tools/perf/Documentation/perf-list.txt |   4 +
 tools/perf/builtin-list.c              | 283 ++++++++++++++++++++-----
 2 files changed, 229 insertions(+), 58 deletions(-)
tools/perf/Documentation/perf-list.txt +4 -0
index 44a819af573d..43263ca88ff7 100644
@@ -43,6 +43,10 @@ Print deprecated events. By default the deprecated events are hidden.
 Print PMU events and metrics limited to the specific PMU name.
 (e.g. --unit cpu, --unit msr, --unit cpu_core, --unit cpu_atom)
 
+-j::
+--json::
+Output in json format.
+
 [[EVENT_MODIFIERS]]
 EVENT MODIFIERS
 ---------------
tools/perf/builtin-list.c +225 -58

357 lines not on this page · raw message

Signature · 1 line
2.38.1.431.g37b22c650d-goog