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