Merge tag 'block-5.9-2020-08-14' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / tools / perf / util / pmu.c
blobf1688e1f6ed7808d49362f7e13911c832a213967
1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/list.h>
3 #include <linux/compiler.h>
4 #include <linux/string.h>
5 #include <linux/zalloc.h>
6 #include <subcmd/pager.h>
7 #include <sys/types.h>
8 #include <errno.h>
9 #include <fcntl.h>
10 #include <sys/stat.h>
11 #include <unistd.h>
12 #include <stdio.h>
13 #include <stdbool.h>
14 #include <stdarg.h>
15 #include <dirent.h>
16 #include <api/fs/fs.h>
17 #include <locale.h>
18 #include <regex.h>
19 #include <perf/cpumap.h>
20 #include "debug.h"
21 #include "evsel.h"
22 #include "pmu.h"
23 #include "parse-events.h"
24 #include "header.h"
25 #include "string2.h"
26 #include "strbuf.h"
27 #include "fncache.h"
29 struct perf_pmu perf_pmu__fake;
31 struct perf_pmu_format {
32 char *name;
33 int value;
34 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
35 struct list_head list;
38 int perf_pmu_parse(struct list_head *list, char *name);
39 extern FILE *perf_pmu_in;
41 static LIST_HEAD(pmus);
44 * Parse & process all the sysfs attributes located under
45 * the directory specified in 'dir' parameter.
47 int perf_pmu__format_parse(char *dir, struct list_head *head)
49 struct dirent *evt_ent;
50 DIR *format_dir;
51 int ret = 0;
53 format_dir = opendir(dir);
54 if (!format_dir)
55 return -EINVAL;
57 while (!ret && (evt_ent = readdir(format_dir))) {
58 char path[PATH_MAX];
59 char *name = evt_ent->d_name;
60 FILE *file;
62 if (!strcmp(name, ".") || !strcmp(name, ".."))
63 continue;
65 snprintf(path, PATH_MAX, "%s/%s", dir, name);
67 ret = -EINVAL;
68 file = fopen(path, "r");
69 if (!file)
70 break;
72 perf_pmu_in = file;
73 ret = perf_pmu_parse(head, name);
74 fclose(file);
77 closedir(format_dir);
78 return ret;
82 * Reading/parsing the default pmu format definition, which should be
83 * located at:
84 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
86 static int pmu_format(const char *name, struct list_head *format)
88 char path[PATH_MAX];
89 const char *sysfs = sysfs__mountpoint();
91 if (!sysfs)
92 return -1;
94 snprintf(path, PATH_MAX,
95 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
97 if (!file_available(path))
98 return 0;
100 if (perf_pmu__format_parse(path, format))
101 return -1;
103 return 0;
106 int perf_pmu__convert_scale(const char *scale, char **end, double *sval)
108 char *lc;
109 int ret = 0;
112 * save current locale
114 lc = setlocale(LC_NUMERIC, NULL);
117 * The lc string may be allocated in static storage,
118 * so get a dynamic copy to make it survive setlocale
119 * call below.
121 lc = strdup(lc);
122 if (!lc) {
123 ret = -ENOMEM;
124 goto out;
128 * force to C locale to ensure kernel
129 * scale string is converted correctly.
130 * kernel uses default C locale.
132 setlocale(LC_NUMERIC, "C");
134 *sval = strtod(scale, end);
136 out:
137 /* restore locale */
138 setlocale(LC_NUMERIC, lc);
139 free(lc);
140 return ret;
143 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
145 struct stat st;
146 ssize_t sret;
147 char scale[128];
148 int fd, ret = -1;
149 char path[PATH_MAX];
151 scnprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
153 fd = open(path, O_RDONLY);
154 if (fd == -1)
155 return -1;
157 if (fstat(fd, &st) < 0)
158 goto error;
160 sret = read(fd, scale, sizeof(scale)-1);
161 if (sret < 0)
162 goto error;
164 if (scale[sret - 1] == '\n')
165 scale[sret - 1] = '\0';
166 else
167 scale[sret] = '\0';
169 ret = perf_pmu__convert_scale(scale, NULL, &alias->scale);
170 error:
171 close(fd);
172 return ret;
175 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
177 char path[PATH_MAX];
178 ssize_t sret;
179 int fd;
181 scnprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
183 fd = open(path, O_RDONLY);
184 if (fd == -1)
185 return -1;
187 sret = read(fd, alias->unit, UNIT_MAX_LEN);
188 if (sret < 0)
189 goto error;
191 close(fd);
193 if (alias->unit[sret - 1] == '\n')
194 alias->unit[sret - 1] = '\0';
195 else
196 alias->unit[sret] = '\0';
198 return 0;
199 error:
200 close(fd);
201 alias->unit[0] = '\0';
202 return -1;
205 static int
206 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
208 char path[PATH_MAX];
209 int fd;
211 scnprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
213 fd = open(path, O_RDONLY);
214 if (fd == -1)
215 return -1;
217 close(fd);
219 alias->per_pkg = true;
220 return 0;
223 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
224 char *dir, char *name)
226 char path[PATH_MAX];
227 int fd;
229 scnprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
231 fd = open(path, O_RDONLY);
232 if (fd == -1)
233 return -1;
235 alias->snapshot = true;
236 close(fd);
237 return 0;
240 static void perf_pmu_assign_str(char *name, const char *field, char **old_str,
241 char **new_str)
243 if (!*old_str)
244 goto set_new;
246 if (*new_str) { /* Have new string, check with old */
247 if (strcasecmp(*old_str, *new_str))
248 pr_debug("alias %s differs in field '%s'\n",
249 name, field);
250 zfree(old_str);
251 } else /* Nothing new --> keep old string */
252 return;
253 set_new:
254 *old_str = *new_str;
255 *new_str = NULL;
258 static void perf_pmu_update_alias(struct perf_pmu_alias *old,
259 struct perf_pmu_alias *newalias)
261 perf_pmu_assign_str(old->name, "desc", &old->desc, &newalias->desc);
262 perf_pmu_assign_str(old->name, "long_desc", &old->long_desc,
263 &newalias->long_desc);
264 perf_pmu_assign_str(old->name, "topic", &old->topic, &newalias->topic);
265 perf_pmu_assign_str(old->name, "metric_expr", &old->metric_expr,
266 &newalias->metric_expr);
267 perf_pmu_assign_str(old->name, "metric_name", &old->metric_name,
268 &newalias->metric_name);
269 perf_pmu_assign_str(old->name, "value", &old->str, &newalias->str);
270 old->scale = newalias->scale;
271 old->per_pkg = newalias->per_pkg;
272 old->snapshot = newalias->snapshot;
273 memcpy(old->unit, newalias->unit, sizeof(old->unit));
276 /* Delete an alias entry. */
277 static void perf_pmu_free_alias(struct perf_pmu_alias *newalias)
279 zfree(&newalias->name);
280 zfree(&newalias->desc);
281 zfree(&newalias->long_desc);
282 zfree(&newalias->topic);
283 zfree(&newalias->str);
284 zfree(&newalias->metric_expr);
285 zfree(&newalias->metric_name);
286 parse_events_terms__purge(&newalias->terms);
287 free(newalias);
290 /* Merge an alias, search in alias list. If this name is already
291 * present merge both of them to combine all information.
293 static bool perf_pmu_merge_alias(struct perf_pmu_alias *newalias,
294 struct list_head *alist)
296 struct perf_pmu_alias *a;
298 list_for_each_entry(a, alist, list) {
299 if (!strcasecmp(newalias->name, a->name)) {
300 perf_pmu_update_alias(a, newalias);
301 perf_pmu_free_alias(newalias);
302 return true;
305 return false;
308 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
309 char *desc, char *val,
310 char *long_desc, char *topic,
311 char *unit, char *perpkg,
312 char *metric_expr,
313 char *metric_name,
314 char *deprecated)
316 struct parse_events_term *term;
317 struct perf_pmu_alias *alias;
318 int ret;
319 int num;
320 char newval[256];
322 alias = malloc(sizeof(*alias));
323 if (!alias)
324 return -ENOMEM;
326 INIT_LIST_HEAD(&alias->terms);
327 alias->scale = 1.0;
328 alias->unit[0] = '\0';
329 alias->per_pkg = false;
330 alias->snapshot = false;
331 alias->deprecated = false;
333 ret = parse_events_terms(&alias->terms, val);
334 if (ret) {
335 pr_err("Cannot parse alias %s: %d\n", val, ret);
336 free(alias);
337 return ret;
340 /* Scan event and remove leading zeroes, spaces, newlines, some
341 * platforms have terms specified as
342 * event=0x0091 (read from files ../<PMU>/events/<FILE>
343 * and terms specified as event=0x91 (read from JSON files).
345 * Rebuild string to make alias->str member comparable.
347 memset(newval, 0, sizeof(newval));
348 ret = 0;
349 list_for_each_entry(term, &alias->terms, list) {
350 if (ret)
351 ret += scnprintf(newval + ret, sizeof(newval) - ret,
352 ",");
353 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
354 ret += scnprintf(newval + ret, sizeof(newval) - ret,
355 "%s=%#x", term->config, term->val.num);
356 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
357 ret += scnprintf(newval + ret, sizeof(newval) - ret,
358 "%s=%s", term->config, term->val.str);
361 alias->name = strdup(name);
362 if (dir) {
364 * load unit name and scale if available
366 perf_pmu__parse_unit(alias, dir, name);
367 perf_pmu__parse_scale(alias, dir, name);
368 perf_pmu__parse_per_pkg(alias, dir, name);
369 perf_pmu__parse_snapshot(alias, dir, name);
372 alias->metric_expr = metric_expr ? strdup(metric_expr) : NULL;
373 alias->metric_name = metric_name ? strdup(metric_name): NULL;
374 alias->desc = desc ? strdup(desc) : NULL;
375 alias->long_desc = long_desc ? strdup(long_desc) :
376 desc ? strdup(desc) : NULL;
377 alias->topic = topic ? strdup(topic) : NULL;
378 if (unit) {
379 if (perf_pmu__convert_scale(unit, &unit, &alias->scale) < 0)
380 return -1;
381 snprintf(alias->unit, sizeof(alias->unit), "%s", unit);
383 alias->per_pkg = perpkg && sscanf(perpkg, "%d", &num) == 1 && num == 1;
384 alias->str = strdup(newval);
386 if (deprecated)
387 alias->deprecated = true;
389 if (!perf_pmu_merge_alias(alias, list))
390 list_add_tail(&alias->list, list);
392 return 0;
395 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
397 char buf[256];
398 int ret;
400 ret = fread(buf, 1, sizeof(buf), file);
401 if (ret == 0)
402 return -EINVAL;
404 buf[ret] = 0;
406 /* Remove trailing newline from sysfs file */
407 strim(buf);
409 return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL, NULL, NULL,
410 NULL, NULL, NULL, NULL);
413 static inline bool pmu_alias_info_file(char *name)
415 size_t len;
417 len = strlen(name);
418 if (len > 5 && !strcmp(name + len - 5, ".unit"))
419 return true;
420 if (len > 6 && !strcmp(name + len - 6, ".scale"))
421 return true;
422 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
423 return true;
424 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
425 return true;
427 return false;
431 * Process all the sysfs attributes located under the directory
432 * specified in 'dir' parameter.
434 static int pmu_aliases_parse(char *dir, struct list_head *head)
436 struct dirent *evt_ent;
437 DIR *event_dir;
439 event_dir = opendir(dir);
440 if (!event_dir)
441 return -EINVAL;
443 while ((evt_ent = readdir(event_dir))) {
444 char path[PATH_MAX];
445 char *name = evt_ent->d_name;
446 FILE *file;
448 if (!strcmp(name, ".") || !strcmp(name, ".."))
449 continue;
452 * skip info files parsed in perf_pmu__new_alias()
454 if (pmu_alias_info_file(name))
455 continue;
457 scnprintf(path, PATH_MAX, "%s/%s", dir, name);
459 file = fopen(path, "r");
460 if (!file) {
461 pr_debug("Cannot open %s\n", path);
462 continue;
465 if (perf_pmu__new_alias(head, dir, name, file) < 0)
466 pr_debug("Cannot set up %s\n", name);
467 fclose(file);
470 closedir(event_dir);
471 return 0;
475 * Reading the pmu event aliases definition, which should be located at:
476 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
478 static int pmu_aliases(const char *name, struct list_head *head)
480 char path[PATH_MAX];
481 const char *sysfs = sysfs__mountpoint();
483 if (!sysfs)
484 return -1;
486 snprintf(path, PATH_MAX,
487 "%s/bus/event_source/devices/%s/events", sysfs, name);
489 if (!file_available(path))
490 return 0;
492 if (pmu_aliases_parse(path, head))
493 return -1;
495 return 0;
498 static int pmu_alias_terms(struct perf_pmu_alias *alias,
499 struct list_head *terms)
501 struct parse_events_term *term, *cloned;
502 LIST_HEAD(list);
503 int ret;
505 list_for_each_entry(term, &alias->terms, list) {
506 ret = parse_events_term__clone(&cloned, term);
507 if (ret) {
508 parse_events_terms__purge(&list);
509 return ret;
512 * Weak terms don't override command line options,
513 * which we don't want for implicit terms in aliases.
515 cloned->weak = true;
516 list_add_tail(&cloned->list, &list);
518 list_splice(&list, terms);
519 return 0;
523 * Reading/parsing the default pmu type value, which should be
524 * located at:
525 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
527 static int pmu_type(const char *name, __u32 *type)
529 char path[PATH_MAX];
530 FILE *file;
531 int ret = 0;
532 const char *sysfs = sysfs__mountpoint();
534 if (!sysfs)
535 return -1;
537 snprintf(path, PATH_MAX,
538 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
540 if (access(path, R_OK) < 0)
541 return -1;
543 file = fopen(path, "r");
544 if (!file)
545 return -EINVAL;
547 if (1 != fscanf(file, "%u", type))
548 ret = -1;
550 fclose(file);
551 return ret;
554 /* Add all pmus in sysfs to pmu list: */
555 static void pmu_read_sysfs(void)
557 char path[PATH_MAX];
558 DIR *dir;
559 struct dirent *dent;
560 const char *sysfs = sysfs__mountpoint();
562 if (!sysfs)
563 return;
565 snprintf(path, PATH_MAX,
566 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
568 dir = opendir(path);
569 if (!dir)
570 return;
572 while ((dent = readdir(dir))) {
573 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
574 continue;
575 /* add to static LIST_HEAD(pmus): */
576 perf_pmu__find(dent->d_name);
579 closedir(dir);
582 static struct perf_cpu_map *__pmu_cpumask(const char *path)
584 FILE *file;
585 struct perf_cpu_map *cpus;
587 file = fopen(path, "r");
588 if (!file)
589 return NULL;
591 cpus = perf_cpu_map__read(file);
592 fclose(file);
593 return cpus;
597 * Uncore PMUs have a "cpumask" file under sysfs. CPU PMUs (e.g. on arm/arm64)
598 * may have a "cpus" file.
600 #define CPUS_TEMPLATE_UNCORE "%s/bus/event_source/devices/%s/cpumask"
601 #define CPUS_TEMPLATE_CPU "%s/bus/event_source/devices/%s/cpus"
603 static struct perf_cpu_map *pmu_cpumask(const char *name)
605 char path[PATH_MAX];
606 struct perf_cpu_map *cpus;
607 const char *sysfs = sysfs__mountpoint();
608 const char *templates[] = {
609 CPUS_TEMPLATE_UNCORE,
610 CPUS_TEMPLATE_CPU,
611 NULL
613 const char **template;
615 if (!sysfs)
616 return NULL;
618 for (template = templates; *template; template++) {
619 snprintf(path, PATH_MAX, *template, sysfs, name);
620 cpus = __pmu_cpumask(path);
621 if (cpus)
622 return cpus;
625 return NULL;
628 static bool pmu_is_uncore(const char *name)
630 char path[PATH_MAX];
631 const char *sysfs;
633 sysfs = sysfs__mountpoint();
634 snprintf(path, PATH_MAX, CPUS_TEMPLATE_UNCORE, sysfs, name);
635 return file_available(path);
639 * PMU CORE devices have different name other than cpu in sysfs on some
640 * platforms.
641 * Looking for possible sysfs files to identify the arm core device.
643 static int is_arm_pmu_core(const char *name)
645 char path[PATH_MAX];
646 const char *sysfs = sysfs__mountpoint();
648 if (!sysfs)
649 return 0;
651 /* Look for cpu sysfs (specific to arm) */
652 scnprintf(path, PATH_MAX, "%s/bus/event_source/devices/%s/cpus",
653 sysfs, name);
654 return file_available(path);
657 static char *perf_pmu__getcpuid(struct perf_pmu *pmu)
659 char *cpuid;
660 static bool printed;
662 cpuid = getenv("PERF_CPUID");
663 if (cpuid)
664 cpuid = strdup(cpuid);
665 if (!cpuid)
666 cpuid = get_cpuid_str(pmu);
667 if (!cpuid)
668 return NULL;
670 if (!printed) {
671 pr_debug("Using CPUID %s\n", cpuid);
672 printed = true;
674 return cpuid;
677 struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu)
679 struct pmu_events_map *map;
680 char *cpuid = perf_pmu__getcpuid(pmu);
681 int i;
683 /* on some platforms which uses cpus map, cpuid can be NULL for
684 * PMUs other than CORE PMUs.
686 if (!cpuid)
687 return NULL;
689 i = 0;
690 for (;;) {
691 map = &pmu_events_map[i++];
692 if (!map->table) {
693 map = NULL;
694 break;
697 if (!strcmp_cpuid_str(map->cpuid, cpuid))
698 break;
700 free(cpuid);
701 return map;
704 bool pmu_uncore_alias_match(const char *pmu_name, const char *name)
706 char *tmp = NULL, *tok, *str;
707 bool res;
709 str = strdup(pmu_name);
710 if (!str)
711 return false;
714 * uncore alias may be from different PMU with common prefix
716 tok = strtok_r(str, ",", &tmp);
717 if (strncmp(pmu_name, tok, strlen(tok))) {
718 res = false;
719 goto out;
723 * Match more complex aliases where the alias name is a comma-delimited
724 * list of tokens, orderly contained in the matching PMU name.
726 * Example: For alias "socket,pmuname" and PMU "socketX_pmunameY", we
727 * match "socket" in "socketX_pmunameY" and then "pmuname" in
728 * "pmunameY".
730 for (; tok; name += strlen(tok), tok = strtok_r(NULL, ",", &tmp)) {
731 name = strstr(name, tok);
732 if (!name) {
733 res = false;
734 goto out;
738 res = true;
739 out:
740 free(str);
741 return res;
745 * From the pmu_events_map, find the table of PMU events that corresponds
746 * to the current running CPU. Then, add all PMU events from that table
747 * as aliases.
749 void pmu_add_cpu_aliases_map(struct list_head *head, struct perf_pmu *pmu,
750 struct pmu_events_map *map)
752 int i;
753 const char *name = pmu->name;
755 * Found a matching PMU events table. Create aliases
757 i = 0;
758 while (1) {
759 const char *cpu_name = is_arm_pmu_core(name) ? name : "cpu";
760 struct pmu_event *pe = &map->table[i++];
761 const char *pname = pe->pmu ? pe->pmu : cpu_name;
763 if (!pe->name) {
764 if (pe->metric_group || pe->metric_name)
765 continue;
766 break;
769 if (pmu_is_uncore(name) &&
770 pmu_uncore_alias_match(pname, name))
771 goto new_alias;
773 if (strcmp(pname, name))
774 continue;
776 new_alias:
777 /* need type casts to override 'const' */
778 __perf_pmu__new_alias(head, NULL, (char *)pe->name,
779 (char *)pe->desc, (char *)pe->event,
780 (char *)pe->long_desc, (char *)pe->topic,
781 (char *)pe->unit, (char *)pe->perpkg,
782 (char *)pe->metric_expr,
783 (char *)pe->metric_name,
784 (char *)pe->deprecated);
788 static void pmu_add_cpu_aliases(struct list_head *head, struct perf_pmu *pmu)
790 struct pmu_events_map *map;
792 map = perf_pmu__find_map(pmu);
793 if (!map)
794 return;
796 pmu_add_cpu_aliases_map(head, pmu, map);
799 struct perf_event_attr * __weak
800 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
802 return NULL;
805 static int pmu_max_precise(const char *name)
807 char path[PATH_MAX];
808 int max_precise = -1;
810 scnprintf(path, PATH_MAX,
811 "bus/event_source/devices/%s/caps/max_precise",
812 name);
814 sysfs__read_int(path, &max_precise);
815 return max_precise;
818 static struct perf_pmu *pmu_lookup(const char *name)
820 struct perf_pmu *pmu;
821 LIST_HEAD(format);
822 LIST_HEAD(aliases);
823 __u32 type;
826 * The pmu data we store & need consists of the pmu
827 * type value and format definitions. Load both right
828 * now.
830 if (pmu_format(name, &format))
831 return NULL;
834 * Check the type first to avoid unnecessary work.
836 if (pmu_type(name, &type))
837 return NULL;
839 if (pmu_aliases(name, &aliases))
840 return NULL;
842 pmu = zalloc(sizeof(*pmu));
843 if (!pmu)
844 return NULL;
846 pmu->cpus = pmu_cpumask(name);
847 pmu->name = strdup(name);
848 pmu->type = type;
849 pmu->is_uncore = pmu_is_uncore(name);
850 pmu->max_precise = pmu_max_precise(name);
851 pmu_add_cpu_aliases(&aliases, pmu);
853 INIT_LIST_HEAD(&pmu->format);
854 INIT_LIST_HEAD(&pmu->aliases);
855 INIT_LIST_HEAD(&pmu->caps);
856 list_splice(&format, &pmu->format);
857 list_splice(&aliases, &pmu->aliases);
858 list_add_tail(&pmu->list, &pmus);
860 pmu->default_config = perf_pmu__get_default_config(pmu);
862 return pmu;
865 static struct perf_pmu *pmu_find(const char *name)
867 struct perf_pmu *pmu;
869 list_for_each_entry(pmu, &pmus, list)
870 if (!strcmp(pmu->name, name))
871 return pmu;
873 return NULL;
876 struct perf_pmu *perf_pmu__find_by_type(unsigned int type)
878 struct perf_pmu *pmu;
880 list_for_each_entry(pmu, &pmus, list)
881 if (pmu->type == type)
882 return pmu;
884 return NULL;
887 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
890 * pmu iterator: If pmu is NULL, we start at the begin,
891 * otherwise return the next pmu. Returns NULL on end.
893 if (!pmu) {
894 pmu_read_sysfs();
895 pmu = list_prepare_entry(pmu, &pmus, list);
897 list_for_each_entry_continue(pmu, &pmus, list)
898 return pmu;
899 return NULL;
902 struct perf_pmu *evsel__find_pmu(struct evsel *evsel)
904 struct perf_pmu *pmu = NULL;
906 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
907 if (pmu->type == evsel->core.attr.type)
908 break;
911 return pmu;
914 bool evsel__is_aux_event(struct evsel *evsel)
916 struct perf_pmu *pmu = evsel__find_pmu(evsel);
918 return pmu && pmu->auxtrace;
921 struct perf_pmu *perf_pmu__find(const char *name)
923 struct perf_pmu *pmu;
926 * Once PMU is loaded it stays in the list,
927 * so we keep us from multiple reading/parsing
928 * the pmu format definitions.
930 pmu = pmu_find(name);
931 if (pmu)
932 return pmu;
934 return pmu_lookup(name);
937 static struct perf_pmu_format *
938 pmu_find_format(struct list_head *formats, const char *name)
940 struct perf_pmu_format *format;
942 list_for_each_entry(format, formats, list)
943 if (!strcmp(format->name, name))
944 return format;
946 return NULL;
949 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
951 struct perf_pmu_format *format = pmu_find_format(formats, name);
952 __u64 bits = 0;
953 int fbit;
955 if (!format)
956 return 0;
958 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
959 bits |= 1ULL << fbit;
961 return bits;
964 int perf_pmu__format_type(struct list_head *formats, const char *name)
966 struct perf_pmu_format *format = pmu_find_format(formats, name);
968 if (!format)
969 return -1;
971 return format->value;
975 * Sets value based on the format definition (format parameter)
976 * and unformated value (value parameter).
978 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
979 bool zero)
981 unsigned long fbit, vbit;
983 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
985 if (!test_bit(fbit, format))
986 continue;
988 if (value & (1llu << vbit++))
989 *v |= (1llu << fbit);
990 else if (zero)
991 *v &= ~(1llu << fbit);
995 static __u64 pmu_format_max_value(const unsigned long *format)
997 int w;
999 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
1000 if (!w)
1001 return 0;
1002 if (w < 64)
1003 return (1ULL << w) - 1;
1004 return -1;
1008 * Term is a string term, and might be a param-term. Try to look up it's value
1009 * in the remaining terms.
1010 * - We have a term like "base-or-format-term=param-term",
1011 * - We need to find the value supplied for "param-term" (with param-term named
1012 * in a config string) later on in the term list.
1014 static int pmu_resolve_param_term(struct parse_events_term *term,
1015 struct list_head *head_terms,
1016 __u64 *value)
1018 struct parse_events_term *t;
1020 list_for_each_entry(t, head_terms, list) {
1021 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM &&
1022 t->config && !strcmp(t->config, term->config)) {
1023 t->used = true;
1024 *value = t->val.num;
1025 return 0;
1029 if (verbose > 0)
1030 printf("Required parameter '%s' not specified\n", term->config);
1032 return -1;
1035 static char *pmu_formats_string(struct list_head *formats)
1037 struct perf_pmu_format *format;
1038 char *str = NULL;
1039 struct strbuf buf = STRBUF_INIT;
1040 unsigned i = 0;
1042 if (!formats)
1043 return NULL;
1045 /* sysfs exported terms */
1046 list_for_each_entry(format, formats, list)
1047 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1048 goto error;
1050 str = strbuf_detach(&buf, NULL);
1051 error:
1052 strbuf_release(&buf);
1054 return str;
1058 * Setup one of config[12] attr members based on the
1059 * user input data - term parameter.
1061 static int pmu_config_term(const char *pmu_name,
1062 struct list_head *formats,
1063 struct perf_event_attr *attr,
1064 struct parse_events_term *term,
1065 struct list_head *head_terms,
1066 bool zero, struct parse_events_error *err)
1068 struct perf_pmu_format *format;
1069 __u64 *vp;
1070 __u64 val, max_val;
1073 * If this is a parameter we've already used for parameterized-eval,
1074 * skip it in normal eval.
1076 if (term->used)
1077 return 0;
1080 * Hardcoded terms should be already in, so nothing
1081 * to be done for them.
1083 if (parse_events__is_hardcoded_term(term))
1084 return 0;
1086 format = pmu_find_format(formats, term->config);
1087 if (!format) {
1088 char *pmu_term = pmu_formats_string(formats);
1089 char *unknown_term;
1090 char *help_msg;
1092 if (asprintf(&unknown_term,
1093 "unknown term '%s' for pmu '%s'",
1094 term->config, pmu_name) < 0)
1095 unknown_term = NULL;
1096 help_msg = parse_events_formats_error_string(pmu_term);
1097 if (err) {
1098 parse_events__handle_error(err, term->err_term,
1099 unknown_term,
1100 help_msg);
1101 } else {
1102 pr_debug("%s (%s)\n", unknown_term, help_msg);
1103 free(unknown_term);
1105 free(pmu_term);
1106 return -EINVAL;
1109 switch (format->value) {
1110 case PERF_PMU_FORMAT_VALUE_CONFIG:
1111 vp = &attr->config;
1112 break;
1113 case PERF_PMU_FORMAT_VALUE_CONFIG1:
1114 vp = &attr->config1;
1115 break;
1116 case PERF_PMU_FORMAT_VALUE_CONFIG2:
1117 vp = &attr->config2;
1118 break;
1119 default:
1120 return -EINVAL;
1124 * Either directly use a numeric term, or try to translate string terms
1125 * using event parameters.
1127 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1128 if (term->no_value &&
1129 bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1130 if (err) {
1131 parse_events__handle_error(err, term->err_val,
1132 strdup("no value assigned for term"),
1133 NULL);
1135 return -EINVAL;
1138 val = term->val.num;
1139 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1140 if (strcmp(term->val.str, "?")) {
1141 if (verbose > 0) {
1142 pr_info("Invalid sysfs entry %s=%s\n",
1143 term->config, term->val.str);
1145 if (err) {
1146 parse_events__handle_error(err, term->err_val,
1147 strdup("expected numeric value"),
1148 NULL);
1150 return -EINVAL;
1153 if (pmu_resolve_param_term(term, head_terms, &val))
1154 return -EINVAL;
1155 } else
1156 return -EINVAL;
1158 max_val = pmu_format_max_value(format->bits);
1159 if (val > max_val) {
1160 if (err) {
1161 char *err_str;
1163 parse_events__handle_error(err, term->err_val,
1164 asprintf(&err_str,
1165 "value too big for format, maximum is %llu",
1166 (unsigned long long)max_val) < 0
1167 ? strdup("value too big for format")
1168 : err_str,
1169 NULL);
1170 return -EINVAL;
1173 * Assume we don't care if !err, in which case the value will be
1174 * silently truncated.
1178 pmu_format_value(format->bits, val, vp, zero);
1179 return 0;
1182 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
1183 struct perf_event_attr *attr,
1184 struct list_head *head_terms,
1185 bool zero, struct parse_events_error *err)
1187 struct parse_events_term *term;
1189 list_for_each_entry(term, head_terms, list) {
1190 if (pmu_config_term(pmu_name, formats, attr, term, head_terms,
1191 zero, err))
1192 return -EINVAL;
1195 return 0;
1199 * Configures event's 'attr' parameter based on the:
1200 * 1) users input - specified in terms parameter
1201 * 2) pmu format definitions - specified by pmu parameter
1203 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1204 struct list_head *head_terms,
1205 struct parse_events_error *err)
1207 bool zero = !!pmu->default_config;
1209 attr->type = pmu->type;
1210 return perf_pmu__config_terms(pmu->name, &pmu->format, attr,
1211 head_terms, zero, err);
1214 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1215 struct parse_events_term *term)
1217 struct perf_pmu_alias *alias;
1218 char *name;
1220 if (parse_events__is_hardcoded_term(term))
1221 return NULL;
1223 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1224 if (term->val.num != 1)
1225 return NULL;
1226 if (pmu_find_format(&pmu->format, term->config))
1227 return NULL;
1228 name = term->config;
1229 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1230 if (strcasecmp(term->config, "event"))
1231 return NULL;
1232 name = term->val.str;
1233 } else {
1234 return NULL;
1237 list_for_each_entry(alias, &pmu->aliases, list) {
1238 if (!strcasecmp(alias->name, name))
1239 return alias;
1241 return NULL;
1245 static int check_info_data(struct perf_pmu_alias *alias,
1246 struct perf_pmu_info *info)
1249 * Only one term in event definition can
1250 * define unit, scale and snapshot, fail
1251 * if there's more than one.
1253 if ((info->unit && alias->unit[0]) ||
1254 (info->scale && alias->scale) ||
1255 (info->snapshot && alias->snapshot))
1256 return -EINVAL;
1258 if (alias->unit[0])
1259 info->unit = alias->unit;
1261 if (alias->scale)
1262 info->scale = alias->scale;
1264 if (alias->snapshot)
1265 info->snapshot = alias->snapshot;
1267 return 0;
1271 * Find alias in the terms list and replace it with the terms
1272 * defined for the alias
1274 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1275 struct perf_pmu_info *info)
1277 struct parse_events_term *term, *h;
1278 struct perf_pmu_alias *alias;
1279 int ret;
1281 info->per_pkg = false;
1284 * Mark unit and scale as not set
1285 * (different from default values, see below)
1287 info->unit = NULL;
1288 info->scale = 0.0;
1289 info->snapshot = false;
1290 info->metric_expr = NULL;
1291 info->metric_name = NULL;
1293 list_for_each_entry_safe(term, h, head_terms, list) {
1294 alias = pmu_find_alias(pmu, term);
1295 if (!alias)
1296 continue;
1297 ret = pmu_alias_terms(alias, &term->list);
1298 if (ret)
1299 return ret;
1301 ret = check_info_data(alias, info);
1302 if (ret)
1303 return ret;
1305 if (alias->per_pkg)
1306 info->per_pkg = true;
1307 info->metric_expr = alias->metric_expr;
1308 info->metric_name = alias->metric_name;
1310 list_del_init(&term->list);
1311 parse_events_term__delete(term);
1315 * if no unit or scale foundin aliases, then
1316 * set defaults as for evsel
1317 * unit cannot left to NULL
1319 if (info->unit == NULL)
1320 info->unit = "";
1322 if (info->scale == 0.0)
1323 info->scale = 1.0;
1325 return 0;
1328 int perf_pmu__new_format(struct list_head *list, char *name,
1329 int config, unsigned long *bits)
1331 struct perf_pmu_format *format;
1333 format = zalloc(sizeof(*format));
1334 if (!format)
1335 return -ENOMEM;
1337 format->name = strdup(name);
1338 format->value = config;
1339 memcpy(format->bits, bits, sizeof(format->bits));
1341 list_add_tail(&format->list, list);
1342 return 0;
1345 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1347 long b;
1349 if (!to)
1350 to = from;
1352 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1353 for (b = from; b <= to; b++)
1354 set_bit(b, bits);
1357 static int sub_non_neg(int a, int b)
1359 if (b > a)
1360 return 0;
1361 return a - b;
1364 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1365 struct perf_pmu_alias *alias)
1367 struct parse_events_term *term;
1368 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1370 list_for_each_entry(term, &alias->terms, list) {
1371 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1372 used += snprintf(buf + used, sub_non_neg(len, used),
1373 ",%s=%s", term->config,
1374 term->val.str);
1377 if (sub_non_neg(len, used) > 0) {
1378 buf[used] = '/';
1379 used++;
1381 if (sub_non_neg(len, used) > 0) {
1382 buf[used] = '\0';
1383 used++;
1384 } else
1385 buf[len - 1] = '\0';
1387 return buf;
1390 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1391 struct perf_pmu_alias *alias)
1393 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1394 return buf;
1397 struct sevent {
1398 char *name;
1399 char *desc;
1400 char *topic;
1401 char *str;
1402 char *pmu;
1403 char *metric_expr;
1404 char *metric_name;
1405 int is_cpu;
1408 static int cmp_sevent(const void *a, const void *b)
1410 const struct sevent *as = a;
1411 const struct sevent *bs = b;
1413 /* Put extra events last */
1414 if (!!as->desc != !!bs->desc)
1415 return !!as->desc - !!bs->desc;
1416 if (as->topic && bs->topic) {
1417 int n = strcmp(as->topic, bs->topic);
1419 if (n)
1420 return n;
1423 /* Order CPU core events to be first */
1424 if (as->is_cpu != bs->is_cpu)
1425 return bs->is_cpu - as->is_cpu;
1427 return strcmp(as->name, bs->name);
1430 static void wordwrap(char *s, int start, int max, int corr)
1432 int column = start;
1433 int n;
1435 while (*s) {
1436 int wlen = strcspn(s, " \t");
1438 if (column + wlen >= max && column > start) {
1439 printf("\n%*s", start, "");
1440 column = start + corr;
1442 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1443 if (n <= 0)
1444 break;
1445 s += wlen;
1446 column += n;
1447 s = skip_spaces(s);
1451 bool is_pmu_core(const char *name)
1453 return !strcmp(name, "cpu") || is_arm_pmu_core(name);
1456 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1457 bool long_desc, bool details_flag, bool deprecated)
1459 struct perf_pmu *pmu;
1460 struct perf_pmu_alias *alias;
1461 char buf[1024];
1462 int printed = 0;
1463 int len, j;
1464 struct sevent *aliases;
1465 int numdesc = 0;
1466 int columns = pager_get_columns();
1467 char *topic = NULL;
1469 pmu = NULL;
1470 len = 0;
1471 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1472 list_for_each_entry(alias, &pmu->aliases, list)
1473 len++;
1474 if (pmu->selectable)
1475 len++;
1477 aliases = zalloc(sizeof(struct sevent) * len);
1478 if (!aliases)
1479 goto out_enomem;
1480 pmu = NULL;
1481 j = 0;
1482 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1483 list_for_each_entry(alias, &pmu->aliases, list) {
1484 char *name = alias->desc ? alias->name :
1485 format_alias(buf, sizeof(buf), pmu, alias);
1486 bool is_cpu = is_pmu_core(pmu->name);
1488 if (alias->deprecated && !deprecated)
1489 continue;
1491 if (event_glob != NULL &&
1492 !(strglobmatch_nocase(name, event_glob) ||
1493 (!is_cpu && strglobmatch_nocase(alias->name,
1494 event_glob)) ||
1495 (alias->topic &&
1496 strglobmatch_nocase(alias->topic, event_glob))))
1497 continue;
1499 if (is_cpu && !name_only && !alias->desc)
1500 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1502 aliases[j].name = name;
1503 if (is_cpu && !name_only && !alias->desc)
1504 aliases[j].name = format_alias_or(buf,
1505 sizeof(buf),
1506 pmu, alias);
1507 aliases[j].name = strdup(aliases[j].name);
1508 if (!aliases[j].name)
1509 goto out_enomem;
1511 aliases[j].desc = long_desc ? alias->long_desc :
1512 alias->desc;
1513 aliases[j].topic = alias->topic;
1514 aliases[j].str = alias->str;
1515 aliases[j].pmu = pmu->name;
1516 aliases[j].metric_expr = alias->metric_expr;
1517 aliases[j].metric_name = alias->metric_name;
1518 aliases[j].is_cpu = is_cpu;
1519 j++;
1521 if (pmu->selectable &&
1522 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1523 char *s;
1524 if (asprintf(&s, "%s//", pmu->name) < 0)
1525 goto out_enomem;
1526 aliases[j].name = s;
1527 j++;
1530 len = j;
1531 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1532 for (j = 0; j < len; j++) {
1533 /* Skip duplicates */
1534 if (j > 0 && !strcmp(aliases[j].name, aliases[j - 1].name))
1535 continue;
1536 if (name_only) {
1537 printf("%s ", aliases[j].name);
1538 continue;
1540 if (aliases[j].desc && !quiet_flag) {
1541 if (numdesc++ == 0)
1542 printf("\n");
1543 if (aliases[j].topic && (!topic ||
1544 strcmp(topic, aliases[j].topic))) {
1545 printf("%s%s:\n", topic ? "\n" : "",
1546 aliases[j].topic);
1547 topic = aliases[j].topic;
1549 printf(" %-50s\n", aliases[j].name);
1550 printf("%*s", 8, "[");
1551 wordwrap(aliases[j].desc, 8, columns, 0);
1552 printf("]\n");
1553 if (details_flag) {
1554 printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
1555 if (aliases[j].metric_name)
1556 printf(" MetricName: %s", aliases[j].metric_name);
1557 if (aliases[j].metric_expr)
1558 printf(" MetricExpr: %s", aliases[j].metric_expr);
1559 putchar('\n');
1561 } else
1562 printf(" %-50s [Kernel PMU event]\n", aliases[j].name);
1563 printed++;
1565 if (printed && pager_in_use())
1566 printf("\n");
1567 out_free:
1568 for (j = 0; j < len; j++)
1569 zfree(&aliases[j].name);
1570 zfree(&aliases);
1571 return;
1573 out_enomem:
1574 printf("FATAL: not enough memory to print PMU events\n");
1575 if (aliases)
1576 goto out_free;
1579 bool pmu_have_event(const char *pname, const char *name)
1581 struct perf_pmu *pmu;
1582 struct perf_pmu_alias *alias;
1584 pmu = NULL;
1585 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1586 if (strcmp(pname, pmu->name))
1587 continue;
1588 list_for_each_entry(alias, &pmu->aliases, list)
1589 if (!strcmp(alias->name, name))
1590 return true;
1592 return false;
1595 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1597 char path[PATH_MAX];
1598 const char *sysfs;
1600 sysfs = sysfs__mountpoint();
1601 if (!sysfs)
1602 return NULL;
1604 snprintf(path, PATH_MAX,
1605 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1606 if (!file_available(path))
1607 return NULL;
1608 return fopen(path, "r");
1611 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1612 ...)
1614 va_list args;
1615 FILE *file;
1616 int ret = EOF;
1618 va_start(args, fmt);
1619 file = perf_pmu__open_file(pmu, name);
1620 if (file) {
1621 ret = vfscanf(file, fmt, args);
1622 fclose(file);
1624 va_end(args);
1625 return ret;
1628 static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1630 struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1632 if (!caps)
1633 return -ENOMEM;
1635 caps->name = strdup(name);
1636 if (!caps->name)
1637 goto free_caps;
1638 caps->value = strndup(value, strlen(value) - 1);
1639 if (!caps->value)
1640 goto free_name;
1641 list_add_tail(&caps->list, list);
1642 return 0;
1644 free_name:
1645 zfree(caps->name);
1646 free_caps:
1647 free(caps);
1649 return -ENOMEM;
1653 * Reading/parsing the given pmu capabilities, which should be located at:
1654 * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1655 * Return the number of capabilities
1657 int perf_pmu__caps_parse(struct perf_pmu *pmu)
1659 struct stat st;
1660 char caps_path[PATH_MAX];
1661 const char *sysfs = sysfs__mountpoint();
1662 DIR *caps_dir;
1663 struct dirent *evt_ent;
1664 int nr_caps = 0;
1666 if (!sysfs)
1667 return -1;
1669 snprintf(caps_path, PATH_MAX,
1670 "%s" EVENT_SOURCE_DEVICE_PATH "%s/caps", sysfs, pmu->name);
1672 if (stat(caps_path, &st) < 0)
1673 return 0; /* no error if caps does not exist */
1675 caps_dir = opendir(caps_path);
1676 if (!caps_dir)
1677 return -EINVAL;
1679 while ((evt_ent = readdir(caps_dir)) != NULL) {
1680 char path[PATH_MAX + NAME_MAX + 1];
1681 char *name = evt_ent->d_name;
1682 char value[128];
1683 FILE *file;
1685 if (!strcmp(name, ".") || !strcmp(name, ".."))
1686 continue;
1688 snprintf(path, sizeof(path), "%s/%s", caps_path, name);
1690 file = fopen(path, "r");
1691 if (!file)
1692 continue;
1694 if (!fgets(value, sizeof(value), file) ||
1695 (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1696 fclose(file);
1697 continue;
1700 nr_caps++;
1701 fclose(file);
1704 closedir(caps_dir);
1706 return nr_caps;