1 #ifndef __PERF_PARSE_EVENTS_H
2 #define __PERF_PARSE_EVENTS_H
4 * Parse symbolic events/counts passed in as options:
7 #include <linux/list.h>
9 #include <linux/types.h>
10 #include <linux/perf_event.h>
16 struct parse_events_error;
20 struct tracepoint_path {
23 struct tracepoint_path *next;
26 struct tracepoint_path *tracepoint_id_to_path(u64 config);
27 struct tracepoint_path *tracepoint_name_to_path(const char *name);
28 bool have_tracepoints(struct list_head *evlist);
30 const char *event_type(int type);
32 int parse_events_option(const struct option *opt, const char *str, int unset);
33 int parse_events(struct perf_evlist *evlist, const char *str,
34 struct parse_events_error *error);
35 int parse_events_terms(struct list_head *terms, const char *str);
36 int parse_filter(const struct option *opt, const char *str, int unset);
37 int exclude_perf(const struct option *opt, const char *arg, int unset);
39 #define EVENTS_HELP_MAX (128*1024)
41 enum perf_pmu_event_symbol_type {
42 PMU_EVENT_SYMBOL_ERR, /* not a PMU EVENT */
43 PMU_EVENT_SYMBOL, /* normal style PMU event */
44 PMU_EVENT_SYMBOL_PREFIX, /* prefix of pre-suf style event */
45 PMU_EVENT_SYMBOL_SUFFIX, /* suffix of pre-suf style event */
48 struct perf_pmu_event_symbol {
50 enum perf_pmu_event_symbol_type type;
54 PARSE_EVENTS__TERM_TYPE_NUM,
55 PARSE_EVENTS__TERM_TYPE_STR,
59 PARSE_EVENTS__TERM_TYPE_USER,
60 PARSE_EVENTS__TERM_TYPE_CONFIG,
61 PARSE_EVENTS__TERM_TYPE_CONFIG1,
62 PARSE_EVENTS__TERM_TYPE_CONFIG2,
63 PARSE_EVENTS__TERM_TYPE_NAME,
64 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
65 PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
66 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
67 PARSE_EVENTS__TERM_TYPE_TIME,
68 PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
69 PARSE_EVENTS__TERM_TYPE_STACKSIZE,
70 PARSE_EVENTS__TERM_TYPE_NOINHERIT,
71 PARSE_EVENTS__TERM_TYPE_INHERIT,
72 PARSE_EVENTS__TERM_TYPE_MAX_STACK,
73 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,
74 PARSE_EVENTS__TERM_TYPE_OVERWRITE,
75 PARSE_EVENTS__TERM_TYPE_DRV_CFG,
76 __PARSE_EVENTS__TERM_TYPE_NR,
79 struct parse_events_array {
87 struct parse_events_term {
89 struct parse_events_array array;
96 struct list_head list;
100 /* error string indexes for within parsed string */
105 struct parse_events_error {
106 int idx; /* index in the parsed string */
107 char *str; /* string to display at the index */
108 char *help; /* optional help string */
111 struct parse_events_state {
112 struct list_head list;
115 struct parse_events_error *error;
116 struct perf_evlist *evlist;
117 struct list_head *terms;
120 void parse_events__shrink_config_terms(void);
121 int parse_events__is_hardcoded_term(struct parse_events_term *term);
122 int parse_events_term__num(struct parse_events_term **term,
123 int type_term, char *config, u64 num,
125 void *loc_term, void *loc_val);
126 int parse_events_term__str(struct parse_events_term **term,
127 int type_term, char *config, char *str,
128 void *loc_term, void *loc_val);
129 int parse_events_term__sym_hw(struct parse_events_term **term,
130 char *config, unsigned idx);
131 int parse_events_term__clone(struct parse_events_term **new,
132 struct parse_events_term *term);
133 void parse_events_terms__delete(struct list_head *terms);
134 void parse_events_terms__purge(struct list_head *terms);
135 void parse_events__clear_array(struct parse_events_array *a);
136 int parse_events__modifier_event(struct list_head *list, char *str, bool add);
137 int parse_events__modifier_group(struct list_head *list, char *event_mod);
138 int parse_events_name(struct list_head *list, char *name);
139 int 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);
143 int parse_events_load_bpf(struct parse_events_state *parse_state,
144 struct list_head *list,
147 struct list_head *head_config);
148 /* Provide this function for perf test */
150 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
151 struct list_head *list,
152 struct bpf_object *obj,
153 struct list_head *head_config);
154 int parse_events_add_numeric(struct parse_events_state *parse_state,
155 struct list_head *list,
156 u32 type, u64 config,
157 struct list_head *head_config);
158 int 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);
162 int parse_events_add_breakpoint(struct list_head *list, int *idx,
163 void *ptr, char *type, u64 len);
164 int parse_events_add_pmu(struct parse_events_state *parse_state,
165 struct list_head *list, char *name,
166 struct list_head *head_config);
168 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
170 struct list_head **listp);
172 int parse_events_copy_term_list(struct list_head *old,
173 struct list_head **new);
175 enum perf_pmu_event_symbol_type
176 perf_pmu__parse_check(const char *name);
177 void parse_events__set_leader(char *name, struct list_head *list);
178 void parse_events_update_lists(struct list_head *list_event,
179 struct list_head *list_all);
180 void parse_events_evlist_error(struct parse_events_state *parse_state,
181 int idx, const char *str);
183 void print_events(const char *event_glob, bool name_only, bool quiet,
184 bool long_desc, bool details_flag);
186 struct event_symbol {
190 extern struct event_symbol event_symbols_hw[];
191 extern struct event_symbol event_symbols_sw[];
192 void print_symbol_events(const char *event_glob, unsigned type,
193 struct event_symbol *syms, unsigned max,
195 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
197 int print_hwcache_events(const char *event_glob, bool name_only);
198 void print_sdt_events(const char *subsys_glob, const char *event_glob,
200 int is_valid_tracepoint(const char *event_string);
202 int valid_event_mount(const char *eventfs);
203 char *parse_events_formats_error_string(char *additional_terms);
205 void parse_events_print_error(struct parse_events_error *err,
208 #ifdef HAVE_LIBELF_SUPPORT
210 * If the probe point starts with '%',
211 * or starts with "sdt_" and has a ':' but no '=',
212 * then it should be a SDT/cached probe point.
214 static inline bool is_sdt_event(char *str)
216 return (str[0] == '%' ||
217 (!strncmp(str, "sdt_", 4) &&
218 !!strchr(str, ':') && !strchr(str, '=')));
221 static inline bool is_sdt_event(char *str __maybe_unused)
225 #endif /* HAVE_LIBELF_SUPPORT */
227 #endif /* __PERF_PARSE_EVENTS_H */