xref: /openbmc/linux/tools/perf/util/evsel.h (revision 05bcf503)
1 #ifndef __PERF_EVSEL_H
2 #define __PERF_EVSEL_H 1
3 
4 #include <linux/list.h>
5 #include <stdbool.h>
6 #include "../../../include/uapi/linux/perf_event.h"
7 #include "types.h"
8 #include "xyarray.h"
9 #include "cgroup.h"
10 #include "hist.h"
11 
12 struct perf_counts_values {
13 	union {
14 		struct {
15 			u64 val;
16 			u64 ena;
17 			u64 run;
18 		};
19 		u64 values[3];
20 	};
21 };
22 
23 struct perf_counts {
24 	s8		   	  scaled;
25 	struct perf_counts_values aggr;
26 	struct perf_counts_values cpu[];
27 };
28 
29 struct perf_evsel;
30 
31 /*
32  * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
33  * more than one entry in the evlist.
34  */
35 struct perf_sample_id {
36 	struct hlist_node 	node;
37 	u64		 	id;
38 	struct perf_evsel	*evsel;
39 };
40 
41 /** struct perf_evsel - event selector
42  *
43  * @name - Can be set to retain the original event name passed by the user,
44  *         so that when showing results in tools such as 'perf stat', we
45  *         show the name used, not some alias.
46  */
47 struct perf_evsel {
48 	struct list_head	node;
49 	struct perf_event_attr	attr;
50 	char			*filter;
51 	struct xyarray		*fd;
52 	struct xyarray		*sample_id;
53 	u64			*id;
54 	struct perf_counts	*counts;
55 	int			idx;
56 	u32			ids;
57 	struct hists		hists;
58 	char			*name;
59 	struct event_format	*tp_format;
60 	union {
61 		void		*priv;
62 		off_t		id_offset;
63 	};
64 	struct cgroup_sel	*cgrp;
65 	struct {
66 		void		*func;
67 		void		*data;
68 	} handler;
69 	struct cpu_map		*cpus;
70 	unsigned int		sample_size;
71 	bool 			supported;
72 	bool 			needs_swap;
73 	/* parse modifier helper */
74 	int			exclude_GH;
75 	struct perf_evsel	*leader;
76 	char			*group_name;
77 };
78 
79 struct cpu_map;
80 struct thread_map;
81 struct perf_evlist;
82 struct perf_record_opts;
83 
84 struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr, int idx);
85 struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name, int idx);
86 
87 struct event_format *event_format__new(const char *sys, const char *name);
88 
89 void perf_evsel__init(struct perf_evsel *evsel,
90 		      struct perf_event_attr *attr, int idx);
91 void perf_evsel__exit(struct perf_evsel *evsel);
92 void perf_evsel__delete(struct perf_evsel *evsel);
93 
94 void perf_evsel__config(struct perf_evsel *evsel,
95 			struct perf_record_opts *opts,
96 			struct perf_evsel *first);
97 
98 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
99 
100 #define PERF_EVSEL__MAX_ALIASES 8
101 
102 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
103 				       [PERF_EVSEL__MAX_ALIASES];
104 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
105 					  [PERF_EVSEL__MAX_ALIASES];
106 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
107 					      [PERF_EVSEL__MAX_ALIASES];
108 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
109 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
110 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
111 					    char *bf, size_t size);
112 const char *perf_evsel__name(struct perf_evsel *evsel);
113 
114 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
115 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
116 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
117 void perf_evsel__free_fd(struct perf_evsel *evsel);
118 void perf_evsel__free_id(struct perf_evsel *evsel);
119 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
120 
121 int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
122 			   const char *filter);
123 
124 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
125 			     struct cpu_map *cpus);
126 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
127 				struct thread_map *threads);
128 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
129 		     struct thread_map *threads);
130 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
131 
132 struct perf_sample;
133 
134 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
135 			 const char *name);
136 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
137 		       const char *name);
138 
139 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
140 				       struct perf_sample *sample,
141 				       const char *name)
142 {
143 	return perf_evsel__rawptr(evsel, sample, name);
144 }
145 
146 struct format_field;
147 
148 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
149 
150 #define perf_evsel__match(evsel, t, c)		\
151 	(evsel->attr.type == PERF_TYPE_##t &&	\
152 	 evsel->attr.config == PERF_COUNT_##c)
153 
154 static inline bool perf_evsel__match2(struct perf_evsel *e1,
155 				      struct perf_evsel *e2)
156 {
157 	return (e1->attr.type == e2->attr.type) &&
158 	       (e1->attr.config == e2->attr.config);
159 }
160 
161 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
162 			      int cpu, int thread, bool scale);
163 
164 /**
165  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
166  *
167  * @evsel - event selector to read value
168  * @cpu - CPU of interest
169  * @thread - thread of interest
170  */
171 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
172 					  int cpu, int thread)
173 {
174 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
175 }
176 
177 /**
178  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
179  *
180  * @evsel - event selector to read value
181  * @cpu - CPU of interest
182  * @thread - thread of interest
183  */
184 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
185 						 int cpu, int thread)
186 {
187 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
188 }
189 
190 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
191 		       bool scale);
192 
193 /**
194  * perf_evsel__read - Read the aggregate results on all CPUs
195  *
196  * @evsel - event selector to read value
197  * @ncpus - Number of cpus affected, from zero
198  * @nthreads - Number of threads affected, from zero
199  */
200 static inline int perf_evsel__read(struct perf_evsel *evsel,
201 				    int ncpus, int nthreads)
202 {
203 	return __perf_evsel__read(evsel, ncpus, nthreads, false);
204 }
205 
206 /**
207  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
208  *
209  * @evsel - event selector to read value
210  * @ncpus - Number of cpus affected, from zero
211  * @nthreads - Number of threads affected, from zero
212  */
213 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
214 					  int ncpus, int nthreads)
215 {
216 	return __perf_evsel__read(evsel, ncpus, nthreads, true);
217 }
218 
219 void hists__init(struct hists *hists);
220 
221 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
222 			     struct perf_sample *sample);
223 
224 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
225 {
226 	return list_entry(evsel->node.next, struct perf_evsel, node);
227 }
228 #endif /* __PERF_EVSEL_H */
229