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 <stdio.h> 11 #include "parse-events.h" 12 #include "pmu-events/pmu-events.h" 13 14 struct evsel_config_term; 15 struct perf_cpu_map; 16 struct print_callbacks; 17 18 enum { 19 PERF_PMU_FORMAT_VALUE_CONFIG, 20 PERF_PMU_FORMAT_VALUE_CONFIG1, 21 PERF_PMU_FORMAT_VALUE_CONFIG2, 22 PERF_PMU_FORMAT_VALUE_CONFIG_END, 23 }; 24 25 #define PERF_PMU_FORMAT_BITS 64 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 /** 37 * struct perf_pmu - hi 38 */ 39 struct perf_pmu { 40 /** @name: The name of the PMU such as "cpu". */ 41 char *name; 42 /** 43 * @alias_name: Optional alternate name for the PMU determined in 44 * architecture specific code. 45 */ 46 char *alias_name; 47 /** 48 * @id: Optional PMU identifier read from 49 * <sysfs>/bus/event_source/devices/<name>/identifier. 50 */ 51 char *id; 52 /** 53 * @type: Perf event attributed type value, read from 54 * <sysfs>/bus/event_source/devices/<name>/type. 55 */ 56 __u32 type; 57 /** 58 * @selectable: Can the PMU name be selected as if it were an event? 59 */ 60 bool selectable; 61 /** 62 * @is_uncore: Is the PMU not within the CPU core? Determined by the 63 * presence of <sysfs>/bus/event_source/devices/<name>/cpumask. 64 */ 65 bool is_uncore; 66 /** 67 * @auxtrace: Are events auxiliary events? Determined in architecture 68 * specific code. 69 */ 70 bool auxtrace; 71 /** 72 * @max_precise: Number of levels of :ppp precision supported by the 73 * PMU, read from 74 * <sysfs>/bus/event_source/devices/<name>/caps/max_precise. 75 */ 76 int max_precise; 77 /** 78 * @default_config: Optional default perf_event_attr determined in 79 * architecture specific code. 80 */ 81 struct perf_event_attr *default_config; 82 /** 83 * @cpus: Empty or the contents of either of: 84 * <sysfs>/bus/event_source/devices/<name>/cpumask. 85 * <sysfs>/bus/event_source/devices/<cpu>/cpus. 86 */ 87 struct perf_cpu_map *cpus; 88 /** 89 * @format: Holds the contents of files read from 90 * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify 91 * which event parameter changes what config, config1 or config2 bits. 92 */ 93 struct list_head format; 94 /** 95 * @aliases: List of struct perf_pmu_alias. Each alias corresponds to an 96 * event read from <sysfs>/bus/event_source/devices/<name>/events/ or 97 * from json events in pmu-events.c. 98 */ 99 struct list_head aliases; 100 /** @caps_initialized: Has the list caps been initialized? */ 101 bool caps_initialized; 102 /** @nr_caps: The length of the list caps. */ 103 u32 nr_caps; 104 /** 105 * @caps: Holds the contents of files read from 106 * <sysfs>/bus/event_source/devices/<name>/caps/. 107 * 108 * The contents are pairs of the filename with the value of its 109 * contents, for example, max_precise (see above) may have a value of 3. 110 */ 111 struct list_head caps; 112 /** @list: Element on pmus list in pmu.c. */ 113 struct list_head list; 114 /** @hybrid_list: Element on perf_pmu__hybrid_pmus. */ 115 struct list_head hybrid_list; 116 117 /** 118 * @missing_features: Features to inhibit when events on this PMU are 119 * opened. 120 */ 121 struct { 122 /** 123 * @exclude_guest: Disables perf_event_attr exclude_guest and 124 * exclude_host. 125 */ 126 bool exclude_guest; 127 } missing_features; 128 }; 129 130 /** @perf_pmu__fake: A special global PMU used for testing. */ 131 extern struct perf_pmu perf_pmu__fake; 132 133 struct perf_pmu_info { 134 const char *unit; 135 double scale; 136 bool per_pkg; 137 bool snapshot; 138 }; 139 140 #define UNIT_MAX_LEN 31 /* max length for event unit name */ 141 142 /** 143 * struct perf_pmu_alias - An event either read from sysfs or builtin in 144 * pmu-events.c, created by parsing the pmu-events json files. 145 */ 146 struct perf_pmu_alias { 147 /** @name: Name of the event like "mem-loads". */ 148 char *name; 149 /** @desc: Optional short description of the event. */ 150 char *desc; 151 /** @long_desc: Optional long description. */ 152 char *long_desc; 153 /** 154 * @topic: Optional topic such as cache or pipeline, particularly for 155 * json events. 156 */ 157 char *topic; 158 /** 159 * @str: Comma separated parameter list like 160 * "event=0xcd,umask=0x1,ldlat=0x3". 161 */ 162 char *str; 163 /** @terms: Owned list of the original parsed parameters. */ 164 struct list_head terms; 165 /** @list: List element of struct perf_pmu aliases. */ 166 struct list_head list; 167 /** @unit: Units for the event, such as bytes or cache lines. */ 168 char unit[UNIT_MAX_LEN+1]; 169 /** @scale: Value to scale read counter values by. */ 170 double scale; 171 /** 172 * @per_pkg: Does the file 173 * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or 174 * equivalent json value exist and have the value 1. 175 */ 176 bool per_pkg; 177 /** 178 * @snapshot: Does the file 179 * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot 180 * exist and have the value 1. 181 */ 182 bool snapshot; 183 /** 184 * @deprecated: Is the event hidden and so not shown in perf list by 185 * default. 186 */ 187 bool deprecated; 188 /** @pmu_name: The name copied from struct perf_pmu. */ 189 char *pmu_name; 190 }; 191 192 struct perf_pmu *perf_pmu__find(const char *name); 193 struct perf_pmu *perf_pmu__find_by_type(unsigned int type); 194 void pmu_add_sys_aliases(struct list_head *head, struct perf_pmu *pmu); 195 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr, 196 struct list_head *head_terms, 197 struct parse_events_error *error); 198 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats, 199 struct perf_event_attr *attr, 200 struct list_head *head_terms, 201 bool zero, struct parse_events_error *error); 202 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name); 203 int perf_pmu__format_type(struct list_head *formats, const char *name); 204 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms, 205 struct perf_pmu_info *info); 206 struct list_head *perf_pmu__alias(struct perf_pmu *pmu, 207 struct list_head *head_terms); 208 void perf_pmu_error(struct list_head *list, char *name, char const *msg); 209 210 int perf_pmu__new_format(struct list_head *list, char *name, 211 int config, unsigned long *bits); 212 void perf_pmu__set_format(unsigned long *bits, long from, long to); 213 int perf_pmu__format_parse(char *dir, struct list_head *head); 214 void perf_pmu__del_formats(struct list_head *formats); 215 216 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu); 217 218 bool is_pmu_core(const char *name); 219 void print_pmu_events(const struct print_callbacks *print_cb, void *print_state); 220 bool pmu_have_event(const char *pname, const char *name); 221 222 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt, ...) __scanf(3, 4); 223 224 bool perf_pmu__file_exists(struct perf_pmu *pmu, const char *name); 225 226 int perf_pmu__test(void); 227 228 struct perf_event_attr *perf_pmu__get_default_config(struct perf_pmu *pmu); 229 void pmu_add_cpu_aliases_table(struct list_head *head, struct perf_pmu *pmu, 230 const struct pmu_events_table *table); 231 232 char *perf_pmu__getcpuid(struct perf_pmu *pmu); 233 const struct pmu_events_table *pmu_events_table__find(void); 234 const struct pmu_metrics_table *pmu_metrics_table__find(void); 235 bool pmu_uncore_alias_match(const char *pmu_name, const char *name); 236 void perf_pmu_free_alias(struct perf_pmu_alias *alias); 237 238 int perf_pmu__convert_scale(const char *scale, char **end, double *sval); 239 240 int perf_pmu__caps_parse(struct perf_pmu *pmu); 241 242 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config, 243 const char *name); 244 void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu); 245 246 bool perf_pmu__has_hybrid(void); 247 int perf_pmu__match(char *pattern, char *name, char *tok); 248 249 int perf_pmu__cpus_match(struct perf_pmu *pmu, struct perf_cpu_map *cpus, 250 struct perf_cpu_map **mcpus_ptr, 251 struct perf_cpu_map **ucpus_ptr); 252 253 char *pmu_find_real_name(const char *name); 254 char *pmu_find_alias_name(const char *name); 255 double perf_pmu__cpu_slots_per_cycle(void); 256 int perf_pmu__event_source_devices_scnprintf(char *pathname, size_t size); 257 int perf_pmu__pathname_scnprintf(char *buf, size_t size, 258 const char *pmu_name, const char *filename); 259 FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name); 260 261 #endif /* __PMU_H */ 262