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