292 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2#ifndef __PERF_PARSE_EVENTS_H3#define __PERF_PARSE_EVENTS_H4/*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 <stdio.h>13#include <string.h>14 15struct evsel;16struct evlist;17struct parse_events_error;18 19struct option;20struct perf_pmu;21struct strbuf;22 23const char *event_type(int type);24 25/* Arguments encoded in opt->value. */26struct parse_events_option_args {27 struct evlist **evlistp;28 const char *pmu_filter;29};30int parse_events_option(const struct option *opt, const char *str, int unset);31int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset);32__attribute__((nonnull(1, 2, 4)))33int __parse_events(struct evlist *evlist, const char *str, const char *pmu_filter,34 struct parse_events_error *error, bool fake_pmu,35 bool warn_if_reordered, bool fake_tp);36 37__attribute__((nonnull(1, 2, 3)))38static inline int parse_events(struct evlist *evlist, const char *str,39 struct parse_events_error *err)40{41 return __parse_events(evlist, str, /*pmu_filter=*/NULL, err, /*fake_pmu=*/false,42 /*warn_if_reordered=*/true, /*fake_tp=*/false);43}44 45int parse_event(struct evlist *evlist, const char *str);46 47int parse_filter(const struct option *opt, const char *str, int unset);48int exclude_perf(const struct option *opt, const char *arg, int unset);49 50enum parse_events__term_val_type {51 PARSE_EVENTS__TERM_TYPE_NUM,52 PARSE_EVENTS__TERM_TYPE_STR,53};54 55enum parse_events__term_type {56 PARSE_EVENTS__TERM_TYPE_USER,57 PARSE_EVENTS__TERM_TYPE_CONFIG,58 PARSE_EVENTS__TERM_TYPE_CONFIG1,59 PARSE_EVENTS__TERM_TYPE_CONFIG2,60 PARSE_EVENTS__TERM_TYPE_CONFIG3,61 PARSE_EVENTS__TERM_TYPE_NAME,62 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,63 PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,64 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,65 PARSE_EVENTS__TERM_TYPE_TIME,66 PARSE_EVENTS__TERM_TYPE_CALLGRAPH,67 PARSE_EVENTS__TERM_TYPE_STACKSIZE,68 PARSE_EVENTS__TERM_TYPE_NOINHERIT,69 PARSE_EVENTS__TERM_TYPE_INHERIT,70 PARSE_EVENTS__TERM_TYPE_MAX_STACK,71 PARSE_EVENTS__TERM_TYPE_MAX_EVENTS,72 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,73 PARSE_EVENTS__TERM_TYPE_OVERWRITE,74 PARSE_EVENTS__TERM_TYPE_DRV_CFG,75 PARSE_EVENTS__TERM_TYPE_PERCORE,76 PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT,77 PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE,78 PARSE_EVENTS__TERM_TYPE_METRIC_ID,79 PARSE_EVENTS__TERM_TYPE_RAW,80 PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE,81 PARSE_EVENTS__TERM_TYPE_HARDWARE,82#define __PARSE_EVENTS__TERM_TYPE_NR (PARSE_EVENTS__TERM_TYPE_HARDWARE + 1)83};84 85struct parse_events_term {86 /** @list: The term list the term is a part of. */87 struct list_head list;88 /**89 * @config: The left-hand side of a term assignment, so the term90 * "event=8" would have the config be "event"91 */92 const char *config;93 /**94 * @val: The right-hand side of a term assignment that can either be a95 * string or a number depending on type_val.96 */97 union {98 char *str;99 u64 num;100 } val;101 /** @type_val: The union variable in val to be used for the term. */102 enum parse_events__term_val_type type_val;103 /**104 * @type_term: A predefined term type or PARSE_EVENTS__TERM_TYPE_USER105 * when not inbuilt.106 */107 enum parse_events__term_type type_term;108 /**109 * @err_term: The column index of the term from parsing, used during110 * error output.111 */112 int err_term;113 /**114 * @err_val: The column index of the val from parsing, used during error115 * output.116 */117 int err_val;118 /** @used: Was the term used during parameterized-eval. */119 bool used;120 /**121 * @weak: A term from the sysfs or json encoding of an event that122 * shouldn't override terms coming from the command line.123 */124 bool weak;125 /**126 * @no_value: Is there no value. If a numeric term has no value then the127 * value is assumed to be 1. An event name also has no value.128 */129 bool no_value;130};131 132struct parse_events_error {133 /** @list: The head of a list of errors. */134 struct list_head list;135};136 137/* A wrapper around a list of terms for the sake of better type safety. */138struct parse_events_terms {139 struct list_head terms;140};141 142struct parse_events_state {143 /* The list parsed events are placed on. */144 struct list_head list;145 /* The updated index used by entries as they are added. */146 int idx;147 /* Error information. */148 struct parse_events_error *error;149 /* Holds returned terms for term parsing. */150 struct parse_events_terms *terms;151 /* Start token. */152 int stoken;153 /* Use the fake PMU marker for testing. */154 bool fake_pmu;155 /* Skip actual tracepoint processing for testing. */156 bool fake_tp;157 /* If non-null, when wildcard matching only match the given PMU. */158 const char *pmu_filter;159 /* Should PE_LEGACY_NAME tokens be generated for config terms? */160 bool match_legacy_cache_terms;161 /* Were multiple PMUs scanned to find events? */162 bool wild_card_pmus;163};164 165bool parse_events__filter_pmu(const struct parse_events_state *parse_state,166 const struct perf_pmu *pmu);167void parse_events__shrink_config_terms(void);168int parse_events__is_hardcoded_term(struct parse_events_term *term);169int parse_events_term__num(struct parse_events_term **term,170 enum parse_events__term_type type_term,171 const char *config, u64 num,172 bool novalue,173 void *loc_term, void *loc_val);174int parse_events_term__str(struct parse_events_term **term,175 enum parse_events__term_type type_term,176 char *config, char *str,177 void *loc_term, void *loc_val);178int parse_events_term__term(struct parse_events_term **term,179 enum parse_events__term_type term_lhs,180 enum parse_events__term_type term_rhs,181 void *loc_term, void *loc_val);182int parse_events_term__clone(struct parse_events_term **new,183 const struct parse_events_term *term);184void parse_events_term__delete(struct parse_events_term *term);185 186void parse_events_terms__delete(struct parse_events_terms *terms);187void parse_events_terms__init(struct parse_events_terms *terms);188void parse_events_terms__exit(struct parse_events_terms *terms);189int parse_events_terms(struct parse_events_terms *terms, const char *str, FILE *input);190int parse_events_terms__to_strbuf(const struct parse_events_terms *terms, struct strbuf *sb);191 192struct parse_events_modifier {193 u8 precise; /* Number of repeated 'p' for precision. */194 bool precise_max : 1; /* 'P' */195 bool non_idle : 1; /* 'I' */196 bool sample_read : 1; /* 'S' */197 bool pinned : 1; /* 'D' */198 bool exclusive : 1; /* 'e' */199 bool weak : 1; /* 'W' */200 bool bpf : 1; /* 'b' */201 bool user : 1; /* 'u' */202 bool kernel : 1; /* 'k' */203 bool hypervisor : 1; /* 'h' */204 bool guest : 1; /* 'G' */205 bool host : 1; /* 'H' */206 bool retire_lat : 1; /* 'R' */207};208 209int parse_events__modifier_event(struct parse_events_state *parse_state, void *loc,210 struct list_head *list, struct parse_events_modifier mod);211int parse_events__modifier_group(struct parse_events_state *parse_state, void *loc,212 struct list_head *list, struct parse_events_modifier mod);213int parse_events__set_default_name(struct list_head *list, char *name);214int parse_events_add_tracepoint(struct parse_events_state *parse_state,215 struct list_head *list,216 const char *sys, const char *event,217 struct parse_events_error *error,218 struct parse_events_terms *head_config, void *loc);219int parse_events_add_numeric(struct parse_events_state *parse_state,220 struct list_head *list,221 u32 type, u64 config,222 const struct parse_events_terms *head_config,223 bool wildcard);224int parse_events_add_tool(struct parse_events_state *parse_state,225 struct list_head *list,226 int tool_event);227int parse_events_add_cache(struct list_head *list, int *idx, const char *name,228 struct parse_events_state *parse_state,229 struct parse_events_terms *parsed_terms);230int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config);231int parse_events_add_breakpoint(struct parse_events_state *parse_state,232 struct list_head *list,233 u64 addr, char *type, u64 len,234 struct parse_events_terms *head_config);235 236struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,237 const char *name, const char *metric_id,238 struct perf_pmu *pmu);239 240int parse_events_multi_pmu_add(struct parse_events_state *parse_state,241 const char *event_name,242 const struct parse_events_terms *const_parsed_terms,243 struct list_head **listp, void *loc);244 245int parse_events_multi_pmu_add_or_add_pmu(struct parse_events_state *parse_state,246 const char *event_or_pmu,247 const struct parse_events_terms *const_parsed_terms,248 struct list_head **listp,249 void *loc_);250 251void parse_events__set_leader(char *name, struct list_head *list);252 253struct event_symbol {254 const char *symbol;255 const char *alias;256};257extern const struct event_symbol event_symbols_hw[];258extern const struct event_symbol event_symbols_sw[];259 260char *parse_events_formats_error_string(char *additional_terms);261 262void parse_events_error__init(struct parse_events_error *err);263void parse_events_error__exit(struct parse_events_error *err);264void parse_events_error__handle(struct parse_events_error *err, int idx,265 char *str, char *help);266void parse_events_error__print(const struct parse_events_error *err,267 const char *event);268bool parse_events_error__contains(const struct parse_events_error *err,269 const char *needle);270#ifdef HAVE_LIBELF_SUPPORT271/*272 * If the probe point starts with '%',273 * or starts with "sdt_" and has a ':' but no '=',274 * then it should be a SDT/cached probe point.275 */276static inline bool is_sdt_event(char *str)277{278 return (str[0] == '%' ||279 (!strncmp(str, "sdt_", 4) &&280 !!strchr(str, ':') && !strchr(str, '=')));281}282#else283static inline bool is_sdt_event(char *str __maybe_unused)284{285 return false;286}287#endif /* HAVE_LIBELF_SUPPORT */288 289size_t default_breakpoint_len(void);290 291#endif /* __PERF_PARSE_EVENTS_H */292