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