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, bool fake_pmu, 35 bool warn_if_reordered, bool fake_tp); 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=*/false, 42 /*warn_if_reordered=*/true, /*fake_tp=*/false); 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_ACTION, 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_HARDWARE, 83 #define __PARSE_EVENTS__TERM_TYPE_NR (PARSE_EVENTS__TERM_TYPE_HARDWARE + 1) 84 }; 85 86 struct parse_events_term { 87 /** @list: The term list the term is a part of. */ 88 struct list_head list; 89 /** 90 * @config: The left-hand side of a term assignment, so the term 91 * "event=8" would have the config be "event" 92 */ 93 const char *config; 94 /** 95 * @val: The right-hand side of a term assignment that can either be a 96 * string or a number depending on type_val. 97 */ 98 union { 99 char *str; 100 u64 num; 101 } val; 102 /** @type_val: The union variable in val to be used for the term. */ 103 enum parse_events__term_val_type type_val; 104 /** 105 * @type_term: A predefined term type or PARSE_EVENTS__TERM_TYPE_USER 106 * when not inbuilt. 107 */ 108 enum parse_events__term_type type_term; 109 /** 110 * @err_term: The column index of the term from parsing, used during 111 * error output. 112 */ 113 int err_term; 114 /** 115 * @err_val: The column index of the val from parsing, used during error 116 * output. 117 */ 118 int err_val; 119 /** @used: Was the term used during parameterized-eval. */ 120 bool used; 121 /** 122 * @weak: A term from the sysfs or json encoding of an event that 123 * shouldn't override terms coming from the command line. 124 */ 125 bool weak; 126 /** 127 * @no_value: Is there no value. If a numeric term has no value then the 128 * value is assumed to be 1. An event name also has no value. 129 */ 130 bool no_value; 131 /** 132 * @alternate_hw_config: config is the event name but num is an 133 * alternate PERF_TYPE_HARDWARE config value which is often nice for the 134 * sake of quick matching. 135 */ 136 bool alternate_hw_config; 137 }; 138 139 struct parse_events_error { 140 /** @list: The head of a list of errors. */ 141 struct list_head list; 142 }; 143 144 /* A wrapper around a list of terms for the sake of better type safety. */ 145 struct parse_events_terms { 146 struct list_head terms; 147 }; 148 149 struct parse_events_state { 150 /* The list parsed events are placed on. */ 151 struct list_head list; 152 /* The updated index used by entries as they are added. */ 153 int idx; 154 /* Error information. */ 155 struct parse_events_error *error; 156 /* Holds returned terms for term parsing. */ 157 struct parse_events_terms *terms; 158 /* Start token. */ 159 int stoken; 160 /* Use the fake PMU marker for testing. */ 161 bool fake_pmu; 162 /* Skip actual tracepoint processing for testing. */ 163 bool fake_tp; 164 /* If non-null, when wildcard matching only match the given PMU. */ 165 const char *pmu_filter; 166 /* Should PE_LEGACY_NAME tokens be generated for config terms? */ 167 bool match_legacy_cache_terms; 168 /* Were multiple PMUs scanned to find events? */ 169 bool wild_card_pmus; 170 }; 171 172 const char *parse_events__term_type_str(enum parse_events__term_type term_type); 173 174 bool parse_events__filter_pmu(const struct parse_events_state *parse_state, 175 const struct perf_pmu *pmu); 176 void parse_events__shrink_config_terms(void); 177 int parse_events__is_hardcoded_term(struct parse_events_term *term); 178 int parse_events_term__num(struct parse_events_term **term, 179 enum parse_events__term_type type_term, 180 const char *config, u64 num, 181 bool novalue, 182 void *loc_term, void *loc_val); 183 int parse_events_term__str(struct parse_events_term **term, 184 enum parse_events__term_type type_term, 185 char *config, char *str, 186 void *loc_term, void *loc_val); 187 int parse_events_term__term(struct parse_events_term **term, 188 enum parse_events__term_type term_lhs, 189 enum parse_events__term_type term_rhs, 190 void *loc_term, void *loc_val); 191 int parse_events_term__clone(struct parse_events_term **new, 192 const struct parse_events_term *term); 193 void parse_events_term__delete(struct parse_events_term *term); 194 195 void parse_events_terms__delete(struct parse_events_terms *terms); 196 void parse_events_terms__init(struct parse_events_terms *terms); 197 void parse_events_terms__exit(struct parse_events_terms *terms); 198 int parse_events_terms(struct parse_events_terms *terms, const char *str, FILE *input); 199 int parse_events_terms__to_strbuf(const struct parse_events_terms *terms, struct strbuf *sb); 200 201 struct parse_events_modifier { 202 u8 precise; /* Number of repeated 'p' for precision. */ 203 bool precise_max : 1; /* 'P' */ 204 bool non_idle : 1; /* 'I' */ 205 bool sample_read : 1; /* 'S' */ 206 bool pinned : 1; /* 'D' */ 207 bool exclusive : 1; /* 'e' */ 208 bool weak : 1; /* 'W' */ 209 bool bpf : 1; /* 'b' */ 210 bool user : 1; /* 'u' */ 211 bool kernel : 1; /* 'k' */ 212 bool hypervisor : 1; /* 'h' */ 213 bool guest : 1; /* 'G' */ 214 bool host : 1; /* 'H' */ 215 bool retire_lat : 1; /* 'R' */ 216 }; 217 218 int parse_events__modifier_event(struct parse_events_state *parse_state, void *loc, 219 struct list_head *list, struct parse_events_modifier mod); 220 int parse_events__modifier_group(struct parse_events_state *parse_state, void *loc, 221 struct list_head *list, struct parse_events_modifier mod); 222 int parse_events__set_default_name(struct list_head *list, char *name); 223 int parse_events_add_tracepoint(struct parse_events_state *parse_state, 224 struct list_head *list, 225 const char *sys, const char *event, 226 struct parse_events_error *error, 227 struct parse_events_terms *head_config, void *loc); 228 int parse_events_add_numeric(struct parse_events_state *parse_state, 229 struct list_head *list, 230 u32 type, u64 config, 231 const struct parse_events_terms *head_config, 232 bool wildcard); 233 int parse_events_add_cache(struct list_head *list, int *idx, const char *name, 234 struct parse_events_state *parse_state, 235 struct parse_events_terms *parsed_terms); 236 int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config); 237 int parse_events_add_breakpoint(struct parse_events_state *parse_state, 238 struct list_head *list, 239 u64 addr, char *type, u64 len, 240 struct parse_events_terms *head_config); 241 242 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr, 243 const char *name, const char *metric_id, 244 struct perf_pmu *pmu); 245 246 int parse_events_multi_pmu_add(struct parse_events_state *parse_state, 247 const char *event_name, u64 hw_config, 248 const struct parse_events_terms *const_parsed_terms, 249 struct list_head **listp, void *loc); 250 251 int parse_events_multi_pmu_add_or_add_pmu(struct parse_events_state *parse_state, 252 const char *event_or_pmu, 253 const struct parse_events_terms *const_parsed_terms, 254 struct list_head **listp, 255 void *loc_); 256 257 void parse_events__set_leader(char *name, struct list_head *list); 258 259 struct event_symbol { 260 const char *symbol; 261 const char *alias; 262 }; 263 extern const struct event_symbol event_symbols_hw[]; 264 extern const struct event_symbol event_symbols_sw[]; 265 266 char *parse_events_formats_error_string(char *additional_terms); 267 268 void parse_events_error__init(struct parse_events_error *err); 269 void parse_events_error__exit(struct parse_events_error *err); 270 void parse_events_error__handle(struct parse_events_error *err, int idx, 271 char *str, char *help); 272 void parse_events_error__print(const struct parse_events_error *err, 273 const char *event); 274 bool parse_events_error__contains(const struct parse_events_error *err, 275 const char *needle); 276 #ifdef HAVE_LIBELF_SUPPORT 277 /* 278 * If the probe point starts with '%', 279 * or starts with "sdt_" and has a ':' but no '=', 280 * then it should be a SDT/cached probe point. 281 */ 282 static inline bool is_sdt_event(char *str) 283 { 284 return (str[0] == '%' || 285 (!strncmp(str, "sdt_", 4) && 286 !!strchr(str, ':') && !strchr(str, '='))); 287 } 288 #else 289 static inline bool is_sdt_event(char *str __maybe_unused) 290 { 291 return false; 292 } 293 #endif /* HAVE_LIBELF_SUPPORT */ 294 295 size_t default_breakpoint_len(void); 296 297 #endif /* __PERF_PARSE_EVENTS_H */ 298