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, bool auto_merge_stats)
1224 struct perf_event_attr attr;
1225 struct perf_pmu_info info;
1226 struct perf_pmu *pmu;
1227 struct perf_evsel *evsel;
1228 struct parse_events_error *err = parse_state->error;
1229 LIST_HEAD(config_terms);
1231 pmu = perf_pmu__find(name);
1233 if (asprintf(&err->str,
1234 "Cannot find PMU `%s'. Missing kernel support?",
1240 if (pmu->default_config) {
1241 memcpy(&attr, pmu->default_config,
1242 sizeof(struct perf_event_attr));
1244 memset(&attr, 0, sizeof(attr));
1248 attr.type = pmu->type;
1249 evsel = __add_event(list, &parse_state->idx, &attr, NULL, pmu, NULL, auto_merge_stats);
1251 evsel->pmu_name = name;
1258 if (perf_pmu__check_alias(pmu, head_config, &info))
1262 * Configure hardcoded terms first, no need to check
1263 * return value when called with fail == 0 ;)
1265 if (config_attr(&attr, head_config, parse_state->error, config_term_pmu))
1268 if (get_config_terms(head_config, &config_terms))
1271 if (perf_pmu__config(pmu, &attr, head_config, parse_state->error))
1274 evsel = __add_event(list, &parse_state->idx, &attr,
1275 get_config_name(head_config), pmu,
1276 &config_terms, auto_merge_stats);
1278 evsel->unit = info.unit;
1279 evsel->scale = info.scale;
1280 evsel->per_pkg = info.per_pkg;
1281 evsel->snapshot = info.snapshot;
1282 evsel->metric_expr = info.metric_expr;
1283 evsel->metric_name = info.metric_name;
1284 evsel->pmu_name = name;
1287 return evsel ? 0 : -ENOMEM;
1290 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
1291 char *str, struct list_head **listp)
1293 struct list_head *head;
1294 struct parse_events_term *term;
1295 struct list_head *list;
1296 struct perf_pmu *pmu = NULL;
1300 /* Add it for all PMUs that support the alias */
1301 list = malloc(sizeof(struct list_head));
1304 INIT_LIST_HEAD(list);
1305 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1306 struct perf_pmu_alias *alias;
1308 list_for_each_entry(alias, &pmu->aliases, list) {
1309 if (!strcasecmp(alias->name, str)) {
1310 head = malloc(sizeof(struct list_head));
1313 INIT_LIST_HEAD(head);
1314 if (parse_events_term__num(&term, PARSE_EVENTS__TERM_TYPE_USER,
1315 str, 1, false, &str, NULL) < 0)
1317 list_add_tail(&term->list, head);
1319 if (!parse_events_add_pmu(parse_state, list,
1320 pmu->name, head, true)) {
1321 pr_debug("%s -> %s/%s/\n", str,
1322 pmu->name, alias->str);
1326 parse_events_terms__delete(head);
1336 int parse_events__modifier_group(struct list_head *list,
1339 return parse_events__modifier_event(list, event_mod, true);
1342 void parse_events__set_leader(char *name, struct list_head *list)
1344 struct perf_evsel *leader;
1346 if (list_empty(list)) {
1347 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1351 __perf_evlist__set_leader(list);
1352 leader = list_entry(list->next, struct perf_evsel, node);
1353 leader->group_name = name ? strdup(name) : NULL;
1356 /* list_event is assumed to point to malloc'ed memory */
1357 void parse_events_update_lists(struct list_head *list_event,
1358 struct list_head *list_all)
1361 * Called for single event definition. Update the
1362 * 'all event' list, and reinit the 'single event'
1363 * list, for next event definition.
1365 list_splice_tail(list_event, list_all);
1369 struct event_modifier {
1384 static int get_event_modifier(struct event_modifier *mod, char *str,
1385 struct perf_evsel *evsel)
1387 int eu = evsel ? evsel->attr.exclude_user : 0;
1388 int ek = evsel ? evsel->attr.exclude_kernel : 0;
1389 int eh = evsel ? evsel->attr.exclude_hv : 0;
1390 int eH = evsel ? evsel->attr.exclude_host : 0;
1391 int eG = evsel ? evsel->attr.exclude_guest : 0;
1392 int eI = evsel ? evsel->attr.exclude_idle : 0;
1393 int precise = evsel ? evsel->attr.precise_ip : 0;
1394 int precise_max = 0;
1395 int sample_read = 0;
1396 int pinned = evsel ? evsel->attr.pinned : 0;
1398 int exclude = eu | ek | eh;
1399 int exclude_GH = evsel ? evsel->exclude_GH : 0;
1402 memset(mod, 0, sizeof(*mod));
1407 exclude = eu = ek = eh = 1;
1409 } else if (*str == 'k') {
1411 exclude = eu = ek = eh = 1;
1413 } else if (*str == 'h') {
1415 exclude = eu = ek = eh = 1;
1417 } else if (*str == 'G') {
1419 exclude_GH = eG = eH = 1;
1421 } else if (*str == 'H') {
1423 exclude_GH = eG = eH = 1;
1425 } else if (*str == 'I') {
1427 } else if (*str == 'p') {
1429 /* use of precise requires exclude_guest */
1432 } else if (*str == 'P') {
1434 } else if (*str == 'S') {
1436 } else if (*str == 'D') {
1438 } else if (*str == 'W') {
1449 * 0 - SAMPLE_IP can have arbitrary skid
1450 * 1 - SAMPLE_IP must have constant skid
1451 * 2 - SAMPLE_IP requested to have 0 skid
1452 * 3 - SAMPLE_IP must have 0 skid
1454 * See also PERF_RECORD_MISC_EXACT_IP
1465 mod->precise = precise;
1466 mod->precise_max = precise_max;
1467 mod->exclude_GH = exclude_GH;
1468 mod->sample_read = sample_read;
1469 mod->pinned = pinned;
1476 * Basic modifier sanity check to validate it contains only one
1477 * instance of any modifier (apart from 'p') present.
1479 static int check_modifier(char *str)
1483 /* The sizeof includes 0 byte as well. */
1484 if (strlen(str) > (sizeof("ukhGHpppPSDIW") - 1))
1488 if (*p != 'p' && strchr(p + 1, *p))
1496 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
1498 struct perf_evsel *evsel;
1499 struct event_modifier mod;
1504 if (check_modifier(str))
1507 if (!add && get_event_modifier(&mod, str, NULL))
1510 __evlist__for_each_entry(list, evsel) {
1511 if (add && get_event_modifier(&mod, str, evsel))
1514 evsel->attr.exclude_user = mod.eu;
1515 evsel->attr.exclude_kernel = mod.ek;
1516 evsel->attr.exclude_hv = mod.eh;
1517 evsel->attr.precise_ip = mod.precise;
1518 evsel->attr.exclude_host = mod.eH;
1519 evsel->attr.exclude_guest = mod.eG;
1520 evsel->attr.exclude_idle = mod.eI;
1521 evsel->exclude_GH = mod.exclude_GH;
1522 evsel->sample_read = mod.sample_read;
1523 evsel->precise_max = mod.precise_max;
1524 evsel->weak_group = mod.weak;
1526 if (perf_evsel__is_group_leader(evsel))
1527 evsel->attr.pinned = mod.pinned;
1533 int parse_events_name(struct list_head *list, char *name)
1535 struct perf_evsel *evsel;
1537 __evlist__for_each_entry(list, evsel) {
1539 evsel->name = strdup(name);
1546 comp_pmu(const void *p1, const void *p2)
1548 struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
1549 struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
1551 return strcasecmp(pmu1->symbol, pmu2->symbol);
1554 static void perf_pmu__parse_cleanup(void)
1556 if (perf_pmu_events_list_num > 0) {
1557 struct perf_pmu_event_symbol *p;
1560 for (i = 0; i < perf_pmu_events_list_num; i++) {
1561 p = perf_pmu_events_list + i;
1564 zfree(&perf_pmu_events_list);
1565 perf_pmu_events_list_num = 0;
1569 #define SET_SYMBOL(str, stype) \
1578 * Read the pmu events list from sysfs
1579 * Save it into perf_pmu_events_list
1581 static void perf_pmu__parse_init(void)
1584 struct perf_pmu *pmu = NULL;
1585 struct perf_pmu_alias *alias;
1589 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1590 list_for_each_entry(alias, &pmu->aliases, list) {
1591 if (strchr(alias->name, '-'))
1598 perf_pmu_events_list_num = -1;
1601 perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
1602 if (!perf_pmu_events_list)
1604 perf_pmu_events_list_num = len;
1608 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1609 list_for_each_entry(alias, &pmu->aliases, list) {
1610 struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
1611 char *tmp = strchr(alias->name, '-');
1614 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
1615 PMU_EVENT_SYMBOL_PREFIX);
1617 SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
1620 SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
1625 qsort(perf_pmu_events_list, len,
1626 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1630 perf_pmu__parse_cleanup();
1633 enum perf_pmu_event_symbol_type
1634 perf_pmu__parse_check(const char *name)
1636 struct perf_pmu_event_symbol p, *r;
1638 /* scan kernel pmu events from sysfs if needed */
1639 if (perf_pmu_events_list_num == 0)
1640 perf_pmu__parse_init();
1642 * name "cpu" could be prefix of cpu-cycles or cpu// events.
1643 * cpu-cycles has been handled by hardcode.
1644 * So it must be cpu// events, not kernel pmu event.
1646 if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
1647 return PMU_EVENT_SYMBOL_ERR;
1649 p.symbol = strdup(name);
1650 r = bsearch(&p, perf_pmu_events_list,
1651 (size_t) perf_pmu_events_list_num,
1652 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1654 return r ? r->type : PMU_EVENT_SYMBOL_ERR;
1657 static int parse_events__scanner(const char *str, void *parse_state, int start_token)
1659 YY_BUFFER_STATE buffer;
1663 ret = parse_events_lex_init_extra(start_token, &scanner);
1667 buffer = parse_events__scan_string(str, scanner);
1670 parse_events_debug = 1;
1672 ret = parse_events_parse(parse_state, scanner);
1674 parse_events__flush_buffer(buffer, scanner);
1675 parse_events__delete_buffer(buffer, scanner);
1676 parse_events_lex_destroy(scanner);
1681 * parse event config string, return a list of event terms.
1683 int parse_events_terms(struct list_head *terms, const char *str)
1685 struct parse_events_state parse_state = {
1690 ret = parse_events__scanner(str, &parse_state, PE_START_TERMS);
1692 list_splice(parse_state.terms, terms);
1693 zfree(&parse_state.terms);
1697 parse_events_terms__delete(parse_state.terms);
1701 int parse_events(struct perf_evlist *evlist, const char *str,
1702 struct parse_events_error *err)
1704 struct parse_events_state parse_state = {
1705 .list = LIST_HEAD_INIT(parse_state.list),
1706 .idx = evlist->nr_entries,
1712 ret = parse_events__scanner(str, &parse_state, PE_START_EVENTS);
1713 perf_pmu__parse_cleanup();
1715 struct perf_evsel *last;
1717 if (list_empty(&parse_state.list)) {
1718 WARN_ONCE(true, "WARNING: event parser found nothing");
1722 perf_evlist__splice_list_tail(evlist, &parse_state.list);
1723 evlist->nr_groups += parse_state.nr_groups;
1724 last = perf_evlist__last(evlist);
1725 last->cmdline_group_boundary = true;
1731 * There are 2 users - builtin-record and builtin-test objects.
1732 * Both call perf_evlist__delete in case of error, so we dont
1738 #define MAX_WIDTH 1000
1739 static int get_term_width(void)
1743 get_term_dimensions(&ws);
1744 return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
1747 void parse_events_print_error(struct parse_events_error *err,
1750 const char *str = "invalid or unsupported event: ";
1751 char _buf[MAX_WIDTH];
1752 char *buf = (char *) event;
1756 /* -2 for extra '' in the final fprintf */
1757 int width = get_term_width() - 2;
1758 int len_event = strlen(event);
1759 int len_str, max_len, cut = 0;
1762 * Maximum error index indent, we will cut
1763 * the event string if it's bigger.
1765 int max_err_idx = 13;
1768 * Let's be specific with the message when
1769 * we have the precise error.
1771 str = "event syntax error: ";
1772 len_str = strlen(str);
1773 max_len = width - len_str;
1777 /* We're cutting from the beginning. */
1778 if (err->idx > max_err_idx)
1779 cut = err->idx - max_err_idx;
1781 strncpy(buf, event + cut, max_len);
1783 /* Mark cut parts with '..' on both sides. */
1785 buf[0] = buf[1] = '.';
1787 if ((len_event - cut) > max_len) {
1788 buf[max_len - 1] = buf[max_len - 2] = '.';
1792 idx = len_str + err->idx - cut;
1795 fprintf(stderr, "%s'%s'\n", str, buf);
1797 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err->str);
1799 fprintf(stderr, "\n%s\n", err->help);
1807 int parse_events_option(const struct option *opt, const char *str,
1808 int unset __maybe_unused)
1810 struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1811 struct parse_events_error err = { .idx = 0, };
1812 int ret = parse_events(evlist, str, &err);
1815 parse_events_print_error(&err, str);
1816 fprintf(stderr, "Run 'perf list' for a list of valid events\n");
1823 foreach_evsel_in_last_glob(struct perf_evlist *evlist,
1824 int (*func)(struct perf_evsel *evsel,
1828 struct perf_evsel *last = NULL;
1832 * Don't return when list_empty, give func a chance to report
1833 * error when it found last == NULL.
1835 * So no need to WARN here, let *func do this.
1837 if (evlist->nr_entries > 0)
1838 last = perf_evlist__last(evlist);
1841 err = (*func)(last, arg);
1847 if (last->node.prev == &evlist->entries)
1849 last = list_entry(last->node.prev, struct perf_evsel, node);
1850 } while (!last->cmdline_group_boundary);
1855 static int set_filter(struct perf_evsel *evsel, const void *arg)
1857 const char *str = arg;
1859 int nr_addr_filters = 0;
1860 struct perf_pmu *pmu = NULL;
1865 if (evsel->attr.type == PERF_TYPE_TRACEPOINT) {
1866 if (perf_evsel__append_tp_filter(evsel, str) < 0) {
1868 "not enough memory to hold filter string\n");
1875 while ((pmu = perf_pmu__scan(pmu)) != NULL)
1876 if (pmu->type == evsel->attr.type) {
1882 perf_pmu__scan_file(pmu, "nr_addr_filters",
1883 "%d", &nr_addr_filters);
1885 if (!nr_addr_filters)
1888 if (perf_evsel__append_addr_filter(evsel, str) < 0) {
1890 "not enough memory to hold filter string\n");
1898 "--filter option should follow a -e tracepoint or HW tracer option\n");
1903 int parse_filter(const struct option *opt, const char *str,
1904 int unset __maybe_unused)
1906 struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1908 return foreach_evsel_in_last_glob(evlist, set_filter,
1912 static int add_exclude_perf_filter(struct perf_evsel *evsel,
1913 const void *arg __maybe_unused)
1915 char new_filter[64];
1917 if (evsel == NULL || evsel->attr.type != PERF_TYPE_TRACEPOINT) {
1919 "--exclude-perf option should follow a -e tracepoint option\n");
1923 snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
1925 if (perf_evsel__append_tp_filter(evsel, new_filter) < 0) {
1927 "not enough memory to hold filter string\n");
1934 int exclude_perf(const struct option *opt,
1935 const char *arg __maybe_unused,
1936 int unset __maybe_unused)
1938 struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1940 return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
1944 static const char * const event_type_descriptors[] = {
1948 "Hardware cache event",
1949 "Raw hardware event descriptor",
1950 "Hardware breakpoint",
1953 static int cmp_string(const void *a, const void *b)
1955 const char * const *as = a;
1956 const char * const *bs = b;
1958 return strcmp(*as, *bs);
1962 * Print the events from <debugfs_mount_point>/tracing/events
1965 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
1968 DIR *sys_dir, *evt_dir;
1969 struct dirent *sys_dirent, *evt_dirent;
1970 char evt_path[MAXPATHLEN];
1971 char dir_path[MAXPATHLEN];
1972 char **evt_list = NULL;
1973 unsigned int evt_i = 0, evt_num = 0;
1974 bool evt_num_known = false;
1977 sys_dir = opendir(tracing_events_path);
1981 if (evt_num_known) {
1982 evt_list = zalloc(sizeof(char *) * evt_num);
1984 goto out_close_sys_dir;
1987 for_each_subsystem(sys_dir, sys_dirent) {
1988 if (subsys_glob != NULL &&
1989 !strglobmatch(sys_dirent->d_name, subsys_glob))
1992 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
1993 sys_dirent->d_name);
1994 evt_dir = opendir(dir_path);
1998 for_each_event(sys_dirent, evt_dir, evt_dirent) {
1999 if (event_glob != NULL &&
2000 !strglobmatch(evt_dirent->d_name, event_glob))
2003 if (!evt_num_known) {
2008 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2009 sys_dirent->d_name, evt_dirent->d_name);
2011 evt_list[evt_i] = strdup(evt_path);
2012 if (evt_list[evt_i] == NULL)
2013 goto out_close_evt_dir;
2020 if (!evt_num_known) {
2021 evt_num_known = true;
2024 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2026 while (evt_i < evt_num) {
2028 printf("%s ", evt_list[evt_i++]);
2031 printf(" %-50s [%s]\n", evt_list[evt_i++],
2032 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2034 if (evt_num && pager_in_use())
2039 for (evt_i = 0; evt_i < evt_num; evt_i++)
2040 zfree(&evt_list[evt_i]);
2049 printf("FATAL: not enough memory to print %s\n",
2050 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2056 * Check whether event is in <debugfs_mount_point>/tracing/events
2059 int is_valid_tracepoint(const char *event_string)
2061 DIR *sys_dir, *evt_dir;
2062 struct dirent *sys_dirent, *evt_dirent;
2063 char evt_path[MAXPATHLEN];
2064 char dir_path[MAXPATHLEN];
2066 sys_dir = opendir(tracing_events_path);
2070 for_each_subsystem(sys_dir, sys_dirent) {
2072 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
2073 sys_dirent->d_name);
2074 evt_dir = opendir(dir_path);
2078 for_each_event(sys_dirent, evt_dir, evt_dirent) {
2079 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2080 sys_dirent->d_name, evt_dirent->d_name);
2081 if (!strcmp(evt_path, event_string)) {
2093 static bool is_event_supported(u8 type, unsigned config)
2097 struct perf_evsel *evsel;
2098 struct perf_event_attr attr = {
2103 struct thread_map *tmap = thread_map__new_by_tid(0);
2108 evsel = perf_evsel__new(&attr);
2110 open_return = perf_evsel__open(evsel, NULL, tmap);
2111 ret = open_return >= 0;
2113 if (open_return == -EACCES) {
2115 * This happens if the paranoid value
2116 * /proc/sys/kernel/perf_event_paranoid is set to 2
2117 * Re-run with exclude_kernel set; we don't do that
2118 * by default as some ARM machines do not support it.
2121 evsel->attr.exclude_kernel = 1;
2122 ret = perf_evsel__open(evsel, NULL, tmap) >= 0;
2124 perf_evsel__delete(evsel);
2130 void print_sdt_events(const char *subsys_glob, const char *event_glob,
2133 struct probe_cache *pcache;
2134 struct probe_cache_entry *ent;
2135 struct strlist *bidlist, *sdtlist;
2136 struct strlist_config cfg = {.dont_dupstr = true};
2137 struct str_node *nd, *nd2;
2138 char *buf, *path, *ptr = NULL;
2139 bool show_detail = false;
2142 sdtlist = strlist__new(NULL, &cfg);
2144 pr_debug("Failed to allocate new strlist for SDT\n");
2147 bidlist = build_id_cache__list_all(true);
2149 pr_debug("Failed to get buildids: %d\n", errno);
2152 strlist__for_each_entry(nd, bidlist) {
2153 pcache = probe_cache__new(nd->s, NULL);
2156 list_for_each_entry(ent, &pcache->entries, node) {
2160 !strglobmatch(ent->pev.group, subsys_glob))
2163 !strglobmatch(ent->pev.event, event_glob))
2165 ret = asprintf(&buf, "%s:%s@%s", ent->pev.group,
2166 ent->pev.event, nd->s);
2168 strlist__add(sdtlist, buf);
2170 probe_cache__delete(pcache);
2172 strlist__delete(bidlist);
2174 strlist__for_each_entry(nd, sdtlist) {
2175 buf = strchr(nd->s, '@');
2179 printf("%s ", nd->s);
2182 nd2 = strlist__next(nd);
2184 ptr = strchr(nd2->s, '@');
2187 if (strcmp(nd->s, nd2->s) == 0)
2191 path = build_id_cache__origname(buf);
2192 ret = asprintf(&buf, "%s@%s(%.12s)", nd->s, path, buf);
2194 printf(" %-50s [%s]\n", buf, "SDT event");
2198 printf(" %-50s [%s]\n", nd->s, "SDT event");
2200 if (strcmp(nd->s, nd2->s) != 0)
2201 show_detail = false;
2206 strlist__delete(sdtlist);
2209 int print_hwcache_events(const char *event_glob, bool name_only)
2211 unsigned int type, op, i, evt_i = 0, evt_num = 0;
2213 char **evt_list = NULL;
2214 bool evt_num_known = false;
2217 if (evt_num_known) {
2218 evt_list = zalloc(sizeof(char *) * evt_num);
2223 for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
2224 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
2225 /* skip invalid cache type */
2226 if (!perf_evsel__is_cache_op_valid(type, op))
2229 for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
2230 __perf_evsel__hw_cache_type_op_res_name(type, op, i,
2231 name, sizeof(name));
2232 if (event_glob != NULL && !strglobmatch(name, event_glob))
2235 if (!is_event_supported(PERF_TYPE_HW_CACHE,
2236 type | (op << 8) | (i << 16)))
2239 if (!evt_num_known) {
2244 evt_list[evt_i] = strdup(name);
2245 if (evt_list[evt_i] == NULL)
2252 if (!evt_num_known) {
2253 evt_num_known = true;
2256 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2258 while (evt_i < evt_num) {
2260 printf("%s ", evt_list[evt_i++]);
2263 printf(" %-50s [%s]\n", evt_list[evt_i++],
2264 event_type_descriptors[PERF_TYPE_HW_CACHE]);
2266 if (evt_num && pager_in_use())
2271 for (evt_i = 0; evt_i < evt_num; evt_i++)
2272 zfree(&evt_list[evt_i]);
2277 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
2283 void print_symbol_events(const char *event_glob, unsigned type,
2284 struct event_symbol *syms, unsigned max,
2287 unsigned int i, evt_i = 0, evt_num = 0;
2288 char name[MAX_NAME_LEN];
2289 char **evt_list = NULL;
2290 bool evt_num_known = false;
2293 if (evt_num_known) {
2294 evt_list = zalloc(sizeof(char *) * evt_num);
2300 for (i = 0; i < max; i++, syms++) {
2302 if (event_glob != NULL && syms->symbol != NULL &&
2303 !(strglobmatch(syms->symbol, event_glob) ||
2304 (syms->alias && strglobmatch(syms->alias, event_glob))))
2307 if (!is_event_supported(type, i))
2310 if (!evt_num_known) {
2315 if (!name_only && strlen(syms->alias))
2316 snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
2318 strncpy(name, syms->symbol, MAX_NAME_LEN);
2320 evt_list[evt_i] = strdup(name);
2321 if (evt_list[evt_i] == NULL)
2326 if (!evt_num_known) {
2327 evt_num_known = true;
2330 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2332 while (evt_i < evt_num) {
2334 printf("%s ", evt_list[evt_i++]);
2337 printf(" %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
2339 if (evt_num && pager_in_use())
2344 for (evt_i = 0; evt_i < evt_num; evt_i++)
2345 zfree(&evt_list[evt_i]);
2350 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
2356 * Print the help text for the event symbols:
2358 void print_events(const char *event_glob, bool name_only, bool quiet_flag,
2359 bool long_desc, bool details_flag)
2361 print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
2362 event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
2364 print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
2365 event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
2367 print_hwcache_events(event_glob, name_only);
2369 print_pmu_events(event_glob, name_only, quiet_flag, long_desc,
2372 if (event_glob != NULL)
2376 printf(" %-50s [%s]\n",
2378 event_type_descriptors[PERF_TYPE_RAW]);
2379 printf(" %-50s [%s]\n",
2380 "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
2381 event_type_descriptors[PERF_TYPE_RAW]);
2383 printf(" (see 'man perf-list' on how to encode it)\n\n");
2385 printf(" %-50s [%s]\n",
2386 "mem:<addr>[/len][:access]",
2387 event_type_descriptors[PERF_TYPE_BREAKPOINT]);
2392 print_tracepoint_events(NULL, NULL, name_only);
2394 print_sdt_events(NULL, NULL, name_only);
2396 metricgroup__print(true, true, NULL, name_only);
2399 int parse_events__is_hardcoded_term(struct parse_events_term *term)
2401 return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
2404 static int new_term(struct parse_events_term **_term,
2405 struct parse_events_term *temp,
2408 struct parse_events_term *term;
2410 term = malloc(sizeof(*term));
2415 INIT_LIST_HEAD(&term->list);
2418 switch (term->type_val) {
2419 case PARSE_EVENTS__TERM_TYPE_NUM:
2420 term->val.num = num;
2422 case PARSE_EVENTS__TERM_TYPE_STR:
2423 term->val.str = str;
2434 int parse_events_term__num(struct parse_events_term **term,
2435 int type_term, char *config, u64 num,
2437 void *loc_term_, void *loc_val_)
2439 YYLTYPE *loc_term = loc_term_;
2440 YYLTYPE *loc_val = loc_val_;
2442 struct parse_events_term temp = {
2443 .type_val = PARSE_EVENTS__TERM_TYPE_NUM,
2444 .type_term = type_term,
2446 .no_value = no_value,
2447 .err_term = loc_term ? loc_term->first_column : 0,
2448 .err_val = loc_val ? loc_val->first_column : 0,
2451 return new_term(term, &temp, NULL, num);
2454 int parse_events_term__str(struct parse_events_term **term,
2455 int type_term, char *config, char *str,
2456 void *loc_term_, void *loc_val_)
2458 YYLTYPE *loc_term = loc_term_;
2459 YYLTYPE *loc_val = loc_val_;
2461 struct parse_events_term temp = {
2462 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2463 .type_term = type_term,
2465 .err_term = loc_term ? loc_term->first_column : 0,
2466 .err_val = loc_val ? loc_val->first_column : 0,
2469 return new_term(term, &temp, str, 0);
2472 int parse_events_term__sym_hw(struct parse_events_term **term,
2473 char *config, unsigned idx)
2475 struct event_symbol *sym;
2476 struct parse_events_term temp = {
2477 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2478 .type_term = PARSE_EVENTS__TERM_TYPE_USER,
2479 .config = config ?: (char *) "event",
2482 BUG_ON(idx >= PERF_COUNT_HW_MAX);
2483 sym = &event_symbols_hw[idx];
2485 return new_term(term, &temp, (char *) sym->symbol, 0);
2488 int parse_events_term__clone(struct parse_events_term **new,
2489 struct parse_events_term *term)
2491 struct parse_events_term temp = {
2492 .type_val = term->type_val,
2493 .type_term = term->type_term,
2494 .config = term->config,
2495 .err_term = term->err_term,
2496 .err_val = term->err_val,
2499 return new_term(new, &temp, term->val.str, term->val.num);
2502 int parse_events_copy_term_list(struct list_head *old,
2503 struct list_head **new)
2505 struct parse_events_term *term, *n;
2513 *new = malloc(sizeof(struct list_head));
2516 INIT_LIST_HEAD(*new);
2518 list_for_each_entry (term, old, list) {
2519 ret = parse_events_term__clone(&n, term);
2522 list_add_tail(&n->list, *new);
2527 void parse_events_terms__purge(struct list_head *terms)
2529 struct parse_events_term *term, *h;
2531 list_for_each_entry_safe(term, h, terms, list) {
2532 if (term->array.nr_ranges)
2533 zfree(&term->array.ranges);
2534 list_del_init(&term->list);
2539 void parse_events_terms__delete(struct list_head *terms)
2543 parse_events_terms__purge(terms);
2547 void parse_events__clear_array(struct parse_events_array *a)
2552 void parse_events_evlist_error(struct parse_events_state *parse_state,
2553 int idx, const char *str)
2555 struct parse_events_error *err = parse_state->error;
2560 err->str = strdup(str);
2561 WARN_ONCE(!err->str, "WARNING: failed to allocate error string");
2564 static void config_terms_list(char *buf, size_t buf_sz)
2570 for (i = 0; i < __PARSE_EVENTS__TERM_TYPE_NR; i++) {
2571 const char *name = config_term_names[i];
2573 if (!config_term_avail(i, NULL))
2580 if (strlen(buf) + strlen(name) + 2 >= buf_sz)
2592 * Return string contains valid config terms of an event.
2593 * @additional_terms: For terms such as PMU sysfs terms.
2595 char *parse_events_formats_error_string(char *additional_terms)
2598 /* "no-overwrite" is the longest name */
2599 char static_terms[__PARSE_EVENTS__TERM_TYPE_NR *
2600 (sizeof("no-overwrite") - 1)];
2602 config_terms_list(static_terms, sizeof(static_terms));
2604 if (additional_terms) {
2605 if (asprintf(&str, "valid terms: %s,%s",
2606 additional_terms, static_terms) < 0)
2609 if (asprintf(&str, "valid terms: %s", static_terms) < 0)