1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/hw_breakpoint.h>
4 #include <linux/zalloc.h>
11 #include <sys/param.h>
16 #include <subcmd/pager.h>
17 #include <subcmd/parse-options.h>
18 #include "parse-events.h"
19 #include <subcmd/exec-cmd.h>
24 #include "bpf-loader.h"
26 #include <api/fs/tracing_path.h>
27 #include <perf/cpumap.h>
28 #include "parse-events-bison.h"
29 #define YY_EXTRA_TYPE int
30 #include "parse-events-flex.h"
32 #include "thread_map.h"
33 #include "probe-file.h"
35 #include "util/parse-branch-options.h"
36 #include "metricgroup.h"
37 #include "util/evsel_config.h"
38 #include "util/event.h"
40 #define MAX_NAME_LEN 100
43 extern int parse_events_debug;
45 int parse_events_parse(void *parse_state, void *scanner);
46 static int get_config_terms(struct list_head *head_config,
47 struct list_head *head_terms __maybe_unused);
49 static struct perf_pmu_event_symbol *perf_pmu_events_list;
51 * The variable indicates the number of supported pmu event symbols.
52 * 0 means not initialized and ready to init
53 * -1 means failed to init, don't try anymore
54 * >0 is the number of supported pmu event symbols
56 static int perf_pmu_events_list_num;
58 struct event_symbol event_symbols_hw[PERF_COUNT_HW_MAX] = {
59 [PERF_COUNT_HW_CPU_CYCLES] = {
60 .symbol = "cpu-cycles",
63 [PERF_COUNT_HW_INSTRUCTIONS] = {
64 .symbol = "instructions",
67 [PERF_COUNT_HW_CACHE_REFERENCES] = {
68 .symbol = "cache-references",
71 [PERF_COUNT_HW_CACHE_MISSES] = {
72 .symbol = "cache-misses",
75 [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
76 .symbol = "branch-instructions",
79 [PERF_COUNT_HW_BRANCH_MISSES] = {
80 .symbol = "branch-misses",
83 [PERF_COUNT_HW_BUS_CYCLES] = {
84 .symbol = "bus-cycles",
87 [PERF_COUNT_HW_STALLED_CYCLES_FRONTEND] = {
88 .symbol = "stalled-cycles-frontend",
89 .alias = "idle-cycles-frontend",
91 [PERF_COUNT_HW_STALLED_CYCLES_BACKEND] = {
92 .symbol = "stalled-cycles-backend",
93 .alias = "idle-cycles-backend",
95 [PERF_COUNT_HW_REF_CPU_CYCLES] = {
96 .symbol = "ref-cycles",
101 struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
102 [PERF_COUNT_SW_CPU_CLOCK] = {
103 .symbol = "cpu-clock",
106 [PERF_COUNT_SW_TASK_CLOCK] = {
107 .symbol = "task-clock",
110 [PERF_COUNT_SW_PAGE_FAULTS] = {
111 .symbol = "page-faults",
114 [PERF_COUNT_SW_CONTEXT_SWITCHES] = {
115 .symbol = "context-switches",
118 [PERF_COUNT_SW_CPU_MIGRATIONS] = {
119 .symbol = "cpu-migrations",
120 .alias = "migrations",
122 [PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
123 .symbol = "minor-faults",
126 [PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
127 .symbol = "major-faults",
130 [PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
131 .symbol = "alignment-faults",
134 [PERF_COUNT_SW_EMULATION_FAULTS] = {
135 .symbol = "emulation-faults",
138 [PERF_COUNT_SW_DUMMY] = {
142 [PERF_COUNT_SW_BPF_OUTPUT] = {
143 .symbol = "bpf-output",
148 #define __PERF_EVENT_FIELD(config, name) \
149 ((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
151 #define PERF_EVENT_RAW(config) __PERF_EVENT_FIELD(config, RAW)
152 #define PERF_EVENT_CONFIG(config) __PERF_EVENT_FIELD(config, CONFIG)
153 #define PERF_EVENT_TYPE(config) __PERF_EVENT_FIELD(config, TYPE)
154 #define PERF_EVENT_ID(config) __PERF_EVENT_FIELD(config, EVENT)
156 #define for_each_subsystem(sys_dir, sys_dirent) \
157 while ((sys_dirent = readdir(sys_dir)) != NULL) \
158 if (sys_dirent->d_type == DT_DIR && \
159 (strcmp(sys_dirent->d_name, ".")) && \
160 (strcmp(sys_dirent->d_name, "..")))
162 static int tp_event_has_id(const char *dir_path, struct dirent *evt_dir)
164 char evt_path[MAXPATHLEN];
167 snprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path, evt_dir->d_name);
168 fd = open(evt_path, O_RDONLY);
176 #define for_each_event(dir_path, evt_dir, evt_dirent) \
177 while ((evt_dirent = readdir(evt_dir)) != NULL) \
178 if (evt_dirent->d_type == DT_DIR && \
179 (strcmp(evt_dirent->d_name, ".")) && \
180 (strcmp(evt_dirent->d_name, "..")) && \
181 (!tp_event_has_id(dir_path, evt_dirent)))
183 #define MAX_EVENT_LENGTH 512
186 struct tracepoint_path *tracepoint_id_to_path(u64 config)
188 struct tracepoint_path *path = NULL;
189 DIR *sys_dir, *evt_dir;
190 struct dirent *sys_dirent, *evt_dirent;
194 char evt_path[MAXPATHLEN];
197 sys_dir = tracing_events__opendir();
201 for_each_subsystem(sys_dir, sys_dirent) {
202 dir_path = get_events_file(sys_dirent->d_name);
205 evt_dir = opendir(dir_path);
209 for_each_event(dir_path, evt_dir, evt_dirent) {
211 scnprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
213 fd = open(evt_path, O_RDONLY);
216 if (read(fd, id_buf, sizeof(id_buf)) < 0) {
223 put_events_file(dir_path);
226 path = zalloc(sizeof(*path));
229 path->system = malloc(MAX_EVENT_LENGTH);
234 path->name = malloc(MAX_EVENT_LENGTH);
236 zfree(&path->system);
240 strncpy(path->system, sys_dirent->d_name,
242 strncpy(path->name, evt_dirent->d_name,
249 put_events_file(dir_path);
256 struct tracepoint_path *tracepoint_name_to_path(const char *name)
258 struct tracepoint_path *path = zalloc(sizeof(*path));
259 char *str = strchr(name, ':');
261 if (path == NULL || str == NULL) {
266 path->system = strndup(name, str - name);
267 path->name = strdup(str+1);
269 if (path->system == NULL || path->name == NULL) {
270 zfree(&path->system);
278 const char *event_type(int type)
281 case PERF_TYPE_HARDWARE:
284 case PERF_TYPE_SOFTWARE:
287 case PERF_TYPE_TRACEPOINT:
290 case PERF_TYPE_HW_CACHE:
291 return "hardware-cache";
300 static int parse_events__is_name_term(struct parse_events_term *term)
302 return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
305 static char *get_config_name(struct list_head *head_terms)
307 struct parse_events_term *term;
312 list_for_each_entry(term, head_terms, list)
313 if (parse_events__is_name_term(term))
314 return term->val.str;
319 static struct evsel *
320 __add_event(struct list_head *list, int *idx,
321 struct perf_event_attr *attr,
322 char *name, struct perf_pmu *pmu,
323 struct list_head *config_terms, bool auto_merge_stats,
324 const char *cpu_list)
327 struct perf_cpu_map *cpus = pmu ? pmu->cpus :
328 cpu_list ? perf_cpu_map__new(cpu_list) : NULL;
330 event_attr_init(attr);
332 evsel = perf_evsel__new_idx(attr, *idx);
337 evsel->core.cpus = perf_cpu_map__get(cpus);
338 evsel->core.own_cpus = perf_cpu_map__get(cpus);
339 evsel->core.system_wide = pmu ? pmu->is_uncore : false;
340 evsel->auto_merge_stats = auto_merge_stats;
343 evsel->name = strdup(name);
346 list_splice(config_terms, &evsel->config_terms);
348 list_add_tail(&evsel->core.node, list);
352 static int add_event(struct list_head *list, int *idx,
353 struct perf_event_attr *attr, char *name,
354 struct list_head *config_terms)
356 return __add_event(list, idx, attr, name, NULL, config_terms, false, NULL) ? 0 : -ENOMEM;
359 static int add_event_tool(struct list_head *list, int *idx,
360 enum perf_tool_event tool_event)
363 struct perf_event_attr attr = {
364 .type = PERF_TYPE_SOFTWARE,
365 .config = PERF_COUNT_SW_DUMMY,
368 evsel = __add_event(list, idx, &attr, NULL, NULL, NULL, false, "0");
371 evsel->tool_event = tool_event;
372 if (tool_event == PERF_TOOL_DURATION_TIME)
373 evsel->unit = strdup("ns");
377 static int parse_aliases(char *str, const char *names[][PERF_EVSEL__MAX_ALIASES], int size)
382 for (i = 0; i < size; i++) {
383 for (j = 0; j < PERF_EVSEL__MAX_ALIASES && names[i][j]; j++) {
384 n = strlen(names[i][j]);
385 if (n > longest && !strncasecmp(str, names[i][j], n))
395 typedef int config_term_func_t(struct perf_event_attr *attr,
396 struct parse_events_term *term,
397 struct parse_events_error *err);
398 static int config_term_common(struct perf_event_attr *attr,
399 struct parse_events_term *term,
400 struct parse_events_error *err);
401 static int config_attr(struct perf_event_attr *attr,
402 struct list_head *head,
403 struct parse_events_error *err,
404 config_term_func_t config_term);
406 int parse_events_add_cache(struct list_head *list, int *idx,
407 char *type, char *op_result1, char *op_result2,
408 struct parse_events_error *err,
409 struct list_head *head_config)
411 struct perf_event_attr attr;
412 LIST_HEAD(config_terms);
413 char name[MAX_NAME_LEN], *config_name;
414 int cache_type = -1, cache_op = -1, cache_result = -1;
415 char *op_result[2] = { op_result1, op_result2 };
419 * No fallback - if we cannot get a clear cache type
422 cache_type = parse_aliases(type, perf_evsel__hw_cache,
423 PERF_COUNT_HW_CACHE_MAX);
424 if (cache_type == -1)
427 config_name = get_config_name(head_config);
428 n = snprintf(name, MAX_NAME_LEN, "%s", type);
430 for (i = 0; (i < 2) && (op_result[i]); i++) {
431 char *str = op_result[i];
433 n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
435 if (cache_op == -1) {
436 cache_op = parse_aliases(str, perf_evsel__hw_cache_op,
437 PERF_COUNT_HW_CACHE_OP_MAX);
439 if (!perf_evsel__is_cache_op_valid(cache_type, cache_op))
445 if (cache_result == -1) {
446 cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
447 PERF_COUNT_HW_CACHE_RESULT_MAX);
448 if (cache_result >= 0)
454 * Fall back to reads:
457 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
460 * Fall back to accesses:
462 if (cache_result == -1)
463 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
465 memset(&attr, 0, sizeof(attr));
466 attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
467 attr.type = PERF_TYPE_HW_CACHE;
470 if (config_attr(&attr, head_config, err,
474 if (get_config_terms(head_config, &config_terms))
477 return add_event(list, idx, &attr, config_name ? : name, &config_terms);
480 static void tracepoint_error(struct parse_events_error *e, int err,
481 const char *sys, const char *name)
489 * We get error directly from syscall errno ( > 0),
490 * or from encoded pointer's error ( < 0).
496 e->str = strdup("can't access trace events");
499 e->str = strdup("unknown tracepoint");
502 e->str = strdup("failed to add tracepoint");
506 tracing_path__strerror_open_tp(err, help, sizeof(help), sys, name);
507 e->help = strdup(help);
510 static int add_tracepoint(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)
517 evsel = perf_evsel__newtp_idx(sys_name, evt_name, (*idx)++);
519 tracepoint_error(err, PTR_ERR(evsel), sys_name, evt_name);
520 return PTR_ERR(evsel);
524 LIST_HEAD(config_terms);
526 if (get_config_terms(head_config, &config_terms))
528 list_splice(&config_terms, &evsel->config_terms);
531 list_add_tail(&evsel->core.node, list);
535 static int add_tracepoint_multi_event(struct list_head *list, int *idx,
536 const char *sys_name, const char *evt_name,
537 struct parse_events_error *err,
538 struct list_head *head_config)
541 struct dirent *evt_ent;
543 int ret = 0, found = 0;
545 evt_path = get_events_file(sys_name);
547 tracepoint_error(err, errno, sys_name, evt_name);
550 evt_dir = opendir(evt_path);
552 put_events_file(evt_path);
553 tracepoint_error(err, errno, sys_name, evt_name);
557 while (!ret && (evt_ent = readdir(evt_dir))) {
558 if (!strcmp(evt_ent->d_name, ".")
559 || !strcmp(evt_ent->d_name, "..")
560 || !strcmp(evt_ent->d_name, "enable")
561 || !strcmp(evt_ent->d_name, "filter"))
564 if (!strglobmatch(evt_ent->d_name, evt_name))
569 ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name,
574 tracepoint_error(err, ENOENT, sys_name, evt_name);
578 put_events_file(evt_path);
583 static int add_tracepoint_event(struct list_head *list, int *idx,
584 const char *sys_name, const char *evt_name,
585 struct parse_events_error *err,
586 struct list_head *head_config)
588 return strpbrk(evt_name, "*?") ?
589 add_tracepoint_multi_event(list, idx, sys_name, evt_name,
591 add_tracepoint(list, idx, sys_name, evt_name,
595 static int add_tracepoint_multi_sys(struct list_head *list, int *idx,
596 const char *sys_name, const char *evt_name,
597 struct parse_events_error *err,
598 struct list_head *head_config)
600 struct dirent *events_ent;
604 events_dir = tracing_events__opendir();
606 tracepoint_error(err, errno, sys_name, evt_name);
610 while (!ret && (events_ent = readdir(events_dir))) {
611 if (!strcmp(events_ent->d_name, ".")
612 || !strcmp(events_ent->d_name, "..")
613 || !strcmp(events_ent->d_name, "enable")
614 || !strcmp(events_ent->d_name, "header_event")
615 || !strcmp(events_ent->d_name, "header_page"))
618 if (!strglobmatch(events_ent->d_name, sys_name))
621 ret = add_tracepoint_event(list, idx, events_ent->d_name,
622 evt_name, err, head_config);
625 closedir(events_dir);
629 struct __add_bpf_event_param {
630 struct parse_events_state *parse_state;
631 struct list_head *list;
632 struct list_head *head_config;
635 static int add_bpf_event(const char *group, const char *event, int fd, struct bpf_object *obj,
638 LIST_HEAD(new_evsels);
639 struct __add_bpf_event_param *param = _param;
640 struct parse_events_state *parse_state = param->parse_state;
641 struct list_head *list = param->list;
645 * Check if we should add the event, i.e. if it is a TP but starts with a '!',
646 * then don't add the tracepoint, this will be used for something else, like
647 * adding to a BPF_MAP_TYPE_PROG_ARRAY.
649 * See tools/perf/examples/bpf/augmented_raw_syscalls.c
654 pr_debug("add bpf event %s:%s and attach bpf program %d\n",
657 err = parse_events_add_tracepoint(&new_evsels, &parse_state->idx, group,
658 event, parse_state->error,
661 struct evsel *evsel, *tmp;
663 pr_debug("Failed to add BPF event %s:%s\n",
665 list_for_each_entry_safe(evsel, tmp, &new_evsels, core.node) {
666 list_del_init(&evsel->core.node);
667 evsel__delete(evsel);
671 pr_debug("adding %s:%s\n", group, event);
673 list_for_each_entry(pos, &new_evsels, core.node) {
674 pr_debug("adding %s:%s to %p\n",
679 list_splice(&new_evsels, list);
683 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
684 struct list_head *list,
685 struct bpf_object *obj,
686 struct list_head *head_config)
690 struct __add_bpf_event_param param = {parse_state, list, head_config};
691 static bool registered_unprobe_atexit = false;
693 if (IS_ERR(obj) || !obj) {
694 snprintf(errbuf, sizeof(errbuf),
695 "Internal error: load bpf obj with NULL");
701 * Register atexit handler before calling bpf__probe() so
702 * bpf__probe() don't need to unprobe probe points its already
703 * created when failure.
705 if (!registered_unprobe_atexit) {
707 registered_unprobe_atexit = true;
710 err = bpf__probe(obj);
712 bpf__strerror_probe(obj, err, errbuf, sizeof(errbuf));
716 err = bpf__load(obj);
718 bpf__strerror_load(obj, err, errbuf, sizeof(errbuf));
722 err = bpf__foreach_event(obj, add_bpf_event, ¶m);
724 snprintf(errbuf, sizeof(errbuf),
725 "Attach events in BPF object failed");
731 parse_state->error->help = strdup("(add -v to see detail)");
732 parse_state->error->str = strdup(errbuf);
737 parse_events_config_bpf(struct parse_events_state *parse_state,
738 struct bpf_object *obj,
739 struct list_head *head_config)
741 struct parse_events_term *term;
744 if (!head_config || list_empty(head_config))
747 list_for_each_entry(term, head_config, list) {
751 if (term->type_term != PARSE_EVENTS__TERM_TYPE_USER) {
752 snprintf(errbuf, sizeof(errbuf),
753 "Invalid config term for BPF object");
754 errbuf[BUFSIZ - 1] = '\0';
756 parse_state->error->idx = term->err_term;
757 parse_state->error->str = strdup(errbuf);
761 err = bpf__config_obj(obj, term, parse_state->evlist, &error_pos);
763 bpf__strerror_config_obj(obj, term, parse_state->evlist,
764 &error_pos, err, errbuf,
766 parse_state->error->help = strdup(
767 "Hint:\tValid config terms:\n"
768 " \tmap:[<arraymap>].value<indices>=[value]\n"
769 " \tmap:[<eventmap>].event<indices>=[event]\n"
771 " \twhere <indices> is something like [0,3...5] or [all]\n"
772 " \t(add -v to see detail)");
773 parse_state->error->str = strdup(errbuf);
774 if (err == -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE)
775 parse_state->error->idx = term->err_val;
777 parse_state->error->idx = term->err_term + error_pos;
785 * Split config terms:
786 * perf record -e bpf.c/call-graph=fp,map:array.value[0]=1/ ...
787 * 'call-graph=fp' is 'evt config', should be applied to each
789 * 'map:array.value[0]=1' is 'obj config', should be processed
790 * with parse_events_config_bpf.
792 * Move object config terms from the first list to obj_head_config.
795 split_bpf_config_terms(struct list_head *evt_head_config,
796 struct list_head *obj_head_config)
798 struct parse_events_term *term, *temp;
801 * Currectly, all possible user config term
802 * belong to bpf object. parse_events__is_hardcoded_term()
803 * happends to be a good flag.
805 * See parse_events_config_bpf() and
806 * config_term_tracepoint().
808 list_for_each_entry_safe(term, temp, evt_head_config, list)
809 if (!parse_events__is_hardcoded_term(term))
810 list_move_tail(&term->list, obj_head_config);
813 int parse_events_load_bpf(struct parse_events_state *parse_state,
814 struct list_head *list,
817 struct list_head *head_config)
820 struct bpf_object *obj;
821 LIST_HEAD(obj_head_config);
824 split_bpf_config_terms(head_config, &obj_head_config);
826 obj = bpf__prepare_load(bpf_file_name, source);
833 snprintf(errbuf, sizeof(errbuf),
834 "BPF support is not compiled");
836 bpf__strerror_prepare_load(bpf_file_name,
841 parse_state->error->help = strdup("(add -v to see detail)");
842 parse_state->error->str = strdup(errbuf);
846 err = parse_events_load_bpf_obj(parse_state, list, obj, head_config);
849 err = parse_events_config_bpf(parse_state, obj, &obj_head_config);
852 * Caller doesn't know anything about obj_head_config,
853 * so combine them together again before returnning.
856 list_splice_tail(&obj_head_config, head_config);
861 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
865 for (i = 0; i < 3; i++) {
866 if (!type || !type[i])
869 #define CHECK_SET_TYPE(bit) \
871 if (attr->bp_type & bit) \
874 attr->bp_type |= bit; \
879 CHECK_SET_TYPE(HW_BREAKPOINT_R);
882 CHECK_SET_TYPE(HW_BREAKPOINT_W);
885 CHECK_SET_TYPE(HW_BREAKPOINT_X);
892 #undef CHECK_SET_TYPE
894 if (!attr->bp_type) /* Default */
895 attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
900 int parse_events_add_breakpoint(struct list_head *list, int *idx,
901 void *ptr, char *type, u64 len)
903 struct perf_event_attr attr;
905 memset(&attr, 0, sizeof(attr));
906 attr.bp_addr = (unsigned long) ptr;
908 if (parse_breakpoint_type(type, &attr))
911 /* Provide some defaults if len is not specified */
913 if (attr.bp_type == HW_BREAKPOINT_X)
916 len = HW_BREAKPOINT_LEN_4;
921 attr.type = PERF_TYPE_BREAKPOINT;
922 attr.sample_period = 1;
924 return add_event(list, idx, &attr, NULL, NULL);
927 static int check_type_val(struct parse_events_term *term,
928 struct parse_events_error *err,
931 if (type == term->type_val)
935 err->idx = term->err_val;
936 if (type == PARSE_EVENTS__TERM_TYPE_NUM)
937 err->str = strdup("expected numeric value");
939 err->str = strdup("expected string value");
945 * Update according to parse-events.l
947 static const char *config_term_names[__PARSE_EVENTS__TERM_TYPE_NR] = {
948 [PARSE_EVENTS__TERM_TYPE_USER] = "<sysfs term>",
949 [PARSE_EVENTS__TERM_TYPE_CONFIG] = "config",
950 [PARSE_EVENTS__TERM_TYPE_CONFIG1] = "config1",
951 [PARSE_EVENTS__TERM_TYPE_CONFIG2] = "config2",
952 [PARSE_EVENTS__TERM_TYPE_NAME] = "name",
953 [PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD] = "period",
954 [PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ] = "freq",
955 [PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE] = "branch_type",
956 [PARSE_EVENTS__TERM_TYPE_TIME] = "time",
957 [PARSE_EVENTS__TERM_TYPE_CALLGRAPH] = "call-graph",
958 [PARSE_EVENTS__TERM_TYPE_STACKSIZE] = "stack-size",
959 [PARSE_EVENTS__TERM_TYPE_NOINHERIT] = "no-inherit",
960 [PARSE_EVENTS__TERM_TYPE_INHERIT] = "inherit",
961 [PARSE_EVENTS__TERM_TYPE_MAX_STACK] = "max-stack",
962 [PARSE_EVENTS__TERM_TYPE_MAX_EVENTS] = "nr",
963 [PARSE_EVENTS__TERM_TYPE_OVERWRITE] = "overwrite",
964 [PARSE_EVENTS__TERM_TYPE_NOOVERWRITE] = "no-overwrite",
965 [PARSE_EVENTS__TERM_TYPE_DRV_CFG] = "driver-config",
966 [PARSE_EVENTS__TERM_TYPE_PERCORE] = "percore",
967 [PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT] = "aux-output",
970 static bool config_term_shrinked;
973 config_term_avail(int term_type, struct parse_events_error *err)
975 if (term_type < 0 || term_type >= __PARSE_EVENTS__TERM_TYPE_NR) {
976 err->str = strdup("Invalid term_type");
979 if (!config_term_shrinked)
983 case PARSE_EVENTS__TERM_TYPE_CONFIG:
984 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
985 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
986 case PARSE_EVENTS__TERM_TYPE_NAME:
987 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
988 case PARSE_EVENTS__TERM_TYPE_PERCORE:
994 /* term_type is validated so indexing is safe */
995 if (asprintf(&err->str, "'%s' is not usable in 'perf stat'",
996 config_term_names[term_type]) < 0)
1002 void parse_events__shrink_config_terms(void)
1004 config_term_shrinked = true;
1007 static int config_term_common(struct perf_event_attr *attr,
1008 struct parse_events_term *term,
1009 struct parse_events_error *err)
1011 #define CHECK_TYPE_VAL(type) \
1013 if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
1017 switch (term->type_term) {
1018 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1019 CHECK_TYPE_VAL(NUM);
1020 attr->config = term->val.num;
1022 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
1023 CHECK_TYPE_VAL(NUM);
1024 attr->config1 = term->val.num;
1026 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
1027 CHECK_TYPE_VAL(NUM);
1028 attr->config2 = term->val.num;
1030 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1031 CHECK_TYPE_VAL(NUM);
1033 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1034 CHECK_TYPE_VAL(NUM);
1036 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1037 CHECK_TYPE_VAL(STR);
1038 if (strcmp(term->val.str, "no") &&
1039 parse_branch_str(term->val.str, &attr->branch_sample_type)) {
1040 err->str = strdup("invalid branch sample type");
1041 err->idx = term->err_val;
1045 case PARSE_EVENTS__TERM_TYPE_TIME:
1046 CHECK_TYPE_VAL(NUM);
1047 if (term->val.num > 1) {
1048 err->str = strdup("expected 0 or 1");
1049 err->idx = term->err_val;
1053 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1054 CHECK_TYPE_VAL(STR);
1056 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1057 CHECK_TYPE_VAL(NUM);
1059 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1060 CHECK_TYPE_VAL(NUM);
1062 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1063 CHECK_TYPE_VAL(NUM);
1065 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1066 CHECK_TYPE_VAL(NUM);
1068 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1069 CHECK_TYPE_VAL(NUM);
1071 case PARSE_EVENTS__TERM_TYPE_NAME:
1072 CHECK_TYPE_VAL(STR);
1074 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1075 CHECK_TYPE_VAL(NUM);
1077 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1078 CHECK_TYPE_VAL(NUM);
1080 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1081 CHECK_TYPE_VAL(NUM);
1082 if ((unsigned int)term->val.num > 1) {
1083 err->str = strdup("expected 0 or 1");
1084 err->idx = term->err_val;
1088 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1089 CHECK_TYPE_VAL(NUM);
1092 err->str = strdup("unknown term");
1093 err->idx = term->err_term;
1094 err->help = parse_events_formats_error_string(NULL);
1099 * Check term availbility after basic checking so
1100 * PARSE_EVENTS__TERM_TYPE_USER can be found and filtered.
1102 * If check availbility at the entry of this function,
1103 * user will see "'<sysfs term>' is not usable in 'perf stat'"
1104 * if an invalid config term is provided for legacy events
1105 * (for example, instructions/badterm/...), which is confusing.
1107 if (!config_term_avail(term->type_term, err))
1110 #undef CHECK_TYPE_VAL
1113 static int config_term_pmu(struct perf_event_attr *attr,
1114 struct parse_events_term *term,
1115 struct parse_events_error *err)
1117 if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER ||
1118 term->type_term == PARSE_EVENTS__TERM_TYPE_DRV_CFG)
1120 * Always succeed for sysfs terms, as we dont know
1121 * at this point what type they need to have.
1125 return config_term_common(attr, term, err);
1128 static int config_term_tracepoint(struct perf_event_attr *attr,
1129 struct parse_events_term *term,
1130 struct parse_events_error *err)
1132 switch (term->type_term) {
1133 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1134 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1135 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1136 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1137 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1138 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1139 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1140 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1141 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1142 return config_term_common(attr, term, err);
1145 err->idx = term->err_term;
1146 err->str = strdup("unknown term");
1147 err->help = strdup("valid terms: call-graph,stack-size\n");
1155 static int config_attr(struct perf_event_attr *attr,
1156 struct list_head *head,
1157 struct parse_events_error *err,
1158 config_term_func_t config_term)
1160 struct parse_events_term *term;
1162 list_for_each_entry(term, head, list)
1163 if (config_term(attr, term, err))
1169 static int get_config_terms(struct list_head *head_config,
1170 struct list_head *head_terms __maybe_unused)
1172 #define ADD_CONFIG_TERM(__type, __name, __val) \
1174 struct perf_evsel_config_term *__t; \
1176 __t = zalloc(sizeof(*__t)); \
1180 INIT_LIST_HEAD(&__t->list); \
1181 __t->type = PERF_EVSEL__CONFIG_TERM_ ## __type; \
1182 __t->val.__name = __val; \
1183 __t->weak = term->weak; \
1184 list_add_tail(&__t->list, head_terms); \
1187 struct parse_events_term *term;
1189 list_for_each_entry(term, head_config, list) {
1190 switch (term->type_term) {
1191 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1192 ADD_CONFIG_TERM(PERIOD, period, term->val.num);
1194 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1195 ADD_CONFIG_TERM(FREQ, freq, term->val.num);
1197 case PARSE_EVENTS__TERM_TYPE_TIME:
1198 ADD_CONFIG_TERM(TIME, time, term->val.num);
1200 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1201 ADD_CONFIG_TERM(CALLGRAPH, callgraph, term->val.str);
1203 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1204 ADD_CONFIG_TERM(BRANCH, branch, term->val.str);
1206 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1207 ADD_CONFIG_TERM(STACK_USER, stack_user, term->val.num);
1209 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1210 ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 1 : 0);
1212 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1213 ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 0 : 1);
1215 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1216 ADD_CONFIG_TERM(MAX_STACK, max_stack, term->val.num);
1218 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1219 ADD_CONFIG_TERM(MAX_EVENTS, max_events, term->val.num);
1221 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1222 ADD_CONFIG_TERM(OVERWRITE, overwrite, term->val.num ? 1 : 0);
1224 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1225 ADD_CONFIG_TERM(OVERWRITE, overwrite, term->val.num ? 0 : 1);
1227 case PARSE_EVENTS__TERM_TYPE_DRV_CFG:
1228 ADD_CONFIG_TERM(DRV_CFG, drv_cfg, term->val.str);
1230 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1231 ADD_CONFIG_TERM(PERCORE, percore,
1232 term->val.num ? true : false);
1234 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1235 ADD_CONFIG_TERM(AUX_OUTPUT, aux_output, term->val.num ? 1 : 0);
1241 #undef ADD_EVSEL_CONFIG
1245 int parse_events_add_tracepoint(struct list_head *list, int *idx,
1246 const char *sys, const char *event,
1247 struct parse_events_error *err,
1248 struct list_head *head_config)
1251 struct perf_event_attr attr;
1253 if (config_attr(&attr, head_config, err,
1254 config_term_tracepoint))
1258 if (strpbrk(sys, "*?"))
1259 return add_tracepoint_multi_sys(list, idx, sys, event,
1262 return add_tracepoint_event(list, idx, sys, event,
1266 int parse_events_add_numeric(struct parse_events_state *parse_state,
1267 struct list_head *list,
1268 u32 type, u64 config,
1269 struct list_head *head_config)
1271 struct perf_event_attr attr;
1272 LIST_HEAD(config_terms);
1274 memset(&attr, 0, sizeof(attr));
1276 attr.config = config;
1279 if (config_attr(&attr, head_config, parse_state->error,
1280 config_term_common))
1283 if (get_config_terms(head_config, &config_terms))
1287 return add_event(list, &parse_state->idx, &attr,
1288 get_config_name(head_config), &config_terms);
1291 int parse_events_add_tool(struct parse_events_state *parse_state,
1292 struct list_head *list,
1293 enum perf_tool_event tool_event)
1295 return add_event_tool(list, &parse_state->idx, tool_event);
1298 static bool config_term_percore(struct list_head *config_terms)
1300 struct perf_evsel_config_term *term;
1302 list_for_each_entry(term, config_terms, list) {
1303 if (term->type == PERF_EVSEL__CONFIG_TERM_PERCORE)
1304 return term->val.percore;
1310 int parse_events_add_pmu(struct parse_events_state *parse_state,
1311 struct list_head *list, char *name,
1312 struct list_head *head_config,
1313 bool auto_merge_stats,
1316 struct perf_event_attr attr;
1317 struct perf_pmu_info info;
1318 struct perf_pmu *pmu;
1319 struct evsel *evsel;
1320 struct parse_events_error *err = parse_state->error;
1321 bool use_uncore_alias;
1322 LIST_HEAD(config_terms);
1324 pmu = perf_pmu__find(name);
1326 if (asprintf(&err->str,
1327 "Cannot find PMU `%s'. Missing kernel support?",
1333 if (pmu->default_config) {
1334 memcpy(&attr, pmu->default_config,
1335 sizeof(struct perf_event_attr));
1337 memset(&attr, 0, sizeof(attr));
1340 use_uncore_alias = (pmu->is_uncore && use_alias);
1343 attr.type = pmu->type;
1344 evsel = __add_event(list, &parse_state->idx, &attr, NULL, pmu, NULL,
1345 auto_merge_stats, NULL);
1347 evsel->pmu_name = name;
1348 evsel->use_uncore_alias = use_uncore_alias;
1355 if (perf_pmu__check_alias(pmu, head_config, &info))
1359 * Configure hardcoded terms first, no need to check
1360 * return value when called with fail == 0 ;)
1362 if (config_attr(&attr, head_config, parse_state->error, config_term_pmu))
1365 if (get_config_terms(head_config, &config_terms))
1368 if (perf_pmu__config(pmu, &attr, head_config, parse_state->error))
1371 evsel = __add_event(list, &parse_state->idx, &attr,
1372 get_config_name(head_config), pmu,
1373 &config_terms, auto_merge_stats, NULL);
1375 evsel->unit = info.unit;
1376 evsel->scale = info.scale;
1377 evsel->per_pkg = info.per_pkg;
1378 evsel->snapshot = info.snapshot;
1379 evsel->metric_expr = info.metric_expr;
1380 evsel->metric_name = info.metric_name;
1381 evsel->pmu_name = name;
1382 evsel->use_uncore_alias = use_uncore_alias;
1383 evsel->percore = config_term_percore(&evsel->config_terms);
1386 return evsel ? 0 : -ENOMEM;
1389 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
1390 char *str, struct list_head **listp)
1392 struct list_head *head;
1393 struct parse_events_term *term;
1394 struct list_head *list;
1395 struct perf_pmu *pmu = NULL;
1399 /* Add it for all PMUs that support the alias */
1400 list = malloc(sizeof(struct list_head));
1403 INIT_LIST_HEAD(list);
1404 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1405 struct perf_pmu_alias *alias;
1407 list_for_each_entry(alias, &pmu->aliases, list) {
1408 if (!strcasecmp(alias->name, str)) {
1409 head = malloc(sizeof(struct list_head));
1412 INIT_LIST_HEAD(head);
1413 if (parse_events_term__num(&term, PARSE_EVENTS__TERM_TYPE_USER,
1414 str, 1, false, &str, NULL) < 0)
1416 list_add_tail(&term->list, head);
1418 if (!parse_events_add_pmu(parse_state, list,
1421 pr_debug("%s -> %s/%s/\n", str,
1422 pmu->name, alias->str);
1426 parse_events_terms__delete(head);
1436 int parse_events__modifier_group(struct list_head *list,
1439 return parse_events__modifier_event(list, event_mod, true);
1443 * Check if the two uncore PMUs are from the same uncore block
1444 * The format of the uncore PMU name is uncore_#blockname_#pmuidx
1446 static bool is_same_uncore_block(const char *pmu_name_a, const char *pmu_name_b)
1448 char *end_a, *end_b;
1450 end_a = strrchr(pmu_name_a, '_');
1451 end_b = strrchr(pmu_name_b, '_');
1453 if (!end_a || !end_b)
1456 if ((end_a - pmu_name_a) != (end_b - pmu_name_b))
1459 return (strncmp(pmu_name_a, pmu_name_b, end_a - pmu_name_a) == 0);
1463 parse_events__set_leader_for_uncore_aliase(char *name, struct list_head *list,
1464 struct parse_events_state *parse_state)
1466 struct evsel *evsel, *leader;
1468 bool is_leader = true;
1469 int i, nr_pmu = 0, total_members, ret = 0;
1471 leader = list_first_entry(list, struct evsel, core.node);
1472 evsel = list_last_entry(list, struct evsel, core.node);
1473 total_members = evsel->idx - leader->idx + 1;
1475 leaders = calloc(total_members, sizeof(uintptr_t));
1476 if (WARN_ON(!leaders))
1480 * Going through the whole group and doing sanity check.
1481 * All members must use alias, and be from the same uncore block.
1482 * Also, storing the leader events in an array.
1484 __evlist__for_each_entry(list, evsel) {
1486 /* Only split the uncore group which members use alias */
1487 if (!evsel->use_uncore_alias)
1490 /* The events must be from the same uncore block */
1491 if (!is_same_uncore_block(leader->pmu_name, evsel->pmu_name))
1497 * If the event's PMU name starts to repeat, it must be a new
1498 * event. That can be used to distinguish the leader from
1499 * other members, even they have the same event name.
1501 if ((leader != evsel) && (leader->pmu_name == evsel->pmu_name)) {
1505 /* The name is always alias name */
1506 WARN_ON(strcmp(leader->name, evsel->name));
1508 /* Store the leader event for each PMU */
1509 leaders[nr_pmu++] = (uintptr_t) evsel;
1512 /* only one event alias */
1513 if (nr_pmu == total_members) {
1514 parse_state->nr_groups--;
1519 * An uncore event alias is a joint name which means the same event
1520 * runs on all PMUs of a block.
1521 * Perf doesn't support mixed events from different PMUs in the same
1522 * group. The big group has to be split into multiple small groups
1523 * which only include the events from the same PMU.
1525 * Here the uncore event aliases must be from the same uncore block.
1526 * The number of PMUs must be same for each alias. The number of new
1527 * small groups equals to the number of PMUs.
1528 * Setting the leader event for corresponding members in each group.
1531 __evlist__for_each_entry(list, evsel) {
1534 evsel->leader = (struct evsel *) leaders[i++];
1537 /* The number of members and group name are same for each group */
1538 for (i = 0; i < nr_pmu; i++) {
1539 evsel = (struct evsel *) leaders[i];
1540 evsel->core.nr_members = total_members / nr_pmu;
1541 evsel->group_name = name ? strdup(name) : NULL;
1544 /* Take the new small groups into account */
1545 parse_state->nr_groups += nr_pmu - 1;
1554 void parse_events__set_leader(char *name, struct list_head *list,
1555 struct parse_events_state *parse_state)
1557 struct evsel *leader;
1559 if (list_empty(list)) {
1560 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1564 if (parse_events__set_leader_for_uncore_aliase(name, list, parse_state))
1567 __perf_evlist__set_leader(list);
1568 leader = list_entry(list->next, struct evsel, core.node);
1569 leader->group_name = name ? strdup(name) : NULL;
1572 /* list_event is assumed to point to malloc'ed memory */
1573 void parse_events_update_lists(struct list_head *list_event,
1574 struct list_head *list_all)
1577 * Called for single event definition. Update the
1578 * 'all event' list, and reinit the 'single event'
1579 * list, for next event definition.
1581 list_splice_tail(list_event, list_all);
1585 struct event_modifier {
1600 static int get_event_modifier(struct event_modifier *mod, char *str,
1601 struct evsel *evsel)
1603 int eu = evsel ? evsel->core.attr.exclude_user : 0;
1604 int ek = evsel ? evsel->core.attr.exclude_kernel : 0;
1605 int eh = evsel ? evsel->core.attr.exclude_hv : 0;
1606 int eH = evsel ? evsel->core.attr.exclude_host : 0;
1607 int eG = evsel ? evsel->core.attr.exclude_guest : 0;
1608 int eI = evsel ? evsel->core.attr.exclude_idle : 0;
1609 int precise = evsel ? evsel->core.attr.precise_ip : 0;
1610 int precise_max = 0;
1611 int sample_read = 0;
1612 int pinned = evsel ? evsel->core.attr.pinned : 0;
1614 int exclude = eu | ek | eh;
1615 int exclude_GH = evsel ? evsel->exclude_GH : 0;
1618 memset(mod, 0, sizeof(*mod));
1623 exclude = eu = ek = eh = 1;
1625 } else if (*str == 'k') {
1627 exclude = eu = ek = eh = 1;
1629 } else if (*str == 'h') {
1631 exclude = eu = ek = eh = 1;
1633 } else if (*str == 'G') {
1635 exclude_GH = eG = eH = 1;
1637 } else if (*str == 'H') {
1639 exclude_GH = eG = eH = 1;
1641 } else if (*str == 'I') {
1643 } else if (*str == 'p') {
1645 /* use of precise requires exclude_guest */
1648 } else if (*str == 'P') {
1650 } else if (*str == 'S') {
1652 } else if (*str == 'D') {
1654 } else if (*str == 'W') {
1665 * 0 - SAMPLE_IP can have arbitrary skid
1666 * 1 - SAMPLE_IP must have constant skid
1667 * 2 - SAMPLE_IP requested to have 0 skid
1668 * 3 - SAMPLE_IP must have 0 skid
1670 * See also PERF_RECORD_MISC_EXACT_IP
1681 mod->precise = precise;
1682 mod->precise_max = precise_max;
1683 mod->exclude_GH = exclude_GH;
1684 mod->sample_read = sample_read;
1685 mod->pinned = pinned;
1692 * Basic modifier sanity check to validate it contains only one
1693 * instance of any modifier (apart from 'p') present.
1695 static int check_modifier(char *str)
1699 /* The sizeof includes 0 byte as well. */
1700 if (strlen(str) > (sizeof("ukhGHpppPSDIW") - 1))
1704 if (*p != 'p' && strchr(p + 1, *p))
1712 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
1714 struct evsel *evsel;
1715 struct event_modifier mod;
1720 if (check_modifier(str))
1723 if (!add && get_event_modifier(&mod, str, NULL))
1726 __evlist__for_each_entry(list, evsel) {
1727 if (add && get_event_modifier(&mod, str, evsel))
1730 evsel->core.attr.exclude_user = mod.eu;
1731 evsel->core.attr.exclude_kernel = mod.ek;
1732 evsel->core.attr.exclude_hv = mod.eh;
1733 evsel->core.attr.precise_ip = mod.precise;
1734 evsel->core.attr.exclude_host = mod.eH;
1735 evsel->core.attr.exclude_guest = mod.eG;
1736 evsel->core.attr.exclude_idle = mod.eI;
1737 evsel->exclude_GH = mod.exclude_GH;
1738 evsel->sample_read = mod.sample_read;
1739 evsel->precise_max = mod.precise_max;
1740 evsel->weak_group = mod.weak;
1742 if (perf_evsel__is_group_leader(evsel))
1743 evsel->core.attr.pinned = mod.pinned;
1749 int parse_events_name(struct list_head *list, char *name)
1751 struct evsel *evsel;
1753 __evlist__for_each_entry(list, evsel) {
1755 evsel->name = strdup(name);
1762 comp_pmu(const void *p1, const void *p2)
1764 struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
1765 struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
1767 return strcasecmp(pmu1->symbol, pmu2->symbol);
1770 static void perf_pmu__parse_cleanup(void)
1772 if (perf_pmu_events_list_num > 0) {
1773 struct perf_pmu_event_symbol *p;
1776 for (i = 0; i < perf_pmu_events_list_num; i++) {
1777 p = perf_pmu_events_list + i;
1780 zfree(&perf_pmu_events_list);
1781 perf_pmu_events_list_num = 0;
1785 #define SET_SYMBOL(str, stype) \
1794 * Read the pmu events list from sysfs
1795 * Save it into perf_pmu_events_list
1797 static void perf_pmu__parse_init(void)
1800 struct perf_pmu *pmu = NULL;
1801 struct perf_pmu_alias *alias;
1805 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1806 list_for_each_entry(alias, &pmu->aliases, list) {
1807 if (strchr(alias->name, '-'))
1814 perf_pmu_events_list_num = -1;
1817 perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
1818 if (!perf_pmu_events_list)
1820 perf_pmu_events_list_num = len;
1824 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1825 list_for_each_entry(alias, &pmu->aliases, list) {
1826 struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
1827 char *tmp = strchr(alias->name, '-');
1830 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
1831 PMU_EVENT_SYMBOL_PREFIX);
1833 SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
1836 SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
1841 qsort(perf_pmu_events_list, len,
1842 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1846 perf_pmu__parse_cleanup();
1849 enum perf_pmu_event_symbol_type
1850 perf_pmu__parse_check(const char *name)
1852 struct perf_pmu_event_symbol p, *r;
1854 /* scan kernel pmu events from sysfs if needed */
1855 if (perf_pmu_events_list_num == 0)
1856 perf_pmu__parse_init();
1858 * name "cpu" could be prefix of cpu-cycles or cpu// events.
1859 * cpu-cycles has been handled by hardcode.
1860 * So it must be cpu// events, not kernel pmu event.
1862 if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
1863 return PMU_EVENT_SYMBOL_ERR;
1865 p.symbol = strdup(name);
1866 r = bsearch(&p, perf_pmu_events_list,
1867 (size_t) perf_pmu_events_list_num,
1868 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1870 return r ? r->type : PMU_EVENT_SYMBOL_ERR;
1873 static int parse_events__scanner(const char *str, void *parse_state, int start_token)
1875 YY_BUFFER_STATE buffer;
1879 ret = parse_events_lex_init_extra(start_token, &scanner);
1883 buffer = parse_events__scan_string(str, scanner);
1886 parse_events_debug = 1;
1888 ret = parse_events_parse(parse_state, scanner);
1890 parse_events__flush_buffer(buffer, scanner);
1891 parse_events__delete_buffer(buffer, scanner);
1892 parse_events_lex_destroy(scanner);
1897 * parse event config string, return a list of event terms.
1899 int parse_events_terms(struct list_head *terms, const char *str)
1901 struct parse_events_state parse_state = {
1906 ret = parse_events__scanner(str, &parse_state, PE_START_TERMS);
1908 list_splice(parse_state.terms, terms);
1909 zfree(&parse_state.terms);
1913 parse_events_terms__delete(parse_state.terms);
1917 int parse_events(struct evlist *evlist, const char *str,
1918 struct parse_events_error *err)
1920 struct parse_events_state parse_state = {
1921 .list = LIST_HEAD_INIT(parse_state.list),
1922 .idx = evlist->core.nr_entries,
1928 ret = parse_events__scanner(str, &parse_state, PE_START_EVENTS);
1929 perf_pmu__parse_cleanup();
1933 if (list_empty(&parse_state.list)) {
1934 WARN_ONCE(true, "WARNING: event parser found nothing\n");
1938 perf_evlist__splice_list_tail(evlist, &parse_state.list);
1939 evlist->nr_groups += parse_state.nr_groups;
1940 last = evlist__last(evlist);
1941 last->cmdline_group_boundary = true;
1947 * There are 2 users - builtin-record and builtin-test objects.
1948 * Both call evlist__delete in case of error, so we dont
1954 #define MAX_WIDTH 1000
1955 static int get_term_width(void)
1959 get_term_dimensions(&ws);
1960 return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
1963 void parse_events_print_error(struct parse_events_error *err,
1966 const char *str = "invalid or unsupported event: ";
1967 char _buf[MAX_WIDTH];
1968 char *buf = (char *) event;
1972 /* -2 for extra '' in the final fprintf */
1973 int width = get_term_width() - 2;
1974 int len_event = strlen(event);
1975 int len_str, max_len, cut = 0;
1978 * Maximum error index indent, we will cut
1979 * the event string if it's bigger.
1981 int max_err_idx = 13;
1984 * Let's be specific with the message when
1985 * we have the precise error.
1987 str = "event syntax error: ";
1988 len_str = strlen(str);
1989 max_len = width - len_str;
1993 /* We're cutting from the beginning. */
1994 if (err->idx > max_err_idx)
1995 cut = err->idx - max_err_idx;
1997 strncpy(buf, event + cut, max_len);
1999 /* Mark cut parts with '..' on both sides. */
2001 buf[0] = buf[1] = '.';
2003 if ((len_event - cut) > max_len) {
2004 buf[max_len - 1] = buf[max_len - 2] = '.';
2008 idx = len_str + err->idx - cut;
2011 fprintf(stderr, "%s'%s'\n", str, buf);
2013 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err->str);
2015 fprintf(stderr, "\n%s\n", err->help);
2023 int parse_events_option(const struct option *opt, const char *str,
2024 int unset __maybe_unused)
2026 struct evlist *evlist = *(struct evlist **)opt->value;
2027 struct parse_events_error err = { .idx = 0, };
2028 int ret = parse_events(evlist, str, &err);
2031 parse_events_print_error(&err, str);
2032 fprintf(stderr, "Run 'perf list' for a list of valid events\n");
2039 foreach_evsel_in_last_glob(struct evlist *evlist,
2040 int (*func)(struct evsel *evsel,
2044 struct evsel *last = NULL;
2048 * Don't return when list_empty, give func a chance to report
2049 * error when it found last == NULL.
2051 * So no need to WARN here, let *func do this.
2053 if (evlist->core.nr_entries > 0)
2054 last = evlist__last(evlist);
2057 err = (*func)(last, arg);
2063 if (last->core.node.prev == &evlist->core.entries)
2065 last = list_entry(last->core.node.prev, struct evsel, core.node);
2066 } while (!last->cmdline_group_boundary);
2071 static int set_filter(struct evsel *evsel, const void *arg)
2073 const char *str = arg;
2075 int nr_addr_filters = 0;
2076 struct perf_pmu *pmu = NULL;
2078 if (evsel == NULL) {
2080 "--filter option should follow a -e tracepoint or HW tracer option\n");
2084 if (evsel->core.attr.type == PERF_TYPE_TRACEPOINT) {
2085 if (perf_evsel__append_tp_filter(evsel, str) < 0) {
2087 "not enough memory to hold filter string\n");
2094 while ((pmu = perf_pmu__scan(pmu)) != NULL)
2095 if (pmu->type == evsel->core.attr.type) {
2101 perf_pmu__scan_file(pmu, "nr_addr_filters",
2102 "%d", &nr_addr_filters);
2104 if (!nr_addr_filters) {
2106 "This CPU does not support address filtering\n");
2110 if (perf_evsel__append_addr_filter(evsel, str) < 0) {
2112 "not enough memory to hold filter string\n");
2119 int parse_filter(const struct option *opt, const char *str,
2120 int unset __maybe_unused)
2122 struct evlist *evlist = *(struct evlist **)opt->value;
2124 return foreach_evsel_in_last_glob(evlist, set_filter,
2128 static int add_exclude_perf_filter(struct evsel *evsel,
2129 const void *arg __maybe_unused)
2131 char new_filter[64];
2133 if (evsel == NULL || evsel->core.attr.type != PERF_TYPE_TRACEPOINT) {
2135 "--exclude-perf option should follow a -e tracepoint option\n");
2139 snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
2141 if (perf_evsel__append_tp_filter(evsel, new_filter) < 0) {
2143 "not enough memory to hold filter string\n");
2150 int exclude_perf(const struct option *opt,
2151 const char *arg __maybe_unused,
2152 int unset __maybe_unused)
2154 struct evlist *evlist = *(struct evlist **)opt->value;
2156 return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
2160 static const char * const event_type_descriptors[] = {
2164 "Hardware cache event",
2165 "Raw hardware event descriptor",
2166 "Hardware breakpoint",
2169 static int cmp_string(const void *a, const void *b)
2171 const char * const *as = a;
2172 const char * const *bs = b;
2174 return strcmp(*as, *bs);
2178 * Print the events from <debugfs_mount_point>/tracing/events
2181 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
2184 DIR *sys_dir, *evt_dir;
2185 struct dirent *sys_dirent, *evt_dirent;
2186 char evt_path[MAXPATHLEN];
2188 char **evt_list = NULL;
2189 unsigned int evt_i = 0, evt_num = 0;
2190 bool evt_num_known = false;
2193 sys_dir = tracing_events__opendir();
2197 if (evt_num_known) {
2198 evt_list = zalloc(sizeof(char *) * evt_num);
2200 goto out_close_sys_dir;
2203 for_each_subsystem(sys_dir, sys_dirent) {
2204 if (subsys_glob != NULL &&
2205 !strglobmatch(sys_dirent->d_name, subsys_glob))
2208 dir_path = get_events_file(sys_dirent->d_name);
2211 evt_dir = opendir(dir_path);
2215 for_each_event(dir_path, evt_dir, evt_dirent) {
2216 if (event_glob != NULL &&
2217 !strglobmatch(evt_dirent->d_name, event_glob))
2220 if (!evt_num_known) {
2225 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2226 sys_dirent->d_name, evt_dirent->d_name);
2228 evt_list[evt_i] = strdup(evt_path);
2229 if (evt_list[evt_i] == NULL) {
2230 put_events_file(dir_path);
2231 goto out_close_evt_dir;
2237 put_events_file(dir_path);
2241 if (!evt_num_known) {
2242 evt_num_known = true;
2245 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2247 while (evt_i < evt_num) {
2249 printf("%s ", evt_list[evt_i++]);
2252 printf(" %-50s [%s]\n", evt_list[evt_i++],
2253 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2255 if (evt_num && pager_in_use())
2260 for (evt_i = 0; evt_i < evt_num; evt_i++)
2261 zfree(&evt_list[evt_i]);
2270 printf("FATAL: not enough memory to print %s\n",
2271 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2277 * Check whether event is in <debugfs_mount_point>/tracing/events
2280 int is_valid_tracepoint(const char *event_string)
2282 DIR *sys_dir, *evt_dir;
2283 struct dirent *sys_dirent, *evt_dirent;
2284 char evt_path[MAXPATHLEN];
2287 sys_dir = tracing_events__opendir();
2291 for_each_subsystem(sys_dir, sys_dirent) {
2292 dir_path = get_events_file(sys_dirent->d_name);
2295 evt_dir = opendir(dir_path);
2299 for_each_event(dir_path, evt_dir, evt_dirent) {
2300 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2301 sys_dirent->d_name, evt_dirent->d_name);
2302 if (!strcmp(evt_path, event_string)) {
2310 put_events_file(dir_path);
2316 static bool is_event_supported(u8 type, unsigned config)
2320 struct evsel *evsel;
2321 struct perf_event_attr attr = {
2326 struct perf_thread_map *tmap = thread_map__new_by_tid(0);
2331 evsel = evsel__new(&attr);
2333 open_return = evsel__open(evsel, NULL, tmap);
2334 ret = open_return >= 0;
2336 if (open_return == -EACCES) {
2338 * This happens if the paranoid value
2339 * /proc/sys/kernel/perf_event_paranoid is set to 2
2340 * Re-run with exclude_kernel set; we don't do that
2341 * by default as some ARM machines do not support it.
2344 evsel->core.attr.exclude_kernel = 1;
2345 ret = evsel__open(evsel, NULL, tmap) >= 0;
2347 evsel__delete(evsel);
2350 perf_thread_map__put(tmap);
2354 void print_sdt_events(const char *subsys_glob, const char *event_glob,
2357 struct probe_cache *pcache;
2358 struct probe_cache_entry *ent;
2359 struct strlist *bidlist, *sdtlist;
2360 struct strlist_config cfg = {.dont_dupstr = true};
2361 struct str_node *nd, *nd2;
2362 char *buf, *path, *ptr = NULL;
2363 bool show_detail = false;
2366 sdtlist = strlist__new(NULL, &cfg);
2368 pr_debug("Failed to allocate new strlist for SDT\n");
2371 bidlist = build_id_cache__list_all(true);
2373 pr_debug("Failed to get buildids: %d\n", errno);
2376 strlist__for_each_entry(nd, bidlist) {
2377 pcache = probe_cache__new(nd->s, NULL);
2380 list_for_each_entry(ent, &pcache->entries, node) {
2384 !strglobmatch(ent->pev.group, subsys_glob))
2387 !strglobmatch(ent->pev.event, event_glob))
2389 ret = asprintf(&buf, "%s:%s@%s", ent->pev.group,
2390 ent->pev.event, nd->s);
2392 strlist__add(sdtlist, buf);
2394 probe_cache__delete(pcache);
2396 strlist__delete(bidlist);
2398 strlist__for_each_entry(nd, sdtlist) {
2399 buf = strchr(nd->s, '@');
2403 printf("%s ", nd->s);
2406 nd2 = strlist__next(nd);
2408 ptr = strchr(nd2->s, '@');
2411 if (strcmp(nd->s, nd2->s) == 0)
2415 path = build_id_cache__origname(buf);
2416 ret = asprintf(&buf, "%s@%s(%.12s)", nd->s, path, buf);
2418 printf(" %-50s [%s]\n", buf, "SDT event");
2423 printf(" %-50s [%s]\n", nd->s, "SDT event");
2425 if (strcmp(nd->s, nd2->s) != 0)
2426 show_detail = false;
2431 strlist__delete(sdtlist);
2434 int print_hwcache_events(const char *event_glob, bool name_only)
2436 unsigned int type, op, i, evt_i = 0, evt_num = 0;
2438 char **evt_list = NULL;
2439 bool evt_num_known = false;
2442 if (evt_num_known) {
2443 evt_list = zalloc(sizeof(char *) * evt_num);
2448 for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
2449 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
2450 /* skip invalid cache type */
2451 if (!perf_evsel__is_cache_op_valid(type, op))
2454 for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
2455 __perf_evsel__hw_cache_type_op_res_name(type, op, i,
2456 name, sizeof(name));
2457 if (event_glob != NULL && !strglobmatch(name, event_glob))
2460 if (!is_event_supported(PERF_TYPE_HW_CACHE,
2461 type | (op << 8) | (i << 16)))
2464 if (!evt_num_known) {
2469 evt_list[evt_i] = strdup(name);
2470 if (evt_list[evt_i] == NULL)
2477 if (!evt_num_known) {
2478 evt_num_known = true;
2481 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2483 while (evt_i < evt_num) {
2485 printf("%s ", evt_list[evt_i++]);
2488 printf(" %-50s [%s]\n", evt_list[evt_i++],
2489 event_type_descriptors[PERF_TYPE_HW_CACHE]);
2491 if (evt_num && pager_in_use())
2496 for (evt_i = 0; evt_i < evt_num; evt_i++)
2497 zfree(&evt_list[evt_i]);
2502 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
2508 static void print_tool_event(const char *name, const char *event_glob,
2511 if (event_glob && !strglobmatch(name, event_glob))
2514 printf("%s ", name);
2516 printf(" %-50s [%s]\n", name, "Tool event");
2520 void print_tool_events(const char *event_glob, bool name_only)
2522 print_tool_event("duration_time", event_glob, name_only);
2527 void print_symbol_events(const char *event_glob, unsigned type,
2528 struct event_symbol *syms, unsigned max,
2531 unsigned int i, evt_i = 0, evt_num = 0;
2532 char name[MAX_NAME_LEN];
2533 char **evt_list = NULL;
2534 bool evt_num_known = false;
2537 if (evt_num_known) {
2538 evt_list = zalloc(sizeof(char *) * evt_num);
2544 for (i = 0; i < max; i++, syms++) {
2546 if (event_glob != NULL && syms->symbol != NULL &&
2547 !(strglobmatch(syms->symbol, event_glob) ||
2548 (syms->alias && strglobmatch(syms->alias, event_glob))))
2551 if (!is_event_supported(type, i))
2554 if (!evt_num_known) {
2559 if (!name_only && strlen(syms->alias))
2560 snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
2562 strlcpy(name, syms->symbol, MAX_NAME_LEN);
2564 evt_list[evt_i] = strdup(name);
2565 if (evt_list[evt_i] == NULL)
2570 if (!evt_num_known) {
2571 evt_num_known = true;
2574 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2576 while (evt_i < evt_num) {
2578 printf("%s ", evt_list[evt_i++]);
2581 printf(" %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
2583 if (evt_num && pager_in_use())
2588 for (evt_i = 0; evt_i < evt_num; evt_i++)
2589 zfree(&evt_list[evt_i]);
2594 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
2600 * Print the help text for the event symbols:
2602 void print_events(const char *event_glob, bool name_only, bool quiet_flag,
2603 bool long_desc, bool details_flag)
2605 print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
2606 event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
2608 print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
2609 event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
2610 print_tool_events(event_glob, name_only);
2612 print_hwcache_events(event_glob, name_only);
2614 print_pmu_events(event_glob, name_only, quiet_flag, long_desc,
2617 if (event_glob != NULL)
2621 printf(" %-50s [%s]\n",
2623 event_type_descriptors[PERF_TYPE_RAW]);
2624 printf(" %-50s [%s]\n",
2625 "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
2626 event_type_descriptors[PERF_TYPE_RAW]);
2628 printf(" (see 'man perf-list' on how to encode it)\n\n");
2630 printf(" %-50s [%s]\n",
2631 "mem:<addr>[/len][:access]",
2632 event_type_descriptors[PERF_TYPE_BREAKPOINT]);
2637 print_tracepoint_events(NULL, NULL, name_only);
2639 print_sdt_events(NULL, NULL, name_only);
2641 metricgroup__print(true, true, NULL, name_only, details_flag);
2644 int parse_events__is_hardcoded_term(struct parse_events_term *term)
2646 return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
2649 static int new_term(struct parse_events_term **_term,
2650 struct parse_events_term *temp,
2653 struct parse_events_term *term;
2655 term = malloc(sizeof(*term));
2660 INIT_LIST_HEAD(&term->list);
2663 switch (term->type_val) {
2664 case PARSE_EVENTS__TERM_TYPE_NUM:
2665 term->val.num = num;
2667 case PARSE_EVENTS__TERM_TYPE_STR:
2668 term->val.str = str;
2679 int parse_events_term__num(struct parse_events_term **term,
2680 int type_term, char *config, u64 num,
2682 void *loc_term_, void *loc_val_)
2684 YYLTYPE *loc_term = loc_term_;
2685 YYLTYPE *loc_val = loc_val_;
2687 struct parse_events_term temp = {
2688 .type_val = PARSE_EVENTS__TERM_TYPE_NUM,
2689 .type_term = type_term,
2691 .no_value = no_value,
2692 .err_term = loc_term ? loc_term->first_column : 0,
2693 .err_val = loc_val ? loc_val->first_column : 0,
2696 return new_term(term, &temp, NULL, num);
2699 int parse_events_term__str(struct parse_events_term **term,
2700 int type_term, char *config, char *str,
2701 void *loc_term_, void *loc_val_)
2703 YYLTYPE *loc_term = loc_term_;
2704 YYLTYPE *loc_val = loc_val_;
2706 struct parse_events_term temp = {
2707 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2708 .type_term = type_term,
2710 .err_term = loc_term ? loc_term->first_column : 0,
2711 .err_val = loc_val ? loc_val->first_column : 0,
2714 return new_term(term, &temp, str, 0);
2717 int parse_events_term__sym_hw(struct parse_events_term **term,
2718 char *config, unsigned idx)
2720 struct event_symbol *sym;
2721 struct parse_events_term temp = {
2722 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2723 .type_term = PARSE_EVENTS__TERM_TYPE_USER,
2724 .config = config ?: (char *) "event",
2727 BUG_ON(idx >= PERF_COUNT_HW_MAX);
2728 sym = &event_symbols_hw[idx];
2730 return new_term(term, &temp, (char *) sym->symbol, 0);
2733 int parse_events_term__clone(struct parse_events_term **new,
2734 struct parse_events_term *term)
2736 struct parse_events_term temp = {
2737 .type_val = term->type_val,
2738 .type_term = term->type_term,
2739 .config = term->config,
2740 .err_term = term->err_term,
2741 .err_val = term->err_val,
2744 return new_term(new, &temp, term->val.str, term->val.num);
2747 int parse_events_copy_term_list(struct list_head *old,
2748 struct list_head **new)
2750 struct parse_events_term *term, *n;
2758 *new = malloc(sizeof(struct list_head));
2761 INIT_LIST_HEAD(*new);
2763 list_for_each_entry (term, old, list) {
2764 ret = parse_events_term__clone(&n, term);
2767 list_add_tail(&n->list, *new);
2772 void parse_events_terms__purge(struct list_head *terms)
2774 struct parse_events_term *term, *h;
2776 list_for_each_entry_safe(term, h, terms, list) {
2777 if (term->array.nr_ranges)
2778 zfree(&term->array.ranges);
2779 list_del_init(&term->list);
2784 void parse_events_terms__delete(struct list_head *terms)
2788 parse_events_terms__purge(terms);
2792 void parse_events__clear_array(struct parse_events_array *a)
2797 void parse_events_evlist_error(struct parse_events_state *parse_state,
2798 int idx, const char *str)
2800 struct parse_events_error *err = parse_state->error;
2805 err->str = strdup(str);
2806 WARN_ONCE(!err->str, "WARNING: failed to allocate error string");
2809 static void config_terms_list(char *buf, size_t buf_sz)
2815 for (i = 0; i < __PARSE_EVENTS__TERM_TYPE_NR; i++) {
2816 const char *name = config_term_names[i];
2818 if (!config_term_avail(i, NULL))
2825 if (strlen(buf) + strlen(name) + 2 >= buf_sz)
2837 * Return string contains valid config terms of an event.
2838 * @additional_terms: For terms such as PMU sysfs terms.
2840 char *parse_events_formats_error_string(char *additional_terms)
2843 /* "no-overwrite" is the longest name */
2844 char static_terms[__PARSE_EVENTS__TERM_TYPE_NR *
2845 (sizeof("no-overwrite") - 1)];
2847 config_terms_list(static_terms, sizeof(static_terms));
2849 if (additional_terms) {
2850 if (asprintf(&str, "valid terms: %s,%s",
2851 additional_terms, static_terms) < 0)
2854 if (asprintf(&str, "valid terms: %s", static_terms) < 0)