Loading...
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 evlist {
52 struct perf_evlist core;
53 int nr_groups;
54 bool enabled;
55 int id_pos;
56 int is_pos;
57 u64 combined_sample_type;
58 enum bkw_mmap_state bkw_mmap_state;
59 struct {
60 int cork_fd;
61 pid_t pid;
62 } workload;
63 struct mmap *mmap;
64 struct mmap *overwrite_mmap;
65 struct evsel *selected;
66 struct events_stats stats;
67 struct perf_env *env;
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};
78
79struct evsel_str_handler {
80 const char *name;
81 void *handler;
82};
83
84struct evlist *evlist__new(void);
85struct evlist *perf_evlist__new_default(void);
86struct evlist *perf_evlist__new_dummy(void);
87void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus,
88 struct perf_thread_map *threads);
89void evlist__exit(struct evlist *evlist);
90void evlist__delete(struct evlist *evlist);
91
92void evlist__add(struct evlist *evlist, struct evsel *entry);
93void evlist__remove(struct evlist *evlist, struct evsel *evsel);
94
95int __perf_evlist__add_default(struct evlist *evlist, bool precise);
96
97static inline int perf_evlist__add_default(struct evlist *evlist)
98{
99 return __perf_evlist__add_default(evlist, true);
100}
101
102int __perf_evlist__add_default_attrs(struct evlist *evlist,
103 struct perf_event_attr *attrs, size_t nr_attrs);
104
105#define perf_evlist__add_default_attrs(evlist, array) \
106 __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
107
108int perf_evlist__add_dummy(struct evlist *evlist);
109
110int perf_evlist__add_sb_event(struct evlist **evlist,
111 struct perf_event_attr *attr,
112 perf_evsel__sb_cb_t cb,
113 void *data);
114int perf_evlist__start_sb_thread(struct evlist *evlist,
115 struct target *target);
116void perf_evlist__stop_sb_thread(struct evlist *evlist);
117
118int perf_evlist__add_newtp(struct evlist *evlist,
119 const char *sys, const char *name, void *handler);
120
121void __perf_evlist__set_sample_bit(struct evlist *evlist,
122 enum perf_event_sample_format bit);
123void __perf_evlist__reset_sample_bit(struct evlist *evlist,
124 enum perf_event_sample_format bit);
125
126#define perf_evlist__set_sample_bit(evlist, bit) \
127 __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
128
129#define perf_evlist__reset_sample_bit(evlist, bit) \
130 __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
131
132int perf_evlist__set_tp_filter(struct evlist *evlist, const char *filter);
133int perf_evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid);
134int perf_evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
135
136struct evsel *
137perf_evlist__find_tracepoint_by_id(struct evlist *evlist, int id);
138
139struct evsel *
140perf_evlist__find_tracepoint_by_name(struct evlist *evlist,
141 const char *name);
142
143int evlist__add_pollfd(struct evlist *evlist, int fd);
144int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
145
146int evlist__poll(struct evlist *evlist, int timeout);
147
148struct evsel *perf_evlist__id2evsel(struct evlist *evlist, u64 id);
149struct evsel *perf_evlist__id2evsel_strict(struct evlist *evlist,
150 u64 id);
151
152struct perf_sample_id *perf_evlist__id2sid(struct evlist *evlist, u64 id);
153
154void perf_evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
155
156void evlist__mmap_consume(struct evlist *evlist, int idx);
157
158int evlist__open(struct evlist *evlist);
159void evlist__close(struct evlist *evlist);
160
161struct callchain_param;
162
163void perf_evlist__set_id_pos(struct evlist *evlist);
164bool perf_can_sample_identifier(void);
165bool perf_can_record_switch_events(void);
166bool perf_can_record_cpu_wide(void);
167void perf_evlist__config(struct evlist *evlist, struct record_opts *opts,
168 struct callchain_param *callchain);
169int record_opts__config(struct record_opts *opts);
170
171int perf_evlist__prepare_workload(struct evlist *evlist,
172 struct target *target,
173 const char *argv[], bool pipe_output,
174 void (*exec_error)(int signo, siginfo_t *info,
175 void *ucontext));
176int perf_evlist__start_workload(struct evlist *evlist);
177
178struct option;
179
180int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
181int perf_evlist__parse_mmap_pages(const struct option *opt,
182 const char *str,
183 int unset);
184
185unsigned long perf_event_mlock_kb_in_pages(void);
186
187int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
188 unsigned int auxtrace_pages,
189 bool auxtrace_overwrite, int nr_cblocks,
190 int affinity, int flush, int comp_level);
191int evlist__mmap(struct evlist *evlist, unsigned int pages);
192void evlist__munmap(struct evlist *evlist);
193
194size_t evlist__mmap_size(unsigned long pages);
195
196void evlist__disable(struct evlist *evlist);
197void evlist__enable(struct evlist *evlist);
198void perf_evlist__toggle_enable(struct evlist *evlist);
199
200int perf_evlist__enable_event_idx(struct evlist *evlist,
201 struct evsel *evsel, int idx);
202
203void perf_evlist__set_selected(struct evlist *evlist,
204 struct evsel *evsel);
205
206int perf_evlist__create_maps(struct evlist *evlist, struct target *target);
207int perf_evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel);
208
209void __perf_evlist__set_leader(struct list_head *list);
210void perf_evlist__set_leader(struct evlist *evlist);
211
212u64 __perf_evlist__combined_sample_type(struct evlist *evlist);
213u64 perf_evlist__combined_sample_type(struct evlist *evlist);
214u64 perf_evlist__combined_branch_type(struct evlist *evlist);
215bool perf_evlist__sample_id_all(struct evlist *evlist);
216u16 perf_evlist__id_hdr_size(struct evlist *evlist);
217
218int perf_evlist__parse_sample(struct evlist *evlist, union perf_event *event,
219 struct perf_sample *sample);
220
221int perf_evlist__parse_sample_timestamp(struct evlist *evlist,
222 union perf_event *event,
223 u64 *timestamp);
224
225bool perf_evlist__valid_sample_type(struct evlist *evlist);
226bool perf_evlist__valid_sample_id_all(struct evlist *evlist);
227bool perf_evlist__valid_read_format(struct evlist *evlist);
228
229void perf_evlist__splice_list_tail(struct evlist *evlist,
230 struct list_head *list);
231
232static inline bool perf_evlist__empty(struct evlist *evlist)
233{
234 return list_empty(&evlist->core.entries);
235}
236
237static 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
244static 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
251int perf_evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
252int perf_evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
253
254bool perf_evlist__can_select_event(struct evlist *evlist, const char *str);
255void perf_evlist__to_front(struct evlist *evlist,
256 struct evsel *move_evsel);
257
258/**
259 * __evlist__for_each_entry - iterate thru all the evsels
260 * @list: list_head instance to iterate
261 * @evsel: struct evsel iterator
262 */
263#define __evlist__for_each_entry(list, evsel) \
264 list_for_each_entry(evsel, list, core.node)
265
266/**
267 * evlist__for_each_entry - iterate thru all the evsels
268 * @evlist: evlist instance to iterate
269 * @evsel: struct evsel iterator
270 */
271#define evlist__for_each_entry(evlist, evsel) \
272 __evlist__for_each_entry(&(evlist)->core.entries, evsel)
273
274/**
275 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
276 * @list: list_head instance to iterate
277 * @evsel: struct evsel iterator
278 */
279#define __evlist__for_each_entry_continue(list, evsel) \
280 list_for_each_entry_continue(evsel, list, core.node)
281
282/**
283 * evlist__for_each_entry_continue - continue iteration thru all the evsels
284 * @evlist: evlist instance to iterate
285 * @evsel: struct evsel iterator
286 */
287#define evlist__for_each_entry_continue(evlist, evsel) \
288 __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
289
290/**
291 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
292 * @list: list_head instance to iterate
293 * @evsel: struct evsel iterator
294 */
295#define __evlist__for_each_entry_reverse(list, evsel) \
296 list_for_each_entry_reverse(evsel, list, core.node)
297
298/**
299 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
300 * @evlist: evlist instance to iterate
301 * @evsel: struct evsel iterator
302 */
303#define evlist__for_each_entry_reverse(evlist, evsel) \
304 __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
305
306/**
307 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
308 * @list: list_head instance to iterate
309 * @tmp: struct evsel temp iterator
310 * @evsel: struct evsel iterator
311 */
312#define __evlist__for_each_entry_safe(list, tmp, evsel) \
313 list_for_each_entry_safe(evsel, tmp, list, core.node)
314
315/**
316 * evlist__for_each_entry_safe - safely iterate thru all the evsels
317 * @evlist: evlist instance to iterate
318 * @evsel: struct evsel iterator
319 * @tmp: struct evsel temp iterator
320 */
321#define evlist__for_each_entry_safe(evlist, tmp, evsel) \
322 __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
323
324void perf_evlist__set_tracking_event(struct evlist *evlist,
325 struct evsel *tracking_evsel);
326
327struct evsel *
328perf_evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
329
330struct evsel *perf_evlist__event2evsel(struct evlist *evlist,
331 union perf_event *event);
332
333bool perf_evlist__exclude_kernel(struct evlist *evlist);
334
335void perf_evlist__force_leader(struct evlist *evlist);
336
337struct evsel *perf_evlist__reset_weak_group(struct evlist *evlist,
338 struct evsel *evsel);
339#endif /* __PERF_EVLIST_H */
1#ifndef __PERF_EVLIST_H
2#define __PERF_EVLIST_H 1
3
4#include <linux/list.h>
5#include "../perf.h"
6#include "event.h"
7
8struct pollfd;
9struct thread_map;
10struct cpu_map;
11
12#define PERF_EVLIST__HLIST_BITS 8
13#define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
14
15struct perf_evlist {
16 struct list_head entries;
17 struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
18 int nr_entries;
19 int nr_fds;
20 int nr_mmaps;
21 int mmap_len;
22 bool overwrite;
23 union perf_event event_copy;
24 struct perf_mmap *mmap;
25 struct pollfd *pollfd;
26 struct thread_map *threads;
27 struct cpu_map *cpus;
28};
29
30struct perf_evsel;
31
32struct perf_evlist *perf_evlist__new(struct cpu_map *cpus,
33 struct thread_map *threads);
34void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
35 struct thread_map *threads);
36void perf_evlist__exit(struct perf_evlist *evlist);
37void perf_evlist__delete(struct perf_evlist *evlist);
38
39void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
40int perf_evlist__add_default(struct perf_evlist *evlist);
41
42void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
43 int cpu, int thread, u64 id);
44
45int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
46void perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
47
48struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
49
50union perf_event *perf_evlist__mmap_read(struct perf_evlist *self, int idx);
51
52int perf_evlist__alloc_mmap(struct perf_evlist *evlist);
53int perf_evlist__mmap(struct perf_evlist *evlist, int pages, bool overwrite);
54void perf_evlist__munmap(struct perf_evlist *evlist);
55
56void perf_evlist__disable(struct perf_evlist *evlist);
57void perf_evlist__enable(struct perf_evlist *evlist);
58
59static inline void perf_evlist__set_maps(struct perf_evlist *evlist,
60 struct cpu_map *cpus,
61 struct thread_map *threads)
62{
63 evlist->cpus = cpus;
64 evlist->threads = threads;
65}
66
67int perf_evlist__create_maps(struct perf_evlist *evlist, pid_t target_pid,
68 pid_t target_tid, const char *cpu_list);
69void perf_evlist__delete_maps(struct perf_evlist *evlist);
70int perf_evlist__set_filters(struct perf_evlist *evlist);
71
72u64 perf_evlist__sample_type(const struct perf_evlist *evlist);
73bool perf_evlist__sample_id_all(const const struct perf_evlist *evlist);
74
75bool perf_evlist__valid_sample_type(const struct perf_evlist *evlist);
76bool perf_evlist__valid_sample_id_all(const struct perf_evlist *evlist);
77#endif /* __PERF_EVLIST_H */