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_sel; 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_sel *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 snapshot; 119 bool supported; 120 bool needs_swap; 121 bool no_aux_samples; 122 bool immediate; 123 bool system_wide; 124 bool tracking; 125 bool per_pkg; 126 bool precise_max; 127 bool ignore_missing_thread; 128 /* parse modifier helper */ 129 int exclude_GH; 130 int nr_members; 131 int sample_read; 132 unsigned long *per_pkg_mask; 133 struct perf_evsel *leader; 134 char *group_name; 135 bool cmdline_group_boundary; 136 struct list_head config_terms; 137 int bpf_fd; 138 bool auto_merge_stats; 139 bool merged_stat; 140 const char * metric_expr; 141 const char * metric_name; 142 struct perf_evsel **metric_events; 143 bool collect_stat; 144 bool weak_group; 145 }; 146 147 union u64_swap { 148 u64 val64; 149 u32 val32[2]; 150 }; 151 152 struct perf_missing_features { 153 bool sample_id_all; 154 bool exclude_guest; 155 bool mmap2; 156 bool cloexec; 157 bool clockid; 158 bool clockid_wrong; 159 bool lbr_flags; 160 bool write_backward; 161 bool group_read; 162 }; 163 164 extern struct perf_missing_features perf_missing_features; 165 166 struct cpu_map; 167 struct target; 168 struct thread_map; 169 struct record_opts; 170 171 static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel) 172 { 173 return evsel->cpus; 174 } 175 176 static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel) 177 { 178 return perf_evsel__cpus(evsel)->nr; 179 } 180 181 void perf_counts_values__scale(struct perf_counts_values *count, 182 bool scale, s8 *pscaled); 183 184 void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread, 185 struct perf_counts_values *count); 186 187 int perf_evsel__object_config(size_t object_size, 188 int (*init)(struct perf_evsel *evsel), 189 void (*fini)(struct perf_evsel *evsel)); 190 191 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx); 192 193 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr) 194 { 195 return perf_evsel__new_idx(attr, 0); 196 } 197 198 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx); 199 200 /* 201 * Returns pointer with encoded error via <linux/err.h> interface. 202 */ 203 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name) 204 { 205 return perf_evsel__newtp_idx(sys, name, 0); 206 } 207 208 struct perf_evsel *perf_evsel__new_cycles(bool precise); 209 210 struct event_format *event_format__new(const char *sys, const char *name); 211 212 void perf_evsel__init(struct perf_evsel *evsel, 213 struct perf_event_attr *attr, int idx); 214 void perf_evsel__exit(struct perf_evsel *evsel); 215 void perf_evsel__delete(struct perf_evsel *evsel); 216 217 struct callchain_param; 218 219 void perf_evsel__config(struct perf_evsel *evsel, 220 struct record_opts *opts, 221 struct callchain_param *callchain); 222 void perf_evsel__config_callchain(struct perf_evsel *evsel, 223 struct record_opts *opts, 224 struct callchain_param *callchain); 225 226 int __perf_evsel__sample_size(u64 sample_type); 227 void perf_evsel__calc_id_pos(struct perf_evsel *evsel); 228 229 bool perf_evsel__is_cache_op_valid(u8 type, u8 op); 230 231 #define PERF_EVSEL__MAX_ALIASES 8 232 233 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX] 234 [PERF_EVSEL__MAX_ALIASES]; 235 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX] 236 [PERF_EVSEL__MAX_ALIASES]; 237 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX] 238 [PERF_EVSEL__MAX_ALIASES]; 239 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX]; 240 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX]; 241 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, 242 char *bf, size_t size); 243 const char *perf_evsel__name(struct perf_evsel *evsel); 244 245 const char *perf_evsel__group_name(struct perf_evsel *evsel); 246 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size); 247 248 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads); 249 void perf_evsel__close_fd(struct perf_evsel *evsel); 250 251 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel, 252 enum perf_event_sample_format bit); 253 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel, 254 enum perf_event_sample_format bit); 255 256 #define perf_evsel__set_sample_bit(evsel, bit) \ 257 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 258 259 #define perf_evsel__reset_sample_bit(evsel, bit) \ 260 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 261 262 void perf_evsel__set_sample_id(struct perf_evsel *evsel, 263 bool use_sample_identifier); 264 265 int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter); 266 int perf_evsel__append_tp_filter(struct perf_evsel *evsel, const char *filter); 267 int perf_evsel__append_addr_filter(struct perf_evsel *evsel, 268 const char *filter); 269 int perf_evsel__apply_filter(struct perf_evsel *evsel, const char *filter); 270 int perf_evsel__enable(struct perf_evsel *evsel); 271 int perf_evsel__disable(struct perf_evsel *evsel); 272 273 int perf_evsel__open_per_cpu(struct perf_evsel *evsel, 274 struct cpu_map *cpus); 275 int perf_evsel__open_per_thread(struct perf_evsel *evsel, 276 struct thread_map *threads); 277 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus, 278 struct thread_map *threads); 279 void perf_evsel__close(struct perf_evsel *evsel); 280 281 struct perf_sample; 282 283 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample, 284 const char *name); 285 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample, 286 const char *name); 287 288 static inline char *perf_evsel__strval(struct perf_evsel *evsel, 289 struct perf_sample *sample, 290 const char *name) 291 { 292 return perf_evsel__rawptr(evsel, sample, name); 293 } 294 295 struct format_field; 296 297 u64 format_field__intval(struct format_field *field, struct perf_sample *sample, bool needs_swap); 298 299 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name); 300 301 #define perf_evsel__match(evsel, t, c) \ 302 (evsel->attr.type == PERF_TYPE_##t && \ 303 evsel->attr.config == PERF_COUNT_##c) 304 305 static inline bool perf_evsel__match2(struct perf_evsel *e1, 306 struct perf_evsel *e2) 307 { 308 return (e1->attr.type == e2->attr.type) && 309 (e1->attr.config == e2->attr.config); 310 } 311 312 #define perf_evsel__cmp(a, b) \ 313 ((a) && \ 314 (b) && \ 315 (a)->attr.type == (b)->attr.type && \ 316 (a)->attr.config == (b)->attr.config) 317 318 int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread, 319 struct perf_counts_values *count); 320 321 int perf_evsel__read_counter(struct perf_evsel *evsel, int cpu, int thread); 322 323 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel, 324 int cpu, int thread, bool scale); 325 326 /** 327 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread 328 * 329 * @evsel - event selector to read value 330 * @cpu - CPU of interest 331 * @thread - thread of interest 332 */ 333 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel, 334 int cpu, int thread) 335 { 336 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false); 337 } 338 339 /** 340 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 341 * 342 * @evsel - event selector to read value 343 * @cpu - CPU of interest 344 * @thread - thread of interest 345 */ 346 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel, 347 int cpu, int thread) 348 { 349 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true); 350 } 351 352 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event, 353 struct perf_sample *sample); 354 355 int perf_evsel__parse_sample_timestamp(struct perf_evsel *evsel, 356 union perf_event *event, 357 u64 *timestamp); 358 359 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel) 360 { 361 return list_entry(evsel->node.next, struct perf_evsel, node); 362 } 363 364 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel) 365 { 366 return list_entry(evsel->node.prev, struct perf_evsel, node); 367 } 368 369 /** 370 * perf_evsel__is_group_leader - Return whether given evsel is a leader event 371 * 372 * @evsel - evsel selector to be tested 373 * 374 * Return %true if @evsel is a group leader or a stand-alone event 375 */ 376 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel) 377 { 378 return evsel->leader == evsel; 379 } 380 381 /** 382 * perf_evsel__is_group_event - Return whether given evsel is a group event 383 * 384 * @evsel - evsel selector to be tested 385 * 386 * Return %true iff event group view is enabled and @evsel is a actual group 387 * leader which has other members in the group 388 */ 389 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel) 390 { 391 if (!symbol_conf.event_group) 392 return false; 393 394 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1; 395 } 396 397 bool perf_evsel__is_function_event(struct perf_evsel *evsel); 398 399 static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel) 400 { 401 struct perf_event_attr *attr = &evsel->attr; 402 403 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) && 404 (attr->type == PERF_TYPE_SOFTWARE); 405 } 406 407 struct perf_attr_details { 408 bool freq; 409 bool verbose; 410 bool event_group; 411 bool force; 412 bool trace_fields; 413 }; 414 415 int perf_evsel__fprintf(struct perf_evsel *evsel, 416 struct perf_attr_details *details, FILE *fp); 417 418 #define EVSEL__PRINT_IP (1<<0) 419 #define EVSEL__PRINT_SYM (1<<1) 420 #define EVSEL__PRINT_DSO (1<<2) 421 #define EVSEL__PRINT_SYMOFFSET (1<<3) 422 #define EVSEL__PRINT_ONELINE (1<<4) 423 #define EVSEL__PRINT_SRCLINE (1<<5) 424 #define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6) 425 #define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7) 426 #define EVSEL__PRINT_SKIP_IGNORED (1<<8) 427 428 struct callchain_cursor; 429 430 int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment, 431 unsigned int print_opts, 432 struct callchain_cursor *cursor, FILE *fp); 433 434 int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al, 435 int left_alignment, unsigned int print_opts, 436 struct callchain_cursor *cursor, FILE *fp); 437 438 bool perf_evsel__fallback(struct perf_evsel *evsel, int err, 439 char *msg, size_t msgsize); 440 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target, 441 int err, char *msg, size_t size); 442 443 static inline int perf_evsel__group_idx(struct perf_evsel *evsel) 444 { 445 return evsel->idx - evsel->leader->idx; 446 } 447 448 #define for_each_group_member(_evsel, _leader) \ 449 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \ 450 (_evsel) && (_evsel)->leader == (_leader); \ 451 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node)) 452 453 static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel) 454 { 455 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 456 } 457 458 typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *); 459 460 int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr, 461 attr__fprintf_f attr__fprintf, void *priv); 462 463 struct perf_env *perf_evsel__env(struct perf_evsel *evsel); 464 465 #endif /* __PERF_EVSEL_H */ 466