1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/hw_breakpoint.h>
4 #include <linux/zalloc.h>
12 #include <subcmd/parse-options.h>
13 #include "parse-events.h"
16 #include "bpf-loader.h"
18 #include <api/fs/tracing_path.h>
19 #include <perf/cpumap.h>
20 #include "parse-events-bison.h"
21 #include "parse-events-flex.h"
24 #include "util/parse-branch-options.h"
25 #include "util/evsel_config.h"
26 #include "util/event.h"
28 #include "util/parse-events-hybrid.h"
29 #include "util/pmu-hybrid.h"
30 #include "tracepoint.h"
31 #include "thread_map.h"
33 #define MAX_NAME_LEN 100
35 struct perf_pmu_event_symbol {
37 enum perf_pmu_event_symbol_type type;
41 extern int parse_events_debug;
43 int parse_events_parse(void *parse_state, void *scanner);
44 static int get_config_terms(struct list_head *head_config,
45 struct list_head *head_terms __maybe_unused);
46 static int parse_events__with_hybrid_pmu(struct parse_events_state *parse_state,
47 const char *str, char *pmu_name,
48 struct list_head *list);
50 static struct perf_pmu_event_symbol *perf_pmu_events_list;
52 * The variable indicates the number of supported pmu event symbols.
53 * 0 means not initialized and ready to init
54 * -1 means failed to init, don't try anymore
55 * >0 is the number of supported pmu event symbols
57 static int perf_pmu_events_list_num;
59 struct event_symbol event_symbols_hw[PERF_COUNT_HW_MAX] = {
60 [PERF_COUNT_HW_CPU_CYCLES] = {
61 .symbol = "cpu-cycles",
64 [PERF_COUNT_HW_INSTRUCTIONS] = {
65 .symbol = "instructions",
68 [PERF_COUNT_HW_CACHE_REFERENCES] = {
69 .symbol = "cache-references",
72 [PERF_COUNT_HW_CACHE_MISSES] = {
73 .symbol = "cache-misses",
76 [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
77 .symbol = "branch-instructions",
80 [PERF_COUNT_HW_BRANCH_MISSES] = {
81 .symbol = "branch-misses",
84 [PERF_COUNT_HW_BUS_CYCLES] = {
85 .symbol = "bus-cycles",
88 [PERF_COUNT_HW_STALLED_CYCLES_FRONTEND] = {
89 .symbol = "stalled-cycles-frontend",
90 .alias = "idle-cycles-frontend",
92 [PERF_COUNT_HW_STALLED_CYCLES_BACKEND] = {
93 .symbol = "stalled-cycles-backend",
94 .alias = "idle-cycles-backend",
96 [PERF_COUNT_HW_REF_CPU_CYCLES] = {
97 .symbol = "ref-cycles",
102 struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
103 [PERF_COUNT_SW_CPU_CLOCK] = {
104 .symbol = "cpu-clock",
107 [PERF_COUNT_SW_TASK_CLOCK] = {
108 .symbol = "task-clock",
111 [PERF_COUNT_SW_PAGE_FAULTS] = {
112 .symbol = "page-faults",
115 [PERF_COUNT_SW_CONTEXT_SWITCHES] = {
116 .symbol = "context-switches",
119 [PERF_COUNT_SW_CPU_MIGRATIONS] = {
120 .symbol = "cpu-migrations",
121 .alias = "migrations",
123 [PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
124 .symbol = "minor-faults",
127 [PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
128 .symbol = "major-faults",
131 [PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
132 .symbol = "alignment-faults",
135 [PERF_COUNT_SW_EMULATION_FAULTS] = {
136 .symbol = "emulation-faults",
139 [PERF_COUNT_SW_DUMMY] = {
143 [PERF_COUNT_SW_BPF_OUTPUT] = {
144 .symbol = "bpf-output",
147 [PERF_COUNT_SW_CGROUP_SWITCHES] = {
148 .symbol = "cgroup-switches",
153 bool is_event_supported(u8 type, u64 config)
158 struct perf_event_attr attr = {
163 struct perf_thread_map *tmap = thread_map__new_by_tid(0);
168 evsel = evsel__new(&attr);
170 open_return = evsel__open(evsel, NULL, tmap);
171 ret = open_return >= 0;
173 if (open_return == -EACCES) {
175 * This happens if the paranoid value
176 * /proc/sys/kernel/perf_event_paranoid is set to 2
177 * Re-run with exclude_kernel set; we don't do that
178 * by default as some ARM machines do not support it.
181 evsel->core.attr.exclude_kernel = 1;
182 ret = evsel__open(evsel, NULL, tmap) >= 0;
184 evsel__delete(evsel);
187 perf_thread_map__put(tmap);
191 const char *event_type(int type)
194 case PERF_TYPE_HARDWARE:
197 case PERF_TYPE_SOFTWARE:
200 case PERF_TYPE_TRACEPOINT:
203 case PERF_TYPE_HW_CACHE:
204 return "hardware-cache";
213 static char *get_config_str(struct list_head *head_terms, int type_term)
215 struct parse_events_term *term;
220 list_for_each_entry(term, head_terms, list)
221 if (term->type_term == type_term)
222 return term->val.str;
227 static char *get_config_metric_id(struct list_head *head_terms)
229 return get_config_str(head_terms, PARSE_EVENTS__TERM_TYPE_METRIC_ID);
232 static char *get_config_name(struct list_head *head_terms)
234 return get_config_str(head_terms, PARSE_EVENTS__TERM_TYPE_NAME);
237 static struct evsel *
238 __add_event(struct list_head *list, int *idx,
239 struct perf_event_attr *attr,
241 const char *name, const char *metric_id, struct perf_pmu *pmu,
242 struct list_head *config_terms, bool auto_merge_stats,
243 const char *cpu_list)
246 struct perf_cpu_map *cpus = pmu ? perf_cpu_map__get(pmu->cpus) :
247 cpu_list ? perf_cpu_map__new(cpu_list) : NULL;
250 perf_pmu__warn_invalid_formats(pmu);
252 if (pmu && attr->type == PERF_TYPE_RAW)
253 perf_pmu__warn_invalid_config(pmu, attr->config, name);
256 event_attr_init(attr);
258 evsel = evsel__new_idx(attr, *idx);
260 perf_cpu_map__put(cpus);
265 evsel->core.cpus = cpus;
266 evsel->core.own_cpus = perf_cpu_map__get(cpus);
267 evsel->core.requires_cpu = pmu ? pmu->is_uncore : false;
268 evsel->auto_merge_stats = auto_merge_stats;
272 evsel->name = strdup(name);
275 evsel->metric_id = strdup(metric_id);
278 list_splice_init(config_terms, &evsel->config_terms);
281 list_add_tail(&evsel->core.node, list);
286 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
287 const char *name, const char *metric_id,
288 struct perf_pmu *pmu)
290 return __add_event(/*list=*/NULL, &idx, attr, /*init_attr=*/false, name,
291 metric_id, pmu, /*config_terms=*/NULL,
292 /*auto_merge_stats=*/false, /*cpu_list=*/NULL);
295 static int add_event(struct list_head *list, int *idx,
296 struct perf_event_attr *attr, const char *name,
297 const char *metric_id, struct list_head *config_terms)
299 return __add_event(list, idx, attr, /*init_attr*/true, name, metric_id,
300 /*pmu=*/NULL, config_terms,
301 /*auto_merge_stats=*/false, /*cpu_list=*/NULL) ? 0 : -ENOMEM;
304 static int add_event_tool(struct list_head *list, int *idx,
305 enum perf_tool_event tool_event)
308 struct perf_event_attr attr = {
309 .type = PERF_TYPE_SOFTWARE,
310 .config = PERF_COUNT_SW_DUMMY,
313 evsel = __add_event(list, idx, &attr, /*init_attr=*/true, /*name=*/NULL,
314 /*metric_id=*/NULL, /*pmu=*/NULL,
315 /*config_terms=*/NULL, /*auto_merge_stats=*/false,
319 evsel->tool_event = tool_event;
320 if (tool_event == PERF_TOOL_DURATION_TIME
321 || tool_event == PERF_TOOL_USER_TIME
322 || tool_event == PERF_TOOL_SYSTEM_TIME) {
323 free((char *)evsel->unit);
324 evsel->unit = strdup("ns");
329 static int parse_aliases(char *str, const char *const names[][EVSEL__MAX_ALIASES], int size)
334 for (i = 0; i < size; i++) {
335 for (j = 0; j < EVSEL__MAX_ALIASES && names[i][j]; j++) {
336 n = strlen(names[i][j]);
337 if (n > longest && !strncasecmp(str, names[i][j], n))
347 typedef int config_term_func_t(struct perf_event_attr *attr,
348 struct parse_events_term *term,
349 struct parse_events_error *err);
350 static int config_term_common(struct perf_event_attr *attr,
351 struct parse_events_term *term,
352 struct parse_events_error *err);
353 static int config_attr(struct perf_event_attr *attr,
354 struct list_head *head,
355 struct parse_events_error *err,
356 config_term_func_t config_term);
358 int parse_events_add_cache(struct list_head *list, int *idx,
359 char *type, char *op_result1, char *op_result2,
360 struct parse_events_error *err,
361 struct list_head *head_config,
362 struct parse_events_state *parse_state)
364 struct perf_event_attr attr;
365 LIST_HEAD(config_terms);
366 char name[MAX_NAME_LEN];
367 const char *config_name, *metric_id;
368 int cache_type = -1, cache_op = -1, cache_result = -1;
369 char *op_result[2] = { op_result1, op_result2 };
374 * No fallback - if we cannot get a clear cache type
377 cache_type = parse_aliases(type, evsel__hw_cache, PERF_COUNT_HW_CACHE_MAX);
378 if (cache_type == -1)
381 config_name = get_config_name(head_config);
382 n = snprintf(name, MAX_NAME_LEN, "%s", type);
384 for (i = 0; (i < 2) && (op_result[i]); i++) {
385 char *str = op_result[i];
387 n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
389 if (cache_op == -1) {
390 cache_op = parse_aliases(str, evsel__hw_cache_op,
391 PERF_COUNT_HW_CACHE_OP_MAX);
393 if (!evsel__is_cache_op_valid(cache_type, cache_op))
399 if (cache_result == -1) {
400 cache_result = parse_aliases(str, evsel__hw_cache_result,
401 PERF_COUNT_HW_CACHE_RESULT_MAX);
402 if (cache_result >= 0)
408 * Fall back to reads:
411 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
414 * Fall back to accesses:
416 if (cache_result == -1)
417 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
419 memset(&attr, 0, sizeof(attr));
420 attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
421 attr.type = PERF_TYPE_HW_CACHE;
424 if (config_attr(&attr, head_config, err,
428 if (get_config_terms(head_config, &config_terms))
432 metric_id = get_config_metric_id(head_config);
433 ret = parse_events__add_cache_hybrid(list, idx, &attr,
434 config_name ? : name,
437 &hybrid, parse_state);
441 ret = add_event(list, idx, &attr, config_name ? : name, metric_id,
444 free_config_terms(&config_terms);
448 #ifdef HAVE_LIBTRACEEVENT
449 static void tracepoint_error(struct parse_events_error *e, int err,
450 const char *sys, const char *name)
459 * We get error directly from syscall errno ( > 0),
460 * or from encoded pointer's error ( < 0).
466 str = "can't access trace events";
469 str = "unknown tracepoint";
472 str = "failed to add tracepoint";
476 tracing_path__strerror_open_tp(err, help, sizeof(help), sys, name);
477 parse_events_error__handle(e, 0, strdup(str), strdup(help));
480 static int add_tracepoint(struct list_head *list, int *idx,
481 const char *sys_name, const char *evt_name,
482 struct parse_events_error *err,
483 struct list_head *head_config)
485 struct evsel *evsel = evsel__newtp_idx(sys_name, evt_name, (*idx)++);
488 tracepoint_error(err, PTR_ERR(evsel), sys_name, evt_name);
489 return PTR_ERR(evsel);
493 LIST_HEAD(config_terms);
495 if (get_config_terms(head_config, &config_terms))
497 list_splice(&config_terms, &evsel->config_terms);
500 list_add_tail(&evsel->core.node, list);
504 static int add_tracepoint_multi_event(struct list_head *list, int *idx,
505 const char *sys_name, const char *evt_name,
506 struct parse_events_error *err,
507 struct list_head *head_config)
510 struct dirent *evt_ent;
512 int ret = 0, found = 0;
514 evt_path = get_events_file(sys_name);
516 tracepoint_error(err, errno, sys_name, evt_name);
519 evt_dir = opendir(evt_path);
521 put_events_file(evt_path);
522 tracepoint_error(err, errno, sys_name, evt_name);
526 while (!ret && (evt_ent = readdir(evt_dir))) {
527 if (!strcmp(evt_ent->d_name, ".")
528 || !strcmp(evt_ent->d_name, "..")
529 || !strcmp(evt_ent->d_name, "enable")
530 || !strcmp(evt_ent->d_name, "filter"))
533 if (!strglobmatch(evt_ent->d_name, evt_name))
538 ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name,
543 tracepoint_error(err, ENOENT, sys_name, evt_name);
547 put_events_file(evt_path);
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 = tracing_events__opendir();
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);
597 #endif /* HAVE_LIBTRACEEVENT */
599 #ifdef HAVE_LIBBPF_SUPPORT
600 struct __add_bpf_event_param {
601 struct parse_events_state *parse_state;
602 struct list_head *list;
603 struct list_head *head_config;
606 static int add_bpf_event(const char *group, const char *event, int fd, struct bpf_object *obj,
609 LIST_HEAD(new_evsels);
610 struct __add_bpf_event_param *param = _param;
611 struct parse_events_state *parse_state = param->parse_state;
612 struct list_head *list = param->list;
616 * Check if we should add the event, i.e. if it is a TP but starts with a '!',
617 * then don't add the tracepoint, this will be used for something else, like
618 * adding to a BPF_MAP_TYPE_PROG_ARRAY.
620 * See tools/perf/examples/bpf/augmented_raw_syscalls.c
625 pr_debug("add bpf event %s:%s and attach bpf program %d\n",
628 err = parse_events_add_tracepoint(&new_evsels, &parse_state->idx, group,
629 event, parse_state->error,
632 struct evsel *evsel, *tmp;
634 pr_debug("Failed to add BPF event %s:%s\n",
636 list_for_each_entry_safe(evsel, tmp, &new_evsels, core.node) {
637 list_del_init(&evsel->core.node);
638 evsel__delete(evsel);
642 pr_debug("adding %s:%s\n", group, event);
644 list_for_each_entry(pos, &new_evsels, core.node) {
645 pr_debug("adding %s:%s to %p\n",
650 list_splice(&new_evsels, list);
654 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
655 struct list_head *list,
656 struct bpf_object *obj,
657 struct list_head *head_config)
661 struct __add_bpf_event_param param = {parse_state, list, head_config};
662 static bool registered_unprobe_atexit = false;
664 if (IS_ERR(obj) || !obj) {
665 snprintf(errbuf, sizeof(errbuf),
666 "Internal error: load bpf obj with NULL");
672 * Register atexit handler before calling bpf__probe() so
673 * bpf__probe() don't need to unprobe probe points its already
674 * created when failure.
676 if (!registered_unprobe_atexit) {
678 registered_unprobe_atexit = true;
681 err = bpf__probe(obj);
683 bpf__strerror_probe(obj, err, errbuf, sizeof(errbuf));
687 err = bpf__load(obj);
689 bpf__strerror_load(obj, err, errbuf, sizeof(errbuf));
693 err = bpf__foreach_event(obj, add_bpf_event, ¶m);
695 snprintf(errbuf, sizeof(errbuf),
696 "Attach events in BPF object failed");
702 parse_events_error__handle(parse_state->error, 0,
703 strdup(errbuf), strdup("(add -v to see detail)"));
708 parse_events_config_bpf(struct parse_events_state *parse_state,
709 struct bpf_object *obj,
710 struct list_head *head_config)
712 struct parse_events_term *term;
715 if (!head_config || list_empty(head_config))
718 list_for_each_entry(term, head_config, list) {
721 if (term->type_term != PARSE_EVENTS__TERM_TYPE_USER) {
722 parse_events_error__handle(parse_state->error, term->err_term,
723 strdup("Invalid config term for BPF object"),
728 err = bpf__config_obj(obj, term, parse_state->evlist, &error_pos);
733 bpf__strerror_config_obj(obj, term, parse_state->evlist,
734 &error_pos, err, errbuf,
737 if (err == -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE)
740 idx = term->err_term + error_pos;
742 parse_events_error__handle(parse_state->error, idx,
745 "Hint:\tValid config terms:\n"
746 " \tmap:[<arraymap>].value<indices>=[value]\n"
747 " \tmap:[<eventmap>].event<indices>=[event]\n"
749 " \twhere <indices> is something like [0,3...5] or [all]\n"
750 " \t(add -v to see detail)"));
758 * Split config terms:
759 * perf record -e bpf.c/call-graph=fp,map:array.value[0]=1/ ...
760 * 'call-graph=fp' is 'evt config', should be applied to each
762 * 'map:array.value[0]=1' is 'obj config', should be processed
763 * with parse_events_config_bpf.
765 * Move object config terms from the first list to obj_head_config.
768 split_bpf_config_terms(struct list_head *evt_head_config,
769 struct list_head *obj_head_config)
771 struct parse_events_term *term, *temp;
774 * Currently, all possible user config term
775 * belong to bpf object. parse_events__is_hardcoded_term()
776 * happens to be a good flag.
778 * See parse_events_config_bpf() and
779 * config_term_tracepoint().
781 list_for_each_entry_safe(term, temp, evt_head_config, list)
782 if (!parse_events__is_hardcoded_term(term))
783 list_move_tail(&term->list, obj_head_config);
786 int parse_events_load_bpf(struct parse_events_state *parse_state,
787 struct list_head *list,
790 struct list_head *head_config)
793 struct bpf_object *obj;
794 LIST_HEAD(obj_head_config);
797 split_bpf_config_terms(head_config, &obj_head_config);
799 obj = bpf__prepare_load(bpf_file_name, source);
806 snprintf(errbuf, sizeof(errbuf),
807 "BPF support is not compiled");
809 bpf__strerror_prepare_load(bpf_file_name,
814 parse_events_error__handle(parse_state->error, 0,
815 strdup(errbuf), strdup("(add -v to see detail)"));
819 err = parse_events_load_bpf_obj(parse_state, list, obj, head_config);
822 err = parse_events_config_bpf(parse_state, obj, &obj_head_config);
825 * Caller doesn't know anything about obj_head_config,
826 * so combine them together again before returning.
829 list_splice_tail(&obj_head_config, head_config);
832 #else // HAVE_LIBBPF_SUPPORT
833 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
834 struct list_head *list __maybe_unused,
835 struct bpf_object *obj __maybe_unused,
836 struct list_head *head_config __maybe_unused)
838 parse_events_error__handle(parse_state->error, 0,
839 strdup("BPF support is not compiled"),
840 strdup("Make sure libbpf-devel is available at build time."));
844 int parse_events_load_bpf(struct parse_events_state *parse_state,
845 struct list_head *list __maybe_unused,
846 char *bpf_file_name __maybe_unused,
847 bool source __maybe_unused,
848 struct list_head *head_config __maybe_unused)
850 parse_events_error__handle(parse_state->error, 0,
851 strdup("BPF support is not compiled"),
852 strdup("Make sure libbpf-devel is available at build time."));
855 #endif // HAVE_LIBBPF_SUPPORT
858 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
862 for (i = 0; i < 3; i++) {
863 if (!type || !type[i])
866 #define CHECK_SET_TYPE(bit) \
868 if (attr->bp_type & bit) \
871 attr->bp_type |= bit; \
876 CHECK_SET_TYPE(HW_BREAKPOINT_R);
879 CHECK_SET_TYPE(HW_BREAKPOINT_W);
882 CHECK_SET_TYPE(HW_BREAKPOINT_X);
889 #undef CHECK_SET_TYPE
891 if (!attr->bp_type) /* Default */
892 attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
897 int parse_events_add_breakpoint(struct list_head *list, int *idx,
898 u64 addr, char *type, u64 len)
900 struct perf_event_attr attr;
902 memset(&attr, 0, sizeof(attr));
905 if (parse_breakpoint_type(type, &attr))
908 /* Provide some defaults if len is not specified */
910 if (attr.bp_type == HW_BREAKPOINT_X)
913 len = HW_BREAKPOINT_LEN_4;
918 attr.type = PERF_TYPE_BREAKPOINT;
919 attr.sample_period = 1;
921 return add_event(list, idx, &attr, /*name=*/NULL, /*mertic_id=*/NULL,
922 /*config_terms=*/NULL);
925 static int check_type_val(struct parse_events_term *term,
926 struct parse_events_error *err,
929 if (type == term->type_val)
933 parse_events_error__handle(err, term->err_val,
934 type == PARSE_EVENTS__TERM_TYPE_NUM
935 ? strdup("expected numeric value")
936 : strdup("expected string value"),
943 * Update according to parse-events.l
945 static const char *config_term_names[__PARSE_EVENTS__TERM_TYPE_NR] = {
946 [PARSE_EVENTS__TERM_TYPE_USER] = "<sysfs term>",
947 [PARSE_EVENTS__TERM_TYPE_CONFIG] = "config",
948 [PARSE_EVENTS__TERM_TYPE_CONFIG1] = "config1",
949 [PARSE_EVENTS__TERM_TYPE_CONFIG2] = "config2",
950 [PARSE_EVENTS__TERM_TYPE_NAME] = "name",
951 [PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD] = "period",
952 [PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ] = "freq",
953 [PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE] = "branch_type",
954 [PARSE_EVENTS__TERM_TYPE_TIME] = "time",
955 [PARSE_EVENTS__TERM_TYPE_CALLGRAPH] = "call-graph",
956 [PARSE_EVENTS__TERM_TYPE_STACKSIZE] = "stack-size",
957 [PARSE_EVENTS__TERM_TYPE_NOINHERIT] = "no-inherit",
958 [PARSE_EVENTS__TERM_TYPE_INHERIT] = "inherit",
959 [PARSE_EVENTS__TERM_TYPE_MAX_STACK] = "max-stack",
960 [PARSE_EVENTS__TERM_TYPE_MAX_EVENTS] = "nr",
961 [PARSE_EVENTS__TERM_TYPE_OVERWRITE] = "overwrite",
962 [PARSE_EVENTS__TERM_TYPE_NOOVERWRITE] = "no-overwrite",
963 [PARSE_EVENTS__TERM_TYPE_DRV_CFG] = "driver-config",
964 [PARSE_EVENTS__TERM_TYPE_PERCORE] = "percore",
965 [PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT] = "aux-output",
966 [PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE] = "aux-sample-size",
967 [PARSE_EVENTS__TERM_TYPE_METRIC_ID] = "metric-id",
970 static bool config_term_shrinked;
973 config_term_avail(int term_type, struct parse_events_error *err)
977 if (term_type < 0 || term_type >= __PARSE_EVENTS__TERM_TYPE_NR) {
978 parse_events_error__handle(err, -1,
979 strdup("Invalid term_type"), NULL);
982 if (!config_term_shrinked)
986 case PARSE_EVENTS__TERM_TYPE_CONFIG:
987 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
988 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
989 case PARSE_EVENTS__TERM_TYPE_NAME:
990 case PARSE_EVENTS__TERM_TYPE_METRIC_ID:
991 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
992 case PARSE_EVENTS__TERM_TYPE_PERCORE:
998 /* term_type is validated so indexing is safe */
999 if (asprintf(&err_str, "'%s' is not usable in 'perf stat'",
1000 config_term_names[term_type]) >= 0)
1001 parse_events_error__handle(err, -1, err_str, NULL);
1006 void parse_events__shrink_config_terms(void)
1008 config_term_shrinked = true;
1011 static int config_term_common(struct perf_event_attr *attr,
1012 struct parse_events_term *term,
1013 struct parse_events_error *err)
1015 #define CHECK_TYPE_VAL(type) \
1017 if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
1021 switch (term->type_term) {
1022 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1023 CHECK_TYPE_VAL(NUM);
1024 attr->config = term->val.num;
1026 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
1027 CHECK_TYPE_VAL(NUM);
1028 attr->config1 = term->val.num;
1030 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
1031 CHECK_TYPE_VAL(NUM);
1032 attr->config2 = term->val.num;
1034 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1035 CHECK_TYPE_VAL(NUM);
1037 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1038 CHECK_TYPE_VAL(NUM);
1040 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1041 CHECK_TYPE_VAL(STR);
1042 if (strcmp(term->val.str, "no") &&
1043 parse_branch_str(term->val.str,
1044 &attr->branch_sample_type)) {
1045 parse_events_error__handle(err, term->err_val,
1046 strdup("invalid branch sample type"),
1051 case PARSE_EVENTS__TERM_TYPE_TIME:
1052 CHECK_TYPE_VAL(NUM);
1053 if (term->val.num > 1) {
1054 parse_events_error__handle(err, term->err_val,
1055 strdup("expected 0 or 1"),
1060 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1061 CHECK_TYPE_VAL(STR);
1063 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1064 CHECK_TYPE_VAL(NUM);
1066 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1067 CHECK_TYPE_VAL(NUM);
1069 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1070 CHECK_TYPE_VAL(NUM);
1072 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1073 CHECK_TYPE_VAL(NUM);
1075 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1076 CHECK_TYPE_VAL(NUM);
1078 case PARSE_EVENTS__TERM_TYPE_NAME:
1079 CHECK_TYPE_VAL(STR);
1081 case PARSE_EVENTS__TERM_TYPE_METRIC_ID:
1082 CHECK_TYPE_VAL(STR);
1084 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1085 CHECK_TYPE_VAL(NUM);
1087 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1088 CHECK_TYPE_VAL(NUM);
1090 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1091 CHECK_TYPE_VAL(NUM);
1092 if ((unsigned int)term->val.num > 1) {
1093 parse_events_error__handle(err, term->err_val,
1094 strdup("expected 0 or 1"),
1099 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1100 CHECK_TYPE_VAL(NUM);
1102 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1103 CHECK_TYPE_VAL(NUM);
1104 if (term->val.num > UINT_MAX) {
1105 parse_events_error__handle(err, term->err_val,
1112 parse_events_error__handle(err, term->err_term,
1113 strdup("unknown term"),
1114 parse_events_formats_error_string(NULL));
1119 * Check term availability after basic checking so
1120 * PARSE_EVENTS__TERM_TYPE_USER can be found and filtered.
1122 * If check availability at the entry of this function,
1123 * user will see "'<sysfs term>' is not usable in 'perf stat'"
1124 * if an invalid config term is provided for legacy events
1125 * (for example, instructions/badterm/...), which is confusing.
1127 if (!config_term_avail(term->type_term, err))
1130 #undef CHECK_TYPE_VAL
1133 static int config_term_pmu(struct perf_event_attr *attr,
1134 struct parse_events_term *term,
1135 struct parse_events_error *err)
1137 if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER ||
1138 term->type_term == PARSE_EVENTS__TERM_TYPE_DRV_CFG)
1140 * Always succeed for sysfs terms, as we dont know
1141 * at this point what type they need to have.
1145 return config_term_common(attr, term, err);
1148 #ifdef HAVE_LIBTRACEEVENT
1149 static int config_term_tracepoint(struct perf_event_attr *attr,
1150 struct parse_events_term *term,
1151 struct parse_events_error *err)
1153 switch (term->type_term) {
1154 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1155 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1156 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1157 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1158 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1159 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1160 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1161 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1162 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1163 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1164 return config_term_common(attr, term, err);
1167 parse_events_error__handle(err, term->err_term,
1168 strdup("unknown term"),
1169 strdup("valid terms: call-graph,stack-size\n"));
1178 static int config_attr(struct perf_event_attr *attr,
1179 struct list_head *head,
1180 struct parse_events_error *err,
1181 config_term_func_t config_term)
1183 struct parse_events_term *term;
1185 list_for_each_entry(term, head, list)
1186 if (config_term(attr, term, err))
1192 static int get_config_terms(struct list_head *head_config,
1193 struct list_head *head_terms __maybe_unused)
1195 #define ADD_CONFIG_TERM(__type, __weak) \
1196 struct evsel_config_term *__t; \
1198 __t = zalloc(sizeof(*__t)); \
1202 INIT_LIST_HEAD(&__t->list); \
1203 __t->type = EVSEL__CONFIG_TERM_ ## __type; \
1204 __t->weak = __weak; \
1205 list_add_tail(&__t->list, head_terms)
1207 #define ADD_CONFIG_TERM_VAL(__type, __name, __val, __weak) \
1209 ADD_CONFIG_TERM(__type, __weak); \
1210 __t->val.__name = __val; \
1213 #define ADD_CONFIG_TERM_STR(__type, __val, __weak) \
1215 ADD_CONFIG_TERM(__type, __weak); \
1216 __t->val.str = strdup(__val); \
1217 if (!__t->val.str) { \
1221 __t->free_str = true; \
1224 struct parse_events_term *term;
1226 list_for_each_entry(term, head_config, list) {
1227 switch (term->type_term) {
1228 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1229 ADD_CONFIG_TERM_VAL(PERIOD, period, term->val.num, term->weak);
1231 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1232 ADD_CONFIG_TERM_VAL(FREQ, freq, term->val.num, term->weak);
1234 case PARSE_EVENTS__TERM_TYPE_TIME:
1235 ADD_CONFIG_TERM_VAL(TIME, time, term->val.num, term->weak);
1237 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1238 ADD_CONFIG_TERM_STR(CALLGRAPH, term->val.str, term->weak);
1240 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1241 ADD_CONFIG_TERM_STR(BRANCH, term->val.str, term->weak);
1243 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1244 ADD_CONFIG_TERM_VAL(STACK_USER, stack_user,
1245 term->val.num, term->weak);
1247 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1248 ADD_CONFIG_TERM_VAL(INHERIT, inherit,
1249 term->val.num ? 1 : 0, term->weak);
1251 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1252 ADD_CONFIG_TERM_VAL(INHERIT, inherit,
1253 term->val.num ? 0 : 1, term->weak);
1255 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1256 ADD_CONFIG_TERM_VAL(MAX_STACK, max_stack,
1257 term->val.num, term->weak);
1259 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1260 ADD_CONFIG_TERM_VAL(MAX_EVENTS, max_events,
1261 term->val.num, term->weak);
1263 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1264 ADD_CONFIG_TERM_VAL(OVERWRITE, overwrite,
1265 term->val.num ? 1 : 0, term->weak);
1267 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1268 ADD_CONFIG_TERM_VAL(OVERWRITE, overwrite,
1269 term->val.num ? 0 : 1, term->weak);
1271 case PARSE_EVENTS__TERM_TYPE_DRV_CFG:
1272 ADD_CONFIG_TERM_STR(DRV_CFG, term->val.str, term->weak);
1274 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1275 ADD_CONFIG_TERM_VAL(PERCORE, percore,
1276 term->val.num ? true : false, term->weak);
1278 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1279 ADD_CONFIG_TERM_VAL(AUX_OUTPUT, aux_output,
1280 term->val.num ? 1 : 0, term->weak);
1282 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1283 ADD_CONFIG_TERM_VAL(AUX_SAMPLE_SIZE, aux_sample_size,
1284 term->val.num, term->weak);
1294 * Add EVSEL__CONFIG_TERM_CFG_CHG where cfg_chg will have a bit set for
1295 * each bit of attr->config that the user has changed.
1297 static int get_config_chgs(struct perf_pmu *pmu, struct list_head *head_config,
1298 struct list_head *head_terms)
1300 struct parse_events_term *term;
1304 list_for_each_entry(term, head_config, list) {
1305 switch (term->type_term) {
1306 case PARSE_EVENTS__TERM_TYPE_USER:
1307 type = perf_pmu__format_type(&pmu->format, term->config);
1308 if (type != PERF_PMU_FORMAT_VALUE_CONFIG)
1310 bits |= perf_pmu__format_bits(&pmu->format, term->config);
1312 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1321 ADD_CONFIG_TERM_VAL(CFG_CHG, cfg_chg, bits, false);
1323 #undef ADD_CONFIG_TERM
1327 int parse_events_add_tracepoint(struct list_head *list, int *idx,
1328 const char *sys, const char *event,
1329 struct parse_events_error *err,
1330 struct list_head *head_config)
1332 #ifdef HAVE_LIBTRACEEVENT
1334 struct perf_event_attr attr;
1336 if (config_attr(&attr, head_config, err,
1337 config_term_tracepoint))
1341 if (strpbrk(sys, "*?"))
1342 return add_tracepoint_multi_sys(list, idx, sys, event,
1345 return add_tracepoint_event(list, idx, sys, event,
1353 parse_events_error__handle(err, 0, strdup("unsupported tracepoint"),
1354 strdup("libtraceevent is necessary for tracepoint support"));
1359 int parse_events_add_numeric(struct parse_events_state *parse_state,
1360 struct list_head *list,
1361 u32 type, u64 config,
1362 struct list_head *head_config)
1364 struct perf_event_attr attr;
1365 LIST_HEAD(config_terms);
1366 const char *name, *metric_id;
1370 memset(&attr, 0, sizeof(attr));
1372 attr.config = config;
1375 if (config_attr(&attr, head_config, parse_state->error,
1376 config_term_common))
1379 if (get_config_terms(head_config, &config_terms))
1383 name = get_config_name(head_config);
1384 metric_id = get_config_metric_id(head_config);
1385 ret = parse_events__add_numeric_hybrid(parse_state, list, &attr,
1387 &config_terms, &hybrid);
1389 goto out_free_terms;
1391 ret = add_event(list, &parse_state->idx, &attr, name, metric_id,
1394 free_config_terms(&config_terms);
1398 int parse_events_add_tool(struct parse_events_state *parse_state,
1399 struct list_head *list,
1402 return add_event_tool(list, &parse_state->idx, tool_event);
1405 static bool config_term_percore(struct list_head *config_terms)
1407 struct evsel_config_term *term;
1409 list_for_each_entry(term, config_terms, list) {
1410 if (term->type == EVSEL__CONFIG_TERM_PERCORE)
1411 return term->val.percore;
1417 static int parse_events__inside_hybrid_pmu(struct parse_events_state *parse_state,
1418 struct list_head *list, char *name,
1419 struct list_head *head_config)
1421 struct parse_events_term *term;
1424 if (parse_state->fake_pmu || !head_config || list_empty(head_config) ||
1425 !perf_pmu__is_hybrid(name)) {
1430 * More than one term in list.
1432 if (head_config->next && head_config->next->next != head_config)
1435 term = list_first_entry(head_config, struct parse_events_term, list);
1436 if (term && term->config && strcmp(term->config, "event")) {
1437 ret = parse_events__with_hybrid_pmu(parse_state, term->config,
1444 int parse_events_add_pmu(struct parse_events_state *parse_state,
1445 struct list_head *list, char *name,
1446 struct list_head *head_config,
1447 bool auto_merge_stats,
1450 struct perf_event_attr attr;
1451 struct perf_pmu_info info;
1452 struct perf_pmu *pmu;
1453 struct evsel *evsel;
1454 struct parse_events_error *err = parse_state->error;
1455 bool use_uncore_alias;
1456 LIST_HEAD(config_terms);
1458 pmu = parse_state->fake_pmu ?: perf_pmu__find(name);
1460 if (verbose > 1 && !(pmu && pmu->selectable)) {
1461 fprintf(stderr, "Attempting to add event pmu '%s' with '",
1464 struct parse_events_term *term;
1466 list_for_each_entry(term, head_config, list) {
1467 fprintf(stderr, "%s,", term->config);
1470 fprintf(stderr, "' that may result in non-fatal errors\n");
1476 if (asprintf(&err_str,
1477 "Cannot find PMU `%s'. Missing kernel support?",
1479 parse_events_error__handle(err, 0, err_str, NULL);
1483 if (pmu->default_config) {
1484 memcpy(&attr, pmu->default_config,
1485 sizeof(struct perf_event_attr));
1487 memset(&attr, 0, sizeof(attr));
1490 use_uncore_alias = (pmu->is_uncore && use_alias);
1493 attr.type = pmu->type;
1494 evsel = __add_event(list, &parse_state->idx, &attr,
1495 /*init_attr=*/true, /*name=*/NULL,
1496 /*metric_id=*/NULL, pmu,
1497 /*config_terms=*/NULL, auto_merge_stats,
1500 evsel->pmu_name = name ? strdup(name) : NULL;
1501 evsel->use_uncore_alias = use_uncore_alias;
1508 if (!parse_state->fake_pmu && perf_pmu__check_alias(pmu, head_config, &info))
1512 fprintf(stderr, "After aliases, add event pmu '%s' with '",
1515 struct parse_events_term *term;
1517 list_for_each_entry(term, head_config, list) {
1518 fprintf(stderr, "%s,", term->config);
1521 fprintf(stderr, "' that may result in non-fatal errors\n");
1525 * Configure hardcoded terms first, no need to check
1526 * return value when called with fail == 0 ;)
1528 if (config_attr(&attr, head_config, parse_state->error, config_term_pmu))
1531 if (get_config_terms(head_config, &config_terms))
1535 * When using default config, record which bits of attr->config were
1536 * changed by the user.
1538 if (pmu->default_config && get_config_chgs(pmu, head_config, &config_terms))
1541 if (!parse_events__inside_hybrid_pmu(parse_state, list, name,
1546 if (!parse_state->fake_pmu && perf_pmu__config(pmu, &attr, head_config, parse_state->error)) {
1547 free_config_terms(&config_terms);
1551 evsel = __add_event(list, &parse_state->idx, &attr, /*init_attr=*/true,
1552 get_config_name(head_config),
1553 get_config_metric_id(head_config), pmu,
1554 &config_terms, auto_merge_stats, /*cpu_list=*/NULL);
1559 evsel->use_config_name = true;
1561 evsel->pmu_name = name ? strdup(name) : NULL;
1562 evsel->use_uncore_alias = use_uncore_alias;
1563 evsel->percore = config_term_percore(&evsel->config_terms);
1565 if (parse_state->fake_pmu)
1568 free((char *)evsel->unit);
1569 evsel->unit = strdup(info.unit);
1570 evsel->scale = info.scale;
1571 evsel->per_pkg = info.per_pkg;
1572 evsel->snapshot = info.snapshot;
1573 evsel->metric_expr = info.metric_expr;
1574 evsel->metric_name = info.metric_name;
1578 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
1579 char *str, struct list_head *head,
1580 struct list_head **listp)
1582 struct parse_events_term *term;
1583 struct list_head *list = NULL;
1584 struct list_head *orig_head = NULL;
1585 struct perf_pmu *pmu = NULL;
1592 head = malloc(sizeof(struct list_head));
1596 INIT_LIST_HEAD(head);
1598 config = strdup(str);
1602 if (parse_events_term__num(&term,
1603 PARSE_EVENTS__TERM_TYPE_USER,
1604 config, 1, false, &config,
1609 list_add_tail(&term->list, head);
1611 /* Add it for all PMUs that support the alias */
1612 list = malloc(sizeof(struct list_head));
1616 INIT_LIST_HEAD(list);
1618 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1619 struct perf_pmu_alias *alias;
1621 list_for_each_entry(alias, &pmu->aliases, list) {
1622 if (!strcasecmp(alias->name, str)) {
1623 parse_events_copy_term_list(head, &orig_head);
1624 if (!parse_events_add_pmu(parse_state, list,
1625 pmu->name, orig_head,
1627 pr_debug("%s -> %s/%s/\n", str,
1628 pmu->name, alias->str);
1631 parse_events_terms__delete(orig_head);
1636 if (parse_state->fake_pmu) {
1637 if (!parse_events_add_pmu(parse_state, list, str, head,
1639 pr_debug("%s -> %s/%s/\n", str, "fake_pmu", str);
1650 parse_events_terms__delete(head);
1654 int parse_events__modifier_group(struct list_head *list,
1657 return parse_events__modifier_event(list, event_mod, true);
1661 * Check if the two uncore PMUs are from the same uncore block
1662 * The format of the uncore PMU name is uncore_#blockname_#pmuidx
1664 static bool is_same_uncore_block(const char *pmu_name_a, const char *pmu_name_b)
1666 char *end_a, *end_b;
1668 end_a = strrchr(pmu_name_a, '_');
1669 end_b = strrchr(pmu_name_b, '_');
1671 if (!end_a || !end_b)
1674 if ((end_a - pmu_name_a) != (end_b - pmu_name_b))
1677 return (strncmp(pmu_name_a, pmu_name_b, end_a - pmu_name_a) == 0);
1681 parse_events__set_leader_for_uncore_aliase(char *name, struct list_head *list,
1682 struct parse_events_state *parse_state)
1684 struct evsel *evsel, *leader;
1686 bool is_leader = true;
1687 int i, nr_pmu = 0, total_members, ret = 0;
1689 leader = list_first_entry(list, struct evsel, core.node);
1690 evsel = list_last_entry(list, struct evsel, core.node);
1691 total_members = evsel->core.idx - leader->core.idx + 1;
1693 leaders = calloc(total_members, sizeof(uintptr_t));
1694 if (WARN_ON(!leaders))
1698 * Going through the whole group and doing sanity check.
1699 * All members must use alias, and be from the same uncore block.
1700 * Also, storing the leader events in an array.
1702 __evlist__for_each_entry(list, evsel) {
1704 /* Only split the uncore group which members use alias */
1705 if (!evsel->use_uncore_alias)
1708 /* The events must be from the same uncore block */
1709 if (!is_same_uncore_block(leader->pmu_name, evsel->pmu_name))
1715 * If the event's PMU name starts to repeat, it must be a new
1716 * event. That can be used to distinguish the leader from
1717 * other members, even they have the same event name.
1719 if ((leader != evsel) &&
1720 !strcmp(leader->pmu_name, evsel->pmu_name)) {
1725 /* Store the leader event for each PMU */
1726 leaders[nr_pmu++] = (uintptr_t) evsel;
1729 /* only one event alias */
1730 if (nr_pmu == total_members) {
1731 parse_state->nr_groups--;
1736 * An uncore event alias is a joint name which means the same event
1737 * runs on all PMUs of a block.
1738 * Perf doesn't support mixed events from different PMUs in the same
1739 * group. The big group has to be split into multiple small groups
1740 * which only include the events from the same PMU.
1742 * Here the uncore event aliases must be from the same uncore block.
1743 * The number of PMUs must be same for each alias. The number of new
1744 * small groups equals to the number of PMUs.
1745 * Setting the leader event for corresponding members in each group.
1748 __evlist__for_each_entry(list, evsel) {
1751 evsel__set_leader(evsel, (struct evsel *) leaders[i++]);
1754 /* The number of members and group name are same for each group */
1755 for (i = 0; i < nr_pmu; i++) {
1756 evsel = (struct evsel *) leaders[i];
1757 evsel->core.nr_members = total_members / nr_pmu;
1758 evsel->group_name = name ? strdup(name) : NULL;
1761 /* Take the new small groups into account */
1762 parse_state->nr_groups += nr_pmu - 1;
1771 __weak struct evsel *arch_evlist__leader(struct list_head *list)
1773 return list_first_entry(list, struct evsel, core.node);
1776 void parse_events__set_leader(char *name, struct list_head *list,
1777 struct parse_events_state *parse_state)
1779 struct evsel *leader;
1781 if (list_empty(list)) {
1782 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1786 if (parse_events__set_leader_for_uncore_aliase(name, list, parse_state))
1789 leader = arch_evlist__leader(list);
1790 __perf_evlist__set_leader(list, &leader->core);
1791 leader->group_name = name ? strdup(name) : NULL;
1792 list_move(&leader->core.node, list);
1795 /* list_event is assumed to point to malloc'ed memory */
1796 void parse_events_update_lists(struct list_head *list_event,
1797 struct list_head *list_all)
1800 * Called for single event definition. Update the
1801 * 'all event' list, and reinit the 'single event'
1802 * list, for next event definition.
1804 list_splice_tail(list_event, list_all);
1808 struct event_modifier {
1825 static int get_event_modifier(struct event_modifier *mod, char *str,
1826 struct evsel *evsel)
1828 int eu = evsel ? evsel->core.attr.exclude_user : 0;
1829 int ek = evsel ? evsel->core.attr.exclude_kernel : 0;
1830 int eh = evsel ? evsel->core.attr.exclude_hv : 0;
1831 int eH = evsel ? evsel->core.attr.exclude_host : 0;
1832 int eG = evsel ? evsel->core.attr.exclude_guest : 0;
1833 int eI = evsel ? evsel->core.attr.exclude_idle : 0;
1834 int precise = evsel ? evsel->core.attr.precise_ip : 0;
1835 int precise_max = 0;
1836 int sample_read = 0;
1837 int pinned = evsel ? evsel->core.attr.pinned : 0;
1838 int exclusive = evsel ? evsel->core.attr.exclusive : 0;
1840 int exclude = eu | ek | eh;
1841 int exclude_GH = evsel ? evsel->exclude_GH : 0;
1843 int bpf_counter = 0;
1845 memset(mod, 0, sizeof(*mod));
1850 exclude = eu = ek = eh = 1;
1851 if (!exclude_GH && !perf_guest)
1854 } else if (*str == 'k') {
1856 exclude = eu = ek = eh = 1;
1858 } else if (*str == 'h') {
1860 exclude = eu = ek = eh = 1;
1862 } else if (*str == 'G') {
1864 exclude_GH = eG = eH = 1;
1866 } else if (*str == 'H') {
1868 exclude_GH = eG = eH = 1;
1870 } else if (*str == 'I') {
1872 } else if (*str == 'p') {
1874 /* use of precise requires exclude_guest */
1877 } else if (*str == 'P') {
1879 } else if (*str == 'S') {
1881 } else if (*str == 'D') {
1883 } else if (*str == 'e') {
1885 } else if (*str == 'W') {
1887 } else if (*str == 'b') {
1898 * 0 - SAMPLE_IP can have arbitrary skid
1899 * 1 - SAMPLE_IP must have constant skid
1900 * 2 - SAMPLE_IP requested to have 0 skid
1901 * 3 - SAMPLE_IP must have 0 skid
1903 * See also PERF_RECORD_MISC_EXACT_IP
1914 mod->precise = precise;
1915 mod->precise_max = precise_max;
1916 mod->exclude_GH = exclude_GH;
1917 mod->sample_read = sample_read;
1918 mod->pinned = pinned;
1920 mod->bpf_counter = bpf_counter;
1921 mod->exclusive = exclusive;
1927 * Basic modifier sanity check to validate it contains only one
1928 * instance of any modifier (apart from 'p') present.
1930 static int check_modifier(char *str)
1934 /* The sizeof includes 0 byte as well. */
1935 if (strlen(str) > (sizeof("ukhGHpppPSDIWeb") - 1))
1939 if (*p != 'p' && strchr(p + 1, *p))
1947 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
1949 struct evsel *evsel;
1950 struct event_modifier mod;
1955 if (check_modifier(str))
1958 if (!add && get_event_modifier(&mod, str, NULL))
1961 __evlist__for_each_entry(list, evsel) {
1962 if (add && get_event_modifier(&mod, str, evsel))
1965 evsel->core.attr.exclude_user = mod.eu;
1966 evsel->core.attr.exclude_kernel = mod.ek;
1967 evsel->core.attr.exclude_hv = mod.eh;
1968 evsel->core.attr.precise_ip = mod.precise;
1969 evsel->core.attr.exclude_host = mod.eH;
1970 evsel->core.attr.exclude_guest = mod.eG;
1971 evsel->core.attr.exclude_idle = mod.eI;
1972 evsel->exclude_GH = mod.exclude_GH;
1973 evsel->sample_read = mod.sample_read;
1974 evsel->precise_max = mod.precise_max;
1975 evsel->weak_group = mod.weak;
1976 evsel->bpf_counter = mod.bpf_counter;
1978 if (evsel__is_group_leader(evsel)) {
1979 evsel->core.attr.pinned = mod.pinned;
1980 evsel->core.attr.exclusive = mod.exclusive;
1987 int parse_events_name(struct list_head *list, const char *name)
1989 struct evsel *evsel;
1991 __evlist__for_each_entry(list, evsel) {
1993 evsel->name = strdup(name);
2000 comp_pmu(const void *p1, const void *p2)
2002 struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
2003 struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
2005 return strcasecmp(pmu1->symbol, pmu2->symbol);
2008 static void perf_pmu__parse_cleanup(void)
2010 if (perf_pmu_events_list_num > 0) {
2011 struct perf_pmu_event_symbol *p;
2014 for (i = 0; i < perf_pmu_events_list_num; i++) {
2015 p = perf_pmu_events_list + i;
2018 zfree(&perf_pmu_events_list);
2019 perf_pmu_events_list_num = 0;
2023 #define SET_SYMBOL(str, stype) \
2032 * Read the pmu events list from sysfs
2033 * Save it into perf_pmu_events_list
2035 static void perf_pmu__parse_init(void)
2038 struct perf_pmu *pmu = NULL;
2039 struct perf_pmu_alias *alias;
2043 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
2044 list_for_each_entry(alias, &pmu->aliases, list) {
2045 char *tmp = strchr(alias->name, '-');
2050 tmp2 = strchr(tmp + 1, '-');
2061 perf_pmu_events_list_num = -1;
2064 perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
2065 if (!perf_pmu_events_list)
2067 perf_pmu_events_list_num = len;
2071 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
2072 list_for_each_entry(alias, &pmu->aliases, list) {
2073 struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
2074 char *tmp = strchr(alias->name, '-');
2078 tmp2 = strchr(tmp + 1, '-');
2080 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
2081 PMU_EVENT_SYMBOL_PREFIX);
2084 SET_SYMBOL(strndup(tmp, tmp2 - tmp), PMU_EVENT_SYMBOL_SUFFIX);
2086 SET_SYMBOL(strdup(++tmp2), PMU_EVENT_SYMBOL_SUFFIX2);
2089 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
2090 PMU_EVENT_SYMBOL_PREFIX);
2092 SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
2095 SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
2100 qsort(perf_pmu_events_list, len,
2101 sizeof(struct perf_pmu_event_symbol), comp_pmu);
2105 perf_pmu__parse_cleanup();
2109 * This function injects special term in
2110 * perf_pmu_events_list so the test code
2111 * can check on this functionality.
2113 int perf_pmu__test_parse_init(void)
2115 struct perf_pmu_event_symbol *list, *tmp, symbols[] = {
2116 {(char *)"read", PMU_EVENT_SYMBOL},
2117 {(char *)"event", PMU_EVENT_SYMBOL_PREFIX},
2118 {(char *)"two", PMU_EVENT_SYMBOL_SUFFIX},
2119 {(char *)"hyphen", PMU_EVENT_SYMBOL_SUFFIX},
2120 {(char *)"hyph", PMU_EVENT_SYMBOL_SUFFIX2},
2124 tmp = list = malloc(sizeof(*list) * ARRAY_SIZE(symbols));
2128 for (i = 0; i < ARRAY_SIZE(symbols); i++, tmp++) {
2129 tmp->type = symbols[i].type;
2130 tmp->symbol = strdup(symbols[i].symbol);
2135 perf_pmu_events_list = list;
2136 perf_pmu_events_list_num = ARRAY_SIZE(symbols);
2138 qsort(perf_pmu_events_list, ARRAY_SIZE(symbols),
2139 sizeof(struct perf_pmu_event_symbol), comp_pmu);
2143 for (j = 0, tmp = list; j < i; j++, tmp++)
2149 enum perf_pmu_event_symbol_type
2150 perf_pmu__parse_check(const char *name)
2152 struct perf_pmu_event_symbol p, *r;
2154 /* scan kernel pmu events from sysfs if needed */
2155 if (perf_pmu_events_list_num == 0)
2156 perf_pmu__parse_init();
2158 * name "cpu" could be prefix of cpu-cycles or cpu// events.
2159 * cpu-cycles has been handled by hardcode.
2160 * So it must be cpu// events, not kernel pmu event.
2162 if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
2163 return PMU_EVENT_SYMBOL_ERR;
2165 p.symbol = strdup(name);
2166 r = bsearch(&p, perf_pmu_events_list,
2167 (size_t) perf_pmu_events_list_num,
2168 sizeof(struct perf_pmu_event_symbol), comp_pmu);
2170 return r ? r->type : PMU_EVENT_SYMBOL_ERR;
2173 static int parse_events__scanner(const char *str,
2174 struct parse_events_state *parse_state)
2176 YY_BUFFER_STATE buffer;
2180 ret = parse_events_lex_init_extra(parse_state, &scanner);
2184 buffer = parse_events__scan_string(str, scanner);
2187 parse_events_debug = 1;
2188 parse_events_set_debug(1, scanner);
2190 ret = parse_events_parse(parse_state, scanner);
2192 parse_events__flush_buffer(buffer, scanner);
2193 parse_events__delete_buffer(buffer, scanner);
2194 parse_events_lex_destroy(scanner);
2199 * parse event config string, return a list of event terms.
2201 int parse_events_terms(struct list_head *terms, const char *str)
2203 struct parse_events_state parse_state = {
2205 .stoken = PE_START_TERMS,
2209 ret = parse_events__scanner(str, &parse_state);
2210 perf_pmu__parse_cleanup();
2213 list_splice(parse_state.terms, terms);
2214 zfree(&parse_state.terms);
2218 parse_events_terms__delete(parse_state.terms);
2222 static int parse_events__with_hybrid_pmu(struct parse_events_state *parse_state,
2223 const char *str, char *pmu_name,
2224 struct list_head *list)
2226 struct parse_events_state ps = {
2227 .list = LIST_HEAD_INIT(ps.list),
2228 .stoken = PE_START_EVENTS,
2229 .hybrid_pmu_name = pmu_name,
2230 .idx = parse_state->idx,
2234 ret = parse_events__scanner(str, &ps);
2235 perf_pmu__parse_cleanup();
2238 if (!list_empty(&ps.list)) {
2239 list_splice(&ps.list, list);
2240 parse_state->idx = ps.idx;
2249 int __parse_events(struct evlist *evlist, const char *str,
2250 struct parse_events_error *err, struct perf_pmu *fake_pmu)
2252 struct parse_events_state parse_state = {
2253 .list = LIST_HEAD_INIT(parse_state.list),
2254 .idx = evlist->core.nr_entries,
2257 .stoken = PE_START_EVENTS,
2258 .fake_pmu = fake_pmu,
2262 ret = parse_events__scanner(str, &parse_state);
2263 perf_pmu__parse_cleanup();
2265 if (!ret && list_empty(&parse_state.list)) {
2266 WARN_ONCE(true, "WARNING: event parser found nothing\n");
2271 * Add list to the evlist even with errors to allow callers to clean up.
2273 evlist__splice_list_tail(evlist, &parse_state.list);
2278 evlist->core.nr_groups += parse_state.nr_groups;
2279 last = evlist__last(evlist);
2280 last->cmdline_group_boundary = true;
2286 * There are 2 users - builtin-record and builtin-test objects.
2287 * Both call evlist__delete in case of error, so we dont
2293 int parse_event(struct evlist *evlist, const char *str)
2295 struct parse_events_error err;
2298 parse_events_error__init(&err);
2299 ret = parse_events(evlist, str, &err);
2300 parse_events_error__exit(&err);
2304 void parse_events_error__init(struct parse_events_error *err)
2306 bzero(err, sizeof(*err));
2309 void parse_events_error__exit(struct parse_events_error *err)
2313 zfree(&err->first_str);
2314 zfree(&err->first_help);
2317 void parse_events_error__handle(struct parse_events_error *err, int idx,
2318 char *str, char *help)
2320 if (WARN(!str || !err, "WARNING: failed to provide error string or struct\n"))
2322 switch (err->num_errors) {
2329 err->first_idx = err->idx;
2331 err->first_str = err->str;
2333 err->first_help = err->help;
2337 pr_debug("Multiple errors dropping message: %s (%s)\n",
2338 err->str, err->help);
2353 #define MAX_WIDTH 1000
2354 static int get_term_width(void)
2358 get_term_dimensions(&ws);
2359 return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
2362 static void __parse_events_error__print(int err_idx, const char *err_str,
2363 const char *err_help, const char *event)
2365 const char *str = "invalid or unsupported event: ";
2366 char _buf[MAX_WIDTH];
2367 char *buf = (char *) event;
2370 /* -2 for extra '' in the final fprintf */
2371 int width = get_term_width() - 2;
2372 int len_event = strlen(event);
2373 int len_str, max_len, cut = 0;
2376 * Maximum error index indent, we will cut
2377 * the event string if it's bigger.
2379 int max_err_idx = 13;
2382 * Let's be specific with the message when
2383 * we have the precise error.
2385 str = "event syntax error: ";
2386 len_str = strlen(str);
2387 max_len = width - len_str;
2391 /* We're cutting from the beginning. */
2392 if (err_idx > max_err_idx)
2393 cut = err_idx - max_err_idx;
2395 strncpy(buf, event + cut, max_len);
2397 /* Mark cut parts with '..' on both sides. */
2399 buf[0] = buf[1] = '.';
2401 if ((len_event - cut) > max_len) {
2402 buf[max_len - 1] = buf[max_len - 2] = '.';
2406 idx = len_str + err_idx - cut;
2409 fprintf(stderr, "%s'%s'\n", str, buf);
2411 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err_str);
2413 fprintf(stderr, "\n%s\n", err_help);
2417 void parse_events_error__print(struct parse_events_error *err,
2420 if (!err->num_errors)
2423 __parse_events_error__print(err->idx, err->str, err->help, event);
2425 if (err->num_errors > 1) {
2426 fputs("\nInitial error:\n", stderr);
2427 __parse_events_error__print(err->first_idx, err->first_str,
2428 err->first_help, event);
2434 int parse_events_option(const struct option *opt, const char *str,
2435 int unset __maybe_unused)
2437 struct evlist *evlist = *(struct evlist **)opt->value;
2438 struct parse_events_error err;
2441 parse_events_error__init(&err);
2442 ret = parse_events(evlist, str, &err);
2445 parse_events_error__print(&err, str);
2446 fprintf(stderr, "Run 'perf list' for a list of valid events\n");
2448 parse_events_error__exit(&err);
2453 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset)
2455 struct evlist **evlistp = opt->value;
2458 if (*evlistp == NULL) {
2459 *evlistp = evlist__new();
2461 if (*evlistp == NULL) {
2462 fprintf(stderr, "Not enough memory to create evlist\n");
2467 ret = parse_events_option(opt, str, unset);
2469 evlist__delete(*evlistp);
2477 foreach_evsel_in_last_glob(struct evlist *evlist,
2478 int (*func)(struct evsel *evsel,
2482 struct evsel *last = NULL;
2486 * Don't return when list_empty, give func a chance to report
2487 * error when it found last == NULL.
2489 * So no need to WARN here, let *func do this.
2491 if (evlist->core.nr_entries > 0)
2492 last = evlist__last(evlist);
2495 err = (*func)(last, arg);
2501 if (last->core.node.prev == &evlist->core.entries)
2503 last = list_entry(last->core.node.prev, struct evsel, core.node);
2504 } while (!last->cmdline_group_boundary);
2509 static int set_filter(struct evsel *evsel, const void *arg)
2511 const char *str = arg;
2513 int nr_addr_filters = 0;
2514 struct perf_pmu *pmu = NULL;
2516 if (evsel == NULL) {
2518 "--filter option should follow a -e tracepoint or HW tracer option\n");
2522 if (evsel->core.attr.type == PERF_TYPE_TRACEPOINT) {
2523 if (evsel__append_tp_filter(evsel, str) < 0) {
2525 "not enough memory to hold filter string\n");
2532 while ((pmu = perf_pmu__scan(pmu)) != NULL)
2533 if (pmu->type == evsel->core.attr.type) {
2539 perf_pmu__scan_file(pmu, "nr_addr_filters",
2540 "%d", &nr_addr_filters);
2542 if (!nr_addr_filters) {
2544 "This CPU does not support address filtering\n");
2548 if (evsel__append_addr_filter(evsel, str) < 0) {
2550 "not enough memory to hold filter string\n");
2557 int parse_filter(const struct option *opt, const char *str,
2558 int unset __maybe_unused)
2560 struct evlist *evlist = *(struct evlist **)opt->value;
2562 return foreach_evsel_in_last_glob(evlist, set_filter,
2566 static int add_exclude_perf_filter(struct evsel *evsel,
2567 const void *arg __maybe_unused)
2569 char new_filter[64];
2571 if (evsel == NULL || evsel->core.attr.type != PERF_TYPE_TRACEPOINT) {
2573 "--exclude-perf option should follow a -e tracepoint option\n");
2577 snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
2579 if (evsel__append_tp_filter(evsel, new_filter) < 0) {
2581 "not enough memory to hold filter string\n");
2588 int exclude_perf(const struct option *opt,
2589 const char *arg __maybe_unused,
2590 int unset __maybe_unused)
2592 struct evlist *evlist = *(struct evlist **)opt->value;
2594 return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
2598 int parse_events__is_hardcoded_term(struct parse_events_term *term)
2600 return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
2603 static int new_term(struct parse_events_term **_term,
2604 struct parse_events_term *temp,
2607 struct parse_events_term *term;
2609 term = malloc(sizeof(*term));
2614 INIT_LIST_HEAD(&term->list);
2617 switch (term->type_val) {
2618 case PARSE_EVENTS__TERM_TYPE_NUM:
2619 term->val.num = num;
2621 case PARSE_EVENTS__TERM_TYPE_STR:
2622 term->val.str = str;
2633 int parse_events_term__num(struct parse_events_term **term,
2634 int type_term, char *config, u64 num,
2636 void *loc_term_, void *loc_val_)
2638 YYLTYPE *loc_term = loc_term_;
2639 YYLTYPE *loc_val = loc_val_;
2641 struct parse_events_term temp = {
2642 .type_val = PARSE_EVENTS__TERM_TYPE_NUM,
2643 .type_term = type_term,
2644 .config = config ? : strdup(config_term_names[type_term]),
2645 .no_value = no_value,
2646 .err_term = loc_term ? loc_term->first_column : 0,
2647 .err_val = loc_val ? loc_val->first_column : 0,
2650 return new_term(term, &temp, NULL, num);
2653 int parse_events_term__str(struct parse_events_term **term,
2654 int type_term, char *config, char *str,
2655 void *loc_term_, void *loc_val_)
2657 YYLTYPE *loc_term = loc_term_;
2658 YYLTYPE *loc_val = loc_val_;
2660 struct parse_events_term temp = {
2661 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2662 .type_term = type_term,
2664 .err_term = loc_term ? loc_term->first_column : 0,
2665 .err_val = loc_val ? loc_val->first_column : 0,
2668 return new_term(term, &temp, str, 0);
2671 int parse_events_term__sym_hw(struct parse_events_term **term,
2672 char *config, unsigned idx)
2674 struct event_symbol *sym;
2676 struct parse_events_term temp = {
2677 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2678 .type_term = PARSE_EVENTS__TERM_TYPE_USER,
2683 temp.config = strdup("event");
2687 BUG_ON(idx >= PERF_COUNT_HW_MAX);
2688 sym = &event_symbols_hw[idx];
2690 str = strdup(sym->symbol);
2693 return new_term(term, &temp, str, 0);
2696 int parse_events_term__clone(struct parse_events_term **new,
2697 struct parse_events_term *term)
2700 struct parse_events_term temp = {
2701 .type_val = term->type_val,
2702 .type_term = term->type_term,
2704 .err_term = term->err_term,
2705 .err_val = term->err_val,
2709 temp.config = strdup(term->config);
2713 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
2714 return new_term(new, &temp, NULL, term->val.num);
2716 str = strdup(term->val.str);
2719 return new_term(new, &temp, str, 0);
2722 void parse_events_term__delete(struct parse_events_term *term)
2724 if (term->array.nr_ranges)
2725 zfree(&term->array.ranges);
2727 if (term->type_val != PARSE_EVENTS__TERM_TYPE_NUM)
2728 zfree(&term->val.str);
2730 zfree(&term->config);
2734 int parse_events_copy_term_list(struct list_head *old,
2735 struct list_head **new)
2737 struct parse_events_term *term, *n;
2745 *new = malloc(sizeof(struct list_head));
2748 INIT_LIST_HEAD(*new);
2750 list_for_each_entry (term, old, list) {
2751 ret = parse_events_term__clone(&n, term);
2754 list_add_tail(&n->list, *new);
2759 void parse_events_terms__purge(struct list_head *terms)
2761 struct parse_events_term *term, *h;
2763 list_for_each_entry_safe(term, h, terms, list) {
2764 list_del_init(&term->list);
2765 parse_events_term__delete(term);
2769 void parse_events_terms__delete(struct list_head *terms)
2773 parse_events_terms__purge(terms);
2777 void parse_events__clear_array(struct parse_events_array *a)
2782 void parse_events_evlist_error(struct parse_events_state *parse_state,
2783 int idx, const char *str)
2785 if (!parse_state->error)
2788 parse_events_error__handle(parse_state->error, idx, strdup(str), NULL);
2791 static void config_terms_list(char *buf, size_t buf_sz)
2797 for (i = 0; i < __PARSE_EVENTS__TERM_TYPE_NR; i++) {
2798 const char *name = config_term_names[i];
2800 if (!config_term_avail(i, NULL))
2807 if (strlen(buf) + strlen(name) + 2 >= buf_sz)
2819 * Return string contains valid config terms of an event.
2820 * @additional_terms: For terms such as PMU sysfs terms.
2822 char *parse_events_formats_error_string(char *additional_terms)
2825 /* "no-overwrite" is the longest name */
2826 char static_terms[__PARSE_EVENTS__TERM_TYPE_NR *
2827 (sizeof("no-overwrite") - 1)];
2829 config_terms_list(static_terms, sizeof(static_terms));
2831 if (additional_terms) {
2832 if (asprintf(&str, "valid terms: %s,%s",
2833 additional_terms, static_terms) < 0)
2836 if (asprintf(&str, "valid terms: %s", static_terms) < 0)
2845 struct evsel *parse_events__add_event_hybrid(struct list_head *list, int *idx,
2846 struct perf_event_attr *attr,
2848 const char *metric_id,
2849 struct perf_pmu *pmu,
2850 struct list_head *config_terms)
2852 return __add_event(list, idx, attr, /*init_attr=*/true, name, metric_id,
2853 pmu, config_terms, /*auto_merge_stats=*/false,