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