xref: /openbmc/linux/tools/perf/util/pmu.h (revision 5af155f9)
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_CONFIG3,
23 	PERF_PMU_FORMAT_VALUE_CONFIG_END,
24 };
25 
26 #define PERF_PMU_FORMAT_BITS 64
27 #define MAX_PMU_NAME_LEN 128
28 
29 struct perf_event_attr;
30 
31 struct perf_pmu_caps {
32 	char *name;
33 	char *value;
34 	struct list_head list;
35 };
36 
37 /**
38  * struct perf_pmu
39  */
40 struct perf_pmu {
41 	/** @name: The name of the PMU such as "cpu". */
42 	const char *name;
43 	/**
44 	 * @alias_name: Optional alternate name for the PMU determined in
45 	 * architecture specific code.
46 	 */
47 	char *alias_name;
48 	/**
49 	 * @id: Optional PMU identifier read from
50 	 * <sysfs>/bus/event_source/devices/<name>/identifier.
51 	 */
52 	const char *id;
53 	/**
54 	 * @type: Perf event attributed type value, read from
55 	 * <sysfs>/bus/event_source/devices/<name>/type.
56 	 */
57 	__u32 type;
58 	/**
59 	 * @selectable: Can the PMU name be selected as if it were an event?
60 	 */
61 	bool selectable;
62 	/**
63 	 * @is_core: Is the PMU the core CPU PMU? Determined by the name being
64 	 * "cpu" or by the presence of
65 	 * <sysfs>/bus/event_source/devices/<name>/cpus. There may be >1 core
66 	 * PMU on systems like Intel hybrid.
67 	 */
68 	bool is_core;
69 	/**
70 	 * @is_uncore: Is the PMU not within the CPU core? Determined by the
71 	 * presence of <sysfs>/bus/event_source/devices/<name>/cpumask.
72 	 */
73 	bool is_uncore;
74 	/**
75 	 * @auxtrace: Are events auxiliary events? Determined in architecture
76 	 * specific code.
77 	 */
78 	bool auxtrace;
79 	/**
80 	 * @formats_checked: Only check PMU's formats are valid for
81 	 * perf_event_attr once.
82 	 */
83 	bool formats_checked;
84 	/** @config_masks_present: Are there config format values? */
85 	bool config_masks_present;
86 	/** @config_masks_computed: Set when masks are lazily computed. */
87 	bool config_masks_computed;
88 	/**
89 	 * @max_precise: Number of levels of :ppp precision supported by the
90 	 * PMU, read from
91 	 * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.
92 	 */
93 	int max_precise;
94 	/**
95 	 * @default_config: Optional default perf_event_attr determined in
96 	 * architecture specific code.
97 	 */
98 	struct perf_event_attr *default_config;
99 	/**
100 	 * @cpus: Empty or the contents of either of:
101 	 * <sysfs>/bus/event_source/devices/<name>/cpumask.
102 	 * <sysfs>/bus/event_source/devices/<cpu>/cpus.
103 	 */
104 	struct perf_cpu_map *cpus;
105 	/**
106 	 * @format: Holds the contents of files read from
107 	 * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify
108 	 * which event parameter changes what config, config1 or config2 bits.
109 	 */
110 	struct list_head format;
111 	/**
112 	 * @aliases: List of struct perf_pmu_alias. Each alias corresponds to an
113 	 * event read from <sysfs>/bus/event_source/devices/<name>/events/ or
114 	 * from json events in pmu-events.c.
115 	 */
116 	struct list_head aliases;
117 	/**
118 	 * @events_table: The events table for json events in pmu-events.c.
119 	 */
120 	const struct pmu_events_table *events_table;
121 	/** @sysfs_aliases: Number of sysfs aliases loaded. */
122 	uint32_t sysfs_aliases;
123 	/** @cpu_json_aliases: Number of json event aliases loaded specific to the CPUID. */
124 	uint32_t cpu_json_aliases;
125 	/** @sys_json_aliases: Number of json event aliases loaded matching the PMU's identifier. */
126 	uint32_t sys_json_aliases;
127 	/** @sysfs_aliases_loaded: Are sysfs aliases loaded from disk? */
128 	bool sysfs_aliases_loaded;
129 	/**
130 	 * @cpu_aliases_added: Have all json events table entries for the PMU
131 	 * been added?
132 	 */
133 	bool cpu_aliases_added;
134 	/** @caps_initialized: Has the list caps been initialized? */
135 	bool caps_initialized;
136 	/** @nr_caps: The length of the list caps. */
137 	u32 nr_caps;
138 	/**
139 	 * @caps: Holds the contents of files read from
140 	 * <sysfs>/bus/event_source/devices/<name>/caps/.
141 	 *
142 	 * The contents are pairs of the filename with the value of its
143 	 * contents, for example, max_precise (see above) may have a value of 3.
144 	 */
145 	struct list_head caps;
146 	/** @list: Element on pmus list in pmu.c. */
147 	struct list_head list;
148 
149 	/**
150 	 * @config_masks: Derived from the PMU's format data, bits that are
151 	 * valid within the config value.
152 	 */
153 	__u64 config_masks[PERF_PMU_FORMAT_VALUE_CONFIG_END];
154 
155 	/**
156 	 * @missing_features: Features to inhibit when events on this PMU are
157 	 * opened.
158 	 */
159 	struct {
160 		/**
161 		 * @exclude_guest: Disables perf_event_attr exclude_guest and
162 		 * exclude_host.
163 		 */
164 		bool exclude_guest;
165 	} missing_features;
166 };
167 
168 /** @perf_pmu__fake: A special global PMU used for testing. */
169 extern struct perf_pmu perf_pmu__fake;
170 
171 struct perf_pmu_info {
172 	const char *unit;
173 	double scale;
174 	bool per_pkg;
175 	bool snapshot;
176 };
177 
178 struct pmu_event_info {
179 	const struct perf_pmu *pmu;
180 	const char *name;
181 	const char* alias;
182 	const char *scale_unit;
183 	const char *desc;
184 	const char *long_desc;
185 	const char *encoding_desc;
186 	const char *topic;
187 	const char *pmu_name;
188 	const char *str;
189 	bool deprecated;
190 };
191 
192 typedef int (*pmu_event_callback)(void *state, struct pmu_event_info *info);
193 
194 void pmu_add_sys_aliases(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(struct perf_pmu *pmu,
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 perf_pmu *pmu, const char *name);
203 int perf_pmu__format_type(struct perf_pmu *pmu, const char *name);
204 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
205 			  struct perf_pmu_info *info, struct parse_events_error *err);
206 int perf_pmu__find_event(struct perf_pmu *pmu, const char *event, void *state, pmu_event_callback cb);
207 
208 int perf_pmu__format_parse(struct perf_pmu *pmu, int dirfd, bool eager_load);
209 void perf_pmu_format__set_value(void *format, int config, unsigned long *bits);
210 bool perf_pmu__has_format(const struct perf_pmu *pmu, const char *name);
211 
212 bool is_pmu_core(const char *name);
213 bool perf_pmu__supports_legacy_cache(const struct perf_pmu *pmu);
214 bool perf_pmu__auto_merge_stats(const struct perf_pmu *pmu);
215 bool perf_pmu__have_event(struct perf_pmu *pmu, const char *name);
216 size_t perf_pmu__num_events(struct perf_pmu *pmu);
217 int perf_pmu__for_each_event(struct perf_pmu *pmu, bool skip_duplicate_pmus,
218 			     void *state, pmu_event_callback cb);
219 bool pmu__name_match(const struct perf_pmu *pmu, const char *pmu_name);
220 
221 /**
222  * perf_pmu_is_software - is the PMU a software PMU as in it uses the
223  *                        perf_sw_context in the kernel?
224  */
225 bool perf_pmu__is_software(const struct perf_pmu *pmu);
226 
227 FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name);
228 FILE *perf_pmu__open_file_at(struct perf_pmu *pmu, int dirfd, const char *name);
229 
230 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt, ...) __scanf(3, 4);
231 int perf_pmu__scan_file_at(struct perf_pmu *pmu, int dirfd, const char *name,
232 			   const char *fmt, ...) __scanf(4, 5);
233 
234 bool perf_pmu__file_exists(struct perf_pmu *pmu, const char *name);
235 
236 int perf_pmu__test(void);
237 
238 struct perf_event_attr *perf_pmu__get_default_config(struct perf_pmu *pmu);
239 void pmu_add_cpu_aliases_table(struct perf_pmu *pmu,
240 			       const struct pmu_events_table *table);
241 
242 char *perf_pmu__getcpuid(struct perf_pmu *pmu);
243 const struct pmu_events_table *pmu_events_table__find(void);
244 const struct pmu_metrics_table *pmu_metrics_table__find(void);
245 bool pmu_uncore_identifier_match(const char *compat, const char *id);
246 
247 int perf_pmu__convert_scale(const char *scale, char **end, double *sval);
248 
249 int perf_pmu__caps_parse(struct perf_pmu *pmu);
250 
251 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
252 				   const char *name, int config_num,
253 				   const char *config_name);
254 void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu);
255 
256 int perf_pmu__match(const char *pattern, const char *name, const char *tok);
257 
258 const char *pmu_find_real_name(const char *name);
259 const char *pmu_find_alias_name(const char *name);
260 double perf_pmu__cpu_slots_per_cycle(void);
261 int perf_pmu__event_source_devices_scnprintf(char *pathname, size_t size);
262 int perf_pmu__pathname_scnprintf(char *buf, size_t size,
263 				 const char *pmu_name, const char *filename);
264 int perf_pmu__event_source_devices_fd(void);
265 int perf_pmu__pathname_fd(int dirfd, const char *pmu_name, const char *filename, int flags);
266 
267 struct perf_pmu *perf_pmu__lookup(struct list_head *pmus, int dirfd, const char *lookup_name);
268 struct perf_pmu *perf_pmu__create_placeholder_core_pmu(struct list_head *core_pmus);
269 void perf_pmu__delete(struct perf_pmu *pmu);
270 struct perf_pmu *perf_pmus__find_core_pmu(void);
271 const char *perf_pmu__name_from_config(struct perf_pmu *pmu, u64 config);
272 
273 #endif /* __PMU_H */
274