Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __PERF_PARSE_EVENTS_H
3#define __PERF_PARSE_EVENTS_H
4/*
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, struct perf_pmu *fake_pmu,
35 bool warn_if_reordered);
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=*/NULL,
42 /*warn_if_reordered=*/true);
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 term
90 * "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 a
95 * 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_USER
105 * 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 during
110 * error output.
111 */
112 int err_term;
113 /**
114 * @err_val: The column index of the val from parsing, used during error
115 * 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 that
122 * 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 the
127 * 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 int num_errors; /* number of errors encountered */
134 int idx; /* index in the parsed string */
135 char *str; /* string to display at the index */
136 char *help; /* optional help string */
137 int first_idx;/* as above, but for the first encountered error */
138 char *first_str;
139 char *first_help;
140};
141
142/* A wrapper around a list of terms for the sake of better type safety. */
143struct parse_events_terms {
144 struct list_head terms;
145};
146
147struct parse_events_state {
148 /* The list parsed events are placed on. */
149 struct list_head list;
150 /* The updated index used by entries as they are added. */
151 int idx;
152 /* Error information. */
153 struct parse_events_error *error;
154 /* Holds returned terms for term parsing. */
155 struct parse_events_terms *terms;
156 /* Start token. */
157 int stoken;
158 /* Special fake PMU marker for testing. */
159 struct perf_pmu *fake_pmu;
160 /* If non-null, when wildcard matching only match the given PMU. */
161 const char *pmu_filter;
162 /* Should PE_LEGACY_NAME tokens be generated for config terms? */
163 bool match_legacy_cache_terms;
164 /* Were multiple PMUs scanned to find events? */
165 bool wild_card_pmus;
166};
167
168bool parse_events__filter_pmu(const struct parse_events_state *parse_state,
169 const struct perf_pmu *pmu);
170void parse_events__shrink_config_terms(void);
171int parse_events__is_hardcoded_term(struct parse_events_term *term);
172int parse_events_term__num(struct parse_events_term **term,
173 enum parse_events__term_type type_term,
174 const char *config, u64 num,
175 bool novalue,
176 void *loc_term, void *loc_val);
177int parse_events_term__str(struct parse_events_term **term,
178 enum parse_events__term_type type_term,
179 char *config, char *str,
180 void *loc_term, void *loc_val);
181int parse_events_term__term(struct parse_events_term **term,
182 enum parse_events__term_type term_lhs,
183 enum parse_events__term_type term_rhs,
184 void *loc_term, void *loc_val);
185int parse_events_term__clone(struct parse_events_term **new,
186 struct parse_events_term *term);
187void parse_events_term__delete(struct parse_events_term *term);
188
189void parse_events_terms__delete(struct parse_events_terms *terms);
190void parse_events_terms__init(struct parse_events_terms *terms);
191void parse_events_terms__exit(struct parse_events_terms *terms);
192int parse_events_terms(struct parse_events_terms *terms, const char *str, FILE *input);
193int parse_events_terms__to_strbuf(const struct parse_events_terms *terms, struct strbuf *sb);
194int parse_events__modifier_event(struct list_head *list, char *str, bool add);
195int parse_events__modifier_group(struct list_head *list, char *event_mod);
196int parse_events_name(struct list_head *list, const char *name);
197int parse_events_add_tracepoint(struct list_head *list, int *idx,
198 const char *sys, const char *event,
199 struct parse_events_error *error,
200 struct parse_events_terms *head_config, void *loc);
201int parse_events_add_numeric(struct parse_events_state *parse_state,
202 struct list_head *list,
203 u32 type, u64 config,
204 struct parse_events_terms *head_config,
205 bool wildcard);
206int parse_events_add_tool(struct parse_events_state *parse_state,
207 struct list_head *list,
208 int tool_event);
209int parse_events_add_cache(struct list_head *list, int *idx, const char *name,
210 struct parse_events_state *parse_state,
211 struct parse_events_terms *head_config);
212int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config);
213int parse_events_add_breakpoint(struct parse_events_state *parse_state,
214 struct list_head *list,
215 u64 addr, char *type, u64 len,
216 struct parse_events_terms *head_config);
217int parse_events_add_pmu(struct parse_events_state *parse_state,
218 struct list_head *list, const char *name,
219 const struct parse_events_terms *const_parsed_terms,
220 bool auto_merge_stats, void *loc);
221
222struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
223 const char *name, const char *metric_id,
224 struct perf_pmu *pmu);
225
226int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
227 const char *event_name,
228 const struct parse_events_terms *const_parsed_terms,
229 struct list_head **listp, void *loc);
230
231void parse_events__set_leader(char *name, struct list_head *list);
232void parse_events_update_lists(struct list_head *list_event,
233 struct list_head *list_all);
234void parse_events_evlist_error(struct parse_events_state *parse_state,
235 int idx, const char *str);
236
237struct event_symbol {
238 const char *symbol;
239 const char *alias;
240};
241extern struct event_symbol event_symbols_hw[];
242extern struct event_symbol event_symbols_sw[];
243
244char *parse_events_formats_error_string(char *additional_terms);
245
246void parse_events_error__init(struct parse_events_error *err);
247void parse_events_error__exit(struct parse_events_error *err);
248void parse_events_error__handle(struct parse_events_error *err, int idx,
249 char *str, char *help);
250void parse_events_error__print(struct parse_events_error *err,
251 const char *event);
252
253#ifdef HAVE_LIBELF_SUPPORT
254/*
255 * If the probe point starts with '%',
256 * or starts with "sdt_" and has a ':' but no '=',
257 * then it should be a SDT/cached probe point.
258 */
259static inline bool is_sdt_event(char *str)
260{
261 return (str[0] == '%' ||
262 (!strncmp(str, "sdt_", 4) &&
263 !!strchr(str, ':') && !strchr(str, '=')));
264}
265#else
266static inline bool is_sdt_event(char *str __maybe_unused)
267{
268 return false;
269}
270#endif /* HAVE_LIBELF_SUPPORT */
271
272#endif /* __PERF_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 "types.h"
10#include <linux/perf_event.h>
11#include "types.h"
12
13struct list_head;
14struct perf_evsel;
15struct perf_evlist;
16
17struct option;
18
19struct tracepoint_path {
20 char *system;
21 char *name;
22 struct tracepoint_path *next;
23};
24
25extern struct tracepoint_path *tracepoint_id_to_path(u64 config);
26extern struct tracepoint_path *tracepoint_name_to_path(const char *name);
27extern bool have_tracepoints(struct list_head *evlist);
28
29const char *event_type(int type);
30
31extern int parse_events_option(const struct option *opt, const char *str,
32 int unset);
33extern int parse_events(struct perf_evlist *evlist, const char *str);
34extern int parse_events_terms(struct list_head *terms, const char *str);
35extern int parse_filter(const struct option *opt, const char *str, int unset);
36
37#define EVENTS_HELP_MAX (128*1024)
38
39enum {
40 PARSE_EVENTS__TERM_TYPE_NUM,
41 PARSE_EVENTS__TERM_TYPE_STR,
42};
43
44enum {
45 PARSE_EVENTS__TERM_TYPE_USER,
46 PARSE_EVENTS__TERM_TYPE_CONFIG,
47 PARSE_EVENTS__TERM_TYPE_CONFIG1,
48 PARSE_EVENTS__TERM_TYPE_CONFIG2,
49 PARSE_EVENTS__TERM_TYPE_NAME,
50 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
51 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
52};
53
54struct parse_events_term {
55 char *config;
56 union {
57 char *str;
58 u64 num;
59 } val;
60 int type_val;
61 int type_term;
62 struct list_head list;
63};
64
65struct parse_events_evlist {
66 struct list_head list;
67 int idx;
68 int nr_groups;
69};
70
71struct parse_events_terms {
72 struct list_head *terms;
73};
74
75int parse_events__is_hardcoded_term(struct parse_events_term *term);
76int parse_events_term__num(struct parse_events_term **_term,
77 int type_term, char *config, u64 num);
78int parse_events_term__str(struct parse_events_term **_term,
79 int type_term, char *config, char *str);
80int parse_events_term__sym_hw(struct parse_events_term **term,
81 char *config, unsigned idx);
82int parse_events_term__clone(struct parse_events_term **new,
83 struct parse_events_term *term);
84void parse_events__free_terms(struct list_head *terms);
85int parse_events__modifier_event(struct list_head *list, char *str, bool add);
86int parse_events__modifier_group(struct list_head *list, char *event_mod);
87int parse_events_name(struct list_head *list, char *name);
88int parse_events_add_tracepoint(struct list_head *list, int *idx,
89 char *sys, char *event);
90int parse_events_add_numeric(struct list_head *list, int *idx,
91 u32 type, u64 config,
92 struct list_head *head_config);
93int parse_events_add_cache(struct list_head *list, int *idx,
94 char *type, char *op_result1, char *op_result2);
95int parse_events_add_breakpoint(struct list_head *list, int *idx,
96 void *ptr, char *type);
97int parse_events_add_pmu(struct list_head *list, int *idx,
98 char *pmu , struct list_head *head_config);
99void parse_events__set_leader(char *name, struct list_head *list);
100void parse_events_update_lists(struct list_head *list_event,
101 struct list_head *list_all);
102void parse_events_error(void *data, void *scanner, char const *msg);
103
104void print_events(const char *event_glob, bool name_only);
105void print_events_type(u8 type);
106void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
107 bool name_only);
108int print_hwcache_events(const char *event_glob, bool name_only);
109extern int is_valid_tracepoint(const char *event_string);
110
111extern int valid_debugfs_mount(const char *debugfs);
112
113#endif /* __PERF_PARSE_EVENTS_H */