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