tools/perf/util/parse-events.h

   1 #ifndef __PERF_PARSE_EVENTS_H
   2 #define __PERF_PARSE_EVENTS_H
   3 /*
   4  * Parse symbolic events/counts passed in as options:
   5  */
   6
   7 #include <linux/list.h>
   8 #include <stdbool.h>
   9 #include <linux/types.h>
  10 #include <linux/perf_event.h>
  11
  12 struct list_head;
  13 struct perf_evsel;
  14 struct perf_evlist;
  15 struct parse_events_error;
  16
  17 struct option;
  18
  19 struct tracepoint_path {
  20         char *system;
  21         char *name;
  22         struct tracepoint_path *next;
  23 };
  24
  25 struct tracepoint_path *tracepoint_id_to_path(u64 config);
  26 struct tracepoint_path *tracepoint_name_to_path(const char *name);
  27 bool have_tracepoints(struct list_head *evlist);
  28
  29 const char *event_type(int type);
  30
  31 int parse_events_option(const struct option *opt, const char *str, int unset);
  32 int parse_events(struct perf_evlist *evlist, const char *str,
  33                  struct parse_events_error *error);
  34 int parse_events_terms(struct list_head *terms, const char *str);
  35 int parse_filter(const struct option *opt, const char *str, int unset);
  36 int exclude_perf(const struct option *opt, const char *arg, int unset);
  37
  38 #define EVENTS_HELP_MAX (128*1024)
  39
  40 enum perf_pmu_event_symbol_type {
  41         PMU_EVENT_SYMBOL_ERR,           /* not a PMU EVENT */
  42         PMU_EVENT_SYMBOL,               /* normal style PMU event */
  43         PMU_EVENT_SYMBOL_PREFIX,        /* prefix of pre-suf style event */
  44         PMU_EVENT_SYMBOL_SUFFIX,        /* suffix of pre-suf style event */
  45 };
  46
  47 struct perf_pmu_event_symbol {
  48         char    *symbol;
  49         enum perf_pmu_event_symbol_type type;
  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_NOOVERWRITE,
  73         PARSE_EVENTS__TERM_TYPE_OVERWRITE,
  74         PARSE_EVENTS__TERM_TYPE_DRV_CFG,
  75         __PARSE_EVENTS__TERM_TYPE_NR,
  76 };
  77
  78 struct parse_events_array {
  79         size_t nr_ranges;
  80         struct {
  81                 unsigned int start;
  82                 size_t length;
  83         } *ranges;
  84 };
  85
  86 struct parse_events_term {
  87         char *config;
  88         struct parse_events_array array;
  89         union {
  90                 char *str;
  91                 u64  num;
  92         } val;
  93         int type_val;
  94         int type_term;
  95         struct list_head list;
  96         bool used;
  97
  98         /* error string indexes for within parsed string */
  99         int err_term;
 100         int err_val;
 101 };
 102
 103 struct parse_events_error {
 104         int   idx;      /* index in the parsed string */
 105         char *str;      /* string to display at the index */
 106         char *help;     /* optional help string */
 107 };
 108
 109 struct parse_events_evlist {
 110         struct list_head           list;
 111         int                        idx;
 112         int                        nr_groups;
 113         struct parse_events_error *error;
 114         struct perf_evlist        *evlist;
 115 };
 116
 117 struct parse_events_terms {
 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                            void *loc_term, void *loc_val);
 126 int parse_events_term__str(struct parse_events_term **term,
 127                            int type_term, char *config, char *str,
 128                            void *loc_term, void *loc_val);
 129 int parse_events_term__sym_hw(struct parse_events_term **term,
 130                               char *config, unsigned idx);
 131 int parse_events_term__clone(struct parse_events_term **new,
 132                              struct parse_events_term *term);
 133 void parse_events_terms__delete(struct list_head *terms);
 134 void parse_events_terms__purge(struct list_head *terms);
 135 void parse_events__clear_array(struct parse_events_array *a);
 136 int parse_events__modifier_event(struct list_head *list, char *str, bool add);
 137 int parse_events__modifier_group(struct list_head *list, char *event_mod);
 138 int parse_events_name(struct list_head *list, char *name);
 139 int parse_events_add_tracepoint(struct list_head *list, int *idx,
 140                                 const char *sys, const char *event,
 141                                 struct parse_events_error *error,
 142                                 struct list_head *head_config);
 143 int parse_events_load_bpf(struct parse_events_evlist *data,
 144                           struct list_head *list,
 145                           char *bpf_file_name,
 146                           bool source,
 147                           struct list_head *head_config);
 148 /* Provide this function for perf test */
 149 struct bpf_object;
 150 int parse_events_load_bpf_obj(struct parse_events_evlist *data,
 151                               struct list_head *list,
 152                               struct bpf_object *obj,
 153                               struct list_head *head_config);
 154 int parse_events_add_numeric(struct parse_events_evlist *data,
 155                              struct list_head *list,
 156                              u32 type, u64 config,
 157                              struct list_head *head_config);
 158 int parse_events_add_cache(struct list_head *list, int *idx,
 159                            char *type, char *op_result1, char *op_result2,
 160                            struct parse_events_error *error,
 161                            struct list_head *head_config);
 162 int parse_events_add_breakpoint(struct list_head *list, int *idx,
 163                                 void *ptr, char *type, u64 len);
 164 int parse_events_add_pmu(struct parse_events_evlist *data,
 165                          struct list_head *list, char *name,
 166                          struct list_head *head_config);
 167 enum perf_pmu_event_symbol_type
 168 perf_pmu__parse_check(const char *name);
 169 void parse_events__set_leader(char *name, struct list_head *list);
 170 void parse_events_update_lists(struct list_head *list_event,
 171                                struct list_head *list_all);
 172 void parse_events_evlist_error(struct parse_events_evlist *data,
 173                                int idx, const char *str);
 174
 175 void print_events(const char *event_glob, bool name_only, bool quiet,
 176                   bool long_desc);
 177
 178 struct event_symbol {
 179         const char      *symbol;
 180         const char      *alias;
 181 };
 182 extern struct event_symbol event_symbols_hw[];
 183 extern struct event_symbol event_symbols_sw[];
 184 void print_symbol_events(const char *event_glob, unsigned type,
 185                                 struct event_symbol *syms, unsigned max,
 186                                 bool name_only);
 187 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
 188                              bool name_only);
 189 int print_hwcache_events(const char *event_glob, bool name_only);
 190 void print_sdt_events(const char *subsys_glob, const char *event_glob,
 191                       bool name_only);
 192 int is_valid_tracepoint(const char *event_string);
 193
 194 int valid_event_mount(const char *eventfs);
 195 char *parse_events_formats_error_string(char *additional_terms);
 196
 197 #endif /* __PERF_PARSE_EVENTS_H */