1 #include <linux/list.h>
2 #include <linux/compiler.h>
13 #include "parse-events.h"
16 struct perf_pmu_format {
19 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
20 struct list_head list;
23 #define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"
25 int perf_pmu_parse(struct list_head *list, char *name);
26 extern FILE *perf_pmu_in;
28 static LIST_HEAD(pmus);
31 * Parse & process all the sysfs attributes located under
32 * the directory specified in 'dir' parameter.
34 int perf_pmu__format_parse(char *dir, struct list_head *head)
36 struct dirent *evt_ent;
40 format_dir = opendir(dir);
44 while (!ret && (evt_ent = readdir(format_dir))) {
46 char *name = evt_ent->d_name;
49 if (!strcmp(name, ".") || !strcmp(name, ".."))
52 snprintf(path, PATH_MAX, "%s/%s", dir, name);
55 file = fopen(path, "r");
60 ret = perf_pmu_parse(head, name);
69 * Reading/parsing the default pmu format definition, which should be
71 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
73 static int pmu_format(const char *name, struct list_head *format)
77 const char *sysfs = sysfs__mountpoint();
82 snprintf(path, PATH_MAX,
83 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
85 if (stat(path, &st) < 0)
86 return 0; /* no error if format does not exist */
88 if (perf_pmu__format_parse(path, format))
94 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
103 snprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
105 fd = open(path, O_RDONLY);
109 if (fstat(fd, &st) < 0)
112 sret = read(fd, scale, sizeof(scale)-1);
116 if (scale[sret - 1] == '\n')
117 scale[sret - 1] = '\0';
122 * save current locale
124 lc = setlocale(LC_NUMERIC, NULL);
127 * force to C locale to ensure kernel
128 * scale string is converted correctly.
129 * kernel uses default C locale.
131 setlocale(LC_NUMERIC, "C");
133 alias->scale = strtod(scale, NULL);
136 setlocale(LC_NUMERIC, lc);
144 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
150 snprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
152 fd = open(path, O_RDONLY);
156 sret = read(fd, alias->unit, UNIT_MAX_LEN);
162 if (alias->unit[sret - 1] == '\n')
163 alias->unit[sret - 1] = '\0';
165 alias->unit[sret] = '\0';
170 alias->unit[0] = '\0';
175 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
180 snprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
182 fd = open(path, O_RDONLY);
188 alias->per_pkg = true;
192 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
193 char *dir, char *name)
198 snprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
200 fd = open(path, O_RDONLY);
204 alias->snapshot = true;
209 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
210 char *desc __maybe_unused, char *val)
212 struct perf_pmu_alias *alias;
215 alias = malloc(sizeof(*alias));
219 INIT_LIST_HEAD(&alias->terms);
221 alias->unit[0] = '\0';
222 alias->per_pkg = false;
224 ret = parse_events_terms(&alias->terms, val);
226 pr_err("Cannot parse alias %s: %d\n", val, ret);
231 alias->name = strdup(name);
234 * load unit name and scale if available
236 perf_pmu__parse_unit(alias, dir, name);
237 perf_pmu__parse_scale(alias, dir, name);
238 perf_pmu__parse_per_pkg(alias, dir, name);
239 perf_pmu__parse_snapshot(alias, dir, name);
242 list_add_tail(&alias->list, list);
247 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
252 ret = fread(buf, 1, sizeof(buf), file);
258 return __perf_pmu__new_alias(list, dir, name, NULL, buf);
261 static inline bool pmu_alias_info_file(char *name)
266 if (len > 5 && !strcmp(name + len - 5, ".unit"))
268 if (len > 6 && !strcmp(name + len - 6, ".scale"))
270 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
272 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
279 * Process all the sysfs attributes located under the directory
280 * specified in 'dir' parameter.
282 static int pmu_aliases_parse(char *dir, struct list_head *head)
284 struct dirent *evt_ent;
288 event_dir = opendir(dir);
292 while (!ret && (evt_ent = readdir(event_dir))) {
294 char *name = evt_ent->d_name;
297 if (!strcmp(name, ".") || !strcmp(name, ".."))
301 * skip info files parsed in perf_pmu__new_alias()
303 if (pmu_alias_info_file(name))
306 snprintf(path, PATH_MAX, "%s/%s", dir, name);
309 file = fopen(path, "r");
313 ret = perf_pmu__new_alias(head, dir, name, file);
322 * Reading the pmu event aliases definition, which should be located at:
323 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
325 static int pmu_aliases(const char *name, struct list_head *head)
329 const char *sysfs = sysfs__mountpoint();
334 snprintf(path, PATH_MAX,
335 "%s/bus/event_source/devices/%s/events", sysfs, name);
337 if (stat(path, &st) < 0)
338 return 0; /* no error if 'events' does not exist */
340 if (pmu_aliases_parse(path, head))
346 static int pmu_alias_terms(struct perf_pmu_alias *alias,
347 struct list_head *terms)
349 struct parse_events_term *term, *cloned;
353 list_for_each_entry(term, &alias->terms, list) {
354 ret = parse_events_term__clone(&cloned, term);
356 parse_events__free_terms(&list);
359 list_add_tail(&cloned->list, &list);
361 list_splice(&list, terms);
366 * Reading/parsing the default pmu type value, which should be
368 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
370 static int pmu_type(const char *name, __u32 *type)
376 const char *sysfs = sysfs__mountpoint();
381 snprintf(path, PATH_MAX,
382 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
384 if (stat(path, &st) < 0)
387 file = fopen(path, "r");
391 if (1 != fscanf(file, "%u", type))
398 /* Add all pmus in sysfs to pmu list: */
399 static void pmu_read_sysfs(void)
404 const char *sysfs = sysfs__mountpoint();
409 snprintf(path, PATH_MAX,
410 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
416 while ((dent = readdir(dir))) {
417 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
419 /* add to static LIST_HEAD(pmus): */
420 perf_pmu__find(dent->d_name);
426 static struct cpu_map *pmu_cpumask(const char *name)
431 struct cpu_map *cpus;
432 const char *sysfs = sysfs__mountpoint();
437 snprintf(path, PATH_MAX,
438 "%s/bus/event_source/devices/%s/cpumask", sysfs, name);
440 if (stat(path, &st) < 0)
443 file = fopen(path, "r");
447 cpus = cpu_map__read(file);
452 struct perf_event_attr * __weak
453 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
458 static struct perf_pmu *pmu_lookup(const char *name)
460 struct perf_pmu *pmu;
466 * The pmu data we store & need consists of the pmu
467 * type value and format definitions. Load both right
470 if (pmu_format(name, &format))
473 if (pmu_aliases(name, &aliases))
476 if (pmu_type(name, &type))
479 pmu = zalloc(sizeof(*pmu));
483 pmu->cpus = pmu_cpumask(name);
485 INIT_LIST_HEAD(&pmu->format);
486 INIT_LIST_HEAD(&pmu->aliases);
487 list_splice(&format, &pmu->format);
488 list_splice(&aliases, &pmu->aliases);
489 pmu->name = strdup(name);
491 list_add_tail(&pmu->list, &pmus);
493 pmu->default_config = perf_pmu__get_default_config(pmu);
498 static struct perf_pmu *pmu_find(const char *name)
500 struct perf_pmu *pmu;
502 list_for_each_entry(pmu, &pmus, list)
503 if (!strcmp(pmu->name, name))
509 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
512 * pmu iterator: If pmu is NULL, we start at the begin,
513 * otherwise return the next pmu. Returns NULL on end.
517 pmu = list_prepare_entry(pmu, &pmus, list);
519 list_for_each_entry_continue(pmu, &pmus, list)
524 struct perf_pmu *perf_pmu__find(const char *name)
526 struct perf_pmu *pmu;
529 * Once PMU is loaded it stays in the list,
530 * so we keep us from multiple reading/parsing
531 * the pmu format definitions.
533 pmu = pmu_find(name);
537 return pmu_lookup(name);
540 static struct perf_pmu_format *
541 pmu_find_format(struct list_head *formats, const char *name)
543 struct perf_pmu_format *format;
545 list_for_each_entry(format, formats, list)
546 if (!strcmp(format->name, name))
552 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
554 struct perf_pmu_format *format = pmu_find_format(formats, name);
561 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
562 bits |= 1ULL << fbit;
568 * Sets value based on the format definition (format parameter)
569 * and unformated value (value parameter).
571 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
574 unsigned long fbit, vbit;
576 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
578 if (!test_bit(fbit, format))
581 if (value & (1llu << vbit++))
582 *v |= (1llu << fbit);
584 *v &= ~(1llu << fbit);
588 static __u64 pmu_format_max_value(const unsigned long *format)
592 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
596 return (1ULL << w) - 1;
601 * Term is a string term, and might be a param-term. Try to look up it's value
602 * in the remaining terms.
603 * - We have a term like "base-or-format-term=param-term",
604 * - We need to find the value supplied for "param-term" (with param-term named
605 * in a config string) later on in the term list.
607 static int pmu_resolve_param_term(struct parse_events_term *term,
608 struct list_head *head_terms,
611 struct parse_events_term *t;
613 list_for_each_entry(t, head_terms, list) {
614 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
615 if (!strcmp(t->config, term->config)) {
624 printf("Required parameter '%s' not specified\n", term->config);
629 static char *pmu_formats_string(struct list_head *formats)
631 struct perf_pmu_format *format;
639 strbuf_init(&buf, 0);
640 /* sysfs exported terms */
641 list_for_each_entry(format, formats, list)
642 strbuf_addf(&buf, i++ ? ",%s" : "%s",
645 str = strbuf_detach(&buf, NULL);
646 strbuf_release(&buf);
652 * Setup one of config[12] attr members based on the
653 * user input data - term parameter.
655 static int pmu_config_term(struct list_head *formats,
656 struct perf_event_attr *attr,
657 struct parse_events_term *term,
658 struct list_head *head_terms,
659 bool zero, struct parse_events_error *err)
661 struct perf_pmu_format *format;
666 * If this is a parameter we've already used for parameterized-eval,
667 * skip it in normal eval.
673 * Hardcoded terms should be already in, so nothing
674 * to be done for them.
676 if (parse_events__is_hardcoded_term(term))
679 format = pmu_find_format(formats, term->config);
682 printf("Invalid event/parameter '%s'\n", term->config);
684 char *pmu_term = pmu_formats_string(formats);
686 err->idx = term->err_term;
687 err->str = strdup("unknown term");
688 err->help = parse_events_formats_error_string(pmu_term);
694 switch (format->value) {
695 case PERF_PMU_FORMAT_VALUE_CONFIG:
698 case PERF_PMU_FORMAT_VALUE_CONFIG1:
701 case PERF_PMU_FORMAT_VALUE_CONFIG2:
709 * Either directly use a numeric term, or try to translate string terms
710 * using event parameters.
712 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
714 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
715 if (strcmp(term->val.str, "?")) {
717 pr_info("Invalid sysfs entry %s=%s\n",
718 term->config, term->val.str);
721 err->idx = term->err_val;
722 err->str = strdup("expected numeric value");
727 if (pmu_resolve_param_term(term, head_terms, &val))
732 max_val = pmu_format_max_value(format->bits);
735 err->idx = term->err_val;
736 if (asprintf(&err->str,
737 "value too big for format, maximum is %llu",
738 (unsigned long long)max_val) < 0)
739 err->str = strdup("value too big for format");
743 * Assume we don't care if !err, in which case the value will be
744 * silently truncated.
748 pmu_format_value(format->bits, val, vp, zero);
752 int perf_pmu__config_terms(struct list_head *formats,
753 struct perf_event_attr *attr,
754 struct list_head *head_terms,
755 bool zero, struct parse_events_error *err)
757 struct parse_events_term *term;
759 list_for_each_entry(term, head_terms, list) {
760 if (pmu_config_term(formats, attr, term, head_terms,
769 * Configures event's 'attr' parameter based on the:
770 * 1) users input - specified in terms parameter
771 * 2) pmu format definitions - specified by pmu parameter
773 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
774 struct list_head *head_terms,
775 struct parse_events_error *err)
777 bool zero = !!pmu->default_config;
779 attr->type = pmu->type;
780 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
784 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
785 struct parse_events_term *term)
787 struct perf_pmu_alias *alias;
790 if (parse_events__is_hardcoded_term(term))
793 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
794 if (term->val.num != 1)
796 if (pmu_find_format(&pmu->format, term->config))
799 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
800 if (strcasecmp(term->config, "event"))
802 name = term->val.str;
807 list_for_each_entry(alias, &pmu->aliases, list) {
808 if (!strcasecmp(alias->name, name))
815 static int check_info_data(struct perf_pmu_alias *alias,
816 struct perf_pmu_info *info)
819 * Only one term in event definition can
820 * define unit, scale and snapshot, fail
821 * if there's more than one.
823 if ((info->unit && alias->unit) ||
824 (info->scale && alias->scale) ||
825 (info->snapshot && alias->snapshot))
829 info->unit = alias->unit;
832 info->scale = alias->scale;
835 info->snapshot = alias->snapshot;
841 * Find alias in the terms list and replace it with the terms
842 * defined for the alias
844 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
845 struct perf_pmu_info *info)
847 struct parse_events_term *term, *h;
848 struct perf_pmu_alias *alias;
851 info->per_pkg = false;
854 * Mark unit and scale as not set
855 * (different from default values, see below)
859 info->snapshot = false;
861 list_for_each_entry_safe(term, h, head_terms, list) {
862 alias = pmu_find_alias(pmu, term);
865 ret = pmu_alias_terms(alias, &term->list);
869 ret = check_info_data(alias, info);
874 info->per_pkg = true;
876 list_del(&term->list);
881 * if no unit or scale foundin aliases, then
882 * set defaults as for evsel
883 * unit cannot left to NULL
885 if (info->unit == NULL)
888 if (info->scale == 0.0)
894 int perf_pmu__new_format(struct list_head *list, char *name,
895 int config, unsigned long *bits)
897 struct perf_pmu_format *format;
899 format = zalloc(sizeof(*format));
903 format->name = strdup(name);
904 format->value = config;
905 memcpy(format->bits, bits, sizeof(format->bits));
907 list_add_tail(&format->list, list);
911 void perf_pmu__set_format(unsigned long *bits, long from, long to)
918 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
919 for (b = from; b <= to; b++)
923 static int sub_non_neg(int a, int b)
930 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
931 struct perf_pmu_alias *alias)
933 struct parse_events_term *term;
934 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
936 list_for_each_entry(term, &alias->terms, list) {
937 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
938 used += snprintf(buf + used, sub_non_neg(len, used),
939 ",%s=%s", term->config,
943 if (sub_non_neg(len, used) > 0) {
947 if (sub_non_neg(len, used) > 0) {
956 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
957 struct perf_pmu_alias *alias)
959 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
963 static int cmp_string(const void *a, const void *b)
965 const char * const *as = a;
966 const char * const *bs = b;
967 return strcmp(*as, *bs);
970 void print_pmu_events(const char *event_glob, bool name_only)
972 struct perf_pmu *pmu;
973 struct perf_pmu_alias *alias;
981 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
982 list_for_each_entry(alias, &pmu->aliases, list)
987 aliases = zalloc(sizeof(char *) * len);
992 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
993 list_for_each_entry(alias, &pmu->aliases, list) {
994 char *name = format_alias(buf, sizeof(buf), pmu, alias);
995 bool is_cpu = !strcmp(pmu->name, "cpu");
997 if (event_glob != NULL &&
998 !(strglobmatch(name, event_glob) ||
999 (!is_cpu && strglobmatch(alias->name,
1003 if (is_cpu && !name_only)
1004 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1006 aliases[j] = strdup(name);
1007 if (aliases[j] == NULL)
1011 if (pmu->selectable &&
1012 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1014 if (asprintf(&s, "%s//", pmu->name) < 0)
1021 qsort(aliases, len, sizeof(char *), cmp_string);
1022 for (j = 0; j < len; j++) {
1024 printf("%s ", aliases[j]);
1027 printf(" %-50s [Kernel PMU event]\n", aliases[j]);
1030 if (printed && pager_in_use())
1033 for (j = 0; j < len; j++)
1039 printf("FATAL: not enough memory to print PMU events\n");
1044 bool pmu_have_event(const char *pname, const char *name)
1046 struct perf_pmu *pmu;
1047 struct perf_pmu_alias *alias;
1050 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1051 if (strcmp(pname, pmu->name))
1053 list_for_each_entry(alias, &pmu->aliases, list)
1054 if (!strcmp(alias->name, name))
1060 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1063 char path[PATH_MAX];
1066 sysfs = sysfs__mountpoint();
1070 snprintf(path, PATH_MAX,
1071 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1073 if (stat(path, &st) < 0)
1076 return fopen(path, "r");
1079 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1086 va_start(args, fmt);
1087 file = perf_pmu__open_file(pmu, name);
1089 ret = vfscanf(file, fmt, args);