gpio: rcar: Fix runtime PM imbalance on error
[linux/fpc-iii.git] / tools / perf / util / parse-events.c
blob10107747b36176f2b49ee7aa65f2607de5645fe6
1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/hw_breakpoint.h>
3 #include <linux/err.h>
4 #include <linux/zalloc.h>
5 #include <dirent.h>
6 #include <errno.h>
7 #include <sys/ioctl.h>
8 #include <sys/types.h>
9 #include <sys/stat.h>
10 #include <fcntl.h>
11 #include <sys/param.h>
12 #include "term.h"
13 #include "build-id.h"
14 #include "evlist.h"
15 #include "evsel.h"
16 #include <subcmd/pager.h>
17 #include <subcmd/parse-options.h>
18 #include "parse-events.h"
19 #include <subcmd/exec-cmd.h>
20 #include "string2.h"
21 #include "strlist.h"
22 #include "symbol.h"
23 #include "header.h"
24 #include "bpf-loader.h"
25 #include "debug.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"
31 #include "pmu.h"
32 #include "thread_map.h"
33 #include "probe-file.h"
34 #include "asm/bug.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
42 #ifdef PARSER_DEBUG
43 extern int parse_events_debug;
44 #endif
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",
61 .alias = "cycles",
63 [PERF_COUNT_HW_INSTRUCTIONS] = {
64 .symbol = "instructions",
65 .alias = "",
67 [PERF_COUNT_HW_CACHE_REFERENCES] = {
68 .symbol = "cache-references",
69 .alias = "",
71 [PERF_COUNT_HW_CACHE_MISSES] = {
72 .symbol = "cache-misses",
73 .alias = "",
75 [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
76 .symbol = "branch-instructions",
77 .alias = "branches",
79 [PERF_COUNT_HW_BRANCH_MISSES] = {
80 .symbol = "branch-misses",
81 .alias = "",
83 [PERF_COUNT_HW_BUS_CYCLES] = {
84 .symbol = "bus-cycles",
85 .alias = "",
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",
97 .alias = "",
101 struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
102 [PERF_COUNT_SW_CPU_CLOCK] = {
103 .symbol = "cpu-clock",
104 .alias = "",
106 [PERF_COUNT_SW_TASK_CLOCK] = {
107 .symbol = "task-clock",
108 .alias = "",
110 [PERF_COUNT_SW_PAGE_FAULTS] = {
111 .symbol = "page-faults",
112 .alias = "faults",
114 [PERF_COUNT_SW_CONTEXT_SWITCHES] = {
115 .symbol = "context-switches",
116 .alias = "cs",
118 [PERF_COUNT_SW_CPU_MIGRATIONS] = {
119 .symbol = "cpu-migrations",
120 .alias = "migrations",
122 [PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
123 .symbol = "minor-faults",
124 .alias = "",
126 [PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
127 .symbol = "major-faults",
128 .alias = "",
130 [PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
131 .symbol = "alignment-faults",
132 .alias = "",
134 [PERF_COUNT_SW_EMULATION_FAULTS] = {
135 .symbol = "emulation-faults",
136 .alias = "",
138 [PERF_COUNT_SW_DUMMY] = {
139 .symbol = "dummy",
140 .alias = "",
142 [PERF_COUNT_SW_BPF_OUTPUT] = {
143 .symbol = "bpf-output",
144 .alias = "",
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];
165 int fd;
167 snprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path, evt_dir->d_name);
168 fd = open(evt_path, O_RDONLY);
169 if (fd < 0)
170 return -EINVAL;
171 close(fd);
173 return 0;
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
185 void parse_events__handle_error(struct parse_events_error *err, int idx,
186 char *str, char *help)
188 if (WARN(!str, "WARNING: failed to provide error string\n")) {
189 free(help);
190 return;
192 switch (err->num_errors) {
193 case 0:
194 err->idx = idx;
195 err->str = str;
196 err->help = help;
197 break;
198 case 1:
199 err->first_idx = err->idx;
200 err->idx = idx;
201 err->first_str = err->str;
202 err->str = str;
203 err->first_help = err->help;
204 err->help = help;
205 break;
206 default:
207 WARN_ONCE(1, "WARNING: multiple event parsing errors\n");
208 free(err->str);
209 err->str = str;
210 free(err->help);
211 err->help = help;
212 break;
214 err->num_errors++;
217 struct tracepoint_path *tracepoint_id_to_path(u64 config)
219 struct tracepoint_path *path = NULL;
220 DIR *sys_dir, *evt_dir;
221 struct dirent *sys_dirent, *evt_dirent;
222 char id_buf[24];
223 int fd;
224 u64 id;
225 char evt_path[MAXPATHLEN];
226 char *dir_path;
228 sys_dir = tracing_events__opendir();
229 if (!sys_dir)
230 return NULL;
232 for_each_subsystem(sys_dir, sys_dirent) {
233 dir_path = get_events_file(sys_dirent->d_name);
234 if (!dir_path)
235 continue;
236 evt_dir = opendir(dir_path);
237 if (!evt_dir)
238 goto next;
240 for_each_event(dir_path, evt_dir, evt_dirent) {
242 scnprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
243 evt_dirent->d_name);
244 fd = open(evt_path, O_RDONLY);
245 if (fd < 0)
246 continue;
247 if (read(fd, id_buf, sizeof(id_buf)) < 0) {
248 close(fd);
249 continue;
251 close(fd);
252 id = atoll(id_buf);
253 if (id == config) {
254 put_events_file(dir_path);
255 closedir(evt_dir);
256 closedir(sys_dir);
257 path = zalloc(sizeof(*path));
258 if (!path)
259 return NULL;
260 if (asprintf(&path->system, "%.*s", MAX_EVENT_LENGTH, sys_dirent->d_name) < 0) {
261 free(path);
262 return NULL;
264 if (asprintf(&path->name, "%.*s", MAX_EVENT_LENGTH, evt_dirent->d_name) < 0) {
265 zfree(&path->system);
266 free(path);
267 return NULL;
269 return path;
272 closedir(evt_dir);
273 next:
274 put_events_file(dir_path);
277 closedir(sys_dir);
278 return NULL;
281 struct tracepoint_path *tracepoint_name_to_path(const char *name)
283 struct tracepoint_path *path = zalloc(sizeof(*path));
284 char *str = strchr(name, ':');
286 if (path == NULL || str == NULL) {
287 free(path);
288 return NULL;
291 path->system = strndup(name, str - name);
292 path->name = strdup(str+1);
294 if (path->system == NULL || path->name == NULL) {
295 zfree(&path->system);
296 zfree(&path->name);
297 zfree(&path);
300 return path;
303 const char *event_type(int type)
305 switch (type) {
306 case PERF_TYPE_HARDWARE:
307 return "hardware";
309 case PERF_TYPE_SOFTWARE:
310 return "software";
312 case PERF_TYPE_TRACEPOINT:
313 return "tracepoint";
315 case PERF_TYPE_HW_CACHE:
316 return "hardware-cache";
318 default:
319 break;
322 return "unknown";
325 static int parse_events__is_name_term(struct parse_events_term *term)
327 return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
330 static char *get_config_name(struct list_head *head_terms)
332 struct parse_events_term *term;
334 if (!head_terms)
335 return NULL;
337 list_for_each_entry(term, head_terms, list)
338 if (parse_events__is_name_term(term))
339 return term->val.str;
341 return NULL;
344 static struct evsel *
345 __add_event(struct list_head *list, int *idx,
346 struct perf_event_attr *attr,
347 char *name, struct perf_pmu *pmu,
348 struct list_head *config_terms, bool auto_merge_stats,
349 const char *cpu_list)
351 struct evsel *evsel;
352 struct perf_cpu_map *cpus = pmu ? pmu->cpus :
353 cpu_list ? perf_cpu_map__new(cpu_list) : NULL;
355 event_attr_init(attr);
357 evsel = perf_evsel__new_idx(attr, *idx);
358 if (!evsel)
359 return NULL;
361 (*idx)++;
362 evsel->core.cpus = perf_cpu_map__get(cpus);
363 evsel->core.own_cpus = perf_cpu_map__get(cpus);
364 evsel->core.system_wide = pmu ? pmu->is_uncore : false;
365 evsel->auto_merge_stats = auto_merge_stats;
367 if (name)
368 evsel->name = strdup(name);
370 if (config_terms)
371 list_splice(config_terms, &evsel->config_terms);
373 list_add_tail(&evsel->core.node, list);
374 return evsel;
377 static int add_event(struct list_head *list, int *idx,
378 struct perf_event_attr *attr, char *name,
379 struct list_head *config_terms)
381 return __add_event(list, idx, attr, name, NULL, config_terms, false, NULL) ? 0 : -ENOMEM;
384 static int add_event_tool(struct list_head *list, int *idx,
385 enum perf_tool_event tool_event)
387 struct evsel *evsel;
388 struct perf_event_attr attr = {
389 .type = PERF_TYPE_SOFTWARE,
390 .config = PERF_COUNT_SW_DUMMY,
393 evsel = __add_event(list, idx, &attr, NULL, NULL, NULL, false, "0");
394 if (!evsel)
395 return -ENOMEM;
396 evsel->tool_event = tool_event;
397 if (tool_event == PERF_TOOL_DURATION_TIME)
398 evsel->unit = strdup("ns");
399 return 0;
402 static int parse_aliases(char *str, const char *names[][PERF_EVSEL__MAX_ALIASES], int size)
404 int i, j;
405 int n, longest = -1;
407 for (i = 0; i < size; i++) {
408 for (j = 0; j < PERF_EVSEL__MAX_ALIASES && names[i][j]; j++) {
409 n = strlen(names[i][j]);
410 if (n > longest && !strncasecmp(str, names[i][j], n))
411 longest = n;
413 if (longest > 0)
414 return i;
417 return -1;
420 typedef int config_term_func_t(struct perf_event_attr *attr,
421 struct parse_events_term *term,
422 struct parse_events_error *err);
423 static int config_term_common(struct perf_event_attr *attr,
424 struct parse_events_term *term,
425 struct parse_events_error *err);
426 static int config_attr(struct perf_event_attr *attr,
427 struct list_head *head,
428 struct parse_events_error *err,
429 config_term_func_t config_term);
431 int parse_events_add_cache(struct list_head *list, int *idx,
432 char *type, char *op_result1, char *op_result2,
433 struct parse_events_error *err,
434 struct list_head *head_config)
436 struct perf_event_attr attr;
437 LIST_HEAD(config_terms);
438 char name[MAX_NAME_LEN], *config_name;
439 int cache_type = -1, cache_op = -1, cache_result = -1;
440 char *op_result[2] = { op_result1, op_result2 };
441 int i, n;
444 * No fallback - if we cannot get a clear cache type
445 * then bail out:
447 cache_type = parse_aliases(type, perf_evsel__hw_cache,
448 PERF_COUNT_HW_CACHE_MAX);
449 if (cache_type == -1)
450 return -EINVAL;
452 config_name = get_config_name(head_config);
453 n = snprintf(name, MAX_NAME_LEN, "%s", type);
455 for (i = 0; (i < 2) && (op_result[i]); i++) {
456 char *str = op_result[i];
458 n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
460 if (cache_op == -1) {
461 cache_op = parse_aliases(str, perf_evsel__hw_cache_op,
462 PERF_COUNT_HW_CACHE_OP_MAX);
463 if (cache_op >= 0) {
464 if (!perf_evsel__is_cache_op_valid(cache_type, cache_op))
465 return -EINVAL;
466 continue;
470 if (cache_result == -1) {
471 cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
472 PERF_COUNT_HW_CACHE_RESULT_MAX);
473 if (cache_result >= 0)
474 continue;
479 * Fall back to reads:
481 if (cache_op == -1)
482 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
485 * Fall back to accesses:
487 if (cache_result == -1)
488 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
490 memset(&attr, 0, sizeof(attr));
491 attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
492 attr.type = PERF_TYPE_HW_CACHE;
494 if (head_config) {
495 if (config_attr(&attr, head_config, err,
496 config_term_common))
497 return -EINVAL;
499 if (get_config_terms(head_config, &config_terms))
500 return -ENOMEM;
502 return add_event(list, idx, &attr, config_name ? : name, &config_terms);
505 static void tracepoint_error(struct parse_events_error *e, int err,
506 const char *sys, const char *name)
508 const char *str;
509 char help[BUFSIZ];
511 if (!e)
512 return;
515 * We get error directly from syscall errno ( > 0),
516 * or from encoded pointer's error ( < 0).
518 err = abs(err);
520 switch (err) {
521 case EACCES:
522 str = "can't access trace events";
523 break;
524 case ENOENT:
525 str = "unknown tracepoint";
526 break;
527 default:
528 str = "failed to add tracepoint";
529 break;
532 tracing_path__strerror_open_tp(err, help, sizeof(help), sys, name);
533 parse_events__handle_error(e, 0, strdup(str), strdup(help));
536 static int add_tracepoint(struct list_head *list, int *idx,
537 const char *sys_name, const char *evt_name,
538 struct parse_events_error *err,
539 struct list_head *head_config)
541 struct evsel *evsel;
543 evsel = perf_evsel__newtp_idx(sys_name, evt_name, (*idx)++);
544 if (IS_ERR(evsel)) {
545 tracepoint_error(err, PTR_ERR(evsel), sys_name, evt_name);
546 return PTR_ERR(evsel);
549 if (head_config) {
550 LIST_HEAD(config_terms);
552 if (get_config_terms(head_config, &config_terms))
553 return -ENOMEM;
554 list_splice(&config_terms, &evsel->config_terms);
557 list_add_tail(&evsel->core.node, list);
558 return 0;
561 static int add_tracepoint_multi_event(struct list_head *list, int *idx,
562 const char *sys_name, const char *evt_name,
563 struct parse_events_error *err,
564 struct list_head *head_config)
566 char *evt_path;
567 struct dirent *evt_ent;
568 DIR *evt_dir;
569 int ret = 0, found = 0;
571 evt_path = get_events_file(sys_name);
572 if (!evt_path) {
573 tracepoint_error(err, errno, sys_name, evt_name);
574 return -1;
576 evt_dir = opendir(evt_path);
577 if (!evt_dir) {
578 put_events_file(evt_path);
579 tracepoint_error(err, errno, sys_name, evt_name);
580 return -1;
583 while (!ret && (evt_ent = readdir(evt_dir))) {
584 if (!strcmp(evt_ent->d_name, ".")
585 || !strcmp(evt_ent->d_name, "..")
586 || !strcmp(evt_ent->d_name, "enable")
587 || !strcmp(evt_ent->d_name, "filter"))
588 continue;
590 if (!strglobmatch(evt_ent->d_name, evt_name))
591 continue;
593 found++;
595 ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name,
596 err, head_config);
599 if (!found) {
600 tracepoint_error(err, ENOENT, sys_name, evt_name);
601 ret = -1;
604 put_events_file(evt_path);
605 closedir(evt_dir);
606 return ret;
609 static int add_tracepoint_event(struct list_head *list, int *idx,
610 const char *sys_name, const char *evt_name,
611 struct parse_events_error *err,
612 struct list_head *head_config)
614 return strpbrk(evt_name, "*?") ?
615 add_tracepoint_multi_event(list, idx, sys_name, evt_name,
616 err, head_config) :
617 add_tracepoint(list, idx, sys_name, evt_name,
618 err, head_config);
621 static int add_tracepoint_multi_sys(struct list_head *list, int *idx,
622 const char *sys_name, const char *evt_name,
623 struct parse_events_error *err,
624 struct list_head *head_config)
626 struct dirent *events_ent;
627 DIR *events_dir;
628 int ret = 0;
630 events_dir = tracing_events__opendir();
631 if (!events_dir) {
632 tracepoint_error(err, errno, sys_name, evt_name);
633 return -1;
636 while (!ret && (events_ent = readdir(events_dir))) {
637 if (!strcmp(events_ent->d_name, ".")
638 || !strcmp(events_ent->d_name, "..")
639 || !strcmp(events_ent->d_name, "enable")
640 || !strcmp(events_ent->d_name, "header_event")
641 || !strcmp(events_ent->d_name, "header_page"))
642 continue;
644 if (!strglobmatch(events_ent->d_name, sys_name))
645 continue;
647 ret = add_tracepoint_event(list, idx, events_ent->d_name,
648 evt_name, err, head_config);
651 closedir(events_dir);
652 return ret;
655 struct __add_bpf_event_param {
656 struct parse_events_state *parse_state;
657 struct list_head *list;
658 struct list_head *head_config;
661 static int add_bpf_event(const char *group, const char *event, int fd, struct bpf_object *obj,
662 void *_param)
664 LIST_HEAD(new_evsels);
665 struct __add_bpf_event_param *param = _param;
666 struct parse_events_state *parse_state = param->parse_state;
667 struct list_head *list = param->list;
668 struct evsel *pos;
669 int err;
671 * Check if we should add the event, i.e. if it is a TP but starts with a '!',
672 * then don't add the tracepoint, this will be used for something else, like
673 * adding to a BPF_MAP_TYPE_PROG_ARRAY.
675 * See tools/perf/examples/bpf/augmented_raw_syscalls.c
677 if (group[0] == '!')
678 return 0;
680 pr_debug("add bpf event %s:%s and attach bpf program %d\n",
681 group, event, fd);
683 err = parse_events_add_tracepoint(&new_evsels, &parse_state->idx, group,
684 event, parse_state->error,
685 param->head_config);
686 if (err) {
687 struct evsel *evsel, *tmp;
689 pr_debug("Failed to add BPF event %s:%s\n",
690 group, event);
691 list_for_each_entry_safe(evsel, tmp, &new_evsels, core.node) {
692 list_del_init(&evsel->core.node);
693 evsel__delete(evsel);
695 return err;
697 pr_debug("adding %s:%s\n", group, event);
699 list_for_each_entry(pos, &new_evsels, core.node) {
700 pr_debug("adding %s:%s to %p\n",
701 group, event, pos);
702 pos->bpf_fd = fd;
703 pos->bpf_obj = obj;
705 list_splice(&new_evsels, list);
706 return 0;
709 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
710 struct list_head *list,
711 struct bpf_object *obj,
712 struct list_head *head_config)
714 int err;
715 char errbuf[BUFSIZ];
716 struct __add_bpf_event_param param = {parse_state, list, head_config};
717 static bool registered_unprobe_atexit = false;
719 if (IS_ERR(obj) || !obj) {
720 snprintf(errbuf, sizeof(errbuf),
721 "Internal error: load bpf obj with NULL");
722 err = -EINVAL;
723 goto errout;
727 * Register atexit handler before calling bpf__probe() so
728 * bpf__probe() don't need to unprobe probe points its already
729 * created when failure.
731 if (!registered_unprobe_atexit) {
732 atexit(bpf__clear);
733 registered_unprobe_atexit = true;
736 err = bpf__probe(obj);
737 if (err) {
738 bpf__strerror_probe(obj, err, errbuf, sizeof(errbuf));
739 goto errout;
742 err = bpf__load(obj);
743 if (err) {
744 bpf__strerror_load(obj, err, errbuf, sizeof(errbuf));
745 goto errout;
748 err = bpf__foreach_event(obj, add_bpf_event, &param);
749 if (err) {
750 snprintf(errbuf, sizeof(errbuf),
751 "Attach events in BPF object failed");
752 goto errout;
755 return 0;
756 errout:
757 parse_state->error->help = strdup("(add -v to see detail)");
758 parse_state->error->str = strdup(errbuf);
759 return err;
762 static int
763 parse_events_config_bpf(struct parse_events_state *parse_state,
764 struct bpf_object *obj,
765 struct list_head *head_config)
767 struct parse_events_term *term;
768 int error_pos;
770 if (!head_config || list_empty(head_config))
771 return 0;
773 list_for_each_entry(term, head_config, list) {
774 char errbuf[BUFSIZ];
775 int err;
777 if (term->type_term != PARSE_EVENTS__TERM_TYPE_USER) {
778 snprintf(errbuf, sizeof(errbuf),
779 "Invalid config term for BPF object");
780 errbuf[BUFSIZ - 1] = '\0';
782 parse_state->error->idx = term->err_term;
783 parse_state->error->str = strdup(errbuf);
784 return -EINVAL;
787 err = bpf__config_obj(obj, term, parse_state->evlist, &error_pos);
788 if (err) {
789 bpf__strerror_config_obj(obj, term, parse_state->evlist,
790 &error_pos, err, errbuf,
791 sizeof(errbuf));
792 parse_state->error->help = strdup(
793 "Hint:\tValid config terms:\n"
794 " \tmap:[<arraymap>].value<indices>=[value]\n"
795 " \tmap:[<eventmap>].event<indices>=[event]\n"
796 "\n"
797 " \twhere <indices> is something like [0,3...5] or [all]\n"
798 " \t(add -v to see detail)");
799 parse_state->error->str = strdup(errbuf);
800 if (err == -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE)
801 parse_state->error->idx = term->err_val;
802 else
803 parse_state->error->idx = term->err_term + error_pos;
804 return err;
807 return 0;
811 * Split config terms:
812 * perf record -e bpf.c/call-graph=fp,map:array.value[0]=1/ ...
813 * 'call-graph=fp' is 'evt config', should be applied to each
814 * events in bpf.c.
815 * 'map:array.value[0]=1' is 'obj config', should be processed
816 * with parse_events_config_bpf.
818 * Move object config terms from the first list to obj_head_config.
820 static void
821 split_bpf_config_terms(struct list_head *evt_head_config,
822 struct list_head *obj_head_config)
824 struct parse_events_term *term, *temp;
827 * Currectly, all possible user config term
828 * belong to bpf object. parse_events__is_hardcoded_term()
829 * happends to be a good flag.
831 * See parse_events_config_bpf() and
832 * config_term_tracepoint().
834 list_for_each_entry_safe(term, temp, evt_head_config, list)
835 if (!parse_events__is_hardcoded_term(term))
836 list_move_tail(&term->list, obj_head_config);
839 int parse_events_load_bpf(struct parse_events_state *parse_state,
840 struct list_head *list,
841 char *bpf_file_name,
842 bool source,
843 struct list_head *head_config)
845 int err;
846 struct bpf_object *obj;
847 LIST_HEAD(obj_head_config);
849 if (head_config)
850 split_bpf_config_terms(head_config, &obj_head_config);
852 obj = bpf__prepare_load(bpf_file_name, source);
853 if (IS_ERR(obj)) {
854 char errbuf[BUFSIZ];
856 err = PTR_ERR(obj);
858 if (err == -ENOTSUP)
859 snprintf(errbuf, sizeof(errbuf),
860 "BPF support is not compiled");
861 else
862 bpf__strerror_prepare_load(bpf_file_name,
863 source,
864 -err, errbuf,
865 sizeof(errbuf));
867 parse_state->error->help = strdup("(add -v to see detail)");
868 parse_state->error->str = strdup(errbuf);
869 return err;
872 err = parse_events_load_bpf_obj(parse_state, list, obj, head_config);
873 if (err)
874 return err;
875 err = parse_events_config_bpf(parse_state, obj, &obj_head_config);
878 * Caller doesn't know anything about obj_head_config,
879 * so combine them together again before returnning.
881 if (head_config)
882 list_splice_tail(&obj_head_config, head_config);
883 return err;
886 static int
887 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
889 int i;
891 for (i = 0; i < 3; i++) {
892 if (!type || !type[i])
893 break;
895 #define CHECK_SET_TYPE(bit) \
896 do { \
897 if (attr->bp_type & bit) \
898 return -EINVAL; \
899 else \
900 attr->bp_type |= bit; \
901 } while (0)
903 switch (type[i]) {
904 case 'r':
905 CHECK_SET_TYPE(HW_BREAKPOINT_R);
906 break;
907 case 'w':
908 CHECK_SET_TYPE(HW_BREAKPOINT_W);
909 break;
910 case 'x':
911 CHECK_SET_TYPE(HW_BREAKPOINT_X);
912 break;
913 default:
914 return -EINVAL;
918 #undef CHECK_SET_TYPE
920 if (!attr->bp_type) /* Default */
921 attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
923 return 0;
926 int parse_events_add_breakpoint(struct list_head *list, int *idx,
927 void *ptr, char *type, u64 len)
929 struct perf_event_attr attr;
931 memset(&attr, 0, sizeof(attr));
932 attr.bp_addr = (unsigned long) ptr;
934 if (parse_breakpoint_type(type, &attr))
935 return -EINVAL;
937 /* Provide some defaults if len is not specified */
938 if (!len) {
939 if (attr.bp_type == HW_BREAKPOINT_X)
940 len = sizeof(long);
941 else
942 len = HW_BREAKPOINT_LEN_4;
945 attr.bp_len = len;
947 attr.type = PERF_TYPE_BREAKPOINT;
948 attr.sample_period = 1;
950 return add_event(list, idx, &attr, NULL, NULL);
953 static int check_type_val(struct parse_events_term *term,
954 struct parse_events_error *err,
955 int type)
957 if (type == term->type_val)
958 return 0;
960 if (err) {
961 parse_events__handle_error(err, term->err_val,
962 type == PARSE_EVENTS__TERM_TYPE_NUM
963 ? strdup("expected numeric value")
964 : strdup("expected string value"),
965 NULL);
967 return -EINVAL;
971 * Update according to parse-events.l
973 static const char *config_term_names[__PARSE_EVENTS__TERM_TYPE_NR] = {
974 [PARSE_EVENTS__TERM_TYPE_USER] = "<sysfs term>",
975 [PARSE_EVENTS__TERM_TYPE_CONFIG] = "config",
976 [PARSE_EVENTS__TERM_TYPE_CONFIG1] = "config1",
977 [PARSE_EVENTS__TERM_TYPE_CONFIG2] = "config2",
978 [PARSE_EVENTS__TERM_TYPE_NAME] = "name",
979 [PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD] = "period",
980 [PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ] = "freq",
981 [PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE] = "branch_type",
982 [PARSE_EVENTS__TERM_TYPE_TIME] = "time",
983 [PARSE_EVENTS__TERM_TYPE_CALLGRAPH] = "call-graph",
984 [PARSE_EVENTS__TERM_TYPE_STACKSIZE] = "stack-size",
985 [PARSE_EVENTS__TERM_TYPE_NOINHERIT] = "no-inherit",
986 [PARSE_EVENTS__TERM_TYPE_INHERIT] = "inherit",
987 [PARSE_EVENTS__TERM_TYPE_MAX_STACK] = "max-stack",
988 [PARSE_EVENTS__TERM_TYPE_MAX_EVENTS] = "nr",
989 [PARSE_EVENTS__TERM_TYPE_OVERWRITE] = "overwrite",
990 [PARSE_EVENTS__TERM_TYPE_NOOVERWRITE] = "no-overwrite",
991 [PARSE_EVENTS__TERM_TYPE_DRV_CFG] = "driver-config",
992 [PARSE_EVENTS__TERM_TYPE_PERCORE] = "percore",
993 [PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT] = "aux-output",
994 [PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE] = "aux-sample-size",
997 static bool config_term_shrinked;
999 static bool
1000 config_term_avail(int term_type, struct parse_events_error *err)
1002 char *err_str;
1004 if (term_type < 0 || term_type >= __PARSE_EVENTS__TERM_TYPE_NR) {
1005 parse_events__handle_error(err, -1,
1006 strdup("Invalid term_type"), NULL);
1007 return false;
1009 if (!config_term_shrinked)
1010 return true;
1012 switch (term_type) {
1013 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1014 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
1015 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
1016 case PARSE_EVENTS__TERM_TYPE_NAME:
1017 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1018 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1019 return true;
1020 default:
1021 if (!err)
1022 return false;
1024 /* term_type is validated so indexing is safe */
1025 if (asprintf(&err_str, "'%s' is not usable in 'perf stat'",
1026 config_term_names[term_type]) >= 0)
1027 parse_events__handle_error(err, -1, err_str, NULL);
1028 return false;
1032 void parse_events__shrink_config_terms(void)
1034 config_term_shrinked = true;
1037 static int config_term_common(struct perf_event_attr *attr,
1038 struct parse_events_term *term,
1039 struct parse_events_error *err)
1041 #define CHECK_TYPE_VAL(type) \
1042 do { \
1043 if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
1044 return -EINVAL; \
1045 } while (0)
1047 switch (term->type_term) {
1048 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1049 CHECK_TYPE_VAL(NUM);
1050 attr->config = term->val.num;
1051 break;
1052 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
1053 CHECK_TYPE_VAL(NUM);
1054 attr->config1 = term->val.num;
1055 break;
1056 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
1057 CHECK_TYPE_VAL(NUM);
1058 attr->config2 = term->val.num;
1059 break;
1060 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1061 CHECK_TYPE_VAL(NUM);
1062 break;
1063 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1064 CHECK_TYPE_VAL(NUM);
1065 break;
1066 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1067 CHECK_TYPE_VAL(STR);
1068 if (strcmp(term->val.str, "no") &&
1069 parse_branch_str(term->val.str,
1070 &attr->branch_sample_type)) {
1071 parse_events__handle_error(err, term->err_val,
1072 strdup("invalid branch sample type"),
1073 NULL);
1074 return -EINVAL;
1076 break;
1077 case PARSE_EVENTS__TERM_TYPE_TIME:
1078 CHECK_TYPE_VAL(NUM);
1079 if (term->val.num > 1) {
1080 parse_events__handle_error(err, term->err_val,
1081 strdup("expected 0 or 1"),
1082 NULL);
1083 return -EINVAL;
1085 break;
1086 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1087 CHECK_TYPE_VAL(STR);
1088 break;
1089 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1090 CHECK_TYPE_VAL(NUM);
1091 break;
1092 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1093 CHECK_TYPE_VAL(NUM);
1094 break;
1095 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1096 CHECK_TYPE_VAL(NUM);
1097 break;
1098 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1099 CHECK_TYPE_VAL(NUM);
1100 break;
1101 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1102 CHECK_TYPE_VAL(NUM);
1103 break;
1104 case PARSE_EVENTS__TERM_TYPE_NAME:
1105 CHECK_TYPE_VAL(STR);
1106 break;
1107 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1108 CHECK_TYPE_VAL(NUM);
1109 break;
1110 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1111 CHECK_TYPE_VAL(NUM);
1112 break;
1113 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1114 CHECK_TYPE_VAL(NUM);
1115 if ((unsigned int)term->val.num > 1) {
1116 parse_events__handle_error(err, term->err_val,
1117 strdup("expected 0 or 1"),
1118 NULL);
1119 return -EINVAL;
1121 break;
1122 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1123 CHECK_TYPE_VAL(NUM);
1124 break;
1125 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1126 CHECK_TYPE_VAL(NUM);
1127 if (term->val.num > UINT_MAX) {
1128 parse_events__handle_error(err, term->err_val,
1129 strdup("too big"),
1130 NULL);
1131 return -EINVAL;
1133 break;
1134 default:
1135 parse_events__handle_error(err, term->err_term,
1136 strdup("unknown term"),
1137 parse_events_formats_error_string(NULL));
1138 return -EINVAL;
1142 * Check term availbility after basic checking so
1143 * PARSE_EVENTS__TERM_TYPE_USER can be found and filtered.
1145 * If check availbility at the entry of this function,
1146 * user will see "'<sysfs term>' is not usable in 'perf stat'"
1147 * if an invalid config term is provided for legacy events
1148 * (for example, instructions/badterm/...), which is confusing.
1150 if (!config_term_avail(term->type_term, err))
1151 return -EINVAL;
1152 return 0;
1153 #undef CHECK_TYPE_VAL
1156 static int config_term_pmu(struct perf_event_attr *attr,
1157 struct parse_events_term *term,
1158 struct parse_events_error *err)
1160 if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER ||
1161 term->type_term == PARSE_EVENTS__TERM_TYPE_DRV_CFG)
1163 * Always succeed for sysfs terms, as we dont know
1164 * at this point what type they need to have.
1166 return 0;
1167 else
1168 return config_term_common(attr, term, err);
1171 static int config_term_tracepoint(struct perf_event_attr *attr,
1172 struct parse_events_term *term,
1173 struct parse_events_error *err)
1175 switch (term->type_term) {
1176 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1177 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1178 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1179 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1180 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1181 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1182 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1183 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1184 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1185 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1186 return config_term_common(attr, term, err);
1187 default:
1188 if (err) {
1189 parse_events__handle_error(err, term->err_term,
1190 strdup("unknown term"),
1191 strdup("valid terms: call-graph,stack-size\n"));
1193 return -EINVAL;
1196 return 0;
1199 static int config_attr(struct perf_event_attr *attr,
1200 struct list_head *head,
1201 struct parse_events_error *err,
1202 config_term_func_t config_term)
1204 struct parse_events_term *term;
1206 list_for_each_entry(term, head, list)
1207 if (config_term(attr, term, err))
1208 return -EINVAL;
1210 return 0;
1213 static int get_config_terms(struct list_head *head_config,
1214 struct list_head *head_terms __maybe_unused)
1216 #define ADD_CONFIG_TERM(__type, __weak) \
1217 struct perf_evsel_config_term *__t; \
1219 __t = zalloc(sizeof(*__t)); \
1220 if (!__t) \
1221 return -ENOMEM; \
1223 INIT_LIST_HEAD(&__t->list); \
1224 __t->type = PERF_EVSEL__CONFIG_TERM_ ## __type; \
1225 __t->weak = __weak; \
1226 list_add_tail(&__t->list, head_terms)
1228 #define ADD_CONFIG_TERM_VAL(__type, __name, __val, __weak) \
1229 do { \
1230 ADD_CONFIG_TERM(__type, __weak); \
1231 __t->val.__name = __val; \
1232 } while (0)
1234 #define ADD_CONFIG_TERM_STR(__type, __val, __weak) \
1235 do { \
1236 ADD_CONFIG_TERM(__type, __weak); \
1237 __t->val.str = strdup(__val); \
1238 if (!__t->val.str) { \
1239 zfree(&__t); \
1240 return -ENOMEM; \
1242 __t->free_str = true; \
1243 } while (0)
1245 struct parse_events_term *term;
1247 list_for_each_entry(term, head_config, list) {
1248 switch (term->type_term) {
1249 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1250 ADD_CONFIG_TERM_VAL(PERIOD, period, term->val.num, term->weak);
1251 break;
1252 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1253 ADD_CONFIG_TERM_VAL(FREQ, freq, term->val.num, term->weak);
1254 break;
1255 case PARSE_EVENTS__TERM_TYPE_TIME:
1256 ADD_CONFIG_TERM_VAL(TIME, time, term->val.num, term->weak);
1257 break;
1258 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1259 ADD_CONFIG_TERM_STR(CALLGRAPH, term->val.str, term->weak);
1260 break;
1261 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1262 ADD_CONFIG_TERM_STR(BRANCH, term->val.str, term->weak);
1263 break;
1264 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1265 ADD_CONFIG_TERM_VAL(STACK_USER, stack_user,
1266 term->val.num, term->weak);
1267 break;
1268 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1269 ADD_CONFIG_TERM_VAL(INHERIT, inherit,
1270 term->val.num ? 1 : 0, term->weak);
1271 break;
1272 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1273 ADD_CONFIG_TERM_VAL(INHERIT, inherit,
1274 term->val.num ? 0 : 1, term->weak);
1275 break;
1276 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1277 ADD_CONFIG_TERM_VAL(MAX_STACK, max_stack,
1278 term->val.num, term->weak);
1279 break;
1280 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1281 ADD_CONFIG_TERM_VAL(MAX_EVENTS, max_events,
1282 term->val.num, term->weak);
1283 break;
1284 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1285 ADD_CONFIG_TERM_VAL(OVERWRITE, overwrite,
1286 term->val.num ? 1 : 0, term->weak);
1287 break;
1288 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1289 ADD_CONFIG_TERM_VAL(OVERWRITE, overwrite,
1290 term->val.num ? 0 : 1, term->weak);
1291 break;
1292 case PARSE_EVENTS__TERM_TYPE_DRV_CFG:
1293 ADD_CONFIG_TERM_STR(DRV_CFG, term->val.str, term->weak);
1294 break;
1295 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1296 ADD_CONFIG_TERM_VAL(PERCORE, percore,
1297 term->val.num ? true : false, term->weak);
1298 break;
1299 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1300 ADD_CONFIG_TERM_VAL(AUX_OUTPUT, aux_output,
1301 term->val.num ? 1 : 0, term->weak);
1302 break;
1303 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1304 ADD_CONFIG_TERM_VAL(AUX_SAMPLE_SIZE, aux_sample_size,
1305 term->val.num, term->weak);
1306 break;
1307 default:
1308 break;
1311 return 0;
1315 * Add PERF_EVSEL__CONFIG_TERM_CFG_CHG where cfg_chg will have a bit set for
1316 * each bit of attr->config that the user has changed.
1318 static int get_config_chgs(struct perf_pmu *pmu, struct list_head *head_config,
1319 struct list_head *head_terms)
1321 struct parse_events_term *term;
1322 u64 bits = 0;
1323 int type;
1325 list_for_each_entry(term, head_config, list) {
1326 switch (term->type_term) {
1327 case PARSE_EVENTS__TERM_TYPE_USER:
1328 type = perf_pmu__format_type(&pmu->format, term->config);
1329 if (type != PERF_PMU_FORMAT_VALUE_CONFIG)
1330 continue;
1331 bits |= perf_pmu__format_bits(&pmu->format, term->config);
1332 break;
1333 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1334 bits = ~(u64)0;
1335 break;
1336 default:
1337 break;
1341 if (bits)
1342 ADD_CONFIG_TERM_VAL(CFG_CHG, cfg_chg, bits, false);
1344 #undef ADD_CONFIG_TERM
1345 return 0;
1348 int parse_events_add_tracepoint(struct list_head *list, int *idx,
1349 const char *sys, const char *event,
1350 struct parse_events_error *err,
1351 struct list_head *head_config)
1353 if (head_config) {
1354 struct perf_event_attr attr;
1356 if (config_attr(&attr, head_config, err,
1357 config_term_tracepoint))
1358 return -EINVAL;
1361 if (strpbrk(sys, "*?"))
1362 return add_tracepoint_multi_sys(list, idx, sys, event,
1363 err, head_config);
1364 else
1365 return add_tracepoint_event(list, idx, sys, event,
1366 err, head_config);
1369 int parse_events_add_numeric(struct parse_events_state *parse_state,
1370 struct list_head *list,
1371 u32 type, u64 config,
1372 struct list_head *head_config)
1374 struct perf_event_attr attr;
1375 LIST_HEAD(config_terms);
1377 memset(&attr, 0, sizeof(attr));
1378 attr.type = type;
1379 attr.config = config;
1381 if (head_config) {
1382 if (config_attr(&attr, head_config, parse_state->error,
1383 config_term_common))
1384 return -EINVAL;
1386 if (get_config_terms(head_config, &config_terms))
1387 return -ENOMEM;
1390 return add_event(list, &parse_state->idx, &attr,
1391 get_config_name(head_config), &config_terms);
1394 int parse_events_add_tool(struct parse_events_state *parse_state,
1395 struct list_head *list,
1396 enum perf_tool_event tool_event)
1398 return add_event_tool(list, &parse_state->idx, tool_event);
1401 static bool config_term_percore(struct list_head *config_terms)
1403 struct perf_evsel_config_term *term;
1405 list_for_each_entry(term, config_terms, list) {
1406 if (term->type == PERF_EVSEL__CONFIG_TERM_PERCORE)
1407 return term->val.percore;
1410 return false;
1413 int parse_events_add_pmu(struct parse_events_state *parse_state,
1414 struct list_head *list, char *name,
1415 struct list_head *head_config,
1416 bool auto_merge_stats,
1417 bool use_alias)
1419 struct perf_event_attr attr;
1420 struct perf_pmu_info info;
1421 struct perf_pmu *pmu;
1422 struct evsel *evsel;
1423 struct parse_events_error *err = parse_state->error;
1424 bool use_uncore_alias;
1425 LIST_HEAD(config_terms);
1427 pmu = perf_pmu__find(name);
1428 if (!pmu) {
1429 char *err_str;
1431 if (asprintf(&err_str,
1432 "Cannot find PMU `%s'. Missing kernel support?",
1433 name) >= 0)
1434 parse_events__handle_error(err, 0, err_str, NULL);
1435 return -EINVAL;
1438 if (pmu->default_config) {
1439 memcpy(&attr, pmu->default_config,
1440 sizeof(struct perf_event_attr));
1441 } else {
1442 memset(&attr, 0, sizeof(attr));
1445 use_uncore_alias = (pmu->is_uncore && use_alias);
1447 if (!head_config) {
1448 attr.type = pmu->type;
1449 evsel = __add_event(list, &parse_state->idx, &attr, NULL, pmu, NULL,
1450 auto_merge_stats, NULL);
1451 if (evsel) {
1452 evsel->pmu_name = name ? strdup(name) : NULL;
1453 evsel->use_uncore_alias = use_uncore_alias;
1454 return 0;
1455 } else {
1456 return -ENOMEM;
1460 if (perf_pmu__check_alias(pmu, head_config, &info))
1461 return -EINVAL;
1464 * Configure hardcoded terms first, no need to check
1465 * return value when called with fail == 0 ;)
1467 if (config_attr(&attr, head_config, parse_state->error, config_term_pmu))
1468 return -EINVAL;
1470 if (get_config_terms(head_config, &config_terms))
1471 return -ENOMEM;
1474 * When using default config, record which bits of attr->config were
1475 * changed by the user.
1477 if (pmu->default_config && get_config_chgs(pmu, head_config, &config_terms))
1478 return -ENOMEM;
1480 if (perf_pmu__config(pmu, &attr, head_config, parse_state->error)) {
1481 struct perf_evsel_config_term *pos, *tmp;
1483 list_for_each_entry_safe(pos, tmp, &config_terms, list) {
1484 list_del_init(&pos->list);
1485 free(pos);
1487 return -EINVAL;
1490 evsel = __add_event(list, &parse_state->idx, &attr,
1491 get_config_name(head_config), pmu,
1492 &config_terms, auto_merge_stats, NULL);
1493 if (evsel) {
1494 evsel->unit = info.unit;
1495 evsel->scale = info.scale;
1496 evsel->per_pkg = info.per_pkg;
1497 evsel->snapshot = info.snapshot;
1498 evsel->metric_expr = info.metric_expr;
1499 evsel->metric_name = info.metric_name;
1500 evsel->pmu_name = name ? strdup(name) : NULL;
1501 evsel->use_uncore_alias = use_uncore_alias;
1502 evsel->percore = config_term_percore(&evsel->config_terms);
1505 return evsel ? 0 : -ENOMEM;
1508 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
1509 char *str, struct list_head **listp)
1511 struct parse_events_term *term;
1512 struct list_head *list;
1513 struct perf_pmu *pmu = NULL;
1514 int ok = 0;
1516 *listp = NULL;
1517 /* Add it for all PMUs that support the alias */
1518 list = malloc(sizeof(struct list_head));
1519 if (!list)
1520 return -1;
1521 INIT_LIST_HEAD(list);
1522 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1523 struct perf_pmu_alias *alias;
1525 list_for_each_entry(alias, &pmu->aliases, list) {
1526 if (!strcasecmp(alias->name, str)) {
1527 struct list_head *head;
1528 char *config;
1530 head = malloc(sizeof(struct list_head));
1531 if (!head)
1532 return -1;
1533 INIT_LIST_HEAD(head);
1534 config = strdup(str);
1535 if (!config)
1536 return -1;
1537 if (parse_events_term__num(&term,
1538 PARSE_EVENTS__TERM_TYPE_USER,
1539 config, 1, false, &config,
1540 NULL) < 0) {
1541 free(list);
1542 free(config);
1543 return -1;
1545 list_add_tail(&term->list, head);
1547 if (!parse_events_add_pmu(parse_state, list,
1548 pmu->name, head,
1549 true, true)) {
1550 pr_debug("%s -> %s/%s/\n", str,
1551 pmu->name, alias->str);
1552 ok++;
1555 parse_events_terms__delete(head);
1559 if (!ok) {
1560 free(list);
1561 return -1;
1563 *listp = list;
1564 return 0;
1567 int parse_events__modifier_group(struct list_head *list,
1568 char *event_mod)
1570 return parse_events__modifier_event(list, event_mod, true);
1574 * Check if the two uncore PMUs are from the same uncore block
1575 * The format of the uncore PMU name is uncore_#blockname_#pmuidx
1577 static bool is_same_uncore_block(const char *pmu_name_a, const char *pmu_name_b)
1579 char *end_a, *end_b;
1581 end_a = strrchr(pmu_name_a, '_');
1582 end_b = strrchr(pmu_name_b, '_');
1584 if (!end_a || !end_b)
1585 return false;
1587 if ((end_a - pmu_name_a) != (end_b - pmu_name_b))
1588 return false;
1590 return (strncmp(pmu_name_a, pmu_name_b, end_a - pmu_name_a) == 0);
1593 static int
1594 parse_events__set_leader_for_uncore_aliase(char *name, struct list_head *list,
1595 struct parse_events_state *parse_state)
1597 struct evsel *evsel, *leader;
1598 uintptr_t *leaders;
1599 bool is_leader = true;
1600 int i, nr_pmu = 0, total_members, ret = 0;
1602 leader = list_first_entry(list, struct evsel, core.node);
1603 evsel = list_last_entry(list, struct evsel, core.node);
1604 total_members = evsel->idx - leader->idx + 1;
1606 leaders = calloc(total_members, sizeof(uintptr_t));
1607 if (WARN_ON(!leaders))
1608 return 0;
1611 * Going through the whole group and doing sanity check.
1612 * All members must use alias, and be from the same uncore block.
1613 * Also, storing the leader events in an array.
1615 __evlist__for_each_entry(list, evsel) {
1617 /* Only split the uncore group which members use alias */
1618 if (!evsel->use_uncore_alias)
1619 goto out;
1621 /* The events must be from the same uncore block */
1622 if (!is_same_uncore_block(leader->pmu_name, evsel->pmu_name))
1623 goto out;
1625 if (!is_leader)
1626 continue;
1628 * If the event's PMU name starts to repeat, it must be a new
1629 * event. That can be used to distinguish the leader from
1630 * other members, even they have the same event name.
1632 if ((leader != evsel) && (leader->pmu_name == evsel->pmu_name)) {
1633 is_leader = false;
1634 continue;
1636 /* The name is always alias name */
1637 WARN_ON(strcmp(leader->name, evsel->name));
1639 /* Store the leader event for each PMU */
1640 leaders[nr_pmu++] = (uintptr_t) evsel;
1643 /* only one event alias */
1644 if (nr_pmu == total_members) {
1645 parse_state->nr_groups--;
1646 goto handled;
1650 * An uncore event alias is a joint name which means the same event
1651 * runs on all PMUs of a block.
1652 * Perf doesn't support mixed events from different PMUs in the same
1653 * group. The big group has to be split into multiple small groups
1654 * which only include the events from the same PMU.
1656 * Here the uncore event aliases must be from the same uncore block.
1657 * The number of PMUs must be same for each alias. The number of new
1658 * small groups equals to the number of PMUs.
1659 * Setting the leader event for corresponding members in each group.
1661 i = 0;
1662 __evlist__for_each_entry(list, evsel) {
1663 if (i >= nr_pmu)
1664 i = 0;
1665 evsel->leader = (struct evsel *) leaders[i++];
1668 /* The number of members and group name are same for each group */
1669 for (i = 0; i < nr_pmu; i++) {
1670 evsel = (struct evsel *) leaders[i];
1671 evsel->core.nr_members = total_members / nr_pmu;
1672 evsel->group_name = name ? strdup(name) : NULL;
1675 /* Take the new small groups into account */
1676 parse_state->nr_groups += nr_pmu - 1;
1678 handled:
1679 ret = 1;
1680 out:
1681 free(leaders);
1682 return ret;
1685 void parse_events__set_leader(char *name, struct list_head *list,
1686 struct parse_events_state *parse_state)
1688 struct evsel *leader;
1690 if (list_empty(list)) {
1691 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1692 return;
1695 if (parse_events__set_leader_for_uncore_aliase(name, list, parse_state))
1696 return;
1698 __perf_evlist__set_leader(list);
1699 leader = list_entry(list->next, struct evsel, core.node);
1700 leader->group_name = name ? strdup(name) : NULL;
1703 /* list_event is assumed to point to malloc'ed memory */
1704 void parse_events_update_lists(struct list_head *list_event,
1705 struct list_head *list_all)
1708 * Called for single event definition. Update the
1709 * 'all event' list, and reinit the 'single event'
1710 * list, for next event definition.
1712 list_splice_tail(list_event, list_all);
1713 free(list_event);
1716 struct event_modifier {
1717 int eu;
1718 int ek;
1719 int eh;
1720 int eH;
1721 int eG;
1722 int eI;
1723 int precise;
1724 int precise_max;
1725 int exclude_GH;
1726 int sample_read;
1727 int pinned;
1728 int weak;
1731 static int get_event_modifier(struct event_modifier *mod, char *str,
1732 struct evsel *evsel)
1734 int eu = evsel ? evsel->core.attr.exclude_user : 0;
1735 int ek = evsel ? evsel->core.attr.exclude_kernel : 0;
1736 int eh = evsel ? evsel->core.attr.exclude_hv : 0;
1737 int eH = evsel ? evsel->core.attr.exclude_host : 0;
1738 int eG = evsel ? evsel->core.attr.exclude_guest : 0;
1739 int eI = evsel ? evsel->core.attr.exclude_idle : 0;
1740 int precise = evsel ? evsel->core.attr.precise_ip : 0;
1741 int precise_max = 0;
1742 int sample_read = 0;
1743 int pinned = evsel ? evsel->core.attr.pinned : 0;
1745 int exclude = eu | ek | eh;
1746 int exclude_GH = evsel ? evsel->exclude_GH : 0;
1747 int weak = 0;
1749 memset(mod, 0, sizeof(*mod));
1751 while (*str) {
1752 if (*str == 'u') {
1753 if (!exclude)
1754 exclude = eu = ek = eh = 1;
1755 eu = 0;
1756 } else if (*str == 'k') {
1757 if (!exclude)
1758 exclude = eu = ek = eh = 1;
1759 ek = 0;
1760 } else if (*str == 'h') {
1761 if (!exclude)
1762 exclude = eu = ek = eh = 1;
1763 eh = 0;
1764 } else if (*str == 'G') {
1765 if (!exclude_GH)
1766 exclude_GH = eG = eH = 1;
1767 eG = 0;
1768 } else if (*str == 'H') {
1769 if (!exclude_GH)
1770 exclude_GH = eG = eH = 1;
1771 eH = 0;
1772 } else if (*str == 'I') {
1773 eI = 1;
1774 } else if (*str == 'p') {
1775 precise++;
1776 /* use of precise requires exclude_guest */
1777 if (!exclude_GH)
1778 eG = 1;
1779 } else if (*str == 'P') {
1780 precise_max = 1;
1781 } else if (*str == 'S') {
1782 sample_read = 1;
1783 } else if (*str == 'D') {
1784 pinned = 1;
1785 } else if (*str == 'W') {
1786 weak = 1;
1787 } else
1788 break;
1790 ++str;
1794 * precise ip:
1796 * 0 - SAMPLE_IP can have arbitrary skid
1797 * 1 - SAMPLE_IP must have constant skid
1798 * 2 - SAMPLE_IP requested to have 0 skid
1799 * 3 - SAMPLE_IP must have 0 skid
1801 * See also PERF_RECORD_MISC_EXACT_IP
1803 if (precise > 3)
1804 return -EINVAL;
1806 mod->eu = eu;
1807 mod->ek = ek;
1808 mod->eh = eh;
1809 mod->eH = eH;
1810 mod->eG = eG;
1811 mod->eI = eI;
1812 mod->precise = precise;
1813 mod->precise_max = precise_max;
1814 mod->exclude_GH = exclude_GH;
1815 mod->sample_read = sample_read;
1816 mod->pinned = pinned;
1817 mod->weak = weak;
1819 return 0;
1823 * Basic modifier sanity check to validate it contains only one
1824 * instance of any modifier (apart from 'p') present.
1826 static int check_modifier(char *str)
1828 char *p = str;
1830 /* The sizeof includes 0 byte as well. */
1831 if (strlen(str) > (sizeof("ukhGHpppPSDIW") - 1))
1832 return -1;
1834 while (*p) {
1835 if (*p != 'p' && strchr(p + 1, *p))
1836 return -1;
1837 p++;
1840 return 0;
1843 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
1845 struct evsel *evsel;
1846 struct event_modifier mod;
1848 if (str == NULL)
1849 return 0;
1851 if (check_modifier(str))
1852 return -EINVAL;
1854 if (!add && get_event_modifier(&mod, str, NULL))
1855 return -EINVAL;
1857 __evlist__for_each_entry(list, evsel) {
1858 if (add && get_event_modifier(&mod, str, evsel))
1859 return -EINVAL;
1861 evsel->core.attr.exclude_user = mod.eu;
1862 evsel->core.attr.exclude_kernel = mod.ek;
1863 evsel->core.attr.exclude_hv = mod.eh;
1864 evsel->core.attr.precise_ip = mod.precise;
1865 evsel->core.attr.exclude_host = mod.eH;
1866 evsel->core.attr.exclude_guest = mod.eG;
1867 evsel->core.attr.exclude_idle = mod.eI;
1868 evsel->exclude_GH = mod.exclude_GH;
1869 evsel->sample_read = mod.sample_read;
1870 evsel->precise_max = mod.precise_max;
1871 evsel->weak_group = mod.weak;
1873 if (perf_evsel__is_group_leader(evsel))
1874 evsel->core.attr.pinned = mod.pinned;
1877 return 0;
1880 int parse_events_name(struct list_head *list, char *name)
1882 struct evsel *evsel;
1884 __evlist__for_each_entry(list, evsel) {
1885 if (!evsel->name)
1886 evsel->name = strdup(name);
1889 return 0;
1892 static int
1893 comp_pmu(const void *p1, const void *p2)
1895 struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
1896 struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
1898 return strcasecmp(pmu1->symbol, pmu2->symbol);
1901 static void perf_pmu__parse_cleanup(void)
1903 if (perf_pmu_events_list_num > 0) {
1904 struct perf_pmu_event_symbol *p;
1905 int i;
1907 for (i = 0; i < perf_pmu_events_list_num; i++) {
1908 p = perf_pmu_events_list + i;
1909 zfree(&p->symbol);
1911 zfree(&perf_pmu_events_list);
1912 perf_pmu_events_list_num = 0;
1916 #define SET_SYMBOL(str, stype) \
1917 do { \
1918 p->symbol = str; \
1919 if (!p->symbol) \
1920 goto err; \
1921 p->type = stype; \
1922 } while (0)
1925 * Read the pmu events list from sysfs
1926 * Save it into perf_pmu_events_list
1928 static void perf_pmu__parse_init(void)
1931 struct perf_pmu *pmu = NULL;
1932 struct perf_pmu_alias *alias;
1933 int len = 0;
1935 pmu = NULL;
1936 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1937 list_for_each_entry(alias, &pmu->aliases, list) {
1938 if (strchr(alias->name, '-'))
1939 len++;
1940 len++;
1944 if (len == 0) {
1945 perf_pmu_events_list_num = -1;
1946 return;
1948 perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
1949 if (!perf_pmu_events_list)
1950 return;
1951 perf_pmu_events_list_num = len;
1953 len = 0;
1954 pmu = NULL;
1955 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1956 list_for_each_entry(alias, &pmu->aliases, list) {
1957 struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
1958 char *tmp = strchr(alias->name, '-');
1960 if (tmp != NULL) {
1961 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
1962 PMU_EVENT_SYMBOL_PREFIX);
1963 p++;
1964 SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
1965 len += 2;
1966 } else {
1967 SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
1968 len++;
1972 qsort(perf_pmu_events_list, len,
1973 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1975 return;
1976 err:
1977 perf_pmu__parse_cleanup();
1980 enum perf_pmu_event_symbol_type
1981 perf_pmu__parse_check(const char *name)
1983 struct perf_pmu_event_symbol p, *r;
1985 /* scan kernel pmu events from sysfs if needed */
1986 if (perf_pmu_events_list_num == 0)
1987 perf_pmu__parse_init();
1989 * name "cpu" could be prefix of cpu-cycles or cpu// events.
1990 * cpu-cycles has been handled by hardcode.
1991 * So it must be cpu// events, not kernel pmu event.
1993 if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
1994 return PMU_EVENT_SYMBOL_ERR;
1996 p.symbol = strdup(name);
1997 r = bsearch(&p, perf_pmu_events_list,
1998 (size_t) perf_pmu_events_list_num,
1999 sizeof(struct perf_pmu_event_symbol), comp_pmu);
2000 zfree(&p.symbol);
2001 return r ? r->type : PMU_EVENT_SYMBOL_ERR;
2004 static int parse_events__scanner(const char *str, void *parse_state, int start_token)
2006 YY_BUFFER_STATE buffer;
2007 void *scanner;
2008 int ret;
2010 ret = parse_events_lex_init_extra(start_token, &scanner);
2011 if (ret)
2012 return ret;
2014 buffer = parse_events__scan_string(str, scanner);
2016 #ifdef PARSER_DEBUG
2017 parse_events_debug = 1;
2018 #endif
2019 ret = parse_events_parse(parse_state, scanner);
2021 parse_events__flush_buffer(buffer, scanner);
2022 parse_events__delete_buffer(buffer, scanner);
2023 parse_events_lex_destroy(scanner);
2024 return ret;
2028 * parse event config string, return a list of event terms.
2030 int parse_events_terms(struct list_head *terms, const char *str)
2032 struct parse_events_state parse_state = {
2033 .terms = NULL,
2035 int ret;
2037 ret = parse_events__scanner(str, &parse_state, PE_START_TERMS);
2038 if (!ret) {
2039 list_splice(parse_state.terms, terms);
2040 zfree(&parse_state.terms);
2041 return 0;
2044 parse_events_terms__delete(parse_state.terms);
2045 return ret;
2048 int parse_events(struct evlist *evlist, const char *str,
2049 struct parse_events_error *err)
2051 struct parse_events_state parse_state = {
2052 .list = LIST_HEAD_INIT(parse_state.list),
2053 .idx = evlist->core.nr_entries,
2054 .error = err,
2055 .evlist = evlist,
2057 int ret;
2059 ret = parse_events__scanner(str, &parse_state, PE_START_EVENTS);
2060 perf_pmu__parse_cleanup();
2062 if (!ret && list_empty(&parse_state.list)) {
2063 WARN_ONCE(true, "WARNING: event parser found nothing\n");
2064 return -1;
2068 * Add list to the evlist even with errors to allow callers to clean up.
2070 perf_evlist__splice_list_tail(evlist, &parse_state.list);
2072 if (!ret) {
2073 struct evsel *last;
2075 evlist->nr_groups += parse_state.nr_groups;
2076 last = evlist__last(evlist);
2077 last->cmdline_group_boundary = true;
2079 return 0;
2083 * There are 2 users - builtin-record and builtin-test objects.
2084 * Both call evlist__delete in case of error, so we dont
2085 * need to bother.
2087 return ret;
2090 #define MAX_WIDTH 1000
2091 static int get_term_width(void)
2093 struct winsize ws;
2095 get_term_dimensions(&ws);
2096 return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
2099 static void __parse_events_print_error(int err_idx, const char *err_str,
2100 const char *err_help, const char *event)
2102 const char *str = "invalid or unsupported event: ";
2103 char _buf[MAX_WIDTH];
2104 char *buf = (char *) event;
2105 int idx = 0;
2106 if (err_str) {
2107 /* -2 for extra '' in the final fprintf */
2108 int width = get_term_width() - 2;
2109 int len_event = strlen(event);
2110 int len_str, max_len, cut = 0;
2113 * Maximum error index indent, we will cut
2114 * the event string if it's bigger.
2116 int max_err_idx = 13;
2119 * Let's be specific with the message when
2120 * we have the precise error.
2122 str = "event syntax error: ";
2123 len_str = strlen(str);
2124 max_len = width - len_str;
2126 buf = _buf;
2128 /* We're cutting from the beginning. */
2129 if (err_idx > max_err_idx)
2130 cut = err_idx - max_err_idx;
2132 strncpy(buf, event + cut, max_len);
2134 /* Mark cut parts with '..' on both sides. */
2135 if (cut)
2136 buf[0] = buf[1] = '.';
2138 if ((len_event - cut) > max_len) {
2139 buf[max_len - 1] = buf[max_len - 2] = '.';
2140 buf[max_len] = 0;
2143 idx = len_str + err_idx - cut;
2146 fprintf(stderr, "%s'%s'\n", str, buf);
2147 if (idx) {
2148 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err_str);
2149 if (err_help)
2150 fprintf(stderr, "\n%s\n", err_help);
2154 void parse_events_print_error(struct parse_events_error *err,
2155 const char *event)
2157 if (!err->num_errors)
2158 return;
2160 __parse_events_print_error(err->idx, err->str, err->help, event);
2161 zfree(&err->str);
2162 zfree(&err->help);
2164 if (err->num_errors > 1) {
2165 fputs("\nInitial error:\n", stderr);
2166 __parse_events_print_error(err->first_idx, err->first_str,
2167 err->first_help, event);
2168 zfree(&err->first_str);
2169 zfree(&err->first_help);
2173 #undef MAX_WIDTH
2175 int parse_events_option(const struct option *opt, const char *str,
2176 int unset __maybe_unused)
2178 struct evlist *evlist = *(struct evlist **)opt->value;
2179 struct parse_events_error err;
2180 int ret;
2182 bzero(&err, sizeof(err));
2183 ret = parse_events(evlist, str, &err);
2185 if (ret) {
2186 parse_events_print_error(&err, str);
2187 fprintf(stderr, "Run 'perf list' for a list of valid events\n");
2190 return ret;
2193 static int
2194 foreach_evsel_in_last_glob(struct evlist *evlist,
2195 int (*func)(struct evsel *evsel,
2196 const void *arg),
2197 const void *arg)
2199 struct evsel *last = NULL;
2200 int err;
2203 * Don't return when list_empty, give func a chance to report
2204 * error when it found last == NULL.
2206 * So no need to WARN here, let *func do this.
2208 if (evlist->core.nr_entries > 0)
2209 last = evlist__last(evlist);
2211 do {
2212 err = (*func)(last, arg);
2213 if (err)
2214 return -1;
2215 if (!last)
2216 return 0;
2218 if (last->core.node.prev == &evlist->core.entries)
2219 return 0;
2220 last = list_entry(last->core.node.prev, struct evsel, core.node);
2221 } while (!last->cmdline_group_boundary);
2223 return 0;
2226 static int set_filter(struct evsel *evsel, const void *arg)
2228 const char *str = arg;
2229 bool found = false;
2230 int nr_addr_filters = 0;
2231 struct perf_pmu *pmu = NULL;
2233 if (evsel == NULL) {
2234 fprintf(stderr,
2235 "--filter option should follow a -e tracepoint or HW tracer option\n");
2236 return -1;
2239 if (evsel->core.attr.type == PERF_TYPE_TRACEPOINT) {
2240 if (perf_evsel__append_tp_filter(evsel, str) < 0) {
2241 fprintf(stderr,
2242 "not enough memory to hold filter string\n");
2243 return -1;
2246 return 0;
2249 while ((pmu = perf_pmu__scan(pmu)) != NULL)
2250 if (pmu->type == evsel->core.attr.type) {
2251 found = true;
2252 break;
2255 if (found)
2256 perf_pmu__scan_file(pmu, "nr_addr_filters",
2257 "%d", &nr_addr_filters);
2259 if (!nr_addr_filters) {
2260 fprintf(stderr,
2261 "This CPU does not support address filtering\n");
2262 return -1;
2265 if (perf_evsel__append_addr_filter(evsel, str) < 0) {
2266 fprintf(stderr,
2267 "not enough memory to hold filter string\n");
2268 return -1;
2271 return 0;
2274 int parse_filter(const struct option *opt, const char *str,
2275 int unset __maybe_unused)
2277 struct evlist *evlist = *(struct evlist **)opt->value;
2279 return foreach_evsel_in_last_glob(evlist, set_filter,
2280 (const void *)str);
2283 static int add_exclude_perf_filter(struct evsel *evsel,
2284 const void *arg __maybe_unused)
2286 char new_filter[64];
2288 if (evsel == NULL || evsel->core.attr.type != PERF_TYPE_TRACEPOINT) {
2289 fprintf(stderr,
2290 "--exclude-perf option should follow a -e tracepoint option\n");
2291 return -1;
2294 snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
2296 if (perf_evsel__append_tp_filter(evsel, new_filter) < 0) {
2297 fprintf(stderr,
2298 "not enough memory to hold filter string\n");
2299 return -1;
2302 return 0;
2305 int exclude_perf(const struct option *opt,
2306 const char *arg __maybe_unused,
2307 int unset __maybe_unused)
2309 struct evlist *evlist = *(struct evlist **)opt->value;
2311 return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
2312 NULL);
2315 static const char * const event_type_descriptors[] = {
2316 "Hardware event",
2317 "Software event",
2318 "Tracepoint event",
2319 "Hardware cache event",
2320 "Raw hardware event descriptor",
2321 "Hardware breakpoint",
2324 static int cmp_string(const void *a, const void *b)
2326 const char * const *as = a;
2327 const char * const *bs = b;
2329 return strcmp(*as, *bs);
2333 * Print the events from <debugfs_mount_point>/tracing/events
2336 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
2337 bool name_only)
2339 DIR *sys_dir, *evt_dir;
2340 struct dirent *sys_dirent, *evt_dirent;
2341 char evt_path[MAXPATHLEN];
2342 char *dir_path;
2343 char **evt_list = NULL;
2344 unsigned int evt_i = 0, evt_num = 0;
2345 bool evt_num_known = false;
2347 restart:
2348 sys_dir = tracing_events__opendir();
2349 if (!sys_dir)
2350 return;
2352 if (evt_num_known) {
2353 evt_list = zalloc(sizeof(char *) * evt_num);
2354 if (!evt_list)
2355 goto out_close_sys_dir;
2358 for_each_subsystem(sys_dir, sys_dirent) {
2359 if (subsys_glob != NULL &&
2360 !strglobmatch(sys_dirent->d_name, subsys_glob))
2361 continue;
2363 dir_path = get_events_file(sys_dirent->d_name);
2364 if (!dir_path)
2365 continue;
2366 evt_dir = opendir(dir_path);
2367 if (!evt_dir)
2368 goto next;
2370 for_each_event(dir_path, evt_dir, evt_dirent) {
2371 if (event_glob != NULL &&
2372 !strglobmatch(evt_dirent->d_name, event_glob))
2373 continue;
2375 if (!evt_num_known) {
2376 evt_num++;
2377 continue;
2380 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2381 sys_dirent->d_name, evt_dirent->d_name);
2383 evt_list[evt_i] = strdup(evt_path);
2384 if (evt_list[evt_i] == NULL) {
2385 put_events_file(dir_path);
2386 goto out_close_evt_dir;
2388 evt_i++;
2390 closedir(evt_dir);
2391 next:
2392 put_events_file(dir_path);
2394 closedir(sys_dir);
2396 if (!evt_num_known) {
2397 evt_num_known = true;
2398 goto restart;
2400 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2401 evt_i = 0;
2402 while (evt_i < evt_num) {
2403 if (name_only) {
2404 printf("%s ", evt_list[evt_i++]);
2405 continue;
2407 printf(" %-50s [%s]\n", evt_list[evt_i++],
2408 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2410 if (evt_num && pager_in_use())
2411 printf("\n");
2413 out_free:
2414 evt_num = evt_i;
2415 for (evt_i = 0; evt_i < evt_num; evt_i++)
2416 zfree(&evt_list[evt_i]);
2417 zfree(&evt_list);
2418 return;
2420 out_close_evt_dir:
2421 closedir(evt_dir);
2422 out_close_sys_dir:
2423 closedir(sys_dir);
2425 printf("FATAL: not enough memory to print %s\n",
2426 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2427 if (evt_list)
2428 goto out_free;
2432 * Check whether event is in <debugfs_mount_point>/tracing/events
2435 int is_valid_tracepoint(const char *event_string)
2437 DIR *sys_dir, *evt_dir;
2438 struct dirent *sys_dirent, *evt_dirent;
2439 char evt_path[MAXPATHLEN];
2440 char *dir_path;
2442 sys_dir = tracing_events__opendir();
2443 if (!sys_dir)
2444 return 0;
2446 for_each_subsystem(sys_dir, sys_dirent) {
2447 dir_path = get_events_file(sys_dirent->d_name);
2448 if (!dir_path)
2449 continue;
2450 evt_dir = opendir(dir_path);
2451 if (!evt_dir)
2452 goto next;
2454 for_each_event(dir_path, evt_dir, evt_dirent) {
2455 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2456 sys_dirent->d_name, evt_dirent->d_name);
2457 if (!strcmp(evt_path, event_string)) {
2458 closedir(evt_dir);
2459 closedir(sys_dir);
2460 return 1;
2463 closedir(evt_dir);
2464 next:
2465 put_events_file(dir_path);
2467 closedir(sys_dir);
2468 return 0;
2471 static bool is_event_supported(u8 type, unsigned config)
2473 bool ret = true;
2474 int open_return;
2475 struct evsel *evsel;
2476 struct perf_event_attr attr = {
2477 .type = type,
2478 .config = config,
2479 .disabled = 1,
2481 struct perf_thread_map *tmap = thread_map__new_by_tid(0);
2483 if (tmap == NULL)
2484 return false;
2486 evsel = evsel__new(&attr);
2487 if (evsel) {
2488 open_return = evsel__open(evsel, NULL, tmap);
2489 ret = open_return >= 0;
2491 if (open_return == -EACCES) {
2493 * This happens if the paranoid value
2494 * /proc/sys/kernel/perf_event_paranoid is set to 2
2495 * Re-run with exclude_kernel set; we don't do that
2496 * by default as some ARM machines do not support it.
2499 evsel->core.attr.exclude_kernel = 1;
2500 ret = evsel__open(evsel, NULL, tmap) >= 0;
2502 evsel__delete(evsel);
2505 perf_thread_map__put(tmap);
2506 return ret;
2509 void print_sdt_events(const char *subsys_glob, const char *event_glob,
2510 bool name_only)
2512 struct probe_cache *pcache;
2513 struct probe_cache_entry *ent;
2514 struct strlist *bidlist, *sdtlist;
2515 struct strlist_config cfg = {.dont_dupstr = true};
2516 struct str_node *nd, *nd2;
2517 char *buf, *path, *ptr = NULL;
2518 bool show_detail = false;
2519 int ret;
2521 sdtlist = strlist__new(NULL, &cfg);
2522 if (!sdtlist) {
2523 pr_debug("Failed to allocate new strlist for SDT\n");
2524 return;
2526 bidlist = build_id_cache__list_all(true);
2527 if (!bidlist) {
2528 pr_debug("Failed to get buildids: %d\n", errno);
2529 return;
2531 strlist__for_each_entry(nd, bidlist) {
2532 pcache = probe_cache__new(nd->s, NULL);
2533 if (!pcache)
2534 continue;
2535 list_for_each_entry(ent, &pcache->entries, node) {
2536 if (!ent->sdt)
2537 continue;
2538 if (subsys_glob &&
2539 !strglobmatch(ent->pev.group, subsys_glob))
2540 continue;
2541 if (event_glob &&
2542 !strglobmatch(ent->pev.event, event_glob))
2543 continue;
2544 ret = asprintf(&buf, "%s:%s@%s", ent->pev.group,
2545 ent->pev.event, nd->s);
2546 if (ret > 0)
2547 strlist__add(sdtlist, buf);
2549 probe_cache__delete(pcache);
2551 strlist__delete(bidlist);
2553 strlist__for_each_entry(nd, sdtlist) {
2554 buf = strchr(nd->s, '@');
2555 if (buf)
2556 *(buf++) = '\0';
2557 if (name_only) {
2558 printf("%s ", nd->s);
2559 continue;
2561 nd2 = strlist__next(nd);
2562 if (nd2) {
2563 ptr = strchr(nd2->s, '@');
2564 if (ptr)
2565 *ptr = '\0';
2566 if (strcmp(nd->s, nd2->s) == 0)
2567 show_detail = true;
2569 if (show_detail) {
2570 path = build_id_cache__origname(buf);
2571 ret = asprintf(&buf, "%s@%s(%.12s)", nd->s, path, buf);
2572 if (ret > 0) {
2573 printf(" %-50s [%s]\n", buf, "SDT event");
2574 free(buf);
2576 free(path);
2577 } else
2578 printf(" %-50s [%s]\n", nd->s, "SDT event");
2579 if (nd2) {
2580 if (strcmp(nd->s, nd2->s) != 0)
2581 show_detail = false;
2582 if (ptr)
2583 *ptr = '@';
2586 strlist__delete(sdtlist);
2589 int print_hwcache_events(const char *event_glob, bool name_only)
2591 unsigned int type, op, i, evt_i = 0, evt_num = 0;
2592 char name[64];
2593 char **evt_list = NULL;
2594 bool evt_num_known = false;
2596 restart:
2597 if (evt_num_known) {
2598 evt_list = zalloc(sizeof(char *) * evt_num);
2599 if (!evt_list)
2600 goto out_enomem;
2603 for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
2604 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
2605 /* skip invalid cache type */
2606 if (!perf_evsel__is_cache_op_valid(type, op))
2607 continue;
2609 for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
2610 __perf_evsel__hw_cache_type_op_res_name(type, op, i,
2611 name, sizeof(name));
2612 if (event_glob != NULL && !strglobmatch(name, event_glob))
2613 continue;
2615 if (!is_event_supported(PERF_TYPE_HW_CACHE,
2616 type | (op << 8) | (i << 16)))
2617 continue;
2619 if (!evt_num_known) {
2620 evt_num++;
2621 continue;
2624 evt_list[evt_i] = strdup(name);
2625 if (evt_list[evt_i] == NULL)
2626 goto out_enomem;
2627 evt_i++;
2632 if (!evt_num_known) {
2633 evt_num_known = true;
2634 goto restart;
2636 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2637 evt_i = 0;
2638 while (evt_i < evt_num) {
2639 if (name_only) {
2640 printf("%s ", evt_list[evt_i++]);
2641 continue;
2643 printf(" %-50s [%s]\n", evt_list[evt_i++],
2644 event_type_descriptors[PERF_TYPE_HW_CACHE]);
2646 if (evt_num && pager_in_use())
2647 printf("\n");
2649 out_free:
2650 evt_num = evt_i;
2651 for (evt_i = 0; evt_i < evt_num; evt_i++)
2652 zfree(&evt_list[evt_i]);
2653 zfree(&evt_list);
2654 return evt_num;
2656 out_enomem:
2657 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
2658 if (evt_list)
2659 goto out_free;
2660 return evt_num;
2663 static void print_tool_event(const char *name, const char *event_glob,
2664 bool name_only)
2666 if (event_glob && !strglobmatch(name, event_glob))
2667 return;
2668 if (name_only)
2669 printf("%s ", name);
2670 else
2671 printf(" %-50s [%s]\n", name, "Tool event");
2675 void print_tool_events(const char *event_glob, bool name_only)
2677 print_tool_event("duration_time", event_glob, name_only);
2678 if (pager_in_use())
2679 printf("\n");
2682 void print_symbol_events(const char *event_glob, unsigned type,
2683 struct event_symbol *syms, unsigned max,
2684 bool name_only)
2686 unsigned int i, evt_i = 0, evt_num = 0;
2687 char name[MAX_NAME_LEN];
2688 char **evt_list = NULL;
2689 bool evt_num_known = false;
2691 restart:
2692 if (evt_num_known) {
2693 evt_list = zalloc(sizeof(char *) * evt_num);
2694 if (!evt_list)
2695 goto out_enomem;
2696 syms -= max;
2699 for (i = 0; i < max; i++, syms++) {
2701 if (event_glob != NULL && syms->symbol != NULL &&
2702 !(strglobmatch(syms->symbol, event_glob) ||
2703 (syms->alias && strglobmatch(syms->alias, event_glob))))
2704 continue;
2706 if (!is_event_supported(type, i))
2707 continue;
2709 if (!evt_num_known) {
2710 evt_num++;
2711 continue;
2714 if (!name_only && strlen(syms->alias))
2715 snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
2716 else
2717 strlcpy(name, syms->symbol, MAX_NAME_LEN);
2719 evt_list[evt_i] = strdup(name);
2720 if (evt_list[evt_i] == NULL)
2721 goto out_enomem;
2722 evt_i++;
2725 if (!evt_num_known) {
2726 evt_num_known = true;
2727 goto restart;
2729 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2730 evt_i = 0;
2731 while (evt_i < evt_num) {
2732 if (name_only) {
2733 printf("%s ", evt_list[evt_i++]);
2734 continue;
2736 printf(" %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
2738 if (evt_num && pager_in_use())
2739 printf("\n");
2741 out_free:
2742 evt_num = evt_i;
2743 for (evt_i = 0; evt_i < evt_num; evt_i++)
2744 zfree(&evt_list[evt_i]);
2745 zfree(&evt_list);
2746 return;
2748 out_enomem:
2749 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
2750 if (evt_list)
2751 goto out_free;
2755 * Print the help text for the event symbols:
2757 void print_events(const char *event_glob, bool name_only, bool quiet_flag,
2758 bool long_desc, bool details_flag, bool deprecated)
2760 print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
2761 event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
2763 print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
2764 event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
2765 print_tool_events(event_glob, name_only);
2767 print_hwcache_events(event_glob, name_only);
2769 print_pmu_events(event_glob, name_only, quiet_flag, long_desc,
2770 details_flag, deprecated);
2772 if (event_glob != NULL)
2773 return;
2775 if (!name_only) {
2776 printf(" %-50s [%s]\n",
2777 "rNNN",
2778 event_type_descriptors[PERF_TYPE_RAW]);
2779 printf(" %-50s [%s]\n",
2780 "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
2781 event_type_descriptors[PERF_TYPE_RAW]);
2782 if (pager_in_use())
2783 printf(" (see 'man perf-list' on how to encode it)\n\n");
2785 printf(" %-50s [%s]\n",
2786 "mem:<addr>[/len][:access]",
2787 event_type_descriptors[PERF_TYPE_BREAKPOINT]);
2788 if (pager_in_use())
2789 printf("\n");
2792 print_tracepoint_events(NULL, NULL, name_only);
2794 print_sdt_events(NULL, NULL, name_only);
2796 metricgroup__print(true, true, NULL, name_only, details_flag);
2799 int parse_events__is_hardcoded_term(struct parse_events_term *term)
2801 return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
2804 static int new_term(struct parse_events_term **_term,
2805 struct parse_events_term *temp,
2806 char *str, u64 num)
2808 struct parse_events_term *term;
2810 term = malloc(sizeof(*term));
2811 if (!term)
2812 return -ENOMEM;
2814 *term = *temp;
2815 INIT_LIST_HEAD(&term->list);
2816 term->weak = false;
2818 switch (term->type_val) {
2819 case PARSE_EVENTS__TERM_TYPE_NUM:
2820 term->val.num = num;
2821 break;
2822 case PARSE_EVENTS__TERM_TYPE_STR:
2823 term->val.str = str;
2824 break;
2825 default:
2826 free(term);
2827 return -EINVAL;
2830 *_term = term;
2831 return 0;
2834 int parse_events_term__num(struct parse_events_term **term,
2835 int type_term, char *config, u64 num,
2836 bool no_value,
2837 void *loc_term_, void *loc_val_)
2839 YYLTYPE *loc_term = loc_term_;
2840 YYLTYPE *loc_val = loc_val_;
2842 struct parse_events_term temp = {
2843 .type_val = PARSE_EVENTS__TERM_TYPE_NUM,
2844 .type_term = type_term,
2845 .config = config,
2846 .no_value = no_value,
2847 .err_term = loc_term ? loc_term->first_column : 0,
2848 .err_val = loc_val ? loc_val->first_column : 0,
2851 return new_term(term, &temp, NULL, num);
2854 int parse_events_term__str(struct parse_events_term **term,
2855 int type_term, char *config, char *str,
2856 void *loc_term_, void *loc_val_)
2858 YYLTYPE *loc_term = loc_term_;
2859 YYLTYPE *loc_val = loc_val_;
2861 struct parse_events_term temp = {
2862 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2863 .type_term = type_term,
2864 .config = config,
2865 .err_term = loc_term ? loc_term->first_column : 0,
2866 .err_val = loc_val ? loc_val->first_column : 0,
2869 return new_term(term, &temp, str, 0);
2872 int parse_events_term__sym_hw(struct parse_events_term **term,
2873 char *config, unsigned idx)
2875 struct event_symbol *sym;
2876 char *str;
2877 struct parse_events_term temp = {
2878 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2879 .type_term = PARSE_EVENTS__TERM_TYPE_USER,
2880 .config = config,
2883 if (!temp.config) {
2884 temp.config = strdup("event");
2885 if (!temp.config)
2886 return -ENOMEM;
2888 BUG_ON(idx >= PERF_COUNT_HW_MAX);
2889 sym = &event_symbols_hw[idx];
2891 str = strdup(sym->symbol);
2892 if (!str)
2893 return -ENOMEM;
2894 return new_term(term, &temp, str, 0);
2897 int parse_events_term__clone(struct parse_events_term **new,
2898 struct parse_events_term *term)
2900 char *str;
2901 struct parse_events_term temp = {
2902 .type_val = term->type_val,
2903 .type_term = term->type_term,
2904 .config = NULL,
2905 .err_term = term->err_term,
2906 .err_val = term->err_val,
2909 if (term->config) {
2910 temp.config = strdup(term->config);
2911 if (!temp.config)
2912 return -ENOMEM;
2914 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
2915 return new_term(new, &temp, NULL, term->val.num);
2917 str = strdup(term->val.str);
2918 if (!str)
2919 return -ENOMEM;
2920 return new_term(new, &temp, str, 0);
2923 void parse_events_term__delete(struct parse_events_term *term)
2925 if (term->array.nr_ranges)
2926 zfree(&term->array.ranges);
2928 if (term->type_val != PARSE_EVENTS__TERM_TYPE_NUM)
2929 zfree(&term->val.str);
2931 zfree(&term->config);
2932 free(term);
2935 int parse_events_copy_term_list(struct list_head *old,
2936 struct list_head **new)
2938 struct parse_events_term *term, *n;
2939 int ret;
2941 if (!old) {
2942 *new = NULL;
2943 return 0;
2946 *new = malloc(sizeof(struct list_head));
2947 if (!*new)
2948 return -ENOMEM;
2949 INIT_LIST_HEAD(*new);
2951 list_for_each_entry (term, old, list) {
2952 ret = parse_events_term__clone(&n, term);
2953 if (ret)
2954 return ret;
2955 list_add_tail(&n->list, *new);
2957 return 0;
2960 void parse_events_terms__purge(struct list_head *terms)
2962 struct parse_events_term *term, *h;
2964 list_for_each_entry_safe(term, h, terms, list) {
2965 list_del_init(&term->list);
2966 parse_events_term__delete(term);
2970 void parse_events_terms__delete(struct list_head *terms)
2972 if (!terms)
2973 return;
2974 parse_events_terms__purge(terms);
2975 free(terms);
2978 void parse_events__clear_array(struct parse_events_array *a)
2980 zfree(&a->ranges);
2983 void parse_events_evlist_error(struct parse_events_state *parse_state,
2984 int idx, const char *str)
2986 if (!parse_state->error)
2987 return;
2989 parse_events__handle_error(parse_state->error, idx, strdup(str), NULL);
2992 static void config_terms_list(char *buf, size_t buf_sz)
2994 int i;
2995 bool first = true;
2997 buf[0] = '\0';
2998 for (i = 0; i < __PARSE_EVENTS__TERM_TYPE_NR; i++) {
2999 const char *name = config_term_names[i];
3001 if (!config_term_avail(i, NULL))
3002 continue;
3003 if (!name)
3004 continue;
3005 if (name[0] == '<')
3006 continue;
3008 if (strlen(buf) + strlen(name) + 2 >= buf_sz)
3009 return;
3011 if (!first)
3012 strcat(buf, ",");
3013 else
3014 first = false;
3015 strcat(buf, name);
3020 * Return string contains valid config terms of an event.
3021 * @additional_terms: For terms such as PMU sysfs terms.
3023 char *parse_events_formats_error_string(char *additional_terms)
3025 char *str;
3026 /* "no-overwrite" is the longest name */
3027 char static_terms[__PARSE_EVENTS__TERM_TYPE_NR *
3028 (sizeof("no-overwrite") - 1)];
3030 config_terms_list(static_terms, sizeof(static_terms));
3031 /* valid terms */
3032 if (additional_terms) {
3033 if (asprintf(&str, "valid terms: %s,%s",
3034 additional_terms, static_terms) < 0)
3035 goto fail;
3036 } else {
3037 if (asprintf(&str, "valid terms: %s", static_terms) < 0)
3038 goto fail;
3040 return str;
3042 fail:
3043 return NULL;