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 "parse-events.h" 11 #include "pmu-events/pmu-events.h" 12 13 struct evsel_config_term; 14 struct perf_cpu_map; 15 16 enum { 17 PERF_PMU_FORMAT_VALUE_CONFIG, 18 PERF_PMU_FORMAT_VALUE_CONFIG1, 19 PERF_PMU_FORMAT_VALUE_CONFIG2, 20 PERF_PMU_FORMAT_VALUE_CONFIG_END, 21 }; 22 23 #define PERF_PMU_FORMAT_BITS 64 24 #define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/" 25 #define CPUS_TEMPLATE_CPU "%s/bus/event_source/devices/%s/cpus" 26 #define MAX_PMU_NAME_LEN 128 27 28 struct perf_event_attr; 29 30 struct perf_pmu_caps { 31 char *name; 32 char *value; 33 struct list_head list; 34 }; 35 36 struct perf_pmu { 37 char *name; 38 char *alias_name; 39 char *id; 40 __u32 type; 41 bool selectable; 42 bool is_uncore; 43 bool is_hybrid; 44 bool auxtrace; 45 int max_precise; 46 struct perf_event_attr *default_config; 47 struct perf_cpu_map *cpus; 48 struct list_head format; /* HEAD struct perf_pmu_format -> list */ 49 struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */ 50 struct list_head caps; /* HEAD struct perf_pmu_caps -> list */ 51 struct list_head list; /* ELEM */ 52 struct list_head hybrid_list; 53 }; 54 55 extern struct perf_pmu perf_pmu__fake; 56 57 struct perf_pmu_info { 58 const char *unit; 59 const char *metric_expr; 60 const char *metric_name; 61 double scale; 62 bool per_pkg; 63 bool snapshot; 64 }; 65 66 #define UNIT_MAX_LEN 31 /* max length for event unit name */ 67 68 struct perf_pmu_alias { 69 char *name; 70 char *desc; 71 char *long_desc; 72 char *topic; 73 char *str; 74 struct list_head terms; /* HEAD struct parse_events_term -> list */ 75 struct list_head list; /* ELEM */ 76 char unit[UNIT_MAX_LEN+1]; 77 double scale; 78 bool per_pkg; 79 bool snapshot; 80 bool deprecated; 81 char *metric_expr; 82 char *metric_name; 83 char *pmu_name; 84 }; 85 86 struct perf_pmu *perf_pmu__find(const char *name); 87 struct perf_pmu *perf_pmu__find_by_type(unsigned int type); 88 void pmu_add_sys_aliases(struct list_head *head, struct perf_pmu *pmu); 89 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr, 90 struct list_head *head_terms, 91 struct parse_events_error *error); 92 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats, 93 struct perf_event_attr *attr, 94 struct list_head *head_terms, 95 bool zero, struct parse_events_error *error); 96 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name); 97 int perf_pmu__format_type(struct list_head *formats, const char *name); 98 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms, 99 struct perf_pmu_info *info); 100 struct list_head *perf_pmu__alias(struct perf_pmu *pmu, 101 struct list_head *head_terms); 102 void perf_pmu_error(struct list_head *list, char *name, char const *msg); 103 104 int perf_pmu__new_format(struct list_head *list, char *name, 105 int config, unsigned long *bits); 106 void perf_pmu__set_format(unsigned long *bits, long from, long to); 107 int perf_pmu__format_parse(char *dir, struct list_head *head); 108 void perf_pmu__del_formats(struct list_head *formats); 109 110 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu); 111 112 bool is_pmu_core(const char *name); 113 void print_pmu_events(const char *event_glob, bool name_only, bool quiet, 114 bool long_desc, bool details_flag, 115 bool deprecated); 116 bool pmu_have_event(const char *pname, const char *name); 117 118 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt, ...) __scanf(3, 4); 119 120 int perf_pmu__test(void); 121 122 struct perf_event_attr *perf_pmu__get_default_config(struct perf_pmu *pmu); 123 void pmu_add_cpu_aliases_map(struct list_head *head, struct perf_pmu *pmu, 124 struct pmu_events_map *map); 125 126 struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu); 127 struct pmu_events_map *pmu_events_map__find(void); 128 bool pmu_uncore_alias_match(const char *pmu_name, const char *name); 129 void perf_pmu_free_alias(struct perf_pmu_alias *alias); 130 131 typedef int (*pmu_sys_event_iter_fn)(struct pmu_event *pe, void *data); 132 void pmu_for_each_sys_event(pmu_sys_event_iter_fn fn, void *data); 133 int perf_pmu__convert_scale(const char *scale, char **end, double *sval); 134 135 int perf_pmu__caps_parse(struct perf_pmu *pmu); 136 137 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config, 138 char *name); 139 void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu); 140 141 bool perf_pmu__has_hybrid(void); 142 int perf_pmu__match(char *pattern, char *name, char *tok); 143 144 int perf_pmu__cpus_match(struct perf_pmu *pmu, struct perf_cpu_map *cpus, 145 struct perf_cpu_map **mcpus_ptr, 146 struct perf_cpu_map **ucpus_ptr); 147 148 char *pmu_find_real_name(const char *name); 149 char *pmu_find_alias_name(const char *name); 150 #endif /* __PMU_H */ 151