1 #include <linux/list.h>
12 #include "parse-events.h"
15 struct perf_pmu_format {
18 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
19 struct list_head list;
22 #define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"
24 int perf_pmu_parse(struct list_head *list, char *name);
25 extern FILE *perf_pmu_in;
27 static LIST_HEAD(pmus);
30 * Parse & process all the sysfs attributes located under
31 * the directory specified in 'dir' parameter.
33 int perf_pmu__format_parse(char *dir, struct list_head *head)
35 struct dirent *evt_ent;
39 format_dir = opendir(dir);
43 while (!ret && (evt_ent = readdir(format_dir))) {
45 char *name = evt_ent->d_name;
48 if (!strcmp(name, ".") || !strcmp(name, ".."))
51 snprintf(path, PATH_MAX, "%s/%s", dir, name);
54 file = fopen(path, "r");
59 ret = perf_pmu_parse(head, name);
68 * Reading/parsing the default pmu format definition, which should be
70 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
72 static int pmu_format(const char *name, struct list_head *format)
76 const char *sysfs = sysfs__mountpoint();
81 snprintf(path, PATH_MAX,
82 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
84 if (stat(path, &st) < 0)
85 return 0; /* no error if format does not exist */
87 if (perf_pmu__format_parse(path, format))
93 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
102 snprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
104 fd = open(path, O_RDONLY);
108 if (fstat(fd, &st) < 0)
111 sret = read(fd, scale, sizeof(scale)-1);
117 * save current locale
119 lc = setlocale(LC_NUMERIC, NULL);
122 * force to C locale to ensure kernel
123 * scale string is converted correctly.
124 * kernel uses default C locale.
126 setlocale(LC_NUMERIC, "C");
128 alias->scale = strtod(scale, NULL);
131 setlocale(LC_NUMERIC, lc);
139 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
145 snprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
147 fd = open(path, O_RDONLY);
151 sret = read(fd, alias->unit, UNIT_MAX_LEN);
157 alias->unit[sret] = '\0';
162 alias->unit[0] = '\0';
166 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
168 struct perf_pmu_alias *alias;
172 ret = fread(buf, 1, sizeof(buf), file);
177 alias = malloc(sizeof(*alias));
181 INIT_LIST_HEAD(&alias->terms);
183 alias->unit[0] = '\0';
185 ret = parse_events_terms(&alias->terms, buf);
191 alias->name = strdup(name);
193 * load unit name and scale if available
195 perf_pmu__parse_unit(alias, dir, name);
196 perf_pmu__parse_scale(alias, dir, name);
198 list_add_tail(&alias->list, list);
203 static inline bool pmu_alias_info_file(char *name)
208 if (len > 5 && !strcmp(name + len - 5, ".unit"))
210 if (len > 6 && !strcmp(name + len - 6, ".scale"))
217 * Process all the sysfs attributes located under the directory
218 * specified in 'dir' parameter.
220 static int pmu_aliases_parse(char *dir, struct list_head *head)
222 struct dirent *evt_ent;
226 event_dir = opendir(dir);
230 while (!ret && (evt_ent = readdir(event_dir))) {
232 char *name = evt_ent->d_name;
235 if (!strcmp(name, ".") || !strcmp(name, ".."))
239 * skip info files parsed in perf_pmu__new_alias()
241 if (pmu_alias_info_file(name))
244 snprintf(path, PATH_MAX, "%s/%s", dir, name);
247 file = fopen(path, "r");
251 ret = perf_pmu__new_alias(head, dir, name, file);
260 * Reading the pmu event aliases definition, which should be located at:
261 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
263 static int pmu_aliases(const char *name, struct list_head *head)
267 const char *sysfs = sysfs__mountpoint();
272 snprintf(path, PATH_MAX,
273 "%s/bus/event_source/devices/%s/events", sysfs, name);
275 if (stat(path, &st) < 0)
276 return 0; /* no error if 'events' does not exist */
278 if (pmu_aliases_parse(path, head))
284 static int pmu_alias_terms(struct perf_pmu_alias *alias,
285 struct list_head *terms)
287 struct parse_events_term *term, *cloned;
291 list_for_each_entry(term, &alias->terms, list) {
292 ret = parse_events_term__clone(&cloned, term);
294 parse_events__free_terms(&list);
297 list_add_tail(&cloned->list, &list);
299 list_splice(&list, terms);
304 * Reading/parsing the default pmu type value, which should be
306 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
308 static int pmu_type(const char *name, __u32 *type)
314 const char *sysfs = sysfs__mountpoint();
319 snprintf(path, PATH_MAX,
320 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
322 if (stat(path, &st) < 0)
325 file = fopen(path, "r");
329 if (1 != fscanf(file, "%u", type))
336 /* Add all pmus in sysfs to pmu list: */
337 static void pmu_read_sysfs(void)
342 const char *sysfs = sysfs__mountpoint();
347 snprintf(path, PATH_MAX,
348 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
354 while ((dent = readdir(dir))) {
355 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
357 /* add to static LIST_HEAD(pmus): */
358 perf_pmu__find(dent->d_name);
364 static struct cpu_map *pmu_cpumask(const char *name)
369 struct cpu_map *cpus;
370 const char *sysfs = sysfs__mountpoint();
375 snprintf(path, PATH_MAX,
376 "%s/bus/event_source/devices/%s/cpumask", sysfs, name);
378 if (stat(path, &st) < 0)
381 file = fopen(path, "r");
385 cpus = cpu_map__read(file);
390 struct perf_event_attr *__attribute__((weak))
391 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
396 static struct perf_pmu *pmu_lookup(const char *name)
398 struct perf_pmu *pmu;
404 * The pmu data we store & need consists of the pmu
405 * type value and format definitions. Load both right
408 if (pmu_format(name, &format))
411 if (pmu_aliases(name, &aliases))
414 if (pmu_type(name, &type))
417 pmu = zalloc(sizeof(*pmu));
421 pmu->cpus = pmu_cpumask(name);
423 INIT_LIST_HEAD(&pmu->format);
424 INIT_LIST_HEAD(&pmu->aliases);
425 list_splice(&format, &pmu->format);
426 list_splice(&aliases, &pmu->aliases);
427 pmu->name = strdup(name);
429 list_add_tail(&pmu->list, &pmus);
431 pmu->default_config = perf_pmu__get_default_config(pmu);
436 static struct perf_pmu *pmu_find(const char *name)
438 struct perf_pmu *pmu;
440 list_for_each_entry(pmu, &pmus, list)
441 if (!strcmp(pmu->name, name))
447 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
450 * pmu iterator: If pmu is NULL, we start at the begin,
451 * otherwise return the next pmu. Returns NULL on end.
455 pmu = list_prepare_entry(pmu, &pmus, list);
457 list_for_each_entry_continue(pmu, &pmus, list)
462 struct perf_pmu *perf_pmu__find(const char *name)
464 struct perf_pmu *pmu;
467 * Once PMU is loaded it stays in the list,
468 * so we keep us from multiple reading/parsing
469 * the pmu format definitions.
471 pmu = pmu_find(name);
475 return pmu_lookup(name);
478 static struct perf_pmu_format *
479 pmu_find_format(struct list_head *formats, char *name)
481 struct perf_pmu_format *format;
483 list_for_each_entry(format, formats, list)
484 if (!strcmp(format->name, name))
491 * Sets value based on the format definition (format parameter)
492 * and unformated value (value parameter).
494 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
497 unsigned long fbit, vbit;
499 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
501 if (!test_bit(fbit, format))
504 if (value & (1llu << vbit++))
505 *v |= (1llu << fbit);
507 *v &= ~(1llu << fbit);
512 * Setup one of config[12] attr members based on the
513 * user input data - term parameter.
515 static int pmu_config_term(struct list_head *formats,
516 struct perf_event_attr *attr,
517 struct parse_events_term *term,
520 struct perf_pmu_format *format;
524 * Support only for hardcoded and numnerial terms.
525 * Hardcoded terms should be already in, so nothing
526 * to be done for them.
528 if (parse_events__is_hardcoded_term(term))
531 if (term->type_val != PARSE_EVENTS__TERM_TYPE_NUM)
534 format = pmu_find_format(formats, term->config);
538 switch (format->value) {
539 case PERF_PMU_FORMAT_VALUE_CONFIG:
542 case PERF_PMU_FORMAT_VALUE_CONFIG1:
545 case PERF_PMU_FORMAT_VALUE_CONFIG2:
553 * XXX If we ever decide to go with string values for
554 * non-hardcoded terms, here's the place to translate
557 pmu_format_value(format->bits, term->val.num, vp, zero);
561 int perf_pmu__config_terms(struct list_head *formats,
562 struct perf_event_attr *attr,
563 struct list_head *head_terms,
566 struct parse_events_term *term;
568 list_for_each_entry(term, head_terms, list)
569 if (pmu_config_term(formats, attr, term, zero))
576 * Configures event's 'attr' parameter based on the:
577 * 1) users input - specified in terms parameter
578 * 2) pmu format definitions - specified by pmu parameter
580 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
581 struct list_head *head_terms)
583 bool zero = !!pmu->default_config;
585 attr->type = pmu->type;
586 return perf_pmu__config_terms(&pmu->format, attr, head_terms, zero);
589 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
590 struct parse_events_term *term)
592 struct perf_pmu_alias *alias;
595 if (parse_events__is_hardcoded_term(term))
598 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
599 if (term->val.num != 1)
601 if (pmu_find_format(&pmu->format, term->config))
604 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
605 if (strcasecmp(term->config, "event"))
607 name = term->val.str;
612 list_for_each_entry(alias, &pmu->aliases, list) {
613 if (!strcasecmp(alias->name, name))
620 static int check_unit_scale(struct perf_pmu_alias *alias,
621 const char **unit, double *scale)
624 * Only one term in event definition can
625 * define unit and scale, fail if there's
628 if ((*unit && alias->unit) ||
629 (*scale && alias->scale))
636 *scale = alias->scale;
642 * Find alias in the terms list and replace it with the terms
643 * defined for the alias
645 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
646 struct perf_pmu_info *info)
648 struct parse_events_term *term, *h;
649 struct perf_pmu_alias *alias;
653 * Mark unit and scale as not set
654 * (different from default values, see below)
659 list_for_each_entry_safe(term, h, head_terms, list) {
660 alias = pmu_find_alias(pmu, term);
663 ret = pmu_alias_terms(alias, &term->list);
667 ret = check_unit_scale(alias, &info->unit, &info->scale);
671 list_del(&term->list);
676 * if no unit or scale foundin aliases, then
677 * set defaults as for evsel
678 * unit cannot left to NULL
680 if (info->unit == NULL)
683 if (info->scale == 0.0)
689 int perf_pmu__new_format(struct list_head *list, char *name,
690 int config, unsigned long *bits)
692 struct perf_pmu_format *format;
694 format = zalloc(sizeof(*format));
698 format->name = strdup(name);
699 format->value = config;
700 memcpy(format->bits, bits, sizeof(format->bits));
702 list_add_tail(&format->list, list);
706 void perf_pmu__set_format(unsigned long *bits, long from, long to)
713 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
714 for (b = from; b <= to; b++)
718 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
719 struct perf_pmu_alias *alias)
721 snprintf(buf, len, "%s/%s/", pmu->name, alias->name);
725 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
726 struct perf_pmu_alias *alias)
728 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
732 static int cmp_string(const void *a, const void *b)
734 const char * const *as = a;
735 const char * const *bs = b;
736 return strcmp(*as, *bs);
739 void print_pmu_events(const char *event_glob, bool name_only)
741 struct perf_pmu *pmu;
742 struct perf_pmu_alias *alias;
750 while ((pmu = perf_pmu__scan(pmu)) != NULL)
751 list_for_each_entry(alias, &pmu->aliases, list)
753 aliases = malloc(sizeof(char *) * len);
758 while ((pmu = perf_pmu__scan(pmu)) != NULL)
759 list_for_each_entry(alias, &pmu->aliases, list) {
760 char *name = format_alias(buf, sizeof(buf), pmu, alias);
761 bool is_cpu = !strcmp(pmu->name, "cpu");
763 if (event_glob != NULL &&
764 !(strglobmatch(name, event_glob) ||
765 (!is_cpu && strglobmatch(alias->name,
769 if (is_cpu && !name_only)
770 aliases[j] = format_alias_or(buf, sizeof(buf),
772 aliases[j] = strdup(aliases[j]);
776 qsort(aliases, len, sizeof(char *), cmp_string);
777 for (j = 0; j < len; j++) {
779 printf("%s ", aliases[j]);
782 printf(" %-50s [Kernel PMU event]\n", aliases[j]);
791 bool pmu_have_event(const char *pname, const char *name)
793 struct perf_pmu *pmu;
794 struct perf_pmu_alias *alias;
797 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
798 if (strcmp(pname, pmu->name))
800 list_for_each_entry(alias, &pmu->aliases, list)
801 if (!strcmp(alias->name, name))
807 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
813 sysfs = sysfs__mountpoint();
817 snprintf(path, PATH_MAX,
818 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
820 if (stat(path, &st) < 0)
823 return fopen(path, "r");
826 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
834 file = perf_pmu__open_file(pmu, name);
836 ret = vfscanf(file, fmt, args);