1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/hw_breakpoint.h>
10 #include <sys/param.h>
15 #include <subcmd/parse-options.h>
16 #include "parse-events.h"
17 #include <subcmd/exec-cmd.h>
23 #include "bpf-loader.h"
25 #include <api/fs/tracing_path.h>
26 #include "parse-events-bison.h"
27 #define YY_EXTRA_TYPE int
28 #include "parse-events-flex.h"
30 #include "thread_map.h"
32 #include "probe-file.h"
34 #include "util/parse-branch-options.h"
35 #include "metricgroup.h"
37 #define MAX_NAME_LEN 100
40 extern int parse_events_debug
;
42 int parse_events_parse(void *parse_state
, void *scanner
);
43 static int get_config_terms(struct list_head
*head_config
,
44 struct list_head
*head_terms __maybe_unused
);
46 static struct perf_pmu_event_symbol
*perf_pmu_events_list
;
48 * The variable indicates the number of supported pmu event symbols.
49 * 0 means not initialized and ready to init
50 * -1 means failed to init, don't try anymore
51 * >0 is the number of supported pmu event symbols
53 static int perf_pmu_events_list_num
;
55 struct event_symbol event_symbols_hw
[PERF_COUNT_HW_MAX
] = {
56 [PERF_COUNT_HW_CPU_CYCLES
] = {
57 .symbol
= "cpu-cycles",
60 [PERF_COUNT_HW_INSTRUCTIONS
] = {
61 .symbol
= "instructions",
64 [PERF_COUNT_HW_CACHE_REFERENCES
] = {
65 .symbol
= "cache-references",
68 [PERF_COUNT_HW_CACHE_MISSES
] = {
69 .symbol
= "cache-misses",
72 [PERF_COUNT_HW_BRANCH_INSTRUCTIONS
] = {
73 .symbol
= "branch-instructions",
76 [PERF_COUNT_HW_BRANCH_MISSES
] = {
77 .symbol
= "branch-misses",
80 [PERF_COUNT_HW_BUS_CYCLES
] = {
81 .symbol
= "bus-cycles",
84 [PERF_COUNT_HW_STALLED_CYCLES_FRONTEND
] = {
85 .symbol
= "stalled-cycles-frontend",
86 .alias
= "idle-cycles-frontend",
88 [PERF_COUNT_HW_STALLED_CYCLES_BACKEND
] = {
89 .symbol
= "stalled-cycles-backend",
90 .alias
= "idle-cycles-backend",
92 [PERF_COUNT_HW_REF_CPU_CYCLES
] = {
93 .symbol
= "ref-cycles",
98 struct event_symbol event_symbols_sw
[PERF_COUNT_SW_MAX
] = {
99 [PERF_COUNT_SW_CPU_CLOCK
] = {
100 .symbol
= "cpu-clock",
103 [PERF_COUNT_SW_TASK_CLOCK
] = {
104 .symbol
= "task-clock",
107 [PERF_COUNT_SW_PAGE_FAULTS
] = {
108 .symbol
= "page-faults",
111 [PERF_COUNT_SW_CONTEXT_SWITCHES
] = {
112 .symbol
= "context-switches",
115 [PERF_COUNT_SW_CPU_MIGRATIONS
] = {
116 .symbol
= "cpu-migrations",
117 .alias
= "migrations",
119 [PERF_COUNT_SW_PAGE_FAULTS_MIN
] = {
120 .symbol
= "minor-faults",
123 [PERF_COUNT_SW_PAGE_FAULTS_MAJ
] = {
124 .symbol
= "major-faults",
127 [PERF_COUNT_SW_ALIGNMENT_FAULTS
] = {
128 .symbol
= "alignment-faults",
131 [PERF_COUNT_SW_EMULATION_FAULTS
] = {
132 .symbol
= "emulation-faults",
135 [PERF_COUNT_SW_DUMMY
] = {
139 [PERF_COUNT_SW_BPF_OUTPUT
] = {
140 .symbol
= "bpf-output",
145 #define __PERF_EVENT_FIELD(config, name) \
146 ((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
148 #define PERF_EVENT_RAW(config) __PERF_EVENT_FIELD(config, RAW)
149 #define PERF_EVENT_CONFIG(config) __PERF_EVENT_FIELD(config, CONFIG)
150 #define PERF_EVENT_TYPE(config) __PERF_EVENT_FIELD(config, TYPE)
151 #define PERF_EVENT_ID(config) __PERF_EVENT_FIELD(config, EVENT)
153 #define for_each_subsystem(sys_dir, sys_dirent) \
154 while ((sys_dirent = readdir(sys_dir)) != NULL) \
155 if (sys_dirent->d_type == DT_DIR && \
156 (strcmp(sys_dirent->d_name, ".")) && \
157 (strcmp(sys_dirent->d_name, "..")))
159 static int tp_event_has_id(struct dirent
*sys_dir
, struct dirent
*evt_dir
)
161 char evt_path
[MAXPATHLEN
];
164 snprintf(evt_path
, MAXPATHLEN
, "%s/%s/%s/id", tracing_events_path
,
165 sys_dir
->d_name
, evt_dir
->d_name
);
166 fd
= open(evt_path
, O_RDONLY
);
174 #define for_each_event(sys_dirent, evt_dir, evt_dirent) \
175 while ((evt_dirent = readdir(evt_dir)) != NULL) \
176 if (evt_dirent->d_type == DT_DIR && \
177 (strcmp(evt_dirent->d_name, ".")) && \
178 (strcmp(evt_dirent->d_name, "..")) && \
179 (!tp_event_has_id(sys_dirent, evt_dirent)))
181 #define MAX_EVENT_LENGTH 512
184 struct tracepoint_path
*tracepoint_id_to_path(u64 config
)
186 struct tracepoint_path
*path
= NULL
;
187 DIR *sys_dir
, *evt_dir
;
188 struct dirent
*sys_dirent
, *evt_dirent
;
192 char evt_path
[MAXPATHLEN
];
193 char dir_path
[MAXPATHLEN
];
195 sys_dir
= opendir(tracing_events_path
);
199 for_each_subsystem(sys_dir
, sys_dirent
) {
201 snprintf(dir_path
, MAXPATHLEN
, "%s/%s", tracing_events_path
,
203 evt_dir
= opendir(dir_path
);
207 for_each_event(sys_dirent
, evt_dir
, evt_dirent
) {
209 snprintf(evt_path
, MAXPATHLEN
, "%s/%s/id", dir_path
,
211 fd
= open(evt_path
, O_RDONLY
);
214 if (read(fd
, id_buf
, sizeof(id_buf
)) < 0) {
223 path
= zalloc(sizeof(*path
));
226 path
->system
= malloc(MAX_EVENT_LENGTH
);
231 path
->name
= malloc(MAX_EVENT_LENGTH
);
233 zfree(&path
->system
);
237 strncpy(path
->system
, sys_dirent
->d_name
,
239 strncpy(path
->name
, evt_dirent
->d_name
,
251 struct tracepoint_path
*tracepoint_name_to_path(const char *name
)
253 struct tracepoint_path
*path
= zalloc(sizeof(*path
));
254 char *str
= strchr(name
, ':');
256 if (path
== NULL
|| str
== NULL
) {
261 path
->system
= strndup(name
, str
- name
);
262 path
->name
= strdup(str
+1);
264 if (path
->system
== NULL
|| path
->name
== NULL
) {
265 zfree(&path
->system
);
273 const char *event_type(int type
)
276 case PERF_TYPE_HARDWARE
:
279 case PERF_TYPE_SOFTWARE
:
282 case PERF_TYPE_TRACEPOINT
:
285 case PERF_TYPE_HW_CACHE
:
286 return "hardware-cache";
295 static int parse_events__is_name_term(struct parse_events_term
*term
)
297 return term
->type_term
== PARSE_EVENTS__TERM_TYPE_NAME
;
300 static char *get_config_name(struct list_head
*head_terms
)
302 struct parse_events_term
*term
;
307 list_for_each_entry(term
, head_terms
, list
)
308 if (parse_events__is_name_term(term
))
309 return term
->val
.str
;
314 static struct perf_evsel
*
315 __add_event(struct list_head
*list
, int *idx
,
316 struct perf_event_attr
*attr
,
317 char *name
, struct perf_pmu
*pmu
,
318 struct list_head
*config_terms
, bool auto_merge_stats
)
320 struct perf_evsel
*evsel
;
321 struct cpu_map
*cpus
= pmu
? pmu
->cpus
: NULL
;
323 event_attr_init(attr
);
325 evsel
= perf_evsel__new_idx(attr
, *idx
);
330 evsel
->cpus
= cpu_map__get(cpus
);
331 evsel
->own_cpus
= cpu_map__get(cpus
);
332 evsel
->system_wide
= pmu
? pmu
->is_uncore
: false;
333 evsel
->auto_merge_stats
= auto_merge_stats
;
336 evsel
->name
= strdup(name
);
339 list_splice(config_terms
, &evsel
->config_terms
);
341 list_add_tail(&evsel
->node
, list
);
345 static int add_event(struct list_head
*list
, int *idx
,
346 struct perf_event_attr
*attr
, char *name
,
347 struct list_head
*config_terms
)
349 return __add_event(list
, idx
, attr
, name
, NULL
, config_terms
, false) ? 0 : -ENOMEM
;
352 static int parse_aliases(char *str
, const char *names
[][PERF_EVSEL__MAX_ALIASES
], int size
)
357 for (i
= 0; i
< size
; i
++) {
358 for (j
= 0; j
< PERF_EVSEL__MAX_ALIASES
&& names
[i
][j
]; j
++) {
359 n
= strlen(names
[i
][j
]);
360 if (n
> longest
&& !strncasecmp(str
, names
[i
][j
], n
))
370 typedef int config_term_func_t(struct perf_event_attr
*attr
,
371 struct parse_events_term
*term
,
372 struct parse_events_error
*err
);
373 static int config_term_common(struct perf_event_attr
*attr
,
374 struct parse_events_term
*term
,
375 struct parse_events_error
*err
);
376 static int config_attr(struct perf_event_attr
*attr
,
377 struct list_head
*head
,
378 struct parse_events_error
*err
,
379 config_term_func_t config_term
);
381 int parse_events_add_cache(struct list_head
*list
, int *idx
,
382 char *type
, char *op_result1
, char *op_result2
,
383 struct parse_events_error
*err
,
384 struct list_head
*head_config
)
386 struct perf_event_attr attr
;
387 LIST_HEAD(config_terms
);
388 char name
[MAX_NAME_LEN
], *config_name
;
389 int cache_type
= -1, cache_op
= -1, cache_result
= -1;
390 char *op_result
[2] = { op_result1
, op_result2
};
394 * No fallback - if we cannot get a clear cache type
397 cache_type
= parse_aliases(type
, perf_evsel__hw_cache
,
398 PERF_COUNT_HW_CACHE_MAX
);
399 if (cache_type
== -1)
402 config_name
= get_config_name(head_config
);
403 n
= snprintf(name
, MAX_NAME_LEN
, "%s", type
);
405 for (i
= 0; (i
< 2) && (op_result
[i
]); i
++) {
406 char *str
= op_result
[i
];
408 n
+= snprintf(name
+ n
, MAX_NAME_LEN
- n
, "-%s", str
);
410 if (cache_op
== -1) {
411 cache_op
= parse_aliases(str
, perf_evsel__hw_cache_op
,
412 PERF_COUNT_HW_CACHE_OP_MAX
);
414 if (!perf_evsel__is_cache_op_valid(cache_type
, cache_op
))
420 if (cache_result
== -1) {
421 cache_result
= parse_aliases(str
, perf_evsel__hw_cache_result
,
422 PERF_COUNT_HW_CACHE_RESULT_MAX
);
423 if (cache_result
>= 0)
429 * Fall back to reads:
432 cache_op
= PERF_COUNT_HW_CACHE_OP_READ
;
435 * Fall back to accesses:
437 if (cache_result
== -1)
438 cache_result
= PERF_COUNT_HW_CACHE_RESULT_ACCESS
;
440 memset(&attr
, 0, sizeof(attr
));
441 attr
.config
= cache_type
| (cache_op
<< 8) | (cache_result
<< 16);
442 attr
.type
= PERF_TYPE_HW_CACHE
;
445 if (config_attr(&attr
, head_config
, err
,
449 if (get_config_terms(head_config
, &config_terms
))
452 return add_event(list
, idx
, &attr
, config_name
? : name
, &config_terms
);
455 static void tracepoint_error(struct parse_events_error
*e
, int err
,
456 const char *sys
, const char *name
)
464 * We get error directly from syscall errno ( > 0),
465 * or from encoded pointer's error ( < 0).
471 e
->str
= strdup("can't access trace events");
474 e
->str
= strdup("unknown tracepoint");
477 e
->str
= strdup("failed to add tracepoint");
481 tracing_path__strerror_open_tp(err
, help
, sizeof(help
), sys
, name
);
482 e
->help
= strdup(help
);
485 static int add_tracepoint(struct list_head
*list
, int *idx
,
486 const char *sys_name
, const char *evt_name
,
487 struct parse_events_error
*err
,
488 struct list_head
*head_config
)
490 struct perf_evsel
*evsel
;
492 evsel
= perf_evsel__newtp_idx(sys_name
, evt_name
, (*idx
)++);
494 tracepoint_error(err
, PTR_ERR(evsel
), sys_name
, evt_name
);
495 return PTR_ERR(evsel
);
499 LIST_HEAD(config_terms
);
501 if (get_config_terms(head_config
, &config_terms
))
503 list_splice(&config_terms
, &evsel
->config_terms
);
506 list_add_tail(&evsel
->node
, list
);
510 static int add_tracepoint_multi_event(struct list_head
*list
, int *idx
,
511 const char *sys_name
, const char *evt_name
,
512 struct parse_events_error
*err
,
513 struct list_head
*head_config
)
515 char evt_path
[MAXPATHLEN
];
516 struct dirent
*evt_ent
;
518 int ret
= 0, found
= 0;
520 snprintf(evt_path
, MAXPATHLEN
, "%s/%s", tracing_events_path
, sys_name
);
521 evt_dir
= opendir(evt_path
);
523 tracepoint_error(err
, errno
, sys_name
, evt_name
);
527 while (!ret
&& (evt_ent
= readdir(evt_dir
))) {
528 if (!strcmp(evt_ent
->d_name
, ".")
529 || !strcmp(evt_ent
->d_name
, "..")
530 || !strcmp(evt_ent
->d_name
, "enable")
531 || !strcmp(evt_ent
->d_name
, "filter"))
534 if (!strglobmatch(evt_ent
->d_name
, evt_name
))
539 ret
= add_tracepoint(list
, idx
, sys_name
, evt_ent
->d_name
,
544 tracepoint_error(err
, ENOENT
, sys_name
, evt_name
);
552 static int add_tracepoint_event(struct list_head
*list
, int *idx
,
553 const char *sys_name
, const char *evt_name
,
554 struct parse_events_error
*err
,
555 struct list_head
*head_config
)
557 return strpbrk(evt_name
, "*?") ?
558 add_tracepoint_multi_event(list
, idx
, sys_name
, evt_name
,
560 add_tracepoint(list
, idx
, sys_name
, evt_name
,
564 static int add_tracepoint_multi_sys(struct list_head
*list
, int *idx
,
565 const char *sys_name
, const char *evt_name
,
566 struct parse_events_error
*err
,
567 struct list_head
*head_config
)
569 struct dirent
*events_ent
;
573 events_dir
= opendir(tracing_events_path
);
575 tracepoint_error(err
, errno
, sys_name
, evt_name
);
579 while (!ret
&& (events_ent
= readdir(events_dir
))) {
580 if (!strcmp(events_ent
->d_name
, ".")
581 || !strcmp(events_ent
->d_name
, "..")
582 || !strcmp(events_ent
->d_name
, "enable")
583 || !strcmp(events_ent
->d_name
, "header_event")
584 || !strcmp(events_ent
->d_name
, "header_page"))
587 if (!strglobmatch(events_ent
->d_name
, sys_name
))
590 ret
= add_tracepoint_event(list
, idx
, events_ent
->d_name
,
591 evt_name
, err
, head_config
);
594 closedir(events_dir
);
598 struct __add_bpf_event_param
{
599 struct parse_events_state
*parse_state
;
600 struct list_head
*list
;
601 struct list_head
*head_config
;
604 static int add_bpf_event(const char *group
, const char *event
, int fd
,
607 LIST_HEAD(new_evsels
);
608 struct __add_bpf_event_param
*param
= _param
;
609 struct parse_events_state
*parse_state
= param
->parse_state
;
610 struct list_head
*list
= param
->list
;
611 struct perf_evsel
*pos
;
614 pr_debug("add bpf event %s:%s and attach bpf program %d\n",
617 err
= parse_events_add_tracepoint(&new_evsels
, &parse_state
->idx
, group
,
618 event
, parse_state
->error
,
621 struct perf_evsel
*evsel
, *tmp
;
623 pr_debug("Failed to add BPF event %s:%s\n",
625 list_for_each_entry_safe(evsel
, tmp
, &new_evsels
, node
) {
626 list_del(&evsel
->node
);
627 perf_evsel__delete(evsel
);
631 pr_debug("adding %s:%s\n", group
, event
);
633 list_for_each_entry(pos
, &new_evsels
, node
) {
634 pr_debug("adding %s:%s to %p\n",
638 list_splice(&new_evsels
, list
);
642 int parse_events_load_bpf_obj(struct parse_events_state
*parse_state
,
643 struct list_head
*list
,
644 struct bpf_object
*obj
,
645 struct list_head
*head_config
)
649 struct __add_bpf_event_param param
= {parse_state
, list
, head_config
};
650 static bool registered_unprobe_atexit
= false;
652 if (IS_ERR(obj
) || !obj
) {
653 snprintf(errbuf
, sizeof(errbuf
),
654 "Internal error: load bpf obj with NULL");
660 * Register atexit handler before calling bpf__probe() so
661 * bpf__probe() don't need to unprobe probe points its already
662 * created when failure.
664 if (!registered_unprobe_atexit
) {
666 registered_unprobe_atexit
= true;
669 err
= bpf__probe(obj
);
671 bpf__strerror_probe(obj
, err
, errbuf
, sizeof(errbuf
));
675 err
= bpf__load(obj
);
677 bpf__strerror_load(obj
, err
, errbuf
, sizeof(errbuf
));
681 err
= bpf__foreach_event(obj
, add_bpf_event
, ¶m
);
683 snprintf(errbuf
, sizeof(errbuf
),
684 "Attach events in BPF object failed");
690 parse_state
->error
->help
= strdup("(add -v to see detail)");
691 parse_state
->error
->str
= strdup(errbuf
);
696 parse_events_config_bpf(struct parse_events_state
*parse_state
,
697 struct bpf_object
*obj
,
698 struct list_head
*head_config
)
700 struct parse_events_term
*term
;
703 if (!head_config
|| list_empty(head_config
))
706 list_for_each_entry(term
, head_config
, list
) {
710 if (term
->type_term
!= PARSE_EVENTS__TERM_TYPE_USER
) {
711 snprintf(errbuf
, sizeof(errbuf
),
712 "Invalid config term for BPF object");
713 errbuf
[BUFSIZ
- 1] = '\0';
715 parse_state
->error
->idx
= term
->err_term
;
716 parse_state
->error
->str
= strdup(errbuf
);
720 err
= bpf__config_obj(obj
, term
, parse_state
->evlist
, &error_pos
);
722 bpf__strerror_config_obj(obj
, term
, parse_state
->evlist
,
723 &error_pos
, err
, errbuf
,
725 parse_state
->error
->help
= strdup(
726 "Hint:\tValid config terms:\n"
727 " \tmap:[<arraymap>].value<indices>=[value]\n"
728 " \tmap:[<eventmap>].event<indices>=[event]\n"
730 " \twhere <indices> is something like [0,3...5] or [all]\n"
731 " \t(add -v to see detail)");
732 parse_state
->error
->str
= strdup(errbuf
);
733 if (err
== -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE
)
734 parse_state
->error
->idx
= term
->err_val
;
736 parse_state
->error
->idx
= term
->err_term
+ error_pos
;
744 * Split config terms:
745 * perf record -e bpf.c/call-graph=fp,map:array.value[0]=1/ ...
746 * 'call-graph=fp' is 'evt config', should be applied to each
748 * 'map:array.value[0]=1' is 'obj config', should be processed
749 * with parse_events_config_bpf.
751 * Move object config terms from the first list to obj_head_config.
754 split_bpf_config_terms(struct list_head
*evt_head_config
,
755 struct list_head
*obj_head_config
)
757 struct parse_events_term
*term
, *temp
;
760 * Currectly, all possible user config term
761 * belong to bpf object. parse_events__is_hardcoded_term()
762 * happends to be a good flag.
764 * See parse_events_config_bpf() and
765 * config_term_tracepoint().
767 list_for_each_entry_safe(term
, temp
, evt_head_config
, list
)
768 if (!parse_events__is_hardcoded_term(term
))
769 list_move_tail(&term
->list
, obj_head_config
);
772 int parse_events_load_bpf(struct parse_events_state
*parse_state
,
773 struct list_head
*list
,
776 struct list_head
*head_config
)
779 struct bpf_object
*obj
;
780 LIST_HEAD(obj_head_config
);
783 split_bpf_config_terms(head_config
, &obj_head_config
);
785 obj
= bpf__prepare_load(bpf_file_name
, source
);
792 snprintf(errbuf
, sizeof(errbuf
),
793 "BPF support is not compiled");
795 bpf__strerror_prepare_load(bpf_file_name
,
800 parse_state
->error
->help
= strdup("(add -v to see detail)");
801 parse_state
->error
->str
= strdup(errbuf
);
805 err
= parse_events_load_bpf_obj(parse_state
, list
, obj
, head_config
);
808 err
= parse_events_config_bpf(parse_state
, obj
, &obj_head_config
);
811 * Caller doesn't know anything about obj_head_config,
812 * so combine them together again before returnning.
815 list_splice_tail(&obj_head_config
, head_config
);
820 parse_breakpoint_type(const char *type
, struct perf_event_attr
*attr
)
824 for (i
= 0; i
< 3; i
++) {
825 if (!type
|| !type
[i
])
828 #define CHECK_SET_TYPE(bit) \
830 if (attr->bp_type & bit) \
833 attr->bp_type |= bit; \
838 CHECK_SET_TYPE(HW_BREAKPOINT_R
);
841 CHECK_SET_TYPE(HW_BREAKPOINT_W
);
844 CHECK_SET_TYPE(HW_BREAKPOINT_X
);
851 #undef CHECK_SET_TYPE
853 if (!attr
->bp_type
) /* Default */
854 attr
->bp_type
= HW_BREAKPOINT_R
| HW_BREAKPOINT_W
;
859 int parse_events_add_breakpoint(struct list_head
*list
, int *idx
,
860 void *ptr
, char *type
, u64 len
)
862 struct perf_event_attr attr
;
864 memset(&attr
, 0, sizeof(attr
));
865 attr
.bp_addr
= (unsigned long) ptr
;
867 if (parse_breakpoint_type(type
, &attr
))
870 /* Provide some defaults if len is not specified */
872 if (attr
.bp_type
== HW_BREAKPOINT_X
)
875 len
= HW_BREAKPOINT_LEN_4
;
880 attr
.type
= PERF_TYPE_BREAKPOINT
;
881 attr
.sample_period
= 1;
883 return add_event(list
, idx
, &attr
, NULL
, NULL
);
886 static int check_type_val(struct parse_events_term
*term
,
887 struct parse_events_error
*err
,
890 if (type
== term
->type_val
)
894 err
->idx
= term
->err_val
;
895 if (type
== PARSE_EVENTS__TERM_TYPE_NUM
)
896 err
->str
= strdup("expected numeric value");
898 err
->str
= strdup("expected string value");
904 * Update according to parse-events.l
906 static const char *config_term_names
[__PARSE_EVENTS__TERM_TYPE_NR
] = {
907 [PARSE_EVENTS__TERM_TYPE_USER
] = "<sysfs term>",
908 [PARSE_EVENTS__TERM_TYPE_CONFIG
] = "config",
909 [PARSE_EVENTS__TERM_TYPE_CONFIG1
] = "config1",
910 [PARSE_EVENTS__TERM_TYPE_CONFIG2
] = "config2",
911 [PARSE_EVENTS__TERM_TYPE_NAME
] = "name",
912 [PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD
] = "period",
913 [PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ
] = "freq",
914 [PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE
] = "branch_type",
915 [PARSE_EVENTS__TERM_TYPE_TIME
] = "time",
916 [PARSE_EVENTS__TERM_TYPE_CALLGRAPH
] = "call-graph",
917 [PARSE_EVENTS__TERM_TYPE_STACKSIZE
] = "stack-size",
918 [PARSE_EVENTS__TERM_TYPE_NOINHERIT
] = "no-inherit",
919 [PARSE_EVENTS__TERM_TYPE_INHERIT
] = "inherit",
920 [PARSE_EVENTS__TERM_TYPE_MAX_STACK
] = "max-stack",
921 [PARSE_EVENTS__TERM_TYPE_OVERWRITE
] = "overwrite",
922 [PARSE_EVENTS__TERM_TYPE_NOOVERWRITE
] = "no-overwrite",
923 [PARSE_EVENTS__TERM_TYPE_DRV_CFG
] = "driver-config",
926 static bool config_term_shrinked
;
929 config_term_avail(int term_type
, struct parse_events_error
*err
)
931 if (term_type
< 0 || term_type
>= __PARSE_EVENTS__TERM_TYPE_NR
) {
932 err
->str
= strdup("Invalid term_type");
935 if (!config_term_shrinked
)
939 case PARSE_EVENTS__TERM_TYPE_CONFIG
:
940 case PARSE_EVENTS__TERM_TYPE_CONFIG1
:
941 case PARSE_EVENTS__TERM_TYPE_CONFIG2
:
942 case PARSE_EVENTS__TERM_TYPE_NAME
:
943 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD
:
949 /* term_type is validated so indexing is safe */
950 if (asprintf(&err
->str
, "'%s' is not usable in 'perf stat'",
951 config_term_names
[term_type
]) < 0)
957 void parse_events__shrink_config_terms(void)
959 config_term_shrinked
= true;
962 static int config_term_common(struct perf_event_attr
*attr
,
963 struct parse_events_term
*term
,
964 struct parse_events_error
*err
)
966 #define CHECK_TYPE_VAL(type) \
968 if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
972 switch (term
->type_term
) {
973 case PARSE_EVENTS__TERM_TYPE_CONFIG
:
975 attr
->config
= term
->val
.num
;
977 case PARSE_EVENTS__TERM_TYPE_CONFIG1
:
979 attr
->config1
= term
->val
.num
;
981 case PARSE_EVENTS__TERM_TYPE_CONFIG2
:
983 attr
->config2
= term
->val
.num
;
985 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD
:
988 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ
:
991 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE
:
993 if (strcmp(term
->val
.str
, "no") &&
994 parse_branch_str(term
->val
.str
, &attr
->branch_sample_type
)) {
995 err
->str
= strdup("invalid branch sample type");
996 err
->idx
= term
->err_val
;
1000 case PARSE_EVENTS__TERM_TYPE_TIME
:
1001 CHECK_TYPE_VAL(NUM
);
1002 if (term
->val
.num
> 1) {
1003 err
->str
= strdup("expected 0 or 1");
1004 err
->idx
= term
->err_val
;
1008 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH
:
1009 CHECK_TYPE_VAL(STR
);
1011 case PARSE_EVENTS__TERM_TYPE_STACKSIZE
:
1012 CHECK_TYPE_VAL(NUM
);
1014 case PARSE_EVENTS__TERM_TYPE_INHERIT
:
1015 CHECK_TYPE_VAL(NUM
);
1017 case PARSE_EVENTS__TERM_TYPE_NOINHERIT
:
1018 CHECK_TYPE_VAL(NUM
);
1020 case PARSE_EVENTS__TERM_TYPE_OVERWRITE
:
1021 CHECK_TYPE_VAL(NUM
);
1023 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE
:
1024 CHECK_TYPE_VAL(NUM
);
1026 case PARSE_EVENTS__TERM_TYPE_NAME
:
1027 CHECK_TYPE_VAL(STR
);
1029 case PARSE_EVENTS__TERM_TYPE_MAX_STACK
:
1030 CHECK_TYPE_VAL(NUM
);
1033 err
->str
= strdup("unknown term");
1034 err
->idx
= term
->err_term
;
1035 err
->help
= parse_events_formats_error_string(NULL
);
1040 * Check term availbility after basic checking so
1041 * PARSE_EVENTS__TERM_TYPE_USER can be found and filtered.
1043 * If check availbility at the entry of this function,
1044 * user will see "'<sysfs term>' is not usable in 'perf stat'"
1045 * if an invalid config term is provided for legacy events
1046 * (for example, instructions/badterm/...), which is confusing.
1048 if (!config_term_avail(term
->type_term
, err
))
1051 #undef CHECK_TYPE_VAL
1054 static int config_term_pmu(struct perf_event_attr
*attr
,
1055 struct parse_events_term
*term
,
1056 struct parse_events_error
*err
)
1058 if (term
->type_term
== PARSE_EVENTS__TERM_TYPE_USER
||
1059 term
->type_term
== PARSE_EVENTS__TERM_TYPE_DRV_CFG
)
1061 * Always succeed for sysfs terms, as we dont know
1062 * at this point what type they need to have.
1066 return config_term_common(attr
, term
, err
);
1069 static int config_term_tracepoint(struct perf_event_attr
*attr
,
1070 struct parse_events_term
*term
,
1071 struct parse_events_error
*err
)
1073 switch (term
->type_term
) {
1074 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH
:
1075 case PARSE_EVENTS__TERM_TYPE_STACKSIZE
:
1076 case PARSE_EVENTS__TERM_TYPE_INHERIT
:
1077 case PARSE_EVENTS__TERM_TYPE_NOINHERIT
:
1078 case PARSE_EVENTS__TERM_TYPE_MAX_STACK
:
1079 case PARSE_EVENTS__TERM_TYPE_OVERWRITE
:
1080 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE
:
1081 return config_term_common(attr
, term
, err
);
1084 err
->idx
= term
->err_term
;
1085 err
->str
= strdup("unknown term");
1086 err
->help
= strdup("valid terms: call-graph,stack-size\n");
1094 static int config_attr(struct perf_event_attr
*attr
,
1095 struct list_head
*head
,
1096 struct parse_events_error
*err
,
1097 config_term_func_t config_term
)
1099 struct parse_events_term
*term
;
1101 list_for_each_entry(term
, head
, list
)
1102 if (config_term(attr
, term
, err
))
1108 static int get_config_terms(struct list_head
*head_config
,
1109 struct list_head
*head_terms __maybe_unused
)
1111 #define ADD_CONFIG_TERM(__type, __name, __val) \
1113 struct perf_evsel_config_term *__t; \
1115 __t = zalloc(sizeof(*__t)); \
1119 INIT_LIST_HEAD(&__t->list); \
1120 __t->type = PERF_EVSEL__CONFIG_TERM_ ## __type; \
1121 __t->val.__name = __val; \
1122 __t->weak = term->weak; \
1123 list_add_tail(&__t->list, head_terms); \
1126 struct parse_events_term
*term
;
1128 list_for_each_entry(term
, head_config
, list
) {
1129 switch (term
->type_term
) {
1130 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD
:
1131 ADD_CONFIG_TERM(PERIOD
, period
, term
->val
.num
);
1133 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ
:
1134 ADD_CONFIG_TERM(FREQ
, freq
, term
->val
.num
);
1136 case PARSE_EVENTS__TERM_TYPE_TIME
:
1137 ADD_CONFIG_TERM(TIME
, time
, term
->val
.num
);
1139 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH
:
1140 ADD_CONFIG_TERM(CALLGRAPH
, callgraph
, term
->val
.str
);
1142 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE
:
1143 ADD_CONFIG_TERM(BRANCH
, branch
, term
->val
.str
);
1145 case PARSE_EVENTS__TERM_TYPE_STACKSIZE
:
1146 ADD_CONFIG_TERM(STACK_USER
, stack_user
, term
->val
.num
);
1148 case PARSE_EVENTS__TERM_TYPE_INHERIT
:
1149 ADD_CONFIG_TERM(INHERIT
, inherit
, term
->val
.num
? 1 : 0);
1151 case PARSE_EVENTS__TERM_TYPE_NOINHERIT
:
1152 ADD_CONFIG_TERM(INHERIT
, inherit
, term
->val
.num
? 0 : 1);
1154 case PARSE_EVENTS__TERM_TYPE_MAX_STACK
:
1155 ADD_CONFIG_TERM(MAX_STACK
, max_stack
, term
->val
.num
);
1157 case PARSE_EVENTS__TERM_TYPE_OVERWRITE
:
1158 ADD_CONFIG_TERM(OVERWRITE
, overwrite
, term
->val
.num
? 1 : 0);
1160 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE
:
1161 ADD_CONFIG_TERM(OVERWRITE
, overwrite
, term
->val
.num
? 0 : 1);
1163 case PARSE_EVENTS__TERM_TYPE_DRV_CFG
:
1164 ADD_CONFIG_TERM(DRV_CFG
, drv_cfg
, term
->val
.str
);
1170 #undef ADD_EVSEL_CONFIG
1174 int parse_events_add_tracepoint(struct list_head
*list
, int *idx
,
1175 const char *sys
, const char *event
,
1176 struct parse_events_error
*err
,
1177 struct list_head
*head_config
)
1180 struct perf_event_attr attr
;
1182 if (config_attr(&attr
, head_config
, err
,
1183 config_term_tracepoint
))
1187 if (strpbrk(sys
, "*?"))
1188 return add_tracepoint_multi_sys(list
, idx
, sys
, event
,
1191 return add_tracepoint_event(list
, idx
, sys
, event
,
1195 int parse_events_add_numeric(struct parse_events_state
*parse_state
,
1196 struct list_head
*list
,
1197 u32 type
, u64 config
,
1198 struct list_head
*head_config
)
1200 struct perf_event_attr attr
;
1201 LIST_HEAD(config_terms
);
1203 memset(&attr
, 0, sizeof(attr
));
1205 attr
.config
= config
;
1208 if (config_attr(&attr
, head_config
, parse_state
->error
,
1209 config_term_common
))
1212 if (get_config_terms(head_config
, &config_terms
))
1216 return add_event(list
, &parse_state
->idx
, &attr
,
1217 get_config_name(head_config
), &config_terms
);
1220 static int __parse_events_add_pmu(struct parse_events_state
*parse_state
,
1221 struct list_head
*list
, char *name
,
1222 struct list_head
*head_config
, bool auto_merge_stats
)
1224 struct perf_event_attr attr
;
1225 struct perf_pmu_info info
;
1226 struct perf_pmu
*pmu
;
1227 struct perf_evsel
*evsel
;
1228 struct parse_events_error
*err
= parse_state
->error
;
1229 LIST_HEAD(config_terms
);
1231 pmu
= perf_pmu__find(name
);
1233 if (asprintf(&err
->str
,
1234 "Cannot find PMU `%s'. Missing kernel support?",
1240 if (pmu
->default_config
) {
1241 memcpy(&attr
, pmu
->default_config
,
1242 sizeof(struct perf_event_attr
));
1244 memset(&attr
, 0, sizeof(attr
));
1248 attr
.type
= pmu
->type
;
1249 evsel
= __add_event(list
, &parse_state
->idx
, &attr
, NULL
, pmu
, NULL
, auto_merge_stats
);
1250 return evsel
? 0 : -ENOMEM
;
1253 if (perf_pmu__check_alias(pmu
, head_config
, &info
))
1257 * Configure hardcoded terms first, no need to check
1258 * return value when called with fail == 0 ;)
1260 if (config_attr(&attr
, head_config
, parse_state
->error
, config_term_pmu
))
1263 if (get_config_terms(head_config
, &config_terms
))
1266 if (perf_pmu__config(pmu
, &attr
, head_config
, parse_state
->error
))
1269 evsel
= __add_event(list
, &parse_state
->idx
, &attr
,
1270 get_config_name(head_config
), pmu
,
1271 &config_terms
, auto_merge_stats
);
1273 evsel
->unit
= info
.unit
;
1274 evsel
->scale
= info
.scale
;
1275 evsel
->per_pkg
= info
.per_pkg
;
1276 evsel
->snapshot
= info
.snapshot
;
1277 evsel
->metric_expr
= info
.metric_expr
;
1278 evsel
->metric_name
= info
.metric_name
;
1281 return evsel
? 0 : -ENOMEM
;
1284 int parse_events_add_pmu(struct parse_events_state
*parse_state
,
1285 struct list_head
*list
, char *name
,
1286 struct list_head
*head_config
)
1288 return __parse_events_add_pmu(parse_state
, list
, name
, head_config
, false);
1291 int parse_events_multi_pmu_add(struct parse_events_state
*parse_state
,
1292 char *str
, struct list_head
**listp
)
1294 struct list_head
*head
;
1295 struct parse_events_term
*term
;
1296 struct list_head
*list
;
1297 struct perf_pmu
*pmu
= NULL
;
1301 /* Add it for all PMUs that support the alias */
1302 list
= malloc(sizeof(struct list_head
));
1305 INIT_LIST_HEAD(list
);
1306 while ((pmu
= perf_pmu__scan(pmu
)) != NULL
) {
1307 struct perf_pmu_alias
*alias
;
1309 list_for_each_entry(alias
, &pmu
->aliases
, list
) {
1310 if (!strcasecmp(alias
->name
, str
)) {
1311 head
= malloc(sizeof(struct list_head
));
1314 INIT_LIST_HEAD(head
);
1315 if (parse_events_term__num(&term
, PARSE_EVENTS__TERM_TYPE_USER
,
1316 str
, 1, false, &str
, NULL
) < 0)
1318 list_add_tail(&term
->list
, head
);
1320 if (!__parse_events_add_pmu(parse_state
, list
,
1321 pmu
->name
, head
, true)) {
1322 pr_debug("%s -> %s/%s/\n", str
,
1323 pmu
->name
, alias
->str
);
1327 parse_events_terms__delete(head
);
1337 int parse_events__modifier_group(struct list_head
*list
,
1340 return parse_events__modifier_event(list
, event_mod
, true);
1343 void parse_events__set_leader(char *name
, struct list_head
*list
)
1345 struct perf_evsel
*leader
;
1347 if (list_empty(list
)) {
1348 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1352 __perf_evlist__set_leader(list
);
1353 leader
= list_entry(list
->next
, struct perf_evsel
, node
);
1354 leader
->group_name
= name
? strdup(name
) : NULL
;
1357 /* list_event is assumed to point to malloc'ed memory */
1358 void parse_events_update_lists(struct list_head
*list_event
,
1359 struct list_head
*list_all
)
1362 * Called for single event definition. Update the
1363 * 'all event' list, and reinit the 'single event'
1364 * list, for next event definition.
1366 list_splice_tail(list_event
, list_all
);
1370 struct event_modifier
{
1385 static int get_event_modifier(struct event_modifier
*mod
, char *str
,
1386 struct perf_evsel
*evsel
)
1388 int eu
= evsel
? evsel
->attr
.exclude_user
: 0;
1389 int ek
= evsel
? evsel
->attr
.exclude_kernel
: 0;
1390 int eh
= evsel
? evsel
->attr
.exclude_hv
: 0;
1391 int eH
= evsel
? evsel
->attr
.exclude_host
: 0;
1392 int eG
= evsel
? evsel
->attr
.exclude_guest
: 0;
1393 int eI
= evsel
? evsel
->attr
.exclude_idle
: 0;
1394 int precise
= evsel
? evsel
->attr
.precise_ip
: 0;
1395 int precise_max
= 0;
1396 int sample_read
= 0;
1397 int pinned
= evsel
? evsel
->attr
.pinned
: 0;
1399 int exclude
= eu
| ek
| eh
;
1400 int exclude_GH
= evsel
? evsel
->exclude_GH
: 0;
1403 memset(mod
, 0, sizeof(*mod
));
1408 exclude
= eu
= ek
= eh
= 1;
1410 } else if (*str
== 'k') {
1412 exclude
= eu
= ek
= eh
= 1;
1414 } else if (*str
== 'h') {
1416 exclude
= eu
= ek
= eh
= 1;
1418 } else if (*str
== 'G') {
1420 exclude_GH
= eG
= eH
= 1;
1422 } else if (*str
== 'H') {
1424 exclude_GH
= eG
= eH
= 1;
1426 } else if (*str
== 'I') {
1428 } else if (*str
== 'p') {
1430 /* use of precise requires exclude_guest */
1433 } else if (*str
== 'P') {
1435 } else if (*str
== 'S') {
1437 } else if (*str
== 'D') {
1439 } else if (*str
== 'W') {
1450 * 0 - SAMPLE_IP can have arbitrary skid
1451 * 1 - SAMPLE_IP must have constant skid
1452 * 2 - SAMPLE_IP requested to have 0 skid
1453 * 3 - SAMPLE_IP must have 0 skid
1455 * See also PERF_RECORD_MISC_EXACT_IP
1466 mod
->precise
= precise
;
1467 mod
->precise_max
= precise_max
;
1468 mod
->exclude_GH
= exclude_GH
;
1469 mod
->sample_read
= sample_read
;
1470 mod
->pinned
= pinned
;
1477 * Basic modifier sanity check to validate it contains only one
1478 * instance of any modifier (apart from 'p') present.
1480 static int check_modifier(char *str
)
1484 /* The sizeof includes 0 byte as well. */
1485 if (strlen(str
) > (sizeof("ukhGHpppPSDIW") - 1))
1489 if (*p
!= 'p' && strchr(p
+ 1, *p
))
1497 int parse_events__modifier_event(struct list_head
*list
, char *str
, bool add
)
1499 struct perf_evsel
*evsel
;
1500 struct event_modifier mod
;
1505 if (check_modifier(str
))
1508 if (!add
&& get_event_modifier(&mod
, str
, NULL
))
1511 __evlist__for_each_entry(list
, evsel
) {
1512 if (add
&& get_event_modifier(&mod
, str
, evsel
))
1515 evsel
->attr
.exclude_user
= mod
.eu
;
1516 evsel
->attr
.exclude_kernel
= mod
.ek
;
1517 evsel
->attr
.exclude_hv
= mod
.eh
;
1518 evsel
->attr
.precise_ip
= mod
.precise
;
1519 evsel
->attr
.exclude_host
= mod
.eH
;
1520 evsel
->attr
.exclude_guest
= mod
.eG
;
1521 evsel
->attr
.exclude_idle
= mod
.eI
;
1522 evsel
->exclude_GH
= mod
.exclude_GH
;
1523 evsel
->sample_read
= mod
.sample_read
;
1524 evsel
->precise_max
= mod
.precise_max
;
1525 evsel
->weak_group
= mod
.weak
;
1527 if (perf_evsel__is_group_leader(evsel
))
1528 evsel
->attr
.pinned
= mod
.pinned
;
1534 int parse_events_name(struct list_head
*list
, char *name
)
1536 struct perf_evsel
*evsel
;
1538 __evlist__for_each_entry(list
, evsel
) {
1540 evsel
->name
= strdup(name
);
1547 comp_pmu(const void *p1
, const void *p2
)
1549 struct perf_pmu_event_symbol
*pmu1
= (struct perf_pmu_event_symbol
*) p1
;
1550 struct perf_pmu_event_symbol
*pmu2
= (struct perf_pmu_event_symbol
*) p2
;
1552 return strcasecmp(pmu1
->symbol
, pmu2
->symbol
);
1555 static void perf_pmu__parse_cleanup(void)
1557 if (perf_pmu_events_list_num
> 0) {
1558 struct perf_pmu_event_symbol
*p
;
1561 for (i
= 0; i
< perf_pmu_events_list_num
; i
++) {
1562 p
= perf_pmu_events_list
+ i
;
1565 zfree(&perf_pmu_events_list
);
1566 perf_pmu_events_list_num
= 0;
1570 #define SET_SYMBOL(str, stype) \
1579 * Read the pmu events list from sysfs
1580 * Save it into perf_pmu_events_list
1582 static void perf_pmu__parse_init(void)
1585 struct perf_pmu
*pmu
= NULL
;
1586 struct perf_pmu_alias
*alias
;
1590 while ((pmu
= perf_pmu__scan(pmu
)) != NULL
) {
1591 list_for_each_entry(alias
, &pmu
->aliases
, list
) {
1592 if (strchr(alias
->name
, '-'))
1599 perf_pmu_events_list_num
= -1;
1602 perf_pmu_events_list
= malloc(sizeof(struct perf_pmu_event_symbol
) * len
);
1603 if (!perf_pmu_events_list
)
1605 perf_pmu_events_list_num
= len
;
1609 while ((pmu
= perf_pmu__scan(pmu
)) != NULL
) {
1610 list_for_each_entry(alias
, &pmu
->aliases
, list
) {
1611 struct perf_pmu_event_symbol
*p
= perf_pmu_events_list
+ len
;
1612 char *tmp
= strchr(alias
->name
, '-');
1615 SET_SYMBOL(strndup(alias
->name
, tmp
- alias
->name
),
1616 PMU_EVENT_SYMBOL_PREFIX
);
1618 SET_SYMBOL(strdup(++tmp
), PMU_EVENT_SYMBOL_SUFFIX
);
1621 SET_SYMBOL(strdup(alias
->name
), PMU_EVENT_SYMBOL
);
1626 qsort(perf_pmu_events_list
, len
,
1627 sizeof(struct perf_pmu_event_symbol
), comp_pmu
);
1631 perf_pmu__parse_cleanup();
1634 enum perf_pmu_event_symbol_type
1635 perf_pmu__parse_check(const char *name
)
1637 struct perf_pmu_event_symbol p
, *r
;
1639 /* scan kernel pmu events from sysfs if needed */
1640 if (perf_pmu_events_list_num
== 0)
1641 perf_pmu__parse_init();
1643 * name "cpu" could be prefix of cpu-cycles or cpu// events.
1644 * cpu-cycles has been handled by hardcode.
1645 * So it must be cpu// events, not kernel pmu event.
1647 if ((perf_pmu_events_list_num
<= 0) || !strcmp(name
, "cpu"))
1648 return PMU_EVENT_SYMBOL_ERR
;
1650 p
.symbol
= strdup(name
);
1651 r
= bsearch(&p
, perf_pmu_events_list
,
1652 (size_t) perf_pmu_events_list_num
,
1653 sizeof(struct perf_pmu_event_symbol
), comp_pmu
);
1655 return r
? r
->type
: PMU_EVENT_SYMBOL_ERR
;
1658 static int parse_events__scanner(const char *str
, void *parse_state
, int start_token
)
1660 YY_BUFFER_STATE buffer
;
1664 ret
= parse_events_lex_init_extra(start_token
, &scanner
);
1668 buffer
= parse_events__scan_string(str
, scanner
);
1671 parse_events_debug
= 1;
1673 ret
= parse_events_parse(parse_state
, scanner
);
1675 parse_events__flush_buffer(buffer
, scanner
);
1676 parse_events__delete_buffer(buffer
, scanner
);
1677 parse_events_lex_destroy(scanner
);
1682 * parse event config string, return a list of event terms.
1684 int parse_events_terms(struct list_head
*terms
, const char *str
)
1686 struct parse_events_state parse_state
= {
1691 ret
= parse_events__scanner(str
, &parse_state
, PE_START_TERMS
);
1693 list_splice(parse_state
.terms
, terms
);
1694 zfree(&parse_state
.terms
);
1698 parse_events_terms__delete(parse_state
.terms
);
1702 int parse_events(struct perf_evlist
*evlist
, const char *str
,
1703 struct parse_events_error
*err
)
1705 struct parse_events_state parse_state
= {
1706 .list
= LIST_HEAD_INIT(parse_state
.list
),
1707 .idx
= evlist
->nr_entries
,
1713 ret
= parse_events__scanner(str
, &parse_state
, PE_START_EVENTS
);
1714 perf_pmu__parse_cleanup();
1716 struct perf_evsel
*last
;
1718 if (list_empty(&parse_state
.list
)) {
1719 WARN_ONCE(true, "WARNING: event parser found nothing");
1723 perf_evlist__splice_list_tail(evlist
, &parse_state
.list
);
1724 evlist
->nr_groups
+= parse_state
.nr_groups
;
1725 last
= perf_evlist__last(evlist
);
1726 last
->cmdline_group_boundary
= true;
1732 * There are 2 users - builtin-record and builtin-test objects.
1733 * Both call perf_evlist__delete in case of error, so we dont
1739 #define MAX_WIDTH 1000
1740 static int get_term_width(void)
1744 get_term_dimensions(&ws
);
1745 return ws
.ws_col
> MAX_WIDTH
? MAX_WIDTH
: ws
.ws_col
;
1748 void parse_events_print_error(struct parse_events_error
*err
,
1751 const char *str
= "invalid or unsupported event: ";
1752 char _buf
[MAX_WIDTH
];
1753 char *buf
= (char *) event
;
1757 /* -2 for extra '' in the final fprintf */
1758 int width
= get_term_width() - 2;
1759 int len_event
= strlen(event
);
1760 int len_str
, max_len
, cut
= 0;
1763 * Maximum error index indent, we will cut
1764 * the event string if it's bigger.
1766 int max_err_idx
= 13;
1769 * Let's be specific with the message when
1770 * we have the precise error.
1772 str
= "event syntax error: ";
1773 len_str
= strlen(str
);
1774 max_len
= width
- len_str
;
1778 /* We're cutting from the beginning. */
1779 if (err
->idx
> max_err_idx
)
1780 cut
= err
->idx
- max_err_idx
;
1782 strncpy(buf
, event
+ cut
, max_len
);
1784 /* Mark cut parts with '..' on both sides. */
1786 buf
[0] = buf
[1] = '.';
1788 if ((len_event
- cut
) > max_len
) {
1789 buf
[max_len
- 1] = buf
[max_len
- 2] = '.';
1793 idx
= len_str
+ err
->idx
- cut
;
1796 fprintf(stderr
, "%s'%s'\n", str
, buf
);
1798 fprintf(stderr
, "%*s\\___ %s\n", idx
+ 1, "", err
->str
);
1800 fprintf(stderr
, "\n%s\n", err
->help
);
1808 int parse_events_option(const struct option
*opt
, const char *str
,
1809 int unset __maybe_unused
)
1811 struct perf_evlist
*evlist
= *(struct perf_evlist
**)opt
->value
;
1812 struct parse_events_error err
= { .idx
= 0, };
1813 int ret
= parse_events(evlist
, str
, &err
);
1816 parse_events_print_error(&err
, str
);
1817 fprintf(stderr
, "Run 'perf list' for a list of valid events\n");
1824 foreach_evsel_in_last_glob(struct perf_evlist
*evlist
,
1825 int (*func
)(struct perf_evsel
*evsel
,
1829 struct perf_evsel
*last
= NULL
;
1833 * Don't return when list_empty, give func a chance to report
1834 * error when it found last == NULL.
1836 * So no need to WARN here, let *func do this.
1838 if (evlist
->nr_entries
> 0)
1839 last
= perf_evlist__last(evlist
);
1842 err
= (*func
)(last
, arg
);
1848 if (last
->node
.prev
== &evlist
->entries
)
1850 last
= list_entry(last
->node
.prev
, struct perf_evsel
, node
);
1851 } while (!last
->cmdline_group_boundary
);
1856 static int set_filter(struct perf_evsel
*evsel
, const void *arg
)
1858 const char *str
= arg
;
1860 int nr_addr_filters
= 0;
1861 struct perf_pmu
*pmu
= NULL
;
1866 if (evsel
->attr
.type
== PERF_TYPE_TRACEPOINT
) {
1867 if (perf_evsel__append_tp_filter(evsel
, str
) < 0) {
1869 "not enough memory to hold filter string\n");
1876 while ((pmu
= perf_pmu__scan(pmu
)) != NULL
)
1877 if (pmu
->type
== evsel
->attr
.type
) {
1883 perf_pmu__scan_file(pmu
, "nr_addr_filters",
1884 "%d", &nr_addr_filters
);
1886 if (!nr_addr_filters
)
1889 if (perf_evsel__append_addr_filter(evsel
, str
) < 0) {
1891 "not enough memory to hold filter string\n");
1899 "--filter option should follow a -e tracepoint or HW tracer option\n");
1904 int parse_filter(const struct option
*opt
, const char *str
,
1905 int unset __maybe_unused
)
1907 struct perf_evlist
*evlist
= *(struct perf_evlist
**)opt
->value
;
1909 return foreach_evsel_in_last_glob(evlist
, set_filter
,
1913 static int add_exclude_perf_filter(struct perf_evsel
*evsel
,
1914 const void *arg __maybe_unused
)
1916 char new_filter
[64];
1918 if (evsel
== NULL
|| evsel
->attr
.type
!= PERF_TYPE_TRACEPOINT
) {
1920 "--exclude-perf option should follow a -e tracepoint option\n");
1924 snprintf(new_filter
, sizeof(new_filter
), "common_pid != %d", getpid());
1926 if (perf_evsel__append_tp_filter(evsel
, new_filter
) < 0) {
1928 "not enough memory to hold filter string\n");
1935 int exclude_perf(const struct option
*opt
,
1936 const char *arg __maybe_unused
,
1937 int unset __maybe_unused
)
1939 struct perf_evlist
*evlist
= *(struct perf_evlist
**)opt
->value
;
1941 return foreach_evsel_in_last_glob(evlist
, add_exclude_perf_filter
,
1945 static const char * const event_type_descriptors
[] = {
1949 "Hardware cache event",
1950 "Raw hardware event descriptor",
1951 "Hardware breakpoint",
1954 static int cmp_string(const void *a
, const void *b
)
1956 const char * const *as
= a
;
1957 const char * const *bs
= b
;
1959 return strcmp(*as
, *bs
);
1963 * Print the events from <debugfs_mount_point>/tracing/events
1966 void print_tracepoint_events(const char *subsys_glob
, const char *event_glob
,
1969 DIR *sys_dir
, *evt_dir
;
1970 struct dirent
*sys_dirent
, *evt_dirent
;
1971 char evt_path
[MAXPATHLEN
];
1972 char dir_path
[MAXPATHLEN
];
1973 char **evt_list
= NULL
;
1974 unsigned int evt_i
= 0, evt_num
= 0;
1975 bool evt_num_known
= false;
1978 sys_dir
= opendir(tracing_events_path
);
1982 if (evt_num_known
) {
1983 evt_list
= zalloc(sizeof(char *) * evt_num
);
1985 goto out_close_sys_dir
;
1988 for_each_subsystem(sys_dir
, sys_dirent
) {
1989 if (subsys_glob
!= NULL
&&
1990 !strglobmatch(sys_dirent
->d_name
, subsys_glob
))
1993 snprintf(dir_path
, MAXPATHLEN
, "%s/%s", tracing_events_path
,
1994 sys_dirent
->d_name
);
1995 evt_dir
= opendir(dir_path
);
1999 for_each_event(sys_dirent
, evt_dir
, evt_dirent
) {
2000 if (event_glob
!= NULL
&&
2001 !strglobmatch(evt_dirent
->d_name
, event_glob
))
2004 if (!evt_num_known
) {
2009 snprintf(evt_path
, MAXPATHLEN
, "%s:%s",
2010 sys_dirent
->d_name
, evt_dirent
->d_name
);
2012 evt_list
[evt_i
] = strdup(evt_path
);
2013 if (evt_list
[evt_i
] == NULL
)
2014 goto out_close_evt_dir
;
2021 if (!evt_num_known
) {
2022 evt_num_known
= true;
2025 qsort(evt_list
, evt_num
, sizeof(char *), cmp_string
);
2027 while (evt_i
< evt_num
) {
2029 printf("%s ", evt_list
[evt_i
++]);
2032 printf(" %-50s [%s]\n", evt_list
[evt_i
++],
2033 event_type_descriptors
[PERF_TYPE_TRACEPOINT
]);
2035 if (evt_num
&& pager_in_use())
2040 for (evt_i
= 0; evt_i
< evt_num
; evt_i
++)
2041 zfree(&evt_list
[evt_i
]);
2050 printf("FATAL: not enough memory to print %s\n",
2051 event_type_descriptors
[PERF_TYPE_TRACEPOINT
]);
2057 * Check whether event is in <debugfs_mount_point>/tracing/events
2060 int is_valid_tracepoint(const char *event_string
)
2062 DIR *sys_dir
, *evt_dir
;
2063 struct dirent
*sys_dirent
, *evt_dirent
;
2064 char evt_path
[MAXPATHLEN
];
2065 char dir_path
[MAXPATHLEN
];
2067 sys_dir
= opendir(tracing_events_path
);
2071 for_each_subsystem(sys_dir
, sys_dirent
) {
2073 snprintf(dir_path
, MAXPATHLEN
, "%s/%s", tracing_events_path
,
2074 sys_dirent
->d_name
);
2075 evt_dir
= opendir(dir_path
);
2079 for_each_event(sys_dirent
, evt_dir
, evt_dirent
) {
2080 snprintf(evt_path
, MAXPATHLEN
, "%s:%s",
2081 sys_dirent
->d_name
, evt_dirent
->d_name
);
2082 if (!strcmp(evt_path
, event_string
)) {
2094 static bool is_event_supported(u8 type
, unsigned config
)
2098 struct perf_evsel
*evsel
;
2099 struct perf_event_attr attr
= {
2104 struct thread_map
*tmap
= thread_map__new_by_tid(0);
2109 evsel
= perf_evsel__new(&attr
);
2111 open_return
= perf_evsel__open(evsel
, NULL
, tmap
);
2112 ret
= open_return
>= 0;
2114 if (open_return
== -EACCES
) {
2116 * This happens if the paranoid value
2117 * /proc/sys/kernel/perf_event_paranoid is set to 2
2118 * Re-run with exclude_kernel set; we don't do that
2119 * by default as some ARM machines do not support it.
2122 evsel
->attr
.exclude_kernel
= 1;
2123 ret
= perf_evsel__open(evsel
, NULL
, tmap
) >= 0;
2125 perf_evsel__delete(evsel
);
2131 void print_sdt_events(const char *subsys_glob
, const char *event_glob
,
2134 struct probe_cache
*pcache
;
2135 struct probe_cache_entry
*ent
;
2136 struct strlist
*bidlist
, *sdtlist
;
2137 struct strlist_config cfg
= {.dont_dupstr
= true};
2138 struct str_node
*nd
, *nd2
;
2139 char *buf
, *path
, *ptr
= NULL
;
2140 bool show_detail
= false;
2143 sdtlist
= strlist__new(NULL
, &cfg
);
2145 pr_debug("Failed to allocate new strlist for SDT\n");
2148 bidlist
= build_id_cache__list_all(true);
2150 pr_debug("Failed to get buildids: %d\n", errno
);
2153 strlist__for_each_entry(nd
, bidlist
) {
2154 pcache
= probe_cache__new(nd
->s
, NULL
);
2157 list_for_each_entry(ent
, &pcache
->entries
, node
) {
2161 !strglobmatch(ent
->pev
.group
, subsys_glob
))
2164 !strglobmatch(ent
->pev
.event
, event_glob
))
2166 ret
= asprintf(&buf
, "%s:%s@%s", ent
->pev
.group
,
2167 ent
->pev
.event
, nd
->s
);
2169 strlist__add(sdtlist
, buf
);
2171 probe_cache__delete(pcache
);
2173 strlist__delete(bidlist
);
2175 strlist__for_each_entry(nd
, sdtlist
) {
2176 buf
= strchr(nd
->s
, '@');
2180 printf("%s ", nd
->s
);
2183 nd2
= strlist__next(nd
);
2185 ptr
= strchr(nd2
->s
, '@');
2188 if (strcmp(nd
->s
, nd2
->s
) == 0)
2192 path
= build_id_cache__origname(buf
);
2193 ret
= asprintf(&buf
, "%s@%s(%.12s)", nd
->s
, path
, buf
);
2195 printf(" %-50s [%s]\n", buf
, "SDT event");
2199 printf(" %-50s [%s]\n", nd
->s
, "SDT event");
2201 if (strcmp(nd
->s
, nd2
->s
) != 0)
2202 show_detail
= false;
2207 strlist__delete(sdtlist
);
2210 int print_hwcache_events(const char *event_glob
, bool name_only
)
2212 unsigned int type
, op
, i
, evt_i
= 0, evt_num
= 0;
2214 char **evt_list
= NULL
;
2215 bool evt_num_known
= false;
2218 if (evt_num_known
) {
2219 evt_list
= zalloc(sizeof(char *) * evt_num
);
2224 for (type
= 0; type
< PERF_COUNT_HW_CACHE_MAX
; type
++) {
2225 for (op
= 0; op
< PERF_COUNT_HW_CACHE_OP_MAX
; op
++) {
2226 /* skip invalid cache type */
2227 if (!perf_evsel__is_cache_op_valid(type
, op
))
2230 for (i
= 0; i
< PERF_COUNT_HW_CACHE_RESULT_MAX
; i
++) {
2231 __perf_evsel__hw_cache_type_op_res_name(type
, op
, i
,
2232 name
, sizeof(name
));
2233 if (event_glob
!= NULL
&& !strglobmatch(name
, event_glob
))
2236 if (!is_event_supported(PERF_TYPE_HW_CACHE
,
2237 type
| (op
<< 8) | (i
<< 16)))
2240 if (!evt_num_known
) {
2245 evt_list
[evt_i
] = strdup(name
);
2246 if (evt_list
[evt_i
] == NULL
)
2253 if (!evt_num_known
) {
2254 evt_num_known
= true;
2257 qsort(evt_list
, evt_num
, sizeof(char *), cmp_string
);
2259 while (evt_i
< evt_num
) {
2261 printf("%s ", evt_list
[evt_i
++]);
2264 printf(" %-50s [%s]\n", evt_list
[evt_i
++],
2265 event_type_descriptors
[PERF_TYPE_HW_CACHE
]);
2267 if (evt_num
&& pager_in_use())
2272 for (evt_i
= 0; evt_i
< evt_num
; evt_i
++)
2273 zfree(&evt_list
[evt_i
]);
2278 printf("FATAL: not enough memory to print %s\n", event_type_descriptors
[PERF_TYPE_HW_CACHE
]);
2284 void print_symbol_events(const char *event_glob
, unsigned type
,
2285 struct event_symbol
*syms
, unsigned max
,
2288 unsigned int i
, evt_i
= 0, evt_num
= 0;
2289 char name
[MAX_NAME_LEN
];
2290 char **evt_list
= NULL
;
2291 bool evt_num_known
= false;
2294 if (evt_num_known
) {
2295 evt_list
= zalloc(sizeof(char *) * evt_num
);
2301 for (i
= 0; i
< max
; i
++, syms
++) {
2303 if (event_glob
!= NULL
&& syms
->symbol
!= NULL
&&
2304 !(strglobmatch(syms
->symbol
, event_glob
) ||
2305 (syms
->alias
&& strglobmatch(syms
->alias
, event_glob
))))
2308 if (!is_event_supported(type
, i
))
2311 if (!evt_num_known
) {
2316 if (!name_only
&& strlen(syms
->alias
))
2317 snprintf(name
, MAX_NAME_LEN
, "%s OR %s", syms
->symbol
, syms
->alias
);
2319 strncpy(name
, syms
->symbol
, MAX_NAME_LEN
);
2321 evt_list
[evt_i
] = strdup(name
);
2322 if (evt_list
[evt_i
] == NULL
)
2327 if (!evt_num_known
) {
2328 evt_num_known
= true;
2331 qsort(evt_list
, evt_num
, sizeof(char *), cmp_string
);
2333 while (evt_i
< evt_num
) {
2335 printf("%s ", evt_list
[evt_i
++]);
2338 printf(" %-50s [%s]\n", evt_list
[evt_i
++], event_type_descriptors
[type
]);
2340 if (evt_num
&& pager_in_use())
2345 for (evt_i
= 0; evt_i
< evt_num
; evt_i
++)
2346 zfree(&evt_list
[evt_i
]);
2351 printf("FATAL: not enough memory to print %s\n", event_type_descriptors
[type
]);
2357 * Print the help text for the event symbols:
2359 void print_events(const char *event_glob
, bool name_only
, bool quiet_flag
,
2360 bool long_desc
, bool details_flag
)
2362 print_symbol_events(event_glob
, PERF_TYPE_HARDWARE
,
2363 event_symbols_hw
, PERF_COUNT_HW_MAX
, name_only
);
2365 print_symbol_events(event_glob
, PERF_TYPE_SOFTWARE
,
2366 event_symbols_sw
, PERF_COUNT_SW_MAX
, name_only
);
2368 print_hwcache_events(event_glob
, name_only
);
2370 print_pmu_events(event_glob
, name_only
, quiet_flag
, long_desc
,
2373 if (event_glob
!= NULL
)
2377 printf(" %-50s [%s]\n",
2379 event_type_descriptors
[PERF_TYPE_RAW
]);
2380 printf(" %-50s [%s]\n",
2381 "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
2382 event_type_descriptors
[PERF_TYPE_RAW
]);
2384 printf(" (see 'man perf-list' on how to encode it)\n\n");
2386 printf(" %-50s [%s]\n",
2387 "mem:<addr>[/len][:access]",
2388 event_type_descriptors
[PERF_TYPE_BREAKPOINT
]);
2393 print_tracepoint_events(NULL
, NULL
, name_only
);
2395 print_sdt_events(NULL
, NULL
, name_only
);
2397 metricgroup__print(true, true, NULL
, name_only
);
2400 int parse_events__is_hardcoded_term(struct parse_events_term
*term
)
2402 return term
->type_term
!= PARSE_EVENTS__TERM_TYPE_USER
;
2405 static int new_term(struct parse_events_term
**_term
,
2406 struct parse_events_term
*temp
,
2409 struct parse_events_term
*term
;
2411 term
= malloc(sizeof(*term
));
2416 INIT_LIST_HEAD(&term
->list
);
2419 switch (term
->type_val
) {
2420 case PARSE_EVENTS__TERM_TYPE_NUM
:
2421 term
->val
.num
= num
;
2423 case PARSE_EVENTS__TERM_TYPE_STR
:
2424 term
->val
.str
= str
;
2435 int parse_events_term__num(struct parse_events_term
**term
,
2436 int type_term
, char *config
, u64 num
,
2438 void *loc_term_
, void *loc_val_
)
2440 YYLTYPE
*loc_term
= loc_term_
;
2441 YYLTYPE
*loc_val
= loc_val_
;
2443 struct parse_events_term temp
= {
2444 .type_val
= PARSE_EVENTS__TERM_TYPE_NUM
,
2445 .type_term
= type_term
,
2447 .no_value
= no_value
,
2448 .err_term
= loc_term
? loc_term
->first_column
: 0,
2449 .err_val
= loc_val
? loc_val
->first_column
: 0,
2452 return new_term(term
, &temp
, NULL
, num
);
2455 int parse_events_term__str(struct parse_events_term
**term
,
2456 int type_term
, char *config
, char *str
,
2457 void *loc_term_
, void *loc_val_
)
2459 YYLTYPE
*loc_term
= loc_term_
;
2460 YYLTYPE
*loc_val
= loc_val_
;
2462 struct parse_events_term temp
= {
2463 .type_val
= PARSE_EVENTS__TERM_TYPE_STR
,
2464 .type_term
= type_term
,
2466 .err_term
= loc_term
? loc_term
->first_column
: 0,
2467 .err_val
= loc_val
? loc_val
->first_column
: 0,
2470 return new_term(term
, &temp
, str
, 0);
2473 int parse_events_term__sym_hw(struct parse_events_term
**term
,
2474 char *config
, unsigned idx
)
2476 struct event_symbol
*sym
;
2477 struct parse_events_term temp
= {
2478 .type_val
= PARSE_EVENTS__TERM_TYPE_STR
,
2479 .type_term
= PARSE_EVENTS__TERM_TYPE_USER
,
2480 .config
= config
?: (char *) "event",
2483 BUG_ON(idx
>= PERF_COUNT_HW_MAX
);
2484 sym
= &event_symbols_hw
[idx
];
2486 return new_term(term
, &temp
, (char *) sym
->symbol
, 0);
2489 int parse_events_term__clone(struct parse_events_term
**new,
2490 struct parse_events_term
*term
)
2492 struct parse_events_term temp
= {
2493 .type_val
= term
->type_val
,
2494 .type_term
= term
->type_term
,
2495 .config
= term
->config
,
2496 .err_term
= term
->err_term
,
2497 .err_val
= term
->err_val
,
2500 return new_term(new, &temp
, term
->val
.str
, term
->val
.num
);
2503 int parse_events_copy_term_list(struct list_head
*old
,
2504 struct list_head
**new)
2506 struct parse_events_term
*term
, *n
;
2514 *new = malloc(sizeof(struct list_head
));
2517 INIT_LIST_HEAD(*new);
2519 list_for_each_entry (term
, old
, list
) {
2520 ret
= parse_events_term__clone(&n
, term
);
2523 list_add_tail(&n
->list
, *new);
2528 void parse_events_terms__purge(struct list_head
*terms
)
2530 struct parse_events_term
*term
, *h
;
2532 list_for_each_entry_safe(term
, h
, terms
, list
) {
2533 if (term
->array
.nr_ranges
)
2534 zfree(&term
->array
.ranges
);
2535 list_del_init(&term
->list
);
2540 void parse_events_terms__delete(struct list_head
*terms
)
2544 parse_events_terms__purge(terms
);
2548 void parse_events__clear_array(struct parse_events_array
*a
)
2553 void parse_events_evlist_error(struct parse_events_state
*parse_state
,
2554 int idx
, const char *str
)
2556 struct parse_events_error
*err
= parse_state
->error
;
2561 err
->str
= strdup(str
);
2562 WARN_ONCE(!err
->str
, "WARNING: failed to allocate error string");
2565 static void config_terms_list(char *buf
, size_t buf_sz
)
2571 for (i
= 0; i
< __PARSE_EVENTS__TERM_TYPE_NR
; i
++) {
2572 const char *name
= config_term_names
[i
];
2574 if (!config_term_avail(i
, NULL
))
2581 if (strlen(buf
) + strlen(name
) + 2 >= buf_sz
)
2593 * Return string contains valid config terms of an event.
2594 * @additional_terms: For terms such as PMU sysfs terms.
2596 char *parse_events_formats_error_string(char *additional_terms
)
2599 /* "no-overwrite" is the longest name */
2600 char static_terms
[__PARSE_EVENTS__TERM_TYPE_NR
*
2601 (sizeof("no-overwrite") - 1)];
2603 config_terms_list(static_terms
, sizeof(static_terms
));
2605 if (additional_terms
) {
2606 if (asprintf(&str
, "valid terms: %s,%s",
2607 additional_terms
, static_terms
) < 0)
2610 if (asprintf(&str
, "valid terms: %s", static_terms
) < 0)