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