treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / tools / perf / util / parse-events.c
blobed7c008b9c8bd3161daeb3c378f281d27c33521c
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 path->system = malloc(MAX_EVENT_LENGTH);
261 if (!path->system) {
262 free(path);
263 return NULL;
265 path->name = malloc(MAX_EVENT_LENGTH);
266 if (!path->name) {
267 zfree(&path->system);
268 free(path);
269 return NULL;
271 strncpy(path->system, sys_dirent->d_name,
272 MAX_EVENT_LENGTH);
273 strncpy(path->name, evt_dirent->d_name,
274 MAX_EVENT_LENGTH);
275 return path;
278 closedir(evt_dir);
279 next:
280 put_events_file(dir_path);
283 closedir(sys_dir);
284 return NULL;
287 struct tracepoint_path *tracepoint_name_to_path(const char *name)
289 struct tracepoint_path *path = zalloc(sizeof(*path));
290 char *str = strchr(name, ':');
292 if (path == NULL || str == NULL) {
293 free(path);
294 return NULL;
297 path->system = strndup(name, str - name);
298 path->name = strdup(str+1);
300 if (path->system == NULL || path->name == NULL) {
301 zfree(&path->system);
302 zfree(&path->name);
303 zfree(&path);
306 return path;
309 const char *event_type(int type)
311 switch (type) {
312 case PERF_TYPE_HARDWARE:
313 return "hardware";
315 case PERF_TYPE_SOFTWARE:
316 return "software";
318 case PERF_TYPE_TRACEPOINT:
319 return "tracepoint";
321 case PERF_TYPE_HW_CACHE:
322 return "hardware-cache";
324 default:
325 break;
328 return "unknown";
331 static int parse_events__is_name_term(struct parse_events_term *term)
333 return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
336 static char *get_config_name(struct list_head *head_terms)
338 struct parse_events_term *term;
340 if (!head_terms)
341 return NULL;
343 list_for_each_entry(term, head_terms, list)
344 if (parse_events__is_name_term(term))
345 return term->val.str;
347 return NULL;
350 static struct evsel *
351 __add_event(struct list_head *list, int *idx,
352 struct perf_event_attr *attr,
353 char *name, struct perf_pmu *pmu,
354 struct list_head *config_terms, bool auto_merge_stats,
355 const char *cpu_list)
357 struct evsel *evsel;
358 struct perf_cpu_map *cpus = pmu ? pmu->cpus :
359 cpu_list ? perf_cpu_map__new(cpu_list) : NULL;
361 event_attr_init(attr);
363 evsel = perf_evsel__new_idx(attr, *idx);
364 if (!evsel)
365 return NULL;
367 (*idx)++;
368 evsel->core.cpus = perf_cpu_map__get(cpus);
369 evsel->core.own_cpus = perf_cpu_map__get(cpus);
370 evsel->core.system_wide = pmu ? pmu->is_uncore : false;
371 evsel->auto_merge_stats = auto_merge_stats;
373 if (name)
374 evsel->name = strdup(name);
376 if (config_terms)
377 list_splice(config_terms, &evsel->config_terms);
379 list_add_tail(&evsel->core.node, list);
380 return evsel;
383 static int add_event(struct list_head *list, int *idx,
384 struct perf_event_attr *attr, char *name,
385 struct list_head *config_terms)
387 return __add_event(list, idx, attr, name, NULL, config_terms, false, NULL) ? 0 : -ENOMEM;
390 static int add_event_tool(struct list_head *list, int *idx,
391 enum perf_tool_event tool_event)
393 struct evsel *evsel;
394 struct perf_event_attr attr = {
395 .type = PERF_TYPE_SOFTWARE,
396 .config = PERF_COUNT_SW_DUMMY,
399 evsel = __add_event(list, idx, &attr, NULL, NULL, NULL, false, "0");
400 if (!evsel)
401 return -ENOMEM;
402 evsel->tool_event = tool_event;
403 if (tool_event == PERF_TOOL_DURATION_TIME)
404 evsel->unit = strdup("ns");
405 return 0;
408 static int parse_aliases(char *str, const char *names[][PERF_EVSEL__MAX_ALIASES], int size)
410 int i, j;
411 int n, longest = -1;
413 for (i = 0; i < size; i++) {
414 for (j = 0; j < PERF_EVSEL__MAX_ALIASES && names[i][j]; j++) {
415 n = strlen(names[i][j]);
416 if (n > longest && !strncasecmp(str, names[i][j], n))
417 longest = n;
419 if (longest > 0)
420 return i;
423 return -1;
426 typedef int config_term_func_t(struct perf_event_attr *attr,
427 struct parse_events_term *term,
428 struct parse_events_error *err);
429 static int config_term_common(struct perf_event_attr *attr,
430 struct parse_events_term *term,
431 struct parse_events_error *err);
432 static int config_attr(struct perf_event_attr *attr,
433 struct list_head *head,
434 struct parse_events_error *err,
435 config_term_func_t config_term);
437 int parse_events_add_cache(struct list_head *list, int *idx,
438 char *type, char *op_result1, char *op_result2,
439 struct parse_events_error *err,
440 struct list_head *head_config)
442 struct perf_event_attr attr;
443 LIST_HEAD(config_terms);
444 char name[MAX_NAME_LEN], *config_name;
445 int cache_type = -1, cache_op = -1, cache_result = -1;
446 char *op_result[2] = { op_result1, op_result2 };
447 int i, n;
450 * No fallback - if we cannot get a clear cache type
451 * then bail out:
453 cache_type = parse_aliases(type, perf_evsel__hw_cache,
454 PERF_COUNT_HW_CACHE_MAX);
455 if (cache_type == -1)
456 return -EINVAL;
458 config_name = get_config_name(head_config);
459 n = snprintf(name, MAX_NAME_LEN, "%s", type);
461 for (i = 0; (i < 2) && (op_result[i]); i++) {
462 char *str = op_result[i];
464 n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
466 if (cache_op == -1) {
467 cache_op = parse_aliases(str, perf_evsel__hw_cache_op,
468 PERF_COUNT_HW_CACHE_OP_MAX);
469 if (cache_op >= 0) {
470 if (!perf_evsel__is_cache_op_valid(cache_type, cache_op))
471 return -EINVAL;
472 continue;
476 if (cache_result == -1) {
477 cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
478 PERF_COUNT_HW_CACHE_RESULT_MAX);
479 if (cache_result >= 0)
480 continue;
485 * Fall back to reads:
487 if (cache_op == -1)
488 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
491 * Fall back to accesses:
493 if (cache_result == -1)
494 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
496 memset(&attr, 0, sizeof(attr));
497 attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
498 attr.type = PERF_TYPE_HW_CACHE;
500 if (head_config) {
501 if (config_attr(&attr, head_config, err,
502 config_term_common))
503 return -EINVAL;
505 if (get_config_terms(head_config, &config_terms))
506 return -ENOMEM;
508 return add_event(list, idx, &attr, config_name ? : name, &config_terms);
511 static void tracepoint_error(struct parse_events_error *e, int err,
512 const char *sys, const char *name)
514 const char *str;
515 char help[BUFSIZ];
517 if (!e)
518 return;
521 * We get error directly from syscall errno ( > 0),
522 * or from encoded pointer's error ( < 0).
524 err = abs(err);
526 switch (err) {
527 case EACCES:
528 str = "can't access trace events";
529 break;
530 case ENOENT:
531 str = "unknown tracepoint";
532 break;
533 default:
534 str = "failed to add tracepoint";
535 break;
538 tracing_path__strerror_open_tp(err, help, sizeof(help), sys, name);
539 parse_events__handle_error(e, 0, strdup(str), strdup(help));
542 static int add_tracepoint(struct list_head *list, int *idx,
543 const char *sys_name, const char *evt_name,
544 struct parse_events_error *err,
545 struct list_head *head_config)
547 struct evsel *evsel;
549 evsel = perf_evsel__newtp_idx(sys_name, evt_name, (*idx)++);
550 if (IS_ERR(evsel)) {
551 tracepoint_error(err, PTR_ERR(evsel), sys_name, evt_name);
552 return PTR_ERR(evsel);
555 if (head_config) {
556 LIST_HEAD(config_terms);
558 if (get_config_terms(head_config, &config_terms))
559 return -ENOMEM;
560 list_splice(&config_terms, &evsel->config_terms);
563 list_add_tail(&evsel->core.node, list);
564 return 0;
567 static int add_tracepoint_multi_event(struct list_head *list, int *idx,
568 const char *sys_name, const char *evt_name,
569 struct parse_events_error *err,
570 struct list_head *head_config)
572 char *evt_path;
573 struct dirent *evt_ent;
574 DIR *evt_dir;
575 int ret = 0, found = 0;
577 evt_path = get_events_file(sys_name);
578 if (!evt_path) {
579 tracepoint_error(err, errno, sys_name, evt_name);
580 return -1;
582 evt_dir = opendir(evt_path);
583 if (!evt_dir) {
584 put_events_file(evt_path);
585 tracepoint_error(err, errno, sys_name, evt_name);
586 return -1;
589 while (!ret && (evt_ent = readdir(evt_dir))) {
590 if (!strcmp(evt_ent->d_name, ".")
591 || !strcmp(evt_ent->d_name, "..")
592 || !strcmp(evt_ent->d_name, "enable")
593 || !strcmp(evt_ent->d_name, "filter"))
594 continue;
596 if (!strglobmatch(evt_ent->d_name, evt_name))
597 continue;
599 found++;
601 ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name,
602 err, head_config);
605 if (!found) {
606 tracepoint_error(err, ENOENT, sys_name, evt_name);
607 ret = -1;
610 put_events_file(evt_path);
611 closedir(evt_dir);
612 return ret;
615 static int add_tracepoint_event(struct list_head *list, int *idx,
616 const char *sys_name, const char *evt_name,
617 struct parse_events_error *err,
618 struct list_head *head_config)
620 return strpbrk(evt_name, "*?") ?
621 add_tracepoint_multi_event(list, idx, sys_name, evt_name,
622 err, head_config) :
623 add_tracepoint(list, idx, sys_name, evt_name,
624 err, head_config);
627 static int add_tracepoint_multi_sys(struct list_head *list, int *idx,
628 const char *sys_name, const char *evt_name,
629 struct parse_events_error *err,
630 struct list_head *head_config)
632 struct dirent *events_ent;
633 DIR *events_dir;
634 int ret = 0;
636 events_dir = tracing_events__opendir();
637 if (!events_dir) {
638 tracepoint_error(err, errno, sys_name, evt_name);
639 return -1;
642 while (!ret && (events_ent = readdir(events_dir))) {
643 if (!strcmp(events_ent->d_name, ".")
644 || !strcmp(events_ent->d_name, "..")
645 || !strcmp(events_ent->d_name, "enable")
646 || !strcmp(events_ent->d_name, "header_event")
647 || !strcmp(events_ent->d_name, "header_page"))
648 continue;
650 if (!strglobmatch(events_ent->d_name, sys_name))
651 continue;
653 ret = add_tracepoint_event(list, idx, events_ent->d_name,
654 evt_name, err, head_config);
657 closedir(events_dir);
658 return ret;
661 struct __add_bpf_event_param {
662 struct parse_events_state *parse_state;
663 struct list_head *list;
664 struct list_head *head_config;
667 static int add_bpf_event(const char *group, const char *event, int fd, struct bpf_object *obj,
668 void *_param)
670 LIST_HEAD(new_evsels);
671 struct __add_bpf_event_param *param = _param;
672 struct parse_events_state *parse_state = param->parse_state;
673 struct list_head *list = param->list;
674 struct evsel *pos;
675 int err;
677 * Check if we should add the event, i.e. if it is a TP but starts with a '!',
678 * then don't add the tracepoint, this will be used for something else, like
679 * adding to a BPF_MAP_TYPE_PROG_ARRAY.
681 * See tools/perf/examples/bpf/augmented_raw_syscalls.c
683 if (group[0] == '!')
684 return 0;
686 pr_debug("add bpf event %s:%s and attach bpf program %d\n",
687 group, event, fd);
689 err = parse_events_add_tracepoint(&new_evsels, &parse_state->idx, group,
690 event, parse_state->error,
691 param->head_config);
692 if (err) {
693 struct evsel *evsel, *tmp;
695 pr_debug("Failed to add BPF event %s:%s\n",
696 group, event);
697 list_for_each_entry_safe(evsel, tmp, &new_evsels, core.node) {
698 list_del_init(&evsel->core.node);
699 evsel__delete(evsel);
701 return err;
703 pr_debug("adding %s:%s\n", group, event);
705 list_for_each_entry(pos, &new_evsels, core.node) {
706 pr_debug("adding %s:%s to %p\n",
707 group, event, pos);
708 pos->bpf_fd = fd;
709 pos->bpf_obj = obj;
711 list_splice(&new_evsels, list);
712 return 0;
715 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
716 struct list_head *list,
717 struct bpf_object *obj,
718 struct list_head *head_config)
720 int err;
721 char errbuf[BUFSIZ];
722 struct __add_bpf_event_param param = {parse_state, list, head_config};
723 static bool registered_unprobe_atexit = false;
725 if (IS_ERR(obj) || !obj) {
726 snprintf(errbuf, sizeof(errbuf),
727 "Internal error: load bpf obj with NULL");
728 err = -EINVAL;
729 goto errout;
733 * Register atexit handler before calling bpf__probe() so
734 * bpf__probe() don't need to unprobe probe points its already
735 * created when failure.
737 if (!registered_unprobe_atexit) {
738 atexit(bpf__clear);
739 registered_unprobe_atexit = true;
742 err = bpf__probe(obj);
743 if (err) {
744 bpf__strerror_probe(obj, err, errbuf, sizeof(errbuf));
745 goto errout;
748 err = bpf__load(obj);
749 if (err) {
750 bpf__strerror_load(obj, err, errbuf, sizeof(errbuf));
751 goto errout;
754 err = bpf__foreach_event(obj, add_bpf_event, &param);
755 if (err) {
756 snprintf(errbuf, sizeof(errbuf),
757 "Attach events in BPF object failed");
758 goto errout;
761 return 0;
762 errout:
763 parse_state->error->help = strdup("(add -v to see detail)");
764 parse_state->error->str = strdup(errbuf);
765 return err;
768 static int
769 parse_events_config_bpf(struct parse_events_state *parse_state,
770 struct bpf_object *obj,
771 struct list_head *head_config)
773 struct parse_events_term *term;
774 int error_pos;
776 if (!head_config || list_empty(head_config))
777 return 0;
779 list_for_each_entry(term, head_config, list) {
780 char errbuf[BUFSIZ];
781 int err;
783 if (term->type_term != PARSE_EVENTS__TERM_TYPE_USER) {
784 snprintf(errbuf, sizeof(errbuf),
785 "Invalid config term for BPF object");
786 errbuf[BUFSIZ - 1] = '\0';
788 parse_state->error->idx = term->err_term;
789 parse_state->error->str = strdup(errbuf);
790 return -EINVAL;
793 err = bpf__config_obj(obj, term, parse_state->evlist, &error_pos);
794 if (err) {
795 bpf__strerror_config_obj(obj, term, parse_state->evlist,
796 &error_pos, err, errbuf,
797 sizeof(errbuf));
798 parse_state->error->help = strdup(
799 "Hint:\tValid config terms:\n"
800 " \tmap:[<arraymap>].value<indices>=[value]\n"
801 " \tmap:[<eventmap>].event<indices>=[event]\n"
802 "\n"
803 " \twhere <indices> is something like [0,3...5] or [all]\n"
804 " \t(add -v to see detail)");
805 parse_state->error->str = strdup(errbuf);
806 if (err == -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE)
807 parse_state->error->idx = term->err_val;
808 else
809 parse_state->error->idx = term->err_term + error_pos;
810 return err;
813 return 0;
817 * Split config terms:
818 * perf record -e bpf.c/call-graph=fp,map:array.value[0]=1/ ...
819 * 'call-graph=fp' is 'evt config', should be applied to each
820 * events in bpf.c.
821 * 'map:array.value[0]=1' is 'obj config', should be processed
822 * with parse_events_config_bpf.
824 * Move object config terms from the first list to obj_head_config.
826 static void
827 split_bpf_config_terms(struct list_head *evt_head_config,
828 struct list_head *obj_head_config)
830 struct parse_events_term *term, *temp;
833 * Currectly, all possible user config term
834 * belong to bpf object. parse_events__is_hardcoded_term()
835 * happends to be a good flag.
837 * See parse_events_config_bpf() and
838 * config_term_tracepoint().
840 list_for_each_entry_safe(term, temp, evt_head_config, list)
841 if (!parse_events__is_hardcoded_term(term))
842 list_move_tail(&term->list, obj_head_config);
845 int parse_events_load_bpf(struct parse_events_state *parse_state,
846 struct list_head *list,
847 char *bpf_file_name,
848 bool source,
849 struct list_head *head_config)
851 int err;
852 struct bpf_object *obj;
853 LIST_HEAD(obj_head_config);
855 if (head_config)
856 split_bpf_config_terms(head_config, &obj_head_config);
858 obj = bpf__prepare_load(bpf_file_name, source);
859 if (IS_ERR(obj)) {
860 char errbuf[BUFSIZ];
862 err = PTR_ERR(obj);
864 if (err == -ENOTSUP)
865 snprintf(errbuf, sizeof(errbuf),
866 "BPF support is not compiled");
867 else
868 bpf__strerror_prepare_load(bpf_file_name,
869 source,
870 -err, errbuf,
871 sizeof(errbuf));
873 parse_state->error->help = strdup("(add -v to see detail)");
874 parse_state->error->str = strdup(errbuf);
875 return err;
878 err = parse_events_load_bpf_obj(parse_state, list, obj, head_config);
879 if (err)
880 return err;
881 err = parse_events_config_bpf(parse_state, obj, &obj_head_config);
884 * Caller doesn't know anything about obj_head_config,
885 * so combine them together again before returnning.
887 if (head_config)
888 list_splice_tail(&obj_head_config, head_config);
889 return err;
892 static int
893 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
895 int i;
897 for (i = 0; i < 3; i++) {
898 if (!type || !type[i])
899 break;
901 #define CHECK_SET_TYPE(bit) \
902 do { \
903 if (attr->bp_type & bit) \
904 return -EINVAL; \
905 else \
906 attr->bp_type |= bit; \
907 } while (0)
909 switch (type[i]) {
910 case 'r':
911 CHECK_SET_TYPE(HW_BREAKPOINT_R);
912 break;
913 case 'w':
914 CHECK_SET_TYPE(HW_BREAKPOINT_W);
915 break;
916 case 'x':
917 CHECK_SET_TYPE(HW_BREAKPOINT_X);
918 break;
919 default:
920 return -EINVAL;
924 #undef CHECK_SET_TYPE
926 if (!attr->bp_type) /* Default */
927 attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
929 return 0;
932 int parse_events_add_breakpoint(struct list_head *list, int *idx,
933 void *ptr, char *type, u64 len)
935 struct perf_event_attr attr;
937 memset(&attr, 0, sizeof(attr));
938 attr.bp_addr = (unsigned long) ptr;
940 if (parse_breakpoint_type(type, &attr))
941 return -EINVAL;
943 /* Provide some defaults if len is not specified */
944 if (!len) {
945 if (attr.bp_type == HW_BREAKPOINT_X)
946 len = sizeof(long);
947 else
948 len = HW_BREAKPOINT_LEN_4;
951 attr.bp_len = len;
953 attr.type = PERF_TYPE_BREAKPOINT;
954 attr.sample_period = 1;
956 return add_event(list, idx, &attr, NULL, NULL);
959 static int check_type_val(struct parse_events_term *term,
960 struct parse_events_error *err,
961 int type)
963 if (type == term->type_val)
964 return 0;
966 if (err) {
967 parse_events__handle_error(err, term->err_val,
968 type == PARSE_EVENTS__TERM_TYPE_NUM
969 ? strdup("expected numeric value")
970 : strdup("expected string value"),
971 NULL);
973 return -EINVAL;
977 * Update according to parse-events.l
979 static const char *config_term_names[__PARSE_EVENTS__TERM_TYPE_NR] = {
980 [PARSE_EVENTS__TERM_TYPE_USER] = "<sysfs term>",
981 [PARSE_EVENTS__TERM_TYPE_CONFIG] = "config",
982 [PARSE_EVENTS__TERM_TYPE_CONFIG1] = "config1",
983 [PARSE_EVENTS__TERM_TYPE_CONFIG2] = "config2",
984 [PARSE_EVENTS__TERM_TYPE_NAME] = "name",
985 [PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD] = "period",
986 [PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ] = "freq",
987 [PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE] = "branch_type",
988 [PARSE_EVENTS__TERM_TYPE_TIME] = "time",
989 [PARSE_EVENTS__TERM_TYPE_CALLGRAPH] = "call-graph",
990 [PARSE_EVENTS__TERM_TYPE_STACKSIZE] = "stack-size",
991 [PARSE_EVENTS__TERM_TYPE_NOINHERIT] = "no-inherit",
992 [PARSE_EVENTS__TERM_TYPE_INHERIT] = "inherit",
993 [PARSE_EVENTS__TERM_TYPE_MAX_STACK] = "max-stack",
994 [PARSE_EVENTS__TERM_TYPE_MAX_EVENTS] = "nr",
995 [PARSE_EVENTS__TERM_TYPE_OVERWRITE] = "overwrite",
996 [PARSE_EVENTS__TERM_TYPE_NOOVERWRITE] = "no-overwrite",
997 [PARSE_EVENTS__TERM_TYPE_DRV_CFG] = "driver-config",
998 [PARSE_EVENTS__TERM_TYPE_PERCORE] = "percore",
999 [PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT] = "aux-output",
1000 [PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE] = "aux-sample-size",
1003 static bool config_term_shrinked;
1005 static bool
1006 config_term_avail(int term_type, struct parse_events_error *err)
1008 char *err_str;
1010 if (term_type < 0 || term_type >= __PARSE_EVENTS__TERM_TYPE_NR) {
1011 parse_events__handle_error(err, -1,
1012 strdup("Invalid term_type"), NULL);
1013 return false;
1015 if (!config_term_shrinked)
1016 return true;
1018 switch (term_type) {
1019 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1020 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
1021 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
1022 case PARSE_EVENTS__TERM_TYPE_NAME:
1023 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1024 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1025 return true;
1026 default:
1027 if (!err)
1028 return false;
1030 /* term_type is validated so indexing is safe */
1031 if (asprintf(&err_str, "'%s' is not usable in 'perf stat'",
1032 config_term_names[term_type]) >= 0)
1033 parse_events__handle_error(err, -1, err_str, NULL);
1034 return false;
1038 void parse_events__shrink_config_terms(void)
1040 config_term_shrinked = true;
1043 static int config_term_common(struct perf_event_attr *attr,
1044 struct parse_events_term *term,
1045 struct parse_events_error *err)
1047 #define CHECK_TYPE_VAL(type) \
1048 do { \
1049 if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
1050 return -EINVAL; \
1051 } while (0)
1053 switch (term->type_term) {
1054 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1055 CHECK_TYPE_VAL(NUM);
1056 attr->config = term->val.num;
1057 break;
1058 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
1059 CHECK_TYPE_VAL(NUM);
1060 attr->config1 = term->val.num;
1061 break;
1062 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
1063 CHECK_TYPE_VAL(NUM);
1064 attr->config2 = term->val.num;
1065 break;
1066 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1067 CHECK_TYPE_VAL(NUM);
1068 break;
1069 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1070 CHECK_TYPE_VAL(NUM);
1071 break;
1072 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1073 CHECK_TYPE_VAL(STR);
1074 if (strcmp(term->val.str, "no") &&
1075 parse_branch_str(term->val.str,
1076 &attr->branch_sample_type)) {
1077 parse_events__handle_error(err, term->err_val,
1078 strdup("invalid branch sample type"),
1079 NULL);
1080 return -EINVAL;
1082 break;
1083 case PARSE_EVENTS__TERM_TYPE_TIME:
1084 CHECK_TYPE_VAL(NUM);
1085 if (term->val.num > 1) {
1086 parse_events__handle_error(err, term->err_val,
1087 strdup("expected 0 or 1"),
1088 NULL);
1089 return -EINVAL;
1091 break;
1092 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1093 CHECK_TYPE_VAL(STR);
1094 break;
1095 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1096 CHECK_TYPE_VAL(NUM);
1097 break;
1098 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1099 CHECK_TYPE_VAL(NUM);
1100 break;
1101 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1102 CHECK_TYPE_VAL(NUM);
1103 break;
1104 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1105 CHECK_TYPE_VAL(NUM);
1106 break;
1107 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1108 CHECK_TYPE_VAL(NUM);
1109 break;
1110 case PARSE_EVENTS__TERM_TYPE_NAME:
1111 CHECK_TYPE_VAL(STR);
1112 break;
1113 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1114 CHECK_TYPE_VAL(NUM);
1115 break;
1116 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1117 CHECK_TYPE_VAL(NUM);
1118 break;
1119 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1120 CHECK_TYPE_VAL(NUM);
1121 if ((unsigned int)term->val.num > 1) {
1122 parse_events__handle_error(err, term->err_val,
1123 strdup("expected 0 or 1"),
1124 NULL);
1125 return -EINVAL;
1127 break;
1128 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1129 CHECK_TYPE_VAL(NUM);
1130 break;
1131 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1132 CHECK_TYPE_VAL(NUM);
1133 if (term->val.num > UINT_MAX) {
1134 parse_events__handle_error(err, term->err_val,
1135 strdup("too big"),
1136 NULL);
1137 return -EINVAL;
1139 break;
1140 default:
1141 parse_events__handle_error(err, term->err_term,
1142 strdup("unknown term"),
1143 parse_events_formats_error_string(NULL));
1144 return -EINVAL;
1148 * Check term availbility after basic checking so
1149 * PARSE_EVENTS__TERM_TYPE_USER can be found and filtered.
1151 * If check availbility at the entry of this function,
1152 * user will see "'<sysfs term>' is not usable in 'perf stat'"
1153 * if an invalid config term is provided for legacy events
1154 * (for example, instructions/badterm/...), which is confusing.
1156 if (!config_term_avail(term->type_term, err))
1157 return -EINVAL;
1158 return 0;
1159 #undef CHECK_TYPE_VAL
1162 static int config_term_pmu(struct perf_event_attr *attr,
1163 struct parse_events_term *term,
1164 struct parse_events_error *err)
1166 if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER ||
1167 term->type_term == PARSE_EVENTS__TERM_TYPE_DRV_CFG)
1169 * Always succeed for sysfs terms, as we dont know
1170 * at this point what type they need to have.
1172 return 0;
1173 else
1174 return config_term_common(attr, term, err);
1177 static int config_term_tracepoint(struct perf_event_attr *attr,
1178 struct parse_events_term *term,
1179 struct parse_events_error *err)
1181 switch (term->type_term) {
1182 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1183 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1184 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1185 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1186 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1187 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1188 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1189 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1190 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1191 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1192 return config_term_common(attr, term, err);
1193 default:
1194 if (err) {
1195 parse_events__handle_error(err, term->err_term,
1196 strdup("unknown term"),
1197 strdup("valid terms: call-graph,stack-size\n"));
1199 return -EINVAL;
1202 return 0;
1205 static int config_attr(struct perf_event_attr *attr,
1206 struct list_head *head,
1207 struct parse_events_error *err,
1208 config_term_func_t config_term)
1210 struct parse_events_term *term;
1212 list_for_each_entry(term, head, list)
1213 if (config_term(attr, term, err))
1214 return -EINVAL;
1216 return 0;
1219 static int get_config_terms(struct list_head *head_config,
1220 struct list_head *head_terms __maybe_unused)
1222 #define ADD_CONFIG_TERM(__type, __name, __val) \
1223 do { \
1224 struct perf_evsel_config_term *__t; \
1226 __t = zalloc(sizeof(*__t)); \
1227 if (!__t) \
1228 return -ENOMEM; \
1230 INIT_LIST_HEAD(&__t->list); \
1231 __t->type = PERF_EVSEL__CONFIG_TERM_ ## __type; \
1232 __t->val.__name = __val; \
1233 __t->weak = term->weak; \
1234 list_add_tail(&__t->list, head_terms); \
1235 } while (0)
1237 struct parse_events_term *term;
1239 list_for_each_entry(term, head_config, list) {
1240 switch (term->type_term) {
1241 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1242 ADD_CONFIG_TERM(PERIOD, period, term->val.num);
1243 break;
1244 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1245 ADD_CONFIG_TERM(FREQ, freq, term->val.num);
1246 break;
1247 case PARSE_EVENTS__TERM_TYPE_TIME:
1248 ADD_CONFIG_TERM(TIME, time, term->val.num);
1249 break;
1250 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1251 ADD_CONFIG_TERM(CALLGRAPH, callgraph, term->val.str);
1252 break;
1253 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1254 ADD_CONFIG_TERM(BRANCH, branch, term->val.str);
1255 break;
1256 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1257 ADD_CONFIG_TERM(STACK_USER, stack_user, term->val.num);
1258 break;
1259 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1260 ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 1 : 0);
1261 break;
1262 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1263 ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 0 : 1);
1264 break;
1265 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1266 ADD_CONFIG_TERM(MAX_STACK, max_stack, term->val.num);
1267 break;
1268 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1269 ADD_CONFIG_TERM(MAX_EVENTS, max_events, term->val.num);
1270 break;
1271 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1272 ADD_CONFIG_TERM(OVERWRITE, overwrite, term->val.num ? 1 : 0);
1273 break;
1274 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1275 ADD_CONFIG_TERM(OVERWRITE, overwrite, term->val.num ? 0 : 1);
1276 break;
1277 case PARSE_EVENTS__TERM_TYPE_DRV_CFG:
1278 ADD_CONFIG_TERM(DRV_CFG, drv_cfg, term->val.str);
1279 break;
1280 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1281 ADD_CONFIG_TERM(PERCORE, percore,
1282 term->val.num ? true : false);
1283 break;
1284 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1285 ADD_CONFIG_TERM(AUX_OUTPUT, aux_output, term->val.num ? 1 : 0);
1286 break;
1287 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1288 ADD_CONFIG_TERM(AUX_SAMPLE_SIZE, aux_sample_size, term->val.num);
1289 break;
1290 default:
1291 break;
1294 return 0;
1298 * Add PERF_EVSEL__CONFIG_TERM_CFG_CHG where cfg_chg will have a bit set for
1299 * each bit of attr->config that the user has changed.
1301 static int get_config_chgs(struct perf_pmu *pmu, struct list_head *head_config,
1302 struct list_head *head_terms)
1304 struct parse_events_term *term;
1305 u64 bits = 0;
1306 int type;
1308 list_for_each_entry(term, head_config, list) {
1309 switch (term->type_term) {
1310 case PARSE_EVENTS__TERM_TYPE_USER:
1311 type = perf_pmu__format_type(&pmu->format, term->config);
1312 if (type != PERF_PMU_FORMAT_VALUE_CONFIG)
1313 continue;
1314 bits |= perf_pmu__format_bits(&pmu->format, term->config);
1315 break;
1316 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1317 bits = ~(u64)0;
1318 break;
1319 default:
1320 break;
1324 if (bits)
1325 ADD_CONFIG_TERM(CFG_CHG, cfg_chg, bits);
1327 #undef ADD_CONFIG_TERM
1328 return 0;
1331 int parse_events_add_tracepoint(struct list_head *list, int *idx,
1332 const char *sys, const char *event,
1333 struct parse_events_error *err,
1334 struct list_head *head_config)
1336 if (head_config) {
1337 struct perf_event_attr attr;
1339 if (config_attr(&attr, head_config, err,
1340 config_term_tracepoint))
1341 return -EINVAL;
1344 if (strpbrk(sys, "*?"))
1345 return add_tracepoint_multi_sys(list, idx, sys, event,
1346 err, head_config);
1347 else
1348 return add_tracepoint_event(list, idx, sys, event,
1349 err, head_config);
1352 int parse_events_add_numeric(struct parse_events_state *parse_state,
1353 struct list_head *list,
1354 u32 type, u64 config,
1355 struct list_head *head_config)
1357 struct perf_event_attr attr;
1358 LIST_HEAD(config_terms);
1360 memset(&attr, 0, sizeof(attr));
1361 attr.type = type;
1362 attr.config = config;
1364 if (head_config) {
1365 if (config_attr(&attr, head_config, parse_state->error,
1366 config_term_common))
1367 return -EINVAL;
1369 if (get_config_terms(head_config, &config_terms))
1370 return -ENOMEM;
1373 return add_event(list, &parse_state->idx, &attr,
1374 get_config_name(head_config), &config_terms);
1377 int parse_events_add_tool(struct parse_events_state *parse_state,
1378 struct list_head *list,
1379 enum perf_tool_event tool_event)
1381 return add_event_tool(list, &parse_state->idx, tool_event);
1384 static bool config_term_percore(struct list_head *config_terms)
1386 struct perf_evsel_config_term *term;
1388 list_for_each_entry(term, config_terms, list) {
1389 if (term->type == PERF_EVSEL__CONFIG_TERM_PERCORE)
1390 return term->val.percore;
1393 return false;
1396 int parse_events_add_pmu(struct parse_events_state *parse_state,
1397 struct list_head *list, char *name,
1398 struct list_head *head_config,
1399 bool auto_merge_stats,
1400 bool use_alias)
1402 struct perf_event_attr attr;
1403 struct perf_pmu_info info;
1404 struct perf_pmu *pmu;
1405 struct evsel *evsel;
1406 struct parse_events_error *err = parse_state->error;
1407 bool use_uncore_alias;
1408 LIST_HEAD(config_terms);
1410 pmu = perf_pmu__find(name);
1411 if (!pmu) {
1412 char *err_str;
1414 if (asprintf(&err_str,
1415 "Cannot find PMU `%s'. Missing kernel support?",
1416 name) >= 0)
1417 parse_events__handle_error(err, 0, err_str, NULL);
1418 return -EINVAL;
1421 if (pmu->default_config) {
1422 memcpy(&attr, pmu->default_config,
1423 sizeof(struct perf_event_attr));
1424 } else {
1425 memset(&attr, 0, sizeof(attr));
1428 use_uncore_alias = (pmu->is_uncore && use_alias);
1430 if (!head_config) {
1431 attr.type = pmu->type;
1432 evsel = __add_event(list, &parse_state->idx, &attr, NULL, pmu, NULL,
1433 auto_merge_stats, NULL);
1434 if (evsel) {
1435 evsel->pmu_name = name;
1436 evsel->use_uncore_alias = use_uncore_alias;
1437 return 0;
1438 } else {
1439 return -ENOMEM;
1443 if (perf_pmu__check_alias(pmu, head_config, &info))
1444 return -EINVAL;
1447 * Configure hardcoded terms first, no need to check
1448 * return value when called with fail == 0 ;)
1450 if (config_attr(&attr, head_config, parse_state->error, config_term_pmu))
1451 return -EINVAL;
1453 if (get_config_terms(head_config, &config_terms))
1454 return -ENOMEM;
1457 * When using default config, record which bits of attr->config were
1458 * changed by the user.
1460 if (pmu->default_config && get_config_chgs(pmu, head_config, &config_terms))
1461 return -ENOMEM;
1463 if (perf_pmu__config(pmu, &attr, head_config, parse_state->error)) {
1464 struct perf_evsel_config_term *pos, *tmp;
1466 list_for_each_entry_safe(pos, tmp, &config_terms, list) {
1467 list_del_init(&pos->list);
1468 free(pos);
1470 return -EINVAL;
1473 evsel = __add_event(list, &parse_state->idx, &attr,
1474 get_config_name(head_config), pmu,
1475 &config_terms, auto_merge_stats, NULL);
1476 if (evsel) {
1477 evsel->unit = info.unit;
1478 evsel->scale = info.scale;
1479 evsel->per_pkg = info.per_pkg;
1480 evsel->snapshot = info.snapshot;
1481 evsel->metric_expr = info.metric_expr;
1482 evsel->metric_name = info.metric_name;
1483 evsel->pmu_name = name;
1484 evsel->use_uncore_alias = use_uncore_alias;
1485 evsel->percore = config_term_percore(&evsel->config_terms);
1488 return evsel ? 0 : -ENOMEM;
1491 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
1492 char *str, struct list_head **listp)
1494 struct parse_events_term *term;
1495 struct list_head *list;
1496 struct perf_pmu *pmu = NULL;
1497 int ok = 0;
1499 *listp = NULL;
1500 /* Add it for all PMUs that support the alias */
1501 list = malloc(sizeof(struct list_head));
1502 if (!list)
1503 return -1;
1504 INIT_LIST_HEAD(list);
1505 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1506 struct perf_pmu_alias *alias;
1508 list_for_each_entry(alias, &pmu->aliases, list) {
1509 if (!strcasecmp(alias->name, str)) {
1510 struct list_head *head;
1511 char *config;
1513 head = malloc(sizeof(struct list_head));
1514 if (!head)
1515 return -1;
1516 INIT_LIST_HEAD(head);
1517 config = strdup(str);
1518 if (!config)
1519 return -1;
1520 if (parse_events_term__num(&term,
1521 PARSE_EVENTS__TERM_TYPE_USER,
1522 config, 1, false, &config,
1523 NULL) < 0) {
1524 free(list);
1525 free(config);
1526 return -1;
1528 list_add_tail(&term->list, head);
1530 if (!parse_events_add_pmu(parse_state, list,
1531 pmu->name, head,
1532 true, true)) {
1533 pr_debug("%s -> %s/%s/\n", config,
1534 pmu->name, alias->str);
1535 ok++;
1538 parse_events_terms__delete(head);
1542 if (!ok) {
1543 free(list);
1544 return -1;
1546 *listp = list;
1547 return 0;
1550 int parse_events__modifier_group(struct list_head *list,
1551 char *event_mod)
1553 return parse_events__modifier_event(list, event_mod, true);
1557 * Check if the two uncore PMUs are from the same uncore block
1558 * The format of the uncore PMU name is uncore_#blockname_#pmuidx
1560 static bool is_same_uncore_block(const char *pmu_name_a, const char *pmu_name_b)
1562 char *end_a, *end_b;
1564 end_a = strrchr(pmu_name_a, '_');
1565 end_b = strrchr(pmu_name_b, '_');
1567 if (!end_a || !end_b)
1568 return false;
1570 if ((end_a - pmu_name_a) != (end_b - pmu_name_b))
1571 return false;
1573 return (strncmp(pmu_name_a, pmu_name_b, end_a - pmu_name_a) == 0);
1576 static int
1577 parse_events__set_leader_for_uncore_aliase(char *name, struct list_head *list,
1578 struct parse_events_state *parse_state)
1580 struct evsel *evsel, *leader;
1581 uintptr_t *leaders;
1582 bool is_leader = true;
1583 int i, nr_pmu = 0, total_members, ret = 0;
1585 leader = list_first_entry(list, struct evsel, core.node);
1586 evsel = list_last_entry(list, struct evsel, core.node);
1587 total_members = evsel->idx - leader->idx + 1;
1589 leaders = calloc(total_members, sizeof(uintptr_t));
1590 if (WARN_ON(!leaders))
1591 return 0;
1594 * Going through the whole group and doing sanity check.
1595 * All members must use alias, and be from the same uncore block.
1596 * Also, storing the leader events in an array.
1598 __evlist__for_each_entry(list, evsel) {
1600 /* Only split the uncore group which members use alias */
1601 if (!evsel->use_uncore_alias)
1602 goto out;
1604 /* The events must be from the same uncore block */
1605 if (!is_same_uncore_block(leader->pmu_name, evsel->pmu_name))
1606 goto out;
1608 if (!is_leader)
1609 continue;
1611 * If the event's PMU name starts to repeat, it must be a new
1612 * event. That can be used to distinguish the leader from
1613 * other members, even they have the same event name.
1615 if ((leader != evsel) && (leader->pmu_name == evsel->pmu_name)) {
1616 is_leader = false;
1617 continue;
1619 /* The name is always alias name */
1620 WARN_ON(strcmp(leader->name, evsel->name));
1622 /* Store the leader event for each PMU */
1623 leaders[nr_pmu++] = (uintptr_t) evsel;
1626 /* only one event alias */
1627 if (nr_pmu == total_members) {
1628 parse_state->nr_groups--;
1629 goto handled;
1633 * An uncore event alias is a joint name which means the same event
1634 * runs on all PMUs of a block.
1635 * Perf doesn't support mixed events from different PMUs in the same
1636 * group. The big group has to be split into multiple small groups
1637 * which only include the events from the same PMU.
1639 * Here the uncore event aliases must be from the same uncore block.
1640 * The number of PMUs must be same for each alias. The number of new
1641 * small groups equals to the number of PMUs.
1642 * Setting the leader event for corresponding members in each group.
1644 i = 0;
1645 __evlist__for_each_entry(list, evsel) {
1646 if (i >= nr_pmu)
1647 i = 0;
1648 evsel->leader = (struct evsel *) leaders[i++];
1651 /* The number of members and group name are same for each group */
1652 for (i = 0; i < nr_pmu; i++) {
1653 evsel = (struct evsel *) leaders[i];
1654 evsel->core.nr_members = total_members / nr_pmu;
1655 evsel->group_name = name ? strdup(name) : NULL;
1658 /* Take the new small groups into account */
1659 parse_state->nr_groups += nr_pmu - 1;
1661 handled:
1662 ret = 1;
1663 out:
1664 free(leaders);
1665 return ret;
1668 void parse_events__set_leader(char *name, struct list_head *list,
1669 struct parse_events_state *parse_state)
1671 struct evsel *leader;
1673 if (list_empty(list)) {
1674 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1675 return;
1678 if (parse_events__set_leader_for_uncore_aliase(name, list, parse_state))
1679 return;
1681 __perf_evlist__set_leader(list);
1682 leader = list_entry(list->next, struct evsel, core.node);
1683 leader->group_name = name ? strdup(name) : NULL;
1686 /* list_event is assumed to point to malloc'ed memory */
1687 void parse_events_update_lists(struct list_head *list_event,
1688 struct list_head *list_all)
1691 * Called for single event definition. Update the
1692 * 'all event' list, and reinit the 'single event'
1693 * list, for next event definition.
1695 list_splice_tail(list_event, list_all);
1696 free(list_event);
1699 struct event_modifier {
1700 int eu;
1701 int ek;
1702 int eh;
1703 int eH;
1704 int eG;
1705 int eI;
1706 int precise;
1707 int precise_max;
1708 int exclude_GH;
1709 int sample_read;
1710 int pinned;
1711 int weak;
1714 static int get_event_modifier(struct event_modifier *mod, char *str,
1715 struct evsel *evsel)
1717 int eu = evsel ? evsel->core.attr.exclude_user : 0;
1718 int ek = evsel ? evsel->core.attr.exclude_kernel : 0;
1719 int eh = evsel ? evsel->core.attr.exclude_hv : 0;
1720 int eH = evsel ? evsel->core.attr.exclude_host : 0;
1721 int eG = evsel ? evsel->core.attr.exclude_guest : 0;
1722 int eI = evsel ? evsel->core.attr.exclude_idle : 0;
1723 int precise = evsel ? evsel->core.attr.precise_ip : 0;
1724 int precise_max = 0;
1725 int sample_read = 0;
1726 int pinned = evsel ? evsel->core.attr.pinned : 0;
1728 int exclude = eu | ek | eh;
1729 int exclude_GH = evsel ? evsel->exclude_GH : 0;
1730 int weak = 0;
1732 memset(mod, 0, sizeof(*mod));
1734 while (*str) {
1735 if (*str == 'u') {
1736 if (!exclude)
1737 exclude = eu = ek = eh = 1;
1738 eu = 0;
1739 } else if (*str == 'k') {
1740 if (!exclude)
1741 exclude = eu = ek = eh = 1;
1742 ek = 0;
1743 } else if (*str == 'h') {
1744 if (!exclude)
1745 exclude = eu = ek = eh = 1;
1746 eh = 0;
1747 } else if (*str == 'G') {
1748 if (!exclude_GH)
1749 exclude_GH = eG = eH = 1;
1750 eG = 0;
1751 } else if (*str == 'H') {
1752 if (!exclude_GH)
1753 exclude_GH = eG = eH = 1;
1754 eH = 0;
1755 } else if (*str == 'I') {
1756 eI = 1;
1757 } else if (*str == 'p') {
1758 precise++;
1759 /* use of precise requires exclude_guest */
1760 if (!exclude_GH)
1761 eG = 1;
1762 } else if (*str == 'P') {
1763 precise_max = 1;
1764 } else if (*str == 'S') {
1765 sample_read = 1;
1766 } else if (*str == 'D') {
1767 pinned = 1;
1768 } else if (*str == 'W') {
1769 weak = 1;
1770 } else
1771 break;
1773 ++str;
1777 * precise ip:
1779 * 0 - SAMPLE_IP can have arbitrary skid
1780 * 1 - SAMPLE_IP must have constant skid
1781 * 2 - SAMPLE_IP requested to have 0 skid
1782 * 3 - SAMPLE_IP must have 0 skid
1784 * See also PERF_RECORD_MISC_EXACT_IP
1786 if (precise > 3)
1787 return -EINVAL;
1789 mod->eu = eu;
1790 mod->ek = ek;
1791 mod->eh = eh;
1792 mod->eH = eH;
1793 mod->eG = eG;
1794 mod->eI = eI;
1795 mod->precise = precise;
1796 mod->precise_max = precise_max;
1797 mod->exclude_GH = exclude_GH;
1798 mod->sample_read = sample_read;
1799 mod->pinned = pinned;
1800 mod->weak = weak;
1802 return 0;
1806 * Basic modifier sanity check to validate it contains only one
1807 * instance of any modifier (apart from 'p') present.
1809 static int check_modifier(char *str)
1811 char *p = str;
1813 /* The sizeof includes 0 byte as well. */
1814 if (strlen(str) > (sizeof("ukhGHpppPSDIW") - 1))
1815 return -1;
1817 while (*p) {
1818 if (*p != 'p' && strchr(p + 1, *p))
1819 return -1;
1820 p++;
1823 return 0;
1826 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
1828 struct evsel *evsel;
1829 struct event_modifier mod;
1831 if (str == NULL)
1832 return 0;
1834 if (check_modifier(str))
1835 return -EINVAL;
1837 if (!add && get_event_modifier(&mod, str, NULL))
1838 return -EINVAL;
1840 __evlist__for_each_entry(list, evsel) {
1841 if (add && get_event_modifier(&mod, str, evsel))
1842 return -EINVAL;
1844 evsel->core.attr.exclude_user = mod.eu;
1845 evsel->core.attr.exclude_kernel = mod.ek;
1846 evsel->core.attr.exclude_hv = mod.eh;
1847 evsel->core.attr.precise_ip = mod.precise;
1848 evsel->core.attr.exclude_host = mod.eH;
1849 evsel->core.attr.exclude_guest = mod.eG;
1850 evsel->core.attr.exclude_idle = mod.eI;
1851 evsel->exclude_GH = mod.exclude_GH;
1852 evsel->sample_read = mod.sample_read;
1853 evsel->precise_max = mod.precise_max;
1854 evsel->weak_group = mod.weak;
1856 if (perf_evsel__is_group_leader(evsel))
1857 evsel->core.attr.pinned = mod.pinned;
1860 return 0;
1863 int parse_events_name(struct list_head *list, char *name)
1865 struct evsel *evsel;
1867 __evlist__for_each_entry(list, evsel) {
1868 if (!evsel->name)
1869 evsel->name = strdup(name);
1872 return 0;
1875 static int
1876 comp_pmu(const void *p1, const void *p2)
1878 struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
1879 struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
1881 return strcasecmp(pmu1->symbol, pmu2->symbol);
1884 static void perf_pmu__parse_cleanup(void)
1886 if (perf_pmu_events_list_num > 0) {
1887 struct perf_pmu_event_symbol *p;
1888 int i;
1890 for (i = 0; i < perf_pmu_events_list_num; i++) {
1891 p = perf_pmu_events_list + i;
1892 zfree(&p->symbol);
1894 zfree(&perf_pmu_events_list);
1895 perf_pmu_events_list_num = 0;
1899 #define SET_SYMBOL(str, stype) \
1900 do { \
1901 p->symbol = str; \
1902 if (!p->symbol) \
1903 goto err; \
1904 p->type = stype; \
1905 } while (0)
1908 * Read the pmu events list from sysfs
1909 * Save it into perf_pmu_events_list
1911 static void perf_pmu__parse_init(void)
1914 struct perf_pmu *pmu = NULL;
1915 struct perf_pmu_alias *alias;
1916 int len = 0;
1918 pmu = NULL;
1919 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1920 list_for_each_entry(alias, &pmu->aliases, list) {
1921 if (strchr(alias->name, '-'))
1922 len++;
1923 len++;
1927 if (len == 0) {
1928 perf_pmu_events_list_num = -1;
1929 return;
1931 perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
1932 if (!perf_pmu_events_list)
1933 return;
1934 perf_pmu_events_list_num = len;
1936 len = 0;
1937 pmu = NULL;
1938 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1939 list_for_each_entry(alias, &pmu->aliases, list) {
1940 struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
1941 char *tmp = strchr(alias->name, '-');
1943 if (tmp != NULL) {
1944 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
1945 PMU_EVENT_SYMBOL_PREFIX);
1946 p++;
1947 SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
1948 len += 2;
1949 } else {
1950 SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
1951 len++;
1955 qsort(perf_pmu_events_list, len,
1956 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1958 return;
1959 err:
1960 perf_pmu__parse_cleanup();
1963 enum perf_pmu_event_symbol_type
1964 perf_pmu__parse_check(const char *name)
1966 struct perf_pmu_event_symbol p, *r;
1968 /* scan kernel pmu events from sysfs if needed */
1969 if (perf_pmu_events_list_num == 0)
1970 perf_pmu__parse_init();
1972 * name "cpu" could be prefix of cpu-cycles or cpu// events.
1973 * cpu-cycles has been handled by hardcode.
1974 * So it must be cpu// events, not kernel pmu event.
1976 if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
1977 return PMU_EVENT_SYMBOL_ERR;
1979 p.symbol = strdup(name);
1980 r = bsearch(&p, perf_pmu_events_list,
1981 (size_t) perf_pmu_events_list_num,
1982 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1983 zfree(&p.symbol);
1984 return r ? r->type : PMU_EVENT_SYMBOL_ERR;
1987 static int parse_events__scanner(const char *str, void *parse_state, int start_token)
1989 YY_BUFFER_STATE buffer;
1990 void *scanner;
1991 int ret;
1993 ret = parse_events_lex_init_extra(start_token, &scanner);
1994 if (ret)
1995 return ret;
1997 buffer = parse_events__scan_string(str, scanner);
1999 #ifdef PARSER_DEBUG
2000 parse_events_debug = 1;
2001 #endif
2002 ret = parse_events_parse(parse_state, scanner);
2004 parse_events__flush_buffer(buffer, scanner);
2005 parse_events__delete_buffer(buffer, scanner);
2006 parse_events_lex_destroy(scanner);
2007 return ret;
2011 * parse event config string, return a list of event terms.
2013 int parse_events_terms(struct list_head *terms, const char *str)
2015 struct parse_events_state parse_state = {
2016 .terms = NULL,
2018 int ret;
2020 ret = parse_events__scanner(str, &parse_state, PE_START_TERMS);
2021 if (!ret) {
2022 list_splice(parse_state.terms, terms);
2023 zfree(&parse_state.terms);
2024 return 0;
2027 parse_events_terms__delete(parse_state.terms);
2028 return ret;
2031 int parse_events(struct evlist *evlist, const char *str,
2032 struct parse_events_error *err)
2034 struct parse_events_state parse_state = {
2035 .list = LIST_HEAD_INIT(parse_state.list),
2036 .idx = evlist->core.nr_entries,
2037 .error = err,
2038 .evlist = evlist,
2040 int ret;
2042 ret = parse_events__scanner(str, &parse_state, PE_START_EVENTS);
2043 perf_pmu__parse_cleanup();
2045 if (!ret && list_empty(&parse_state.list)) {
2046 WARN_ONCE(true, "WARNING: event parser found nothing\n");
2047 return -1;
2051 * Add list to the evlist even with errors to allow callers to clean up.
2053 perf_evlist__splice_list_tail(evlist, &parse_state.list);
2055 if (!ret) {
2056 struct evsel *last;
2058 evlist->nr_groups += parse_state.nr_groups;
2059 last = evlist__last(evlist);
2060 last->cmdline_group_boundary = true;
2062 return 0;
2066 * There are 2 users - builtin-record and builtin-test objects.
2067 * Both call evlist__delete in case of error, so we dont
2068 * need to bother.
2070 return ret;
2073 #define MAX_WIDTH 1000
2074 static int get_term_width(void)
2076 struct winsize ws;
2078 get_term_dimensions(&ws);
2079 return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
2082 static void __parse_events_print_error(int err_idx, const char *err_str,
2083 const char *err_help, const char *event)
2085 const char *str = "invalid or unsupported event: ";
2086 char _buf[MAX_WIDTH];
2087 char *buf = (char *) event;
2088 int idx = 0;
2089 if (err_str) {
2090 /* -2 for extra '' in the final fprintf */
2091 int width = get_term_width() - 2;
2092 int len_event = strlen(event);
2093 int len_str, max_len, cut = 0;
2096 * Maximum error index indent, we will cut
2097 * the event string if it's bigger.
2099 int max_err_idx = 13;
2102 * Let's be specific with the message when
2103 * we have the precise error.
2105 str = "event syntax error: ";
2106 len_str = strlen(str);
2107 max_len = width - len_str;
2109 buf = _buf;
2111 /* We're cutting from the beginning. */
2112 if (err_idx > max_err_idx)
2113 cut = err_idx - max_err_idx;
2115 strncpy(buf, event + cut, max_len);
2117 /* Mark cut parts with '..' on both sides. */
2118 if (cut)
2119 buf[0] = buf[1] = '.';
2121 if ((len_event - cut) > max_len) {
2122 buf[max_len - 1] = buf[max_len - 2] = '.';
2123 buf[max_len] = 0;
2126 idx = len_str + err_idx - cut;
2129 fprintf(stderr, "%s'%s'\n", str, buf);
2130 if (idx) {
2131 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err_str);
2132 if (err_help)
2133 fprintf(stderr, "\n%s\n", err_help);
2137 void parse_events_print_error(struct parse_events_error *err,
2138 const char *event)
2140 if (!err->num_errors)
2141 return;
2143 __parse_events_print_error(err->idx, err->str, err->help, event);
2144 zfree(&err->str);
2145 zfree(&err->help);
2147 if (err->num_errors > 1) {
2148 fputs("\nInitial error:\n", stderr);
2149 __parse_events_print_error(err->first_idx, err->first_str,
2150 err->first_help, event);
2151 zfree(&err->first_str);
2152 zfree(&err->first_help);
2156 #undef MAX_WIDTH
2158 int parse_events_option(const struct option *opt, const char *str,
2159 int unset __maybe_unused)
2161 struct evlist *evlist = *(struct evlist **)opt->value;
2162 struct parse_events_error err;
2163 int ret;
2165 bzero(&err, sizeof(err));
2166 ret = parse_events(evlist, str, &err);
2168 if (ret) {
2169 parse_events_print_error(&err, str);
2170 fprintf(stderr, "Run 'perf list' for a list of valid events\n");
2173 return ret;
2176 static int
2177 foreach_evsel_in_last_glob(struct evlist *evlist,
2178 int (*func)(struct evsel *evsel,
2179 const void *arg),
2180 const void *arg)
2182 struct evsel *last = NULL;
2183 int err;
2186 * Don't return when list_empty, give func a chance to report
2187 * error when it found last == NULL.
2189 * So no need to WARN here, let *func do this.
2191 if (evlist->core.nr_entries > 0)
2192 last = evlist__last(evlist);
2194 do {
2195 err = (*func)(last, arg);
2196 if (err)
2197 return -1;
2198 if (!last)
2199 return 0;
2201 if (last->core.node.prev == &evlist->core.entries)
2202 return 0;
2203 last = list_entry(last->core.node.prev, struct evsel, core.node);
2204 } while (!last->cmdline_group_boundary);
2206 return 0;
2209 static int set_filter(struct evsel *evsel, const void *arg)
2211 const char *str = arg;
2212 bool found = false;
2213 int nr_addr_filters = 0;
2214 struct perf_pmu *pmu = NULL;
2216 if (evsel == NULL) {
2217 fprintf(stderr,
2218 "--filter option should follow a -e tracepoint or HW tracer option\n");
2219 return -1;
2222 if (evsel->core.attr.type == PERF_TYPE_TRACEPOINT) {
2223 if (perf_evsel__append_tp_filter(evsel, str) < 0) {
2224 fprintf(stderr,
2225 "not enough memory to hold filter string\n");
2226 return -1;
2229 return 0;
2232 while ((pmu = perf_pmu__scan(pmu)) != NULL)
2233 if (pmu->type == evsel->core.attr.type) {
2234 found = true;
2235 break;
2238 if (found)
2239 perf_pmu__scan_file(pmu, "nr_addr_filters",
2240 "%d", &nr_addr_filters);
2242 if (!nr_addr_filters) {
2243 fprintf(stderr,
2244 "This CPU does not support address filtering\n");
2245 return -1;
2248 if (perf_evsel__append_addr_filter(evsel, str) < 0) {
2249 fprintf(stderr,
2250 "not enough memory to hold filter string\n");
2251 return -1;
2254 return 0;
2257 int parse_filter(const struct option *opt, const char *str,
2258 int unset __maybe_unused)
2260 struct evlist *evlist = *(struct evlist **)opt->value;
2262 return foreach_evsel_in_last_glob(evlist, set_filter,
2263 (const void *)str);
2266 static int add_exclude_perf_filter(struct evsel *evsel,
2267 const void *arg __maybe_unused)
2269 char new_filter[64];
2271 if (evsel == NULL || evsel->core.attr.type != PERF_TYPE_TRACEPOINT) {
2272 fprintf(stderr,
2273 "--exclude-perf option should follow a -e tracepoint option\n");
2274 return -1;
2277 snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
2279 if (perf_evsel__append_tp_filter(evsel, new_filter) < 0) {
2280 fprintf(stderr,
2281 "not enough memory to hold filter string\n");
2282 return -1;
2285 return 0;
2288 int exclude_perf(const struct option *opt,
2289 const char *arg __maybe_unused,
2290 int unset __maybe_unused)
2292 struct evlist *evlist = *(struct evlist **)opt->value;
2294 return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
2295 NULL);
2298 static const char * const event_type_descriptors[] = {
2299 "Hardware event",
2300 "Software event",
2301 "Tracepoint event",
2302 "Hardware cache event",
2303 "Raw hardware event descriptor",
2304 "Hardware breakpoint",
2307 static int cmp_string(const void *a, const void *b)
2309 const char * const *as = a;
2310 const char * const *bs = b;
2312 return strcmp(*as, *bs);
2316 * Print the events from <debugfs_mount_point>/tracing/events
2319 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
2320 bool name_only)
2322 DIR *sys_dir, *evt_dir;
2323 struct dirent *sys_dirent, *evt_dirent;
2324 char evt_path[MAXPATHLEN];
2325 char *dir_path;
2326 char **evt_list = NULL;
2327 unsigned int evt_i = 0, evt_num = 0;
2328 bool evt_num_known = false;
2330 restart:
2331 sys_dir = tracing_events__opendir();
2332 if (!sys_dir)
2333 return;
2335 if (evt_num_known) {
2336 evt_list = zalloc(sizeof(char *) * evt_num);
2337 if (!evt_list)
2338 goto out_close_sys_dir;
2341 for_each_subsystem(sys_dir, sys_dirent) {
2342 if (subsys_glob != NULL &&
2343 !strglobmatch(sys_dirent->d_name, subsys_glob))
2344 continue;
2346 dir_path = get_events_file(sys_dirent->d_name);
2347 if (!dir_path)
2348 continue;
2349 evt_dir = opendir(dir_path);
2350 if (!evt_dir)
2351 goto next;
2353 for_each_event(dir_path, evt_dir, evt_dirent) {
2354 if (event_glob != NULL &&
2355 !strglobmatch(evt_dirent->d_name, event_glob))
2356 continue;
2358 if (!evt_num_known) {
2359 evt_num++;
2360 continue;
2363 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2364 sys_dirent->d_name, evt_dirent->d_name);
2366 evt_list[evt_i] = strdup(evt_path);
2367 if (evt_list[evt_i] == NULL) {
2368 put_events_file(dir_path);
2369 goto out_close_evt_dir;
2371 evt_i++;
2373 closedir(evt_dir);
2374 next:
2375 put_events_file(dir_path);
2377 closedir(sys_dir);
2379 if (!evt_num_known) {
2380 evt_num_known = true;
2381 goto restart;
2383 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2384 evt_i = 0;
2385 while (evt_i < evt_num) {
2386 if (name_only) {
2387 printf("%s ", evt_list[evt_i++]);
2388 continue;
2390 printf(" %-50s [%s]\n", evt_list[evt_i++],
2391 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2393 if (evt_num && pager_in_use())
2394 printf("\n");
2396 out_free:
2397 evt_num = evt_i;
2398 for (evt_i = 0; evt_i < evt_num; evt_i++)
2399 zfree(&evt_list[evt_i]);
2400 zfree(&evt_list);
2401 return;
2403 out_close_evt_dir:
2404 closedir(evt_dir);
2405 out_close_sys_dir:
2406 closedir(sys_dir);
2408 printf("FATAL: not enough memory to print %s\n",
2409 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2410 if (evt_list)
2411 goto out_free;
2415 * Check whether event is in <debugfs_mount_point>/tracing/events
2418 int is_valid_tracepoint(const char *event_string)
2420 DIR *sys_dir, *evt_dir;
2421 struct dirent *sys_dirent, *evt_dirent;
2422 char evt_path[MAXPATHLEN];
2423 char *dir_path;
2425 sys_dir = tracing_events__opendir();
2426 if (!sys_dir)
2427 return 0;
2429 for_each_subsystem(sys_dir, sys_dirent) {
2430 dir_path = get_events_file(sys_dirent->d_name);
2431 if (!dir_path)
2432 continue;
2433 evt_dir = opendir(dir_path);
2434 if (!evt_dir)
2435 goto next;
2437 for_each_event(dir_path, evt_dir, evt_dirent) {
2438 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2439 sys_dirent->d_name, evt_dirent->d_name);
2440 if (!strcmp(evt_path, event_string)) {
2441 closedir(evt_dir);
2442 closedir(sys_dir);
2443 return 1;
2446 closedir(evt_dir);
2447 next:
2448 put_events_file(dir_path);
2450 closedir(sys_dir);
2451 return 0;
2454 static bool is_event_supported(u8 type, unsigned config)
2456 bool ret = true;
2457 int open_return;
2458 struct evsel *evsel;
2459 struct perf_event_attr attr = {
2460 .type = type,
2461 .config = config,
2462 .disabled = 1,
2464 struct perf_thread_map *tmap = thread_map__new_by_tid(0);
2466 if (tmap == NULL)
2467 return false;
2469 evsel = evsel__new(&attr);
2470 if (evsel) {
2471 open_return = evsel__open(evsel, NULL, tmap);
2472 ret = open_return >= 0;
2474 if (open_return == -EACCES) {
2476 * This happens if the paranoid value
2477 * /proc/sys/kernel/perf_event_paranoid is set to 2
2478 * Re-run with exclude_kernel set; we don't do that
2479 * by default as some ARM machines do not support it.
2482 evsel->core.attr.exclude_kernel = 1;
2483 ret = evsel__open(evsel, NULL, tmap) >= 0;
2485 evsel__delete(evsel);
2488 perf_thread_map__put(tmap);
2489 return ret;
2492 void print_sdt_events(const char *subsys_glob, const char *event_glob,
2493 bool name_only)
2495 struct probe_cache *pcache;
2496 struct probe_cache_entry *ent;
2497 struct strlist *bidlist, *sdtlist;
2498 struct strlist_config cfg = {.dont_dupstr = true};
2499 struct str_node *nd, *nd2;
2500 char *buf, *path, *ptr = NULL;
2501 bool show_detail = false;
2502 int ret;
2504 sdtlist = strlist__new(NULL, &cfg);
2505 if (!sdtlist) {
2506 pr_debug("Failed to allocate new strlist for SDT\n");
2507 return;
2509 bidlist = build_id_cache__list_all(true);
2510 if (!bidlist) {
2511 pr_debug("Failed to get buildids: %d\n", errno);
2512 return;
2514 strlist__for_each_entry(nd, bidlist) {
2515 pcache = probe_cache__new(nd->s, NULL);
2516 if (!pcache)
2517 continue;
2518 list_for_each_entry(ent, &pcache->entries, node) {
2519 if (!ent->sdt)
2520 continue;
2521 if (subsys_glob &&
2522 !strglobmatch(ent->pev.group, subsys_glob))
2523 continue;
2524 if (event_glob &&
2525 !strglobmatch(ent->pev.event, event_glob))
2526 continue;
2527 ret = asprintf(&buf, "%s:%s@%s", ent->pev.group,
2528 ent->pev.event, nd->s);
2529 if (ret > 0)
2530 strlist__add(sdtlist, buf);
2532 probe_cache__delete(pcache);
2534 strlist__delete(bidlist);
2536 strlist__for_each_entry(nd, sdtlist) {
2537 buf = strchr(nd->s, '@');
2538 if (buf)
2539 *(buf++) = '\0';
2540 if (name_only) {
2541 printf("%s ", nd->s);
2542 continue;
2544 nd2 = strlist__next(nd);
2545 if (nd2) {
2546 ptr = strchr(nd2->s, '@');
2547 if (ptr)
2548 *ptr = '\0';
2549 if (strcmp(nd->s, nd2->s) == 0)
2550 show_detail = true;
2552 if (show_detail) {
2553 path = build_id_cache__origname(buf);
2554 ret = asprintf(&buf, "%s@%s(%.12s)", nd->s, path, buf);
2555 if (ret > 0) {
2556 printf(" %-50s [%s]\n", buf, "SDT event");
2557 free(buf);
2559 free(path);
2560 } else
2561 printf(" %-50s [%s]\n", nd->s, "SDT event");
2562 if (nd2) {
2563 if (strcmp(nd->s, nd2->s) != 0)
2564 show_detail = false;
2565 if (ptr)
2566 *ptr = '@';
2569 strlist__delete(sdtlist);
2572 int print_hwcache_events(const char *event_glob, bool name_only)
2574 unsigned int type, op, i, evt_i = 0, evt_num = 0;
2575 char name[64];
2576 char **evt_list = NULL;
2577 bool evt_num_known = false;
2579 restart:
2580 if (evt_num_known) {
2581 evt_list = zalloc(sizeof(char *) * evt_num);
2582 if (!evt_list)
2583 goto out_enomem;
2586 for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
2587 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
2588 /* skip invalid cache type */
2589 if (!perf_evsel__is_cache_op_valid(type, op))
2590 continue;
2592 for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
2593 __perf_evsel__hw_cache_type_op_res_name(type, op, i,
2594 name, sizeof(name));
2595 if (event_glob != NULL && !strglobmatch(name, event_glob))
2596 continue;
2598 if (!is_event_supported(PERF_TYPE_HW_CACHE,
2599 type | (op << 8) | (i << 16)))
2600 continue;
2602 if (!evt_num_known) {
2603 evt_num++;
2604 continue;
2607 evt_list[evt_i] = strdup(name);
2608 if (evt_list[evt_i] == NULL)
2609 goto out_enomem;
2610 evt_i++;
2615 if (!evt_num_known) {
2616 evt_num_known = true;
2617 goto restart;
2619 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2620 evt_i = 0;
2621 while (evt_i < evt_num) {
2622 if (name_only) {
2623 printf("%s ", evt_list[evt_i++]);
2624 continue;
2626 printf(" %-50s [%s]\n", evt_list[evt_i++],
2627 event_type_descriptors[PERF_TYPE_HW_CACHE]);
2629 if (evt_num && pager_in_use())
2630 printf("\n");
2632 out_free:
2633 evt_num = evt_i;
2634 for (evt_i = 0; evt_i < evt_num; evt_i++)
2635 zfree(&evt_list[evt_i]);
2636 zfree(&evt_list);
2637 return evt_num;
2639 out_enomem:
2640 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
2641 if (evt_list)
2642 goto out_free;
2643 return evt_num;
2646 static void print_tool_event(const char *name, const char *event_glob,
2647 bool name_only)
2649 if (event_glob && !strglobmatch(name, event_glob))
2650 return;
2651 if (name_only)
2652 printf("%s ", name);
2653 else
2654 printf(" %-50s [%s]\n", name, "Tool event");
2658 void print_tool_events(const char *event_glob, bool name_only)
2660 print_tool_event("duration_time", event_glob, name_only);
2661 if (pager_in_use())
2662 printf("\n");
2665 void print_symbol_events(const char *event_glob, unsigned type,
2666 struct event_symbol *syms, unsigned max,
2667 bool name_only)
2669 unsigned int i, evt_i = 0, evt_num = 0;
2670 char name[MAX_NAME_LEN];
2671 char **evt_list = NULL;
2672 bool evt_num_known = false;
2674 restart:
2675 if (evt_num_known) {
2676 evt_list = zalloc(sizeof(char *) * evt_num);
2677 if (!evt_list)
2678 goto out_enomem;
2679 syms -= max;
2682 for (i = 0; i < max; i++, syms++) {
2684 if (event_glob != NULL && syms->symbol != NULL &&
2685 !(strglobmatch(syms->symbol, event_glob) ||
2686 (syms->alias && strglobmatch(syms->alias, event_glob))))
2687 continue;
2689 if (!is_event_supported(type, i))
2690 continue;
2692 if (!evt_num_known) {
2693 evt_num++;
2694 continue;
2697 if (!name_only && strlen(syms->alias))
2698 snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
2699 else
2700 strlcpy(name, syms->symbol, MAX_NAME_LEN);
2702 evt_list[evt_i] = strdup(name);
2703 if (evt_list[evt_i] == NULL)
2704 goto out_enomem;
2705 evt_i++;
2708 if (!evt_num_known) {
2709 evt_num_known = true;
2710 goto restart;
2712 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2713 evt_i = 0;
2714 while (evt_i < evt_num) {
2715 if (name_only) {
2716 printf("%s ", evt_list[evt_i++]);
2717 continue;
2719 printf(" %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
2721 if (evt_num && pager_in_use())
2722 printf("\n");
2724 out_free:
2725 evt_num = evt_i;
2726 for (evt_i = 0; evt_i < evt_num; evt_i++)
2727 zfree(&evt_list[evt_i]);
2728 zfree(&evt_list);
2729 return;
2731 out_enomem:
2732 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
2733 if (evt_list)
2734 goto out_free;
2738 * Print the help text for the event symbols:
2740 void print_events(const char *event_glob, bool name_only, bool quiet_flag,
2741 bool long_desc, bool details_flag, bool deprecated)
2743 print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
2744 event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
2746 print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
2747 event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
2748 print_tool_events(event_glob, name_only);
2750 print_hwcache_events(event_glob, name_only);
2752 print_pmu_events(event_glob, name_only, quiet_flag, long_desc,
2753 details_flag, deprecated);
2755 if (event_glob != NULL)
2756 return;
2758 if (!name_only) {
2759 printf(" %-50s [%s]\n",
2760 "rNNN",
2761 event_type_descriptors[PERF_TYPE_RAW]);
2762 printf(" %-50s [%s]\n",
2763 "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
2764 event_type_descriptors[PERF_TYPE_RAW]);
2765 if (pager_in_use())
2766 printf(" (see 'man perf-list' on how to encode it)\n\n");
2768 printf(" %-50s [%s]\n",
2769 "mem:<addr>[/len][:access]",
2770 event_type_descriptors[PERF_TYPE_BREAKPOINT]);
2771 if (pager_in_use())
2772 printf("\n");
2775 print_tracepoint_events(NULL, NULL, name_only);
2777 print_sdt_events(NULL, NULL, name_only);
2779 metricgroup__print(true, true, NULL, name_only, details_flag);
2782 int parse_events__is_hardcoded_term(struct parse_events_term *term)
2784 return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
2787 static int new_term(struct parse_events_term **_term,
2788 struct parse_events_term *temp,
2789 char *str, u64 num)
2791 struct parse_events_term *term;
2793 term = malloc(sizeof(*term));
2794 if (!term)
2795 return -ENOMEM;
2797 *term = *temp;
2798 INIT_LIST_HEAD(&term->list);
2799 term->weak = false;
2801 switch (term->type_val) {
2802 case PARSE_EVENTS__TERM_TYPE_NUM:
2803 term->val.num = num;
2804 break;
2805 case PARSE_EVENTS__TERM_TYPE_STR:
2806 term->val.str = str;
2807 break;
2808 default:
2809 free(term);
2810 return -EINVAL;
2813 *_term = term;
2814 return 0;
2817 int parse_events_term__num(struct parse_events_term **term,
2818 int type_term, char *config, u64 num,
2819 bool no_value,
2820 void *loc_term_, void *loc_val_)
2822 YYLTYPE *loc_term = loc_term_;
2823 YYLTYPE *loc_val = loc_val_;
2825 struct parse_events_term temp = {
2826 .type_val = PARSE_EVENTS__TERM_TYPE_NUM,
2827 .type_term = type_term,
2828 .config = config,
2829 .no_value = no_value,
2830 .err_term = loc_term ? loc_term->first_column : 0,
2831 .err_val = loc_val ? loc_val->first_column : 0,
2834 return new_term(term, &temp, NULL, num);
2837 int parse_events_term__str(struct parse_events_term **term,
2838 int type_term, char *config, char *str,
2839 void *loc_term_, void *loc_val_)
2841 YYLTYPE *loc_term = loc_term_;
2842 YYLTYPE *loc_val = loc_val_;
2844 struct parse_events_term temp = {
2845 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2846 .type_term = type_term,
2847 .config = config,
2848 .err_term = loc_term ? loc_term->first_column : 0,
2849 .err_val = loc_val ? loc_val->first_column : 0,
2852 return new_term(term, &temp, str, 0);
2855 int parse_events_term__sym_hw(struct parse_events_term **term,
2856 char *config, unsigned idx)
2858 struct event_symbol *sym;
2859 char *str;
2860 struct parse_events_term temp = {
2861 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2862 .type_term = PARSE_EVENTS__TERM_TYPE_USER,
2863 .config = config,
2866 if (!temp.config) {
2867 temp.config = strdup("event");
2868 if (!temp.config)
2869 return -ENOMEM;
2871 BUG_ON(idx >= PERF_COUNT_HW_MAX);
2872 sym = &event_symbols_hw[idx];
2874 str = strdup(sym->symbol);
2875 if (!str)
2876 return -ENOMEM;
2877 return new_term(term, &temp, str, 0);
2880 int parse_events_term__clone(struct parse_events_term **new,
2881 struct parse_events_term *term)
2883 char *str;
2884 struct parse_events_term temp = {
2885 .type_val = term->type_val,
2886 .type_term = term->type_term,
2887 .config = NULL,
2888 .err_term = term->err_term,
2889 .err_val = term->err_val,
2892 if (term->config) {
2893 temp.config = strdup(term->config);
2894 if (!temp.config)
2895 return -ENOMEM;
2897 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
2898 return new_term(new, &temp, NULL, term->val.num);
2900 str = strdup(term->val.str);
2901 if (!str)
2902 return -ENOMEM;
2903 return new_term(new, &temp, str, 0);
2906 void parse_events_term__delete(struct parse_events_term *term)
2908 if (term->array.nr_ranges)
2909 zfree(&term->array.ranges);
2911 if (term->type_val != PARSE_EVENTS__TERM_TYPE_NUM)
2912 zfree(&term->val.str);
2914 zfree(&term->config);
2915 free(term);
2918 int parse_events_copy_term_list(struct list_head *old,
2919 struct list_head **new)
2921 struct parse_events_term *term, *n;
2922 int ret;
2924 if (!old) {
2925 *new = NULL;
2926 return 0;
2929 *new = malloc(sizeof(struct list_head));
2930 if (!*new)
2931 return -ENOMEM;
2932 INIT_LIST_HEAD(*new);
2934 list_for_each_entry (term, old, list) {
2935 ret = parse_events_term__clone(&n, term);
2936 if (ret)
2937 return ret;
2938 list_add_tail(&n->list, *new);
2940 return 0;
2943 void parse_events_terms__purge(struct list_head *terms)
2945 struct parse_events_term *term, *h;
2947 list_for_each_entry_safe(term, h, terms, list) {
2948 list_del_init(&term->list);
2949 parse_events_term__delete(term);
2953 void parse_events_terms__delete(struct list_head *terms)
2955 if (!terms)
2956 return;
2957 parse_events_terms__purge(terms);
2958 free(terms);
2961 void parse_events__clear_array(struct parse_events_array *a)
2963 zfree(&a->ranges);
2966 void parse_events_evlist_error(struct parse_events_state *parse_state,
2967 int idx, const char *str)
2969 if (!parse_state->error)
2970 return;
2972 parse_events__handle_error(parse_state->error, idx, strdup(str), NULL);
2975 static void config_terms_list(char *buf, size_t buf_sz)
2977 int i;
2978 bool first = true;
2980 buf[0] = '\0';
2981 for (i = 0; i < __PARSE_EVENTS__TERM_TYPE_NR; i++) {
2982 const char *name = config_term_names[i];
2984 if (!config_term_avail(i, NULL))
2985 continue;
2986 if (!name)
2987 continue;
2988 if (name[0] == '<')
2989 continue;
2991 if (strlen(buf) + strlen(name) + 2 >= buf_sz)
2992 return;
2994 if (!first)
2995 strcat(buf, ",");
2996 else
2997 first = false;
2998 strcat(buf, name);
3003 * Return string contains valid config terms of an event.
3004 * @additional_terms: For terms such as PMU sysfs terms.
3006 char *parse_events_formats_error_string(char *additional_terms)
3008 char *str;
3009 /* "no-overwrite" is the longest name */
3010 char static_terms[__PARSE_EVENTS__TERM_TYPE_NR *
3011 (sizeof("no-overwrite") - 1)];
3013 config_terms_list(static_terms, sizeof(static_terms));
3014 /* valid terms */
3015 if (additional_terms) {
3016 if (asprintf(&str, "valid terms: %s,%s",
3017 additional_terms, static_terms) < 0)
3018 goto fail;
3019 } else {
3020 if (asprintf(&str, "valid terms: %s", static_terms) < 0)
3021 goto fail;
3023 return str;
3025 fail:
3026 return NULL;