xref: /openbmc/linux/tools/perf/util/evlist.h (revision 161f4089)
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 	char		 event_copy[PERF_SAMPLE_MAX_SIZE];
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 	size_t		 mmap_len;
35 	int		 id_pos;
36 	int		 is_pos;
37 	u64		 combined_sample_type;
38 	struct {
39 		int	cork_fd;
40 		pid_t	pid;
41 	} workload;
42 	bool		 overwrite;
43 	struct perf_mmap *mmap;
44 	struct pollfd	 *pollfd;
45 	struct thread_map *threads;
46 	struct cpu_map	  *cpus;
47 	struct perf_evsel *selected;
48 };
49 
50 struct perf_evsel_str_handler {
51 	const char *name;
52 	void	   *handler;
53 };
54 
55 struct perf_evlist *perf_evlist__new(void);
56 struct perf_evlist *perf_evlist__new_default(void);
57 void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
58 		       struct thread_map *threads);
59 void perf_evlist__exit(struct perf_evlist *evlist);
60 void perf_evlist__delete(struct perf_evlist *evlist);
61 
62 void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
63 int perf_evlist__add_default(struct perf_evlist *evlist);
64 int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
65 				     struct perf_event_attr *attrs, size_t nr_attrs);
66 
67 #define perf_evlist__add_default_attrs(evlist, array) \
68 	__perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
69 
70 int perf_evlist__add_newtp(struct perf_evlist *evlist,
71 			   const char *sys, const char *name, void *handler);
72 
73 int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
74 
75 struct perf_evsel *
76 perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
77 
78 struct perf_evsel *
79 perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
80 				     const char *name);
81 
82 void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
83 			 int cpu, int thread, u64 id);
84 
85 void perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
86 
87 struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
88 
89 struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);
90 
91 union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx);
92 
93 void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);
94 
95 int perf_evlist__open(struct perf_evlist *evlist);
96 void perf_evlist__close(struct perf_evlist *evlist);
97 
98 void perf_evlist__set_id_pos(struct perf_evlist *evlist);
99 bool perf_can_sample_identifier(void);
100 void perf_evlist__config(struct perf_evlist *evlist,
101 			 struct perf_record_opts *opts);
102 int perf_record_opts__config(struct perf_record_opts *opts);
103 
104 int perf_evlist__prepare_workload(struct perf_evlist *evlist,
105 				  struct perf_target *target,
106 				  const char *argv[], bool pipe_output,
107 				  bool want_signal);
108 int perf_evlist__start_workload(struct perf_evlist *evlist);
109 
110 int perf_evlist__parse_mmap_pages(const struct option *opt,
111 				  const char *str,
112 				  int unset);
113 
114 int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
115 		      bool overwrite);
116 void perf_evlist__munmap(struct perf_evlist *evlist);
117 
118 void perf_evlist__disable(struct perf_evlist *evlist);
119 void perf_evlist__enable(struct perf_evlist *evlist);
120 
121 int perf_evlist__disable_event(struct perf_evlist *evlist,
122 			       struct perf_evsel *evsel);
123 int perf_evlist__enable_event(struct perf_evlist *evlist,
124 			      struct perf_evsel *evsel);
125 
126 void perf_evlist__set_selected(struct perf_evlist *evlist,
127 			       struct perf_evsel *evsel);
128 
129 static inline void perf_evlist__set_maps(struct perf_evlist *evlist,
130 					 struct cpu_map *cpus,
131 					 struct thread_map *threads)
132 {
133 	evlist->cpus	= cpus;
134 	evlist->threads	= threads;
135 }
136 
137 int perf_evlist__create_maps(struct perf_evlist *evlist,
138 			     struct perf_target *target);
139 void perf_evlist__delete_maps(struct perf_evlist *evlist);
140 int perf_evlist__apply_filters(struct perf_evlist *evlist);
141 
142 void __perf_evlist__set_leader(struct list_head *list);
143 void perf_evlist__set_leader(struct perf_evlist *evlist);
144 
145 u64 perf_evlist__read_format(struct perf_evlist *evlist);
146 u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
147 u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
148 bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
149 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
150 
151 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
152 			      struct perf_sample *sample);
153 
154 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
155 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
156 bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
157 
158 void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
159 				   struct list_head *list,
160 				   int nr_entries);
161 
162 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
163 {
164 	return list_entry(evlist->entries.next, struct perf_evsel, node);
165 }
166 
167 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
168 {
169 	return list_entry(evlist->entries.prev, struct perf_evsel, node);
170 }
171 
172 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
173 
174 int perf_evlist__strerror_tp(struct perf_evlist *evlist, int err, char *buf, size_t size);
175 int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
176 
177 static inline unsigned int perf_mmap__read_head(struct perf_mmap *mm)
178 {
179 	struct perf_event_mmap_page *pc = mm->base;
180 	int head = ACCESS_ONCE(pc->data_head);
181 	rmb();
182 	return head;
183 }
184 
185 static inline void perf_mmap__write_tail(struct perf_mmap *md,
186 					 unsigned long tail)
187 {
188 	struct perf_event_mmap_page *pc = md->base;
189 
190 	/*
191 	 * ensure all reads are done before we write the tail out.
192 	 */
193 	mb();
194 	pc->data_tail = tail;
195 }
196 
197 #endif /* __PERF_EVLIST_H */
198