453 lines
		
	
	
		
			16 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			453 lines
		
	
	
		
			16 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /* SPDX-License-Identifier: GPL-2.0 */
 | |
| #ifndef __PERF_EVLIST_H
 | |
| #define __PERF_EVLIST_H 1
 | |
| 
 | |
| #include <linux/compiler.h>
 | |
| #include <linux/kernel.h>
 | |
| #include <linux/refcount.h>
 | |
| #include <linux/list.h>
 | |
| #include <api/fd/array.h>
 | |
| #include <internal/evlist.h>
 | |
| #include <internal/evsel.h>
 | |
| #include <perf/evlist.h>
 | |
| #include "events_stats.h"
 | |
| #include "evsel.h"
 | |
| #include <pthread.h>
 | |
| #include <signal.h>
 | |
| #include <unistd.h>
 | |
| 
 | |
| struct pollfd;
 | |
| struct thread_map;
 | |
| struct perf_cpu_map;
 | |
| struct record_opts;
 | |
| struct target;
 | |
| 
 | |
| /*
 | |
|  * State machine of bkw_mmap_state:
 | |
|  *
 | |
|  *                     .________________(forbid)_____________.
 | |
|  *                     |                                     V
 | |
|  * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
 | |
|  *                     ^  ^              |   ^               |
 | |
|  *                     |  |__(forbid)____/   |___(forbid)___/|
 | |
|  *                     |                                     |
 | |
|  *                      \_________________(3)_______________/
 | |
|  *
 | |
|  * NOTREADY     : Backward ring buffers are not ready
 | |
|  * RUNNING      : Backward ring buffers are recording
 | |
|  * DATA_PENDING : We are required to collect data from backward ring buffers
 | |
|  * EMPTY        : We have collected data from backward ring buffers.
 | |
|  *
 | |
|  * (0): Setup backward ring buffer
 | |
|  * (1): Pause ring buffers for reading
 | |
|  * (2): Read from ring buffers
 | |
|  * (3): Resume ring buffers for recording
 | |
|  */
 | |
| enum bkw_mmap_state {
 | |
| 	BKW_MMAP_NOTREADY,
 | |
| 	BKW_MMAP_RUNNING,
 | |
| 	BKW_MMAP_DATA_PENDING,
 | |
| 	BKW_MMAP_EMPTY,
 | |
| };
 | |
| 
 | |
| struct event_enable_timer;
 | |
| 
 | |
| struct evlist {
 | |
| 	struct perf_evlist core;
 | |
| 	bool		 enabled;
 | |
| 	int		 id_pos;
 | |
| 	int		 is_pos;
 | |
| 	int		 nr_br_cntr;
 | |
| 	u64		 combined_sample_type;
 | |
| 	enum bkw_mmap_state bkw_mmap_state;
 | |
| 	struct {
 | |
| 		int	cork_fd;
 | |
| 		pid_t	pid;
 | |
| 	} workload;
 | |
| 	struct mmap *mmap;
 | |
| 	struct mmap *overwrite_mmap;
 | |
| 	struct evsel *selected;
 | |
| 	struct events_stats stats;
 | |
| 	struct perf_env	*env;
 | |
| 	void (*trace_event_sample_raw)(struct evlist *evlist,
 | |
| 				       union perf_event *event,
 | |
| 				       struct perf_sample *sample);
 | |
| 	u64		first_sample_time;
 | |
| 	u64		last_sample_time;
 | |
| 	struct {
 | |
| 		pthread_t		th;
 | |
| 		volatile int		done;
 | |
| 	} thread;
 | |
| 	struct {
 | |
| 		int	fd;	/* control file descriptor */
 | |
| 		int	ack;	/* ack file descriptor for control commands */
 | |
| 		int	pos;	/* index at evlist core object to check signals */
 | |
| 	} ctl_fd;
 | |
| 	struct event_enable_timer *eet;
 | |
| };
 | |
| 
 | |
| struct evsel_str_handler {
 | |
| 	const char *name;
 | |
| 	void	   *handler;
 | |
| };
 | |
| 
 | |
| struct evlist *evlist__new(void);
 | |
| struct evlist *evlist__new_default(void);
 | |
| struct evlist *evlist__new_dummy(void);
 | |
| void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus,
 | |
| 		  struct perf_thread_map *threads);
 | |
| void evlist__exit(struct evlist *evlist);
 | |
| void evlist__delete(struct evlist *evlist);
 | |
| 
 | |
| void evlist__add(struct evlist *evlist, struct evsel *entry);
 | |
