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 extern struct tracepoint_path *tracepoint_id_to_path(u64 config);
  26 extern struct tracepoint_path *tracepoint_name_to_path(const char *name);
  27 extern bool have_tracepoints(struct list_head *evlist);
  28
  29 const char *event_type(int type);
  30
  31 extern int parse_events_option(const struct option *opt, const char *str,
  32                                int unset);
  33 extern int parse_events(struct perf_evlist *evlist, const char *str,
  34                         struct parse_events_error *error);
  35 extern int parse_events_terms(struct list_head *terms, const char *str);
  36 extern int parse_filter(const struct option *opt, const char *str, int unset);
  37 extern int exclude_perf(const struct option *opt, const char *arg, int unset);
  38
  39 #define EVENTS_HELP_MAX (128*1024)
  40
  41 enum perf_pmu_event_symbol_type {
  42         PMU_EVENT_SYMBOL_ERR,           /* not a PMU EVENT */
  43         PMU_EVENT_SYMBOL,               /* normal style PMU event */
  44         PMU_EVENT_SYMBOL_PREFIX,        /* prefix of pre-suf style event */
  45         PMU_EVENT_SYMBOL_SUFFIX,        /* suffix of pre-suf style event */
  46 };
  47
  48 struct perf_pmu_event_symbol {
  49         char    *symbol;
  50         enum perf_pmu_event_symbol_type type;
  51 };
  52
  53 enum {
  54         PARSE_EVENTS__TERM_TYPE_NUM,
  55         PARSE_EVENTS__TERM_TYPE_STR,
  56 };
  57
  58 enum {
  59         PARSE_EVENTS__TERM_TYPE_USER,
  60         PARSE_EVENTS__TERM_TYPE_CONFIG,
  61         PARSE_EVENTS__TERM_TYPE_CONFIG1,
  62         PARSE_EVENTS__TERM_TYPE_CONFIG2,
  63         PARSE_EVENTS__TERM_TYPE_NAME,
  64         PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
  65         PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
  66         PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
  67         PARSE_EVENTS__TERM_TYPE_TIME,
  68         PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
  69         PARSE_EVENTS__TERM_TYPE_STACKSIZE,
  70         PARSE_EVENTS__TERM_TYPE_NOINHERIT,
  71         PARSE_EVENTS__TERM_TYPE_INHERIT
  72 };
  73
  74 struct parse_events_term {
  75         char *config;
  76         union {
  77                 char *str;
  78                 u64  num;
  79         } val;
  80         int type_val;
  81         int type_term;
  82         struct list_head list;
  83         bool used;
  84
  85         /* error string indexes for within parsed string */
  86         int err_term;
  87         int err_val;
  88 };
  89
  90 struct parse_events_error {
  91         int   idx;      /* index in the parsed string */
  92         char *str;      /* string to display at the index */
  93         char *help;     /* optional help string */
  94 };
  95
  96 struct parse_events_evlist {
  97         struct list_head           list;
  98         int                        idx;
  99         int                        nr_groups;
 100         struct parse_events_error *error;
 101 };
 102
 103 struct parse_events_terms {
 104         struct list_head *terms;
 105 };
 106
 107 int parse_events__is_hardcoded_term(struct parse_events_term *term);
 108 int parse_events_term__num(struct parse_events_term **term,
 109                            int type_term, char *config, u64 num,
 110                            void *loc_term, void *loc_val);
 111 int parse_events_term__str(struct parse_events_term **term,
 112                            int type_term, char *config, char *str,
 113                            void *loc_term, void *loc_val);
 114 int parse_events_term__sym_hw(struct parse_events_term **term,
 115                               char *config, unsigned idx);
 116 int parse_events_term__clone(struct parse_events_term **new,
 117                              struct parse_events_term *term);
 118 void parse_events__free_terms(struct list_head *terms);
 119 int parse_events__modifier_event(struct list_head *list, char *str, bool add);
 120 int parse_events__modifier_group(struct list_head *list, char *event_mod);
 121 int parse_events_name(struct list_head *list, char *name);
 122 int parse_events_add_tracepoint(struct list_head *list, int *idx,
 123                                 char *sys, char *event,
 124                                 struct parse_events_error *error,
 125                                 struct list_head *head_config);
 126 int parse_events_load_bpf(struct parse_events_evlist *data,
 127                           struct list_head *list,
 128                           char *bpf_file_name,
 129                           bool source);
 130 /* Provide this function for perf test */
 131 struct bpf_object;
 132 int parse_events_load_bpf_obj(struct parse_events_evlist *data,
 133                               struct list_head *list,
 134                               struct bpf_object *obj);
 135 int parse_events_add_numeric(struct parse_events_evlist *data,
 136                              struct list_head *list,
 137                              u32 type, u64 config,
 138                              struct list_head *head_config);
 139 int parse_events_add_cache(struct list_head *list, int *idx,
 140                            char *type, char *op_result1, char *op_result2);
 141 int parse_events_add_breakpoint(struct list_head *list, int *idx,
 142                                 void *ptr, char *type, u64 len);
 143 int parse_events_add_pmu(struct parse_events_evlist *data,
 144                          struct list_head *list, char *name,
 145                          struct list_head *head_config);
 146 enum perf_pmu_event_symbol_type
 147 perf_pmu__parse_check(const char *name);
 148 void parse_events__set_leader(char *name, struct list_head *list);
 149 void parse_events_update_lists(struct list_head *list_event,
 150                                struct list_head *list_all);
 151 void parse_events_evlist_error(struct parse_events_evlist *data,
 152                                int idx, const char *str);
 153
 154 void print_events(const char *event_glob, bool name_only);
 155
 156 struct event_symbol {
 157         const char      *symbol;
 158         const char      *alias;
 159 };
 160 extern struct event_symbol event_symbols_hw[];
 161 extern struct event_symbol event_symbols_sw[];
 162 void print_symbol_events(const char *event_glob, unsigned type,
 163                                 struct event_symbol *syms, unsigned max,
 164                                 bool name_only);
 165 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
 166                              bool name_only);
 167 int print_hwcache_events(const char *event_glob, bool name_only);
 168 extern int is_valid_tracepoint(const char *event_string);
 169
 170 int valid_event_mount(const char *eventfs);
 171 char *parse_events_formats_error_string(char *additional_terms);
 172
 173 #endif /* __PERF_PARSE_EVENTS_H */