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 struct hashmap *per_pkg_mask; 130 int err; 131 int script_output_type; 132 struct { 133 evsel__sb_cb_t *cb; 134 void *data; 135 } side_band; 136 /* 137 * For reporting purposes, an evsel sample can have a callchain 138 * synthesized from AUX area data. Keep track of synthesized sample 139 * types here. Note, the recorded sample_type cannot be changed because 140 * it is needed to continue to parse events. 141 * See also evsel__has_callchain(). 142 */ 143 __u64 synth_sample_type; 144 145 /* 146 * Store the branch counter related information. 147 * br_cntr_idx: The idx of the branch counter event in the evlist 148 * br_cntr_nr: The number of the branch counter event in the group 149 * (Only available for the leader event) 150 * abbr_name: The abbreviation name assigned to an event which is 151 * logged by the branch counter. 152 * The abbr name is from A to Z9. NA is applied if out 153 * of the range. 154 */ 155 int br_cntr_idx; 156 int br_cntr_nr; 157 char abbr_name[3]; 158 159 /* 160 * bpf_counter_ops serves two use cases: 161 * 1. perf-stat -b counting events used byBPF programs 162 * 2. perf-stat --use-bpf use BPF programs to aggregate counts 163 */ 164 struct bpf_counter_ops *bpf_counter_ops; 165 166 struct list_head bpf_counter_list; /* for perf-stat -b */ 167 struct list_head bpf_filters; /* for perf-record --filter */ 168 169 /* for perf-stat --use-bpf */ 170 int bperf_leader_prog_fd; 171 int bperf_leader_link_fd; 172 union { 173 struct bperf_leader_bpf *leader_skel; 174 struct bperf_follower_bpf *follower_skel; 175 void *bpf_skel; 176 }; 177 unsigned long open_flags; 178 int precise_ip_original; 179 180 /* The PMU the event is from. Used for missing_features, PMU name, etc. */ 181 struct perf_pmu *pmu; 182 183 /* For tool events */ 184 /* Beginning time subtracted when the counter is read. */ 185 union { 186 /* Defaults for retirement latency events. */ 187 struct _retirement_latency { 188 double mean; 189 double min; 190 double max; 191 } retirement_latency; 192 /* duration_time is a single global time. */ 193 struct { 194 __u64 start_time; 195 __u64 accumulated_time; 196 } duration_time; 197 /* 198 * user_time and system_time read an initial value potentially 199 * per-CPU or per-pid. 200 */ 201 struct { 202 struct xyarray *start_times; 203 struct xyarray *accumulated_times; 204 } process_time; 205 }; 206 /* Is the tool's fd for /proc/pid/stat or /proc/stat. */ 207 bool pid_stat; 208 }; 209 210 struct perf_missing_features { 211 bool sample_id_all; 212 bool exclude_guest; 213 bool mmap2; 214 bool cloexec; 215 bool clockid; 216 bool clockid_wrong; 217 bool lbr_flags; 218 bool write_backward; 219 bool group_read; 220 bool ksymbol; 221 bool bpf; 222 bool aux_output; 223 bool branch_hw_idx; 224 bool cgroup; 225 bool data_page_size; 226 bool code_page_size; 227 bool weight_struct; 228 bool read_lost; 229 bool branch_counters; 230 bool aux_action; 231 bool inherit_sample_read; 232 bool defer_callchain; 233 }; 234 235 extern struct perf_missing_features perf_missing_features; 236 237 struct perf_cpu_map; 238 struct thread_map; 239 struct record_opts; 240 241 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel) 242 { 243 return perf_evsel__cpus(&evsel->core); 244 } 245 246 static inline int evsel__nr_cpus(struct evsel *evsel) 247 { 248 return perf_cpu_map__nr(evsel__cpus(evsel)); 249 } 250 251 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread, 252 struct perf_counts_values *count); 253 254 int evsel__object_config(size_t object_size, 255 int (*init)(struct evsel *evsel), 256 void (*fini)(struct evsel *evsel)); 257 258 struct perf_pmu *evsel__find_pmu(const struct evsel *evsel); 259 const char *evsel__pmu_name(const struct evsel *evsel); 260 bool evsel__is_aux_event(const struct evsel *evsel); 261 262 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx); 263 264 static inline struct evsel *evsel__new(struct perf_event_attr *attr) 265 { 266 return evsel__new_idx(attr, 0); 267 } 268 269 struct evsel *evsel__clone(struct evsel *dest, struct evsel *orig); 270 271 int copy_config_terms(struct list_head *dst, struct list_head *src); 272 void free_config_terms(struct list_head *config_terms); 273 274 275 /* 276 * Returns pointer with encoded error via <linux/err.h> interface. 277 */ 278 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx, bool format); 279 static inline struct evsel *evsel__newtp(const char *sys, const char *name) 280 { 281 return evsel__newtp_idx(sys, name, 0, true); 282 } 283 284 #ifdef HAVE_LIBTRACEEVENT 285 struct tep_event *evsel__tp_format(struct evsel *evsel); 286 #endif 287 288 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx); 289 void evsel__exit(struct evsel *evsel); 290 void evsel__delete(struct evsel *evsel); 291 292 void evsel__set_priv_destructor(void (*destructor)(void *priv)); 293 294 struct callchain_param; 295 296 void evsel__config(struct evsel *evsel, const struct record_opts *opts, 297 const struct callchain_param *callchain); 298 void evsel__config_callchain(struct evsel *evsel, const struct record_opts *opts, 299 const struct callchain_param *callchain); 300 301 int __evsel__sample_size(u64 sample_type); 302 void evsel__calc_id_pos(struct evsel *evsel); 303 304 bool evsel__is_cache_op_valid(u8 type, u8 op); 305 306 static inline bool evsel__is_bpf(struct evsel *evsel) 307 { 308 return evsel->bpf_counter_ops != NULL; 309 } 310 311 static inline bool evsel__is_bperf(struct evsel *evsel) 312 { 313 return evsel->bpf_counter_ops != NULL && list_empty(&evsel->bpf_counter_list); 314 } 315 316 #define EVSEL__MAX_ALIASES 8 317 318 extern const char *const evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES]; 319 extern const char *const evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES]; 320 extern const char *const evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES]; 321 extern const char *const evsel__hw_names[PERF_COUNT_HW_MAX]; 322 extern const char *const evsel__sw_names[PERF_COUNT_SW_MAX]; 323 extern char *evsel__bpf_counter_events; 324 bool evsel__match_bpf_counter_events(const char *name); 325 int arch_evsel__hw_name(struct evsel *evsel, char *bf, size_t size); 326 327 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size); 328 const char *evsel__name(struct evsel *evsel); 329 bool evsel__name_is(struct evsel *evsel, const char *name); 330 const char *evsel__metric_id(const struct evsel *evsel); 331 332 static inline bool evsel__is_retire_lat(const struct evsel *evsel) 333 { 334 return evsel->retire_lat; 335 } 336 337 const char *evsel__group_name(struct evsel *evsel); 338 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size); 339 340 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 341 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 342 343 #define evsel__set_sample_bit(evsel, bit) \ 344 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 345 346 #define evsel__reset_sample_bit(evsel, bit) \ 347 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 348 349 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier); 350 351 void arch_evsel__set_sample_weight(struct evsel *evsel); 352 void arch__post_evsel_config(struct evsel *evsel, struct perf_event_attr *attr); 353 int arch_evsel__open_strerror(struct evsel *evsel, int err, char *msg, size_t size); 354 void arch_evsel__apply_ratio_to_prev(struct evsel *evsel, struct perf_event_attr *attr); 355 356 int evsel__set_filter(struct evsel *evsel, const char *filter); 357 int evsel__append_tp_filter(struct evsel *evsel, const char *filter); 358 int evsel__append_addr_filter(struct evsel *evsel, const char *filter); 359 static inline bool evsel__is_non_perf_event_open_pmu(const struct evsel *evsel) 360 { 361 return evsel->pmu && evsel->pmu->type > PERF_PMU_TYPE_PE_END; 362 } 363 364 int evsel__enable_cpu(struct evsel *evsel, int cpu_map_idx); 365 int evsel__enable(struct evsel *evsel); 366 int evsel__disable(struct evsel *evsel); 367 int evsel__disable_cpu(struct evsel *evsel, int cpu_map_idx); 368 369 int evsel__open_per_cpu_and_thread(struct evsel *evsel, 370 struct perf_cpu_map *cpus, int cpu_map_idx, 371 struct perf_thread_map *threads); 372 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu_map_idx); 373 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads); 374 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus, 375 struct perf_thread_map *threads); 376 void evsel__close(struct evsel *evsel); 377 int evsel__prepare_open(struct evsel *evsel, struct perf_cpu_map *cpus, 378 struct perf_thread_map *threads); 379 380 bool evsel__precise_ip_fallback(struct evsel *evsel); 381 382 struct perf_sample; 383 384 #ifdef HAVE_LIBTRACEEVENT 385 void *perf_sample__rawptr(struct perf_sample *sample, const char *name); 386 u64 perf_sample__intval(struct perf_sample *sample, const char *name); 387 u64 perf_sample__intval_common(struct perf_sample *sample, const char *name); 388 char perf_sample__taskstate(struct perf_sample *sample, const char *name); 389 390 static inline char *perf_sample__strval(struct perf_sample *sample, const char *name) 391 { 392 return perf_sample__rawptr(sample, name); 393 } 394 #endif 395 396 struct tep_format_field; 397 398 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap); 399 400 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name); 401 struct tep_format_field *evsel__common_field(struct evsel *evsel, const char *name); 402 403 bool __evsel__match(const struct evsel *evsel, u32 type, u64 config); 404 405 #define evsel__match(evsel, t, c) __evsel__match(evsel, PERF_TYPE_##t, PERF_COUNT_##c) 406 407 int evsel__read_counter(struct evsel *evsel, int cpu_map_idx, int thread); 408 409 int __evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread, bool scale); 410 411 /** 412 * evsel__read_on_cpu - Read out the results on a CPU and thread 413 * 414 * @evsel - event selector to read value 415 * @cpu_map_idx - CPU of interest 416 * @thread - thread of interest 417 */ 418 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread) 419 { 420 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, false); 421 } 422 423 /** 424 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 425 * 426 * @evsel - event selector to read value 427 * @cpu_map_idx - CPU of interest 428 * @thread - thread of interest 429 */ 430 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu_map_idx, int thread) 431 { 432 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, true); 433 } 434 435 int evsel__parse_sample(struct evsel *evsel, union perf_event *event, 436 struct perf_sample *sample); 437 438 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event, 439 u64 *timestamp); 440 441 u16 evsel__id_hdr_size(const struct evsel *evsel); 442 443 static inline struct evsel *evsel__next(struct evsel *evsel) 444 { 445 return list_entry(evsel->core.node.next, struct evsel, core.node); 446 } 447 448 static inline struct evsel *evsel__prev(struct evsel *evsel) 449 { 450 return list_entry(evsel->core.node.prev, struct evsel, core.node); 451 } 452 453 /** 454 * evsel__is_group_leader - Return whether given evsel is a leader event 455 * 456 * @evsel - evsel selector to be tested 457 * 458 * Return %true if @evsel is a group leader or a stand-alone event 459 */ 460 static inline bool evsel__is_group_leader(const struct evsel *evsel) 461 { 462 return evsel->core.leader == &evsel->core; 463 } 464 465 /** 466 * evsel__is_group_event - Return whether given evsel is a group event 467 * 468 * @evsel - evsel selector to be tested 469 * 470 * Return %true iff event group view is enabled and @evsel is a actual group 471 * leader which has other members in the group 472 */ 473 static inline bool evsel__is_group_event(struct evsel *evsel) 474 { 475 if (!symbol_conf.event_group) 476 return false; 477 478 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1; 479 } 480 481 bool evsel__is_function_event(struct evsel *evsel); 482 483 static inline bool evsel__is_bpf_output(struct evsel *evsel) 484 { 485 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT); 486 } 487 488 static inline bool evsel__is_clock(const struct evsel *evsel) 489 { 490 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) || 491 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK); 492 } 493 494 bool evsel__fallback(struct evsel *evsel, struct target *target, int err, 495 char *msg, size_t msgsize); 496 int evsel__open_strerror(struct evsel *evsel, struct target *target, 497 int err, char *msg, size_t size); 498 499 static inline int evsel__group_idx(struct evsel *evsel) 500 { 501 return evsel->core.idx - evsel->core.leader->idx; 502 } 503 504 /* Iterates group WITHOUT the leader. */ 505 #define for_each_group_member_head(_evsel, _leader, _head) \ 506 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \ 507 (_evsel) && &(_evsel)->core.node != (_head) && \ 508 (_evsel)->core.leader == &(_leader)->core; \ 509 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 510 511 #define for_each_group_member(_evsel, _leader) \ 512 for_each_group_member_head(_evsel, _leader, &(_leader)->evlist->core.entries) 513 514 /* Iterates group WITH the leader. */ 515 #define for_each_group_evsel_head(_evsel, _leader, _head) \ 516 for ((_evsel) = _leader; \ 517 (_evsel) && &(_evsel)->core.node != (_head) && \ 518 (_evsel)->core.leader == &(_leader)->core; \ 519 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 520 521 #define for_each_group_evsel(_evsel, _leader) \ 522 for_each_group_evsel_head(_evsel, _leader, &(_leader)->evlist->core.entries) 523 524 static inline bool evsel__has_branch_callstack(const struct evsel *evsel) 525 { 526 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 527 } 528 529 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel) 530 { 531 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX; 532 } 533 534 static inline bool evsel__has_callchain(const struct evsel *evsel) 535 { 536 /* 537 * For reporting purposes, an evsel sample can have a recorded callchain 538 * or a callchain synthesized from AUX area data. 539 */ 540 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN || 541 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN; 542 } 543 544 static inline bool evsel__has_br_stack(const struct evsel *evsel) 545 { 546 /* 547 * For reporting purposes, an evsel sample can have a recorded branch 548 * stack or a branch stack synthesized from AUX area data. 549 */ 550 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK || 551 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK; 552 } 553 554 static inline bool evsel__is_dummy_event(struct evsel *evsel) 555 { 556 return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) && 557 (evsel->core.attr.config == PERF_COUNT_SW_DUMMY); 558 } 559 560 struct perf_session *evsel__session(struct evsel *evsel); 561 struct perf_env *evsel__env(struct evsel *evsel); 562 uint16_t evsel__e_machine(struct evsel *evsel, uint32_t *e_flags); 563 564 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist); 565 566 void evsel__zero_per_pkg(struct evsel *evsel); 567 bool evsel__is_hybrid(const struct evsel *evsel); 568 struct evsel *evsel__leader(const struct evsel *evsel); 569 bool evsel__has_leader(struct evsel *evsel, struct evsel *leader); 570 bool evsel__is_leader(struct evsel *evsel); 571 void evsel__set_leader(struct evsel *evsel, struct evsel *leader); 572 int evsel__source_count(const struct evsel *evsel); 573 void evsel__remove_from_group(struct evsel *evsel, struct evsel *leader); 574 575 bool arch_evsel__must_be_in_group(const struct evsel *evsel); 576 577 bool evsel__set_needs_uniquify(struct evsel *counter, const struct perf_stat_config *config); 578 void evsel__uniquify_counter(struct evsel *counter); 579 580 /* 581 * Macro to swap the bit-field postition and size. 582 * Used when, 583 * - dont need to swap the entire u64 && 584 * - when u64 has variable bit-field sizes && 585 * - when presented in a host endian which is different 586 * than the source endian of the perf.data file 587 */ 588 #define bitfield_swap(src, pos, size) \ 589 ((((src) >> (pos)) & ((1ull << (size)) - 1)) << (63 - ((pos) + (size) - 1))) 590 591 u64 evsel__bitfield_swap_branch_flags(u64 value); 592 bool evsel__config_exists(const struct evsel *evsel, const char *config_name); 593 int evsel__get_config_val(const struct evsel *evsel, const char *config_name, 594 u64 *val); 595 void evsel__set_config_if_unset(struct evsel *evsel, const char *config_name, 596 u64 val); 597 598 bool evsel__is_offcpu_event(struct evsel *evsel); 599 600 void evsel__warn_user_requested_cpus(struct evsel *evsel, struct perf_cpu_map *user_requested_cpus); 601 602 #endif /* __PERF_EVSEL_H */ 603