linux/tools/perf/util/parse-events.h
<<
>>
Prefs
   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
  12struct list_head;
  13struct perf_evsel;
  14struct perf_evlist;
  15struct parse_events_error;
  16
  17struct option;
  18
  19struct tracepoint_path {
  20        char *system;
  21        char *name;
  22        struct tracepoint_path *next;
  23};
  24
  25struct tracepoint_path *tracepoint_id_to_path(u64 config);
  26struct tracepoint_path *tracepoint_name_to_path(const char *name);
  27bool have_tracepoints(struct list_head *evlist);
  28
  29const char *event_type(int type);
  30
  31int parse_events_option(const struct option *opt, const char *str, int unset);
  32int parse_events(struct perf_evlist *evlist, const char *str,
  33                 struct parse_events_error *error);
  34int parse_events_terms(struct list_head *terms, const char *str);
  35int parse_filter(const struct option *opt, const char *str, int unset);
  36int exclude_perf(const struct option *opt, const char *arg, int unset);
  37
  38#define EVENTS_HELP_MAX (128*1024)
  39
  40enum 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
  47struct perf_pmu_event_symbol {
  48        char    *symbol;
  49        enum perf_pmu_event_symbol_type type;
  50};
  51
  52enum {
  53        PARSE_EVENTS__TERM_TYPE_NUM,
  54        PARSE_EVENTS__TERM_TYPE_STR,
  55};
  56
  57enum {
  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
  78struct parse_events_array {
  79        size_t nr_ranges;
  80        struct {
  81                unsigned int start;
  82                size_t length;
  83        } *ranges;
  84};
  85
  86struct 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        bool no_value;
  98
  99        /* error string indexes for within parsed string */
 100        int err_term;
 101        int err_val;
 102};
 103
 104struct parse_events_error {
 105        int   idx;      /* index in the parsed string */
 106        char *str;      /* string to display at the index */
 107        char *help;     /* optional help string */
 108};
 109
 110struct parse_events_evlist {
 111        struct list_head           list;
 112        int                        idx;
 113        int                        nr_groups;
 114        struct parse_events_error *error;
 115        struct perf_evlist        *evlist;
 116};
 117
 118struct parse_events_terms {
 119        struct list_head *terms;
 120};
 121
 122void parse_events__shrink_config_terms(void);
 123int parse_events__is_hardcoded_term(struct parse_events_term *term);
 124int parse_events_term__num(struct parse_events_term **term,
 125                           int type_term, char *config, u64 num,
 126                           bool novalue,
 127                           void *loc_term, void *loc_val);
 128int parse_events_term__str(struct parse_events_term **term,
 129                           int type_term, char *config, char *str,
 130                           void *loc_term, void *loc_val);
 131int parse_events_term__sym_hw(struct parse_events_term **term,
 132                              char *config, unsigned idx);
 133int parse_events_term__clone(struct parse_events_term **new,
 134                             struct parse_events_term *term);
 135void parse_events_terms__delete(struct list_head *terms);
 136void parse_events_terms__purge(struct list_head *terms);
 137void parse_events__clear_array(struct parse_events_array *a);
 138int parse_events__modifier_event(struct list_head *list, char *str, bool add);
 139int parse_events__modifier_group(struct list_head *list, char *event_mod);
 140int parse_events_name(struct list_head *list, char *name);
 141int parse_events_add_tracepoint(struct list_head *list, int *idx,
 142                                const char *sys, const char *event,
 143                                struct parse_events_error *error,
 144                                struct list_head *head_config);
 145int parse_events_load_bpf(struct parse_events_evlist *data,
 146                          struct list_head *list,
 147                          char *bpf_file_name,
 148                          bool source,
 149                          struct list_head *head_config);
 150/* Provide this function for perf test */
 151struct bpf_object;
 152int parse_events_load_bpf_obj(struct parse_events_evlist *data,
 153                              struct list_head *list,
 154                              struct bpf_object *obj,
 155                              struct list_head *head_config);
 156int parse_events_add_numeric(struct parse_events_evlist *data,
 157                             struct list_head *list,
 158                             u32 type, u64 config,
 159                             struct list_head *head_config);
 160int parse_events_add_cache(struct list_head *list, int *idx,
 161                           char *type, char *op_result1, char *op_result2,
 162                           struct parse_events_error *error,
 163                           struct list_head *head_config);
 164int parse_events_add_breakpoint(struct list_head *list, int *idx,
 165                                void *ptr, char *type, u64 len);
 166int parse_events_add_pmu(struct parse_events_evlist *data,
 167                         struct list_head *list, char *name,
 168                         struct list_head *head_config);
 169enum perf_pmu_event_symbol_type
 170perf_pmu__parse_check(const char *name);
 171void parse_events__set_leader(char *name, struct list_head *list);
 172void parse_events_update_lists(struct list_head *list_event,
 173                               struct list_head *list_all);
 174void parse_events_evlist_error(struct parse_events_evlist *data,
 175                               int idx, const char *str);
 176
 177void print_events(const char *event_glob, bool name_only, bool quiet,
 178                  bool long_desc);
 179
 180struct event_symbol {
 181        const char      *symbol;
 182        const char      *alias;
 183};
 184extern struct event_symbol event_symbols_hw[];
 185extern struct event_symbol event_symbols_sw[];
 186void print_symbol_events(const char *event_glob, unsigned type,
 187                                struct event_symbol *syms, unsigned max,
 188                                bool name_only);
 189void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
 190                             bool name_only);
 191int print_hwcache_events(const char *event_glob, bool name_only);
 192void print_sdt_events(const char *subsys_glob, const char *event_glob,
 193                      bool name_only);
 194int is_valid_tracepoint(const char *event_string);
 195
 196int valid_event_mount(const char *eventfs);
 197char *parse_events_formats_error_string(char *additional_terms);
 198
 199#endif /* __PERF_PARSE_EVENTS_H */
 200