xref: /linux/tools/perf/util/evsel.h (revision 95e9fd10f06cb5642028b6b851e32b8c8afb4571)
1 #ifndef __PERF_EVSEL_H
2 #define __PERF_EVSEL_H 1
3 
4 #include <linux/list.h>
5 #include <stdbool.h>
6 #include "../../../include/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 	int			ids;
57 	struct hists		hists;
58 	char			*name;
59 	union {
60 		void		*priv;
61 		off_t		id_offset;
62 	};
63 	struct cgroup_sel	*cgrp;
64 	struct {
65 		void		*func;
66 		void		*data;
67 	} handler;
68 	unsigned int		sample_size;
69 	bool 			supported;
70 };
71 
72 struct cpu_map;
73 struct thread_map;
74 struct perf_evlist;
75 struct perf_record_opts;
76 
77 struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr, int idx);
78 void perf_evsel__init(struct perf_evsel *evsel,
79 		      struct perf_event_attr *attr, int idx);
80 void perf_evsel__exit(struct perf_evsel *evsel);
81 void perf_evsel__delete(struct perf_evsel *evsel);
82 
83 void perf_evsel__config(struct perf_evsel *evsel,
84 			struct perf_record_opts *opts,
85 			struct perf_evsel *first);
86 
87 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
88 
89 #define PERF_EVSEL__MAX_ALIASES 8
90 
91 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
92 				       [PERF_EVSEL__MAX_ALIASES];
93 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
94 					  [PERF_EVSEL__MAX_ALIASES];
95 const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
96 				       [PERF_EVSEL__MAX_ALIASES];
97 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
98 					    char *bf, size_t size);
99 const char *perf_evsel__name(struct perf_evsel *evsel);
100 
101 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
102 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
103 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
104 void perf_evsel__free_fd(struct perf_evsel *evsel);
105 void perf_evsel__free_id(struct perf_evsel *evsel);
106 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
107 
108 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
109 			     struct cpu_map *cpus, bool group,
110 			     struct xyarray *group_fds);
111 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
112 				struct thread_map *threads, bool group,
113 				struct xyarray *group_fds);
114 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
115 		     struct thread_map *threads, bool group,
116 		     struct xyarray *group_fds);
117 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
118 
119 #define perf_evsel__match(evsel, t, c)		\
120 	(evsel->attr.type == PERF_TYPE_##t &&	\
121 	 evsel->attr.config == PERF_COUNT_##c)
122 
123 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
124 			      int cpu, int thread, bool scale);
125 
126 /**
127  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
128  *
129  * @evsel - event selector to read value
130  * @cpu - CPU of interest
131  * @thread - thread of interest
132  */
133 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
134 					  int cpu, int thread)
135 {
136 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
137 }
138 
139 /**
140  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
141  *
142  * @evsel - event selector to read value
143  * @cpu - CPU of interest
144  * @thread - thread of interest
145  */
146 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
147 						 int cpu, int thread)
148 {
149 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
150 }
151 
152 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
153 		       bool scale);
154 
155 /**
156  * perf_evsel__read - Read the aggregate results on all CPUs
157  *
158  * @evsel - event selector to read value
159  * @ncpus - Number of cpus affected, from zero
160  * @nthreads - Number of threads affected, from zero
161  */
162 static inline int perf_evsel__read(struct perf_evsel *evsel,
163 				    int ncpus, int nthreads)
164 {
165 	return __perf_evsel__read(evsel, ncpus, nthreads, false);
166 }
167 
168 /**
169  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
170  *
171  * @evsel - event selector to read value
172  * @ncpus - Number of cpus affected, from zero
173  * @nthreads - Number of threads affected, from zero
174  */
175 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
176 					  int ncpus, int nthreads)
177 {
178 	return __perf_evsel__read(evsel, ncpus, nthreads, true);
179 }
180 
181 void hists__init(struct hists *hists);
182 
183 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
184 			     struct perf_sample *sample, bool swapped);
185 #endif /* __PERF_EVSEL_H */
186