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 14 struct list_head; 15 struct perf_evsel; 16 struct perf_evlist; 17 struct parse_events_error; 18 19 struct option; 20 21 struct tracepoint_path { 22 char *system; 23 char *name; 24 struct tracepoint_path *next; 25 }; 26 27 struct tracepoint_path *tracepoint_id_to_path(u64 config); 28 struct tracepoint_path *tracepoint_name_to_path(const char *name); 29 bool have_tracepoints(struct list_head *evlist); 30 31 const char *event_type(int type); 32 33 int parse_events_option(const struct option *opt, const char *str, int unset); 34 int parse_events(struct perf_evlist *evlist, const char *str, 35 struct parse_events_error *error); 36 int parse_events_terms(struct list_head *terms, const char *str); 37 int parse_filter(const struct option *opt, const char *str, int unset); 38 int exclude_perf(const struct option *opt, const char *arg, int unset); 39 40 #define EVENTS_HELP_MAX (128*1024) 41 42 enum perf_pmu_event_symbol_type { 43 PMU_EVENT_SYMBOL_ERR, /* not a PMU EVENT */ 44 PMU_EVENT_SYMBOL, /* normal style PMU event */ 45 PMU_EVENT_SYMBOL_PREFIX, /* prefix of pre-suf style event */ 46 PMU_EVENT_SYMBOL_SUFFIX, /* suffix of pre-suf style event */ 47 }; 48 49 struct perf_pmu_event_symbol { 50 char *symbol; 51 enum perf_pmu_event_symbol_type type; 52 }; 53 54 enum { 55 PARSE_EVENTS__TERM_TYPE_NUM, 56 PARSE_EVENTS__TERM_TYPE_STR, 57 }; 58 59 enum { 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_NAME, 65 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD, 66 PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ, 67 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE, 68 PARSE_EVENTS__TERM_TYPE_TIME, 69 PARSE_EVENTS__TERM_TYPE_CALLGRAPH, 70 PARSE_EVENTS__TERM_TYPE_STACKSIZE, 71 PARSE_EVENTS__TERM_TYPE_NOINHERIT, 72 PARSE_EVENTS__TERM_TYPE_INHERIT, 73 PARSE_EVENTS__TERM_TYPE_MAX_STACK, 74 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE, 75 PARSE_EVENTS__TERM_TYPE_OVERWRITE, 76 PARSE_EVENTS__TERM_TYPE_DRV_CFG, 77 __PARSE_EVENTS__TERM_TYPE_NR, 78 }; 79 80 struct parse_events_array { 81 size_t nr_ranges; 82 struct { 83 unsigned int start; 84 size_t length; 85 } *ranges; 86 }; 87 88 struct parse_events_term { 89 char *config; 90 struct parse_events_array array; 91 union { 92 char *str; 93 u64 num; 94 } val; 95 int type_val; 96 int type_term; 97 struct list_head list; 98 bool used; 99 bool no_value; 100 101 /* error string indexes for within parsed string */ 102 int err_term; 103 int err_val; 104 105 /* Coming from implicit alias */ 106 bool weak; 107 }; 108 109 struct parse_events_error { 110 int idx; /* index in the parsed string */ 111 char *str; /* string to display at the index */ 112 char *help; /* optional help string */ 113 }; 114 115 struct parse_events_state { 116 struct list_head list; 117 int idx; 118 int nr_groups; 119 struct parse_events_error *error; 120 struct perf_evlist *evlist; 121 struct list_head *terms; 122 }; 123 124 void parse_events__shrink_config_terms(void); 125 int parse_events__is_hardcoded_term(struct parse_events_term *term); 126 int parse_events_term__num(struct parse_events_term **term, 127 int type_term, char *config, u64 num, 128 bool novalue, 129 void *loc_term, void *loc_val); 130 int parse_events_term__str(struct parse_events_term **term, 131 int type_term, char *config, char *str, 132 void *loc_term, void *loc_val); 133 int parse_events_term__sym_hw(struct parse_events_term **term, 134 char *config, unsigned idx); 135 int parse_events_term__clone(struct parse_events_term **new, 136 struct parse_events_term *term); 137 void parse_events_terms__delete(struct list_head *terms); 138 void parse_events_terms__purge(struct list_head *terms); 139 void parse_events__clear_array(struct parse_events_array *a); 140 int parse_events__modifier_event(struct list_head *list, char *str, bool add); 141 int parse_events__modifier_group(struct list_head *list, char *event_mod); 142 int parse_events_name(struct list_head *list, char *name); 143 int parse_events_add_tracepoint(struct list_head *list, int *idx, 144 const char *sys, const char *event, 145 struct parse_events_error *error, 146 struct list_head *head_config); 147 int parse_events_load_bpf(struct parse_events_state *parse_state, 148 struct list_head *list, 149 char *bpf_file_name, 150 bool source, 151 struct list_head *head_config); 152 /* Provide this function for perf test */ 153 struct bpf_object; 154 int parse_events_load_bpf_obj(struct parse_events_state *parse_state, 155 struct list_head *list, 156 struct bpf_object *obj, 157 struct list_head *head_config); 158 int parse_events_add_numeric(struct parse_events_state *parse_state, 159 struct list_head *list, 160 u32 type, u64 config, 161 struct list_head *head_config); 162 int parse_events_add_cache(struct list_head *list, int *idx, 163 char *type, char *op_result1, char *op_result2, 164 struct parse_events_error *error, 165 struct list_head *head_config); 166 int parse_events_add_breakpoint(struct list_head *list, int *idx, 167 void *ptr, char *type, u64 len); 168 int parse_events_add_pmu(struct parse_events_state *parse_state, 169 struct list_head *list, char *name, 170 struct list_head *head_config); 171 172 int parse_events_multi_pmu_add(struct parse_events_state *parse_state, 173 char *str, 174 struct list_head **listp); 175 176 int parse_events_copy_term_list(struct list_head *old, 177 struct list_head **new); 178 179 enum perf_pmu_event_symbol_type 180 perf_pmu__parse_check(const char *name); 181 void parse_events__set_leader(char *name, struct list_head *list); 182 void parse_events_update_lists(struct list_head *list_event, 183 struct list_head *list_all); 184 void parse_events_evlist_error(struct parse_events_state *parse_state, 185 int idx, const char *str); 186 187 void print_events(const char *event_glob, bool name_only, bool quiet, 188 bool long_desc, bool details_flag); 189 190 struct event_symbol { 191 const char *symbol; 192 const char *alias; 193 }; 194 extern struct event_symbol event_symbols_hw[]; 195 extern struct event_symbol event_symbols_sw[]; 196 void print_symbol_events(const char *event_glob, unsigned type, 197 struct event_symbol *syms, unsigned max, 198 bool name_only); 199 void print_tracepoint_events(const char *subsys_glob, const char *event_glob, 200 bool name_only); 201 int print_hwcache_events(const char *event_glob, bool name_only); 202 void print_sdt_events(const char *subsys_glob, const char *event_glob, 203 bool name_only); 204 int is_valid_tracepoint(const char *event_string); 205 206 int valid_event_mount(const char *eventfs); 207 char *parse_events_formats_error_string(char *additional_terms); 208 209 void parse_events_print_error(struct parse_events_error *err, 210 const char *event); 211 212 #ifdef HAVE_LIBELF_SUPPORT 213 /* 214 * If the probe point starts with '%', 215 * or starts with "sdt_" and has a ':' but no '=', 216 * then it should be a SDT/cached probe point. 217 */ 218 static inline bool is_sdt_event(char *str) 219 { 220 return (str[0] == '%' || 221 (!strncmp(str, "sdt_", 4) && 222 !!strchr(str, ':') && !strchr(str, '='))); 223 } 224 #else 225 static inline bool is_sdt_event(char *str __maybe_unused) 226 { 227 return false; 228 } 229 #endif /* HAVE_LIBELF_SUPPORT */ 230 231 #endif /* __PERF_PARSE_EVENTS_H */ 232