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 bool cputype_filter; 30 }; 31 int parse_events_option(const struct option *opt, const char *str, int unset); 32 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset); 33 __attribute__((nonnull(1, 2, 5))) int 34 __parse_events(struct evlist *evlist, const char *str, const char *pmu_filter, 35 bool cputype_filter, struct parse_events_error *error, 36 bool fake_pmu, bool warn_if_reordered, bool fake_tp); 37 38 __attribute__((nonnull(1, 2, 3))) 39 static inline int parse_events(struct evlist *evlist, const char *str, 40 struct parse_events_error *err) 41 { 42 return __parse_events(evlist, str, /*pmu_filter=*/NULL, 43 /*cputype_filter=*/false, err, /*fake_pmu=*/false, 44 /*warn_if_reordered=*/true, 45 /*fake_tp=*/false); 46 } 47 48 int parse_event(struct evlist *evlist, const char *str); 49 50 int parse_filter(const struct option *opt, const char *str, int unset); 51 int parse_uid_filter(struct evlist *evlist, uid_t uid); 52 int exclude_perf(const struct option *opt, const char *arg, int unset); 53 54 enum parse_events__term_val_type { 55 PARSE_EVENTS__TERM_TYPE_NUM, 56 PARSE_EVENTS__TERM_TYPE_STR, 57 }; 58 59 enum parse_events__term_type { 60 PARSE_EVENTS__TERM_TYPE_USER, 61 PARSE_EVENTS__TERM_TYPE_CONFIG, 62 PARSE_EVENTS__TERM_TYPE_CONFIG1, 63 PARSE_EVENTS__TERM_TYPE_CONFIG2, 64 PARSE_EVENTS__TERM_TYPE_CONFIG3, 65 PARSE_EVENTS__TERM_TYPE_CONFIG4, 66 PARSE_EVENTS__TERM_TYPE_NAME, 67 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD, 68 PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ, 69 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE, 70 PARSE_EVENTS__TERM_TYPE_TIME, 71 PARSE_EVENTS__TERM_TYPE_CALLGRAPH, 72 PARSE_EVENTS__TERM_TYPE_STACKSIZE, 73 PARSE_EVENTS__TERM_TYPE_NOINHERIT, 74 PARSE_EVENTS__TERM_TYPE_INHERIT, 75 PARSE_EVENTS__TERM_TYPE_MAX_STACK, 76 PARSE_EVENTS__TERM_TYPE_MAX_EVENTS, 77 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE, 78 PARSE_EVENTS__TERM_TYPE_OVERWRITE, 79 PARSE_EVENTS__TERM_TYPE_DRV_CFG, 80 PARSE_EVENTS__TERM_TYPE_PERCORE, 81 PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT, 82 PARSE_EVENTS__TERM_TYPE_AUX_ACTION, 83 PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE, 84 PARSE_EVENTS__TERM_TYPE_METRIC_ID, 85 PARSE_EVENTS__TERM_TYPE_RAW, 86 PARSE_EVENTS__TERM_TYPE_CPU, 87 PARSE_EVENTS__TERM_TYPE_RATIO_TO_PREV, 88 PARSE_EVENTS__TERM_TYPE_LEGACY_HARDWARE_CONFIG, 89 PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE_CONFIG, 90 #define __PARSE_EVENTS__TERM_TYPE_NR (PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE_CONFIG + 1) 91 }; 92 93 struct parse_events_term { 94 /** @list: The term list the term is a part of. */ 95 struct list_head list; 96 /** 97 * @config: The left-hand side of a term assignment, so the term 98 * "event=8" would have the config be "event" 99 */ 100 const char *config; 101 /** 102 * @val: The right-hand side of a term assignment that can either be a 103 * string or a number depending on type_val. 104 */ 105 union { 106 char *str; 107 u64 num; 108 } val; 109 /** @type_val: The union variable in val to be used for the term. */ 110 enum parse_events__term_val_type type_val; 111 /** 112 * @type_term: A predefined term type or PARSE_EVENTS__TERM_TYPE_USER 113 * when not inbuilt. 114 */ 115 enum parse_events__term_type type_term; 116 /** 117 * @err_term: The column index of the term from parsing, used during 118 * error output. 119 */ 120 int err_term; 121 /** 122 * @err_val: The column index of the val from parsing, used during error 123 * output. 124 */ 125 int err_val; 126 /** @used: Was the term used during parameterized-eval. */ 127 bool used; 128 /** 129 * @weak: A term from the sysfs or json encoding of an event that 130 * shouldn't override terms coming from the command line. 131 */ 132 bool weak; 133 /** 134 * @no_value: Is there no value. If a numeric term has no value then the 135 * value is assumed to be 1. An event name also has no value. 136 */ 137 bool no_value; 138 }; 139 140 struct parse_events_error { 141 /** @list: The head of a list of errors. */ 142 struct list_head list; 143 }; 144 145 /* A wrapper around a list of terms for the sake of better type safety. */ 146 struct parse_events_terms { 147 struct list_head terms; 148 }; 149 150 struct parse_events_state { 151 /* The list parsed events are placed on. */ 152 struct list_head list; 153 /* The updated index used by entries as they are added. */ 154 int idx; 155 /* Error information. */ 156 struct parse_events_error *error; 157 /* Holds returned terms for term parsing. */ 158 struct parse_events_terms *terms; 159 /* Start token. */ 160 int stoken; 161 /* Use the fake PMU marker for testing. */ 162 bool fake_pmu; 163 /* Skip actual tracepoint processing for testing. */ 164 bool fake_tp; 165 /* If non-null, when wildcard matching only match the given PMU. */ 166 const char *pmu_filter; 167 /* If true, the pmu_filter was set by --cputype option. */ 168 bool cputype_filter; 169 /* Should PE_LEGACY_NAME tokens be generated for config terms? */ 170 bool match_legacy_cache_terms; 171 /* Were multiple PMUs scanned to find events? */ 172 bool wild_card_pmus; 173 }; 174 175 const char *parse_events__term_type_str(enum parse_events__term_type term_type); 176 177 bool parse_events__filter_pmu(const struct parse_events_state *parse_state, 178 const struct perf_pmu *pmu); 179 void parse_events__shrink_config_terms(void); 180 int parse_events__is_hardcoded_term(struct parse_events_term *term); 181 int parse_events_term__num(struct parse_events_term **term, 182 enum parse_events__term_type type_term, 183 const char *config, u64 num, 184 bool novalue, 185 void *loc_term, void *loc_val); 186 int parse_events_term__str(struct parse_events_term **term, 187 enum parse_events__term_type type_term, 188 char *config, char *str, 189 void *loc_term, void *loc_val); 190 int parse_events_term__term(struct parse_events_term **term, 191 enum parse_events__term_type term_lhs, 192 enum parse_events__term_type term_rhs, 193 void *loc_term, void *loc_val); 194 int parse_events_term__clone(struct parse_events_term **new, 195 const struct parse_events_term *term); 196 void parse_events_term__delete(struct parse_events_term *term); 197 198 void parse_events_terms__delete(struct parse_events_terms *terms); 199 void parse_events_terms__init(struct parse_events_terms *terms); 200 void parse_events_terms__exit(struct parse_events_terms *terms); 201 int parse_events_terms(struct parse_events_terms *terms, const char *str); 202 203 struct parse_events_modifier { 204 u8 precise; /* Number of repeated 'p' for precision. */ 205 bool precise_max : 1; /* 'P' */ 206 bool non_idle : 1; /* 'I' */ 207 bool sample_read : 1; /* 'S' */ 208 bool pinned : 1; /* 'D' */ 209 bool exclusive : 1; /* 'e' */ 210 bool weak : 1; /* 'W' */ 211 bool bpf : 1; /* 'b' */ 212 bool user : 1; /* 'u' */ 213 bool kernel : 1; /* 'k' */ 214 bool hypervisor : 1; /* 'h' */ 215 bool guest : 1; /* 'G' */ 216 bool host : 1; /* 'H' */ 217 bool retire_lat : 1; /* 'R' */ 218 bool dont_regroup : 1; /* 'X' */ 219 }; 220 221 int parse_events__modifier_event(struct parse_events_state *parse_state, void *loc, 222 struct list_head *list, struct parse_events_modifier mod); 223 int parse_events__modifier_group(struct parse_events_state *parse_state, void *loc, 224 struct list_head *list, struct parse_events_modifier mod); 225 int parse_events__set_default_name(struct list_head *list, char *name); 226 int parse_events_add_tracepoint(struct parse_events_state *parse_state, 227 struct list_head *list, 228 const char *sys, const char *event, 229 struct parse_events_error *error, 230 struct parse_events_terms *head_config, void *loc); 231 int parse_events_add_numeric(struct parse_events_state *parse_state, 232 struct list_head *list, 233 u32 type, u64 config, 234 const struct parse_events_terms *head_config, 235 bool wildcard); 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, 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 264 char *parse_events_formats_error_string(char *additional_terms); 265 266 void parse_events_error__init(struct parse_events_error *err); 267 void parse_events_error__exit(struct parse_events_error *err); 268 void parse_events_error__handle(struct parse_events_error *err, int idx, 269 char *str, char *help); 270 void parse_events_error__print(const struct parse_events_error *err, 271 const char *event); 272 bool parse_events_error__contains(const struct parse_events_error *err, 273 const char *needle); 274 #ifdef HAVE_LIBELF_SUPPORT 275 /* 276 * If the probe point starts with '%', 277 * or starts with "sdt_" and has a ':' but no '=', 278 * then it should be a SDT/cached probe point. 279 */ 280 static inline bool is_sdt_event(char *str) 281 { 282 return (str[0] == '%' || 283 (!strncmp(str, "sdt_", 4) && 284 !!strchr(str, ':') && !strchr(str, '='))); 285 } 286 #else 287 static inline bool is_sdt_event(char *str __maybe_unused) 288 { 289 return false; 290 } 291 #endif /* HAVE_LIBELF_SUPPORT */ 292 293 size_t default_breakpoint_len(void); 294 295 #endif /* __PERF_PARSE_EVENTS_H */ 296