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