1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/hw_breakpoint.h>
10 #include <sys/param.h>
15 #include <subcmd/parse-options.h>
16 #include "parse-events.h"
17 #include <subcmd/exec-cmd.h>
23 #include "bpf-loader.h"
25 #include <api/fs/tracing_path.h>
26 #include "parse-events-bison.h"
27 #define YY_EXTRA_TYPE int
28 #include "parse-events-flex.h"
30 #include "thread_map.h"
32 #include "probe-file.h"
34 #include "util/parse-branch-options.h"
35 #include "metricgroup.h"
37 #define MAX_NAME_LEN 100
40 extern int parse_events_debug;
42 int parse_events_parse(void *parse_state, void *scanner);
43 static int get_config_terms(struct list_head *head_config,
44 struct list_head *head_terms __maybe_unused);
46 static struct perf_pmu_event_symbol *perf_pmu_events_list;
48 * The variable indicates the number of supported pmu event symbols.
49 * 0 means not initialized and ready to init
50 * -1 means failed to init, don't try anymore
51 * >0 is the number of supported pmu event symbols
53 static int perf_pmu_events_list_num;
55 struct event_symbol event_symbols_hw[PERF_COUNT_HW_MAX] = {
56 [PERF_COUNT_HW_CPU_CYCLES] = {
57 .symbol = "cpu-cycles",
60 [PERF_COUNT_HW_INSTRUCTIONS] = {
61 .symbol = "instructions",
64 [PERF_COUNT_HW_CACHE_REFERENCES] = {
65 .symbol = "cache-references",
68 [PERF_COUNT_HW_CACHE_MISSES] = {
69 .symbol = "cache-misses",
72 [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
73 .symbol = "branch-instructions",
76 [PERF_COUNT_HW_BRANCH_MISSES] = {
77 .symbol = "branch-misses",
80 [PERF_COUNT_HW_BUS_CYCLES] = {
81 .symbol = "bus-cycles",
84 [PERF_COUNT_HW_STALLED_CYCLES_FRONTEND] = {
85 .symbol = "stalled-cycles-frontend",
86 .alias = "idle-cycles-frontend",
88 [PERF_COUNT_HW_STALLED_CYCLES_BACKEND] = {
89 .symbol = "stalled-cycles-backend",
90 .alias = "idle-cycles-backend",
92 [PERF_COUNT_HW_REF_CPU_CYCLES] = {
93 .symbol = "ref-cycles",
98 struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
99 [PERF_COUNT_SW_CPU_CLOCK] = {
100 .symbol = "cpu-clock",
103 [PERF_COUNT_SW_TASK_CLOCK] = {
104 .symbol = "task-clock",
107 [PERF_COUNT_SW_PAGE_FAULTS] = {
108 .symbol = "page-faults",
111 [PERF_COUNT_SW_CONTEXT_SWITCHES] = {
112 .symbol = "context-switches",
115 [PERF_COUNT_SW_CPU_MIGRATIONS] = {
116 .symbol = "cpu-migrations",
117 .alias = "migrations",
119 [PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
120 .symbol = "minor-faults",
123 [PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
124 .symbol = "major-faults",
127 [PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
128 .symbol = "alignment-faults",
131 [PERF_COUNT_SW_EMULATION_FAULTS] = {
132 .symbol = "emulation-faults",
135 [PERF_COUNT_SW_DUMMY] = {
139 [PERF_COUNT_SW_BPF_OUTPUT] = {
140 .symbol = "bpf-output",
145 #define __PERF_EVENT_FIELD(config, name) \
146 ((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
148 #define PERF_EVENT_RAW(config) __PERF_EVENT_FIELD(config, RAW)
149 #define PERF_EVENT_CONFIG(config) __PERF_EVENT_FIELD(config, CONFIG)
150 #define PERF_EVENT_TYPE(config) __PERF_EVENT_FIELD(config, TYPE)
151 #define PERF_EVENT_ID(config) __PERF_EVENT_FIELD(config, EVENT)
153 #define for_each_subsystem(sys_dir, sys_dirent) \
154 while ((sys_dirent = readdir(sys_dir)) != NULL) \
155 if (sys_dirent->d_type == DT_DIR && \
156 (strcmp(sys_dirent->d_name, ".")) && \
157 (strcmp(sys_dirent->d_name, "..")))
159 static int tp_event_has_id(struct dirent *sys_dir, struct dirent *evt_dir)
161 char evt_path[MAXPATHLEN];
164 snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", tracing_events_path,
165 sys_dir->d_name, evt_dir->d_name);
166 fd = open(evt_path, O_RDONLY);
174 #define for_each_event(sys_dirent, evt_dir, evt_dirent) \
175 while ((evt_dirent = readdir(evt_dir)) != NULL) \
176 if (evt_dirent->d_type == DT_DIR && \
177 (strcmp(evt_dirent->d_name, ".")) && \
178 (strcmp(evt_dirent->d_name, "..")) && \
179 (!tp_event_has_id(sys_dirent, evt_dirent)))
181 #define MAX_EVENT_LENGTH 512
184 struct tracepoint_path *tracepoint_id_to_path(u64 config)
186 struct tracepoint_path *path = NULL;
187 DIR *sys_dir, *evt_dir;
188 struct dirent *sys_dirent, *evt_dirent;
192 char evt_path[MAXPATHLEN];
193 char dir_path[MAXPATHLEN];
195 sys_dir = opendir(tracing_events_path);
199 for_each_subsystem(sys_dir, sys_dirent) {
201 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
203 evt_dir = opendir(dir_path);
207 for_each_event(sys_dirent, evt_dir, evt_dirent) {
209 scnprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
211 fd = open(evt_path, O_RDONLY);
214 if (read(fd, id_buf, sizeof(id_buf)) < 0) {
223 path = zalloc(sizeof(*path));
226 path->system = malloc(MAX_EVENT_LENGTH);
231 path->name = malloc(MAX_EVENT_LENGTH);
233 zfree(&path->system);
237 strncpy(path->system, sys_dirent->d_name,
239 strncpy(path->name, evt_dirent->d_name,
251 struct tracepoint_path *tracepoint_name_to_path(const char *name)
253 struct tracepoint_path *path = zalloc(sizeof(*path));
254 char *str = strchr(name, ':');
256 if (path == NULL || str == NULL) {
261 path->system = strndup(name, str - name);
262 path->name = strdup(str+1);
264 if (path->system == NULL || path->name == NULL) {
265 zfree(&path->system);
273 const char *event_type(int type)
276 case PERF_TYPE_HARDWARE:
279 case PERF_TYPE_SOFTWARE:
282 case PERF_TYPE_TRACEPOINT:
285 case PERF_TYPE_HW_CACHE:
286 return "hardware-cache";
295 static int parse_events__is_name_term(struct parse_events_term *term)
297 return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
300 static char *get_config_name(struct list_head *head_terms)
302 struct parse_events_term *term;
307 list_for_each_entry(term, head_terms, list)
308 if (parse_events__is_name_term(term))
309 return term->val.str;
314 static struct perf_evsel *
315 __add_event(struct list_head *list, int *idx,
316 struct perf_event_attr *attr,
317 char *name, struct perf_pmu *pmu,
318 struct list_head *config_terms, bool auto_merge_stats)
320 struct perf_evsel *evsel;
321 struct cpu_map *cpus = pmu ? pmu->cpus : NULL;
323 event_attr_init(attr);
325 evsel = perf_evsel__new_idx(attr, *idx);
330 evsel->cpus = cpu_map__get(cpus);
331 evsel->own_cpus = cpu_map__get(cpus);
332 evsel->system_wide = pmu ? pmu->is_uncore : false;
333 evsel->auto_merge_stats = auto_merge_stats;
336 evsel->name = strdup(name);
339 list_splice(config_terms, &evsel->config_terms);
341 list_add_tail(&evsel->node, list);
345 static int add_event(struct list_head *list, int *idx,
346 struct perf_event_attr *attr, char *name,
347 struct list_head *config_terms)
349 return __add_event(list, idx, attr, name, NULL, config_terms, false) ? 0 : -ENOMEM;
352 static int parse_aliases(char *str, const char *names[][PERF_EVSEL__MAX_ALIASES], int size)
357 for (i = 0; i < size; i++) {
358 for (j = 0; j < PERF_EVSEL__MAX_ALIASES && names[i][j]; j++) {
359 n = strlen(names[i][j]);
360 if (n > longest && !strncasecmp(str, names[i][j], n))
370 typedef int config_term_func_t(struct perf_event_attr *attr,
371 struct parse_events_term *term,
372 struct parse_events_error *err);
373 static int config_term_common(struct perf_event_attr *attr,
374 struct parse_events_term *term,
375 struct parse_events_error *err);
376 static int config_attr(struct perf_event_attr *attr,
377 struct list_head *head,
378 struct parse_events_error *err,
379 config_term_func_t config_term);
381 int parse_events_add_cache(struct list_head *list, int *idx,
382 char *type, char *op_result1, char *op_result2,
383 struct parse_events_error *err,
384 struct list_head *head_config)
386 struct perf_event_attr attr;
387 LIST_HEAD(config_terms);
388 char name[MAX_NAME_LEN], *config_name;
389 int cache_type = -1, cache_op = -1, cache_result = -1;
390 char *op_result[2] = { op_result1, op_result2 };
394 * No fallback - if we cannot get a clear cache type
397 cache_type = parse_aliases(type, perf_evsel__hw_cache,
398 PERF_COUNT_HW_CACHE_MAX);
399 if (cache_type == -1)
402 config_name = get_config_name(head_config);
403 n = snprintf(name, MAX_NAME_LEN, "%s", type);
405 for (i = 0; (i < 2) && (op_result[i]); i++) {
406 char *str = op_result[i];
408 n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
410 if (cache_op == -1) {
411 cache_op = parse_aliases(str, perf_evsel__hw_cache_op,
412 PERF_COUNT_HW_CACHE_OP_MAX);
414 if (!perf_evsel__is_cache_op_valid(cache_type, cache_op))
420 if (cache_result == -1) {
421 cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
422 PERF_COUNT_HW_CACHE_RESULT_MAX);
423 if (cache_result >= 0)
429 * Fall back to reads:
432 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
435 * Fall back to accesses:
437 if (cache_result == -1)
438 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
440 memset(&attr, 0, sizeof(attr));
441 attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
442 attr.type = PERF_TYPE_HW_CACHE;
445 if (config_attr(&attr, head_config, err,
449 if (get_config_terms(head_config, &config_terms))
452 return add_event(list, idx, &attr, config_name ? : name, &config_terms);
455 static void tracepoint_error(struct parse_events_error *e, int err,
456 const char *sys, const char *name)
464 * We get error directly from syscall errno ( > 0),
465 * or from encoded pointer's error ( < 0).
471 e->str = strdup("can't access trace events");
474 e->str = strdup("unknown tracepoint");
477 e->str = strdup("failed to add tracepoint");
481 tracing_path__strerror_open_tp(err, help, sizeof(help), sys, name);
482 e->help = strdup(help);
485 static int add_tracepoint(struct list_head *list, int *idx,
486 const char *sys_name, const char *evt_name,
487 struct parse_events_error *err,
488 struct list_head *head_config)
490 struct perf_evsel *evsel;
492 evsel = perf_evsel__newtp_idx(sys_name, evt_name, (*idx)++);
494 tracepoint_error(err, PTR_ERR(evsel), sys_name, evt_name);
495 return PTR_ERR(evsel);
499 LIST_HEAD(config_terms);
501 if (get_config_terms(head_config, &config_terms))
503 list_splice(&config_terms, &evsel->config_terms);
506 list_add_tail(&evsel->node, list);
510 static int add_tracepoint_multi_event(struct list_head *list, int *idx,
511 const char *sys_name, const char *evt_name,
512 struct parse_events_error *err,
513 struct list_head *head_config)
515 char evt_path[MAXPATHLEN];
516 struct dirent *evt_ent;
518 int ret = 0, found = 0;
520 snprintf(evt_path, MAXPATHLEN, "%s/%s", tracing_events_path, sys_name);
521 evt_dir = opendir(evt_path);
523 tracepoint_error(err, errno, sys_name, evt_name);
527 while (!ret && (evt_ent = readdir(evt_dir))) {
528 if (!strcmp(evt_ent->d_name, ".")
529 || !strcmp(evt_ent->d_name, "..")
530 || !strcmp(evt_ent->d_name, "enable")
531 || !strcmp(evt_ent->d_name, "filter"))
534 if (!strglobmatch(evt_ent->d_name, evt_name))
539 ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name,
544 tracepoint_error(err, ENOENT, sys_name, evt_name);
552 static int add_tracepoint_event(struct list_head *list, int *idx,
553 const char *sys_name, const char *evt_name,
554 struct parse_events_error *err,
555 struct list_head *head_config)
557 return strpbrk(evt_name, "*?") ?
558 add_tracepoint_multi_event(list, idx, sys_name, evt_name,
560 add_tracepoint(list, idx, sys_name, evt_name,
564 static int add_tracepoint_multi_sys(struct list_head *list, int *idx,
565 const char *sys_name, const char *evt_name,
566 struct parse_events_error *err,
567 struct list_head *head_config)
569 struct dirent *events_ent;
573 events_dir = opendir(tracing_events_path);
575 tracepoint_error(err, errno, sys_name, evt_name);
579 while (!ret && (events_ent = readdir(events_dir))) {
580 if (!strcmp(events_ent->d_name, ".")
581 || !strcmp(events_ent->d_name, "..")
582 || !strcmp(events_ent->d_name, "enable")
583 || !strcmp(events_ent->d_name, "header_event")
584 || !strcmp(events_ent->d_name, "header_page"))
587 if (!strglobmatch(events_ent->d_name, sys_name))
590 ret = add_tracepoint_event(list, idx, events_ent->d_name,
591 evt_name, err, head_config);
594 closedir(events_dir);
598 struct __add_bpf_event_param {
599 struct parse_events_state *parse_state;
600 struct list_head *list;
601 struct list_head *head_config;
604 static int add_bpf_event(const char *group, const char *event, int fd,
607 LIST_HEAD(new_evsels);
608 struct __add_bpf_event_param *param = _param;
609 struct parse_events_state *parse_state = param->parse_state;
610 struct list_head *list = param->list;
611 struct perf_evsel *pos;
614 pr_debug("add bpf event %s:%s and attach bpf program %d\n",
617 err = parse_events_add_tracepoint(&new_evsels, &parse_state->idx, group,
618 event, parse_state->error,
621 struct perf_evsel *evsel, *tmp;
623 pr_debug("Failed to add BPF event %s:%s\n",
625 list_for_each_entry_safe(evsel, tmp, &new_evsels, node) {
626 list_del(&evsel->node);
627 perf_evsel__delete(evsel);
631 pr_debug("adding %s:%s\n", group, event);
633 list_for_each_entry(pos, &new_evsels, node) {
634 pr_debug("adding %s:%s to %p\n",
638 list_splice(&new_evsels, list);
642 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
643 struct list_head *list,
644 struct bpf_object *obj,
645 struct list_head *head_config)
649 struct __add_bpf_event_param param = {parse_state, list, head_config};
650 static bool registered_unprobe_atexit = false;
652 if (IS_ERR(obj) || !obj) {
653 snprintf(errbuf, sizeof(errbuf),
654 "Internal error: load bpf obj with NULL");
660 * Register atexit handler before calling bpf__probe() so
661 * bpf__probe() don't need to unprobe probe points its already
662 * created when failure.
664 if (!registered_unprobe_atexit) {
666 registered_unprobe_atexit = true;
669 err = bpf__probe(obj);
671 bpf__strerror_probe(obj, err, errbuf, sizeof(errbuf));
675 err = bpf__load(obj);
677 bpf__strerror_load(obj, err, errbuf, sizeof(errbuf));
681 err = bpf__foreach_event(obj, add_bpf_event, ¶m);
683 snprintf(errbuf, sizeof(errbuf),
684 "Attach events in BPF object failed");
690 parse_state->error->help = strdup("(add -v to see detail)");
691 parse_state->error->str = strdup(errbuf);
696 parse_events_config_bpf(struct parse_events_state *parse_state,
697 struct bpf_object *obj,
698 struct list_head *head_config)
700 struct parse_events_term *term;
703 if (!head_config || list_empty(head_config))
706 list_for_each_entry(term, head_config, list) {
710 if (term->type_term != PARSE_EVENTS__TERM_TYPE_USER) {
711 snprintf(errbuf, sizeof(errbuf),
712 "Invalid config term for BPF object");
713 errbuf[BUFSIZ - 1] = '\0';
715 parse_state->error->idx = term->err_term;
716 parse_state->error->str = strdup(errbuf);
720 err = bpf__config_obj(obj, term, parse_state->evlist, &error_pos);
722 bpf__strerror_config_obj(obj, term, parse_state->evlist,
723 &error_pos, err, errbuf,
725 parse_state->error->help = strdup(
726 "Hint:\tValid config terms:\n"
727 " \tmap:[<arraymap>].value<indices>=[value]\n"
728 " \tmap:[<eventmap>].event<indices>=[event]\n"
730 " \twhere <indices> is something like [0,3...5] or [all]\n"
731 " \t(add -v to see detail)");
732 parse_state->error->str = strdup(errbuf);
733 if (err == -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE)
734 parse_state->error->idx = term->err_val;
736 parse_state->error->idx = term->err_term + error_pos;
744 * Split config terms:
745 * perf record -e bpf.c/call-graph=fp,map:array.value[0]=1/ ...
746 * 'call-graph=fp' is 'evt config', should be applied to each
748 * 'map:array.value[0]=1' is 'obj config', should be processed
749 * with parse_events_config_bpf.
751 * Move object config terms from the first list to obj_head_config.
754 split_bpf_config_terms(struct list_head *evt_head_config,
755 struct list_head *obj_head_config)
757 struct parse_events_term *term, *temp;
760 * Currectly, all possible user config term
761 * belong to bpf object. parse_events__is_hardcoded_term()
762 * happends to be a good flag.
764 * See parse_events_config_bpf() and
765 * config_term_tracepoint().
767 list_for_each_entry_safe(term, temp, evt_head_config, list)
768 if (!parse_events__is_hardcoded_term(term))
769 list_move_tail(&term->list, obj_head_config);
772 int parse_events_load_bpf(struct parse_events_state *parse_state,
773 struct list_head *list,
776 struct list_head *head_config)
779 struct bpf_object *obj;
780 LIST_HEAD(obj_head_config);
783 split_bpf_config_terms(head_config, &obj_head_config);
785 obj = bpf__prepare_load(bpf_file_name, source);
792 snprintf(errbuf, sizeof(errbuf),
793 "BPF support is not compiled");
795 bpf__strerror_prepare_load(bpf_file_name,
800 parse_state->error->help = strdup("(add -v to see detail)");
801 parse_state->error->str = strdup(errbuf);
805 err = parse_events_load_bpf_obj(parse_state, list, obj, head_config);
808 err = parse_events_config_bpf(parse_state, obj, &obj_head_config);
811 * Caller doesn't know anything about obj_head_config,
812 * so combine them together again before returnning.
815 list_splice_tail(&obj_head_config, head_config);
820 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
824 for (i = 0; i < 3; i++) {
825 if (!type || !type[i])
828 #define CHECK_SET_TYPE(bit) \
830 if (attr->bp_type & bit) \
833 attr->bp_type |= bit; \
838 CHECK_SET_TYPE(HW_BREAKPOINT_R);
841 CHECK_SET_TYPE(HW_BREAKPOINT_W);
844 CHECK_SET_TYPE(HW_BREAKPOINT_X);
851 #undef CHECK_SET_TYPE
853 if (!attr->bp_type) /* Default */
854 attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
859 int parse_events_add_breakpoint(struct list_head *list, int *idx,
860 void *ptr, char *type, u64 len)
862 struct perf_event_attr attr;
864 memset(&attr, 0, sizeof(attr));
865 attr.bp_addr = (unsigned long) ptr;
867 if (parse_breakpoint_type(type, &attr))
870 /* Provide some defaults if len is not specified */
872 if (attr.bp_type == HW_BREAKPOINT_X)
875 len = HW_BREAKPOINT_LEN_4;
880 attr.type = PERF_TYPE_BREAKPOINT;
881 attr.sample_period = 1;
883 return add_event(list, idx, &attr, NULL, NULL);
886 static int check_type_val(struct parse_events_term *term,
887 struct parse_events_error *err,
890 if (type == term->type_val)
894 err->idx = term->err_val;
895 if (type == PARSE_EVENTS__TERM_TYPE_NUM)
896 err->str = strdup("expected numeric value");
898 err->str = strdup("expected string value");
904 * Update according to parse-events.l
906 static const char *config_term_names[__PARSE_EVENTS__TERM_TYPE_NR] = {
907 [PARSE_EVENTS__TERM_TYPE_USER] = "<sysfs term>",
908 [PARSE_EVENTS__TERM_TYPE_CONFIG] = "config",
909 [PARSE_EVENTS__TERM_TYPE_CONFIG1] = "config1",
910 [PARSE_EVENTS__TERM_TYPE_CONFIG2] = "config2",
911 [PARSE_EVENTS__TERM_TYPE_NAME] = "name",
912 [PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD] = "period",
913 [PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ] = "freq",
914 [PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE] = "branch_type",
915 [PARSE_EVENTS__TERM_TYPE_TIME] = "time",
916 [PARSE_EVENTS__TERM_TYPE_CALLGRAPH] = "call-graph",
917 [PARSE_EVENTS__TERM_TYPE_STACKSIZE] = "stack-size",
918 [PARSE_EVENTS__TERM_TYPE_NOINHERIT] = "no-inherit",
919 [PARSE_EVENTS__TERM_TYPE_INHERIT] = "inherit",
920 [PARSE_EVENTS__TERM_TYPE_MAX_STACK] = "max-stack",
921 [PARSE_EVENTS__TERM_TYPE_OVERWRITE] = "overwrite",
922 [PARSE_EVENTS__TERM_TYPE_NOOVERWRITE] = "no-overwrite",
923 [PARSE_EVENTS__TERM_TYPE_DRV_CFG] = "driver-config",
926 static bool config_term_shrinked;
929 config_term_avail(int term_type, struct parse_events_error *err)
931 if (term_type < 0 || term_type >= __PARSE_EVENTS__TERM_TYPE_NR) {
932 err->str = strdup("Invalid term_type");
935 if (!config_term_shrinked)
939 case PARSE_EVENTS__TERM_TYPE_CONFIG:
940 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
941 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
942 case PARSE_EVENTS__TERM_TYPE_NAME:
943 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
949 /* term_type is validated so indexing is safe */
950 if (asprintf(&err->str, "'%s' is not usable in 'perf stat'",
951 config_term_names[term_type]) < 0)
957 void parse_events__shrink_config_terms(void)
959 config_term_shrinked = true;
962 static int config_term_common(struct perf_event_attr *attr,
963 struct parse_events_term *term,
964 struct parse_events_error *err)
966 #define CHECK_TYPE_VAL(type) \
968 if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
972 switch (term->type_term) {
973 case PARSE_EVENTS__TERM_TYPE_CONFIG:
975 attr->config = term->val.num;
977 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
979 attr->config1 = term->val.num;
981 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
983 attr->config2 = term->val.num;
985 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
988 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
991 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
993 if (strcmp(term->val.str, "no") &&
994 parse_branch_str(term->val.str, &attr->branch_sample_type)) {
995 err->str = strdup("invalid branch sample type");
996 err->idx = term->err_val;
1000 case PARSE_EVENTS__TERM_TYPE_TIME:
1001 CHECK_TYPE_VAL(NUM);
1002 if (term->val.num > 1) {
1003 err->str = strdup("expected 0 or 1");
1004 err->idx = term->err_val;
1008 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1009 CHECK_TYPE_VAL(STR);
1011 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1012 CHECK_TYPE_VAL(NUM);
1014 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1015 CHECK_TYPE_VAL(NUM);
1017 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1018 CHECK_TYPE_VAL(NUM);
1020 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1021 CHECK_TYPE_VAL(NUM);
1023 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1024 CHECK_TYPE_VAL(NUM);
1026 case PARSE_EVENTS__TERM_TYPE_NAME:
1027 CHECK_TYPE_VAL(STR);
1029 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1030 CHECK_TYPE_VAL(NUM);
1033 err->str = strdup("unknown term");
1034 err->idx = term->err_term;
1035 err->help = parse_events_formats_error_string(NULL);
1040 * Check term availbility after basic checking so
1041 * PARSE_EVENTS__TERM_TYPE_USER can be found and filtered.
1043 * If check availbility at the entry of this function,
1044 * user will see "'<sysfs term>' is not usable in 'perf stat'"
1045 * if an invalid config term is provided for legacy events
1046 * (for example, instructions/badterm/...), which is confusing.
1048 if (!config_term_avail(term->type_term, err))
1051 #undef CHECK_TYPE_VAL
1054 static int config_term_pmu(struct perf_event_attr *attr,
1055 struct parse_events_term *term,
1056 struct parse_events_error *err)
1058 if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER ||
1059 term->type_term == PARSE_EVENTS__TERM_TYPE_DRV_CFG)
1061 * Always succeed for sysfs terms, as we dont know
1062 * at this point what type they need to have.
1066 return config_term_common(attr, term, err);
1069 static int config_term_tracepoint(struct perf_event_attr *attr,
1070 struct parse_events_term *term,
1071 struct parse_events_error *err)
1073 switch (term->type_term) {
1074 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1075 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1076 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1077 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1078 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1079 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1080 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1081 return config_term_common(attr, term, err);
1084 err->idx = term->err_term;
1085 err->str = strdup("unknown term");
1086 err->help = strdup("valid terms: call-graph,stack-size\n");
1094 static int config_attr(struct perf_event_attr *attr,
1095 struct list_head *head,
1096 struct parse_events_error *err,
1097 config_term_func_t config_term)
1099 struct parse_events_term *term;
1101 list_for_each_entry(term, head, list)
1102 if (config_term(attr, term, err))
1108 static int get_config_terms(struct list_head *head_config,
1109 struct list_head *head_terms __maybe_unused)
1111 #define ADD_CONFIG_TERM(__type, __name, __val) \
1113 struct perf_evsel_config_term *__t; \
1115 __t = zalloc(sizeof(*__t)); \
1119 INIT_LIST_HEAD(&__t->list); \
1120 __t->type = PERF_EVSEL__CONFIG_TERM_ ## __type; \
1121 __t->val.__name = __val; \
1122 __t->weak = term->weak; \
1123 list_add_tail(&__t->list, head_terms); \
1126 struct parse_events_term *term;
1128 list_for_each_entry(term, head_config, list) {
1129 switch (term->type_term) {
1130 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1131 ADD_CONFIG_TERM(PERIOD, period, term->val.num);
1133 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1134 ADD_CONFIG_TERM(FREQ, freq, term->val.num);
1136 case PARSE_EVENTS__TERM_TYPE_TIME:
1137 ADD_CONFIG_TERM(TIME, time, term->val.num);
1139 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1140 ADD_CONFIG_TERM(CALLGRAPH, callgraph, term->val.str);
1142 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1143 ADD_CONFIG_TERM(BRANCH, branch, term->val.str);
1145 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1146 ADD_CONFIG_TERM(STACK_USER, stack_user, term->val.num);
1148 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1149 ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 1 : 0);
1151 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1152 ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 0 : 1);
1154 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1155 ADD_CONFIG_TERM(MAX_STACK, max_stack, term->val.num);
1157 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1158 ADD_CONFIG_TERM(OVERWRITE, overwrite, term->val.num ? 1 : 0);
1160 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1161 ADD_CONFIG_TERM(OVERWRITE, overwrite, term->val.num ? 0 : 1);
1163 case PARSE_EVENTS__TERM_TYPE_DRV_CFG:
1164 ADD_CONFIG_TERM(DRV_CFG, drv_cfg, term->val.str);
1170 #undef ADD_EVSEL_CONFIG
1174 int parse_events_add_tracepoint(struct list_head *list, int *idx,
1175 const char *sys, const char *event,
1176 struct parse_events_error *err,
1177 struct list_head *head_config)
1180 struct perf_event_attr attr;
1182 if (config_attr(&attr, head_config, err,
1183 config_term_tracepoint))
1187 if (strpbrk(sys, "*?"))
1188 return add_tracepoint_multi_sys(list, idx, sys, event,
1191 return add_tracepoint_event(list, idx, sys, event,
1195 int parse_events_add_numeric(struct parse_events_state *parse_state,
1196 struct list_head *list,
1197 u32 type, u64 config,
1198 struct list_head *head_config)
1200 struct perf_event_attr attr;
1201 LIST_HEAD(config_terms);
1203 memset(&attr, 0, sizeof(attr));
1205 attr.config = config;
1208 if (config_attr(&attr, head_config, parse_state->error,
1209 config_term_common))
1212 if (get_config_terms(head_config, &config_terms))
1216 return add_event(list, &parse_state->idx, &attr,
1217 get_config_name(head_config), &config_terms);
1220 int parse_events_add_pmu(struct parse_events_state *parse_state,
1221 struct list_head *list, char *name,
1222 struct list_head *head_config,
1223 bool auto_merge_stats,
1226 struct perf_event_attr attr;
1227 struct perf_pmu_info info;
1228 struct perf_pmu *pmu;
1229 struct perf_evsel *evsel;
1230 struct parse_events_error *err = parse_state->error;
1231 bool use_uncore_alias;
1232 LIST_HEAD(config_terms);
1234 pmu = perf_pmu__find(name);
1236 if (asprintf(&err->str,
1237 "Cannot find PMU `%s'. Missing kernel support?",
1243 if (pmu->default_config) {
1244 memcpy(&attr, pmu->default_config,
1245 sizeof(struct perf_event_attr));
1247 memset(&attr, 0, sizeof(attr));
1250 use_uncore_alias = (pmu->is_uncore && use_alias);
1253 attr.type = pmu->type;
1254 evsel = __add_event(list, &parse_state->idx, &attr, NULL, pmu, NULL, auto_merge_stats);
1256 evsel->pmu_name = name;
1257 evsel->use_uncore_alias = use_uncore_alias;
1264 if (perf_pmu__check_alias(pmu, head_config, &info))
1268 * Configure hardcoded terms first, no need to check
1269 * return value when called with fail == 0 ;)
1271 if (config_attr(&attr, head_config, parse_state->error, config_term_pmu))
1274 if (get_config_terms(head_config, &config_terms))
1277 if (perf_pmu__config(pmu, &attr, head_config, parse_state->error))
1280 evsel = __add_event(list, &parse_state->idx, &attr,
1281 get_config_name(head_config), pmu,
1282 &config_terms, auto_merge_stats);
1284 evsel->unit = info.unit;
1285 evsel->scale = info.scale;
1286 evsel->per_pkg = info.per_pkg;
1287 evsel->snapshot = info.snapshot;
1288 evsel->metric_expr = info.metric_expr;
1289 evsel->metric_name = info.metric_name;
1290 evsel->pmu_name = name;
1291 evsel->use_uncore_alias = use_uncore_alias;
1294 return evsel ? 0 : -ENOMEM;
1297 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
1298 char *str, struct list_head **listp)
1300 struct list_head *head;
1301 struct parse_events_term *term;
1302 struct list_head *list;
1303 struct perf_pmu *pmu = NULL;
1307 /* Add it for all PMUs that support the alias */
1308 list = malloc(sizeof(struct list_head));
1311 INIT_LIST_HEAD(list);
1312 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1313 struct perf_pmu_alias *alias;
1315 list_for_each_entry(alias, &pmu->aliases, list) {
1316 if (!strcasecmp(alias->name, str)) {
1317 head = malloc(sizeof(struct list_head));
1320 INIT_LIST_HEAD(head);
1321 if (parse_events_term__num(&term, PARSE_EVENTS__TERM_TYPE_USER,
1322 str, 1, false, &str, NULL) < 0)
1324 list_add_tail(&term->list, head);
1326 if (!parse_events_add_pmu(parse_state, list,
1329 pr_debug("%s -> %s/%s/\n", str,
1330 pmu->name, alias->str);
1334 parse_events_terms__delete(head);
1344 int parse_events__modifier_group(struct list_head *list,
1347 return parse_events__modifier_event(list, event_mod, true);
1351 * Check if the two uncore PMUs are from the same uncore block
1352 * The format of the uncore PMU name is uncore_#blockname_#pmuidx
1354 static bool is_same_uncore_block(const char *pmu_name_a, const char *pmu_name_b)
1356 char *end_a, *end_b;
1358 end_a = strrchr(pmu_name_a, '_');
1359 end_b = strrchr(pmu_name_b, '_');
1361 if (!end_a || !end_b)
1364 if ((end_a - pmu_name_a) != (end_b - pmu_name_b))
1367 return (strncmp(pmu_name_a, pmu_name_b, end_a - pmu_name_a) == 0);
1371 parse_events__set_leader_for_uncore_aliase(char *name, struct list_head *list,
1372 struct parse_events_state *parse_state)
1374 struct perf_evsel *evsel, *leader;
1376 bool is_leader = true;
1377 int i, nr_pmu = 0, total_members, ret = 0;
1379 leader = list_first_entry(list, struct perf_evsel, node);
1380 evsel = list_last_entry(list, struct perf_evsel, node);
1381 total_members = evsel->idx - leader->idx + 1;
1383 leaders = calloc(total_members, sizeof(uintptr_t));
1384 if (WARN_ON(!leaders))
1388 * Going through the whole group and doing sanity check.
1389 * All members must use alias, and be from the same uncore block.
1390 * Also, storing the leader events in an array.
1392 __evlist__for_each_entry(list, evsel) {
1394 /* Only split the uncore group which members use alias */
1395 if (!evsel->use_uncore_alias)
1398 /* The events must be from the same uncore block */
1399 if (!is_same_uncore_block(leader->pmu_name, evsel->pmu_name))
1405 * If the event's PMU name starts to repeat, it must be a new
1406 * event. That can be used to distinguish the leader from
1407 * other members, even they have the same event name.
1409 if ((leader != evsel) && (leader->pmu_name == evsel->pmu_name)) {
1413 /* The name is always alias name */
1414 WARN_ON(strcmp(leader->name, evsel->name));
1416 /* Store the leader event for each PMU */
1417 leaders[nr_pmu++] = (uintptr_t) evsel;
1420 /* only one event alias */
1421 if (nr_pmu == total_members) {
1422 parse_state->nr_groups--;
1427 * An uncore event alias is a joint name which means the same event
1428 * runs on all PMUs of a block.
1429 * Perf doesn't support mixed events from different PMUs in the same
1430 * group. The big group has to be split into multiple small groups
1431 * which only include the events from the same PMU.
1433 * Here the uncore event aliases must be from the same uncore block.
1434 * The number of PMUs must be same for each alias. The number of new
1435 * small groups equals to the number of PMUs.
1436 * Setting the leader event for corresponding members in each group.
1439 __evlist__for_each_entry(list, evsel) {
1442 evsel->leader = (struct perf_evsel *) leaders[i++];
1445 /* The number of members and group name are same for each group */
1446 for (i = 0; i < nr_pmu; i++) {
1447 evsel = (struct perf_evsel *) leaders[i];
1448 evsel->nr_members = total_members / nr_pmu;
1449 evsel->group_name = name ? strdup(name) : NULL;
1452 /* Take the new small groups into account */
1453 parse_state->nr_groups += nr_pmu - 1;
1462 void parse_events__set_leader(char *name, struct list_head *list,
1463 struct parse_events_state *parse_state)
1465 struct perf_evsel *leader;
1467 if (list_empty(list)) {
1468 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1472 if (parse_events__set_leader_for_uncore_aliase(name, list, parse_state))
1475 __perf_evlist__set_leader(list);
1476 leader = list_entry(list->next, struct perf_evsel, node);
1477 leader->group_name = name ? strdup(name) : NULL;
1480 /* list_event is assumed to point to malloc'ed memory */
1481 void parse_events_update_lists(struct list_head *list_event,
1482 struct list_head *list_all)
1485 * Called for single event definition. Update the
1486 * 'all event' list, and reinit the 'single event'
1487 * list, for next event definition.
1489 list_splice_tail(list_event, list_all);
1493 struct event_modifier {
1508 static int get_event_modifier(struct event_modifier *mod, char *str,
1509 struct perf_evsel *evsel)
1511 int eu = evsel ? evsel->attr.exclude_user : 0;
1512 int ek = evsel ? evsel->attr.exclude_kernel : 0;
1513 int eh = evsel ? evsel->attr.exclude_hv : 0;
1514 int eH = evsel ? evsel->attr.exclude_host : 0;
1515 int eG = evsel ? evsel->attr.exclude_guest : 0;
1516 int eI = evsel ? evsel->attr.exclude_idle : 0;
1517 int precise = evsel ? evsel->attr.precise_ip : 0;
1518 int precise_max = 0;
1519 int sample_read = 0;
1520 int pinned = evsel ? evsel->attr.pinned : 0;
1522 int exclude = eu | ek | eh;
1523 int exclude_GH = evsel ? evsel->exclude_GH : 0;
1526 memset(mod, 0, sizeof(*mod));
1531 exclude = eu = ek = eh = 1;
1533 } else if (*str == 'k') {
1535 exclude = eu = ek = eh = 1;
1537 } else if (*str == 'h') {
1539 exclude = eu = ek = eh = 1;
1541 } else if (*str == 'G') {
1543 exclude_GH = eG = eH = 1;
1545 } else if (*str == 'H') {
1547 exclude_GH = eG = eH = 1;
1549 } else if (*str == 'I') {
1551 } else if (*str == 'p') {
1553 /* use of precise requires exclude_guest */
1556 } else if (*str == 'P') {
1558 } else if (*str == 'S') {
1560 } else if (*str == 'D') {
1562 } else if (*str == 'W') {
1573 * 0 - SAMPLE_IP can have arbitrary skid
1574 * 1 - SAMPLE_IP must have constant skid
1575 * 2 - SAMPLE_IP requested to have 0 skid
1576 * 3 - SAMPLE_IP must have 0 skid
1578 * See also PERF_RECORD_MISC_EXACT_IP
1589 mod->precise = precise;
1590 mod->precise_max = precise_max;
1591 mod->exclude_GH = exclude_GH;
1592 mod->sample_read = sample_read;
1593 mod->pinned = pinned;
1600 * Basic modifier sanity check to validate it contains only one
1601 * instance of any modifier (apart from 'p') present.
1603 static int check_modifier(char *str)
1607 /* The sizeof includes 0 byte as well. */
1608 if (strlen(str) > (sizeof("ukhGHpppPSDIW") - 1))
1612 if (*p != 'p' && strchr(p + 1, *p))
1620 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
1622 struct perf_evsel *evsel;
1623 struct event_modifier mod;
1628 if (check_modifier(str))
1631 if (!add && get_event_modifier(&mod, str, NULL))
1634 __evlist__for_each_entry(list, evsel) {
1635 if (add && get_event_modifier(&mod, str, evsel))
1638 evsel->attr.exclude_user = mod.eu;
1639 evsel->attr.exclude_kernel = mod.ek;
1640 evsel->attr.exclude_hv = mod.eh;
1641 evsel->attr.precise_ip = mod.precise;
1642 evsel->attr.exclude_host = mod.eH;
1643 evsel->attr.exclude_guest = mod.eG;
1644 evsel->attr.exclude_idle = mod.eI;
1645 evsel->exclude_GH = mod.exclude_GH;
1646 evsel->sample_read = mod.sample_read;
1647 evsel->precise_max = mod.precise_max;
1648 evsel->weak_group = mod.weak;
1650 if (perf_evsel__is_group_leader(evsel))
1651 evsel->attr.pinned = mod.pinned;
1657 int parse_events_name(struct list_head *list, char *name)
1659 struct perf_evsel *evsel;
1661 __evlist__for_each_entry(list, evsel) {
1663 evsel->name = strdup(name);
1670 comp_pmu(const void *p1, const void *p2)
1672 struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
1673 struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
1675 return strcasecmp(pmu1->symbol, pmu2->symbol);
1678 static void perf_pmu__parse_cleanup(void)
1680 if (perf_pmu_events_list_num > 0) {
1681 struct perf_pmu_event_symbol *p;
1684 for (i = 0; i < perf_pmu_events_list_num; i++) {
1685 p = perf_pmu_events_list + i;
1688 zfree(&perf_pmu_events_list);
1689 perf_pmu_events_list_num = 0;
1693 #define SET_SYMBOL(str, stype) \
1702 * Read the pmu events list from sysfs
1703 * Save it into perf_pmu_events_list
1705 static void perf_pmu__parse_init(void)
1708 struct perf_pmu *pmu = NULL;
1709 struct perf_pmu_alias *alias;
1713 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1714 list_for_each_entry(alias, &pmu->aliases, list) {
1715 if (strchr(alias->name, '-'))
1722 perf_pmu_events_list_num = -1;
1725 perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
1726 if (!perf_pmu_events_list)
1728 perf_pmu_events_list_num = len;
1732 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1733 list_for_each_entry(alias, &pmu->aliases, list) {
1734 struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
1735 char *tmp = strchr(alias->name, '-');
1738 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
1739 PMU_EVENT_SYMBOL_PREFIX);
1741 SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
1744 SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
1749 qsort(perf_pmu_events_list, len,
1750 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1754 perf_pmu__parse_cleanup();
1757 enum perf_pmu_event_symbol_type
1758 perf_pmu__parse_check(const char *name)
1760 struct perf_pmu_event_symbol p, *r;
1762 /* scan kernel pmu events from sysfs if needed */
1763 if (perf_pmu_events_list_num == 0)
1764 perf_pmu__parse_init();
1766 * name "cpu" could be prefix of cpu-cycles or cpu// events.
1767 * cpu-cycles has been handled by hardcode.
1768 * So it must be cpu// events, not kernel pmu event.
1770 if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
1771 return PMU_EVENT_SYMBOL_ERR;
1773 p.symbol = strdup(name);
1774 r = bsearch(&p, perf_pmu_events_list,
1775 (size_t) perf_pmu_events_list_num,
1776 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1778 return r ? r->type : PMU_EVENT_SYMBOL_ERR;
1781 static int parse_events__scanner(const char *str, void *parse_state, int start_token)
1783 YY_BUFFER_STATE buffer;
1787 ret = parse_events_lex_init_extra(start_token, &scanner);
1791 buffer = parse_events__scan_string(str, scanner);
1794 parse_events_debug = 1;
1796 ret = parse_events_parse(parse_state, scanner);
1798 parse_events__flush_buffer(buffer, scanner);
1799 parse_events__delete_buffer(buffer, scanner);
1800 parse_events_lex_destroy(scanner);
1805 * parse event config string, return a list of event terms.
1807 int parse_events_terms(struct list_head *terms, const char *str)
1809 struct parse_events_state parse_state = {
1814 ret = parse_events__scanner(str, &parse_state, PE_START_TERMS);
1816 list_splice(parse_state.terms, terms);
1817 zfree(&parse_state.terms);
1821 parse_events_terms__delete(parse_state.terms);
1825 int parse_events(struct perf_evlist *evlist, const char *str,
1826 struct parse_events_error *err)
1828 struct parse_events_state parse_state = {
1829 .list = LIST_HEAD_INIT(parse_state.list),
1830 .idx = evlist->nr_entries,
1836 ret = parse_events__scanner(str, &parse_state, PE_START_EVENTS);
1837 perf_pmu__parse_cleanup();
1839 struct perf_evsel *last;
1841 if (list_empty(&parse_state.list)) {
1842 WARN_ONCE(true, "WARNING: event parser found nothing\n");
1846 perf_evlist__splice_list_tail(evlist, &parse_state.list);
1847 evlist->nr_groups += parse_state.nr_groups;
1848 last = perf_evlist__last(evlist);
1849 last->cmdline_group_boundary = true;
1855 * There are 2 users - builtin-record and builtin-test objects.
1856 * Both call perf_evlist__delete in case of error, so we dont
1862 #define MAX_WIDTH 1000
1863 static int get_term_width(void)
1867 get_term_dimensions(&ws);
1868 return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
1871 void parse_events_print_error(struct parse_events_error *err,
1874 const char *str = "invalid or unsupported event: ";
1875 char _buf[MAX_WIDTH];
1876 char *buf = (char *) event;
1880 /* -2 for extra '' in the final fprintf */
1881 int width = get_term_width() - 2;
1882 int len_event = strlen(event);
1883 int len_str, max_len, cut = 0;
1886 * Maximum error index indent, we will cut
1887 * the event string if it's bigger.
1889 int max_err_idx = 13;
1892 * Let's be specific with the message when
1893 * we have the precise error.
1895 str = "event syntax error: ";
1896 len_str = strlen(str);
1897 max_len = width - len_str;
1901 /* We're cutting from the beginning. */
1902 if (err->idx > max_err_idx)
1903 cut = err->idx - max_err_idx;
1905 strncpy(buf, event + cut, max_len);
1907 /* Mark cut parts with '..' on both sides. */
1909 buf[0] = buf[1] = '.';
1911 if ((len_event - cut) > max_len) {
1912 buf[max_len - 1] = buf[max_len - 2] = '.';
1916 idx = len_str + err->idx - cut;
1919 fprintf(stderr, "%s'%s'\n", str, buf);
1921 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err->str);
1923 fprintf(stderr, "\n%s\n", err->help);
1931 int parse_events_option(const struct option *opt, const char *str,
1932 int unset __maybe_unused)
1934 struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1935 struct parse_events_error err = { .idx = 0, };
1936 int ret = parse_events(evlist, str, &err);
1939 parse_events_print_error(&err, str);
1940 fprintf(stderr, "Run 'perf list' for a list of valid events\n");
1947 foreach_evsel_in_last_glob(struct perf_evlist *evlist,
1948 int (*func)(struct perf_evsel *evsel,
1952 struct perf_evsel *last = NULL;
1956 * Don't return when list_empty, give func a chance to report
1957 * error when it found last == NULL.
1959 * So no need to WARN here, let *func do this.
1961 if (evlist->nr_entries > 0)
1962 last = perf_evlist__last(evlist);
1965 err = (*func)(last, arg);
1971 if (last->node.prev == &evlist->entries)
1973 last = list_entry(last->node.prev, struct perf_evsel, node);
1974 } while (!last->cmdline_group_boundary);
1979 static int set_filter(struct perf_evsel *evsel, const void *arg)
1981 const char *str = arg;
1983 int nr_addr_filters = 0;
1984 struct perf_pmu *pmu = NULL;
1989 if (evsel->attr.type == PERF_TYPE_TRACEPOINT) {
1990 if (perf_evsel__append_tp_filter(evsel, str) < 0) {
1992 "not enough memory to hold filter string\n");
1999 while ((pmu = perf_pmu__scan(pmu)) != NULL)
2000 if (pmu->type == evsel->attr.type) {
2006 perf_pmu__scan_file(pmu, "nr_addr_filters",
2007 "%d", &nr_addr_filters);
2009 if (!nr_addr_filters)
2012 if (perf_evsel__append_addr_filter(evsel, str) < 0) {
2014 "not enough memory to hold filter string\n");
2022 "--filter option should follow a -e tracepoint or HW tracer option\n");
2027 int parse_filter(const struct option *opt, const char *str,
2028 int unset __maybe_unused)
2030 struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
2032 return foreach_evsel_in_last_glob(evlist, set_filter,
2036 static int add_exclude_perf_filter(struct perf_evsel *evsel,
2037 const void *arg __maybe_unused)
2039 char new_filter[64];
2041 if (evsel == NULL || evsel->attr.type != PERF_TYPE_TRACEPOINT) {
2043 "--exclude-perf option should follow a -e tracepoint option\n");
2047 snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
2049 if (perf_evsel__append_tp_filter(evsel, new_filter) < 0) {
2051 "not enough memory to hold filter string\n");
2058 int exclude_perf(const struct option *opt,
2059 const char *arg __maybe_unused,
2060 int unset __maybe_unused)
2062 struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
2064 return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
2068 static const char * const event_type_descriptors[] = {
2072 "Hardware cache event",
2073 "Raw hardware event descriptor",
2074 "Hardware breakpoint",
2077 static int cmp_string(const void *a, const void *b)
2079 const char * const *as = a;
2080 const char * const *bs = b;
2082 return strcmp(*as, *bs);
2086 * Print the events from <debugfs_mount_point>/tracing/events
2089 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
2092 DIR *sys_dir, *evt_dir;
2093 struct dirent *sys_dirent, *evt_dirent;
2094 char evt_path[MAXPATHLEN];
2095 char dir_path[MAXPATHLEN];
2096 char **evt_list = NULL;
2097 unsigned int evt_i = 0, evt_num = 0;
2098 bool evt_num_known = false;
2101 sys_dir = opendir(tracing_events_path);
2105 if (evt_num_known) {
2106 evt_list = zalloc(sizeof(char *) * evt_num);
2108 goto out_close_sys_dir;
2111 for_each_subsystem(sys_dir, sys_dirent) {
2112 if (subsys_glob != NULL &&
2113 !strglobmatch(sys_dirent->d_name, subsys_glob))
2116 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
2117 sys_dirent->d_name);
2118 evt_dir = opendir(dir_path);
2122 for_each_event(sys_dirent, evt_dir, evt_dirent) {
2123 if (event_glob != NULL &&
2124 !strglobmatch(evt_dirent->d_name, event_glob))
2127 if (!evt_num_known) {
2132 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2133 sys_dirent->d_name, evt_dirent->d_name);
2135 evt_list[evt_i] = strdup(evt_path);
2136 if (evt_list[evt_i] == NULL)
2137 goto out_close_evt_dir;
2144 if (!evt_num_known) {
2145 evt_num_known = true;
2148 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2150 while (evt_i < evt_num) {
2152 printf("%s ", evt_list[evt_i++]);
2155 printf(" %-50s [%s]\n", evt_list[evt_i++],
2156 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2158 if (evt_num && pager_in_use())
2163 for (evt_i = 0; evt_i < evt_num; evt_i++)
2164 zfree(&evt_list[evt_i]);
2173 printf("FATAL: not enough memory to print %s\n",
2174 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2180 * Check whether event is in <debugfs_mount_point>/tracing/events
2183 int is_valid_tracepoint(const char *event_string)
2185 DIR *sys_dir, *evt_dir;
2186 struct dirent *sys_dirent, *evt_dirent;
2187 char evt_path[MAXPATHLEN];
2188 char dir_path[MAXPATHLEN];
2190 sys_dir = opendir(tracing_events_path);
2194 for_each_subsystem(sys_dir, sys_dirent) {
2196 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
2197 sys_dirent->d_name);
2198 evt_dir = opendir(dir_path);
2202 for_each_event(sys_dirent, evt_dir, evt_dirent) {
2203 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2204 sys_dirent->d_name, evt_dirent->d_name);
2205 if (!strcmp(evt_path, event_string)) {
2217 static bool is_event_supported(u8 type, unsigned config)
2221 struct perf_evsel *evsel;
2222 struct perf_event_attr attr = {
2227 struct thread_map *tmap = thread_map__new_by_tid(0);
2232 evsel = perf_evsel__new(&attr);
2234 open_return = perf_evsel__open(evsel, NULL, tmap);
2235 ret = open_return >= 0;
2237 if (open_return == -EACCES) {
2239 * This happens if the paranoid value
2240 * /proc/sys/kernel/perf_event_paranoid is set to 2
2241 * Re-run with exclude_kernel set; we don't do that
2242 * by default as some ARM machines do not support it.
2245 evsel->attr.exclude_kernel = 1;
2246 ret = perf_evsel__open(evsel, NULL, tmap) >= 0;
2248 perf_evsel__delete(evsel);
2254 void print_sdt_events(const char *subsys_glob, const char *event_glob,
2257 struct probe_cache *pcache;
2258 struct probe_cache_entry *ent;
2259 struct strlist *bidlist, *sdtlist;
2260 struct strlist_config cfg = {.dont_dupstr = true};
2261 struct str_node *nd, *nd2;
2262 char *buf, *path, *ptr = NULL;
2263 bool show_detail = false;
2266 sdtlist = strlist__new(NULL, &cfg);
2268 pr_debug("Failed to allocate new strlist for SDT\n");
2271 bidlist = build_id_cache__list_all(true);
2273 pr_debug("Failed to get buildids: %d\n", errno);
2276 strlist__for_each_entry(nd, bidlist) {
2277 pcache = probe_cache__new(nd->s, NULL);
2280 list_for_each_entry(ent, &pcache->entries, node) {
2284 !strglobmatch(ent->pev.group, subsys_glob))
2287 !strglobmatch(ent->pev.event, event_glob))
2289 ret = asprintf(&buf, "%s:%s@%s", ent->pev.group,
2290 ent->pev.event, nd->s);
2292 strlist__add(sdtlist, buf);
2294 probe_cache__delete(pcache);
2296 strlist__delete(bidlist);
2298 strlist__for_each_entry(nd, sdtlist) {
2299 buf = strchr(nd->s, '@');
2303 printf("%s ", nd->s);
2306 nd2 = strlist__next(nd);
2308 ptr = strchr(nd2->s, '@');
2311 if (strcmp(nd->s, nd2->s) == 0)
2315 path = build_id_cache__origname(buf);
2316 ret = asprintf(&buf, "%s@%s(%.12s)", nd->s, path, buf);
2318 printf(" %-50s [%s]\n", buf, "SDT event");
2322 printf(" %-50s [%s]\n", nd->s, "SDT event");
2324 if (strcmp(nd->s, nd2->s) != 0)
2325 show_detail = false;
2330 strlist__delete(sdtlist);
2333 int print_hwcache_events(const char *event_glob, bool name_only)
2335 unsigned int type, op, i, evt_i = 0, evt_num = 0;
2337 char **evt_list = NULL;
2338 bool evt_num_known = false;
2341 if (evt_num_known) {
2342 evt_list = zalloc(sizeof(char *) * evt_num);
2347 for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
2348 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
2349 /* skip invalid cache type */
2350 if (!perf_evsel__is_cache_op_valid(type, op))
2353 for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
2354 __perf_evsel__hw_cache_type_op_res_name(type, op, i,
2355 name, sizeof(name));
2356 if (event_glob != NULL && !strglobmatch(name, event_glob))
2359 if (!is_event_supported(PERF_TYPE_HW_CACHE,
2360 type | (op << 8) | (i << 16)))
2363 if (!evt_num_known) {
2368 evt_list[evt_i] = strdup(name);
2369 if (evt_list[evt_i] == NULL)
2376 if (!evt_num_known) {
2377 evt_num_known = true;
2380 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2382 while (evt_i < evt_num) {
2384 printf("%s ", evt_list[evt_i++]);
2387 printf(" %-50s [%s]\n", evt_list[evt_i++],
2388 event_type_descriptors[PERF_TYPE_HW_CACHE]);
2390 if (evt_num && pager_in_use())
2395 for (evt_i = 0; evt_i < evt_num; evt_i++)
2396 zfree(&evt_list[evt_i]);
2401 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
2407 void print_symbol_events(const char *event_glob, unsigned type,
2408 struct event_symbol *syms, unsigned max,
2411 unsigned int i, evt_i = 0, evt_num = 0;
2412 char name[MAX_NAME_LEN];
2413 char **evt_list = NULL;
2414 bool evt_num_known = false;
2417 if (evt_num_known) {
2418 evt_list = zalloc(sizeof(char *) * evt_num);
2424 for (i = 0; i < max; i++, syms++) {
2426 if (event_glob != NULL && syms->symbol != NULL &&
2427 !(strglobmatch(syms->symbol, event_glob) ||
2428 (syms->alias && strglobmatch(syms->alias, event_glob))))
2431 if (!is_event_supported(type, i))
2434 if (!evt_num_known) {
2439 if (!name_only && strlen(syms->alias))
2440 snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
2442 strncpy(name, syms->symbol, MAX_NAME_LEN);
2444 evt_list[evt_i] = strdup(name);
2445 if (evt_list[evt_i] == NULL)
2450 if (!evt_num_known) {
2451 evt_num_known = true;
2454 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2456 while (evt_i < evt_num) {
2458 printf("%s ", evt_list[evt_i++]);
2461 printf(" %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
2463 if (evt_num && pager_in_use())
2468 for (evt_i = 0; evt_i < evt_num; evt_i++)
2469 zfree(&evt_list[evt_i]);
2474 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
2480 * Print the help text for the event symbols:
2482 void print_events(const char *event_glob, bool name_only, bool quiet_flag,
2483 bool long_desc, bool details_flag)
2485 print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
2486 event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
2488 print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
2489 event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
2491 print_hwcache_events(event_glob, name_only);
2493 print_pmu_events(event_glob, name_only, quiet_flag, long_desc,
2496 if (event_glob != NULL)
2500 printf(" %-50s [%s]\n",
2502 event_type_descriptors[PERF_TYPE_RAW]);
2503 printf(" %-50s [%s]\n",
2504 "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
2505 event_type_descriptors[PERF_TYPE_RAW]);
2507 printf(" (see 'man perf-list' on how to encode it)\n\n");
2509 printf(" %-50s [%s]\n",
2510 "mem:<addr>[/len][:access]",
2511 event_type_descriptors[PERF_TYPE_BREAKPOINT]);
2516 print_tracepoint_events(NULL, NULL, name_only);
2518 print_sdt_events(NULL, NULL, name_only);
2520 metricgroup__print(true, true, NULL, name_only);
2523 int parse_events__is_hardcoded_term(struct parse_events_term *term)
2525 return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
2528 static int new_term(struct parse_events_term **_term,
2529 struct parse_events_term *temp,
2532 struct parse_events_term *term;
2534 term = malloc(sizeof(*term));
2539 INIT_LIST_HEAD(&term->list);
2542 switch (term->type_val) {
2543 case PARSE_EVENTS__TERM_TYPE_NUM:
2544 term->val.num = num;
2546 case PARSE_EVENTS__TERM_TYPE_STR:
2547 term->val.str = str;
2558 int parse_events_term__num(struct parse_events_term **term,
2559 int type_term, char *config, u64 num,
2561 void *loc_term_, void *loc_val_)
2563 YYLTYPE *loc_term = loc_term_;
2564 YYLTYPE *loc_val = loc_val_;
2566 struct parse_events_term temp = {
2567 .type_val = PARSE_EVENTS__TERM_TYPE_NUM,
2568 .type_term = type_term,
2570 .no_value = no_value,
2571 .err_term = loc_term ? loc_term->first_column : 0,
2572 .err_val = loc_val ? loc_val->first_column : 0,
2575 return new_term(term, &temp, NULL, num);
2578 int parse_events_term__str(struct parse_events_term **term,
2579 int type_term, char *config, char *str,
2580 void *loc_term_, void *loc_val_)
2582 YYLTYPE *loc_term = loc_term_;
2583 YYLTYPE *loc_val = loc_val_;
2585 struct parse_events_term temp = {
2586 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2587 .type_term = type_term,
2589 .err_term = loc_term ? loc_term->first_column : 0,
2590 .err_val = loc_val ? loc_val->first_column : 0,
2593 return new_term(term, &temp, str, 0);
2596 int parse_events_term__sym_hw(struct parse_events_term **term,
2597 char *config, unsigned idx)
2599 struct event_symbol *sym;
2600 struct parse_events_term temp = {
2601 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2602 .type_term = PARSE_EVENTS__TERM_TYPE_USER,
2603 .config = config ?: (char *) "event",
2606 BUG_ON(idx >= PERF_COUNT_HW_MAX);
2607 sym = &event_symbols_hw[idx];
2609 return new_term(term, &temp, (char *) sym->symbol, 0);
2612 int parse_events_term__clone(struct parse_events_term **new,
2613 struct parse_events_term *term)
2615 struct parse_events_term temp = {
2616 .type_val = term->type_val,
2617 .type_term = term->type_term,
2618 .config = term->config,
2619 .err_term = term->err_term,
2620 .err_val = term->err_val,
2623 return new_term(new, &temp, term->val.str, term->val.num);
2626 int parse_events_copy_term_list(struct list_head *old,
2627 struct list_head **new)
2629 struct parse_events_term *term, *n;
2637 *new = malloc(sizeof(struct list_head));
2640 INIT_LIST_HEAD(*new);
2642 list_for_each_entry (term, old, list) {
2643 ret = parse_events_term__clone(&n, term);
2646 list_add_tail(&n->list, *new);
2651 void parse_events_terms__purge(struct list_head *terms)
2653 struct parse_events_term *term, *h;
2655 list_for_each_entry_safe(term, h, terms, list) {
2656 if (term->array.nr_ranges)
2657 zfree(&term->array.ranges);
2658 list_del_init(&term->list);
2663 void parse_events_terms__delete(struct list_head *terms)
2667 parse_events_terms__purge(terms);
2671 void parse_events__clear_array(struct parse_events_array *a)
2676 void parse_events_evlist_error(struct parse_events_state *parse_state,
2677 int idx, const char *str)
2679 struct parse_events_error *err = parse_state->error;
2684 err->str = strdup(str);
2685 WARN_ONCE(!err->str, "WARNING: failed to allocate error string");
2688 static void config_terms_list(char *buf, size_t buf_sz)
2694 for (i = 0; i < __PARSE_EVENTS__TERM_TYPE_NR; i++) {
2695 const char *name = config_term_names[i];
2697 if (!config_term_avail(i, NULL))
2704 if (strlen(buf) + strlen(name) + 2 >= buf_sz)
2716 * Return string contains valid config terms of an event.
2717 * @additional_terms: For terms such as PMU sysfs terms.
2719 char *parse_events_formats_error_string(char *additional_terms)
2722 /* "no-overwrite" is the longest name */
2723 char static_terms[__PARSE_EVENTS__TERM_TYPE_NR *
2724 (sizeof("no-overwrite") - 1)];
2726 config_terms_list(static_terms, sizeof(static_terms));
2728 if (additional_terms) {
2729 if (asprintf(&str, "valid terms: %s,%s",
2730 additional_terms, static_terms) < 0)
2733 if (asprintf(&str, "valid terms: %s", static_terms) < 0)