1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PERF_EVSEL_H 3 #define __PERF_EVSEL_H 1 4 5 #include <linux/list.h> 6 #include <stdbool.h> 7 #include <sys/types.h> 8 #include <linux/perf_event.h> 9 #include <linux/types.h> 10 #include <internal/evsel.h> 11 #include <perf/evsel.h> 12 #include "symbol_conf.h" 13 #include <internal/cpumap.h> 14 15 struct bpf_object; 16 struct cgroup; 17 struct perf_counts; 18 struct perf_stat_evsel; 19 union perf_event; 20 21 typedef int (evsel__sb_cb_t)(union perf_event *event, void *data); 22 23 enum perf_tool_event { 24 PERF_TOOL_NONE = 0, 25 PERF_TOOL_DURATION_TIME = 1, 26 }; 27 28 /** struct evsel - event selector 29 * 30 * @evlist - evlist this evsel is in, if it is in one. 31 * @core - libperf evsel object 32 * @name - Can be set to retain the original event name passed by the user, 33 * so that when showing results in tools such as 'perf stat', we 34 * show the name used, not some alias. 35 * @id_pos: the position of the event id (PERF_SAMPLE_ID or 36 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of 37 * struct perf_record_sample 38 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or 39 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all 40 * is used there is an id sample appended to non-sample events 41 * @priv: And what is in its containing unnamed union are tool specific 42 */ 43 struct evsel { 44 struct perf_evsel core; 45 struct evlist *evlist; 46 off_t id_offset; 47 int idx; 48 int id_pos; 49 int is_pos; 50 unsigned int sample_size; 51 52 /* 53 * These fields can be set in the parse-events code or similar. 54 * Please check evsel__clone() to copy them properly so that 55 * they can be released properly. 56 */ 57 struct { 58 char *name; 59 char *group_name; 60 const char *pmu_name; 61 struct tep_event *tp_format; 62 char *filter; 63 unsigned long max_events; 64 double scale; 65 const char *unit; 66 struct cgroup *cgrp; 67 enum perf_tool_event tool_event; 68 /* parse modifier helper */ 69 int exclude_GH; 70 int sample_read; 71 bool snapshot; 72 bool per_pkg; 73 bool percore; 74 bool precise_max; 75 bool use_uncore_alias; 76 bool is_libpfm_event; 77 bool auto_merge_stats; 78 bool collect_stat; 79 bool weak_group; 80 int bpf_fd; 81 struct bpf_object *bpf_obj; 82 }; 83 84 /* 85 * metric fields are similar, but needs more care as they can have 86 * references to other metric (evsel). 87 */ 88 const char * metric_expr; 89 const char * metric_name; 90 struct evsel **metric_events; 91 struct evsel *metric_leader; 92 93 void *handler; 94 struct perf_counts *counts; 95 struct perf_counts *prev_raw_counts; 96 unsigned long nr_events_printed; 97 struct perf_stat_evsel *stats; 98 void *priv; 99 u64 db_id; 100 bool uniquified_name; 101 bool supported; 102 bool needs_swap; 103 bool disabled; 104 bool no_aux_samples; 105 bool immediate; 106 bool tracking; 107 bool ignore_missing_thread; 108 bool forced_leader; 109 bool cmdline_group_boundary; 110 bool merged_stat; 111 bool reset_group; 112 bool errored; 113 unsigned long *per_pkg_mask; 114 struct evsel *leader; 115 struct list_head config_terms; 116 int err; 117 int cpu_iter; 118 struct { 119 evsel__sb_cb_t *cb; 120 void *data; 121 } side_band; 122 /* 123 * For reporting purposes, an evsel sample can have a callchain 124 * synthesized from AUX area data. Keep track of synthesized sample 125 * types here. Note, the recorded sample_type cannot be changed because 126 * it is needed to continue to parse events. 127 * See also evsel__has_callchain(). 128 */ 129 __u64 synth_sample_type; 130 }; 131 132 struct perf_missing_features { 133 bool sample_id_all; 134 bool exclude_guest; 135 bool mmap2; 136 bool cloexec; 137 bool clockid; 138 bool clockid_wrong; 139 bool lbr_flags; 140 bool write_backward; 141 bool group_read; 142 bool ksymbol; 143 bool bpf; 144 bool aux_output; 145 bool branch_hw_idx; 146 bool cgroup; 147 bool data_page_size; 148 }; 149 150 extern struct perf_missing_features perf_missing_features; 151 152 struct perf_cpu_map; 153 struct target; 154 struct thread_map; 155 struct record_opts; 156 157 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel) 158 { 159 return perf_evsel__cpus(&evsel->core); 160 } 161 162 static inline int evsel__nr_cpus(struct evsel *evsel) 163 { 164 return evsel__cpus(evsel)->nr; 165 } 166 167 void perf_counts_values__scale(struct perf_counts_values *count, 168 bool scale, s8 *pscaled); 169 170 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread, 171 struct perf_counts_values *count); 172 173 int evsel__object_config(size_t object_size, 174 int (*init)(struct evsel *evsel), 175 void (*fini)(struct evsel *evsel)); 176 177 struct perf_pmu *evsel__find_pmu(struct evsel *evsel); 178 bool evsel__is_aux_event(struct evsel *evsel); 179 180 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx); 181 182 static inline struct evsel *evsel__new(struct perf_event_attr *attr) 183 { 184 return evsel__new_idx(attr, 0); 185 } 186 187 struct evsel *evsel__clone(struct evsel *orig); 188 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx); 189 190 /* 191 * Returns pointer with encoded error via <linux/err.h> interface. 192 */ 193 static inline struct evsel *evsel__newtp(const char *sys, const char *name) 194 { 195 return evsel__newtp_idx(sys, name, 0); 196 } 197 198 struct evsel *evsel__new_cycles(bool precise); 199 200 struct tep_event *event_format__new(const char *sys, const char *name); 201 202 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx); 203 void evsel__exit(struct evsel *evsel); 204 void evsel__delete(struct evsel *evsel); 205 206 struct callchain_param; 207 208 void evsel__config(struct evsel *evsel, struct record_opts *opts, 209 struct callchain_param *callchain); 210 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts, 211 struct callchain_param *callchain); 212 213 int __evsel__sample_size(u64 sample_type); 214 void evsel__calc_id_pos(struct evsel *evsel); 215 216 bool evsel__is_cache_op_valid(u8 type, u8 op); 217 218 #define EVSEL__MAX_ALIASES 8 219 220 extern const char *evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES]; 221 extern const char *evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES]; 222 extern const char *evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES]; 223 extern const char *evsel__hw_names[PERF_COUNT_HW_MAX]; 224 extern const char *evsel__sw_names[PERF_COUNT_SW_MAX]; 225 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size); 226 const char *evsel__name(struct evsel *evsel); 227 228 const char *evsel__group_name(struct evsel *evsel); 229 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size); 230 231 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 232 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 233 234 #define evsel__set_sample_bit(evsel, bit) \ 235 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 236 237 #define evsel__reset_sample_bit(evsel, bit) \ 238 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 239 240 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier); 241 242 int evsel__set_filter(struct evsel *evsel, const char *filter); 243 int evsel__append_tp_filter(struct evsel *evsel, const char *filter); 244 int evsel__append_addr_filter(struct evsel *evsel, const char *filter); 245 int evsel__enable_cpu(struct evsel *evsel, int cpu); 246 int evsel__enable(struct evsel *evsel); 247 int evsel__disable(struct evsel *evsel); 248 int evsel__disable_cpu(struct evsel *evsel, int cpu); 249 250 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu); 251 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads); 252 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus, 253 struct perf_thread_map *threads); 254 void evsel__close(struct evsel *evsel); 255 256 struct perf_sample; 257 258 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name); 259 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name); 260 261 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name) 262 { 263 return evsel__rawptr(evsel, sample, name); 264 } 265 266 struct tep_format_field; 267 268 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap); 269 270 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name); 271 272 #define evsel__match(evsel, t, c) \ 273 (evsel->core.attr.type == PERF_TYPE_##t && \ 274 evsel->core.attr.config == PERF_COUNT_##c) 275 276 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2) 277 { 278 return (e1->core.attr.type == e2->core.attr.type) && 279 (e1->core.attr.config == e2->core.attr.config); 280 } 281 282 int evsel__read_counter(struct evsel *evsel, int cpu, int thread); 283 284 int __evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread, bool scale); 285 286 /** 287 * evsel__read_on_cpu - Read out the results on a CPU and thread 288 * 289 * @evsel - event selector to read value 290 * @cpu - CPU of interest 291 * @thread - thread of interest 292 */ 293 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread) 294 { 295 return __evsel__read_on_cpu(evsel, cpu, thread, false); 296 } 297 298 /** 299 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 300 * 301 * @evsel - event selector to read value 302 * @cpu - CPU of interest 303 * @thread - thread of interest 304 */ 305 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu, int thread) 306 { 307 return __evsel__read_on_cpu(evsel, cpu, thread, true); 308 } 309 310 int evsel__parse_sample(struct evsel *evsel, union perf_event *event, 311 struct perf_sample *sample); 312 313 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event, 314 u64 *timestamp); 315 316 static inline struct evsel *evsel__next(struct evsel *evsel) 317 { 318 return list_entry(evsel->core.node.next, struct evsel, core.node); 319 } 320 321 static inline struct evsel *evsel__prev(struct evsel *evsel) 322 { 323 return list_entry(evsel->core.node.prev, struct evsel, core.node); 324 } 325 326 /** 327 * evsel__is_group_leader - Return whether given evsel is a leader event 328 * 329 * @evsel - evsel selector to be tested 330 * 331 * Return %true if @evsel is a group leader or a stand-alone event 332 */ 333 static inline bool evsel__is_group_leader(const struct evsel *evsel) 334 { 335 return evsel->leader == evsel; 336 } 337 338 /** 339 * evsel__is_group_event - Return whether given evsel is a group event 340 * 341 * @evsel - evsel selector to be tested 342 * 343 * Return %true iff event group view is enabled and @evsel is a actual group 344 * leader which has other members in the group 345 */ 346 static inline bool evsel__is_group_event(struct evsel *evsel) 347 { 348 if (!symbol_conf.event_group) 349 return false; 350 351 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1; 352 } 353 354 bool evsel__is_function_event(struct evsel *evsel); 355 356 static inline bool evsel__is_bpf_output(struct evsel *evsel) 357 { 358 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT); 359 } 360 361 static inline bool evsel__is_clock(struct evsel *evsel) 362 { 363 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) || 364 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK); 365 } 366 367 bool evsel__fallback(struct evsel *evsel, int err, char *msg, size_t msgsize); 368 int evsel__open_strerror(struct evsel *evsel, struct target *target, 369 int err, char *msg, size_t size); 370 371 static inline int evsel__group_idx(struct evsel *evsel) 372 { 373 return evsel->idx - evsel->leader->idx; 374 } 375 376 /* Iterates group WITHOUT the leader. */ 377 #define for_each_group_member(_evsel, _leader) \ 378 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \ 379 (_evsel) && (_evsel)->leader == (_leader); \ 380 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 381 382 /* Iterates group WITH the leader. */ 383 #define for_each_group_evsel(_evsel, _leader) \ 384 for ((_evsel) = _leader; \ 385 (_evsel) && (_evsel)->leader == (_leader); \ 386 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 387 388 static inline bool evsel__has_branch_callstack(const struct evsel *evsel) 389 { 390 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 391 } 392 393 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel) 394 { 395 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX; 396 } 397 398 static inline bool evsel__has_callchain(const struct evsel *evsel) 399 { 400 /* 401 * For reporting purposes, an evsel sample can have a recorded callchain 402 * or a callchain synthesized from AUX area data. 403 */ 404 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN || 405 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN; 406 } 407 408 static inline bool evsel__has_br_stack(const struct evsel *evsel) 409 { 410 /* 411 * For reporting purposes, an evsel sample can have a recorded branch 412 * stack or a branch stack synthesized from AUX area data. 413 */ 414 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK || 415 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK; 416 } 417 418 static inline bool evsel__is_dummy_event(struct evsel *evsel) 419 { 420 return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) && 421 (evsel->core.attr.config == PERF_COUNT_SW_DUMMY); 422 } 423 424 struct perf_env *evsel__env(struct evsel *evsel); 425 426 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist); 427 #endif /* __PERF_EVSEL_H */ 428