| void evlist__remove(struct evlist *evlist, struct evsel *evsel);
 | |
| 
 | |
| int evlist__add_attrs(struct evlist *evlist, struct perf_event_attr *attrs, size_t nr_attrs);
 | |
| 
 | |
| int __evlist__add_default_attrs(struct evlist *evlist,
 | |
| 				     struct perf_event_attr *attrs, size_t nr_attrs);
 | |
| 
 | |
| int arch_evlist__add_default_attrs(struct evlist *evlist,
 | |
| 				   struct perf_event_attr *attrs,
 | |
| 				   size_t nr_attrs);
 | |
| 
 | |
| #define evlist__add_default_attrs(evlist, array) \
 | |
| 	arch_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
 | |
| 
 | |
| int arch_evlist__cmp(const struct evsel *lhs, const struct evsel *rhs);
 | |
| 
 | |
| int evlist__add_dummy(struct evlist *evlist);
 | |
| struct evsel *evlist__add_aux_dummy(struct evlist *evlist, bool system_wide);
 | |
| static inline struct evsel *evlist__add_dummy_on_all_cpus(struct evlist *evlist)
 | |
| {
 | |
| 	return evlist__add_aux_dummy(evlist, true);
 | |
| }
 | |
| #ifdef HAVE_LIBTRACEEVENT
 | |
| struct evsel *evlist__add_sched_switch(struct evlist *evlist, bool system_wide);
 | |
| #endif
 | |
| 
 | |
| int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr,
 | |
| 			 evsel__sb_cb_t cb, void *data);
 | |
| void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data);
 | |
| int evlist__start_sb_thread(struct evlist *evlist, struct target *target);
 | |
| void evlist__stop_sb_thread(struct evlist *evlist);
 | |
| 
 | |
| #ifdef HAVE_LIBTRACEEVENT
 | |
| int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler);
 | |
| #endif
 | |
| 
 | |
| int __evlist__set_tracepoints_handlers(struct evlist *evlist,
 | |
| 				       const struct evsel_str_handler *assocs,
 | |
| 				       size_t nr_assocs);
 | |
| 
 | |
| #define evlist__set_tracepoints_handlers(evlist, array) \
 | |
| 	__evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array))
 | |
| 
 | |
| int evlist__set_tp_filter(struct evlist *evlist, const char *filter);
 | |
| int evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid);
 | |
| int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
 | |
| 
 | |
| int evlist__append_tp_filter(struct evlist *evlist, const char *filter);
 | |
| 
 | |
| int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid);
 | |
| int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
 | |
| 
 | |
| struct evsel *evlist__find_tracepoint_by_id(struct evlist *evlist, int id);
 | |
| struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name);
 | |
| 
 | |
| int evlist__add_pollfd(struct evlist *evlist, int fd);
 | |
| int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
 | |
| 
 | |
| #ifdef HAVE_EVENTFD_SUPPORT
 | |
| int evlist__add_wakeup_eventfd(struct evlist *evlist, int fd);
 | |
| #endif
 | |
| 
 | |
| int evlist__poll(struct evlist *evlist, int timeout);
 | |
| 
 | |
| struct evsel *evlist__id2evsel(struct evlist *evlist, u64 id);
 | |
| struct evsel *evlist__id2evsel_strict(struct evlist *evlist, u64 id);
 | |
| 
 | |
| struct perf_sample_id *evlist__id2sid(struct evlist *evlist, u64 id);
 | |
| 
 | |
| void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
 | |
| 
 | |
| void evlist__mmap_consume(struct evlist *evlist, int idx);
 | |
| 
 | |
| int evlist__open(struct evlist *evlist);
 | |
| void evlist__close(struct evlist *evlist);
 | |
| 
 | |
| struct callchain_param;
 | |
| 
 | |
| void evlist__set_id_pos(struct evlist *evlist);
 | |
| void evlist__config(struct evlist *evlist, struct record_opts *opts, struct callchain_param *callchain);
 | |
| int record_opts__config(struct record_opts *opts);
 | |
| 
 | |
| int evlist__prepare_workload(struct evlist *evlist, struct target *target,
 | |
| 			     const char *argv[], bool pipe_output,
 | |
| 			     void (*exec_error)(int signo, siginfo_t *info, void *ucontext));
 | |
| int evlist__start_workload(struct evlist *evlist);
 | |
| 
 | |
| struct option;
 | |
| 
 | |
| int __evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
 | |
| int evlist__parse_mmap_pages(const struct option *opt, const char *str, int unset);
 | |
| 
 | |
| unsigned long perf_event_mlock_kb_in_pages(void);
 | |
