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