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