xref: /linux/tools/perf/util/parse-events.h (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732)
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 };
71 
72 struct parse_events_term {
73 	char *config;
74 	union {
75 		char *str;
76 		u64  num;
77 	} val;
78 	int type_val;
79 	int type_term;
80 	struct list_head list;
81 	bool used;
82 
83 	/* error string indexes for within parsed string */
84 	int err_term;
85 	int err_val;
86 };
87 
88 struct parse_events_error {
89 	int   idx;	/* index in the parsed string */
90 	char *str;      /* string to display at the index */
91 	char *help;	/* optional help string */
92 };
93 
94 struct parse_events_evlist {
95 	struct list_head	   list;
96 	int			   idx;
97 	int			   nr_groups;
98 	struct parse_events_error *error;
99 };
100 
101 struct parse_events_terms {
102 	struct list_head *terms;
103 };
104 
105 int parse_events__is_hardcoded_term(struct parse_events_term *term);
106 int parse_events_term__num(struct parse_events_term **term,
107 			   int type_term, char *config, u64 num,
108 			   void *loc_term, void *loc_val);
109 int parse_events_term__str(struct parse_events_term **term,
110 			   int type_term, char *config, char *str,
111 			   void *loc_term, void *loc_val);
112 int parse_events_term__sym_hw(struct parse_events_term **term,
113 			      char *config, unsigned idx);
114 int parse_events_term__clone(struct parse_events_term **new,
115 			     struct parse_events_term *term);
116 void parse_events__free_terms(struct list_head *terms);
117 int parse_events__modifier_event(struct list_head *list, char *str, bool add);
118 int parse_events__modifier_group(struct list_head *list, char *event_mod);
119 int parse_events_name(struct list_head *list, char *name);
120 int parse_events_add_tracepoint(struct list_head *list, int *idx,
121 				char *sys, char *event);
122 int parse_events_add_numeric(struct parse_events_evlist *data,
123 			     struct list_head *list,
124 			     u32 type, u64 config,
125 			     struct list_head *head_config);
126 int parse_events_add_cache(struct list_head *list, int *idx,
127 			   char *type, char *op_result1, char *op_result2);
128 int parse_events_add_breakpoint(struct list_head *list, int *idx,
129 				void *ptr, char *type, u64 len);
130 int parse_events_add_pmu(struct parse_events_evlist *data,
131 			 struct list_head *list, char *name,
132 			 struct list_head *head_config);
133 enum perf_pmu_event_symbol_type
134 perf_pmu__parse_check(const char *name);
135 void parse_events__set_leader(char *name, struct list_head *list);
136 void parse_events_update_lists(struct list_head *list_event,
137 			       struct list_head *list_all);
138 void parse_events_evlist_error(struct parse_events_evlist *data,
139 			       int idx, const char *str);
140 
141 void print_events(const char *event_glob, bool name_only);
142 
143 struct event_symbol {
144 	const char	*symbol;
145 	const char	*alias;
146 };
147 extern struct event_symbol event_symbols_hw[];
148 extern struct event_symbol event_symbols_sw[];
149 void print_symbol_events(const char *event_glob, unsigned type,
150 				struct event_symbol *syms, unsigned max,
151 				bool name_only);
152 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
153 			     bool name_only);
154 int print_hwcache_events(const char *event_glob, bool name_only);
155 extern int is_valid_tracepoint(const char *event_string);
156 
157 int valid_event_mount(const char *eventfs);
158 
159 #endif /* __PERF_PARSE_EVENTS_H */
160