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