1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_EVLIST_H
3 #define __PERF_EVLIST_H 1
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"
24 * State machine of bkw_mmap_state:
26 * .________________(forbid)_____________.
28 * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
30 * | |__(forbid)____/ |___(forbid)___/|
32 * \_________________(3)_______________/
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.
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
47 BKW_MMAP_DATA_PENDING,
52 struct perf_evlist core;
57 u64 combined_sample_type;
58 enum bkw_mmap_state bkw_mmap_state;
64 struct mmap *overwrite_mmap;
65 struct evsel *selected;
66 struct events_stats stats;
68 void (*trace_event_sample_raw)(struct evlist *evlist,
69 union perf_event *event,
70 struct perf_sample *sample);
71 u64 first_sample_time;
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 */
84 struct evsel_str_handler {
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);
97 void evlist__add(struct evlist *evlist, struct evsel *entry);
98 void evlist__remove(struct evlist *evlist, struct evsel *evsel);
100 int __evlist__add_default(struct evlist *evlist, bool precise);
102 static inline int evlist__add_default(struct evlist *evlist)
104 return __evlist__add_default(evlist, true);
107 int __evlist__add_default_attrs(struct evlist *evlist,
108 struct perf_event_attr *attrs, size_t nr_attrs);
110 #define evlist__add_default_attrs(evlist, array) \
111 __evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
113 int evlist__add_dummy(struct evlist *evlist);
115 int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr,
116 evsel__sb_cb_t cb, void *data);
117 void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data);
118 int evlist__start_sb_thread(struct evlist *evlist, struct target *target);
119 void evlist__stop_sb_thread(struct evlist *evlist);
121 int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler);
123 int __evlist__set_tracepoints_handlers(struct evlist *evlist,
124 const struct evsel_str_handler *assocs,
127 #define evlist__set_tracepoints_handlers(evlist, array) \
128 __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array))
130 int evlist__set_tp_filter(struct evlist *evlist, const char *filter);
131 int evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid);
132 int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
134 int evlist__append_tp_filter(struct evlist *evlist, const char *filter);
136 int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid);
137 int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
139 struct evsel *evlist__find_tracepoint_by_id(struct evlist *evlist, int id);
140 struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name);
142 int evlist__add_pollfd(struct evlist *evlist, int fd);
143 int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
145 int evlist__poll(struct evlist *evlist, int timeout);
147 struct evsel *evlist__id2evsel(struct evlist *evlist, u64 id);
148 struct evsel *evlist__id2evsel_strict(struct evlist *evlist, u64 id);
150 struct perf_sample_id *evlist__id2sid(struct evlist *evlist, u64 id);
152 void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
154 void evlist__mmap_consume(struct evlist *evlist, int idx);
156 int evlist__open(struct evlist *evlist);
157 void evlist__close(struct evlist *evlist);
159 struct callchain_param;
161 void evlist__set_id_pos(struct evlist *evlist);
162 void evlist__config(struct evlist *evlist, struct record_opts *opts, struct callchain_param *callchain);
163 int record_opts__config(struct record_opts *opts);
165 int evlist__prepare_workload(struct evlist *evlist, struct target *target,
166 const char *argv[], bool pipe_output,
167 void (*exec_error)(int signo, siginfo_t *info, void *ucontext));
168 int evlist__start_workload(struct evlist *evlist);
172 int __evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
173 int evlist__parse_mmap_pages(const struct option *opt, const char *str, int unset);
175 unsigned long perf_event_mlock_kb_in_pages(void);
177 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
178 unsigned int auxtrace_pages,
179 bool auxtrace_overwrite, int nr_cblocks,
180 int affinity, int flush, int comp_level);
181 int evlist__mmap(struct evlist *evlist, unsigned int pages);
182 void evlist__munmap(struct evlist *evlist);
184 size_t evlist__mmap_size(unsigned long pages);
186 void evlist__disable(struct evlist *evlist);
187 void evlist__enable(struct evlist *evlist);
188 void evlist__toggle_enable(struct evlist *evlist);
190 int evlist__enable_event_idx(struct evlist *evlist, struct evsel *evsel, int idx);
192 void evlist__set_selected(struct evlist *evlist, struct evsel *evsel);
194 int evlist__create_maps(struct evlist *evlist, struct target *target);
195 int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel);
197 void __evlist__set_leader(struct list_head *list);
198 void evlist__set_leader(struct evlist *evlist);
200 u64 __evlist__combined_sample_type(struct evlist *evlist);
201 u64 evlist__combined_sample_type(struct evlist *evlist);
202 u64 evlist__combined_branch_type(struct evlist *evlist);
203 bool evlist__sample_id_all(struct evlist *evlist);
204 u16 evlist__id_hdr_size(struct evlist *evlist);
206 int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample);
207 int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp);
209 bool evlist__valid_sample_type(struct evlist *evlist);
210 bool evlist__valid_sample_id_all(struct evlist *evlist);
211 bool evlist__valid_read_format(struct evlist *evlist);
213 void evlist__splice_list_tail(struct evlist *evlist, struct list_head *list);
215 static inline bool evlist__empty(struct evlist *evlist)
217 return list_empty(&evlist->core.entries);
220 static inline struct evsel *evlist__first(struct evlist *evlist)
222 struct perf_evsel *evsel = perf_evlist__first(&evlist->core);
224 return container_of(evsel, struct evsel, core);
227 static inline struct evsel *evlist__last(struct evlist *evlist)
229 struct perf_evsel *evsel = perf_evlist__last(&evlist->core);
231 return container_of(evsel, struct evsel, core);
234 int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
235 int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
237 bool evlist__can_select_event(struct evlist *evlist, const char *str);
238 void evlist__to_front(struct evlist *evlist, struct evsel *move_evsel);
241 * __evlist__for_each_entry - iterate thru all the evsels
242 * @list: list_head instance to iterate
243 * @evsel: struct evsel iterator
245 #define __evlist__for_each_entry(list, evsel) \
246 list_for_each_entry(evsel, list, core.node)
249 * evlist__for_each_entry - iterate thru all the evsels
250 * @evlist: evlist instance to iterate
251 * @evsel: struct evsel iterator
253 #define evlist__for_each_entry(evlist, evsel) \
254 __evlist__for_each_entry(&(evlist)->core.entries, evsel)
257 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
258 * @list: list_head instance to iterate
259 * @evsel: struct evsel iterator
261 #define __evlist__for_each_entry_continue(list, evsel) \
262 list_for_each_entry_continue(evsel, list, core.node)
265 * evlist__for_each_entry_continue - continue iteration thru all the evsels
266 * @evlist: evlist instance to iterate
267 * @evsel: struct evsel iterator
269 #define evlist__for_each_entry_continue(evlist, evsel) \
270 __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
273 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
274 * @list: list_head instance to iterate
275 * @evsel: struct evsel iterator
277 #define __evlist__for_each_entry_reverse(list, evsel) \
278 list_for_each_entry_reverse(evsel, list, core.node)
281 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
282 * @evlist: evlist instance to iterate
283 * @evsel: struct evsel iterator
285 #define evlist__for_each_entry_reverse(evlist, evsel) \
286 __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
289 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
290 * @list: list_head instance to iterate
291 * @tmp: struct evsel temp iterator
292 * @evsel: struct evsel iterator
294 #define __evlist__for_each_entry_safe(list, tmp, evsel) \
295 list_for_each_entry_safe(evsel, tmp, list, core.node)
298 * evlist__for_each_entry_safe - safely iterate thru all the evsels
299 * @evlist: evlist instance to iterate
300 * @evsel: struct evsel iterator
301 * @tmp: struct evsel temp iterator
303 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
304 __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
306 #define evlist__for_each_cpu(evlist, index, cpu) \
307 evlist__cpu_iter_start(evlist); \
308 perf_cpu_map__for_each_cpu (cpu, index, (evlist)->core.all_cpus)
310 struct evsel *evlist__get_tracking_event(struct evlist *evlist);
311 void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel);
313 void evlist__cpu_iter_start(struct evlist *evlist);
314 bool evsel__cpu_iter_skip(struct evsel *ev, int cpu);
315 bool evsel__cpu_iter_skip_no_inc(struct evsel *ev, int cpu);
317 struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
319 struct evsel *evlist__event2evsel(struct evlist *evlist, union perf_event *event);
321 bool evlist__exclude_kernel(struct evlist *evlist);
323 void evlist__force_leader(struct evlist *evlist);
325 struct evsel *evlist__reset_weak_group(struct evlist *evlist, struct evsel *evsel, bool close);
327 #define EVLIST_CTL_CMD_ENABLE_TAG "enable"
328 #define EVLIST_CTL_CMD_DISABLE_TAG "disable"
329 #define EVLIST_CTL_CMD_ACK_TAG "ack\n"
330 #define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot"
332 #define EVLIST_CTL_CMD_MAX_LEN 64
334 enum evlist_ctl_cmd {
335 EVLIST_CTL_CMD_UNSUPPORTED = 0,
336 EVLIST_CTL_CMD_ENABLE,
337 EVLIST_CTL_CMD_DISABLE,
339 EVLIST_CTL_CMD_SNAPSHOT,
342 int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close);
343 void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close);
344 int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack);
345 int evlist__finalize_ctlfd(struct evlist *evlist);
346 bool evlist__ctlfd_initialized(struct evlist *evlist);
347 int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd);
348 int evlist__ctlfd_ack(struct evlist *evlist);
350 #define EVLIST_ENABLED_MSG "Events enabled\n"
351 #define EVLIST_DISABLED_MSG "Events disabled\n"
353 struct evsel *evlist__find_evsel(struct evlist *evlist, int idx);
354 #endif /* __PERF_EVLIST_H */