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