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