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