]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - tools/perf/util/evlist.h
perf record: Implement COMPRESSED event record and its attributes
[mirror_ubuntu-hirsute-kernel.git] / tools / perf / util / evlist.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
361c99a6
ACM
2#ifndef __PERF_EVLIST_H
3#define __PERF_EVLIST_H 1
4
5c97cac6 5#include <linux/compiler.h>
877a7a11 6#include <linux/kernel.h>
25a3720c 7#include <linux/refcount.h>
361c99a6 8#include <linux/list.h>
1b85337d 9#include <api/fd/array.h>
50d08e47 10#include <stdio.h>
70db7533 11#include "../perf.h"
04391deb 12#include "event.h"
0c21f736 13#include "evsel.h"
16958497 14#include "mmap.h"
50d08e47 15#include "util.h"
9607ad3a 16#include <signal.h>
35b9d88e 17#include <unistd.h>
361c99a6 18
5c581041 19struct pollfd;
f8a95309
ACM
20struct thread_map;
21struct cpu_map;
b4006796 22struct record_opts;
5c581041 23
70db7533
ACM
24#define PERF_EVLIST__HLIST_BITS 8
25#define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
26
361c99a6
ACM
27struct perf_evlist {
28 struct list_head entries;
70db7533 29 struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
361c99a6 30 int nr_entries;
97f63e4a 31 int nr_groups;
aece948f 32 int nr_mmaps;
2b56bcfb 33 bool enabled;
ec9a77a7 34 bool has_user_cpus;
994a1f78 35 size_t mmap_len;
75562573
AH
36 int id_pos;
37 int is_pos;
38 u64 combined_sample_type;
54cc54de 39 enum bkw_mmap_state bkw_mmap_state;
35b9d88e
ACM
40 struct {
41 int cork_fd;
42 pid_t pid;
43 } workload;
1b85337d 44 struct fdarray pollfd;
70db7533 45 struct perf_mmap *mmap;
0b72d69a 46 struct perf_mmap *overwrite_mmap;
7e2ed097
ACM
47 struct thread_map *threads;
48 struct cpu_map *cpus;
81cce8de 49 struct perf_evsel *selected;
75be989a 50 struct events_stats stats;
2c07144d 51 struct perf_env *env;
93115d32
TR
52 void (*trace_event_sample_raw)(struct perf_evlist *evlist,
53 union perf_event *event,
54 struct perf_sample *sample);
6011518d
JY
55 u64 first_sample_time;
56 u64 last_sample_time;
657ee553
SL
57 struct {
58 pthread_t th;
59 volatile int done;
60 } thread;
361c99a6
ACM
61};
62
ee29be62
ACM
63struct perf_evsel_str_handler {
64 const char *name;
65 void *handler;
66};
67
334fe7a3 68struct perf_evlist *perf_evlist__new(void);
b22d54b0 69struct perf_evlist *perf_evlist__new_default(void);
5bae0250 70struct perf_evlist *perf_evlist__new_dummy(void);
7e2ed097
ACM
71void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
72 struct thread_map *threads);
ef1d1af2 73void perf_evlist__exit(struct perf_evlist *evlist);
361c99a6
ACM
74void perf_evlist__delete(struct perf_evlist *evlist);
75
76void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
4768230a 77void perf_evlist__remove(struct perf_evlist *evlist, struct perf_evsel *evsel);
db918acb
ACM
78
79int __perf_evlist__add_default(struct perf_evlist *evlist, bool precise);
80
81static inline int perf_evlist__add_default(struct perf_evlist *evlist)
82{
83 return __perf_evlist__add_default(evlist, true);
84}
85
79695e1b
ACM
86int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
87 struct perf_event_attr *attrs, size_t nr_attrs);
e60fc847 88
79695e1b
ACM
89#define perf_evlist__add_default_attrs(evlist, array) \
90 __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
361c99a6 91
5bae0250
ACM
92int perf_evlist__add_dummy(struct perf_evlist *evlist);
93
657ee553
SL
94int perf_evlist__add_sb_event(struct perf_evlist **evlist,
95 struct perf_event_attr *attr,
96 perf_evsel__sb_cb_t cb,
97 void *data);
98int perf_evlist__start_sb_thread(struct perf_evlist *evlist,
99 struct target *target);
100void perf_evlist__stop_sb_thread(struct perf_evlist *evlist);
101
39876e7d
ACM
102int perf_evlist__add_newtp(struct perf_evlist *evlist,
103 const char *sys, const char *name, void *handler);
104
22c8a376
ACM
105void __perf_evlist__set_sample_bit(struct perf_evlist *evlist,
106 enum perf_event_sample_format bit);
107void __perf_evlist__reset_sample_bit(struct perf_evlist *evlist,
108 enum perf_event_sample_format bit);
109
110#define perf_evlist__set_sample_bit(evlist, bit) \
111 __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
112
113#define perf_evlist__reset_sample_bit(evlist, bit) \
114 __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
115
7ad92a33
ACM
116int perf_evlist__set_tp_filter(struct perf_evlist *evlist, const char *filter);
117int perf_evlist__set_tp_filter_pid(struct perf_evlist *evlist, pid_t pid);
118int perf_evlist__set_tp_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids);
745cefc5 119
da378962
ACM
120struct perf_evsel *
121perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
122
a2f2804a
DA
123struct perf_evsel *
124perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
125 const char *name);
126
a91e5431
ACM
127void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
128 int cpu, int thread, u64 id);
1c59612d
JO
129int perf_evlist__id_add_fd(struct perf_evlist *evlist,
130 struct perf_evsel *evsel,
131 int cpu, int thread, int fd);
3d3b5e95 132
ad6765dd
ACM
133int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
134int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
1ddec7f0
ACM
135int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);
136
f66a889d
ACM
137int perf_evlist__poll(struct perf_evlist *evlist, int timeout);
138
70db7533 139struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
dddcf6ab
AH
140struct perf_evsel *perf_evlist__id2evsel_strict(struct perf_evlist *evlist,
141 u64 id);
70db7533 142
932a3594
JO
143struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);
144
54cc54de
WN
145void perf_evlist__toggle_bkw_mmap(struct perf_evlist *evlist, enum bkw_mmap_state state);
146
8e50d384
ZZ
147void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);
148
6a4bb04c 149int perf_evlist__open(struct perf_evlist *evlist);
a74b4b66 150void perf_evlist__close(struct perf_evlist *evlist);
727ab04e 151
e68ae9cf
ACM
152struct callchain_param;
153
75562573
AH
154void perf_evlist__set_id_pos(struct perf_evlist *evlist);
155bool perf_can_sample_identifier(void);
b757bb09 156bool perf_can_record_switch_events(void);
83509565 157bool perf_can_record_cpu_wide(void);
e68ae9cf
ACM
158void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts,
159 struct callchain_param *callchain);
b4006796 160int record_opts__config(struct record_opts *opts);
0f82ebc4 161
35b9d88e 162int perf_evlist__prepare_workload(struct perf_evlist *evlist,
602ad878 163 struct target *target,
55e162ea 164 const char *argv[], bool pipe_output,
735f7e0b
ACM
165 void (*exec_error)(int signo, siginfo_t *info,
166 void *ucontext));
35b9d88e
ACM
167int perf_evlist__start_workload(struct perf_evlist *evlist);
168
724ce97e
ACM
169struct option;
170
e9db1310 171int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
994a1f78
JO
172int perf_evlist__parse_mmap_pages(const struct option *opt,
173 const char *str,
174 int unset);
175
f5e7150c
ACM
176unsigned long perf_event_mlock_kb_in_pages(void);
177
718c602d 178int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,
7a276ff6 179 unsigned int auxtrace_pages,
470530bb
AB
180 bool auxtrace_overwrite, int nr_cblocks,
181 int affinity, int flush);
f74b9d3a 182int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages);
7e2ed097
ACM
183void perf_evlist__munmap(struct perf_evlist *evlist);
184
0c582449
JO
185size_t perf_evlist__mmap_size(unsigned long pages);
186
4152ab37 187void perf_evlist__disable(struct perf_evlist *evlist);
764e16a3 188void perf_evlist__enable(struct perf_evlist *evlist);
2b56bcfb 189void perf_evlist__toggle_enable(struct perf_evlist *evlist);
4152ab37 190
1c65056c
AH
191int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
192 struct perf_evsel *evsel, int idx);
395c3070 193
81cce8de
ACM
194void perf_evlist__set_selected(struct perf_evlist *evlist,
195 struct perf_evsel *evsel);
196
d5bc056e
AH
197void perf_evlist__set_maps(struct perf_evlist *evlist, struct cpu_map *cpus,
198 struct thread_map *threads);
602ad878 199int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
23d4aad4 200int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel);
f8a95309 201
63dab225
ACM
202void __perf_evlist__set_leader(struct list_head *list);
203void perf_evlist__set_leader(struct perf_evlist *evlist);
204
9ede473c 205u64 perf_evlist__read_format(struct perf_evlist *evlist);
75562573
AH
206u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
207u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
98df858e 208u64 perf_evlist__combined_branch_type(struct perf_evlist *evlist);
0c21f736
ACM
209bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
210u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
74429964 211
a3f698fe 212int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
0807d2d8 213 struct perf_sample *sample);
cb0b29e0 214
01468120
JO
215int perf_evlist__parse_sample_timestamp(struct perf_evlist *evlist,
216 union perf_event *event,
217 u64 *timestamp);
218
0c21f736
ACM
219bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
220bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
9ede473c 221bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
0529bc1f
JO
222
223void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
f114d6ef 224 struct list_head *list);
0c21f736 225
64831a21
DCC
226static inline bool perf_evlist__empty(struct perf_evlist *evlist)
227{
228 return list_empty(&evlist->entries);
229}
230
0c21f736
ACM
231static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
232{
233 return list_entry(evlist->entries.next, struct perf_evsel, node);
234}
235
236static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
237{
238 return list_entry(evlist->entries.prev, struct perf_evsel, node);
239}
78f067b3
ACM
240
241size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
0479b8b9 242
a8f23d8f 243int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
956fa571 244int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size);
6ef068cb 245
c09ec622 246bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
a025e4f0
AH
247void perf_evlist__to_front(struct perf_evlist *evlist,
248 struct perf_evsel *move_evsel);
249
0050f7aa 250/**
e5cadb93 251 * __evlist__for_each_entry - iterate thru all the evsels
0050f7aa
ACM
252 * @list: list_head instance to iterate
253 * @evsel: struct evsel iterator
254 */
e5cadb93 255#define __evlist__for_each_entry(list, evsel) \
0050f7aa
ACM
256 list_for_each_entry(evsel, list, node)
257
258/**
e5cadb93 259 * evlist__for_each_entry - iterate thru all the evsels
0050f7aa
ACM
260 * @evlist: evlist instance to iterate
261 * @evsel: struct evsel iterator
262 */
e5cadb93
ACM
263#define evlist__for_each_entry(evlist, evsel) \
264 __evlist__for_each_entry(&(evlist)->entries, evsel)
0050f7aa
ACM
265
266/**
e5cadb93 267 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
0050f7aa
ACM
268 * @list: list_head instance to iterate
269 * @evsel: struct evsel iterator
270 */
e5cadb93 271#define __evlist__for_each_entry_continue(list, evsel) \
0050f7aa
ACM
272 list_for_each_entry_continue(evsel, list, node)
273
274/**
e5cadb93 275 * evlist__for_each_entry_continue - continue iteration thru all the evsels
0050f7aa
ACM
276 * @evlist: evlist instance to iterate
277 * @evsel: struct evsel iterator
278 */
e5cadb93
ACM
279#define evlist__for_each_entry_continue(evlist, evsel) \
280 __evlist__for_each_entry_continue(&(evlist)->entries, evsel)
0050f7aa
ACM
281
282/**
e5cadb93 283 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
0050f7aa
ACM
284 * @list: list_head instance to iterate
285 * @evsel: struct evsel iterator
286 */
e5cadb93 287#define __evlist__for_each_entry_reverse(list, evsel) \
0050f7aa
ACM
288 list_for_each_entry_reverse(evsel, list, node)
289
290/**
e5cadb93 291 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
0050f7aa
ACM
292 * @evlist: evlist instance to iterate
293 * @evsel: struct evsel iterator
294 */
e5cadb93
ACM
295#define evlist__for_each_entry_reverse(evlist, evsel) \
296 __evlist__for_each_entry_reverse(&(evlist)->entries, evsel)
0050f7aa
ACM
297
298/**
e5cadb93 299 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
0050f7aa
ACM
300 * @list: list_head instance to iterate
301 * @tmp: struct evsel temp iterator
302 * @evsel: struct evsel iterator
303 */
e5cadb93 304#define __evlist__for_each_entry_safe(list, tmp, evsel) \
0050f7aa
ACM
305 list_for_each_entry_safe(evsel, tmp, list, node)
306
307/**
e5cadb93 308 * evlist__for_each_entry_safe - safely iterate thru all the evsels
0050f7aa
ACM
309 * @evlist: evlist instance to iterate
310 * @evsel: struct evsel iterator
311 * @tmp: struct evsel temp iterator
312 */
e5cadb93
ACM
313#define evlist__for_each_entry_safe(evlist, tmp, evsel) \
314 __evlist__for_each_entry_safe(&(evlist)->entries, tmp, evsel)
c09ec622 315
60b0896c
AH
316void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
317 struct perf_evsel *tracking_evsel);
45cf6c33 318
7630b3e2
WN
319struct perf_evsel *
320perf_evlist__find_evsel_by_str(struct perf_evlist *evlist, const char *str);
7cb5c5ac
JO
321
322struct perf_evsel *perf_evlist__event2evsel(struct perf_evlist *evlist,
323 union perf_event *event);
07d6f446
ACM
324
325bool perf_evlist__exclude_kernel(struct perf_evlist *evlist);
e2bdbe80
JY
326
327void perf_evlist__force_leader(struct perf_evlist *evlist);
328
c3537fc2
AK
329struct perf_evsel *perf_evlist__reset_weak_group(struct perf_evlist *evlist,
330 struct perf_evsel *evsel);
361c99a6 331#endif /* __PERF_EVLIST_H */