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 14struct 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 */ 20struct 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 32struct 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*/ 40enum { 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 50struct 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 */ 79struct 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 union { 97 void *priv; 98 u64 db_id; 99 }; 100 struct cgroup_sel *cgrp; 101 void *handler; 102 struct cpu_map *cpus; 103 struct cpu_map *own_cpus; 104 struct thread_map *threads; 105 unsigned int sample_size; 106 int id_pos; 107 int is_pos; 108 bool snapshot; 109 bool supported; 110 bool needs_swap; 111 bool no_aux_samples; 112 bool immediate; 113 bool system_wide; 114 bool tracking; 115 bool per_pkg; 116 bool precise_max; 117 /* parse modifier helper */ 118 int exclude_GH; 119 int nr_members; 120 int sample_read; 121 unsigned long *per_pkg_mask; 122 struct perf_evsel *leader; 123 char *group_name; 124 bool cmdline_group_boundary; 125 struct list_head config_terms; 126 int bpf_fd; 127}; 128 129union u64_swap { 130 u64 val64; 131 u32 val32[2]; 132}; 133 134struct cpu_map; 135struct target; 136struct thread_map; 137struct record_opts; 138 139static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel) 140{ 141 return evsel->cpus; 142} 143 144static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel) 145{ 146 return perf_evsel__cpus(evsel)->nr; 147} 148 149void perf_counts_values__scale(struct perf_counts_values *count, 150 bool scale, s8 *pscaled); 151 152void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread, 153 struct perf_counts_values *count); 154 155int perf_evsel__object_config(size_t object_size, 156 int (*init)(struct perf_evsel *evsel), 157 void (*fini)(struct perf_evsel *evsel)); 158 159struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx); 160 161static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr) 162{ 163 return perf_evsel__new_idx(attr, 0); 164} 165 166struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx); 167 168/* 169 * Returns pointer with encoded error via <linux/err.h> interface. 170 */ 171static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name) 172{ 173 return perf_evsel__newtp_idx(sys, name, 0); 174} 175 176struct event_format *event_format__new(const char *sys, const char *name); 177 178void perf_evsel__init(struct perf_evsel *evsel, 179 struct perf_event_attr *attr, int idx); 180void perf_evsel__exit(struct perf_evsel *evsel); 181void perf_evsel__delete(struct perf_evsel *evsel); 182 183void perf_evsel__config(struct perf_evsel *evsel, 184 struct record_opts *opts); 185 186int __perf_evsel__sample_size(u64 sample_type); 187void perf_evsel__calc_id_pos(struct perf_evsel *evsel); 188 189bool perf_evsel__is_cache_op_valid(u8 type, u8 op); 190 191#define PERF_EVSEL__MAX_ALIASES 8 192 193extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX] 194 [PERF_EVSEL__MAX_ALIASES]; 195extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX] 196 [PERF_EVSEL__MAX_ALIASES]; 197extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX] 198 [PERF_EVSEL__MAX_ALIASES]; 199extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX]; 200extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX]; 201int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, 202 char *bf, size_t size); 203const char *perf_evsel__name(struct perf_evsel *evsel); 204 205const char *perf_evsel__group_name(struct perf_evsel *evsel); 206int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size); 207 208int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads); 209void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads); 210 211void __perf_evsel__set_sample_bit(struct perf_evsel *evsel, 212 enum perf_event_sample_format bit); 213void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel, 214 enum perf_event_sample_format bit); 215 216#define perf_evsel__set_sample_bit(evsel, bit) \ 217 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 218 219#define perf_evsel__reset_sample_bit(evsel, bit) \ 220 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 221 222void perf_evsel__set_sample_id(struct perf_evsel *evsel, 223 bool use_sample_identifier); 224 225int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter); 226int perf_evsel__append_filter(struct perf_evsel *evsel, 227 const char *op, const char *filter); 228int perf_evsel__apply_filter(struct perf_evsel *evsel, int ncpus, int nthreads, 229 const char *filter); 230int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads); 231 232int perf_evsel__open_per_cpu(struct perf_evsel *evsel, 233 struct cpu_map *cpus); 234int perf_evsel__open_per_thread(struct perf_evsel *evsel, 235 struct thread_map *threads); 236int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus, 237 struct thread_map *threads); 238void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads); 239 240struct perf_sample; 241 242void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample, 243 const char *name); 244u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample, 245 const char *name); 246 247static inline char *perf_evsel__strval(struct perf_evsel *evsel, 248 struct perf_sample *sample, 249 const char *name) 250{ 251 return perf_evsel__rawptr(evsel, sample, name); 252} 253 254struct format_field; 255 256struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name); 257 258#define perf_evsel__match(evsel, t, c) \ 259 (evsel->attr.type == PERF_TYPE_##t && \ 260 evsel->attr.config == PERF_COUNT_##c) 261 262static inline bool perf_evsel__match2(struct perf_evsel *e1, 263 struct perf_evsel *e2) 264{ 265 return (e1->attr.type == e2->attr.type) && 266 (e1->attr.config == e2->attr.config); 267} 268 269#define perf_evsel__cmp(a, b) \ 270 ((a) && \ 271 (b) && \ 272 (a)->attr.type == (b)->attr.type && \ 273 (a)->attr.config == (b)->attr.config) 274 275int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread, 276 struct perf_counts_values *count); 277 278int __perf_evsel__read_on_cpu(struct perf_evsel *evsel, 279 int cpu, int thread, bool scale); 280 281/** 282 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread 283 * 284 * @evsel - event selector to read value 285 * @cpu - CPU of interest 286 * @thread - thread of interest 287 */ 288static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel, 289 int cpu, int thread) 290{ 291 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false); 292} 293 294/** 295 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 296 * 297 * @evsel - event selector to read value 298 * @cpu - CPU of interest 299 * @thread - thread of interest 300 */ 301static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel, 302 int cpu, int thread) 303{ 304 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true); 305} 306 307int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event, 308 struct perf_sample *sample); 309 310static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel) 311{ 312 return list_entry(evsel->node.next, struct perf_evsel, node); 313} 314 315static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel) 316{ 317 return list_entry(evsel->node.prev, struct perf_evsel, node); 318} 319 320/** 321 * perf_evsel__is_group_leader - Return whether given evsel is a leader event 322 * 323 * @evsel - evsel selector to be tested 324 * 325 * Return %true if @evsel is a group leader or a stand-alone event 326 */ 327static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel) 328{ 329 return evsel->leader == evsel; 330} 331 332/** 333 * perf_evsel__is_group_event - Return whether given evsel is a group event 334 * 335 * @evsel - evsel selector to be tested 336 * 337 * Return %true iff event group view is enabled and @evsel is a actual group 338 * leader which has other members in the group 339 */ 340static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel) 341{ 342 if (!symbol_conf.event_group) 343 return false; 344 345 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1; 346} 347 348/** 349 * perf_evsel__is_function_event - Return whether given evsel is a function 350 * trace event 351 * 352 * @evsel - evsel selector to be tested 353 * 354 * Return %true if event is function trace event 355 */ 356static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel) 357{ 358#define FUNCTION_EVENT "ftrace:function" 359 360 return evsel->name && 361 !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT)); 362 363#undef FUNCTION_EVENT 364} 365 366struct perf_attr_details { 367 bool freq; 368 bool verbose; 369 bool event_group; 370 bool force; 371}; 372 373int perf_evsel__fprintf(struct perf_evsel *evsel, 374 struct perf_attr_details *details, FILE *fp); 375 376bool perf_evsel__fallback(struct perf_evsel *evsel, int err, 377 char *msg, size_t msgsize); 378int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target, 379 int err, char *msg, size_t size); 380 381static inline int perf_evsel__group_idx(struct perf_evsel *evsel) 382{ 383 return evsel->idx - evsel->leader->idx; 384} 385 386#define for_each_group_member(_evsel, _leader) \ 387for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \ 388 (_evsel) && (_evsel)->leader == (_leader); \ 389 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node)) 390 391static inline bool has_branch_callstack(struct perf_evsel *evsel) 392{ 393 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 394} 395 396typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *); 397 398int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr, 399 attr__fprintf_f attr__fprintf, void *priv); 400 401#endif /* __PERF_EVSEL_H */ 402