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