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