]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - tools/perf/util/evsel.h
Merge tag 'clk-fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[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"
759ff497 10#include "symbol.h"
a22e99cd 11#include "cpumap.h"
d809560b 12#include "counts.h"
69aad6f1 13
70db7533
ACM
14struct perf_evsel;
15
16/*
17 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
18 * more than one entry in the evlist.
19 */
20struct perf_sample_id {
21 struct hlist_node node;
22 u64 id;
23 struct perf_evsel *evsel;
3c659eed
AH
24 int idx;
25 int cpu;
26 pid_t tid;
e4caec0d
JO
27
28 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
29 u64 period;
70db7533
ACM
30};
31
f14d5707
ACM
32struct cgroup_sel;
33
930a2e29
JO
34/*
35 * The 'struct perf_evsel_config_term' is used to pass event
36 * specific configuration data to perf_evsel__config routine.
37 * It is allocated within event parsing and attached to
38 * perf_evsel::config_terms list head.
39*/
40enum {
ee4c7588 41 PERF_EVSEL__CONFIG_TERM_PERIOD,
09af2a55 42 PERF_EVSEL__CONFIG_TERM_FREQ,
32067712 43 PERF_EVSEL__CONFIG_TERM_TIME,
d457c963
KL
44 PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
45 PERF_EVSEL__CONFIG_TERM_STACK_USER,
374ce938 46 PERF_EVSEL__CONFIG_TERM_INHERIT,
792d48b4 47 PERF_EVSEL__CONFIG_TERM_MAX_STACK,
626a6b78 48 PERF_EVSEL__CONFIG_TERM_OVERWRITE,
930a2e29
JO
49 PERF_EVSEL__CONFIG_TERM_MAX,
50};
51
52struct perf_evsel_config_term {
53 struct list_head list;
54 int type;
55 union {
56 u64 period;
09af2a55 57 u64 freq;
32067712 58 bool time;
d457c963
KL
59 char *callgraph;
60 u64 stack_user;
792d48b4 61 int max_stack;
374ce938 62 bool inherit;
626a6b78 63 bool overwrite;
930a2e29
JO
64 } val;
65};
66
f0c55bcf
SE
67/** struct perf_evsel - event selector
68 *
d49e4695
ACM
69 * @evlist - evlist this evsel is in, if it is in one.
70 * @node - To insert it into evlist->entries or in other list_heads, say in
71 * the event parsing routines.
f0c55bcf
SE
72 * @name - Can be set to retain the original event name passed by the user,
73 * so that when showing results in tools such as 'perf stat', we
74 * show the name used, not some alias.
75562573
AH
75 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
76 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
77 * struct sample_event
78 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
79 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
80 * is used there is an id sample appended to non-sample events
0db15b1e 81 * @priv: And what is in its containing unnamed union are tool specific
f0c55bcf 82 */
69aad6f1
ACM
83struct perf_evsel {
84 struct list_head node;
d49e4695 85 struct perf_evlist *evlist;
69aad6f1
ACM
86 struct perf_event_attr attr;
87 char *filter;
88 struct xyarray *fd;
a91e5431
ACM
89 struct xyarray *sample_id;
90 u64 *id;
c52b12ed 91 struct perf_counts *counts;
c7a79c47 92 struct perf_counts *prev_raw_counts;
69aad6f1 93 int idx;
f4d83436 94 u32 ids;
f0c55bcf 95 char *name;
410136f5
SE
96 double scale;
97 const char *unit;
fcf65bf1 98 struct event_format *tp_format;
af339981 99 off_t id_offset;
616df645
CP
100 void *priv;
101 u64 db_id;
023695d9 102 struct cgroup_sel *cgrp;
744a9719 103 void *handler;
7ae92e74 104 struct cpu_map *cpus;
fce4d296 105 struct cpu_map *own_cpus;
578e91ec 106 struct thread_map *threads;
bde09467 107 unsigned int sample_size;
75562573
AH
108 int id_pos;
109 int is_pos;
86066064 110 bool snapshot;
2cee77c4 111 bool supported;
0807d2d8 112 bool needs_swap;
6ff1ce76 113 bool no_aux_samples;
2afd2bcf 114 bool immediate;
bf8e8f4b 115 bool system_wide;
60b0896c 116 bool tracking;
044330c1 117 bool per_pkg;
7f94af7a 118 bool precise_max;
f5b1135b
JO
119 /* parse modifier helper */
120 int exclude_GH;
97f63e4a 121 int nr_members;
3c176311 122 int sample_read;
86066064 123 unsigned long *per_pkg_mask;
6a4bb04c
JO
124 struct perf_evsel *leader;
125 char *group_name;
15bfd2cc 126 bool cmdline_group_boundary;
930a2e29 127 struct list_head config_terms;
1f45b1d4 128 int bpf_fd;
69aad6f1
ACM
129};
130
88080ce7
BP
131union u64_swap {
132 u64 val64;
133 u32 val32[2];
134};
135
86bd5e86 136struct cpu_map;
80b2210c 137struct target;
86bd5e86 138struct thread_map;
b4006796 139struct record_opts;
86bd5e86 140
a22e99cd
JO
141static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
142{
143 return evsel->cpus;
144}
145
146static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
147{
148 return perf_evsel__cpus(evsel)->nr;
149}
150
13112bbf
JO
151void perf_counts_values__scale(struct perf_counts_values *count,
152 bool scale, s8 *pscaled);
153
a6fa0038 154void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
857a94a2
JO
155 struct perf_counts_values *count);
156
ce8ccff5
ACM
157int perf_evsel__object_config(size_t object_size,
158 int (*init)(struct perf_evsel *evsel),
159 void (*fini)(struct perf_evsel *evsel));
160
ef503831
ACM
161struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
162
163static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
164{
165 return perf_evsel__new_idx(attr, 0);
166}
167
168struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
169
8dd2a131
JO
170/*
171 * Returns pointer with encoded error via <linux/err.h> interface.
172 */
ef503831
ACM
173static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
174{
175 return perf_evsel__newtp_idx(sys, name, 0);
176}
201b7334 177
7c48dcfd
ACM
178struct perf_evsel *perf_evsel__new_cycles(void);
179
201b7334
ACM
180struct event_format *event_format__new(const char *sys, const char *name);
181
ef1d1af2
ACM
182void perf_evsel__init(struct perf_evsel *evsel,
183 struct perf_event_attr *attr, int idx);
184void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1
ACM
185void perf_evsel__delete(struct perf_evsel *evsel);
186
e68ae9cf
ACM
187struct callchain_param;
188
0f82ebc4 189void perf_evsel__config(struct perf_evsel *evsel,
e68ae9cf
ACM
190 struct record_opts *opts,
191 struct callchain_param *callchain);
01e0d50c
ACM
192void perf_evsel__config_callchain(struct perf_evsel *evsel,
193 struct record_opts *opts,
194 struct callchain_param *callchain);
0f82ebc4 195
75562573
AH
196int __perf_evsel__sample_size(u64 sample_type);
197void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
198
0b668bc9
ACM
199bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
200
201#define PERF_EVSEL__MAX_ALIASES 8
202
203extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
204 [PERF_EVSEL__MAX_ALIASES];
205extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
206 [PERF_EVSEL__MAX_ALIASES];
8ad7013b
ACM
207extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
208 [PERF_EVSEL__MAX_ALIASES];
209extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
210extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9
ACM
211int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
212 char *bf, size_t size);
7289f83c 213const char *perf_evsel__name(struct perf_evsel *evsel);
410136f5 214
717e263f
NK
215const char *perf_evsel__group_name(struct perf_evsel *evsel);
216int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
c410431c 217
70db7533 218int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed 219void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1 220
7be5ebe8
ACM
221void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
222 enum perf_event_sample_format bit);
223void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
224 enum perf_event_sample_format bit);
225
226#define perf_evsel__set_sample_bit(evsel, bit) \
227 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
228
229#define perf_evsel__reset_sample_bit(evsel, bit) \
230 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
231
75562573
AH
232void perf_evsel__set_sample_id(struct perf_evsel *evsel,
233 bool use_sample_identifier);
7a5a5ca5 234
12467ae4 235int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
64ec84f5
ACM
236int perf_evsel__append_filter(struct perf_evsel *evsel,
237 const char *op, const char *filter);
f47805a2
ACM
238int perf_evsel__apply_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
239 const char *filter);
5cd95fc3 240int perf_evsel__enable(struct perf_evsel *evsel);
e98a4cbb 241int perf_evsel__disable(struct perf_evsel *evsel);
745cefc5 242
f08199d3 243int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c 244 struct cpu_map *cpus);
f08199d3 245int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c 246 struct thread_map *threads);
f08199d3 247int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
6a4bb04c 248 struct thread_map *threads);
727ab04e 249void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609 250
5555ded4
ACM
251struct perf_sample;
252
5d2074ea 253void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
5555ded4
ACM
254 const char *name);
255u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
256 const char *name);
257
5d2074ea
ACM
258static inline char *perf_evsel__strval(struct perf_evsel *evsel,
259 struct perf_sample *sample,
260 const char *name)
261{
262 return perf_evsel__rawptr(evsel, sample, name);
263}
264
efd2b924
ACM
265struct format_field;
266
90525176
ACM
267u64 format_field__intval(struct format_field *field, struct perf_sample *sample, bool needs_swap);
268
efd2b924
ACM
269struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
270
daec78a0
ACM
271#define perf_evsel__match(evsel, t, c) \
272 (evsel->attr.type == PERF_TYPE_##t && \
273 evsel->attr.config == PERF_COUNT_##c)
274
863e451f
JO
275static inline bool perf_evsel__match2(struct perf_evsel *e1,
276 struct perf_evsel *e2)
277{
278 return (e1->attr.type == e2->attr.type) &&
279 (e1->attr.config == e2->attr.config);
280}
281
4cabc3d1
AK
282#define perf_evsel__cmp(a, b) \
283 ((a) && \
284 (b) && \
285 (a)->attr.type == (b)->attr.type && \
286 (a)->attr.config == (b)->attr.config)
287
f99f4719
JO
288int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
289 struct perf_counts_values *count);
290
c52b12ed
ACM
291int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
292 int cpu, int thread, bool scale);
293
294/**
295 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
296 *
297 * @evsel - event selector to read value
298 * @cpu - CPU of interest
299 * @thread - thread of interest
300 */
301static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
302 int cpu, int thread)
303{
304 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
305}
306
307/**
308 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
309 *
310 * @evsel - event selector to read value
311 * @cpu - CPU of interest
312 * @thread - thread of interest
313 */
314static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
315 int cpu, int thread)
316{
317 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
318}
319
a3f698fe 320int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
0807d2d8 321 struct perf_sample *sample);
0c21f736
ACM
322
323static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
324{
325 return list_entry(evsel->node.next, struct perf_evsel, node);
326}
07ac002f 327
d87fcb4a
ACM
328static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
329{
330 return list_entry(evsel->node.prev, struct perf_evsel, node);
331}
332
759ff497
NK
333/**
334 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
335 *
336 * @evsel - evsel selector to be tested
337 *
338 * Return %true if @evsel is a group leader or a stand-alone event
339 */
823254ed 340static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f 341{
823254ed 342 return evsel->leader == evsel;
07ac002f 343}
0698aedd 344
759ff497
NK
345/**
346 * perf_evsel__is_group_event - Return whether given evsel is a group event
347 *
348 * @evsel - evsel selector to be tested
349 *
350 * Return %true iff event group view is enabled and @evsel is a actual group
351 * leader which has other members in the group
352 */
353static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
354{
355 if (!symbol_conf.event_group)
356 return false;
357
358 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
359}
360
5496bc0c 361bool perf_evsel__is_function_event(struct perf_evsel *evsel);
6bedfab6 362
03e0a7df
WN
363static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
364{
365 struct perf_event_attr *attr = &evsel->attr;
366
367 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
368 (attr->type == PERF_TYPE_SOFTWARE);
369}
370
0698aedd
ACM
371struct perf_attr_details {
372 bool freq;
373 bool verbose;
e35ef355 374 bool event_group;
9e3b6ec1 375 bool force;
775d8a1b 376 bool trace_fields;
0698aedd
ACM
377};
378
379int perf_evsel__fprintf(struct perf_evsel *evsel,
380 struct perf_attr_details *details, FILE *fp);
c0a54341 381
e20ab86e
ACM
382#define EVSEL__PRINT_IP (1<<0)
383#define EVSEL__PRINT_SYM (1<<1)
384#define EVSEL__PRINT_DSO (1<<2)
385#define EVSEL__PRINT_SYMOFFSET (1<<3)
386#define EVSEL__PRINT_ONELINE (1<<4)
387#define EVSEL__PRINT_SRCLINE (1<<5)
388#define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
389
6f736735
ACM
390struct callchain_cursor;
391
d327e60c
ACM
392int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
393 unsigned int print_opts,
6f736735
ACM
394 struct callchain_cursor *cursor, FILE *fp);
395
396int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
397 int left_alignment, unsigned int print_opts,
398 struct callchain_cursor *cursor, FILE *fp);
e20ab86e 399
c0a54341
ACM
400bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
401 char *msg, size_t msgsize);
602ad878 402int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
56e52e85 403 int err, char *msg, size_t size);
97f63e4a
NK
404
405static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
406{
407 return evsel->idx - evsel->leader->idx;
408}
717e263f
NK
409
410#define for_each_group_member(_evsel, _leader) \
411for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
412 (_evsel) && (_evsel)->leader == (_leader); \
413 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
414
acf2abbd 415static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
384b6055
KL
416{
417 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
418}
2c5e8c52
PZ
419
420typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
421
422int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
423 attr__fprintf_f attr__fprintf, void *priv);
424
f4e47f9f
RB
425char *perf_evsel__env_arch(struct perf_evsel *evsel);
426
69aad6f1 427#endif /* __PERF_EVSEL_H */