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