perf evlist: Rename for_each() macros to for_each_entry()
[deliverable/linux.git] / tools / perf / util / evlist.h
CommitLineData
361c99a6
ACM
1#ifndef __PERF_EVLIST_H
2#define __PERF_EVLIST_H 1
3
7143849a 4#include <linux/atomic.h>
361c99a6 5#include <linux/list.h>
1b85337d 6#include <api/fd/array.h>
50d08e47 7#include <stdio.h>
70db7533 8#include "../perf.h"
04391deb 9#include "event.h"
0c21f736 10#include "evsel.h"
50d08e47 11#include "util.h"
718c602d 12#include "auxtrace.h"
35b9d88e 13#include <unistd.h>
361c99a6 14
5c581041 15struct pollfd;
f8a95309
ACM
16struct thread_map;
17struct cpu_map;
b4006796 18struct record_opts;
5c581041 19
70db7533
ACM
20#define PERF_EVLIST__HLIST_BITS 8
21#define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
22
82396986
ACM
23/**
24 * struct perf_mmap - perf's ring buffer mmap details
25 *
26 * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
27 */
0479b8b9
DA
28struct perf_mmap {
29 void *base;
30 int mask;
d4c6fb36 31 int fd;
7143849a 32 atomic_t refcnt;
7b8283b5 33 u64 prev;
718c602d 34 struct auxtrace_mmap auxtrace_mmap;
a73b6c19 35 char event_copy[PERF_SAMPLE_MAX_SIZE] __attribute__((aligned(8)));
0479b8b9
DA
36};
37
361c99a6
ACM
38struct perf_evlist {
39 struct list_head entries;
70db7533 40 struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
361c99a6 41 int nr_entries;
97f63e4a 42 int nr_groups;
aece948f 43 int nr_mmaps;
86066064 44 bool overwrite;
2b56bcfb 45 bool enabled;
ec9a77a7 46 bool has_user_cpus;
3a62a7b8 47 bool backward;
994a1f78 48 size_t mmap_len;
75562573
AH
49 int id_pos;
50 int is_pos;
51 u64 combined_sample_type;
35b9d88e
ACM
52 struct {
53 int cork_fd;
54 pid_t pid;
55 } workload;
1b85337d 56 struct fdarray pollfd;
70db7533 57 struct perf_mmap *mmap;
7e2ed097
ACM
58 struct thread_map *threads;
59 struct cpu_map *cpus;
81cce8de 60 struct perf_evsel *selected;
75be989a 61 struct events_stats stats;
2c07144d 62 struct perf_env *env;
361c99a6
ACM
63};
64
ee29be62
ACM
65struct perf_evsel_str_handler {
66 const char *name;
67 void *handler;
68};
69
334fe7a3 70struct perf_evlist *perf_evlist__new(void);
b22d54b0 71struct perf_evlist *perf_evlist__new_default(void);
5bae0250 72struct perf_evlist *perf_evlist__new_dummy(void);
7e2ed097
ACM
73void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
74 struct thread_map *threads);
ef1d1af2 75void perf_evlist__exit(struct perf_evlist *evlist);
361c99a6
ACM
76void perf_evlist__delete(struct perf_evlist *evlist);
77
78void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
4768230a 79void perf_evlist__remove(struct perf_evlist *evlist, struct perf_evsel *evsel);
361c99a6 80int perf_evlist__add_default(struct perf_evlist *evlist);
79695e1b
ACM
81int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
82 struct perf_event_attr *attrs, size_t nr_attrs);
e60fc847 83
79695e1b
ACM
84#define perf_evlist__add_default_attrs(evlist, array) \
85 __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
361c99a6 86
5bae0250
ACM
87int perf_evlist__add_dummy(struct perf_evlist *evlist);
88
39876e7d
ACM
89int perf_evlist__add_newtp(struct perf_evlist *evlist,
90 const char *sys, const char *name, void *handler);
91
22c8a376
ACM
92void __perf_evlist__set_sample_bit(struct perf_evlist *evlist,
93 enum perf_event_sample_format bit);
94void __perf_evlist__reset_sample_bit(struct perf_evlist *evlist,
95 enum perf_event_sample_format bit);
96
97#define perf_evlist__set_sample_bit(evlist, bit) \
98 __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
99
100#define perf_evlist__reset_sample_bit(evlist, bit) \
101 __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
102
745cefc5 103int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
cfd70a26 104int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid);
be199ada 105int perf_evlist__set_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids);
745cefc5 106
da378962
ACM
107struct perf_evsel *
108perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
109
a2f2804a
DA
110struct perf_evsel *
111perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
112 const char *name);
113
a91e5431
ACM
114void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
115 int cpu, int thread, u64 id);
1c59612d
JO
116int perf_evlist__id_add_fd(struct perf_evlist *evlist,
117 struct perf_evsel *evsel,
118 int cpu, int thread, int fd);
3d3b5e95 119
ad6765dd
ACM
120int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
121int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
1ddec7f0
ACM
122int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);
123
f66a889d
ACM
124int perf_evlist__poll(struct perf_evlist *evlist, int timeout);
125
70db7533 126struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
dddcf6ab
AH
127struct perf_evsel *perf_evlist__id2evsel_strict(struct perf_evlist *evlist,
128 u64 id);
70db7533 129
932a3594
JO
130struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);
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
65aea233
WN
142int perf_evlist__pause(struct perf_evlist *evlist);
143int perf_evlist__resume(struct perf_evlist *evlist);
6a4bb04c 144int perf_evlist__open(struct perf_evlist *evlist);
a74b4b66 145void perf_evlist__close(struct perf_evlist *evlist);
727ab04e 146
e68ae9cf
ACM
147struct callchain_param;
148
75562573
AH
149void perf_evlist__set_id_pos(struct perf_evlist *evlist);
150bool perf_can_sample_identifier(void);
b757bb09 151bool perf_can_record_switch_events(void);
83509565 152bool perf_can_record_cpu_wide(void);
e68ae9cf
ACM
153void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts,
154 struct callchain_param *callchain);
b4006796 155int record_opts__config(struct record_opts *opts);
0f82ebc4 156
35b9d88e 157int perf_evlist__prepare_workload(struct perf_evlist *evlist,
602ad878 158 struct target *target,
55e162ea 159 const char *argv[], bool pipe_output,
735f7e0b
ACM
160 void (*exec_error)(int signo, siginfo_t *info,
161 void *ucontext));
35b9d88e
ACM
162int perf_evlist__start_workload(struct perf_evlist *evlist);
163
724ce97e
ACM
164struct option;
165
e9db1310 166int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
994a1f78
JO
167int perf_evlist__parse_mmap_pages(const struct option *opt,
168 const char *str,
169 int unset);
170
f5e7150c
ACM
171unsigned long perf_event_mlock_kb_in_pages(void);
172
718c602d
AH
173int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,
174 bool overwrite, unsigned int auxtrace_pages,
175 bool auxtrace_overwrite);
50a682ce
ACM
176int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
177 bool overwrite);
7e2ed097
ACM
178void perf_evlist__munmap(struct perf_evlist *evlist);
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
ACM
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}
78f067b3
ACM
224
225size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
0479b8b9 226
a8f23d8f 227int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
956fa571 228int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size);
6ef068cb 229
7b8283b5 230static inline u64 perf_mmap__read_head(struct perf_mmap *mm)
0479b8b9
DA
231{
232 struct perf_event_mmap_page *pc = mm->base;
7b8283b5 233 u64 head = ACCESS_ONCE(pc->data_head);
0479b8b9
DA
234 rmb();
235 return head;
236}
237
7b8283b5 238static inline void perf_mmap__write_tail(struct perf_mmap *md, u64 tail)
0479b8b9
DA
239{
240 struct perf_event_mmap_page *pc = md->base;
241
242 /*
243 * ensure all reads are done before we write the tail out.
244 */
a94d342b 245 mb();
0479b8b9
DA
246 pc->data_tail = tail;
247}
248
c09ec622 249bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
a025e4f0
AH
250void perf_evlist__to_front(struct perf_evlist *evlist,
251 struct perf_evsel *move_evsel);
252
0050f7aa 253/**
e5cadb93 254 * __evlist__for_each_entry - iterate thru all the evsels
0050f7aa
ACM
255 * @list: list_head instance to iterate
256 * @evsel: struct evsel iterator
257 */
e5cadb93 258#define __evlist__for_each_entry(list, evsel) \
0050f7aa
ACM
259 list_for_each_entry(evsel, list, node)
260
261/**
e5cadb93 262 * evlist__for_each_entry - iterate thru all the evsels
0050f7aa
ACM
263 * @evlist: evlist instance to iterate
264 * @evsel: struct evsel iterator
265 */
e5cadb93
ACM
266#define evlist__for_each_entry(evlist, evsel) \
267 __evlist__for_each_entry(&(evlist)->entries, evsel)
0050f7aa
ACM
268
269/**
e5cadb93 270 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
0050f7aa
ACM
271 * @list: list_head instance to iterate
272 * @evsel: struct evsel iterator
273 */
e5cadb93 274#define __evlist__for_each_entry_continue(list, evsel) \
0050f7aa
ACM
275 list_for_each_entry_continue(evsel, list, node)
276
277/**
e5cadb93 278 * evlist__for_each_entry_continue - continue iteration thru all the evsels
0050f7aa
ACM
279 * @evlist: evlist instance to iterate
280 * @evsel: struct evsel iterator
281 */
e5cadb93
ACM
282#define evlist__for_each_entry_continue(evlist, evsel) \
283 __evlist__for_each_entry_continue(&(evlist)->entries, evsel)
0050f7aa
ACM
284
285/**
e5cadb93 286 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
0050f7aa
ACM
287 * @list: list_head instance to iterate
288 * @evsel: struct evsel iterator
289 */
e5cadb93 290#define __evlist__for_each_entry_reverse(list, evsel) \
0050f7aa
ACM
291 list_for_each_entry_reverse(evsel, list, node)
292
293/**
e5cadb93 294 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
0050f7aa
ACM
295 * @evlist: evlist instance to iterate
296 * @evsel: struct evsel iterator
297 */
e5cadb93
ACM
298#define evlist__for_each_entry_reverse(evlist, evsel) \
299 __evlist__for_each_entry_reverse(&(evlist)->entries, evsel)
0050f7aa
ACM
300
301/**
e5cadb93 302 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
0050f7aa
ACM
303 * @list: list_head instance to iterate
304 * @tmp: struct evsel temp iterator
305 * @evsel: struct evsel iterator
306 */
e5cadb93 307#define __evlist__for_each_entry_safe(list, tmp, evsel) \
0050f7aa
ACM
308 list_for_each_entry_safe(evsel, tmp, list, node)
309
310/**
e5cadb93 311 * evlist__for_each_entry_safe - safely iterate thru all the evsels
0050f7aa
ACM
312 * @evlist: evlist instance to iterate
313 * @evsel: struct evsel iterator
314 * @tmp: struct evsel temp iterator
315 */
e5cadb93
ACM
316#define evlist__for_each_entry_safe(evlist, tmp, evsel) \
317 __evlist__for_each_entry_safe(&(evlist)->entries, tmp, evsel)
c09ec622 318
60b0896c
AH
319void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
320 struct perf_evsel *tracking_evsel);
45cf6c33
JO
321
322void perf_event_attr__set_max_precise_ip(struct perf_event_attr *attr);
7630b3e2
WN
323
324struct perf_evsel *
325perf_evlist__find_evsel_by_str(struct perf_evlist *evlist, const char *str);
361c99a6 326#endif /* __PERF_EVLIST_H */
This page took 0.280668 seconds and 5 git commands to generate.