Merge tag 'block-5.9-2020-08-14' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / tools / perf / util / parse-events.c
blob9f7260e691134ef6a1f696d515c768e42d6c7e9d
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 void*
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"
39 #include "util/pfm.h"
41 #define MAX_NAME_LEN 100
43 #ifdef PARSER_DEBUG
44 extern int parse_events_debug;
45 #endif
46 int parse_events_parse(void *parse_state, void *scanner);
47 static int get_config_terms(struct list_head *head_config,
48 struct list_head *head_terms __maybe_unused);
50 static struct perf_pmu_event_symbol *perf_pmu_events_list;
52 * The variable indicates the number of supported pmu event symbols.
53 * 0 means not initialized and ready to init
54 * -1 means failed to init, don't try anymore
55 * >0 is the number of supported pmu event symbols
57 static int perf_pmu_events_list_num;
59 struct event_symbol event_symbols_hw[PERF_COUNT_HW_MAX] = {
60 [PERF_COUNT_HW_CPU_CYCLES] = {
61 .symbol = "cpu-cycles",
62 .alias = "cycles",
64 [PERF_COUNT_HW_INSTRUCTIONS] = {
65 .symbol = "instructions",
66 .alias = "",
68 [PERF_COUNT_HW_CACHE_REFERENCES] = {
69 .symbol = "cache-references",
70 .alias = "",
72 [PERF_COUNT_HW_CACHE_MISSES] = {
73 .symbol = "cache-misses",
74 .alias = "",
76 [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
77 .symbol = "branch-instructions",
78 .alias = "branches",
80 [PERF_COUNT_HW_BRANCH_MISSES] = {
81 .symbol = "branch-misses",
82 .alias = "",
84 [PERF_COUNT_HW_BUS_CYCLES] = {
85 .symbol = "bus-cycles",
86 .alias = "",
88 [PERF_COUNT_HW_STALLED_CYCLES_FRONTEND] = {
89 .symbol = "stalled-cycles-frontend",
90 .alias = "idle-cycles-frontend",
92 [PERF_COUNT_HW_STALLED_CYCLES_BACKEND] = {
93 .symbol = "stalled-cycles-backend",
94 .alias = "idle-cycles-backend",
96 [PERF_COUNT_HW_REF_CPU_CYCLES] = {
97 .symbol = "ref-cycles",
98 .alias = "",
102 struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
103 [PERF_COUNT_SW_CPU_CLOCK] = {
104 .symbol = "cpu-clock",
105 .alias = "",
107 [PERF_COUNT_SW_TASK_CLOCK] = {
108 .symbol = "task-clock",
109 .alias = "",
111 [PERF_COUNT_SW_PAGE_FAULTS] = {
112 .symbol = "page-faults",
113 .alias = "faults",
115 [PERF_COUNT_SW_CONTEXT_SWITCHES] = {
116 .symbol = "context-switches",
117 .alias = "cs",
119 [PERF_COUNT_SW_CPU_MIGRATIONS] = {
120 .symbol = "cpu-migrations",
121 .alias = "migrations",
123 [PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
124 .symbol = "minor-faults",
125 .alias = "",
127 [PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
128 .symbol = "major-faults",
129 .alias = "",
131 [PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
132 .symbol = "alignment-faults",
133 .alias = "",
135 [PERF_COUNT_SW_EMULATION_FAULTS] = {
136 .symbol = "emulation-faults",
137 .alias = "",
139 [PERF_COUNT_SW_DUMMY] = {
140 .symbol = "dummy",
141 .alias = "",
143 [PERF_COUNT_SW_BPF_OUTPUT] = {
144 .symbol = "bpf-output",
145 .alias = "",
149 #define __PERF_EVENT_FIELD(config, name) \
150 ((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
152 #define PERF_EVENT_RAW(config) __PERF_EVENT_FIELD(config, RAW)
153 #define PERF_EVENT_CONFIG(config) __PERF_EVENT_FIELD(config, CONFIG)
154 #define PERF_EVENT_TYPE(config) __PERF_EVENT_FIELD(config, TYPE)
155 #define PERF_EVENT_ID(config) __PERF_EVENT_FIELD(config, EVENT)
157 #define for_each_subsystem(sys_dir, sys_dirent) \
158 while ((sys_dirent = readdir(sys_dir)) != NULL) \
159 if (sys_dirent->d_type == DT_DIR && \
160 (strcmp(sys_dirent->d_name, ".")) && \
161 (strcmp(sys_dirent->d_name, "..")))
163 static int tp_event_has_id(const char *dir_path, struct dirent *evt_dir)
165 char evt_path[MAXPATHLEN];
166 int fd;
168 snprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path, evt_dir->d_name);
169 fd = open(evt_path, O_RDONLY);
170 if (fd < 0)
171 return -EINVAL;
172 close(fd);
174 return 0;
177 #define for_each_event(dir_path, evt_dir, evt_dirent) \
178 while ((evt_dirent = readdir(evt_dir)) != NULL) \
179 if (evt_dirent->d_type == DT_DIR && \
180 (strcmp(evt_dirent->d_name, ".")) && \
181 (strcmp(evt_dirent->d_name, "..")) && \
182 (!tp_event_has_id(dir_path, evt_dirent)))
184 #define MAX_EVENT_LENGTH 512
186 void parse_events__handle_error(struct parse_events_error *err, int idx,
187 char *str, char *help)
189 if (WARN(!str, "WARNING: failed to provide error string\n")) {
190 free(help);
191 return;
193 switch (err->num_errors) {
194 case 0:
195 err->idx = idx;
196 err->str = str;
197 err->help = help;
198 break;
199 case 1:
200 err->first_idx = err->idx;
201 err->idx = idx;
202 err->first_str = err->str;
203 err->str = str;
204 err->first_help = err->help;
205 err->help = help;
206 break;
207 default:
208 pr_debug("Multiple errors dropping message: %s (%s)\n",
209 err->str, err->help);
210 free(err->str);
211 err->str = str;
212 free(err->help);
213 err->help = help;
214 break;
216 err->num_errors++;
219 struct tracepoint_path *tracepoint_id_to_path(u64 config)
221 struct tracepoint_path *path = NULL;
222 DIR *sys_dir, *evt_dir;
223 struct dirent *sys_dirent, *evt_dirent;
224 char id_buf[24];
225 int fd;
226 u64 id;
227 char evt_path[MAXPATHLEN];
228 char *dir_path;
230 sys_dir = tracing_events__opendir();
231 if (!sys_dir)
232 return NULL;
234 for_each_subsystem(sys_dir, sys_dirent) {
235 dir_path = get_events_file(sys_dirent->d_name);
236 if (!dir_path)
237 continue;
238 evt_dir = opendir(dir_path);
239 if (!evt_dir)
240 goto next;
242 for_each_event(dir_path, evt_dir, evt_dirent) {
244 scnprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
245 evt_dirent->d_name);
246 fd = open(evt_path, O_RDONLY);
247 if (fd < 0)
248 continue;
249 if (read(fd, id_buf, sizeof(id_buf)) < 0) {
250 close(fd);
251 continue;
253 close(fd);
254 id = atoll(id_buf);
255 if (id == config) {
256 put_events_file(dir_path);
257 closedir(evt_dir);
258 closedir(sys_dir);
259 path = zalloc(sizeof(*path));
260 if (!path)
261 return NULL;
262 if (asprintf(&path->system, "%.*s", MAX_EVENT_LENGTH, sys_dirent->d_name) < 0) {
263 free(path);
264 return NULL;
266 if (asprintf(&path->name, "%.*s", MAX_EVENT_LENGTH, evt_dirent->d_name) < 0) {
267 zfree(&path->system);
268 free(path);
269 return NULL;
271 return path;
274 closedir(evt_dir);
275 next:
276 put_events_file(dir_path);
279 closedir(sys_dir);
280 return NULL;
283 struct tracepoint_path *tracepoint_name_to_path(const char *name)
285 struct tracepoint_path *path = zalloc(sizeof(*path));
286 char *str = strchr(name, ':');
288 if (path == NULL || str == NULL) {
289 free(path);
290 return NULL;
293 path->system = strndup(name, str - name);
294 path->name = strdup(str+1);
296 if (path->system == NULL || path->name == NULL) {
297 zfree(&path->system);
298 zfree(&path->name);
299 zfree(&path);
302 return path;
305 const char *event_type(int type)
307 switch (type) {
308 case PERF_TYPE_HARDWARE:
309 return "hardware";
311 case PERF_TYPE_SOFTWARE:
312 return "software";
314 case PERF_TYPE_TRACEPOINT:
315 return "tracepoint";
317 case PERF_TYPE_HW_CACHE:
318 return "hardware-cache";
320 default:
321 break;
324 return "unknown";
327 static int parse_events__is_name_term(struct parse_events_term *term)
329 return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
332 static char *get_config_name(struct list_head *head_terms)
334 struct parse_events_term *term;
336 if (!head_terms)
337 return NULL;
339 list_for_each_entry(term, head_terms, list)
340 if (parse_events__is_name_term(term))
341 return term->val.str;
343 return NULL;
346 static struct evsel *
347 __add_event(struct list_head *list, int *idx,
348 struct perf_event_attr *attr,
349 bool init_attr,
350 char *name, struct perf_pmu *pmu,
351 struct list_head *config_terms, bool auto_merge_stats,
352 const char *cpu_list)
354 struct evsel *evsel;
355 struct perf_cpu_map *cpus = pmu ? pmu->cpus :
356 cpu_list ? perf_cpu_map__new(cpu_list) : NULL;
358 if (init_attr)
359 event_attr_init(attr);
361 evsel = evsel__new_idx(attr, *idx);
362 if (!evsel)
363 return NULL;
365 (*idx)++;
366 evsel->core.cpus = perf_cpu_map__get(cpus);
367 evsel->core.own_cpus = perf_cpu_map__get(cpus);
368 evsel->core.system_wide = pmu ? pmu->is_uncore : false;
369 evsel->auto_merge_stats = auto_merge_stats;
371 if (name)
372 evsel->name = strdup(name);
374 if (config_terms)
375 list_splice(config_terms, &evsel->config_terms);
377 if (list)
378 list_add_tail(&evsel->core.node, list);
380 return evsel;
383 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
384 char *name, struct perf_pmu *pmu)
386 return __add_event(NULL, &idx, attr, false, name, pmu, NULL, false,
387 NULL);
390 static int add_event(struct list_head *list, int *idx,
391 struct perf_event_attr *attr, char *name,
392 struct list_head *config_terms)
394 return __add_event(list, idx, attr, true, name, NULL, config_terms,
395 false, NULL) ? 0 : -ENOMEM;
398 static int add_event_tool(struct list_head *list, int *idx,
399 enum perf_tool_event tool_event)
401 struct evsel *evsel;
402 struct perf_event_attr attr = {
403 .type = PERF_TYPE_SOFTWARE,
404 .config = PERF_COUNT_SW_DUMMY,
407 evsel = __add_event(list, idx, &attr, true, NULL, NULL, NULL, false,
408 "0");
409 if (!evsel)
410 return -ENOMEM;
411 evsel->tool_event = tool_event;
412 if (tool_event == PERF_TOOL_DURATION_TIME)
413 evsel->unit = strdup("ns");
414 return 0;
417 static int parse_aliases(char *str, const char *names[][EVSEL__MAX_ALIASES], int size)
419 int i, j;
420 int n, longest = -1;
422 for (i = 0; i < size; i++) {
423 for (j = 0; j < EVSEL__MAX_ALIASES && names[i][j]; j++) {
424 n = strlen(names[i][j]);
425 if (n > longest && !strncasecmp(str, names[i][j], n))
426 longest = n;
428 if (longest > 0)
429 return i;
432 return -1;
435 typedef int config_term_func_t(struct perf_event_attr *attr,
436 struct parse_events_term *term,
437 struct parse_events_error *err);
438 static int config_term_common(struct perf_event_attr *attr,
439 struct parse_events_term *term,
440 struct parse_events_error *err);
441 static int config_attr(struct perf_event_attr *attr,
442 struct list_head *head,
443 struct parse_events_error *err,
444 config_term_func_t config_term);
446 int parse_events_add_cache(struct list_head *list, int *idx,
447 char *type, char *op_result1, char *op_result2,
448 struct parse_events_error *err,
449 struct list_head *head_config)
451 struct perf_event_attr attr;
452 LIST_HEAD(config_terms);
453 char name[MAX_NAME_LEN], *config_name;
454 int cache_type = -1, cache_op = -1, cache_result = -1;
455 char *op_result[2] = { op_result1, op_result2 };
456 int i, n;
459 * No fallback - if we cannot get a clear cache type
460 * then bail out:
462 cache_type = parse_aliases(type, evsel__hw_cache, PERF_COUNT_HW_CACHE_MAX);
463 if (cache_type == -1)
464 return -EINVAL;
466 config_name = get_config_name(head_config);
467 n = snprintf(name, MAX_NAME_LEN, "%s", type);
469 for (i = 0; (i < 2) && (op_result[i]); i++) {
470 char *str = op_result[i];
472 n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
474 if (cache_op == -1) {
475 cache_op = parse_aliases(str, evsel__hw_cache_op,
476 PERF_COUNT_HW_CACHE_OP_MAX);
477 if (cache_op >= 0) {
478 if (!evsel__is_cache_op_valid(cache_type, cache_op))
479 return -EINVAL;
480 continue;
484 if (cache_result == -1) {
485 cache_result = parse_aliases(str, evsel__hw_cache_result,
486 PERF_COUNT_HW_CACHE_RESULT_MAX);
487 if (cache_result >= 0)
488 continue;
493 * Fall back to reads:
495 if (cache_op == -1)
496 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
499 * Fall back to accesses:
501 if (cache_result == -1)
502 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
504 memset(&attr, 0, sizeof(attr));
505 attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
506 attr.type = PERF_TYPE_HW_CACHE;
508 if (head_config) {
509 if (config_attr(&attr, head_config, err,
510 config_term_common))
511 return -EINVAL;
513 if (get_config_terms(head_config, &config_terms))
514 return -ENOMEM;
516 return add_event(list, idx, &attr, config_name ? : name, &config_terms);
519 static void tracepoint_error(struct parse_events_error *e, int err,
520 const char *sys, const char *name)
522 const char *str;
523 char help[BUFSIZ];
525 if (!e)
526 return;
529 * We get error directly from syscall errno ( > 0),
530 * or from encoded pointer's error ( < 0).
532 err = abs(err);
534 switch (err) {
535 case EACCES:
536 str = "can't access trace events";
537 break;
538 case ENOENT:
539 str = "unknown tracepoint";
540 break;
541 default:
542 str = "failed to add tracepoint";
543 break;
546 tracing_path__strerror_open_tp(err, help, sizeof(help), sys, name);
547 parse_events__handle_error(e, 0, strdup(str), strdup(help));
550 static int add_tracepoint(struct list_head *list, int *idx,
551 const char *sys_name, const char *evt_name,
552 struct parse_events_error *err,
553 struct list_head *head_config)
555 struct evsel *evsel = evsel__newtp_idx(sys_name, evt_name, (*idx)++);
557 if (IS_ERR(evsel)) {
558 tracepoint_error(err, PTR_ERR(evsel), sys_name, evt_name);
559 return PTR_ERR(evsel);
562 if (head_config) {
563 LIST_HEAD(config_terms);
565 if (get_config_terms(head_config, &config_terms))
566 return -ENOMEM;
567 list_splice(&config_terms, &evsel->config_terms);
570 list_add_tail(&evsel->core.node, list);
571 return 0;
574 static int add_tracepoint_multi_event(struct list_head *list, int *idx,
575 const char *sys_name, const char *evt_name,
576 struct parse_events_error *err,
577 struct list_head *head_config)
579 char *evt_path;
580 struct dirent *evt_ent;
581 DIR *evt_dir;
582 int ret = 0, found = 0;
584 evt_path = get_events_file(sys_name);
585 if (!evt_path) {
586 tracepoint_error(err, errno, sys_name, evt_name);
587 return -1;
589 evt_dir = opendir(evt_path);
590 if (!evt_dir) {
591 put_events_file(evt_path);
592 tracepoint_error(err, errno, sys_name, evt_name);
593 return -1;
596 while (!ret && (evt_ent = readdir(evt_dir))) {
597 if (!strcmp(evt_ent->d_name, ".")
598 || !strcmp(evt_ent->d_name, "..")
599 || !strcmp(evt_ent->d_name, "enable")
600 || !strcmp(evt_ent->d_name, "filter"))
601 continue;
603 if (!strglobmatch(evt_ent->d_name, evt_name))
604 continue;
606 found++;
608 ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name,
609 err, head_config);
612 if (!found) {
613 tracepoint_error(err, ENOENT, sys_name, evt_name);
614 ret = -1;
617 put_events_file(evt_path);
618 closedir(evt_dir);
619 return ret;
622 static int add_tracepoint_event(struct list_head *list, int *idx,
623 const char *sys_name, const char *evt_name,
624 struct parse_events_error *err,
625 struct list_head *head_config)
627 return strpbrk(evt_name, "*?") ?
628 add_tracepoint_multi_event(list, idx, sys_name, evt_name,
629 err, head_config) :
630 add_tracepoint(list, idx, sys_name, evt_name,
631 err, head_config);
634 static int add_tracepoint_multi_sys(struct list_head *list, int *idx,
635 const char *sys_name, const char *evt_name,
636 struct parse_events_error *err,
637 struct list_head *head_config)
639 struct dirent *events_ent;
640 DIR *events_dir;
641 int ret = 0;
643 events_dir = tracing_events__opendir();
644 if (!events_dir) {
645 tracepoint_error(err, errno, sys_name, evt_name);
646 return -1;
649 while (!ret && (events_ent = readdir(events_dir))) {
650 if (!strcmp(events_ent->d_name, ".")
651 || !strcmp(events_ent->d_name, "..")
652 || !strcmp(events_ent->d_name, "enable")
653 || !strcmp(events_ent->d_name, "header_event")
654 || !strcmp(events_ent->d_name, "header_page"))
655 continue;
657 if (!strglobmatch(events_ent->d_name, sys_name))
658 continue;
660 ret = add_tracepoint_event(list, idx, events_ent->d_name,
661 evt_name, err, head_config);
664 closedir(events_dir);
665 return ret;
668 struct __add_bpf_event_param {
669 struct parse_events_state *parse_state;
670 struct list_head *list;
671 struct list_head *head_config;
674 static int add_bpf_event(const char *group, const char *event, int fd, struct bpf_object *obj,
675 void *_param)
677 LIST_HEAD(new_evsels);
678 struct __add_bpf_event_param *param = _param;
679 struct parse_events_state *parse_state = param->parse_state;
680 struct list_head *list = param->list;
681 struct evsel *pos;
682 int err;
684 * Check if we should add the event, i.e. if it is a TP but starts with a '!',
685 * then don't add the tracepoint, this will be used for something else, like
686 * adding to a BPF_MAP_TYPE_PROG_ARRAY.
688 * See tools/perf/examples/bpf/augmented_raw_syscalls.c
690 if (group[0] == '!')
691 return 0;
693 pr_debug("add bpf event %s:%s and attach bpf program %d\n",
694 group, event, fd);
696 err = parse_events_add_tracepoint(&new_evsels, &parse_state->idx, group,
697 event, parse_state->error,
698 param->head_config);
699 if (err) {
700 struct evsel *evsel, *tmp;
702 pr_debug("Failed to add BPF event %s:%s\n",
703 group, event);
704 list_for_each_entry_safe(evsel, tmp, &new_evsels, core.node) {
705 list_del_init(&evsel->core.node);
706 evsel__delete(evsel);
708 return err;
710 pr_debug("adding %s:%s\n", group, event);
712 list_for_each_entry(pos, &new_evsels, core.node) {
713 pr_debug("adding %s:%s to %p\n",
714 group, event, pos);
715 pos->bpf_fd = fd;
716 pos->bpf_obj = obj;
718 list_splice(&new_evsels, list);
719 return 0;
722 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
723 struct list_head *list,
724 struct bpf_object *obj,
725 struct list_head *head_config)
727 int err;
728 char errbuf[BUFSIZ];
729 struct __add_bpf_event_param param = {parse_state, list, head_config};
730 static bool registered_unprobe_atexit = false;
732 if (IS_ERR(obj) || !obj) {
733 snprintf(errbuf, sizeof(errbuf),
734 "Internal error: load bpf obj with NULL");
735 err = -EINVAL;
736 goto errout;
740 * Register atexit handler before calling bpf__probe() so
741 * bpf__probe() don't need to unprobe probe points its already
742 * created when failure.
744 if (!registered_unprobe_atexit) {
745 atexit(bpf__clear);
746 registered_unprobe_atexit = true;
749 err = bpf__probe(obj);
750 if (err) {
751 bpf__strerror_probe(obj, err, errbuf, sizeof(errbuf));
752 goto errout;
755 err = bpf__load(obj);
756 if (err) {
757 bpf__strerror_load(obj, err, errbuf, sizeof(errbuf));
758 goto errout;
761 err = bpf__foreach_event(obj, add_bpf_event, &param);
762 if (err) {
763 snprintf(errbuf, sizeof(errbuf),
764 "Attach events in BPF object failed");
765 goto errout;
768 return 0;
769 errout:
770 parse_events__handle_error(parse_state->error, 0,
771 strdup(errbuf), strdup("(add -v to see detail)"));
772 return err;
775 static int
776 parse_events_config_bpf(struct parse_events_state *parse_state,
777 struct bpf_object *obj,
778 struct list_head *head_config)
780 struct parse_events_term *term;
781 int error_pos;
783 if (!head_config || list_empty(head_config))
784 return 0;
786 list_for_each_entry(term, head_config, list) {
787 int err;
789 if (term->type_term != PARSE_EVENTS__TERM_TYPE_USER) {
790 parse_events__handle_error(parse_state->error, term->err_term,
791 strdup("Invalid config term for BPF object"),
792 NULL);
793 return -EINVAL;
796 err = bpf__config_obj(obj, term, parse_state->evlist, &error_pos);
797 if (err) {
798 char errbuf[BUFSIZ];
799 int idx;
801 bpf__strerror_config_obj(obj, term, parse_state->evlist,
802 &error_pos, err, errbuf,
803 sizeof(errbuf));
805 if (err == -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE)
806 idx = term->err_val;
807 else
808 idx = term->err_term + error_pos;
810 parse_events__handle_error(parse_state->error, idx,
811 strdup(errbuf),
812 strdup(
813 "Hint:\tValid config terms:\n"
814 " \tmap:[<arraymap>].value<indices>=[value]\n"
815 " \tmap:[<eventmap>].event<indices>=[event]\n"
816 "\n"
817 " \twhere <indices> is something like [0,3...5] or [all]\n"
818 " \t(add -v to see detail)"));
819 return err;
822 return 0;
826 * Split config terms:
827 * perf record -e bpf.c/call-graph=fp,map:array.value[0]=1/ ...
828 * 'call-graph=fp' is 'evt config', should be applied to each
829 * events in bpf.c.
830 * 'map:array.value[0]=1' is 'obj config', should be processed
831 * with parse_events_config_bpf.
833 * Move object config terms from the first list to obj_head_config.
835 static void
836 split_bpf_config_terms(struct list_head *evt_head_config,
837 struct list_head *obj_head_config)
839 struct parse_events_term *term, *temp;
842 * Currectly, all possible user config term
843 * belong to bpf object. parse_events__is_hardcoded_term()
844 * happends to be a good flag.
846 * See parse_events_config_bpf() and
847 * config_term_tracepoint().
849 list_for_each_entry_safe(term, temp, evt_head_config, list)
850 if (!parse_events__is_hardcoded_term(term))
851 list_move_tail(&term->list, obj_head_config);
854 int parse_events_load_bpf(struct parse_events_state *parse_state,
855 struct list_head *list,
856 char *bpf_file_name,
857 bool source,
858 struct list_head *head_config)
860 int err;
861 struct bpf_object *obj;
862 LIST_HEAD(obj_head_config);
864 if (head_config)
865 split_bpf_config_terms(head_config, &obj_head_config);
867 obj = bpf__prepare_load(bpf_file_name, source);
868 if (IS_ERR(obj)) {
869 char errbuf[BUFSIZ];
871 err = PTR_ERR(obj);
873 if (err == -ENOTSUP)
874 snprintf(errbuf, sizeof(errbuf),
875 "BPF support is not compiled");
876 else
877 bpf__strerror_prepare_load(bpf_file_name,
878 source,
879 -err, errbuf,
880 sizeof(errbuf));
882 parse_events__handle_error(parse_state->error, 0,
883 strdup(errbuf), strdup("(add -v to see detail)"));
884 return err;
887 err = parse_events_load_bpf_obj(parse_state, list, obj, head_config);
888 if (err)
889 return err;
890 err = parse_events_config_bpf(parse_state, obj, &obj_head_config);
893 * Caller doesn't know anything about obj_head_config,
894 * so combine them together again before returnning.
896 if (head_config)
897 list_splice_tail(&obj_head_config, head_config);
898 return err;
901 static int
902 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
904 int i;
906 for (i = 0; i < 3; i++) {
907 if (!type || !type[i])
908 break;
910 #define CHECK_SET_TYPE(bit) \
911 do { \
912 if (attr->bp_type & bit) \
913 return -EINVAL; \
914 else \
915 attr->bp_type |= bit; \
916 } while (0)
918 switch (type[i]) {
919 case 'r':
920 CHECK_SET_TYPE(HW_BREAKPOINT_R);
921 break;
922 case 'w':
923 CHECK_SET_TYPE(HW_BREAKPOINT_W);
924 break;
925 case 'x':
926 CHECK_SET_TYPE(HW_BREAKPOINT_X);
927 break;
928 default:
929 return -EINVAL;
933 #undef CHECK_SET_TYPE
935 if (!attr->bp_type) /* Default */
936 attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
938 return 0;
941 int parse_events_add_breakpoint(struct list_head *list, int *idx,
942 void *ptr, char *type, u64 len)
944 struct perf_event_attr attr;
946 memset(&attr, 0, sizeof(attr));
947 attr.bp_addr = (unsigned long) ptr;
949 if (parse_breakpoint_type(type, &attr))
950 return -EINVAL;
952 /* Provide some defaults if len is not specified */
953 if (!len) {
954 if (attr.bp_type == HW_BREAKPOINT_X)
955 len = sizeof(long);
956 else
957 len = HW_BREAKPOINT_LEN_4;
960 attr.bp_len = len;
962 attr.type = PERF_TYPE_BREAKPOINT;
963 attr.sample_period = 1;
965 return add_event(list, idx, &attr, NULL, NULL);
968 static int check_type_val(struct parse_events_term *term,
969 struct parse_events_error *err,
970 int type)
972 if (type == term->type_val)
973 return 0;
975 if (err) {
976 parse_events__handle_error(err, term->err_val,
977 type == PARSE_EVENTS__TERM_TYPE_NUM
978 ? strdup("expected numeric value")
979 : strdup("expected string value"),
980 NULL);
982 return -EINVAL;
986 * Update according to parse-events.l
988 static const char *config_term_names[__PARSE_EVENTS__TERM_TYPE_NR] = {
989 [PARSE_EVENTS__TERM_TYPE_USER] = "<sysfs term>",
990 [PARSE_EVENTS__TERM_TYPE_CONFIG] = "config",
991 [PARSE_EVENTS__TERM_TYPE_CONFIG1] = "config1",
992 [PARSE_EVENTS__TERM_TYPE_CONFIG2] = "config2",
993 [PARSE_EVENTS__TERM_TYPE_NAME] = "name",
994 [PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD] = "period",
995 [PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ] = "freq",
996 [PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE] = "branch_type",
997 [PARSE_EVENTS__TERM_TYPE_TIME] = "time",
998 [PARSE_EVENTS__TERM_TYPE_CALLGRAPH] = "call-graph",
999 [PARSE_EVENTS__TERM_TYPE_STACKSIZE] = "stack-size",
1000 [PARSE_EVENTS__TERM_TYPE_NOINHERIT] = "no-inherit",
1001 [PARSE_EVENTS__TERM_TYPE_INHERIT] = "inherit",
1002 [PARSE_EVENTS__TERM_TYPE_MAX_STACK] = "max-stack",
1003 [PARSE_EVENTS__TERM_TYPE_MAX_EVENTS] = "nr",
1004 [PARSE_EVENTS__TERM_TYPE_OVERWRITE] = "overwrite",
1005 [PARSE_EVENTS__TERM_TYPE_NOOVERWRITE] = "no-overwrite",
1006 [PARSE_EVENTS__TERM_TYPE_DRV_CFG] = "driver-config",
1007 [PARSE_EVENTS__TERM_TYPE_PERCORE] = "percore",
1008 [PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT] = "aux-output",
1009 [PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE] = "aux-sample-size",
1012 static bool config_term_shrinked;
1014 static bool
1015 config_term_avail(int term_type, struct parse_events_error *err)
1017 char *err_str;
1019 if (term_type < 0 || term_type >= __PARSE_EVENTS__TERM_TYPE_NR) {
1020 parse_events__handle_error(err, -1,
1021 strdup("Invalid term_type"), NULL);
1022 return false;
1024 if (!config_term_shrinked)
1025 return true;
1027 switch (term_type) {
1028 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1029 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
1030 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
1031 case PARSE_EVENTS__TERM_TYPE_NAME:
1032 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1033 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1034 return true;
1035 default:
1036 if (!err)
1037 return false;
1039 /* term_type is validated so indexing is safe */
1040 if (asprintf(&err_str, "'%s' is not usable in 'perf stat'",
1041 config_term_names[term_type]) >= 0)
1042 parse_events__handle_error(err, -1, err_str, NULL);
1043 return false;
1047 void parse_events__shrink_config_terms(void)
1049 config_term_shrinked = true;
1052 static int config_term_common(struct perf_event_attr *attr,
1053 struct parse_events_term *term,
1054 struct parse_events_error *err)
1056 #define CHECK_TYPE_VAL(type) \
1057 do { \
1058 if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
1059 return -EINVAL; \
1060 } while (0)
1062 switch (term->type_term) {
1063 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1064 CHECK_TYPE_VAL(NUM);
1065 attr->config = term->val.num;
1066 break;
1067 case PARSE_EVENTS__TERM_TYPE_CONFIG1:
1068 CHECK_TYPE_VAL(NUM);
1069 attr->config1 = term->val.num;
1070 break;
1071 case PARSE_EVENTS__TERM_TYPE_CONFIG2:
1072 CHECK_TYPE_VAL(NUM);
1073 attr->config2 = term->val.num;
1074 break;
1075 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1076 CHECK_TYPE_VAL(NUM);
1077 break;
1078 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1079 CHECK_TYPE_VAL(NUM);
1080 break;
1081 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1082 CHECK_TYPE_VAL(STR);
1083 if (strcmp(term->val.str, "no") &&
1084 parse_branch_str(term->val.str,
1085 &attr->branch_sample_type)) {
1086 parse_events__handle_error(err, term->err_val,
1087 strdup("invalid branch sample type"),
1088 NULL);
1089 return -EINVAL;
1091 break;
1092 case PARSE_EVENTS__TERM_TYPE_TIME:
1093 CHECK_TYPE_VAL(NUM);
1094 if (term->val.num > 1) {
1095 parse_events__handle_error(err, term->err_val,
1096 strdup("expected 0 or 1"),
1097 NULL);
1098 return -EINVAL;
1100 break;
1101 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1102 CHECK_TYPE_VAL(STR);
1103 break;
1104 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1105 CHECK_TYPE_VAL(NUM);
1106 break;
1107 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1108 CHECK_TYPE_VAL(NUM);
1109 break;
1110 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1111 CHECK_TYPE_VAL(NUM);
1112 break;
1113 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1114 CHECK_TYPE_VAL(NUM);
1115 break;
1116 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1117 CHECK_TYPE_VAL(NUM);
1118 break;
1119 case PARSE_EVENTS__TERM_TYPE_NAME:
1120 CHECK_TYPE_VAL(STR);
1121 break;
1122 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1123 CHECK_TYPE_VAL(NUM);
1124 break;
1125 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1126 CHECK_TYPE_VAL(NUM);
1127 break;
1128 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1129 CHECK_TYPE_VAL(NUM);
1130 if ((unsigned int)term->val.num > 1) {
1131 parse_events__handle_error(err, term->err_val,
1132 strdup("expected 0 or 1"),
1133 NULL);
1134 return -EINVAL;
1136 break;
1137 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1138 CHECK_TYPE_VAL(NUM);
1139 break;
1140 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1141 CHECK_TYPE_VAL(NUM);
1142 if (term->val.num > UINT_MAX) {
1143 parse_events__handle_error(err, term->err_val,
1144 strdup("too big"),
1145 NULL);
1146 return -EINVAL;
1148 break;
1149 default:
1150 parse_events__handle_error(err, term->err_term,
1151 strdup("unknown term"),
1152 parse_events_formats_error_string(NULL));
1153 return -EINVAL;
1157 * Check term availbility after basic checking so
1158 * PARSE_EVENTS__TERM_TYPE_USER can be found and filtered.
1160 * If check availbility at the entry of this function,
1161 * user will see "'<sysfs term>' is not usable in 'perf stat'"
1162 * if an invalid config term is provided for legacy events
1163 * (for example, instructions/badterm/...), which is confusing.
1165 if (!config_term_avail(term->type_term, err))
1166 return -EINVAL;
1167 return 0;
1168 #undef CHECK_TYPE_VAL
1171 static int config_term_pmu(struct perf_event_attr *attr,
1172 struct parse_events_term *term,
1173 struct parse_events_error *err)
1175 if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER ||
1176 term->type_term == PARSE_EVENTS__TERM_TYPE_DRV_CFG)
1178 * Always succeed for sysfs terms, as we dont know
1179 * at this point what type they need to have.
1181 return 0;
1182 else
1183 return config_term_common(attr, term, err);
1186 static int config_term_tracepoint(struct perf_event_attr *attr,
1187 struct parse_events_term *term,
1188 struct parse_events_error *err)
1190 switch (term->type_term) {
1191 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1192 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1193 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1194 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1195 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1196 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1197 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1198 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1199 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1200 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1201 return config_term_common(attr, term, err);
1202 default:
1203 if (err) {
1204 parse_events__handle_error(err, term->err_term,
1205 strdup("unknown term"),
1206 strdup("valid terms: call-graph,stack-size\n"));
1208 return -EINVAL;
1211 return 0;
1214 static int config_attr(struct perf_event_attr *attr,
1215 struct list_head *head,
1216 struct parse_events_error *err,
1217 config_term_func_t config_term)
1219 struct parse_events_term *term;
1221 list_for_each_entry(term, head, list)
1222 if (config_term(attr, term, err))
1223 return -EINVAL;
1225 return 0;
1228 static int get_config_terms(struct list_head *head_config,
1229 struct list_head *head_terms __maybe_unused)
1231 #define ADD_CONFIG_TERM(__type, __weak) \
1232 struct evsel_config_term *__t; \
1234 __t = zalloc(sizeof(*__t)); \
1235 if (!__t) \
1236 return -ENOMEM; \
1238 INIT_LIST_HEAD(&__t->list); \
1239 __t->type = EVSEL__CONFIG_TERM_ ## __type; \
1240 __t->weak = __weak; \
1241 list_add_tail(&__t->list, head_terms)
1243 #define ADD_CONFIG_TERM_VAL(__type, __name, __val, __weak) \
1244 do { \
1245 ADD_CONFIG_TERM(__type, __weak); \
1246 __t->val.__name = __val; \
1247 } while (0)
1249 #define ADD_CONFIG_TERM_STR(__type, __val, __weak) \
1250 do { \
1251 ADD_CONFIG_TERM(__type, __weak); \
1252 __t->val.str = strdup(__val); \
1253 if (!__t->val.str) { \
1254 zfree(&__t); \
1255 return -ENOMEM; \
1257 __t->free_str = true; \
1258 } while (0)
1260 struct parse_events_term *term;
1262 list_for_each_entry(term, head_config, list) {
1263 switch (term->type_term) {
1264 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1265 ADD_CONFIG_TERM_VAL(PERIOD, period, term->val.num, term->weak);
1266 break;
1267 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1268 ADD_CONFIG_TERM_VAL(FREQ, freq, term->val.num, term->weak);
1269 break;
1270 case PARSE_EVENTS__TERM_TYPE_TIME:
1271 ADD_CONFIG_TERM_VAL(TIME, time, term->val.num, term->weak);
1272 break;
1273 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1274 ADD_CONFIG_TERM_STR(CALLGRAPH, term->val.str, term->weak);
1275 break;
1276 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1277 ADD_CONFIG_TERM_STR(BRANCH, term->val.str, term->weak);
1278 break;
1279 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1280 ADD_CONFIG_TERM_VAL(STACK_USER, stack_user,
1281 term->val.num, term->weak);
1282 break;
1283 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1284 ADD_CONFIG_TERM_VAL(INHERIT, inherit,
1285 term->val.num ? 1 : 0, term->weak);
1286 break;
1287 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1288 ADD_CONFIG_TERM_VAL(INHERIT, inherit,
1289 term->val.num ? 0 : 1, term->weak);
1290 break;
1291 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1292 ADD_CONFIG_TERM_VAL(MAX_STACK, max_stack,
1293 term->val.num, term->weak);
1294 break;
1295 case PARSE_EVENTS__TERM_TYPE_MAX_EVENTS:
1296 ADD_CONFIG_TERM_VAL(MAX_EVENTS, max_events,
1297 term->val.num, term->weak);
1298 break;
1299 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1300 ADD_CONFIG_TERM_VAL(OVERWRITE, overwrite,
1301 term->val.num ? 1 : 0, term->weak);
1302 break;
1303 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1304 ADD_CONFIG_TERM_VAL(OVERWRITE, overwrite,
1305 term->val.num ? 0 : 1, term->weak);
1306 break;
1307 case PARSE_EVENTS__TERM_TYPE_DRV_CFG:
1308 ADD_CONFIG_TERM_STR(DRV_CFG, term->val.str, term->weak);
1309 break;
1310 case PARSE_EVENTS__TERM_TYPE_PERCORE:
1311 ADD_CONFIG_TERM_VAL(PERCORE, percore,
1312 term->val.num ? true : false, term->weak);
1313 break;
1314 case PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT:
1315 ADD_CONFIG_TERM_VAL(AUX_OUTPUT, aux_output,
1316 term->val.num ? 1 : 0, term->weak);
1317 break;
1318 case PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE:
1319 ADD_CONFIG_TERM_VAL(AUX_SAMPLE_SIZE, aux_sample_size,
1320 term->val.num, term->weak);
1321 break;
1322 default:
1323 break;
1326 return 0;
1330 * Add EVSEL__CONFIG_TERM_CFG_CHG where cfg_chg will have a bit set for
1331 * each bit of attr->config that the user has changed.
1333 static int get_config_chgs(struct perf_pmu *pmu, struct list_head *head_config,
1334 struct list_head *head_terms)
1336 struct parse_events_term *term;
1337 u64 bits = 0;
1338 int type;
1340 list_for_each_entry(term, head_config, list) {
1341 switch (term->type_term) {
1342 case PARSE_EVENTS__TERM_TYPE_USER:
1343 type = perf_pmu__format_type(&pmu->format, term->config);
1344 if (type != PERF_PMU_FORMAT_VALUE_CONFIG)
1345 continue;
1346 bits |= perf_pmu__format_bits(&pmu->format, term->config);
1347 break;
1348 case PARSE_EVENTS__TERM_TYPE_CONFIG:
1349 bits = ~(u64)0;
1350 break;
1351 default:
1352 break;
1356 if (bits)
1357 ADD_CONFIG_TERM_VAL(CFG_CHG, cfg_chg, bits, false);
1359 #undef ADD_CONFIG_TERM
1360 return 0;
1363 int parse_events_add_tracepoint(struct list_head *list, int *idx,
1364 const char *sys, const char *event,
1365 struct parse_events_error *err,
1366 struct list_head *head_config)
1368 if (head_config) {
1369 struct perf_event_attr attr;
1371 if (config_attr(&attr, head_config, err,
1372 config_term_tracepoint))
1373 return -EINVAL;
1376 if (strpbrk(sys, "*?"))
1377 return add_tracepoint_multi_sys(list, idx, sys, event,
1378 err, head_config);
1379 else
1380 return add_tracepoint_event(list, idx, sys, event,
1381 err, head_config);
1384 int parse_events_add_numeric(struct parse_events_state *parse_state,
1385 struct list_head *list,
1386 u32 type, u64 config,
1387 struct list_head *head_config)
1389 struct perf_event_attr attr;
1390 LIST_HEAD(config_terms);
1392 memset(&attr, 0, sizeof(attr));
1393 attr.type = type;
1394 attr.config = config;
1396 if (head_config) {
1397 if (config_attr(&attr, head_config, parse_state->error,
1398 config_term_common))
1399 return -EINVAL;
1401 if (get_config_terms(head_config, &config_terms))
1402 return -ENOMEM;
1405 return add_event(list, &parse_state->idx, &attr,
1406 get_config_name(head_config), &config_terms);
1409 int parse_events_add_tool(struct parse_events_state *parse_state,
1410 struct list_head *list,
1411 enum perf_tool_event tool_event)
1413 return add_event_tool(list, &parse_state->idx, tool_event);
1416 static bool config_term_percore(struct list_head *config_terms)
1418 struct evsel_config_term *term;
1420 list_for_each_entry(term, config_terms, list) {
1421 if (term->type == EVSEL__CONFIG_TERM_PERCORE)
1422 return term->val.percore;
1425 return false;
1428 int parse_events_add_pmu(struct parse_events_state *parse_state,
1429 struct list_head *list, char *name,
1430 struct list_head *head_config,
1431 bool auto_merge_stats,
1432 bool use_alias)
1434 struct perf_event_attr attr;
1435 struct perf_pmu_info info;
1436 struct perf_pmu *pmu;
1437 struct evsel *evsel;
1438 struct parse_events_error *err = parse_state->error;
1439 bool use_uncore_alias;
1440 LIST_HEAD(config_terms);
1442 if (verbose > 1) {
1443 fprintf(stderr, "Attempting to add event pmu '%s' with '",
1444 name);
1445 if (head_config) {
1446 struct parse_events_term *term;
1448 list_for_each_entry(term, head_config, list) {
1449 fprintf(stderr, "%s,", term->config);
1452 fprintf(stderr, "' that may result in non-fatal errors\n");
1455 pmu = parse_state->fake_pmu ?: perf_pmu__find(name);
1456 if (!pmu) {
1457 char *err_str;
1459 if (asprintf(&err_str,
1460 "Cannot find PMU `%s'. Missing kernel support?",
1461 name) >= 0)
1462 parse_events__handle_error(err, 0, err_str, NULL);
1463 return -EINVAL;
1466 if (pmu->default_config) {
1467 memcpy(&attr, pmu->default_config,
1468 sizeof(struct perf_event_attr));
1469 } else {
1470 memset(&attr, 0, sizeof(attr));
1473 use_uncore_alias = (pmu->is_uncore && use_alias);
1475 if (!head_config) {
1476 attr.type = pmu->type;
1477 evsel = __add_event(list, &parse_state->idx, &attr, true, NULL,
1478 pmu, NULL, auto_merge_stats, NULL);
1479 if (evsel) {
1480 evsel->pmu_name = name ? strdup(name) : NULL;
1481 evsel->use_uncore_alias = use_uncore_alias;
1482 return 0;
1483 } else {
1484 return -ENOMEM;
1488 if (!parse_state->fake_pmu && perf_pmu__check_alias(pmu, head_config, &info))
1489 return -EINVAL;
1491 if (verbose > 1) {
1492 fprintf(stderr, "After aliases, add event pmu '%s' with '",
1493 name);
1494 if (head_config) {
1495 struct parse_events_term *term;
1497 list_for_each_entry(term, head_config, list) {
1498 fprintf(stderr, "%s,", term->config);
1501 fprintf(stderr, "' that may result in non-fatal errors\n");
1505 * Configure hardcoded terms first, no need to check
1506 * return value when called with fail == 0 ;)
1508 if (config_attr(&attr, head_config, parse_state->error, config_term_pmu))
1509 return -EINVAL;
1511 if (get_config_terms(head_config, &config_terms))
1512 return -ENOMEM;
1515 * When using default config, record which bits of attr->config were
1516 * changed by the user.
1518 if (pmu->default_config && get_config_chgs(pmu, head_config, &config_terms))
1519 return -ENOMEM;
1521 if (!parse_state->fake_pmu && perf_pmu__config(pmu, &attr, head_config, parse_state->error)) {
1522 struct evsel_config_term *pos, *tmp;
1524 list_for_each_entry_safe(pos, tmp, &config_terms, list) {
1525 list_del_init(&pos->list);
1526 if (pos->free_str)
1527 zfree(&pos->val.str);
1528 free(pos);
1530 return -EINVAL;
1533 evsel = __add_event(list, &parse_state->idx, &attr, true,
1534 get_config_name(head_config), pmu,
1535 &config_terms, auto_merge_stats, NULL);
1536 if (evsel) {
1537 evsel->unit = info.unit;
1538 evsel->scale = info.scale;
1539 evsel->per_pkg = info.per_pkg;
1540 evsel->snapshot = info.snapshot;
1541 evsel->metric_expr = info.metric_expr;
1542 evsel->metric_name = info.metric_name;
1543 evsel->pmu_name = name ? strdup(name) : NULL;
1544 evsel->use_uncore_alias = use_uncore_alias;
1545 evsel->percore = config_term_percore(&evsel->config_terms);
1548 return evsel ? 0 : -ENOMEM;
1551 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
1552 char *str, struct list_head **listp)
1554 struct parse_events_term *term;
1555 struct list_head *list;
1556 struct perf_pmu *pmu = NULL;
1557 int ok = 0;
1559 *listp = NULL;
1560 /* Add it for all PMUs that support the alias */
1561 list = malloc(sizeof(struct list_head));
1562 if (!list)
1563 return -1;
1564 INIT_LIST_HEAD(list);
1565 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1566 struct perf_pmu_alias *alias;
1568 list_for_each_entry(alias, &pmu->aliases, list) {
1569 if (!strcasecmp(alias->name, str)) {
1570 struct list_head *head;
1571 char *config;
1573 head = malloc(sizeof(struct list_head));
1574 if (!head)
1575 return -1;
1576 INIT_LIST_HEAD(head);
1577 config = strdup(str);
1578 if (!config)
1579 return -1;
1580 if (parse_events_term__num(&term,
1581 PARSE_EVENTS__TERM_TYPE_USER,
1582 config, 1, false, &config,
1583 NULL) < 0) {
1584 free(list);
1585 free(config);
1586 return -1;
1588 list_add_tail(&term->list, head);
1590 if (!parse_events_add_pmu(parse_state, list,
1591 pmu->name, head,
1592 true, true)) {
1593 pr_debug("%s -> %s/%s/\n", str,
1594 pmu->name, alias->str);
1595 ok++;
1598 parse_events_terms__delete(head);
1602 if (!ok) {
1603 free(list);
1604 return -1;
1606 *listp = list;
1607 return 0;
1610 int parse_events__modifier_group(struct list_head *list,
1611 char *event_mod)
1613 return parse_events__modifier_event(list, event_mod, true);
1617 * Check if the two uncore PMUs are from the same uncore block
1618 * The format of the uncore PMU name is uncore_#blockname_#pmuidx
1620 static bool is_same_uncore_block(const char *pmu_name_a, const char *pmu_name_b)
1622 char *end_a, *end_b;
1624 end_a = strrchr(pmu_name_a, '_');
1625 end_b = strrchr(pmu_name_b, '_');
1627 if (!end_a || !end_b)
1628 return false;
1630 if ((end_a - pmu_name_a) != (end_b - pmu_name_b))
1631 return false;
1633 return (strncmp(pmu_name_a, pmu_name_b, end_a - pmu_name_a) == 0);
1636 static int
1637 parse_events__set_leader_for_uncore_aliase(char *name, struct list_head *list,
1638 struct parse_events_state *parse_state)
1640 struct evsel *evsel, *leader;
1641 uintptr_t *leaders;
1642 bool is_leader = true;
1643 int i, nr_pmu = 0, total_members, ret = 0;
1645 leader = list_first_entry(list, struct evsel, core.node);
1646 evsel = list_last_entry(list, struct evsel, core.node);
1647 total_members = evsel->idx - leader->idx + 1;
1649 leaders = calloc(total_members, sizeof(uintptr_t));
1650 if (WARN_ON(!leaders))
1651 return 0;
1654 * Going through the whole group and doing sanity check.
1655 * All members must use alias, and be from the same uncore block.
1656 * Also, storing the leader events in an array.
1658 __evlist__for_each_entry(list, evsel) {
1660 /* Only split the uncore group which members use alias */
1661 if (!evsel->use_uncore_alias)
1662 goto out;
1664 /* The events must be from the same uncore block */
1665 if (!is_same_uncore_block(leader->pmu_name, evsel->pmu_name))
1666 goto out;
1668 if (!is_leader)
1669 continue;
1671 * If the event's PMU name starts to repeat, it must be a new
1672 * event. That can be used to distinguish the leader from
1673 * other members, even they have the same event name.
1675 if ((leader != evsel) &&
1676 !strcmp(leader->pmu_name, evsel->pmu_name)) {
1677 is_leader = false;
1678 continue;
1681 /* Store the leader event for each PMU */
1682 leaders[nr_pmu++] = (uintptr_t) evsel;
1685 /* only one event alias */
1686 if (nr_pmu == total_members) {
1687 parse_state->nr_groups--;
1688 goto handled;
1692 * An uncore event alias is a joint name which means the same event
1693 * runs on all PMUs of a block.
1694 * Perf doesn't support mixed events from different PMUs in the same
1695 * group. The big group has to be split into multiple small groups
1696 * which only include the events from the same PMU.
1698 * Here the uncore event aliases must be from the same uncore block.
1699 * The number of PMUs must be same for each alias. The number of new
1700 * small groups equals to the number of PMUs.
1701 * Setting the leader event for corresponding members in each group.
1703 i = 0;
1704 __evlist__for_each_entry(list, evsel) {
1705 if (i >= nr_pmu)
1706 i = 0;
1707 evsel->leader = (struct evsel *) leaders[i++];
1710 /* The number of members and group name are same for each group */
1711 for (i = 0; i < nr_pmu; i++) {
1712 evsel = (struct evsel *) leaders[i];
1713 evsel->core.nr_members = total_members / nr_pmu;
1714 evsel->group_name = name ? strdup(name) : NULL;
1717 /* Take the new small groups into account */
1718 parse_state->nr_groups += nr_pmu - 1;
1720 handled:
1721 ret = 1;
1722 out:
1723 free(leaders);
1724 return ret;
1727 void parse_events__set_leader(char *name, struct list_head *list,
1728 struct parse_events_state *parse_state)
1730 struct evsel *leader;
1732 if (list_empty(list)) {
1733 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1734 return;
1737 if (parse_events__set_leader_for_uncore_aliase(name, list, parse_state))
1738 return;
1740 __perf_evlist__set_leader(list);
1741 leader = list_entry(list->next, struct evsel, core.node);
1742 leader->group_name = name ? strdup(name) : NULL;
1745 /* list_event is assumed to point to malloc'ed memory */
1746 void parse_events_update_lists(struct list_head *list_event,
1747 struct list_head *list_all)
1750 * Called for single event definition. Update the
1751 * 'all event' list, and reinit the 'single event'
1752 * list, for next event definition.
1754 list_splice_tail(list_event, list_all);
1755 free(list_event);
1758 struct event_modifier {
1759 int eu;
1760 int ek;
1761 int eh;
1762 int eH;
1763 int eG;
1764 int eI;
1765 int precise;
1766 int precise_max;
1767 int exclude_GH;
1768 int sample_read;
1769 int pinned;
1770 int weak;
1773 static int get_event_modifier(struct event_modifier *mod, char *str,
1774 struct evsel *evsel)
1776 int eu = evsel ? evsel->core.attr.exclude_user : 0;
1777 int ek = evsel ? evsel->core.attr.exclude_kernel : 0;
1778 int eh = evsel ? evsel->core.attr.exclude_hv : 0;
1779 int eH = evsel ? evsel->core.attr.exclude_host : 0;
1780 int eG = evsel ? evsel->core.attr.exclude_guest : 0;
1781 int eI = evsel ? evsel->core.attr.exclude_idle : 0;
1782 int precise = evsel ? evsel->core.attr.precise_ip : 0;
1783 int precise_max = 0;
1784 int sample_read = 0;
1785 int pinned = evsel ? evsel->core.attr.pinned : 0;
1787 int exclude = eu | ek | eh;
1788 int exclude_GH = evsel ? evsel->exclude_GH : 0;
1789 int weak = 0;
1791 memset(mod, 0, sizeof(*mod));
1793 while (*str) {
1794 if (*str == 'u') {
1795 if (!exclude)
1796 exclude = eu = ek = eh = 1;
1797 eu = 0;
1798 } else if (*str == 'k') {
1799 if (!exclude)
1800 exclude = eu = ek = eh = 1;
1801 ek = 0;
1802 } else if (*str == 'h') {
1803 if (!exclude)
1804 exclude = eu = ek = eh = 1;
1805 eh = 0;
1806 } else if (*str == 'G') {
1807 if (!exclude_GH)
1808 exclude_GH = eG = eH = 1;
1809 eG = 0;
1810 } else if (*str == 'H') {
1811 if (!exclude_GH)
1812 exclude_GH = eG = eH = 1;
1813 eH = 0;
1814 } else if (*str == 'I') {
1815 eI = 1;
1816 } else if (*str == 'p') {
1817 precise++;
1818 /* use of precise requires exclude_guest */
1819 if (!exclude_GH)
1820 eG = 1;
1821 } else if (*str == 'P') {
1822 precise_max = 1;
1823 } else if (*str == 'S') {
1824 sample_read = 1;
1825 } else if (*str == 'D') {
1826 pinned = 1;
1827 } else if (*str == 'W') {
1828 weak = 1;
1829 } else
1830 break;
1832 ++str;
1836 * precise ip:
1838 * 0 - SAMPLE_IP can have arbitrary skid
1839 * 1 - SAMPLE_IP must have constant skid
1840 * 2 - SAMPLE_IP requested to have 0 skid
1841 * 3 - SAMPLE_IP must have 0 skid
1843 * See also PERF_RECORD_MISC_EXACT_IP
1845 if (precise > 3)
1846 return -EINVAL;
1848 mod->eu = eu;
1849 mod->ek = ek;
1850 mod->eh = eh;
1851 mod->eH = eH;
1852 mod->eG = eG;
1853 mod->eI = eI;
1854 mod->precise = precise;
1855 mod->precise_max = precise_max;
1856 mod->exclude_GH = exclude_GH;
1857 mod->sample_read = sample_read;
1858 mod->pinned = pinned;
1859 mod->weak = weak;
1861 return 0;
1865 * Basic modifier sanity check to validate it contains only one
1866 * instance of any modifier (apart from 'p') present.
1868 static int check_modifier(char *str)
1870 char *p = str;
1872 /* The sizeof includes 0 byte as well. */
1873 if (strlen(str) > (sizeof("ukhGHpppPSDIW") - 1))
1874 return -1;
1876 while (*p) {
1877 if (*p != 'p' && strchr(p + 1, *p))
1878 return -1;
1879 p++;
1882 return 0;
1885 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
1887 struct evsel *evsel;
1888 struct event_modifier mod;
1890 if (str == NULL)
1891 return 0;
1893 if (check_modifier(str))
1894 return -EINVAL;
1896 if (!add && get_event_modifier(&mod, str, NULL))
1897 return -EINVAL;
1899 __evlist__for_each_entry(list, evsel) {
1900 if (add && get_event_modifier(&mod, str, evsel))
1901 return -EINVAL;
1903 evsel->core.attr.exclude_user = mod.eu;
1904 evsel->core.attr.exclude_kernel = mod.ek;
1905 evsel->core.attr.exclude_hv = mod.eh;
1906 evsel->core.attr.precise_ip = mod.precise;
1907 evsel->core.attr.exclude_host = mod.eH;
1908 evsel->core.attr.exclude_guest = mod.eG;
1909 evsel->core.attr.exclude_idle = mod.eI;
1910 evsel->exclude_GH = mod.exclude_GH;
1911 evsel->sample_read = mod.sample_read;
1912 evsel->precise_max = mod.precise_max;
1913 evsel->weak_group = mod.weak;
1915 if (evsel__is_group_leader(evsel))
1916 evsel->core.attr.pinned = mod.pinned;
1919 return 0;
1922 int parse_events_name(struct list_head *list, char *name)
1924 struct evsel *evsel;
1926 __evlist__for_each_entry(list, evsel) {
1927 if (!evsel->name)
1928 evsel->name = strdup(name);
1931 return 0;
1934 static int
1935 comp_pmu(const void *p1, const void *p2)
1937 struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
1938 struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
1940 return strcasecmp(pmu1->symbol, pmu2->symbol);
1943 static void perf_pmu__parse_cleanup(void)
1945 if (perf_pmu_events_list_num > 0) {
1946 struct perf_pmu_event_symbol *p;
1947 int i;
1949 for (i = 0; i < perf_pmu_events_list_num; i++) {
1950 p = perf_pmu_events_list + i;
1951 zfree(&p->symbol);
1953 zfree(&perf_pmu_events_list);
1954 perf_pmu_events_list_num = 0;
1958 #define SET_SYMBOL(str, stype) \
1959 do { \
1960 p->symbol = str; \
1961 if (!p->symbol) \
1962 goto err; \
1963 p->type = stype; \
1964 } while (0)
1967 * Read the pmu events list from sysfs
1968 * Save it into perf_pmu_events_list
1970 static void perf_pmu__parse_init(void)
1973 struct perf_pmu *pmu = NULL;
1974 struct perf_pmu_alias *alias;
1975 int len = 0;
1977 pmu = NULL;
1978 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1979 list_for_each_entry(alias, &pmu->aliases, list) {
1980 if (strchr(alias->name, '-'))
1981 len++;
1982 len++;
1986 if (len == 0) {
1987 perf_pmu_events_list_num = -1;
1988 return;
1990 perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
1991 if (!perf_pmu_events_list)
1992 return;
1993 perf_pmu_events_list_num = len;
1995 len = 0;
1996 pmu = NULL;
1997 while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1998 list_for_each_entry(alias, &pmu->aliases, list) {
1999 struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
2000 char *tmp = strchr(alias->name, '-');
2002 if (tmp != NULL) {
2003 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
2004 PMU_EVENT_SYMBOL_PREFIX);
2005 p++;
2006 SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
2007 len += 2;
2008 } else {
2009 SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
2010 len++;
2014 qsort(perf_pmu_events_list, len,
2015 sizeof(struct perf_pmu_event_symbol), comp_pmu);
2017 return;
2018 err:
2019 perf_pmu__parse_cleanup();
2023 * This function injects special term in
2024 * perf_pmu_events_list so the test code
2025 * can check on this functionality.
2027 int perf_pmu__test_parse_init(void)
2029 struct perf_pmu_event_symbol *list;
2031 list = malloc(sizeof(*list) * 1);
2032 if (!list)
2033 return -ENOMEM;
2035 list->type = PMU_EVENT_SYMBOL;
2036 list->symbol = strdup("read");
2038 if (!list->symbol) {
2039 free(list);
2040 return -ENOMEM;
2043 perf_pmu_events_list = list;
2044 perf_pmu_events_list_num = 1;
2045 return 0;
2048 enum perf_pmu_event_symbol_type
2049 perf_pmu__parse_check(const char *name)
2051 struct perf_pmu_event_symbol p, *r;
2053 /* scan kernel pmu events from sysfs if needed */
2054 if (perf_pmu_events_list_num == 0)
2055 perf_pmu__parse_init();
2057 * name "cpu" could be prefix of cpu-cycles or cpu// events.
2058 * cpu-cycles has been handled by hardcode.
2059 * So it must be cpu// events, not kernel pmu event.
2061 if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
2062 return PMU_EVENT_SYMBOL_ERR;
2064 p.symbol = strdup(name);
2065 r = bsearch(&p, perf_pmu_events_list,
2066 (size_t) perf_pmu_events_list_num,
2067 sizeof(struct perf_pmu_event_symbol), comp_pmu);
2068 zfree(&p.symbol);
2069 return r ? r->type : PMU_EVENT_SYMBOL_ERR;
2072 static int parse_events__scanner(const char *str,
2073 struct parse_events_state *parse_state)
2075 YY_BUFFER_STATE buffer;
2076 void *scanner;
2077 int ret;
2079 ret = parse_events_lex_init_extra(parse_state, &scanner);
2080 if (ret)
2081 return ret;
2083 buffer = parse_events__scan_string(str, scanner);
2085 #ifdef PARSER_DEBUG
2086 parse_events_debug = 1;
2087 parse_events_set_debug(1, scanner);
2088 #endif
2089 ret = parse_events_parse(parse_state, scanner);
2091 parse_events__flush_buffer(buffer, scanner);
2092 parse_events__delete_buffer(buffer, scanner);
2093 parse_events_lex_destroy(scanner);
2094 return ret;
2098 * parse event config string, return a list of event terms.
2100 int parse_events_terms(struct list_head *terms, const char *str)
2102 struct parse_events_state parse_state = {
2103 .terms = NULL,
2104 .stoken = PE_START_TERMS,
2106 int ret;
2108 ret = parse_events__scanner(str, &parse_state);
2109 perf_pmu__parse_cleanup();
2111 if (!ret) {
2112 list_splice(parse_state.terms, terms);
2113 zfree(&parse_state.terms);
2114 return 0;
2117 parse_events_terms__delete(parse_state.terms);
2118 return ret;
2121 int __parse_events(struct evlist *evlist, const char *str,
2122 struct parse_events_error *err, struct perf_pmu *fake_pmu)
2124 struct parse_events_state parse_state = {
2125 .list = LIST_HEAD_INIT(parse_state.list),
2126 .idx = evlist->core.nr_entries,
2127 .error = err,
2128 .evlist = evlist,
2129 .stoken = PE_START_EVENTS,
2130 .fake_pmu = fake_pmu,
2132 int ret;
2134 ret = parse_events__scanner(str, &parse_state);
2135 perf_pmu__parse_cleanup();
2137 if (!ret && list_empty(&parse_state.list)) {
2138 WARN_ONCE(true, "WARNING: event parser found nothing\n");
2139 return -1;
2143 * Add list to the evlist even with errors to allow callers to clean up.
2145 perf_evlist__splice_list_tail(evlist, &parse_state.list);
2147 if (!ret) {
2148 struct evsel *last;
2150 evlist->nr_groups += parse_state.nr_groups;
2151 last = evlist__last(evlist);
2152 last->cmdline_group_boundary = true;
2154 return 0;
2158 * There are 2 users - builtin-record and builtin-test objects.
2159 * Both call evlist__delete in case of error, so we dont
2160 * need to bother.
2162 return ret;
2165 #define MAX_WIDTH 1000
2166 static int get_term_width(void)
2168 struct winsize ws;
2170 get_term_dimensions(&ws);
2171 return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
2174 static void __parse_events_print_error(int err_idx, const char *err_str,
2175 const char *err_help, const char *event)
2177 const char *str = "invalid or unsupported event: ";
2178 char _buf[MAX_WIDTH];
2179 char *buf = (char *) event;
2180 int idx = 0;
2181 if (err_str) {
2182 /* -2 for extra '' in the final fprintf */
2183 int width = get_term_width() - 2;
2184 int len_event = strlen(event);
2185 int len_str, max_len, cut = 0;
2188 * Maximum error index indent, we will cut
2189 * the event string if it's bigger.
2191 int max_err_idx = 13;
2194 * Let's be specific with the message when
2195 * we have the precise error.
2197 str = "event syntax error: ";
2198 len_str = strlen(str);
2199 max_len = width - len_str;
2201 buf = _buf;
2203 /* We're cutting from the beginning. */
2204 if (err_idx > max_err_idx)
2205 cut = err_idx - max_err_idx;
2207 strncpy(buf, event + cut, max_len);
2209 /* Mark cut parts with '..' on both sides. */
2210 if (cut)
2211 buf[0] = buf[1] = '.';
2213 if ((len_event - cut) > max_len) {
2214 buf[max_len - 1] = buf[max_len - 2] = '.';
2215 buf[max_len] = 0;
2218 idx = len_str + err_idx - cut;
2221 fprintf(stderr, "%s'%s'\n", str, buf);
2222 if (idx) {
2223 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err_str);
2224 if (err_help)
2225 fprintf(stderr, "\n%s\n", err_help);
2229 void parse_events_print_error(struct parse_events_error *err,
2230 const char *event)
2232 if (!err->num_errors)
2233 return;
2235 __parse_events_print_error(err->idx, err->str, err->help, event);
2236 zfree(&err->str);
2237 zfree(&err->help);
2239 if (err->num_errors > 1) {
2240 fputs("\nInitial error:\n", stderr);
2241 __parse_events_print_error(err->first_idx, err->first_str,
2242 err->first_help, event);
2243 zfree(&err->first_str);
2244 zfree(&err->first_help);
2248 #undef MAX_WIDTH
2250 int parse_events_option(const struct option *opt, const char *str,
2251 int unset __maybe_unused)
2253 struct evlist *evlist = *(struct evlist **)opt->value;
2254 struct parse_events_error err;
2255 int ret;
2257 bzero(&err, sizeof(err));
2258 ret = parse_events(evlist, str, &err);
2260 if (ret) {
2261 parse_events_print_error(&err, str);
2262 fprintf(stderr, "Run 'perf list' for a list of valid events\n");
2265 return ret;
2268 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset)
2270 struct evlist **evlistp = opt->value;
2271 int ret;
2273 if (*evlistp == NULL) {
2274 *evlistp = evlist__new();
2276 if (*evlistp == NULL) {
2277 fprintf(stderr, "Not enough memory to create evlist\n");
2278 return -1;
2282 ret = parse_events_option(opt, str, unset);
2283 if (ret) {
2284 evlist__delete(*evlistp);
2285 *evlistp = NULL;
2288 return ret;
2291 static int
2292 foreach_evsel_in_last_glob(struct evlist *evlist,
2293 int (*func)(struct evsel *evsel,
2294 const void *arg),
2295 const void *arg)
2297 struct evsel *last = NULL;
2298 int err;
2301 * Don't return when list_empty, give func a chance to report
2302 * error when it found last == NULL.
2304 * So no need to WARN here, let *func do this.
2306 if (evlist->core.nr_entries > 0)
2307 last = evlist__last(evlist);
2309 do {
2310 err = (*func)(last, arg);
2311 if (err)
2312 return -1;
2313 if (!last)
2314 return 0;
2316 if (last->core.node.prev == &evlist->core.entries)
2317 return 0;
2318 last = list_entry(last->core.node.prev, struct evsel, core.node);
2319 } while (!last->cmdline_group_boundary);
2321 return 0;
2324 static int set_filter(struct evsel *evsel, const void *arg)
2326 const char *str = arg;
2327 bool found = false;
2328 int nr_addr_filters = 0;
2329 struct perf_pmu *pmu = NULL;
2331 if (evsel == NULL) {
2332 fprintf(stderr,
2333 "--filter option should follow a -e tracepoint or HW tracer option\n");
2334 return -1;
2337 if (evsel->core.attr.type == PERF_TYPE_TRACEPOINT) {
2338 if (evsel__append_tp_filter(evsel, str) < 0) {
2339 fprintf(stderr,
2340 "not enough memory to hold filter string\n");
2341 return -1;
2344 return 0;
2347 while ((pmu = perf_pmu__scan(pmu)) != NULL)
2348 if (pmu->type == evsel->core.attr.type) {
2349 found = true;
2350 break;
2353 if (found)
2354 perf_pmu__scan_file(pmu, "nr_addr_filters",
2355 "%d", &nr_addr_filters);
2357 if (!nr_addr_filters) {
2358 fprintf(stderr,
2359 "This CPU does not support address filtering\n");
2360 return -1;
2363 if (evsel__append_addr_filter(evsel, str) < 0) {
2364 fprintf(stderr,
2365 "not enough memory to hold filter string\n");
2366 return -1;
2369 return 0;
2372 int parse_filter(const struct option *opt, const char *str,
2373 int unset __maybe_unused)
2375 struct evlist *evlist = *(struct evlist **)opt->value;
2377 return foreach_evsel_in_last_glob(evlist, set_filter,
2378 (const void *)str);
2381 static int add_exclude_perf_filter(struct evsel *evsel,
2382 const void *arg __maybe_unused)
2384 char new_filter[64];
2386 if (evsel == NULL || evsel->core.attr.type != PERF_TYPE_TRACEPOINT) {
2387 fprintf(stderr,
2388 "--exclude-perf option should follow a -e tracepoint option\n");
2389 return -1;
2392 snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
2394 if (evsel__append_tp_filter(evsel, new_filter) < 0) {
2395 fprintf(stderr,
2396 "not enough memory to hold filter string\n");
2397 return -1;
2400 return 0;
2403 int exclude_perf(const struct option *opt,
2404 const char *arg __maybe_unused,
2405 int unset __maybe_unused)
2407 struct evlist *evlist = *(struct evlist **)opt->value;
2409 return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
2410 NULL);
2413 static const char * const event_type_descriptors[] = {
2414 "Hardware event",
2415 "Software event",
2416 "Tracepoint event",
2417 "Hardware cache event",
2418 "Raw hardware event descriptor",
2419 "Hardware breakpoint",
2422 static int cmp_string(const void *a, const void *b)
2424 const char * const *as = a;
2425 const char * const *bs = b;
2427 return strcmp(*as, *bs);
2431 * Print the events from <debugfs_mount_point>/tracing/events
2434 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
2435 bool name_only)
2437 DIR *sys_dir, *evt_dir;
2438 struct dirent *sys_dirent, *evt_dirent;
2439 char evt_path[MAXPATHLEN];
2440 char *dir_path;
2441 char **evt_list = NULL;
2442 unsigned int evt_i = 0, evt_num = 0;
2443 bool evt_num_known = false;
2445 restart:
2446 sys_dir = tracing_events__opendir();
2447 if (!sys_dir)
2448 return;
2450 if (evt_num_known) {
2451 evt_list = zalloc(sizeof(char *) * evt_num);
2452 if (!evt_list)
2453 goto out_close_sys_dir;
2456 for_each_subsystem(sys_dir, sys_dirent) {
2457 if (subsys_glob != NULL &&
2458 !strglobmatch(sys_dirent->d_name, subsys_glob))
2459 continue;
2461 dir_path = get_events_file(sys_dirent->d_name);
2462 if (!dir_path)
2463 continue;
2464 evt_dir = opendir(dir_path);
2465 if (!evt_dir)
2466 goto next;
2468 for_each_event(dir_path, evt_dir, evt_dirent) {
2469 if (event_glob != NULL &&
2470 !strglobmatch(evt_dirent->d_name, event_glob))
2471 continue;
2473 if (!evt_num_known) {
2474 evt_num++;
2475 continue;
2478 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2479 sys_dirent->d_name, evt_dirent->d_name);
2481 evt_list[evt_i] = strdup(evt_path);
2482 if (evt_list[evt_i] == NULL) {
2483 put_events_file(dir_path);
2484 goto out_close_evt_dir;
2486 evt_i++;
2488 closedir(evt_dir);
2489 next:
2490 put_events_file(dir_path);
2492 closedir(sys_dir);
2494 if (!evt_num_known) {
2495 evt_num_known = true;
2496 goto restart;
2498 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2499 evt_i = 0;
2500 while (evt_i < evt_num) {
2501 if (name_only) {
2502 printf("%s ", evt_list[evt_i++]);
2503 continue;
2505 printf(" %-50s [%s]\n", evt_list[evt_i++],
2506 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2508 if (evt_num && pager_in_use())
2509 printf("\n");
2511 out_free:
2512 evt_num = evt_i;
2513 for (evt_i = 0; evt_i < evt_num; evt_i++)
2514 zfree(&evt_list[evt_i]);
2515 zfree(&evt_list);
2516 return;
2518 out_close_evt_dir:
2519 closedir(evt_dir);
2520 out_close_sys_dir:
2521 closedir(sys_dir);
2523 printf("FATAL: not enough memory to print %s\n",
2524 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2525 if (evt_list)
2526 goto out_free;
2530 * Check whether event is in <debugfs_mount_point>/tracing/events
2533 int is_valid_tracepoint(const char *event_string)
2535 DIR *sys_dir, *evt_dir;
2536 struct dirent *sys_dirent, *evt_dirent;
2537 char evt_path[MAXPATHLEN];
2538 char *dir_path;
2540 sys_dir = tracing_events__opendir();
2541 if (!sys_dir)
2542 return 0;
2544 for_each_subsystem(sys_dir, sys_dirent) {
2545 dir_path = get_events_file(sys_dirent->d_name);
2546 if (!dir_path)
2547 continue;
2548 evt_dir = opendir(dir_path);
2549 if (!evt_dir)
2550 goto next;
2552 for_each_event(dir_path, evt_dir, evt_dirent) {
2553 snprintf(evt_path, MAXPATHLEN, "%s:%s",
2554 sys_dirent->d_name, evt_dirent->d_name);
2555 if (!strcmp(evt_path, event_string)) {
2556 closedir(evt_dir);
2557 closedir(sys_dir);
2558 return 1;
2561 closedir(evt_dir);
2562 next:
2563 put_events_file(dir_path);
2565 closedir(sys_dir);
2566 return 0;
2569 static bool is_event_supported(u8 type, unsigned config)
2571 bool ret = true;
2572 int open_return;
2573 struct evsel *evsel;
2574 struct perf_event_attr attr = {
2575 .type = type,
2576 .config = config,
2577 .disabled = 1,
2579 struct perf_thread_map *tmap = thread_map__new_by_tid(0);
2581 if (tmap == NULL)
2582 return false;
2584 evsel = evsel__new(&attr);
2585 if (evsel) {
2586 open_return = evsel__open(evsel, NULL, tmap);
2587 ret = open_return >= 0;
2589 if (open_return == -EACCES) {
2591 * This happens if the paranoid value
2592 * /proc/sys/kernel/perf_event_paranoid is set to 2
2593 * Re-run with exclude_kernel set; we don't do that
2594 * by default as some ARM machines do not support it.
2597 evsel->core.attr.exclude_kernel = 1;
2598 ret = evsel__open(evsel, NULL, tmap) >= 0;
2600 evsel__delete(evsel);
2603 perf_thread_map__put(tmap);
2604 return ret;
2607 void print_sdt_events(const char *subsys_glob, const char *event_glob,
2608 bool name_only)
2610 struct probe_cache *pcache;
2611 struct probe_cache_entry *ent;
2612 struct strlist *bidlist, *sdtlist;
2613 struct strlist_config cfg = {.dont_dupstr = true};
2614 struct str_node *nd, *nd2;
2615 char *buf, *path, *ptr = NULL;
2616 bool show_detail = false;
2617 int ret;
2619 sdtlist = strlist__new(NULL, &cfg);
2620 if (!sdtlist) {
2621 pr_debug("Failed to allocate new strlist for SDT\n");
2622 return;
2624 bidlist = build_id_cache__list_all(true);
2625 if (!bidlist) {
2626 pr_debug("Failed to get buildids: %d\n", errno);
2627 return;
2629 strlist__for_each_entry(nd, bidlist) {
2630 pcache = probe_cache__new(nd->s, NULL);
2631 if (!pcache)
2632 continue;
2633 list_for_each_entry(ent, &pcache->entries, node) {
2634 if (!ent->sdt)
2635 continue;
2636 if (subsys_glob &&
2637 !strglobmatch(ent->pev.group, subsys_glob))
2638 continue;
2639 if (event_glob &&
2640 !strglobmatch(ent->pev.event, event_glob))
2641 continue;
2642 ret = asprintf(&buf, "%s:%s@%s", ent->pev.group,
2643 ent->pev.event, nd->s);
2644 if (ret > 0)
2645 strlist__add(sdtlist, buf);
2647 probe_cache__delete(pcache);
2649 strlist__delete(bidlist);
2651 strlist__for_each_entry(nd, sdtlist) {
2652 buf = strchr(nd->s, '@');
2653 if (buf)
2654 *(buf++) = '\0';
2655 if (name_only) {
2656 printf("%s ", nd->s);
2657 continue;
2659 nd2 = strlist__next(nd);
2660 if (nd2) {
2661 ptr = strchr(nd2->s, '@');
2662 if (ptr)
2663 *ptr = '\0';
2664 if (strcmp(nd->s, nd2->s) == 0)
2665 show_detail = true;
2667 if (show_detail) {
2668 path = build_id_cache__origname(buf);
2669 ret = asprintf(&buf, "%s@%s(%.12s)", nd->s, path, buf);
2670 if (ret > 0) {
2671 printf(" %-50s [%s]\n", buf, "SDT event");
2672 free(buf);
2674 free(path);
2675 } else
2676 printf(" %-50s [%s]\n", nd->s, "SDT event");
2677 if (nd2) {
2678 if (strcmp(nd->s, nd2->s) != 0)
2679 show_detail = false;
2680 if (ptr)
2681 *ptr = '@';
2684 strlist__delete(sdtlist);
2687 int print_hwcache_events(const char *event_glob, bool name_only)
2689 unsigned int type, op, i, evt_i = 0, evt_num = 0;
2690 char name[64];
2691 char **evt_list = NULL;
2692 bool evt_num_known = false;
2694 restart:
2695 if (evt_num_known) {
2696 evt_list = zalloc(sizeof(char *) * evt_num);
2697 if (!evt_list)
2698 goto out_enomem;
2701 for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
2702 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
2703 /* skip invalid cache type */
2704 if (!evsel__is_cache_op_valid(type, op))
2705 continue;
2707 for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
2708 __evsel__hw_cache_type_op_res_name(type, op, i, name, sizeof(name));
2709 if (event_glob != NULL && !strglobmatch(name, event_glob))
2710 continue;
2712 if (!is_event_supported(PERF_TYPE_HW_CACHE,
2713 type | (op << 8) | (i << 16)))
2714 continue;
2716 if (!evt_num_known) {
2717 evt_num++;
2718 continue;
2721 evt_list[evt_i] = strdup(name);
2722 if (evt_list[evt_i] == NULL)
2723 goto out_enomem;
2724 evt_i++;
2729 if (!evt_num_known) {
2730 evt_num_known = true;
2731 goto restart;
2733 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2734 evt_i = 0;
2735 while (evt_i < evt_num) {
2736 if (name_only) {
2737 printf("%s ", evt_list[evt_i++]);
2738 continue;
2740 printf(" %-50s [%s]\n", evt_list[evt_i++],
2741 event_type_descriptors[PERF_TYPE_HW_CACHE]);
2743 if (evt_num && pager_in_use())
2744 printf("\n");
2746 out_free:
2747 evt_num = evt_i;
2748 for (evt_i = 0; evt_i < evt_num; evt_i++)
2749 zfree(&evt_list[evt_i]);
2750 zfree(&evt_list);
2751 return evt_num;
2753 out_enomem:
2754 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
2755 if (evt_list)
2756 goto out_free;
2757 return evt_num;
2760 static void print_tool_event(const char *name, const char *event_glob,
2761 bool name_only)
2763 if (event_glob && !strglobmatch(name, event_glob))
2764 return;
2765 if (name_only)
2766 printf("%s ", name);
2767 else
2768 printf(" %-50s [%s]\n", name, "Tool event");
2772 void print_tool_events(const char *event_glob, bool name_only)
2774 print_tool_event("duration_time", event_glob, name_only);
2775 if (pager_in_use())
2776 printf("\n");
2779 void print_symbol_events(const char *event_glob, unsigned type,
2780 struct event_symbol *syms, unsigned max,
2781 bool name_only)
2783 unsigned int i, evt_i = 0, evt_num = 0;
2784 char name[MAX_NAME_LEN];
2785 char **evt_list = NULL;
2786 bool evt_num_known = false;
2788 restart:
2789 if (evt_num_known) {
2790 evt_list = zalloc(sizeof(char *) * evt_num);
2791 if (!evt_list)
2792 goto out_enomem;
2793 syms -= max;
2796 for (i = 0; i < max; i++, syms++) {
2798 if (event_glob != NULL && syms->symbol != NULL &&
2799 !(strglobmatch(syms->symbol, event_glob) ||
2800 (syms->alias && strglobmatch(syms->alias, event_glob))))
2801 continue;
2803 if (!is_event_supported(type, i))
2804 continue;
2806 if (!evt_num_known) {
2807 evt_num++;
2808 continue;
2811 if (!name_only && strlen(syms->alias))
2812 snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
2813 else
2814 strlcpy(name, syms->symbol, MAX_NAME_LEN);
2816 evt_list[evt_i] = strdup(name);
2817 if (evt_list[evt_i] == NULL)
2818 goto out_enomem;
2819 evt_i++;
2822 if (!evt_num_known) {
2823 evt_num_known = true;
2824 goto restart;
2826 qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2827 evt_i = 0;
2828 while (evt_i < evt_num) {
2829 if (name_only) {
2830 printf("%s ", evt_list[evt_i++]);
2831 continue;
2833 printf(" %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
2835 if (evt_num && pager_in_use())
2836 printf("\n");
2838 out_free:
2839 evt_num = evt_i;
2840 for (evt_i = 0; evt_i < evt_num; evt_i++)
2841 zfree(&evt_list[evt_i]);
2842 zfree(&evt_list);
2843 return;
2845 out_enomem:
2846 printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
2847 if (evt_list)
2848 goto out_free;
2852 * Print the help text for the event symbols:
2854 void print_events(const char *event_glob, bool name_only, bool quiet_flag,
2855 bool long_desc, bool details_flag, bool deprecated)
2857 print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
2858 event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
2860 print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
2861 event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
2862 print_tool_events(event_glob, name_only);
2864 print_hwcache_events(event_glob, name_only);
2866 print_pmu_events(event_glob, name_only, quiet_flag, long_desc,
2867 details_flag, deprecated);
2869 if (event_glob != NULL)
2870 return;
2872 if (!name_only) {
2873 printf(" %-50s [%s]\n",
2874 "rNNN",
2875 event_type_descriptors[PERF_TYPE_RAW]);
2876 printf(" %-50s [%s]\n",
2877 "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
2878 event_type_descriptors[PERF_TYPE_RAW]);
2879 if (pager_in_use())
2880 printf(" (see 'man perf-list' on how to encode it)\n\n");
2882 printf(" %-50s [%s]\n",
2883 "mem:<addr>[/len][:access]",
2884 event_type_descriptors[PERF_TYPE_BREAKPOINT]);
2885 if (pager_in_use())
2886 printf("\n");
2889 print_tracepoint_events(NULL, NULL, name_only);
2891 print_sdt_events(NULL, NULL, name_only);
2893 metricgroup__print(true, true, NULL, name_only, details_flag);
2895 print_libpfm_events(name_only, long_desc);
2898 int parse_events__is_hardcoded_term(struct parse_events_term *term)
2900 return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
2903 static int new_term(struct parse_events_term **_term,
2904 struct parse_events_term *temp,
2905 char *str, u64 num)
2907 struct parse_events_term *term;
2909 term = malloc(sizeof(*term));
2910 if (!term)
2911 return -ENOMEM;
2913 *term = *temp;
2914 INIT_LIST_HEAD(&term->list);
2915 term->weak = false;
2917 switch (term->type_val) {
2918 case PARSE_EVENTS__TERM_TYPE_NUM:
2919 term->val.num = num;
2920 break;
2921 case PARSE_EVENTS__TERM_TYPE_STR:
2922 term->val.str = str;
2923 break;
2924 default:
2925 free(term);
2926 return -EINVAL;
2929 *_term = term;
2930 return 0;
2933 int parse_events_term__num(struct parse_events_term **term,
2934 int type_term, char *config, u64 num,
2935 bool no_value,
2936 void *loc_term_, void *loc_val_)
2938 YYLTYPE *loc_term = loc_term_;
2939 YYLTYPE *loc_val = loc_val_;
2941 struct parse_events_term temp = {
2942 .type_val = PARSE_EVENTS__TERM_TYPE_NUM,
2943 .type_term = type_term,
2944 .config = config,
2945 .no_value = no_value,
2946 .err_term = loc_term ? loc_term->first_column : 0,
2947 .err_val = loc_val ? loc_val->first_column : 0,
2950 return new_term(term, &temp, NULL, num);
2953 int parse_events_term__str(struct parse_events_term **term,
2954 int type_term, char *config, char *str,
2955 void *loc_term_, void *loc_val_)
2957 YYLTYPE *loc_term = loc_term_;
2958 YYLTYPE *loc_val = loc_val_;
2960 struct parse_events_term temp = {
2961 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2962 .type_term = type_term,
2963 .config = config,
2964 .err_term = loc_term ? loc_term->first_column : 0,
2965 .err_val = loc_val ? loc_val->first_column : 0,
2968 return new_term(term, &temp, str, 0);
2971 int parse_events_term__sym_hw(struct parse_events_term **term,
2972 char *config, unsigned idx)
2974 struct event_symbol *sym;
2975 char *str;
2976 struct parse_events_term temp = {
2977 .type_val = PARSE_EVENTS__TERM_TYPE_STR,
2978 .type_term = PARSE_EVENTS__TERM_TYPE_USER,
2979 .config = config,
2982 if (!temp.config) {
2983 temp.config = strdup("event");
2984 if (!temp.config)
2985 return -ENOMEM;
2987 BUG_ON(idx >= PERF_COUNT_HW_MAX);
2988 sym = &event_symbols_hw[idx];
2990 str = strdup(sym->symbol);
2991 if (!str)
2992 return -ENOMEM;
2993 return new_term(term, &temp, str, 0);
2996 int parse_events_term__clone(struct parse_events_term **new,
2997 struct parse_events_term *term)
2999 char *str;
3000 struct parse_events_term temp = {
3001 .type_val = term->type_val,
3002 .type_term = term->type_term,
3003 .config = NULL,
3004 .err_term = term->err_term,
3005 .err_val = term->err_val,
3008 if (term->config) {
3009 temp.config = strdup(term->config);
3010 if (!temp.config)
3011 return -ENOMEM;
3013 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
3014 return new_term(new, &temp, NULL, term->val.num);
3016 str = strdup(term->val.str);
3017 if (!str)
3018 return -ENOMEM;
3019 return new_term(new, &temp, str, 0);
3022 void parse_events_term__delete(struct parse_events_term *term)
3024 if (term->array.nr_ranges)
3025 zfree(&term->array.ranges);
3027 if (term->type_val != PARSE_EVENTS__TERM_TYPE_NUM)
3028 zfree(&term->val.str);
3030 zfree(&term->config);
3031 free(term);
3034 int parse_events_copy_term_list(struct list_head *old,
3035 struct list_head **new)
3037 struct parse_events_term *term, *n;
3038 int ret;
3040 if (!old) {
3041 *new = NULL;
3042 return 0;
3045 *new = malloc(sizeof(struct list_head));
3046 if (!*new)
3047 return -ENOMEM;
3048 INIT_LIST_HEAD(*new);
3050 list_for_each_entry (term, old, list) {
3051 ret = parse_events_term__clone(&n, term);
3052 if (ret)
3053 return ret;
3054 list_add_tail(&n->list, *new);
3056 return 0;
3059 void parse_events_terms__purge(struct list_head *terms)
3061 struct parse_events_term *term, *h;
3063 list_for_each_entry_safe(term, h, terms, list) {
3064 list_del_init(&term->list);
3065 parse_events_term__delete(term);
3069 void parse_events_terms__delete(struct list_head *terms)
3071 if (!terms)
3072 return;
3073 parse_events_terms__purge(terms);
3074 free(terms);
3077 void parse_events__clear_array(struct parse_events_array *a)
3079 zfree(&a->ranges);
3082 void parse_events_evlist_error(struct parse_events_state *parse_state,
3083 int idx, const char *str)
3085 if (!parse_state->error)
3086 return;
3088 parse_events__handle_error(parse_state->error, idx, strdup(str), NULL);
3091 static void config_terms_list(char *buf, size_t buf_sz)
3093 int i;
3094 bool first = true;
3096 buf[0] = '\0';
3097 for (i = 0; i < __PARSE_EVENTS__TERM_TYPE_NR; i++) {
3098 const char *name = config_term_names[i];
3100 if (!config_term_avail(i, NULL))
3101 continue;
3102 if (!name)
3103 continue;
3104 if (name[0] == '<')
3105 continue;
3107 if (strlen(buf) + strlen(name) + 2 >= buf_sz)
3108 return;
3110 if (!first)
3111 strcat(buf, ",");
3112 else
3113 first = false;
3114 strcat(buf, name);
3119 * Return string contains valid config terms of an event.
3120 * @additional_terms: For terms such as PMU sysfs terms.
3122 char *parse_events_formats_error_string(char *additional_terms)
3124 char *str;
3125 /* "no-overwrite" is the longest name */
3126 char static_terms[__PARSE_EVENTS__TERM_TYPE_NR *
3127 (sizeof("no-overwrite") - 1)];
3129 config_terms_list(static_terms, sizeof(static_terms));
3130 /* valid terms */
3131 if (additional_terms) {
3132 if (asprintf(&str, "valid terms: %s,%s",
3133 additional_terms, static_terms) < 0)
3134 goto fail;
3135 } else {
3136 if (asprintf(&str, "valid terms: %s", static_terms) < 0)
3137 goto fail;
3139 return str;
3141 fail:
3142 return NULL;