| 
 | |
| int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
 | |
| 			 unsigned int auxtrace_pages,
 | |
| 			 bool auxtrace_overwrite, int nr_cblocks,
 | |
| 			 int affinity, int flush, int comp_level);
 | |
| int evlist__mmap(struct evlist *evlist, unsigned int pages);
 | |
| void evlist__munmap(struct evlist *evlist);
 | |
| 
 | |
| size_t evlist__mmap_size(unsigned long pages);
 | |
| 
 | |
| void evlist__disable(struct evlist *evlist);
 | |
| void evlist__enable(struct evlist *evlist);
 | |
| void evlist__toggle_enable(struct evlist *evlist);
 | |
| void evlist__disable_evsel(struct evlist *evlist, char *evsel_name);
 | |
| void evlist__enable_evsel(struct evlist *evlist, char *evsel_name);
 | |
| void evlist__disable_non_dummy(struct evlist *evlist);
 | |
| void evlist__enable_non_dummy(struct evlist *evlist);
 | |
| 
 | |
| void evlist__set_selected(struct evlist *evlist, struct evsel *evsel);
 | |
| 
 | |
| int evlist__create_maps(struct evlist *evlist, struct target *target);
 | |
| int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel,
 | |
| 			  struct target *target);
 | |
| 
 | |
| u64 __evlist__combined_sample_type(struct evlist *evlist);
 | |
| u64 evlist__combined_sample_type(struct evlist *evlist);
 | |
| u64 evlist__combined_branch_type(struct evlist *evlist);
 | |
| void evlist__update_br_cntr(struct evlist *evlist);
 | |
| bool evlist__sample_id_all(struct evlist *evlist);
 | |
| u16 evlist__id_hdr_size(struct evlist *evlist);
 | |
| 
 | |
| int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample);
 | |
| int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp);
 | |
| 
 | |
| bool evlist__valid_sample_type(struct evlist *evlist);
 | |
| bool evlist__valid_sample_id_all(struct evlist *evlist);
 | |
| bool evlist__valid_read_format(struct evlist *evlist);
 | |
| 
 | |
| void evlist__splice_list_tail(struct evlist *evlist, struct list_head *list);
 | |
| 
 | |
| static inline bool evlist__empty(struct evlist *evlist)
 | |
| {
 | |
| 	return list_empty(&evlist->core.entries);
 | |
| }
 | |
| 
 | |
| static inline struct evsel *evlist__first(struct evlist *evlist)
 | |
| {
 | |
| 	struct perf_evsel *evsel = perf_evlist__first(&evlist->core);
 | |
| 
 | |
| 	return container_of(evsel, struct evsel, core);
 | |
| }
 | |
| 
 | |
| static inline struct evsel *evlist__last(struct evlist *evlist)
 | |
| {
 | |
| 	struct perf_evsel *evsel = perf_evlist__last(&evlist->core);
 | |
| 
 | |
| 	return container_of(evsel, struct evsel, core);
 | |
| }
 | |
| 
 | |
| static inline int evlist__nr_groups(struct evlist *evlist)
 | |
| {
 | |
| 	return perf_evlist__nr_groups(&evlist->core);
 | |
| }
 | |
| 
 | |
| int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
 | |
| int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
 | |
| 
 | |
| bool evlist__can_select_event(struct evlist *evlist, const char *str);
 | |
| void evlist__to_front(struct evlist *evlist, struct evsel *move_evsel);
 | |
| 
 | |
| /**
 | |
|  * __evlist__for_each_entry - iterate thru all the evsels
 | |
|  * @list: list_head instance to iterate
 | |
|  * @evsel: struct evsel iterator
 | |
|  */
 | |
| #define __evlist__for_each_entry(list, evsel) \
 | |
|         list_for_each_entry(evsel, list, core.node)
 | |
| 
 | |
| /**
 | |
|  * evlist__for_each_entry - iterate thru all the evsels
 | |
|  * @evlist: evlist instance to iterate
 | |
|  * @evsel: struct evsel iterator
 | |
|  */
 | |
| #define evlist__for_each_entry(evlist, evsel) \
 | |
| 	__evlist__for_each_entry(&(evlist)->core.entries, evsel)
 | |
| 
 | |
| /**
 | |
|  * __evlist__for_each_entry_continue - continue iteration thru all the evsels
 | |
|  * @list: list_head instance to iterate
 | |
|  * @evsel: struct evsel iterator
 | |
|  */
 | |
| #define __evlist__for_each_entry_continue(list, evsel) \
 | |
