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