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 <sys/types.h> 8 #include <linux/perf_event.h> 9 #include <linux/types.h> 10 #include <internal/evsel.h> 11 #include <perf/evsel.h> 12 #include "symbol_conf.h" 13 #include "pmus.h" 14 #include "pmu.h" 15 16 struct bpf_object; 17 struct cgroup; 18 struct perf_counts; 19 struct perf_stat_config; 20 struct perf_stat_evsel; 21 union perf_event; 22 struct bpf_counter_ops; 23 struct target; 24 struct hashmap; 25 struct bperf_leader_bpf; 26 struct bperf_follower_bpf; 27 28 typedef int (evsel__sb_cb_t)(union perf_event *event, void *data); 29 30 /** struct evsel - event selector 31 * 32 * @evlist - evlist this evsel is in, if it is in one. 33 * @core - libperf evsel object 34 * @name - Can be set to retain the original event name passed by the user, 35 * so that when showing results in tools such as 'perf stat', we 36 * show the name used, not some alias. 37 * @id_pos: the position of the event id (PERF_SAMPLE_ID or 38 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of 39 * struct perf_record_sample 40 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or 41 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all 42 * is used there is an id sample appended to non-sample events 43 * @priv: And what is in its containing unnamed union are tool specific 44 */ 45 struct evsel { 46 struct perf_evsel core; 47 struct evlist *evlist; 48 off_t id_offset; 49 int id_pos; 50 int is_pos; 51 unsigned int sample_size; 52 53 /* 54 * These fields can be set in the parse-events code or similar. 55 * Please check evsel__clone() to copy them properly so that 56 * they can be released properly. 57 */ 58 struct { 59 char *name; 60 char *group_name; 61 const char *group_pmu_name; 62 #ifdef HAVE_LIBTRACEEVENT 63 char *tp_sys; 64 char *tp_name; 65 struct tep_event *tp_format; 66 #endif 67 char *filter; 68 unsigned long max_events; 69 double scale; 70 const char *unit; 71 struct cgroup *cgrp; 72 const char *metric_id; 73 /* 74 * This point to the first evsel with the same name, intended to store the 75 * aggregated counts in aggregation mode. 76 */ 77 struct evsel *first_wildcard_match; 78 /* parse modifier helper */ 79 int exclude_GH; 80 int sample_read; 81 bool snapshot; 82 bool per_pkg; 83 bool percore; 84 bool precise_max; 85 bool is_libpfm_event; 86 bool collect_stat; 87 bool weak_group; 88 bool bpf_counter; 89 bool use_config_name; 90 bool skippable; 91 bool retire_lat; 92 bool dont_regroup; 93 int bpf_fd; 94 struct bpf_object *bpf_obj; 95 struct list_head config_terms; 96 u64 alternate_hw_config; 97 }; 98 99 /* 100 * metric fields are similar, but needs more care as they can have 101 * references to other metric (evsel). 102 */ 103 struct evsel *metric_leader; 104 105 void *handler; 106 struct perf_counts *counts; 107 struct perf_counts *prev_raw_counts; 108 unsigned long nr_events_printed; 109 struct perf_stat_evsel *stats; 110 void *priv; 111 u64 db_id; 112 bool uniquified_name; 113 bool supported; 114 bool needs_swap; 115 bool disabled; 116 bool no_aux_samples; 117 bool immediate; 118 bool tracking; 119 bool ignore_missing_thread; 120 bool forced_leader; 121 bool cmdline_group_boundary; 122 bool reset_group; 123 bool needs_auxtrace_mmap; 124 bool default_metricgroup; /* A member of the Default metricgroup */ 125 bool default_show_events; /* If a default group member, show the event */ 126 bool needs_uniquify; 127 bool fallenback_eacces; 128 bool fallenback_eopnotsupp; 129 u8 probe_type:3; 130 struct hashmap *per_pkg_mask; 131 int err; 132 int script_output_type; 133 struct { 134 evsel__sb_cb_t *cb; 135 void *data; 136 } side_band; 137 /* 138 * For reporting purposes, an evsel sample can have a callchain 139 * synthesized from AUX area data. Keep track of synthesized sample 140 * types here. Note, the recorded sample_type cannot be changed because 141 * it is needed to continue to parse events. 142 * See also evsel__has_callchain(). 143 */ 144 __u64 synth_sample_type; 145 146 /* 147 * Store the branch counter related information. 148 * br_cntr_idx: The idx of the branch counter event in the evlist 149 * br_cntr_nr: The number of the branch counter event in the group 150 * (Only available for the leader event) 151 * abbr_name: The abbreviation name assigned to an event which is 152 * logged by the branch counter. 153 * The abbr name is from A to Z9. NA is applied if out 154 * of the range. 155 */ 156 int br_cntr_idx; 157 int br_cntr_nr; 158 char abbr_name[3]; 159 160 /* 161 * bpf_counter_ops serves two use cases: 162 * 1. perf-stat -b counting events used byBPF programs 163 * 2. perf-stat --use-bpf use BPF programs to aggregate counts 164 */ 165 struct bpf_counter_ops *bpf_counter_ops; 166 167 struct list_head bpf_counter_list; /* for perf-stat -b */ 168 struct list_head bpf_filters; /* for perf-record --filter */ 169 170 /* for perf-stat --use-bpf */ 171 int bperf_leader_prog_fd; 172 int bperf_leader_link_fd; 173 union { 174 struct bperf_leader_bpf *leader_skel; 175 struct bperf_follower_bpf *follower_skel; 176 void *bpf_skel; 177 }; 178 unsigned long open_flags; 179 int precise_ip_original; 180 181 /* The PMU the event is from. Used for missing_features, PMU name, etc. */ 182 struct perf_pmu *pmu; 183 184 /* For tool events */ 185 /* Beginning time subtracted when the counter is read. */ 186 union { 187 /* Defaults for retirement latency events. */ 188 struct _retirement_latency { 189 double mean; 190 double min; 191 double max; 192 } retirement_latency; 193 /* duration_time is a single global time. */ 194 struct { 195 __u64 start_time; 196 __u64 accumulated_time; 197 } duration_time; 198 /* 199 * user_time and system_time read an initial value potentially 200 * per-CPU or per-pid. 201 */ 202 struct { 203 struct xyarray *start_times; 204 struct xyarray *accumulated_times; 205 } process_time; 206 }; 207 /* Is the tool's fd for /proc/pid/stat or /proc/stat. */ 208 bool pid_stat; 209 }; 210 211 struct perf_missing_features { 212 bool sample_id_all; 213 bool exclude_guest; 214 bool mmap2; 215 bool cloexec; 216 bool clockid; 217 bool clockid_wrong; 218 bool lbr_flags; 219 bool write_backward; 220 bool group_read; 221 bool ksymbol; 222 bool bpf; 223 bool aux_output; 224 bool branch_hw_idx; 225 bool cgroup; 226 bool data_page_size; 227 bool code_page_size; 228 bool weight_struct; 229 bool read_lost; 230 bool branch_counters; 231 bool aux_action; 232 bool inherit_sample_read; 233 bool defer_callchain; 234 }; 235 236 extern struct perf_missing_features perf_missing_features; 237 238 struct perf_cpu_map; 239 struct thread_map; 240 struct record_opts; 241 242 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel) 243 { 244 return perf_evsel__cpus(&evsel->core); 245 } 246 247 static inline int evsel__nr_cpus(struct evsel *evsel) 248 { 249 return perf_cpu_map__nr(evsel__cpus(evsel)); 250 } 251 252 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread, 253 struct perf_counts_values *count); 254 255 int evsel__object_config(size_t object_size, 256 int (*init)(struct evsel *evsel), 257 void (*fini)(struct evsel *evsel)); 258 259 struct perf_pmu *evsel__find_pmu(const struct evsel *evsel); 260 const char *evsel__pmu_name(const struct evsel *evsel); 261 bool evsel__is_aux_event(const struct evsel *evsel); 262 263 bool evsel__is_probe(struct evsel *evsel); 264 bool evsel__is_kprobe(struct evsel *evsel); 265 bool evsel__is_uprobe(struct evsel *evsel); 266 267 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx); 268 269 static inline struct evsel *evsel__new(struct perf_event_attr *attr) 270 { 271 return evsel__new_idx(attr, 0); 272 } 273 274 struct evsel *evsel__clone(struct evsel *dest, struct evsel *orig); 275 276 int copy_config_terms(struct list_head *dst, struct list_head *src); 277 void free_config_terms(struct list_head *config_terms); 278 279 280 /* 281 * Returns pointer with encoded error via <linux/err.h> interface. 282 */ 283 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx, bool format); 284 static inline struct evsel *evsel__newtp(const char *sys, const char *name) 285 { 286 return evsel__newtp_idx(sys, name, 0, true); 287 } 288 289 #ifdef HAVE_LIBTRACEEVENT 290 struct tep_event *evsel__tp_format(struct evsel *evsel); 291 #endif 292 293 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx); 294 void evsel__exit(struct evsel *evsel); 295 void evsel__delete(struct evsel *evsel); 296 297 void evsel__set_priv_destructor(void (*destructor)(void *priv)); 298 299 struct callchain_param; 300 301 void evsel__config(struct evsel *evsel, const struct record_opts *opts, 302 const struct callchain_param *callchain); 303 void evsel__config_callchain(struct evsel *evsel, const struct record_opts *opts, 304 const struct callchain_param *callchain); 305 306 int __evsel__sample_size(u64 sample_type); 307 void evsel__calc_id_pos(struct evsel *evsel); 308 309 bool evsel__is_cache_op_valid(u8 type, u8 op); 310 311 static inline bool evsel__is_bpf(struct evsel *evsel) 312 { 313 return evsel->bpf_counter_ops != NULL; 314 } 315 316 static inline bool evsel__is_bperf(struct evsel *evsel) 317 { 318 return evsel->bpf_counter_ops != NULL && list_empty(&evsel->bpf_counter_list); 319 } 320 321 #define EVSEL__MAX_ALIASES 8 322 323 extern const char *const evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES]; 324 extern const char *const evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES]; 325 extern const char *const evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES]; 326 extern const char *const evsel__hw_names[PERF_COUNT_HW_MAX]; 327 extern const char *const evsel__sw_names[PERF_COUNT_SW_MAX]; 328 extern char *evsel__bpf_counter_events; 329 bool evsel__match_bpf_counter_events(const char *name); 330 int arch_evsel__hw_name(struct evsel *evsel, char *bf, size_t size); 331 332 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size); 333 const char *evsel__name(struct evsel *evsel); 334 bool evsel__name_is(struct evsel *evsel, const char *name); 335 const char *evsel__metric_id(const struct evsel *evsel); 336 337 static inline bool evsel__is_retire_lat(const struct evsel *evsel) 338 { 339 return evsel->retire_lat; 340 } 341 342 const char *evsel__group_name(struct evsel *evsel); 343 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size); 344 345 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 346 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 347 348 #define evsel__set_sample_bit(evsel, bit) \ 349 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 350 351 #define evsel__reset_sample_bit(evsel, bit) \ 352 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 353 354 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier); 355 356 void arch_evsel__set_sample_weight(struct evsel *evsel); 357 void arch__post_evsel_config(struct evsel *evsel, struct perf_event_attr *attr); 358 int arch_evsel__open_strerror(struct evsel *evsel, int err, char *msg, size_t size); 359 void arch_evsel__apply_ratio_to_prev(struct evsel *evsel, struct perf_event_attr *attr); 360 361 int evsel__set_filter(struct evsel *evsel, const char *filter); 362 int evsel__append_tp_filter(struct evsel *evsel, const char *filter); 363 int evsel__append_addr_filter(struct evsel *evsel, const char *filter); 364 static inline bool evsel__is_non_perf_event_open_pmu(const struct evsel *evsel) 365 { 366 return evsel->pmu && evsel->pmu->type > PERF_PMU_TYPE_PE_END; 367 } 368 369 int evsel__enable_cpu(struct evsel *evsel, int cpu_map_idx); 370 int evsel__enable(struct evsel *evsel); 371 int evsel__disable(struct evsel *evsel); 372 int evsel__disable_cpu(struct evsel *evsel, int cpu_map_idx); 373 374 int evsel__open_per_cpu_and_thread(struct evsel *evsel, 375 struct perf_cpu_map *cpus, int cpu_map_idx, 376 struct perf_thread_map *threads); 377 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu_map_idx); 378 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads); 379 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus, 380 struct perf_thread_map *threads); 381 void evsel__close(struct evsel *evsel); 382 int evsel__prepare_open(struct evsel *evsel, struct perf_cpu_map *cpus, 383 struct perf_thread_map *threads); 384 385 bool evsel__precise_ip_fallback(struct evsel *evsel); 386 387 struct perf_sample; 388 389 #ifdef HAVE_LIBTRACEEVENT 390 void *perf_sample__rawptr(struct perf_sample *sample, const char *name); 391 u64 perf_sample__intval(struct perf_sample *sample, const char *name); 392 u64 perf_sample__intval_common(struct perf_sample *sample, const char *name); 393 char perf_sample__taskstate(struct perf_sample *sample, const char *name); 394 395 static inline char *perf_sample__strval(struct perf_sample *sample, const char *name) 396 { 397 return perf_sample__rawptr(sample, name); 398 } 399 #endif 400 401 struct tep_format_field; 402 403 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap); 404 405 #ifdef HAVE_LIBTRACEEVENT 406 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name); 407 struct tep_format_field *evsel__common_field(struct evsel *evsel, const char *name); 408 #else 409 static inline struct tep_format_field * 410 evsel__field(struct evsel *evsel __maybe_unused, const char *name __maybe_unused) 411 { 412 return NULL; 413 } 414 415 static inline struct tep_format_field * 416 evsel__common_field(struct evsel *evsel __maybe_unused, const char *name __maybe_unused) 417 { 418 return NULL; 419 } 420 #endif 421 422 bool __evsel__match(const struct evsel *evsel, u32 type, u64 config); 423 424 #define evsel__match(evsel, t, c) __evsel__match(evsel, PERF_TYPE_##t, PERF_COUNT_##c) 425 426 int evsel__read_counter(struct evsel *evsel, int cpu_map_idx, int thread); 427 428 int __evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread, bool scale); 429 430 /** 431 * evsel__read_on_cpu - Read out the results on a CPU and thread 432 * 433 * @evsel - event selector to read value 434 * @cpu_map_idx - CPU of interest 435 * @thread - thread of interest 436 */ 437 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread) 438 { 439 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, false); 440 } 441 442 /** 443 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 444 * 445 * @evsel - event selector to read value 446 * @cpu_map_idx - CPU of interest 447 * @thread - thread of interest 448 */ 449 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu_map_idx, int thread) 450 { 451 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, true); 452 } 453 454 int __evsel__parse_sample(struct evsel *evsel, union perf_event *event, 455 struct perf_sample *data, bool needs_swap); 456 457 static inline int evsel__parse_sample(struct evsel *evsel, union perf_event *event, 458 struct perf_sample *data) 459 { 460 return __evsel__parse_sample(evsel, event, data, evsel->needs_swap); 461 } 462 463 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event, 464 u64 *timestamp); 465 466 u16 evsel__id_hdr_size(const struct evsel *evsel); 467 468 static inline struct evsel *evsel__next(struct evsel *evsel) 469 { 470 return list_entry(evsel->core.node.next, struct evsel, core.node); 471 } 472 473 static inline struct evsel *evsel__prev(struct evsel *evsel) 474 { 475 return list_entry(evsel->core.node.prev, struct evsel, core.node); 476 } 477 478 /** 479 * evsel__is_group_leader - Return whether given evsel is a leader event 480 * 481 * @evsel - evsel selector to be tested 482 * 483 * Return %true if @evsel is a group leader or a stand-alone event 484 */ 485 static inline bool evsel__is_group_leader(const struct evsel *evsel) 486 { 487 return evsel->core.leader == &evsel->core; 488 } 489 490 /** 491 * evsel__is_group_event - Return whether given evsel is a group event 492 * 493 * @evsel - evsel selector to be tested 494 * 495 * Return %true iff event group view is enabled and @evsel is a actual group 496 * leader which has other members in the group 497 */ 498 static inline bool evsel__is_group_event(struct evsel *evsel) 499 { 500 if (!symbol_conf.event_group) 501 return false; 502 503 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1; 504 } 505 506 bool evsel__is_function_event(struct evsel *evsel); 507 508 static inline bool evsel__is_bpf_output(struct evsel *evsel) 509 { 510 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT); 511 } 512 513 static inline bool evsel__is_clock(const struct evsel *evsel) 514 { 515 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) || 516 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK); 517 } 518 519 bool evsel__fallback(struct evsel *evsel, struct target *target, int err, 520 char *msg, size_t msgsize); 521 int evsel__open_strerror(struct evsel *evsel, struct target *target, 522 int err, char *msg, size_t size); 523 524 static inline int evsel__group_idx(struct evsel *evsel) 525 { 526 return evsel->core.idx - evsel->core.leader->idx; 527 } 528 529 /* Iterates group WITHOUT the leader. */ 530 #define for_each_group_member_head(_evsel, _leader, _head) \ 531 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \ 532 (_evsel) && &(_evsel)->core.node != (_head) && \ 533 (_evsel)->core.leader == &(_leader)->core; \ 534 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 535 536 #define for_each_group_member(_evsel, _leader) \ 537 for_each_group_member_head(_evsel, _leader, &(_leader)->evlist->core.entries) 538 539 /* Iterates group WITH the leader. */ 540 #define for_each_group_evsel_head(_evsel, _leader, _head) \ 541 for ((_evsel) = _leader; \ 542 (_evsel) && &(_evsel)->core.node != (_head) && \ 543 (_evsel)->core.leader == &(_leader)->core; \ 544 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 545 546 #define for_each_group_evsel(_evsel, _leader) \ 547 for_each_group_evsel_head(_evsel, _leader, &(_leader)->evlist->core.entries) 548 549 static inline bool evsel__has_branch_callstack(const struct evsel *evsel) 550 { 551 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 552 } 553 554 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel) 555 { 556 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX; 557 } 558 559 static inline bool evsel__has_callchain(const struct evsel *evsel) 560 { 561 /* 562 * For reporting purposes, an evsel sample can have a recorded callchain 563 * or a callchain synthesized from AUX area data. 564 */ 565 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN || 566 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN; 567 } 568 569 static inline bool evsel__has_br_stack(const struct evsel *evsel) 570 { 571 /* 572 * For reporting purposes, an evsel sample can have a recorded branch 573 * stack or a branch stack synthesized from AUX area data. 574 */ 575 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK || 576 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK; 577 } 578 579 static inline bool evsel__is_dummy_event(struct evsel *evsel) 580 { 581 return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) && 582 (evsel->core.attr.config == PERF_COUNT_SW_DUMMY); 583 } 584 585 struct perf_session *evsel__session(struct evsel *evsel); 586 struct perf_env *evsel__env(struct evsel *evsel); 587 uint16_t evsel__e_machine(struct evsel *evsel, uint32_t *e_flags); 588 589 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist); 590 591 void evsel__zero_per_pkg(struct evsel *evsel); 592 bool evsel__is_hybrid(const struct evsel *evsel); 593 struct evsel *evsel__leader(const struct evsel *evsel); 594 bool evsel__has_leader(struct evsel *evsel, struct evsel *leader); 595 bool evsel__is_leader(struct evsel *evsel); 596 void evsel__set_leader(struct evsel *evsel, struct evsel *leader); 597 int evsel__source_count(const struct evsel *evsel); 598 void evsel__remove_from_group(struct evsel *evsel, struct evsel *leader); 599 600 bool arch_evsel__must_be_in_group(const struct evsel *evsel); 601 602 bool evsel__set_needs_uniquify(struct evsel *counter, const struct perf_stat_config *config); 603 void evsel__uniquify_counter(struct evsel *counter); 604 605 /* 606 * Macro to swap the bit-field postition and size. 607 * Used when, 608 * - dont need to swap the entire u64 && 609 * - when u64 has variable bit-field sizes && 610 * - when presented in a host endian which is different 611 * than the source endian of the perf.data file 612 */ 613 #define bitfield_swap(src, pos, size) \ 614 ((((src) >> (pos)) & ((1ull << (size)) - 1)) << (63 - ((pos) + (size) - 1))) 615 616 u64 evsel__bitfield_swap_branch_flags(u64 value); 617 bool evsel__config_exists(const struct evsel *evsel, const char *config_name); 618 int evsel__get_config_val(const struct evsel *evsel, const char *config_name, 619 u64 *val); 620 void evsel__set_config_if_unset(struct evsel *evsel, const char *config_name, 621 u64 val); 622 623 bool evsel__is_offcpu_event(struct evsel *evsel); 624 625 void evsel__warn_user_requested_cpus(struct evsel *evsel, struct perf_cpu_map *user_requested_cpus); 626 627 #endif /* __PERF_EVSEL_H */ 628