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