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