?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux 4.16-rc1
[cris-mirror.git] / tools / perf / util / evsel.h
blob846e416445254f6090a1280305106a6c581b715a
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_EVSEL_H
3 #define __PERF_EVSEL_H 1
4
5 #include <linux/list.h>
6 #include <stdbool.h>
7 #include <stddef.h>
8 #include <linux/perf_event.h>
9 #include <linux/types.h>
10 #include "xyarray.h"
11 #include "symbol.h"
12 #include "cpumap.h"
13 #include "counts.h"
14
15 struct perf_evsel;
16
17 /*
18 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
19 * more than one entry in the evlist.
20 */
21 struct perf_sample_id {
22 struct hlist_node node;
23 u64 id;
24 struct perf_evsel *evsel;
25 int idx;
26 int cpu;
27 pid_t tid;
28
29 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
30 u64 period;
31 };
32
33 struct cgroup_sel;
34
35 /*
36 * The 'struct perf_evsel_config_term' is used to pass event
37 * specific configuration data to perf_evsel__config routine.
38 * It is allocated within event parsing and attached to
39 * perf_evsel::config_terms list head.
40 */
41 enum term_type {
42 PERF_EVSEL__CONFIG_TERM_PERIOD,
43 PERF_EVSEL__CONFIG_TERM_FREQ,
44 PERF_EVSEL__CONFIG_TERM_TIME,
45 PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
46 PERF_EVSEL__CONFIG_TERM_STACK_USER,
47 PERF_EVSEL__CONFIG_TERM_INHERIT,
48 PERF_EVSEL__CONFIG_TERM_MAX_STACK,
49 PERF_EVSEL__CONFIG_TERM_OVERWRITE,
50 PERF_EVSEL__CONFIG_TERM_DRV_CFG,
51 PERF_EVSEL__CONFIG_TERM_BRANCH,
52 };
53
54 struct perf_evsel_config_term {
55 struct list_head list;
56 enum term_type type;
57 union {
58 u64 period;
59 u64 freq;
60 bool time;
61 char *callgraph;
62 char *drv_cfg;
63 u64 stack_user;
64 int max_stack;
65 bool inherit;
66 bool overwrite;
67 char *branch;
68 } val;
69 bool weak;
70 };
71
72 struct perf_stat_evsel;
73
74 /** struct perf_evsel - event selector
75 *
76 * @evlist - evlist this evsel is in, if it is in one.
77 * @node - To insert it into evlist->entries or in other list_heads, say in
78 * the event parsing routines.
79 * @name - Can be set to retain the original event name passed by the user,
80 * so that when showing results in tools such as 'perf stat', we
81 * show the name used, not some alias.
82 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
83 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
84 * struct sample_event
85 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
86 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
87 * is used there is an id sample appended to non-sample events
88 * @priv: And what is in its containing unnamed union are tool specific
89 */
90 struct perf_evsel {
91 struct list_head node;
92 struct perf_evlist *evlist;
93 struct perf_event_attr attr;
94 char *filter;
95 struct xyarray *fd;
96 struct xyarray *sample_id;
97 u64 *id;
98 struct perf_counts *counts;
99 struct perf_counts *prev_raw_counts;
100 int idx;
101 u32 ids;
102 char *name;
103 double scale;
104 const char *unit;
105 struct event_format *tp_format;
106 off_t id_offset;
107 struct perf_stat_evsel *stats;
108 void *priv;
109 u64 db_id;
110 struct cgroup_sel *cgrp;
111 void *handler;
112 struct cpu_map *cpus;
113 struct cpu_map *own_cpus;
114 struct thread_map *threads;
115 unsigned int sample_size;
116 int id_pos;
117 int is_pos;
118 bool snapshot;
119 bool supported;
120 bool needs_swap;
121 bool no_aux_samples;
122 bool immediate;
123 bool system_wide;
124 bool tracking;
125 bool per_pkg;
126 bool precise_max;
127 bool ignore_missing_thread;
128 /* parse modifier helper */
129 int exclude_GH;
130 int nr_members;
131 int sample_read;
132 unsigned long *per_pkg_mask;
133 struct perf_evsel *leader;
134 char *group_name;
135 bool cmdline_group_boundary;
136 struct list_head config_terms;
137 int bpf_fd;
138 bool auto_merge_stats;
139 bool merged_stat;
140 const char * metric_expr;
141 const char * metric_name;
142 struct perf_evsel **metric_events;
143 bool collect_stat;
144 bool weak_group;
145 };
146
147 union u64_swap {
148 u64 val64;
149 u32 val32[2];
150 };
151
152 struct cpu_map;
153 struct target;
154 struct thread_map;
155 struct record_opts;
156
157 static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
158 {
159 return evsel->cpus;
160 }
161
162 static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
163 {
164 return perf_evsel__cpus(evsel)->nr;
165 }
166
167 void perf_counts_values__scale(struct perf_counts_values *count,
168 bool scale, s8 *pscaled);
169
170 void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
171 struct perf_counts_values *count);
172
173 int perf_evsel__object_config(size_t object_size,
174 int (*init)(struct perf_evsel *evsel),
175 void (*fini)(struct perf_evsel *evsel));
176
177 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
178
179 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
180 {
181 return perf_evsel__new_idx(attr, 0);
182 }
183
184 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
185
186 /*
187 * Returns pointer with encoded error via <linux/err.h> interface.
188 */
189 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
190 {
191 return perf_evsel__newtp_idx(sys, name, 0);
192 }
193
194 struct perf_evsel *perf_evsel__new_cycles(bool precise);
195
196 struct event_format *event_format__new(const char *sys, const char *name);
197
198 void perf_evsel__init(struct perf_evsel *evsel,
199 struct perf_event_attr *attr, int idx);
200 void perf_evsel__exit(struct perf_evsel *evsel);
201 void perf_evsel__delete(struct perf_evsel *evsel);
202
203 struct callchain_param;
204
205 void perf_evsel__config(struct perf_evsel *evsel,
206 struct record_opts *opts,
207 struct callchain_param *callchain);
208 void perf_evsel__config_callchain(struct perf_evsel *evsel,
209 struct record_opts *opts,
210 struct callchain_param *callchain);
211
212 int __perf_evsel__sample_size(u64 sample_type);
213 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
214
215 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
216
217 #define PERF_EVSEL__MAX_ALIASES 8
218
219 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
220 [PERF_EVSEL__MAX_ALIASES];
221 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
222 [PERF_EVSEL__MAX_ALIASES];
223 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
224 [PERF_EVSEL__MAX_ALIASES];
225 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
226 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
227 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
228 char *bf, size_t size);
229 const char *perf_evsel__name(struct perf_evsel *evsel);
230
231 const char *perf_evsel__group_name(struct perf_evsel *evsel);
232 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
233
234 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
235 void perf_evsel__close_fd(struct perf_evsel *evsel);
236
237 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
238 enum perf_event_sample_format bit);
239 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
240 enum perf_event_sample_format bit);
241
242 #define perf_evsel__set_sample_bit(evsel, bit) \
243 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
244
245 #define perf_evsel__reset_sample_bit(evsel, bit) \
246 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
247
248 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
249 bool use_sample_identifier);
250
251 int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
252 int perf_evsel__append_tp_filter(struct perf_evsel *evsel, const char *filter);
253 int perf_evsel__append_addr_filter(struct perf_evsel *evsel,
254 const char *filter);
255 int perf_evsel__apply_filter(struct perf_evsel *evsel, const char *filter);
256 int perf_evsel__enable(struct perf_evsel *evsel);
257 int perf_evsel__disable(struct perf_evsel *evsel);
258
259 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
260 struct cpu_map *cpus);
261 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
262 struct thread_map *threads);
263 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
264 struct thread_map *threads);
265 void perf_evsel__close(struct perf_evsel *evsel);
266
267 struct perf_sample;
268
269 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
270 const char *name);
271 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
272 const char *name);
273
274 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
275 struct perf_sample *sample,
276 const char *name)
277 {
278 return perf_evsel__rawptr(evsel, sample, name);
279 }
280
281 struct format_field;
282
283 u64 format_field__intval(struct format_field *field, struct perf_sample *sample, bool needs_swap);
284
285 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
286
287 #define perf_evsel__match(evsel, t, c) \
288 (evsel->attr.type == PERF_TYPE_##t && \
289 evsel->attr.config == PERF_COUNT_##c)
290
291 static inline bool perf_evsel__match2(struct perf_evsel *e1,
292 struct perf_evsel *e2)
293 {
294 return (e1->attr.type == e2->attr.type) &&
295 (e1->attr.config == e2->attr.config);
296 }
297
298 #define perf_evsel__cmp(a, b) \
299 ((a) && \
300 (b) && \
301 (a)->attr.type == (b)->attr.type && \
302 (a)->attr.config == (b)->attr.config)
303
304 int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
305 struct perf_counts_values *count);
306
307 int perf_evsel__read_counter(struct perf_evsel *evsel, int cpu, int thread);
308
309 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
310 int cpu, int thread, bool scale);
311
312 /**
313 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
314 *
315 * @evsel - event selector to read value
316 * @cpu - CPU of interest
317 * @thread - thread of interest
318 */
319 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
320 int cpu, int thread)
321 {
322 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
323 }
324
325 /**
326 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
327 *
328 * @evsel - event selector to read value
329 * @cpu - CPU of interest
330 * @thread - thread of interest
331 */
332 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
333 int cpu, int thread)
334 {
335 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
336 }
337
338 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
339 struct perf_sample *sample);
340
341 int perf_evsel__parse_sample_timestamp(struct perf_evsel *evsel,
342 union perf_event *event,
343 u64 *timestamp);
344
345 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
346 {
347 return list_entry(evsel->node.next, struct perf_evsel, node);
348 }
349
350 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
351 {
352 return list_entry(evsel->node.prev, struct perf_evsel, node);
353 }
354
355 /**
356 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
357 *
358 * @evsel - evsel selector to be tested
359 *
360 * Return %true if @evsel is a group leader or a stand-alone event
361 */
362 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
363 {
364 return evsel->leader == evsel;
365 }
366
367 /**
368 * perf_evsel__is_group_event - Return whether given evsel is a group event
369 *
370 * @evsel - evsel selector to be tested
371 *
372 * Return %true iff event group view is enabled and @evsel is a actual group
373 * leader which has other members in the group
374 */
375 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
376 {
377 if (!symbol_conf.event_group)
378 return false;
379
380 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
381 }
382
383 bool perf_evsel__is_function_event(struct perf_evsel *evsel);
384
385 static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
386 {
387 struct perf_event_attr *attr = &evsel->attr;
388
389 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
390 (attr->type == PERF_TYPE_SOFTWARE);
391 }
392
393 struct perf_attr_details {
394 bool freq;
395 bool verbose;
396 bool event_group;
397 bool force;
398 bool trace_fields;
399 };
400
401 int perf_evsel__fprintf(struct perf_evsel *evsel,
402 struct perf_attr_details *details, FILE *fp);
403
404 #define EVSEL__PRINT_IP (1<<0)
405 #define EVSEL__PRINT_SYM (1<<1)
406 #define EVSEL__PRINT_DSO (1<<2)
407 #define EVSEL__PRINT_SYMOFFSET (1<<3)
408 #define EVSEL__PRINT_ONELINE (1<<4)
409 #define EVSEL__PRINT_SRCLINE (1<<5)
410 #define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
411 #define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7)
412 #define EVSEL__PRINT_SKIP_IGNORED (1<<8)
413
414 struct callchain_cursor;
415
416 int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
417 unsigned int print_opts,
418 struct callchain_cursor *cursor, FILE *fp);
419
420 int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
421 int left_alignment, unsigned int print_opts,
422 struct callchain_cursor *cursor, FILE *fp);
423
424 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
425 char *msg, size_t msgsize);
426 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
427 int err, char *msg, size_t size);
428
429 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
430 {
431 return evsel->idx - evsel->leader->idx;
432 }
433
434 #define for_each_group_member(_evsel, _leader) \
435 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
436 (_evsel) && (_evsel)->leader == (_leader); \
437 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
438
439 static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
440 {
441 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
442 }
443
444 typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
445
446 int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
447 attr__fprintf_f attr__fprintf, void *priv);
448
449 struct perf_env *perf_evsel__env(struct perf_evsel *evsel);
450
451 #endif /* __PERF_EVSEL_H */
CRIS linux kernel tree