Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __PERF_PARSE_EVENTS_H
3#define __PERF_PARSE_EVENTS_H
4/*
5 * Parse symbolic events/counts passed in as options:
6 */
7
8#include <linux/list.h>
9#include <stdbool.h>
10#include <linux/types.h>
11#include <linux/perf_event.h>
12#include <string.h>
13
14struct list_head;
15struct perf_evsel;
16struct perf_evlist;
17struct parse_events_error;
18
19struct option;
20
21struct tracepoint_path {
22 char *system;
23 char *name;
24 struct tracepoint_path *next;
25};
26
27struct tracepoint_path *tracepoint_id_to_path(u64 config);
28struct tracepoint_path *tracepoint_name_to_path(const char *name);
29bool have_tracepoints(struct list_head *evlist);
30
31const char *event_type(int type);
32
33int parse_events_option(const struct option *opt, const char *str, int unset);
34int parse_events(struct perf_evlist *evlist, const char *str,
35 struct parse_events_error *error);
36int parse_events_terms(struct list_head *terms, const char *str);
37int parse_filter(const struct option *opt, const char *str, int unset);
38int exclude_perf(const struct option *opt, const char *arg, int unset);
39
40#define EVENTS_HELP_MAX (128*1024)
41
42enum perf_pmu_event_symbol_type {
43 PMU_EVENT_SYMBOL_ERR, /* not a PMU EVENT */
44 PMU_EVENT_SYMBOL, /* normal style PMU event */
45 PMU_EVENT_SYMBOL_PREFIX, /* prefix of pre-suf style event */
46 PMU_EVENT_SYMBOL_SUFFIX, /* suffix of pre-suf style event */
47};
48
49struct perf_pmu_event_symbol {
50 char *symbol;
51 enum perf_pmu_event_symbol_type type;
52};
53
54enum {
55 PARSE_EVENTS__TERM_TYPE_NUM,
56 PARSE_EVENTS__TERM_TYPE_STR,
57};
58
59enum {
60 PARSE_EVENTS__TERM_TYPE_USER,
61 PARSE_EVENTS__TERM_TYPE_CONFIG,
62 PARSE_EVENTS__TERM_TYPE_CONFIG1,
63 PARSE_EVENTS__TERM_TYPE_CONFIG2,
64 PARSE_EVENTS__TERM_TYPE_NAME,
65 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
66 PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
67 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
68 PARSE_EVENTS__TERM_TYPE_TIME,
69 PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
70 PARSE_EVENTS__TERM_TYPE_STACKSIZE,
71 PARSE_EVENTS__TERM_TYPE_NOINHERIT,
72 PARSE_EVENTS__TERM_TYPE_INHERIT,
73 PARSE_EVENTS__TERM_TYPE_MAX_STACK,
74 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,
75 PARSE_EVENTS__TERM_TYPE_OVERWRITE,
76 PARSE_EVENTS__TERM_TYPE_DRV_CFG,
77 __PARSE_EVENTS__TERM_TYPE_NR,
78};
79
80struct parse_events_array {
81 size_t nr_ranges;
82 struct {
83 unsigned int start;
84 size_t length;
85 } *ranges;
86};
87
88struct parse_events_term {
89 char *config;
90 struct parse_events_array array;
91 union {
92 char *str;
93 u64 num;
94 } val;
95 int type_val;
96 int type_term;
97 struct list_head list;
98 bool used;
99 bool no_value;
100
101 /* error string indexes for within parsed string */
102 int err_term;
103 int err_val;
104
105 /* Coming from implicit alias */
106 bool weak;
107};
108
109struct parse_events_error {
110 int idx; /* index in the parsed string */
111 char *str; /* string to display at the index */
112 char *help; /* optional help string */
113};
114
115struct parse_events_state {
116 struct list_head list;
117 int idx;
118 int nr_groups;
119 struct parse_events_error *error;
120 struct perf_evlist *evlist;
121 struct list_head *terms;
122};
123
124void parse_events__shrink_config_terms(void);
125int parse_events__is_hardcoded_term(struct parse_events_term *term);
126int parse_events_term__num(struct parse_events_term **term,
127 int type_term, char *config, u64 num,
128 bool novalue,
129 void *loc_term, void *loc_val);
130int parse_events_term__str(struct parse_events_term **term,
131 int type_term, char *config, char *str,
132 void *loc_term, void *loc_val);
133int parse_events_term__sym_hw(struct parse_events_term **term,
134 char *config, unsigned idx);
135int parse_events_term__clone(struct parse_events_term **new,
136 struct parse_events_term *term);
137void parse_events_terms__delete(struct list_head *terms);
138void parse_events_terms__purge(struct list_head *terms);
139void parse_events__clear_array(struct parse_events_array *a);
140int parse_events__modifier_event(struct list_head *list, char *str, bool add);
141int parse_events__modifier_group(struct list_head *list, char *event_mod);
142int parse_events_name(struct list_head *list, char *name);
143int parse_events_add_tracepoint(struct list_head *list, int *idx,
144 const char *sys, const char *event,
145 struct parse_events_error *error,
146 struct list_head *head_config);
147int parse_events_load_bpf(struct parse_events_state *parse_state,
148 struct list_head *list,
149 char *bpf_file_name,
150 bool source,
151 struct list_head *head_config);
152/* Provide this function for perf test */
153struct bpf_object;
154int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
155 struct list_head *list,
156 struct bpf_object *obj,
157 struct list_head *head_config);
158int parse_events_add_numeric(struct parse_events_state *parse_state,
159 struct list_head *list,
160 u32 type, u64 config,
161 struct list_head *head_config);
162int parse_events_add_cache(struct list_head *list, int *idx,
163 char *type, char *op_result1, char *op_result2,
164 struct parse_events_error *error,
165 struct list_head *head_config);
166int parse_events_add_breakpoint(struct list_head *list, int *idx,
167 void *ptr, char *type, u64 len);
168int parse_events_add_pmu(struct parse_events_state *parse_state,
169 struct list_head *list, char *name,
170 struct list_head *head_config,
171 bool auto_merge_stats,
172 bool use_alias);
173
174int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
175 char *str,
176 struct list_head **listp);
177
178int parse_events_copy_term_list(struct list_head *old,
179 struct list_head **new);
180
181enum perf_pmu_event_symbol_type
182perf_pmu__parse_check(const char *name);
183void parse_events__set_leader(char *name, struct list_head *list,
184 struct parse_events_state *parse_state);
185void parse_events_update_lists(struct list_head *list_event,
186 struct list_head *list_all);
187void parse_events_evlist_error(struct parse_events_state *parse_state,
188 int idx, const char *str);
189
190void print_events(const char *event_glob, bool name_only, bool quiet,
191 bool long_desc, bool details_flag);
192
193struct event_symbol {
194 const char *symbol;
195 const char *alias;
196};
197extern struct event_symbol event_symbols_hw[];
198extern struct event_symbol event_symbols_sw[];
199void print_symbol_events(const char *event_glob, unsigned type,
200 struct event_symbol *syms, unsigned max,
201 bool name_only);
202void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
203 bool name_only);
204int print_hwcache_events(const char *event_glob, bool name_only);
205void print_sdt_events(const char *subsys_glob, const char *event_glob,
206 bool name_only);
207int is_valid_tracepoint(const char *event_string);
208
209int valid_event_mount(const char *eventfs);
210char *parse_events_formats_error_string(char *additional_terms);
211
212void parse_events_print_error(struct parse_events_error *err,
213 const char *event);
214
215#ifdef HAVE_LIBELF_SUPPORT
216/*
217 * If the probe point starts with '%',
218 * or starts with "sdt_" and has a ':' but no '=',
219 * then it should be a SDT/cached probe point.
220 */
221static inline bool is_sdt_event(char *str)
222{
223 return (str[0] == '%' ||
224 (!strncmp(str, "sdt_", 4) &&
225 !!strchr(str, ':') && !strchr(str, '=')));
226}
227#else
228static inline bool is_sdt_event(char *str __maybe_unused)
229{
230 return false;
231}
232#endif /* HAVE_LIBELF_SUPPORT */
233
234#endif /* __PERF_PARSE_EVENTS_H */
1#ifndef __PERF_PARSE_EVENTS_H
2#define __PERF_PARSE_EVENTS_H
3/*
4 * Parse symbolic events/counts passed in as options:
5 */
6
7#include <linux/list.h>
8#include <stdbool.h>
9#include <linux/types.h>
10#include <linux/perf_event.h>
11
12struct list_head;
13struct perf_evsel;
14struct perf_evlist;
15struct parse_events_error;
16
17struct option;
18
19struct tracepoint_path {
20 char *system;
21 char *name;
22 struct tracepoint_path *next;
23};
24
25struct tracepoint_path *tracepoint_id_to_path(u64 config);
26struct tracepoint_path *tracepoint_name_to_path(const char *name);
27bool have_tracepoints(struct list_head *evlist);
28
29const char *event_type(int type);
30
31int parse_events_option(const struct option *opt, const char *str, int unset);
32int parse_events(struct perf_evlist *evlist, const char *str,
33 struct parse_events_error *error);
34int parse_events_terms(struct list_head *terms, const char *str);
35int parse_filter(const struct option *opt, const char *str, int unset);
36int exclude_perf(const struct option *opt, const char *arg, int unset);
37
38#define EVENTS_HELP_MAX (128*1024)
39
40enum perf_pmu_event_symbol_type {
41 PMU_EVENT_SYMBOL_ERR, /* not a PMU EVENT */
42 PMU_EVENT_SYMBOL, /* normal style PMU event */
43 PMU_EVENT_SYMBOL_PREFIX, /* prefix of pre-suf style event */
44 PMU_EVENT_SYMBOL_SUFFIX, /* suffix of pre-suf style event */
45};
46
47struct perf_pmu_event_symbol {
48 char *symbol;
49 enum perf_pmu_event_symbol_type type;
50};
51
52enum {
53 PARSE_EVENTS__TERM_TYPE_NUM,
54 PARSE_EVENTS__TERM_TYPE_STR,
55};
56
57enum {
58 PARSE_EVENTS__TERM_TYPE_USER,
59 PARSE_EVENTS__TERM_TYPE_CONFIG,
60 PARSE_EVENTS__TERM_TYPE_CONFIG1,
61 PARSE_EVENTS__TERM_TYPE_CONFIG2,
62 PARSE_EVENTS__TERM_TYPE_NAME,
63 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
64 PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
65 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
66 PARSE_EVENTS__TERM_TYPE_TIME,
67 PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
68 PARSE_EVENTS__TERM_TYPE_STACKSIZE,
69 PARSE_EVENTS__TERM_TYPE_NOINHERIT,
70 PARSE_EVENTS__TERM_TYPE_INHERIT,
71 PARSE_EVENTS__TERM_TYPE_MAX_STACK,
72 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,
73 PARSE_EVENTS__TERM_TYPE_OVERWRITE,
74 PARSE_EVENTS__TERM_TYPE_DRV_CFG,
75 __PARSE_EVENTS__TERM_TYPE_NR,
76};
77
78struct parse_events_array {
79 size_t nr_ranges;
80 struct {
81 unsigned int start;
82 size_t length;
83 } *ranges;
84};
85
86struct parse_events_term {
87 char *config;
88 struct parse_events_array array;
89 union {
90 char *str;
91 u64 num;
92 } val;
93 int type_val;
94 int type_term;
95 struct list_head list;
96 bool used;
97
98 /* error string indexes for within parsed string */
99 int err_term;
100 int err_val;
101};
102
103struct parse_events_error {
104 int idx; /* index in the parsed string */
105 char *str; /* string to display at the index */
106 char *help; /* optional help string */
107};
108
109struct parse_events_evlist {
110 struct list_head list;
111 int idx;
112 int nr_groups;
113 struct parse_events_error *error;
114 struct perf_evlist *evlist;
115};
116
117struct parse_events_terms {
118 struct list_head *terms;
119};
120
121void parse_events__shrink_config_terms(void);
122int parse_events__is_hardcoded_term(struct parse_events_term *term);
123int parse_events_term__num(struct parse_events_term **term,
124 int type_term, char *config, u64 num,
125 void *loc_term, void *loc_val);
126int parse_events_term__str(struct parse_events_term **term,
127 int type_term, char *config, char *str,
128 void *loc_term, void *loc_val);
129int parse_events_term__sym_hw(struct parse_events_term **term,
130 char *config, unsigned idx);
131int parse_events_term__clone(struct parse_events_term **new,
132 struct parse_events_term *term);
133void parse_events_terms__delete(struct list_head *terms);
134void parse_events_terms__purge(struct list_head *terms);
135void parse_events__clear_array(struct parse_events_array *a);
136int parse_events__modifier_event(struct list_head *list, char *str, bool add);
137int parse_events__modifier_group(struct list_head *list, char *event_mod);
138int parse_events_name(struct list_head *list, char *name);
139int parse_events_add_tracepoint(struct list_head *list, int *idx,
140 const char *sys, const char *event,
141 struct parse_events_error *error,
142 struct list_head *head_config);
143int parse_events_load_bpf(struct parse_events_evlist *data,
144 struct list_head *list,
145 char *bpf_file_name,
146 bool source,
147 struct list_head *head_config);
148/* Provide this function for perf test */
149struct bpf_object;
150int parse_events_load_bpf_obj(struct parse_events_evlist *data,
151 struct list_head *list,
152 struct bpf_object *obj,
153 struct list_head *head_config);
154int parse_events_add_numeric(struct parse_events_evlist *data,
155 struct list_head *list,
156 u32 type, u64 config,
157 struct list_head *head_config);
158int parse_events_add_cache(struct list_head *list, int *idx,
159 char *type, char *op_result1, char *op_result2,
160 struct parse_events_error *error,
161 struct list_head *head_config);
162int parse_events_add_breakpoint(struct list_head *list, int *idx,
163 void *ptr, char *type, u64 len);
164int parse_events_add_pmu(struct parse_events_evlist *data,
165 struct list_head *list, char *name,
166 struct list_head *head_config);
167enum perf_pmu_event_symbol_type
168perf_pmu__parse_check(const char *name);
169void parse_events__set_leader(char *name, struct list_head *list);
170void parse_events_update_lists(struct list_head *list_event,
171 struct list_head *list_all);
172void parse_events_evlist_error(struct parse_events_evlist *data,
173 int idx, const char *str);
174
175void print_events(const char *event_glob, bool name_only, bool quiet,
176 bool long_desc);
177
178struct event_symbol {
179 const char *symbol;
180 const char *alias;
181};
182extern struct event_symbol event_symbols_hw[];
183extern struct event_symbol event_symbols_sw[];
184void print_symbol_events(const char *event_glob, unsigned type,
185 struct event_symbol *syms, unsigned max,
186 bool name_only);
187void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
188 bool name_only);
189int print_hwcache_events(const char *event_glob, bool name_only);
190void print_sdt_events(const char *subsys_glob, const char *event_glob,
191 bool name_only);
192int is_valid_tracepoint(const char *event_string);
193
194int valid_event_mount(const char *eventfs);
195char *parse_events_formats_error_string(char *additional_terms);
196
197#endif /* __PERF_PARSE_EVENTS_H */