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 22 const char *event_type(int type); 23 24 /* Arguments encoded in opt->value. */ 25 struct parse_events_option_args { 26 struct evlist **evlistp; 27 const char *pmu_filter; 28 }; 29 int parse_events_option(const struct option *opt, const char *str, int unset); 30 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset); 31 __attribute__((nonnull(1, 2, 4))) 32 int __parse_events(struct evlist *evlist, const char *str, const char *pmu_filter, 33 struct parse_events_error *error, struct perf_pmu *fake_pmu, 34 bool warn_if_reordered); 35 36 __attribute__((nonnull(1, 2, 3))) 37 static inline int parse_events(struct evlist *evlist, const char *str, 38 struct parse_events_error *err) 39 { 40 return __parse_events(evlist, str, /*pmu_filter=*/NULL, err, /*fake_pmu=*/NULL, 41 /*warn_if_reordered=*/true); 42 } 43 44 int parse_event(struct evlist *evlist, const char *str); 45 46 int parse_events_terms(struct list_head *terms, const char *str, FILE *input); 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 { 51 PARSE_EVENTS__TERM_TYPE_NUM, 52 PARSE_EVENTS__TERM_TYPE_STR, 53 }; 54 55 enum { 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 __PARSE_EVENTS__TERM_TYPE_NR, 83 }; 84 85 struct parse_events_term { 86 const char *config; 87 union { 88 char *str; 89 u64 num; 90 } val; 91 int type_val; 92 int type_term; 93 struct list_head list; 94 bool used; 95 bool no_value; 96 97 /* error string indexes for within parsed string */ 98 int err_term; 99 int err_val; 100 101 /* Coming from implicit alias */ 102 bool weak; 103 }; 104 105 struct parse_events_error { 106 int num_errors; /* number of errors encountered */ 107 int idx; /* index in the parsed string */ 108 char *str; /* string to display at the index */ 109 char *help; /* optional help string */ 110 int first_idx;/* as above, but for the first encountered error */ 111 char *first_str; 112 char *first_help; 113 }; 114 115 struct parse_events_state { 116 /* The list parsed events are placed on. */ 117 struct list_head list; 118 /* The updated index used by entries as they are added. */ 119 int idx; 120 /* Error information. */ 121 struct parse_events_error *error; 122 /* Holds returned terms for term parsing. */ 123 struct list_head *terms; 124 /* Start token. */ 125 int stoken; 126 /* Special fake PMU marker for testing. */ 127 struct perf_pmu *fake_pmu; 128 /* If non-null, when wildcard matching only match the given PMU. */ 129 const char *pmu_filter; 130 /* Should PE_LEGACY_NAME tokens be generated for config terms? */ 131 bool match_legacy_cache_terms; 132 /* Were multiple PMUs scanned to find events? */ 133 bool wild_card_pmus; 134 }; 135 136 bool parse_events__filter_pmu(const struct parse_events_state *parse_state, 137 const struct perf_pmu *pmu); 138 void parse_events__shrink_config_terms(void); 139 int parse_events__is_hardcoded_term(struct parse_events_term *term); 140 int parse_events_term__num(struct parse_events_term **term, 141 int type_term, const char *config, u64 num, 142 bool novalue, 143 void *loc_term, void *loc_val); 144 int parse_events_term__str(struct parse_events_term **term, 145 int type_term, char *config, char *str, 146 void *loc_term, void *loc_val); 147 int parse_events_term__term(struct parse_events_term **term, 148 int term_lhs, int term_rhs, 149 void *loc_term, void *loc_val); 150 int parse_events_term__clone(struct parse_events_term **new, 151 struct parse_events_term *term); 152 void parse_events_term__delete(struct parse_events_term *term); 153 void parse_events_terms__delete(struct list_head *terms); 154 void parse_events_terms__purge(struct list_head *terms); 155 int parse_events__modifier_event(struct list_head *list, char *str, bool add); 156 int parse_events__modifier_group(struct list_head *list, char *event_mod); 157 int parse_events_name(struct list_head *list, const char *name); 158 int parse_events_add_tracepoint(struct list_head *list, int *idx, 159 const char *sys, const char *event, 160 struct parse_events_error *error, 161 struct list_head *head_config, void *loc); 162 int parse_events_add_numeric(struct parse_events_state *parse_state, 163 struct list_head *list, 164 u32 type, u64 config, 165 struct list_head *head_config, 166 bool wildcard); 167 int parse_events_add_tool(struct parse_events_state *parse_state, 168 struct list_head *list, 169 int tool_event); 170 int parse_events_add_cache(struct list_head *list, int *idx, const char *name, 171 struct parse_events_state *parse_state, 172 struct list_head *head_config); 173 int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config); 174 int parse_events_add_breakpoint(struct parse_events_state *parse_state, 175 struct list_head *list, 176 u64 addr, char *type, u64 len, 177 struct list_head *head_config); 178 int parse_events_add_pmu(struct parse_events_state *parse_state, 179 struct list_head *list, const char *name, 180 struct list_head *head_config, 181 bool auto_merge_stats, void *loc); 182 183 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr, 184 const char *name, const char *metric_id, 185 struct perf_pmu *pmu); 186 187 int parse_events_multi_pmu_add(struct parse_events_state *parse_state, 188 char *str, 189 struct list_head *head_config, 190 struct list_head **listp, void *loc); 191 192 int parse_events_copy_term_list(struct list_head *old, 193 struct list_head **new); 194 195 void parse_events__set_leader(char *name, struct list_head *list); 196 void parse_events_update_lists(struct list_head *list_event, 197 struct list_head *list_all); 198 void parse_events_evlist_error(struct parse_events_state *parse_state, 199 int idx, const char *str); 200 201 struct event_symbol { 202 const char *symbol; 203 const char *alias; 204 }; 205 extern struct event_symbol event_symbols_hw[]; 206 extern struct event_symbol event_symbols_sw[]; 207 208 char *parse_events_formats_error_string(char *additional_terms); 209 210 void parse_events_error__init(struct parse_events_error *err); 211 void parse_events_error__exit(struct parse_events_error *err); 212 void parse_events_error__handle(struct parse_events_error *err, int idx, 213 char *str, char *help); 214 void parse_events_error__print(struct parse_events_error *err, 215 const char *event); 216 217 #ifdef HAVE_LIBELF_SUPPORT 218 /* 219 * If the probe point starts with '%', 220 * or starts with "sdt_" and has a ':' but no '=', 221 * then it should be a SDT/cached probe point. 222 */ 223 static inline bool is_sdt_event(char *str) 224 { 225 return (str[0] == '%' || 226 (!strncmp(str, "sdt_", 4) && 227 !!strchr(str, ':') && !strchr(str, '='))); 228 } 229 #else 230 static inline bool is_sdt_event(char *str __maybe_unused) 231 { 232 return false; 233 } 234 #endif /* HAVE_LIBELF_SUPPORT */ 235 236 #endif /* __PERF_PARSE_EVENTS_H */ 237