xref: /openbmc/linux/tools/perf/util/evlist.h (revision 827634ad)
1 #ifndef __PERF_EVLIST_H
2 #define __PERF_EVLIST_H 1
3 
4 #include <linux/list.h>
5 #include <api/fd/array.h>
6 #include <stdio.h>
7 #include "../perf.h"
8 #include "event.h"
9 #include "evsel.h"
10 #include "util.h"
11 #include "auxtrace.h"
12 #include <unistd.h>
13 
14 struct pollfd;
15 struct thread_map;
16 struct cpu_map;
17 struct record_opts;
18 
19 #define PERF_EVLIST__HLIST_BITS 8
20 #define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
21 
22 /**
23  * struct perf_mmap - perf's ring buffer mmap details
24  *
25  * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
26  */
27 struct perf_mmap {
28 	void		 *base;
29 	int		 mask;
30 	int		 refcnt;
31 	u64		 prev;
32 	struct auxtrace_mmap auxtrace_mmap;
33 	char		 event_copy[PERF_SAMPLE_MAX_SIZE] __attribute__((aligned(8)));
34 };
35 
36 struct perf_evlist {
37 	struct list_head entries;
38 	struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
39 	int		 nr_entries;
40 	int		 nr_groups;
41 	int		 nr_mmaps;
42 	size_t		 mmap_len;
43 	int		 id_pos;
44 	int		 is_pos;
45 	u64		 combined_sample_type;
46 	struct {
47 		int	cork_fd;
48 		pid_t	pid;
49 	} workload;
50 	bool		 overwrite;
51 	struct fdarray	 pollfd;
52 	struct perf_mmap *mmap;
53 	struct thread_map *threads;
54 	struct cpu_map	  *cpus;
55 	struct perf_evsel *selected;
56 	struct events_stats stats;
57 };
58 
59 struct perf_evsel_str_handler {
60 	const char *name;
61 	void	   *handler;
62 };
63 
64 struct perf_evlist *perf_evlist__new(void);
65 struct perf_evlist *perf_evlist__new_default(void);
66 void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
67 		       struct thread_map *threads);
68 void perf_evlist__exit(struct perf_evlist *evlist);
69 void perf_evlist__delete(struct perf_evlist *evlist);
70 
71 void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
72 int perf_evlist__add_default(struct perf_evlist *evlist);
73 int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
74 				     struct perf_event_attr *attrs, size_t nr_attrs);
75 
76 #define perf_evlist__add_default_attrs(evlist, array) \
77 	__perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
78 
79 int perf_evlist__add_newtp(struct perf_evlist *evlist,
80 			   const char *sys, const char *name, void *handler);
81 
82 int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
83 int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid);
84 int perf_evlist__set_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids);
85 
86 struct perf_evsel *
87 perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
88 
89 struct perf_evsel *
90 perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
91 				     const char *name);
92 
93 void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
94 			 int cpu, int thread, u64 id);
95 
96 int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
97 int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
98 int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);
99 
100 int perf_evlist__poll(struct perf_evlist *evlist, int timeout);
101 
102 struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
103 
104 struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);
105 
106 union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx);
107 
108 void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);
109 
110 int perf_evlist__open(struct perf_evlist *evlist);
111 void perf_evlist__close(struct perf_evlist *evlist);
112 
113 void perf_evlist__set_id_pos(struct perf_evlist *evlist);
114 bool perf_can_sample_identifier(void);
115 void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts);
116 int record_opts__config(struct record_opts *opts);
117 
118 int perf_evlist__prepare_workload(struct perf_evlist *evlist,
119 				  struct target *target,
120 				  const char *argv[], bool pipe_output,
121 				  void (*exec_error)(int signo, siginfo_t *info,
122 						     void *ucontext));
123 int perf_evlist__start_workload(struct perf_evlist *evlist);
124 
125 struct option;
126 
127 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
128 int perf_evlist__parse_mmap_pages(const struct option *opt,
129 				  const char *str,
130 				  int unset);
131 
132 int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,
133 			 bool overwrite, unsigned int auxtrace_pages,
134 			 bool auxtrace_overwrite);
135 int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
136 		      bool overwrite);
137 void perf_evlist__munmap(struct perf_evlist *evlist);
138 
139 void perf_evlist__disable(struct perf_evlist *evlist);
140 void perf_evlist__enable(struct perf_evlist *evlist);
141 
142 int perf_evlist__disable_event(struct perf_evlist *evlist,
143 			       struct perf_evsel *evsel);
144 int perf_evlist__enable_event(struct perf_evlist *evlist,
145 			      struct perf_evsel *evsel);
146 int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
147 				  struct perf_evsel *evsel, int idx);
148 
149 void perf_evlist__set_selected(struct perf_evlist *evlist,
150 			       struct perf_evsel *evsel);
151 
152 static inline void perf_evlist__set_maps(struct perf_evlist *evlist,
153 					 struct cpu_map *cpus,
154 					 struct thread_map *threads)
155 {
156 	evlist->cpus	= cpus;
157 	evlist->threads	= threads;
158 }
159 
160 int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
161 int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel);
162 
163 void __perf_evlist__set_leader(struct list_head *list);
164 void perf_evlist__set_leader(struct perf_evlist *evlist);
165 
166 u64 perf_evlist__read_format(struct perf_evlist *evlist);
167 u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
168 u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
169 bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
170 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
171 
172 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
173 			      struct perf_sample *sample);
174 
175 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
176 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
177 bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
178 
179 void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
180 				   struct list_head *list,
181 				   int nr_entries);
182 
183 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
184 {
185 	return list_entry(evlist->entries.next, struct perf_evsel, node);
186 }
187 
188 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
189 {
190 	return list_entry(evlist->entries.prev, struct perf_evsel, node);
191 }
192 
193 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
194 
195 int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
196 int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size);
197 
198 static inline u64 perf_mmap__read_head(struct perf_mmap *mm)
199 {
200 	struct perf_event_mmap_page *pc = mm->base;
201 	u64 head = ACCESS_ONCE(pc->data_head);
202 	rmb();
203 	return head;
204 }
205 
206 static inline void perf_mmap__write_tail(struct perf_mmap *md, u64 tail)
207 {
208 	struct perf_event_mmap_page *pc = md->base;
209 
210 	/*
211 	 * ensure all reads are done before we write the tail out.
212 	 */
213 	mb();
214 	pc->data_tail = tail;
215 }
216 
217 bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
218 void perf_evlist__to_front(struct perf_evlist *evlist,
219 			   struct perf_evsel *move_evsel);
220 
221 /**
222  * __evlist__for_each - iterate thru all the evsels
223  * @list: list_head instance to iterate
224  * @evsel: struct evsel iterator
225  */
226 #define __evlist__for_each(list, evsel) \
227         list_for_each_entry(evsel, list, node)
228 
229 /**
230  * evlist__for_each - iterate thru all the evsels
231  * @evlist: evlist instance to iterate
232  * @evsel: struct evsel iterator
233  */
234 #define evlist__for_each(evlist, evsel) \
235 	__evlist__for_each(&(evlist)->entries, evsel)
236 
237 /**
238  * __evlist__for_each_continue - continue iteration thru all the evsels
239  * @list: list_head instance to iterate
240  * @evsel: struct evsel iterator
241  */
242 #define __evlist__for_each_continue(list, evsel) \
243         list_for_each_entry_continue(evsel, list, node)
244 
245 /**
246  * evlist__for_each_continue - continue iteration thru all the evsels
247  * @evlist: evlist instance to iterate
248  * @evsel: struct evsel iterator
249  */
250 #define evlist__for_each_continue(evlist, evsel) \
251 	__evlist__for_each_continue(&(evlist)->entries, evsel)
252 
253 /**
254  * __evlist__for_each_reverse - iterate thru all the evsels in reverse order
255  * @list: list_head instance to iterate
256  * @evsel: struct evsel iterator
257  */
258 #define __evlist__for_each_reverse(list, evsel) \
259         list_for_each_entry_reverse(evsel, list, node)
260 
261 /**
262  * evlist__for_each_reverse - iterate thru all the evsels in reverse order
263  * @evlist: evlist instance to iterate
264  * @evsel: struct evsel iterator
265  */
266 #define evlist__for_each_reverse(evlist, evsel) \
267 	__evlist__for_each_reverse(&(evlist)->entries, evsel)
268 
269 /**
270  * __evlist__for_each_safe - safely iterate thru all the evsels
271  * @list: list_head instance to iterate
272  * @tmp: struct evsel temp iterator
273  * @evsel: struct evsel iterator
274  */
275 #define __evlist__for_each_safe(list, tmp, evsel) \
276         list_for_each_entry_safe(evsel, tmp, list, node)
277 
278 /**
279  * evlist__for_each_safe - safely iterate thru all the evsels
280  * @evlist: evlist instance to iterate
281  * @evsel: struct evsel iterator
282  * @tmp: struct evsel temp iterator
283  */
284 #define evlist__for_each_safe(evlist, tmp, evsel) \
285 	__evlist__for_each_safe(&(evlist)->entries, tmp, evsel)
286 
287 void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
288 				     struct perf_evsel *tracking_evsel);
289 
290 #endif /* __PERF_EVLIST_H */
291