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