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>
14 #include <api/fs/fs.h>
22 #include "pmu-bison.h"
24 #include "parse-events.h"
25 #include "print-events.h"
30 #include "util/evsel_config.h"
32 struct perf_pmu perf_pmu__fake;
35 * struct perf_pmu_format - Values from a format file read from
36 * <sysfs>/devices/cpu/format/ held in struct perf_pmu.
38 * For example, the contents of <sysfs>/devices/cpu/format/event may be
39 * "config:0-7" and will be represented here as name="event",
40 * value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will be set.
42 struct perf_pmu_format {
43 /** @name: The modifier/file name. */
46 * @value : Which config value the format relates to. Supported values
47 * are from PERF_PMU_FORMAT_VALUE_CONFIG to
48 * PERF_PMU_FORMAT_VALUE_CONFIG_END.
51 /** @bits: Which config bits are set by this format value. */
52 DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
53 /** @list: Element on list within struct perf_pmu. */
54 struct list_head list;
58 * Parse & process all the sysfs attributes located under
59 * the directory specified in 'dir' parameter.
61 int perf_pmu__format_parse(int dirfd, struct list_head *head)
63 struct dirent *evt_ent;
67 format_dir = fdopendir(dirfd);
71 while (!ret && (evt_ent = readdir(format_dir))) {
72 char *name = evt_ent->d_name;
77 if (!strcmp(name, ".") || !strcmp(name, ".."))
82 fd = openat(dirfd, name, O_RDONLY);
86 file = fdopen(fd, "r");
92 ret = perf_pmu_lex_init(&scanner);
98 perf_pmu_set_in(file, scanner);
99 ret = perf_pmu_parse(head, name, scanner);
100 perf_pmu_lex_destroy(scanner);
104 closedir(format_dir);
109 * Reading/parsing the default pmu format definition, which should be
111 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
113 static int pmu_format(int dirfd, const char *name, struct list_head *format)
117 fd = perf_pmu__pathname_fd(dirfd, name, "format", O_DIRECTORY);
121 /* it'll close the fd */
122 if (perf_pmu__format_parse(fd, format))
128 int perf_pmu__convert_scale(const char *scale, char **end, double *sval)
134 * save current locale
136 lc = setlocale(LC_NUMERIC, NULL);
139 * The lc string may be allocated in static storage,
140 * so get a dynamic copy to make it survive setlocale
150 * force to C locale to ensure kernel
151 * scale string is converted correctly.
152 * kernel uses default C locale.
154 setlocale(LC_NUMERIC, "C");
156 *sval = strtod(scale, end);
160 setlocale(LC_NUMERIC, lc);
165 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, int dirfd, char *name)
173 scnprintf(path, PATH_MAX, "%s.scale", name);
175 fd = openat(dirfd, path, O_RDONLY);
179 if (fstat(fd, &st) < 0)
182 sret = read(fd, scale, sizeof(scale)-1);
186 if (scale[sret - 1] == '\n')
187 scale[sret - 1] = '\0';
191 ret = perf_pmu__convert_scale(scale, NULL, &alias->scale);
197 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, int dirfd, char *name)
203 scnprintf(path, PATH_MAX, "%s.unit", name);
205 fd = openat(dirfd, path, O_RDONLY);
209 sret = read(fd, alias->unit, UNIT_MAX_LEN);
215 if (alias->unit[sret - 1] == '\n')
216 alias->unit[sret - 1] = '\0';
218 alias->unit[sret] = '\0';
223 alias->unit[0] = '\0';
228 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, int dirfd, char *name)
233 scnprintf(path, PATH_MAX, "%s.per-pkg", name);
235 fd = openat(dirfd, path, O_RDONLY);
241 alias->per_pkg = true;
245 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
246 int dirfd, char *name)
251 scnprintf(path, PATH_MAX, "%s.snapshot", name);
253 fd = openat(dirfd, path, O_RDONLY);
257 alias->snapshot = true;
262 static void perf_pmu_assign_str(char *name, const char *field, char **old_str,
268 if (*new_str) { /* Have new string, check with old */
269 if (strcasecmp(*old_str, *new_str))
270 pr_debug("alias %s differs in field '%s'\n",
273 } else /* Nothing new --> keep old string */
280 static void perf_pmu_update_alias(struct perf_pmu_alias *old,
281 struct perf_pmu_alias *newalias)
283 perf_pmu_assign_str(old->name, "desc", &old->desc, &newalias->desc);
284 perf_pmu_assign_str(old->name, "long_desc", &old->long_desc,
285 &newalias->long_desc);
286 perf_pmu_assign_str(old->name, "topic", &old->topic, &newalias->topic);
287 perf_pmu_assign_str(old->name, "value", &old->str, &newalias->str);
288 old->scale = newalias->scale;
289 old->per_pkg = newalias->per_pkg;
290 old->snapshot = newalias->snapshot;
291 memcpy(old->unit, newalias->unit, sizeof(old->unit));
294 /* Delete an alias entry. */
295 void perf_pmu_free_alias(struct perf_pmu_alias *newalias)
297 zfree(&newalias->name);
298 zfree(&newalias->desc);
299 zfree(&newalias->long_desc);
300 zfree(&newalias->topic);
301 zfree(&newalias->str);
302 zfree(&newalias->pmu_name);
303 parse_events_terms__purge(&newalias->terms);
307 static void perf_pmu__del_aliases(struct perf_pmu *pmu)
309 struct perf_pmu_alias *alias, *tmp;
311 list_for_each_entry_safe(alias, tmp, &pmu->aliases, list) {
312 list_del(&alias->list);
313 perf_pmu_free_alias(alias);
317 /* Merge an alias, search in alias list. If this name is already
318 * present merge both of them to combine all information.
320 static bool perf_pmu_merge_alias(struct perf_pmu_alias *newalias,
321 struct list_head *alist)
323 struct perf_pmu_alias *a;
325 list_for_each_entry(a, alist, list) {
326 if (!strcasecmp(newalias->name, a->name)) {
327 if (newalias->pmu_name && a->pmu_name &&
328 !strcasecmp(newalias->pmu_name, a->pmu_name)) {
331 perf_pmu_update_alias(a, newalias);
332 perf_pmu_free_alias(newalias);
339 static int __perf_pmu__new_alias(struct list_head *list, int dirfd, char *name,
340 char *desc, char *val, const struct pmu_event *pe)
342 struct parse_events_term *term;
343 struct perf_pmu_alias *alias;
346 const char *long_desc = NULL, *topic = NULL, *unit = NULL, *pmu_name = NULL;
347 bool deprecated = false, perpkg = false;
350 long_desc = pe->long_desc;
354 deprecated = pe->deprecated;
358 alias = malloc(sizeof(*alias));
362 INIT_LIST_HEAD(&alias->terms);
364 alias->unit[0] = '\0';
365 alias->per_pkg = perpkg;
366 alias->snapshot = false;
367 alias->deprecated = deprecated;
369 ret = parse_events_terms(&alias->terms, val);
371 pr_err("Cannot parse alias %s: %d\n", val, ret);
376 /* Scan event and remove leading zeroes, spaces, newlines, some
377 * platforms have terms specified as
378 * event=0x0091 (read from files ../<PMU>/events/<FILE>
379 * and terms specified as event=0x91 (read from JSON files).
381 * Rebuild string to make alias->str member comparable.
383 memset(newval, 0, sizeof(newval));
385 list_for_each_entry(term, &alias->terms, list) {
387 ret += scnprintf(newval + ret, sizeof(newval) - ret,
389 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
390 ret += scnprintf(newval + ret, sizeof(newval) - ret,
391 "%s=%#x", term->config, term->val.num);
392 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
393 ret += scnprintf(newval + ret, sizeof(newval) - ret,
394 "%s=%s", term->config, term->val.str);
397 alias->name = strdup(name);
400 * load unit name and scale if available
402 perf_pmu__parse_unit(alias, dirfd, name);
403 perf_pmu__parse_scale(alias, dirfd, name);
404 perf_pmu__parse_per_pkg(alias, dirfd, name);
405 perf_pmu__parse_snapshot(alias, dirfd, name);
408 alias->desc = desc ? strdup(desc) : NULL;
409 alias->long_desc = long_desc ? strdup(long_desc) :
410 desc ? strdup(desc) : NULL;
411 alias->topic = topic ? strdup(topic) : NULL;
413 if (perf_pmu__convert_scale(unit, (char **)&unit, &alias->scale) < 0)
415 snprintf(alias->unit, sizeof(alias->unit), "%s", unit);
417 alias->str = strdup(newval);
418 alias->pmu_name = pmu_name ? strdup(pmu_name) : NULL;
420 if (!perf_pmu_merge_alias(alias, list))
421 list_add_tail(&alias->list, list);
426 static int perf_pmu__new_alias(struct list_head *list, int dirfd, char *name, FILE *file)
431 ret = fread(buf, 1, sizeof(buf), file);
437 /* Remove trailing newline from sysfs file */
440 return __perf_pmu__new_alias(list, dirfd, name, NULL, buf, NULL);
443 static inline bool pmu_alias_info_file(char *name)
448 if (len > 5 && !strcmp(name + len - 5, ".unit"))
450 if (len > 6 && !strcmp(name + len - 6, ".scale"))
452 if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
454 if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
461 * Process all the sysfs attributes located under the directory
462 * specified in 'dir' parameter.
464 static int pmu_aliases_parse(int dirfd, struct list_head *head)
466 struct dirent *evt_ent;
470 event_dir = fdopendir(dirfd);
474 while ((evt_ent = readdir(event_dir))) {
475 char *name = evt_ent->d_name;
478 if (!strcmp(name, ".") || !strcmp(name, ".."))
482 * skip info files parsed in perf_pmu__new_alias()
484 if (pmu_alias_info_file(name))
487 fd = openat(dirfd, name, O_RDONLY);
489 pr_debug("Cannot open %s\n", name);
492 file = fdopen(fd, "r");
498 if (perf_pmu__new_alias(head, dirfd, name, file) < 0)
499 pr_debug("Cannot set up %s\n", name);
508 * Reading the pmu event aliases definition, which should be located at:
509 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
511 static int pmu_aliases(int dirfd, const char *name, struct list_head *head)
515 fd = perf_pmu__pathname_fd(dirfd, name, "events", O_DIRECTORY);
519 /* it'll close the fd */
520 if (pmu_aliases_parse(fd, head))
526 static int pmu_alias_terms(struct perf_pmu_alias *alias,
527 struct list_head *terms)
529 struct parse_events_term *term, *cloned;
533 list_for_each_entry(term, &alias->terms, list) {
534 ret = parse_events_term__clone(&cloned, term);
536 parse_events_terms__purge(&list);
540 * Weak terms don't override command line options,
541 * which we don't want for implicit terms in aliases.
544 list_add_tail(&cloned->list, &list);
546 list_splice(&list, terms);
551 * Uncore PMUs have a "cpumask" file under sysfs. CPU PMUs (e.g. on arm/arm64)
552 * may have a "cpus" file.
554 static struct perf_cpu_map *pmu_cpumask(int dirfd, const char *name)
556 struct perf_cpu_map *cpus;
557 const char *templates[] = {
562 const char **template;
563 char pmu_name[PATH_MAX];
564 struct perf_pmu pmu = {.name = pmu_name};
567 strlcpy(pmu_name, name, sizeof(pmu_name));
568 for (template = templates; *template; template++) {
569 file = perf_pmu__open_file_at(&pmu, dirfd, *template);
572 cpus = perf_cpu_map__read(file);
578 return !strcmp(name, "cpu") ? perf_cpu_map__get(cpu_map__online()) : NULL;
581 static bool pmu_is_uncore(int dirfd, const char *name)
585 fd = perf_pmu__pathname_fd(dirfd, name, "cpumask", O_PATH);
593 static char *pmu_id(const char *name)
595 char path[PATH_MAX], *str;
598 perf_pmu__pathname_scnprintf(path, sizeof(path), name, "identifier");
600 if (filename__read_str(path, &str, &len) < 0)
603 str[len - 1] = 0; /* remove line feed */
609 * is_sysfs_pmu_core() - PMU CORE devices have different name other than cpu in
610 * sysfs on some platforms like ARM or Intel hybrid. Looking for
611 * possible the cpus file in sysfs files to identify whether this is a
613 * @name: The PMU name such as "cpu_atom".
615 static int is_sysfs_pmu_core(const char *name)
619 if (!perf_pmu__pathname_scnprintf(path, sizeof(path), name, "cpus"))
621 return file_available(path);
624 char *perf_pmu__getcpuid(struct perf_pmu *pmu)
629 cpuid = getenv("PERF_CPUID");
631 cpuid = strdup(cpuid);
633 cpuid = get_cpuid_str(pmu);
638 pr_debug("Using CPUID %s\n", cpuid);
644 __weak const struct pmu_events_table *pmu_events_table__find(void)
646 return perf_pmu__find_events_table(NULL);
649 __weak const struct pmu_metrics_table *pmu_metrics_table__find(void)
651 return perf_pmu__find_metrics_table(NULL);
655 * perf_pmu__match_ignoring_suffix - Does the pmu_name match tok ignoring any
656 * trailing suffix? The Suffix must be in form
657 * tok_{digits}, or tok{digits}.
658 * @pmu_name: The pmu_name with possible suffix.
659 * @tok: The possible match to pmu_name without suffix.
661 static bool perf_pmu__match_ignoring_suffix(const char *pmu_name, const char *tok)
665 if (strncmp(pmu_name, tok, strlen(tok)))
668 p = pmu_name + strlen(tok);
675 /* Ensure we end in a number */
687 * pmu_uncore_alias_match - does name match the PMU name?
688 * @pmu_name: the json struct pmu_event name. This may lack a suffix (which
689 * matches) or be of the form "socket,pmuname" which will match
690 * "socketX_pmunameY".
691 * @name: a real full PMU name as from sysfs.
693 static bool pmu_uncore_alias_match(const char *pmu_name, const char *name)
695 char *tmp = NULL, *tok, *str;
698 if (strchr(pmu_name, ',') == NULL)
699 return perf_pmu__match_ignoring_suffix(name, pmu_name);
701 str = strdup(pmu_name);
706 * uncore alias may be from different PMU with common prefix
708 tok = strtok_r(str, ",", &tmp);
709 if (strncmp(pmu_name, tok, strlen(tok))) {
715 * Match more complex aliases where the alias name is a comma-delimited
716 * list of tokens, orderly contained in the matching PMU name.
718 * Example: For alias "socket,pmuname" and PMU "socketX_pmunameY", we
719 * match "socket" in "socketX_pmunameY" and then "pmuname" in
723 char *next_tok = strtok_r(NULL, ",", &tmp);
725 name = strstr(name, tok);
727 (!next_tok && !perf_pmu__match_ignoring_suffix(name, tok))) {
743 struct pmu_add_cpu_aliases_map_data {
744 struct list_head *head;
746 const char *cpu_name;
747 struct perf_pmu *pmu;
750 static int pmu_add_cpu_aliases_map_callback(const struct pmu_event *pe,
751 const struct pmu_events_table *table __maybe_unused,
754 struct pmu_add_cpu_aliases_map_data *data = vdata;
755 const char *pname = pe->pmu ? pe->pmu : data->cpu_name;
757 if (data->pmu->is_uncore && pmu_uncore_alias_match(pname, data->name))
760 if (strcmp(pname, data->name))
764 /* need type casts to override 'const' */
765 __perf_pmu__new_alias(data->head, -1, (char *)pe->name, (char *)pe->desc,
766 (char *)pe->event, pe);
771 * From the pmu_events_map, find the table of PMU events that corresponds
772 * to the current running CPU. Then, add all PMU events from that table
775 void pmu_add_cpu_aliases_table(struct list_head *head, struct perf_pmu *pmu,
776 const struct pmu_events_table *table)
778 struct pmu_add_cpu_aliases_map_data data = {
781 .cpu_name = is_sysfs_pmu_core(pmu->name) ? pmu->name : "cpu",
785 pmu_events_table_for_each_event(table, pmu_add_cpu_aliases_map_callback, &data);
788 static void pmu_add_cpu_aliases(struct list_head *head, struct perf_pmu *pmu)
790 const struct pmu_events_table *table;
792 table = perf_pmu__find_events_table(pmu);
796 pmu_add_cpu_aliases_table(head, pmu, table);
799 struct pmu_sys_event_iter_data {
800 struct list_head *head;
801 struct perf_pmu *pmu;
804 static int pmu_add_sys_aliases_iter_fn(const struct pmu_event *pe,
805 const struct pmu_events_table *table __maybe_unused,
808 struct pmu_sys_event_iter_data *idata = data;
809 struct perf_pmu *pmu = idata->pmu;
811 if (!pe->compat || !pe->pmu)
814 if (!strcmp(pmu->id, pe->compat) &&
815 pmu_uncore_alias_match(pe->pmu, pmu->name)) {
816 __perf_pmu__new_alias(idata->head, -1,
826 void pmu_add_sys_aliases(struct list_head *head, struct perf_pmu *pmu)
828 struct pmu_sys_event_iter_data idata = {
836 pmu_for_each_sys_event(pmu_add_sys_aliases_iter_fn, &idata);
839 struct perf_event_attr * __weak
840 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
846 pmu_find_real_name(const char *name)
852 pmu_find_alias_name(const char *name __maybe_unused)
857 static int pmu_max_precise(int dirfd, struct perf_pmu *pmu)
859 int max_precise = -1;
861 perf_pmu__scan_file_at(pmu, dirfd, "caps/max_precise", "%d", &max_precise);
865 struct perf_pmu *perf_pmu__lookup(struct list_head *pmus, int dirfd, const char *lookup_name)
867 struct perf_pmu *pmu;
871 char *name = pmu_find_real_name(lookup_name);
875 * The pmu data we store & need consists of the pmu
876 * type value and format definitions. Load both right
879 if (pmu_format(dirfd, name, &format))
883 * Check the aliases first to avoid unnecessary work.
885 if (pmu_aliases(dirfd, name, &aliases))
888 pmu = zalloc(sizeof(*pmu));
892 pmu->cpus = pmu_cpumask(dirfd, name);
893 pmu->name = strdup(name);
897 /* Read type, and ensure that type value is successfully assigned (return 1) */
898 if (perf_pmu__scan_file_at(pmu, dirfd, "type", "%u", &type) != 1)
901 alias_name = pmu_find_alias_name(name);
903 pmu->alias_name = strdup(alias_name);
904 if (!pmu->alias_name)
909 pmu->is_core = is_pmu_core(name);
910 pmu->is_uncore = pmu_is_uncore(dirfd, name);
912 pmu->id = pmu_id(name);
913 pmu->max_precise = pmu_max_precise(dirfd, pmu);
914 pmu_add_cpu_aliases(&aliases, pmu);
915 pmu_add_sys_aliases(&aliases, pmu);
917 INIT_LIST_HEAD(&pmu->format);
918 INIT_LIST_HEAD(&pmu->aliases);
919 INIT_LIST_HEAD(&pmu->caps);
920 list_splice(&format, &pmu->format);
921 list_splice(&aliases, &pmu->aliases);
922 list_add_tail(&pmu->list, pmus);
924 pmu->default_config = perf_pmu__get_default_config(pmu);
933 void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu)
935 struct perf_pmu_format *format;
937 if (pmu->formats_checked)
940 pmu->formats_checked = true;
942 /* fake pmu doesn't have format list */
943 if (pmu == &perf_pmu__fake)
946 list_for_each_entry(format, &pmu->format, list)
947 if (format->value >= PERF_PMU_FORMAT_VALUE_CONFIG_END) {
948 pr_warning("WARNING: '%s' format '%s' requires 'perf_event_attr::config%d'"
949 "which is not supported by this version of perf!\n",
950 pmu->name, format->name, format->value);
955 bool evsel__is_aux_event(const struct evsel *evsel)
957 struct perf_pmu *pmu = evsel__find_pmu(evsel);
959 return pmu && pmu->auxtrace;
963 * Set @config_name to @val as long as the user hasn't already set or cleared it
964 * by passing a config term on the command line.
966 * @val is the value to put into the bits specified by @config_name rather than
967 * the bit pattern. It is shifted into position by this function, so to set
968 * something to true, pass 1 for val rather than a pre shifted value.
970 #define field_prep(_mask, _val) (((_val) << (ffsll(_mask) - 1)) & (_mask))
971 void evsel__set_config_if_unset(struct perf_pmu *pmu, struct evsel *evsel,
972 const char *config_name, u64 val)
974 u64 user_bits = 0, bits;
975 struct evsel_config_term *term = evsel__get_config_term(evsel, CFG_CHG);
978 user_bits = term->val.cfg_chg;
980 bits = perf_pmu__format_bits(&pmu->format, config_name);
982 /* Do nothing if the user changed the value */
983 if (bits & user_bits)
986 /* Otherwise replace it */
987 evsel->core.attr.config &= ~bits;
988 evsel->core.attr.config |= field_prep(bits, val);
991 static struct perf_pmu_format *
992 pmu_find_format(struct list_head *formats, const char *name)
994 struct perf_pmu_format *format;
996 list_for_each_entry(format, formats, list)
997 if (!strcmp(format->name, name))
1003 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
1005 struct perf_pmu_format *format = pmu_find_format(formats, name);
1012 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
1013 bits |= 1ULL << fbit;
1018 int perf_pmu__format_type(struct list_head *formats, const char *name)
1020 struct perf_pmu_format *format = pmu_find_format(formats, name);
1025 return format->value;
1029 * Sets value based on the format definition (format parameter)
1030 * and unformatted value (value parameter).
1032 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
1035 unsigned long fbit, vbit;
1037 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
1039 if (!test_bit(fbit, format))
1042 if (value & (1llu << vbit++))
1043 *v |= (1llu << fbit);
1045 *v &= ~(1llu << fbit);
1049 static __u64 pmu_format_max_value(const unsigned long *format)
1053 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
1057 return (1ULL << w) - 1;
1062 * Term is a string term, and might be a param-term. Try to look up it's value
1063 * in the remaining terms.
1064 * - We have a term like "base-or-format-term=param-term",
1065 * - We need to find the value supplied for "param-term" (with param-term named
1066 * in a config string) later on in the term list.
1068 static int pmu_resolve_param_term(struct parse_events_term *term,
1069 struct list_head *head_terms,
1072 struct parse_events_term *t;
1074 list_for_each_entry(t, head_terms, list) {
1075 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM &&
1076 t->config && !strcmp(t->config, term->config)) {
1078 *value = t->val.num;
1084 printf("Required parameter '%s' not specified\n", term->config);
1089 static char *pmu_formats_string(struct list_head *formats)
1091 struct perf_pmu_format *format;
1093 struct strbuf buf = STRBUF_INIT;
1099 /* sysfs exported terms */
1100 list_for_each_entry(format, formats, list)
1101 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1104 str = strbuf_detach(&buf, NULL);
1106 strbuf_release(&buf);
1112 * Setup one of config[12] attr members based on the
1113 * user input data - term parameter.
1115 static int pmu_config_term(const char *pmu_name,
1116 struct list_head *formats,
1117 struct perf_event_attr *attr,
1118 struct parse_events_term *term,
1119 struct list_head *head_terms,
1120 bool zero, struct parse_events_error *err)
1122 struct perf_pmu_format *format;
1127 * If this is a parameter we've already used for parameterized-eval,
1128 * skip it in normal eval.
1134 * Hardcoded terms should be already in, so nothing
1135 * to be done for them.
1137 if (parse_events__is_hardcoded_term(term))
1140 format = pmu_find_format(formats, term->config);
1142 char *pmu_term = pmu_formats_string(formats);
1146 if (asprintf(&unknown_term,
1147 "unknown term '%s' for pmu '%s'",
1148 term->config, pmu_name) < 0)
1149 unknown_term = NULL;
1150 help_msg = parse_events_formats_error_string(pmu_term);
1152 parse_events_error__handle(err, term->err_term,
1156 pr_debug("%s (%s)\n", unknown_term, help_msg);
1163 switch (format->value) {
1164 case PERF_PMU_FORMAT_VALUE_CONFIG:
1167 case PERF_PMU_FORMAT_VALUE_CONFIG1:
1168 vp = &attr->config1;
1170 case PERF_PMU_FORMAT_VALUE_CONFIG2:
1171 vp = &attr->config2;
1173 case PERF_PMU_FORMAT_VALUE_CONFIG3:
1174 vp = &attr->config3;
1181 * Either directly use a numeric term, or try to translate string terms
1182 * using event parameters.
1184 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1185 if (term->no_value &&
1186 bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1188 parse_events_error__handle(err, term->err_val,
1189 strdup("no value assigned for term"),
1195 val = term->val.num;
1196 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1197 if (strcmp(term->val.str, "?")) {
1199 pr_info("Invalid sysfs entry %s=%s\n",
1200 term->config, term->val.str);
1203 parse_events_error__handle(err, term->err_val,
1204 strdup("expected numeric value"),
1210 if (pmu_resolve_param_term(term, head_terms, &val))
1215 max_val = pmu_format_max_value(format->bits);
1216 if (val > max_val) {
1220 parse_events_error__handle(err, term->err_val,
1222 "value too big for format, maximum is %llu",
1223 (unsigned long long)max_val) < 0
1224 ? strdup("value too big for format")
1230 * Assume we don't care if !err, in which case the value will be
1231 * silently truncated.
1235 pmu_format_value(format->bits, val, vp, zero);
1239 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
1240 struct perf_event_attr *attr,
1241 struct list_head *head_terms,
1242 bool zero, struct parse_events_error *err)
1244 struct parse_events_term *term;
1246 list_for_each_entry(term, head_terms, list) {
1247 if (pmu_config_term(pmu_name, formats, attr, term, head_terms,
1256 * Configures event's 'attr' parameter based on the:
1257 * 1) users input - specified in terms parameter
1258 * 2) pmu format definitions - specified by pmu parameter
1260 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1261 struct list_head *head_terms,
1262 struct parse_events_error *err)
1264 bool zero = !!pmu->default_config;
1266 return perf_pmu__config_terms(pmu->name, &pmu->format, attr,
1267 head_terms, zero, err);
1270 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1271 struct parse_events_term *term)
1273 struct perf_pmu_alias *alias;
1276 if (parse_events__is_hardcoded_term(term))
1279 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1280 if (term->val.num != 1)
1282 if (pmu_find_format(&pmu->format, term->config))
1284 name = term->config;
1285 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1286 if (strcasecmp(term->config, "event"))
1288 name = term->val.str;
1293 list_for_each_entry(alias, &pmu->aliases, list) {
1294 if (!strcasecmp(alias->name, name))
1301 static int check_info_data(struct perf_pmu_alias *alias,
1302 struct perf_pmu_info *info)
1305 * Only one term in event definition can
1306 * define unit, scale and snapshot, fail
1307 * if there's more than one.
1309 if ((info->unit && alias->unit[0]) ||
1310 (info->scale && alias->scale) ||
1311 (info->snapshot && alias->snapshot))
1315 info->unit = alias->unit;
1318 info->scale = alias->scale;
1320 if (alias->snapshot)
1321 info->snapshot = alias->snapshot;
1327 * Find alias in the terms list and replace it with the terms
1328 * defined for the alias
1330 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1331 struct perf_pmu_info *info)
1333 struct parse_events_term *term, *h;
1334 struct perf_pmu_alias *alias;
1337 info->per_pkg = false;
1340 * Mark unit and scale as not set
1341 * (different from default values, see below)
1345 info->snapshot = false;
1347 list_for_each_entry_safe(term, h, head_terms, list) {
1348 alias = pmu_find_alias(pmu, term);
1351 ret = pmu_alias_terms(alias, &term->list);
1355 ret = check_info_data(alias, info);
1360 info->per_pkg = true;
1362 list_del_init(&term->list);
1363 parse_events_term__delete(term);
1367 * if no unit or scale found in aliases, then
1368 * set defaults as for evsel
1369 * unit cannot left to NULL
1371 if (info->unit == NULL)
1374 if (info->scale == 0.0)
1380 int perf_pmu__new_format(struct list_head *list, char *name,
1381 int config, unsigned long *bits)
1383 struct perf_pmu_format *format;
1385 format = zalloc(sizeof(*format));
1389 format->name = strdup(name);
1390 format->value = config;
1391 memcpy(format->bits, bits, sizeof(format->bits));
1393 list_add_tail(&format->list, list);
1397 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1404 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1405 for (b = from; b <= to; b++)
1409 void perf_pmu__del_formats(struct list_head *formats)
1411 struct perf_pmu_format *fmt, *tmp;
1413 list_for_each_entry_safe(fmt, tmp, formats, list) {
1414 list_del(&fmt->list);
1420 bool is_pmu_core(const char *name)
1422 return !strcmp(name, "cpu") || is_sysfs_pmu_core(name);
1425 bool perf_pmu__supports_legacy_cache(const struct perf_pmu *pmu)
1427 return pmu->is_core;
1430 bool perf_pmu__auto_merge_stats(const struct perf_pmu *pmu)
1432 return pmu->is_core && perf_pmus__num_core_pmus() == 1;
1435 bool perf_pmu__have_event(const struct perf_pmu *pmu, const char *name)
1437 struct perf_pmu_alias *alias;
1439 list_for_each_entry(alias, &pmu->aliases, list) {
1440 if (!strcmp(alias->name, name))
1446 bool perf_pmu__is_software(const struct perf_pmu *pmu)
1448 if (pmu->is_core || pmu->is_uncore || pmu->auxtrace)
1450 switch (pmu->type) {
1451 case PERF_TYPE_HARDWARE: return false;
1452 case PERF_TYPE_SOFTWARE: return true;
1453 case PERF_TYPE_TRACEPOINT: return true;
1454 case PERF_TYPE_HW_CACHE: return false;
1455 case PERF_TYPE_RAW: return false;
1456 case PERF_TYPE_BREAKPOINT: return true;
1459 return !strcmp(pmu->name, "kprobe") || !strcmp(pmu->name, "uprobe");
1462 FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1464 char path[PATH_MAX];
1466 if (!perf_pmu__pathname_scnprintf(path, sizeof(path), pmu->name, name) ||
1467 !file_available(path))
1470 return fopen(path, "r");
1473 FILE *perf_pmu__open_file_at(struct perf_pmu *pmu, int dirfd, const char *name)
1477 fd = perf_pmu__pathname_fd(dirfd, pmu->name, name, O_RDONLY);
1481 return fdopen(fd, "r");
1484 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1491 va_start(args, fmt);
1492 file = perf_pmu__open_file(pmu, name);
1494 ret = vfscanf(file, fmt, args);
1501 int perf_pmu__scan_file_at(struct perf_pmu *pmu, int dirfd, const char *name,
1502 const char *fmt, ...)
1508 va_start(args, fmt);
1509 file = perf_pmu__open_file_at(pmu, dirfd, name);
1511 ret = vfscanf(file, fmt, args);
1518 bool perf_pmu__file_exists(struct perf_pmu *pmu, const char *name)
1520 char path[PATH_MAX];
1522 if (!perf_pmu__pathname_scnprintf(path, sizeof(path), pmu->name, name))
1525 return file_available(path);
1528 static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1530 struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1535 caps->name = strdup(name);
1538 caps->value = strndup(value, strlen(value) - 1);
1541 list_add_tail(&caps->list, list);
1552 static void perf_pmu__del_caps(struct perf_pmu *pmu)
1554 struct perf_pmu_caps *caps, *tmp;
1556 list_for_each_entry_safe(caps, tmp, &pmu->caps, list) {
1557 list_del(&caps->list);
1559 zfree(&caps->value);
1565 * Reading/parsing the given pmu capabilities, which should be located at:
1566 * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1567 * Return the number of capabilities
1569 int perf_pmu__caps_parse(struct perf_pmu *pmu)
1572 char caps_path[PATH_MAX];
1574 struct dirent *evt_ent;
1577 if (pmu->caps_initialized)
1578 return pmu->nr_caps;
1582 if (!perf_pmu__pathname_scnprintf(caps_path, sizeof(caps_path), pmu->name, "caps"))
1585 if (stat(caps_path, &st) < 0) {
1586 pmu->caps_initialized = true;
1587 return 0; /* no error if caps does not exist */
1590 caps_dir = opendir(caps_path);
1594 caps_fd = dirfd(caps_dir);
1596 while ((evt_ent = readdir(caps_dir)) != NULL) {
1597 char *name = evt_ent->d_name;
1602 if (!strcmp(name, ".") || !strcmp(name, ".."))
1605 fd = openat(caps_fd, name, O_RDONLY);
1608 file = fdopen(fd, "r");
1614 if (!fgets(value, sizeof(value), file) ||
1615 (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1626 pmu->caps_initialized = true;
1627 return pmu->nr_caps;
1630 static void perf_pmu__compute_config_masks(struct perf_pmu *pmu)
1632 struct perf_pmu_format *format;
1634 if (pmu->config_masks_computed)
1637 list_for_each_entry(format, &pmu->format, list) {
1641 if (format->value >= PERF_PMU_FORMAT_VALUE_CONFIG_END)
1644 pmu->config_masks_present = true;
1645 mask = &pmu->config_masks[format->value];
1647 for_each_set_bit(i, format->bits, PERF_PMU_FORMAT_BITS)
1650 pmu->config_masks_computed = true;
1653 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
1654 const char *name, int config_num,
1655 const char *config_name)
1660 perf_pmu__compute_config_masks(pmu);
1663 * Kernel doesn't export any valid format bits.
1665 if (!pmu->config_masks_present)
1668 bits = config & ~pmu->config_masks[config_num];
1672 bitmap_scnprintf((unsigned long *)&bits, sizeof(bits) * 8, buf, sizeof(buf));
1674 pr_warning("WARNING: event '%s' not valid (bits %s of %s "
1675 "'%llx' not supported by kernel)!\n",
1676 name ?: "N/A", buf, config_name, config);
1679 int perf_pmu__match(char *pattern, char *name, char *tok)
1684 if (fnmatch(pattern, name, 0))
1687 if (tok && !perf_pmu__match_ignoring_suffix(name, tok))
1693 double __weak perf_pmu__cpu_slots_per_cycle(void)
1698 int perf_pmu__event_source_devices_scnprintf(char *pathname, size_t size)
1700 const char *sysfs = sysfs__mountpoint();
1704 return scnprintf(pathname, size, "%s/bus/event_source/devices/", sysfs);
1707 int perf_pmu__event_source_devices_fd(void)
1709 char path[PATH_MAX];
1710 const char *sysfs = sysfs__mountpoint();
1715 scnprintf(path, sizeof(path), "%s/bus/event_source/devices/", sysfs);
1716 return open(path, O_DIRECTORY);
1720 * Fill 'buf' with the path to a file or folder in 'pmu_name' in
1721 * sysfs. For example if pmu_name = "cs_etm" and 'filename' = "format"
1722 * then pathname will be filled with
1723 * "/sys/bus/event_source/devices/cs_etm/format"
1725 * Return 0 if the sysfs mountpoint couldn't be found or if no
1726 * characters were written.
1728 int perf_pmu__pathname_scnprintf(char *buf, size_t size,
1729 const char *pmu_name, const char *filename)
1731 char base_path[PATH_MAX];
1733 if (!perf_pmu__event_source_devices_scnprintf(base_path, sizeof(base_path)))
1735 return scnprintf(buf, size, "%s%s/%s", base_path, pmu_name, filename);
1738 int perf_pmu__pathname_fd(int dirfd, const char *pmu_name, const char *filename, int flags)
1740 char path[PATH_MAX];
1742 scnprintf(path, sizeof(path), "%s/%s", pmu_name, filename);
1743 return openat(dirfd, path, flags);
1746 void perf_pmu__delete(struct perf_pmu *pmu)
1748 perf_pmu__del_formats(&pmu->format);
1749 perf_pmu__del_aliases(pmu);
1750 perf_pmu__del_caps(pmu);
1752 perf_cpu_map__put(pmu->cpus);
1754 zfree(&pmu->default_config);
1756 zfree(&pmu->alias_name);