2 #define __PERF_EVSEL_H 1
4 #include <linux/list.h>
7 #include <linux/perf_event.h>
8 #include <linux/types.h>
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.
20 struct perf_sample_id {
21 struct hlist_node node;
23 struct perf_evsel *evsel;
28 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
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.
41 PERF_EVSEL__CONFIG_TERM_PERIOD,
42 PERF_EVSEL__CONFIG_TERM_FREQ,
43 PERF_EVSEL__CONFIG_TERM_TIME,
44 PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
45 PERF_EVSEL__CONFIG_TERM_STACK_USER,
46 PERF_EVSEL__CONFIG_TERM_INHERIT,
47 PERF_EVSEL__CONFIG_TERM_MAX_STACK,
48 PERF_EVSEL__CONFIG_TERM_OVERWRITE,
49 PERF_EVSEL__CONFIG_TERM_DRV_CFG,
50 PERF_EVSEL__CONFIG_TERM_BRANCH,
51 PERF_EVSEL__CONFIG_TERM_MAX,
54 struct perf_evsel_config_term {
55 struct list_head list;
71 /** struct perf_evsel - event selector
73 * @evlist - evlist this evsel is in, if it is in one.
74 * @node - To insert it into evlist->entries or in other list_heads, say in
75 * the event parsing routines.
76 * @name - Can be set to retain the original event name passed by the user,
77 * so that when showing results in tools such as 'perf stat', we
78 * show the name used, not some alias.
79 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
80 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
82 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
83 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
84 * is used there is an id sample appended to non-sample events
85 * @priv: And what is in its containing unnamed union are tool specific
88 struct list_head node;
89 struct perf_evlist *evlist;
90 struct perf_event_attr attr;
93 struct xyarray *sample_id;
95 struct perf_counts *counts;
96 struct perf_counts *prev_raw_counts;
102 struct event_format *tp_format;
106 struct cgroup_sel *cgrp;
108 struct cpu_map *cpus;
109 struct cpu_map *own_cpus;
110 struct thread_map *threads;
111 unsigned int sample_size;
123 bool ignore_missing_thread;
124 /* parse modifier helper */
128 unsigned long *per_pkg_mask;
129 struct perf_evsel *leader;
131 bool cmdline_group_boundary;
132 struct list_head config_terms;
134 bool auto_merge_stats;
136 const char * metric_expr;
137 const char * metric_name;
138 struct perf_evsel **metric_events;
152 static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
157 static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
159 return perf_evsel__cpus(evsel)->nr;
162 void perf_counts_values__scale(struct perf_counts_values *count,
163 bool scale, s8 *pscaled);
165 void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
166 struct perf_counts_values *count);
168 int perf_evsel__object_config(size_t object_size,
169 int (*init)(struct perf_evsel *evsel),
170 void (*fini)(struct perf_evsel *evsel));
172 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
174 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
176 return perf_evsel__new_idx(attr, 0);
179 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
182 * Returns pointer with encoded error via <linux/err.h> interface.
184 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
186 return perf_evsel__newtp_idx(sys, name, 0);
189 struct perf_evsel *perf_evsel__new_cycles(bool precise);
191 struct event_format *event_format__new(const char *sys, const char *name);
193 void perf_evsel__init(struct perf_evsel *evsel,
194 struct perf_event_attr *attr, int idx);
195 void perf_evsel__exit(struct perf_evsel *evsel);
196 void perf_evsel__delete(struct perf_evsel *evsel);
198 struct callchain_param;
200 void perf_evsel__config(struct perf_evsel *evsel,
201 struct record_opts *opts,
202 struct callchain_param *callchain);
203 void perf_evsel__config_callchain(struct perf_evsel *evsel,
204 struct record_opts *opts,
205 struct callchain_param *callchain);
207 int __perf_evsel__sample_size(u64 sample_type);
208 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
210 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
212 #define PERF_EVSEL__MAX_ALIASES 8
214 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
215 [PERF_EVSEL__MAX_ALIASES];
216 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
217 [PERF_EVSEL__MAX_ALIASES];
218 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
219 [PERF_EVSEL__MAX_ALIASES];
220 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
221 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
222 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
223 char *bf, size_t size);
224 const char *perf_evsel__name(struct perf_evsel *evsel);
226 const char *perf_evsel__group_name(struct perf_evsel *evsel);
227 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
229 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
230 void perf_evsel__close_fd(struct perf_evsel *evsel);
232 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
233 enum perf_event_sample_format bit);
234 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
235 enum perf_event_sample_format bit);
237 #define perf_evsel__set_sample_bit(evsel, bit) \
238 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
240 #define perf_evsel__reset_sample_bit(evsel, bit) \
241 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
243 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
244 bool use_sample_identifier);
246 int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
247 int perf_evsel__append_tp_filter(struct perf_evsel *evsel, const char *filter);
248 int perf_evsel__append_addr_filter(struct perf_evsel *evsel,
250 int perf_evsel__apply_filter(struct perf_evsel *evsel, const char *filter);
251 int perf_evsel__enable(struct perf_evsel *evsel);
252 int perf_evsel__disable(struct perf_evsel *evsel);
254 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
255 struct cpu_map *cpus);
256 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
257 struct thread_map *threads);
258 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
259 struct thread_map *threads);
260 void perf_evsel__close(struct perf_evsel *evsel);
264 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
266 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
269 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
270 struct perf_sample *sample,
273 return perf_evsel__rawptr(evsel, sample, name);
278 u64 format_field__intval(struct format_field *field, struct perf_sample *sample, bool needs_swap);
280 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
282 #define perf_evsel__match(evsel, t, c) \
283 (evsel->attr.type == PERF_TYPE_##t && \
284 evsel->attr.config == PERF_COUNT_##c)
286 static inline bool perf_evsel__match2(struct perf_evsel *e1,
287 struct perf_evsel *e2)
289 return (e1->attr.type == e2->attr.type) &&
290 (e1->attr.config == e2->attr.config);
293 #define perf_evsel__cmp(a, b) \
296 (a)->attr.type == (b)->attr.type && \
297 (a)->attr.config == (b)->attr.config)
299 int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
300 struct perf_counts_values *count);
302 int perf_evsel__read_counter(struct perf_evsel *evsel, int cpu, int thread);
304 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
305 int cpu, int thread, bool scale);
308 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
310 * @evsel - event selector to read value
311 * @cpu - CPU of interest
312 * @thread - thread of interest
314 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
317 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
321 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
323 * @evsel - event selector to read value
324 * @cpu - CPU of interest
325 * @thread - thread of interest
327 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
330 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
333 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
334 struct perf_sample *sample);
336 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
338 return list_entry(evsel->node.next, struct perf_evsel, node);
341 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
343 return list_entry(evsel->node.prev, struct perf_evsel, node);
347 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
349 * @evsel - evsel selector to be tested
351 * Return %true if @evsel is a group leader or a stand-alone event
353 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
355 return evsel->leader == evsel;
359 * perf_evsel__is_group_event - Return whether given evsel is a group event
361 * @evsel - evsel selector to be tested
363 * Return %true iff event group view is enabled and @evsel is a actual group
364 * leader which has other members in the group
366 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
368 if (!symbol_conf.event_group)
371 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
374 bool perf_evsel__is_function_event(struct perf_evsel *evsel);
376 static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
378 struct perf_event_attr *attr = &evsel->attr;
380 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
381 (attr->type == PERF_TYPE_SOFTWARE);
384 struct perf_attr_details {
392 int perf_evsel__fprintf(struct perf_evsel *evsel,
393 struct perf_attr_details *details, FILE *fp);
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 #define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7)
403 #define EVSEL__PRINT_SKIP_IGNORED (1<<8)
405 struct callchain_cursor;
407 int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
408 unsigned int print_opts,
409 struct callchain_cursor *cursor, FILE *fp);
411 int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
412 int left_alignment, unsigned int print_opts,
413 struct callchain_cursor *cursor, FILE *fp);
415 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
416 char *msg, size_t msgsize);
417 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
418 int err, char *msg, size_t size);
420 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
422 return evsel->idx - evsel->leader->idx;
425 #define for_each_group_member(_evsel, _leader) \
426 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
427 (_evsel) && (_evsel)->leader == (_leader); \
428 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
430 static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
432 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
435 typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
437 int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
438 attr__fprintf_f attr__fprintf, void *priv);
440 char *perf_evsel__env_arch(struct perf_evsel *evsel);
441 char *perf_evsel__env_cpuid(struct perf_evsel *evsel);
443 #endif /* __PERF_EVSEL_H */