1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_EVLIST_H
3 #define __PERF_EVLIST_H 1
5 #include <linux/compiler.h>
6 #include <linux/kernel.h>
7 #include <linux/refcount.h>
8 #include <linux/list.h>
9 #include <api/fd/array.h>
25 #define PERF_EVLIST__HLIST_BITS 8
26 #define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
29 struct list_head entries;
30 struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
40 u64 combined_sample_type;
41 enum bkw_mmap_state bkw_mmap_state;
46 struct fdarray pollfd;
47 struct perf_mmap *mmap;
48 struct perf_mmap *backward_mmap;
49 struct thread_map *threads;
51 struct perf_evsel *selected;
52 struct events_stats stats;
56 struct perf_evsel_str_handler {
61 struct perf_evlist *perf_evlist__new(void);
62 struct perf_evlist *perf_evlist__new_default(void);
63 struct perf_evlist *perf_evlist__new_dummy(void);
64 void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
65 struct thread_map *threads);
66 void perf_evlist__exit(struct perf_evlist *evlist);
67 void perf_evlist__delete(struct perf_evlist *evlist);
69 void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
70 void perf_evlist__remove(struct perf_evlist *evlist, struct perf_evsel *evsel);
72 int __perf_evlist__add_default(struct perf_evlist *evlist, bool precise);
74 static inline int perf_evlist__add_default(struct perf_evlist *evlist)
76 return __perf_evlist__add_default(evlist, true);
79 int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
80 struct perf_event_attr *attrs, size_t nr_attrs);
82 #define perf_evlist__add_default_attrs(evlist, array) \
83 __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
85 int perf_evlist__add_dummy(struct perf_evlist *evlist);
87 int perf_evlist__add_newtp(struct perf_evlist *evlist,
88 const char *sys, const char *name, void *handler);
90 void __perf_evlist__set_sample_bit(struct perf_evlist *evlist,
91 enum perf_event_sample_format bit);
92 void __perf_evlist__reset_sample_bit(struct perf_evlist *evlist,
93 enum perf_event_sample_format bit);
95 #define perf_evlist__set_sample_bit(evlist, bit) \
96 __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
98 #define perf_evlist__reset_sample_bit(evlist, bit) \
99 __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
101 int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
102 int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid);
103 int perf_evlist__set_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids);
106 perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
109 perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
112 void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
113 int cpu, int thread, u64 id);
114 int perf_evlist__id_add_fd(struct perf_evlist *evlist,
115 struct perf_evsel *evsel,
116 int cpu, int thread, int fd);
118 int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
119 int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
120 int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);
122 int perf_evlist__poll(struct perf_evlist *evlist, int timeout);
124 struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
125 struct perf_evsel *perf_evlist__id2evsel_strict(struct perf_evlist *evlist,
128 struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);
130 void perf_evlist__toggle_bkw_mmap(struct perf_evlist *evlist, enum bkw_mmap_state state);
132 union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx);
134 union perf_event *perf_evlist__mmap_read_forward(struct perf_evlist *evlist,
136 union perf_event *perf_evlist__mmap_read_backward(struct perf_evlist *evlist,
138 void perf_evlist__mmap_read_catchup(struct perf_evlist *evlist, int idx);
140 void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);
142 int perf_evlist__open(struct perf_evlist *evlist);
143 void perf_evlist__close(struct perf_evlist *evlist);
145 struct callchain_param;
147 void perf_evlist__set_id_pos(struct perf_evlist *evlist);
148 bool perf_can_sample_identifier(void);
149 bool perf_can_record_switch_events(void);
150 bool perf_can_record_cpu_wide(void);
151 void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts,
152 struct callchain_param *callchain);
153 int record_opts__config(struct record_opts *opts);
155 int perf_evlist__prepare_workload(struct perf_evlist *evlist,
156 struct target *target,
157 const char *argv[], bool pipe_output,
158 void (*exec_error)(int signo, siginfo_t *info,
160 int perf_evlist__start_workload(struct perf_evlist *evlist);
164 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
165 int perf_evlist__parse_mmap_pages(const struct option *opt,
169 unsigned long perf_event_mlock_kb_in_pages(void);
171 int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,
172 bool overwrite, unsigned int auxtrace_pages,
173 bool auxtrace_overwrite);
174 int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
176 void perf_evlist__munmap(struct perf_evlist *evlist);
178 size_t perf_evlist__mmap_size(unsigned long pages);
180 void perf_evlist__disable(struct perf_evlist *evlist);
181 void perf_evlist__enable(struct perf_evlist *evlist);
182 void perf_evlist__toggle_enable(struct perf_evlist *evlist);
184 int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
185 struct perf_evsel *evsel, int idx);
187 void perf_evlist__set_selected(struct perf_evlist *evlist,
188 struct perf_evsel *evsel);
190 void perf_evlist__set_maps(struct perf_evlist *evlist, struct cpu_map *cpus,
191 struct thread_map *threads);
192 int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
193 int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel);
195 void __perf_evlist__set_leader(struct list_head *list);
196 void perf_evlist__set_leader(struct perf_evlist *evlist);
198 u64 perf_evlist__read_format(struct perf_evlist *evlist);
199 u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
200 u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
201 u64 perf_evlist__combined_branch_type(struct perf_evlist *evlist);
202 bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
203 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
205 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
206 struct perf_sample *sample);
208 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
209 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
210 bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
212 void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
213 struct list_head *list);
215 static inline bool perf_evlist__empty(struct perf_evlist *evlist)
217 return list_empty(&evlist->entries);
220 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
222 return list_entry(evlist->entries.next, struct perf_evsel, node);
225 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
227 return list_entry(evlist->entries.prev, struct perf_evsel, node);
230 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
232 int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
233 int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size);
235 bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
236 void perf_evlist__to_front(struct perf_evlist *evlist,
237 struct perf_evsel *move_evsel);
240 * __evlist__for_each_entry - iterate thru all the evsels
241 * @list: list_head instance to iterate
242 * @evsel: struct evsel iterator
244 #define __evlist__for_each_entry(list, evsel) \
245 list_for_each_entry(evsel, list, node)
248 * evlist__for_each_entry - iterate thru all the evsels
249 * @evlist: evlist instance to iterate
250 * @evsel: struct evsel iterator
252 #define evlist__for_each_entry(evlist, evsel) \
253 __evlist__for_each_entry(&(evlist)->entries, evsel)
256 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
257 * @list: list_head instance to iterate
258 * @evsel: struct evsel iterator
260 #define __evlist__for_each_entry_continue(list, evsel) \
261 list_for_each_entry_continue(evsel, list, node)
264 * evlist__for_each_entry_continue - continue iteration thru all the evsels
265 * @evlist: evlist instance to iterate
266 * @evsel: struct evsel iterator
268 #define evlist__for_each_entry_continue(evlist, evsel) \
269 __evlist__for_each_entry_continue(&(evlist)->entries, evsel)
272 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
273 * @list: list_head instance to iterate
274 * @evsel: struct evsel iterator
276 #define __evlist__for_each_entry_reverse(list, evsel) \
277 list_for_each_entry_reverse(evsel, list, node)
280 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
281 * @evlist: evlist instance to iterate
282 * @evsel: struct evsel iterator
284 #define evlist__for_each_entry_reverse(evlist, evsel) \
285 __evlist__for_each_entry_reverse(&(evlist)->entries, evsel)
288 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
289 * @list: list_head instance to iterate
290 * @tmp: struct evsel temp iterator
291 * @evsel: struct evsel iterator
293 #define __evlist__for_each_entry_safe(list, tmp, evsel) \
294 list_for_each_entry_safe(evsel, tmp, list, node)
297 * evlist__for_each_entry_safe - safely iterate thru all the evsels
298 * @evlist: evlist instance to iterate
299 * @evsel: struct evsel iterator
300 * @tmp: struct evsel temp iterator
302 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
303 __evlist__for_each_entry_safe(&(evlist)->entries, tmp, evsel)
305 void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
306 struct perf_evsel *tracking_evsel);
308 void perf_event_attr__set_max_precise_ip(struct perf_event_attr *attr);
311 perf_evlist__find_evsel_by_str(struct perf_evlist *evlist, const char *str);
313 struct perf_evsel *perf_evlist__event2evsel(struct perf_evlist *evlist,
314 union perf_event *event);
316 bool perf_evlist__exclude_kernel(struct perf_evlist *evlist);
317 #endif /* __PERF_EVLIST_H */