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