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