bf758e53c9292fe6eeddb64074836007f55b5752
[linux-3.10.git] / tools / perf / util / evsel.h
1 #ifndef __PERF_EVSEL_H
2 #define __PERF_EVSEL_H 1
3
4 #include <linux/list.h>
5 #include <stdbool.h>
6 #include <stddef.h>
7 #include <linux/perf_event.h>
8 #include "types.h"
9 #include "xyarray.h"
10 #include "cgroup.h"
11 #include "hist.h"
12 #include "symbol.h"
13  
14 struct perf_counts_values {
15         union {
16                 struct {
17                         u64 val;
18                         u64 ena;
19                         u64 run;
20                 };
21                 u64 values[3];
22         };
23 };
24
25 struct perf_counts {
26         s8                        scaled;
27         struct perf_counts_values aggr;
28         struct perf_counts_values cpu[];
29 };
30
31 struct perf_evsel;
32
33 /*
34  * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
35  * more than one entry in the evlist.
36  */
37 struct perf_sample_id {
38         struct hlist_node       node;
39         u64                     id;
40         struct perf_evsel       *evsel;
41 };
42
43 /** struct perf_evsel - event selector
44  *
45  * @name - Can be set to retain the original event name passed by the user,
46  *         so that when showing results in tools such as 'perf stat', we
47  *         show the name used, not some alias.
48  */
49 struct perf_evsel {
50         struct list_head        node;
51         struct perf_event_attr  attr;
52         char                    *filter;
53         struct xyarray          *fd;
54         struct xyarray          *sample_id;
55         u64                     *id;
56         struct perf_counts      *counts;
57         struct perf_counts      *prev_raw_counts;
58         int                     idx;
59         u32                     ids;
60         struct hists            hists;
61         char                    *name;
62         struct event_format     *tp_format;
63         union {
64                 void            *priv;
65                 off_t           id_offset;
66         };
67         struct cgroup_sel       *cgrp;
68         struct {
69                 void            *func;
70                 void            *data;
71         } handler;
72         struct cpu_map          *cpus;
73         unsigned int            sample_size;
74         bool                    supported;
75         bool                    needs_swap;
76         /* parse modifier helper */
77         int                     exclude_GH;
78         int                     nr_members;
79         struct perf_evsel       *leader;
80         char                    *group_name;
81 };
82
83 #define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)
84
85 struct cpu_map;
86 struct thread_map;
87 struct perf_evlist;
88 struct perf_record_opts;
89
90 struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr, int idx);
91 struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name, int idx);
92
93 struct event_format *event_format__new(const char *sys, const char *name);
94
95 void perf_evsel__init(struct perf_evsel *evsel,
96                       struct perf_event_attr *attr, int idx);
97 void perf_evsel__exit(struct perf_evsel *evsel);
98 void perf_evsel__delete(struct perf_evsel *evsel);
99
100 void perf_evsel__config(struct perf_evsel *evsel,
101                         struct perf_record_opts *opts);
102
103 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
104
105 #define PERF_EVSEL__MAX_ALIASES 8
106
107 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
108                                        [PERF_EVSEL__MAX_ALIASES];
109 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
110                                           [PERF_EVSEL__MAX_ALIASES];
111 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
112                                               [PERF_EVSEL__MAX_ALIASES];
113 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
114 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
115 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
116                                             char *bf, size_t size);
117 const char *perf_evsel__name(struct perf_evsel *evsel);
118 const char *perf_evsel__group_name(struct perf_evsel *evsel);
119 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
120
121 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
122 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
123 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
124 void perf_evsel__free_fd(struct perf_evsel *evsel);
125 void perf_evsel__free_id(struct perf_evsel *evsel);
126 void perf_evsel__free_counts(struct perf_evsel *evsel);
127 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
128
129 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
130                                   enum perf_event_sample_format bit);
131 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
132                                     enum perf_event_sample_format bit);
133
134 #define perf_evsel__set_sample_bit(evsel, bit) \
135         __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
136
137 #define perf_evsel__reset_sample_bit(evsel, bit) \
138         __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
139
140 void perf_evsel__set_sample_id(struct perf_evsel *evsel);
141
142 int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
143                            const char *filter);
144
145 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
146                              struct cpu_map *cpus);
147 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
148                                 struct thread_map *threads);
149 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
150                      struct thread_map *threads);
151 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
152
153 struct perf_sample;
154
155 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
156                          const char *name);
157 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
158                        const char *name);
159
160 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
161                                        struct perf_sample *sample,
162                                        const char *name)
163 {
164         return perf_evsel__rawptr(evsel, sample, name);
165 }
166
167 struct format_field;
168
169 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
170
171 #define perf_evsel__match(evsel, t, c)          \
172         (evsel->attr.type == PERF_TYPE_##t &&   \
173          evsel->attr.config == PERF_COUNT_##c)
174
175 static inline bool perf_evsel__match2(struct perf_evsel *e1,
176                                       struct perf_evsel *e2)
177 {
178         return (e1->attr.type == e2->attr.type) &&
179                (e1->attr.config == e2->attr.config);
180 }
181
182 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
183                               int cpu, int thread, bool scale);
184
185 /**
186  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
187  *
188  * @evsel - event selector to read value
189  * @cpu - CPU of interest
190  * @thread - thread of interest
191  */
192 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
193                                           int cpu, int thread)
194 {
195         return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
196 }
197
198 /**
199  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
200  *
201  * @evsel - event selector to read value
202  * @cpu - CPU of interest
203  * @thread - thread of interest
204  */
205 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
206                                                  int cpu, int thread)
207 {
208         return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
209 }
210
211 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
212                        bool scale);
213
214 /**
215  * perf_evsel__read - Read the aggregate results on all CPUs
216  *
217  * @evsel - event selector to read value
218  * @ncpus - Number of cpus affected, from zero
219  * @nthreads - Number of threads affected, from zero
220  */
221 static inline int perf_evsel__read(struct perf_evsel *evsel,
222                                     int ncpus, int nthreads)
223 {
224         return __perf_evsel__read(evsel, ncpus, nthreads, false);
225 }
226
227 /**
228  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
229  *
230  * @evsel - event selector to read value
231  * @ncpus - Number of cpus affected, from zero
232  * @nthreads - Number of threads affected, from zero
233  */
234 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
235                                           int ncpus, int nthreads)
236 {
237         return __perf_evsel__read(evsel, ncpus, nthreads, true);
238 }
239
240 void hists__init(struct hists *hists);
241
242 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
243                              struct perf_sample *sample);
244
245 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
246 {
247         return list_entry(evsel->node.next, struct perf_evsel, node);
248 }
249
250 /**
251  * perf_evsel__is_group_leader - Return whether given evsel is a leader event
252  *
253  * @evsel - evsel selector to be tested
254  *
255  * Return %true if @evsel is a group leader or a stand-alone event
256  */
257 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
258 {
259         return evsel->leader == evsel;
260 }
261
262 /**
263  * perf_evsel__is_group_event - Return whether given evsel is a group event
264  *
265  * @evsel - evsel selector to be tested
266  *
267  * Return %true iff event group view is enabled and @evsel is a actual group
268  * leader which has other members in the group
269  */
270 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
271 {
272         if (!symbol_conf.event_group)
273                 return false;
274
275         return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
276 }
277
278 struct perf_attr_details {
279         bool freq;
280         bool verbose;
281         bool event_group;
282 };
283
284 int perf_evsel__fprintf(struct perf_evsel *evsel,
285                         struct perf_attr_details *details, FILE *fp);
286
287 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
288                           char *msg, size_t msgsize);
289 int perf_evsel__open_strerror(struct perf_evsel *evsel,
290                               struct perf_target *target,
291                               int err, char *msg, size_t size);
292
293 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
294 {
295         return evsel->idx - evsel->leader->idx;
296 }
297
298 #define for_each_group_member(_evsel, _leader)                                  \
299 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node);      \
300      (_evsel) && (_evsel)->leader == (_leader);                                 \
301      (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
302
303 #endif /* __PERF_EVSEL_H */