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