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