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