1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/list.h>
3 #include <linux/compiler.h>
4 #include <linux/string.h>
5 #include <linux/zalloc.h>
6 #include <linux/ctype.h>
7 #include <subcmd/pager.h>
17 #include <api/fs/fs.h>
20 #include <perf/cpumap.h>
25 #include "parse-events.h"
30 #include "pmu-hybrid.h"
32 struct perf_pmu perf_pmu__fake;
34 struct perf_pmu_format {
37 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
38 struct list_head list;
41 int perf_pmu_parse(struct list_head *list, char *name);
42 extern FILE *perf_pmu_in;
44 static LIST_HEAD(pmus);
45 static bool hybrid_scanned;
48 * Parse & process all the sysfs attributes located under
49 * the directory specified in 'dir' parameter.
51 int perf_pmu__format_parse(char *dir, struct list_head *head)
53 struct dirent *evt_ent;
57 format_dir = opendir(dir);
61 while (!ret && (evt_ent = readdir(format_dir))) {
63 char *name = evt_ent->d_name;
66 if (!strcmp(name, ".") || !strcmp(name, ".."))
69 snprintf(path, PATH_MAX, "%s/%s", dir, name);
72 file = fopen(path, "r");
77 ret = perf_pmu_parse(head, name);
86 * Reading/parsing the default pmu format definition, which should be
88 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
90 static int pmu_format(const char *name, struct list_head *format)
93 const char *sysfs = sysfs__mountpoint();
98 snprintf(path, PATH_MAX,
99 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
101 if (!file_available(path))
104 if (perf_pmu__format_parse(path, format))
110 int perf_pmu__convert_scale(const char *scale, char **end, double *sval)
116 * save current locale
118 lc = setlocale(LC_NUMERIC, NULL);
121 * The lc string may be allocated in static storage,
122 * so get a dynamic copy to make it survive setlocale
132 * force to C locale to ensure kernel
133 * scale string is converted correctly.
134 * kernel uses default C locale.
136 setlocale(LC_NUMERIC, "C");
138 *sval = strtod(scale, end);
142 setlocale(LC_NUMERIC, lc);
147 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
155 scnprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
157 fd = open(path, O_RDONLY);
161 if (fstat(fd, &st) < 0)
164 sret = read(fd, scale, sizeof(scale)-1);
168 if (scale[sret - 1] == '\n')
169 scale[sret - 1] = '\0';
173 ret = perf_pmu__convert_scale(scale, NULL, &alias->scale);
179 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
185 scnprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
187 fd = open(path, O_RDONLY);
191 sret = read(fd, alias->unit, UNIT_MAX_LEN);
197 if (alias->unit[sret - 1] == '\n')
198 alias->unit[sret - 1] = '\0';
200 alias->unit[sret] = '\0';
205 alias->unit[0] = '\0';
210 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
215 scnprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
217 fd = open(path, O_RDONLY);
223 alias->per_pkg = true;
227 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
228 char *dir, char *name)
233 scnprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
235 fd = open(path, O_RDONLY);
239 alias->snapshot = true;
244 static void perf_pmu_assign_str(char *name, const char *field, char **old_str,
250 if (*new_str) { /* Have new string, check with old */
251 if (strcasecmp(*old_str, *new_str))
252 pr_debug("alias %s differs in field '%s'\n",
255 } else /* Nothing new --> keep old string */
262 static void perf_pmu_update_alias(struct perf_pmu_alias *old,
263 struct perf_pmu_alias *newalias)
265 perf_pmu_assign_str(old->name, "desc", &old->desc, &newalias->desc);
266 perf_pmu_assign_str(old->name, "long_desc", &old->long_desc,
267 &newalias->long_desc);
268 perf_pmu_assign_str(old->name, "topic", &old->topic, &newalias->topic);
269 perf_pmu_assign_str(old->name, "metric_expr", &old->metric_expr,
270 &newalias->metric_expr);
271 perf_pmu_assign_str(old->name, "metric_name", &old->metric_name,
272 &newalias->metric_name);
273 perf_pmu_assign_str(old->name, "value", &old->str, &newalias->str);
274 old->scale = newalias->scale;
275 old->per_pkg = newalias->per_pkg;
276 old->snapshot = newalias->snapshot;
277 memcpy(old->unit, newalias->unit, sizeof(old->unit));
280 /* Delete an alias entry. */
281 void perf_pmu_free_alias(struct perf_pmu_alias *newalias)
283 zfree(&newalias->name);
284 zfree(&newalias->desc);
285 zfree(&newalias->long_desc);
286 zfree(&newalias->topic);
287 zfree(&newalias->str);
288 zfree(&newalias->metric_expr);
289 zfree(&newalias->metric_name);
290 zfree(&newalias->pmu_name);
291 parse_events_terms__purge(&newalias->terms);
295 /* Merge an alias, search in alias list. If this name is already
296 * present merge both of them to combine all information.
298 static bool perf_pmu_merge_alias(struct perf_pmu_alias *newalias,
299 struct list_head *alist)
301 struct perf_pmu_alias *a;
303 list_for_each_entry(a, alist, list) {
304 if (!strcasecmp(newalias->name, a->name)) {
305 if (newalias->pmu_name && a->pmu_name &&
306 !strcasecmp(newalias->pmu_name, a->pmu_name)) {
309 perf_pmu_update_alias(a, newalias);
310 perf_pmu_free_alias(newalias);
317 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
318 char *desc, char *val, struct pmu_event *pe)
320 struct parse_events_term *term;
321 struct perf_pmu_alias *alias;
325 char *long_desc = NULL, *topic = NULL, *unit = NULL, *perpkg = NULL,
326 *metric_expr = NULL, *metric_name = NULL, *deprecated = NULL,
330 long_desc = (char *)pe->long_desc;
331 topic = (char *)pe->topic;
332 unit = (char *)pe->unit;
333 perpkg = (char *)pe->perpkg;
334 metric_expr = (char *)pe->metric_expr;
335 metric_name = (char *)pe->metric_name;
336 deprecated = (char *)pe->deprecated;
337 pmu_name = (char *)pe->pmu;
340 alias = malloc(sizeof(*alias));
344 INIT_LIST_HEAD(&alias->terms);
346 alias->unit[0] = '\0';
347 alias->per_pkg = false;
348 alias->snapshot = false;
349 alias->deprecated = false;
351 ret = parse_events_terms(&alias->terms, val);
353 pr_err("Cannot parse alias %s: %d\n", val, ret);
358 /* Scan event and remove leading zeroes, spaces, newlines, some
359 * platforms have terms specified as
360 * event=0x0091 (read from files ../<PMU>/events/<FILE>
361 * and terms specified as event=0x91 (read from JSON files).
363 * Rebuild string to make alias->str member comparable.
365 memset(newval, 0, sizeof(newval));
367 list_for_each_entry(term, &alias->terms, list) {
369 ret += scnprintf(newval + ret, sizeof(newval) - ret,
371 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
372 ret += scnprintf(newval + ret, sizeof(newval) - ret,
373 "%s=%#x", term->config, term->val.num);
374 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
375 ret += scnprintf(newval + ret, sizeof(newval) - ret,
376 "%s=%s", term->config, term->val.str);
379 alias->name = strdup(name);
382 * load unit name and scale if available
384 perf_pmu__parse_unit(alias, dir, name);
385 perf_pmu__parse_scale(alias, dir, name);
386 perf_pmu__parse_per_pkg(alias, dir, name);
387 perf_pmu__parse_snapshot(alias, dir, name);
390 alias->metric_expr = metric_expr ? strdup(metric_expr) : NULL;
391 alias->metric_name = metric_name ? strdup(metric_name): NULL;
392 alias->desc = desc ? strdup(desc) : NULL;
393 alias->long_desc = long_desc ? strdup(long_desc) :
394 desc ? strdup(desc) : NULL;
395 alias->topic = topic ? strdup(topic) : NULL;
397 if (perf_pmu__convert_scale(unit, &unit, &alias->scale) < 0)
399 snprintf(alias->unit, sizeof(alias->unit), "%s", unit);
401 alias->per_pkg = perpkg && sscanf(perpkg, "%d", &num) == 1 && num == 1;
402 alias->str = strdup(newval);
403 alias->pmu_name = pmu_name ? strdup(pmu_name) : NULL;
406 alias->deprecated = true;
408 if (!perf_pmu_merge_alias(alias, list))
409 list_add_tail(&alias->list, list);
414 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
419 ret = fread(buf, 1, sizeof(buf), file);
425 /* Remove trailing newline from sysfs file */
428 return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL);
431 static inline bool pmu_alias_info_file(char *name)
436 if (len > 5 && !strcmp(name + len - 5, ".unit"))
438 if (len > 6 && !strcmp(name + len - 6, ".scale"))
440 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
442 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
449 * Process all the sysfs attributes located under the directory
450 * specified in 'dir' parameter.
452 static int pmu_aliases_parse(char *dir, struct list_head *head)
454 struct dirent *evt_ent;
457 event_dir = opendir(dir);
461 while ((evt_ent = readdir(event_dir))) {
463 char *name = evt_ent->d_name;
466 if (!strcmp(name, ".") || !strcmp(name, ".."))
470 * skip info files parsed in perf_pmu__new_alias()
472 if (pmu_alias_info_file(name))
475 scnprintf(path, PATH_MAX, "%s/%s", dir, name);
477 file = fopen(path, "r");
479 pr_debug("Cannot open %s\n", path);
483 if (perf_pmu__new_alias(head, dir, name, file) < 0)
484 pr_debug("Cannot set up %s\n", name);
493 * Reading the pmu event aliases definition, which should be located at:
494 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
496 static int pmu_aliases(const char *name, struct list_head *head)
499 const char *sysfs = sysfs__mountpoint();
504 snprintf(path, PATH_MAX,
505 "%s/bus/event_source/devices/%s/events", sysfs, name);
507 if (!file_available(path))
510 if (pmu_aliases_parse(path, head))
516 static int pmu_alias_terms(struct perf_pmu_alias *alias,
517 struct list_head *terms)
519 struct parse_events_term *term, *cloned;
523 list_for_each_entry(term, &alias->terms, list) {
524 ret = parse_events_term__clone(&cloned, term);
526 parse_events_terms__purge(&list);
530 * Weak terms don't override command line options,
531 * which we don't want for implicit terms in aliases.
534 list_add_tail(&cloned->list, &list);
536 list_splice(&list, terms);
541 * Reading/parsing the default pmu type value, which should be
543 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
545 static int pmu_type(const char *name, __u32 *type)
550 const char *sysfs = sysfs__mountpoint();
555 snprintf(path, PATH_MAX,
556 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
558 if (access(path, R_OK) < 0)
561 file = fopen(path, "r");
565 if (1 != fscanf(file, "%u", type))
572 /* Add all pmus in sysfs to pmu list: */
573 static void pmu_read_sysfs(void)
578 const char *sysfs = sysfs__mountpoint();
583 snprintf(path, PATH_MAX,
584 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
590 while ((dent = readdir(dir))) {
591 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
593 /* add to static LIST_HEAD(pmus): */
594 perf_pmu__find(dent->d_name);
600 static struct perf_cpu_map *__pmu_cpumask(const char *path)
603 struct perf_cpu_map *cpus;
605 file = fopen(path, "r");
609 cpus = perf_cpu_map__read(file);
615 * Uncore PMUs have a "cpumask" file under sysfs. CPU PMUs (e.g. on arm/arm64)
616 * may have a "cpus" file.
618 #define SYS_TEMPLATE_ID "./bus/event_source/devices/%s/identifier"
619 #define CPUS_TEMPLATE_UNCORE "%s/bus/event_source/devices/%s/cpumask"
621 static struct perf_cpu_map *pmu_cpumask(const char *name)
624 struct perf_cpu_map *cpus;
625 const char *sysfs = sysfs__mountpoint();
626 const char *templates[] = {
627 CPUS_TEMPLATE_UNCORE,
631 const char **template;
636 for (template = templates; *template; template++) {
637 snprintf(path, PATH_MAX, *template, sysfs, name);
638 cpus = __pmu_cpumask(path);
646 static bool pmu_is_uncore(const char *name)
651 if (perf_pmu__hybrid_mounted(name))
654 sysfs = sysfs__mountpoint();
655 snprintf(path, PATH_MAX, CPUS_TEMPLATE_UNCORE, sysfs, name);
656 return file_available(path);
659 static char *pmu_id(const char *name)
661 char path[PATH_MAX], *str;
664 snprintf(path, PATH_MAX, SYS_TEMPLATE_ID, name);
666 if (sysfs__read_str(path, &str, &len) < 0)
669 str[len - 1] = 0; /* remove line feed */
675 * PMU CORE devices have different name other than cpu in sysfs on some
677 * Looking for possible sysfs files to identify the arm core device.
679 static int is_arm_pmu_core(const char *name)
682 const char *sysfs = sysfs__mountpoint();
687 /* Look for cpu sysfs (specific to arm) */
688 scnprintf(path, PATH_MAX, "%s/bus/event_source/devices/%s/cpus",
690 return file_available(path);
693 static char *perf_pmu__getcpuid(struct perf_pmu *pmu)
698 cpuid = getenv("PERF_CPUID");
700 cpuid = strdup(cpuid);
702 cpuid = get_cpuid_str(pmu);
707 pr_debug("Using CPUID %s\n", cpuid);
713 struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu)
715 struct pmu_events_map *map;
716 char *cpuid = perf_pmu__getcpuid(pmu);
719 /* on some platforms which uses cpus map, cpuid can be NULL for
720 * PMUs other than CORE PMUs.
727 map = &pmu_events_map[i++];
733 if (!strcmp_cpuid_str(map->cpuid, cpuid))
740 struct pmu_events_map *__weak pmu_events_map__find(void)
742 return perf_pmu__find_map(NULL);
745 static bool perf_pmu__valid_suffix(char *pmu_name, char *tok)
749 if (strncmp(pmu_name, tok, strlen(tok)))
752 p = pmu_name + strlen(tok);
760 if (*p == 0 || !isdigit(*p))
766 bool pmu_uncore_alias_match(const char *pmu_name, const char *name)
768 char *tmp = NULL, *tok, *str;
771 str = strdup(pmu_name);
776 * uncore alias may be from different PMU with common prefix
778 tok = strtok_r(str, ",", &tmp);
779 if (strncmp(pmu_name, tok, strlen(tok))) {
785 * Match more complex aliases where the alias name is a comma-delimited
786 * list of tokens, orderly contained in the matching PMU name.
788 * Example: For alias "socket,pmuname" and PMU "socketX_pmunameY", we
789 * match "socket" in "socketX_pmunameY" and then "pmuname" in
792 for (; tok; name += strlen(tok), tok = strtok_r(NULL, ",", &tmp)) {
793 name = strstr(name, tok);
794 if (!name || !perf_pmu__valid_suffix((char *)name, tok)) {
807 * From the pmu_events_map, find the table of PMU events that corresponds
808 * to the current running CPU. Then, add all PMU events from that table
811 void pmu_add_cpu_aliases_map(struct list_head *head, struct perf_pmu *pmu,
812 struct pmu_events_map *map)
815 const char *name = pmu->name;
817 * Found a matching PMU events table. Create aliases
821 const char *cpu_name = is_arm_pmu_core(name) ? name : "cpu";
822 struct pmu_event *pe = &map->table[i++];
823 const char *pname = pe->pmu ? pe->pmu : cpu_name;
826 if (pe->metric_group || pe->metric_name)
831 if (pmu_is_uncore(name) &&
832 pmu_uncore_alias_match(pname, name))
835 if (strcmp(pname, name))
839 /* need type casts to override 'const' */
840 __perf_pmu__new_alias(head, NULL, (char *)pe->name,
841 (char *)pe->desc, (char *)pe->event,
846 static void pmu_add_cpu_aliases(struct list_head *head, struct perf_pmu *pmu)
848 struct pmu_events_map *map;
850 map = perf_pmu__find_map(pmu);
854 pmu_add_cpu_aliases_map(head, pmu, map);
857 void pmu_for_each_sys_event(pmu_sys_event_iter_fn fn, void *data)
862 struct pmu_sys_events *event_table;
865 event_table = &pmu_sys_event_tables[i++];
867 if (!event_table->table)
871 struct pmu_event *pe = &event_table->table[j++];
874 if (!pe->name && !pe->metric_group && !pe->metric_name)
884 struct pmu_sys_event_iter_data {
885 struct list_head *head;
886 struct perf_pmu *pmu;
889 static int pmu_add_sys_aliases_iter_fn(struct pmu_event *pe, void *data)
891 struct pmu_sys_event_iter_data *idata = data;
892 struct perf_pmu *pmu = idata->pmu;
895 if (pe->metric_group || pe->metric_name)
900 if (!pe->compat || !pe->pmu)
903 if (!strcmp(pmu->id, pe->compat) &&
904 pmu_uncore_alias_match(pe->pmu, pmu->name)) {
905 __perf_pmu__new_alias(idata->head, NULL,
915 static void pmu_add_sys_aliases(struct list_head *head, struct perf_pmu *pmu)
917 struct pmu_sys_event_iter_data idata = {
925 pmu_for_each_sys_event(pmu_add_sys_aliases_iter_fn, &idata);
928 struct perf_event_attr * __weak
929 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
934 static int pmu_max_precise(const char *name)
937 int max_precise = -1;
939 scnprintf(path, PATH_MAX,
940 "bus/event_source/devices/%s/caps/max_precise",
943 sysfs__read_int(path, &max_precise);
947 static struct perf_pmu *pmu_lookup(const char *name)
949 struct perf_pmu *pmu;
955 * The pmu data we store & need consists of the pmu
956 * type value and format definitions. Load both right
959 if (pmu_format(name, &format))
963 * Check the type first to avoid unnecessary work.
965 if (pmu_type(name, &type))
968 if (pmu_aliases(name, &aliases))
971 pmu = zalloc(sizeof(*pmu));
975 pmu->cpus = pmu_cpumask(name);
976 pmu->name = strdup(name);
978 pmu->is_uncore = pmu_is_uncore(name);
980 pmu->id = pmu_id(name);
981 pmu->is_hybrid = perf_pmu__hybrid_mounted(name);
982 pmu->max_precise = pmu_max_precise(name);
983 pmu_add_cpu_aliases(&aliases, pmu);
984 pmu_add_sys_aliases(&aliases, pmu);
986 INIT_LIST_HEAD(&pmu->format);
987 INIT_LIST_HEAD(&pmu->aliases);
988 INIT_LIST_HEAD(&pmu->caps);
989 list_splice(&format, &pmu->format);
990 list_splice(&aliases, &pmu->aliases);
991 list_add_tail(&pmu->list, &pmus);
994 list_add_tail(&pmu->hybrid_list, &perf_pmu__hybrid_pmus);
996 pmu->default_config = perf_pmu__get_default_config(pmu);
1001 static struct perf_pmu *pmu_find(const char *name)
1003 struct perf_pmu *pmu;
1005 list_for_each_entry(pmu, &pmus, list)
1006 if (!strcmp(pmu->name, name))
1012 struct perf_pmu *perf_pmu__find_by_type(unsigned int type)
1014 struct perf_pmu *pmu;
1016 list_for_each_entry(pmu, &pmus, list)
1017 if (pmu->type == type)
1023 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
1026 * pmu iterator: If pmu is NULL, we start at the begin,
1027 * otherwise return the next pmu. Returns NULL on end.
1031 pmu = list_prepare_entry(pmu, &pmus, list);
1033 list_for_each_entry_continue(pmu, &pmus, list)
1038 struct perf_pmu *evsel__find_pmu(struct evsel *evsel)
1040 struct perf_pmu *pmu = NULL;
1042 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1043 if (pmu->type == evsel->core.attr.type)
1050 bool evsel__is_aux_event(struct evsel *evsel)
1052 struct perf_pmu *pmu = evsel__find_pmu(evsel);
1054 return pmu && pmu->auxtrace;
1057 struct perf_pmu *perf_pmu__find(const char *name)
1059 struct perf_pmu *pmu;
1062 * Once PMU is loaded it stays in the list,
1063 * so we keep us from multiple reading/parsing
1064 * the pmu format definitions.
1066 pmu = pmu_find(name);
1070 return pmu_lookup(name);
1073 static struct perf_pmu_format *
1074 pmu_find_format(struct list_head *formats, const char *name)
1076 struct perf_pmu_format *format;
1078 list_for_each_entry(format, formats, list)
1079 if (!strcmp(format->name, name))
1085 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
1087 struct perf_pmu_format *format = pmu_find_format(formats, name);
1094 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
1095 bits |= 1ULL << fbit;
1100 int perf_pmu__format_type(struct list_head *formats, const char *name)
1102 struct perf_pmu_format *format = pmu_find_format(formats, name);
1107 return format->value;
1111 * Sets value based on the format definition (format parameter)
1112 * and unformatted value (value parameter).
1114 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
1117 unsigned long fbit, vbit;
1119 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
1121 if (!test_bit(fbit, format))
1124 if (value & (1llu << vbit++))
1125 *v |= (1llu << fbit);
1127 *v &= ~(1llu << fbit);
1131 static __u64 pmu_format_max_value(const unsigned long *format)
1135 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
1139 return (1ULL << w) - 1;
1144 * Term is a string term, and might be a param-term. Try to look up it's value
1145 * in the remaining terms.
1146 * - We have a term like "base-or-format-term=param-term",
1147 * - We need to find the value supplied for "param-term" (with param-term named
1148 * in a config string) later on in the term list.
1150 static int pmu_resolve_param_term(struct parse_events_term *term,
1151 struct list_head *head_terms,
1154 struct parse_events_term *t;
1156 list_for_each_entry(t, head_terms, list) {
1157 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM &&
1158 t->config && !strcmp(t->config, term->config)) {
1160 *value = t->val.num;
1166 printf("Required parameter '%s' not specified\n", term->config);
1171 static char *pmu_formats_string(struct list_head *formats)
1173 struct perf_pmu_format *format;
1175 struct strbuf buf = STRBUF_INIT;
1181 /* sysfs exported terms */
1182 list_for_each_entry(format, formats, list)
1183 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1186 str = strbuf_detach(&buf, NULL);
1188 strbuf_release(&buf);
1194 * Setup one of config[12] attr members based on the
1195 * user input data - term parameter.
1197 static int pmu_config_term(const char *pmu_name,
1198 struct list_head *formats,
1199 struct perf_event_attr *attr,
1200 struct parse_events_term *term,
1201 struct list_head *head_terms,
1202 bool zero, struct parse_events_error *err)
1204 struct perf_pmu_format *format;
1209 * If this is a parameter we've already used for parameterized-eval,
1210 * skip it in normal eval.
1216 * Hardcoded terms should be already in, so nothing
1217 * to be done for them.
1219 if (parse_events__is_hardcoded_term(term))
1222 format = pmu_find_format(formats, term->config);
1224 char *pmu_term = pmu_formats_string(formats);
1228 if (asprintf(&unknown_term,
1229 "unknown term '%s' for pmu '%s'",
1230 term->config, pmu_name) < 0)
1231 unknown_term = NULL;
1232 help_msg = parse_events_formats_error_string(pmu_term);
1234 parse_events__handle_error(err, term->err_term,
1238 pr_debug("%s (%s)\n", unknown_term, help_msg);
1245 switch (format->value) {
1246 case PERF_PMU_FORMAT_VALUE_CONFIG:
1249 case PERF_PMU_FORMAT_VALUE_CONFIG1:
1250 vp = &attr->config1;
1252 case PERF_PMU_FORMAT_VALUE_CONFIG2:
1253 vp = &attr->config2;
1260 * Either directly use a numeric term, or try to translate string terms
1261 * using event parameters.
1263 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1264 if (term->no_value &&
1265 bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1267 parse_events__handle_error(err, term->err_val,
1268 strdup("no value assigned for term"),
1274 val = term->val.num;
1275 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1276 if (strcmp(term->val.str, "?")) {
1278 pr_info("Invalid sysfs entry %s=%s\n",
1279 term->config, term->val.str);
1282 parse_events__handle_error(err, term->err_val,
1283 strdup("expected numeric value"),
1289 if (pmu_resolve_param_term(term, head_terms, &val))
1294 max_val = pmu_format_max_value(format->bits);
1295 if (val > max_val) {
1299 parse_events__handle_error(err, term->err_val,
1301 "value too big for format, maximum is %llu",
1302 (unsigned long long)max_val) < 0
1303 ? strdup("value too big for format")
1309 * Assume we don't care if !err, in which case the value will be
1310 * silently truncated.
1314 pmu_format_value(format->bits, val, vp, zero);
1318 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
1319 struct perf_event_attr *attr,
1320 struct list_head *head_terms,
1321 bool zero, struct parse_events_error *err)
1323 struct parse_events_term *term;
1325 list_for_each_entry(term, head_terms, list) {
1326 if (pmu_config_term(pmu_name, formats, attr, term, head_terms,
1335 * Configures event's 'attr' parameter based on the:
1336 * 1) users input - specified in terms parameter
1337 * 2) pmu format definitions - specified by pmu parameter
1339 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1340 struct list_head *head_terms,
1341 struct parse_events_error *err)
1343 bool zero = !!pmu->default_config;
1345 attr->type = pmu->type;
1346 return perf_pmu__config_terms(pmu->name, &pmu->format, attr,
1347 head_terms, zero, err);
1350 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1351 struct parse_events_term *term)
1353 struct perf_pmu_alias *alias;
1356 if (parse_events__is_hardcoded_term(term))
1359 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1360 if (term->val.num != 1)
1362 if (pmu_find_format(&pmu->format, term->config))
1364 name = term->config;
1365 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1366 if (strcasecmp(term->config, "event"))
1368 name = term->val.str;
1373 list_for_each_entry(alias, &pmu->aliases, list) {
1374 if (!strcasecmp(alias->name, name))
1381 static int check_info_data(struct perf_pmu_alias *alias,
1382 struct perf_pmu_info *info)
1385 * Only one term in event definition can
1386 * define unit, scale and snapshot, fail
1387 * if there's more than one.
1389 if ((info->unit && alias->unit[0]) ||
1390 (info->scale && alias->scale) ||
1391 (info->snapshot && alias->snapshot))
1395 info->unit = alias->unit;
1398 info->scale = alias->scale;
1400 if (alias->snapshot)
1401 info->snapshot = alias->snapshot;
1407 * Find alias in the terms list and replace it with the terms
1408 * defined for the alias
1410 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1411 struct perf_pmu_info *info)
1413 struct parse_events_term *term, *h;
1414 struct perf_pmu_alias *alias;
1417 info->per_pkg = false;
1420 * Mark unit and scale as not set
1421 * (different from default values, see below)
1425 info->snapshot = false;
1426 info->metric_expr = NULL;
1427 info->metric_name = NULL;
1429 list_for_each_entry_safe(term, h, head_terms, list) {
1430 alias = pmu_find_alias(pmu, term);
1433 ret = pmu_alias_terms(alias, &term->list);
1437 ret = check_info_data(alias, info);
1442 info->per_pkg = true;
1443 info->metric_expr = alias->metric_expr;
1444 info->metric_name = alias->metric_name;
1446 list_del_init(&term->list);
1447 parse_events_term__delete(term);
1451 * if no unit or scale found in aliases, then
1452 * set defaults as for evsel
1453 * unit cannot left to NULL
1455 if (info->unit == NULL)
1458 if (info->scale == 0.0)
1464 int perf_pmu__new_format(struct list_head *list, char *name,
1465 int config, unsigned long *bits)
1467 struct perf_pmu_format *format;
1469 format = zalloc(sizeof(*format));
1473 format->name = strdup(name);
1474 format->value = config;
1475 memcpy(format->bits, bits, sizeof(format->bits));
1477 list_add_tail(&format->list, list);
1481 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1488 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1489 for (b = from; b <= to; b++)
1493 void perf_pmu__del_formats(struct list_head *formats)
1495 struct perf_pmu_format *fmt, *tmp;
1497 list_for_each_entry_safe(fmt, tmp, formats, list) {
1498 list_del(&fmt->list);
1504 static int sub_non_neg(int a, int b)
1511 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1512 struct perf_pmu_alias *alias)
1514 struct parse_events_term *term;
1515 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1517 list_for_each_entry(term, &alias->terms, list) {
1518 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1519 used += snprintf(buf + used, sub_non_neg(len, used),
1520 ",%s=%s", term->config,
1524 if (sub_non_neg(len, used) > 0) {
1528 if (sub_non_neg(len, used) > 0) {
1532 buf[len - 1] = '\0';
1537 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1538 struct perf_pmu_alias *alias)
1540 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1555 static int cmp_sevent(const void *a, const void *b)
1557 const struct sevent *as = a;
1558 const struct sevent *bs = b;
1560 /* Put extra events last */
1561 if (!!as->desc != !!bs->desc)
1562 return !!as->desc - !!bs->desc;
1563 if (as->topic && bs->topic) {
1564 int n = strcmp(as->topic, bs->topic);
1570 /* Order CPU core events to be first */
1571 if (as->is_cpu != bs->is_cpu)
1572 return bs->is_cpu - as->is_cpu;
1574 return strcmp(as->name, bs->name);
1577 static void wordwrap(char *s, int start, int max, int corr)
1583 int wlen = strcspn(s, " \t");
1585 if (column + wlen >= max && column > start) {
1586 printf("\n%*s", start, "");
1587 column = start + corr;
1589 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1598 bool is_pmu_core(const char *name)
1600 return !strcmp(name, "cpu") || is_arm_pmu_core(name);
1603 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1604 bool long_desc, bool details_flag, bool deprecated)
1606 struct perf_pmu *pmu;
1607 struct perf_pmu_alias *alias;
1611 struct sevent *aliases;
1613 int columns = pager_get_columns();
1618 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1619 list_for_each_entry(alias, &pmu->aliases, list)
1621 if (pmu->selectable)
1624 aliases = zalloc(sizeof(struct sevent) * len);
1629 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1630 list_for_each_entry(alias, &pmu->aliases, list) {
1631 char *name = alias->desc ? alias->name :
1632 format_alias(buf, sizeof(buf), pmu, alias);
1633 bool is_cpu = is_pmu_core(pmu->name);
1635 if (alias->deprecated && !deprecated)
1638 if (event_glob != NULL &&
1639 !(strglobmatch_nocase(name, event_glob) ||
1640 (!is_cpu && strglobmatch_nocase(alias->name,
1643 strglobmatch_nocase(alias->topic, event_glob))))
1646 if (is_cpu && !name_only && !alias->desc)
1647 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1649 aliases[j].name = name;
1650 if (is_cpu && !name_only && !alias->desc)
1651 aliases[j].name = format_alias_or(buf,
1654 aliases[j].name = strdup(aliases[j].name);
1655 if (!aliases[j].name)
1658 aliases[j].desc = long_desc ? alias->long_desc :
1660 aliases[j].topic = alias->topic;
1661 aliases[j].str = alias->str;
1662 aliases[j].pmu = pmu->name;
1663 aliases[j].metric_expr = alias->metric_expr;
1664 aliases[j].metric_name = alias->metric_name;
1665 aliases[j].is_cpu = is_cpu;
1668 if (pmu->selectable &&
1669 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1671 if (asprintf(&s, "%s//", pmu->name) < 0)
1673 aliases[j].name = s;
1678 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1679 for (j = 0; j < len; j++) {
1680 /* Skip duplicates */
1681 if (j > 0 && !strcmp(aliases[j].name, aliases[j - 1].name))
1684 printf("%s ", aliases[j].name);
1687 if (aliases[j].desc && !quiet_flag) {
1690 if (aliases[j].topic && (!topic ||
1691 strcmp(topic, aliases[j].topic))) {
1692 printf("%s%s:\n", topic ? "\n" : "",
1694 topic = aliases[j].topic;
1696 printf(" %-50s\n", aliases[j].name);
1697 printf("%*s", 8, "[");
1698 wordwrap(aliases[j].desc, 8, columns, 0);
1701 printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
1702 if (aliases[j].metric_name)
1703 printf(" MetricName: %s", aliases[j].metric_name);
1704 if (aliases[j].metric_expr)
1705 printf(" MetricExpr: %s", aliases[j].metric_expr);
1709 printf(" %-50s [Kernel PMU event]\n", aliases[j].name);
1712 if (printed && pager_in_use())
1715 for (j = 0; j < len; j++)
1716 zfree(&aliases[j].name);
1721 printf("FATAL: not enough memory to print PMU events\n");
1726 bool pmu_have_event(const char *pname, const char *name)
1728 struct perf_pmu *pmu;
1729 struct perf_pmu_alias *alias;
1732 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1733 if (strcmp(pname, pmu->name))
1735 list_for_each_entry(alias, &pmu->aliases, list)
1736 if (!strcmp(alias->name, name))
1742 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1744 char path[PATH_MAX];
1747 sysfs = sysfs__mountpoint();
1751 snprintf(path, PATH_MAX,
1752 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1753 if (!file_available(path))
1755 return fopen(path, "r");
1758 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1765 va_start(args, fmt);
1766 file = perf_pmu__open_file(pmu, name);
1768 ret = vfscanf(file, fmt, args);
1775 static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1777 struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1782 caps->name = strdup(name);
1785 caps->value = strndup(value, strlen(value) - 1);
1788 list_add_tail(&caps->list, list);
1800 * Reading/parsing the given pmu capabilities, which should be located at:
1801 * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1802 * Return the number of capabilities
1804 int perf_pmu__caps_parse(struct perf_pmu *pmu)
1807 char caps_path[PATH_MAX];
1808 const char *sysfs = sysfs__mountpoint();
1810 struct dirent *evt_ent;
1816 snprintf(caps_path, PATH_MAX,
1817 "%s" EVENT_SOURCE_DEVICE_PATH "%s/caps", sysfs, pmu->name);
1819 if (stat(caps_path, &st) < 0)
1820 return 0; /* no error if caps does not exist */
1822 caps_dir = opendir(caps_path);
1826 while ((evt_ent = readdir(caps_dir)) != NULL) {
1827 char path[PATH_MAX + NAME_MAX + 1];
1828 char *name = evt_ent->d_name;
1832 if (!strcmp(name, ".") || !strcmp(name, ".."))
1835 snprintf(path, sizeof(path), "%s/%s", caps_path, name);
1837 file = fopen(path, "r");
1841 if (!fgets(value, sizeof(value), file) ||
1842 (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1856 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
1859 struct perf_pmu_format *format;
1860 __u64 masks = 0, bits;
1864 list_for_each_entry(format, &pmu->format, list) {
1865 if (format->value != PERF_PMU_FORMAT_VALUE_CONFIG)
1868 for_each_set_bit(i, format->bits, PERF_PMU_FORMAT_BITS)
1873 * Kernel doesn't export any valid format bits.
1878 bits = config & ~masks;
1882 bitmap_scnprintf((unsigned long *)&bits, sizeof(bits) * 8, buf, sizeof(buf));
1884 pr_warning("WARNING: event '%s' not valid (bits %s of config "
1885 "'%llx' not supported by kernel)!\n",
1886 name ?: "N/A", buf, config);
1889 bool perf_pmu__has_hybrid(void)
1891 if (!hybrid_scanned) {
1892 hybrid_scanned = true;
1893 perf_pmu__scan(NULL);
1896 return !list_empty(&perf_pmu__hybrid_pmus);
1899 int perf_pmu__match(char *pattern, char *name, char *tok)
1901 if (fnmatch(pattern, name, 0))
1904 if (tok && !perf_pmu__valid_suffix(name, tok))