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