1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_EVLIST_H
3 #define __PERF_EVLIST_H 1
4
5 #include <linux/compiler.h>
6 #include <linux/kernel.h>
7 #include <linux/refcount.h>
8 #include <linux/list.h>
9 #include <api/fd/array.h>
10 #include <internal/evlist.h>
11 #include <internal/evsel.h>
12 #include "events_stats.h"
13 #include "evsel.h"
14 #include <pthread.h>
15 #include <signal.h>
16 #include <unistd.h>
17
18 struct pollfd;
19 struct thread_map;
20 struct perf_cpu_map;
21 struct record_opts;
22
23 /*
24 * State machine of bkw_mmap_state:
25 *
26 * .________________(forbid)_____________.
27 * | V
28 * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
29 * ^ ^ | ^ |
30 * | |__(forbid)____/ |___(forbid)___/|
31 * | |
32 * \_________________(3)_______________/
33 *
34 * NOTREADY : Backward ring buffers are not ready
35 * RUNNING : Backward ring buffers are recording
36 * DATA_PENDING : We are required to collect data from backward ring buffers
37 * EMPTY : We have collected data from backward ring buffers.
38 *
39 * (0): Setup backward ring buffer
40 * (1): Pause ring buffers for reading
41 * (2): Read from ring buffers
42 * (3): Resume ring buffers for recording
43 */
44 enum bkw_mmap_state {
45 BKW_MMAP_NOTREADY,
46 BKW_MMAP_RUNNING,
47 BKW_MMAP_DATA_PENDING,
48 BKW_MMAP_EMPTY,
49 };
50
51 struct evlist {
52 struct perf_evlist core;
53 bool enabled;
54 int id_pos;
55 int is_pos;
56 u64 combined_sample_type;
57 enum bkw_mmap_state bkw_mmap_state;
58 struct {
59 int cork_fd;
60 pid_t pid;
61 } workload;
62 struct mmap *mmap;
63 struct mmap *overwrite_mmap;
64 struct evsel *selected;
65 struct events_stats stats;
66 struct perf_env *env;
67 const char *hybrid_pmu_name;
68 void (*trace_event_sample_raw)(struct evlist *evlist,
69 union perf_event *event,
70 struct perf_sample *sample);
71 u64 first_sample_time;
72 u64 last_sample_time;
73 struct {
74 pthread_t th;
75 volatile int done;
76 } thread;
77 struct {
78 int fd; /* control file descriptor */
79 int ack; /* ack file descriptor for control commands */
80 int pos; /* index at evlist core object to check signals */
81 } ctl_fd;
82 };
83
84 struct evsel_str_handler {
85 const char *name;
86 void *handler;
87 };
88
89 struct evlist *evlist__new(void);
90 struct evlist *evlist__new_default(void);
91 struct evlist *evlist__new_dummy(void);
92 void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus,
93 struct perf_thread_map *threads);
94 void evlist__exit(struct evlist *evlist);
95 void evlist__delete(struct evlist *evlist);
96
97 void evlist__add(struct evlist *evlist, struct evsel *entry);
98 void evlist__remove(struct evlist *evlist, struct evsel *evsel);
99
100 int __evlist__add_default(struct evlist *evlist, bool precise);
101
evlist__add_default(struct evlist * evlist)102 static inline int evlist__add_default(struct evlist *evlist)
103 {
104 return __evlist__add_default(evlist, true);
105 }
106
107 int __evlist__add_default_attrs(struct evlist *evlist,
108 struct perf_event_attr *attrs, size_t nr_attrs);
109
110 int arch_evlist__add_default_attrs(struct evlist *evlist,
111 struct perf_event_attr *attrs,
112 size_t nr_attrs);
113
114 #define evlist__add_default_attrs(evlist, array) \
115 arch_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
116
117 struct evsel *arch_evlist__leader(struct list_head *list);
118
119 int evlist__add_dummy(struct evlist *evlist);
120 struct evsel *evlist__add_aux_dummy(struct evlist *evlist, bool system_wide);
evlist__add_dummy_on_all_cpus(struct evlist * evlist)121 static inline struct evsel *evlist__add_dummy_on_all_cpus(struct evlist *evlist)
122 {
123 return evlist__add_aux_dummy(evlist, true);
124 }
125
126 int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr,
127 evsel__sb_cb_t cb, void *data);
128 void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data);
129 int evlist__start_sb_thread(struct evlist *evlist, struct target *target);
130 void evlist__stop_sb_thread(struct evlist *evlist);
131
132 int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler);
133
134 int __evlist__set_tracepoints_handlers(struct evlist *evlist,
135 const struct evsel_str_handler *assocs,
136 size_t nr_assocs);
137
138 #define evlist__set_tracepoints_handlers(evlist, array) \
139 __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array))
140
141 int evlist__set_tp_filter(struct evlist *evlist, const char *filter);
142 int evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid);
143 int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
144
145 int evlist__append_tp_filter(struct evlist *evlist, const char *filter);
146
147 int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid);
148 int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
149
150 struct evsel *evlist__find_tracepoint_by_id(struct evlist *evlist, int id);
151 struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name);
152
153 int evlist__add_pollfd(struct evlist *evlist, int fd);
154 int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
155
156 #ifdef HAVE_EVENTFD_SUPPORT
157 int evlist__add_wakeup_eventfd(struct evlist *evlist, int fd);
158 #endif
159
160 int evlist__poll(struct evlist *evlist, int timeout);
161
162 struct evsel *evlist__id2evsel(struct evlist *evlist, u64 id);
163 struct evsel *evlist__id2evsel_strict(struct evlist *evlist, u64 id);
164
165 struct perf_sample_id *evlist__id2sid(struct evlist *evlist, u64 id);
166
167 void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
168
169 void evlist__mmap_consume(struct evlist *evlist, int idx);
170
171 int evlist__open(struct evlist *evlist);
172 void evlist__close(struct evlist *evlist);
173
174 struct callchain_param;
175
176 void evlist__set_id_pos(struct evlist *evlist);
177 void evlist__config(struct evlist *evlist, struct record_opts *opts, struct callchain_param *callchain);
178 int record_opts__config(struct record_opts *opts);
179
180 int evlist__prepare_workload(struct evlist *evlist, struct target *target,
181 const char *argv[], bool pipe_output,
182 void (*exec_error)(int signo, siginfo_t *info, void *ucontext));
183 int evlist__start_workload(struct evlist *evlist);
184
185 struct option;
186
187 int __evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
188 int evlist__parse_mmap_pages(const struct option *opt, const char *str, int unset);
189
190 unsigned long perf_event_mlock_kb_in_pages(void);
191
192 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
193 unsigned int auxtrace_pages,
194 bool auxtrace_overwrite, int nr_cblocks,
195 int affinity, int flush, int comp_level);
196 int evlist__mmap(struct evlist *evlist, unsigned int pages);
197 void evlist__munmap(struct evlist *evlist);
198
199 size_t evlist__mmap_size(unsigned long pages);
200
201 void evlist__disable(struct evlist *evlist);
202 void evlist__enable(struct evlist *evlist);
203 void evlist__toggle_enable(struct evlist *evlist);
204 void evlist__disable_evsel(struct evlist *evlist, char *evsel_name);
205 void evlist__enable_evsel(struct evlist *evlist, char *evsel_name);
206
207 void evlist__set_selected(struct evlist *evlist, struct evsel *evsel);
208
209 int evlist__create_maps(struct evlist *evlist, struct target *target);
210 int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel);
211
212 void evlist__set_leader(struct evlist *evlist);
213
214 u64 __evlist__combined_sample_type(struct evlist *evlist);
215 u64 evlist__combined_sample_type(struct evlist *evlist);
216 u64 evlist__combined_branch_type(struct evlist *evlist);
217 bool evlist__sample_id_all(struct evlist *evlist);
218 u16 evlist__id_hdr_size(struct evlist *evlist);
219
220 int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample);
221 int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp);
222
223 bool evlist__valid_sample_type(struct evlist *evlist);
224 bool evlist__valid_sample_id_all(struct evlist *evlist);
225 bool evlist__valid_read_format(struct evlist *evlist);
226
227 void evlist__splice_list_tail(struct evlist *evlist, struct list_head *list);
228
evlist__empty(struct evlist * evlist)229 static inline bool evlist__empty(struct evlist *evlist)
230 {
231 return list_empty(&evlist->core.entries);
232 }
233
evlist__first(struct evlist * evlist)234 static inline struct evsel *evlist__first(struct evlist *evlist)
235 {
236 struct perf_evsel *evsel = perf_evlist__first(&evlist->core);
237
238 return container_of(evsel, struct evsel, core);
239 }
240
evlist__last(struct evlist * evlist)241 static inline struct evsel *evlist__last(struct evlist *evlist)
242 {
243 struct perf_evsel *evsel = perf_evlist__last(&evlist->core);
244
245 return container_of(evsel, struct evsel, core);
246 }
247
248 int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
249 int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
250
251 bool evlist__can_select_event(struct evlist *evlist, const char *str);
252 void evlist__to_front(struct evlist *evlist, struct evsel *move_evsel);
253
254 /**
255 * __evlist__for_each_entry - iterate thru all the evsels
256 * @list: list_head instance to iterate
257 * @evsel: struct evsel iterator
258 */
259 #define __evlist__for_each_entry(list, evsel) \
260 list_for_each_entry(evsel, list, core.node)
261
262 /**
263 * evlist__for_each_entry - iterate thru all the evsels
264 * @evlist: evlist instance to iterate
265 * @evsel: struct evsel iterator
266 */
267 #define evlist__for_each_entry(evlist, evsel) \
268 __evlist__for_each_entry(&(evlist)->core.entries, evsel)
269
270 /**
271 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
272 * @list: list_head instance to iterate
273 * @evsel: struct evsel iterator
274 */
275 #define __evlist__for_each_entry_continue(list, evsel) \
276 list_for_each_entry_continue(evsel, list, core.node)
277
278 /**
279 * evlist__for_each_entry_continue - continue iteration thru all the evsels
280 * @evlist: evlist instance to iterate
281 * @evsel: struct evsel iterator
282 */
283 #define evlist__for_each_entry_continue(evlist, evsel) \
284 __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
285
286 /**
287 * __evlist__for_each_entry_from - continue iteration from @evsel (included)
288 * @list: list_head instance to iterate
289 * @evsel: struct evsel iterator
290 */
291 #define __evlist__for_each_entry_from(list, evsel) \
292 list_for_each_entry_from(evsel, list, core.node)
293
294 /**
295 * evlist__for_each_entry_from - continue iteration from @evsel (included)
296 * @evlist: evlist instance to iterate
297 * @evsel: struct evsel iterator
298 */
299 #define evlist__for_each_entry_from(evlist, evsel) \
300 __evlist__for_each_entry_from(&(evlist)->core.entries, evsel)
301
302 /**
303 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
304 * @list: list_head instance to iterate
305 * @evsel: struct evsel iterator
306 */
307 #define __evlist__for_each_entry_reverse(list, evsel) \
308 list_for_each_entry_reverse(evsel, list, core.node)
309
310 /**
311 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
312 * @evlist: evlist instance to iterate
313 * @evsel: struct evsel iterator
314 */
315 #define evlist__for_each_entry_reverse(evlist, evsel) \
316 __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
317
318 /**
319 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
320 * @list: list_head instance to iterate
321 * @tmp: struct evsel temp iterator
322 * @evsel: struct evsel iterator
323 */
324 #define __evlist__for_each_entry_safe(list, tmp, evsel) \
325 list_for_each_entry_safe(evsel, tmp, list, core.node)
326
327 /**
328 * evlist__for_each_entry_safe - safely iterate thru all the evsels
329 * @evlist: evlist instance to iterate
330 * @evsel: struct evsel iterator
331 * @tmp: struct evsel temp iterator
332 */
333 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
334 __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
335
336 /** Iterator state for evlist__for_each_cpu */
337 struct evlist_cpu_iterator {
338 /** The list being iterated through. */
339 struct evlist *container;
340 /** The current evsel of the iterator. */
341 struct evsel *evsel;
342 /** The CPU map index corresponding to the evsel->core.cpus for the current CPU. */
343 int cpu_map_idx;
344 /**
345 * The CPU map index corresponding to evlist->core.all_cpus for the
346 * current CPU. Distinct from cpu_map_idx as the evsel's cpu map may
347 * contain fewer entries.
348 */
349 int evlist_cpu_map_idx;
350 /** The number of CPU map entries in evlist->core.all_cpus. */
351 int evlist_cpu_map_nr;
352 /** The current CPU of the iterator. */
353 struct perf_cpu cpu;
354 /** If present, used to set the affinity when switching between CPUs. */
355 struct affinity *affinity;
356 };
357
358 /**
359 * evlist__for_each_cpu - without affinity, iterate over the evlist. With
360 * affinity, iterate over all CPUs and then the evlist
361 * for each evsel on that CPU. When switching between
362 * CPUs the affinity is set to the CPU to avoid IPIs
363 * during syscalls.
364 * @evlist_cpu_itr: the iterator instance.
365 * @evlist: evlist instance to iterate.
366 * @affinity: NULL or used to set the affinity to the current CPU.
367 */
368 #define evlist__for_each_cpu(evlist_cpu_itr, evlist, affinity) \
369 for ((evlist_cpu_itr) = evlist__cpu_begin(evlist, affinity); \
370 !evlist_cpu_iterator__end(&evlist_cpu_itr); \
371 evlist_cpu_iterator__next(&evlist_cpu_itr))
372
373 /** Returns an iterator set to the first CPU/evsel of evlist. */
374 struct evlist_cpu_iterator evlist__cpu_begin(struct evlist *evlist, struct affinity *affinity);
375 /** Move to next element in iterator, updating CPU, evsel and the affinity. */
376 void evlist_cpu_iterator__next(struct evlist_cpu_iterator *evlist_cpu_itr);
377 /** Returns true when iterator is at the end of the CPUs and evlist. */
378 bool evlist_cpu_iterator__end(const struct evlist_cpu_iterator *evlist_cpu_itr);
379
380 struct evsel *evlist__get_tracking_event(struct evlist *evlist);
381 void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel);
382
383 struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
384
385 struct evsel *evlist__event2evsel(struct evlist *evlist, union perf_event *event);
386
387 bool evlist__exclude_kernel(struct evlist *evlist);
388
389 void evlist__force_leader(struct evlist *evlist);
390
391 struct evsel *evlist__reset_weak_group(struct evlist *evlist, struct evsel *evsel, bool close);
392
393 #define EVLIST_CTL_CMD_ENABLE_TAG "enable"
394 #define EVLIST_CTL_CMD_DISABLE_TAG "disable"
395 #define EVLIST_CTL_CMD_ACK_TAG "ack\n"
396 #define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot"
397 #define EVLIST_CTL_CMD_EVLIST_TAG "evlist"
398 #define EVLIST_CTL_CMD_STOP_TAG "stop"
399 #define EVLIST_CTL_CMD_PING_TAG "ping"
400
401 #define EVLIST_CTL_CMD_MAX_LEN 64
402
403 enum evlist_ctl_cmd {
404 EVLIST_CTL_CMD_UNSUPPORTED = 0,
405 EVLIST_CTL_CMD_ENABLE,
406 EVLIST_CTL_CMD_DISABLE,
407 EVLIST_CTL_CMD_ACK,
408 EVLIST_CTL_CMD_SNAPSHOT,
409 EVLIST_CTL_CMD_EVLIST,
410 EVLIST_CTL_CMD_STOP,
411 EVLIST_CTL_CMD_PING,
412 };
413
414 int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close);
415 void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close);
416 int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack);
417 int evlist__finalize_ctlfd(struct evlist *evlist);
418 bool evlist__ctlfd_initialized(struct evlist *evlist);
419 int evlist__ctlfd_update(struct evlist *evlist, struct pollfd *update);
420 int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd);
421 int evlist__ctlfd_ack(struct evlist *evlist);
422
423 #define EVLIST_ENABLED_MSG "Events enabled\n"
424 #define EVLIST_DISABLED_MSG "Events disabled\n"
425
426 struct evsel *evlist__find_evsel(struct evlist *evlist, int idx);
427
428 int evlist__scnprintf_evsels(struct evlist *evlist, size_t size, char *bf);
429 void evlist__check_mem_load_aux(struct evlist *evlist);
430 #endif /* __PERF_EVLIST_H */
431