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