xref: /linux/tools/perf/util/evsel.h (revision ce7240e445303de3ca66e6d08f17a2ec278a5bf6)
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 	bool 			supported;
69 };
70 
71 struct cpu_map;
72 struct thread_map;
73 struct perf_evlist;
74 struct perf_record_opts;
75 
76 struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr, int idx);
77 void perf_evsel__init(struct perf_evsel *evsel,
78 		      struct perf_event_attr *attr, int idx);
79 void perf_evsel__exit(struct perf_evsel *evsel);
80 void perf_evsel__delete(struct perf_evsel *evsel);
81 
82 void perf_evsel__config(struct perf_evsel *evsel,
83 			struct perf_record_opts *opts,
84 			struct perf_evsel *first);
85 
86 const char* __perf_evsel__hw_name(u64 config);
87 int perf_evsel__name(struct perf_evsel *evsel, char *bf, size_t size);
88 
89 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
90 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
91 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
92 void perf_evsel__free_fd(struct perf_evsel *evsel);
93 void perf_evsel__free_id(struct perf_evsel *evsel);
94 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
95 
96 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
97 			     struct cpu_map *cpus, bool group,
98 			     struct xyarray *group_fds);
99 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
100 				struct thread_map *threads, bool group,
101 				struct xyarray *group_fds);
102 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
103 		     struct thread_map *threads, bool group,
104 		     struct xyarray *group_fds);
105 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
106 
107 #define perf_evsel__match(evsel, t, c)		\
108 	(evsel->attr.type == PERF_TYPE_##t &&	\
109 	 evsel->attr.config == PERF_COUNT_##c)
110 
111 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
112 			      int cpu, int thread, bool scale);
113 
114 /**
115  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
116  *
117  * @evsel - event selector to read value
118  * @cpu - CPU of interest
119  * @thread - thread of interest
120  */
121 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
122 					  int cpu, int thread)
123 {
124 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
125 }
126 
127 /**
128  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
129  *
130  * @evsel - event selector to read value
131  * @cpu - CPU of interest
132  * @thread - thread of interest
133  */
134 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
135 						 int cpu, int thread)
136 {
137 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
138 }
139 
140 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
141 		       bool scale);
142 
143 /**
144  * perf_evsel__read - Read the aggregate results on all CPUs
145  *
146  * @evsel - event selector to read value
147  * @ncpus - Number of cpus affected, from zero
148  * @nthreads - Number of threads affected, from zero
149  */
150 static inline int perf_evsel__read(struct perf_evsel *evsel,
151 				    int ncpus, int nthreads)
152 {
153 	return __perf_evsel__read(evsel, ncpus, nthreads, false);
154 }
155 
156 /**
157  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
158  *
159  * @evsel - event selector to read value
160  * @ncpus - Number of cpus affected, from zero
161  * @nthreads - Number of threads affected, from zero
162  */
163 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
164 					  int ncpus, int nthreads)
165 {
166 	return __perf_evsel__read(evsel, ncpus, nthreads, true);
167 }
168 
169 int __perf_evsel__sample_size(u64 sample_type);
170 
171 static inline int perf_evsel__sample_size(struct perf_evsel *evsel)
172 {
173 	return __perf_evsel__sample_size(evsel->attr.sample_type);
174 }
175 
176 void hists__init(struct hists *hists);
177 
178 #endif /* __PERF_EVSEL_H */
179