1 #ifndef __PERF_EVLIST_H
2 #define __PERF_EVLIST_H 1
3
4 #include <linux/list.h>
5 #include <api/fd/array.h>
6 #include <stdio.h>
7 #include "../perf.h"
8 #include "event.h"
9 #include "evsel.h"
10 #include "util.h"
11 #include <unistd.h>
12
13 struct pollfd;
14 struct thread_map;
15 struct cpu_map;
16 struct record_opts;
17
18 #define PERF_EVLIST__HLIST_BITS 8
19 #define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
20
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 */
26 struct perf_mmap {
27 void *base;
28 int mask;
29 int refcnt;
30 unsigned int prev;
31 char event_copy[PERF_SAMPLE_MAX_SIZE];
32 };
33
34 struct perf_evlist {
35 struct list_head entries;
36 struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
37 int nr_entries;
38 int nr_groups;
39 int nr_mmaps;
40 size_t mmap_len;
41 int id_pos;
42 int is_pos;
43 u64 combined_sample_type;
44 struct {
45 int cork_fd;
46 pid_t pid;
47 } workload;
48 bool overwrite;
49 struct fdarray pollfd;
50 struct perf_mmap *mmap;
51 struct thread_map *threads;
52 struct cpu_map *cpus;
53 struct perf_evsel *selected;
54 };
55
56 struct perf_evsel_str_handler {
57 const char *name;
58 void *handler;
59 };
60
61 struct perf_evlist *perf_evlist__new(void);
62 struct perf_evlist *perf_evlist__new_default(void);
63 void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
64 struct thread_map *threads);
65 void perf_evlist__exit(struct perf_evlist *evlist);
66 void perf_evlist__delete(struct perf_evlist *evlist);
67
68 void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
69 int perf_evlist__add_default(struct perf_evlist *evlist);
70 int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
71 struct perf_event_attr *attrs, size_t nr_attrs);
72
73 #define perf_evlist__add_default_attrs(evlist, array) \
74 __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
75
76 int perf_evlist__add_newtp(struct perf_evlist *evlist,
77 const char *sys, const char *name, void *handler);
78
79 int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
80
81 struct perf_evsel *
82 perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
83
84 struct perf_evsel *
85 perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
86 const char *name);
87
88 void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
89 int cpu, int thread, u64 id);
90
91 int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
92 int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
93 int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);
94
95 int perf_evlist__poll(struct perf_evlist *evlist, int timeout);
96
97 struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
98
99 struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);
100
101 union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx);
102
103 void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);
104
105 int perf_evlist__open(struct perf_evlist *evlist);
106 void perf_evlist__close(struct perf_evlist *evlist);
107
108 void perf_evlist__set_id_pos(struct perf_evlist *evlist);
109 bool perf_can_sample_identifier(void);
110 void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts);
111 int record_opts__config(struct record_opts *opts);
112
113 int perf_evlist__prepare_workload(struct perf_evlist *evlist,
114 struct target *target,
115 const char *argv[], bool pipe_output,
116 void (*exec_error)(int signo, siginfo_t *info,
117 void *ucontext));
118 int perf_evlist__start_workload(struct perf_evlist *evlist);
119
120 struct option;
121
122 int perf_evlist__parse_mmap_pages(const struct option *opt,
123 const char *str,
124 int unset);
125
126 int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
127 bool overwrite);
128 void perf_evlist__munmap(struct perf_evlist *evlist);
129
130 void perf_evlist__disable(struct perf_evlist *evlist);
131 void perf_evlist__enable(struct perf_evlist *evlist);
132
133 int perf_evlist__disable_event(struct perf_evlist *evlist,
134 struct perf_evsel *evsel);
135 int perf_evlist__enable_event(struct perf_evlist *evlist,
136 struct perf_evsel *evsel);
137 int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
138 struct perf_evsel *evsel, int idx);
139
140 void perf_evlist__set_selected(struct perf_evlist *evlist,
141 struct perf_evsel *evsel);
142
perf_evlist__set_maps(struct perf_evlist * evlist,struct cpu_map * cpus,struct thread_map * threads)143 static inline void perf_evlist__set_maps(struct perf_evlist *evlist,
144 struct cpu_map *cpus,
145 struct thread_map *threads)
146 {
147 evlist->cpus = cpus;
148 evlist->threads = threads;
149 }
150
151 int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
152 int perf_evlist__apply_filters(struct perf_evlist *evlist);
153
154 void __perf_evlist__set_leader(struct list_head *list);
155 void perf_evlist__set_leader(struct perf_evlist *evlist);
156
157 u64 perf_evlist__read_format(struct perf_evlist *evlist);
158 u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
159 u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
160 bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
161 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
162
163 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
164 struct perf_sample *sample);
165
166 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
167 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
168 bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
169
170 void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
171 struct list_head *list,
172 int nr_entries);
173
perf_evlist__first(struct perf_evlist * evlist)174 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
175 {
176 return list_entry(evlist->entries.next, struct perf_evsel, node);
177 }
178
perf_evlist__last(struct perf_evlist * evlist)179 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
180 {
181 return list_entry(evlist->entries.prev, struct perf_evsel, node);
182 }
183
184 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
185
186 int perf_evlist__strerror_tp(struct perf_evlist *evlist, int err, char *buf, size_t size);
187 int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
188
perf_mmap__read_head(struct perf_mmap * mm)189 static inline unsigned int perf_mmap__read_head(struct perf_mmap *mm)
190 {
191 struct perf_event_mmap_page *pc = mm->base;
192 int head = ACCESS_ONCE(pc->data_head);
193 rmb();
194 return head;
195 }
196
perf_mmap__write_tail(struct perf_mmap * md,unsigned long tail)197 static inline void perf_mmap__write_tail(struct perf_mmap *md,
198 unsigned long tail)
199 {
200 struct perf_event_mmap_page *pc = md->base;
201
202 /*
203 * ensure all reads are done before we write the tail out.
204 */
205 mb();
206 pc->data_tail = tail;
207 }
208
209 bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
210 void perf_evlist__to_front(struct perf_evlist *evlist,
211 struct perf_evsel *move_evsel);
212
213 /**
214 * __evlist__for_each - iterate thru all the evsels
215 * @list: list_head instance to iterate
216 * @evsel: struct evsel iterator
217 */
218 #define __evlist__for_each(list, evsel) \
219 list_for_each_entry(evsel, list, node)
220
221 /**
222 * evlist__for_each - iterate thru all the evsels
223 * @evlist: evlist instance to iterate
224 * @evsel: struct evsel iterator
225 */
226 #define evlist__for_each(evlist, evsel) \
227 __evlist__for_each(&(evlist)->entries, evsel)
228
229 /**
230 * __evlist__for_each_continue - continue iteration thru all the evsels
231 * @list: list_head instance to iterate
232 * @evsel: struct evsel iterator
233 */
234 #define __evlist__for_each_continue(list, evsel) \
235 list_for_each_entry_continue(evsel, list, node)
236
237 /**
238 * evlist__for_each_continue - continue iteration thru all the evsels
239 * @evlist: evlist instance to iterate
240 * @evsel: struct evsel iterator
241 */
242 #define evlist__for_each_continue(evlist, evsel) \
243 __evlist__for_each_continue(&(evlist)->entries, evsel)
244
245 /**
246 * __evlist__for_each_reverse - iterate thru all the evsels in reverse order
247 * @list: list_head instance to iterate
248 * @evsel: struct evsel iterator
249 */
250 #define __evlist__for_each_reverse(list, evsel) \
251 list_for_each_entry_reverse(evsel, list, node)
252
253 /**
254 * evlist__for_each_reverse - iterate thru all the evsels in reverse order
255 * @evlist: evlist instance to iterate
256 * @evsel: struct evsel iterator
257 */
258 #define evlist__for_each_reverse(evlist, evsel) \
259 __evlist__for_each_reverse(&(evlist)->entries, evsel)
260
261 /**
262 * __evlist__for_each_safe - safely iterate thru all the evsels
263 * @list: list_head instance to iterate
264 * @tmp: struct evsel temp iterator
265 * @evsel: struct evsel iterator
266 */
267 #define __evlist__for_each_safe(list, tmp, evsel) \
268 list_for_each_entry_safe(evsel, tmp, list, node)
269
270 /**
271 * evlist__for_each_safe - safely iterate thru all the evsels
272 * @evlist: evlist instance to iterate
273 * @evsel: struct evsel iterator
274 * @tmp: struct evsel temp iterator
275 */
276 #define evlist__for_each_safe(evlist, tmp, evsel) \
277 __evlist__for_each_safe(&(evlist)->entries, tmp, evsel)
278
279 void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
280 struct perf_evsel *tracking_evsel);
281
282 #endif /* __PERF_EVLIST_H */
283