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 #include <sys/types.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(size_t 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 parse_uid_filter(struct evlist *evlist, uid_t uid); 49 int exclude_perf(const struct option *opt, const char *arg, int unset); 50 51 enum parse_events__term_val_type { 52 PARSE_EVENTS__TERM_TYPE_NUM, 53 PARSE_EVENTS__TERM_TYPE_STR, 54 }; 55 56 enum parse_events__term_type { 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_CONFIG4, 63 PARSE_EVENTS__TERM_TYPE_NAME, 64 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD, 65 PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ, 66 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE, 67 PARSE_EVENTS__TERM_TYPE_TIME, 68 PARSE_EVENTS__TERM_TYPE_CALLGRAPH, 69 PARSE_EVENTS__TERM_TYPE_STACKSIZE, 70 PARSE_EVENTS__TERM_TYPE_NOINHERIT, 71 PARSE_EVENTS__TERM_TYPE_INHERIT, 72 PARSE_EVENTS__TERM_TYPE_MAX_STACK, 73 PARSE_EVENTS__TERM_TYPE_MAX_EVENTS, 74 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE, 75 PARSE_EVENTS__TERM_TYPE_OVERWRITE, 76 PARSE_EVENTS__TERM_TYPE_DRV_CFG, 77 PARSE_EVENTS__TERM_TYPE_PERCORE, 78 PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT, 79 PARSE_EVENTS__TERM_TYPE_AUX_ACTION, 80 PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE, 81 PARSE_EVENTS__TERM_TYPE_METRIC_ID, 82 PARSE_EVENTS__TERM_TYPE_RAW, 83 PARSE_EVENTS__TERM_TYPE_CPU, 84 PARSE_EVENTS__TERM_TYPE_RATIO_TO_PREV, 85 PARSE_EVENTS__TERM_TYPE_LEGACY_HARDWARE_CONFIG, 86 PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE_CONFIG, 87 #define __PARSE_EVENTS__TERM_TYPE_NR (PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE_CONFIG + 1) 88 }; 89 90 struct parse_events_term { 91 /** @list: The term list the term is a part of. */ 92 struct list_head list; 93 /** 94 * @config: The left-hand side of a term assignment, so the term 95 * "event=8" would have the config be "event" 96 */ 97 const char *config; 98 /** 99 * @val: The right-hand side of a term assignment that can either be a 100 * string or a number depending on type_val. 101 */ 102 union { 103 char *str; 104 u64 num; 105 } val; 106 /** @type_val: The union variable in val to be used for the term. */ 107 enum parse_events__term_val_type type_val; 108 /** 109 * @type_term: A predefined term type or PARSE_EVENTS__TERM_TYPE_USER 110 * when not inbuilt. 111 */ 112 enum parse_events__term_type type_term; 113 /** 114 * @err_term: The column index of the term from parsing, used during 115 * error output. 116 */ 117 int err_term; 118 /** 119 * @err_val: The column index of the val from parsing, used during error 120 * output. 121 */ 122 int err_val; 123 /** @used: Was the term used during parameterized-eval. */ 124 bool used; 125 /** 126 * @weak: A term from the sysfs or json encoding of an event that 127 * shouldn't override terms coming from the command line. 128 */ 129 bool weak; 130 /** 131 * @no_value: Is there no value. If a numeric term has no value then the 132 * value is assumed to be 1. An event name also has no value. 133 */ 134 bool no_value; 135 }; 136 137 struct parse_events_error { 138 /** @list: The head of a list of errors. */ 139 struct list_head list; 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 /* Use the fake PMU marker for testing. */ 159 bool fake_pmu; 160 /* Skip actual tracepoint processing for testing. */ 161 bool fake_tp; 162 /* If non-null, when wildcard matching only match the given PMU. */ 163 const char *pmu_filter; 164 /* Should PE_LEGACY_NAME tokens be generated for config terms? */ 165 bool match_legacy_cache_terms; 166 /* Were multiple PMUs scanned to find events? */ 167 bool wild_card_pmus; 168 }; 169 170 const char *parse_events__term_type_str(enum parse_events__term_type term_type); 171 172 bool parse_events__filter_pmu(const struct parse_events_state *parse_state, 173 const struct perf_pmu *pmu); 174 void parse_events__shrink_config_terms(void); 175 int parse_events__is_hardcoded_term(struct parse_events_term *term); 176 int parse_events_term__num(struct parse_events_term **term, 177 enum parse_events__term_type type_term, 178 const char *config, u64 num, 179 bool novalue, 180 void *loc_term, void *loc_val); 181 int parse_events_term__str(struct parse_events_term **term, 182 enum parse_events__term_type type_term, 183 char *config, char *str, 184 void *loc_term, void *loc_val); 185 int parse_events_term__term(struct parse_events_term **term, 186 enum parse_events__term_type term_lhs, 187 enum parse_events__term_type term_rhs, 188 void *loc_term, void *loc_val); 189 int parse_events_term__clone(struct parse_events_term **new, 190 const struct parse_events_term *term); 191 void parse_events_term__delete(struct parse_events_term *term); 192 193 void parse_events_terms__delete(struct parse_events_terms *terms); 194 void parse_events_terms__init(struct parse_events_terms *terms); 195 void parse_events_terms__exit(struct parse_events_terms *terms); 196 int parse_events_terms(struct parse_events_terms *terms, const char *str); 197 198 struct parse_events_modifier { 199 u8 precise; /* Number of repeated 'p' for precision. */ 200 bool precise_max : 1; /* 'P' */ 201 bool non_idle : 1; /* 'I' */ 202 bool sample_read : 1; /* 'S' */ 203 bool pinned : 1; /* 'D' */ 204 bool exclusive : 1; /* 'e' */ 205 bool weak : 1; /* 'W' */ 206 bool bpf : 1; /* 'b' */ 207 bool user : 1; /* 'u' */ 208 bool kernel : 1; /* 'k' */ 209 bool hypervisor : 1; /* 'h' */ 210 bool guest : 1; /* 'G' */ 211 bool host : 1; /* 'H' */ 212 bool retire_lat : 1; /* 'R' */ 213 bool dont_regroup : 1; /* 'X' */ 214 }; 215 216 int parse_events__modifier_event(struct parse_events_state *parse_state, void *loc, 217 struct list_head *list, struct parse_events_modifier mod); 218 int parse_events__modifier_group(struct parse_events_state *parse_state, void *loc, 219 struct list_head *list, struct parse_events_modifier mod); 220 int parse_events__set_default_name(struct list_head *list, char *name); 221 int parse_events_add_tracepoint(struct parse_events_state *parse_state, 222 struct list_head *list, 223 const char *sys, const char *event, 224 struct parse_events_error *error, 225 struct parse_events_terms *head_config, void *loc); 226 int parse_events_add_numeric(struct parse_events_state *parse_state, 227 struct list_head *list, 228 u32 type, u64 config, 229 const struct parse_events_terms *head_config, 230 bool wildcard); 231 int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config); 232 int parse_events_add_breakpoint(struct parse_events_state *parse_state, 233 struct list_head *list, 234 u64 addr, char *type, u64 len, 235 struct parse_events_terms *head_config); 236 237 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr, 238 const char *name, const char *metric_id, 239 struct perf_pmu *pmu); 240 241 int parse_events_multi_pmu_add(struct parse_events_state *parse_state, 242 const char *event_name, 243 const struct parse_events_terms *const_parsed_terms, 244 struct list_head **listp, void *loc); 245 246 int parse_events_multi_pmu_add_or_add_pmu(struct parse_events_state *parse_state, 247 const char *event_or_pmu, 248 const struct parse_events_terms *const_parsed_terms, 249 struct list_head **listp, 250 void *loc_); 251 252 void parse_events__set_leader(char *name, struct list_head *list); 253 254 struct event_symbol { 255 const char *symbol; 256 const char *alias; 257 }; 258 259 char *parse_events_formats_error_string(char *additional_terms); 260 261 void parse_events_error__init(struct parse_events_error *err); 262 void parse_events_error__exit(struct parse_events_error *err); 263 void parse_events_error__handle(struct parse_events_error *err, int idx, 264 char *str, char *help); 265 void parse_events_error__print(const struct parse_events_error *err, 266 const char *event); 267 bool parse_events_error__contains(const struct parse_events_error *err, 268 const char *needle); 269 #ifdef HAVE_LIBELF_SUPPORT 270 /* 271 * If the probe point starts with '%', 272 * or starts with "sdt_" and has a ':' but no '=', 273 * then it should be a SDT/cached probe point. 274 */ 275 static inline bool is_sdt_event(char *str) 276 { 277 return (str[0] == '%' || 278 (!strncmp(str, "sdt_", 4) && 279 !!strchr(str, ':') && !strchr(str, '='))); 280 } 281 #else 282 static inline bool is_sdt_event(char *str __maybe_unused) 283 { 284 return false; 285 } 286 #endif /* HAVE_LIBELF_SUPPORT */ 287 288 size_t default_breakpoint_len(void); 289 290 #endif /* __PERF_PARSE_EVENTS_H */ 291