[deliverable/linux.git] / tools / perf / util / evlist.h

#ifndef __PERF_EVLIST_H
#define __PERF_EVLIST_H 1

#include <linux/list.h>
#include <api/fd/array.h>
#include <stdio.h>
#include "../perf.h"
#include "event.h"
#include "evsel.h"
#include "util.h"
#include <unistd.h>

struct pollfd;
struct thread_map;
struct cpu_map;
struct record_opts;

#define PERF_EVLIST__HLIST_BITS 8
#define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)

/**
 * struct perf_mmap - perf's ring buffer mmap details
 *
 * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
 */
struct perf_mmap {
	void		 *base;
	int		 mask;
	int		 refcnt;
	unsigned int	 prev;
	char		 event_copy[PERF_SAMPLE_MAX_SIZE];
};

struct perf_evlist {
	struct list_head entries;
	struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
	int		 nr_entries;
	int		 nr_groups;
	int		 nr_mmaps;
	size_t		 mmap_len;
	int		 id_pos;
	int		 is_pos;
	u64		 combined_sample_type;
	struct {
		int	cork_fd;
		pid_t	pid;
	} workload;
	bool		 overwrite;
	struct fdarray	 pollfd;
	struct perf_mmap *mmap;
	struct thread_map *threads;
	struct cpu_map	  *cpus;
	struct perf_evsel *selected;
};

struct perf_evsel_str_handler {
	const char *name;
	void	   *handler;
};

struct perf_evlist *perf_evlist__new(void);
struct perf_evlist *perf_evlist__new_default(void);
void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
		       struct thread_map *threads);
void perf_evlist__exit(struct perf_evlist *evlist);
void perf_evlist__delete(struct perf_evlist *evlist);

void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
int perf_evlist__add_default(struct perf_evlist *evlist);
int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
				     struct perf_event_attr *attrs, size_t nr_attrs);

#define perf_evlist__add_default_attrs(evlist, array) \
	__perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))

int perf_evlist__add_newtp(struct perf_evlist *evlist,
			   const char *sys, const char *name, void *handler);

int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid);

struct perf_evsel *
perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);

struct perf_evsel *
perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
				     const char *name);

void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
			 int cpu, int thread, u64 id);

int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);

int perf_evlist__poll(struct perf_evlist *evlist, int timeout);

struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);

struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);

union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx);

void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);

int perf_evlist__open(struct perf_evlist *evlist);
void perf_evlist__close(struct perf_evlist *evlist);

void perf_evlist__set_id_pos(struct perf_evlist *evlist);
bool perf_can_sample_identifier(void);
void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts);
int record_opts__config(struct record_opts *opts);

int perf_evlist__prepare_workload(struct perf_evlist *evlist,
				  struct target *target,
				  const char *argv[], bool pipe_output,
				  void (*exec_error)(int signo, siginfo_t *info,
						     void *ucontext));
int perf_evlist__start_workload(struct perf_evlist *evlist);

struct option;

int perf_evlist__parse_mmap_pages(const struct option *opt,
				  const char *str,
				  int unset);

int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
		      bool overwrite);
void perf_evlist__munmap(struct perf_evlist *evlist);

void perf_evlist__disable(struct perf_evlist *evlist);
void perf_evlist__enable(struct perf_evlist *evlist);

int perf_evlist__disable_event(struct perf_evlist *evlist,
			       struct perf_evsel *evsel);
int perf_evlist__enable_event(struct perf_evlist *evlist,
			      struct perf_evsel *evsel);
int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
				  struct perf_evsel *evsel, int idx);

void perf_evlist__set_selected(struct perf_evlist *evlist,
			       struct perf_evsel *evsel);

static inline void perf_evlist__set_maps(struct perf_evlist *evlist,
					 struct cpu_map *cpus,
					 struct thread_map *threads)
{
	evlist->cpus	= cpus;
	evlist->threads	= threads;
}

int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
int perf_evlist__apply_filters(struct perf_evlist *evlist);

void __perf_evlist__set_leader(struct list_head *list);
void perf_evlist__set_leader(struct perf_evlist *evlist);

u64 perf_evlist__read_format(struct perf_evlist *evlist);
u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);

int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
			      struct perf_sample *sample);

bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
bool perf_evlist__valid_read_format(struct perf_evlist *evlist);

void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
				   struct list_head *list,
				   int nr_entries);

static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
{
	return list_entry(evlist->entries.next, struct perf_evsel, node);
}

static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
{
	return list_entry(evlist->entries.prev, struct perf_evsel, node);
}

size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);

int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size);

static inline unsigned int perf_mmap__read_head(struct perf_mmap *mm)
{
	struct perf_event_mmap_page *pc = mm->base;
	int head = ACCESS_ONCE(pc->data_head);
	rmb();
	return head;
}

static inline void perf_mmap__write_tail(struct perf_mmap *md,
					 unsigned long tail)
{
	struct perf_event_mmap_page *pc = md->base;

	/*
	 * ensure all reads are done before we write the tail out.
	 */
	mb();
	pc->data_tail = tail;
}

bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
void perf_evlist__to_front(struct perf_evlist *evlist,
			   struct perf_evsel *move_evsel);

/**
 * __evlist__for_each - iterate thru all the evsels
 * @list: list_head instance to iterate
 * @evsel: struct evsel iterator
 */
#define __evlist__for_each(list, evsel) \
        list_for_each_entry(evsel, list, node)

/**
 * evlist__for_each - iterate thru all the evsels
 * @evlist: evlist instance to iterate
 * @evsel: struct evsel iterator
 */
#define evlist__for_each(evlist, evsel) \
	__evlist__for_each(&(evlist)->entries, evsel)

/**
 * __evlist__for_each_continue - continue iteration thru all the evsels
 * @list: list_head instance to iterate
 * @evsel: struct evsel iterator
 */
#define __evlist__for_each_continue(list, evsel) \
        list_for_each_entry_continue(evsel, list, node)

/**
 * evlist__for_each_continue - continue iteration thru all the evsels
 * @evlist: evlist instance to iterate
 * @evsel: struct evsel iterator
 */
#define evlist__for_each_continue(evlist, evsel) \
	__evlist__for_each_continue(&(evlist)->entries, evsel)

/**
 * __evlist__for_each_reverse - iterate thru all the evsels in reverse order
 * @list: list_head instance to iterate
 * @evsel: struct evsel iterator
 */
#define __evlist__for_each_reverse(list, evsel) \
        list_for_each_entry_reverse(evsel, list, node)

/**
 * evlist__for_each_reverse - iterate thru all the evsels in reverse order
 * @evlist: evlist instance to iterate
 * @evsel: struct evsel iterator
 */
#define evlist__for_each_reverse(evlist, evsel) \
	__evlist__for_each_reverse(&(evlist)->entries, evsel)

/**
 * __evlist__for_each_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_safe(list, tmp, evsel) \
        list_for_each_entry_safe(evsel, tmp, list, node)

/**
 * evlist__for_each_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_safe(evlist, tmp, evsel) \
	__evlist__for_each_safe(&(evlist)->entries, tmp, evsel)

void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
				     struct perf_evsel *tracking_evsel);

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