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, const 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 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 __weak const struct pmu_events_table *pmu_events_table__find(void)
715 return perf_pmu__find_table(NULL);
719 * Suffix must be in form tok_{digits}, or tok{digits}, or same as pmu_name
722 static bool perf_pmu__valid_suffix(const char *pmu_name, char *tok)
726 if (strncmp(pmu_name, tok, strlen(tok)))
729 p = pmu_name + strlen(tok);
736 /* Ensure we end in a number */
747 bool pmu_uncore_alias_match(const char *pmu_name, const char *name)
749 char *tmp = NULL, *tok, *str;
752 str = strdup(pmu_name);
757 * uncore alias may be from different PMU with common prefix
759 tok = strtok_r(str, ",", &tmp);
760 if (strncmp(pmu_name, tok, strlen(tok))) {
766 * Match more complex aliases where the alias name is a comma-delimited
767 * list of tokens, orderly contained in the matching PMU name.
769 * Example: For alias "socket,pmuname" and PMU "socketX_pmunameY", we
770 * match "socket" in "socketX_pmunameY" and then "pmuname" in
774 char *next_tok = strtok_r(NULL, ",", &tmp);
776 name = strstr(name, tok);
778 (!next_tok && !perf_pmu__valid_suffix(name, tok))) {
794 struct pmu_add_cpu_aliases_map_data {
795 struct list_head *head;
797 const char *cpu_name;
798 struct perf_pmu *pmu;
801 static int pmu_add_cpu_aliases_map_callback(const struct pmu_event *pe,
802 const struct pmu_events_table *table __maybe_unused,
805 struct pmu_add_cpu_aliases_map_data *data = vdata;
806 const char *pname = pe->pmu ? pe->pmu : data->cpu_name;
811 if (data->pmu->is_uncore && pmu_uncore_alias_match(pname, data->name))
814 if (strcmp(pname, data->name))
818 /* need type casts to override 'const' */
819 __perf_pmu__new_alias(data->head, NULL, (char *)pe->name, (char *)pe->desc,
820 (char *)pe->event, pe);
825 * From the pmu_events_map, find the table of PMU events that corresponds
826 * to the current running CPU. Then, add all PMU events from that table
829 void pmu_add_cpu_aliases_table(struct list_head *head, struct perf_pmu *pmu,
830 const struct pmu_events_table *table)
832 struct pmu_add_cpu_aliases_map_data data = {
835 .cpu_name = is_arm_pmu_core(pmu->name) ? pmu->name : "cpu",
839 pmu_events_table_for_each_event(table, pmu_add_cpu_aliases_map_callback, &data);
842 static void pmu_add_cpu_aliases(struct list_head *head, struct perf_pmu *pmu)
844 const struct pmu_events_table *table;
846 table = perf_pmu__find_table(pmu);
850 pmu_add_cpu_aliases_table(head, pmu, table);
853 struct pmu_sys_event_iter_data {
854 struct list_head *head;
855 struct perf_pmu *pmu;
858 static int pmu_add_sys_aliases_iter_fn(const struct pmu_event *pe,
859 const struct pmu_events_table *table __maybe_unused,
862 struct pmu_sys_event_iter_data *idata = data;
863 struct perf_pmu *pmu = idata->pmu;
866 if (pe->metric_group || pe->metric_name)
871 if (!pe->compat || !pe->pmu)
874 if (!strcmp(pmu->id, pe->compat) &&
875 pmu_uncore_alias_match(pe->pmu, pmu->name)) {
876 __perf_pmu__new_alias(idata->head, NULL,
886 void pmu_add_sys_aliases(struct list_head *head, struct perf_pmu *pmu)
888 struct pmu_sys_event_iter_data idata = {
896 pmu_for_each_sys_event(pmu_add_sys_aliases_iter_fn, &idata);
899 struct perf_event_attr * __weak
900 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
906 pmu_find_real_name(const char *name)
912 pmu_find_alias_name(const char *name __maybe_unused)
917 static int pmu_max_precise(const char *name)
920 int max_precise = -1;
922 scnprintf(path, PATH_MAX,
923 "bus/event_source/devices/%s/caps/max_precise",
926 sysfs__read_int(path, &max_precise);
930 static struct perf_pmu *pmu_lookup(const char *lookup_name)
932 struct perf_pmu *pmu;
936 char *name = pmu_find_real_name(lookup_name);
937 bool is_hybrid = perf_pmu__hybrid_mounted(name);
941 * Check pmu name for hybrid and the pmu may be invalid in sysfs
943 if (!strncmp(name, "cpu_", 4) && !is_hybrid)
947 * The pmu data we store & need consists of the pmu
948 * type value and format definitions. Load both right
951 if (pmu_format(name, &format))
955 * Check the type first to avoid unnecessary work.
957 if (pmu_type(name, &type))
960 if (pmu_aliases(name, &aliases))
963 pmu = zalloc(sizeof(*pmu));
967 pmu->cpus = pmu_cpumask(name);
968 pmu->name = strdup(name);
972 alias_name = pmu_find_alias_name(name);
974 pmu->alias_name = strdup(alias_name);
975 if (!pmu->alias_name)
980 pmu->is_uncore = pmu_is_uncore(name);
982 pmu->id = pmu_id(name);
983 pmu->is_hybrid = is_hybrid;
984 pmu->max_precise = pmu_max_precise(name);
985 pmu_add_cpu_aliases(&aliases, pmu);
986 pmu_add_sys_aliases(&aliases, pmu);
988 INIT_LIST_HEAD(&pmu->format);
989 INIT_LIST_HEAD(&pmu->aliases);
990 INIT_LIST_HEAD(&pmu->caps);
991 list_splice(&format, &pmu->format);
992 list_splice(&aliases, &pmu->aliases);
993 list_add_tail(&pmu->list, &pmus);
996 list_add_tail(&pmu->hybrid_list, &perf_pmu__hybrid_pmus);
998 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) ||
1014 (pmu->alias_name && !strcmp(pmu->alias_name, name)))
1021 struct perf_pmu *perf_pmu__find_by_type(unsigned int type)
1023 struct perf_pmu *pmu;
1025 list_for_each_entry(pmu, &pmus, list)
1026 if (pmu->type == type)
1032 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
1035 * pmu iterator: If pmu is NULL, we start at the begin,
1036 * otherwise return the next pmu. Returns NULL on end.
1040 pmu = list_prepare_entry(pmu, &pmus, list);
1042 list_for_each_entry_continue(pmu, &pmus, list)
1047 struct perf_pmu *evsel__find_pmu(struct evsel *evsel)
1049 struct perf_pmu *pmu = NULL;
1051 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1052 if (pmu->type == evsel->core.attr.type)
1059 bool evsel__is_aux_event(struct evsel *evsel)
1061 struct perf_pmu *pmu = evsel__find_pmu(evsel);
1063 return pmu && pmu->auxtrace;
1066 struct perf_pmu *perf_pmu__find(const char *name)
1068 struct perf_pmu *pmu;
1071 * Once PMU is loaded it stays in the list,
1072 * so we keep us from multiple reading/parsing
1073 * the pmu format definitions.
1075 pmu = pmu_find(name);
1079 return pmu_lookup(name);
1082 static struct perf_pmu_format *
1083 pmu_find_format(struct list_head *formats, const char *name)
1085 struct perf_pmu_format *format;
1087 list_for_each_entry(format, formats, list)
1088 if (!strcmp(format->name, name))
1094 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
1096 struct perf_pmu_format *format = pmu_find_format(formats, name);
1103 for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
1104 bits |= 1ULL << fbit;
1109 int perf_pmu__format_type(struct list_head *formats, const char *name)
1111 struct perf_pmu_format *format = pmu_find_format(formats, name);
1116 return format->value;
1120 * Sets value based on the format definition (format parameter)
1121 * and unformatted value (value parameter).
1123 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
1126 unsigned long fbit, vbit;
1128 for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
1130 if (!test_bit(fbit, format))
1133 if (value & (1llu << vbit++))
1134 *v |= (1llu << fbit);
1136 *v &= ~(1llu << fbit);
1140 static __u64 pmu_format_max_value(const unsigned long *format)
1144 w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
1148 return (1ULL << w) - 1;
1153 * Term is a string term, and might be a param-term. Try to look up it's value
1154 * in the remaining terms.
1155 * - We have a term like "base-or-format-term=param-term",
1156 * - We need to find the value supplied for "param-term" (with param-term named
1157 * in a config string) later on in the term list.
1159 static int pmu_resolve_param_term(struct parse_events_term *term,
1160 struct list_head *head_terms,
1163 struct parse_events_term *t;
1165 list_for_each_entry(t, head_terms, list) {
1166 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM &&
1167 t->config && !strcmp(t->config, term->config)) {
1169 *value = t->val.num;
1175 printf("Required parameter '%s' not specified\n", term->config);
1180 static char *pmu_formats_string(struct list_head *formats)
1182 struct perf_pmu_format *format;
1184 struct strbuf buf = STRBUF_INIT;
1190 /* sysfs exported terms */
1191 list_for_each_entry(format, formats, list)
1192 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1195 str = strbuf_detach(&buf, NULL);
1197 strbuf_release(&buf);
1203 * Setup one of config[12] attr members based on the
1204 * user input data - term parameter.
1206 static int pmu_config_term(const char *pmu_name,
1207 struct list_head *formats,
1208 struct perf_event_attr *attr,
1209 struct parse_events_term *term,
1210 struct list_head *head_terms,
1211 bool zero, struct parse_events_error *err)
1213 struct perf_pmu_format *format;
1218 * If this is a parameter we've already used for parameterized-eval,
1219 * skip it in normal eval.
1225 * Hardcoded terms should be already in, so nothing
1226 * to be done for them.
1228 if (parse_events__is_hardcoded_term(term))
1231 format = pmu_find_format(formats, term->config);
1233 char *pmu_term = pmu_formats_string(formats);
1237 if (asprintf(&unknown_term,
1238 "unknown term '%s' for pmu '%s'",
1239 term->config, pmu_name) < 0)
1240 unknown_term = NULL;
1241 help_msg = parse_events_formats_error_string(pmu_term);
1243 parse_events_error__handle(err, term->err_term,
1247 pr_debug("%s (%s)\n", unknown_term, help_msg);
1254 switch (format->value) {
1255 case PERF_PMU_FORMAT_VALUE_CONFIG:
1258 case PERF_PMU_FORMAT_VALUE_CONFIG1:
1259 vp = &attr->config1;
1261 case PERF_PMU_FORMAT_VALUE_CONFIG2:
1262 vp = &attr->config2;
1269 * Either directly use a numeric term, or try to translate string terms
1270 * using event parameters.
1272 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1273 if (term->no_value &&
1274 bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1276 parse_events_error__handle(err, term->err_val,
1277 strdup("no value assigned for term"),
1283 val = term->val.num;
1284 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1285 if (strcmp(term->val.str, "?")) {
1287 pr_info("Invalid sysfs entry %s=%s\n",
1288 term->config, term->val.str);
1291 parse_events_error__handle(err, term->err_val,
1292 strdup("expected numeric value"),
1298 if (pmu_resolve_param_term(term, head_terms, &val))
1303 max_val = pmu_format_max_value(format->bits);
1304 if (val > max_val) {
1308 parse_events_error__handle(err, term->err_val,
1310 "value too big for format, maximum is %llu",
1311 (unsigned long long)max_val) < 0
1312 ? strdup("value too big for format")
1318 * Assume we don't care if !err, in which case the value will be
1319 * silently truncated.
1323 pmu_format_value(format->bits, val, vp, zero);
1327 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
1328 struct perf_event_attr *attr,
1329 struct list_head *head_terms,
1330 bool zero, struct parse_events_error *err)
1332 struct parse_events_term *term;
1334 list_for_each_entry(term, head_terms, list) {
1335 if (pmu_config_term(pmu_name, formats, attr, term, head_terms,
1344 * Configures event's 'attr' parameter based on the:
1345 * 1) users input - specified in terms parameter
1346 * 2) pmu format definitions - specified by pmu parameter
1348 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1349 struct list_head *head_terms,
1350 struct parse_events_error *err)
1352 bool zero = !!pmu->default_config;
1354 attr->type = pmu->type;
1355 return perf_pmu__config_terms(pmu->name, &pmu->format, attr,
1356 head_terms, zero, err);
1359 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1360 struct parse_events_term *term)
1362 struct perf_pmu_alias *alias;
1365 if (parse_events__is_hardcoded_term(term))
1368 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1369 if (term->val.num != 1)
1371 if (pmu_find_format(&pmu->format, term->config))
1373 name = term->config;
1374 } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1375 if (strcasecmp(term->config, "event"))
1377 name = term->val.str;
1382 list_for_each_entry(alias, &pmu->aliases, list) {
1383 if (!strcasecmp(alias->name, name))
1390 static int check_info_data(struct perf_pmu_alias *alias,
1391 struct perf_pmu_info *info)
1394 * Only one term in event definition can
1395 * define unit, scale and snapshot, fail
1396 * if there's more than one.
1398 if ((info->unit && alias->unit[0]) ||
1399 (info->scale && alias->scale) ||
1400 (info->snapshot && alias->snapshot))
1404 info->unit = alias->unit;
1407 info->scale = alias->scale;
1409 if (alias->snapshot)
1410 info->snapshot = alias->snapshot;
1416 * Find alias in the terms list and replace it with the terms
1417 * defined for the alias
1419 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1420 struct perf_pmu_info *info)
1422 struct parse_events_term *term, *h;
1423 struct perf_pmu_alias *alias;
1426 info->per_pkg = false;
1429 * Mark unit and scale as not set
1430 * (different from default values, see below)
1434 info->snapshot = false;
1435 info->metric_expr = NULL;
1436 info->metric_name = NULL;
1438 list_for_each_entry_safe(term, h, head_terms, list) {
1439 alias = pmu_find_alias(pmu, term);
1442 ret = pmu_alias_terms(alias, &term->list);
1446 ret = check_info_data(alias, info);
1451 info->per_pkg = true;
1452 info->metric_expr = alias->metric_expr;
1453 info->metric_name = alias->metric_name;
1455 list_del_init(&term->list);
1456 parse_events_term__delete(term);
1460 * if no unit or scale found in aliases, then
1461 * set defaults as for evsel
1462 * unit cannot left to NULL
1464 if (info->unit == NULL)
1467 if (info->scale == 0.0)
1473 int perf_pmu__new_format(struct list_head *list, char *name,
1474 int config, unsigned long *bits)
1476 struct perf_pmu_format *format;
1478 format = zalloc(sizeof(*format));
1482 format->name = strdup(name);
1483 format->value = config;
1484 memcpy(format->bits, bits, sizeof(format->bits));
1486 list_add_tail(&format->list, list);
1490 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1497 memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1498 for (b = from; b <= to; b++)
1502 void perf_pmu__del_formats(struct list_head *formats)
1504 struct perf_pmu_format *fmt, *tmp;
1506 list_for_each_entry_safe(fmt, tmp, formats, list) {
1507 list_del(&fmt->list);
1513 static int sub_non_neg(int a, int b)
1520 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1521 struct perf_pmu_alias *alias)
1523 struct parse_events_term *term;
1524 int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1526 list_for_each_entry(term, &alias->terms, list) {
1527 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1528 used += snprintf(buf + used, sub_non_neg(len, used),
1529 ",%s=%s", term->config,
1533 if (sub_non_neg(len, used) > 0) {
1537 if (sub_non_neg(len, used) > 0) {
1541 buf[len - 1] = '\0';
1546 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1547 struct perf_pmu_alias *alias)
1549 snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1564 static int cmp_sevent(const void *a, const void *b)
1566 const struct sevent *as = a;
1567 const struct sevent *bs = b;
1570 /* Put extra events last */
1571 if (!!as->desc != !!bs->desc)
1572 return !!as->desc - !!bs->desc;
1573 if (as->topic && bs->topic) {
1574 int n = strcmp(as->topic, bs->topic);
1580 /* Order CPU core events to be first */
1581 if (as->is_cpu != bs->is_cpu)
1582 return bs->is_cpu - as->is_cpu;
1584 ret = strcmp(as->name, bs->name);
1586 if (as->pmu && bs->pmu)
1587 return strcmp(as->pmu, bs->pmu);
1593 static void wordwrap(char *s, int start, int max, int corr)
1599 int wlen = strcspn(s, " \t");
1601 if (column + wlen >= max && column > start) {
1602 printf("\n%*s", start, "");
1603 column = start + corr;
1605 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1614 bool is_pmu_core(const char *name)
1616 return !strcmp(name, "cpu") || is_arm_pmu_core(name);
1619 static bool pmu_alias_is_duplicate(struct sevent *alias_a,
1620 struct sevent *alias_b)
1622 /* Different names -> never duplicates */
1623 if (strcmp(alias_a->name, alias_b->name))
1626 /* Don't remove duplicates for hybrid PMUs */
1627 if (perf_pmu__is_hybrid(alias_a->pmu) &&
1628 perf_pmu__is_hybrid(alias_b->pmu))
1634 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1635 bool long_desc, bool details_flag, bool deprecated,
1636 const char *pmu_name)
1638 struct perf_pmu *pmu;
1639 struct perf_pmu_alias *alias;
1643 struct sevent *aliases;
1645 int columns = pager_get_columns();
1650 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1651 list_for_each_entry(alias, &pmu->aliases, list)
1653 if (pmu->selectable)
1656 aliases = zalloc(sizeof(struct sevent) * len);
1661 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1662 if (pmu_name && perf_pmu__is_hybrid(pmu->name) &&
1663 strcmp(pmu_name, pmu->name)) {
1667 list_for_each_entry(alias, &pmu->aliases, list) {
1668 char *name = alias->desc ? alias->name :
1669 format_alias(buf, sizeof(buf), pmu, alias);
1670 bool is_cpu = is_pmu_core(pmu->name) ||
1671 perf_pmu__is_hybrid(pmu->name);
1673 if (alias->deprecated && !deprecated)
1676 if (event_glob != NULL &&
1677 !(strglobmatch_nocase(name, event_glob) ||
1678 (!is_cpu && strglobmatch_nocase(alias->name,
1681 strglobmatch_nocase(alias->topic, event_glob))))
1684 if (is_cpu && !name_only && !alias->desc)
1685 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1687 aliases[j].name = name;
1688 if (is_cpu && !name_only && !alias->desc)
1689 aliases[j].name = format_alias_or(buf,
1692 aliases[j].name = strdup(aliases[j].name);
1693 if (!aliases[j].name)
1696 aliases[j].desc = long_desc ? alias->long_desc :
1698 aliases[j].topic = alias->topic;
1699 aliases[j].str = alias->str;
1700 aliases[j].pmu = pmu->name;
1701 aliases[j].metric_expr = alias->metric_expr;
1702 aliases[j].metric_name = alias->metric_name;
1703 aliases[j].is_cpu = is_cpu;
1706 if (pmu->selectable &&
1707 (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1709 if (asprintf(&s, "%s//", pmu->name) < 0)
1711 aliases[j].name = s;
1716 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1717 for (j = 0; j < len; j++) {
1718 /* Skip duplicates */
1719 if (j > 0 && pmu_alias_is_duplicate(&aliases[j], &aliases[j - 1]))
1723 printf("%s ", aliases[j].name);
1726 if (aliases[j].desc && !quiet_flag) {
1729 if (aliases[j].topic && (!topic ||
1730 strcmp(topic, aliases[j].topic))) {
1731 printf("%s%s:\n", topic ? "\n" : "",
1733 topic = aliases[j].topic;
1735 printf(" %-50s\n", aliases[j].name);
1736 printf("%*s", 8, "[");
1737 wordwrap(aliases[j].desc, 8, columns, 0);
1740 printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
1741 if (aliases[j].metric_name)
1742 printf(" MetricName: %s", aliases[j].metric_name);
1743 if (aliases[j].metric_expr)
1744 printf(" MetricExpr: %s", aliases[j].metric_expr);
1748 printf(" %-50s [Kernel PMU event]\n", aliases[j].name);
1751 if (printed && pager_in_use())
1754 for (j = 0; j < len; j++)
1755 zfree(&aliases[j].name);
1760 printf("FATAL: not enough memory to print PMU events\n");
1765 bool pmu_have_event(const char *pname, const char *name)
1767 struct perf_pmu *pmu;
1768 struct perf_pmu_alias *alias;
1771 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1772 if (strcmp(pname, pmu->name))
1774 list_for_each_entry(alias, &pmu->aliases, list)
1775 if (!strcmp(alias->name, name))
1781 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1783 char path[PATH_MAX];
1786 sysfs = sysfs__mountpoint();
1790 snprintf(path, PATH_MAX,
1791 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1792 if (!file_available(path))
1794 return fopen(path, "r");
1797 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1804 va_start(args, fmt);
1805 file = perf_pmu__open_file(pmu, name);
1807 ret = vfscanf(file, fmt, args);
1814 static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1816 struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1821 caps->name = strdup(name);
1824 caps->value = strndup(value, strlen(value) - 1);
1827 list_add_tail(&caps->list, list);
1839 * Reading/parsing the given pmu capabilities, which should be located at:
1840 * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1841 * Return the number of capabilities
1843 int perf_pmu__caps_parse(struct perf_pmu *pmu)
1846 char caps_path[PATH_MAX];
1847 const char *sysfs = sysfs__mountpoint();
1849 struct dirent *evt_ent;
1851 if (pmu->caps_initialized)
1852 return pmu->nr_caps;
1859 snprintf(caps_path, PATH_MAX,
1860 "%s" EVENT_SOURCE_DEVICE_PATH "%s/caps", sysfs, pmu->name);
1862 if (stat(caps_path, &st) < 0) {
1863 pmu->caps_initialized = true;
1864 return 0; /* no error if caps does not exist */
1867 caps_dir = opendir(caps_path);
1871 while ((evt_ent = readdir(caps_dir)) != NULL) {
1872 char path[PATH_MAX + NAME_MAX + 1];
1873 char *name = evt_ent->d_name;
1877 if (!strcmp(name, ".") || !strcmp(name, ".."))
1880 snprintf(path, sizeof(path), "%s/%s", caps_path, name);
1882 file = fopen(path, "r");
1886 if (!fgets(value, sizeof(value), file) ||
1887 (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1898 pmu->caps_initialized = true;
1899 return pmu->nr_caps;
1902 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
1905 struct perf_pmu_format *format;
1906 __u64 masks = 0, bits;
1910 list_for_each_entry(format, &pmu->format, list) {
1911 if (format->value != PERF_PMU_FORMAT_VALUE_CONFIG)
1914 for_each_set_bit(i, format->bits, PERF_PMU_FORMAT_BITS)
1919 * Kernel doesn't export any valid format bits.
1924 bits = config & ~masks;
1928 bitmap_scnprintf((unsigned long *)&bits, sizeof(bits) * 8, buf, sizeof(buf));
1930 pr_warning("WARNING: event '%s' not valid (bits %s of config "
1931 "'%llx' not supported by kernel)!\n",
1932 name ?: "N/A", buf, config);
1935 bool perf_pmu__has_hybrid(void)
1937 if (!hybrid_scanned) {
1938 hybrid_scanned = true;
1939 perf_pmu__scan(NULL);
1942 return !list_empty(&perf_pmu__hybrid_pmus);
1945 int perf_pmu__match(char *pattern, char *name, char *tok)
1950 if (fnmatch(pattern, name, 0))
1953 if (tok && !perf_pmu__valid_suffix(name, tok))
1959 int perf_pmu__cpus_match(struct perf_pmu *pmu, struct perf_cpu_map *cpus,
1960 struct perf_cpu_map **mcpus_ptr,
1961 struct perf_cpu_map **ucpus_ptr)
1963 struct perf_cpu_map *pmu_cpus = pmu->cpus;
1964 struct perf_cpu_map *matched_cpus, *unmatched_cpus;
1965 struct perf_cpu cpu;
1966 int i, matched_nr = 0, unmatched_nr = 0;
1968 matched_cpus = perf_cpu_map__default_new();
1972 unmatched_cpus = perf_cpu_map__default_new();
1973 if (!unmatched_cpus) {
1974 perf_cpu_map__put(matched_cpus);
1978 perf_cpu_map__for_each_cpu(cpu, i, cpus) {
1979 if (!perf_cpu_map__has(pmu_cpus, cpu))
1980 unmatched_cpus->map[unmatched_nr++] = cpu;
1982 matched_cpus->map[matched_nr++] = cpu;
1985 unmatched_cpus->nr = unmatched_nr;
1986 matched_cpus->nr = matched_nr;
1987 *mcpus_ptr = matched_cpus;
1988 *ucpus_ptr = unmatched_cpus;