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 <stdbool.h>
   9 #include "parse-events.h"
  10 #include "pmu-events/pmu-events.h"
  11
  12 struct perf_evsel_config_term;
  13
  14 enum {
  15         PERF_PMU_FORMAT_VALUE_CONFIG,
  16         PERF_PMU_FORMAT_VALUE_CONFIG1,
  17         PERF_PMU_FORMAT_VALUE_CONFIG2,
  18 };
  19
  20 #define PERF_PMU_FORMAT_BITS 64
  21 #define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"
  22
  23 struct perf_event_attr;
  24
  25 struct perf_pmu {
  26         char *name;
  27         __u32 type;
  28         bool selectable;
  29         bool is_uncore;
  30         bool auxtrace;
  31         int max_precise;
  32         struct perf_event_attr *default_config;
  33         struct perf_cpu_map *cpus;
  34         struct list_head format;  /* HEAD struct perf_pmu_format -> list */
  35         struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
  36         struct list_head list;    /* ELEM */
  37 };
  38
  39 struct perf_pmu_info {
  40         const char *unit;
  41         const char *metric_expr;
  42         const char *metric_name;
  43         double scale;
  44         bool per_pkg;
  45         bool snapshot;
  46 };
  47
  48 #define UNIT_MAX_LEN    31 /* max length for event unit name */
  49
  50 struct perf_pmu_alias {
  51         char *name;
  52         char *desc;
  53         char *long_desc;
  54         char *topic;
  55         char *str;
  56         struct list_head terms; /* HEAD struct parse_events_term -> list */
  57         struct list_head list;  /* ELEM */
  58         char unit[UNIT_MAX_LEN+1];
  59         double scale;
  60         bool per_pkg;
  61         bool snapshot;
  62         bool deprecated;
  63         char *metric_expr;
  64         char *metric_name;
  65 };
  66
  67 struct perf_pmu *perf_pmu__find(const char *name);
  68 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
  69                      struct list_head *head_terms,
  70                      struct parse_events_error *error);
  71 int perf_pmu__config_terms(struct list_head *formats,
  72                            struct perf_event_attr *attr,
  73                            struct list_head *head_terms,
  74                            bool zero, struct parse_events_error *error);
  75 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name);
  76 int perf_pmu__format_type(struct list_head *formats, const char *name);
  77 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
  78                           struct perf_pmu_info *info);
  79 struct list_head *perf_pmu__alias(struct perf_pmu *pmu,
  80                                   struct list_head *head_terms);
  81 int perf_pmu_wrap(void);
  82 void perf_pmu_error(struct list_head *list, char *name, char const *msg);
  83
  84 int perf_pmu__new_format(struct list_head *list, char *name,
  85                          int config, unsigned long *bits);
  86 void perf_pmu__set_format(unsigned long *bits, long from, long to);
  87 int perf_pmu__format_parse(char *dir, struct list_head *head);
  88
  89 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu);
  90
  91 bool is_pmu_core(const char *name);
  92 void print_pmu_events(const char *event_glob, bool name_only, bool quiet,
  93                       bool long_desc, bool details_flag,
  94                       bool deprecated);
  95 bool pmu_have_event(const char *pname, const char *name);
  96
  97 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt, ...) __scanf(3, 4);
  98
  99 int perf_pmu__test(void);
 100
 101 struct perf_event_attr *perf_pmu__get_default_config(struct perf_pmu *pmu);
 102 void pmu_add_cpu_aliases_map(struct list_head *head, struct perf_pmu *pmu,
 103                              struct pmu_events_map *map);
 104
 105 struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu);
 106 bool pmu_uncore_alias_match(const char *pmu_name, const char *name);
 107
 108 int perf_pmu__convert_scale(const char *scale, char **end, double *sval);
 109
 110 #endif /* __PMU_H */