1 #ifndef __PERF_EVSEL_H 2 #define __PERF_EVSEL_H 1 3 4 #include <linux/list.h> 5 #include <stdbool.h> 6 #include <stddef.h> 7 #include <linux/perf_event.h> 8 #include <linux/types.h> 9 #include "xyarray.h" 10 #include "symbol.h" 11 #include "cpumap.h" 12 #include "counts.h" 13 14 struct perf_evsel; 15 16 /* 17 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are 18 * more than one entry in the evlist. 19 */ 20 struct perf_sample_id { 21 struct hlist_node node; 22 u64 id; 23 struct perf_evsel *evsel; 24 int idx; 25 int cpu; 26 pid_t tid; 27 28 /* Holds total ID period value for PERF_SAMPLE_READ processing. */ 29 u64 period; 30 }; 31 32 struct cgroup_sel; 33 34 /* 35 * The 'struct perf_evsel_config_term' is used to pass event 36 * specific configuration data to perf_evsel__config routine. 37 * It is allocated within event parsing and attached to 38 * perf_evsel::config_terms list head. 39 */ 40 enum { 41 PERF_EVSEL__CONFIG_TERM_PERIOD, 42 PERF_EVSEL__CONFIG_TERM_FREQ, 43 PERF_EVSEL__CONFIG_TERM_TIME, 44 PERF_EVSEL__CONFIG_TERM_CALLGRAPH, 45 PERF_EVSEL__CONFIG_TERM_STACK_USER, 46 PERF_EVSEL__CONFIG_TERM_INHERIT, 47 PERF_EVSEL__CONFIG_TERM_MAX_STACK, 48 PERF_EVSEL__CONFIG_TERM_OVERWRITE, 49 PERF_EVSEL__CONFIG_TERM_DRV_CFG, 50 PERF_EVSEL__CONFIG_TERM_BRANCH, 51 PERF_EVSEL__CONFIG_TERM_MAX, 52 }; 53 54 struct perf_evsel_config_term { 55 struct list_head list; 56 int 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 }; 70 71 /** struct perf_evsel - event selector 72 * 73 * @evlist - evlist this evsel is in, if it is in one. 74 * @node - To insert it into evlist->entries or in other list_heads, say in 75 * the event parsing routines. 76 * @name - Can be set to retain the original event name passed by the user, 77 * so that when showing results in tools such as 'perf stat', we 78 * show the name used, not some alias. 79 * @id_pos: the position of the event id (PERF_SAMPLE_ID or 80 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of 81 * struct sample_event 82 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or 83 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all 84 * is used there is an id sample appended to non-sample events 85 * @priv: And what is in its containing unnamed union are tool specific 86 */ 87 struct perf_evsel { 88 struct list_head node; 89 struct perf_evlist *evlist; 90 struct perf_event_attr attr; 91 char *filter; 92 struct xyarray *fd; 93 struct xyarray *sample_id; 94 u64 *id; 95 struct perf_counts *counts; 96 struct perf_counts *prev_raw_counts; 97 int idx; 98 u32 ids; 99 char *name; 100 double scale; 101 const char *unit; 102 struct event_format *tp_format; 103 off_t id_offset; 104 void *priv; 105 u64 db_id; 106 struct cgroup_sel *cgrp; 107 void *handler; 108 struct cpu_map *cpus; 109 struct cpu_map *own_cpus; 110 struct thread_map *threads; 111 unsigned int sample_size; 112 int id_pos; 113 int is_pos; 114 bool snapshot; 115 bool supported; 116 bool needs_swap; 117 bool no_aux_samples; 118 bool immediate; 119 bool system_wide; 120 bool tracking; 121 bool per_pkg; 122 bool precise_max; 123 bool ignore_missing_thread; 124 /* parse modifier helper */ 125 int exclude_GH; 126 int nr_members; 127 int sample_read; 128 unsigned long *per_pkg_mask; 129 struct perf_evsel *leader; 130 char *group_name; 131 bool cmdline_group_boundary; 132 struct list_head config_terms; 133 int bpf_fd; 134 }; 135 136 union u64_swap { 137 u64 val64; 138 u32 val32[2]; 139 }; 140 141 struct cpu_map; 142 struct target; 143 struct thread_map; 144 struct record_opts; 145 146 static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel) 147 { 148 return evsel->cpus; 149 } 150 151 static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel) 152 { 153 return perf_evsel__cpus(evsel)->nr; 154 } 155 156 void perf_counts_values__scale(struct perf_counts_values *count, 157 bool scale, s8 *pscaled); 158 159 void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread, 160 struct perf_counts_values *count); 161 162 int perf_evsel__object_config(size_t object_size, 163 int (*init)(struct perf_evsel *evsel), 164 void (*fini)(struct perf_evsel *evsel)); 165 166 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx); 167 168 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr) 169 { 170 return perf_evsel__new_idx(attr, 0); 171 } 172 173 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx); 174 175 /* 176 * Returns pointer with encoded error via <linux/err.h> interface. 177 */ 178 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name) 179 { 180 return perf_evsel__newtp_idx(sys, name, 0); 181 } 182 183 struct perf_evsel *perf_evsel__new_cycles(void); 184 185 struct event_format *event_format__new(const char *sys, const char *name); 186 187 void perf_evsel__init(struct perf_evsel *evsel, 188 struct perf_event_attr *attr, int idx); 189 void perf_evsel__exit(struct perf_evsel *evsel); 190 void perf_evsel__delete(struct perf_evsel *evsel); 191 192 struct callchain_param; 193 194 void perf_evsel__config(struct perf_evsel *evsel, 195 struct record_opts *opts, 196 struct callchain_param *callchain); 197 void perf_evsel__config_callchain(struct perf_evsel *evsel, 198 struct record_opts *opts, 199 struct callchain_param *callchain); 200 201 int __perf_evsel__sample_size(u64 sample_type); 202 void perf_evsel__calc_id_pos(struct perf_evsel *evsel); 203 204 bool perf_evsel__is_cache_op_valid(u8 type, u8 op); 205 206 #define PERF_EVSEL__MAX_ALIASES 8 207 208 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX] 209 [PERF_EVSEL__MAX_ALIASES]; 210 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX] 211 [PERF_EVSEL__MAX_ALIASES]; 212 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX] 213 [PERF_EVSEL__MAX_ALIASES]; 214 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX]; 215 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX]; 216 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, 217 char *bf, size_t size); 218 const char *perf_evsel__name(struct perf_evsel *evsel); 219 220 const char *perf_evsel__group_name(struct perf_evsel *evsel); 221 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size); 222 223 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads); 224 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads); 225 226 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel, 227 enum perf_event_sample_format bit); 228 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel, 229 enum perf_event_sample_format bit); 230 231 #define perf_evsel__set_sample_bit(evsel, bit) \ 232 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 233 234 #define perf_evsel__reset_sample_bit(evsel, bit) \ 235 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 236 237 void perf_evsel__set_sample_id(struct perf_evsel *evsel, 238 bool use_sample_identifier); 239 240 int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter); 241 int perf_evsel__append_tp_filter(struct perf_evsel *evsel, const char *filter); 242 int perf_evsel__append_addr_filter(struct perf_evsel *evsel, 243 const char *filter); 244 int perf_evsel__apply_filter(struct perf_evsel *evsel, int ncpus, int nthreads, 245 const char *filter); 246 int perf_evsel__enable(struct perf_evsel *evsel); 247 int perf_evsel__disable(struct perf_evsel *evsel); 248 249 int perf_evsel__open_per_cpu(struct perf_evsel *evsel, 250 struct cpu_map *cpus); 251 int perf_evsel__open_per_thread(struct perf_evsel *evsel, 252 struct thread_map *threads); 253 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus, 254 struct thread_map *threads); 255 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads); 256 257 struct perf_sample; 258 259 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample, 260 const char *name); 261 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample, 262 const char *name); 263 264 static inline char *perf_evsel__strval(struct perf_evsel *evsel, 265 struct perf_sample *sample, 266 const char *name) 267 { 268 return perf_evsel__rawptr(evsel, sample, name); 269 } 270 271 struct format_field; 272 273 u64 format_field__intval(struct format_field *field, struct perf_sample *sample, bool needs_swap); 274 275 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name); 276 277 #define perf_evsel__match(evsel, t, c) \ 278 (evsel->attr.type == PERF_TYPE_##t && \ 279 evsel->attr.config == PERF_COUNT_##c) 280 281 static inline bool perf_evsel__match2(struct perf_evsel *e1, 282 struct perf_evsel *e2) 283 { 284 return (e1->attr.type == e2->attr.type) && 285 (e1->attr.config == e2->attr.config); 286 } 287 288 #define perf_evsel__cmp(a, b) \ 289 ((a) && \ 290 (b) && \ 291 (a)->attr.type == (b)->attr.type && \ 292 (a)->attr.config == (b)->attr.config) 293 294 int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread, 295 struct perf_counts_values *count); 296 297 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel, 298 int cpu, int thread, bool scale); 299 300 /** 301 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread 302 * 303 * @evsel - event selector to read value 304 * @cpu - CPU of interest 305 * @thread - thread of interest 306 */ 307 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel, 308 int cpu, int thread) 309 { 310 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false); 311 } 312 313 /** 314 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 315 * 316 * @evsel - event selector to read value 317 * @cpu - CPU of interest 318 * @thread - thread of interest 319 */ 320 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel, 321 int cpu, int thread) 322 { 323 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true); 324 } 325 326 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event, 327 struct perf_sample *sample); 328 329 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel) 330 { 331 return list_entry(evsel->node.next, struct perf_evsel, node); 332 } 333 334 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel) 335 { 336 return list_entry(evsel->node.prev, struct perf_evsel, node); 337 } 338 339 /** 340 * perf_evsel__is_group_leader - Return whether given evsel is a leader event 341 * 342 * @evsel - evsel selector to be tested 343 * 344 * Return %true if @evsel is a group leader or a stand-alone event 345 */ 346 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel) 347 { 348 return evsel->leader == evsel; 349 } 350 351 /** 352 * perf_evsel__is_group_event - Return whether given evsel is a group event 353 * 354 * @evsel - evsel selector to be tested 355 * 356 * Return %true iff event group view is enabled and @evsel is a actual group 357 * leader which has other members in the group 358 */ 359 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel) 360 { 361 if (!symbol_conf.event_group) 362 return false; 363 364 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1; 365 } 366 367 bool perf_evsel__is_function_event(struct perf_evsel *evsel); 368 369 static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel) 370 { 371 struct perf_event_attr *attr = &evsel->attr; 372 373 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) && 374 (attr->type == PERF_TYPE_SOFTWARE); 375 } 376 377 struct perf_attr_details { 378 bool freq; 379 bool verbose; 380 bool event_group; 381 bool force; 382 bool trace_fields; 383 }; 384 385 int perf_evsel__fprintf(struct perf_evsel *evsel, 386 struct perf_attr_details *details, FILE *fp); 387 388 #define EVSEL__PRINT_IP (1<<0) 389 #define EVSEL__PRINT_SYM (1<<1) 390 #define EVSEL__PRINT_DSO (1<<2) 391 #define EVSEL__PRINT_SYMOFFSET (1<<3) 392 #define EVSEL__PRINT_ONELINE (1<<4) 393 #define EVSEL__PRINT_SRCLINE (1<<5) 394 #define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6) 395 #define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7) 396 #define EVSEL__PRINT_SKIP_IGNORED (1<<8) 397 398 struct callchain_cursor; 399 400 int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment, 401 unsigned int print_opts, 402 struct callchain_cursor *cursor, FILE *fp); 403 404 int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al, 405 int left_alignment, unsigned int print_opts, 406 struct callchain_cursor *cursor, FILE *fp); 407 408 bool perf_evsel__fallback(struct perf_evsel *evsel, int err, 409 char *msg, size_t msgsize); 410 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target, 411 int err, char *msg, size_t size); 412 413 static inline int perf_evsel__group_idx(struct perf_evsel *evsel) 414 { 415 return evsel->idx - evsel->leader->idx; 416 } 417 418 #define for_each_group_member(_evsel, _leader) \ 419 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \ 420 (_evsel) && (_evsel)->leader == (_leader); \ 421 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node)) 422 423 static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel) 424 { 425 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 426 } 427 428 typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *); 429 430 int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr, 431 attr__fprintf_f attr__fprintf, void *priv); 432 433 char *perf_evsel__env_arch(struct perf_evsel *evsel); 434 435 #endif /* __PERF_EVSEL_H */ 436