1 #include <linux/list.h>
2 #include <linux/compiler.h>
13 #include "parse-events.h"
16 #include "pmu-events/pmu-events.h"
19 struct perf_pmu_format {
22 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
23 struct list_head list;
26 #define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"
28 int perf_pmu_parse(struct list_head *list, char *name);
29 extern FILE *perf_pmu_in;
31 static LIST_HEAD(pmus);
34 * Parse & process all the sysfs attributes located under
35 * the directory specified in 'dir' parameter.
37 int perf_pmu__format_parse(char *dir, struct list_head *head)
39 struct dirent *evt_ent;
43 format_dir = opendir(dir);
47 while (!ret && (evt_ent = readdir(format_dir))) {
49 char *name = evt_ent->d_name;
52 if (!strcmp(name, ".") || !strcmp(name, ".."))
55 snprintf(path, PATH_MAX, "%s/%s", dir, name);
58 file = fopen(path, "r");
63 ret = perf_pmu_parse(head, name);
72 * Reading/parsing the default pmu format definition, which should be
74 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
76 static int pmu_format(const char *name, struct list_head *format)
80 const char *sysfs = sysfs__mountpoint();
85 snprintf(path, PATH_MAX,
86 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
88 if (stat(path, &st) < 0)
89 return 0; /* no error if format does not exist */
91 if (perf_pmu__format_parse(path, format))
97 static int convert_scale(const char *scale, char **end, double *sval)
103 * save current locale
105 lc = setlocale(LC_NUMERIC, NULL);
108 * The lc string may be allocated in static storage,
109 * so get a dynamic copy to make it survive setlocale
119 * force to C locale to ensure kernel
120 * scale string is converted correctly.
121 * kernel uses default C locale.
123 setlocale(LC_NUMERIC, "C");
125 *sval = strtod(scale, end);
129 setlocale(LC_NUMERIC, lc);
134 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
142 snprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
144 fd = open(path, O_RDONLY);
148 if (fstat(fd, &st) < 0)
151 sret = read(fd, scale, sizeof(scale)-1);
155 if (scale[sret - 1] == '\n')
156 scale[sret - 1] = '\0';
160 ret = convert_scale(scale, NULL, &alias->scale);
166 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
172 snprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
174 fd = open(path, O_RDONLY);
178 sret = read(fd, alias->unit, UNIT_MAX_LEN);
184 if (alias->unit[sret - 1] == '\n')
185 alias->unit[sret - 1] = '\0';
187 alias->unit[sret] = '\0';
192 alias->unit[0] = '\0';
197 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
202 snprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
204 fd = open(path, O_RDONLY);
210 alias->per_pkg = true;
214 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
215 char *dir, char *name)
220 snprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
222 fd = open(path, O_RDONLY);
226 alias->snapshot = true;
231 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
232 char *desc, char *val, char *long_desc,
235 struct perf_pmu_alias *alias;
238 alias = malloc(sizeof(*alias));
242 INIT_LIST_HEAD(&alias->terms);
244 alias->unit[0] = '\0';
245 alias->per_pkg = false;
246 alias->snapshot = false;
248 ret = parse_events_terms(&alias->terms, val);
250 pr_err("Cannot parse alias %s: %d\n", val, ret);
255 alias->name = strdup(name);
258 * load unit name and scale if available
260 perf_pmu__parse_unit(alias, dir, name);
261 perf_pmu__parse_scale(alias, dir, name);
262 perf_pmu__parse_per_pkg(alias, dir, name);
263 perf_pmu__parse_snapshot(alias, dir, name);
266 alias->desc = desc ? strdup(desc) : NULL;
267 alias->long_desc = long_desc ? strdup(long_desc) :
268 desc ? strdup(desc) : NULL;
269 alias->topic = topic ? strdup(topic) : NULL;
271 list_add_tail(&alias->list, list);
276 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
281 ret = fread(buf, 1, sizeof(buf), file);
287 return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL, NULL);
290 static inline bool pmu_alias_info_file(char *name)
295 if (len > 5 && !strcmp(name + len - 5, ".unit"))
297 if (len > 6 && !strcmp(name + len - 6, ".scale"))
299 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
301 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
308 * Process all the sysfs attributes located under the directory
309 * specified in 'dir' parameter.
311 static int pmu_aliases_parse(char *dir, struct list_head *head)
313 struct dirent *evt_ent;
316 event_dir = opendir(dir);
320 while ((evt_ent = readdir(event_dir))) {
322 char *name = evt_ent->d_name;
325 if (!strcmp(name, ".") || !strcmp(name, ".."))
329 * skip info files parsed in perf_pmu__new_alias()
331 if (pmu_alias_info_file(name))
334 snprintf(path, PATH_MAX, "%s/%s", dir, name);
336 file = fopen(path, "r");
338 pr_debug("Cannot open %s\n", path);
342 if (perf_pmu__new_alias(head, dir, name, file) < 0)
343 pr_debug("Cannot set up %s\n", name);
352 * Reading the pmu event aliases definition, which should be located at:
353 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
355 static int pmu_aliases(const char *name, struct list_head *head)
359 const char *sysfs = sysfs__mountpoint();
364 snprintf(path, PATH_MAX,
365 "%s/bus/event_source/devices/%s/events", sysfs, name);
367 if (stat(path, &st) < 0)
368 return 0; /* no error if 'events' does not exist */
370 if (pmu_aliases_parse(path, head))
376 static int pmu_alias_terms(struct perf_pmu_alias *alias,
377 struct list_head *terms)
379 struct parse_events_term *term, *cloned;
383 list_for_each_entry(term, &alias->terms, list) {
384 ret = parse_events_term__clone(&cloned, term);
386 parse_events_terms__purge(&list);
389 list_add_tail(&cloned->list, &list);
391 list_splice(&list, terms);
396 * Reading/parsing the default pmu type value, which should be
398 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
400 static int pmu_type(const char *name, __u32 *type)
406 const char *sysfs = sysfs__mountpoint();
411 snprintf(path, PATH_MAX,
412 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
414 if (stat(path, &st) < 0)
417 file = fopen(path, "r");
421 if (1 != fscanf(file, "%u", type))
428 /* Add all pmus in sysfs to pmu list: */
429 static void pmu_read_sysfs(void)
434 const char *sysfs = sysfs__mountpoint();
439 snprintf(path, PATH_MAX,
440 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
446 while ((dent = readdir(dir))) {
447 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
449 /* add to static LIST_HEAD(pmus): */
450 perf_pmu__find(dent->d_name);
456 static struct cpu_map *pmu_cpumask(const char *name)
461 struct cpu_map *cpus;
462 const char *sysfs = sysfs__mountpoint();
463 const char *templates[] = {
464 "%s/bus/event_source/devices/%s/cpumask",
465 "%s/bus/event_source/devices/%s/cpus",
468 const char **template;
473 for (template = templates; *template; template++) {
474 snprintf(path, PATH_MAX, *template, sysfs, name);
475 if (stat(path, &st) == 0)
482 file = fopen(path, "r");
486 cpus = cpu_map__read(file);
492 * Return the CPU id as a raw string.
494 * Each architecture should provide a more precise id string that
495 * can be use to match the architecture's "mapfile".
497 char * __weak get_cpuid_str(void)
503 * From the pmu_events_map, find the table of PMU events that corresponds
504 * to the current running CPU. Then, add all PMU events from that table
507 static void pmu_add_cpu_aliases(struct list_head *head)
510 struct pmu_events_map *map;
511 struct pmu_event *pe;
515 cpuid = getenv("PERF_CPUID");
517 cpuid = strdup(cpuid);
519 cpuid = get_cpuid_str();
524 pr_debug("Using CPUID %s\n", cpuid);
530 map = &pmu_events_map[i++];
534 if (!strcmp(map->cpuid, cpuid))
539 * Found a matching PMU events table. Create aliases
543 pe = &map->table[i++];
547 /* need type casts to override 'const' */
548 __perf_pmu__new_alias(head, NULL, (char *)pe->name,
549 (char *)pe->desc, (char *)pe->event,
550 (char *)pe->long_desc, (char *)pe->topic);
557 struct perf_event_attr * __weak
558 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
563 static struct perf_pmu *pmu_lookup(const char *name)
565 struct perf_pmu *pmu;
571 * The pmu data we store & need consists of the pmu
572 * type value and format definitions. Load both right
575 if (pmu_format(name, &format))
578 if (pmu_aliases(name, &aliases))
581 if (!strcmp(name, "cpu"))
582 pmu_add_cpu_aliases(&aliases);
584 if (pmu_type(name, &type))
587 pmu = zalloc(sizeof(*pmu));
591 pmu->cpus = pmu_cpumask(name);
593 INIT_LIST_HEAD(&pmu->format);
594 INIT_LIST_HEAD(&pmu->aliases);
595 list_splice(&format, &pmu->format);
596 list_splice(&aliases, &pmu->aliases);
597 pmu->name = strdup(name);
599 list_add_tail(&pmu->list, &pmus);
601 pmu->default_config = perf_pmu__get_default_config(pmu);
606 static struct perf_pmu *pmu_find(const char *name)
608 struct perf_pmu *pmu;
610 list_for_each_entry(pmu, &pmus, list)
611 if (!strcmp(pmu->name, name))
617 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
620 * pmu iterator: If pmu is NULL, we start at the begin,
621 * otherwise return the next pmu. Returns NULL on end.
625 pmu = list_prepare_entry(pmu, &pmus, list);
627 list_for_each_entry_continue(pmu, &pmus, list)
632 struct perf_pmu *perf_pmu__find(const char *name)
634 struct perf_pmu *pmu;
637 * Once PMU is loaded it stays in the list,
638 * so we keep us from multiple reading/parsing
639 * the pmu format definitions.
641 pmu = pmu_find(name);
645 return pmu_lookup(name);
648 static struct perf_pmu_format *
649 pmu_find_format(struct list_head *formats, const char *name)
651 struct perf_pmu_format *format;
653 list_for_each_entry(format, formats, list)
654 if (!strcmp(format->name, name))
660 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
662 struct perf_pmu_format *format = pmu_find_format(formats, name);
669 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
670 bits |= 1ULL << fbit;
676 * Sets value based on the format definition (format parameter)
677 * and unformated value (value parameter).
679 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
682 unsigned long fbit, vbit;
684 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
686 if (!test_bit(fbit, format))
689 if (value & (1llu << vbit++))
690 *v |= (1llu << fbit);
692 *v &= ~(1llu << fbit);
696 static __u64 pmu_format_max_value(const unsigned long *format)
701 for_each_set_bit(fbit, format, PERF_PMU_FORMAT_BITS)
708 * Term is a string term, and might be a param-term. Try to look up it's value
709 * in the remaining terms.
710 * - We have a term like "base-or-format-term=param-term",
711 * - We need to find the value supplied for "param-term" (with param-term named
712 * in a config string) later on in the term list.
714 static int pmu_resolve_param_term(struct parse_events_term *term,
715 struct list_head *head_terms,
718 struct parse_events_term *t;
720 list_for_each_entry(t, head_terms, list) {
721 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
722 if (!strcmp(t->config, term->config)) {
731 printf("Required parameter '%s' not specified\n", term->config);
736 static char *pmu_formats_string(struct list_head *formats)
738 struct perf_pmu_format *format;
740 struct strbuf buf = STRBUF_INIT;
746 /* sysfs exported terms */
747 list_for_each_entry(format, formats, list)
748 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
751 str = strbuf_detach(&buf, NULL);
753 strbuf_release(&buf);
759 * Setup one of config[12] attr members based on the
760 * user input data - term parameter.
762 static int pmu_config_term(struct list_head *formats,
763 struct perf_event_attr *attr,
764 struct parse_events_term *term,
765 struct list_head *head_terms,
766 bool zero, struct parse_events_error *err)
768 struct perf_pmu_format *format;
773 * If this is a parameter we've already used for parameterized-eval,
774 * skip it in normal eval.
780 * Hardcoded terms should be already in, so nothing
781 * to be done for them.
783 if (parse_events__is_hardcoded_term(term))
786 format = pmu_find_format(formats, term->config);
789 printf("Invalid event/parameter '%s'\n", term->config);
791 char *pmu_term = pmu_formats_string(formats);
793 err->idx = term->err_term;
794 err->str = strdup("unknown term");
795 err->help = parse_events_formats_error_string(pmu_term);
801 switch (format->value) {
802 case PERF_PMU_FORMAT_VALUE_CONFIG:
805 case PERF_PMU_FORMAT_VALUE_CONFIG1:
808 case PERF_PMU_FORMAT_VALUE_CONFIG2:
816 * Either directly use a numeric term, or try to translate string terms
817 * using event parameters.
819 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
821 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
822 if (strcmp(term->val.str, "?")) {
824 pr_info("Invalid sysfs entry %s=%s\n",
825 term->config, term->val.str);
828 err->idx = term->err_val;
829 err->str = strdup("expected numeric value");
834 if (pmu_resolve_param_term(term, head_terms, &val))
839 max_val = pmu_format_max_value(format->bits);
842 err->idx = term->err_val;
843 if (asprintf(&err->str,
844 "value too big for format, maximum is %llu",
845 (unsigned long long)max_val) < 0)
846 err->str = strdup("value too big for format");
850 * Assume we don't care if !err, in which case the value will be
851 * silently truncated.
855 pmu_format_value(format->bits, val, vp, zero);
859 int perf_pmu__config_terms(struct list_head *formats,
860 struct perf_event_attr *attr,
861 struct list_head *head_terms,
862 bool zero, struct parse_events_error *err)
864 struct parse_events_term *term;
866 list_for_each_entry(term, head_terms, list) {
867 if (pmu_config_term(formats, attr, term, head_terms,
876 * Configures event's 'attr' parameter based on the:
877 * 1) users input - specified in terms parameter
878 * 2) pmu format definitions - specified by pmu parameter
880 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
881 struct list_head *head_terms,
882 struct parse_events_error *err)
884 bool zero = !!pmu->default_config;
886 attr->type = pmu->type;
887 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
891 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
892 struct parse_events_term *term)
894 struct perf_pmu_alias *alias;
897 if (parse_events__is_hardcoded_term(term))
900 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
901 if (term->val.num != 1)
903 if (pmu_find_format(&pmu->format, term->config))
906 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
907 if (strcasecmp(term->config, "event"))
909 name = term->val.str;
914 list_for_each_entry(alias, &pmu->aliases, list) {
915 if (!strcasecmp(alias->name, name))
922 static int check_info_data(struct perf_pmu_alias *alias,
923 struct perf_pmu_info *info)
926 * Only one term in event definition can
927 * define unit, scale and snapshot, fail
928 * if there's more than one.
930 if ((info->unit && alias->unit) ||
931 (info->scale && alias->scale) ||
932 (info->snapshot && alias->snapshot))
936 info->unit = alias->unit;
939 info->scale = alias->scale;
942 info->snapshot = alias->snapshot;
948 * Find alias in the terms list and replace it with the terms
949 * defined for the alias
951 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
952 struct perf_pmu_info *info)
954 struct parse_events_term *term, *h;
955 struct perf_pmu_alias *alias;
958 info->per_pkg = false;
961 * Mark unit and scale as not set
962 * (different from default values, see below)
966 info->snapshot = false;
968 list_for_each_entry_safe(term, h, head_terms, list) {
969 alias = pmu_find_alias(pmu, term);
972 ret = pmu_alias_terms(alias, &term->list);
976 ret = check_info_data(alias, info);
981 info->per_pkg = true;
983 list_del(&term->list);
988 * if no unit or scale foundin aliases, then
989 * set defaults as for evsel
990 * unit cannot left to NULL
992 if (info->unit == NULL)
995 if (info->scale == 0.0)
1001 int perf_pmu__new_format(struct list_head *list, char *name,
1002 int config, unsigned long *bits)
1004 struct perf_pmu_format *format;
1006 format = zalloc(sizeof(*format));
1010 format->name = strdup(name);
1011 format->value = config;
1012 memcpy(format->bits, bits, sizeof(format->bits));
1014 list_add_tail(&format->list, list);
1018 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1025 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1026 for (b = from; b <= to; b++)
1030 static int sub_non_neg(int a, int b)
1037 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1038 struct perf_pmu_alias *alias)
1040 struct parse_events_term *term;
1041 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1043 list_for_each_entry(term, &alias->terms, list) {
1044 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1045 used += snprintf(buf + used, sub_non_neg(len, used),
1046 ",%s=%s", term->config,
1050 if (sub_non_neg(len, used) > 0) {
1054 if (sub_non_neg(len, used) > 0) {
1058 buf[len - 1] = '\0';
1063 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1064 struct perf_pmu_alias *alias)
1066 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1076 static int cmp_sevent(const void *a, const void *b)
1078 const struct sevent *as = a;
1079 const struct sevent *bs = b;
1081 /* Put extra events last */
1082 if (!!as->desc != !!bs->desc)
1083 return !!as->desc - !!bs->desc;
1084 if (as->topic && bs->topic) {
1085 int n = strcmp(as->topic, bs->topic);
1090 return strcmp(as->name, bs->name);
1093 static void wordwrap(char *s, int start, int max, int corr)
1099 int wlen = strcspn(s, " \t");
1101 if (column + wlen >= max && column > start) {
1102 printf("\n%*s", start, "");
1103 column = start + corr;
1105 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1115 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1118 struct perf_pmu *pmu;
1119 struct perf_pmu_alias *alias;
1123 struct sevent *aliases;
1125 int columns = pager_get_columns();
1130 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1131 list_for_each_entry(alias, &pmu->aliases, list)
1133 if (pmu->selectable)
1136 aliases = zalloc(sizeof(struct sevent) * len);
1141 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1142 list_for_each_entry(alias, &pmu->aliases, list) {
1143 char *name = alias->desc ? alias->name :
1144 format_alias(buf, sizeof(buf), pmu, alias);
1145 bool is_cpu = !strcmp(pmu->name, "cpu");
1147 if (event_glob != NULL &&
1148 !(strglobmatch_nocase(name, event_glob) ||
1149 (!is_cpu && strglobmatch_nocase(alias->name,
1152 strglobmatch_nocase(alias->topic, event_glob))))
1155 if (is_cpu && !name_only && !alias->desc)
1156 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1158 aliases[j].name = name;
1159 if (is_cpu && !name_only && !alias->desc)
1160 aliases[j].name = format_alias_or(buf,
1163 aliases[j].name = strdup(aliases[j].name);
1164 if (!aliases[j].name)
1167 aliases[j].desc = long_desc ? alias->long_desc :
1169 aliases[j].topic = alias->topic;
1172 if (pmu->selectable &&
1173 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1175 if (asprintf(&s, "%s//", pmu->name) < 0)
1177 aliases[j].name = s;
1182 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1183 for (j = 0; j < len; j++) {
1185 printf("%s ", aliases[j].name);
1188 if (aliases[j].desc && !quiet_flag) {
1191 if (aliases[j].topic && (!topic ||
1192 strcmp(topic, aliases[j].topic))) {
1193 printf("%s%s:\n", topic ? "\n" : "",
1195 topic = aliases[j].topic;
1197 printf(" %-50s\n", aliases[j].name);
1198 printf("%*s", 8, "[");
1199 wordwrap(aliases[j].desc, 8, columns, 0);
1202 printf(" %-50s [Kernel PMU event]\n", aliases[j].name);
1205 if (printed && pager_in_use())
1208 for (j = 0; j < len; j++)
1209 zfree(&aliases[j].name);
1214 printf("FATAL: not enough memory to print PMU events\n");
1219 bool pmu_have_event(const char *pname, const char *name)
1221 struct perf_pmu *pmu;
1222 struct perf_pmu_alias *alias;
1225 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1226 if (strcmp(pname, pmu->name))
1228 list_for_each_entry(alias, &pmu->aliases, list)
1229 if (!strcmp(alias->name, name))
1235 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1238 char path[PATH_MAX];
1241 sysfs = sysfs__mountpoint();
1245 snprintf(path, PATH_MAX,
1246 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1248 if (stat(path, &st) < 0)
1251 return fopen(path, "r");
1254 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1261 va_start(args, fmt);
1262 file = perf_pmu__open_file(pmu, name);
1264 ret = vfscanf(file, fmt, args);