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