|         list_for_each_entry_continue(evsel, list, core.node)
 | |
| 
 | |
| /**
 | |
|  * evlist__for_each_entry_continue - continue iteration thru all the evsels
 | |
|  * @evlist: evlist instance to iterate
 | |
|  * @evsel: struct evsel iterator
 | |
|  */
 | |
| #define evlist__for_each_entry_continue(evlist, evsel) \
 | |
| 	__evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
 | |
| 
 | |
| /**
 | |
|  * __evlist__for_each_entry_from - continue iteration from @evsel (included)
 | |
|  * @list: list_head instance to iterate
 | |
|  * @evsel: struct evsel iterator
 | |
|  */
 | |
| #define __evlist__for_each_entry_from(list, evsel) \
 | |
| 	list_for_each_entry_from(evsel, list, core.node)
 | |
| 
 | |
| /**
 | |
|  * evlist__for_each_entry_from - continue iteration from @evsel (included)
 | |
|  * @evlist: evlist instance to iterate
 | |
|  * @evsel: struct evsel iterator
 | |
|  */
 | |
| #define evlist__for_each_entry_from(evlist, evsel) \
 | |
| 	__evlist__for_each_entry_from(&(evlist)->core.entries, evsel)
 | |
| 
 | |
| /**
 | |
|  * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 | |
|  * @list: list_head instance to iterate
 | |
|  * @evsel: struct evsel iterator
 | |
|  */
 | |
| #define __evlist__for_each_entry_reverse(list, evsel) \
 | |
|         list_for_each_entry_reverse(evsel, list, core.node)
 | |
| 
 | |
| /**
 | |
|  * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 | |
|  * @evlist: evlist instance to iterate
 | |
|  * @evsel: struct evsel iterator
 | |
|  */
 | |
| #define evlist__for_each_entry_reverse(evlist, evsel) \
 | |
| 	__evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
 | |
| 
 | |
| /**
 | |
|  * __evlist__for_each_entry_safe - safely iterate thru all the evsels
 | |
|  * @list: list_head instance to iterate
 | |
|  * @tmp: struct evsel temp iterator
 | |
|  * @evsel: struct evsel iterator
 | |
|  */
 | |
| #define __evlist__for_each_entry_safe(list, tmp, evsel) \
 | |
|         list_for_each_entry_safe(evsel, tmp, list, core.node)
 | |
| 
 | |
| /**
 | |
|  * evlist__for_each_entry_safe - safely iterate thru all the evsels
 | |
|  * @evlist: evlist instance to iterate
 | |
|  * @evsel: struct evsel iterator
 | |
|  * @tmp: struct evsel temp iterator
 | |
|  */
 | |
| #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
 | |
| 	__evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
 | |
| 
 | |
| /** Iterator state for evlist__for_each_cpu */
 | |
| struct evlist_cpu_iterator {
 | |
| 	/** The list being iterated through. */
 | |
| 	struct evlist *container;
 | |
| 	/** The current evsel of the iterator. */
 | |
| 	struct evsel *evsel;
 | |
| 	/** The CPU map index corresponding to the evsel->core.cpus for the current CPU. */
 | |
| 	int cpu_map_idx;
 | |
| 	/**
 | |
| 	 * The CPU map index corresponding to evlist->core.all_cpus for the
 | |
| 	 * current CPU.  Distinct from cpu_map_idx as the evsel's cpu map may
 | |
| 	 * contain fewer entries.
 | |
| 	 */
 | |
| 	int evlist_cpu_map_idx;
 | |
| 	/** The number of CPU map entries in evlist->core.all_cpus. */
 | |
| 	int evlist_cpu_map_nr;
 | |
| 	/** The current CPU of the iterator. */
 | |
| 	struct perf_cpu cpu;
 | |
| 	/** If present, used to set the affinity when switching between CPUs. */
 | |
| 	struct affinity *affinity;
 | |
| };
 | |
| 
 | |
| /**
 | |
|  * evlist__for_each_cpu - without affinity, iterate over the evlist. With
 | |
|  *                        affinity, iterate over all CPUs and then the evlist
 | |
|  *                        for each evsel on that CPU. When switching between
 | |
|  *                        CPUs the affinity is set to the CPU to avoid IPIs
 | |
|  *                        during syscalls.
 | |
|  * @evlist_cpu_itr: the iterator instance.
 | |
|  * @evlist: evlist instance to iterate.
 | |
|  * @affinity: NULL or used to set the affinity to the current CPU.
 | |
|  */
 | |
| #define evlist__for_each_cpu(evlist_cpu_itr, evlist, affinity)		\
 | |
