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 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
 106 struct parse_events_error {
 107         int   idx;      /* index in the parsed string */
 108         char *str;      /* string to display at the index */
 109         char *help;     /* optional help string */
 110 };
 111
 112 struct parse_events_state {
 113         struct list_head           list;
 114         int                        idx;
 115         int                        nr_groups;
 116         struct parse_events_error *error;
 117         struct perf_evlist        *evlist;
 118         struct list_head          *terms;
 119 };
 120
 121 void parse_events__shrink_config_terms(void);
 122 int parse_events__is_hardcoded_term(struct parse_events_term *term);
 123 int parse_events_term__num(struct parse_events_term **term,
 124                            int type_term, char *config, u64 num,
 125                            bool novalue,
 126                            void *loc_term, void *loc_val);
 127 int parse_events_term__str(struct parse_events_term **term,
 128                            int type_term, char *config, char *str,
 129                            void *loc_term, void *loc_val);
 130 int parse_events_term__sym_hw(struct parse_events_term **term,
 131                               char *config, unsigned idx);
 132 int parse_events_term__clone(struct parse_events_term **new,
 133                              struct parse_events_term *term);
 134 void parse_events_terms__delete(struct list_head *terms);
 135 void parse_events_terms__purge(struct list_head *terms);
 136 void parse_events__clear_array(struct parse_events_array *a);
 137 int parse_events__modifier_event(struct list_head *list, char *str, bool add);
 138 int parse_events__modifier_group(struct list_head *list, char *event_mod);
 139 int parse_events_name(struct list_head *list, char *name);
 140 int parse_events_add_tracepoint(struct list_head *list, int *idx,
 141                                 const char *sys, const char *event,
 142                                 struct parse_events_error *error,
 143                                 struct list_head *head_config);
 144 int parse_events_load_bpf(struct parse_events_state *parse_state,
 145                           struct list_head *list,
 146                           char *bpf_file_name,
 147                           bool source,
 148                           struct list_head *head_config);
 149 /* Provide this function for perf test */
 150 struct bpf_object;
 151 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
 152                               struct list_head *list,
 153                               struct bpf_object *obj,
 154                               struct list_head *head_config);
 155 int parse_events_add_numeric(struct parse_events_state *parse_state,
 156                              struct list_head *list,
 157                              u32 type, u64 config,
 158                              struct list_head *head_config);
 159 int parse_events_add_cache(struct list_head *list, int *idx,
 160                            char *type, char *op_result1, char *op_result2,
 161                            struct parse_events_error *error,
 162                            struct list_head *head_config);
 163 int parse_events_add_breakpoint(struct list_head *list, int *idx,
 164                                 void *ptr, char *type, u64 len);
 165 int parse_events_add_pmu(struct parse_events_state *parse_state,
 166                          struct list_head *list, char *name,
 167                          struct list_head *head_config);
 168
 169 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
 170                                char *str,
 171                                struct list_head **listp);
 172
 173 int parse_events_copy_term_list(struct list_head *old,
 174                                  struct list_head **new);
 175
 176 enum perf_pmu_event_symbol_type
 177 perf_pmu__parse_check(const char *name);
 178 void parse_events__set_leader(char *name, struct list_head *list);
 179 void parse_events_update_lists(struct list_head *list_event,
 180                                struct list_head *list_all);
 181 void parse_events_evlist_error(struct parse_events_state *parse_state,
 182                                int idx, const char *str);
 183
 184 void print_events(const char *event_glob, bool name_only, bool quiet,
 185                   bool long_desc, bool details_flag);
 186
 187 struct event_symbol {
 188         const char      *symbol;
 189         const char      *alias;
 190 };
 191 extern struct event_symbol event_symbols_hw[];
 192 extern struct event_symbol event_symbols_sw[];
 193 void print_symbol_events(const char *event_glob, unsigned type,
 194                                 struct event_symbol *syms, unsigned max,
 195                                 bool name_only);
 196 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
 197                              bool name_only);
 198 int print_hwcache_events(const char *event_glob, bool name_only);
 199 void print_sdt_events(const char *subsys_glob, const char *event_glob,
 200                       bool name_only);
 201 int is_valid_tracepoint(const char *event_string);
 202
 203 int valid_event_mount(const char *eventfs);
 204 char *parse_events_formats_error_string(char *additional_terms);
 205
 206 void parse_events_print_error(struct parse_events_error *err,
 207                               const char *event);
 208
 209 #ifdef HAVE_LIBELF_SUPPORT
 210 /*
 211  * If the probe point starts with '%',
 212  * or starts with "sdt_" and has a ':' but no '=',
 213  * then it should be a SDT/cached probe point.
 214  */
 215 static inline bool is_sdt_event(char *str)
 216 {
 217         return (str[0] == '%' ||
 218                 (!strncmp(str, "sdt_", 4) &&
 219                  !!strchr(str, ':') && !strchr(str, '=')));
 220 }
 221 #else
 222 static inline bool is_sdt_event(char *str __maybe_unused)
 223 {
 224         return false;
 225 }
 226 #endif /* HAVE_LIBELF_SUPPORT */
 227
 228 #endif /* __PERF_PARSE_EVENTS_H */