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