]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - tools/perf/util/evsel.h
perf evlist: Add 'system_wide' option
[mirror_ubuntu-artful-kernel.git] / tools / perf / util / evsel.h
CommitLineData
69aad6f1
ACM
1#ifndef __PERF_EVSEL_H
2#define __PERF_EVSEL_H 1
3
4#include <linux/list.h>
c52b12ed 5#include <stdbool.h>
07ac002f 6#include <stddef.h>
d2709c7c 7#include <linux/perf_event.h>
d944c4ee 8#include <linux/types.h>
69aad6f1 9#include "xyarray.h"
023695d9 10#include "cgroup.h"
e248de33 11#include "hist.h"
759ff497 12#include "symbol.h"
d944c4ee 13
c52b12ed
ACM
14struct perf_counts_values {
15 union {
16 struct {
17 u64 val;
18 u64 ena;
19 u64 run;
20 };
21 u64 values[3];
22 };
23};
24
25struct perf_counts {
26 s8 scaled;
27 struct perf_counts_values aggr;
28 struct perf_counts_values cpu[];
29};
69aad6f1 30
70db7533
ACM
31struct 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 */
37struct perf_sample_id {
38 struct hlist_node node;
39 u64 id;
40 struct perf_evsel *evsel;
e4caec0d
JO
41
42 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
43 u64 period;
70db7533
ACM
44};
45
f0c55bcf
SE
46/** struct perf_evsel - event selector
47 *
48 * @name - Can be set to retain the original event name passed by the user,
49 * so that when showing results in tools such as 'perf stat', we
50 * show the name used, not some alias.
75562573
AH
51 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
52 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
53 * struct sample_event
54 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
55 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
56 * is used there is an id sample appended to non-sample events
f0c55bcf 57 */
69aad6f1
ACM
58struct perf_evsel {
59 struct list_head node;
60 struct perf_event_attr attr;
61 char *filter;
62 struct xyarray *fd;
a91e5431
ACM
63 struct xyarray *sample_id;
64 u64 *id;
c52b12ed 65 struct perf_counts *counts;
c7a79c47 66 struct perf_counts *prev_raw_counts;
69aad6f1 67 int idx;
f4d83436 68 u32 ids;
e248de33 69 struct hists hists;
f0c55bcf 70 char *name;
410136f5
SE
71 double scale;
72 const char *unit;
fcf65bf1 73 struct event_format *tp_format;
a91e5431
ACM
74 union {
75 void *priv;
76 off_t id_offset;
77 };
023695d9 78 struct cgroup_sel *cgrp;
744a9719 79 void *handler;
7ae92e74 80 struct cpu_map *cpus;
bde09467 81 unsigned int sample_size;
75562573
AH
82 int id_pos;
83 int is_pos;
2cee77c4 84 bool supported;
0807d2d8 85 bool needs_swap;
6ff1ce76 86 bool no_aux_samples;
2afd2bcf 87 bool immediate;
bf8e8f4b 88 bool system_wide;
f5b1135b
JO
89 /* parse modifier helper */
90 int exclude_GH;
97f63e4a 91 int nr_members;
3c176311 92 int sample_read;
6a4bb04c
JO
93 struct perf_evsel *leader;
94 char *group_name;
69aad6f1
ACM
95};
96
88080ce7
BP
97union u64_swap {
98 u64 val64;
99 u32 val32[2];
100};
101
29d720ed
NK
102#define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)
103
86bd5e86
ACM
104struct cpu_map;
105struct thread_map;
70082dd9 106struct perf_evlist;
b4006796 107struct record_opts;
86bd5e86 108
ef503831
ACM
109struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
110
111static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
112{
113 return perf_evsel__new_idx(attr, 0);
114}
115
116struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
117
118static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
119{
120 return perf_evsel__newtp_idx(sys, name, 0);
121}
201b7334
ACM
122
123struct event_format *event_format__new(const char *sys, const char *name);
124
ef1d1af2
ACM
125void perf_evsel__init(struct perf_evsel *evsel,
126 struct perf_event_attr *attr, int idx);
127void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1
ACM
128void perf_evsel__delete(struct perf_evsel *evsel);
129
0f82ebc4 130void perf_evsel__config(struct perf_evsel *evsel,
b4006796 131 struct record_opts *opts);
0f82ebc4 132
75562573
AH
133int __perf_evsel__sample_size(u64 sample_type);
134void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
135
0b668bc9
ACM
136bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
137
138#define PERF_EVSEL__MAX_ALIASES 8
139
140extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
141 [PERF_EVSEL__MAX_ALIASES];
142extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
143 [PERF_EVSEL__MAX_ALIASES];
8ad7013b
ACM
144extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
145 [PERF_EVSEL__MAX_ALIASES];
146extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
147extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9
ACM
148int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
149 char *bf, size_t size);
7289f83c 150const char *perf_evsel__name(struct perf_evsel *evsel);
410136f5 151
717e263f
NK
152const char *perf_evsel__group_name(struct perf_evsel *evsel);
153int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
c410431c 154
69aad6f1 155int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
70db7533 156int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed 157int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
a7e191c3 158void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
69aad6f1 159void perf_evsel__free_fd(struct perf_evsel *evsel);
70db7533 160void perf_evsel__free_id(struct perf_evsel *evsel);
43f8e76e 161void perf_evsel__free_counts(struct perf_evsel *evsel);
c52b12ed 162void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1 163
7be5ebe8
ACM
164void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
165 enum perf_event_sample_format bit);
166void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
167 enum perf_event_sample_format bit);
168
169#define perf_evsel__set_sample_bit(evsel, bit) \
170 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
171
172#define perf_evsel__reset_sample_bit(evsel, bit) \
173 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
174
75562573
AH
175void perf_evsel__set_sample_id(struct perf_evsel *evsel,
176 bool use_sample_identifier);
7a5a5ca5 177
745cefc5
ACM
178int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
179 const char *filter);
e2407bef 180int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
745cefc5 181
f08199d3 182int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c 183 struct cpu_map *cpus);
f08199d3 184int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c 185 struct thread_map *threads);
f08199d3 186int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
6a4bb04c 187 struct thread_map *threads);
727ab04e 188void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609 189
5555ded4
ACM
190struct perf_sample;
191
5d2074ea 192void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
5555ded4
ACM
193 const char *name);
194u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
195 const char *name);
196
5d2074ea
ACM
197static inline char *perf_evsel__strval(struct perf_evsel *evsel,
198 struct perf_sample *sample,
199 const char *name)
200{
201 return perf_evsel__rawptr(evsel, sample, name);
202}
203
efd2b924
ACM
204struct format_field;
205
206struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
207
daec78a0
ACM
208#define perf_evsel__match(evsel, t, c) \
209 (evsel->attr.type == PERF_TYPE_##t && \
210 evsel->attr.config == PERF_COUNT_##c)
211
863e451f
JO
212static inline bool perf_evsel__match2(struct perf_evsel *e1,
213 struct perf_evsel *e2)
214{
215 return (e1->attr.type == e2->attr.type) &&
216 (e1->attr.config == e2->attr.config);
217}
218
4cabc3d1
AK
219#define perf_evsel__cmp(a, b) \
220 ((a) && \
221 (b) && \
222 (a)->attr.type == (b)->attr.type && \
223 (a)->attr.config == (b)->attr.config)
224
c52b12ed
ACM
225int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
226 int cpu, int thread, bool scale);
227
228/**
229 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
230 *
231 * @evsel - event selector to read value
232 * @cpu - CPU of interest
233 * @thread - thread of interest
234 */
235static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
236 int cpu, int thread)
237{
238 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
239}
240
241/**
242 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
243 *
244 * @evsel - event selector to read value
245 * @cpu - CPU of interest
246 * @thread - thread of interest
247 */
248static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
249 int cpu, int thread)
250{
251 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
252}
253
254int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
255 bool scale);
256
257/**
258 * perf_evsel__read - Read the aggregate results on all CPUs
259 *
260 * @evsel - event selector to read value
261 * @ncpus - Number of cpus affected, from zero
262 * @nthreads - Number of threads affected, from zero
263 */
264static inline int perf_evsel__read(struct perf_evsel *evsel,
265 int ncpus, int nthreads)
266{
267 return __perf_evsel__read(evsel, ncpus, nthreads, false);
268}
269
270/**
271 * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
272 *
273 * @evsel - event selector to read value
274 * @ncpus - Number of cpus affected, from zero
275 * @nthreads - Number of threads affected, from zero
276 */
277static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
278 int ncpus, int nthreads)
279{
280 return __perf_evsel__read(evsel, ncpus, nthreads, true);
281}
282
4bf9ce1b
JO
283void hists__init(struct hists *hists);
284
a3f698fe 285int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
0807d2d8 286 struct perf_sample *sample);
0c21f736
ACM
287
288static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
289{
290 return list_entry(evsel->node.next, struct perf_evsel, node);
291}
07ac002f 292
d87fcb4a
ACM
293static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
294{
295 return list_entry(evsel->node.prev, struct perf_evsel, node);
296}
297
759ff497
NK
298/**
299 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
300 *
301 * @evsel - evsel selector to be tested
302 *
303 * Return %true if @evsel is a group leader or a stand-alone event
304 */
823254ed 305static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f 306{
823254ed 307 return evsel->leader == evsel;
07ac002f 308}
0698aedd 309
759ff497
NK
310/**
311 * perf_evsel__is_group_event - Return whether given evsel is a group event
312 *
313 * @evsel - evsel selector to be tested
314 *
315 * Return %true iff event group view is enabled and @evsel is a actual group
316 * leader which has other members in the group
317 */
318static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
319{
320 if (!symbol_conf.event_group)
321 return false;
322
323 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
324}
325
6bedfab6
JO
326/**
327 * perf_evsel__is_function_event - Return whether given evsel is a function
328 * trace event
329 *
330 * @evsel - evsel selector to be tested
331 *
332 * Return %true if event is function trace event
333 */
334static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel)
335{
336#define FUNCTION_EVENT "ftrace:function"
337
338 return evsel->name &&
339 !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
340
341#undef FUNCTION_EVENT
342}
343
0698aedd
ACM
344struct perf_attr_details {
345 bool freq;
346 bool verbose;
e35ef355 347 bool event_group;
0698aedd
ACM
348};
349
350int perf_evsel__fprintf(struct perf_evsel *evsel,
351 struct perf_attr_details *details, FILE *fp);
c0a54341
ACM
352
353bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
354 char *msg, size_t msgsize);
602ad878 355int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
56e52e85 356 int err, char *msg, size_t size);
97f63e4a
NK
357
358static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
359{
360 return evsel->idx - evsel->leader->idx;
361}
717e263f
NK
362
363#define for_each_group_member(_evsel, _leader) \
364for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
365 (_evsel) && (_evsel)->leader == (_leader); \
366 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
367
69aad6f1 368#endif /* __PERF_EVSEL_H */