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 * The lc string may be allocated in static storage,
128 * so get a dynamic copy to make it survive setlocale
138 * force to C locale to ensure kernel
139 * scale string is converted correctly.
140 * kernel uses default C locale.
142 setlocale(LC_NUMERIC, "C");
144 alias->scale = strtod(scale, NULL);
147 setlocale(LC_NUMERIC, lc);
157 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
163 snprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
165 fd = open(path, O_RDONLY);
169 sret = read(fd, alias->unit, UNIT_MAX_LEN);
175 if (alias->unit[sret - 1] == '\n')
176 alias->unit[sret - 1] = '\0';
178 alias->unit[sret] = '\0';
183 alias->unit[0] = '\0';
188 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
193 snprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
195 fd = open(path, O_RDONLY);
201 alias->per_pkg = true;
205 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
206 char *dir, char *name)
211 snprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
213 fd = open(path, O_RDONLY);
217 alias->snapshot = true;
222 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
223 char *desc __maybe_unused, char *val)
225 struct perf_pmu_alias *alias;
228 alias = malloc(sizeof(*alias));
232 INIT_LIST_HEAD(&alias->terms);
234 alias->unit[0] = '\0';
235 alias->per_pkg = false;
236 alias->snapshot = false;
238 ret = parse_events_terms(&alias->terms, val);
240 pr_err("Cannot parse alias %s: %d\n", val, ret);
245 alias->name = strdup(name);
248 * load unit name and scale if available
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);
256 list_add_tail(&alias->list, list);
261 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
266 ret = fread(buf, 1, sizeof(buf), file);
272 return __perf_pmu__new_alias(list, dir, name, NULL, buf);
275 static inline bool pmu_alias_info_file(char *name)
280 if (len > 5 && !strcmp(name + len - 5, ".unit"))
282 if (len > 6 && !strcmp(name + len - 6, ".scale"))
284 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
286 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
293 * Process all the sysfs attributes located under the directory
294 * specified in 'dir' parameter.
296 static int pmu_aliases_parse(char *dir, struct list_head *head)
298 struct dirent *evt_ent;
301 event_dir = opendir(dir);
305 while ((evt_ent = readdir(event_dir))) {
307 char *name = evt_ent->d_name;
310 if (!strcmp(name, ".") || !strcmp(name, ".."))
314 * skip info files parsed in perf_pmu__new_alias()
316 if (pmu_alias_info_file(name))
319 snprintf(path, PATH_MAX, "%s/%s", dir, name);
321 file = fopen(path, "r");
323 pr_debug("Cannot open %s\n", path);
327 if (perf_pmu__new_alias(head, dir, name, file) < 0)
328 pr_debug("Cannot set up %s\n", name);
337 * Reading the pmu event aliases definition, which should be located at:
338 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
340 static int pmu_aliases(const char *name, struct list_head *head)
344 const char *sysfs = sysfs__mountpoint();
349 snprintf(path, PATH_MAX,
350 "%s/bus/event_source/devices/%s/events", sysfs, name);
352 if (stat(path, &st) < 0)
353 return 0; /* no error if 'events' does not exist */
355 if (pmu_aliases_parse(path, head))
361 static int pmu_alias_terms(struct perf_pmu_alias *alias,
362 struct list_head *terms)
364 struct parse_events_term *term, *cloned;
368 list_for_each_entry(term, &alias->terms, list) {
369 ret = parse_events_term__clone(&cloned, term);
371 parse_events_terms__purge(&list);
374 list_add_tail(&cloned->list, &list);
376 list_splice(&list, terms);
381 * Reading/parsing the default pmu type value, which should be
383 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
385 static int pmu_type(const char *name, __u32 *type)
391 const char *sysfs = sysfs__mountpoint();
396 snprintf(path, PATH_MAX,
397 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
399 if (stat(path, &st) < 0)
402 file = fopen(path, "r");
406 if (1 != fscanf(file, "%u", type))
413 /* Add all pmus in sysfs to pmu list: */
414 static void pmu_read_sysfs(void)
419 const char *sysfs = sysfs__mountpoint();
424 snprintf(path, PATH_MAX,
425 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
431 while ((dent = readdir(dir))) {
432 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
434 /* add to static LIST_HEAD(pmus): */
435 perf_pmu__find(dent->d_name);
441 static struct cpu_map *pmu_cpumask(const char *name)
446 struct cpu_map *cpus;
447 const char *sysfs = sysfs__mountpoint();
448 const char *templates[] = {
449 "%s/bus/event_source/devices/%s/cpumask",
450 "%s/bus/event_source/devices/%s/cpus",
453 const char **template;
458 for (template = templates; *template; template++) {
459 snprintf(path, PATH_MAX, *template, sysfs, name);
460 if (stat(path, &st) == 0)
467 file = fopen(path, "r");
471 cpus = cpu_map__read(file);
476 struct perf_event_attr * __weak
477 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
482 static struct perf_pmu *pmu_lookup(const char *name)
484 struct perf_pmu *pmu;
490 * The pmu data we store & need consists of the pmu
491 * type value and format definitions. Load both right
494 if (pmu_format(name, &format))
497 if (pmu_aliases(name, &aliases))
500 if (pmu_type(name, &type))
503 pmu = zalloc(sizeof(*pmu));
507 pmu->cpus = pmu_cpumask(name);
509 INIT_LIST_HEAD(&pmu->format);
510 INIT_LIST_HEAD(&pmu->aliases);
511 list_splice(&format, &pmu->format);
512 list_splice(&aliases, &pmu->aliases);
513 pmu->name = strdup(name);
515 list_add_tail(&pmu->list, &pmus);
517 pmu->default_config = perf_pmu__get_default_config(pmu);
522 static struct perf_pmu *pmu_find(const char *name)
524 struct perf_pmu *pmu;
526 list_for_each_entry(pmu, &pmus, list)
527 if (!strcmp(pmu->name, name))
533 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
536 * pmu iterator: If pmu is NULL, we start at the begin,
537 * otherwise return the next pmu. Returns NULL on end.
541 pmu = list_prepare_entry(pmu, &pmus, list);
543 list_for_each_entry_continue(pmu, &pmus, list)
548 struct perf_pmu *perf_pmu__find(const char *name)
550 struct perf_pmu *pmu;
553 * Once PMU is loaded it stays in the list,
554 * so we keep us from multiple reading/parsing
555 * the pmu format definitions.
557 pmu = pmu_find(name);
561 return pmu_lookup(name);
564 static struct perf_pmu_format *
565 pmu_find_format(struct list_head *formats, const char *name)
567 struct perf_pmu_format *format;
569 list_for_each_entry(format, formats, list)
570 if (!strcmp(format->name, name))
576 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
578 struct perf_pmu_format *format = pmu_find_format(formats, name);
585 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
586 bits |= 1ULL << fbit;
592 * Sets value based on the format definition (format parameter)
593 * and unformated value (value parameter).
595 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
598 unsigned long fbit, vbit;
600 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
602 if (!test_bit(fbit, format))
605 if (value & (1llu << vbit++))
606 *v |= (1llu << fbit);
608 *v &= ~(1llu << fbit);
612 static __u64 pmu_format_max_value(const unsigned long *format)
617 for_each_set_bit(fbit, format, PERF_PMU_FORMAT_BITS)
624 * Term is a string term, and might be a param-term. Try to look up it's value
625 * in the remaining terms.
626 * - We have a term like "base-or-format-term=param-term",
627 * - We need to find the value supplied for "param-term" (with param-term named
628 * in a config string) later on in the term list.
630 static int pmu_resolve_param_term(struct parse_events_term *term,
631 struct list_head *head_terms,
634 struct parse_events_term *t;
636 list_for_each_entry(t, head_terms, list) {
637 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
638 if (!strcmp(t->config, term->config)) {
647 printf("Required parameter '%s' not specified\n", term->config);
652 static char *pmu_formats_string(struct list_head *formats)
654 struct perf_pmu_format *format;
656 struct strbuf buf = STRBUF_INIT;
662 /* sysfs exported terms */
663 list_for_each_entry(format, formats, list)
664 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
667 str = strbuf_detach(&buf, NULL);
669 strbuf_release(&buf);
675 * Setup one of config[12] attr members based on the
676 * user input data - term parameter.
678 static int pmu_config_term(struct list_head *formats,
679 struct perf_event_attr *attr,
680 struct parse_events_term *term,
681 struct list_head *head_terms,
682 bool zero, struct parse_events_error *err)
684 struct perf_pmu_format *format;
689 * If this is a parameter we've already used for parameterized-eval,
690 * skip it in normal eval.
696 * Hardcoded terms should be already in, so nothing
697 * to be done for them.
699 if (parse_events__is_hardcoded_term(term))
702 format = pmu_find_format(formats, term->config);
705 printf("Invalid event/parameter '%s'\n", term->config);
707 char *pmu_term = pmu_formats_string(formats);
709 err->idx = term->err_term;
710 err->str = strdup("unknown term");
711 err->help = parse_events_formats_error_string(pmu_term);
717 switch (format->value) {
718 case PERF_PMU_FORMAT_VALUE_CONFIG:
721 case PERF_PMU_FORMAT_VALUE_CONFIG1:
724 case PERF_PMU_FORMAT_VALUE_CONFIG2:
732 * Either directly use a numeric term, or try to translate string terms
733 * using event parameters.
735 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
737 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
738 if (strcmp(term->val.str, "?")) {
740 pr_info("Invalid sysfs entry %s=%s\n",
741 term->config, term->val.str);
744 err->idx = term->err_val;
745 err->str = strdup("expected numeric value");
750 if (pmu_resolve_param_term(term, head_terms, &val))
755 max_val = pmu_format_max_value(format->bits);
758 err->idx = term->err_val;
759 if (asprintf(&err->str,
760 "value too big for format, maximum is %llu",
761 (unsigned long long)max_val) < 0)
762 err->str = strdup("value too big for format");
766 * Assume we don't care if !err, in which case the value will be
767 * silently truncated.
771 pmu_format_value(format->bits, val, vp, zero);
775 int perf_pmu__config_terms(struct list_head *formats,
776 struct perf_event_attr *attr,
777 struct list_head *head_terms,
778 bool zero, struct parse_events_error *err)
780 struct parse_events_term *term;
782 list_for_each_entry(term, head_terms, list) {
783 if (pmu_config_term(formats, attr, term, head_terms,
792 * Configures event's 'attr' parameter based on the:
793 * 1) users input - specified in terms parameter
794 * 2) pmu format definitions - specified by pmu parameter
796 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
797 struct list_head *head_terms,
798 struct parse_events_error *err)
800 bool zero = !!pmu->default_config;
802 attr->type = pmu->type;
803 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
807 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
808 struct parse_events_term *term)
810 struct perf_pmu_alias *alias;
813 if (parse_events__is_hardcoded_term(term))
816 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
817 if (term->val.num != 1)
819 if (pmu_find_format(&pmu->format, term->config))
822 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
823 if (strcasecmp(term->config, "event"))
825 name = term->val.str;
830 list_for_each_entry(alias, &pmu->aliases, list) {
831 if (!strcasecmp(alias->name, name))
838 static int check_info_data(struct perf_pmu_alias *alias,
839 struct perf_pmu_info *info)
842 * Only one term in event definition can
843 * define unit, scale and snapshot, fail
844 * if there's more than one.
846 if ((info->unit && alias->unit) ||
847 (info->scale && alias->scale) ||
848 (info->snapshot && alias->snapshot))
852 info->unit = alias->unit;
855 info->scale = alias->scale;
858 info->snapshot = alias->snapshot;
864 * Find alias in the terms list and replace it with the terms
865 * defined for the alias
867 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
868 struct perf_pmu_info *info)
870 struct parse_events_term *term, *h;
871 struct perf_pmu_alias *alias;
874 info->per_pkg = false;
877 * Mark unit and scale as not set
878 * (different from default values, see below)
882 info->snapshot = false;
884 list_for_each_entry_safe(term, h, head_terms, list) {
885 alias = pmu_find_alias(pmu, term);
888 ret = pmu_alias_terms(alias, &term->list);
892 ret = check_info_data(alias, info);
897 info->per_pkg = true;
899 list_del(&term->list);
904 * if no unit or scale foundin aliases, then
905 * set defaults as for evsel
906 * unit cannot left to NULL
908 if (info->unit == NULL)
911 if (info->scale == 0.0)
917 int perf_pmu__new_format(struct list_head *list, char *name,
918 int config, unsigned long *bits)
920 struct perf_pmu_format *format;
922 format = zalloc(sizeof(*format));
926 format->name = strdup(name);
927 format->value = config;
928 memcpy(format->bits, bits, sizeof(format->bits));
930 list_add_tail(&format->list, list);
934 void perf_pmu__set_format(unsigned long *bits, long from, long to)
941 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
942 for (b = from; b <= to; b++)
946 static int sub_non_neg(int a, int b)
953 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
954 struct perf_pmu_alias *alias)
956 struct parse_events_term *term;
957 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
959 list_for_each_entry(term, &alias->terms, list) {
960 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
961 used += snprintf(buf + used, sub_non_neg(len, used),
962 ",%s=%s", term->config,
966 if (sub_non_neg(len, used) > 0) {
970 if (sub_non_neg(len, used) > 0) {
979 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
980 struct perf_pmu_alias *alias)
982 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
986 static int cmp_string(const void *a, const void *b)
988 const char * const *as = a;
989 const char * const *bs = b;
990 return strcmp(*as, *bs);
993 void print_pmu_events(const char *event_glob, bool name_only)
995 struct perf_pmu *pmu;
996 struct perf_pmu_alias *alias;
1004 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1005 list_for_each_entry(alias, &pmu->aliases, list)
1007 if (pmu->selectable)
1010 aliases = zalloc(sizeof(char *) * len);
1015 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1016 list_for_each_entry(alias, &pmu->aliases, list) {
1017 char *name = format_alias(buf, sizeof(buf), pmu, alias);
1018 bool is_cpu = !strcmp(pmu->name, "cpu");
1020 if (event_glob != NULL &&
1021 !(strglobmatch(name, event_glob) ||
1022 (!is_cpu && strglobmatch(alias->name,
1026 if (is_cpu && !name_only)
1027 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1029 aliases[j] = strdup(name);
1030 if (aliases[j] == NULL)
1034 if (pmu->selectable &&
1035 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1037 if (asprintf(&s, "%s//", pmu->name) < 0)
1044 qsort(aliases, len, sizeof(char *), cmp_string);
1045 for (j = 0; j < len; j++) {
1047 printf("%s ", aliases[j]);
1050 printf(" %-50s [Kernel PMU event]\n", aliases[j]);
1053 if (printed && pager_in_use())
1056 for (j = 0; j < len; j++)
1062 printf("FATAL: not enough memory to print PMU events\n");
1067 bool pmu_have_event(const char *pname, const char *name)
1069 struct perf_pmu *pmu;
1070 struct perf_pmu_alias *alias;
1073 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1074 if (strcmp(pname, pmu->name))
1076 list_for_each_entry(alias, &pmu->aliases, list)
1077 if (!strcmp(alias->name, name))
1083 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1086 char path[PATH_MAX];
1089 sysfs = sysfs__mountpoint();
1093 snprintf(path, PATH_MAX,
1094 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1096 if (stat(path, &st) < 0)
1099 return fopen(path, "r");
1102 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1109 va_start(args, fmt);
1110 file = perf_pmu__open_file(pmu, name);
1112 ret = vfscanf(file, fmt, args);