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, FILE *file)
211 struct perf_pmu_alias *alias;
215 ret = fread(buf, 1, sizeof(buf), file);
220 alias = malloc(sizeof(*alias));
224 INIT_LIST_HEAD(&alias->terms);
226 alias->unit[0] = '\0';
227 alias->per_pkg = false;
229 ret = parse_events_terms(&alias->terms, buf);
235 alias->name = strdup(name);
237 * load unit name and scale if available
239 perf_pmu__parse_unit(alias, dir, name);
240 perf_pmu__parse_scale(alias, dir, name);
241 perf_pmu__parse_per_pkg(alias, dir, name);
242 perf_pmu__parse_snapshot(alias, dir, name);
244 list_add_tail(&alias->list, list);
249 static inline bool pmu_alias_info_file(char *name)
254 if (len > 5 && !strcmp(name + len - 5, ".unit"))
256 if (len > 6 && !strcmp(name + len - 6, ".scale"))
258 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
260 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
267 * Process all the sysfs attributes located under the directory
268 * specified in 'dir' parameter.
270 static int pmu_aliases_parse(char *dir, struct list_head *head)
272 struct dirent *evt_ent;
276 event_dir = opendir(dir);
280 while (!ret && (evt_ent = readdir(event_dir))) {
282 char *name = evt_ent->d_name;
285 if (!strcmp(name, ".") || !strcmp(name, ".."))
289 * skip info files parsed in perf_pmu__new_alias()
291 if (pmu_alias_info_file(name))
294 snprintf(path, PATH_MAX, "%s/%s", dir, name);
297 file = fopen(path, "r");
301 ret = perf_pmu__new_alias(head, dir, name, file);
310 * Reading the pmu event aliases definition, which should be located at:
311 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
313 static int pmu_aliases(const char *name, struct list_head *head)
317 const char *sysfs = sysfs__mountpoint();
322 snprintf(path, PATH_MAX,
323 "%s/bus/event_source/devices/%s/events", sysfs, name);
325 if (stat(path, &st) < 0)
326 return 0; /* no error if 'events' does not exist */
328 if (pmu_aliases_parse(path, head))
334 static int pmu_alias_terms(struct perf_pmu_alias *alias,
335 struct list_head *terms)
337 struct parse_events_term *term, *cloned;
341 list_for_each_entry(term, &alias->terms, list) {
342 ret = parse_events_term__clone(&cloned, term);
344 parse_events__free_terms(&list);
347 list_add_tail(&cloned->list, &list);
349 list_splice(&list, terms);
354 * Reading/parsing the default pmu type value, which should be
356 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
358 static int pmu_type(const char *name, __u32 *type)
364 const char *sysfs = sysfs__mountpoint();
369 snprintf(path, PATH_MAX,
370 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
372 if (stat(path, &st) < 0)
375 file = fopen(path, "r");
379 if (1 != fscanf(file, "%u", type))
386 /* Add all pmus in sysfs to pmu list: */
387 static void pmu_read_sysfs(void)
392 const char *sysfs = sysfs__mountpoint();
397 snprintf(path, PATH_MAX,
398 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
404 while ((dent = readdir(dir))) {
405 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
407 /* add to static LIST_HEAD(pmus): */
408 perf_pmu__find(dent->d_name);
414 static struct cpu_map *pmu_cpumask(const char *name)
419 struct cpu_map *cpus;
420 const char *sysfs = sysfs__mountpoint();
425 snprintf(path, PATH_MAX,
426 "%s/bus/event_source/devices/%s/cpumask", sysfs, name);
428 if (stat(path, &st) < 0)
431 file = fopen(path, "r");
435 cpus = cpu_map__read(file);
440 struct perf_event_attr * __weak
441 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
446 static struct perf_pmu *pmu_lookup(const char *name)
448 struct perf_pmu *pmu;
453 /* No support for intel_bts or intel_pt so disallow them */
454 if (!strcmp(name, "intel_bts") || !strcmp(name, "intel_pt"))
458 * The pmu data we store & need consists of the pmu
459 * type value and format definitions. Load both right
462 if (pmu_format(name, &format))
465 if (pmu_aliases(name, &aliases))
468 if (pmu_type(name, &type))
471 pmu = zalloc(sizeof(*pmu));
475 pmu->cpus = pmu_cpumask(name);
477 INIT_LIST_HEAD(&pmu->format);
478 INIT_LIST_HEAD(&pmu->aliases);
479 list_splice(&format, &pmu->format);
480 list_splice(&aliases, &pmu->aliases);
481 pmu->name = strdup(name);
483 list_add_tail(&pmu->list, &pmus);
485 pmu->default_config = perf_pmu__get_default_config(pmu);
490 static struct perf_pmu *pmu_find(const char *name)
492 struct perf_pmu *pmu;
494 list_for_each_entry(pmu, &pmus, list)
495 if (!strcmp(pmu->name, name))
501 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
504 * pmu iterator: If pmu is NULL, we start at the begin,
505 * otherwise return the next pmu. Returns NULL on end.
509 pmu = list_prepare_entry(pmu, &pmus, list);
511 list_for_each_entry_continue(pmu, &pmus, list)
516 struct perf_pmu *perf_pmu__find(const char *name)
518 struct perf_pmu *pmu;
521 * Once PMU is loaded it stays in the list,
522 * so we keep us from multiple reading/parsing
523 * the pmu format definitions.
525 pmu = pmu_find(name);
529 return pmu_lookup(name);
532 static struct perf_pmu_format *
533 pmu_find_format(struct list_head *formats, char *name)
535 struct perf_pmu_format *format;
537 list_for_each_entry(format, formats, list)
538 if (!strcmp(format->name, name))
545 * Sets value based on the format definition (format parameter)
546 * and unformated value (value parameter).
548 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
551 unsigned long fbit, vbit;
553 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
555 if (!test_bit(fbit, format))
558 if (value & (1llu << vbit++))
559 *v |= (1llu << fbit);
561 *v &= ~(1llu << fbit);
566 * Term is a string term, and might be a param-term. Try to look up it's value
567 * in the remaining terms.
568 * - We have a term like "base-or-format-term=param-term",
569 * - We need to find the value supplied for "param-term" (with param-term named
570 * in a config string) later on in the term list.
572 static int pmu_resolve_param_term(struct parse_events_term *term,
573 struct list_head *head_terms,
576 struct parse_events_term *t;
578 list_for_each_entry(t, head_terms, list) {
579 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
580 if (!strcmp(t->config, term->config)) {
589 printf("Required parameter '%s' not specified\n", term->config);
594 static char *formats_error_string(struct list_head *formats)
596 struct perf_pmu_format *format;
598 static const char *static_terms = "config,config1,config2,name,period,branch_type\n";
601 if (!asprintf(&str, "valid terms:"))
604 /* sysfs exported terms */
605 list_for_each_entry(format, formats, list) {
606 char c = i++ ? ',' : ' ';
609 if (!asprintf(&str, "%s%c%s", err, c, format->name))
616 if (!asprintf(&str, "%s,%s", err, static_terms))
627 * Setup one of config[12] attr members based on the
628 * user input data - term parameter.
630 static int pmu_config_term(struct list_head *formats,
631 struct perf_event_attr *attr,
632 struct parse_events_term *term,
633 struct list_head *head_terms,
634 bool zero, struct parse_events_error *err)
636 struct perf_pmu_format *format;
641 * If this is a parameter we've already used for parameterized-eval,
642 * skip it in normal eval.
648 * Hardcoded terms should be already in, so nothing
649 * to be done for them.
651 if (parse_events__is_hardcoded_term(term))
654 format = pmu_find_format(formats, term->config);
657 printf("Invalid event/parameter '%s'\n", term->config);
659 err->idx = term->err_term;
660 err->str = strdup("unknown term");
661 err->help = formats_error_string(formats);
666 switch (format->value) {
667 case PERF_PMU_FORMAT_VALUE_CONFIG:
670 case PERF_PMU_FORMAT_VALUE_CONFIG1:
673 case PERF_PMU_FORMAT_VALUE_CONFIG2:
681 * Either directly use a numeric term, or try to translate string terms
682 * using event parameters.
684 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
686 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
687 if (strcmp(term->val.str, "?")) {
689 pr_info("Invalid sysfs entry %s=%s\n",
690 term->config, term->val.str);
693 err->idx = term->err_val;
694 err->str = strdup("expected numeric value");
699 if (pmu_resolve_param_term(term, head_terms, &val))
704 pmu_format_value(format->bits, val, vp, zero);
708 int perf_pmu__config_terms(struct list_head *formats,
709 struct perf_event_attr *attr,
710 struct list_head *head_terms,
711 bool zero, struct parse_events_error *err)
713 struct parse_events_term *term;
715 list_for_each_entry(term, head_terms, list) {
716 if (pmu_config_term(formats, attr, term, head_terms,
725 * Configures event's 'attr' parameter based on the:
726 * 1) users input - specified in terms parameter
727 * 2) pmu format definitions - specified by pmu parameter
729 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
730 struct list_head *head_terms,
731 struct parse_events_error *err)
733 bool zero = !!pmu->default_config;
735 attr->type = pmu->type;
736 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
740 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
741 struct parse_events_term *term)
743 struct perf_pmu_alias *alias;
746 if (parse_events__is_hardcoded_term(term))
749 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
750 if (term->val.num != 1)
752 if (pmu_find_format(&pmu->format, term->config))
755 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
756 if (strcasecmp(term->config, "event"))
758 name = term->val.str;
763 list_for_each_entry(alias, &pmu->aliases, list) {
764 if (!strcasecmp(alias->name, name))
771 static int check_info_data(struct perf_pmu_alias *alias,
772 struct perf_pmu_info *info)
775 * Only one term in event definition can
776 * define unit, scale and snapshot, fail
777 * if there's more than one.
779 if ((info->unit && alias->unit) ||
780 (info->scale && alias->scale) ||
781 (info->snapshot && alias->snapshot))
785 info->unit = alias->unit;
788 info->scale = alias->scale;
791 info->snapshot = alias->snapshot;
797 * Find alias in the terms list and replace it with the terms
798 * defined for the alias
800 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
801 struct perf_pmu_info *info)
803 struct parse_events_term *term, *h;
804 struct perf_pmu_alias *alias;
807 info->per_pkg = false;
810 * Mark unit and scale as not set
811 * (different from default values, see below)
815 info->snapshot = false;
817 list_for_each_entry_safe(term, h, head_terms, list) {
818 alias = pmu_find_alias(pmu, term);
821 ret = pmu_alias_terms(alias, &term->list);
825 ret = check_info_data(alias, info);
830 info->per_pkg = true;
832 list_del(&term->list);
837 * if no unit or scale foundin aliases, then
838 * set defaults as for evsel
839 * unit cannot left to NULL
841 if (info->unit == NULL)
844 if (info->scale == 0.0)
850 int perf_pmu__new_format(struct list_head *list, char *name,
851 int config, unsigned long *bits)
853 struct perf_pmu_format *format;
855 format = zalloc(sizeof(*format));
859 format->name = strdup(name);
860 format->value = config;
861 memcpy(format->bits, bits, sizeof(format->bits));
863 list_add_tail(&format->list, list);
867 void perf_pmu__set_format(unsigned long *bits, long from, long to)
874 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
875 for (b = from; b <= to; b++)
879 static int sub_non_neg(int a, int b)
886 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
887 struct perf_pmu_alias *alias)
889 struct parse_events_term *term;
890 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
892 list_for_each_entry(term, &alias->terms, list) {
893 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
894 used += snprintf(buf + used, sub_non_neg(len, used),
895 ",%s=%s", term->config,
899 if (sub_non_neg(len, used) > 0) {
903 if (sub_non_neg(len, used) > 0) {
912 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
913 struct perf_pmu_alias *alias)
915 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
919 static int cmp_string(const void *a, const void *b)
921 const char * const *as = a;
922 const char * const *bs = b;
923 return strcmp(*as, *bs);
926 void print_pmu_events(const char *event_glob, bool name_only)
928 struct perf_pmu *pmu;
929 struct perf_pmu_alias *alias;
937 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
938 list_for_each_entry(alias, &pmu->aliases, list)
943 aliases = zalloc(sizeof(char *) * len);
948 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
949 list_for_each_entry(alias, &pmu->aliases, list) {
950 char *name = format_alias(buf, sizeof(buf), pmu, alias);
951 bool is_cpu = !strcmp(pmu->name, "cpu");
953 if (event_glob != NULL &&
954 !(strglobmatch(name, event_glob) ||
955 (!is_cpu && strglobmatch(alias->name,
959 if (is_cpu && !name_only)
960 name = format_alias_or(buf, sizeof(buf), pmu, alias);
962 aliases[j] = strdup(name);
963 if (aliases[j] == NULL)
967 if (pmu->selectable) {
969 if (asprintf(&s, "%s//", pmu->name) < 0)
976 qsort(aliases, len, sizeof(char *), cmp_string);
977 for (j = 0; j < len; j++) {
979 printf("%s ", aliases[j]);
982 printf(" %-50s [Kernel PMU event]\n", aliases[j]);
988 for (j = 0; j < len; j++)
994 printf("FATAL: not enough memory to print PMU events\n");
999 bool pmu_have_event(const char *pname, const char *name)
1001 struct perf_pmu *pmu;
1002 struct perf_pmu_alias *alias;
1005 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1006 if (strcmp(pname, pmu->name))
1008 list_for_each_entry(alias, &pmu->aliases, list)
1009 if (!strcmp(alias->name, name))
1015 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1018 char path[PATH_MAX];
1021 sysfs = sysfs__mountpoint();
1025 snprintf(path, PATH_MAX,
1026 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1028 if (stat(path, &st) < 0)
1031 return fopen(path, "r");
1034 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1041 va_start(args, fmt);
1042 file = perf_pmu__open_file(pmu, name);
1044 ret = vfscanf(file, fmt, args);