evlist.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2#ifndef __PERF_EVLIST_H
  3#define __PERF_EVLIST_H 1
  4
  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>
 10#include <internal/evlist.h>
 11#include <internal/evsel.h>
 12#include <perf/evlist.h>
 13#include "events_stats.h"
 14#include "evsel.h"
 15#include "rblist.h"
 16#include <pthread.h>
 17#include <signal.h>
 18#include <unistd.h>
 19
 20struct pollfd;
 21struct thread_map;
 22struct perf_cpu_map;
 23struct perf_stat_config;
 24struct record_opts;
 25struct strbuf;
 26struct target;
 27
 28/*
 29 * State machine of bkw_mmap_state:
 30 *
 31 *                     .________________(forbid)_____________.
 32 *                     |                                     V
 33 * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
 34 *                     ^  ^              |   ^               |
 35 *                     |  |__(forbid)____/   |___(forbid)___/|
 36 *                     |                                     |
 37 *                      \_________________(3)_______________/
 38 *
 39 * NOTREADY     : Backward ring buffers are not ready
 40 * RUNNING      : Backward ring buffers are recording
 41 * DATA_PENDING : We are required to collect data from backward ring buffers
 42 * EMPTY        : We have collected data from backward ring buffers.
 43 *
 44 * (0): Setup backward ring buffer
 45 * (1): Pause ring buffers for reading
 46 * (2): Read from ring buffers
 47 * (3): Resume ring buffers for recording
 48 */
 49enum bkw_mmap_state {
 50	BKW_MMAP_NOTREADY,
 51	BKW_MMAP_RUNNING,
 52	BKW_MMAP_DATA_PENDING,
 53	BKW_MMAP_EMPTY,
 54};
 55
 56struct event_enable_timer;
 57
 58struct evlist {
 59	struct perf_evlist core;
 60	bool		 enabled;
 61	int		 id_pos;
 62	int		 is_pos;
 63	int		 nr_br_cntr;
 64	u64		 combined_sample_type;
 65	enum bkw_mmap_state bkw_mmap_state;
 66	struct {
 67		int	cork_fd;
 68		pid_t	pid;
 69	} workload;
 70	struct mmap *mmap;
 71	struct mmap *overwrite_mmap;
 72	struct evsel *selected;
 73	struct events_stats stats;
 74	struct perf_session *session;
 75	void (*trace_event_sample_raw)(struct evlist *evlist,
 76				       union perf_event *event,
 77				       struct perf_sample *sample);
 78	u64		first_sample_time;
 79	u64		last_sample_time;
 80	struct {
 81		pthread_t		th;
 82		volatile int		done;
 83	} thread;
 84	struct {
 85		int	fd;	/* control file descriptor */
 86		int	ack;	/* ack file descriptor for control commands */
 87		int	pos;	/* index at evlist core object to check signals */
 88	} ctl_fd;
 89	struct event_enable_timer *eet;
 90	/**
 91	 * @metric_events: A list of struct metric_event which each have a list
 92	 * of struct metric_expr.
 93	 */
 94	struct rblist	metric_events;
 95	/* samples with deferred_callchain would wait here. */
 96	struct list_head deferred_samples;
 97};
 98
 99struct evsel_str_handler {
100	const char *name;
101	void	   *handler;
102};
103
104struct evlist *evlist__new(void);
105struct evlist *evlist__new_default(void);
106struct evlist *evlist__new_dummy(void);
107void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus,
108		  struct perf_thread_map *threads);
109void evlist__exit(struct evlist *evlist);
110void evlist__delete(struct evlist *evlist);
111
112void evlist__add(struct evlist *evlist, struct evsel *entry);
113void evlist__remove(struct evlist *evlist, struct evsel *evsel);
114
115int arch_evlist__cmp(const struct evsel *lhs, const struct evsel *rhs);
116int arch_evlist__add_required_events(struct list_head *list);
117
118int evlist__add_dummy(struct evlist *evlist);
119struct evsel *evlist__add_aux_dummy(struct evlist *evlist, bool system_wide);
120static inline struct evsel *evlist__add_dummy_on_all_cpus(struct evlist *evlist)
121{
122	return evlist__add_aux_dummy(evlist, true);
123}
124#ifdef HAVE_LIBTRACEEVENT
125struct evsel *evlist__add_sched_switch(struct evlist *evlist, bool system_wide);
126#endif
127
128int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr,
129			 evsel__sb_cb_t cb, void *data);
130void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data);
131int evlist__start_sb_thread(struct evlist *evlist, struct target *target);
132void evlist__stop_sb_thread(struct evlist *evlist);
133
134#ifdef HAVE_LIBTRACEEVENT
135int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler);
136#endif
137
138int __evlist__set_tracepoints_handlers(struct evlist *evlist,
139				       const struct evsel_str_handler *assocs,
140				       size_t nr_assocs);
141
142#define evlist__set_tracepoints_handlers(evlist, array) \
143	__evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array))
144
145int evlist__set_tp_filter(struct evlist *evlist, const char *filter);
146int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
147
148int evlist__append_tp_filter(struct evlist *evlist, const char *filter);
149
150int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid);
151int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
152
153struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name);
154
155int evlist__add_pollfd(struct evlist *evlist, int fd);
156int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
157
158#ifdef HAVE_EVENTFD_SUPPORT
159int evlist__add_wakeup_eventfd(struct evlist *evlist, int fd);
160#endif
161
162int evlist__poll(struct evlist *evlist, int timeout);
163
164struct evsel *evlist__id2evsel(struct evlist *evlist, u64 id);
165struct evsel *evlist__id2evsel_strict(struct evlist *evlist, u64 id);
166
167struct perf_sample_id *evlist__id2sid(struct evlist *evlist, u64 id);
168
169void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
170
171void evlist__mmap_consume(struct evlist *evlist, int idx);
172
173int evlist__open(struct evlist *evlist);
174void evlist__close(struct evlist *evlist);
175
176struct callchain_param;
177
178void evlist__set_id_pos(struct evlist *evlist);
179void evlist__config(struct evlist *evlist, struct record_opts *opts, struct callchain_param *callchain);
180int record_opts__config(struct record_opts *opts);
181
182int evlist__prepare_workload(struct evlist *evlist, struct target *target,
183			     const char *argv[], bool pipe_output,
184			     void (*exec_error)(int signo, siginfo_t *info, void *ucontext));
185int evlist__start_workload(struct evlist *evlist);
186void evlist__cancel_workload(struct evlist *evlist);
187
188struct option;
189
190int __evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
191int evlist__parse_mmap_pages(const struct option *opt, const char *str, int unset);
192
193unsigned long perf_event_mlock_kb_in_pages(void);
194
195int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
196			 unsigned int auxtrace_pages,
197			 bool auxtrace_overwrite, int nr_cblocks,
198			 int affinity, int flush, int comp_level);
199int evlist__mmap(struct evlist *evlist, unsigned int pages);
200void evlist__munmap(struct evlist *evlist);
201
202size_t evlist__mmap_size(unsigned long pages);
203
204void evlist__disable(struct evlist *evlist);
205void evlist__enable(struct evlist *evlist);
206void evlist__toggle_enable(struct evlist *evlist);
207void evlist__disable_evsel(struct evlist *evlist, char *evsel_name);
208void evlist__enable_evsel(struct evlist *evlist, char *evsel_name);
209void evlist__disable_non_dummy(struct evlist *evlist);
210void evlist__enable_non_dummy(struct evlist *evlist);
211
212void evlist__set_selected(struct evlist *evlist, struct evsel *evsel);
213
214int evlist__create_maps(struct evlist *evlist, struct target *target);
215int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel,
216			  struct target *target);
217
218u64 __evlist__combined_sample_type(struct evlist *evlist);
219u64 evlist__combined_sample_type(struct evlist *evlist);
220u64 evlist__combined_branch_type(struct evlist *evlist);
221void evlist__update_br_cntr(struct evlist *evlist);
222bool evlist__sample_id_all(struct evlist *evlist);
223u16 evlist__id_hdr_size(struct evlist *evlist);
224
225int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample);
226int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp);
227
228bool evlist__valid_sample_type(struct evlist *evlist);
229bool evlist__valid_sample_id_all(struct evlist *evlist);
230bool evlist__valid_read_format(struct evlist *evlist);
231
232void evlist__splice_list_tail(struct evlist *evlist, struct list_head *list);
233
234static inline bool evlist__empty(struct evlist *evlist)
235{
236	return list_empty(&evlist->core.entries);
237}
238
239static inline struct evsel *evlist__first(struct evlist *evlist)
240{
241	struct perf_evsel *evsel = perf_evlist__first(&evlist->core);
242
243	return container_of(evsel, struct evsel, core);
244}
245
246static inline struct evsel *evlist__last(struct evlist *evlist)
247{
248	struct perf_evsel *evsel = perf_evlist__last(&evlist->core);
249
250	return container_of(evsel, struct evsel, core);
251}
252
253static inline int evlist__nr_groups(struct evlist *evlist)
254{
255	return perf_evlist__nr_groups(&evlist->core);
256}
257
258int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
259int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
260
261bool evlist__can_select_event(struct evlist *evlist, const char *str);
262void evlist__to_front(struct evlist *evlist, struct evsel *move_evsel);
263
264/**
265 * __evlist__for_each_entry - iterate thru all the evsels
266 * @list: list_head instance to iterate
267 * @evsel: struct evsel iterator
268 */
269#define __evlist__for_each_entry(list, evsel) \
270        list_for_each_entry(evsel, list, core.node)
271
272/**
273 * evlist__for_each_entry - iterate thru all the evsels
274 * @evlist: evlist instance to iterate
275 * @evsel: struct evsel iterator
276 */
277#define evlist__for_each_entry(evlist, evsel) \
278	__evlist__for_each_entry(&(evlist)->core.entries, evsel)
279
280/**
281 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
282 * @list: list_head instance to iterate
283 * @evsel: struct evsel iterator
284 */
285#define __evlist__for_each_entry_continue(list, evsel) \
286        list_for_each_entry_continue(evsel, list, core.node)
287
288/**
289 * evlist__for_each_entry_continue - continue iteration thru all the evsels
290 * @evlist: evlist instance to iterate
291 * @evsel: struct evsel iterator
292 */
293#define evlist__for_each_entry_continue(evlist, evsel) \
294	__evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
295
296/**
297 * __evlist__for_each_entry_from - continue iteration from @evsel (included)
298 * @list: list_head instance to iterate
299 * @evsel: struct evsel iterator
300 */
301#define __evlist__for_each_entry_from(list, evsel) \
302	list_for_each_entry_from(evsel, list, core.node)
303
304/**
305 * evlist__for_each_entry_from - continue iteration from @evsel (included)
306 * @evlist: evlist instance to iterate
307 * @evsel: struct evsel iterator
308 */
309#define evlist__for_each_entry_from(evlist, evsel) \
310	__evlist__for_each_entry_from(&(evlist)->core.entries, evsel)
311
312/**
313 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
314 * @list: list_head instance to iterate
315 * @evsel: struct evsel iterator
316 */
317#define __evlist__for_each_entry_reverse(list, evsel) \
318        list_for_each_entry_reverse(evsel, list, core.node)
319
320/**
321 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
322 * @evlist: evlist instance to iterate
323 * @evsel: struct evsel iterator
324 */
325#define evlist__for_each_entry_reverse(evlist, evsel) \
326	__evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
327
328/**
329 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
330 * @list: list_head instance to iterate
331 * @tmp: struct evsel temp iterator
332 * @evsel: struct evsel iterator
333 */
334#define __evlist__for_each_entry_safe(list, tmp, evsel) \
335        list_for_each_entry_safe(evsel, tmp, list, core.node)
336
337/**
338 * evlist__for_each_entry_safe - safely iterate thru all the evsels
339 * @evlist: evlist instance to iterate
340 * @evsel: struct evsel iterator
341 * @tmp: struct evsel temp iterator
342 */
343#define evlist__for_each_entry_safe(evlist, tmp, evsel) \
344	__evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
345
346/** Iterator state for evlist__for_each_cpu */
347struct evlist_cpu_iterator {
348	/** The list being iterated through. */
349	struct evlist *container;
350	/** The current evsel of the iterator. */
351	struct evsel *evsel;
352	/** The CPU map index corresponding to the evsel->core.cpus for the current CPU. */
353	int cpu_map_idx;
354	/**
355	 * The CPU map index corresponding to evlist->core.all_cpus for the
356	 * current CPU.  Distinct from cpu_map_idx as the evsel's cpu map may
357	 * contain fewer entries.
358	 */
359	int evlist_cpu_map_idx;
360	/** The number of CPU map entries in evlist->core.all_cpus. */
361	int evlist_cpu_map_nr;
362	/** The current CPU of the iterator. */
363	struct perf_cpu cpu;
364	/** If present, used to set the affinity when switching between CPUs. */
365	struct affinity *affinity;
366};
367
368/**
369 * evlist__for_each_cpu - without affinity, iterate over the evlist. With
370 *                        affinity, iterate over all CPUs and then the evlist
371 *                        for each evsel on that CPU. When switching between
372 *                        CPUs the affinity is set to the CPU to avoid IPIs
373 *                        during syscalls.
374 * @evlist_cpu_itr: the iterator instance.
375 * @evlist: evlist instance to iterate.
376 * @affinity: NULL or used to set the affinity to the current CPU.
377 */
378#define evlist__for_each_cpu(evlist_cpu_itr, evlist, affinity)		\
379	for ((evlist_cpu_itr) = evlist__cpu_begin(evlist, affinity);	\
380	     !evlist_cpu_iterator__end(&evlist_cpu_itr);		\
381	     evlist_cpu_iterator__next(&evlist_cpu_itr))
382
383/** Returns an iterator set to the first CPU/evsel of evlist. */
384struct evlist_cpu_iterator evlist__cpu_begin(struct evlist *evlist, struct affinity *affinity);
385/** Move to next element in iterator, updating CPU, evsel and the affinity. */
386void evlist_cpu_iterator__next(struct evlist_cpu_iterator *evlist_cpu_itr);
387/** Returns true when iterator is at the end of the CPUs and evlist. */
388bool evlist_cpu_iterator__end(const struct evlist_cpu_iterator *evlist_cpu_itr);
389
390struct evsel *evlist__get_tracking_event(struct evlist *evlist);
391void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel);
392struct evsel *evlist__findnew_tracking_event(struct evlist *evlist, bool system_wide);
393
394struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
395
396struct evsel *evlist__event2evsel(struct evlist *evlist, union perf_event *event);
397
398bool evlist__exclude_kernel(struct evlist *evlist);
399
400void evlist__force_leader(struct evlist *evlist);
401
402struct evsel *evlist__reset_weak_group(struct evlist *evlist, struct evsel *evsel, bool close);
403
404#define EVLIST_CTL_CMD_ENABLE_TAG  "enable"
405#define EVLIST_CTL_CMD_DISABLE_TAG "disable"
406#define EVLIST_CTL_CMD_ACK_TAG     "ack\n"
407#define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot"
408#define EVLIST_CTL_CMD_EVLIST_TAG "evlist"
409#define EVLIST_CTL_CMD_STOP_TAG "stop"
410#define EVLIST_CTL_CMD_PING_TAG "ping"
411
412#define EVLIST_CTL_CMD_MAX_LEN 64
413
414enum evlist_ctl_cmd {
415	EVLIST_CTL_CMD_UNSUPPORTED = 0,
416	EVLIST_CTL_CMD_ENABLE,
417	EVLIST_CTL_CMD_DISABLE,
418	EVLIST_CTL_CMD_ACK,
419	EVLIST_CTL_CMD_SNAPSHOT,
420	EVLIST_CTL_CMD_EVLIST,
421	EVLIST_CTL_CMD_STOP,
422	EVLIST_CTL_CMD_PING,
423};
424
425int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close);
426void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close);
427int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack);
428int evlist__finalize_ctlfd(struct evlist *evlist);
429bool evlist__ctlfd_initialized(struct evlist *evlist);
430int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd);
431int evlist__ctlfd_ack(struct evlist *evlist);
432
433#define EVLIST_ENABLED_MSG "Events enabled\n"
434#define EVLIST_DISABLED_MSG "Events disabled\n"
435
436int evlist__parse_event_enable_time(struct evlist *evlist, struct record_opts *opts,
437				    const char *str, int unset);
438int event_enable_timer__start(struct event_enable_timer *eet);
439void event_enable_timer__exit(struct event_enable_timer **ep);
440int event_enable_timer__process(struct event_enable_timer *eet);
441
442struct evsel *evlist__find_evsel(struct evlist *evlist, int idx);
443
444void evlist__format_evsels(struct evlist *evlist, struct strbuf *sb, size_t max_length);
445void evlist__check_mem_load_aux(struct evlist *evlist);
446void evlist__warn_user_requested_cpus(struct evlist *evlist, const char *cpu_list);
447void evlist__uniquify_evsel_names(struct evlist *evlist, const struct perf_stat_config *config);
448bool evlist__has_bpf_output(struct evlist *evlist);
449bool evlist__needs_bpf_sb_event(struct evlist *evlist);
450
451#endif /* __PERF_EVLIST_H */