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