xref: /linux/tools/perf/util/evlist.h (revision f884ab15afdc5514e88105c92a4e2e1e6539869a)
1 #ifndef __PERF_EVLIST_H
2 #define __PERF_EVLIST_H 1
3 
4 #include <linux/list.h>
5 #include <stdio.h>
6 #include "../perf.h"
7 #include "event.h"
8 #include "evsel.h"
9 #include "util.h"
10 #include <unistd.h>
11 
12 struct pollfd;
13 struct thread_map;
14 struct cpu_map;
15 struct perf_record_opts;
16 
17 #define PERF_EVLIST__HLIST_BITS 8
18 #define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
19 
20 struct perf_mmap {
21 	void		 *base;
22 	int		 mask;
23 	unsigned int	 prev;
24 	union perf_event event_copy;
25 };
26 
27 struct perf_evlist {
28 	struct list_head entries;
29 	struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
30 	int		 nr_entries;
31 	int		 nr_groups;
32 	int		 nr_fds;
33 	int		 nr_mmaps;
34 	int		 mmap_len;
35 	struct {
36 		int	cork_fd;
37 		pid_t	pid;
38 	} workload;
39 	bool		 overwrite;
40 	struct perf_mmap *mmap;
41 	struct pollfd	 *pollfd;
42 	struct thread_map *threads;
43 	struct cpu_map	  *cpus;
44 	struct perf_evsel *selected;
45 };
46 
47 struct perf_evsel_str_handler {
48 	const char *name;
49 	void	   *handler;
50 };
51 
52 struct perf_evlist *perf_evlist__new(void);
53 void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
54 		       struct thread_map *threads);
55 void perf_evlist__exit(struct perf_evlist *evlist);
56 void perf_evlist__delete(struct perf_evlist *evlist);
57 
58 void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
59 int perf_evlist__add_default(struct perf_evlist *evlist);
60 int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
61 				     struct perf_event_attr *attrs, size_t nr_attrs);
62 
63 #define perf_evlist__add_default_attrs(evlist, array) \
64 	__perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
65 
66 int perf_evlist__add_newtp(struct perf_evlist *evlist,
67 			   const char *sys, const char *name, void *handler);
68 
69 int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
70 
71 struct perf_evsel *
72 perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
73 
74 void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
75 			 int cpu, int thread, u64 id);
76 
77 void perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
78 
79 struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
80 
81 union perf_event *perf_evlist__mmap_read(struct perf_evlist *self, int idx);
82 
83 int perf_evlist__open(struct perf_evlist *evlist);
84 void perf_evlist__close(struct perf_evlist *evlist);
85 
86 void perf_evlist__config(struct perf_evlist *evlist,
87 			 struct perf_record_opts *opts);
88 
89 int perf_evlist__prepare_workload(struct perf_evlist *evlist,
90 				  struct perf_target *target,
91 				  const char *argv[], bool pipe_output,
92 				  bool want_signal);
93 int perf_evlist__start_workload(struct perf_evlist *evlist);
94 
95 int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
96 		      bool overwrite);
97 void perf_evlist__munmap(struct perf_evlist *evlist);
98 
99 void perf_evlist__disable(struct perf_evlist *evlist);
100 void perf_evlist__enable(struct perf_evlist *evlist);
101 
102 void perf_evlist__set_selected(struct perf_evlist *evlist,
103 			       struct perf_evsel *evsel);
104 
105 static inline void perf_evlist__set_maps(struct perf_evlist *evlist,
106 					 struct cpu_map *cpus,
107 					 struct thread_map *threads)
108 {
109 	evlist->cpus	= cpus;
110 	evlist->threads	= threads;
111 }
112 
113 int perf_evlist__create_maps(struct perf_evlist *evlist,
114 			     struct perf_target *target);
115 void perf_evlist__delete_maps(struct perf_evlist *evlist);
116 int perf_evlist__apply_filters(struct perf_evlist *evlist);
117 
118 void __perf_evlist__set_leader(struct list_head *list);
119 void perf_evlist__set_leader(struct perf_evlist *evlist);
120 
121 u64 perf_evlist__sample_type(struct perf_evlist *evlist);
122 bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
123 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
124 
125 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
126 			      struct perf_sample *sample);
127 
128 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
129 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
130 
131 void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
132 				   struct list_head *list,
133 				   int nr_entries);
134 
135 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
136 {
137 	return list_entry(evlist->entries.next, struct perf_evsel, node);
138 }
139 
140 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
141 {
142 	return list_entry(evlist->entries.prev, struct perf_evsel, node);
143 }
144 
145 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
146 
147 static inline unsigned int perf_mmap__read_head(struct perf_mmap *mm)
148 {
149 	struct perf_event_mmap_page *pc = mm->base;
150 	int head = pc->data_head;
151 	rmb();
152 	return head;
153 }
154 
155 static inline void perf_mmap__write_tail(struct perf_mmap *md,
156 					 unsigned long tail)
157 {
158 	struct perf_event_mmap_page *pc = md->base;
159 
160 	/*
161 	 * ensure all reads are done before we write the tail out.
162 	 */
163 	/* mb(); */
164 	pc->data_tail = tail;
165 }
166 
167 #endif /* __PERF_EVLIST_H */
168