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 <internal/cpumap.h> 14 #include <perf/cpumap.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 struct perf_pmu; 27 28 typedef int (evsel__sb_cb_t)(union perf_event *event, void *data); 29 30 enum perf_tool_event { 31 PERF_TOOL_NONE = 0, 32 PERF_TOOL_DURATION_TIME = 1, 33 PERF_TOOL_USER_TIME = 2, 34 PERF_TOOL_SYSTEM_TIME = 3, 35 36 PERF_TOOL_MAX, 37 }; 38 39 const char *perf_tool_event__to_str(enum perf_tool_event ev); 40 enum perf_tool_event perf_tool_event__from_str(const char *str); 41 42 #define perf_tool_event__for_each_event(ev) \ 43 for ((ev) = PERF_TOOL_DURATION_TIME; (ev) < PERF_TOOL_MAX; ev++) 44 45 /** struct evsel - event selector 46 * 47 * @evlist - evlist this evsel is in, if it is in one. 48 * @core - libperf evsel object 49 * @name - Can be set to retain the original event name passed by the user, 50 * so that when showing results in tools such as 'perf stat', we 51 * show the name used, not some alias. 52 * @id_pos: the position of the event id (PERF_SAMPLE_ID or 53 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of 54 * struct perf_record_sample 55 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or 56 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all 57 * is used there is an id sample appended to non-sample events 58 * @priv: And what is in its containing unnamed union are tool specific 59 */ 60 struct evsel { 61 struct perf_evsel core; 62 struct evlist *evlist; 63 off_t id_offset; 64 int id_pos; 65 int is_pos; 66 unsigned int sample_size; 67 68 /* 69 * These fields can be set in the parse-events code or similar. 70 * Please check evsel__clone() to copy them properly so that 71 * they can be released properly. 72 */ 73 struct { 74 char *name; 75 char *group_name; 76 const char *pmu_name; 77 struct tep_event *tp_format; 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 use_uncore_alias; 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 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 const char * metric_expr; 109 const char * metric_name; 110 struct evsel **metric_events; 111 struct evsel *metric_leader; 112 113 void *handler; 114 struct perf_counts *counts; 115 struct perf_counts *prev_raw_counts; 116 unsigned long nr_events_printed; 117 struct perf_stat_evsel *stats; 118 void *priv; 119 u64 db_id; 120 bool uniquified_name; 121 bool supported; 122 bool needs_swap; 123 bool disabled; 124 bool no_aux_samples; 125 bool immediate; 126 bool tracking; 127 bool ignore_missing_thread; 128 bool forced_leader; 129 bool cmdline_group_boundary; 130 bool merged_stat; 131 bool reset_group; 132 bool errored; 133 bool needs_auxtrace_mmap; 134 struct hashmap *per_pkg_mask; 135 int err; 136 struct { 137 evsel__sb_cb_t *cb; 138 void *data; 139 } side_band; 140 /* 141 * For reporting purposes, an evsel sample can have a callchain 142 * synthesized from AUX area data. Keep track of synthesized sample 143 * types here. Note, the recorded sample_type cannot be changed because 144 * it is needed to continue to parse events. 145 * See also evsel__has_callchain(). 146 */ 147 __u64 synth_sample_type; 148 149 /* 150 * bpf_counter_ops serves two use cases: 151 * 1. perf-stat -b counting events used byBPF programs 152 * 2. perf-stat --use-bpf use BPF programs to aggregate counts 153 */ 154 struct bpf_counter_ops *bpf_counter_ops; 155 156 /* for perf-stat -b */ 157 struct list_head bpf_counter_list; 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 }; 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 }; 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(struct evsel *evsel); 217 bool evsel__is_aux_event(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 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx); 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 * Returns pointer with encoded error via <linux/err.h> interface. 234 */ 235 static inline struct evsel *evsel__newtp(const char *sys, const char *name) 236 { 237 return evsel__newtp_idx(sys, name, 0); 238 } 239 240 struct evsel *evsel__new_cycles(bool precise, __u32 type, __u64 config); 241 242 struct tep_event *event_format__new(const char *sys, const char *name); 243 244 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx); 245 void evsel__exit(struct evsel *evsel); 246 void evsel__delete(struct evsel *evsel); 247 248 struct callchain_param; 249 250 void evsel__config(struct evsel *evsel, struct record_opts *opts, 251 struct callchain_param *callchain); 252 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts, 253 struct callchain_param *callchain); 254 255 int __evsel__sample_size(u64 sample_type); 256 void evsel__calc_id_pos(struct evsel *evsel); 257 258 bool evsel__is_cache_op_valid(u8 type, u8 op); 259 260 static inline bool evsel__is_bpf(struct evsel *evsel) 261 { 262 return evsel->bpf_counter_ops != NULL; 263 } 264 265 #define EVSEL__MAX_ALIASES 8 266 267 extern const char *const evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES]; 268 extern const char *const evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES]; 269 extern const char *const evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES]; 270 extern const char *const evsel__hw_names[PERF_COUNT_HW_MAX]; 271 extern const char *const evsel__sw_names[PERF_COUNT_SW_MAX]; 272 extern char *evsel__bpf_counter_events; 273 bool evsel__match_bpf_counter_events(const char *name); 274 int arch_evsel__hw_name(struct evsel *evsel, char *bf, size_t size); 275 276 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size); 277 const char *evsel__name(struct evsel *evsel); 278 const char *evsel__metric_id(const struct evsel *evsel); 279 280 static inline bool evsel__is_tool(const struct evsel *evsel) 281 { 282 return evsel->tool_event != PERF_TOOL_NONE; 283 } 284 285 const char *evsel__group_name(struct evsel *evsel); 286 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size); 287 288 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 289 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 290 291 #define evsel__set_sample_bit(evsel, bit) \ 292 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 293 294 #define evsel__reset_sample_bit(evsel, bit) \ 295 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 296 297 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier); 298 299 void arch_evsel__set_sample_weight(struct evsel *evsel); 300 void arch_evsel__fixup_new_cycles(struct perf_event_attr *attr); 301 void arch__post_evsel_config(struct evsel *evsel, struct perf_event_attr *attr); 302 303 int evsel__set_filter(struct evsel *evsel, const char *filter); 304 int evsel__append_tp_filter(struct evsel *evsel, const char *filter); 305 int evsel__append_addr_filter(struct evsel *evsel, const char *filter); 306 int evsel__enable_cpu(struct evsel *evsel, int cpu_map_idx); 307 int evsel__enable(struct evsel *evsel); 308 int evsel__disable(struct evsel *evsel); 309 int evsel__disable_cpu(struct evsel *evsel, int cpu_map_idx); 310 311 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu_map_idx); 312 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads); 313 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus, 314 struct perf_thread_map *threads); 315 void evsel__close(struct evsel *evsel); 316 int evsel__prepare_open(struct evsel *evsel, struct perf_cpu_map *cpus, 317 struct perf_thread_map *threads); 318 bool evsel__detect_missing_features(struct evsel *evsel); 319 320 enum rlimit_action { NO_CHANGE, SET_TO_MAX, INCREASED_MAX }; 321 bool evsel__increase_rlimit(enum rlimit_action *set_rlimit); 322 323 bool evsel__precise_ip_fallback(struct evsel *evsel); 324 325 struct perf_sample; 326 327 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name); 328 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name); 329 330 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name) 331 { 332 return evsel__rawptr(evsel, sample, name); 333 } 334 335 struct tep_format_field; 336 337 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap); 338 339 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name); 340 341 #define evsel__match(evsel, t, c) \ 342 (evsel->core.attr.type == PERF_TYPE_##t && \ 343 evsel->core.attr.config == PERF_COUNT_##c) 344 345 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2) 346 { 347 return (e1->core.attr.type == e2->core.attr.type) && 348 (e1->core.attr.config == e2->core.attr.config); 349 } 350 351 int evsel__read_counter(struct evsel *evsel, int cpu_map_idx, int thread); 352 353 int __evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread, bool scale); 354 355 /** 356 * evsel__read_on_cpu - Read out the results on a CPU and thread 357 * 358 * @evsel - event selector to read value 359 * @cpu_map_idx - CPU of interest 360 * @thread - thread of interest 361 */ 362 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread) 363 { 364 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, false); 365 } 366 367 /** 368 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 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_scaled(struct evsel *evsel, int cpu_map_idx, int thread) 375 { 376 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, true); 377 } 378 379 int evsel__parse_sample(struct evsel *evsel, union perf_event *event, 380 struct perf_sample *sample); 381 382 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event, 383 u64 *timestamp); 384 385 u16 evsel__id_hdr_size(struct evsel *evsel); 386 387 static inline struct evsel *evsel__next(struct evsel *evsel) 388 { 389 return list_entry(evsel->core.node.next, struct evsel, core.node); 390 } 391 392 static inline struct evsel *evsel__prev(struct evsel *evsel) 393 { 394 return list_entry(evsel->core.node.prev, struct evsel, core.node); 395 } 396 397 /** 398 * evsel__is_group_leader - Return whether given evsel is a leader event 399 * 400 * @evsel - evsel selector to be tested 401 * 402 * Return %true if @evsel is a group leader or a stand-alone event 403 */ 404 static inline bool evsel__is_group_leader(const struct evsel *evsel) 405 { 406 return evsel->core.leader == &evsel->core; 407 } 408 409 /** 410 * evsel__is_group_event - Return whether given evsel is a group event 411 * 412 * @evsel - evsel selector to be tested 413 * 414 * Return %true iff event group view is enabled and @evsel is a actual group 415 * leader which has other members in the group 416 */ 417 static inline bool evsel__is_group_event(struct evsel *evsel) 418 { 419 if (!symbol_conf.event_group) 420 return false; 421 422 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1; 423 } 424 425 bool evsel__is_function_event(struct evsel *evsel); 426 427 static inline bool evsel__is_bpf_output(struct evsel *evsel) 428 { 429 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT); 430 } 431 432 static inline bool evsel__is_clock(struct evsel *evsel) 433 { 434 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) || 435 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK); 436 } 437 438 bool evsel__fallback(struct evsel *evsel, int err, char *msg, size_t msgsize); 439 int evsel__open_strerror(struct evsel *evsel, struct target *target, 440 int err, char *msg, size_t size); 441 442 static inline int evsel__group_idx(struct evsel *evsel) 443 { 444 return evsel->core.idx - evsel->core.leader->idx; 445 } 446 447 /* Iterates group WITHOUT the leader. */ 448 #define for_each_group_member(_evsel, _leader) \ 449 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \ 450 (_evsel) && (_evsel)->core.leader == (&_leader->core); \ 451 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 452 453 /* Iterates group WITH the leader. */ 454 #define for_each_group_evsel(_evsel, _leader) \ 455 for ((_evsel) = _leader; \ 456 (_evsel) && (_evsel)->core.leader == (&_leader->core); \ 457 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 458 459 static inline bool evsel__has_branch_callstack(const struct evsel *evsel) 460 { 461 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 462 } 463 464 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel) 465 { 466 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX; 467 } 468 469 static inline bool evsel__has_callchain(const struct evsel *evsel) 470 { 471 /* 472 * For reporting purposes, an evsel sample can have a recorded callchain 473 * or a callchain synthesized from AUX area data. 474 */ 475 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN || 476 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN; 477 } 478 479 static inline bool evsel__has_br_stack(const struct evsel *evsel) 480 { 481 /* 482 * For reporting purposes, an evsel sample can have a recorded branch 483 * stack or a branch stack synthesized from AUX area data. 484 */ 485 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK || 486 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK; 487 } 488 489 static inline bool evsel__is_dummy_event(struct evsel *evsel) 490 { 491 return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) && 492 (evsel->core.attr.config == PERF_COUNT_SW_DUMMY); 493 } 494 495 struct perf_env *evsel__env(struct evsel *evsel); 496 497 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist); 498 499 void evsel__zero_per_pkg(struct evsel *evsel); 500 bool evsel__is_hybrid(struct evsel *evsel); 501 struct evsel *evsel__leader(struct evsel *evsel); 502 bool evsel__has_leader(struct evsel *evsel, struct evsel *leader); 503 bool evsel__is_leader(struct evsel *evsel); 504 void evsel__set_leader(struct evsel *evsel, struct evsel *leader); 505 int evsel__source_count(const struct evsel *evsel); 506 void evsel__remove_from_group(struct evsel *evsel, struct evsel *leader); 507 508 bool arch_evsel__must_be_in_group(const struct evsel *evsel); 509 510 /* 511 * Macro to swap the bit-field postition and size. 512 * Used when, 513 * - dont need to swap the entire u64 && 514 * - when u64 has variable bit-field sizes && 515 * - when presented in a host endian which is different 516 * than the source endian of the perf.data file 517 */ 518 #define bitfield_swap(src, pos, size) \ 519 ((((src) >> (pos)) & ((1ull << (size)) - 1)) << (63 - ((pos) + (size) - 1))) 520 521 u64 evsel__bitfield_swap_branch_flags(u64 value); 522 #endif /* __PERF_EVSEL_H */ 523