Loading...
1#include <linux/list.h>
2#include <linux/compiler.h>
3#include <sys/types.h>
4#include <unistd.h>
5#include <stdio.h>
6#include <stdbool.h>
7#include <stdarg.h>
8#include <dirent.h>
9#include <api/fs/fs.h>
10#include <locale.h>
11#include "util.h"
12#include "pmu.h"
13#include "parse-events.h"
14#include "cpumap.h"
15
16struct perf_pmu_format {
17 char *name;
18 int value;
19 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
20 struct list_head list;
21};
22
23#define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"
24
25int perf_pmu_parse(struct list_head *list, char *name);
26extern FILE *perf_pmu_in;
27
28static LIST_HEAD(pmus);
29
30/*
31 * Parse & process all the sysfs attributes located under
32 * the directory specified in 'dir' parameter.
33 */
34int perf_pmu__format_parse(char *dir, struct list_head *head)
35{
36 struct dirent *evt_ent;
37 DIR *format_dir;
38 int ret = 0;
39
40 format_dir = opendir(dir);
41 if (!format_dir)
42 return -EINVAL;
43
44 while (!ret && (evt_ent = readdir(format_dir))) {
45 char path[PATH_MAX];
46 char *name = evt_ent->d_name;
47 FILE *file;
48
49 if (!strcmp(name, ".") || !strcmp(name, ".."))
50 continue;
51
52 snprintf(path, PATH_MAX, "%s/%s", dir, name);
53
54 ret = -EINVAL;
55 file = fopen(path, "r");
56 if (!file)
57 break;
58
59 perf_pmu_in = file;
60 ret = perf_pmu_parse(head, name);
61 fclose(file);
62 }
63
64 closedir(format_dir);
65 return ret;
66}
67
68/*
69 * Reading/parsing the default pmu format definition, which should be
70 * located at:
71 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
72 */
73static int pmu_format(const char *name, struct list_head *format)
74{
75 struct stat st;
76 char path[PATH_MAX];
77 const char *sysfs = sysfs__mountpoint();
78
79 if (!sysfs)
80 return -1;
81
82 snprintf(path, PATH_MAX,
83 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
84
85 if (stat(path, &st) < 0)
86 return 0; /* no error if format does not exist */
87
88 if (perf_pmu__format_parse(path, format))
89 return -1;
90
91 return 0;
92}
93
94static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
95{
96 struct stat st;
97 ssize_t sret;
98 char scale[128];
99 int fd, ret = -1;
100 char path[PATH_MAX];
101 char *lc;
102
103 snprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
104
105 fd = open(path, O_RDONLY);
106 if (fd == -1)
107 return -1;
108
109 if (fstat(fd, &st) < 0)
110 goto error;
111
112 sret = read(fd, scale, sizeof(scale)-1);
113 if (sret < 0)
114 goto error;
115
116 if (scale[sret - 1] == '\n')
117 scale[sret - 1] = '\0';
118 else
119 scale[sret] = '\0';
120
121 /*
122 * save current locale
123 */
124 lc = setlocale(LC_NUMERIC, NULL);
125
126 /*
127 * The lc string may be allocated in static storage,
128 * so get a dynamic copy to make it survive setlocale
129 * call below.
130 */
131 lc = strdup(lc);
132 if (!lc) {
133 ret = -ENOMEM;
134 goto error;
135 }
136
137 /*
138 * force to C locale to ensure kernel
139 * scale string is converted correctly.
140 * kernel uses default C locale.
141 */
142 setlocale(LC_NUMERIC, "C");
143
144 alias->scale = strtod(scale, NULL);
145
146 /* restore locale */
147 setlocale(LC_NUMERIC, lc);
148
149 free(lc);
150
151 ret = 0;
152error:
153 close(fd);
154 return ret;
155}
156
157static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
158{
159 char path[PATH_MAX];
160 ssize_t sret;
161 int fd;
162
163 snprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
164
165 fd = open(path, O_RDONLY);
166 if (fd == -1)
167 return -1;
168
169 sret = read(fd, alias->unit, UNIT_MAX_LEN);
170 if (sret < 0)
171 goto error;
172
173 close(fd);
174
175 if (alias->unit[sret - 1] == '\n')
176 alias->unit[sret - 1] = '\0';
177 else
178 alias->unit[sret] = '\0';
179
180 return 0;
181error:
182 close(fd);
183 alias->unit[0] = '\0';
184 return -1;
185}
186
187static int
188perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
189{
190 char path[PATH_MAX];
191 int fd;
192
193 snprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
194
195 fd = open(path, O_RDONLY);
196 if (fd == -1)
197 return -1;
198
199 close(fd);
200
201 alias->per_pkg = true;
202 return 0;
203}
204
205static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
206 char *dir, char *name)
207{
208 char path[PATH_MAX];
209 int fd;
210
211 snprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
212
213 fd = open(path, O_RDONLY);
214 if (fd == -1)
215 return -1;
216
217 alias->snapshot = true;
218 close(fd);
219 return 0;
220}
221
222static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
223 char *desc __maybe_unused, char *val)
224{
225 struct perf_pmu_alias *alias;
226 int ret;
227
228 alias = malloc(sizeof(*alias));
229 if (!alias)
230 return -ENOMEM;
231
232 INIT_LIST_HEAD(&alias->terms);
233 alias->scale = 1.0;
234 alias->unit[0] = '\0';
235 alias->per_pkg = false;
236 alias->snapshot = false;
237
238 ret = parse_events_terms(&alias->terms, val);
239 if (ret) {
240 pr_err("Cannot parse alias %s: %d\n", val, ret);
241 free(alias);
242 return ret;
243 }
244
245 alias->name = strdup(name);
246 if (dir) {
247 /*
248 * load unit name and scale if available
249 */
250 perf_pmu__parse_unit(alias, dir, name);
251 perf_pmu__parse_scale(alias, dir, name);
252 perf_pmu__parse_per_pkg(alias, dir, name);
253 perf_pmu__parse_snapshot(alias, dir, name);
254 }
255
256 list_add_tail(&alias->list, list);
257
258 return 0;
259}
260
261static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
262{
263 char buf[256];
264 int ret;
265
266 ret = fread(buf, 1, sizeof(buf), file);
267 if (ret == 0)
268 return -EINVAL;
269
270 buf[ret] = 0;
271
272 return __perf_pmu__new_alias(list, dir, name, NULL, buf);
273}
274
275static inline bool pmu_alias_info_file(char *name)
276{
277 size_t len;
278
279 len = strlen(name);
280 if (len > 5 && !strcmp(name + len - 5, ".unit"))
281 return true;
282 if (len > 6 && !strcmp(name + len - 6, ".scale"))
283 return true;
284 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
285 return true;
286 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
287 return true;
288
289 return false;
290}
291
292/*
293 * Process all the sysfs attributes located under the directory
294 * specified in 'dir' parameter.
295 */
296static int pmu_aliases_parse(char *dir, struct list_head *head)
297{
298 struct dirent *evt_ent;
299 DIR *event_dir;
300
301 event_dir = opendir(dir);
302 if (!event_dir)
303 return -EINVAL;
304
305 while ((evt_ent = readdir(event_dir))) {
306 char path[PATH_MAX];
307 char *name = evt_ent->d_name;
308 FILE *file;
309
310 if (!strcmp(name, ".") || !strcmp(name, ".."))
311 continue;
312
313 /*
314 * skip info files parsed in perf_pmu__new_alias()
315 */
316 if (pmu_alias_info_file(name))
317 continue;
318
319 snprintf(path, PATH_MAX, "%s/%s", dir, name);
320
321 file = fopen(path, "r");
322 if (!file) {
323 pr_debug("Cannot open %s\n", path);
324 continue;
325 }
326
327 if (perf_pmu__new_alias(head, dir, name, file) < 0)
328 pr_debug("Cannot set up %s\n", name);
329 fclose(file);
330 }
331
332 closedir(event_dir);
333 return 0;
334}
335
336/*
337 * Reading the pmu event aliases definition, which should be located at:
338 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
339 */
340static int pmu_aliases(const char *name, struct list_head *head)
341{
342 struct stat st;
343 char path[PATH_MAX];
344 const char *sysfs = sysfs__mountpoint();
345
346 if (!sysfs)
347 return -1;
348
349 snprintf(path, PATH_MAX,
350 "%s/bus/event_source/devices/%s/events", sysfs, name);
351
352 if (stat(path, &st) < 0)
353 return 0; /* no error if 'events' does not exist */
354
355 if (pmu_aliases_parse(path, head))
356 return -1;
357
358 return 0;
359}
360
361static int pmu_alias_terms(struct perf_pmu_alias *alias,
362 struct list_head *terms)
363{
364 struct parse_events_term *term, *cloned;
365 LIST_HEAD(list);
366 int ret;
367
368 list_for_each_entry(term, &alias->terms, list) {
369 ret = parse_events_term__clone(&cloned, term);
370 if (ret) {
371 parse_events_terms__purge(&list);
372 return ret;
373 }
374 list_add_tail(&cloned->list, &list);
375 }
376 list_splice(&list, terms);
377 return 0;
378}
379
380/*
381 * Reading/parsing the default pmu type value, which should be
382 * located at:
383 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
384 */
385static int pmu_type(const char *name, __u32 *type)
386{
387 struct stat st;
388 char path[PATH_MAX];
389 FILE *file;
390 int ret = 0;
391 const char *sysfs = sysfs__mountpoint();
392
393 if (!sysfs)
394 return -1;
395
396 snprintf(path, PATH_MAX,
397 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
398
399 if (stat(path, &st) < 0)
400 return -1;
401
402 file = fopen(path, "r");
403 if (!file)
404 return -EINVAL;
405
406 if (1 != fscanf(file, "%u", type))
407 ret = -1;
408
409 fclose(file);
410 return ret;
411}
412
413/* Add all pmus in sysfs to pmu list: */
414static void pmu_read_sysfs(void)
415{
416 char path[PATH_MAX];
417 DIR *dir;
418 struct dirent *dent;
419 const char *sysfs = sysfs__mountpoint();
420
421 if (!sysfs)
422 return;
423
424 snprintf(path, PATH_MAX,
425 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
426
427 dir = opendir(path);
428 if (!dir)
429 return;
430
431 while ((dent = readdir(dir))) {
432 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
433 continue;
434 /* add to static LIST_HEAD(pmus): */
435 perf_pmu__find(dent->d_name);
436 }
437
438 closedir(dir);
439}
440
441static struct cpu_map *pmu_cpumask(const char *name)
442{
443 struct stat st;
444 char path[PATH_MAX];
445 FILE *file;
446 struct cpu_map *cpus;
447 const char *sysfs = sysfs__mountpoint();
448
449 if (!sysfs)
450 return NULL;
451
452 snprintf(path, PATH_MAX,
453 "%s/bus/event_source/devices/%s/cpumask", sysfs, name);
454
455 if (stat(path, &st) < 0)
456 return NULL;
457
458 file = fopen(path, "r");
459 if (!file)
460 return NULL;
461
462 cpus = cpu_map__read(file);
463 fclose(file);
464 return cpus;
465}
466
467struct perf_event_attr * __weak
468perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
469{
470 return NULL;
471}
472
473static struct perf_pmu *pmu_lookup(const char *name)
474{
475 struct perf_pmu *pmu;
476 LIST_HEAD(format);
477 LIST_HEAD(aliases);
478 __u32 type;
479
480 /*
481 * The pmu data we store & need consists of the pmu
482 * type value and format definitions. Load both right
483 * now.
484 */
485 if (pmu_format(name, &format))
486 return NULL;
487
488 if (pmu_aliases(name, &aliases))
489 return NULL;
490
491 if (pmu_type(name, &type))
492 return NULL;
493
494 pmu = zalloc(sizeof(*pmu));
495 if (!pmu)
496 return NULL;
497
498 pmu->cpus = pmu_cpumask(name);
499
500 INIT_LIST_HEAD(&pmu->format);
501 INIT_LIST_HEAD(&pmu->aliases);
502 list_splice(&format, &pmu->format);
503 list_splice(&aliases, &pmu->aliases);
504 pmu->name = strdup(name);
505 pmu->type = type;
506 list_add_tail(&pmu->list, &pmus);
507
508 pmu->default_config = perf_pmu__get_default_config(pmu);
509
510 return pmu;
511}
512
513static struct perf_pmu *pmu_find(const char *name)
514{
515 struct perf_pmu *pmu;
516
517 list_for_each_entry(pmu, &pmus, list)
518 if (!strcmp(pmu->name, name))
519 return pmu;
520
521 return NULL;
522}
523
524struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
525{
526 /*
527 * pmu iterator: If pmu is NULL, we start at the begin,
528 * otherwise return the next pmu. Returns NULL on end.
529 */
530 if (!pmu) {
531 pmu_read_sysfs();
532 pmu = list_prepare_entry(pmu, &pmus, list);
533 }
534 list_for_each_entry_continue(pmu, &pmus, list)
535 return pmu;
536 return NULL;
537}
538
539struct perf_pmu *perf_pmu__find(const char *name)
540{
541 struct perf_pmu *pmu;
542
543 /*
544 * Once PMU is loaded it stays in the list,
545 * so we keep us from multiple reading/parsing
546 * the pmu format definitions.
547 */
548 pmu = pmu_find(name);
549 if (pmu)
550 return pmu;
551
552 return pmu_lookup(name);
553}
554
555static struct perf_pmu_format *
556pmu_find_format(struct list_head *formats, const char *name)
557{
558 struct perf_pmu_format *format;
559
560 list_for_each_entry(format, formats, list)
561 if (!strcmp(format->name, name))
562 return format;
563
564 return NULL;
565}
566
567__u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
568{
569 struct perf_pmu_format *format = pmu_find_format(formats, name);
570 __u64 bits = 0;
571 int fbit;
572
573 if (!format)
574 return 0;
575
576 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
577 bits |= 1ULL << fbit;
578
579 return bits;
580}
581
582/*
583 * Sets value based on the format definition (format parameter)
584 * and unformated value (value parameter).
585 */
586static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
587 bool zero)
588{
589 unsigned long fbit, vbit;
590
591 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
592
593 if (!test_bit(fbit, format))
594 continue;
595
596 if (value & (1llu << vbit++))
597 *v |= (1llu << fbit);
598 else if (zero)
599 *v &= ~(1llu << fbit);
600 }
601}
602
603static __u64 pmu_format_max_value(const unsigned long *format)
604{
605 int w;
606
607 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
608 if (!w)
609 return 0;
610 if (w < 64)
611 return (1ULL << w) - 1;
612 return -1;
613}
614
615/*
616 * Term is a string term, and might be a param-term. Try to look up it's value
617 * in the remaining terms.
618 * - We have a term like "base-or-format-term=param-term",
619 * - We need to find the value supplied for "param-term" (with param-term named
620 * in a config string) later on in the term list.
621 */
622static int pmu_resolve_param_term(struct parse_events_term *term,
623 struct list_head *head_terms,
624 __u64 *value)
625{
626 struct parse_events_term *t;
627
628 list_for_each_entry(t, head_terms, list) {
629 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
630 if (!strcmp(t->config, term->config)) {
631 t->used = true;
632 *value = t->val.num;
633 return 0;
634 }
635 }
636 }
637
638 if (verbose)
639 printf("Required parameter '%s' not specified\n", term->config);
640
641 return -1;
642}
643
644static char *pmu_formats_string(struct list_head *formats)
645{
646 struct perf_pmu_format *format;
647 char *str;
648 struct strbuf buf;
649 unsigned i = 0;
650
651 if (!formats)
652 return NULL;
653
654 strbuf_init(&buf, 0);
655 /* sysfs exported terms */
656 list_for_each_entry(format, formats, list)
657 strbuf_addf(&buf, i++ ? ",%s" : "%s",
658 format->name);
659
660 str = strbuf_detach(&buf, NULL);
661 strbuf_release(&buf);
662
663 return str;
664}
665
666/*
667 * Setup one of config[12] attr members based on the
668 * user input data - term parameter.
669 */
670static int pmu_config_term(struct list_head *formats,
671 struct perf_event_attr *attr,
672 struct parse_events_term *term,
673 struct list_head *head_terms,
674 bool zero, struct parse_events_error *err)
675{
676 struct perf_pmu_format *format;
677 __u64 *vp;
678 __u64 val, max_val;
679
680 /*
681 * If this is a parameter we've already used for parameterized-eval,
682 * skip it in normal eval.
683 */
684 if (term->used)
685 return 0;
686
687 /*
688 * Hardcoded terms should be already in, so nothing
689 * to be done for them.
690 */
691 if (parse_events__is_hardcoded_term(term))
692 return 0;
693
694 format = pmu_find_format(formats, term->config);
695 if (!format) {
696 if (verbose)
697 printf("Invalid event/parameter '%s'\n", term->config);
698 if (err) {
699 char *pmu_term = pmu_formats_string(formats);
700
701 err->idx = term->err_term;
702 err->str = strdup("unknown term");
703 err->help = parse_events_formats_error_string(pmu_term);
704 free(pmu_term);
705 }
706 return -EINVAL;
707 }
708
709 switch (format->value) {
710 case PERF_PMU_FORMAT_VALUE_CONFIG:
711 vp = &attr->config;
712 break;
713 case PERF_PMU_FORMAT_VALUE_CONFIG1:
714 vp = &attr->config1;
715 break;
716 case PERF_PMU_FORMAT_VALUE_CONFIG2:
717 vp = &attr->config2;
718 break;
719 default:
720 return -EINVAL;
721 }
722
723 /*
724 * Either directly use a numeric term, or try to translate string terms
725 * using event parameters.
726 */
727 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
728 val = term->val.num;
729 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
730 if (strcmp(term->val.str, "?")) {
731 if (verbose) {
732 pr_info("Invalid sysfs entry %s=%s\n",
733 term->config, term->val.str);
734 }
735 if (err) {
736 err->idx = term->err_val;
737 err->str = strdup("expected numeric value");
738 }
739 return -EINVAL;
740 }
741
742 if (pmu_resolve_param_term(term, head_terms, &val))
743 return -EINVAL;
744 } else
745 return -EINVAL;
746
747 max_val = pmu_format_max_value(format->bits);
748 if (val > max_val) {
749 if (err) {
750 err->idx = term->err_val;
751 if (asprintf(&err->str,
752 "value too big for format, maximum is %llu",
753 (unsigned long long)max_val) < 0)
754 err->str = strdup("value too big for format");
755 return -EINVAL;
756 }
757 /*
758 * Assume we don't care if !err, in which case the value will be
759 * silently truncated.
760 */
761 }
762
763 pmu_format_value(format->bits, val, vp, zero);
764 return 0;
765}
766
767int perf_pmu__config_terms(struct list_head *formats,
768 struct perf_event_attr *attr,
769 struct list_head *head_terms,
770 bool zero, struct parse_events_error *err)
771{
772 struct parse_events_term *term;
773
774 list_for_each_entry(term, head_terms, list) {
775 if (pmu_config_term(formats, attr, term, head_terms,
776 zero, err))
777 return -EINVAL;
778 }
779
780 return 0;
781}
782
783/*
784 * Configures event's 'attr' parameter based on the:
785 * 1) users input - specified in terms parameter
786 * 2) pmu format definitions - specified by pmu parameter
787 */
788int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
789 struct list_head *head_terms,
790 struct parse_events_error *err)
791{
792 bool zero = !!pmu->default_config;
793
794 attr->type = pmu->type;
795 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
796 zero, err);
797}
798
799static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
800 struct parse_events_term *term)
801{
802 struct perf_pmu_alias *alias;
803 char *name;
804
805 if (parse_events__is_hardcoded_term(term))
806 return NULL;
807
808 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
809 if (term->val.num != 1)
810 return NULL;
811 if (pmu_find_format(&pmu->format, term->config))
812 return NULL;
813 name = term->config;
814 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
815 if (strcasecmp(term->config, "event"))
816 return NULL;
817 name = term->val.str;
818 } else {
819 return NULL;
820 }
821
822 list_for_each_entry(alias, &pmu->aliases, list) {
823 if (!strcasecmp(alias->name, name))
824 return alias;
825 }
826 return NULL;
827}
828
829
830static int check_info_data(struct perf_pmu_alias *alias,
831 struct perf_pmu_info *info)
832{
833 /*
834 * Only one term in event definition can
835 * define unit, scale and snapshot, fail
836 * if there's more than one.
837 */
838 if ((info->unit && alias->unit) ||
839 (info->scale && alias->scale) ||
840 (info->snapshot && alias->snapshot))
841 return -EINVAL;
842
843 if (alias->unit)
844 info->unit = alias->unit;
845
846 if (alias->scale)
847 info->scale = alias->scale;
848
849 if (alias->snapshot)
850 info->snapshot = alias->snapshot;
851
852 return 0;
853}
854
855/*
856 * Find alias in the terms list and replace it with the terms
857 * defined for the alias
858 */
859int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
860 struct perf_pmu_info *info)
861{
862 struct parse_events_term *term, *h;
863 struct perf_pmu_alias *alias;
864 int ret;
865
866 info->per_pkg = false;
867
868 /*
869 * Mark unit and scale as not set
870 * (different from default values, see below)
871 */
872 info->unit = NULL;
873 info->scale = 0.0;
874 info->snapshot = false;
875
876 list_for_each_entry_safe(term, h, head_terms, list) {
877 alias = pmu_find_alias(pmu, term);
878 if (!alias)
879 continue;
880 ret = pmu_alias_terms(alias, &term->list);
881 if (ret)
882 return ret;
883
884 ret = check_info_data(alias, info);
885 if (ret)
886 return ret;
887
888 if (alias->per_pkg)
889 info->per_pkg = true;
890
891 list_del(&term->list);
892 free(term);
893 }
894
895 /*
896 * if no unit or scale foundin aliases, then
897 * set defaults as for evsel
898 * unit cannot left to NULL
899 */
900 if (info->unit == NULL)
901 info->unit = "";
902
903 if (info->scale == 0.0)
904 info->scale = 1.0;
905
906 return 0;
907}
908
909int perf_pmu__new_format(struct list_head *list, char *name,
910 int config, unsigned long *bits)
911{
912 struct perf_pmu_format *format;
913
914 format = zalloc(sizeof(*format));
915 if (!format)
916 return -ENOMEM;
917
918 format->name = strdup(name);
919 format->value = config;
920 memcpy(format->bits, bits, sizeof(format->bits));
921
922 list_add_tail(&format->list, list);
923 return 0;
924}
925
926void perf_pmu__set_format(unsigned long *bits, long from, long to)
927{
928 long b;
929
930 if (!to)
931 to = from;
932
933 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
934 for (b = from; b <= to; b++)
935 set_bit(b, bits);
936}
937
938static int sub_non_neg(int a, int b)
939{
940 if (b > a)
941 return 0;
942 return a - b;
943}
944
945static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
946 struct perf_pmu_alias *alias)
947{
948 struct parse_events_term *term;
949 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
950
951 list_for_each_entry(term, &alias->terms, list) {
952 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
953 used += snprintf(buf + used, sub_non_neg(len, used),
954 ",%s=%s", term->config,
955 term->val.str);
956 }
957
958 if (sub_non_neg(len, used) > 0) {
959 buf[used] = '/';
960 used++;
961 }
962 if (sub_non_neg(len, used) > 0) {
963 buf[used] = '\0';
964 used++;
965 } else
966 buf[len - 1] = '\0';
967
968 return buf;
969}
970
971static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
972 struct perf_pmu_alias *alias)
973{
974 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
975 return buf;
976}
977
978static int cmp_string(const void *a, const void *b)
979{
980 const char * const *as = a;
981 const char * const *bs = b;
982 return strcmp(*as, *bs);
983}
984
985void print_pmu_events(const char *event_glob, bool name_only)
986{
987 struct perf_pmu *pmu;
988 struct perf_pmu_alias *alias;
989 char buf[1024];
990 int printed = 0;
991 int len, j;
992 char **aliases;
993
994 pmu = NULL;
995 len = 0;
996 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
997 list_for_each_entry(alias, &pmu->aliases, list)
998 len++;
999 if (pmu->selectable)
1000 len++;
1001 }
1002 aliases = zalloc(sizeof(char *) * len);
1003 if (!aliases)
1004 goto out_enomem;
1005 pmu = NULL;
1006 j = 0;
1007 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1008 list_for_each_entry(alias, &pmu->aliases, list) {
1009 char *name = format_alias(buf, sizeof(buf), pmu, alias);
1010 bool is_cpu = !strcmp(pmu->name, "cpu");
1011
1012 if (event_glob != NULL &&
1013 !(strglobmatch(name, event_glob) ||
1014 (!is_cpu && strglobmatch(alias->name,
1015 event_glob))))
1016 continue;
1017
1018 if (is_cpu && !name_only)
1019 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1020
1021 aliases[j] = strdup(name);
1022 if (aliases[j] == NULL)
1023 goto out_enomem;
1024 j++;
1025 }
1026 if (pmu->selectable &&
1027 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1028 char *s;
1029 if (asprintf(&s, "%s//", pmu->name) < 0)
1030 goto out_enomem;
1031 aliases[j] = s;
1032 j++;
1033 }
1034 }
1035 len = j;
1036 qsort(aliases, len, sizeof(char *), cmp_string);
1037 for (j = 0; j < len; j++) {
1038 if (name_only) {
1039 printf("%s ", aliases[j]);
1040 continue;
1041 }
1042 printf(" %-50s [Kernel PMU event]\n", aliases[j]);
1043 printed++;
1044 }
1045 if (printed && pager_in_use())
1046 printf("\n");
1047out_free:
1048 for (j = 0; j < len; j++)
1049 zfree(&aliases[j]);
1050 zfree(&aliases);
1051 return;
1052
1053out_enomem:
1054 printf("FATAL: not enough memory to print PMU events\n");
1055 if (aliases)
1056 goto out_free;
1057}
1058
1059bool pmu_have_event(const char *pname, const char *name)
1060{
1061 struct perf_pmu *pmu;
1062 struct perf_pmu_alias *alias;
1063
1064 pmu = NULL;
1065 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1066 if (strcmp(pname, pmu->name))
1067 continue;
1068 list_for_each_entry(alias, &pmu->aliases, list)
1069 if (!strcmp(alias->name, name))
1070 return true;
1071 }
1072 return false;
1073}
1074
1075static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1076{
1077 struct stat st;
1078 char path[PATH_MAX];
1079 const char *sysfs;
1080
1081 sysfs = sysfs__mountpoint();
1082 if (!sysfs)
1083 return NULL;
1084
1085 snprintf(path, PATH_MAX,
1086 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1087
1088 if (stat(path, &st) < 0)
1089 return NULL;
1090
1091 return fopen(path, "r");
1092}
1093
1094int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1095 ...)
1096{
1097 va_list args;
1098 FILE *file;
1099 int ret = EOF;
1100
1101 va_start(args, fmt);
1102 file = perf_pmu__open_file(pmu, name);
1103 if (file) {
1104 ret = vfscanf(file, fmt, args);
1105 fclose(file);
1106 }
1107 va_end(args);
1108 return ret;
1109}
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"
28
29struct perf_pmu perf_pmu__fake;
30
31struct perf_pmu_format {
32 char *name;
33 int value;
34 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
35 struct list_head list;
36};
37
38int perf_pmu_parse(struct list_head *list, char *name);
39extern FILE *perf_pmu_in;
40
41static LIST_HEAD(pmus);
42
43/*
44 * Parse & process all the sysfs attributes located under
45 * the directory specified in 'dir' parameter.
46 */
47int perf_pmu__format_parse(char *dir, struct list_head *head)
48{
49 struct dirent *evt_ent;
50 DIR *format_dir;
51 int ret = 0;
52
53 format_dir = opendir(dir);
54 if (!format_dir)
55 return -EINVAL;
56
57 while (!ret && (evt_ent = readdir(format_dir))) {
58 char path[PATH_MAX];
59 char *name = evt_ent->d_name;
60 FILE *file;
61
62 if (!strcmp(name, ".") || !strcmp(name, ".."))
63 continue;
64
65 snprintf(path, PATH_MAX, "%s/%s", dir, name);
66
67 ret = -EINVAL;
68 file = fopen(path, "r");
69 if (!file)
70 break;
71
72 perf_pmu_in = file;
73 ret = perf_pmu_parse(head, name);
74 fclose(file);
75 }
76
77 closedir(format_dir);
78 return ret;
79}
80
81/*
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.
85 */
86static int pmu_format(const char *name, struct list_head *format)
87{
88 char path[PATH_MAX];
89 const char *sysfs = sysfs__mountpoint();
90
91 if (!sysfs)
92 return -1;
93
94 snprintf(path, PATH_MAX,
95 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
96
97 if (!file_available(path))
98 return 0;
99
100 if (perf_pmu__format_parse(path, format))
101 return -1;
102
103 return 0;
104}
105
106int perf_pmu__convert_scale(const char *scale, char **end, double *sval)
107{
108 char *lc;
109 int ret = 0;
110
111 /*
112 * save current locale
113 */
114 lc = setlocale(LC_NUMERIC, NULL);
115
116 /*
117 * The lc string may be allocated in static storage,
118 * so get a dynamic copy to make it survive setlocale
119 * call below.
120 */
121 lc = strdup(lc);
122 if (!lc) {
123 ret = -ENOMEM;
124 goto out;
125 }
126
127 /*
128 * force to C locale to ensure kernel
129 * scale string is converted correctly.
130 * kernel uses default C locale.
131 */
132 setlocale(LC_NUMERIC, "C");
133
134 *sval = strtod(scale, end);
135
136out:
137 /* restore locale */
138 setlocale(LC_NUMERIC, lc);
139 free(lc);
140 return ret;
141}
142
143static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
144{
145 struct stat st;
146 ssize_t sret;
147 char scale[128];
148 int fd, ret = -1;
149 char path[PATH_MAX];
150
151 scnprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
152
153 fd = open(path, O_RDONLY);
154 if (fd == -1)
155 return -1;
156
157 if (fstat(fd, &st) < 0)
158 goto error;
159
160 sret = read(fd, scale, sizeof(scale)-1);
161 if (sret < 0)
162 goto error;
163
164 if (scale[sret - 1] == '\n')
165 scale[sret - 1] = '\0';
166 else
167 scale[sret] = '\0';
168
169 ret = perf_pmu__convert_scale(scale, NULL, &alias->scale);
170error:
171 close(fd);
172 return ret;
173}
174
175static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
176{
177 char path[PATH_MAX];
178 ssize_t sret;
179 int fd;
180
181 scnprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
182
183 fd = open(path, O_RDONLY);
184 if (fd == -1)
185 return -1;
186
187 sret = read(fd, alias->unit, UNIT_MAX_LEN);
188 if (sret < 0)
189 goto error;
190
191 close(fd);
192
193 if (alias->unit[sret - 1] == '\n')
194 alias->unit[sret - 1] = '\0';
195 else
196 alias->unit[sret] = '\0';
197
198 return 0;
199error:
200 close(fd);
201 alias->unit[0] = '\0';
202 return -1;
203}
204
205static int
206perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
207{
208 char path[PATH_MAX];
209 int fd;
210
211 scnprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
212
213 fd = open(path, O_RDONLY);
214 if (fd == -1)
215 return -1;
216
217 close(fd);
218
219 alias->per_pkg = true;
220 return 0;
221}
222
223static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
224 char *dir, char *name)
225{
226 char path[PATH_MAX];
227 int fd;
228
229 scnprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
230
231 fd = open(path, O_RDONLY);
232 if (fd == -1)
233 return -1;
234
235 alias->snapshot = true;
236 close(fd);
237 return 0;
238}
239
240static void perf_pmu_assign_str(char *name, const char *field, char **old_str,
241 char **new_str)
242{
243 if (!*old_str)
244 goto set_new;
245
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;
253set_new:
254 *old_str = *new_str;
255 *new_str = NULL;
256}
257
258static void perf_pmu_update_alias(struct perf_pmu_alias *old,
259 struct perf_pmu_alias *newalias)
260{
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));
274}
275
276/* Delete an alias entry. */
277void perf_pmu_free_alias(struct perf_pmu_alias *newalias)
278{
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);
288}
289
290/* Merge an alias, search in alias list. If this name is already
291 * present merge both of them to combine all information.
292 */
293static bool perf_pmu_merge_alias(struct perf_pmu_alias *newalias,
294 struct list_head *alist)
295{
296 struct perf_pmu_alias *a;
297
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;
303 }
304 }
305 return false;
306}
307
308static 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)
315{
316 struct parse_events_term *term;
317 struct perf_pmu_alias *alias;
318 int ret;
319 int num;
320 char newval[256];
321
322 alias = malloc(sizeof(*alias));
323 if (!alias)
324 return -ENOMEM;
325
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;
332
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;
338 }
339
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).
344 *
345 * Rebuild string to make alias->str member comparable.
346 */
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);
359 }
360
361 alias->name = strdup(name);
362 if (dir) {
363 /*
364 * load unit name and scale if available
365 */
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);
370 }
371
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);
382 }
383 alias->per_pkg = perpkg && sscanf(perpkg, "%d", &num) == 1 && num == 1;
384 alias->str = strdup(newval);
385
386 if (deprecated)
387 alias->deprecated = true;
388
389 if (!perf_pmu_merge_alias(alias, list))
390 list_add_tail(&alias->list, list);
391
392 return 0;
393}
394
395static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
396{
397 char buf[256];
398 int ret;
399
400 ret = fread(buf, 1, sizeof(buf), file);
401 if (ret == 0)
402 return -EINVAL;
403
404 buf[ret] = 0;
405
406 /* Remove trailing newline from sysfs file */
407 strim(buf);
408
409 return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL, NULL, NULL,
410 NULL, NULL, NULL, NULL);
411}
412
413static inline bool pmu_alias_info_file(char *name)
414{
415 size_t len;
416
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;
426
427 return false;
428}
429
430/*
431 * Process all the sysfs attributes located under the directory
432 * specified in 'dir' parameter.
433 */
434static int pmu_aliases_parse(char *dir, struct list_head *head)
435{
436 struct dirent *evt_ent;
437 DIR *event_dir;
438
439 event_dir = opendir(dir);
440 if (!event_dir)
441 return -EINVAL;
442
443 while ((evt_ent = readdir(event_dir))) {
444 char path[PATH_MAX];
445 char *name = evt_ent->d_name;
446 FILE *file;
447
448 if (!strcmp(name, ".") || !strcmp(name, ".."))
449 continue;
450
451 /*
452 * skip info files parsed in perf_pmu__new_alias()
453 */
454 if (pmu_alias_info_file(name))
455 continue;
456
457 scnprintf(path, PATH_MAX, "%s/%s", dir, name);
458
459 file = fopen(path, "r");
460 if (!file) {
461 pr_debug("Cannot open %s\n", path);
462 continue;
463 }
464
465 if (perf_pmu__new_alias(head, dir, name, file) < 0)
466 pr_debug("Cannot set up %s\n", name);
467 fclose(file);
468 }
469
470 closedir(event_dir);
471 return 0;
472}
473
474/*
475 * Reading the pmu event aliases definition, which should be located at:
476 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
477 */
478static int pmu_aliases(const char *name, struct list_head *head)
479{
480 char path[PATH_MAX];
481 const char *sysfs = sysfs__mountpoint();
482
483 if (!sysfs)
484 return -1;
485
486 snprintf(path, PATH_MAX,
487 "%s/bus/event_source/devices/%s/events", sysfs, name);
488
489 if (!file_available(path))
490 return 0;
491
492 if (pmu_aliases_parse(path, head))
493 return -1;
494
495 return 0;
496}
497
498static int pmu_alias_terms(struct perf_pmu_alias *alias,
499 struct list_head *terms)
500{
501 struct parse_events_term *term, *cloned;
502 LIST_HEAD(list);
503 int ret;
504
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;
510 }
511 /*
512 * Weak terms don't override command line options,
513 * which we don't want for implicit terms in aliases.
514 */
515 cloned->weak = true;
516 list_add_tail(&cloned->list, &list);
517 }
518 list_splice(&list, terms);
519 return 0;
520}
521
522/*
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.
526 */
527static int pmu_type(const char *name, __u32 *type)
528{
529 char path[PATH_MAX];
530 FILE *file;
531 int ret = 0;
532 const char *sysfs = sysfs__mountpoint();
533
534 if (!sysfs)
535 return -1;
536
537 snprintf(path, PATH_MAX,
538 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
539
540 if (access(path, R_OK) < 0)
541 return -1;
542
543 file = fopen(path, "r");
544 if (!file)
545 return -EINVAL;
546
547 if (1 != fscanf(file, "%u", type))
548 ret = -1;
549
550 fclose(file);
551 return ret;
552}
553
554/* Add all pmus in sysfs to pmu list: */
555static void pmu_read_sysfs(void)
556{
557 char path[PATH_MAX];
558 DIR *dir;
559 struct dirent *dent;
560 const char *sysfs = sysfs__mountpoint();
561
562 if (!sysfs)
563 return;
564
565 snprintf(path, PATH_MAX,
566 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
567
568 dir = opendir(path);
569 if (!dir)
570 return;
571
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);
577 }
578
579 closedir(dir);
580}
581
582static struct perf_cpu_map *__pmu_cpumask(const char *path)
583{
584 FILE *file;
585 struct perf_cpu_map *cpus;
586
587 file = fopen(path, "r");
588 if (!file)
589 return NULL;
590
591 cpus = perf_cpu_map__read(file);
592 fclose(file);
593 return cpus;
594}
595
596/*
597 * Uncore PMUs have a "cpumask" file under sysfs. CPU PMUs (e.g. on arm/arm64)
598 * may have a "cpus" file.
599 */
600#define CPUS_TEMPLATE_UNCORE "%s/bus/event_source/devices/%s/cpumask"
601#define CPUS_TEMPLATE_CPU "%s/bus/event_source/devices/%s/cpus"
602
603static struct perf_cpu_map *pmu_cpumask(const char *name)
604{
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
612 };
613 const char **template;
614
615 if (!sysfs)
616 return NULL;
617
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;
623 }
624
625 return NULL;
626}
627
628static bool pmu_is_uncore(const char *name)
629{
630 char path[PATH_MAX];
631 const char *sysfs;
632
633 sysfs = sysfs__mountpoint();
634 snprintf(path, PATH_MAX, CPUS_TEMPLATE_UNCORE, sysfs, name);
635 return file_available(path);
636}
637
638/*
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.
642 */
643static int is_arm_pmu_core(const char *name)
644{
645 char path[PATH_MAX];
646 const char *sysfs = sysfs__mountpoint();
647
648 if (!sysfs)
649 return 0;
650
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);
655}
656
657static char *perf_pmu__getcpuid(struct perf_pmu *pmu)
658{
659 char *cpuid;
660 static bool printed;
661
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;
669
670 if (!printed) {
671 pr_debug("Using CPUID %s\n", cpuid);
672 printed = true;
673 }
674 return cpuid;
675}
676
677struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu)
678{
679 struct pmu_events_map *map;
680 char *cpuid = perf_pmu__getcpuid(pmu);
681 int i;
682
683 /* on some platforms which uses cpus map, cpuid can be NULL for
684 * PMUs other than CORE PMUs.
685 */
686 if (!cpuid)
687 return NULL;
688
689 i = 0;
690 for (;;) {
691 map = &pmu_events_map[i++];
692 if (!map->table) {
693 map = NULL;
694 break;
695 }
696
697 if (!strcmp_cpuid_str(map->cpuid, cpuid))
698 break;
699 }
700 free(cpuid);
701 return map;
702}
703
704bool pmu_uncore_alias_match(const char *pmu_name, const char *name)
705{
706 char *tmp = NULL, *tok, *str;
707 bool res;
708
709 str = strdup(pmu_name);
710 if (!str)
711 return false;
712
713 /*
714 * uncore alias may be from different PMU with common prefix
715 */
716 tok = strtok_r(str, ",", &tmp);
717 if (strncmp(pmu_name, tok, strlen(tok))) {
718 res = false;
719 goto out;
720 }
721
722 /*
723 * Match more complex aliases where the alias name is a comma-delimited
724 * list of tokens, orderly contained in the matching PMU name.
725 *
726 * Example: For alias "socket,pmuname" and PMU "socketX_pmunameY", we
727 * match "socket" in "socketX_pmunameY" and then "pmuname" in
728 * "pmunameY".
729 */
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;
735 }
736 }
737
738 res = true;
739out:
740 free(str);
741 return res;
742}
743
744/*
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.
748 */
749void pmu_add_cpu_aliases_map(struct list_head *head, struct perf_pmu *pmu,
750 struct pmu_events_map *map)
751{
752 int i;
753 const char *name = pmu->name;
754 /*
755 * Found a matching PMU events table. Create aliases
756 */
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;
762
763 if (!pe->name) {
764 if (pe->metric_group || pe->metric_name)
765 continue;
766 break;
767 }
768
769 if (pmu_is_uncore(name) &&
770 pmu_uncore_alias_match(pname, name))
771 goto new_alias;
772
773 if (strcmp(pname, name))
774 continue;
775
776new_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);
785 }
786}
787
788static void pmu_add_cpu_aliases(struct list_head *head, struct perf_pmu *pmu)
789{
790 struct pmu_events_map *map;
791
792 map = perf_pmu__find_map(pmu);
793 if (!map)
794 return;
795
796 pmu_add_cpu_aliases_map(head, pmu, map);
797}
798
799struct perf_event_attr * __weak
800perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
801{
802 return NULL;
803}
804
805static int pmu_max_precise(const char *name)
806{
807 char path[PATH_MAX];
808 int max_precise = -1;
809
810 scnprintf(path, PATH_MAX,
811 "bus/event_source/devices/%s/caps/max_precise",
812 name);
813
814 sysfs__read_int(path, &max_precise);
815 return max_precise;
816}
817
818static struct perf_pmu *pmu_lookup(const char *name)
819{
820 struct perf_pmu *pmu;
821 LIST_HEAD(format);
822 LIST_HEAD(aliases);
823 __u32 type;
824
825 /*
826 * The pmu data we store & need consists of the pmu
827 * type value and format definitions. Load both right
828 * now.
829 */
830 if (pmu_format(name, &format))
831 return NULL;
832
833 /*
834 * Check the type first to avoid unnecessary work.
835 */
836 if (pmu_type(name, &type))
837 return NULL;
838
839 if (pmu_aliases(name, &aliases))
840 return NULL;
841
842 pmu = zalloc(sizeof(*pmu));
843 if (!pmu)
844 return NULL;
845
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);
852
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);
859
860 pmu->default_config = perf_pmu__get_default_config(pmu);
861
862 return pmu;
863}
864
865static struct perf_pmu *pmu_find(const char *name)
866{
867 struct perf_pmu *pmu;
868
869 list_for_each_entry(pmu, &pmus, list)
870 if (!strcmp(pmu->name, name))
871 return pmu;
872
873 return NULL;
874}
875
876struct perf_pmu *perf_pmu__find_by_type(unsigned int type)
877{
878 struct perf_pmu *pmu;
879
880 list_for_each_entry(pmu, &pmus, list)
881 if (pmu->type == type)
882 return pmu;
883
884 return NULL;
885}
886
887struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
888{
889 /*
890 * pmu iterator: If pmu is NULL, we start at the begin,
891 * otherwise return the next pmu. Returns NULL on end.
892 */
893 if (!pmu) {
894 pmu_read_sysfs();
895 pmu = list_prepare_entry(pmu, &pmus, list);
896 }
897 list_for_each_entry_continue(pmu, &pmus, list)
898 return pmu;
899 return NULL;
900}
901
902struct perf_pmu *evsel__find_pmu(struct evsel *evsel)
903{
904 struct perf_pmu *pmu = NULL;
905
906 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
907 if (pmu->type == evsel->core.attr.type)
908 break;
909 }
910
911 return pmu;
912}
913
914bool evsel__is_aux_event(struct evsel *evsel)
915{
916 struct perf_pmu *pmu = evsel__find_pmu(evsel);
917
918 return pmu && pmu->auxtrace;
919}
920
921struct perf_pmu *perf_pmu__find(const char *name)
922{
923 struct perf_pmu *pmu;
924
925 /*
926 * Once PMU is loaded it stays in the list,
927 * so we keep us from multiple reading/parsing
928 * the pmu format definitions.
929 */
930 pmu = pmu_find(name);
931 if (pmu)
932 return pmu;
933
934 return pmu_lookup(name);
935}
936
937static struct perf_pmu_format *
938pmu_find_format(struct list_head *formats, const char *name)
939{
940 struct perf_pmu_format *format;
941
942 list_for_each_entry(format, formats, list)
943 if (!strcmp(format->name, name))
944 return format;
945
946 return NULL;
947}
948
949__u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
950{
951 struct perf_pmu_format *format = pmu_find_format(formats, name);
952 __u64 bits = 0;
953 int fbit;
954
955 if (!format)
956 return 0;
957
958 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
959 bits |= 1ULL << fbit;
960
961 return bits;
962}
963
964int perf_pmu__format_type(struct list_head *formats, const char *name)
965{
966 struct perf_pmu_format *format = pmu_find_format(formats, name);
967
968 if (!format)
969 return -1;
970
971 return format->value;
972}
973
974/*
975 * Sets value based on the format definition (format parameter)
976 * and unformated value (value parameter).
977 */
978static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
979 bool zero)
980{
981 unsigned long fbit, vbit;
982
983 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
984
985 if (!test_bit(fbit, format))
986 continue;
987
988 if (value & (1llu << vbit++))
989 *v |= (1llu << fbit);
990 else if (zero)
991 *v &= ~(1llu << fbit);
992 }
993}
994
995static __u64 pmu_format_max_value(const unsigned long *format)
996{
997 int w;
998
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;
1005}
1006
1007/*
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.
1013 */
1014static int pmu_resolve_param_term(struct parse_events_term *term,
1015 struct list_head *head_terms,
1016 __u64 *value)
1017{
1018 struct parse_events_term *t;
1019
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;
1026 }
1027 }
1028
1029 if (verbose > 0)
1030 printf("Required parameter '%s' not specified\n", term->config);
1031
1032 return -1;
1033}
1034
1035static char *pmu_formats_string(struct list_head *formats)
1036{
1037 struct perf_pmu_format *format;
1038 char *str = NULL;
1039 struct strbuf buf = STRBUF_INIT;
1040 unsigned i = 0;
1041
1042 if (!formats)
1043 return NULL;
1044
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;
1049
1050 str = strbuf_detach(&buf, NULL);
1051error:
1052 strbuf_release(&buf);
1053
1054 return str;
1055}
1056
1057/*
1058 * Setup one of config[12] attr members based on the
1059 * user input data - term parameter.
1060 */
1061static 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)
1067{
1068 struct perf_pmu_format *format;
1069 __u64 *vp;
1070 __u64 val, max_val;
1071
1072 /*
1073 * If this is a parameter we've already used for parameterized-eval,
1074 * skip it in normal eval.
1075 */
1076 if (term->used)
1077 return 0;
1078
1079 /*
1080 * Hardcoded terms should be already in, so nothing
1081 * to be done for them.
1082 */
1083 if (parse_events__is_hardcoded_term(term))
1084 return 0;
1085
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;
1091
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);
1104 }
1105 free(pmu_term);
1106 return -EINVAL;
1107 }
1108
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;
1121 }
1122
1123 /*
1124 * Either directly use a numeric term, or try to translate string terms
1125 * using event parameters.
1126 */
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);
1134 }
1135 return -EINVAL;
1136 }
1137
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);
1144 }
1145 if (err) {
1146 parse_events__handle_error(err, term->err_val,
1147 strdup("expected numeric value"),
1148 NULL);
1149 }
1150 return -EINVAL;
1151 }
1152
1153 if (pmu_resolve_param_term(term, head_terms, &val))
1154 return -EINVAL;
1155 } else
1156 return -EINVAL;
1157
1158 max_val = pmu_format_max_value(format->bits);
1159 if (val > max_val) {
1160 if (err) {
1161 char *err_str;
1162
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;
1171 }
1172 /*
1173 * Assume we don't care if !err, in which case the value will be
1174 * silently truncated.
1175 */
1176 }
1177
1178 pmu_format_value(format->bits, val, vp, zero);
1179 return 0;
1180}
1181
1182int 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)
1186{
1187 struct parse_events_term *term;
1188
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;
1193 }
1194
1195 return 0;
1196}
1197
1198/*
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
1202 */
1203int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1204 struct list_head *head_terms,
1205 struct parse_events_error *err)
1206{
1207 bool zero = !!pmu->default_config;
1208
1209 attr->type = pmu->type;
1210 return perf_pmu__config_terms(pmu->name, &pmu->format, attr,
1211 head_terms, zero, err);
1212}
1213
1214static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1215 struct parse_events_term *term)
1216{
1217 struct perf_pmu_alias *alias;
1218 char *name;
1219
1220 if (parse_events__is_hardcoded_term(term))
1221 return NULL;
1222
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;
1235 }
1236
1237 list_for_each_entry(alias, &pmu->aliases, list) {
1238 if (!strcasecmp(alias->name, name))
1239 return alias;
1240 }
1241 return NULL;
1242}
1243
1244
1245static int check_info_data(struct perf_pmu_alias *alias,
1246 struct perf_pmu_info *info)
1247{
1248 /*
1249 * Only one term in event definition can
1250 * define unit, scale and snapshot, fail
1251 * if there's more than one.
1252 */
1253 if ((info->unit && alias->unit[0]) ||
1254 (info->scale && alias->scale) ||
1255 (info->snapshot && alias->snapshot))
1256 return -EINVAL;
1257
1258 if (alias->unit[0])
1259 info->unit = alias->unit;
1260
1261 if (alias->scale)
1262 info->scale = alias->scale;
1263
1264 if (alias->snapshot)
1265 info->snapshot = alias->snapshot;
1266
1267 return 0;
1268}
1269
1270/*
1271 * Find alias in the terms list and replace it with the terms
1272 * defined for the alias
1273 */
1274int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1275 struct perf_pmu_info *info)
1276{
1277 struct parse_events_term *term, *h;
1278 struct perf_pmu_alias *alias;
1279 int ret;
1280
1281 info->per_pkg = false;
1282
1283 /*
1284 * Mark unit and scale as not set
1285 * (different from default values, see below)
1286 */
1287 info->unit = NULL;
1288 info->scale = 0.0;
1289 info->snapshot = false;
1290 info->metric_expr = NULL;
1291 info->metric_name = NULL;
1292
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;
1300
1301 ret = check_info_data(alias, info);
1302 if (ret)
1303 return ret;
1304
1305 if (alias->per_pkg)
1306 info->per_pkg = true;
1307 info->metric_expr = alias->metric_expr;
1308 info->metric_name = alias->metric_name;
1309
1310 list_del_init(&term->list);
1311 parse_events_term__delete(term);
1312 }
1313
1314 /*
1315 * if no unit or scale foundin aliases, then
1316 * set defaults as for evsel
1317 * unit cannot left to NULL
1318 */
1319 if (info->unit == NULL)
1320 info->unit = "";
1321
1322 if (info->scale == 0.0)
1323 info->scale = 1.0;
1324
1325 return 0;
1326}
1327
1328int perf_pmu__new_format(struct list_head *list, char *name,
1329 int config, unsigned long *bits)
1330{
1331 struct perf_pmu_format *format;
1332
1333 format = zalloc(sizeof(*format));
1334 if (!format)
1335 return -ENOMEM;
1336
1337 format->name = strdup(name);
1338 format->value = config;
1339 memcpy(format->bits, bits, sizeof(format->bits));
1340
1341 list_add_tail(&format->list, list);
1342 return 0;
1343}
1344
1345void perf_pmu__set_format(unsigned long *bits, long from, long to)
1346{
1347 long b;
1348
1349 if (!to)
1350 to = from;
1351
1352 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1353 for (b = from; b <= to; b++)
1354 set_bit(b, bits);
1355}
1356
1357void perf_pmu__del_formats(struct list_head *formats)
1358{
1359 struct perf_pmu_format *fmt, *tmp;
1360
1361 list_for_each_entry_safe(fmt, tmp, formats, list) {
1362 list_del(&fmt->list);
1363 free(fmt->name);
1364 free(fmt);
1365 }
1366}
1367
1368static int sub_non_neg(int a, int b)
1369{
1370 if (b > a)
1371 return 0;
1372 return a - b;
1373}
1374
1375static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1376 struct perf_pmu_alias *alias)
1377{
1378 struct parse_events_term *term;
1379 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1380
1381 list_for_each_entry(term, &alias->terms, list) {
1382 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1383 used += snprintf(buf + used, sub_non_neg(len, used),
1384 ",%s=%s", term->config,
1385 term->val.str);
1386 }
1387
1388 if (sub_non_neg(len, used) > 0) {
1389 buf[used] = '/';
1390 used++;
1391 }
1392 if (sub_non_neg(len, used) > 0) {
1393 buf[used] = '\0';
1394 used++;
1395 } else
1396 buf[len - 1] = '\0';
1397
1398 return buf;
1399}
1400
1401static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1402 struct perf_pmu_alias *alias)
1403{
1404 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1405 return buf;
1406}
1407
1408struct sevent {
1409 char *name;
1410 char *desc;
1411 char *topic;
1412 char *str;
1413 char *pmu;
1414 char *metric_expr;
1415 char *metric_name;
1416 int is_cpu;
1417};
1418
1419static int cmp_sevent(const void *a, const void *b)
1420{
1421 const struct sevent *as = a;
1422 const struct sevent *bs = b;
1423
1424 /* Put extra events last */
1425 if (!!as->desc != !!bs->desc)
1426 return !!as->desc - !!bs->desc;
1427 if (as->topic && bs->topic) {
1428 int n = strcmp(as->topic, bs->topic);
1429
1430 if (n)
1431 return n;
1432 }
1433
1434 /* Order CPU core events to be first */
1435 if (as->is_cpu != bs->is_cpu)
1436 return bs->is_cpu - as->is_cpu;
1437
1438 return strcmp(as->name, bs->name);
1439}
1440
1441static void wordwrap(char *s, int start, int max, int corr)
1442{
1443 int column = start;
1444 int n;
1445
1446 while (*s) {
1447 int wlen = strcspn(s, " \t");
1448
1449 if (column + wlen >= max && column > start) {
1450 printf("\n%*s", start, "");
1451 column = start + corr;
1452 }
1453 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1454 if (n <= 0)
1455 break;
1456 s += wlen;
1457 column += n;
1458 s = skip_spaces(s);
1459 }
1460}
1461
1462bool is_pmu_core(const char *name)
1463{
1464 return !strcmp(name, "cpu") || is_arm_pmu_core(name);
1465}
1466
1467void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1468 bool long_desc, bool details_flag, bool deprecated)
1469{
1470 struct perf_pmu *pmu;
1471 struct perf_pmu_alias *alias;
1472 char buf[1024];
1473 int printed = 0;
1474 int len, j;
1475 struct sevent *aliases;
1476 int numdesc = 0;
1477 int columns = pager_get_columns();
1478 char *topic = NULL;
1479
1480 pmu = NULL;
1481 len = 0;
1482 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1483 list_for_each_entry(alias, &pmu->aliases, list)
1484 len++;
1485 if (pmu->selectable)
1486 len++;
1487 }
1488 aliases = zalloc(sizeof(struct sevent) * len);
1489 if (!aliases)
1490 goto out_enomem;
1491 pmu = NULL;
1492 j = 0;
1493 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1494 list_for_each_entry(alias, &pmu->aliases, list) {
1495 char *name = alias->desc ? alias->name :
1496 format_alias(buf, sizeof(buf), pmu, alias);
1497 bool is_cpu = is_pmu_core(pmu->name);
1498
1499 if (alias->deprecated && !deprecated)
1500 continue;
1501
1502 if (event_glob != NULL &&
1503 !(strglobmatch_nocase(name, event_glob) ||
1504 (!is_cpu && strglobmatch_nocase(alias->name,
1505 event_glob)) ||
1506 (alias->topic &&
1507 strglobmatch_nocase(alias->topic, event_glob))))
1508 continue;
1509
1510 if (is_cpu && !name_only && !alias->desc)
1511 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1512
1513 aliases[j].name = name;
1514 if (is_cpu && !name_only && !alias->desc)
1515 aliases[j].name = format_alias_or(buf,
1516 sizeof(buf),
1517 pmu, alias);
1518 aliases[j].name = strdup(aliases[j].name);
1519 if (!aliases[j].name)
1520 goto out_enomem;
1521
1522 aliases[j].desc = long_desc ? alias->long_desc :
1523 alias->desc;
1524 aliases[j].topic = alias->topic;
1525 aliases[j].str = alias->str;
1526 aliases[j].pmu = pmu->name;
1527 aliases[j].metric_expr = alias->metric_expr;
1528 aliases[j].metric_name = alias->metric_name;
1529 aliases[j].is_cpu = is_cpu;
1530 j++;
1531 }
1532 if (pmu->selectable &&
1533 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1534 char *s;
1535 if (asprintf(&s, "%s//", pmu->name) < 0)
1536 goto out_enomem;
1537 aliases[j].name = s;
1538 j++;
1539 }
1540 }
1541 len = j;
1542 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1543 for (j = 0; j < len; j++) {
1544 /* Skip duplicates */
1545 if (j > 0 && !strcmp(aliases[j].name, aliases[j - 1].name))
1546 continue;
1547 if (name_only) {
1548 printf("%s ", aliases[j].name);
1549 continue;
1550 }
1551 if (aliases[j].desc && !quiet_flag) {
1552 if (numdesc++ == 0)
1553 printf("\n");
1554 if (aliases[j].topic && (!topic ||
1555 strcmp(topic, aliases[j].topic))) {
1556 printf("%s%s:\n", topic ? "\n" : "",
1557 aliases[j].topic);
1558 topic = aliases[j].topic;
1559 }
1560 printf(" %-50s\n", aliases[j].name);
1561 printf("%*s", 8, "[");
1562 wordwrap(aliases[j].desc, 8, columns, 0);
1563 printf("]\n");
1564 if (details_flag) {
1565 printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
1566 if (aliases[j].metric_name)
1567 printf(" MetricName: %s", aliases[j].metric_name);
1568 if (aliases[j].metric_expr)
1569 printf(" MetricExpr: %s", aliases[j].metric_expr);
1570 putchar('\n');
1571 }
1572 } else
1573 printf(" %-50s [Kernel PMU event]\n", aliases[j].name);
1574 printed++;
1575 }
1576 if (printed && pager_in_use())
1577 printf("\n");
1578out_free:
1579 for (j = 0; j < len; j++)
1580 zfree(&aliases[j].name);
1581 zfree(&aliases);
1582 return;
1583
1584out_enomem:
1585 printf("FATAL: not enough memory to print PMU events\n");
1586 if (aliases)
1587 goto out_free;
1588}
1589
1590bool pmu_have_event(const char *pname, const char *name)
1591{
1592 struct perf_pmu *pmu;
1593 struct perf_pmu_alias *alias;
1594
1595 pmu = NULL;
1596 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1597 if (strcmp(pname, pmu->name))
1598 continue;
1599 list_for_each_entry(alias, &pmu->aliases, list)
1600 if (!strcmp(alias->name, name))
1601 return true;
1602 }
1603 return false;
1604}
1605
1606static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1607{
1608 char path[PATH_MAX];
1609 const char *sysfs;
1610
1611 sysfs = sysfs__mountpoint();
1612 if (!sysfs)
1613 return NULL;
1614
1615 snprintf(path, PATH_MAX,
1616 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1617 if (!file_available(path))
1618 return NULL;
1619 return fopen(path, "r");
1620}
1621
1622int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1623 ...)
1624{
1625 va_list args;
1626 FILE *file;
1627 int ret = EOF;
1628
1629 va_start(args, fmt);
1630 file = perf_pmu__open_file(pmu, name);
1631 if (file) {
1632 ret = vfscanf(file, fmt, args);
1633 fclose(file);
1634 }
1635 va_end(args);
1636 return ret;
1637}
1638
1639static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1640{
1641 struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1642
1643 if (!caps)
1644 return -ENOMEM;
1645
1646 caps->name = strdup(name);
1647 if (!caps->name)
1648 goto free_caps;
1649 caps->value = strndup(value, strlen(value) - 1);
1650 if (!caps->value)
1651 goto free_name;
1652 list_add_tail(&caps->list, list);
1653 return 0;
1654
1655free_name:
1656 zfree(caps->name);
1657free_caps:
1658 free(caps);
1659
1660 return -ENOMEM;
1661}
1662
1663/*
1664 * Reading/parsing the given pmu capabilities, which should be located at:
1665 * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1666 * Return the number of capabilities
1667 */
1668int perf_pmu__caps_parse(struct perf_pmu *pmu)
1669{
1670 struct stat st;
1671 char caps_path[PATH_MAX];
1672 const char *sysfs = sysfs__mountpoint();
1673 DIR *caps_dir;
1674 struct dirent *evt_ent;
1675 int nr_caps = 0;
1676
1677 if (!sysfs)
1678 return -1;
1679
1680 snprintf(caps_path, PATH_MAX,
1681 "%s" EVENT_SOURCE_DEVICE_PATH "%s/caps", sysfs, pmu->name);
1682
1683 if (stat(caps_path, &st) < 0)
1684 return 0; /* no error if caps does not exist */
1685
1686 caps_dir = opendir(caps_path);
1687 if (!caps_dir)
1688 return -EINVAL;
1689
1690 while ((evt_ent = readdir(caps_dir)) != NULL) {
1691 char path[PATH_MAX + NAME_MAX + 1];
1692 char *name = evt_ent->d_name;
1693 char value[128];
1694 FILE *file;
1695
1696 if (!strcmp(name, ".") || !strcmp(name, ".."))
1697 continue;
1698
1699 snprintf(path, sizeof(path), "%s/%s", caps_path, name);
1700
1701 file = fopen(path, "r");
1702 if (!file)
1703 continue;
1704
1705 if (!fgets(value, sizeof(value), file) ||
1706 (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1707 fclose(file);
1708 continue;
1709 }
1710
1711 nr_caps++;
1712 fclose(file);
1713 }
1714
1715 closedir(caps_dir);
1716
1717 return nr_caps;
1718}