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