blob: fc683bc417152d338fb4cc9b23d7519ab479ed1d [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Jiri Olsacd82a322012-03-15 20:09:17 +01002#include <linux/list.h>
Sukadev Bhattiproluc5de47f2015-06-10 00:25:07 -07003#include <linux/compiler.h>
Arnaldo Carvalho de Melo32858482019-06-26 11:42:03 -03004#include <linux/string.h>
Arnaldo Carvalho de Melo7f7c5362019-07-04 11:32:27 -03005#include <linux/zalloc.h>
Jin Yaoc47a5592021-07-01 14:42:53 +08006#include <linux/ctype.h>
Arnaldo Carvalho de Melofa0d9842019-08-30 12:52:25 -03007#include <subcmd/pager.h>
Jiri Olsacd82a322012-03-15 20:09:17 +01008#include <sys/types.h>
Arnaldo Carvalho de Meloa43783a2017-04-18 10:46:11 -03009#include <errno.h>
Arnaldo Carvalho de Meloc23c2a02017-09-11 10:50:26 -030010#include <fcntl.h>
Arnaldo Carvalho de Melo7a8ef4c2017-04-19 20:57:47 -030011#include <sys/stat.h>
Jiri Olsacd82a322012-03-15 20:09:17 +010012#include <unistd.h>
13#include <stdio.h>
Adrian Hunterdc0a6202014-07-31 09:00:49 +030014#include <stdbool.h>
Adrian Hunter7d4bdab2014-07-31 09:00:50 +030015#include <stdarg.h>
Jiri Olsacd82a322012-03-15 20:09:17 +010016#include <dirent.h>
Borislav Petkovcd0cfad2013-12-09 17:14:24 +010017#include <api/fs/fs.h>
Stephane Eranian410136f2013-11-12 17:58:49 +010018#include <locale.h>
William Cohenfbc28442017-12-04 09:57:28 -050019#include <regex.h>
Jiri Olsa9c3516d2019-07-21 13:24:30 +020020#include <perf/cpumap.h>
Jin Yaoc47a5592021-07-01 14:42:53 +080021#include <fnmatch.h>
Arnaldo Carvalho de Melo5e51b0b2019-08-22 10:48:31 -030022#include "debug.h"
Adrian Huntere12ee9f2020-04-01 13:16:09 +030023#include "evsel.h"
Jiri Olsacd82a322012-03-15 20:09:17 +010024#include "pmu.h"
25#include "parse-events.h"
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -070026#include "header.h"
Arnaldo Carvalho de Meloa0675582017-04-17 16:51:59 -030027#include "string2.h"
Arnaldo Carvalho de Melofa0d9842019-08-30 12:52:25 -030028#include "strbuf.h"
Andi Kleend9664582019-11-20 16:15:11 -080029#include "fncache.h"
Jin Yao44462432021-04-27 15:01:18 +080030#include "pmu-hybrid.h"
Jiri Olsacd82a322012-03-15 20:09:17 +010031
Arnaldo Carvalho de Meloe46fc8d2020-06-09 13:23:24 -030032struct perf_pmu perf_pmu__fake;
33
Arnaldo Carvalho de Meloab1bf6532013-01-18 17:05:09 -030034struct perf_pmu_format {
35 char *name;
36 int value;
37 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
38 struct list_head list;
39};
40
Jiri Olsacd82a322012-03-15 20:09:17 +010041int perf_pmu_parse(struct list_head *list, char *name);
42extern FILE *perf_pmu_in;
43
44static LIST_HEAD(pmus);
Jin Yaoc5a26ea2021-04-27 15:01:19 +080045static bool hybrid_scanned;
Jiri Olsacd82a322012-03-15 20:09:17 +010046
47/*
48 * Parse & process all the sysfs attributes located under
49 * the directory specified in 'dir' parameter.
50 */
Jiri Olsacff7f952012-11-10 01:46:50 +010051int perf_pmu__format_parse(char *dir, struct list_head *head)
Jiri Olsacd82a322012-03-15 20:09:17 +010052{
53 struct dirent *evt_ent;
54 DIR *format_dir;
55 int ret = 0;
56
57 format_dir = opendir(dir);
58 if (!format_dir)
59 return -EINVAL;
60
61 while (!ret && (evt_ent = readdir(format_dir))) {
62 char path[PATH_MAX];
63 char *name = evt_ent->d_name;
64 FILE *file;
65
66 if (!strcmp(name, ".") || !strcmp(name, ".."))
67 continue;
68
69 snprintf(path, PATH_MAX, "%s/%s", dir, name);
70
71 ret = -EINVAL;
72 file = fopen(path, "r");
73 if (!file)
74 break;
75
76 perf_pmu_in = file;
77 ret = perf_pmu_parse(head, name);
78 fclose(file);
79 }
80
81 closedir(format_dir);
82 return ret;
83}
84
85/*
86 * Reading/parsing the default pmu format definition, which should be
87 * located at:
88 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
89 */
Adrian Hunterb6b96fb2013-07-04 16:20:25 +030090static int pmu_format(const char *name, struct list_head *format)
Jiri Olsacd82a322012-03-15 20:09:17 +010091{
Jiri Olsacd82a322012-03-15 20:09:17 +010092 char path[PATH_MAX];
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -030093 const char *sysfs = sysfs__mountpoint();
Jiri Olsacd82a322012-03-15 20:09:17 +010094
Jiri Olsacd82a322012-03-15 20:09:17 +010095 if (!sysfs)
96 return -1;
97
98 snprintf(path, PATH_MAX,
Robert Richter50a96672012-08-16 21:10:24 +020099 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
Jiri Olsacd82a322012-03-15 20:09:17 +0100100
Andi Kleend9664582019-11-20 16:15:11 -0800101 if (!file_available(path))
102 return 0;
Jiri Olsacd82a322012-03-15 20:09:17 +0100103
Jiri Olsacff7f952012-11-10 01:46:50 +0100104 if (perf_pmu__format_parse(path, format))
Jiri Olsacd82a322012-03-15 20:09:17 +0100105 return -1;
106
107 return 0;
108}
109
Jin Yaoa55ab7c2019-08-28 13:59:29 +0800110int perf_pmu__convert_scale(const char *scale, char **end, double *sval)
Andi Kleend02fc6b2017-01-03 07:08:23 -0800111{
112 char *lc;
113 int ret = 0;
114
115 /*
116 * save current locale
117 */
118 lc = setlocale(LC_NUMERIC, NULL);
119
120 /*
121 * The lc string may be allocated in static storage,
122 * so get a dynamic copy to make it survive setlocale
123 * call below.
124 */
125 lc = strdup(lc);
126 if (!lc) {
127 ret = -ENOMEM;
128 goto out;
129 }
130
131 /*
132 * force to C locale to ensure kernel
133 * scale string is converted correctly.
134 * kernel uses default C locale.
135 */
136 setlocale(LC_NUMERIC, "C");
137
138 *sval = strtod(scale, end);
139
140out:
141 /* restore locale */
142 setlocale(LC_NUMERIC, lc);
143 free(lc);
144 return ret;
145}
146
Stephane Eranian410136f2013-11-12 17:58:49 +0100147static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
148{
149 struct stat st;
150 ssize_t sret;
151 char scale[128];
152 int fd, ret = -1;
153 char path[PATH_MAX];
Stephane Eranian410136f2013-11-12 17:58:49 +0100154
Ben Hutchings11a64a02018-11-11 18:45:24 +0000155 scnprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
Stephane Eranian410136f2013-11-12 17:58:49 +0100156
157 fd = open(path, O_RDONLY);
158 if (fd == -1)
159 return -1;
160
161 if (fstat(fd, &st) < 0)
162 goto error;
163
164 sret = read(fd, scale, sizeof(scale)-1);
165 if (sret < 0)
166 goto error;
167
Madhavan Srinivasan9ecae062015-05-31 11:36:23 +0530168 if (scale[sret - 1] == '\n')
169 scale[sret - 1] = '\0';
170 else
171 scale[sret] = '\0';
172
Jin Yaoa55ab7c2019-08-28 13:59:29 +0800173 ret = perf_pmu__convert_scale(scale, NULL, &alias->scale);
Stephane Eranian410136f2013-11-12 17:58:49 +0100174error:
175 close(fd);
176 return ret;
177}
178
179static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
180{
181 char path[PATH_MAX];
182 ssize_t sret;
183 int fd;
184
Ben Hutchings11a64a02018-11-11 18:45:24 +0000185 scnprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
Stephane Eranian410136f2013-11-12 17:58:49 +0100186
187 fd = open(path, O_RDONLY);
188 if (fd == -1)
189 return -1;
190
Markus Trippelsdorfd85ce832015-12-14 16:44:40 +0100191 sret = read(fd, alias->unit, UNIT_MAX_LEN);
Stephane Eranian410136f2013-11-12 17:58:49 +0100192 if (sret < 0)
193 goto error;
194
195 close(fd);
196
Madhavan Srinivasan9ecae062015-05-31 11:36:23 +0530197 if (alias->unit[sret - 1] == '\n')
198 alias->unit[sret - 1] = '\0';
199 else
200 alias->unit[sret] = '\0';
Stephane Eranian410136f2013-11-12 17:58:49 +0100201
202 return 0;
203error:
204 close(fd);
205 alias->unit[0] = '\0';
206 return -1;
207}
208
Matt Fleming044330c2014-11-21 10:31:12 +0100209static int
210perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
211{
212 char path[PATH_MAX];
213 int fd;
214
Ben Hutchings11a64a02018-11-11 18:45:24 +0000215 scnprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
Matt Fleming044330c2014-11-21 10:31:12 +0100216
217 fd = open(path, O_RDONLY);
218 if (fd == -1)
219 return -1;
220
221 close(fd);
222
223 alias->per_pkg = true;
224 return 0;
225}
226
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100227static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
228 char *dir, char *name)
229{
230 char path[PATH_MAX];
231 int fd;
232
Ben Hutchings11a64a02018-11-11 18:45:24 +0000233 scnprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100234
235 fd = open(path, O_RDONLY);
236 if (fd == -1)
237 return -1;
238
239 alias->snapshot = true;
240 close(fd);
241 return 0;
242}
243
Thomas Richter6dde6422018-06-15 12:11:05 +0200244static void perf_pmu_assign_str(char *name, const char *field, char **old_str,
245 char **new_str)
246{
247 if (!*old_str)
248 goto set_new;
249
250 if (*new_str) { /* Have new string, check with old */
251 if (strcasecmp(*old_str, *new_str))
252 pr_debug("alias %s differs in field '%s'\n",
253 name, field);
254 zfree(old_str);
255 } else /* Nothing new --> keep old string */
256 return;
257set_new:
258 *old_str = *new_str;
259 *new_str = NULL;
260}
261
262static void perf_pmu_update_alias(struct perf_pmu_alias *old,
263 struct perf_pmu_alias *newalias)
264{
265 perf_pmu_assign_str(old->name, "desc", &old->desc, &newalias->desc);
266 perf_pmu_assign_str(old->name, "long_desc", &old->long_desc,
267 &newalias->long_desc);
268 perf_pmu_assign_str(old->name, "topic", &old->topic, &newalias->topic);
269 perf_pmu_assign_str(old->name, "metric_expr", &old->metric_expr,
270 &newalias->metric_expr);
271 perf_pmu_assign_str(old->name, "metric_name", &old->metric_name,
272 &newalias->metric_name);
273 perf_pmu_assign_str(old->name, "value", &old->str, &newalias->str);
274 old->scale = newalias->scale;
275 old->per_pkg = newalias->per_pkg;
276 old->snapshot = newalias->snapshot;
277 memcpy(old->unit, newalias->unit, sizeof(old->unit));
278}
279
280/* Delete an alias entry. */
Namhyung Kim22fe5a22020-09-15 12:18:18 +0900281void perf_pmu_free_alias(struct perf_pmu_alias *newalias)
Thomas Richter6dde6422018-06-15 12:11:05 +0200282{
283 zfree(&newalias->name);
284 zfree(&newalias->desc);
285 zfree(&newalias->long_desc);
286 zfree(&newalias->topic);
287 zfree(&newalias->str);
288 zfree(&newalias->metric_expr);
289 zfree(&newalias->metric_name);
Jin Yao32705de2021-04-27 15:01:17 +0800290 zfree(&newalias->pmu_name);
Thomas Richter6dde6422018-06-15 12:11:05 +0200291 parse_events_terms__purge(&newalias->terms);
292 free(newalias);
293}
294
295/* Merge an alias, search in alias list. If this name is already
296 * present merge both of them to combine all information.
297 */
298static bool perf_pmu_merge_alias(struct perf_pmu_alias *newalias,
299 struct list_head *alist)
300{
301 struct perf_pmu_alias *a;
302
303 list_for_each_entry(a, alist, list) {
304 if (!strcasecmp(newalias->name, a->name)) {
Jin Yao32705de2021-04-27 15:01:17 +0800305 if (newalias->pmu_name && a->pmu_name &&
306 !strcasecmp(newalias->pmu_name, a->pmu_name)) {
307 continue;
308 }
Thomas Richter6dde6422018-06-15 12:11:05 +0200309 perf_pmu_update_alias(a, newalias);
310 perf_pmu_free_alias(newalias);
311 return true;
312 }
313 }
314 return false;
315}
316
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700317static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
Jin Yaoeab35952021-04-27 15:01:16 +0800318 char *desc, char *val, struct pmu_event *pe)
Zheng Yana6146d52012-06-15 14:31:41 +0800319{
Thomas Richter0c24d6f2018-06-15 12:11:04 +0200320 struct parse_events_term *term;
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300321 struct perf_pmu_alias *alias;
Zheng Yana6146d52012-06-15 14:31:41 +0800322 int ret;
Andi Kleenfedb2b52017-01-27 18:03:37 -0800323 int num;
Thomas Richter0c24d6f2018-06-15 12:11:04 +0200324 char newval[256];
Jin Yaoeab35952021-04-27 15:01:16 +0800325 char *long_desc = NULL, *topic = NULL, *unit = NULL, *perpkg = NULL,
Jin Yao32705de2021-04-27 15:01:17 +0800326 *metric_expr = NULL, *metric_name = NULL, *deprecated = NULL,
327 *pmu_name = NULL;
Jin Yaoeab35952021-04-27 15:01:16 +0800328
329 if (pe) {
330 long_desc = (char *)pe->long_desc;
331 topic = (char *)pe->topic;
332 unit = (char *)pe->unit;
333 perpkg = (char *)pe->perpkg;
334 metric_expr = (char *)pe->metric_expr;
335 metric_name = (char *)pe->metric_name;
336 deprecated = (char *)pe->deprecated;
Jin Yao32705de2021-04-27 15:01:17 +0800337 pmu_name = (char *)pe->pmu;
Jin Yaoeab35952021-04-27 15:01:16 +0800338 }
Zheng Yana6146d52012-06-15 14:31:41 +0800339
Zheng Yana6146d52012-06-15 14:31:41 +0800340 alias = malloc(sizeof(*alias));
341 if (!alias)
342 return -ENOMEM;
343
344 INIT_LIST_HEAD(&alias->terms);
Stephane Eranian410136f2013-11-12 17:58:49 +0100345 alias->scale = 1.0;
346 alias->unit[0] = '\0';
Matt Fleming044330c2014-11-21 10:31:12 +0100347 alias->per_pkg = false;
Stephane Eranian84530922016-01-06 19:50:01 +0100348 alias->snapshot = false;
Jin Yaoa7f6c8c2019-10-15 10:53:57 +0800349 alias->deprecated = false;
Stephane Eranian410136f2013-11-12 17:58:49 +0100350
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700351 ret = parse_events_terms(&alias->terms, val);
Zheng Yana6146d52012-06-15 14:31:41 +0800352 if (ret) {
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700353 pr_err("Cannot parse alias %s: %d\n", val, ret);
Zheng Yana6146d52012-06-15 14:31:41 +0800354 free(alias);
355 return ret;
356 }
357
Thomas Richter0c24d6f2018-06-15 12:11:04 +0200358 /* Scan event and remove leading zeroes, spaces, newlines, some
359 * platforms have terms specified as
360 * event=0x0091 (read from files ../<PMU>/events/<FILE>
361 * and terms specified as event=0x91 (read from JSON files).
362 *
363 * Rebuild string to make alias->str member comparable.
364 */
365 memset(newval, 0, sizeof(newval));
366 ret = 0;
367 list_for_each_entry(term, &alias->terms, list) {
368 if (ret)
369 ret += scnprintf(newval + ret, sizeof(newval) - ret,
370 ",");
371 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
372 ret += scnprintf(newval + ret, sizeof(newval) - ret,
373 "%s=%#x", term->config, term->val.num);
374 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
375 ret += scnprintf(newval + ret, sizeof(newval) - ret,
376 "%s=%s", term->config, term->val.str);
377 }
378
Zheng Yana6146d52012-06-15 14:31:41 +0800379 alias->name = strdup(name);
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700380 if (dir) {
381 /*
382 * load unit name and scale if available
383 */
384 perf_pmu__parse_unit(alias, dir, name);
385 perf_pmu__parse_scale(alias, dir, name);
386 perf_pmu__parse_per_pkg(alias, dir, name);
387 perf_pmu__parse_snapshot(alias, dir, name);
388 }
Stephane Eranian410136f2013-11-12 17:58:49 +0100389
Andi Kleen00636c32017-03-20 13:17:07 -0700390 alias->metric_expr = metric_expr ? strdup(metric_expr) : NULL;
Andi Kleen96284812017-03-20 13:17:10 -0700391 alias->metric_name = metric_name ? strdup(metric_name): NULL;
Andi Kleen08e60ed2016-09-15 15:24:43 -0700392 alias->desc = desc ? strdup(desc) : NULL;
Sukadev Bhattiproluc8d68282016-09-15 15:24:48 -0700393 alias->long_desc = long_desc ? strdup(long_desc) :
394 desc ? strdup(desc) : NULL;
Andi Kleendd5f1032016-09-15 15:24:50 -0700395 alias->topic = topic ? strdup(topic) : NULL;
Andi Kleenfedb2b52017-01-27 18:03:37 -0800396 if (unit) {
Jin Yaoa55ab7c2019-08-28 13:59:29 +0800397 if (perf_pmu__convert_scale(unit, &unit, &alias->scale) < 0)
Andi Kleenfedb2b52017-01-27 18:03:37 -0800398 return -1;
399 snprintf(alias->unit, sizeof(alias->unit), "%s", unit);
400 }
401 alias->per_pkg = perpkg && sscanf(perpkg, "%d", &num) == 1 && num == 1;
Thomas Richter0c24d6f2018-06-15 12:11:04 +0200402 alias->str = strdup(newval);
Jin Yao32705de2021-04-27 15:01:17 +0800403 alias->pmu_name = pmu_name ? strdup(pmu_name) : NULL;
Andi Kleenf2361022017-01-27 18:03:40 -0800404
Jin Yaoa7f6c8c2019-10-15 10:53:57 +0800405 if (deprecated)
406 alias->deprecated = true;
407
Thomas Richter6dde6422018-06-15 12:11:05 +0200408 if (!perf_pmu_merge_alias(alias, list))
409 list_add_tail(&alias->list, list);
Stephane Eranian410136f2013-11-12 17:58:49 +0100410
Zheng Yana6146d52012-06-15 14:31:41 +0800411 return 0;
412}
413
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700414static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
415{
416 char buf[256];
417 int ret;
418
419 ret = fread(buf, 1, sizeof(buf), file);
420 if (ret == 0)
421 return -EINVAL;
422
423 buf[ret] = 0;
424
Thomas Richterea23ac72018-06-15 12:11:03 +0200425 /* Remove trailing newline from sysfs file */
Arnaldo Carvalho de Melo13c230a2019-06-26 12:13:13 -0300426 strim(buf);
Thomas Richterea23ac72018-06-15 12:11:03 +0200427
Jin Yaoeab35952021-04-27 15:01:16 +0800428 return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL);
Sukadev Bhattiprolu70c646e2015-06-10 00:25:08 -0700429}
430
Matt Fleming46441bd2014-09-24 15:04:06 +0100431static inline bool pmu_alias_info_file(char *name)
432{
433 size_t len;
434
435 len = strlen(name);
436 if (len > 5 && !strcmp(name + len - 5, ".unit"))
437 return true;
438 if (len > 6 && !strcmp(name + len - 6, ".scale"))
439 return true;
Matt Fleming044330c2014-11-21 10:31:12 +0100440 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
441 return true;
Jiri Olsa1d9e4462014-11-21 10:31:13 +0100442 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
443 return true;
Matt Fleming46441bd2014-09-24 15:04:06 +0100444
445 return false;
446}
447
Zheng Yana6146d52012-06-15 14:31:41 +0800448/*
449 * Process all the sysfs attributes located under the directory
450 * specified in 'dir' parameter.
451 */
452static int pmu_aliases_parse(char *dir, struct list_head *head)
453{
454 struct dirent *evt_ent;
455 DIR *event_dir;
Zheng Yana6146d52012-06-15 14:31:41 +0800456
457 event_dir = opendir(dir);
458 if (!event_dir)
459 return -EINVAL;
460
Andi Kleen940db6d2016-02-17 14:44:55 -0800461 while ((evt_ent = readdir(event_dir))) {
Zheng Yana6146d52012-06-15 14:31:41 +0800462 char path[PATH_MAX];
463 char *name = evt_ent->d_name;
464 FILE *file;
465
466 if (!strcmp(name, ".") || !strcmp(name, ".."))
467 continue;
468
Stephane Eranian410136f2013-11-12 17:58:49 +0100469 /*
Matt Fleming46441bd2014-09-24 15:04:06 +0100470 * skip info files parsed in perf_pmu__new_alias()
Stephane Eranian410136f2013-11-12 17:58:49 +0100471 */
Matt Fleming46441bd2014-09-24 15:04:06 +0100472 if (pmu_alias_info_file(name))
Stephane Eranian410136f2013-11-12 17:58:49 +0100473 continue;
474
Jiri Olsa77f18152018-03-19 09:29:01 +0100475 scnprintf(path, PATH_MAX, "%s/%s", dir, name);
Zheng Yana6146d52012-06-15 14:31:41 +0800476
Zheng Yana6146d52012-06-15 14:31:41 +0800477 file = fopen(path, "r");
Andi Kleen940db6d2016-02-17 14:44:55 -0800478 if (!file) {
479 pr_debug("Cannot open %s\n", path);
480 continue;
481 }
Stephane Eranian410136f2013-11-12 17:58:49 +0100482
Andi Kleen940db6d2016-02-17 14:44:55 -0800483 if (perf_pmu__new_alias(head, dir, name, file) < 0)
484 pr_debug("Cannot set up %s\n", name);
Zheng Yana6146d52012-06-15 14:31:41 +0800485 fclose(file);
486 }
487
488 closedir(event_dir);
Andi Kleen940db6d2016-02-17 14:44:55 -0800489 return 0;
Zheng Yana6146d52012-06-15 14:31:41 +0800490}
491
492/*
493 * Reading the pmu event aliases definition, which should be located at:
494 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
495 */
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300496static int pmu_aliases(const char *name, struct list_head *head)
Zheng Yana6146d52012-06-15 14:31:41 +0800497{
Zheng Yana6146d52012-06-15 14:31:41 +0800498 char path[PATH_MAX];
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300499 const char *sysfs = sysfs__mountpoint();
Zheng Yana6146d52012-06-15 14:31:41 +0800500
Zheng Yana6146d52012-06-15 14:31:41 +0800501 if (!sysfs)
502 return -1;
503
504 snprintf(path, PATH_MAX,
505 "%s/bus/event_source/devices/%s/events", sysfs, name);
506
Andi Kleend9664582019-11-20 16:15:11 -0800507 if (!file_available(path))
508 return 0;
Zheng Yana6146d52012-06-15 14:31:41 +0800509
510 if (pmu_aliases_parse(path, head))
511 return -1;
512
513 return 0;
514}
515
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -0300516static int pmu_alias_terms(struct perf_pmu_alias *alias,
Zheng Yana6146d52012-06-15 14:31:41 +0800517 struct list_head *terms)
518{
Jiri Olsa7c2f8162014-04-16 20:49:02 +0200519 struct parse_events_term *term, *cloned;
Zheng Yana6146d52012-06-15 14:31:41 +0800520 LIST_HEAD(list);
521 int ret;
522
523 list_for_each_entry(term, &alias->terms, list) {
Jiri Olsa7c2f8162014-04-16 20:49:02 +0200524 ret = parse_events_term__clone(&cloned, term);
Zheng Yana6146d52012-06-15 14:31:41 +0800525 if (ret) {
Arnaldo Carvalho de Melo682dc242016-02-12 16:48:00 -0300526 parse_events_terms__purge(&list);
Zheng Yana6146d52012-06-15 14:31:41 +0800527 return ret;
528 }
Andi Kleenc2f1cea2017-10-20 13:27:55 -0700529 /*
530 * Weak terms don't override command line options,
531 * which we don't want for implicit terms in aliases.
532 */
533 cloned->weak = true;
Jiri Olsa7c2f8162014-04-16 20:49:02 +0200534 list_add_tail(&cloned->list, &list);
Zheng Yana6146d52012-06-15 14:31:41 +0800535 }
536 list_splice(&list, terms);
537 return 0;
538}
539
Jiri Olsacd82a322012-03-15 20:09:17 +0100540/*
541 * Reading/parsing the default pmu type value, which should be
542 * located at:
543 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
544 */
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300545static int pmu_type(const char *name, __u32 *type)
Jiri Olsacd82a322012-03-15 20:09:17 +0100546{
Jiri Olsacd82a322012-03-15 20:09:17 +0100547 char path[PATH_MAX];
Jiri Olsacd82a322012-03-15 20:09:17 +0100548 FILE *file;
549 int ret = 0;
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300550 const char *sysfs = sysfs__mountpoint();
Jiri Olsacd82a322012-03-15 20:09:17 +0100551
Jiri Olsacd82a322012-03-15 20:09:17 +0100552 if (!sysfs)
553 return -1;
554
555 snprintf(path, PATH_MAX,
Robert Richter50a96672012-08-16 21:10:24 +0200556 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
Jiri Olsacd82a322012-03-15 20:09:17 +0100557
Andi Kleend9664582019-11-20 16:15:11 -0800558 if (access(path, R_OK) < 0)
Jiri Olsacd82a322012-03-15 20:09:17 +0100559 return -1;
560
561 file = fopen(path, "r");
562 if (!file)
563 return -EINVAL;
564
565 if (1 != fscanf(file, "%u", type))
566 ret = -1;
567
568 fclose(file);
569 return ret;
570}
571
Robert Richter50a96672012-08-16 21:10:24 +0200572/* Add all pmus in sysfs to pmu list: */
573static void pmu_read_sysfs(void)
574{
575 char path[PATH_MAX];
Robert Richter50a96672012-08-16 21:10:24 +0200576 DIR *dir;
577 struct dirent *dent;
Arnaldo Carvalho de Melocf38fad2013-11-05 14:48:50 -0300578 const char *sysfs = sysfs__mountpoint();
Robert Richter50a96672012-08-16 21:10:24 +0200579
Robert Richter50a96672012-08-16 21:10:24 +0200580 if (!sysfs)
581 return;
582
583 snprintf(path, PATH_MAX,
584 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
585
586 dir = opendir(path);
587 if (!dir)
588 return;
589
590 while ((dent = readdir(dir))) {
591 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
592 continue;
593 /* add to static LIST_HEAD(pmus): */
594 perf_pmu__find(dent->d_name);
595 }
596
597 closedir(dir);
598}
599
Jiri Olsaf8548392019-07-21 13:23:49 +0200600static struct perf_cpu_map *__pmu_cpumask(const char *path)
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800601{
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800602 FILE *file;
Jiri Olsaf8548392019-07-21 13:23:49 +0200603 struct perf_cpu_map *cpus;
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800604
605 file = fopen(path, "r");
606 if (!file)
607 return NULL;
608
Jiri Olsa9c3516d2019-07-21 13:24:30 +0200609 cpus = perf_cpu_map__read(file);
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800610 fclose(file);
611 return cpus;
612}
613
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -0700614/*
Mark Rutland66ec11912017-10-06 19:38:22 +0100615 * Uncore PMUs have a "cpumask" file under sysfs. CPU PMUs (e.g. on arm/arm64)
616 * may have a "cpus" file.
617 */
John Garry51d54842020-12-04 19:10:09 +0800618#define SYS_TEMPLATE_ID "./bus/event_source/devices/%s/identifier"
Mark Rutland66ec11912017-10-06 19:38:22 +0100619#define CPUS_TEMPLATE_UNCORE "%s/bus/event_source/devices/%s/cpumask"
Mark Rutland66ec11912017-10-06 19:38:22 +0100620
Jiri Olsaf8548392019-07-21 13:23:49 +0200621static struct perf_cpu_map *pmu_cpumask(const char *name)
Mark Rutland66ec11912017-10-06 19:38:22 +0100622{
623 char path[PATH_MAX];
Jiri Olsaf8548392019-07-21 13:23:49 +0200624 struct perf_cpu_map *cpus;
Mark Rutland66ec11912017-10-06 19:38:22 +0100625 const char *sysfs = sysfs__mountpoint();
626 const char *templates[] = {
627 CPUS_TEMPLATE_UNCORE,
628 CPUS_TEMPLATE_CPU,
629 NULL
630 };
631 const char **template;
632
633 if (!sysfs)
634 return NULL;
635
636 for (template = templates; *template; template++) {
637 snprintf(path, PATH_MAX, *template, sysfs, name);
638 cpus = __pmu_cpumask(path);
639 if (cpus)
640 return cpus;
641 }
642
643 return NULL;
644}
645
646static bool pmu_is_uncore(const char *name)
647{
648 char path[PATH_MAX];
Andi Kleend9664582019-11-20 16:15:11 -0800649 const char *sysfs;
Mark Rutland66ec11912017-10-06 19:38:22 +0100650
Jin Yao44462432021-04-27 15:01:18 +0800651 if (perf_pmu__hybrid_mounted(name))
652 return false;
653
Andi Kleend9664582019-11-20 16:15:11 -0800654 sysfs = sysfs__mountpoint();
Mark Rutland66ec11912017-10-06 19:38:22 +0100655 snprintf(path, PATH_MAX, CPUS_TEMPLATE_UNCORE, sysfs, name);
Andi Kleend9664582019-11-20 16:15:11 -0800656 return file_available(path);
Mark Rutland66ec11912017-10-06 19:38:22 +0100657}
658
John Garry51d54842020-12-04 19:10:09 +0800659static char *pmu_id(const char *name)
660{
661 char path[PATH_MAX], *str;
662 size_t len;
663
664 snprintf(path, PATH_MAX, SYS_TEMPLATE_ID, name);
665
666 if (sysfs__read_str(path, &str, &len) < 0)
667 return NULL;
668
669 str[len - 1] = 0; /* remove line feed */
670
671 return str;
672}
673
Mark Rutland66ec11912017-10-06 19:38:22 +0100674/*
Ganapatrao Kulkarni14b22ae2017-08-24 16:30:58 +0530675 * PMU CORE devices have different name other than cpu in sysfs on some
Kan Liang292c34c2018-04-24 11:20:10 -0700676 * platforms.
677 * Looking for possible sysfs files to identify the arm core device.
Ganapatrao Kulkarni14b22ae2017-08-24 16:30:58 +0530678 */
Kan Liang292c34c2018-04-24 11:20:10 -0700679static int is_arm_pmu_core(const char *name)
Ganapatrao Kulkarni14b22ae2017-08-24 16:30:58 +0530680{
Ganapatrao Kulkarni14b22ae2017-08-24 16:30:58 +0530681 char path[PATH_MAX];
682 const char *sysfs = sysfs__mountpoint();
683
684 if (!sysfs)
685 return 0;
686
Ganapatrao Kulkarni14b22ae2017-08-24 16:30:58 +0530687 /* Look for cpu sysfs (specific to arm) */
688 scnprintf(path, PATH_MAX, "%s/bus/event_source/devices/%s/cpus",
689 sysfs, name);
Andi Kleend9664582019-11-20 16:15:11 -0800690 return file_available(path);
Ganapatrao Kulkarni14b22ae2017-08-24 16:30:58 +0530691}
692
Ganapatrao Kulkarni54e32dc2017-10-17 00:02:18 +0530693static char *perf_pmu__getcpuid(struct perf_pmu *pmu)
Andi Kleend77ade92017-08-31 12:40:30 -0700694{
695 char *cpuid;
696 static bool printed;
697
698 cpuid = getenv("PERF_CPUID");
699 if (cpuid)
700 cpuid = strdup(cpuid);
701 if (!cpuid)
Ganapatrao Kulkarni54e32dc2017-10-17 00:02:18 +0530702 cpuid = get_cpuid_str(pmu);
Andi Kleend77ade92017-08-31 12:40:30 -0700703 if (!cpuid)
704 return NULL;
705
706 if (!printed) {
707 pr_debug("Using CPUID %s\n", cpuid);
708 printed = true;
709 }
710 return cpuid;
711}
712
Ganapatrao Kulkarni54e32dc2017-10-17 00:02:18 +0530713struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu)
Andi Kleend77ade92017-08-31 12:40:30 -0700714{
715 struct pmu_events_map *map;
Ganapatrao Kulkarni54e32dc2017-10-17 00:02:18 +0530716 char *cpuid = perf_pmu__getcpuid(pmu);
Andi Kleend77ade92017-08-31 12:40:30 -0700717 int i;
718
Ganapatrao Kulkarnide3d0f12017-10-17 00:02:22 +0530719 /* on some platforms which uses cpus map, cpuid can be NULL for
720 * PMUs other than CORE PMUs.
721 */
722 if (!cpuid)
723 return NULL;
724
Andi Kleend77ade92017-08-31 12:40:30 -0700725 i = 0;
726 for (;;) {
727 map = &pmu_events_map[i++];
728 if (!map->table) {
729 map = NULL;
730 break;
731 }
732
Thomas Richter4cb7d3e2018-02-13 16:14:18 +0100733 if (!strcmp_cpuid_str(map->cpuid, cpuid))
Andi Kleend77ade92017-08-31 12:40:30 -0700734 break;
735 }
736 free(cpuid);
737 return map;
738}
739
John Garrye126bef2021-04-07 18:32:47 +0800740struct pmu_events_map *__weak pmu_events_map__find(void)
741{
742 return perf_pmu__find_map(NULL);
743}
744
John Garryc07d5c92021-07-20 23:10:19 +0800745/*
746 * Suffix must be in form tok_{digits}, or tok{digits}, or same as pmu_name
747 * to be valid.
748 */
749static bool perf_pmu__valid_suffix(const char *pmu_name, char *tok)
Jin Yaoc47a5592021-07-01 14:42:53 +0800750{
John Garryc07d5c92021-07-20 23:10:19 +0800751 const char *p;
Jin Yaoc47a5592021-07-01 14:42:53 +0800752
753 if (strncmp(pmu_name, tok, strlen(tok)))
754 return false;
755
756 p = pmu_name + strlen(tok);
757 if (*p == 0)
758 return true;
759
John Garryc07d5c92021-07-20 23:10:19 +0800760 if (*p == '_')
761 ++p;
Jin Yaoc47a5592021-07-01 14:42:53 +0800762
John Garryc07d5c92021-07-20 23:10:19 +0800763 /* Ensure we end in a number */
764 while (1) {
765 if (!isdigit(*p))
766 return false;
767 if (*(++p) == 0)
768 break;
769 }
Jin Yaoc47a5592021-07-01 14:42:53 +0800770
771 return true;
772}
773
John Garry5b9a5002020-03-17 19:02:18 +0800774bool pmu_uncore_alias_match(const char *pmu_name, const char *name)
John Garry730670b12019-06-28 22:35:49 +0800775{
776 char *tmp = NULL, *tok, *str;
777 bool res;
778
779 str = strdup(pmu_name);
780 if (!str)
781 return false;
782
783 /*
784 * uncore alias may be from different PMU with common prefix
785 */
786 tok = strtok_r(str, ",", &tmp);
787 if (strncmp(pmu_name, tok, strlen(tok))) {
788 res = false;
789 goto out;
790 }
791
792 /*
793 * Match more complex aliases where the alias name is a comma-delimited
794 * list of tokens, orderly contained in the matching PMU name.
795 *
796 * Example: For alias "socket,pmuname" and PMU "socketX_pmunameY", we
797 * match "socket" in "socketX_pmunameY" and then "pmuname" in
798 * "pmunameY".
799 */
John Garryc07d5c92021-07-20 23:10:19 +0800800 while (1) {
801 char *next_tok = strtok_r(NULL, ",", &tmp);
802
John Garry730670b12019-06-28 22:35:49 +0800803 name = strstr(name, tok);
John Garryc07d5c92021-07-20 23:10:19 +0800804 if (!name ||
805 (!next_tok && !perf_pmu__valid_suffix(name, tok))) {
John Garry730670b12019-06-28 22:35:49 +0800806 res = false;
807 goto out;
808 }
John Garryc07d5c92021-07-20 23:10:19 +0800809 if (!next_tok)
810 break;
811 tok = next_tok;
812 name += strlen(tok);
John Garry730670b12019-06-28 22:35:49 +0800813 }
814
815 res = true;
816out:
817 free(str);
818 return res;
819}
820
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -0700821/*
822 * From the pmu_events_map, find the table of PMU events that corresponds
823 * to the current running CPU. Then, add all PMU events from that table
824 * as aliases.
825 */
John Garrye45ad702020-03-17 19:02:15 +0800826void pmu_add_cpu_aliases_map(struct list_head *head, struct perf_pmu *pmu,
827 struct pmu_events_map *map)
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -0700828{
829 int i;
Ganapatrao Kulkarni54e32dc2017-10-17 00:02:18 +0530830 const char *name = pmu->name;
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -0700831 /*
832 * Found a matching PMU events table. Create aliases
833 */
834 i = 0;
835 while (1) {
John Garry599ee182019-06-14 22:07:59 +0800836 const char *cpu_name = is_arm_pmu_core(name) ? name : "cpu";
837 struct pmu_event *pe = &map->table[i++];
838 const char *pname = pe->pmu ? pe->pmu : cpu_name;
Andi Kleenfedb2b52017-01-27 18:03:37 -0800839
Andi Kleenb18f3e32017-08-31 12:40:31 -0700840 if (!pe->name) {
841 if (pe->metric_group || pe->metric_name)
842 continue;
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -0700843 break;
Andi Kleenb18f3e32017-08-31 12:40:31 -0700844 }
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -0700845
John Garry599ee182019-06-14 22:07:59 +0800846 if (pmu_is_uncore(name) &&
John Garry730670b12019-06-28 22:35:49 +0800847 pmu_uncore_alias_match(pname, name))
John Garry599ee182019-06-14 22:07:59 +0800848 goto new_alias;
Kan Liange94d6b72019-03-15 11:00:14 -0700849
John Garry599ee182019-06-14 22:07:59 +0800850 if (strcmp(pname, name))
851 continue;
Andi Kleenfedb2b52017-01-27 18:03:37 -0800852
Kan Liange94d6b72019-03-15 11:00:14 -0700853new_alias:
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -0700854 /* need type casts to override 'const' */
855 __perf_pmu__new_alias(head, NULL, (char *)pe->name,
Sukadev Bhattiproluc8d68282016-09-15 15:24:48 -0700856 (char *)pe->desc, (char *)pe->event,
Jin Yaoeab35952021-04-27 15:01:16 +0800857 pe);
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -0700858 }
Sukadev Bhattiprolu933f82f2016-09-15 15:24:40 -0700859}
860
John Garrye45ad702020-03-17 19:02:15 +0800861static void pmu_add_cpu_aliases(struct list_head *head, struct perf_pmu *pmu)
862{
863 struct pmu_events_map *map;
864
865 map = perf_pmu__find_map(pmu);
866 if (!map)
867 return;
868
869 pmu_add_cpu_aliases_map(head, pmu, map);
870}
871
John Garry4513c712020-12-04 19:10:10 +0800872void pmu_for_each_sys_event(pmu_sys_event_iter_fn fn, void *data)
873{
874 int i = 0;
875
876 while (1) {
877 struct pmu_sys_events *event_table;
878 int j = 0;
879
880 event_table = &pmu_sys_event_tables[i++];
881
882 if (!event_table->table)
883 break;
884
885 while (1) {
886 struct pmu_event *pe = &event_table->table[j++];
887 int ret;
888
889 if (!pe->name && !pe->metric_group && !pe->metric_name)
890 break;
891
892 ret = fn(pe, data);
893 if (ret)
894 break;
895 }
896 }
897}
898
899struct pmu_sys_event_iter_data {
900 struct list_head *head;
901 struct perf_pmu *pmu;
902};
903
904static int pmu_add_sys_aliases_iter_fn(struct pmu_event *pe, void *data)
905{
906 struct pmu_sys_event_iter_data *idata = data;
907 struct perf_pmu *pmu = idata->pmu;
908
909 if (!pe->name) {
910 if (pe->metric_group || pe->metric_name)
911 return 0;
912 return -EINVAL;
913 }
914
915 if (!pe->compat || !pe->pmu)
916 return 0;
917
918 if (!strcmp(pmu->id, pe->compat) &&
919 pmu_uncore_alias_match(pe->pmu, pmu->name)) {
920 __perf_pmu__new_alias(idata->head, NULL,
921 (char *)pe->name,
922 (char *)pe->desc,
923 (char *)pe->event,
Jin Yaoeab35952021-04-27 15:01:16 +0800924 pe);
John Garry4513c712020-12-04 19:10:10 +0800925 }
926
927 return 0;
928}
929
930static void pmu_add_sys_aliases(struct list_head *head, struct perf_pmu *pmu)
931{
932 struct pmu_sys_event_iter_data idata = {
933 .head = head,
934 .pmu = pmu,
935 };
936
937 if (!pmu->id)
938 return;
939
940 pmu_for_each_sys_event(pmu_add_sys_aliases_iter_fn, &idata);
941}
942
Sukadev Bhattiproluc5de47f2015-06-10 00:25:07 -0700943struct perf_event_attr * __weak
Adrian Hunterdc0a6202014-07-31 09:00:49 +0300944perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
945{
946 return NULL;
947}
948
Jiri Olsa90a86bd2019-03-05 16:25:32 +0100949static int pmu_max_precise(const char *name)
950{
951 char path[PATH_MAX];
952 int max_precise = -1;
953
954 scnprintf(path, PATH_MAX,
955 "bus/event_source/devices/%s/caps/max_precise",
956 name);
957
958 sysfs__read_int(path, &max_precise);
959 return max_precise;
960}
961
Adrian Hunterb6b96fb2013-07-04 16:20:25 +0300962static struct perf_pmu *pmu_lookup(const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +0100963{
964 struct perf_pmu *pmu;
965 LIST_HEAD(format);
Zheng Yana6146d52012-06-15 14:31:41 +0800966 LIST_HEAD(aliases);
Jiri Olsacd82a322012-03-15 20:09:17 +0100967 __u32 type;
Jin Yao49afa7f2021-07-08 09:36:58 +0800968 bool is_hybrid = perf_pmu__hybrid_mounted(name);
969
970 /*
971 * Check pmu name for hybrid and the pmu may be invalid in sysfs
972 */
973 if (!strncmp(name, "cpu_", 4) && !is_hybrid)
974 return NULL;
Jiri Olsacd82a322012-03-15 20:09:17 +0100975
976 /*
977 * The pmu data we store & need consists of the pmu
978 * type value and format definitions. Load both right
979 * now.
980 */
981 if (pmu_format(name, &format))
982 return NULL;
983
Andi Kleen15b22ed2017-01-27 18:03:38 -0800984 /*
985 * Check the type first to avoid unnecessary work.
986 */
987 if (pmu_type(name, &type))
988 return NULL;
989
Jiri Olsa3fded962012-10-10 14:53:16 +0200990 if (pmu_aliases(name, &aliases))
991 return NULL;
992
Jiri Olsacd82a322012-03-15 20:09:17 +0100993 pmu = zalloc(sizeof(*pmu));
994 if (!pmu)
995 return NULL;
996
Yan, Zheng7ae92e72012-09-10 15:53:50 +0800997 pmu->cpus = pmu_cpumask(name);
Ganapatrao Kulkarni54e32dc2017-10-17 00:02:18 +0530998 pmu->name = strdup(name);
999 pmu->type = type;
Mark Rutland66ec11912017-10-06 19:38:22 +01001000 pmu->is_uncore = pmu_is_uncore(name);
John Garry51d54842020-12-04 19:10:09 +08001001 if (pmu->is_uncore)
1002 pmu->id = pmu_id(name);
Jin Yao49afa7f2021-07-08 09:36:58 +08001003 pmu->is_hybrid = is_hybrid;
Jiri Olsa90a86bd2019-03-05 16:25:32 +01001004 pmu->max_precise = pmu_max_precise(name);
Ganapatrao Kulkarni54e32dc2017-10-17 00:02:18 +05301005 pmu_add_cpu_aliases(&aliases, pmu);
John Garry4513c712020-12-04 19:10:10 +08001006 pmu_add_sys_aliases(&aliases, pmu);
Mark Rutland66ec11912017-10-06 19:38:22 +01001007
Jiri Olsacd82a322012-03-15 20:09:17 +01001008 INIT_LIST_HEAD(&pmu->format);
Zheng Yana6146d52012-06-15 14:31:41 +08001009 INIT_LIST_HEAD(&pmu->aliases);
Kan Liang9fbc61f2020-03-19 13:25:01 -07001010 INIT_LIST_HEAD(&pmu->caps);
Jiri Olsacd82a322012-03-15 20:09:17 +01001011 list_splice(&format, &pmu->format);
Zheng Yana6146d52012-06-15 14:31:41 +08001012 list_splice(&aliases, &pmu->aliases);
Robert Richter9bc8f9f2012-06-14 22:38:37 +02001013 list_add_tail(&pmu->list, &pmus);
Adrian Hunterdc0a6202014-07-31 09:00:49 +03001014
Jin Yao44462432021-04-27 15:01:18 +08001015 if (pmu->is_hybrid)
1016 list_add_tail(&pmu->hybrid_list, &perf_pmu__hybrid_pmus);
1017
Adrian Hunterdc0a6202014-07-31 09:00:49 +03001018 pmu->default_config = perf_pmu__get_default_config(pmu);
1019
Jiri Olsacd82a322012-03-15 20:09:17 +01001020 return pmu;
1021}
1022
Adrian Hunterb6b96fb2013-07-04 16:20:25 +03001023static struct perf_pmu *pmu_find(const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +01001024{
1025 struct perf_pmu *pmu;
1026
1027 list_for_each_entry(pmu, &pmus, list)
1028 if (!strcmp(pmu->name, name))
1029 return pmu;
1030
1031 return NULL;
1032}
1033
Stephane Eranian3a50dc72020-04-29 16:14:42 -07001034struct perf_pmu *perf_pmu__find_by_type(unsigned int type)
1035{
1036 struct perf_pmu *pmu;
1037
1038 list_for_each_entry(pmu, &pmus, list)
1039 if (pmu->type == type)
1040 return pmu;
1041
1042 return NULL;
1043}
1044
Robert Richter50a96672012-08-16 21:10:24 +02001045struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
1046{
1047 /*
1048 * pmu iterator: If pmu is NULL, we start at the begin,
1049 * otherwise return the next pmu. Returns NULL on end.
1050 */
1051 if (!pmu) {
1052 pmu_read_sysfs();
1053 pmu = list_prepare_entry(pmu, &pmus, list);
1054 }
1055 list_for_each_entry_continue(pmu, &pmus, list)
1056 return pmu;
1057 return NULL;
1058}
1059
Arnaldo Carvalho de Meloe76026b2020-04-29 15:50:10 -03001060struct perf_pmu *evsel__find_pmu(struct evsel *evsel)
Adrian Huntere12ee9f2020-04-01 13:16:09 +03001061{
1062 struct perf_pmu *pmu = NULL;
1063
1064 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1065 if (pmu->type == evsel->core.attr.type)
1066 break;
1067 }
1068
1069 return pmu;
1070}
1071
Arnaldo Carvalho de Melo39453ed2020-04-29 15:51:38 -03001072bool evsel__is_aux_event(struct evsel *evsel)
Adrian Huntere12ee9f2020-04-01 13:16:09 +03001073{
Arnaldo Carvalho de Meloe76026b2020-04-29 15:50:10 -03001074 struct perf_pmu *pmu = evsel__find_pmu(evsel);
Adrian Huntere12ee9f2020-04-01 13:16:09 +03001075
1076 return pmu && pmu->auxtrace;
1077}
1078
Adrian Hunterb6b96fb2013-07-04 16:20:25 +03001079struct perf_pmu *perf_pmu__find(const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +01001080{
1081 struct perf_pmu *pmu;
1082
1083 /*
1084 * Once PMU is loaded it stays in the list,
1085 * so we keep us from multiple reading/parsing
1086 * the pmu format definitions.
1087 */
1088 pmu = pmu_find(name);
1089 if (pmu)
1090 return pmu;
1091
1092 return pmu_lookup(name);
1093}
1094
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -03001095static struct perf_pmu_format *
Adrian Hunter09ff6072015-07-17 19:33:49 +03001096pmu_find_format(struct list_head *formats, const char *name)
Jiri Olsacd82a322012-03-15 20:09:17 +01001097{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -03001098 struct perf_pmu_format *format;
Jiri Olsacd82a322012-03-15 20:09:17 +01001099
1100 list_for_each_entry(format, formats, list)
1101 if (!strcmp(format->name, name))
1102 return format;
1103
1104 return NULL;
1105}
1106
Adrian Hunter09ff6072015-07-17 19:33:49 +03001107__u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
1108{
1109 struct perf_pmu_format *format = pmu_find_format(formats, name);
1110 __u64 bits = 0;
1111 int fbit;
1112
1113 if (!format)
1114 return 0;
1115
1116 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
1117 bits |= 1ULL << fbit;
1118
1119 return bits;
1120}
1121
Adrian Huntera1ac7de2019-11-15 14:42:22 +02001122int perf_pmu__format_type(struct list_head *formats, const char *name)
1123{
1124 struct perf_pmu_format *format = pmu_find_format(formats, name);
1125
1126 if (!format)
1127 return -1;
1128
1129 return format->value;
1130}
1131
Jiri Olsacd82a322012-03-15 20:09:17 +01001132/*
Adrian Hunterdc0a6202014-07-31 09:00:49 +03001133 * Sets value based on the format definition (format parameter)
Ingo Molnar4d39c892021-03-23 17:09:15 +01001134 * and unformatted value (value parameter).
Jiri Olsacd82a322012-03-15 20:09:17 +01001135 */
Adrian Hunterdc0a6202014-07-31 09:00:49 +03001136static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
1137 bool zero)
Jiri Olsacd82a322012-03-15 20:09:17 +01001138{
1139 unsigned long fbit, vbit;
Jiri Olsacd82a322012-03-15 20:09:17 +01001140
1141 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
1142
1143 if (!test_bit(fbit, format))
1144 continue;
1145
Adrian Hunterdc0a6202014-07-31 09:00:49 +03001146 if (value & (1llu << vbit++))
1147 *v |= (1llu << fbit);
1148 else if (zero)
1149 *v &= ~(1llu << fbit);
Jiri Olsacd82a322012-03-15 20:09:17 +01001150 }
Jiri Olsacd82a322012-03-15 20:09:17 +01001151}
1152
Adrian Hunter0efe6b62015-07-17 19:33:50 +03001153static __u64 pmu_format_max_value(const unsigned long *format)
1154{
Jiri Olsa1b9caa12018-10-03 09:20:46 +02001155 int w;
Adrian Hunter0efe6b62015-07-17 19:33:50 +03001156
Jiri Olsa1b9caa12018-10-03 09:20:46 +02001157 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
1158 if (!w)
1159 return 0;
1160 if (w < 64)
1161 return (1ULL << w) - 1;
1162 return -1;
Adrian Hunter0efe6b62015-07-17 19:33:50 +03001163}
1164
Jiri Olsacd82a322012-03-15 20:09:17 +01001165/*
Cody P Schafer688d4df2015-01-07 17:13:50 -08001166 * Term is a string term, and might be a param-term. Try to look up it's value
1167 * in the remaining terms.
1168 * - We have a term like "base-or-format-term=param-term",
1169 * - We need to find the value supplied for "param-term" (with param-term named
1170 * in a config string) later on in the term list.
1171 */
1172static int pmu_resolve_param_term(struct parse_events_term *term,
1173 struct list_head *head_terms,
1174 __u64 *value)
1175{
1176 struct parse_events_term *t;
1177
1178 list_for_each_entry(t, head_terms, list) {
Ian Rogers2a3d2522020-03-25 09:40:22 -07001179 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM &&
1180 t->config && !strcmp(t->config, term->config)) {
1181 t->used = true;
1182 *value = t->val.num;
1183 return 0;
Cody P Schafer688d4df2015-01-07 17:13:50 -08001184 }
1185 }
1186
Namhyung Kimbb963e12017-02-17 17:17:38 +09001187 if (verbose > 0)
Cody P Schafer688d4df2015-01-07 17:13:50 -08001188 printf("Required parameter '%s' not specified\n", term->config);
1189
1190 return -1;
1191}
1192
He Kuangffeb8832015-09-28 03:52:14 +00001193static char *pmu_formats_string(struct list_head *formats)
Jiri Olsae64b0202015-04-22 21:10:21 +02001194{
1195 struct perf_pmu_format *format;
Masami Hiramatsu11db4e22016-05-10 14:47:44 +09001196 char *str = NULL;
1197 struct strbuf buf = STRBUF_INIT;
Jiri Olsae64b0202015-04-22 21:10:21 +02001198 unsigned i = 0;
1199
He Kuangffeb8832015-09-28 03:52:14 +00001200 if (!formats)
Jiri Olsae64b0202015-04-22 21:10:21 +02001201 return NULL;
1202
1203 /* sysfs exported terms */
He Kuangffeb8832015-09-28 03:52:14 +00001204 list_for_each_entry(format, formats, list)
Masami Hiramatsu11db4e22016-05-10 14:47:44 +09001205 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1206 goto error;
Jiri Olsae64b0202015-04-22 21:10:21 +02001207
He Kuangffeb8832015-09-28 03:52:14 +00001208 str = strbuf_detach(&buf, NULL);
Masami Hiramatsu11db4e22016-05-10 14:47:44 +09001209error:
He Kuangffeb8832015-09-28 03:52:14 +00001210 strbuf_release(&buf);
Jiri Olsae64b0202015-04-22 21:10:21 +02001211
Jiri Olsae64b0202015-04-22 21:10:21 +02001212 return str;
Jiri Olsae64b0202015-04-22 21:10:21 +02001213}
1214
Cody P Schafer688d4df2015-01-07 17:13:50 -08001215/*
Jiri Olsacd82a322012-03-15 20:09:17 +01001216 * Setup one of config[12] attr members based on the
Cody P Schafer88aca8d2014-01-08 08:43:51 -08001217 * user input data - term parameter.
Jiri Olsacd82a322012-03-15 20:09:17 +01001218 */
Ian Rogers4ac22b42020-05-13 15:06:35 -07001219static int pmu_config_term(const char *pmu_name,
1220 struct list_head *formats,
Jiri Olsacd82a322012-03-15 20:09:17 +01001221 struct perf_event_attr *attr,
Adrian Hunterdc0a6202014-07-31 09:00:49 +03001222 struct parse_events_term *term,
Cody P Schafer688d4df2015-01-07 17:13:50 -08001223 struct list_head *head_terms,
Jiri Olsae64b0202015-04-22 21:10:21 +02001224 bool zero, struct parse_events_error *err)
Jiri Olsacd82a322012-03-15 20:09:17 +01001225{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -03001226 struct perf_pmu_format *format;
Jiri Olsacd82a322012-03-15 20:09:17 +01001227 __u64 *vp;
Adrian Hunter0efe6b62015-07-17 19:33:50 +03001228 __u64 val, max_val;
Jiri Olsacd82a322012-03-15 20:09:17 +01001229
1230 /*
Cody P Schafer688d4df2015-01-07 17:13:50 -08001231 * If this is a parameter we've already used for parameterized-eval,
1232 * skip it in normal eval.
1233 */
1234 if (term->used)
1235 return 0;
1236
1237 /*
Jiri Olsacd82a322012-03-15 20:09:17 +01001238 * Hardcoded terms should be already in, so nothing
1239 * to be done for them.
1240 */
1241 if (parse_events__is_hardcoded_term(term))
1242 return 0;
1243
Jiri Olsacd82a322012-03-15 20:09:17 +01001244 format = pmu_find_format(formats, term->config);
Cody P Schafer688d4df2015-01-07 17:13:50 -08001245 if (!format) {
Ian Rogers4ac22b42020-05-13 15:06:35 -07001246 char *pmu_term = pmu_formats_string(formats);
1247 char *unknown_term;
1248 char *help_msg;
He Kuangffeb8832015-09-28 03:52:14 +00001249
Ian Rogers4ac22b42020-05-13 15:06:35 -07001250 if (asprintf(&unknown_term,
1251 "unknown term '%s' for pmu '%s'",
1252 term->config, pmu_name) < 0)
1253 unknown_term = NULL;
1254 help_msg = parse_events_formats_error_string(pmu_term);
1255 if (err) {
Ian Rogers448d7322019-10-30 15:34:39 -07001256 parse_events__handle_error(err, term->err_term,
Ian Rogers4ac22b42020-05-13 15:06:35 -07001257 unknown_term,
1258 help_msg);
1259 } else {
1260 pr_debug("%s (%s)\n", unknown_term, help_msg);
1261 free(unknown_term);
Jiri Olsae64b0202015-04-22 21:10:21 +02001262 }
Ian Rogers4ac22b42020-05-13 15:06:35 -07001263 free(pmu_term);
Jiri Olsacd82a322012-03-15 20:09:17 +01001264 return -EINVAL;
Cody P Schafer688d4df2015-01-07 17:13:50 -08001265 }
Jiri Olsacd82a322012-03-15 20:09:17 +01001266
1267 switch (format->value) {
1268 case PERF_PMU_FORMAT_VALUE_CONFIG:
1269 vp = &attr->config;
1270 break;
1271 case PERF_PMU_FORMAT_VALUE_CONFIG1:
1272 vp = &attr->config1;
1273 break;
1274 case PERF_PMU_FORMAT_VALUE_CONFIG2:
1275 vp = &attr->config2;
1276 break;
1277 default:
1278 return -EINVAL;
1279 }
1280
Jiri Olsa16fa7e82012-04-25 18:24:57 +02001281 /*
Cody P Schafer688d4df2015-01-07 17:13:50 -08001282 * Either directly use a numeric term, or try to translate string terms
1283 * using event parameters.
Jiri Olsa16fa7e82012-04-25 18:24:57 +02001284 */
Jiri Olsa99e71382017-02-17 15:00:56 +01001285 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1286 if (term->no_value &&
1287 bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1288 if (err) {
Ian Rogers448d7322019-10-30 15:34:39 -07001289 parse_events__handle_error(err, term->err_val,
1290 strdup("no value assigned for term"),
1291 NULL);
Jiri Olsa99e71382017-02-17 15:00:56 +01001292 }
1293 return -EINVAL;
1294 }
1295
Cody P Schafer688d4df2015-01-07 17:13:50 -08001296 val = term->val.num;
Jiri Olsa99e71382017-02-17 15:00:56 +01001297 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
Cody P Schafer688d4df2015-01-07 17:13:50 -08001298 if (strcmp(term->val.str, "?")) {
Namhyung Kimbb963e12017-02-17 17:17:38 +09001299 if (verbose > 0) {
Cody P Schafer688d4df2015-01-07 17:13:50 -08001300 pr_info("Invalid sysfs entry %s=%s\n",
1301 term->config, term->val.str);
Jiri Olsae64b0202015-04-22 21:10:21 +02001302 }
1303 if (err) {
Ian Rogers448d7322019-10-30 15:34:39 -07001304 parse_events__handle_error(err, term->err_val,
1305 strdup("expected numeric value"),
1306 NULL);
Jiri Olsae64b0202015-04-22 21:10:21 +02001307 }
Cody P Schafer688d4df2015-01-07 17:13:50 -08001308 return -EINVAL;
1309 }
1310
1311 if (pmu_resolve_param_term(term, head_terms, &val))
1312 return -EINVAL;
1313 } else
1314 return -EINVAL;
1315
Adrian Hunter0efe6b62015-07-17 19:33:50 +03001316 max_val = pmu_format_max_value(format->bits);
1317 if (val > max_val) {
1318 if (err) {
Ian Rogers448d7322019-10-30 15:34:39 -07001319 char *err_str;
1320
1321 parse_events__handle_error(err, term->err_val,
1322 asprintf(&err_str,
1323 "value too big for format, maximum is %llu",
1324 (unsigned long long)max_val) < 0
1325 ? strdup("value too big for format")
1326 : err_str,
1327 NULL);
Adrian Hunter0efe6b62015-07-17 19:33:50 +03001328 return -EINVAL;
1329 }
1330 /*
1331 * Assume we don't care if !err, in which case the value will be
1332 * silently truncated.
1333 */
1334 }
1335
Cody P Schafer688d4df2015-01-07 17:13:50 -08001336 pmu_format_value(format->bits, val, vp, zero);
Jiri Olsacd82a322012-03-15 20:09:17 +01001337 return 0;
1338}
1339
Ian Rogers4ac22b42020-05-13 15:06:35 -07001340int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
Jiri Olsacff7f952012-11-10 01:46:50 +01001341 struct perf_event_attr *attr,
Adrian Hunterdc0a6202014-07-31 09:00:49 +03001342 struct list_head *head_terms,
Jiri Olsae64b0202015-04-22 21:10:21 +02001343 bool zero, struct parse_events_error *err)
Jiri Olsacd82a322012-03-15 20:09:17 +01001344{
Arnaldo Carvalho de Melo6cee6cd2013-01-18 16:29:49 -03001345 struct parse_events_term *term;
Jiri Olsacd82a322012-03-15 20:09:17 +01001346
Cody P Schafer688d4df2015-01-07 17:13:50 -08001347 list_for_each_entry(term, head_terms, list) {
Ian Rogers4ac22b42020-05-13 15:06:35 -07001348 if (pmu_config_term(pmu_name, formats, attr, term, head_terms,
Jiri Olsae64b0202015-04-22 21:10:21 +02001349 zero, err))
Jiri Olsacd82a322012-03-15 20:09:17 +01001350 return -EINVAL;
Cody P Schafer688d4df2015-01-07 17:13:50 -08001351 }
Jiri Olsacd82a322012-03-15 20:09:17 +01001352
1353 return 0;
1354}
1355
1356/*
1357 * Configures event's 'attr' parameter based on the:
1358 * 1) users input - specified in terms parameter
1359 * 2) pmu format definitions - specified by pmu parameter
1360 */
1361int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
Jiri Olsae64b0202015-04-22 21:10:21 +02001362 struct list_head *head_terms,
1363 struct parse_events_error *err)
Jiri Olsacd82a322012-03-15 20:09:17 +01001364{
Adrian Hunterdc0a6202014-07-31 09:00:49 +03001365 bool zero = !!pmu->default_config;
1366
Jiri Olsacd82a322012-03-15 20:09:17 +01001367 attr->type = pmu->type;
Ian Rogers4ac22b42020-05-13 15:06:35 -07001368 return perf_pmu__config_terms(pmu->name, &pmu->format, attr,
1369 head_terms, zero, err);
Jiri Olsacd82a322012-03-15 20:09:17 +01001370}
1371
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -03001372static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1373 struct parse_events_term *term)
Zheng Yana6146d52012-06-15 14:31:41 +08001374{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -03001375 struct perf_pmu_alias *alias;
Zheng Yana6146d52012-06-15 14:31:41 +08001376 char *name;
1377
1378 if (parse_events__is_hardcoded_term(term))
1379 return NULL;
1380
1381 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1382 if (term->val.num != 1)
1383 return NULL;
1384 if (pmu_find_format(&pmu->format, term->config))
1385 return NULL;
1386 name = term->config;
1387 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1388 if (strcasecmp(term->config, "event"))
1389 return NULL;
1390 name = term->val.str;
1391 } else {
1392 return NULL;
1393 }
1394
1395 list_for_each_entry(alias, &pmu->aliases, list) {
1396 if (!strcasecmp(alias->name, name))
1397 return alias;
1398 }
1399 return NULL;
1400}
1401
Stephane Eranian410136f2013-11-12 17:58:49 +01001402
Jiri Olsa1d9e4462014-11-21 10:31:13 +01001403static int check_info_data(struct perf_pmu_alias *alias,
1404 struct perf_pmu_info *info)
Stephane Eranian410136f2013-11-12 17:58:49 +01001405{
1406 /*
1407 * Only one term in event definition can
Jiri Olsa1d9e4462014-11-21 10:31:13 +01001408 * define unit, scale and snapshot, fail
1409 * if there's more than one.
Stephane Eranian410136f2013-11-12 17:58:49 +01001410 */
Arnaldo Carvalho de Melob30a7d12017-02-15 10:06:20 -03001411 if ((info->unit && alias->unit[0]) ||
Jiri Olsa1d9e4462014-11-21 10:31:13 +01001412 (info->scale && alias->scale) ||
1413 (info->snapshot && alias->snapshot))
Stephane Eranian410136f2013-11-12 17:58:49 +01001414 return -EINVAL;
1415
Arnaldo Carvalho de Melob30a7d12017-02-15 10:06:20 -03001416 if (alias->unit[0])
Jiri Olsa1d9e4462014-11-21 10:31:13 +01001417 info->unit = alias->unit;
Stephane Eranian410136f2013-11-12 17:58:49 +01001418
1419 if (alias->scale)
Jiri Olsa1d9e4462014-11-21 10:31:13 +01001420 info->scale = alias->scale;
1421
1422 if (alias->snapshot)
1423 info->snapshot = alias->snapshot;
Stephane Eranian410136f2013-11-12 17:58:49 +01001424
1425 return 0;
1426}
1427
Zheng Yana6146d52012-06-15 14:31:41 +08001428/*
1429 * Find alias in the terms list and replace it with the terms
1430 * defined for the alias
1431 */
Stephane Eranian410136f2013-11-12 17:58:49 +01001432int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
Matt Fleming46441bd2014-09-24 15:04:06 +01001433 struct perf_pmu_info *info)
Zheng Yana6146d52012-06-15 14:31:41 +08001434{
Arnaldo Carvalho de Melo6cee6cd2013-01-18 16:29:49 -03001435 struct parse_events_term *term, *h;
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -03001436 struct perf_pmu_alias *alias;
Zheng Yana6146d52012-06-15 14:31:41 +08001437 int ret;
1438
Matt Fleming044330c2014-11-21 10:31:12 +01001439 info->per_pkg = false;
1440
Stephane Eranian8a398892014-01-17 16:34:05 +01001441 /*
1442 * Mark unit and scale as not set
1443 * (different from default values, see below)
1444 */
Jiri Olsa1d9e4462014-11-21 10:31:13 +01001445 info->unit = NULL;
1446 info->scale = 0.0;
1447 info->snapshot = false;
Andi Kleen37932c12017-03-20 13:17:08 -07001448 info->metric_expr = NULL;
Andi Kleen96284812017-03-20 13:17:10 -07001449 info->metric_name = NULL;
Stephane Eranian410136f2013-11-12 17:58:49 +01001450
Zheng Yana6146d52012-06-15 14:31:41 +08001451 list_for_each_entry_safe(term, h, head_terms, list) {
1452 alias = pmu_find_alias(pmu, term);
1453 if (!alias)
1454 continue;
1455 ret = pmu_alias_terms(alias, &term->list);
1456 if (ret)
1457 return ret;
Stephane Eranian410136f2013-11-12 17:58:49 +01001458
Jiri Olsa1d9e4462014-11-21 10:31:13 +01001459 ret = check_info_data(alias, info);
Stephane Eranian410136f2013-11-12 17:58:49 +01001460 if (ret)
1461 return ret;
1462
Matt Fleming044330c2014-11-21 10:31:12 +01001463 if (alias->per_pkg)
1464 info->per_pkg = true;
Andi Kleen37932c12017-03-20 13:17:08 -07001465 info->metric_expr = alias->metric_expr;
Andi Kleen96284812017-03-20 13:17:10 -07001466 info->metric_name = alias->metric_name;
Matt Fleming044330c2014-11-21 10:31:12 +01001467
Arnaldo Carvalho de Meloe56fbc92019-07-04 12:13:46 -03001468 list_del_init(&term->list);
Ian Rogers1dc92552019-10-30 15:34:47 -07001469 parse_events_term__delete(term);
Zheng Yana6146d52012-06-15 14:31:41 +08001470 }
Stephane Eranian8a398892014-01-17 16:34:05 +01001471
1472 /*
Ingo Molnar4d39c892021-03-23 17:09:15 +01001473 * if no unit or scale found in aliases, then
Stephane Eranian8a398892014-01-17 16:34:05 +01001474 * set defaults as for evsel
1475 * unit cannot left to NULL
1476 */
Matt Fleming46441bd2014-09-24 15:04:06 +01001477 if (info->unit == NULL)
1478 info->unit = "";
Stephane Eranian8a398892014-01-17 16:34:05 +01001479
Matt Fleming46441bd2014-09-24 15:04:06 +01001480 if (info->scale == 0.0)
1481 info->scale = 1.0;
Stephane Eranian8a398892014-01-17 16:34:05 +01001482
Zheng Yana6146d52012-06-15 14:31:41 +08001483 return 0;
1484}
1485
Jiri Olsacd82a322012-03-15 20:09:17 +01001486int perf_pmu__new_format(struct list_head *list, char *name,
1487 int config, unsigned long *bits)
1488{
Arnaldo Carvalho de Melo5c6ccc32013-01-18 16:54:00 -03001489 struct perf_pmu_format *format;
Jiri Olsacd82a322012-03-15 20:09:17 +01001490
1491 format = zalloc(sizeof(*format));
1492 if (!format)
1493 return -ENOMEM;
1494
1495 format->name = strdup(name);
1496 format->value = config;
1497 memcpy(format->bits, bits, sizeof(format->bits));
1498
1499 list_add_tail(&format->list, list);
1500 return 0;
1501}
1502
1503void perf_pmu__set_format(unsigned long *bits, long from, long to)
1504{
1505 long b;
1506
1507 if (!to)
1508 to = from;
1509
Sukadev Bhattiprolu15268132013-01-17 09:11:30 -08001510 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
Jiri Olsacd82a322012-03-15 20:09:17 +01001511 for (b = from; b <= to; b++)
1512 set_bit(b, bits);
1513}
Andi Kleendc098b32013-04-20 11:02:29 -07001514
Namhyung Kimd26383d2020-09-15 12:18:19 +09001515void perf_pmu__del_formats(struct list_head *formats)
1516{
1517 struct perf_pmu_format *fmt, *tmp;
1518
1519 list_for_each_entry_safe(fmt, tmp, formats, list) {
1520 list_del(&fmt->list);
1521 free(fmt->name);
1522 free(fmt);
1523 }
1524}
1525
Cody P Schaferaaea3612015-01-07 17:13:51 -08001526static int sub_non_neg(int a, int b)
1527{
1528 if (b > a)
1529 return 0;
1530 return a - b;
1531}
1532
Andi Kleendc098b32013-04-20 11:02:29 -07001533static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1534 struct perf_pmu_alias *alias)
1535{
Cody P Schaferaaea3612015-01-07 17:13:51 -08001536 struct parse_events_term *term;
1537 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1538
1539 list_for_each_entry(term, &alias->terms, list) {
1540 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1541 used += snprintf(buf + used, sub_non_neg(len, used),
1542 ",%s=%s", term->config,
1543 term->val.str);
1544 }
1545
1546 if (sub_non_neg(len, used) > 0) {
1547 buf[used] = '/';
1548 used++;
1549 }
1550 if (sub_non_neg(len, used) > 0) {
1551 buf[used] = '\0';
1552 used++;
1553 } else
1554 buf[len - 1] = '\0';
1555
Andi Kleendc098b32013-04-20 11:02:29 -07001556 return buf;
1557}
1558
1559static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1560 struct perf_pmu_alias *alias)
1561{
1562 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1563 return buf;
1564}
1565
Andi Kleendd5f1032016-09-15 15:24:50 -07001566struct sevent {
Andi Kleen08e60ed2016-09-15 15:24:43 -07001567 char *name;
1568 char *desc;
Andi Kleendd5f1032016-09-15 15:24:50 -07001569 char *topic;
Andi Kleenf2361022017-01-27 18:03:40 -08001570 char *str;
1571 char *pmu;
Andi Kleen7f372a62017-03-20 13:17:09 -07001572 char *metric_expr;
Andi Kleen96284812017-03-20 13:17:10 -07001573 char *metric_name;
John Garryce0dc7d2020-06-17 17:01:54 +08001574 int is_cpu;
Andi Kleen08e60ed2016-09-15 15:24:43 -07001575};
1576
Andi Kleendd5f1032016-09-15 15:24:50 -07001577static int cmp_sevent(const void *a, const void *b)
Andi Kleendc098b32013-04-20 11:02:29 -07001578{
Andi Kleendd5f1032016-09-15 15:24:50 -07001579 const struct sevent *as = a;
1580 const struct sevent *bs = b;
Andi Kleen08e60ed2016-09-15 15:24:43 -07001581
1582 /* Put extra events last */
1583 if (!!as->desc != !!bs->desc)
1584 return !!as->desc - !!bs->desc;
Andi Kleendd5f1032016-09-15 15:24:50 -07001585 if (as->topic && bs->topic) {
1586 int n = strcmp(as->topic, bs->topic);
1587
1588 if (n)
1589 return n;
1590 }
John Garryce0dc7d2020-06-17 17:01:54 +08001591
1592 /* Order CPU core events to be first */
1593 if (as->is_cpu != bs->is_cpu)
1594 return bs->is_cpu - as->is_cpu;
1595
Andi Kleen08e60ed2016-09-15 15:24:43 -07001596 return strcmp(as->name, bs->name);
1597}
1598
1599static void wordwrap(char *s, int start, int max, int corr)
1600{
1601 int column = start;
1602 int n;
1603
1604 while (*s) {
1605 int wlen = strcspn(s, " \t");
1606
1607 if (column + wlen >= max && column > start) {
1608 printf("\n%*s", start, "");
1609 column = start + corr;
1610 }
1611 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1612 if (n <= 0)
1613 break;
1614 s += wlen;
1615 column += n;
Arnaldo Carvalho de Melo32858482019-06-26 11:42:03 -03001616 s = skip_spaces(s);
Andi Kleen08e60ed2016-09-15 15:24:43 -07001617 }
Andi Kleendc098b32013-04-20 11:02:29 -07001618}
1619
John Garryd504fae2020-03-17 19:02:17 +08001620bool is_pmu_core(const char *name)
1621{
1622 return !strcmp(name, "cpu") || is_arm_pmu_core(name);
1623}
1624
Sukadev Bhattiproluc8d68282016-09-15 15:24:48 -07001625void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
Jin Yaoa7f6c8c2019-10-15 10:53:57 +08001626 bool long_desc, bool details_flag, bool deprecated)
Andi Kleendc098b32013-04-20 11:02:29 -07001627{
1628 struct perf_pmu *pmu;
1629 struct perf_pmu_alias *alias;
1630 char buf[1024];
1631 int printed = 0;
1632 int len, j;
Andi Kleendd5f1032016-09-15 15:24:50 -07001633 struct sevent *aliases;
Andi Kleen08e60ed2016-09-15 15:24:43 -07001634 int numdesc = 0;
Andi Kleen61eb2eb2016-09-15 15:24:44 -07001635 int columns = pager_get_columns();
Andi Kleendd5f1032016-09-15 15:24:50 -07001636 char *topic = NULL;
Andi Kleendc098b32013-04-20 11:02:29 -07001637
1638 pmu = NULL;
1639 len = 0;
Adrian Hunter42634bc2014-10-23 13:45:10 +03001640 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
Andi Kleendc098b32013-04-20 11:02:29 -07001641 list_for_each_entry(alias, &pmu->aliases, list)
1642 len++;
Adrian Hunter42634bc2014-10-23 13:45:10 +03001643 if (pmu->selectable)
1644 len++;
1645 }
Andi Kleendd5f1032016-09-15 15:24:50 -07001646 aliases = zalloc(sizeof(struct sevent) * len);
Andi Kleendc098b32013-04-20 11:02:29 -07001647 if (!aliases)
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001648 goto out_enomem;
Andi Kleendc098b32013-04-20 11:02:29 -07001649 pmu = NULL;
1650 j = 0;
Adrian Hunter42634bc2014-10-23 13:45:10 +03001651 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
Andi Kleendc098b32013-04-20 11:02:29 -07001652 list_for_each_entry(alias, &pmu->aliases, list) {
Andi Kleen08e60ed2016-09-15 15:24:43 -07001653 char *name = alias->desc ? alias->name :
1654 format_alias(buf, sizeof(buf), pmu, alias);
John Garryc1b47452020-06-17 17:01:53 +08001655 bool is_cpu = is_pmu_core(pmu->name);
Andi Kleendc098b32013-04-20 11:02:29 -07001656
Jin Yaoa7f6c8c2019-10-15 10:53:57 +08001657 if (alias->deprecated && !deprecated)
1658 continue;
1659
Andi Kleendc098b32013-04-20 11:02:29 -07001660 if (event_glob != NULL &&
Andi Kleen38d14f02016-10-19 10:50:01 -07001661 !(strglobmatch_nocase(name, event_glob) ||
1662 (!is_cpu && strglobmatch_nocase(alias->name,
Andi Kleen67bdc352016-10-19 11:45:23 -07001663 event_glob)) ||
1664 (alias->topic &&
1665 strglobmatch_nocase(alias->topic, event_glob))))
Andi Kleendc098b32013-04-20 11:02:29 -07001666 continue;
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001667
Andi Kleen08e60ed2016-09-15 15:24:43 -07001668 if (is_cpu && !name_only && !alias->desc)
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001669 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1670
Andi Kleen08e60ed2016-09-15 15:24:43 -07001671 aliases[j].name = name;
1672 if (is_cpu && !name_only && !alias->desc)
1673 aliases[j].name = format_alias_or(buf,
1674 sizeof(buf),
1675 pmu, alias);
1676 aliases[j].name = strdup(aliases[j].name);
1677 if (!aliases[j].name)
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001678 goto out_enomem;
Andi Kleen08e60ed2016-09-15 15:24:43 -07001679
Sukadev Bhattiproluc8d68282016-09-15 15:24:48 -07001680 aliases[j].desc = long_desc ? alias->long_desc :
1681 alias->desc;
Andi Kleendd5f1032016-09-15 15:24:50 -07001682 aliases[j].topic = alias->topic;
Andi Kleenf2361022017-01-27 18:03:40 -08001683 aliases[j].str = alias->str;
1684 aliases[j].pmu = pmu->name;
Andi Kleen7f372a62017-03-20 13:17:09 -07001685 aliases[j].metric_expr = alias->metric_expr;
Andi Kleen96284812017-03-20 13:17:10 -07001686 aliases[j].metric_name = alias->metric_name;
John Garryce0dc7d2020-06-17 17:01:54 +08001687 aliases[j].is_cpu = is_cpu;
Andi Kleendc098b32013-04-20 11:02:29 -07001688 j++;
1689 }
Arnaldo Carvalho de Melofa52cea2015-10-02 15:28:16 -03001690 if (pmu->selectable &&
1691 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001692 char *s;
1693 if (asprintf(&s, "%s//", pmu->name) < 0)
1694 goto out_enomem;
Andi Kleen08e60ed2016-09-15 15:24:43 -07001695 aliases[j].name = s;
Adrian Hunter42634bc2014-10-23 13:45:10 +03001696 j++;
1697 }
1698 }
Andi Kleendc098b32013-04-20 11:02:29 -07001699 len = j;
Andi Kleendd5f1032016-09-15 15:24:50 -07001700 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
Andi Kleendc098b32013-04-20 11:02:29 -07001701 for (j = 0; j < len; j++) {
Andi Kleen15b22ed2017-01-27 18:03:38 -08001702 /* Skip duplicates */
1703 if (j > 0 && !strcmp(aliases[j].name, aliases[j - 1].name))
1704 continue;
Andi Kleendc098b32013-04-20 11:02:29 -07001705 if (name_only) {
Andi Kleen08e60ed2016-09-15 15:24:43 -07001706 printf("%s ", aliases[j].name);
Andi Kleendc098b32013-04-20 11:02:29 -07001707 continue;
1708 }
Andi Kleen1c5f01f2016-09-15 15:24:45 -07001709 if (aliases[j].desc && !quiet_flag) {
Andi Kleen08e60ed2016-09-15 15:24:43 -07001710 if (numdesc++ == 0)
1711 printf("\n");
Andi Kleendd5f1032016-09-15 15:24:50 -07001712 if (aliases[j].topic && (!topic ||
1713 strcmp(topic, aliases[j].topic))) {
1714 printf("%s%s:\n", topic ? "\n" : "",
1715 aliases[j].topic);
1716 topic = aliases[j].topic;
1717 }
Andi Kleen08e60ed2016-09-15 15:24:43 -07001718 printf(" %-50s\n", aliases[j].name);
1719 printf("%*s", 8, "[");
1720 wordwrap(aliases[j].desc, 8, columns, 0);
1721 printf("]\n");
Andi Kleenbf874fc2017-03-20 13:17:11 -07001722 if (details_flag) {
Andi Kleen7f372a62017-03-20 13:17:09 -07001723 printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
Andi Kleen96284812017-03-20 13:17:10 -07001724 if (aliases[j].metric_name)
1725 printf(" MetricName: %s", aliases[j].metric_name);
Andi Kleen7f372a62017-03-20 13:17:09 -07001726 if (aliases[j].metric_expr)
1727 printf(" MetricExpr: %s", aliases[j].metric_expr);
1728 putchar('\n');
1729 }
Andi Kleen08e60ed2016-09-15 15:24:43 -07001730 } else
1731 printf(" %-50s [Kernel PMU event]\n", aliases[j].name);
Andi Kleendc098b32013-04-20 11:02:29 -07001732 printed++;
1733 }
Arnaldo Carvalho de Melodfc431c2015-09-30 17:13:26 -03001734 if (printed && pager_in_use())
Andi Kleendc098b32013-04-20 11:02:29 -07001735 printf("\n");
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001736out_free:
1737 for (j = 0; j < len; j++)
Andi Kleen08e60ed2016-09-15 15:24:43 -07001738 zfree(&aliases[j].name);
Arnaldo Carvalho de Melo7e4772d2014-10-24 10:25:09 -03001739 zfree(&aliases);
1740 return;
1741
1742out_enomem:
1743 printf("FATAL: not enough memory to print PMU events\n");
1744 if (aliases)
1745 goto out_free;
Andi Kleendc098b32013-04-20 11:02:29 -07001746}
Andi Kleen4cabc3d2013-08-21 16:47:26 -07001747
1748bool pmu_have_event(const char *pname, const char *name)
1749{
1750 struct perf_pmu *pmu;
1751 struct perf_pmu_alias *alias;
1752
1753 pmu = NULL;
1754 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1755 if (strcmp(pname, pmu->name))
1756 continue;
1757 list_for_each_entry(alias, &pmu->aliases, list)
1758 if (!strcmp(alias->name, name))
1759 return true;
1760 }
1761 return false;
1762}
Adrian Hunter7d4bdab2014-07-31 09:00:50 +03001763
1764static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1765{
Adrian Hunter7d4bdab2014-07-31 09:00:50 +03001766 char path[PATH_MAX];
1767 const char *sysfs;
1768
1769 sysfs = sysfs__mountpoint();
1770 if (!sysfs)
1771 return NULL;
1772
1773 snprintf(path, PATH_MAX,
1774 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
Andi Kleend9664582019-11-20 16:15:11 -08001775 if (!file_available(path))
Adrian Hunter7d4bdab2014-07-31 09:00:50 +03001776 return NULL;
Adrian Hunter7d4bdab2014-07-31 09:00:50 +03001777 return fopen(path, "r");
1778}
1779
1780int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1781 ...)
1782{
1783 va_list args;
1784 FILE *file;
1785 int ret = EOF;
1786
1787 va_start(args, fmt);
1788 file = perf_pmu__open_file(pmu, name);
1789 if (file) {
1790 ret = vfscanf(file, fmt, args);
1791 fclose(file);
1792 }
1793 va_end(args);
1794 return ret;
1795}
Kan Liang9fbc61f2020-03-19 13:25:01 -07001796
1797static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1798{
1799 struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1800
1801 if (!caps)
1802 return -ENOMEM;
1803
1804 caps->name = strdup(name);
1805 if (!caps->name)
1806 goto free_caps;
1807 caps->value = strndup(value, strlen(value) - 1);
1808 if (!caps->value)
1809 goto free_name;
1810 list_add_tail(&caps->list, list);
1811 return 0;
1812
1813free_name:
1814 zfree(caps->name);
1815free_caps:
1816 free(caps);
1817
1818 return -ENOMEM;
1819}
1820
1821/*
1822 * Reading/parsing the given pmu capabilities, which should be located at:
1823 * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1824 * Return the number of capabilities
1825 */
1826int perf_pmu__caps_parse(struct perf_pmu *pmu)
1827{
1828 struct stat st;
1829 char caps_path[PATH_MAX];
1830 const char *sysfs = sysfs__mountpoint();
1831 DIR *caps_dir;
1832 struct dirent *evt_ent;
1833 int nr_caps = 0;
1834
1835 if (!sysfs)
1836 return -1;
1837
1838 snprintf(caps_path, PATH_MAX,
1839 "%s" EVENT_SOURCE_DEVICE_PATH "%s/caps", sysfs, pmu->name);
1840
1841 if (stat(caps_path, &st) < 0)
1842 return 0; /* no error if caps does not exist */
1843
1844 caps_dir = opendir(caps_path);
1845 if (!caps_dir)
1846 return -EINVAL;
1847
1848 while ((evt_ent = readdir(caps_dir)) != NULL) {
1849 char path[PATH_MAX + NAME_MAX + 1];
1850 char *name = evt_ent->d_name;
1851 char value[128];
1852 FILE *file;
1853
1854 if (!strcmp(name, ".") || !strcmp(name, ".."))
1855 continue;
1856
1857 snprintf(path, sizeof(path), "%s/%s", caps_path, name);
1858
1859 file = fopen(path, "r");
1860 if (!file)
1861 continue;
1862
1863 if (!fgets(value, sizeof(value), file) ||
1864 (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1865 fclose(file);
1866 continue;
1867 }
1868
1869 nr_caps++;
1870 fclose(file);
1871 }
1872
1873 closedir(caps_dir);
1874
1875 return nr_caps;
1876}
Jin Yaoe4064772021-03-10 13:11:38 +08001877
1878void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
1879 char *name)
1880{
1881 struct perf_pmu_format *format;
1882 __u64 masks = 0, bits;
1883 char buf[100];
1884 unsigned int i;
1885
1886 list_for_each_entry(format, &pmu->format, list) {
1887 if (format->value != PERF_PMU_FORMAT_VALUE_CONFIG)
1888 continue;
1889
1890 for_each_set_bit(i, format->bits, PERF_PMU_FORMAT_BITS)
1891 masks |= 1ULL << i;
1892 }
1893
1894 /*
1895 * Kernel doesn't export any valid format bits.
1896 */
1897 if (masks == 0)
1898 return;
1899
1900 bits = config & ~masks;
1901 if (bits == 0)
1902 return;
1903
1904 bitmap_scnprintf((unsigned long *)&bits, sizeof(bits) * 8, buf, sizeof(buf));
1905
1906 pr_warning("WARNING: event '%s' not valid (bits %s of config "
1907 "'%llx' not supported by kernel)!\n",
1908 name ?: "N/A", buf, config);
1909}
Jin Yaoc5a26ea2021-04-27 15:01:19 +08001910
1911bool perf_pmu__has_hybrid(void)
1912{
1913 if (!hybrid_scanned) {
1914 hybrid_scanned = true;
1915 perf_pmu__scan(NULL);
1916 }
1917
1918 return !list_empty(&perf_pmu__hybrid_pmus);
1919}
Jin Yaoc47a5592021-07-01 14:42:53 +08001920
1921int perf_pmu__match(char *pattern, char *name, char *tok)
1922{
1923 if (fnmatch(pattern, name, 0))
1924 return -1;
1925
1926 if (tok && !perf_pmu__valid_suffix(name, tok))
1927 return -1;
1928
1929 return 0;
1930}