1 #include <linux/hw_breakpoint.h>
7 #include <subcmd/parse-options.h>
8 #include "parse-events.h"
9 #include <subcmd/exec-cmd.h>
14 #include "bpf-loader.h"
16 #include <api/fs/tracing_path.h>
17 #include "parse-events-bison.h"
18 #define YY_EXTRA_TYPE int
19 #include "parse-events-flex.h"
21 #include "thread_map.h"
25 #define MAX_NAME_LEN 100
28 extern int parse_events_debug
;
30 int parse_events_parse(void *data
, void *scanner
);
31 static int get_config_terms(struct list_head
*head_config
,
32 struct list_head
*head_terms __maybe_unused
);
34 static struct perf_pmu_event_symbol
*perf_pmu_events_list
;
36 * The variable indicates the number of supported pmu event symbols.
37 * 0 means not initialized and ready to init
38 * -1 means failed to init, don't try anymore
39 * >0 is the number of supported pmu event symbols
41 static int perf_pmu_events_list_num
;
43 struct event_symbol event_symbols_hw
[PERF_COUNT_HW_MAX
] = {
44 [PERF_COUNT_HW_CPU_CYCLES
] = {
45 .symbol
= "cpu-cycles",
48 [PERF_COUNT_HW_INSTRUCTIONS
] = {
49 .symbol
= "instructions",
52 [PERF_COUNT_HW_CACHE_REFERENCES
] = {
53 .symbol
= "cache-references",
56 [PERF_COUNT_HW_CACHE_MISSES
] = {
57 .symbol
= "cache-misses",
60 [PERF_COUNT_HW_BRANCH_INSTRUCTIONS
] = {
61 .symbol
= "branch-instructions",
64 [PERF_COUNT_HW_BRANCH_MISSES
] = {
65 .symbol
= "branch-misses",
68 [PERF_COUNT_HW_BUS_CYCLES
] = {
69 .symbol
= "bus-cycles",
72 [PERF_COUNT_HW_STALLED_CYCLES_FRONTEND
] = {
73 .symbol
= "stalled-cycles-frontend",
74 .alias
= "idle-cycles-frontend",
76 [PERF_COUNT_HW_STALLED_CYCLES_BACKEND
] = {
77 .symbol
= "stalled-cycles-backend",
78 .alias
= "idle-cycles-backend",
80 [PERF_COUNT_HW_REF_CPU_CYCLES
] = {
81 .symbol
= "ref-cycles",
86 struct event_symbol event_symbols_sw
[PERF_COUNT_SW_MAX
] = {
87 [PERF_COUNT_SW_CPU_CLOCK
] = {
88 .symbol
= "cpu-clock",
91 [PERF_COUNT_SW_TASK_CLOCK
] = {
92 .symbol
= "task-clock",
95 [PERF_COUNT_SW_PAGE_FAULTS
] = {
96 .symbol
= "page-faults",
99 [PERF_COUNT_SW_CONTEXT_SWITCHES
] = {
100 .symbol
= "context-switches",
103 [PERF_COUNT_SW_CPU_MIGRATIONS
] = {
104 .symbol
= "cpu-migrations",
105 .alias
= "migrations",
107 [PERF_COUNT_SW_PAGE_FAULTS_MIN
] = {
108 .symbol
= "minor-faults",
111 [PERF_COUNT_SW_PAGE_FAULTS_MAJ
] = {
112 .symbol
= "major-faults",
115 [PERF_COUNT_SW_ALIGNMENT_FAULTS
] = {
116 .symbol
= "alignment-faults",
119 [PERF_COUNT_SW_EMULATION_FAULTS
] = {
120 .symbol
= "emulation-faults",
123 [PERF_COUNT_SW_DUMMY
] = {
127 [PERF_COUNT_SW_BPF_OUTPUT
] = {
128 .symbol
= "bpf-output",
133 #define __PERF_EVENT_FIELD(config, name) \
134 ((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
136 #define PERF_EVENT_RAW(config) __PERF_EVENT_FIELD(config, RAW)
137 #define PERF_EVENT_CONFIG(config) __PERF_EVENT_FIELD(config, CONFIG)
138 #define PERF_EVENT_TYPE(config) __PERF_EVENT_FIELD(config, TYPE)
139 #define PERF_EVENT_ID(config) __PERF_EVENT_FIELD(config, EVENT)
141 #define for_each_subsystem(sys_dir, sys_dirent) \
142 while ((sys_dirent = readdir(sys_dir)) != NULL) \
143 if (sys_dirent->d_type == DT_DIR && \
144 (strcmp(sys_dirent->d_name, ".")) && \
145 (strcmp(sys_dirent->d_name, "..")))
147 static int tp_event_has_id(struct dirent
*sys_dir
, struct dirent
*evt_dir
)
149 char evt_path
[MAXPATHLEN
];
152 snprintf(evt_path
, MAXPATHLEN
, "%s/%s/%s/id", tracing_events_path
,
153 sys_dir
->d_name
, evt_dir
->d_name
);
154 fd
= open(evt_path
, O_RDONLY
);
162 #define for_each_event(sys_dirent, evt_dir, evt_dirent) \
163 while ((evt_dirent = readdir(evt_dir)) != NULL) \
164 if (evt_dirent->d_type == DT_DIR && \
165 (strcmp(evt_dirent->d_name, ".")) && \
166 (strcmp(evt_dirent->d_name, "..")) && \
167 (!tp_event_has_id(sys_dirent, evt_dirent)))
169 #define MAX_EVENT_LENGTH 512
172 struct tracepoint_path
*tracepoint_id_to_path(u64 config
)
174 struct tracepoint_path
*path
= NULL
;
175 DIR *sys_dir
, *evt_dir
;
176 struct dirent
*sys_dirent
, *evt_dirent
;
180 char evt_path
[MAXPATHLEN
];
181 char dir_path
[MAXPATHLEN
];
183 sys_dir
= opendir(tracing_events_path
);
187 for_each_subsystem(sys_dir
, sys_dirent
) {
189 snprintf(dir_path
, MAXPATHLEN
, "%s/%s", tracing_events_path
,
191 evt_dir
= opendir(dir_path
);
195 for_each_event(sys_dirent
, evt_dir
, evt_dirent
) {
197 snprintf(evt_path
, MAXPATHLEN
, "%s/%s/id", dir_path
,
199 fd
= open(evt_path
, O_RDONLY
);
202 if (read(fd
, id_buf
, sizeof(id_buf
)) < 0) {
211 path
= zalloc(sizeof(*path
));
212 path
->system
= malloc(MAX_EVENT_LENGTH
);
217 path
->name
= malloc(MAX_EVENT_LENGTH
);
219 zfree(&path
->system
);
223 strncpy(path
->system
, sys_dirent
->d_name
,
225 strncpy(path
->name
, evt_dirent
->d_name
,
237 struct tracepoint_path
*tracepoint_name_to_path(const char *name
)
239 struct tracepoint_path
*path
= zalloc(sizeof(*path
));
240 char *str
= strchr(name
, ':');
242 if (path
== NULL
|| str
== NULL
) {
247 path
->system
= strndup(name
, str
- name
);
248 path
->name
= strdup(str
+1);
250 if (path
->system
== NULL
|| path
->name
== NULL
) {
251 zfree(&path
->system
);
260 const char *event_type(int type
)
263 case PERF_TYPE_HARDWARE
:
266 case PERF_TYPE_SOFTWARE
:
269 case PERF_TYPE_TRACEPOINT
:
272 case PERF_TYPE_HW_CACHE
:
273 return "hardware-cache";
282 static int parse_events__is_name_term(struct parse_events_term
*term
)
284 return term
->type_term
== PARSE_EVENTS__TERM_TYPE_NAME
;
287 static char *get_config_name(struct list_head
*head_terms
)
289 struct parse_events_term
*term
;
294 list_for_each_entry(term
, head_terms
, list
)
295 if (parse_events__is_name_term(term
))
296 return term
->val
.str
;
301 static struct perf_evsel
*
302 __add_event(struct list_head
*list
, int *idx
,
303 struct perf_event_attr
*attr
,
304 char *name
, struct cpu_map
*cpus
,
305 struct list_head
*config_terms
)
307 struct perf_evsel
*evsel
;
309 event_attr_init(attr
);
311 evsel
= perf_evsel__new_idx(attr
, (*idx
)++);
315 evsel
->cpus
= cpu_map__get(cpus
);
316 evsel
->own_cpus
= cpu_map__get(cpus
);
319 evsel
->name
= strdup(name
);
322 list_splice(config_terms
, &evsel
->config_terms
);
324 list_add_tail(&evsel
->node
, list
);
328 static int add_event(struct list_head
*list
, int *idx
,
329 struct perf_event_attr
*attr
, char *name
,
330 struct list_head
*config_terms
)
332 return __add_event(list
, idx
, attr
, name
, NULL
, config_terms
) ? 0 : -ENOMEM
;
335 static int parse_aliases(char *str
, const char *names
[][PERF_EVSEL__MAX_ALIASES
], int size
)
340 for (i
= 0; i
< size
; i
++) {
341 for (j
= 0; j
< PERF_EVSEL__MAX_ALIASES
&& names
[i
][j
]; j
++) {
342 n
= strlen(names
[i
][j
]);
343 if (n
> longest
&& !strncasecmp(str
, names
[i
][j
], n
))
353 typedef int config_term_func_t(struct perf_event_attr
*attr
,
354 struct parse_events_term
*term
,
355 struct parse_events_error
*err
);
356 static int config_term_common(struct perf_event_attr
*attr
,
357 struct parse_events_term
*term
,
358 struct parse_events_error
*err
);
359 static int config_attr(struct perf_event_attr
*attr
,
360 struct list_head
*head
,
361 struct parse_events_error
*err
,
362 config_term_func_t config_term
);
364 int parse_events_add_cache(struct list_head
*list
, int *idx
,
365 char *type
, char *op_result1
, char *op_result2
,
366 struct parse_events_error
*err
,
367 struct list_head
*head_config
)
369 struct perf_event_attr attr
;
370 LIST_HEAD(config_terms
);
371 char name
[MAX_NAME_LEN
], *config_name
;
372 int cache_type
= -1, cache_op
= -1, cache_result
= -1;
373 char *op_result
[2] = { op_result1
, op_result2
};
377 * No fallback - if we cannot get a clear cache type
380 cache_type
= parse_aliases(type
, perf_evsel__hw_cache
,
381 PERF_COUNT_HW_CACHE_MAX
);
382 if (cache_type
== -1)
385 config_name
= get_config_name(head_config
);
386 n
= snprintf(name
, MAX_NAME_LEN
, "%s", type
);
388 for (i
= 0; (i
< 2) && (op_result
[i
]); i
++) {
389 char *str
= op_result
[i
];
391 n
+= snprintf(name
+ n
, MAX_NAME_LEN
- n
, "-%s", str
);
393 if (cache_op
== -1) {
394 cache_op
= parse_aliases(str
, perf_evsel__hw_cache_op
,
395 PERF_COUNT_HW_CACHE_OP_MAX
);
397 if (!perf_evsel__is_cache_op_valid(cache_type
, cache_op
))
403 if (cache_result
== -1) {
404 cache_result
= parse_aliases(str
, perf_evsel__hw_cache_result
,
405 PERF_COUNT_HW_CACHE_RESULT_MAX
);
406 if (cache_result
>= 0)
412 * Fall back to reads:
415 cache_op
= PERF_COUNT_HW_CACHE_OP_READ
;
418 * Fall back to accesses:
420 if (cache_result
== -1)
421 cache_result
= PERF_COUNT_HW_CACHE_RESULT_ACCESS
;
423 memset(&attr
, 0, sizeof(attr
));
424 attr
.config
= cache_type
| (cache_op
<< 8) | (cache_result
<< 16);
425 attr
.type
= PERF_TYPE_HW_CACHE
;
428 if (config_attr(&attr
, head_config
, err
,
432 if (get_config_terms(head_config
, &config_terms
))
435 return add_event(list
, idx
, &attr
, config_name
? : name
, &config_terms
);
438 static void tracepoint_error(struct parse_events_error
*e
, int err
,
439 char *sys
, char *name
)
447 * We get error directly from syscall errno ( > 0),
448 * or from encoded pointer's error ( < 0).
454 e
->str
= strdup("can't access trace events");
457 e
->str
= strdup("unknown tracepoint");
460 e
->str
= strdup("failed to add tracepoint");
464 tracing_path__strerror_open_tp(err
, help
, sizeof(help
), sys
, name
);
465 e
->help
= strdup(help
);
468 static int add_tracepoint(struct list_head
*list
, int *idx
,
469 char *sys_name
, char *evt_name
,
470 struct parse_events_error
*err
,
471 struct list_head
*head_config
)
473 struct perf_evsel
*evsel
;
475 evsel
= perf_evsel__newtp_idx(sys_name
, evt_name
, (*idx
)++);
477 tracepoint_error(err
, PTR_ERR(evsel
), sys_name
, evt_name
);
478 return PTR_ERR(evsel
);
482 LIST_HEAD(config_terms
);
484 if (get_config_terms(head_config
, &config_terms
))
486 list_splice(&config_terms
, &evsel
->config_terms
);
489 list_add_tail(&evsel
->node
, list
);
493 static int add_tracepoint_multi_event(struct list_head
*list
, int *idx
,
494 char *sys_name
, char *evt_name
,
495 struct parse_events_error
*err
,
496 struct list_head
*head_config
)
498 char evt_path
[MAXPATHLEN
];
499 struct dirent
*evt_ent
;
501 int ret
= 0, found
= 0;
503 snprintf(evt_path
, MAXPATHLEN
, "%s/%s", tracing_events_path
, sys_name
);
504 evt_dir
= opendir(evt_path
);
506 tracepoint_error(err
, errno
, sys_name
, evt_name
);
510 while (!ret
&& (evt_ent
= readdir(evt_dir
))) {
511 if (!strcmp(evt_ent
->d_name
, ".")
512 || !strcmp(evt_ent
->d_name
, "..")
513 || !strcmp(evt_ent
->d_name
, "enable")
514 || !strcmp(evt_ent
->d_name
, "filter"))
517 if (!strglobmatch(evt_ent
->d_name
, evt_name
))
522 ret
= add_tracepoint(list
, idx
, sys_name
, evt_ent
->d_name
,
527 tracepoint_error(err
, ENOENT
, sys_name
, evt_name
);
535 static int add_tracepoint_event(struct list_head
*list
, int *idx
,
536 char *sys_name
, char *evt_name
,
537 struct parse_events_error
*err
,
538 struct list_head
*head_config
)
540 return strpbrk(evt_name
, "*?") ?
541 add_tracepoint_multi_event(list
, idx
, sys_name
, evt_name
,
543 add_tracepoint(list
, idx
, sys_name
, evt_name
,
547 static int add_tracepoint_multi_sys(struct list_head
*list
, int *idx
,
548 char *sys_name
, char *evt_name
,
549 struct parse_events_error
*err
,
550 struct list_head
*head_config
)
552 struct dirent
*events_ent
;
556 events_dir
= opendir(tracing_events_path
);
558 tracepoint_error(err
, errno
, sys_name
, evt_name
);
562 while (!ret
&& (events_ent
= readdir(events_dir
))) {
563 if (!strcmp(events_ent
->d_name
, ".")
564 || !strcmp(events_ent
->d_name
, "..")
565 || !strcmp(events_ent
->d_name
, "enable")
566 || !strcmp(events_ent
->d_name
, "header_event")
567 || !strcmp(events_ent
->d_name
, "header_page"))
570 if (!strglobmatch(events_ent
->d_name
, sys_name
))
573 ret
= add_tracepoint_event(list
, idx
, events_ent
->d_name
,
574 evt_name
, err
, head_config
);
577 closedir(events_dir
);
581 struct __add_bpf_event_param
{
582 struct parse_events_evlist
*data
;
583 struct list_head
*list
;
584 struct list_head
*head_config
;
587 static int add_bpf_event(struct probe_trace_event
*tev
, int fd
,
590 LIST_HEAD(new_evsels
);
591 struct __add_bpf_event_param
*param
= _param
;
592 struct parse_events_evlist
*evlist
= param
->data
;
593 struct list_head
*list
= param
->list
;
594 struct perf_evsel
*pos
;
597 pr_debug("add bpf event %s:%s and attach bpf program %d\n",
598 tev
->group
, tev
->event
, fd
);
600 err
= parse_events_add_tracepoint(&new_evsels
, &evlist
->idx
, tev
->group
,
601 tev
->event
, evlist
->error
,
604 struct perf_evsel
*evsel
, *tmp
;
606 pr_debug("Failed to add BPF event %s:%s\n",
607 tev
->group
, tev
->event
);
608 list_for_each_entry_safe(evsel
, tmp
, &new_evsels
, node
) {
609 list_del(&evsel
->node
);
610 perf_evsel__delete(evsel
);
614 pr_debug("adding %s:%s\n", tev
->group
, tev
->event
);
616 list_for_each_entry(pos
, &new_evsels
, node
) {
617 pr_debug("adding %s:%s to %p\n",
618 tev
->group
, tev
->event
, pos
);
621 list_splice(&new_evsels
, list
);
625 int parse_events_load_bpf_obj(struct parse_events_evlist
*data
,
626 struct list_head
*list
,
627 struct bpf_object
*obj
,
628 struct list_head
*head_config
)
632 struct __add_bpf_event_param param
= {data
, list
, head_config
};
633 static bool registered_unprobe_atexit
= false;
635 if (IS_ERR(obj
) || !obj
) {
636 snprintf(errbuf
, sizeof(errbuf
),
637 "Internal error: load bpf obj with NULL");
643 * Register atexit handler before calling bpf__probe() so
644 * bpf__probe() don't need to unprobe probe points its already
645 * created when failure.
647 if (!registered_unprobe_atexit
) {
649 registered_unprobe_atexit
= true;
652 err
= bpf__probe(obj
);
654 bpf__strerror_probe(obj
, err
, errbuf
, sizeof(errbuf
));
658 err
= bpf__load(obj
);
660 bpf__strerror_load(obj
, err
, errbuf
, sizeof(errbuf
));
664 err
= bpf__foreach_tev(obj
, add_bpf_event
, ¶m
);
666 snprintf(errbuf
, sizeof(errbuf
),
667 "Attach events in BPF object failed");
673 data
->error
->help
= strdup("(add -v to see detail)");
674 data
->error
->str
= strdup(errbuf
);
679 parse_events_config_bpf(struct parse_events_evlist
*data
,
680 struct bpf_object
*obj
,
681 struct list_head
*head_config
)
683 struct parse_events_term
*term
;
686 if (!head_config
|| list_empty(head_config
))
689 list_for_each_entry(term
, head_config
, list
) {
693 if (term
->type_term
!= PARSE_EVENTS__TERM_TYPE_USER
) {
694 snprintf(errbuf
, sizeof(errbuf
),
695 "Invalid config term for BPF object");
696 errbuf
[BUFSIZ
- 1] = '\0';
698 data
->error
->idx
= term
->err_term
;
699 data
->error
->str
= strdup(errbuf
);
703 err
= bpf__config_obj(obj
, term
, data
->evlist
, &error_pos
);
705 bpf__strerror_config_obj(obj
, term
, data
->evlist
,
706 &error_pos
, err
, errbuf
,
708 data
->error
->help
= strdup(
709 "Hint:\tValid config terms:\n"
710 " \tmap:[<arraymap>].value<indices>=[value]\n"
711 " \tmap:[<eventmap>].event<indices>=[event]\n"
713 " \twhere <indices> is something like [0,3...5] or [all]\n"
714 " \t(add -v to see detail)");
715 data
->error
->str
= strdup(errbuf
);
716 if (err
== -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE
)
717 data
->error
->idx
= term
->err_val
;
719 data
->error
->idx
= term
->err_term
+ error_pos
;
727 * Split config terms:
728 * perf record -e bpf.c/call-graph=fp,map:array.value[0]=1/ ...
729 * 'call-graph=fp' is 'evt config', should be applied to each
731 * 'map:array.value[0]=1' is 'obj config', should be processed
732 * with parse_events_config_bpf.
734 * Move object config terms from the first list to obj_head_config.
737 split_bpf_config_terms(struct list_head
*evt_head_config
,
738 struct list_head
*obj_head_config
)
740 struct parse_events_term
*term
, *temp
;
743 * Currectly, all possible user config term
744 * belong to bpf object. parse_events__is_hardcoded_term()
745 * happends to be a good flag.
747 * See parse_events_config_bpf() and
748 * config_term_tracepoint().
750 list_for_each_entry_safe(term
, temp
, evt_head_config
, list
)
751 if (!parse_events__is_hardcoded_term(term
))
752 list_move_tail(&term
->list
, obj_head_config
);
755 int parse_events_load_bpf(struct parse_events_evlist
*data
,
756 struct list_head
*list
,
759 struct list_head
*head_config
)
762 struct bpf_object
*obj
;
763 LIST_HEAD(obj_head_config
);
766 split_bpf_config_terms(head_config
, &obj_head_config
);
768 obj
= bpf__prepare_load(bpf_file_name
, source
);
775 snprintf(errbuf
, sizeof(errbuf
),
776 "BPF support is not compiled");
778 bpf__strerror_prepare_load(bpf_file_name
,
783 data
->error
->help
= strdup("(add -v to see detail)");
784 data
->error
->str
= strdup(errbuf
);
788 err
= parse_events_load_bpf_obj(data
, list
, obj
, head_config
);
791 err
= parse_events_config_bpf(data
, obj
, &obj_head_config
);
794 * Caller doesn't know anything about obj_head_config,
795 * so combine them together again before returnning.
798 list_splice_tail(&obj_head_config
, head_config
);
803 parse_breakpoint_type(const char *type
, struct perf_event_attr
*attr
)
807 for (i
= 0; i
< 3; i
++) {
808 if (!type
|| !type
[i
])
811 #define CHECK_SET_TYPE(bit) \
813 if (attr->bp_type & bit) \
816 attr->bp_type |= bit; \
821 CHECK_SET_TYPE(HW_BREAKPOINT_R
);
824 CHECK_SET_TYPE(HW_BREAKPOINT_W
);
827 CHECK_SET_TYPE(HW_BREAKPOINT_X
);
834 #undef CHECK_SET_TYPE
836 if (!attr
->bp_type
) /* Default */
837 attr
->bp_type
= HW_BREAKPOINT_R
| HW_BREAKPOINT_W
;
842 int parse_events_add_breakpoint(struct list_head
*list
, int *idx
,
843 void *ptr
, char *type
, u64 len
)
845 struct perf_event_attr attr
;
847 memset(&attr
, 0, sizeof(attr
));
848 attr
.bp_addr
= (unsigned long) ptr
;
850 if (parse_breakpoint_type(type
, &attr
))
853 /* Provide some defaults if len is not specified */
855 if (attr
.bp_type
== HW_BREAKPOINT_X
)
858 len
= HW_BREAKPOINT_LEN_4
;
863 attr
.type
= PERF_TYPE_BREAKPOINT
;
864 attr
.sample_period
= 1;
866 return add_event(list
, idx
, &attr
, NULL
, NULL
);
869 static int check_type_val(struct parse_events_term
*term
,
870 struct parse_events_error
*err
,
873 if (type
== term
->type_val
)
877 err
->idx
= term
->err_val
;
878 if (type
== PARSE_EVENTS__TERM_TYPE_NUM
)
879 err
->str
= strdup("expected numeric value");
881 err
->str
= strdup("expected string value");
887 * Update according to parse-events.l
889 static const char *config_term_names
[__PARSE_EVENTS__TERM_TYPE_NR
] = {
890 [PARSE_EVENTS__TERM_TYPE_USER
] = "<sysfs term>",
891 [PARSE_EVENTS__TERM_TYPE_CONFIG
] = "config",
892 [PARSE_EVENTS__TERM_TYPE_CONFIG1
] = "config1",
893 [PARSE_EVENTS__TERM_TYPE_CONFIG2
] = "config2",
894 [PARSE_EVENTS__TERM_TYPE_NAME
] = "name",
895 [PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD
] = "period",
896 [PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ
] = "freq",
897 [PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE
] = "branch_type",
898 [PARSE_EVENTS__TERM_TYPE_TIME
] = "time",
899 [PARSE_EVENTS__TERM_TYPE_CALLGRAPH
] = "call-graph",
900 [PARSE_EVENTS__TERM_TYPE_STACKSIZE
] = "stack-size",
901 [PARSE_EVENTS__TERM_TYPE_NOINHERIT
] = "no-inherit",
902 [PARSE_EVENTS__TERM_TYPE_INHERIT
] = "inherit",
903 [PARSE_EVENTS__TERM_TYPE_MAX_STACK
] = "max-stack",
906 static bool config_term_shrinked
;
909 config_term_avail(int term_type
, struct parse_events_error
*err
)
911 if (term_type
< 0 || term_type
>= __PARSE_EVENTS__TERM_TYPE_NR
) {
912 err
->str
= strdup("Invalid term_type");
915 if (!config_term_shrinked
)
919 case PARSE_EVENTS__TERM_TYPE_CONFIG
:
920 case PARSE_EVENTS__TERM_TYPE_CONFIG1
:
921 case PARSE_EVENTS__TERM_TYPE_CONFIG2
:
922 case PARSE_EVENTS__TERM_TYPE_NAME
:
928 /* term_type is validated so indexing is safe */
929 if (asprintf(&err
->str
, "'%s' is not usable in 'perf stat'",
930 config_term_names
[term_type
]) < 0)
936 void parse_events__shrink_config_terms(void)
938 config_term_shrinked
= true;
941 static int config_term_common(struct perf_event_attr
*attr
,
942 struct parse_events_term
*term
,
943 struct parse_events_error
*err
)
945 #define CHECK_TYPE_VAL(type) \
947 if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
951 switch (term
->type_term
) {
952 case PARSE_EVENTS__TERM_TYPE_CONFIG
:
954 attr
->config
= term
->val
.num
;
956 case PARSE_EVENTS__TERM_TYPE_CONFIG1
:
958 attr
->config1
= term
->val
.num
;
960 case PARSE_EVENTS__TERM_TYPE_CONFIG2
:
962 attr
->config2
= term
->val
.num
;
964 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD
:
967 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ
:
970 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE
:
972 * TODO uncomment when the field is available
973 * attr->branch_sample_type = term->val.num;
976 case PARSE_EVENTS__TERM_TYPE_TIME
:
978 if (term
->val
.num
> 1) {
979 err
->str
= strdup("expected 0 or 1");
980 err
->idx
= term
->err_val
;
984 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH
:
987 case PARSE_EVENTS__TERM_TYPE_STACKSIZE
:
990 case PARSE_EVENTS__TERM_TYPE_INHERIT
:
993 case PARSE_EVENTS__TERM_TYPE_NOINHERIT
:
996 case PARSE_EVENTS__TERM_TYPE_NAME
:
999 case PARSE_EVENTS__TERM_TYPE_MAX_STACK
:
1000 CHECK_TYPE_VAL(NUM
);
1003 err
->str
= strdup("unknown term");
1004 err
->idx
= term
->err_term
;
1005 err
->help
= parse_events_formats_error_string(NULL
);
1010 * Check term availbility after basic checking so
1011 * PARSE_EVENTS__TERM_TYPE_USER can be found and filtered.
1013 * If check availbility at the entry of this function,
1014 * user will see "'<sysfs term>' is not usable in 'perf stat'"
1015 * if an invalid config term is provided for legacy events
1016 * (for example, instructions/badterm/...), which is confusing.
1018 if (!config_term_avail(term
->type_term
, err
))
1021 #undef CHECK_TYPE_VAL
1024 static int config_term_pmu(struct perf_event_attr
*attr
,
1025 struct parse_events_term
*term
,
1026 struct parse_events_error
*err
)
1028 if (term
->type_term
== PARSE_EVENTS__TERM_TYPE_USER
)
1030 * Always succeed for sysfs terms, as we dont know
1031 * at this point what type they need to have.
1035 return config_term_common(attr
, term
, err
);
1038 static int config_term_tracepoint(struct perf_event_attr
*attr
,
1039 struct parse_events_term
*term
,
1040 struct parse_events_error
*err
)
1042 switch (term
->type_term
) {
1043 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH
:
1044 case PARSE_EVENTS__TERM_TYPE_STACKSIZE
:
1045 case PARSE_EVENTS__TERM_TYPE_INHERIT
:
1046 case PARSE_EVENTS__TERM_TYPE_NOINHERIT
:
1047 case PARSE_EVENTS__TERM_TYPE_MAX_STACK
:
1048 return config_term_common(attr
, term
, err
);
1051 err
->idx
= term
->err_term
;
1052 err
->str
= strdup("unknown term");
1053 err
->help
= strdup("valid terms: call-graph,stack-size\n");
1061 static int config_attr(struct perf_event_attr
*attr
,
1062 struct list_head
*head
,
1063 struct parse_events_error
*err
,
1064 config_term_func_t config_term
)
1066 struct parse_events_term
*term
;
1068 list_for_each_entry(term
, head
, list
)
1069 if (config_term(attr
, term
, err
))
1075 static int get_config_terms(struct list_head
*head_config
,
1076 struct list_head
*head_terms __maybe_unused
)
1078 #define ADD_CONFIG_TERM(__type, __name, __val) \
1080 struct perf_evsel_config_term *__t; \
1082 __t = zalloc(sizeof(*__t)); \
1086 INIT_LIST_HEAD(&__t->list); \
1087 __t->type = PERF_EVSEL__CONFIG_TERM_ ## __type; \
1088 __t->val.__name = __val; \
1089 list_add_tail(&__t->list, head_terms); \
1092 struct parse_events_term
*term
;
1094 list_for_each_entry(term
, head_config
, list
) {
1095 switch (term
->type_term
) {
1096 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD
:
1097 ADD_CONFIG_TERM(PERIOD
, period
, term
->val
.num
);
1099 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ
:
1100 ADD_CONFIG_TERM(FREQ
, freq
, term
->val
.num
);
1102 case PARSE_EVENTS__TERM_TYPE_TIME
:
1103 ADD_CONFIG_TERM(TIME
, time
, term
->val
.num
);
1105 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH
:
1106 ADD_CONFIG_TERM(CALLGRAPH
, callgraph
, term
->val
.str
);
1108 case PARSE_EVENTS__TERM_TYPE_STACKSIZE
:
1109 ADD_CONFIG_TERM(STACK_USER
, stack_user
, term
->val
.num
);
1111 case PARSE_EVENTS__TERM_TYPE_INHERIT
:
1112 ADD_CONFIG_TERM(INHERIT
, inherit
, term
->val
.num
? 1 : 0);
1114 case PARSE_EVENTS__TERM_TYPE_NOINHERIT
:
1115 ADD_CONFIG_TERM(INHERIT
, inherit
, term
->val
.num
? 0 : 1);
1117 case PARSE_EVENTS__TERM_TYPE_MAX_STACK
:
1118 ADD_CONFIG_TERM(MAX_STACK
, max_stack
, term
->val
.num
);
1124 #undef ADD_EVSEL_CONFIG
1128 int parse_events_add_tracepoint(struct list_head
*list
, int *idx
,
1129 char *sys
, char *event
,
1130 struct parse_events_error
*err
,
1131 struct list_head
*head_config
)
1134 struct perf_event_attr attr
;
1136 if (config_attr(&attr
, head_config
, err
,
1137 config_term_tracepoint
))
1141 if (strpbrk(sys
, "*?"))
1142 return add_tracepoint_multi_sys(list
, idx
, sys
, event
,
1145 return add_tracepoint_event(list
, idx
, sys
, event
,
1149 int parse_events_add_numeric(struct parse_events_evlist
*data
,
1150 struct list_head
*list
,
1151 u32 type
, u64 config
,
1152 struct list_head
*head_config
)
1154 struct perf_event_attr attr
;
1155 LIST_HEAD(config_terms
);
1157 memset(&attr
, 0, sizeof(attr
));
1159 attr
.config
= config
;
1162 if (config_attr(&attr
, head_config
, data
->error
,
1163 config_term_common
))
1166 if (get_config_terms(head_config
, &config_terms
))
1170 return add_event(list
, &data
->idx
, &attr
,
1171 get_config_name(head_config
), &config_terms
);
1174 int parse_events_add_pmu(struct parse_events_evlist
*data
,
1175 struct list_head
*list
, char *name
,
1176 struct list_head
*head_config
)
1178 struct perf_event_attr attr
;
1179 struct perf_pmu_info info
;
1180 struct perf_pmu
*pmu
;
1181 struct perf_evsel
*evsel
;
1182 LIST_HEAD(config_terms
);
1184 pmu
= perf_pmu__find(name
);
1188 if (pmu
->default_config
) {
1189 memcpy(&attr
, pmu
->default_config
,
1190 sizeof(struct perf_event_attr
));
1192 memset(&attr
, 0, sizeof(attr
));
1196 attr
.type
= pmu
->type
;
1197 evsel
= __add_event(list
, &data
->idx
, &attr
, NULL
, pmu
->cpus
, NULL
);
1198 return evsel
? 0 : -ENOMEM
;
1201 if (perf_pmu__check_alias(pmu
, head_config
, &info
))
1205 * Configure hardcoded terms first, no need to check
1206 * return value when called with fail == 0 ;)
1208 if (config_attr(&attr
, head_config
, data
->error
, config_term_pmu
))
1211 if (get_config_terms(head_config
, &config_terms
))
1214 if (perf_pmu__config(pmu
, &attr
, head_config
, data
->error
))
1217 evsel
= __add_event(list
, &data
->idx
, &attr
,
1218 get_config_name(head_config
), pmu
->cpus
,
1221 evsel
->unit
= info
.unit
;
1222 evsel
->scale
= info
.scale
;
1223 evsel
->per_pkg
= info
.per_pkg
;
1224 evsel
->snapshot
= info
.snapshot
;
1227 return evsel
? 0 : -ENOMEM
;
1230 int parse_events__modifier_group(struct list_head
*list
,
1233 return parse_events__modifier_event(list
, event_mod
, true);
1236 void parse_events__set_leader(char *name
, struct list_head
*list
)
1238 struct perf_evsel
*leader
;
1240 if (list_empty(list
)) {
1241 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1245 __perf_evlist__set_leader(list
);
1246 leader
= list_entry(list
->next
, struct perf_evsel
, node
);
1247 leader
->group_name
= name
? strdup(name
) : NULL
;
1250 /* list_event is assumed to point to malloc'ed memory */
1251 void parse_events_update_lists(struct list_head
*list_event
,
1252 struct list_head
*list_all
)
1255 * Called for single event definition. Update the
1256 * 'all event' list, and reinit the 'single event'
1257 * list, for next event definition.
1259 list_splice_tail(list_event
, list_all
);
1263 struct event_modifier
{
1277 static int get_event_modifier(struct event_modifier
*mod
, char *str
,
1278 struct perf_evsel
*evsel
)
1280 int eu
= evsel
? evsel
->attr
.exclude_user
: 0;
1281 int ek
= evsel
? evsel
->attr
.exclude_kernel
: 0;
1282 int eh
= evsel
? evsel
->attr
.exclude_hv
: 0;
1283 int eH
= evsel
? evsel
->attr
.exclude_host
: 0;
1284 int eG
= evsel
? evsel
->attr
.exclude_guest
: 0;
1285 int eI
= evsel
? evsel
->attr
.exclude_idle
: 0;
1286 int precise
= evsel
? evsel
->attr
.precise_ip
: 0;
1287 int precise_max
= 0;
1288 int sample_read
= 0;
1289 int pinned
= evsel
? evsel
->attr
.pinned
: 0;
1291 int exclude
= eu
| ek
| eh
;
1292 int exclude_GH
= evsel
? evsel
->exclude_GH
: 0;
1294 memset(mod
, 0, sizeof(*mod
));
1299 exclude
= eu
= ek
= eh
= 1;
1301 } else if (*str
== 'k') {
1303 exclude
= eu
= ek
= eh
= 1;
1305 } else if (*str
== 'h') {
1307 exclude
= eu
= ek
= eh
= 1;
1309 } else if (*str
== 'G') {
1311 exclude_GH
= eG
= eH
= 1;
1313 } else if (*str
== 'H') {
1315 exclude_GH
= eG
= eH
= 1;
1317 } else if (*str
== 'I') {
1319 } else if (*str
== 'p') {
1321 /* use of precise requires exclude_guest */
1324 } else if (*str
== 'P') {
1326 } else if (*str
== 'S') {
1328 } else if (*str
== 'D') {
1339 * 0 - SAMPLE_IP can have arbitrary skid
1340 * 1 - SAMPLE_IP must have constant skid
1341 * 2 - SAMPLE_IP requested to have 0 skid
1342 * 3 - SAMPLE_IP must have 0 skid
1344 * See also PERF_RECORD_MISC_EXACT_IP
1355 mod
->precise
= precise
;
1356 mod
->precise_max
= precise_max
;
1357 mod
->exclude_GH
= exclude_GH
;
1358 mod
->sample_read
= sample_read
;
1359 mod
->pinned
= pinned
;
1365 * Basic modifier sanity check to validate it contains only one
1366 * instance of any modifier (apart from 'p') present.
1368 static int check_modifier(char *str
)
1372 /* The sizeof includes 0 byte as well. */
1373 if (strlen(str
) > (sizeof("ukhGHpppPSDI") - 1))
1377 if (*p
!= 'p' && strchr(p
+ 1, *p
))
1385 int parse_events__modifier_event(struct list_head
*list
, char *str
, bool add
)
1387 struct perf_evsel
*evsel
;
1388 struct event_modifier mod
;
1393 if (check_modifier(str
))
1396 if (!add
&& get_event_modifier(&mod
, str
, NULL
))
1399 __evlist__for_each_entry(list
, evsel
) {
1400 if (add
&& get_event_modifier(&mod
, str
, evsel
))
1403 evsel
->attr
.exclude_user
= mod
.eu
;
1404 evsel
->attr
.exclude_kernel
= mod
.ek
;
1405 evsel
->attr
.exclude_hv
= mod
.eh
;
1406 evsel
->attr
.precise_ip
= mod
.precise
;
1407 evsel
->attr
.exclude_host
= mod
.eH
;
1408 evsel
->attr
.exclude_guest
= mod
.eG
;
1409 evsel
->attr
.exclude_idle
= mod
.eI
;
1410 evsel
->exclude_GH
= mod
.exclude_GH
;
1411 evsel
->sample_read
= mod
.sample_read
;
1412 evsel
->precise_max
= mod
.precise_max
;
1414 if (perf_evsel__is_group_leader(evsel
))
1415 evsel
->attr
.pinned
= mod
.pinned
;
1421 int parse_events_name(struct list_head
*list
, char *name
)
1423 struct perf_evsel
*evsel
;
1425 __evlist__for_each_entry(list
, evsel
) {
1427 evsel
->name
= strdup(name
);
1434 comp_pmu(const void *p1
, const void *p2
)
1436 struct perf_pmu_event_symbol
*pmu1
= (struct perf_pmu_event_symbol
*) p1
;
1437 struct perf_pmu_event_symbol
*pmu2
= (struct perf_pmu_event_symbol
*) p2
;
1439 return strcmp(pmu1
->symbol
, pmu2
->symbol
);
1442 static void perf_pmu__parse_cleanup(void)
1444 if (perf_pmu_events_list_num
> 0) {
1445 struct perf_pmu_event_symbol
*p
;
1448 for (i
= 0; i
< perf_pmu_events_list_num
; i
++) {
1449 p
= perf_pmu_events_list
+ i
;
1452 free(perf_pmu_events_list
);
1453 perf_pmu_events_list
= NULL
;
1454 perf_pmu_events_list_num
= 0;
1458 #define SET_SYMBOL(str, stype) \
1467 * Read the pmu events list from sysfs
1468 * Save it into perf_pmu_events_list
1470 static void perf_pmu__parse_init(void)
1473 struct perf_pmu
*pmu
= NULL
;
1474 struct perf_pmu_alias
*alias
;
1477 pmu
= perf_pmu__find("cpu");
1478 if ((pmu
== NULL
) || list_empty(&pmu
->aliases
)) {
1479 perf_pmu_events_list_num
= -1;
1482 list_for_each_entry(alias
, &pmu
->aliases
, list
) {
1483 if (strchr(alias
->name
, '-'))
1487 perf_pmu_events_list
= malloc(sizeof(struct perf_pmu_event_symbol
) * len
);
1488 if (!perf_pmu_events_list
)
1490 perf_pmu_events_list_num
= len
;
1493 list_for_each_entry(alias
, &pmu
->aliases
, list
) {
1494 struct perf_pmu_event_symbol
*p
= perf_pmu_events_list
+ len
;
1495 char *tmp
= strchr(alias
->name
, '-');
1498 SET_SYMBOL(strndup(alias
->name
, tmp
- alias
->name
),
1499 PMU_EVENT_SYMBOL_PREFIX
);
1501 SET_SYMBOL(strdup(++tmp
), PMU_EVENT_SYMBOL_SUFFIX
);
1504 SET_SYMBOL(strdup(alias
->name
), PMU_EVENT_SYMBOL
);
1508 qsort(perf_pmu_events_list
, len
,
1509 sizeof(struct perf_pmu_event_symbol
), comp_pmu
);
1513 perf_pmu__parse_cleanup();
1516 enum perf_pmu_event_symbol_type
1517 perf_pmu__parse_check(const char *name
)
1519 struct perf_pmu_event_symbol p
, *r
;
1521 /* scan kernel pmu events from sysfs if needed */
1522 if (perf_pmu_events_list_num
== 0)
1523 perf_pmu__parse_init();
1525 * name "cpu" could be prefix of cpu-cycles or cpu// events.
1526 * cpu-cycles has been handled by hardcode.
1527 * So it must be cpu// events, not kernel pmu event.
1529 if ((perf_pmu_events_list_num
<= 0) || !strcmp(name
, "cpu"))
1530 return PMU_EVENT_SYMBOL_ERR
;
1532 p
.symbol
= strdup(name
);
1533 r
= bsearch(&p
, perf_pmu_events_list
,
1534 (size_t) perf_pmu_events_list_num
,
1535 sizeof(struct perf_pmu_event_symbol
), comp_pmu
);
1537 return r
? r
->type
: PMU_EVENT_SYMBOL_ERR
;
1540 static int parse_events__scanner(const char *str
, void *data
, int start_token
)
1542 YY_BUFFER_STATE buffer
;
1546 ret
= parse_events_lex_init_extra(start_token
, &scanner
);
1550 buffer
= parse_events__scan_string(str
, scanner
);
1553 parse_events_debug
= 1;
1555 ret
= parse_events_parse(data
, scanner
);
1557 parse_events__flush_buffer(buffer
, scanner
);
1558 parse_events__delete_buffer(buffer
, scanner
);
1559 parse_events_lex_destroy(scanner
);
1564 * parse event config string, return a list of event terms.
1566 int parse_events_terms(struct list_head
*terms
, const char *str
)
1568 struct parse_events_terms data
= {
1573 ret
= parse_events__scanner(str
, &data
, PE_START_TERMS
);
1575 list_splice(data
.terms
, terms
);
1580 parse_events_terms__delete(data
.terms
);
1584 int parse_events(struct perf_evlist
*evlist
, const char *str
,
1585 struct parse_events_error
*err
)
1587 struct parse_events_evlist data
= {
1588 .list
= LIST_HEAD_INIT(data
.list
),
1589 .idx
= evlist
->nr_entries
,
1595 ret
= parse_events__scanner(str
, &data
, PE_START_EVENTS
);
1596 perf_pmu__parse_cleanup();
1598 struct perf_evsel
*last
;
1600 if (list_empty(&data
.list
)) {
1601 WARN_ONCE(true, "WARNING: event parser found nothing");
1605 perf_evlist__splice_list_tail(evlist
, &data
.list
);
1606 evlist
->nr_groups
+= data
.nr_groups
;
1607 last
= perf_evlist__last(evlist
);
1608 last
->cmdline_group_boundary
= true;
1614 * There are 2 users - builtin-record and builtin-test objects.
1615 * Both call perf_evlist__delete in case of error, so we dont
1621 #define MAX_WIDTH 1000
1622 static int get_term_width(void)
1626 get_term_dimensions(&ws
);
1627 return ws
.ws_col
> MAX_WIDTH
? MAX_WIDTH
: ws
.ws_col
;
1630 static void parse_events_print_error(struct parse_events_error
*err
,
1633 const char *str
= "invalid or unsupported event: ";
1634 char _buf
[MAX_WIDTH
];
1635 char *buf
= (char *) event
;
1639 /* -2 for extra '' in the final fprintf */
1640 int width
= get_term_width() - 2;
1641 int len_event
= strlen(event
);
1642 int len_str
, max_len
, cut
= 0;
1645 * Maximum error index indent, we will cut
1646 * the event string if it's bigger.
1648 int max_err_idx
= 13;
1651 * Let's be specific with the message when
1652 * we have the precise error.
1654 str
= "event syntax error: ";
1655 len_str
= strlen(str
);
1656 max_len
= width
- len_str
;
1660 /* We're cutting from the beginning. */
1661 if (err
->idx
> max_err_idx
)
1662 cut
= err
->idx
- max_err_idx
;
1664 strncpy(buf
, event
+ cut
, max_len
);
1666 /* Mark cut parts with '..' on both sides. */
1668 buf
[0] = buf
[1] = '.';
1670 if ((len_event
- cut
) > max_len
) {
1671 buf
[max_len
- 1] = buf
[max_len
- 2] = '.';
1675 idx
= len_str
+ err
->idx
- cut
;
1678 fprintf(stderr
, "%s'%s'\n", str
, buf
);
1680 fprintf(stderr
, "%*s\\___ %s\n", idx
+ 1, "", err
->str
);
1682 fprintf(stderr
, "\n%s\n", err
->help
);
1687 fprintf(stderr
, "Run 'perf list' for a list of valid events\n");
1692 int parse_events_option(const struct option
*opt
, const char *str
,
1693 int unset __maybe_unused
)
1695 struct perf_evlist
*evlist
= *(struct perf_evlist
**)opt
->value
;
1696 struct parse_events_error err
= { .idx
= 0, };
1697 int ret
= parse_events(evlist
, str
, &err
);
1700 parse_events_print_error(&err
, str
);
1706 foreach_evsel_in_last_glob(struct perf_evlist
*evlist
,
1707 int (*func
)(struct perf_evsel
*evsel
,
1711 struct perf_evsel
*last
= NULL
;
1715 * Don't return when list_empty, give func a chance to report
1716 * error when it found last == NULL.
1718 * So no need to WARN here, let *func do this.
1720 if (evlist
->nr_entries
> 0)
1721 last
= perf_evlist__last(evlist
);
1724 err
= (*func
)(last
, arg
);
1730 if (last
->node
.prev
== &evlist
->entries
)
1732 last
= list_entry(last
->node
.prev
, struct perf_evsel
, node
);
1733 } while (!last
->cmdline_group_boundary
);
1738 static int set_filter(struct perf_evsel
*evsel
, const void *arg
)
1740 const char *str
= arg
;
1742 if (evsel
== NULL
|| evsel
->attr
.type
!= PERF_TYPE_TRACEPOINT
) {
1744 "--filter option should follow a -e tracepoint option\n");
1748 if (perf_evsel__append_filter(evsel
, "&&", str
) < 0) {
1750 "not enough memory to hold filter string\n");
1757 int parse_filter(const struct option
*opt
, const char *str
,
1758 int unset __maybe_unused
)
1760 struct perf_evlist
*evlist
= *(struct perf_evlist
**)opt
->value
;
1762 return foreach_evsel_in_last_glob(evlist
, set_filter
,
1766 static int add_exclude_perf_filter(struct perf_evsel
*evsel
,
1767 const void *arg __maybe_unused
)
1769 char new_filter
[64];
1771 if (evsel
== NULL
|| evsel
->attr
.type
!= PERF_TYPE_TRACEPOINT
) {
1773 "--exclude-perf option should follow a -e tracepoint option\n");
1777 snprintf(new_filter
, sizeof(new_filter
), "common_pid != %d", getpid());
1779 if (perf_evsel__append_filter(evsel
, "&&", new_filter
) < 0) {
1781 "not enough memory to hold filter string\n");
1788 int exclude_perf(const struct option
*opt
,
1789 const char *arg __maybe_unused
,
1790 int unset __maybe_unused
)
1792 struct perf_evlist
*evlist
= *(struct perf_evlist
**)opt
->value
;
1794 return foreach_evsel_in_last_glob(evlist
, add_exclude_perf_filter
,
1798 static const char * const event_type_descriptors
[] = {
1802 "Hardware cache event",
1803 "Raw hardware event descriptor",
1804 "Hardware breakpoint",
1807 static int cmp_string(const void *a
, const void *b
)
1809 const char * const *as
= a
;
1810 const char * const *bs
= b
;
1812 return strcmp(*as
, *bs
);
1816 * Print the events from <debugfs_mount_point>/tracing/events
1819 void print_tracepoint_events(const char *subsys_glob
, const char *event_glob
,
1822 DIR *sys_dir
, *evt_dir
;
1823 struct dirent
*sys_dirent
, *evt_dirent
;
1824 char evt_path
[MAXPATHLEN
];
1825 char dir_path
[MAXPATHLEN
];
1826 char **evt_list
= NULL
;
1827 unsigned int evt_i
= 0, evt_num
= 0;
1828 bool evt_num_known
= false;
1831 sys_dir
= opendir(tracing_events_path
);
1835 if (evt_num_known
) {
1836 evt_list
= zalloc(sizeof(char *) * evt_num
);
1838 goto out_close_sys_dir
;
1841 for_each_subsystem(sys_dir
, sys_dirent
) {
1842 if (subsys_glob
!= NULL
&&
1843 !strglobmatch(sys_dirent
->d_name
, subsys_glob
))
1846 snprintf(dir_path
, MAXPATHLEN
, "%s/%s", tracing_events_path
,
1847 sys_dirent
->d_name
);
1848 evt_dir
= opendir(dir_path
);
1852 for_each_event(sys_dirent
, evt_dir
, evt_dirent
) {
1853 if (event_glob
!= NULL
&&
1854 !strglobmatch(evt_dirent
->d_name
, event_glob
))
1857 if (!evt_num_known
) {
1862 snprintf(evt_path
, MAXPATHLEN
, "%s:%s",
1863 sys_dirent
->d_name
, evt_dirent
->d_name
);
1865 evt_list
[evt_i
] = strdup(evt_path
);
1866 if (evt_list
[evt_i
] == NULL
)
1867 goto out_close_evt_dir
;
1874 if (!evt_num_known
) {
1875 evt_num_known
= true;
1878 qsort(evt_list
, evt_num
, sizeof(char *), cmp_string
);
1880 while (evt_i
< evt_num
) {
1882 printf("%s ", evt_list
[evt_i
++]);
1885 printf(" %-50s [%s]\n", evt_list
[evt_i
++],
1886 event_type_descriptors
[PERF_TYPE_TRACEPOINT
]);
1888 if (evt_num
&& pager_in_use())
1893 for (evt_i
= 0; evt_i
< evt_num
; evt_i
++)
1894 zfree(&evt_list
[evt_i
]);
1903 printf("FATAL: not enough memory to print %s\n",
1904 event_type_descriptors
[PERF_TYPE_TRACEPOINT
]);
1910 * Check whether event is in <debugfs_mount_point>/tracing/events
1913 int is_valid_tracepoint(const char *event_string
)
1915 DIR *sys_dir
, *evt_dir
;
1916 struct dirent
*sys_dirent
, *evt_dirent
;
1917 char evt_path
[MAXPATHLEN
];
1918 char dir_path
[MAXPATHLEN
];
1920 sys_dir
= opendir(tracing_events_path
);
1924 for_each_subsystem(sys_dir
, sys_dirent
) {
1926 snprintf(dir_path
, MAXPATHLEN
, "%s/%s", tracing_events_path
,
1927 sys_dirent
->d_name
);
1928 evt_dir
= opendir(dir_path
);
1932 for_each_event(sys_dirent
, evt_dir
, evt_dirent
) {
1933 snprintf(evt_path
, MAXPATHLEN
, "%s:%s",
1934 sys_dirent
->d_name
, evt_dirent
->d_name
);
1935 if (!strcmp(evt_path
, event_string
)) {
1947 static bool is_event_supported(u8 type
, unsigned config
)
1951 struct perf_evsel
*evsel
;
1952 struct perf_event_attr attr
= {
1958 struct thread_map map
;
1965 evsel
= perf_evsel__new(&attr
);
1967 open_return
= perf_evsel__open(evsel
, NULL
, &tmap
.map
);
1968 ret
= open_return
>= 0;
1970 if (open_return
== -EACCES
) {
1972 * This happens if the paranoid value
1973 * /proc/sys/kernel/perf_event_paranoid is set to 2
1974 * Re-run with exclude_kernel set; we don't do that
1975 * by default as some ARM machines do not support it.
1978 evsel
->attr
.exclude_kernel
= 1;
1979 ret
= perf_evsel__open(evsel
, NULL
, &tmap
.map
) >= 0;
1981 perf_evsel__delete(evsel
);
1987 int print_hwcache_events(const char *event_glob
, bool name_only
)
1989 unsigned int type
, op
, i
, evt_i
= 0, evt_num
= 0;
1991 char **evt_list
= NULL
;
1992 bool evt_num_known
= false;
1995 if (evt_num_known
) {
1996 evt_list
= zalloc(sizeof(char *) * evt_num
);
2001 for (type
= 0; type
< PERF_COUNT_HW_CACHE_MAX
; type
++) {
2002 for (op
= 0; op
< PERF_COUNT_HW_CACHE_OP_MAX
; op
++) {
2003 /* skip invalid cache type */
2004 if (!perf_evsel__is_cache_op_valid(type
, op
))
2007 for (i
= 0; i
< PERF_COUNT_HW_CACHE_RESULT_MAX
; i
++) {
2008 __perf_evsel__hw_cache_type_op_res_name(type
, op
, i
,
2009 name
, sizeof(name
));
2010 if (event_glob
!= NULL
&& !strglobmatch(name
, event_glob
))
2013 if (!is_event_supported(PERF_TYPE_HW_CACHE
,
2014 type
| (op
<< 8) | (i
<< 16)))
2017 if (!evt_num_known
) {
2022 evt_list
[evt_i
] = strdup(name
);
2023 if (evt_list
[evt_i
] == NULL
)
2030 if (!evt_num_known
) {
2031 evt_num_known
= true;
2034 qsort(evt_list
, evt_num
, sizeof(char *), cmp_string
);
2036 while (evt_i
< evt_num
) {
2038 printf("%s ", evt_list
[evt_i
++]);
2041 printf(" %-50s [%s]\n", evt_list
[evt_i
++],
2042 event_type_descriptors
[PERF_TYPE_HW_CACHE
]);
2044 if (evt_num
&& pager_in_use())
2049 for (evt_i
= 0; evt_i
< evt_num
; evt_i
++)
2050 zfree(&evt_list
[evt_i
]);
2055 printf("FATAL: not enough memory to print %s\n", event_type_descriptors
[PERF_TYPE_HW_CACHE
]);
2061 void print_symbol_events(const char *event_glob
, unsigned type
,
2062 struct event_symbol
*syms
, unsigned max
,
2065 unsigned int i
, evt_i
= 0, evt_num
= 0;
2066 char name
[MAX_NAME_LEN
];
2067 char **evt_list
= NULL
;
2068 bool evt_num_known
= false;
2071 if (evt_num_known
) {
2072 evt_list
= zalloc(sizeof(char *) * evt_num
);
2078 for (i
= 0; i
< max
; i
++, syms
++) {
2080 if (event_glob
!= NULL
&& syms
->symbol
!= NULL
&&
2081 !(strglobmatch(syms
->symbol
, event_glob
) ||
2082 (syms
->alias
&& strglobmatch(syms
->alias
, event_glob
))))
2085 if (!is_event_supported(type
, i
))
2088 if (!evt_num_known
) {
2093 if (!name_only
&& strlen(syms
->alias
))
2094 snprintf(name
, MAX_NAME_LEN
, "%s OR %s", syms
->symbol
, syms
->alias
);
2096 strncpy(name
, syms
->symbol
, MAX_NAME_LEN
);
2098 evt_list
[evt_i
] = strdup(name
);
2099 if (evt_list
[evt_i
] == NULL
)
2104 if (!evt_num_known
) {
2105 evt_num_known
= true;
2108 qsort(evt_list
, evt_num
, sizeof(char *), cmp_string
);
2110 while (evt_i
< evt_num
) {
2112 printf("%s ", evt_list
[evt_i
++]);
2115 printf(" %-50s [%s]\n", evt_list
[evt_i
++], event_type_descriptors
[type
]);
2117 if (evt_num
&& pager_in_use())
2122 for (evt_i
= 0; evt_i
< evt_num
; evt_i
++)
2123 zfree(&evt_list
[evt_i
]);
2128 printf("FATAL: not enough memory to print %s\n", event_type_descriptors
[type
]);
2134 * Print the help text for the event symbols:
2136 void print_events(const char *event_glob
, bool name_only
)
2138 print_symbol_events(event_glob
, PERF_TYPE_HARDWARE
,
2139 event_symbols_hw
, PERF_COUNT_HW_MAX
, name_only
);
2141 print_symbol_events(event_glob
, PERF_TYPE_SOFTWARE
,
2142 event_symbols_sw
, PERF_COUNT_SW_MAX
, name_only
);
2144 print_hwcache_events(event_glob
, name_only
);
2146 print_pmu_events(event_glob
, name_only
);
2148 if (event_glob
!= NULL
)
2152 printf(" %-50s [%s]\n",
2154 event_type_descriptors
[PERF_TYPE_RAW
]);
2155 printf(" %-50s [%s]\n",
2156 "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
2157 event_type_descriptors
[PERF_TYPE_RAW
]);
2159 printf(" (see 'man perf-list' on how to encode it)\n\n");
2161 printf(" %-50s [%s]\n",
2162 "mem:<addr>[/len][:access]",
2163 event_type_descriptors
[PERF_TYPE_BREAKPOINT
]);
2168 print_tracepoint_events(NULL
, NULL
, name_only
);
2171 int parse_events__is_hardcoded_term(struct parse_events_term
*term
)
2173 return term
->type_term
!= PARSE_EVENTS__TERM_TYPE_USER
;
2176 static int new_term(struct parse_events_term
**_term
, int type_val
,
2177 int type_term
, char *config
,
2178 char *str
, u64 num
, int err_term
, int err_val
)
2180 struct parse_events_term
*term
;
2182 term
= zalloc(sizeof(*term
));
2186 INIT_LIST_HEAD(&term
->list
);
2187 term
->type_val
= type_val
;
2188 term
->type_term
= type_term
;
2189 term
->config
= config
;
2190 term
->err_term
= err_term
;
2191 term
->err_val
= err_val
;
2194 case PARSE_EVENTS__TERM_TYPE_NUM
:
2195 term
->val
.num
= num
;
2197 case PARSE_EVENTS__TERM_TYPE_STR
:
2198 term
->val
.str
= str
;
2209 int parse_events_term__num(struct parse_events_term
**term
,
2210 int type_term
, char *config
, u64 num
,
2211 void *loc_term_
, void *loc_val_
)
2213 YYLTYPE
*loc_term
= loc_term_
;
2214 YYLTYPE
*loc_val
= loc_val_
;
2216 return new_term(term
, PARSE_EVENTS__TERM_TYPE_NUM
, type_term
,
2218 loc_term
? loc_term
->first_column
: 0,
2219 loc_val
? loc_val
->first_column
: 0);
2222 int parse_events_term__str(struct parse_events_term
**term
,
2223 int type_term
, char *config
, char *str
,
2224 void *loc_term_
, void *loc_val_
)
2226 YYLTYPE
*loc_term
= loc_term_
;
2227 YYLTYPE
*loc_val
= loc_val_
;
2229 return new_term(term
, PARSE_EVENTS__TERM_TYPE_STR
, type_term
,
2231 loc_term
? loc_term
->first_column
: 0,
2232 loc_val
? loc_val
->first_column
: 0);
2235 int parse_events_term__sym_hw(struct parse_events_term
**term
,
2236 char *config
, unsigned idx
)
2238 struct event_symbol
*sym
;
2240 BUG_ON(idx
>= PERF_COUNT_HW_MAX
);
2241 sym
= &event_symbols_hw
[idx
];
2244 return new_term(term
, PARSE_EVENTS__TERM_TYPE_STR
,
2245 PARSE_EVENTS__TERM_TYPE_USER
, config
,
2246 (char *) sym
->symbol
, 0, 0, 0);
2248 return new_term(term
, PARSE_EVENTS__TERM_TYPE_STR
,
2249 PARSE_EVENTS__TERM_TYPE_USER
,
2250 (char *) "event", (char *) sym
->symbol
,
2254 int parse_events_term__clone(struct parse_events_term
**new,
2255 struct parse_events_term
*term
)
2257 return new_term(new, term
->type_val
, term
->type_term
, term
->config
,
2258 term
->val
.str
, term
->val
.num
,
2259 term
->err_term
, term
->err_val
);
2262 void parse_events_terms__purge(struct list_head
*terms
)
2264 struct parse_events_term
*term
, *h
;
2266 list_for_each_entry_safe(term
, h
, terms
, list
) {
2267 if (term
->array
.nr_ranges
)
2268 free(term
->array
.ranges
);
2269 list_del_init(&term
->list
);
2274 void parse_events_terms__delete(struct list_head
*terms
)
2278 parse_events_terms__purge(terms
);
2282 void parse_events__clear_array(struct parse_events_array
*a
)
2287 void parse_events_evlist_error(struct parse_events_evlist
*data
,
2288 int idx
, const char *str
)
2290 struct parse_events_error
*err
= data
->error
;
2295 err
->str
= strdup(str
);
2296 WARN_ONCE(!err
->str
, "WARNING: failed to allocate error string");
2299 static void config_terms_list(char *buf
, size_t buf_sz
)
2305 for (i
= 0; i
< __PARSE_EVENTS__TERM_TYPE_NR
; i
++) {
2306 const char *name
= config_term_names
[i
];
2308 if (!config_term_avail(i
, NULL
))
2315 if (strlen(buf
) + strlen(name
) + 2 >= buf_sz
)
2327 * Return string contains valid config terms of an event.
2328 * @additional_terms: For terms such as PMU sysfs terms.
2330 char *parse_events_formats_error_string(char *additional_terms
)
2333 /* "branch_type" is the longest name */
2334 char static_terms
[__PARSE_EVENTS__TERM_TYPE_NR
*
2335 (sizeof("branch_type") - 1)];
2337 config_terms_list(static_terms
, sizeof(static_terms
));
2339 if (additional_terms
) {
2340 if (asprintf(&str
, "valid terms: %s,%s",
2341 additional_terms
, static_terms
) < 0)
2344 if (asprintf(&str
, "valid terms: %s", static_terms
) < 0)