perf/util/parse-events.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef __PERF_PARSE_EVENTS_H
0003 #define __PERF_PARSE_EVENTS_H
0004 /*
0005  * Parse symbolic events/counts passed in as options:
0006  */
0007
0008 #include <linux/list.h>
0009 #include <stdbool.h>
0010 #include <linux/types.h>
0011 #include <linux/perf_event.h>
0012 #include <string.h>
0013
0014 struct evsel;
0015 struct evlist;
0016 struct parse_events_error;
0017
0018 struct option;
0019 struct perf_pmu;
0020
0021 bool have_tracepoints(struct list_head *evlist);
0022 bool is_event_supported(u8 type, u64 config);
0023
0024 const char *event_type(int type);
0025
0026 int parse_events_option(const struct option *opt, const char *str, int unset);
0027 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset);
0028 __attribute__((nonnull(1, 2, 3)))
0029 int __parse_events(struct evlist *evlist, const char *str, struct parse_events_error *error,
0030            struct perf_pmu *fake_pmu);
0031
0032 __attribute__((nonnull))
0033 static inline int parse_events(struct evlist *evlist, const char *str,
0034                    struct parse_events_error *err)
0035 {
0036     return __parse_events(evlist, str, err, NULL);
0037 }
0038
0039 int parse_event(struct evlist *evlist, const char *str);
0040
0041 int parse_events_terms(struct list_head *terms, const char *str);
0042 int parse_filter(const struct option *opt, const char *str, int unset);
0043 int exclude_perf(const struct option *opt, const char *arg, int unset);
0044
0045 enum perf_pmu_event_symbol_type {
0046     PMU_EVENT_SYMBOL_ERR,       /* not a PMU EVENT */
0047     PMU_EVENT_SYMBOL,       /* normal style PMU event */
0048     PMU_EVENT_SYMBOL_PREFIX,    /* prefix of pre-suf style event */
0049     PMU_EVENT_SYMBOL_SUFFIX,    /* suffix of pre-suf style event */
0050     PMU_EVENT_SYMBOL_SUFFIX2,   /* suffix of pre-suf2 style event */
0051 };
0052
0053 enum {
0054     PARSE_EVENTS__TERM_TYPE_NUM,
0055     PARSE_EVENTS__TERM_TYPE_STR,
0056 };
0057
0058 enum {
0059     PARSE_EVENTS__TERM_TYPE_USER,
0060     PARSE_EVENTS__TERM_TYPE_CONFIG,
0061     PARSE_EVENTS__TERM_TYPE_CONFIG1,
0062     PARSE_EVENTS__TERM_TYPE_CONFIG2,
0063     PARSE_EVENTS__TERM_TYPE_NAME,
0064     PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
0065     PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
0066     PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
0067     PARSE_EVENTS__TERM_TYPE_TIME,
0068     PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
0069     PARSE_EVENTS__TERM_TYPE_STACKSIZE,
0070     PARSE_EVENTS__TERM_TYPE_NOINHERIT,
0071     PARSE_EVENTS__TERM_TYPE_INHERIT,
0072     PARSE_EVENTS__TERM_TYPE_MAX_STACK,
0073     PARSE_EVENTS__TERM_TYPE_MAX_EVENTS,
0074     PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,
0075     PARSE_EVENTS__TERM_TYPE_OVERWRITE,
0076     PARSE_EVENTS__TERM_TYPE_DRV_CFG,
0077     PARSE_EVENTS__TERM_TYPE_PERCORE,
0078     PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT,
0079     PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE,
0080     PARSE_EVENTS__TERM_TYPE_METRIC_ID,
0081     __PARSE_EVENTS__TERM_TYPE_NR,
0082 };
0083
0084 struct parse_events_array {
0085     size_t nr_ranges;
0086     struct {
0087         unsigned int start;
0088         size_t length;
0089     } *ranges;
0090 };
0091
0092 struct parse_events_term {
0093     char *config;
0094     struct parse_events_array array;
0095     union {
0096         char *str;
0097         u64  num;
0098     } val;
0099     int type_val;
0100     int type_term;
0101     struct list_head list;
0102     bool used;
0103     bool no_value;
0104
0105     /* error string indexes for within parsed string */
0106     int err_term;
0107     int err_val;
0108
0109     /* Coming from implicit alias */
0110     bool weak;
0111 };
0112
0113 struct parse_events_error {
0114     int   num_errors;       /* number of errors encountered */
0115     int   idx;  /* index in the parsed string */
0116     char *str;      /* string to display at the index */
0117     char *help; /* optional help string */
0118     int   first_idx;/* as above, but for the first encountered error */
0119     char *first_str;
0120     char *first_help;
0121 };
0122
0123 struct parse_events_state {
0124     struct list_head       list;
0125     int            idx;
0126     int            nr_groups;
0127     struct parse_events_error *error;
0128     struct evlist         *evlist;
0129     struct list_head      *terms;
0130     int            stoken;
0131     struct perf_pmu       *fake_pmu;
0132     char              *hybrid_pmu_name;
0133 };
0134
0135 void parse_events__shrink_config_terms(void);
0136 int parse_events__is_hardcoded_term(struct parse_events_term *term);
0137 int parse_events_term__num(struct parse_events_term **term,
0138                int type_term, char *config, u64 num,
0139                bool novalue,
0140                void *loc_term, void *loc_val);
0141 int parse_events_term__str(struct parse_events_term **term,
0142                int type_term, char *config, char *str,
0143                void *loc_term, void *loc_val);
0144 int parse_events_term__sym_hw(struct parse_events_term **term,
0145                   char *config, unsigned idx);
0146 int parse_events_term__clone(struct parse_events_term **new,
0147                  struct parse_events_term *term);
0148 void parse_events_term__delete(struct parse_events_term *term);
0149 void parse_events_terms__delete(struct list_head *terms);
0150 void parse_events_terms__purge(struct list_head *terms);
0151 void parse_events__clear_array(struct parse_events_array *a);
0152 int parse_events__modifier_event(struct list_head *list, char *str, bool add);
0153 int parse_events__modifier_group(struct list_head *list, char *event_mod);
0154 int parse_events_name(struct list_head *list, const char *name);
0155 int parse_events_add_tracepoint(struct list_head *list, int *idx,
0156                 const char *sys, const char *event,
0157                 struct parse_events_error *error,
0158                 struct list_head *head_config);
0159 int parse_events_load_bpf(struct parse_events_state *parse_state,
0160               struct list_head *list,
0161               char *bpf_file_name,
0162               bool source,
0163               struct list_head *head_config);
0164 /* Provide this function for perf test */
0165 struct bpf_object;
0166 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
0167                   struct list_head *list,
0168                   struct bpf_object *obj,
0169                   struct list_head *head_config);
0170 int parse_events_add_numeric(struct parse_events_state *parse_state,
0171                  struct list_head *list,
0172                  u32 type, u64 config,
0173                  struct list_head *head_config);
0174 int parse_events_add_tool(struct parse_events_state *parse_state,
0175               struct list_head *list,
0176               int tool_event);
0177 int parse_events_add_cache(struct list_head *list, int *idx,
0178                char *type, char *op_result1, char *op_result2,
0179                struct parse_events_error *error,
0180                struct list_head *head_config,
0181                struct parse_events_state *parse_state);
0182 int parse_events_add_breakpoint(struct list_head *list, int *idx,
0183                 u64 addr, char *type, u64 len);
0184 int parse_events_add_pmu(struct parse_events_state *parse_state,
0185              struct list_head *list, char *name,
0186              struct list_head *head_config,
0187              bool auto_merge_stats,
0188              bool use_alias);
0189
0190 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
0191                       const char *name, const char *metric_id,
0192                       struct perf_pmu *pmu);
0193
0194 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
0195                    char *str,
0196                    struct list_head *head_config,
0197                    struct list_head **listp);
0198
0199 int parse_events_copy_term_list(struct list_head *old,
0200                  struct list_head **new);
0201
0202 enum perf_pmu_event_symbol_type
0203 perf_pmu__parse_check(const char *name);
0204 void parse_events__set_leader(char *name, struct list_head *list,
0205                   struct parse_events_state *parse_state);
0206 void parse_events_update_lists(struct list_head *list_event,
0207                    struct list_head *list_all);
0208 void parse_events_evlist_error(struct parse_events_state *parse_state,
0209                    int idx, const char *str);
0210
0211 struct event_symbol {
0212     const char  *symbol;
0213     const char  *alias;
0214 };
0215 extern struct event_symbol event_symbols_hw[];
0216 extern struct event_symbol event_symbols_sw[];
0217
0218 char *parse_events_formats_error_string(char *additional_terms);
0219
0220 void parse_events_error__init(struct parse_events_error *err);
0221 void parse_events_error__exit(struct parse_events_error *err);
0222 void parse_events_error__handle(struct parse_events_error *err, int idx,
0223                 char *str, char *help);
0224 void parse_events_error__print(struct parse_events_error *err,
0225                    const char *event);
0226
0227 #ifdef HAVE_LIBELF_SUPPORT
0228 /*
0229  * If the probe point starts with '%',
0230  * or starts with "sdt_" and has a ':' but no '=',
0231  * then it should be a SDT/cached probe point.
0232  */
0233 static inline bool is_sdt_event(char *str)
0234 {
0235     return (str[0] == '%' ||
0236         (!strncmp(str, "sdt_", 4) &&
0237          !!strchr(str, ':') && !strchr(str, '=')));
0238 }
0239 #else
0240 static inline bool is_sdt_event(char *str __maybe_unused)
0241 {
0242     return false;
0243 }
0244 #endif /* HAVE_LIBELF_SUPPORT */
0245
0246 int perf_pmu__test_parse_init(void);
0247
0248 struct evsel *parse_events__add_event_hybrid(struct list_head *list, int *idx,
0249                          struct perf_event_attr *attr,
0250                          const char *name,
0251                          const char *metric_id,
0252                          struct perf_pmu *pmu,
0253                          struct list_head *config_terms);
0254
0255 #endif /* __PERF_PARSE_EVENTS_H */