]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - tools/perf/util/evlist.h
perf header: Add AUX area tracing feature
[mirror_ubuntu-hirsute-kernel.git] / tools / perf / util / evlist.h
CommitLineData
361c99a6
ACM
1#ifndef __PERF_EVLIST_H
2#define __PERF_EVLIST_H 1
3
4#include <linux/list.h>
1b85337d 5#include <api/fd/array.h>
50d08e47 6#include <stdio.h>
70db7533 7#include "../perf.h"
04391deb 8#include "event.h"
0c21f736 9#include "evsel.h"
50d08e47 10#include "util.h"
35b9d88e 11#include <unistd.h>
361c99a6 12
5c581041 13struct pollfd;
f8a95309
ACM
14struct thread_map;
15struct cpu_map;
b4006796 16struct record_opts;
5c581041 17
70db7533
ACM
18#define PERF_EVLIST__HLIST_BITS 8
19#define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
20
82396986
ACM
21/**
22 * struct perf_mmap - perf's ring buffer mmap details
23 *
24 * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
25 */
0479b8b9
DA
26struct perf_mmap {
27 void *base;
28 int mask;
82396986 29 int refcnt;
7b8283b5 30 u64 prev;
a73b6c19 31 char event_copy[PERF_SAMPLE_MAX_SIZE] __attribute__((aligned(8)));
0479b8b9
DA
32};
33
361c99a6
ACM
34struct perf_evlist {
35 struct list_head entries;
70db7533 36 struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
361c99a6 37 int nr_entries;
97f63e4a 38 int nr_groups;
aece948f 39 int nr_mmaps;
994a1f78 40 size_t mmap_len;
75562573
AH
41 int id_pos;
42 int is_pos;
43 u64 combined_sample_type;
35b9d88e
ACM
44 struct {
45 int cork_fd;
46 pid_t pid;
47 } workload;
7bb41152 48 bool overwrite;
1b85337d 49 struct fdarray pollfd;
70db7533 50 struct perf_mmap *mmap;
7e2ed097
ACM
51 struct thread_map *threads;
52 struct cpu_map *cpus;
81cce8de 53 struct perf_evsel *selected;
75be989a 54 struct events_stats stats;
361c99a6
ACM
55};
56
ee29be62
ACM
57struct perf_evsel_str_handler {
58 const char *name;
59 void *handler;
60};
61
334fe7a3 62struct perf_evlist *perf_evlist__new(void);
b22d54b0 63struct perf_evlist *perf_evlist__new_default(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);
70int perf_evlist__add_default(struct perf_evlist *evlist);
79695e1b
ACM
71int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
72 struct perf_event_attr *attrs, size_t nr_attrs);
e60fc847 73
79695e1b
ACM
74#define perf_evlist__add_default_attrs(evlist, array) \
75 __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
361c99a6 76
39876e7d
ACM
77int perf_evlist__add_newtp(struct perf_evlist *evlist,
78 const char *sys, const char *name, void *handler);
79
745cefc5 80int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
cfd70a26 81int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid);
be199ada 82int perf_evlist__set_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids);
745cefc5 83
da378962
ACM
84struct perf_evsel *
85perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
86
a2f2804a
DA
87struct perf_evsel *
88perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
89 const char *name);
90
a91e5431
ACM
91void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
92 int cpu, int thread, u64 id);
3d3b5e95 93
ad6765dd
ACM
94int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
95int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
1ddec7f0
ACM
96int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);
97
f66a889d
ACM
98int perf_evlist__poll(struct perf_evlist *evlist, int timeout);
99
70db7533
ACM
100struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
101
932a3594
JO
102struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);
103
316c7136 104union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx);
04391deb 105
8e50d384
ZZ
106void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);
107
6a4bb04c 108int perf_evlist__open(struct perf_evlist *evlist);
a74b4b66 109void perf_evlist__close(struct perf_evlist *evlist);
727ab04e 110
75562573
AH
111void perf_evlist__set_id_pos(struct perf_evlist *evlist);
112bool perf_can_sample_identifier(void);
b4006796
ACM
113void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts);
114int record_opts__config(struct record_opts *opts);
0f82ebc4 115
35b9d88e 116int perf_evlist__prepare_workload(struct perf_evlist *evlist,
602ad878 117 struct target *target,
55e162ea 118 const char *argv[], bool pipe_output,
735f7e0b
ACM
119 void (*exec_error)(int signo, siginfo_t *info,
120 void *ucontext));
35b9d88e
ACM
121int perf_evlist__start_workload(struct perf_evlist *evlist);
122
724ce97e
ACM
123struct option;
124
994a1f78
JO
125int perf_evlist__parse_mmap_pages(const struct option *opt,
126 const char *str,
127 int unset);
128
50a682ce
ACM
129int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
130 bool overwrite);
7e2ed097
ACM
131void perf_evlist__munmap(struct perf_evlist *evlist);
132
4152ab37 133void perf_evlist__disable(struct perf_evlist *evlist);
764e16a3 134void perf_evlist__enable(struct perf_evlist *evlist);
4152ab37 135
395c3070
AH
136int perf_evlist__disable_event(struct perf_evlist *evlist,
137 struct perf_evsel *evsel);
138int perf_evlist__enable_event(struct perf_evlist *evlist,
139 struct perf_evsel *evsel);
1c65056c
AH
140int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
141 struct perf_evsel *evsel, int idx);
395c3070 142
81cce8de
ACM
143void perf_evlist__set_selected(struct perf_evlist *evlist,
144 struct perf_evsel *evsel);
145
7e2ed097
ACM
146static inline void perf_evlist__set_maps(struct perf_evlist *evlist,
147 struct cpu_map *cpus,
148 struct thread_map *threads)
149{
150 evlist->cpus = cpus;
151 evlist->threads = threads;
152}
153
602ad878 154int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
23d4aad4 155int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel);
f8a95309 156
63dab225
ACM
157void __perf_evlist__set_leader(struct list_head *list);
158void perf_evlist__set_leader(struct perf_evlist *evlist);
159
9ede473c 160u64 perf_evlist__read_format(struct perf_evlist *evlist);
75562573
AH
161u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
162u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
0c21f736
ACM
163bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
164u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
74429964 165
a3f698fe 166int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
0807d2d8 167 struct perf_sample *sample);
cb0b29e0 168
0c21f736
ACM
169bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
170bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
9ede473c 171bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
0529bc1f
JO
172
173void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
174 struct list_head *list,
175 int nr_entries);
0c21f736
ACM
176
177static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
178{
179 return list_entry(evlist->entries.next, struct perf_evsel, node);
180}
181
182static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
183{
184 return list_entry(evlist->entries.prev, struct perf_evsel, node);
185}
78f067b3
ACM
186
187size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
0479b8b9 188
a8f23d8f 189int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
956fa571 190int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size);
6ef068cb 191
7b8283b5 192static inline u64 perf_mmap__read_head(struct perf_mmap *mm)
0479b8b9
DA
193{
194 struct perf_event_mmap_page *pc = mm->base;
7b8283b5 195 u64 head = ACCESS_ONCE(pc->data_head);
0479b8b9
DA
196 rmb();
197 return head;
198}
199
7b8283b5 200static inline void perf_mmap__write_tail(struct perf_mmap *md, u64 tail)
0479b8b9
DA
201{
202 struct perf_event_mmap_page *pc = md->base;
203
204 /*
205 * ensure all reads are done before we write the tail out.
206 */
a94d342b 207 mb();
0479b8b9
DA
208 pc->data_tail = tail;
209}
210
c09ec622 211bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
a025e4f0
AH
212void perf_evlist__to_front(struct perf_evlist *evlist,
213 struct perf_evsel *move_evsel);
214
0050f7aa
ACM
215/**
216 * __evlist__for_each - iterate thru all the evsels
217 * @list: list_head instance to iterate
218 * @evsel: struct evsel iterator
219 */
220#define __evlist__for_each(list, evsel) \
221 list_for_each_entry(evsel, list, node)
222
223/**
224 * evlist__for_each - iterate thru all the evsels
225 * @evlist: evlist instance to iterate
226 * @evsel: struct evsel iterator
227 */
228#define evlist__for_each(evlist, evsel) \
229 __evlist__for_each(&(evlist)->entries, evsel)
230
231/**
232 * __evlist__for_each_continue - continue iteration thru all the evsels
233 * @list: list_head instance to iterate
234 * @evsel: struct evsel iterator
235 */
236#define __evlist__for_each_continue(list, evsel) \
237 list_for_each_entry_continue(evsel, list, node)
238
239/**
240 * evlist__for_each_continue - continue iteration thru all the evsels
241 * @evlist: evlist instance to iterate
242 * @evsel: struct evsel iterator
243 */
244#define evlist__for_each_continue(evlist, evsel) \
245 __evlist__for_each_continue(&(evlist)->entries, evsel)
246
247/**
248 * __evlist__for_each_reverse - iterate thru all the evsels in reverse order
249 * @list: list_head instance to iterate
250 * @evsel: struct evsel iterator
251 */
252#define __evlist__for_each_reverse(list, evsel) \
253 list_for_each_entry_reverse(evsel, list, node)
254
255/**
256 * evlist__for_each_reverse - iterate thru all the evsels in reverse order
257 * @evlist: evlist instance to iterate
258 * @evsel: struct evsel iterator
259 */
260#define evlist__for_each_reverse(evlist, evsel) \
261 __evlist__for_each_reverse(&(evlist)->entries, evsel)
262
263/**
264 * __evlist__for_each_safe - safely iterate thru all the evsels
265 * @list: list_head instance to iterate
266 * @tmp: struct evsel temp iterator
267 * @evsel: struct evsel iterator
268 */
269#define __evlist__for_each_safe(list, tmp, evsel) \
270 list_for_each_entry_safe(evsel, tmp, list, node)
271
272/**
273 * evlist__for_each_safe - safely iterate thru all the evsels
274 * @evlist: evlist instance to iterate
275 * @evsel: struct evsel iterator
276 * @tmp: struct evsel temp iterator
277 */
278#define evlist__for_each_safe(evlist, tmp, evsel) \
279 __evlist__for_each_safe(&(evlist)->entries, tmp, evsel)
c09ec622 280
60b0896c
AH
281void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
282 struct perf_evsel *tracking_evsel);
283
361c99a6 284#endif /* __PERF_EVLIST_H */