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