perf/util/evsel.h

10 #include <internal/evsel.h>
11 #include <perf/evsel.h>
44 /** struct evsel - event selector
46  * @evlist - evlist this evsel is in, if it is in one.
47  * @core - libperf evsel object
59 struct evsel {
108 	 * references to other metric (evsel).
110 	struct evsel		**metric_events;
111 	struct evsel		*metric_leader;
142 	 * For reporting purposes, an evsel sample can have a callchain
203 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
205 	return perf_evsel__cpus(&evsel->core);
208 static inline int evsel__nr_cpus(struct evsel *evsel)
210 	return perf_cpu_map__nr(evsel__cpus(evsel));
213 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
217 			 int (*init)(struct evsel *evsel),
218 			 void (*fini)(struct evsel *evsel));
220 struct perf_pmu *evsel__find_pmu(const struct evsel *evsel);
221 bool evsel__is_aux_event(const struct evsel *evsel);
223 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);
225 static inline struct evsel *evsel__new(struct perf_event_attr *attr)
230 struct evsel *evsel__clone(struct evsel *orig);
237 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx);
242 static inline struct evsel *evsel__newtp(const char *sys, const char *name)
252 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
253 void evsel__exit(struct evsel *evsel);
254 void evsel__delete(struct evsel *evsel);
258 void evsel__config(struct evsel *evsel, struct record_opts *opts,
260 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
264 void evsel__calc_id_pos(struct evsel *evsel);
268 static inline bool evsel__is_bpf(struct evsel *evsel)
270 	return evsel->bpf_counter_ops != NULL;
273 static inline bool evsel__is_bperf(struct evsel *evsel)
275 	return evsel->bpf_counter_ops != NULL && list_empty(&evsel->bpf_counter_list);
287 int arch_evsel__hw_name(struct evsel *evsel, char *bf, size_t size);
290 const char *evsel__name(struct evsel *evsel);
291 bool evsel__name_is(struct evsel *evsel, const char *name);
292 const char *evsel__metric_id(const struct evsel *evsel);
294 static inline bool evsel__is_tool(const struct evsel *evsel)
296 	return evsel->tool_event != PERF_TOOL_NONE;
299 const char *evsel__group_name(struct evsel *evsel);
300 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
302 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
303 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
305 #define evsel__set_sample_bit(evsel, bit) \
306 	__evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
308 #define evsel__reset_sample_bit(evsel, bit) \
309 	__evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
311 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);
313 void arch_evsel__set_sample_weight(struct evsel *evsel);
314 void arch__post_evsel_config(struct evsel *evsel, struct perf_event_attr *attr);
315 int arch_evsel__open_strerror(struct evsel *evsel, char *msg, size_t size);
317 int evsel__set_filter(struct evsel *evsel, const char *filter);
318 int evsel__append_tp_filter(struct evsel *evsel, const char *filter);
319 int evsel__append_addr_filter(struct evsel *evsel, const char *filter);
320 int evsel__enable_cpu(struct evsel *evsel, int cpu_map_idx);
321 int evsel__enable(struct evsel *evsel);
322 int evsel__disable(struct evsel *evsel);
323 int evsel__disable_cpu(struct evsel *evsel, int cpu_map_idx);
325 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu_map_idx);
326 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);
327 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
329 void evsel__close(struct evsel *evsel);
330 int evsel__prepare_open(struct evsel *evsel, struct perf_cpu_map *cpus,
332 bool evsel__detect_missing_features(struct evsel *evsel);
334 bool evsel__precise_ip_fallback(struct evsel *evsel);
339 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);
340 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);
341 u64 evsel__intval_common(struct evsel *evsel, struct perf_sample *sample, const char *name);
342 char evsel__taskstate(struct evsel *evsel, struct perf_sample *sample, const char *name);
344 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)
346 	return evsel__rawptr(evsel, sample, name);
354 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);
355 struct tep_format_field *evsel__common_field(struct evsel *evsel, const char *name);
357 static inline bool __evsel__match(const struct evsel *evsel, u32 type, u64 config)
359 	if (evsel->core.attr.type != type)
364 		return (evsel->core.attr.config & PERF_HW_EVENT_MASK) == config;
366 	return evsel->core.attr.config == config;
369 #define evsel__match(evsel, t, c) __evsel__match(evsel, PERF_TYPE_##t, PERF_COUNT_##c)
371 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2)
377 int evsel__read_counter(struct evsel *evsel, int cpu_map_idx, int thread);
379 int __evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread, bool scale);
384  * @evsel - event selector to read value
388 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread)
390 	return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, false);
396  * @evsel - event selector to read value
400 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu_map_idx, int thread)
402 	return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, true);
405 int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
408 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
411 u16 evsel__id_hdr_size(struct evsel *evsel);
413 static inline struct evsel *evsel__next(struct evsel *evsel)
415 	return list_entry(evsel->core.node.next, struct evsel, core.node);
418 static inline struct evsel *evsel__prev(struct evsel *evsel)
420 	return list_entry(evsel->core.node.prev, struct evsel, core.node);
424  * evsel__is_group_leader - Return whether given evsel is a leader event
426  * @evsel - evsel selector to be tested
428  * Return %true if @evsel is a group leader or a stand-alone event
430 static inline bool evsel__is_group_leader(const struct evsel *evsel)
432 	return evsel->core.leader == &evsel->core;
436  * evsel__is_group_event - Return whether given evsel is a group event
438  * @evsel - evsel selector to be tested
440  * Return %true iff event group view is enabled and @evsel is a actual group
443 static inline bool evsel__is_group_event(struct evsel *evsel)
448 	return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
451 bool evsel__is_function_event(struct evsel *evsel);
453 static inline bool evsel__is_bpf_output(struct evsel *evsel)
455 	return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
458 static inline bool evsel__is_clock(const struct evsel *evsel)
460 	return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
461 	       evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
464 bool evsel__fallback(struct evsel *evsel, struct target *target, int err,
466 int evsel__open_strerror(struct evsel *evsel, struct target *target,
469 static inline int evsel__group_idx(struct evsel *evsel)
471 	return evsel->core.idx - evsel->core.leader->idx;
476 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node);		\
479 	(_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
489 	(_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
494 static inline bool evsel__has_branch_callstack(const struct evsel *evsel)
496 	return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
499 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)
501 	return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;
504 static inline bool evsel__has_callchain(const struct evsel *evsel)
507 	 * For reporting purposes, an evsel sample can have a recorded callchain
510 	return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||
511 	       evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;
514 static inline bool evsel__has_br_stack(const struct evsel *evsel)
517 	 * For reporting purposes, an evsel sample can have a recorded branch
520 	return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||
521 	       evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;
524 static inline bool evsel__is_dummy_event(struct evsel *evsel)
526 	return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) &&
527 	       (evsel->core.attr.config == PERF_COUNT_SW_DUMMY);
530 struct perf_env *evsel__env(struct evsel *evsel);
532 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
534 void evsel__zero_per_pkg(struct evsel *evsel);
535 bool evsel__is_hybrid(const struct evsel *evsel);
536 struct evsel *evsel__leader(const struct evsel *evsel);
537 bool evsel__has_leader(struct evsel *evsel, struct evsel *leader);
538 bool evsel__is_leader(struct evsel *evsel);
539 void evsel__set_leader(struct evsel *evsel, struct evsel *leader);
540 int evsel__source_count(const struct evsel *evsel);
541 void evsel__remove_from_group(struct evsel *evsel, struct evsel *leader);
543 bool arch_evsel__must_be_in_group(const struct evsel *evsel);
557 void evsel__set_config_if_unset(struct perf_pmu *pmu, struct evsel *evsel,