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 is_event_supported(u8 type, u64 config); 22 23 const char *event_type(int type); 24 25 /* Arguments encoded in opt->value. */ 26 struct parse_events_option_args { 27 struct evlist **evlistp; 28 const char *pmu_filter; 29 }; 30 int parse_events_option(const struct option *opt, const char *str, int unset); 31 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset); 32 __attribute__((nonnull(1, 2, 4))) 33 int __parse_events(struct evlist *evlist, const char *str, const char *pmu_filter, 34 struct parse_events_error *error, struct perf_pmu *fake_pmu, 35 bool warn_if_reordered); 36 37 __attribute__((nonnull(1, 2, 3))) 38 static inline int parse_events(struct evlist *evlist, const char *str, 39 struct parse_events_error *err) 40 { 41 return __parse_events(evlist, str, /*pmu_filter=*/NULL, err, /*fake_pmu=*/NULL, 42 /*warn_if_reordered=*/true); 43 } 44 45 int parse_event(struct evlist *evlist, const char *str); 46 47 int parse_events_terms(struct list_head *terms, const char *str); 48 int parse_filter(const struct option *opt, const char *str, int unset); 49 int exclude_perf(const struct option *opt, const char *arg, int unset); 50 51 enum { 52 PARSE_EVENTS__TERM_TYPE_NUM, 53 PARSE_EVENTS__TERM_TYPE_STR, 54 }; 55 56 enum { 57 PARSE_EVENTS__TERM_TYPE_USER, 58 PARSE_EVENTS__TERM_TYPE_CONFIG, 59 PARSE_EVENTS__TERM_TYPE_CONFIG1, 60 PARSE_EVENTS__TERM_TYPE_CONFIG2, 61 PARSE_EVENTS__TERM_TYPE_CONFIG3, 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_MAX_EVENTS, 73 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE, 74 PARSE_EVENTS__TERM_TYPE_OVERWRITE, 75 PARSE_EVENTS__TERM_TYPE_DRV_CFG, 76 PARSE_EVENTS__TERM_TYPE_PERCORE, 77 PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT, 78 PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE, 79 PARSE_EVENTS__TERM_TYPE_METRIC_ID, 80 PARSE_EVENTS__TERM_TYPE_RAW, 81 PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE, 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 struct parse_events_error *error; 128 struct evlist *evlist; 129 struct list_head *terms; 130 int stoken; 131 struct perf_pmu *fake_pmu; 132 /* If non-null, when wildcard matching only match the given PMU. */ 133 const char *pmu_filter; 134 /* Should PE_LEGACY_NAME tokens be generated for config terms? */ 135 bool match_legacy_cache_terms; 136 bool wild_card_pmus; 137 }; 138 139 bool parse_events__filter_pmu(const struct parse_events_state *parse_state, 140 const struct perf_pmu *pmu); 141 void parse_events__shrink_config_terms(void); 142 int parse_events__is_hardcoded_term(struct parse_events_term *term); 143 int parse_events_term__num(struct parse_events_term **term, 144 int type_term, char *config, u64 num, 145 bool novalue, 146 void *loc_term, void *loc_val); 147 int parse_events_term__str(struct parse_events_term **term, 148 int type_term, char *config, char *str, 149 void *loc_term, void *loc_val); 150 int parse_events_term__sym_hw(struct parse_events_term **term, 151 char *config, unsigned idx); 152 int parse_events_term__clone(struct parse_events_term **new, 153 struct parse_events_term *term); 154 void parse_events_term__delete(struct parse_events_term *term); 155 void parse_events_terms__delete(struct list_head *terms); 156 void parse_events_terms__purge(struct list_head *terms); 157 void parse_events__clear_array(struct parse_events_array *a); 158 int parse_events__modifier_event(struct list_head *list, char *str, bool add); 159 int parse_events__modifier_group(struct list_head *list, char *event_mod); 160 int parse_events_name(struct list_head *list, const char *name); 161 int parse_events_add_tracepoint(struct list_head *list, int *idx, 162 const char *sys, const char *event, 163 struct parse_events_error *error, 164 struct list_head *head_config); 165 int parse_events_load_bpf(struct parse_events_state *parse_state, 166 struct list_head *list, 167 char *bpf_file_name, 168 bool source, 169 struct list_head *head_config); 170 /* Provide this function for perf test */ 171 struct bpf_object; 172 int parse_events_load_bpf_obj(struct parse_events_state *parse_state, 173 struct list_head *list, 174 struct bpf_object *obj, 175 struct list_head *head_config); 176 int parse_events_add_numeric(struct parse_events_state *parse_state, 177 struct list_head *list, 178 u32 type, u64 config, 179 struct list_head *head_config, 180 bool wildcard); 181 int parse_events_add_tool(struct parse_events_state *parse_state, 182 struct list_head *list, 183 int tool_event); 184 int parse_events_add_cache(struct list_head *list, int *idx, const char *name, 185 struct parse_events_state *parse_state, 186 struct list_head *head_config); 187 int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config); 188 int parse_events_add_breakpoint(struct list_head *list, int *idx, 189 u64 addr, char *type, u64 len); 190 int parse_events_add_pmu(struct parse_events_state *parse_state, 191 struct list_head *list, char *name, 192 struct list_head *head_config, 193 bool auto_merge_stats); 194 195 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr, 196 const char *name, const char *metric_id, 197 struct perf_pmu *pmu); 198 199 int parse_events_multi_pmu_add(struct parse_events_state *parse_state, 200 char *str, 201 struct list_head *head_config, 202 struct list_head **listp); 203 204 int parse_events_copy_term_list(struct list_head *old, 205 struct list_head **new); 206 207 void parse_events__set_leader(char *name, struct list_head *list); 208 void parse_events_update_lists(struct list_head *list_event, 209 struct list_head *list_all); 210 void parse_events_evlist_error(struct parse_events_state *parse_state, 211 int idx, const char *str); 212 213 struct event_symbol { 214 const char *symbol; 215 const char *alias; 216 }; 217 extern struct event_symbol event_symbols_hw[]; 218 extern struct event_symbol event_symbols_sw[]; 219 220 char *parse_events_formats_error_string(char *additional_terms); 221 222 void parse_events_error__init(struct parse_events_error *err); 223 void parse_events_error__exit(struct parse_events_error *err); 224 void parse_events_error__handle(struct parse_events_error *err, int idx, 225 char *str, char *help); 226 void parse_events_error__print(struct parse_events_error *err, 227 const char *event); 228 229 #ifdef HAVE_LIBELF_SUPPORT 230 /* 231 * If the probe point starts with '%', 232 * or starts with "sdt_" and has a ':' but no '=', 233 * then it should be a SDT/cached probe point. 234 */ 235 static inline bool is_sdt_event(char *str) 236 { 237 return (str[0] == '%' || 238 (!strncmp(str, "sdt_", 4) && 239 !!strchr(str, ':') && !strchr(str, '='))); 240 } 241 #else 242 static inline bool is_sdt_event(char *str __maybe_unused) 243 { 244 return false; 245 } 246 #endif /* HAVE_LIBELF_SUPPORT */ 247 248 #endif /* __PERF_PARSE_EVENTS_H */ 249