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 <stdio.h> 13 #include <string.h> 14 15 struct evsel; 16 struct evlist; 17 struct parse_events_error; 18 19 struct option; 20 struct perf_pmu; 21 struct strbuf; 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_filter(const struct option *opt, const char *str, int unset); 48 int exclude_perf(const struct option *opt, const char *arg, int unset); 49 50 enum parse_events__term_val_type { 51 PARSE_EVENTS__TERM_TYPE_NUM, 52 PARSE_EVENTS__TERM_TYPE_STR, 53 }; 54 55 enum parse_events__term_type { 56 PARSE_EVENTS__TERM_TYPE_USER, 57 PARSE_EVENTS__TERM_TYPE_CONFIG, 58 PARSE_EVENTS__TERM_TYPE_CONFIG1, 59 PARSE_EVENTS__TERM_TYPE_CONFIG2, 60 PARSE_EVENTS__TERM_TYPE_CONFIG3, 61 PARSE_EVENTS__TERM_TYPE_NAME, 62 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD, 63 PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ, 64 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE, 65 PARSE_EVENTS__TERM_TYPE_TIME, 66 PARSE_EVENTS__TERM_TYPE_CALLGRAPH, 67 PARSE_EVENTS__TERM_TYPE_STACKSIZE, 68 PARSE_EVENTS__TERM_TYPE_NOINHERIT, 69 PARSE_EVENTS__TERM_TYPE_INHERIT, 70 PARSE_EVENTS__TERM_TYPE_MAX_STACK, 71 PARSE_EVENTS__TERM_TYPE_MAX_EVENTS, 72 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE, 73 PARSE_EVENTS__TERM_TYPE_OVERWRITE, 74 PARSE_EVENTS__TERM_TYPE_DRV_CFG, 75 PARSE_EVENTS__TERM_TYPE_PERCORE, 76 PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT, 77 PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE, 78 PARSE_EVENTS__TERM_TYPE_METRIC_ID, 79 PARSE_EVENTS__TERM_TYPE_RAW, 80 PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE, 81 PARSE_EVENTS__TERM_TYPE_HARDWARE, 82 #define __PARSE_EVENTS__TERM_TYPE_NR (PARSE_EVENTS__TERM_TYPE_HARDWARE + 1) 83 }; 84 85 struct parse_events_term { 86 /** @list: The term list the term is a part of. */ 87 struct list_head list; 88 /** 89 * @config: The left-hand side of a term assignment, so the term 90 * "event=8" would have the config be "event" 91 */ 92 const char *config; 93 /** 94 * @val: The right-hand side of a term assignment that can either be a 95 * string or a number depending on type_val. 96 */ 97 union { 98 char *str; 99 u64 num; 100 } val; 101 /** @type_val: The union variable in val to be used for the term. */ 102 enum parse_events__term_val_type type_val; 103 /** 104 * @type_term: A predefined term type or PARSE_EVENTS__TERM_TYPE_USER 105 * when not inbuilt. 106 */ 107 enum parse_events__term_type type_term; 108 /** 109 * @err_term: The column index of the term from parsing, used during 110 * error output. 111 */ 112 int err_term; 113 /** 114 * @err_val: The column index of the val from parsing, used during error 115 * output. 116 */ 117 int err_val; 118 /** @used: Was the term used during parameterized-eval. */ 119 bool used; 120 /** 121 * @weak: A term from the sysfs or json encoding of an event that 122 * shouldn't override terms coming from the command line. 123 */ 124 bool weak; 125 /** 126 * @no_value: Is there no value. If a numeric term has no value then the 127 * value is assumed to be 1. An event name also has no value. 128 */ 129 bool no_value; 130 }; 131 132 struct parse_events_error { 133 int num_errors; /* number of errors encountered */ 134 int idx; /* index in the parsed string */ 135 char *str; /* string to display at the index */ 136 char *help; /* optional help string */ 137 int first_idx;/* as above, but for the first encountered error */ 138 char *first_str; 139 char *first_help; 140 }; 141 142 /* A wrapper around a list of terms for the sake of better type safety. */ 143 struct parse_events_terms { 144 struct list_head terms; 145 }; 146 147 struct parse_events_state { 148 /* The list parsed events are placed on. */ 149 struct list_head list; 150 /* The updated index used by entries as they are added. */ 151 int idx; 152 /* Error information. */ 153 struct parse_events_error *error; 154 /* Holds returned terms for term parsing. */ 155 struct parse_events_terms *terms; 156 /* Start token. */ 157 int stoken; 158 /* Special fake PMU marker for testing. */ 159 struct perf_pmu *fake_pmu; 160 /* If non-null, when wildcard matching only match the given PMU. */ 161 const char *pmu_filter; 162 /* Should PE_LEGACY_NAME tokens be generated for config terms? */ 163 bool match_legacy_cache_terms; 164 /* Were multiple PMUs scanned to find events? */ 165 bool wild_card_pmus; 166 }; 167 168 bool parse_events__filter_pmu(const struct parse_events_state *parse_state, 169 const struct perf_pmu *pmu); 170 void parse_events__shrink_config_terms(void); 171 int parse_events__is_hardcoded_term(struct parse_events_term *term); 172 int parse_events_term__num(struct parse_events_term **term, 173 enum parse_events__term_type type_term, 174 const char *config, u64 num, 175 bool novalue, 176 void *loc_term, void *loc_val); 177 int parse_events_term__str(struct parse_events_term **term, 178 enum parse_events__term_type type_term, 179 char *config, char *str, 180 void *loc_term, void *loc_val); 181 int parse_events_term__term(struct parse_events_term **term, 182 enum parse_events__term_type term_lhs, 183 enum parse_events__term_type term_rhs, 184 void *loc_term, void *loc_val); 185 int parse_events_term__clone(struct parse_events_term **new, 186 struct parse_events_term *term); 187 void parse_events_term__delete(struct parse_events_term *term); 188 189 void parse_events_terms__delete(struct parse_events_terms *terms); 190 void parse_events_terms__init(struct parse_events_terms *terms); 191 void parse_events_terms__exit(struct parse_events_terms *terms); 192 int parse_events_terms(struct parse_events_terms *terms, const char *str, FILE *input); 193 int parse_events_terms__to_strbuf(const struct parse_events_terms *terms, struct strbuf *sb); 194 int parse_events__modifier_event(struct list_head *list, char *str, bool add); 195 int parse_events__modifier_group(struct list_head *list, char *event_mod); 196 int parse_events_name(struct list_head *list, const char *name); 197 int parse_events_add_tracepoint(struct list_head *list, int *idx, 198 const char *sys, const char *event, 199 struct parse_events_error *error, 200 struct parse_events_terms *head_config, void *loc); 201 int parse_events_add_numeric(struct parse_events_state *parse_state, 202 struct list_head *list, 203 u32 type, u64 config, 204 struct parse_events_terms *head_config, 205 bool wildcard); 206 int parse_events_add_tool(struct parse_events_state *parse_state, 207 struct list_head *list, 208 int tool_event); 209 int parse_events_add_cache(struct list_head *list, int *idx, const char *name, 210 struct parse_events_state *parse_state, 211 struct parse_events_terms *head_config); 212 int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config); 213 int parse_events_add_breakpoint(struct parse_events_state *parse_state, 214 struct list_head *list, 215 u64 addr, char *type, u64 len, 216 struct parse_events_terms *head_config); 217 int parse_events_add_pmu(struct parse_events_state *parse_state, 218 struct list_head *list, const char *name, 219 const struct parse_events_terms *const_parsed_terms, 220 bool auto_merge_stats, void *loc); 221 222 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr, 223 const char *name, const char *metric_id, 224 struct perf_pmu *pmu); 225 226 int parse_events_multi_pmu_add(struct parse_events_state *parse_state, 227 const char *event_name, 228 const struct parse_events_terms *const_parsed_terms, 229 struct list_head **listp, void *loc); 230 231 void parse_events__set_leader(char *name, struct list_head *list); 232 void parse_events_update_lists(struct list_head *list_event, 233 struct list_head *list_all); 234 void parse_events_evlist_error(struct parse_events_state *parse_state, 235 int idx, const char *str); 236 237 struct event_symbol { 238 const char *symbol; 239 const char *alias; 240 }; 241 extern struct event_symbol event_symbols_hw[]; 242 extern struct event_symbol event_symbols_sw[]; 243 244 char *parse_events_formats_error_string(char *additional_terms); 245 246 void parse_events_error__init(struct parse_events_error *err); 247 void parse_events_error__exit(struct parse_events_error *err); 248 void parse_events_error__handle(struct parse_events_error *err, int idx, 249 char *str, char *help); 250 void parse_events_error__print(struct parse_events_error *err, 251 const char *event); 252 253 #ifdef HAVE_LIBELF_SUPPORT 254 /* 255 * If the probe point starts with '%', 256 * or starts with "sdt_" and has a ':' but no '=', 257 * then it should be a SDT/cached probe point. 258 */ 259 static inline bool is_sdt_event(char *str) 260 { 261 return (str[0] == '%' || 262 (!strncmp(str, "sdt_", 4) && 263 !!strchr(str, ':') && !strchr(str, '='))); 264 } 265 #else 266 static inline bool is_sdt_event(char *str __maybe_unused) 267 { 268 return false; 269 } 270 #endif /* HAVE_LIBELF_SUPPORT */ 271 272 #endif /* __PERF_PARSE_EVENTS_H */ 273