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