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