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