tools/perf/util/pmu.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __PMU_H
   3 #define __PMU_H
   4
   5 #include <linux/bitmap.h>
   6 #include <linux/compiler.h>
   7 #include <linux/perf_event.h>
   8 #include <linux/list.h>
   9 #include <stdbool.h>
  10 #include <stdio.h>
  11 #include "parse-events.h"
  12 #include "pmu-events/pmu-events.h"
  13
  14 struct evsel_config_term;
  15 struct perf_cpu_map;
  16 struct print_callbacks;
  17
  18 enum {
  19         PERF_PMU_FORMAT_VALUE_CONFIG,
  20         PERF_PMU_FORMAT_VALUE_CONFIG1,
  21         PERF_PMU_FORMAT_VALUE_CONFIG2,
  22         PERF_PMU_FORMAT_VALUE_CONFIG3,
  23         PERF_PMU_FORMAT_VALUE_CONFIG_END,
  24 };
  25
  26 #define PERF_PMU_FORMAT_BITS 64
  27 #define MAX_PMU_NAME_LEN 128
  28
  29 struct perf_event_attr;
  30
  31 struct perf_pmu_caps {
  32         char *name;
  33         char *value;
  34         struct list_head list;
  35 };
  36
  37 /**
  38  * struct perf_pmu
  39  */
  40 struct perf_pmu {
  41         /** @name: The name of the PMU such as "cpu". */
  42         char *name;
  43         /**
  44          * @alias_name: Optional alternate name for the PMU determined in
  45          * architecture specific code.
  46          */
  47         char *alias_name;
  48         /**
  49          * @id: Optional PMU identifier read from
  50          * <sysfs>/bus/event_source/devices/<name>/identifier.
  51          */
  52         char *id;
  53         /**
  54          * @type: Perf event attributed type value, read from
  55          * <sysfs>/bus/event_source/devices/<name>/type.
  56          */
  57         __u32 type;
  58         /**
  59          * @selectable: Can the PMU name be selected as if it were an event?
  60          */
  61         bool selectable;
  62         /**
  63          * @is_core: Is the PMU the core CPU PMU? Determined by the name being
  64          * "cpu" or by the presence of
  65          * <sysfs>/bus/event_source/devices/<name>/cpus. There may be >1 core
  66          * PMU on systems like Intel hybrid.
  67          */
  68         bool is_core;
  69         /**
  70          * @is_uncore: Is the PMU not within the CPU core? Determined by the
  71          * presence of <sysfs>/bus/event_source/devices/<name>/cpumask.
  72          */
  73         bool is_uncore;
  74         /**
  75          * @auxtrace: Are events auxiliary events? Determined in architecture
  76          * specific code.
  77          */
  78         bool auxtrace;
  79         /**
  80          * @formats_checked: Only check PMU's formats are valid for
  81          * perf_event_attr once.
  82          */
  83         bool formats_checked;
  84         /** @config_masks_present: Are there config format values? */
  85         bool config_masks_present;
  86         /** @config_masks_computed: Set when masks are lazily computed. */
  87         bool config_masks_computed;
  88         /**
  89          * @max_precise: Number of levels of :ppp precision supported by the
  90          * PMU, read from
  91          * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.
  92          */
  93         int max_precise;
  94         /**
  95          * @default_config: Optional default perf_event_attr determined in
  96          * architecture specific code.
  97          */
  98         struct perf_event_attr *default_config;
  99         /**
 100          * @cpus: Empty or the contents of either of:
 101          * <sysfs>/bus/event_source/devices/<name>/cpumask.
 102          * <sysfs>/bus/event_source/devices/<cpu>/cpus.
 103          */
 104         struct perf_cpu_map *cpus;
 105         /**
 106          * @format: Holds the contents of files read from
 107          * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify
 108          * which event parameter changes what config, config1 or config2 bits.
 109          */
 110         struct list_head format;
 111         /**
 112          * @aliases: List of struct perf_pmu_alias. Each alias corresponds to an
 113          * event read from <sysfs>/bus/event_source/devices/<name>/events/ or
 114          * from json events in pmu-events.c.
 115          */
 116         struct list_head aliases;
 117         /** @caps_initialized: Has the list caps been initialized? */
 118         bool caps_initialized;
 119         /** @nr_caps: The length of the list caps. */
 120         u32 nr_caps;
 121         /**
 122          * @caps: Holds the contents of files read from
 123          * <sysfs>/bus/event_source/devices/<name>/caps/.
 124          *
 125          * The contents are pairs of the filename with the value of its
 126          * contents, for example, max_precise (see above) may have a value of 3.
 127          */
 128         struct list_head caps;
 129         /** @list: Element on pmus list in pmu.c. */
 130         struct list_head list;
 131
 132         /**
 133          * @config_masks: Derived from the PMU's format data, bits that are
 134          * valid within the config value.
 135          */
 136         __u64 config_masks[PERF_PMU_FORMAT_VALUE_CONFIG_END];
 137
 138         /**
 139          * @missing_features: Features to inhibit when events on this PMU are
 140          * opened.
 141          */
 142         struct {
 143                 /**
 144                  * @exclude_guest: Disables perf_event_attr exclude_guest and
 145                  * exclude_host.
 146                  */
 147                 bool exclude_guest;
 148         } missing_features;
 149 };
 150
 151 /** @perf_pmu__fake: A special global PMU used for testing. */
 152 extern struct perf_pmu perf_pmu__fake;
 153
 154 struct perf_pmu_info {
 155         const char *unit;
 156         double scale;
 157         bool per_pkg;
 158         bool snapshot;
 159 };
 160
 161 #define UNIT_MAX_LEN    31 /* max length for event unit name */
 162
 163 /**
 164  * struct perf_pmu_alias - An event either read from sysfs or builtin in
 165  * pmu-events.c, created by parsing the pmu-events json files.
 166  */
 167 struct perf_pmu_alias {
 168         /** @name: Name of the event like "mem-loads". */
 169         char *name;
 170         /** @desc: Optional short description of the event. */
 171         char *desc;
 172         /** @long_desc: Optional long description. */
 173         char *long_desc;
 174         /**
 175          * @topic: Optional topic such as cache or pipeline, particularly for
 176          * json events.
 177          */
 178         char *topic;
 179         /**
 180          * @str: Comma separated parameter list like
 181          * "event=0xcd,umask=0x1,ldlat=0x3".
 182          */
 183         char *str;
 184         /** @terms: Owned list of the original parsed parameters. */
 185         struct list_head terms;
 186         /** @list: List element of struct perf_pmu aliases. */
 187         struct list_head list;
 188         /** @unit: Units for the event, such as bytes or cache lines. */
 189         char unit[UNIT_MAX_LEN+1];
 190         /** @scale: Value to scale read counter values by. */
 191         double scale;
 192         /**
 193          * @per_pkg: Does the file
 194          * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or
 195          * equivalent json value exist and have the value 1.
 196          */
 197         bool per_pkg;
 198         /**
 199          * @snapshot: Does the file
 200          * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot
 201          * exist and have the value 1.
 202          */
 203         bool snapshot;
 204         /**
 205          * @deprecated: Is the event hidden and so not shown in perf list by
 206          * default.
 207          */
 208         bool deprecated;
 209         /**
 210          * @pmu_name: The name copied from the json struct pmu_event. This can
 211          * differ from the PMU name as it won't have suffixes.
 212          */
 213         char *pmu_name;
 214 };
 215
 216 void pmu_add_sys_aliases(struct list_head *head, struct perf_pmu *pmu);
 217 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
 218                      struct list_head *head_terms,
 219                      struct parse_events_error *error);
 220 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
 221                            struct perf_event_attr *attr,
 222                            struct list_head *head_terms,
 223                            bool zero, struct parse_events_error *error);
 224 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name);
 225 int perf_pmu__format_type(struct list_head *formats, const char *name);
 226 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
 227                           struct perf_pmu_info *info);
 228 struct list_head *perf_pmu__alias(struct perf_pmu *pmu,
 229                                   struct list_head *head_terms);
 230 void perf_pmu_error(struct list_head *list, char *name, void *scanner, char const *msg);
 231
 232 int perf_pmu__new_format(struct list_head *list, char *name,
 233                          int config, unsigned long *bits);
 234 void perf_pmu__set_format(unsigned long *bits, long from, long to);
 235 int perf_pmu__format_parse(int dirfd, struct list_head *head);
 236 void perf_pmu__del_formats(struct list_head *formats);
 237 bool perf_pmu__has_format(const struct perf_pmu *pmu, const char *name);
 238
 239 bool is_pmu_core(const char *name);
 240 bool perf_pmu__supports_legacy_cache(const struct perf_pmu *pmu);
 241 bool perf_pmu__auto_merge_stats(const struct perf_pmu *pmu);
 242 bool perf_pmu__have_event(const struct perf_pmu *pmu, const char *name);
 243 /**
 244  * perf_pmu_is_software - is the PMU a software PMU as in it uses the
 245  *                        perf_sw_context in the kernel?
 246  */
 247 bool perf_pmu__is_software(const struct perf_pmu *pmu);
 248
 249 FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name);
 250 FILE *perf_pmu__open_file_at(struct perf_pmu *pmu, int dirfd, const char *name);
 251
 252 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt, ...) __scanf(3, 4);
 253 int perf_pmu__scan_file_at(struct perf_pmu *pmu, int dirfd, const char *name,
 254                            const char *fmt, ...) __scanf(4, 5);
 255
 256 bool perf_pmu__file_exists(struct perf_pmu *pmu, const char *name);
 257
 258 int perf_pmu__test(void);
 259
 260 struct perf_event_attr *perf_pmu__get_default_config(struct perf_pmu *pmu);
 261 void pmu_add_cpu_aliases_table(struct list_head *head, struct perf_pmu *pmu,
 262                                const struct pmu_events_table *table);
 263
 264 char *perf_pmu__getcpuid(struct perf_pmu *pmu);
 265 const struct pmu_events_table *pmu_events_table__find(void);
 266 const struct pmu_metrics_table *pmu_metrics_table__find(void);
 267 void perf_pmu_free_alias(struct perf_pmu_alias *alias);
 268
 269 int perf_pmu__convert_scale(const char *scale, char **end, double *sval);
 270
 271 int perf_pmu__caps_parse(struct perf_pmu *pmu);
 272
 273 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
 274                                    const char *name, int config_num,
 275                                    const char *config_name);
 276 void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu);
 277
 278 int perf_pmu__match(char *pattern, char *name, char *tok);
 279
 280 char *pmu_find_real_name(const char *name);
 281 char *pmu_find_alias_name(const char *name);
 282 double perf_pmu__cpu_slots_per_cycle(void);
 283 int perf_pmu__event_source_devices_scnprintf(char *pathname, size_t size);
 284 int perf_pmu__pathname_scnprintf(char *buf, size_t size,
 285                                  const char *pmu_name, const char *filename);
 286 int perf_pmu__event_source_devices_fd(void);
 287 int perf_pmu__pathname_fd(int dirfd, const char *pmu_name, const char *filename, int flags);
 288
 289 struct perf_pmu *perf_pmu__lookup(struct list_head *pmus, int dirfd, const char *lookup_name);
 290 struct perf_pmu *perf_pmu__create_placeholder_core_pmu(struct list_head *core_pmus);
 291 void perf_pmu__delete(struct perf_pmu *pmu);
 292 struct perf_pmu *pmu__find_core_pmu(void);
 293
 294 #endif /* __PMU_H */