1 #ifndef __PERF_EVLIST_H
2 #define __PERF_EVLIST_H 1
4 #include <linux/compiler.h>
5 #include <linux/kernel.h>
6 #include <linux/refcount.h>
7 #include <linux/list.h>
8 #include <api/fd/array.h>
23 #define PERF_EVLIST__HLIST_BITS 8
24 #define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
27 * struct perf_mmap - perf's ring buffer mmap details
29 * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
37 struct auxtrace_mmap auxtrace_mmap
;
38 char event_copy
[PERF_SAMPLE_MAX_SIZE
] __aligned(8);
42 perf_mmap__mmap_len(struct perf_mmap
*map
)
44 return map
->mask
+ 1 + page_size
;
48 * State machine of bkw_mmap_state:
50 * .________________(forbid)_____________.
52 * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
54 * | |__(forbid)____/ |___(forbid)___/|
56 * \_________________(3)_______________/
58 * NOTREADY : Backward ring buffers are not ready
59 * RUNNING : Backward ring buffers are recording
60 * DATA_PENDING : We are required to collect data from backward ring buffers
61 * EMPTY : We have collected data from backward ring buffers.
63 * (0): Setup backward ring buffer
64 * (1): Pause ring buffers for reading
65 * (2): Read from ring buffers
66 * (3): Resume ring buffers for recording
71 BKW_MMAP_DATA_PENDING
,
76 struct list_head entries
;
77 struct hlist_head heads
[PERF_EVLIST__HLIST_SIZE
];
87 u64 combined_sample_type
;
88 enum bkw_mmap_state bkw_mmap_state
;
93 struct fdarray pollfd
;
94 struct perf_mmap
*mmap
;
95 struct perf_mmap
*backward_mmap
;
96 struct thread_map
*threads
;
98 struct perf_evsel
*selected
;
99 struct events_stats stats
;
100 struct perf_env
*env
;
103 struct perf_evsel_str_handler
{
108 struct perf_evlist
*perf_evlist__new(void);
109 struct perf_evlist
*perf_evlist__new_default(void);
110 struct perf_evlist
*perf_evlist__new_dummy(void);
111 void perf_evlist__init(struct perf_evlist
*evlist
, struct cpu_map
*cpus
,
112 struct thread_map
*threads
);
113 void perf_evlist__exit(struct perf_evlist
*evlist
);
114 void perf_evlist__delete(struct perf_evlist
*evlist
);
116 void perf_evlist__add(struct perf_evlist
*evlist
, struct perf_evsel
*entry
);
117 void perf_evlist__remove(struct perf_evlist
*evlist
, struct perf_evsel
*evsel
);
119 int __perf_evlist__add_default(struct perf_evlist
*evlist
, bool precise
);
121 static inline int perf_evlist__add_default(struct perf_evlist
*evlist
)
123 return __perf_evlist__add_default(evlist
, true);
126 int __perf_evlist__add_default_attrs(struct perf_evlist
*evlist
,
127 struct perf_event_attr
*attrs
, size_t nr_attrs
);
129 #define perf_evlist__add_default_attrs(evlist, array) \
130 __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
132 int perf_evlist__add_dummy(struct perf_evlist
*evlist
);
134 int perf_evlist__add_newtp(struct perf_evlist
*evlist
,
135 const char *sys
, const char *name
, void *handler
);
137 void __perf_evlist__set_sample_bit(struct perf_evlist
*evlist
,
138 enum perf_event_sample_format bit
);
139 void __perf_evlist__reset_sample_bit(struct perf_evlist
*evlist
,
140 enum perf_event_sample_format bit
);
142 #define perf_evlist__set_sample_bit(evlist, bit) \
143 __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
145 #define perf_evlist__reset_sample_bit(evlist, bit) \
146 __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
148 int perf_evlist__set_filter(struct perf_evlist
*evlist
, const char *filter
);
149 int perf_evlist__set_filter_pid(struct perf_evlist
*evlist
, pid_t pid
);
150 int perf_evlist__set_filter_pids(struct perf_evlist
*evlist
, size_t npids
, pid_t
*pids
);
153 perf_evlist__find_tracepoint_by_id(struct perf_evlist
*evlist
, int id
);
156 perf_evlist__find_tracepoint_by_name(struct perf_evlist
*evlist
,
159 void perf_evlist__id_add(struct perf_evlist
*evlist
, struct perf_evsel
*evsel
,
160 int cpu
, int thread
, u64 id
);
161 int perf_evlist__id_add_fd(struct perf_evlist
*evlist
,
162 struct perf_evsel
*evsel
,
163 int cpu
, int thread
, int fd
);
165 int perf_evlist__add_pollfd(struct perf_evlist
*evlist
, int fd
);
166 int perf_evlist__alloc_pollfd(struct perf_evlist
*evlist
);
167 int perf_evlist__filter_pollfd(struct perf_evlist
*evlist
, short revents_and_mask
);
169 int perf_evlist__poll(struct perf_evlist
*evlist
, int timeout
);
171 struct perf_evsel
*perf_evlist__id2evsel(struct perf_evlist
*evlist
, u64 id
);
172 struct perf_evsel
*perf_evlist__id2evsel_strict(struct perf_evlist
*evlist
,
175 struct perf_sample_id
*perf_evlist__id2sid(struct perf_evlist
*evlist
, u64 id
);
177 void perf_evlist__toggle_bkw_mmap(struct perf_evlist
*evlist
, enum bkw_mmap_state state
);
179 union perf_event
*perf_mmap__read_forward(struct perf_mmap
*map
, bool check_messup
);
180 union perf_event
*perf_mmap__read_backward(struct perf_mmap
*map
);
182 void perf_mmap__read_catchup(struct perf_mmap
*md
);
183 void perf_mmap__consume(struct perf_mmap
*md
, bool overwrite
);
185 union perf_event
*perf_evlist__mmap_read(struct perf_evlist
*evlist
, int idx
);
187 union perf_event
*perf_evlist__mmap_read_forward(struct perf_evlist
*evlist
,
189 union perf_event
*perf_evlist__mmap_read_backward(struct perf_evlist
*evlist
,
191 void perf_evlist__mmap_read_catchup(struct perf_evlist
*evlist
, int idx
);
193 void perf_evlist__mmap_consume(struct perf_evlist
*evlist
, int idx
);
195 int perf_evlist__open(struct perf_evlist
*evlist
);
196 void perf_evlist__close(struct perf_evlist
*evlist
);
198 struct callchain_param
;
200 void perf_evlist__set_id_pos(struct perf_evlist
*evlist
);
201 bool perf_can_sample_identifier(void);
202 bool perf_can_record_switch_events(void);
203 bool perf_can_record_cpu_wide(void);
204 void perf_evlist__config(struct perf_evlist
*evlist
, struct record_opts
*opts
,
205 struct callchain_param
*callchain
);
206 int record_opts__config(struct record_opts
*opts
);
208 int perf_evlist__prepare_workload(struct perf_evlist
*evlist
,
209 struct target
*target
,
210 const char *argv
[], bool pipe_output
,
211 void (*exec_error
)(int signo
, siginfo_t
*info
,
213 int perf_evlist__start_workload(struct perf_evlist
*evlist
);
217 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages
, const char *str
);
218 int perf_evlist__parse_mmap_pages(const struct option
*opt
,
222 unsigned long perf_event_mlock_kb_in_pages(void);
224 int perf_evlist__mmap_ex(struct perf_evlist
*evlist
, unsigned int pages
,
225 bool overwrite
, unsigned int auxtrace_pages
,
226 bool auxtrace_overwrite
);
227 int perf_evlist__mmap(struct perf_evlist
*evlist
, unsigned int pages
,
229 void perf_evlist__munmap(struct perf_evlist
*evlist
);
231 size_t perf_evlist__mmap_size(unsigned long pages
);
233 void perf_evlist__disable(struct perf_evlist
*evlist
);
234 void perf_evlist__enable(struct perf_evlist
*evlist
);
235 void perf_evlist__toggle_enable(struct perf_evlist
*evlist
);
237 int perf_evlist__enable_event_idx(struct perf_evlist
*evlist
,
238 struct perf_evsel
*evsel
, int idx
);
240 void perf_evlist__set_selected(struct perf_evlist
*evlist
,
241 struct perf_evsel
*evsel
);
243 void perf_evlist__set_maps(struct perf_evlist
*evlist
, struct cpu_map
*cpus
,
244 struct thread_map
*threads
);
245 int perf_evlist__create_maps(struct perf_evlist
*evlist
, struct target
*target
);
246 int perf_evlist__apply_filters(struct perf_evlist
*evlist
, struct perf_evsel
**err_evsel
);
248 void __perf_evlist__set_leader(struct list_head
*list
);
249 void perf_evlist__set_leader(struct perf_evlist
*evlist
);
251 u64
perf_evlist__read_format(struct perf_evlist
*evlist
);
252 u64
__perf_evlist__combined_sample_type(struct perf_evlist
*evlist
);
253 u64
perf_evlist__combined_sample_type(struct perf_evlist
*evlist
);
254 u64
perf_evlist__combined_branch_type(struct perf_evlist
*evlist
);
255 bool perf_evlist__sample_id_all(struct perf_evlist
*evlist
);
256 u16
perf_evlist__id_hdr_size(struct perf_evlist
*evlist
);
258 int perf_evlist__parse_sample(struct perf_evlist
*evlist
, union perf_event
*event
,
259 struct perf_sample
*sample
);
261 bool perf_evlist__valid_sample_type(struct perf_evlist
*evlist
);
262 bool perf_evlist__valid_sample_id_all(struct perf_evlist
*evlist
);
263 bool perf_evlist__valid_read_format(struct perf_evlist
*evlist
);
265 void perf_evlist__splice_list_tail(struct perf_evlist
*evlist
,
266 struct list_head
*list
);
268 static inline bool perf_evlist__empty(struct perf_evlist
*evlist
)
270 return list_empty(&evlist
->entries
);
273 static inline struct perf_evsel
*perf_evlist__first(struct perf_evlist
*evlist
)
275 return list_entry(evlist
->entries
.next
, struct perf_evsel
, node
);
278 static inline struct perf_evsel
*perf_evlist__last(struct perf_evlist
*evlist
)
280 return list_entry(evlist
->entries
.prev
, struct perf_evsel
, node
);
283 size_t perf_evlist__fprintf(struct perf_evlist
*evlist
, FILE *fp
);
285 int perf_evlist__strerror_open(struct perf_evlist
*evlist
, int err
, char *buf
, size_t size
);
286 int perf_evlist__strerror_mmap(struct perf_evlist
*evlist
, int err
, char *buf
, size_t size
);
288 static inline u64
perf_mmap__read_head(struct perf_mmap
*mm
)
290 struct perf_event_mmap_page
*pc
= mm
->base
;
291 u64 head
= ACCESS_ONCE(pc
->data_head
);
296 static inline void perf_mmap__write_tail(struct perf_mmap
*md
, u64 tail
)
298 struct perf_event_mmap_page
*pc
= md
->base
;
301 * ensure all reads are done before we write the tail out.
304 pc
->data_tail
= tail
;
307 bool perf_evlist__can_select_event(struct perf_evlist
*evlist
, const char *str
);
308 void perf_evlist__to_front(struct perf_evlist
*evlist
,
309 struct perf_evsel
*move_evsel
);
312 * __evlist__for_each_entry - iterate thru all the evsels
313 * @list: list_head instance to iterate
314 * @evsel: struct evsel iterator
316 #define __evlist__for_each_entry(list, evsel) \
317 list_for_each_entry(evsel, list, node)
320 * evlist__for_each_entry - iterate thru all the evsels
321 * @evlist: evlist instance to iterate
322 * @evsel: struct evsel iterator
324 #define evlist__for_each_entry(evlist, evsel) \
325 __evlist__for_each_entry(&(evlist)->entries, evsel)
328 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
329 * @list: list_head instance to iterate
330 * @evsel: struct evsel iterator
332 #define __evlist__for_each_entry_continue(list, evsel) \
333 list_for_each_entry_continue(evsel, list, node)
336 * evlist__for_each_entry_continue - continue iteration thru all the evsels
337 * @evlist: evlist instance to iterate
338 * @evsel: struct evsel iterator
340 #define evlist__for_each_entry_continue(evlist, evsel) \
341 __evlist__for_each_entry_continue(&(evlist)->entries, evsel)
344 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
345 * @list: list_head instance to iterate
346 * @evsel: struct evsel iterator
348 #define __evlist__for_each_entry_reverse(list, evsel) \
349 list_for_each_entry_reverse(evsel, list, node)
352 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
353 * @evlist: evlist instance to iterate
354 * @evsel: struct evsel iterator
356 #define evlist__for_each_entry_reverse(evlist, evsel) \
357 __evlist__for_each_entry_reverse(&(evlist)->entries, evsel)
360 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
361 * @list: list_head instance to iterate
362 * @tmp: struct evsel temp iterator
363 * @evsel: struct evsel iterator
365 #define __evlist__for_each_entry_safe(list, tmp, evsel) \
366 list_for_each_entry_safe(evsel, tmp, list, node)
369 * evlist__for_each_entry_safe - safely iterate thru all the evsels
370 * @evlist: evlist instance to iterate
371 * @evsel: struct evsel iterator
372 * @tmp: struct evsel temp iterator
374 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
375 __evlist__for_each_entry_safe(&(evlist)->entries, tmp, evsel)
377 void perf_evlist__set_tracking_event(struct perf_evlist
*evlist
,
378 struct perf_evsel
*tracking_evsel
);
380 void perf_event_attr__set_max_precise_ip(struct perf_event_attr
*attr
);
383 perf_evlist__find_evsel_by_str(struct perf_evlist
*evlist
, const char *str
);
385 struct perf_evsel
*perf_evlist__event2evsel(struct perf_evlist
*evlist
,
386 union perf_event
*event
);
387 #endif /* __PERF_EVLIST_H */