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