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 <stdio.h> 8 #include <sys/types.h> 9 #include <linux/perf_event.h> 10 #include <linux/types.h> 11 #include <internal/evsel.h> 12 #include <perf/evsel.h> 13 #include "symbol_conf.h" 14 #include <internal/cpumap.h> 15 16 struct addr_location; 17 struct evsel; 18 union perf_event; 19 20 /* 21 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are 22 * more than one entry in the evlist. 23 */ 24 struct perf_sample_id { 25 struct hlist_node node; 26 u64 id; 27 struct evsel *evsel; 28 /* 29 * 'idx' will be used for AUX area sampling. A sample will have AUX area 30 * data that will be queued for decoding, where there are separate 31 * queues for each CPU (per-cpu tracing) or task (per-thread tracing). 32 * The sample ID can be used to lookup 'idx' which is effectively the 33 * queue number. 34 */ 35 int idx; 36 int cpu; 37 pid_t tid; 38 39 /* Holds total ID period value for PERF_SAMPLE_READ processing. */ 40 u64 period; 41 }; 42 43 struct cgroup; 44 45 /* 46 * The 'struct perf_evsel_config_term' is used to pass event 47 * specific configuration data to perf_evsel__config routine. 48 * It is allocated within event parsing and attached to 49 * perf_evsel::config_terms list head. 50 */ 51 enum term_type { 52 PERF_EVSEL__CONFIG_TERM_PERIOD, 53 PERF_EVSEL__CONFIG_TERM_FREQ, 54 PERF_EVSEL__CONFIG_TERM_TIME, 55 PERF_EVSEL__CONFIG_TERM_CALLGRAPH, 56 PERF_EVSEL__CONFIG_TERM_STACK_USER, 57 PERF_EVSEL__CONFIG_TERM_INHERIT, 58 PERF_EVSEL__CONFIG_TERM_MAX_STACK, 59 PERF_EVSEL__CONFIG_TERM_MAX_EVENTS, 60 PERF_EVSEL__CONFIG_TERM_OVERWRITE, 61 PERF_EVSEL__CONFIG_TERM_DRV_CFG, 62 PERF_EVSEL__CONFIG_TERM_BRANCH, 63 PERF_EVSEL__CONFIG_TERM_PERCORE, 64 PERF_EVSEL__CONFIG_TERM_AUX_OUTPUT, 65 }; 66 67 struct perf_evsel_config_term { 68 struct list_head list; 69 enum term_type type; 70 union { 71 u64 period; 72 u64 freq; 73 bool time; 74 char *callgraph; 75 char *drv_cfg; 76 u64 stack_user; 77 int max_stack; 78 bool inherit; 79 bool overwrite; 80 char *branch; 81 unsigned long max_events; 82 bool percore; 83 bool aux_output; 84 } val; 85 bool weak; 86 }; 87 88 struct perf_stat_evsel; 89 90 typedef int (perf_evsel__sb_cb_t)(union perf_event *event, void *data); 91 92 enum perf_tool_event { 93 PERF_TOOL_NONE = 0, 94 PERF_TOOL_DURATION_TIME = 1, 95 }; 96 97 struct bpf_object; 98 struct perf_counts; 99 struct xyarray; 100 101 /** struct evsel - event selector 102 * 103 * @evlist - evlist this evsel is in, if it is in one. 104 * @core - libperf evsel object 105 * @name - Can be set to retain the original event name passed by the user, 106 * so that when showing results in tools such as 'perf stat', we 107 * show the name used, not some alias. 108 * @id_pos: the position of the event id (PERF_SAMPLE_ID or 109 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of 110 * struct perf_record_sample 111 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or 112 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all 113 * is used there is an id sample appended to non-sample events 114 * @priv: And what is in its containing unnamed union are tool specific 115 */ 116 struct evsel { 117 struct perf_evsel core; 118 struct evlist *evlist; 119 char *filter; 120 struct xyarray *sample_id; 121 u64 *id; 122 struct perf_counts *counts; 123 struct perf_counts *prev_raw_counts; 124 int idx; 125 u32 ids; 126 unsigned long max_events; 127 unsigned long nr_events_printed; 128 char *name; 129 double scale; 130 const char *unit; 131 struct tep_event *tp_format; 132 off_t id_offset; 133 struct perf_stat_evsel *stats; 134 void *priv; 135 u64 db_id; 136 struct cgroup *cgrp; 137 void *handler; 138 unsigned int sample_size; 139 int id_pos; 140 int is_pos; 141 enum perf_tool_event tool_event; 142 bool uniquified_name; 143 bool snapshot; 144 bool supported; 145 bool needs_swap; 146 bool disabled; 147 bool no_aux_samples; 148 bool immediate; 149 bool system_wide; 150 bool tracking; 151 bool per_pkg; 152 bool precise_max; 153 bool ignore_missing_thread; 154 bool forced_leader; 155 bool use_uncore_alias; 156 /* parse modifier helper */ 157 int exclude_GH; 158 int sample_read; 159 unsigned long *per_pkg_mask; 160 struct evsel *leader; 161 char *group_name; 162 bool cmdline_group_boundary; 163 struct list_head config_terms; 164 struct bpf_object *bpf_obj; 165 int bpf_fd; 166 bool auto_merge_stats; 167 bool merged_stat; 168 const char * metric_expr; 169 const char * metric_name; 170 struct evsel **metric_events; 171 bool collect_stat; 172 bool weak_group; 173 bool percore; 174 const char *pmu_name; 175 struct { 176 perf_evsel__sb_cb_t *cb; 177 void *data; 178 } side_band; 179 }; 180 181 union u64_swap { 182 u64 val64; 183 u32 val32[2]; 184 }; 185 186 struct perf_missing_features { 187 bool sample_id_all; 188 bool exclude_guest; 189 bool mmap2; 190 bool cloexec; 191 bool clockid; 192 bool clockid_wrong; 193 bool lbr_flags; 194 bool write_backward; 195 bool group_read; 196 bool ksymbol; 197 bool bpf; 198 bool aux_output; 199 }; 200 201 extern struct perf_missing_features perf_missing_features; 202 203 struct perf_cpu_map; 204 struct target; 205 struct thread_map; 206 struct record_opts; 207 208 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel) 209 { 210 return perf_evsel__cpus(&evsel->core); 211 } 212 213 static inline int perf_evsel__nr_cpus(struct evsel *evsel) 214 { 215 return evsel__cpus(evsel)->nr; 216 } 217 218 void perf_counts_values__scale(struct perf_counts_values *count, 219 bool scale, s8 *pscaled); 220 221 void perf_evsel__compute_deltas(struct evsel *evsel, int cpu, int thread, 222 struct perf_counts_values *count); 223 224 int perf_evsel__object_config(size_t object_size, 225 int (*init)(struct evsel *evsel), 226 void (*fini)(struct evsel *evsel)); 227 228 struct evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx); 229 230 static inline struct evsel *evsel__new(struct perf_event_attr *attr) 231 { 232 return perf_evsel__new_idx(attr, 0); 233 } 234 235 struct evsel *perf_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 *perf_evsel__newtp(const char *sys, const char *name) 241 { 242 return perf_evsel__newtp_idx(sys, name, 0); 243 } 244 245 struct evsel *perf_evsel__new_cycles(bool precise); 246 247 struct tep_event *event_format__new(const char *sys, const char *name); 248 249 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx); 250 void perf_evsel__exit(struct evsel *evsel); 251 void evsel__delete(struct evsel *evsel); 252 253 struct callchain_param; 254 255 void perf_evsel__config(struct evsel *evsel, 256 struct record_opts *opts, 257 struct callchain_param *callchain); 258 void perf_evsel__config_callchain(struct evsel *evsel, 259 struct record_opts *opts, 260 struct callchain_param *callchain); 261 262 int __perf_evsel__sample_size(u64 sample_type); 263 void perf_evsel__calc_id_pos(struct evsel *evsel); 264 265 bool perf_evsel__is_cache_op_valid(u8 type, u8 op); 266 267 #define PERF_EVSEL__MAX_ALIASES 8 268 269 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX] 270 [PERF_EVSEL__MAX_ALIASES]; 271 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX] 272 [PERF_EVSEL__MAX_ALIASES]; 273 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX] 274 [PERF_EVSEL__MAX_ALIASES]; 275 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX]; 276 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX]; 277 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, 278 char *bf, size_t size); 279 const char *perf_evsel__name(struct evsel *evsel); 280 281 const char *perf_evsel__group_name(struct evsel *evsel); 282 int perf_evsel__group_desc(struct evsel *evsel, char *buf, size_t size); 283 284 int perf_evsel__alloc_id(struct evsel *evsel, int ncpus, int nthreads); 285 286 void __perf_evsel__set_sample_bit(struct evsel *evsel, 287 enum perf_event_sample_format bit); 288 void __perf_evsel__reset_sample_bit(struct evsel *evsel, 289 enum perf_event_sample_format bit); 290 291 #define perf_evsel__set_sample_bit(evsel, bit) \ 292 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 293 294 #define perf_evsel__reset_sample_bit(evsel, bit) \ 295 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 296 297 void perf_evsel__set_sample_id(struct evsel *evsel, 298 bool use_sample_identifier); 299 300 int perf_evsel__set_filter(struct evsel *evsel, const char *filter); 301 int perf_evsel__append_tp_filter(struct evsel *evsel, const char *filter); 302 int perf_evsel__append_addr_filter(struct evsel *evsel, 303 const char *filter); 304 int evsel__enable(struct evsel *evsel); 305 int evsel__disable(struct evsel *evsel); 306 307 int perf_evsel__open_per_cpu(struct evsel *evsel, 308 struct perf_cpu_map *cpus); 309 int perf_evsel__open_per_thread(struct evsel *evsel, 310 struct perf_thread_map *threads); 311 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus, 312 struct perf_thread_map *threads); 313 void evsel__close(struct evsel *evsel); 314 315 struct perf_sample; 316 317 void *perf_evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, 318 const char *name); 319 u64 perf_evsel__intval(struct evsel *evsel, struct perf_sample *sample, 320 const char *name); 321 322 static inline char *perf_evsel__strval(struct evsel *evsel, 323 struct perf_sample *sample, 324 const char *name) 325 { 326 return perf_evsel__rawptr(evsel, sample, name); 327 } 328 329 struct tep_format_field; 330 331 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap); 332 333 struct tep_format_field *perf_evsel__field(struct evsel *evsel, const char *name); 334 335 #define perf_evsel__match(evsel, t, c) \ 336 (evsel->core.attr.type == PERF_TYPE_##t && \ 337 evsel->core.attr.config == PERF_COUNT_##c) 338 339 static inline bool perf_evsel__match2(struct evsel *e1, 340 struct evsel *e2) 341 { 342 return (e1->core.attr.type == e2->core.attr.type) && 343 (e1->core.attr.config == e2->core.attr.config); 344 } 345 346 #define perf_evsel__cmp(a, b) \ 347 ((a) && \ 348 (b) && \ 349 (a)->core.attr.type == (b)->core.attr.type && \ 350 (a)->core.attr.config == (b)->core.attr.config) 351 352 int perf_evsel__read_counter(struct evsel *evsel, int cpu, int thread); 353 354 int __perf_evsel__read_on_cpu(struct evsel *evsel, 355 int cpu, int thread, bool scale); 356 357 /** 358 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread 359 * 360 * @evsel - event selector to read value 361 * @cpu - CPU of interest 362 * @thread - thread of interest 363 */ 364 static inline int perf_evsel__read_on_cpu(struct evsel *evsel, 365 int cpu, int thread) 366 { 367 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false); 368 } 369 370 /** 371 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 372 * 373 * @evsel - event selector to read value 374 * @cpu - CPU of interest 375 * @thread - thread of interest 376 */ 377 static inline int perf_evsel__read_on_cpu_scaled(struct evsel *evsel, 378 int cpu, int thread) 379 { 380 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true); 381 } 382 383 int perf_evsel__parse_sample(struct evsel *evsel, union perf_event *event, 384 struct perf_sample *sample); 385 386 int perf_evsel__parse_sample_timestamp(struct evsel *evsel, 387 union perf_event *event, 388 u64 *timestamp); 389 390 static inline struct evsel *perf_evsel__next(struct evsel *evsel) 391 { 392 return list_entry(evsel->core.node.next, struct evsel, core.node); 393 } 394 395 static inline struct evsel *perf_evsel__prev(struct evsel *evsel) 396 { 397 return list_entry(evsel->core.node.prev, struct evsel, core.node); 398 } 399 400 /** 401 * perf_evsel__is_group_leader - Return whether given evsel is a leader event 402 * 403 * @evsel - evsel selector to be tested 404 * 405 * Return %true if @evsel is a group leader or a stand-alone event 406 */ 407 static inline bool perf_evsel__is_group_leader(const struct evsel *evsel) 408 { 409 return evsel->leader == evsel; 410 } 411 412 /** 413 * perf_evsel__is_group_event - Return whether given evsel is a group event 414 * 415 * @evsel - evsel selector to be tested 416 * 417 * Return %true iff event group view is enabled and @evsel is a actual group 418 * leader which has other members in the group 419 */ 420 static inline bool perf_evsel__is_group_event(struct evsel *evsel) 421 { 422 if (!symbol_conf.event_group) 423 return false; 424 425 return perf_evsel__is_group_leader(evsel) && evsel->core.nr_members > 1; 426 } 427 428 bool perf_evsel__is_function_event(struct evsel *evsel); 429 430 static inline bool perf_evsel__is_bpf_output(struct evsel *evsel) 431 { 432 return perf_evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT); 433 } 434 435 static inline bool perf_evsel__is_clock(struct evsel *evsel) 436 { 437 return perf_evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) || 438 perf_evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK); 439 } 440 441 struct perf_attr_details { 442 bool freq; 443 bool verbose; 444 bool event_group; 445 bool force; 446 bool trace_fields; 447 }; 448 449 int perf_evsel__fprintf(struct evsel *evsel, 450 struct perf_attr_details *details, FILE *fp); 451 452 #define EVSEL__PRINT_IP (1<<0) 453 #define EVSEL__PRINT_SYM (1<<1) 454 #define EVSEL__PRINT_DSO (1<<2) 455 #define EVSEL__PRINT_SYMOFFSET (1<<3) 456 #define EVSEL__PRINT_ONELINE (1<<4) 457 #define EVSEL__PRINT_SRCLINE (1<<5) 458 #define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6) 459 #define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7) 460 #define EVSEL__PRINT_SKIP_IGNORED (1<<8) 461 462 struct callchain_cursor; 463 464 int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment, 465 unsigned int print_opts, 466 struct callchain_cursor *cursor, FILE *fp); 467 468 int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al, 469 int left_alignment, unsigned int print_opts, 470 struct callchain_cursor *cursor, FILE *fp); 471 472 bool perf_evsel__fallback(struct evsel *evsel, int err, 473 char *msg, size_t msgsize); 474 int perf_evsel__open_strerror(struct evsel *evsel, struct target *target, 475 int err, char *msg, size_t size); 476 477 static inline int perf_evsel__group_idx(struct evsel *evsel) 478 { 479 return evsel->idx - evsel->leader->idx; 480 } 481 482 /* Iterates group WITHOUT the leader. */ 483 #define for_each_group_member(_evsel, _leader) \ 484 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \ 485 (_evsel) && (_evsel)->leader == (_leader); \ 486 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 487 488 /* Iterates group WITH the leader. */ 489 #define for_each_group_evsel(_evsel, _leader) \ 490 for ((_evsel) = _leader; \ 491 (_evsel) && (_evsel)->leader == (_leader); \ 492 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 493 494 static inline bool perf_evsel__has_branch_callstack(const struct evsel *evsel) 495 { 496 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 497 } 498 499 static inline bool evsel__has_callchain(const struct evsel *evsel) 500 { 501 return (evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN) != 0; 502 } 503 504 typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *); 505 506 int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr, 507 attr__fprintf_f attr__fprintf, void *priv); 508 509 struct perf_env *perf_evsel__env(struct evsel *evsel); 510 511 int perf_evsel__store_ids(struct evsel *evsel, struct evlist *evlist); 512 #endif /* __PERF_EVSEL_H */ 513