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