tools/perf/util/parse-events.h

   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 evsel;
  15 struct evlist;
  16 struct parse_events_error;
  17
  18 struct option;
  19 struct perf_pmu;
  20
  21 bool have_tracepoints(struct list_head *evlist);
  22 bool is_event_supported(u8 type, u64 config);
  23
  24 const char *event_type(int type);
  25
  26 int parse_events_option(const struct option *opt, const char *str, int unset);
  27 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset);
  28 __attribute__((nonnull(1, 2, 3)))
  29 int __parse_events(struct evlist *evlist, const char *str, struct parse_events_error *error,
  30                    struct perf_pmu *fake_pmu);
  31
  32 __attribute__((nonnull))
  33 static inline int parse_events(struct evlist *evlist, const char *str,
  34                                struct parse_events_error *err)
  35 {
  36         return __parse_events(evlist, str, err, NULL);
  37 }
  38
  39 int parse_event(struct evlist *evlist, const char *str);
  40
  41 int parse_events_terms(struct list_head *terms, const char *str);
  42 int parse_filter(const struct option *opt, const char *str, int unset);
  43 int exclude_perf(const struct option *opt, const char *arg, int unset);
  44
  45 enum perf_pmu_event_symbol_type {
  46         PMU_EVENT_SYMBOL_ERR,           /* not a PMU EVENT */
  47         PMU_EVENT_SYMBOL,               /* normal style PMU event */
  48         PMU_EVENT_SYMBOL_PREFIX,        /* prefix of pre-suf style event */
  49         PMU_EVENT_SYMBOL_SUFFIX,        /* suffix of pre-suf style event */
  50         PMU_EVENT_SYMBOL_SUFFIX2,       /* suffix of pre-suf2 style event */
  51 };
  52
  53 enum {
  54         PARSE_EVENTS__TERM_TYPE_NUM,
  55         PARSE_EVENTS__TERM_TYPE_STR,
  56 };
  57
  58 enum {
  59         PARSE_EVENTS__TERM_TYPE_USER,
  60         PARSE_EVENTS__TERM_TYPE_CONFIG,
  61         PARSE_EVENTS__TERM_TYPE_CONFIG1,
  62         PARSE_EVENTS__TERM_TYPE_CONFIG2,
  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_SAMPLE_SIZE,
  80         PARSE_EVENTS__TERM_TYPE_METRIC_ID,
  81         __PARSE_EVENTS__TERM_TYPE_NR,
  82 };
  83
  84 struct parse_events_array {
  85         size_t nr_ranges;
  86         struct {
  87                 unsigned int start;
  88                 size_t length;
  89         } *ranges;
  90 };
  91
  92 struct parse_events_term {
  93         char *config;
  94         struct parse_events_array array;
  95         union {
  96                 char *str;
  97                 u64  num;
  98         } val;
  99         int type_val;
 100         int type_term;
 101         struct list_head list;
 102         bool used;
 103         bool no_value;
 104
 105         /* error string indexes for within parsed string */
 106         int err_term;
 107         int err_val;
 108
 109         /* Coming from implicit alias */
 110         bool weak;
 111 };
 112
 113 struct parse_events_error {
 114         int   num_errors;       /* number of errors encountered */
 115         int   idx;      /* index in the parsed string */
 116         char *str;      /* string to display at the index */
 117         char *help;     /* optional help string */
 118         int   first_idx;/* as above, but for the first encountered error */
 119         char *first_str;
 120         char *first_help;
 121 };
 122
 123 struct parse_events_state {
 124         struct list_head           list;
 125         int                        idx;
 126         int                        nr_groups;
 127         struct parse_events_error *error;
 128         struct evlist             *evlist;
 129         struct list_head          *terms;
 130         int                        stoken;
 131         struct perf_pmu           *fake_pmu;
 132         char                      *hybrid_pmu_name;
 133 };
 134
 135 void parse_events__shrink_config_terms(void);
 136 int parse_events__is_hardcoded_term(struct parse_events_term *term);
 137 int parse_events_term__num(struct parse_events_term **term,
 138                            int type_term, char *config, u64 num,
 139                            bool novalue,
 140                            void *loc_term, void *loc_val);
 141 int parse_events_term__str(struct parse_events_term **term,
 142                            int type_term, char *config, char *str,
 143                            void *loc_term, void *loc_val);
 144 int parse_events_term__sym_hw(struct parse_events_term **term,
 145                               char *config, unsigned idx);
 146 int parse_events_term__clone(struct parse_events_term **new,
 147                              struct parse_events_term *term);
 148 void parse_events_term__delete(struct parse_events_term *term);
 149 void parse_events_terms__delete(struct list_head *terms);
 150 void parse_events_terms__purge(struct list_head *terms);
 151 void parse_events__clear_array(struct parse_events_array *a);
 152 int parse_events__modifier_event(struct list_head *list, char *str, bool add);
 153 int parse_events__modifier_group(struct list_head *list, char *event_mod);
 154 int parse_events_name(struct list_head *list, const char *name);
 155 int parse_events_add_tracepoint(struct list_head *list, int *idx,
 156                                 const char *sys, const char *event,
 157                                 struct parse_events_error *error,
 158                                 struct list_head *head_config);
 159 int parse_events_load_bpf(struct parse_events_state *parse_state,
 160                           struct list_head *list,
 161                           char *bpf_file_name,
 162                           bool source,
 163                           struct list_head *head_config);
 164 /* Provide this function for perf test */
 165 struct bpf_object;
 166 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
 167                               struct list_head *list,
 168                               struct bpf_object *obj,
 169                               struct list_head *head_config);
 170 int parse_events_add_numeric(struct parse_events_state *parse_state,
 171                              struct list_head *list,
 172                              u32 type, u64 config,
 173                              struct list_head *head_config);
 174 int parse_events_add_tool(struct parse_events_state *parse_state,
 175                           struct list_head *list,
 176                           int tool_event);
 177 int parse_events_add_cache(struct list_head *list, int *idx,
 178                            char *type, char *op_result1, char *op_result2,
 179                            struct parse_events_error *error,
 180                            struct list_head *head_config,
 181                            struct parse_events_state *parse_state);
 182 int parse_events_add_breakpoint(struct list_head *list, int *idx,
 183                                 u64 addr, char *type, u64 len);
 184 int parse_events_add_pmu(struct parse_events_state *parse_state,
 185                          struct list_head *list, char *name,
 186                          struct list_head *head_config,
 187                          bool auto_merge_stats,
 188                          bool use_alias);
 189
 190 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
 191                                       const char *name, const char *metric_id,
 192                                       struct perf_pmu *pmu);
 193
 194 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
 195                                char *str,
 196                                struct list_head *head_config,
 197                                struct list_head **listp);
 198
 199 int parse_events_copy_term_list(struct list_head *old,
 200                                  struct list_head **new);
 201
 202 enum perf_pmu_event_symbol_type
 203 perf_pmu__parse_check(const char *name);
 204 void parse_events__set_leader(char *name, struct list_head *list,
 205                               struct parse_events_state *parse_state);
 206 void parse_events_update_lists(struct list_head *list_event,
 207                                struct list_head *list_all);
 208 void parse_events_evlist_error(struct parse_events_state *parse_state,
 209                                int idx, const char *str);
 210
 211 struct event_symbol {
 212         const char      *symbol;
 213         const char      *alias;
 214 };
 215 extern struct event_symbol event_symbols_hw[];
 216 extern struct event_symbol event_symbols_sw[];
 217
 218 char *parse_events_formats_error_string(char *additional_terms);
 219
 220 void parse_events_error__init(struct parse_events_error *err);
 221 void parse_events_error__exit(struct parse_events_error *err);
 222 void parse_events_error__handle(struct parse_events_error *err, int idx,
 223                                 char *str, char *help);
 224 void parse_events_error__print(struct parse_events_error *err,
 225                                const char *event);
 226
 227 #ifdef HAVE_LIBELF_SUPPORT
 228 /*
 229  * If the probe point starts with '%',
 230  * or starts with "sdt_" and has a ':' but no '=',
 231  * then it should be a SDT/cached probe point.
 232  */
 233 static inline bool is_sdt_event(char *str)
 234 {
 235         return (str[0] == '%' ||
 236                 (!strncmp(str, "sdt_", 4) &&
 237                  !!strchr(str, ':') && !strchr(str, '=')));
 238 }
 239 #else
 240 static inline bool is_sdt_event(char *str __maybe_unused)
 241 {
 242         return false;
 243 }
 244 #endif /* HAVE_LIBELF_SUPPORT */
 245
 246 int perf_pmu__test_parse_init(void);
 247
 248 struct evsel *parse_events__add_event_hybrid(struct list_head *list, int *idx,
 249                                              struct perf_event_attr *attr,
 250                                              const char *name,
 251                                              const char *metric_id,
 252                                              struct perf_pmu *pmu,
 253                                              struct list_head *config_terms);
 254
 255 #endif /* __PERF_PARSE_EVENTS_H */