1 /* SPDX-License-Identifier: GPL-2.0 */
3 #define __PERF_EVSEL_H 1
5 #include <linux/list.h>
8 #include <linux/perf_event.h>
9 #include <linux/types.h>
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.
21 struct perf_sample_id
{
22 struct hlist_node node
;
24 struct perf_evsel
*evsel
;
29 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
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.
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_MAX_EVENTS
,
50 PERF_EVSEL__CONFIG_TERM_OVERWRITE
,
51 PERF_EVSEL__CONFIG_TERM_DRV_CFG
,
52 PERF_EVSEL__CONFIG_TERM_BRANCH
,
55 struct perf_evsel_config_term
{
56 struct list_head list
;
69 unsigned long max_events
;
74 struct perf_stat_evsel
;
76 /** struct perf_evsel - event selector
78 * @evlist - evlist this evsel is in, if it is in one.
79 * @node - To insert it into evlist->entries or in other list_heads, say in
80 * the event parsing routines.
81 * @name - Can be set to retain the original event name passed by the user,
82 * so that when showing results in tools such as 'perf stat', we
83 * show the name used, not some alias.
84 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
85 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
87 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
88 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
89 * is used there is an id sample appended to non-sample events
90 * @priv: And what is in its containing unnamed union are tool specific
93 struct list_head node
;
94 struct perf_evlist
*evlist
;
95 struct perf_event_attr attr
;
98 struct xyarray
*sample_id
;
100 struct perf_counts
*counts
;
101 struct perf_counts
*prev_raw_counts
;
104 unsigned long max_events
;
105 unsigned long nr_events_printed
;
109 struct tep_event_format
*tp_format
;
111 struct perf_stat_evsel
*stats
;
116 struct cpu_map
*cpus
;
117 struct cpu_map
*own_cpus
;
118 struct thread_map
*threads
;
119 unsigned int sample_size
;
122 bool uniquified_name
;
133 bool ignore_missing_thread
;
135 bool use_uncore_alias
;
136 /* parse modifier helper */
140 unsigned long *per_pkg_mask
;
141 struct perf_evsel
*leader
;
143 bool cmdline_group_boundary
;
144 struct list_head config_terms
;
146 bool auto_merge_stats
;
148 const char * metric_expr
;
149 const char * metric_name
;
150 struct perf_evsel
**metric_events
;
153 const char *pmu_name
;
161 struct perf_missing_features
{
173 extern struct perf_missing_features perf_missing_features
;
180 static inline struct cpu_map
*perf_evsel__cpus(struct perf_evsel
*evsel
)
185 static inline int perf_evsel__nr_cpus(struct perf_evsel
*evsel
)
187 return perf_evsel__cpus(evsel
)->nr
;
190 void perf_counts_values__scale(struct perf_counts_values
*count
,
191 bool scale
, s8
*pscaled
);
193 void perf_evsel__compute_deltas(struct perf_evsel
*evsel
, int cpu
, int thread
,
194 struct perf_counts_values
*count
);
196 int perf_evsel__object_config(size_t object_size
,
197 int (*init
)(struct perf_evsel
*evsel
),
198 void (*fini
)(struct perf_evsel
*evsel
));
200 struct perf_evsel
*perf_evsel__new_idx(struct perf_event_attr
*attr
, int idx
);
202 static inline struct perf_evsel
*perf_evsel__new(struct perf_event_attr
*attr
)
204 return perf_evsel__new_idx(attr
, 0);
207 struct perf_evsel
*perf_evsel__newtp_idx(const char *sys
, const char *name
, int idx
);
210 * Returns pointer with encoded error via <linux/err.h> interface.
212 static inline struct perf_evsel
*perf_evsel__newtp(const char *sys
, const char *name
)
214 return perf_evsel__newtp_idx(sys
, name
, 0);
217 struct perf_evsel
*perf_evsel__new_cycles(bool precise
);
219 struct tep_event_format
*event_format__new(const char *sys
, const char *name
);
221 void perf_evsel__init(struct perf_evsel
*evsel
,
222 struct perf_event_attr
*attr
, int idx
);
223 void perf_evsel__exit(struct perf_evsel
*evsel
);
224 void perf_evsel__delete(struct perf_evsel
*evsel
);
226 struct callchain_param
;
228 void perf_evsel__config(struct perf_evsel
*evsel
,
229 struct record_opts
*opts
,
230 struct callchain_param
*callchain
);
231 void perf_evsel__config_callchain(struct perf_evsel
*evsel
,
232 struct record_opts
*opts
,
233 struct callchain_param
*callchain
);
235 int __perf_evsel__sample_size(u64 sample_type
);
236 void perf_evsel__calc_id_pos(struct perf_evsel
*evsel
);
238 bool perf_evsel__is_cache_op_valid(u8 type
, u8 op
);
240 #define PERF_EVSEL__MAX_ALIASES 8
242 extern const char *perf_evsel__hw_cache
[PERF_COUNT_HW_CACHE_MAX
]
243 [PERF_EVSEL__MAX_ALIASES
];
244 extern const char *perf_evsel__hw_cache_op
[PERF_COUNT_HW_CACHE_OP_MAX
]
245 [PERF_EVSEL__MAX_ALIASES
];
246 extern const char *perf_evsel__hw_cache_result
[PERF_COUNT_HW_CACHE_RESULT_MAX
]
247 [PERF_EVSEL__MAX_ALIASES
];
248 extern const char *perf_evsel__hw_names
[PERF_COUNT_HW_MAX
];
249 extern const char *perf_evsel__sw_names
[PERF_COUNT_SW_MAX
];
250 int __perf_evsel__hw_cache_type_op_res_name(u8 type
, u8 op
, u8 result
,
251 char *bf
, size_t size
);
252 const char *perf_evsel__name(struct perf_evsel
*evsel
);
254 const char *perf_evsel__group_name(struct perf_evsel
*evsel
);
255 int perf_evsel__group_desc(struct perf_evsel
*evsel
, char *buf
, size_t size
);
257 int perf_evsel__alloc_id(struct perf_evsel
*evsel
, int ncpus
, int nthreads
);
258 void perf_evsel__close_fd(struct perf_evsel
*evsel
);
260 void __perf_evsel__set_sample_bit(struct perf_evsel
*evsel
,
261 enum perf_event_sample_format bit
);
262 void __perf_evsel__reset_sample_bit(struct perf_evsel
*evsel
,
263 enum perf_event_sample_format bit
);
265 #define perf_evsel__set_sample_bit(evsel, bit) \
266 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
268 #define perf_evsel__reset_sample_bit(evsel, bit) \
269 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
271 void perf_evsel__set_sample_id(struct perf_evsel
*evsel
,
272 bool use_sample_identifier
);
274 int perf_evsel__set_filter(struct perf_evsel
*evsel
, const char *filter
);
275 int perf_evsel__append_tp_filter(struct perf_evsel
*evsel
, const char *filter
);
276 int perf_evsel__append_addr_filter(struct perf_evsel
*evsel
,
278 int perf_evsel__apply_filter(struct perf_evsel
*evsel
, const char *filter
);
279 int perf_evsel__enable(struct perf_evsel
*evsel
);
280 int perf_evsel__disable(struct perf_evsel
*evsel
);
282 int perf_evsel__open_per_cpu(struct perf_evsel
*evsel
,
283 struct cpu_map
*cpus
);
284 int perf_evsel__open_per_thread(struct perf_evsel
*evsel
,
285 struct thread_map
*threads
);
286 int perf_evsel__open(struct perf_evsel
*evsel
, struct cpu_map
*cpus
,
287 struct thread_map
*threads
);
288 void perf_evsel__close(struct perf_evsel
*evsel
);
292 void *perf_evsel__rawptr(struct perf_evsel
*evsel
, struct perf_sample
*sample
,
294 u64
perf_evsel__intval(struct perf_evsel
*evsel
, struct perf_sample
*sample
,
297 static inline char *perf_evsel__strval(struct perf_evsel
*evsel
,
298 struct perf_sample
*sample
,
301 return perf_evsel__rawptr(evsel
, sample
, name
);
304 struct tep_format_field
;
306 u64
format_field__intval(struct tep_format_field
*field
, struct perf_sample
*sample
, bool needs_swap
);
308 struct tep_format_field
*perf_evsel__field(struct perf_evsel
*evsel
, const char *name
);
310 #define perf_evsel__match(evsel, t, c) \
311 (evsel->attr.type == PERF_TYPE_##t && \
312 evsel->attr.config == PERF_COUNT_##c)
314 static inline bool perf_evsel__match2(struct perf_evsel
*e1
,
315 struct perf_evsel
*e2
)
317 return (e1
->attr
.type
== e2
->attr
.type
) &&
318 (e1
->attr
.config
== e2
->attr
.config
);
321 #define perf_evsel__cmp(a, b) \
324 (a)->attr.type == (b)->attr.type && \
325 (a)->attr.config == (b)->attr.config)
327 int perf_evsel__read(struct perf_evsel
*evsel
, int cpu
, int thread
,
328 struct perf_counts_values
*count
);
330 int perf_evsel__read_counter(struct perf_evsel
*evsel
, int cpu
, int thread
);
332 int __perf_evsel__read_on_cpu(struct perf_evsel
*evsel
,
333 int cpu
, int thread
, bool scale
);
336 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
338 * @evsel - event selector to read value
339 * @cpu - CPU of interest
340 * @thread - thread of interest
342 static inline int perf_evsel__read_on_cpu(struct perf_evsel
*evsel
,
345 return __perf_evsel__read_on_cpu(evsel
, cpu
, thread
, false);
349 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
351 * @evsel - event selector to read value
352 * @cpu - CPU of interest
353 * @thread - thread of interest
355 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel
*evsel
,
358 return __perf_evsel__read_on_cpu(evsel
, cpu
, thread
, true);
361 int perf_evsel__parse_sample(struct perf_evsel
*evsel
, union perf_event
*event
,
362 struct perf_sample
*sample
);
364 int perf_evsel__parse_sample_timestamp(struct perf_evsel
*evsel
,
365 union perf_event
*event
,
368 static inline struct perf_evsel
*perf_evsel__next(struct perf_evsel
*evsel
)
370 return list_entry(evsel
->node
.next
, struct perf_evsel
, node
);
373 static inline struct perf_evsel
*perf_evsel__prev(struct perf_evsel
*evsel
)
375 return list_entry(evsel
->node
.prev
, struct perf_evsel
, node
);
379 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
381 * @evsel - evsel selector to be tested
383 * Return %true if @evsel is a group leader or a stand-alone event
385 static inline bool perf_evsel__is_group_leader(const struct perf_evsel
*evsel
)
387 return evsel
->leader
== evsel
;
391 * perf_evsel__is_group_event - Return whether given evsel is a group event
393 * @evsel - evsel selector to be tested
395 * Return %true iff event group view is enabled and @evsel is a actual group
396 * leader which has other members in the group
398 static inline bool perf_evsel__is_group_event(struct perf_evsel
*evsel
)
400 if (!symbol_conf
.event_group
)
403 return perf_evsel__is_group_leader(evsel
) && evsel
->nr_members
> 1;
406 bool perf_evsel__is_function_event(struct perf_evsel
*evsel
);
408 static inline bool perf_evsel__is_bpf_output(struct perf_evsel
*evsel
)
410 return perf_evsel__match(evsel
, SOFTWARE
, SW_BPF_OUTPUT
);
413 static inline bool perf_evsel__is_clock(struct perf_evsel
*evsel
)
415 return perf_evsel__match(evsel
, SOFTWARE
, SW_CPU_CLOCK
) ||
416 perf_evsel__match(evsel
, SOFTWARE
, SW_TASK_CLOCK
);
419 struct perf_attr_details
{
427 int perf_evsel__fprintf(struct perf_evsel
*evsel
,
428 struct perf_attr_details
*details
, FILE *fp
);
430 #define EVSEL__PRINT_IP (1<<0)
431 #define EVSEL__PRINT_SYM (1<<1)
432 #define EVSEL__PRINT_DSO (1<<2)
433 #define EVSEL__PRINT_SYMOFFSET (1<<3)
434 #define EVSEL__PRINT_ONELINE (1<<4)
435 #define EVSEL__PRINT_SRCLINE (1<<5)
436 #define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
437 #define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7)
438 #define EVSEL__PRINT_SKIP_IGNORED (1<<8)
440 struct callchain_cursor
;
442 int sample__fprintf_callchain(struct perf_sample
*sample
, int left_alignment
,
443 unsigned int print_opts
,
444 struct callchain_cursor
*cursor
, FILE *fp
);
446 int sample__fprintf_sym(struct perf_sample
*sample
, struct addr_location
*al
,
447 int left_alignment
, unsigned int print_opts
,
448 struct callchain_cursor
*cursor
, FILE *fp
);
450 bool perf_evsel__fallback(struct perf_evsel
*evsel
, int err
,
451 char *msg
, size_t msgsize
);
452 int perf_evsel__open_strerror(struct perf_evsel
*evsel
, struct target
*target
,
453 int err
, char *msg
, size_t size
);
455 static inline int perf_evsel__group_idx(struct perf_evsel
*evsel
)
457 return evsel
->idx
- evsel
->leader
->idx
;
460 /* Iterates group WITHOUT the leader. */
461 #define for_each_group_member(_evsel, _leader) \
462 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
463 (_evsel) && (_evsel)->leader == (_leader); \
464 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
466 /* Iterates group WITH the leader. */
467 #define for_each_group_evsel(_evsel, _leader) \
468 for ((_evsel) = _leader; \
469 (_evsel) && (_evsel)->leader == (_leader); \
470 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
472 static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel
*evsel
)
474 return evsel
->attr
.branch_sample_type
& PERF_SAMPLE_BRANCH_CALL_STACK
;
477 static inline bool evsel__has_callchain(const struct perf_evsel
*evsel
)
479 return (evsel
->attr
.sample_type
& PERF_SAMPLE_CALLCHAIN
) != 0;
482 typedef int (*attr__fprintf_f
)(FILE *, const char *, const char *, void *);
484 int perf_event_attr__fprintf(FILE *fp
, struct perf_event_attr
*attr
,
485 attr__fprintf_f attr__fprintf
, void *priv
);
487 struct perf_env
*perf_evsel__env(struct perf_evsel
*evsel
);
489 int perf_evsel__store_ids(struct perf_evsel
*evsel
, struct perf_evlist
*evlist
);
490 #endif /* __PERF_EVSEL_H */