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 perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
106 scnprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
108 fd = open(path, O_RDONLY);
112 if (fstat(fd, &st) < 0)
115 sret = read(fd, scale, sizeof(scale)-1);
119 if (scale[sret - 1] == '\n')
120 scale[sret - 1] = '\0';
125 * save current locale
127 lc = setlocale(LC_NUMERIC, NULL);
130 * The lc string may be allocated in static storage,
131 * so get a dynamic copy to make it survive setlocale
141 * force to C locale to ensure kernel
142 * scale string is converted correctly.
143 * kernel uses default C locale.
145 setlocale(LC_NUMERIC, "C");
147 alias->scale = strtod(scale, NULL);
150 setlocale(LC_NUMERIC, lc);
160 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
166 scnprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
168 fd = open(path, O_RDONLY);
172 sret = read(fd, alias->unit, UNIT_MAX_LEN);
178 if (alias->unit[sret - 1] == '\n')
179 alias->unit[sret - 1] = '\0';
181 alias->unit[sret] = '\0';
186 alias->unit[0] = '\0';
191 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
196 scnprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
198 fd = open(path, O_RDONLY);
204 alias->per_pkg = true;
208 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
209 char *dir, char *name)
214 scnprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
216 fd = open(path, O_RDONLY);
220 alias->snapshot = true;
225 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
226 char *desc, char *val, char *long_desc,
229 struct perf_pmu_alias *alias;
232 alias = malloc(sizeof(*alias));
236 INIT_LIST_HEAD(&alias->terms);
238 alias->unit[0] = '\0';
239 alias->per_pkg = false;
240 alias->snapshot = false;
242 ret = parse_events_terms(&alias->terms, val);
244 pr_err("Cannot parse alias %s: %d\n", val, ret);
249 alias->name = strdup(name);
252 * load unit name and scale if available
254 perf_pmu__parse_unit(alias, dir, name);
255 perf_pmu__parse_scale(alias, dir, name);
256 perf_pmu__parse_per_pkg(alias, dir, name);
257 perf_pmu__parse_snapshot(alias, dir, name);
260 alias->desc = desc ? strdup(desc) : NULL;
261 alias->long_desc = long_desc ? strdup(long_desc) :
262 desc ? strdup(desc) : NULL;
263 alias->topic = topic ? strdup(topic) : NULL;
265 list_add_tail(&alias->list, list);
270 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
275 ret = fread(buf, 1, sizeof(buf), file);
281 return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL, NULL);
284 static inline bool pmu_alias_info_file(char *name)
289 if (len > 5 && !strcmp(name + len - 5, ".unit"))
291 if (len > 6 && !strcmp(name + len - 6, ".scale"))
293 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
295 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
302 * Process all the sysfs attributes located under the directory
303 * specified in 'dir' parameter.
305 static int pmu_aliases_parse(char *dir, struct list_head *head)
307 struct dirent *evt_ent;
310 event_dir = opendir(dir);
314 while ((evt_ent = readdir(event_dir))) {
316 char *name = evt_ent->d_name;
319 if (!strcmp(name, ".") || !strcmp(name, ".."))
323 * skip info files parsed in perf_pmu__new_alias()
325 if (pmu_alias_info_file(name))
328 scnprintf(path, PATH_MAX, "%s/%s", dir, name);
330 file = fopen(path, "r");
332 pr_debug("Cannot open %s\n", path);
336 if (perf_pmu__new_alias(head, dir, name, file) < 0)
337 pr_debug("Cannot set up %s\n", name);
346 * Reading the pmu event aliases definition, which should be located at:
347 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
349 static int pmu_aliases(const char *name, struct list_head *head)
353 const char *sysfs = sysfs__mountpoint();
358 snprintf(path, PATH_MAX,
359 "%s/bus/event_source/devices/%s/events", sysfs, name);
361 if (stat(path, &st) < 0)
362 return 0; /* no error if 'events' does not exist */
364 if (pmu_aliases_parse(path, head))
370 static int pmu_alias_terms(struct perf_pmu_alias *alias,
371 struct list_head *terms)
373 struct parse_events_term *term, *cloned;
377 list_for_each_entry(term, &alias->terms, list) {
378 ret = parse_events_term__clone(&cloned, term);
380 parse_events_terms__purge(&list);
383 list_add_tail(&cloned->list, &list);
385 list_splice(&list, terms);
390 * Reading/parsing the default pmu type value, which should be
392 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
394 static int pmu_type(const char *name, __u32 *type)
400 const char *sysfs = sysfs__mountpoint();
405 snprintf(path, PATH_MAX,
406 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
408 if (stat(path, &st) < 0)
411 file = fopen(path, "r");
415 if (1 != fscanf(file, "%u", type))
422 /* Add all pmus in sysfs to pmu list: */
423 static void pmu_read_sysfs(void)
428 const char *sysfs = sysfs__mountpoint();
433 snprintf(path, PATH_MAX,
434 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
440 while ((dent = readdir(dir))) {
441 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
443 /* add to static LIST_HEAD(pmus): */
444 perf_pmu__find(dent->d_name);
450 static struct cpu_map *pmu_cpumask(const char *name)
455 struct cpu_map *cpus;
456 const char *sysfs = sysfs__mountpoint();
457 const char *templates[] = {
458 "%s/bus/event_source/devices/%s/cpumask",
459 "%s/bus/event_source/devices/%s/cpus",
462 const char **template;
467 for (template = templates; *template; template++) {
468 snprintf(path, PATH_MAX, *template, sysfs, name);
469 if (stat(path, &st) == 0)
476 file = fopen(path, "r");
480 cpus = cpu_map__read(file);
486 * Return the CPU id as a raw string.
488 * Each architecture should provide a more precise id string that
489 * can be use to match the architecture's "mapfile".
491 char * __weak get_cpuid_str(void)
497 * From the pmu_events_map, find the table of PMU events that corresponds
498 * to the current running CPU. Then, add all PMU events from that table
501 static void pmu_add_cpu_aliases(struct list_head *head)
504 struct pmu_events_map *map;
505 struct pmu_event *pe;
508 cpuid = getenv("PERF_CPUID");
510 cpuid = strdup(cpuid);
512 cpuid = get_cpuid_str();
516 pr_debug("Using CPUID %s\n", cpuid);
520 map = &pmu_events_map[i++];
524 if (!strcmp(map->cpuid, cpuid))
529 * Found a matching PMU events table. Create aliases
533 pe = &map->table[i++];
537 /* need type casts to override 'const' */
538 __perf_pmu__new_alias(head, NULL, (char *)pe->name,
539 (char *)pe->desc, (char *)pe->event,
540 (char *)pe->long_desc, (char *)pe->topic);
547 struct perf_event_attr * __weak
548 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
553 static struct perf_pmu *pmu_lookup(const char *name)
555 struct perf_pmu *pmu;
561 * The pmu data we store & need consists of the pmu
562 * type value and format definitions. Load both right
565 if (pmu_format(name, &format))
568 if (pmu_aliases(name, &aliases))
571 if (!strcmp(name, "cpu"))
572 pmu_add_cpu_aliases(&aliases);
574 if (pmu_type(name, &type))
577 pmu = zalloc(sizeof(*pmu));
581 pmu->cpus = pmu_cpumask(name);
583 INIT_LIST_HEAD(&pmu->format);
584 INIT_LIST_HEAD(&pmu->aliases);
585 list_splice(&format, &pmu->format);
586 list_splice(&aliases, &pmu->aliases);
587 pmu->name = strdup(name);
589 list_add_tail(&pmu->list, &pmus);
591 pmu->default_config = perf_pmu__get_default_config(pmu);
596 static struct perf_pmu *pmu_find(const char *name)
598 struct perf_pmu *pmu;
600 list_for_each_entry(pmu, &pmus, list)
601 if (!strcmp(pmu->name, name))
607 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
610 * pmu iterator: If pmu is NULL, we start at the begin,
611 * otherwise return the next pmu. Returns NULL on end.
615 pmu = list_prepare_entry(pmu, &pmus, list);
617 list_for_each_entry_continue(pmu, &pmus, list)
622 struct perf_pmu *perf_pmu__find(const char *name)
624 struct perf_pmu *pmu;
627 * Once PMU is loaded it stays in the list,
628 * so we keep us from multiple reading/parsing
629 * the pmu format definitions.
631 pmu = pmu_find(name);
635 return pmu_lookup(name);
638 static struct perf_pmu_format *
639 pmu_find_format(struct list_head *formats, const char *name)
641 struct perf_pmu_format *format;
643 list_for_each_entry(format, formats, list)
644 if (!strcmp(format->name, name))
650 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
652 struct perf_pmu_format *format = pmu_find_format(formats, name);
659 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
660 bits |= 1ULL << fbit;
666 * Sets value based on the format definition (format parameter)
667 * and unformated value (value parameter).
669 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
672 unsigned long fbit, vbit;
674 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
676 if (!test_bit(fbit, format))
679 if (value & (1llu << vbit++))
680 *v |= (1llu << fbit);
682 *v &= ~(1llu << fbit);
686 static __u64 pmu_format_max_value(const unsigned long *format)
690 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
694 return (1ULL << w) - 1;
699 * Term is a string term, and might be a param-term. Try to look up it's value
700 * in the remaining terms.
701 * - We have a term like "base-or-format-term=param-term",
702 * - We need to find the value supplied for "param-term" (with param-term named
703 * in a config string) later on in the term list.
705 static int pmu_resolve_param_term(struct parse_events_term *term,
706 struct list_head *head_terms,
709 struct parse_events_term *t;
711 list_for_each_entry(t, head_terms, list) {
712 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
713 if (!strcmp(t->config, term->config)) {
722 printf("Required parameter '%s' not specified\n", term->config);
727 static char *pmu_formats_string(struct list_head *formats)
729 struct perf_pmu_format *format;
731 struct strbuf buf = STRBUF_INIT;
737 /* sysfs exported terms */
738 list_for_each_entry(format, formats, list)
739 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
742 str = strbuf_detach(&buf, NULL);
744 strbuf_release(&buf);
750 * Setup one of config[12] attr members based on the
751 * user input data - term parameter.
753 static int pmu_config_term(struct list_head *formats,
754 struct perf_event_attr *attr,
755 struct parse_events_term *term,
756 struct list_head *head_terms,
757 bool zero, struct parse_events_error *err)
759 struct perf_pmu_format *format;
764 * If this is a parameter we've already used for parameterized-eval,
765 * skip it in normal eval.
771 * Hardcoded terms should be already in, so nothing
772 * to be done for them.
774 if (parse_events__is_hardcoded_term(term))
777 format = pmu_find_format(formats, term->config);
780 printf("Invalid event/parameter '%s'\n", term->config);
782 char *pmu_term = pmu_formats_string(formats);
784 err->idx = term->err_term;
785 err->str = strdup("unknown term");
786 err->help = parse_events_formats_error_string(pmu_term);
792 switch (format->value) {
793 case PERF_PMU_FORMAT_VALUE_CONFIG:
796 case PERF_PMU_FORMAT_VALUE_CONFIG1:
799 case PERF_PMU_FORMAT_VALUE_CONFIG2:
807 * Either directly use a numeric term, or try to translate string terms
808 * using event parameters.
810 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
812 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
813 if (strcmp(term->val.str, "?")) {
815 pr_info("Invalid sysfs entry %s=%s\n",
816 term->config, term->val.str);
819 err->idx = term->err_val;
820 err->str = strdup("expected numeric value");
825 if (pmu_resolve_param_term(term, head_terms, &val))
830 max_val = pmu_format_max_value(format->bits);
833 err->idx = term->err_val;
834 if (asprintf(&err->str,
835 "value too big for format, maximum is %llu",
836 (unsigned long long)max_val) < 0)
837 err->str = strdup("value too big for format");
841 * Assume we don't care if !err, in which case the value will be
842 * silently truncated.
846 pmu_format_value(format->bits, val, vp, zero);
850 int perf_pmu__config_terms(struct list_head *formats,
851 struct perf_event_attr *attr,
852 struct list_head *head_terms,
853 bool zero, struct parse_events_error *err)
855 struct parse_events_term *term;
857 list_for_each_entry(term, head_terms, list) {
858 if (pmu_config_term(formats, attr, term, head_terms,
867 * Configures event's 'attr' parameter based on the:
868 * 1) users input - specified in terms parameter
869 * 2) pmu format definitions - specified by pmu parameter
871 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
872 struct list_head *head_terms,
873 struct parse_events_error *err)
875 bool zero = !!pmu->default_config;
877 attr->type = pmu->type;
878 return perf_pmu__config_terms(&pmu->format, attr, head_terms,
882 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
883 struct parse_events_term *term)
885 struct perf_pmu_alias *alias;
888 if (parse_events__is_hardcoded_term(term))
891 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
892 if (term->val.num != 1)
894 if (pmu_find_format(&pmu->format, term->config))
897 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
898 if (strcasecmp(term->config, "event"))
900 name = term->val.str;
905 list_for_each_entry(alias, &pmu->aliases, list) {
906 if (!strcasecmp(alias->name, name))
913 static int check_info_data(struct perf_pmu_alias *alias,
914 struct perf_pmu_info *info)
917 * Only one term in event definition can
918 * define unit, scale and snapshot, fail
919 * if there's more than one.
921 if ((info->unit && alias->unit) ||
922 (info->scale && alias->scale) ||
923 (info->snapshot && alias->snapshot))
927 info->unit = alias->unit;
930 info->scale = alias->scale;
933 info->snapshot = alias->snapshot;
939 * Find alias in the terms list and replace it with the terms
940 * defined for the alias
942 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
943 struct perf_pmu_info *info)
945 struct parse_events_term *term, *h;
946 struct perf_pmu_alias *alias;
949 info->per_pkg = false;
952 * Mark unit and scale as not set
953 * (different from default values, see below)
957 info->snapshot = false;
959 list_for_each_entry_safe(term, h, head_terms, list) {
960 alias = pmu_find_alias(pmu, term);
963 ret = pmu_alias_terms(alias, &term->list);
967 ret = check_info_data(alias, info);
972 info->per_pkg = true;
974 list_del(&term->list);
979 * if no unit or scale foundin aliases, then
980 * set defaults as for evsel
981 * unit cannot left to NULL
983 if (info->unit == NULL)
986 if (info->scale == 0.0)
992 int perf_pmu__new_format(struct list_head *list, char *name,
993 int config, unsigned long *bits)
995 struct perf_pmu_format *format;
997 format = zalloc(sizeof(*format));
1001 format->name = strdup(name);
1002 format->value = config;
1003 memcpy(format->bits, bits, sizeof(format->bits));
1005 list_add_tail(&format->list, list);
1009 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1016 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1017 for (b = from; b <= to; b++)
1021 void perf_pmu__del_formats(struct list_head *formats)
1023 struct perf_pmu_format *fmt, *tmp;
1025 list_for_each_entry_safe(fmt, tmp, formats, list) {
1026 list_del(&fmt->list);
1032 static int sub_non_neg(int a, int b)
1039 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1040 struct perf_pmu_alias *alias)
1042 struct parse_events_term *term;
1043 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1045 list_for_each_entry(term, &alias->terms, list) {
1046 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1047 used += snprintf(buf + used, sub_non_neg(len, used),
1048 ",%s=%s", term->config,
1052 if (sub_non_neg(len, used) > 0) {
1056 if (sub_non_neg(len, used) > 0) {
1060 buf[len - 1] = '\0';
1065 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1066 struct perf_pmu_alias *alias)
1068 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1078 static int cmp_sevent(const void *a, const void *b)
1080 const struct sevent *as = a;
1081 const struct sevent *bs = b;
1083 /* Put extra events last */
1084 if (!!as->desc != !!bs->desc)
1085 return !!as->desc - !!bs->desc;
1086 if (as->topic && bs->topic) {
1087 int n = strcmp(as->topic, bs->topic);
1092 return strcmp(as->name, bs->name);
1095 static void wordwrap(char *s, int start, int max, int corr)
1101 int wlen = strcspn(s, " \t");
1103 if (column + wlen >= max && column > start) {
1104 printf("\n%*s", start, "");
1105 column = start + corr;
1107 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1117 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1120 struct perf_pmu *pmu;
1121 struct perf_pmu_alias *alias;
1125 struct sevent *aliases;
1127 int columns = pager_get_columns();
1132 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1133 list_for_each_entry(alias, &pmu->aliases, list)
1135 if (pmu->selectable)
1138 aliases = zalloc(sizeof(struct sevent) * len);
1143 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1144 list_for_each_entry(alias, &pmu->aliases, list) {
1145 char *name = alias->desc ? alias->name :
1146 format_alias(buf, sizeof(buf), pmu, alias);
1147 bool is_cpu = !strcmp(pmu->name, "cpu");
1149 if (event_glob != NULL &&
1150 !(strglobmatch(name, event_glob) ||
1151 (!is_cpu && strglobmatch(alias->name,
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);