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