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