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