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 const char *event_type(int type);
  22
  23 /* Arguments encoded in opt->value. */
  24 struct parse_events_option_args {
  25         struct evlist **evlistp;
  26         const char *pmu_filter;
  27 };
  28 int parse_events_option(const struct option *opt, const char *str, int unset);
  29 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset);
  30 __attribute__((nonnull(1, 2, 4)))
  31 int __parse_events(struct evlist *evlist, const char *str, const char *pmu_filter,
  32                    struct parse_events_error *error, struct perf_pmu *fake_pmu,
  33                    bool warn_if_reordered);
  34
  35 __attribute__((nonnull(1, 2, 3)))
  36 static inline int parse_events(struct evlist *evlist, const char *str,
  37                                struct parse_events_error *err)
  38 {
  39         return __parse_events(evlist, str, /*pmu_filter=*/NULL, err, /*fake_pmu=*/NULL,
  40                               /*warn_if_reordered=*/true);
  41 }
  42
  43 int parse_event(struct evlist *evlist, const char *str);
  44
  45 int parse_events_terms(struct list_head *terms, const char *str);
  46 int parse_filter(const struct option *opt, const char *str, int unset);
  47 int exclude_perf(const struct option *opt, const char *arg, int unset);
  48
  49 enum {
  50         PARSE_EVENTS__TERM_TYPE_NUM,
  51         PARSE_EVENTS__TERM_TYPE_STR,
  52 };
  53
  54 enum {
  55         PARSE_EVENTS__TERM_TYPE_USER,
  56         PARSE_EVENTS__TERM_TYPE_CONFIG,
  57         PARSE_EVENTS__TERM_TYPE_CONFIG1,
  58         PARSE_EVENTS__TERM_TYPE_CONFIG2,
  59         PARSE_EVENTS__TERM_TYPE_CONFIG3,
  60         PARSE_EVENTS__TERM_TYPE_NAME,
  61         PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
  62         PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
  63         PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
  64         PARSE_EVENTS__TERM_TYPE_TIME,
  65         PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
  66         PARSE_EVENTS__TERM_TYPE_STACKSIZE,
  67         PARSE_EVENTS__TERM_TYPE_NOINHERIT,
  68         PARSE_EVENTS__TERM_TYPE_INHERIT,
  69         PARSE_EVENTS__TERM_TYPE_MAX_STACK,
  70         PARSE_EVENTS__TERM_TYPE_MAX_EVENTS,
  71         PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,
  72         PARSE_EVENTS__TERM_TYPE_OVERWRITE,
  73         PARSE_EVENTS__TERM_TYPE_DRV_CFG,
  74         PARSE_EVENTS__TERM_TYPE_PERCORE,
  75         PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT,
  76         PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE,
  77         PARSE_EVENTS__TERM_TYPE_METRIC_ID,
  78         PARSE_EVENTS__TERM_TYPE_RAW,
  79         PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE,
  80         PARSE_EVENTS__TERM_TYPE_HARDWARE,
  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         struct parse_events_error *error;
 127         struct evlist             *evlist;
 128         struct list_head          *terms;
 129         int                        stoken;
 130         struct perf_pmu           *fake_pmu;
 131         /* If non-null, when wildcard matching only match the given PMU. */
 132         const char                *pmu_filter;
 133         /* Should PE_LEGACY_NAME tokens be generated for config terms? */
 134         bool                       match_legacy_cache_terms;
 135         bool                       wild_card_pmus;
 136 };
 137
 138 bool parse_events__filter_pmu(const struct parse_events_state *parse_state,
 139                               const struct perf_pmu *pmu);
 140 void parse_events__shrink_config_terms(void);
 141 int parse_events__is_hardcoded_term(struct parse_events_term *term);
 142 int parse_events_term__num(struct parse_events_term **term,
 143                            int type_term, char *config, u64 num,
 144                            bool novalue,
 145                            void *loc_term, void *loc_val);
 146 int parse_events_term__str(struct parse_events_term **term,
 147                            int type_term, char *config, char *str,
 148                            void *loc_term, void *loc_val);
 149 int parse_events_term__term(struct parse_events_term **term,
 150                             int term_lhs, int term_rhs,
 151                             void *loc_term, void *loc_val);
 152 int parse_events_term__clone(struct parse_events_term **new,
 153                              struct parse_events_term *term);
 154 void parse_events_term__delete(struct parse_events_term *term);
 155 void parse_events_terms__delete(struct list_head *terms);
 156 void parse_events_terms__purge(struct list_head *terms);
 157 void parse_events__clear_array(struct parse_events_array *a);
 158 int parse_events__modifier_event(struct list_head *list, char *str, bool add);
 159 int parse_events__modifier_group(struct list_head *list, char *event_mod);
 160 int parse_events_name(struct list_head *list, const char *name);
 161 int parse_events_add_tracepoint(struct list_head *list, int *idx,
 162                                 const char *sys, const char *event,
 163                                 struct parse_events_error *error,
 164                                 struct list_head *head_config);
 165 int parse_events_load_bpf(struct parse_events_state *parse_state,
 166                           struct list_head *list,
 167                           char *bpf_file_name,
 168                           bool source,
 169                           struct list_head *head_config);
 170 /* Provide this function for perf test */
 171 struct bpf_object;
 172 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
 173                               struct list_head *list,
 174                               struct bpf_object *obj,
 175                               struct list_head *head_config);
 176 int parse_events_add_numeric(struct parse_events_state *parse_state,
 177                              struct list_head *list,
 178                              u32 type, u64 config,
 179                              struct list_head *head_config,
 180                              bool wildcard);
 181 int parse_events_add_tool(struct parse_events_state *parse_state,
 182                           struct list_head *list,
 183                           int tool_event);
 184 int parse_events_add_cache(struct list_head *list, int *idx, const char *name,
 185                            struct parse_events_state *parse_state,
 186                            struct list_head *head_config);
 187 int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config);
 188 int parse_events_add_breakpoint(struct parse_events_state *parse_state,
 189                                 struct list_head *list,
 190                                 u64 addr, char *type, u64 len,
 191                                 struct list_head *head_config);
 192 int parse_events_add_pmu(struct parse_events_state *parse_state,
 193                          struct list_head *list, char *name,
 194                          struct list_head *head_config,
 195                          bool auto_merge_stats);
 196
 197 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
 198                                       const char *name, const char *metric_id,
 199                                       struct perf_pmu *pmu);
 200
 201 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
 202                                char *str,
 203                                struct list_head *head_config,
 204                                struct list_head **listp);
 205
 206 int parse_events_copy_term_list(struct list_head *old,
 207                                  struct list_head **new);
 208
 209 void parse_events__set_leader(char *name, struct list_head *list);
 210 void parse_events_update_lists(struct list_head *list_event,
 211                                struct list_head *list_all);
 212 void parse_events_evlist_error(struct parse_events_state *parse_state,
 213                                int idx, const char *str);
 214
 215 struct event_symbol {
 216         const char      *symbol;
 217         const char      *alias;
 218 };
 219 extern struct event_symbol event_symbols_hw[];
 220 extern struct event_symbol event_symbols_sw[];
 221
 222 char *parse_events_formats_error_string(char *additional_terms);
 223
 224 void parse_events_error__init(struct parse_events_error *err);
 225 void parse_events_error__exit(struct parse_events_error *err);
 226 void parse_events_error__handle(struct parse_events_error *err, int idx,
 227                                 char *str, char *help);
 228 void parse_events_error__print(struct parse_events_error *err,
 229                                const char *event);
 230
 231 #ifdef HAVE_LIBELF_SUPPORT
 232 /*
 233  * If the probe point starts with '%',
 234  * or starts with "sdt_" and has a ':' but no '=',
 235  * then it should be a SDT/cached probe point.
 236  */
 237 static inline bool is_sdt_event(char *str)
 238 {
 239         return (str[0] == '%' ||
 240                 (!strncmp(str, "sdt_", 4) &&
 241                  !!strchr(str, ':') && !strchr(str, '=')));
 242 }
 243 #else
 244 static inline bool is_sdt_event(char *str __maybe_unused)
 245 {
 246         return false;
 247 }
 248 #endif /* HAVE_LIBELF_SUPPORT */
 249
 250 #endif /* __PERF_PARSE_EVENTS_H */