| 	for ((evlist_cpu_itr) = evlist__cpu_begin(evlist, affinity);	\
 | |
| 	     !evlist_cpu_iterator__end(&evlist_cpu_itr);		\
 | |
| 	     evlist_cpu_iterator__next(&evlist_cpu_itr))
 | |
| 
 | |
| /** Returns an iterator set to the first CPU/evsel of evlist. */
 | |
| struct evlist_cpu_iterator evlist__cpu_begin(struct evlist *evlist, struct affinity *affinity);
 | |
| /** Move to next element in iterator, updating CPU, evsel and the affinity. */
 | |
| void evlist_cpu_iterator__next(struct evlist_cpu_iterator *evlist_cpu_itr);
 | |
| /** Returns true when iterator is at the end of the CPUs and evlist. */
 | |
| bool evlist_cpu_iterator__end(const struct evlist_cpu_iterator *evlist_cpu_itr);
 | |
| 
 | |
| struct evsel *evlist__get_tracking_event(struct evlist *evlist);
 | |
| void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel);
 | |
| struct evsel *evlist__findnew_tracking_event(struct evlist *evlist, bool system_wide);
 | |
| 
 | |
| struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
 | |
| 
 | |
| struct evsel *evlist__event2evsel(struct evlist *evlist, union perf_event *event);
 | |
| 
 | |
| bool evlist__exclude_kernel(struct evlist *evlist);
 | |
| 
 | |
| void evlist__force_leader(struct evlist *evlist);
 | |
| 
 | |
| struct evsel *evlist__reset_weak_group(struct evlist *evlist, struct evsel *evsel, bool close);
 | |
| 
 | |
| #define EVLIST_CTL_CMD_ENABLE_TAG  "enable"
 | |
| #define EVLIST_CTL_CMD_DISABLE_TAG "disable"
 | |
| #define EVLIST_CTL_CMD_ACK_TAG     "ack\n"
 | |
| #define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot"
 | |
| #define EVLIST_CTL_CMD_EVLIST_TAG "evlist"
 | |
| #define EVLIST_CTL_CMD_STOP_TAG "stop"
 | |
| #define EVLIST_CTL_CMD_PING_TAG "ping"
 | |
| 
 | |
| #define EVLIST_CTL_CMD_MAX_LEN 64
 | |
| 
 | |
| enum evlist_ctl_cmd {
 | |
| 	EVLIST_CTL_CMD_UNSUPPORTED = 0,
 | |
| 	EVLIST_CTL_CMD_ENABLE,
 | |
| 	EVLIST_CTL_CMD_DISABLE,
 | |
| 	EVLIST_CTL_CMD_ACK,
 | |
| 	EVLIST_CTL_CMD_SNAPSHOT,
 | |
| 	EVLIST_CTL_CMD_EVLIST,
 | |
| 	EVLIST_CTL_CMD_STOP,
 | |
| 	EVLIST_CTL_CMD_PING,
 | |
| };
 | |
| 
 | |
| int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close);
 | |
| void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close);
 | |
| int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack);
 | |
| int evlist__finalize_ctlfd(struct evlist *evlist);
 | |
| bool evlist__ctlfd_initialized(struct evlist *evlist);
 | |
| int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd);
 | |
| int evlist__ctlfd_ack(struct evlist *evlist);
 | |
| 
 | |
| #define EVLIST_ENABLED_MSG "Events enabled\n"
 | |
| #define EVLIST_DISABLED_MSG "Events disabled\n"
 | |
| 
 | |
| int evlist__parse_event_enable_time(struct evlist *evlist, struct record_opts *opts,
 | |
| 				    const char *str, int unset);
 | |
| int event_enable_timer__start(struct event_enable_timer *eet);
 | |
| void event_enable_timer__exit(struct event_enable_timer **ep);
 | |
| int event_enable_timer__process(struct event_enable_timer *eet);
 | |
| 
 | |
| struct evsel *evlist__find_evsel(struct evlist *evlist, int idx);
 | |
| 
 | |
| int evlist__scnprintf_evsels(struct evlist *evlist, size_t size, char *bf);
 | |
| void evlist__check_mem_load_aux(struct evlist *evlist);
 | |
| void evlist__warn_user_requested_cpus(struct evlist *evlist, const char *cpu_list);
 | |
| void evlist__uniquify_name(struct evlist *evlist);
 | |
| bool evlist__has_bpf_output(struct evlist *evlist);
 | |
| 
 | |
| #endif /* __PERF_EVLIST_H */
 |