This source file includes following definitions.
- perf_pmu__format_parse
- pmu_format
- perf_pmu__convert_scale
- perf_pmu__parse_scale
- perf_pmu__parse_unit
- perf_pmu__parse_per_pkg
- perf_pmu__parse_snapshot
- perf_pmu_assign_str
- perf_pmu_update_alias
- perf_pmu_free_alias
- perf_pmu_merge_alias
- __perf_pmu__new_alias
- perf_pmu__new_alias
- pmu_alias_info_file
- pmu_aliases_parse
- pmu_aliases
- pmu_alias_terms
- pmu_type
- pmu_read_sysfs
- __pmu_cpumask
- pmu_cpumask
- pmu_is_uncore
- is_arm_pmu_core
- perf_pmu__getcpuid
- perf_pmu__find_map
- pmu_uncore_alias_match
- pmu_add_cpu_aliases
- perf_pmu__get_default_config
- pmu_max_precise
- pmu_lookup
- pmu_find
- perf_pmu__scan
- perf_pmu__find
- pmu_find_format
- perf_pmu__format_bits
- pmu_format_value
- pmu_format_max_value
- pmu_resolve_param_term
- pmu_formats_string
- pmu_config_term
- perf_pmu__config_terms
- perf_pmu__config
- pmu_find_alias
- check_info_data
- perf_pmu__check_alias
- perf_pmu__new_format
- perf_pmu__set_format
- sub_non_neg
- format_alias
- format_alias_or
- cmp_sevent
- wordwrap
- print_pmu_events
- pmu_have_event
- perf_pmu__open_file
- perf_pmu__scan_file
1
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 "pmu.h"
22 #include "parse-events.h"
23 #include "header.h"
24 #include "pmu-events/pmu-events.h"
25 #include "string2.h"
26 #include "strbuf.h"
27
28 struct perf_pmu_format {
29 char *name;
30 int value;
31 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
32 struct list_head list;
33 };
34
35 int perf_pmu_parse(struct list_head *list, char *name);
36 extern FILE *perf_pmu_in;
37
38 static LIST_HEAD(pmus);
39
40
41
42
43
44 int perf_pmu__format_parse(char *dir, struct list_head *head)
45 {
46 struct dirent *evt_ent;
47 DIR *format_dir;
48 int ret = 0;
49
50 format_dir = opendir(dir);
51 if (!format_dir)
52 return -EINVAL;
53
54 while (!ret && (evt_ent = readdir(format_dir))) {
55 char path[PATH_MAX];
56 char *name = evt_ent->d_name;
57 FILE *file;
58
59 if (!strcmp(name, ".") || !strcmp(name, ".."))
60 continue;
61
62 snprintf(path, PATH_MAX, "%s/%s", dir, name);
63
64 ret = -EINVAL;
65 file = fopen(path, "r");
66 if (!file)
67 break;
68
69 perf_pmu_in = file;
70 ret = perf_pmu_parse(head, name);
71 fclose(file);
72 }
73
74 closedir(format_dir);
75 return ret;
76 }
77
78
79
80
81
82
83 static int pmu_format(const char *name, struct list_head *format)
84 {
85 struct stat st;
86 char path[PATH_MAX];
87 const char *sysfs = sysfs__mountpoint();
88
89 if (!sysfs)
90 return -1;
91
92 snprintf(path, PATH_MAX,
93 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
94
95 if (stat(path, &st) < 0)
96 return 0;
97
98 if (perf_pmu__format_parse(path, format))
99 return -1;
100
101 return 0;
102 }
103
104 int perf_pmu__convert_scale(const char *scale, char **end, double *sval)
105 {
106 char *lc;
107 int ret = 0;
108
109
110
111
112 lc = setlocale(LC_NUMERIC, NULL);
113
114
115
116
117
118
119 lc = strdup(lc);
120 if (!lc) {
121 ret = -ENOMEM;
122 goto out;
123 }
124
125
126
127
128
129
130 setlocale(LC_NUMERIC, "C");
131
132 *sval = strtod(scale, end);
133
134 out:
135
136 setlocale(LC_NUMERIC, lc);
137 free(lc);
138 return ret;
139 }
140
141 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
142 {
143 struct stat st;
144 ssize_t sret;
145 char scale[128];
146 int fd, ret = -1;
147 char path[PATH_MAX];
148
149 scnprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
150
151 fd = open(path, O_RDONLY);
152 if (fd == -1)
153 return -1;
154
155 if (fstat(fd, &st) < 0)
156 goto error;
157
158 sret = read(fd, scale, sizeof(scale)-1);
159 if (sret < 0)
160 goto error;
161
162 if (scale[sret - 1] == '\n')
163 scale[sret - 1] = '\0';
164 else
165 scale[sret] = '\0';
166
167 ret = perf_pmu__convert_scale(scale, NULL, &alias->scale);
168 error:
169 close(fd);
170 return ret;
171 }
172
173 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
174 {
175 char path[PATH_MAX];
176 ssize_t sret;
177 int fd;
178
179 scnprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
180
181 fd = open(path, O_RDONLY);
182 if (fd == -1)
183 return -1;
184
185 sret = read(fd, alias->unit, UNIT_MAX_LEN);
186 if (sret < 0)
187 goto error;
188
189 close(fd);
190
191 if (alias->unit[sret - 1] == '\n')
192 alias->unit[sret - 1] = '\0';
193 else
194 alias->unit[sret] = '\0';
195
196 return 0;
197 error:
198 close(fd);
199 alias->unit[0] = '\0';
200 return -1;
201 }
202
203 static int
204 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
205 {
206 char path[PATH_MAX];
207 int fd;
208
209 scnprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
210
211 fd = open(path, O_RDONLY);
212 if (fd == -1)
213 return -1;
214
215 close(fd);
216
217 alias->per_pkg = true;
218 return 0;
219 }
220
221 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
222 char *dir, char *name)
223 {
224 char path[PATH_MAX];
225 int fd;
226
227 scnprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
228
229 fd = open(path, O_RDONLY);
230 if (fd == -1)
231 return -1;
232
233 alias->snapshot = true;
234 close(fd);
235 return 0;
236 }
237
238 static void perf_pmu_assign_str(char *name, const char *field, char **old_str,
239 char **new_str)
240 {
241 if (!*old_str)
242 goto set_new;
243
244 if (*new_str) {
245 if (strcasecmp(*old_str, *new_str))
246 pr_debug("alias %s differs in field '%s'\n",
247 name, field);
248 zfree(old_str);
249 } else
250 return;
251 set_new:
252 *old_str = *new_str;
253 *new_str = NULL;
254 }
255
256 static void perf_pmu_update_alias(struct perf_pmu_alias *old,
257 struct perf_pmu_alias *newalias)
258 {
259 perf_pmu_assign_str(old->name, "desc", &old->desc, &newalias->desc);
260 perf_pmu_assign_str(old->name, "long_desc", &old->long_desc,
261 &newalias->long_desc);
262 perf_pmu_assign_str(old->name, "topic", &old->topic, &newalias->topic);
263 perf_pmu_assign_str(old->name, "metric_expr", &old->metric_expr,
264 &newalias->metric_expr);
265 perf_pmu_assign_str(old->name, "metric_name", &old->metric_name,
266 &newalias->metric_name);
267 perf_pmu_assign_str(old->name, "value", &old->str, &newalias->str);
268 old->scale = newalias->scale;
269 old->per_pkg = newalias->per_pkg;
270 old->snapshot = newalias->snapshot;
271 memcpy(old->unit, newalias->unit, sizeof(old->unit));
272 }
273
274
275 static void perf_pmu_free_alias(struct perf_pmu_alias *newalias)
276 {
277 zfree(&newalias->name);
278 zfree(&newalias->desc);
279 zfree(&newalias->long_desc);
280 zfree(&newalias->topic);
281 zfree(&newalias->str);
282 zfree(&newalias->metric_expr);
283 zfree(&newalias->metric_name);
284 parse_events_terms__purge(&newalias->terms);
285 free(newalias);
286 }
287
288
289
290
291 static bool perf_pmu_merge_alias(struct perf_pmu_alias *newalias,
292 struct list_head *alist)
293 {
294 struct perf_pmu_alias *a;
295
296 list_for_each_entry(a, alist, list) {
297 if (!strcasecmp(newalias->name, a->name)) {
298 perf_pmu_update_alias(a, newalias);
299 perf_pmu_free_alias(newalias);
300 return true;
301 }
302 }
303 return false;
304 }
305
306 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
307 char *desc, char *val,
308 char *long_desc, char *topic,
309 char *unit, char *perpkg,
310 char *metric_expr,
311 char *metric_name)
312 {
313 struct parse_events_term *term;
314 struct perf_pmu_alias *alias;
315 int ret;
316 int num;
317 char newval[256];
318
319 alias = malloc(sizeof(*alias));
320 if (!alias)
321 return -ENOMEM;
322
323 INIT_LIST_HEAD(&alias->terms);
324 alias->scale = 1.0;
325 alias->unit[0] = '\0';
326 alias->per_pkg = false;
327 alias->snapshot = false;
328
329 ret = parse_events_terms(&alias->terms, val);
330 if (ret) {
331 pr_err("Cannot parse alias %s: %d\n", val, ret);
332 free(alias);
333 return ret;
334 }
335
336
337
338
339
340
341
342
343 memset(newval, 0, sizeof(newval));
344 ret = 0;
345 list_for_each_entry(term, &alias->terms, list) {
346 if (ret)
347 ret += scnprintf(newval + ret, sizeof(newval) - ret,
348 ",");
349 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
350 ret += scnprintf(newval + ret, sizeof(newval) - ret,
351 "%s=%#x", term->config, term->val.num);
352 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
353 ret += scnprintf(newval + ret, sizeof(newval) - ret,
354 "%s=%s", term->config, term->val.str);
355 }
356
357 alias->name = strdup(name);
358 if (dir) {
359
360
361
362 perf_pmu__parse_unit(alias, dir, name);
363 perf_pmu__parse_scale(alias, dir, name);
364 perf_pmu__parse_per_pkg(alias, dir, name);
365 perf_pmu__parse_snapshot(alias, dir, name);
366 }
367
368 alias->metric_expr = metric_expr ? strdup(metric_expr) : NULL;
369 alias->metric_name = metric_name ? strdup(metric_name): NULL;
370 alias->desc = desc ? strdup(desc) : NULL;
371 alias->long_desc = long_desc ? strdup(long_desc) :
372 desc ? strdup(desc) : NULL;
373 alias->topic = topic ? strdup(topic) : NULL;
374 if (unit) {
375 if (perf_pmu__convert_scale(unit, &unit, &alias->scale) < 0)
376 return -1;
377 snprintf(alias->unit, sizeof(alias->unit), "%s", unit);
378 }
379 alias->per_pkg = perpkg && sscanf(perpkg, "%d", &num) == 1 && num == 1;
380 alias->str = strdup(newval);
381
382 if (!perf_pmu_merge_alias(alias, list))
383 list_add_tail(&alias->list, list);
384
385 return 0;
386 }
387
388 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
389 {
390 char buf[256];
391 int ret;
392
393 ret = fread(buf, 1, sizeof(buf), file);
394 if (ret == 0)
395 return -EINVAL;
396
397 buf[ret] = 0;
398
399
400 strim(buf);
401
402 return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL, NULL, NULL,
403 NULL, NULL, NULL);
404 }
405
406 static inline bool pmu_alias_info_file(char *name)
407 {
408 size_t len;
409
410 len = strlen(name);
411 if (len > 5 && !strcmp(name + len - 5, ".unit"))
412 return true;
413 if (len > 6 && !strcmp(name + len - 6, ".scale"))
414 return true;
415 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
416 return true;
417 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
418 return true;
419
420 return false;
421 }
422
423
424
425
426
427 static int pmu_aliases_parse(char *dir, struct list_head *head)
428 {
429 struct dirent *evt_ent;
430 DIR *event_dir;
431
432 event_dir = opendir(dir);
433 if (!event_dir)
434 return -EINVAL;
435
436 while ((evt_ent = readdir(event_dir))) {
437 char path[PATH_MAX];
438 char *name = evt_ent->d_name;
439 FILE *file;
440
441 if (!strcmp(name, ".") || !strcmp(name, ".."))
442 continue;
443
444
445
446
447 if (pmu_alias_info_file(name))
448 continue;
449
450 scnprintf(path, PATH_MAX, "%s/%s", dir, name);
451
452 file = fopen(path, "r");
453 if (!file) {
454 pr_debug("Cannot open %s\n", path);
455 continue;
456 }
457
458 if (perf_pmu__new_alias(head, dir, name, file) < 0)
459 pr_debug("Cannot set up %s\n", name);
460 fclose(file);
461 }
462
463 closedir(event_dir);
464 return 0;
465 }
466
467
468
469
470
471 static int pmu_aliases(const char *name, struct list_head *head)
472 {
473 struct stat st;
474 char path[PATH_MAX];
475 const char *sysfs = sysfs__mountpoint();
476
477 if (!sysfs)
478 return -1;
479
480 snprintf(path, PATH_MAX,
481 "%s/bus/event_source/devices/%s/events", sysfs, name);
482
483 if (stat(path, &st) < 0)
484 return 0;
485
486 if (pmu_aliases_parse(path, head))
487 return -1;
488
489 return 0;
490 }
491
492 static int pmu_alias_terms(struct perf_pmu_alias *alias,
493 struct list_head *terms)
494 {
495 struct parse_events_term *term, *cloned;
496 LIST_HEAD(list);
497 int ret;
498
499 list_for_each_entry(term, &alias->terms, list) {
500 ret = parse_events_term__clone(&cloned, term);
501 if (ret) {
502 parse_events_terms__purge(&list);
503 return ret;
504 }
505
506
507
508
509 cloned->weak = true;
510 list_add_tail(&cloned->list, &list);
511 }
512 list_splice(&list, terms);
513 return 0;
514 }
515
516
517
518
519
520
521 static int pmu_type(const char *name, __u32 *type)
522 {
523 struct stat st;
524 char path[PATH_MAX];
525 FILE *file;
526 int ret = 0;
527 const char *sysfs = sysfs__mountpoint();
528
529 if (!sysfs)
530 return -1;
531
532 snprintf(path, PATH_MAX,
533 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
534
535 if (stat(path, &st) < 0)
536 return -1;
537
538 file = fopen(path, "r");
539 if (!file)
540 return -EINVAL;
541
542 if (1 != fscanf(file, "%u", type))
543 ret = -1;
544
545 fclose(file);
546 return ret;
547 }
548
549
550 static void pmu_read_sysfs(void)
551 {
552 char path[PATH_MAX];
553 DIR *dir;
554 struct dirent *dent;
555 const char *sysfs = sysfs__mountpoint();
556
557 if (!sysfs)
558 return;
559
560 snprintf(path, PATH_MAX,
561 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
562
563 dir = opendir(path);
564 if (!dir)
565 return;
566
567 while ((dent = readdir(dir))) {
568 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
569 continue;
570
571 perf_pmu__find(dent->d_name);
572 }
573
574 closedir(dir);
575 }
576
577 static struct perf_cpu_map *__pmu_cpumask(const char *path)
578 {
579 FILE *file;
580 struct perf_cpu_map *cpus;
581
582 file = fopen(path, "r");
583 if (!file)
584 return NULL;
585
586 cpus = perf_cpu_map__read(file);
587 fclose(file);
588 return cpus;
589 }
590
591
592
593
594
595 #define CPUS_TEMPLATE_UNCORE "%s/bus/event_source/devices/%s/cpumask"
596 #define CPUS_TEMPLATE_CPU "%s/bus/event_source/devices/%s/cpus"
597
598 static struct perf_cpu_map *pmu_cpumask(const char *name)
599 {
600 char path[PATH_MAX];
601 struct perf_cpu_map *cpus;
602 const char *sysfs = sysfs__mountpoint();
603 const char *templates[] = {
604 CPUS_TEMPLATE_UNCORE,
605 CPUS_TEMPLATE_CPU,
606 NULL
607 };
608 const char **template;
609
610 if (!sysfs)
611 return NULL;
612
613 for (template = templates; *template; template++) {
614 snprintf(path, PATH_MAX, *template, sysfs, name);
615 cpus = __pmu_cpumask(path);
616 if (cpus)
617 return cpus;
618 }
619
620 return NULL;
621 }
622
623 static bool pmu_is_uncore(const char *name)
624 {
625 char path[PATH_MAX];
626 struct perf_cpu_map *cpus;
627 const char *sysfs = sysfs__mountpoint();
628
629 snprintf(path, PATH_MAX, CPUS_TEMPLATE_UNCORE, sysfs, name);
630 cpus = __pmu_cpumask(path);
631 perf_cpu_map__put(cpus);
632
633 return !!cpus;
634 }
635
636
637
638
639
640
641 static int is_arm_pmu_core(const char *name)
642 {
643 struct stat st;
644 char path[PATH_MAX];
645 const char *sysfs = sysfs__mountpoint();
646
647 if (!sysfs)
648 return 0;
649
650
651 scnprintf(path, PATH_MAX, "%s/bus/event_source/devices/%s/cpus",
652 sysfs, name);
653 if (stat(path, &st) == 0)
654 return 1;
655
656 return 0;
657 }
658
659 static char *perf_pmu__getcpuid(struct perf_pmu *pmu)
660 {
661 char *cpuid;
662 static bool printed;
663
664 cpuid = getenv("PERF_CPUID");
665 if (cpuid)
666 cpuid = strdup(cpuid);
667 if (!cpuid)
668 cpuid = get_cpuid_str(pmu);
669 if (!cpuid)
670 return NULL;
671
672 if (!printed) {
673 pr_debug("Using CPUID %s\n", cpuid);
674 printed = true;
675 }
676 return cpuid;
677 }
678
679 struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu)
680 {
681 struct pmu_events_map *map;
682 char *cpuid = perf_pmu__getcpuid(pmu);
683 int i;
684
685
686
687
688 if (!cpuid)
689 return NULL;
690
691 i = 0;
692 for (;;) {
693 map = &pmu_events_map[i++];
694 if (!map->table) {
695 map = NULL;
696 break;
697 }
698
699 if (!strcmp_cpuid_str(map->cpuid, cpuid))
700 break;
701 }
702 free(cpuid);
703 return map;
704 }
705
706 static bool pmu_uncore_alias_match(const char *pmu_name, const char *name)
707 {
708 char *tmp = NULL, *tok, *str;
709 bool res;
710
711 str = strdup(pmu_name);
712 if (!str)
713 return false;
714
715
716
717
718 tok = strtok_r(str, ",", &tmp);
719 if (strncmp(pmu_name, tok, strlen(tok))) {
720 res = false;
721 goto out;
722 }
723
724
725
726
727
728
729
730
731
732 for (; tok; name += strlen(tok), tok = strtok_r(NULL, ",", &tmp)) {
733 name = strstr(name, tok);
734 if (!name) {
735 res = false;
736 goto out;
737 }
738 }
739
740 res = true;
741 out:
742 free(str);
743 return res;
744 }
745
746
747
748
749
750
751 static void pmu_add_cpu_aliases(struct list_head *head, struct perf_pmu *pmu)
752 {
753 int i;
754 struct pmu_events_map *map;
755 const char *name = pmu->name;
756
757 map = perf_pmu__find_map(pmu);
758 if (!map)
759 return;
760
761
762
763
764 i = 0;
765 while (1) {
766 const char *cpu_name = is_arm_pmu_core(name) ? name : "cpu";
767 struct pmu_event *pe = &map->table[i++];
768 const char *pname = pe->pmu ? pe->pmu : cpu_name;
769
770 if (!pe->name) {
771 if (pe->metric_group || pe->metric_name)
772 continue;
773 break;
774 }
775
776 if (pmu_is_uncore(name) &&
777 pmu_uncore_alias_match(pname, name))
778 goto new_alias;
779
780 if (strcmp(pname, name))
781 continue;
782
783 new_alias:
784
785 __perf_pmu__new_alias(head, NULL, (char *)pe->name,
786 (char *)pe->desc, (char *)pe->event,
787 (char *)pe->long_desc, (char *)pe->topic,
788 (char *)pe->unit, (char *)pe->perpkg,
789 (char *)pe->metric_expr,
790 (char *)pe->metric_name);
791 }
792 }
793
794 struct perf_event_attr * __weak
795 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
796 {
797 return NULL;
798 }
799
800 static int pmu_max_precise(const char *name)
801 {
802 char path[PATH_MAX];
803 int max_precise = -1;
804
805 scnprintf(path, PATH_MAX,
806 "bus/event_source/devices/%s/caps/max_precise",
807 name);
808
809 sysfs__read_int(path, &max_precise);
810 return max_precise;
811 }
812
813 static struct perf_pmu *pmu_lookup(const char *name)
814 {
815 struct perf_pmu *pmu;
816 LIST_HEAD(format);
817 LIST_HEAD(aliases);
818 __u32 type;
819
820
821
822
823
824
825 if (pmu_format(name, &format))
826 return NULL;
827
828
829
830
831 if (pmu_type(name, &type))
832 return NULL;
833
834 if (pmu_aliases(name, &aliases))
835 return NULL;
836
837 pmu = zalloc(sizeof(*pmu));
838 if (!pmu)
839 return NULL;
840
841 pmu->cpus = pmu_cpumask(name);
842 pmu->name = strdup(name);
843 pmu->type = type;
844 pmu->is_uncore = pmu_is_uncore(name);
845 pmu->max_precise = pmu_max_precise(name);
846 pmu_add_cpu_aliases(&aliases, pmu);
847
848 INIT_LIST_HEAD(&pmu->format);
849 INIT_LIST_HEAD(&pmu->aliases);
850 list_splice(&format, &pmu->format);
851 list_splice(&aliases, &pmu->aliases);
852 list_add_tail(&pmu->list, &pmus);
853
854 pmu->default_config = perf_pmu__get_default_config(pmu);
855
856 return pmu;
857 }
858
859 static struct perf_pmu *pmu_find(const char *name)
860 {
861 struct perf_pmu *pmu;
862
863 list_for_each_entry(pmu, &pmus, list)
864 if (!strcmp(pmu->name, name))
865 return pmu;
866
867 return NULL;
868 }
869
870 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
871 {
872
873
874
875
876 if (!pmu) {
877 pmu_read_sysfs();
878 pmu = list_prepare_entry(pmu, &pmus, list);
879 }
880 list_for_each_entry_continue(pmu, &pmus, list)
881 return pmu;
882 return NULL;
883 }
884
885 struct perf_pmu *perf_pmu__find(const char *name)
886 {
887 struct perf_pmu *pmu;
888
889
890
891
892
893
894 pmu = pmu_find(name);
895 if (pmu)
896 return pmu;
897
898 return pmu_lookup(name);
899 }
900
901 static struct perf_pmu_format *
902 pmu_find_format(struct list_head *formats, const char *name)
903 {
904 struct perf_pmu_format *format;
905
906 list_for_each_entry(format, formats, list)
907 if (!strcmp(format->name, name))
908 return format;
909
910 return NULL;
911 }
912
913 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
914 {
915 struct perf_pmu_format *format = pmu_find_format(formats, name);
916 __u64 bits = 0;
917 int fbit;
918
919 if (!format)
920 return 0;
921
922 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
923 bits |= 1ULL << fbit;
924
925 return bits;
926 }
927
928
929
930
931
932 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
933 bool zero)
934 {
935 unsigned long fbit, vbit;
936
937 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
938
939 if (!test_bit(fbit, format))
940 continue;
941
942 if (value & (1llu << vbit++))
943 *v |= (1llu << fbit);
944 else if (zero)
945 *v &= ~(1llu << fbit);
946 }
947 }
948
949 static __u64 pmu_format_max_value(const unsigned long *format)
950 {
951 int w;
952
953 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
954 if (!w)
955 return 0;
956 if (w < 64)
957 return (1ULL << w) - 1;
958 return -1;
959 }
960
961
962
963
964
965
966
967
968 static int pmu_resolve_param_term(struct parse_events_term *term,
969 struct list_head *head_terms,
970 __u64 *value)
971 {
972 struct parse_events_term *t;
973
974 list_for_each_entry(t, head_terms, list) {
975 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
976 if (!strcmp(t->config, term->config)) {
977 t->used = true;
978 *value = t->val.num;
979 return 0;
980 }
981 }
982 }
983
984 if (verbose > 0)
985 printf("Required parameter '%s' not specified\n", term->config);
986
987 return -1;
988 }
989
990 static char *pmu_formats_string(struct list_head *formats)
991 {
992 struct perf_pmu_format *format;
993 char *str = NULL;
994 struct strbuf buf = STRBUF_INIT;
995 unsigned i = 0;
996
997 if (!formats)
998 return NULL;
999
1000
1001 list_for_each_entry(format, formats, list)
1002 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1003 goto error;
1004
1005 str = strbuf_detach(&buf, NULL);
1006 error:
1007 strbuf_release(&buf);
1008
1009 return str;
1010 }
1011
1012
1013
1014
1015
1016 static int pmu_config_term(struct list_head *formats,
1017 struct perf_event_attr *attr,
1018 struct parse_events_term *term,
1019 struct list_head *head_terms,
1020 bool zero, struct parse_events_error *err)
1021 {
1022 struct perf_pmu_format *format;
1023 __u64 *vp;
1024 __u64 val, max_val;
1025
1026
1027
1028
1029
1030 if (term->used)
1031 return 0;
1032
1033
1034
1035
1036
1037 if (parse_events__is_hardcoded_term(term))
1038 return 0;
1039
1040 format = pmu_find_format(formats, term->config);
1041 if (!format) {
1042 if (verbose > 0)
1043 printf("Invalid event/parameter '%s'\n", term->config);
1044 if (err) {
1045 char *pmu_term = pmu_formats_string(formats);
1046
1047 err->idx = term->err_term;
1048 err->str = strdup("unknown term");
1049 err->help = parse_events_formats_error_string(pmu_term);
1050 free(pmu_term);
1051 }
1052 return -EINVAL;
1053 }
1054
1055 switch (format->value) {
1056 case PERF_PMU_FORMAT_VALUE_CONFIG:
1057 vp = &attr->config;
1058 break;
1059 case PERF_PMU_FORMAT_VALUE_CONFIG1:
1060 vp = &attr->config1;
1061 break;
1062 case PERF_PMU_FORMAT_VALUE_CONFIG2:
1063 vp = &attr->config2;
1064 break;
1065 default:
1066 return -EINVAL;
1067 }
1068
1069
1070
1071
1072
1073 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1074 if (term->no_value &&
1075 bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1076 if (err) {
1077 err->idx = term->err_val;
1078 err->str = strdup("no value assigned for term");
1079 }
1080 return -EINVAL;
1081 }
1082
1083 val = term->val.num;
1084 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1085 if (strcmp(term->val.str, "?")) {
1086 if (verbose > 0) {
1087 pr_info("Invalid sysfs entry %s=%s\n",
1088 term->config, term->val.str);
1089 }
1090 if (err) {
1091 err->idx = term->err_val;
1092 err->str = strdup("expected numeric value");
1093 }
1094 return -EINVAL;
1095 }
1096
1097 if (pmu_resolve_param_term(term, head_terms, &val))
1098 return -EINVAL;
1099 } else
1100 return -EINVAL;
1101
1102 max_val = pmu_format_max_value(format->bits);
1103 if (val > max_val) {
1104 if (err) {
1105 err->idx = term->err_val;
1106 if (asprintf(&err->str,
1107 "value too big for format, maximum is %llu",
1108 (unsigned long long)max_val) < 0)
1109 err->str = strdup("value too big for format");
1110 return -EINVAL;
1111 }
1112
1113
1114
1115
1116 }
1117
1118 pmu_format_value(format->bits, val, vp, zero);
1119 return 0;
1120 }
1121
1122 int perf_pmu__config_terms(struct list_head *formats,
1123 struct perf_event_attr *attr,
1124 struct list_head *head_terms,
1125 bool zero, struct parse_events_error *err)
1126 {
1127 struct parse_events_term *term;
1128
1129 list_for_each_entry(term, head_terms, list) {
1130 if (pmu_config_term(formats, attr, term, head_terms,
1131 zero, err))
1132 return -EINVAL;
1133 }
1134
1135 return 0;
1136 }
1137
1138
1139
1140
1141
1142
1143 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1144 struct list_head *head_terms,
1145 struct parse_events_error *err)
1146 {
1147 bool zero = !!pmu->default_config;
1148
1149 attr->type = pmu->type;
1150 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
1151 zero, err);
1152 }
1153
1154 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1155 struct parse_events_term *term)
1156 {
1157 struct perf_pmu_alias *alias;
1158 char *name;
1159
1160 if (parse_events__is_hardcoded_term(term))
1161 return NULL;
1162
1163 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1164 if (term->val.num != 1)
1165 return NULL;
1166 if (pmu_find_format(&pmu->format, term->config))
1167 return NULL;
1168 name = term->config;
1169 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1170 if (strcasecmp(term->config, "event"))
1171 return NULL;
1172 name = term->val.str;
1173 } else {
1174 return NULL;
1175 }
1176
1177 list_for_each_entry(alias, &pmu->aliases, list) {
1178 if (!strcasecmp(alias->name, name))
1179 return alias;
1180 }
1181 return NULL;
1182 }
1183
1184
1185 static int check_info_data(struct perf_pmu_alias *alias,
1186 struct perf_pmu_info *info)
1187 {
1188
1189
1190
1191
1192
1193 if ((info->unit && alias->unit[0]) ||
1194 (info->scale && alias->scale) ||
1195 (info->snapshot && alias->snapshot))
1196 return -EINVAL;
1197
1198 if (alias->unit[0])
1199 info->unit = alias->unit;
1200
1201 if (alias->scale)
1202 info->scale = alias->scale;
1203
1204 if (alias->snapshot)
1205 info->snapshot = alias->snapshot;
1206
1207 return 0;
1208 }
1209
1210
1211
1212
1213
1214 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1215 struct perf_pmu_info *info)
1216 {
1217 struct parse_events_term *term, *h;
1218 struct perf_pmu_alias *alias;
1219 int ret;
1220
1221 info->per_pkg = false;
1222
1223
1224
1225
1226
1227 info->unit = NULL;
1228 info->scale = 0.0;
1229 info->snapshot = false;
1230 info->metric_expr = NULL;
1231 info->metric_name = NULL;
1232
1233 list_for_each_entry_safe(term, h, head_terms, list) {
1234 alias = pmu_find_alias(pmu, term);
1235 if (!alias)
1236 continue;
1237 ret = pmu_alias_terms(alias, &term->list);
1238 if (ret)
1239 return ret;
1240
1241 ret = check_info_data(alias, info);
1242 if (ret)
1243 return ret;
1244
1245 if (alias->per_pkg)
1246 info->per_pkg = true;
1247 info->metric_expr = alias->metric_expr;
1248 info->metric_name = alias->metric_name;
1249
1250 list_del_init(&term->list);
1251 free(term);
1252 }
1253
1254
1255
1256
1257
1258
1259 if (info->unit == NULL)
1260 info->unit = "";
1261
1262 if (info->scale == 0.0)
1263 info->scale = 1.0;
1264
1265 return 0;
1266 }
1267
1268 int perf_pmu__new_format(struct list_head *list, char *name,
1269 int config, unsigned long *bits)
1270 {
1271 struct perf_pmu_format *format;
1272
1273 format = zalloc(sizeof(*format));
1274 if (!format)
1275 return -ENOMEM;
1276
1277 format->name = strdup(name);
1278 format->value = config;
1279 memcpy(format->bits, bits, sizeof(format->bits));
1280
1281 list_add_tail(&format->list, list);
1282 return 0;
1283 }
1284
1285 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1286 {
1287 long b;
1288
1289 if (!to)
1290 to = from;
1291
1292 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1293 for (b = from; b <= to; b++)
1294 set_bit(b, bits);
1295 }
1296
1297 static int sub_non_neg(int a, int b)
1298 {
1299 if (b > a)
1300 return 0;
1301 return a - b;
1302 }
1303
1304 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1305 struct perf_pmu_alias *alias)
1306 {
1307 struct parse_events_term *term;
1308 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1309
1310 list_for_each_entry(term, &alias->terms, list) {
1311 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1312 used += snprintf(buf + used, sub_non_neg(len, used),
1313 ",%s=%s", term->config,
1314 term->val.str);
1315 }
1316
1317 if (sub_non_neg(len, used) > 0) {
1318 buf[used] = '/';
1319 used++;
1320 }
1321 if (sub_non_neg(len, used) > 0) {
1322 buf[used] = '\0';
1323 used++;
1324 } else
1325 buf[len - 1] = '\0';
1326
1327 return buf;
1328 }
1329
1330 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1331 struct perf_pmu_alias *alias)
1332 {
1333 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1334 return buf;
1335 }
1336
1337 struct sevent {
1338 char *name;
1339 char *desc;
1340 char *topic;
1341 char *str;
1342 char *pmu;
1343 char *metric_expr;
1344 char *metric_name;
1345 };
1346
1347 static int cmp_sevent(const void *a, const void *b)
1348 {
1349 const struct sevent *as = a;
1350 const struct sevent *bs = b;
1351
1352
1353 if (!!as->desc != !!bs->desc)
1354 return !!as->desc - !!bs->desc;
1355 if (as->topic && bs->topic) {
1356 int n = strcmp(as->topic, bs->topic);
1357
1358 if (n)
1359 return n;
1360 }
1361 return strcmp(as->name, bs->name);
1362 }
1363
1364 static void wordwrap(char *s, int start, int max, int corr)
1365 {
1366 int column = start;
1367 int n;
1368
1369 while (*s) {
1370 int wlen = strcspn(s, " \t");
1371
1372 if (column + wlen >= max && column > start) {
1373 printf("\n%*s", start, "");
1374 column = start + corr;
1375 }
1376 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1377 if (n <= 0)
1378 break;
1379 s += wlen;
1380 column += n;
1381 s = skip_spaces(s);
1382 }
1383 }
1384
1385 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1386 bool long_desc, bool details_flag)
1387 {
1388 struct perf_pmu *pmu;
1389 struct perf_pmu_alias *alias;
1390 char buf[1024];
1391 int printed = 0;
1392 int len, j;
1393 struct sevent *aliases;
1394 int numdesc = 0;
1395 int columns = pager_get_columns();
1396 char *topic = NULL;
1397
1398 pmu = NULL;
1399 len = 0;
1400 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1401 list_for_each_entry(alias, &pmu->aliases, list)
1402 len++;
1403 if (pmu->selectable)
1404 len++;
1405 }
1406 aliases = zalloc(sizeof(struct sevent) * len);
1407 if (!aliases)
1408 goto out_enomem;
1409 pmu = NULL;
1410 j = 0;
1411 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1412 list_for_each_entry(alias, &pmu->aliases, list) {
1413 char *name = alias->desc ? alias->name :
1414 format_alias(buf, sizeof(buf), pmu, alias);
1415 bool is_cpu = !strcmp(pmu->name, "cpu");
1416
1417 if (event_glob != NULL &&
1418 !(strglobmatch_nocase(name, event_glob) ||
1419 (!is_cpu && strglobmatch_nocase(alias->name,
1420 event_glob)) ||
1421 (alias->topic &&
1422 strglobmatch_nocase(alias->topic, event_glob))))
1423 continue;
1424
1425 if (is_cpu && !name_only && !alias->desc)
1426 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1427
1428 aliases[j].name = name;
1429 if (is_cpu && !name_only && !alias->desc)
1430 aliases[j].name = format_alias_or(buf,
1431 sizeof(buf),
1432 pmu, alias);
1433 aliases[j].name = strdup(aliases[j].name);
1434 if (!aliases[j].name)
1435 goto out_enomem;
1436
1437 aliases[j].desc = long_desc ? alias->long_desc :
1438 alias->desc;
1439 aliases[j].topic = alias->topic;
1440 aliases[j].str = alias->str;
1441 aliases[j].pmu = pmu->name;
1442 aliases[j].metric_expr = alias->metric_expr;
1443 aliases[j].metric_name = alias->metric_name;
1444 j++;
1445 }
1446 if (pmu->selectable &&
1447 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1448 char *s;
1449 if (asprintf(&s, "%s//", pmu->name) < 0)
1450 goto out_enomem;
1451 aliases[j].name = s;
1452 j++;
1453 }
1454 }
1455 len = j;
1456 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1457 for (j = 0; j < len; j++) {
1458
1459 if (j > 0 && !strcmp(aliases[j].name, aliases[j - 1].name))
1460 continue;
1461 if (name_only) {
1462 printf("%s ", aliases[j].name);
1463 continue;
1464 }
1465 if (aliases[j].desc && !quiet_flag) {
1466 if (numdesc++ == 0)
1467 printf("\n");
1468 if (aliases[j].topic && (!topic ||
1469 strcmp(topic, aliases[j].topic))) {
1470 printf("%s%s:\n", topic ? "\n" : "",
1471 aliases[j].topic);
1472 topic = aliases[j].topic;
1473 }
1474 printf(" %-50s\n", aliases[j].name);
1475 printf("%*s", 8, "[");
1476 wordwrap(aliases[j].desc, 8, columns, 0);
1477 printf("]\n");
1478 if (details_flag) {
1479 printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
1480 if (aliases[j].metric_name)
1481 printf(" MetricName: %s", aliases[j].metric_name);
1482 if (aliases[j].metric_expr)
1483 printf(" MetricExpr: %s", aliases[j].metric_expr);
1484 putchar('\n');
1485 }
1486 } else
1487 printf(" %-50s [Kernel PMU event]\n", aliases[j].name);
1488 printed++;
1489 }
1490 if (printed && pager_in_use())
1491 printf("\n");
1492 out_free:
1493 for (j = 0; j < len; j++)
1494 zfree(&aliases[j].name);
1495 zfree(&aliases);
1496 return;
1497
1498 out_enomem:
1499 printf("FATAL: not enough memory to print PMU events\n");
1500 if (aliases)
1501 goto out_free;
1502 }
1503
1504 bool pmu_have_event(const char *pname, const char *name)
1505 {
1506 struct perf_pmu *pmu;
1507 struct perf_pmu_alias *alias;
1508
1509 pmu = NULL;
1510 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1511 if (strcmp(pname, pmu->name))
1512 continue;
1513 list_for_each_entry(alias, &pmu->aliases, list)
1514 if (!strcmp(alias->name, name))
1515 return true;
1516 }
1517 return false;
1518 }
1519
1520 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1521 {
1522 struct stat st;
1523 char path[PATH_MAX];
1524 const char *sysfs;
1525
1526 sysfs = sysfs__mountpoint();
1527 if (!sysfs)
1528 return NULL;
1529
1530 snprintf(path, PATH_MAX,
1531 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1532
1533 if (stat(path, &st) < 0)
1534 return NULL;
1535
1536 return fopen(path, "r");
1537 }
1538
1539 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1540 ...)
1541 {
1542 va_list args;
1543 FILE *file;
1544 int ret = EOF;
1545
1546 va_start(args, fmt);
1547 file = perf_pmu__open_file(pmu, name);
1548 if (file) {
1549 ret = vfscanf(file, fmt, args);
1550 fclose(file);
1551 }
1552 va_end(args);
1553 return ret;
1554 }