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;
953 bool is_hybrid = perf_pmu__hybrid_mounted(name);
956 * Check pmu name for hybrid and the pmu may be invalid in sysfs
958 if (!strncmp(name, "cpu_", 4) && !is_hybrid)
962 * The pmu data we store & need consists of the pmu
963 * type value and format definitions. Load both right
966 if (pmu_format(name, &format))
970 * Check the type first to avoid unnecessary work.
972 if (pmu_type(name, &type))
975 if (pmu_aliases(name, &aliases))
978 pmu = zalloc(sizeof(*pmu));
982 pmu->cpus = pmu_cpumask(name);
983 pmu->name = strdup(name);
985 pmu->is_uncore = pmu_is_uncore(name);
987 pmu->id = pmu_id(name);
988 pmu->is_hybrid = is_hybrid;
989 pmu->max_precise = pmu_max_precise(name);
990 pmu_add_cpu_aliases(&aliases, pmu);
991 pmu_add_sys_aliases(&aliases, pmu);
993 INIT_LIST_HEAD(&pmu->format);
994 INIT_LIST_HEAD(&pmu->aliases);
995 INIT_LIST_HEAD(&pmu->caps);
996 list_splice(&format, &pmu->format);
997 list_splice(&aliases, &pmu->aliases);
998 list_add_tail(&pmu->list, &pmus);
1001 list_add_tail(&pmu->hybrid_list, &perf_pmu__hybrid_pmus);
1003 pmu->default_config = perf_pmu__get_default_config(pmu);
1008 static struct perf_pmu *pmu_find(const char *name)
1010 struct perf_pmu *pmu;
1012 list_for_each_entry(pmu, &pmus, list)
1013 if (!strcmp(pmu->name, name))
1019 struct perf_pmu *perf_pmu__find_by_type(unsigned int type)
1021 struct perf_pmu *pmu;
1023 list_for_each_entry(pmu, &pmus, list)
1024 if (pmu->type == type)
1030 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
1033 * pmu iterator: If pmu is NULL, we start at the begin,
1034 * otherwise return the next pmu. Returns NULL on end.
1038 pmu = list_prepare_entry(pmu, &pmus, list);
1040 list_for_each_entry_continue(pmu, &pmus, list)
1045 struct perf_pmu *evsel__find_pmu(struct evsel *evsel)
1047 struct perf_pmu *pmu = NULL;
1049 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1050 if (pmu->type == evsel->core.attr.type)
1057 bool evsel__is_aux_event(struct evsel *evsel)
1059 struct perf_pmu *pmu = evsel__find_pmu(evsel);
1061 return pmu && pmu->auxtrace;
1064 struct perf_pmu *perf_pmu__find(const char *name)
1066 struct perf_pmu *pmu;
1069 * Once PMU is loaded it stays in the list,
1070 * so we keep us from multiple reading/parsing
1071 * the pmu format definitions.
1073 pmu = pmu_find(name);
1077 return pmu_lookup(name);
1080 static struct perf_pmu_format *
1081 pmu_find_format(struct list_head *formats, const char *name)
1083 struct perf_pmu_format *format;
1085 list_for_each_entry(format, formats, list)
1086 if (!strcmp(format->name, name))
1092 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
1094 struct perf_pmu_format *format = pmu_find_format(formats, name);
1101 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
1102 bits |= 1ULL << fbit;
1107 int perf_pmu__format_type(struct list_head *formats, const char *name)
1109 struct perf_pmu_format *format = pmu_find_format(formats, name);
1114 return format->value;
1118 * Sets value based on the format definition (format parameter)
1119 * and unformatted value (value parameter).
1121 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
1124 unsigned long fbit, vbit;
1126 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
1128 if (!test_bit(fbit, format))
1131 if (value & (1llu << vbit++))
1132 *v |= (1llu << fbit);
1134 *v &= ~(1llu << fbit);
1138 static __u64 pmu_format_max_value(const unsigned long *format)
1142 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
1146 return (1ULL << w) - 1;
1151 * Term is a string term, and might be a param-term. Try to look up it's value
1152 * in the remaining terms.
1153 * - We have a term like "base-or-format-term=param-term",
1154 * - We need to find the value supplied for "param-term" (with param-term named
1155 * in a config string) later on in the term list.
1157 static int pmu_resolve_param_term(struct parse_events_term *term,
1158 struct list_head *head_terms,
1161 struct parse_events_term *t;
1163 list_for_each_entry(t, head_terms, list) {
1164 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM &&
1165 t->config && !strcmp(t->config, term->config)) {
1167 *value = t->val.num;
1173 printf("Required parameter '%s' not specified\n", term->config);
1178 static char *pmu_formats_string(struct list_head *formats)
1180 struct perf_pmu_format *format;
1182 struct strbuf buf = STRBUF_INIT;
1188 /* sysfs exported terms */
1189 list_for_each_entry(format, formats, list)
1190 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1193 str = strbuf_detach(&buf, NULL);
1195 strbuf_release(&buf);
1201 * Setup one of config[12] attr members based on the
1202 * user input data - term parameter.
1204 static int pmu_config_term(const char *pmu_name,
1205 struct list_head *formats,
1206 struct perf_event_attr *attr,
1207 struct parse_events_term *term,
1208 struct list_head *head_terms,
1209 bool zero, struct parse_events_error *err)
1211 struct perf_pmu_format *format;
1216 * If this is a parameter we've already used for parameterized-eval,
1217 * skip it in normal eval.
1223 * Hardcoded terms should be already in, so nothing
1224 * to be done for them.
1226 if (parse_events__is_hardcoded_term(term))
1229 format = pmu_find_format(formats, term->config);
1231 char *pmu_term = pmu_formats_string(formats);
1235 if (asprintf(&unknown_term,
1236 "unknown term '%s' for pmu '%s'",
1237 term->config, pmu_name) < 0)
1238 unknown_term = NULL;
1239 help_msg = parse_events_formats_error_string(pmu_term);
1241 parse_events__handle_error(err, term->err_term,
1245 pr_debug("%s (%s)\n", unknown_term, help_msg);
1252 switch (format->value) {
1253 case PERF_PMU_FORMAT_VALUE_CONFIG:
1256 case PERF_PMU_FORMAT_VALUE_CONFIG1:
1257 vp = &attr->config1;
1259 case PERF_PMU_FORMAT_VALUE_CONFIG2:
1260 vp = &attr->config2;
1267 * Either directly use a numeric term, or try to translate string terms
1268 * using event parameters.
1270 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1271 if (term->no_value &&
1272 bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1274 parse_events__handle_error(err, term->err_val,
1275 strdup("no value assigned for term"),
1281 val = term->val.num;
1282 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1283 if (strcmp(term->val.str, "?")) {
1285 pr_info("Invalid sysfs entry %s=%s\n",
1286 term->config, term->val.str);
1289 parse_events__handle_error(err, term->err_val,
1290 strdup("expected numeric value"),
1296 if (pmu_resolve_param_term(term, head_terms, &val))
1301 max_val = pmu_format_max_value(format->bits);
1302 if (val > max_val) {
1306 parse_events__handle_error(err, term->err_val,
1308 "value too big for format, maximum is %llu",
1309 (unsigned long long)max_val) < 0
1310 ? strdup("value too big for format")
1316 * Assume we don't care if !err, in which case the value will be
1317 * silently truncated.
1321 pmu_format_value(format->bits, val, vp, zero);
1325 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
1326 struct perf_event_attr *attr,
1327 struct list_head *head_terms,
1328 bool zero, struct parse_events_error *err)
1330 struct parse_events_term *term;
1332 list_for_each_entry(term, head_terms, list) {
1333 if (pmu_config_term(pmu_name, formats, attr, term, head_terms,
1342 * Configures event's 'attr' parameter based on the:
1343 * 1) users input - specified in terms parameter
1344 * 2) pmu format definitions - specified by pmu parameter
1346 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1347 struct list_head *head_terms,
1348 struct parse_events_error *err)
1350 bool zero = !!pmu->default_config;
1352 attr->type = pmu->type;
1353 return perf_pmu__config_terms(pmu->name, &pmu->format, attr,
1354 head_terms, zero, err);
1357 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1358 struct parse_events_term *term)
1360 struct perf_pmu_alias *alias;
1363 if (parse_events__is_hardcoded_term(term))
1366 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1367 if (term->val.num != 1)
1369 if (pmu_find_format(&pmu->format, term->config))
1371 name = term->config;
1372 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1373 if (strcasecmp(term->config, "event"))
1375 name = term->val.str;
1380 list_for_each_entry(alias, &pmu->aliases, list) {
1381 if (!strcasecmp(alias->name, name))
1388 static int check_info_data(struct perf_pmu_alias *alias,
1389 struct perf_pmu_info *info)
1392 * Only one term in event definition can
1393 * define unit, scale and snapshot, fail
1394 * if there's more than one.
1396 if ((info->unit && alias->unit[0]) ||
1397 (info->scale && alias->scale) ||
1398 (info->snapshot && alias->snapshot))
1402 info->unit = alias->unit;
1405 info->scale = alias->scale;
1407 if (alias->snapshot)
1408 info->snapshot = alias->snapshot;
1414 * Find alias in the terms list and replace it with the terms
1415 * defined for the alias
1417 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1418 struct perf_pmu_info *info)
1420 struct parse_events_term *term, *h;
1421 struct perf_pmu_alias *alias;
1424 info->per_pkg = false;
1427 * Mark unit and scale as not set
1428 * (different from default values, see below)
1432 info->snapshot = false;
1433 info->metric_expr = NULL;
1434 info->metric_name = NULL;
1436 list_for_each_entry_safe(term, h, head_terms, list) {
1437 alias = pmu_find_alias(pmu, term);
1440 ret = pmu_alias_terms(alias, &term->list);
1444 ret = check_info_data(alias, info);
1449 info->per_pkg = true;
1450 info->metric_expr = alias->metric_expr;
1451 info->metric_name = alias->metric_name;
1453 list_del_init(&term->list);
1454 parse_events_term__delete(term);
1458 * if no unit or scale found in aliases, then
1459 * set defaults as for evsel
1460 * unit cannot left to NULL
1462 if (info->unit == NULL)
1465 if (info->scale == 0.0)
1471 int perf_pmu__new_format(struct list_head *list, char *name,
1472 int config, unsigned long *bits)
1474 struct perf_pmu_format *format;
1476 format = zalloc(sizeof(*format));
1480 format->name = strdup(name);
1481 format->value = config;
1482 memcpy(format->bits, bits, sizeof(format->bits));
1484 list_add_tail(&format->list, list);
1488 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1495 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1496 for (b = from; b <= to; b++)
1500 void perf_pmu__del_formats(struct list_head *formats)
1502 struct perf_pmu_format *fmt, *tmp;
1504 list_for_each_entry_safe(fmt, tmp, formats, list) {
1505 list_del(&fmt->list);
1511 static int sub_non_neg(int a, int b)
1518 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1519 struct perf_pmu_alias *alias)
1521 struct parse_events_term *term;
1522 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1524 list_for_each_entry(term, &alias->terms, list) {
1525 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1526 used += snprintf(buf + used, sub_non_neg(len, used),
1527 ",%s=%s", term->config,
1531 if (sub_non_neg(len, used) > 0) {
1535 if (sub_non_neg(len, used) > 0) {
1539 buf[len - 1] = '\0';
1544 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1545 struct perf_pmu_alias *alias)
1547 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1562 static int cmp_sevent(const void *a, const void *b)
1564 const struct sevent *as = a;
1565 const struct sevent *bs = b;
1567 /* Put extra events last */
1568 if (!!as->desc != !!bs->desc)
1569 return !!as->desc - !!bs->desc;
1570 if (as->topic && bs->topic) {
1571 int n = strcmp(as->topic, bs->topic);
1577 /* Order CPU core events to be first */
1578 if (as->is_cpu != bs->is_cpu)
1579 return bs->is_cpu - as->is_cpu;
1581 return strcmp(as->name, bs->name);
1584 static void wordwrap(char *s, int start, int max, int corr)
1590 int wlen = strcspn(s, " \t");
1592 if (column + wlen >= max && column > start) {
1593 printf("\n%*s", start, "");
1594 column = start + corr;
1596 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1605 bool is_pmu_core(const char *name)
1607 return !strcmp(name, "cpu") || is_arm_pmu_core(name);
1610 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1611 bool long_desc, bool details_flag, bool deprecated)
1613 struct perf_pmu *pmu;
1614 struct perf_pmu_alias *alias;
1618 struct sevent *aliases;
1620 int columns = pager_get_columns();
1625 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1626 list_for_each_entry(alias, &pmu->aliases, list)
1628 if (pmu->selectable)
1631 aliases = zalloc(sizeof(struct sevent) * len);
1636 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1637 list_for_each_entry(alias, &pmu->aliases, list) {
1638 char *name = alias->desc ? alias->name :
1639 format_alias(buf, sizeof(buf), pmu, alias);
1640 bool is_cpu = is_pmu_core(pmu->name);
1642 if (alias->deprecated && !deprecated)
1645 if (event_glob != NULL &&
1646 !(strglobmatch_nocase(name, event_glob) ||
1647 (!is_cpu && strglobmatch_nocase(alias->name,
1650 strglobmatch_nocase(alias->topic, event_glob))))
1653 if (is_cpu && !name_only && !alias->desc)
1654 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1656 aliases[j].name = name;
1657 if (is_cpu && !name_only && !alias->desc)
1658 aliases[j].name = format_alias_or(buf,
1661 aliases[j].name = strdup(aliases[j].name);
1662 if (!aliases[j].name)
1665 aliases[j].desc = long_desc ? alias->long_desc :
1667 aliases[j].topic = alias->topic;
1668 aliases[j].str = alias->str;
1669 aliases[j].pmu = pmu->name;
1670 aliases[j].metric_expr = alias->metric_expr;
1671 aliases[j].metric_name = alias->metric_name;
1672 aliases[j].is_cpu = is_cpu;
1675 if (pmu->selectable &&
1676 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1678 if (asprintf(&s, "%s//", pmu->name) < 0)
1680 aliases[j].name = s;
1685 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1686 for (j = 0; j < len; j++) {
1687 /* Skip duplicates */
1688 if (j > 0 && !strcmp(aliases[j].name, aliases[j - 1].name))
1691 printf("%s ", aliases[j].name);
1694 if (aliases[j].desc && !quiet_flag) {
1697 if (aliases[j].topic && (!topic ||
1698 strcmp(topic, aliases[j].topic))) {
1699 printf("%s%s:\n", topic ? "\n" : "",
1701 topic = aliases[j].topic;
1703 printf(" %-50s\n", aliases[j].name);
1704 printf("%*s", 8, "[");
1705 wordwrap(aliases[j].desc, 8, columns, 0);
1708 printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
1709 if (aliases[j].metric_name)
1710 printf(" MetricName: %s", aliases[j].metric_name);
1711 if (aliases[j].metric_expr)
1712 printf(" MetricExpr: %s", aliases[j].metric_expr);
1716 printf(" %-50s [Kernel PMU event]\n", aliases[j].name);
1719 if (printed && pager_in_use())
1722 for (j = 0; j < len; j++)
1723 zfree(&aliases[j].name);
1728 printf("FATAL: not enough memory to print PMU events\n");
1733 bool pmu_have_event(const char *pname, const char *name)
1735 struct perf_pmu *pmu;
1736 struct perf_pmu_alias *alias;
1739 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1740 if (strcmp(pname, pmu->name))
1742 list_for_each_entry(alias, &pmu->aliases, list)
1743 if (!strcmp(alias->name, name))
1749 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1751 char path[PATH_MAX];
1754 sysfs = sysfs__mountpoint();
1758 snprintf(path, PATH_MAX,
1759 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1760 if (!file_available(path))
1762 return fopen(path, "r");
1765 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1772 va_start(args, fmt);
1773 file = perf_pmu__open_file(pmu, name);
1775 ret = vfscanf(file, fmt, args);
1782 static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1784 struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1789 caps->name = strdup(name);
1792 caps->value = strndup(value, strlen(value) - 1);
1795 list_add_tail(&caps->list, list);
1807 * Reading/parsing the given pmu capabilities, which should be located at:
1808 * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1809 * Return the number of capabilities
1811 int perf_pmu__caps_parse(struct perf_pmu *pmu)
1814 char caps_path[PATH_MAX];
1815 const char *sysfs = sysfs__mountpoint();
1817 struct dirent *evt_ent;
1823 snprintf(caps_path, PATH_MAX,
1824 "%s" EVENT_SOURCE_DEVICE_PATH "%s/caps", sysfs, pmu->name);
1826 if (stat(caps_path, &st) < 0)
1827 return 0; /* no error if caps does not exist */
1829 caps_dir = opendir(caps_path);
1833 while ((evt_ent = readdir(caps_dir)) != NULL) {
1834 char path[PATH_MAX + NAME_MAX + 1];
1835 char *name = evt_ent->d_name;
1839 if (!strcmp(name, ".") || !strcmp(name, ".."))
1842 snprintf(path, sizeof(path), "%s/%s", caps_path, name);
1844 file = fopen(path, "r");
1848 if (!fgets(value, sizeof(value), file) ||
1849 (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1863 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
1866 struct perf_pmu_format *format;
1867 __u64 masks = 0, bits;
1871 list_for_each_entry(format, &pmu->format, list) {
1872 if (format->value != PERF_PMU_FORMAT_VALUE_CONFIG)
1875 for_each_set_bit(i, format->bits, PERF_PMU_FORMAT_BITS)
1880 * Kernel doesn't export any valid format bits.
1885 bits = config & ~masks;
1889 bitmap_scnprintf((unsigned long *)&bits, sizeof(bits) * 8, buf, sizeof(buf));
1891 pr_warning("WARNING: event '%s' not valid (bits %s of config "
1892 "'%llx' not supported by kernel)!\n",
1893 name ?: "N/A", buf, config);
1896 bool perf_pmu__has_hybrid(void)
1898 if (!hybrid_scanned) {
1899 hybrid_scanned = true;
1900 perf_pmu__scan(NULL);
1903 return !list_empty(&perf_pmu__hybrid_pmus);
1906 int perf_pmu__match(char *pattern, char *name, char *tok)
1908 if (fnmatch(pattern, name, 0))
1911 if (tok && !perf_pmu__valid_suffix(name, tok))