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;
287 event_dir = opendir(dir);
291 while ((evt_ent = readdir(event_dir))) {
293 char *name = evt_ent->d_name;
296 if (!strcmp(name, ".") || !strcmp(name, ".."))
300 * skip info files parsed in perf_pmu__new_alias()
302 if (pmu_alias_info_file(name))
305 snprintf(path, PATH_MAX, "%s/%s", dir, name);
307 file = fopen(path, "r");
309 pr_debug("Cannot open %s\n", path);
313 if (perf_pmu__new_alias(head, dir, name, file) < 0)
314 pr_debug("Cannot set up %s\n", name);
323 * Reading the pmu event aliases definition, which should be located at:
324 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
326 static int pmu_aliases(const char *name, struct list_head *head)
330 const char *sysfs = sysfs__mountpoint();
335 snprintf(path, PATH_MAX,
336 "%s/bus/event_source/devices/%s/events", sysfs, name);
338 if (stat(path, &st) < 0)
339 return 0; /* no error if 'events' does not exist */
341 if (pmu_aliases_parse(path, head))
347 static int pmu_alias_terms(struct perf_pmu_alias *alias,
348 struct list_head *terms)
350 struct parse_events_term *term, *cloned;
354 list_for_each_entry(term, &alias->terms, list) {
355 ret = parse_events_term__clone(&cloned, term);
357 parse_events__free_terms(&list);
360 list_add_tail(&cloned->list, &list);
362 list_splice(&list, terms);
367 * Reading/parsing the default pmu type value, which should be
369 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
371 static int pmu_type(const char *name, __u32 *type)
377 const char *sysfs = sysfs__mountpoint();
382 snprintf(path, PATH_MAX,
383 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
385 if (stat(path, &st) < 0)
388 file = fopen(path, "r");
392 if (1 != fscanf(file, "%u", type))
399 /* Add all pmus in sysfs to pmu list: */
400 static void pmu_read_sysfs(void)
405 const char *sysfs = sysfs__mountpoint();
410 snprintf(path, PATH_MAX,
411 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
417 while ((dent = readdir(dir))) {
418 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
420 /* add to static LIST_HEAD(pmus): */
421 perf_pmu__find(dent->d_name);
427 static struct cpu_map *pmu_cpumask(const char *name)
432 struct cpu_map *cpus;
433 const char *sysfs = sysfs__mountpoint();
438 snprintf(path, PATH_MAX,
439 "%s/bus/event_source/devices/%s/cpumask", sysfs, name);
441 if (stat(path, &st) < 0)
444 file = fopen(path, "r");
448 cpus = cpu_map__read(file);
453 struct perf_event_attr * __weak
454 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
459 static struct perf_pmu *pmu_lookup(const char *name)
461 struct perf_pmu *pmu;
467 * The pmu data we store & need consists of the pmu
468 * type value and format definitions. Load both right
471 if (pmu_format(name, &format))
474 if (pmu_aliases(name, &aliases))
477 if (pmu_type(name, &type))
480 pmu = zalloc(sizeof(*pmu));
484 pmu->cpus = pmu_cpumask(name);
486 INIT_LIST_HEAD(&pmu->format);
487 INIT_LIST_HEAD(&pmu->aliases);
488 list_splice(&format, &pmu->format);
489 list_splice(&aliases, &pmu->aliases);
490 pmu->name = strdup(name);
492 list_add_tail(&pmu->list, &pmus);
494 pmu->default_config = perf_pmu__get_default_config(pmu);
499 static struct perf_pmu *pmu_find(const char *name)
501 struct perf_pmu *pmu;
503 list_for_each_entry(pmu, &pmus, list)
504 if (!strcmp(pmu->name, name))
510 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
513 * pmu iterator: If pmu is NULL, we start at the begin,
514 * otherwise return the next pmu. Returns NULL on end.
518 pmu = list_prepare_entry(pmu, &pmus, list);
520 list_for_each_entry_continue(pmu, &pmus, list)
525 struct perf_pmu *perf_pmu__find(const char *name)
527 struct perf_pmu *pmu;
530 * Once PMU is loaded it stays in the list,
531 * so we keep us from multiple reading/parsing
532 * the pmu format definitions.
534 pmu = pmu_find(name);
538 return pmu_lookup(name);
541 static struct perf_pmu_format *
542 pmu_find_format(struct list_head *formats, const char *name)
544 struct perf_pmu_format *format;
546 list_for_each_entry(format, formats, list)
547 if (!strcmp(format->name, name))
553 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
555 struct perf_pmu_format *format = pmu_find_format(formats, name);
562 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
563 bits |= 1ULL << fbit;
569 * Sets value based on the format definition (format parameter)
570 * and unformated value (value parameter).
572 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
575 unsigned long fbit, vbit;
577 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
579 if (!test_bit(fbit, format))
582 if (value & (1llu << vbit++))
583 *v |= (1llu << fbit);
585 *v &= ~(1llu << fbit);
589 static __u64 pmu_format_max_value(const unsigned long *format)
593 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
597 return (1ULL << w) - 1;
602 * Term is a string term, and might be a param-term. Try to look up it's value
603 * in the remaining terms.
604 * - We have a term like "base-or-format-term=param-term",
605 * - We need to find the value supplied for "param-term" (with param-term named
606 * in a config string) later on in the term list.
608 static int pmu_resolve_param_term(struct parse_events_term *term,
609 struct list_head *head_terms,
612 struct parse_events_term *t;
614 list_for_each_entry(t, head_terms, list) {
615 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
616 if (!strcmp(t->config, term->config)) {
625 printf("Required parameter '%s' not specified\n", term->config);
630 static char *pmu_formats_string(struct list_head *formats)
632 struct perf_pmu_format *format;
640 strbuf_init(&buf, 0);
641 /* sysfs exported terms */
642 list_for_each_entry(format, formats, list)
643 strbuf_addf(&buf, i++ ? ",%s" : "%s",
646 str = strbuf_detach(&buf, NULL);
647 strbuf_release(&buf);
653 * Setup one of config[12] attr members based on the
654 * user input data - term parameter.
656 static int pmu_config_term(struct list_head *formats,
657 struct perf_event_attr *attr,
658 struct parse_events_term *term,
659 struct list_head *head_terms,
660 bool zero, struct parse_events_error *err)
662 struct perf_pmu_format *format;
667 * If this is a parameter we've already used for parameterized-eval,
668 * skip it in normal eval.
674 * Hardcoded terms should be already in, so nothing
675 * to be done for them.
677 if (parse_events__is_hardcoded_term(term))
680 format = pmu_find_format(formats, term->config);
683 printf("Invalid event/parameter '%s'\n", term->config);
685 char *pmu_term = pmu_formats_string(formats);
687 err->idx = term->err_term;
688 err->str = strdup("unknown term");
689 err->help = parse_events_formats_error_string(pmu_term);
695 switch (format->value) {
696 case PERF_PMU_FORMAT_VALUE_CONFIG:
699 case PERF_PMU_FORMAT_VALUE_CONFIG1:
702 case PERF_PMU_FORMAT_VALUE_CONFIG2:
710 * Either directly use a numeric term, or try to translate string terms
711 * using event parameters.
713 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
715 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
716 if (strcmp(term->val.str, "?")) {
718 pr_info("Invalid sysfs entry %s=%s\n",
719 term->config, term->val.str);
722 err->idx = term->err_val;
723 err->str = strdup("expected numeric value");
728 if (pmu_resolve_param_term(term, head_terms, &val))
733 max_val = pmu_format_max_value(format->bits);
736 err->idx = term->err_val;
737 if (asprintf(&err->str,
738 "value too big for format, maximum is %llu",
739 (unsigned long long)max_val) < 0)
740 err->str = strdup("value too big for format");
744 * Assume we don't care if !err, in which case the value will be
745 * silently truncated.
749 pmu_format_value(format->bits, val, vp, zero);
753 int perf_pmu__config_terms(struct list_head *formats,
754 struct perf_event_attr *attr,
755 struct list_head *head_terms,
756 bool zero, struct parse_events_error *err)
758 struct parse_events_term *term;
760 list_for_each_entry(term, head_terms, list) {
761 if (pmu_config_term(formats, attr, term, head_terms,
770 * Configures event's 'attr' parameter based on the:
771 * 1) users input - specified in terms parameter
772 * 2) pmu format definitions - specified by pmu parameter
774 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
775 struct list_head *head_terms,
776 struct parse_events_error *err)
778 bool zero = !!pmu->default_config;
780 attr->type = pmu->type;
781 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
785 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
786 struct parse_events_term *term)
788 struct perf_pmu_alias *alias;
791 if (parse_events__is_hardcoded_term(term))
794 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
795 if (term->val.num != 1)
797 if (pmu_find_format(&pmu->format, term->config))
800 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
801 if (strcasecmp(term->config, "event"))
803 name = term->val.str;
808 list_for_each_entry(alias, &pmu->aliases, list) {
809 if (!strcasecmp(alias->name, name))
816 static int check_info_data(struct perf_pmu_alias *alias,
817 struct perf_pmu_info *info)
820 * Only one term in event definition can
821 * define unit, scale and snapshot, fail
822 * if there's more than one.
824 if ((info->unit && alias->unit) ||
825 (info->scale && alias->scale) ||
826 (info->snapshot && alias->snapshot))
830 info->unit = alias->unit;
833 info->scale = alias->scale;
836 info->snapshot = alias->snapshot;
842 * Find alias in the terms list and replace it with the terms
843 * defined for the alias
845 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
846 struct perf_pmu_info *info)
848 struct parse_events_term *term, *h;
849 struct perf_pmu_alias *alias;
852 info->per_pkg = false;
855 * Mark unit and scale as not set
856 * (different from default values, see below)
860 info->snapshot = false;
862 list_for_each_entry_safe(term, h, head_terms, list) {
863 alias = pmu_find_alias(pmu, term);
866 ret = pmu_alias_terms(alias, &term->list);
870 ret = check_info_data(alias, info);
875 info->per_pkg = true;
877 list_del(&term->list);
882 * if no unit or scale foundin aliases, then
883 * set defaults as for evsel
884 * unit cannot left to NULL
886 if (info->unit == NULL)
889 if (info->scale == 0.0)
895 int perf_pmu__new_format(struct list_head *list, char *name,
896 int config, unsigned long *bits)
898 struct perf_pmu_format *format;
900 format = zalloc(sizeof(*format));
904 format->name = strdup(name);
905 format->value = config;
906 memcpy(format->bits, bits, sizeof(format->bits));
908 list_add_tail(&format->list, list);
912 void perf_pmu__set_format(unsigned long *bits, long from, long to)
919 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
920 for (b = from; b <= to; b++)
924 static int sub_non_neg(int a, int b)
931 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
932 struct perf_pmu_alias *alias)
934 struct parse_events_term *term;
935 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
937 list_for_each_entry(term, &alias->terms, list) {
938 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
939 used += snprintf(buf + used, sub_non_neg(len, used),
940 ",%s=%s", term->config,
944 if (sub_non_neg(len, used) > 0) {
948 if (sub_non_neg(len, used) > 0) {
957 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
958 struct perf_pmu_alias *alias)
960 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
964 static int cmp_string(const void *a, const void *b)
966 const char * const *as = a;
967 const char * const *bs = b;
968 return strcmp(*as, *bs);
971 void print_pmu_events(const char *event_glob, bool name_only)
973 struct perf_pmu *pmu;
974 struct perf_pmu_alias *alias;
982 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
983 list_for_each_entry(alias, &pmu->aliases, list)
988 aliases = zalloc(sizeof(char *) * len);
993 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
994 list_for_each_entry(alias, &pmu->aliases, list) {
995 char *name = format_alias(buf, sizeof(buf), pmu, alias);
996 bool is_cpu = !strcmp(pmu->name, "cpu");
998 if (event_glob != NULL &&
999 !(strglobmatch(name, event_glob) ||
1000 (!is_cpu && strglobmatch(alias->name,
1004 if (is_cpu && !name_only)
1005 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1007 aliases[j] = strdup(name);
1008 if (aliases[j] == NULL)
1012 if (pmu->selectable &&
1013 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1015 if (asprintf(&s, "%s//", pmu->name) < 0)
1022 qsort(aliases, len, sizeof(char *), cmp_string);
1023 for (j = 0; j < len; j++) {
1025 printf("%s ", aliases[j]);
1028 printf(" %-50s [Kernel PMU event]\n", aliases[j]);
1031 if (printed && pager_in_use())
1034 for (j = 0; j < len; j++)
1040 printf("FATAL: not enough memory to print PMU events\n");
1045 bool pmu_have_event(const char *pname, const char *name)
1047 struct perf_pmu *pmu;
1048 struct perf_pmu_alias *alias;
1051 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1052 if (strcmp(pname, pmu->name))
1054 list_for_each_entry(alias, &pmu->aliases, list)
1055 if (!strcmp(alias->name, name))
1061 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1064 char path[PATH_MAX];
1067 sysfs = sysfs__mountpoint();
1071 snprintf(path, PATH_MAX,
1072 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1074 if (stat(path, &st) < 0)
1077 return fopen(path, "r");
1080 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1087 va_start(args, fmt);
1088 file = perf_pmu__open_file(pmu, name);
1090 ret = vfscanf(file, fmt, args);