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 (perf_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 char *filter; 47 struct perf_counts *counts; 48 struct perf_counts *prev_raw_counts; 49 int idx; 50 unsigned long max_events; 51 unsigned long nr_events_printed; 52 char *name; 53 double scale; 54 const char *unit; 55 struct tep_event *tp_format; 56 off_t id_offset; 57 struct perf_stat_evsel *stats; 58 void *priv; 59 u64 db_id; 60 struct cgroup *cgrp; 61 void *handler; 62 unsigned int sample_size; 63 int id_pos; 64 int is_pos; 65 enum perf_tool_event tool_event; 66 bool uniquified_name; 67 bool snapshot; 68 bool supported; 69 bool needs_swap; 70 bool disabled; 71 bool no_aux_samples; 72 bool immediate; 73 bool tracking; 74 bool per_pkg; 75 bool precise_max; 76 bool ignore_missing_thread; 77 bool forced_leader; 78 bool use_uncore_alias; 79 /* parse modifier helper */ 80 int exclude_GH; 81 int sample_read; 82 unsigned long *per_pkg_mask; 83 struct evsel *leader; 84 char *group_name; 85 bool cmdline_group_boundary; 86 struct list_head config_terms; 87 struct bpf_object *bpf_obj; 88 int bpf_fd; 89 int err; 90 bool auto_merge_stats; 91 bool merged_stat; 92 const char * metric_expr; 93 const char * metric_name; 94 struct evsel **metric_events; 95 struct evsel *metric_leader; 96 bool collect_stat; 97 bool weak_group; 98 bool reset_group; 99 bool errored; 100 bool percore; 101 int cpu_iter; 102 const char *pmu_name; 103 struct { 104 perf_evsel__sb_cb_t *cb; 105 void *data; 106 } side_band; 107 /* 108 * For reporting purposes, an evsel sample can have a callchain 109 * synthesized from AUX area data. Keep track of synthesized sample 110 * types here. Note, the recorded sample_type cannot be changed because 111 * it is needed to continue to parse events. 112 * See also evsel__has_callchain(). 113 */ 114 __u64 synth_sample_type; 115 }; 116 117 struct perf_missing_features { 118 bool sample_id_all; 119 bool exclude_guest; 120 bool mmap2; 121 bool cloexec; 122 bool clockid; 123 bool clockid_wrong; 124 bool lbr_flags; 125 bool write_backward; 126 bool group_read; 127 bool ksymbol; 128 bool bpf; 129 bool aux_output; 130 bool branch_hw_idx; 131 bool cgroup; 132 }; 133 134 extern struct perf_missing_features perf_missing_features; 135 136 struct perf_cpu_map; 137 struct target; 138 struct thread_map; 139 struct record_opts; 140 141 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel) 142 { 143 return perf_evsel__cpus(&evsel->core); 144 } 145 146 static inline int perf_evsel__nr_cpus(struct evsel *evsel) 147 { 148 return evsel__cpus(evsel)->nr; 149 } 150 151 void perf_counts_values__scale(struct perf_counts_values *count, 152 bool scale, s8 *pscaled); 153 154 void perf_evsel__compute_deltas(struct evsel *evsel, int cpu, int thread, 155 struct perf_counts_values *count); 156 157 int perf_evsel__object_config(size_t object_size, 158 int (*init)(struct evsel *evsel), 159 void (*fini)(struct evsel *evsel)); 160 161 struct perf_pmu *perf_evsel__find_pmu(struct evsel *evsel); 162 bool perf_evsel__is_aux_event(struct evsel *evsel); 163 164 struct evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx); 165 166 static inline struct evsel *evsel__new(struct perf_event_attr *attr) 167 { 168 return perf_evsel__new_idx(attr, 0); 169 } 170 171 struct evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx); 172 173 /* 174 * Returns pointer with encoded error via <linux/err.h> interface. 175 */ 176 static inline struct evsel *perf_evsel__newtp(const char *sys, const char *name) 177 { 178 return perf_evsel__newtp_idx(sys, name, 0); 179 } 180 181 struct evsel *perf_evsel__new_cycles(bool precise); 182 183 struct tep_event *event_format__new(const char *sys, const char *name); 184 185 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx); 186 void perf_evsel__exit(struct evsel *evsel); 187 void evsel__delete(struct evsel *evsel); 188 189 struct callchain_param; 190 191 void perf_evsel__config(struct evsel *evsel, 192 struct record_opts *opts, 193 struct callchain_param *callchain); 194 void perf_evsel__config_callchain(struct evsel *evsel, 195 struct record_opts *opts, 196 struct callchain_param *callchain); 197 198 int __perf_evsel__sample_size(u64 sample_type); 199 void perf_evsel__calc_id_pos(struct evsel *evsel); 200 201 bool perf_evsel__is_cache_op_valid(u8 type, u8 op); 202 203 #define PERF_EVSEL__MAX_ALIASES 8 204 205 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX] 206 [PERF_EVSEL__MAX_ALIASES]; 207 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX] 208 [PERF_EVSEL__MAX_ALIASES]; 209 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX] 210 [PERF_EVSEL__MAX_ALIASES]; 211 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX]; 212 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX]; 213 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, 214 char *bf, size_t size); 215 const char *perf_evsel__name(struct evsel *evsel); 216 217 const char *perf_evsel__group_name(struct evsel *evsel); 218 int perf_evsel__group_desc(struct evsel *evsel, char *buf, size_t size); 219 220 void __perf_evsel__set_sample_bit(struct evsel *evsel, 221 enum perf_event_sample_format bit); 222 void __perf_evsel__reset_sample_bit(struct evsel *evsel, 223 enum perf_event_sample_format bit); 224 225 #define perf_evsel__set_sample_bit(evsel, bit) \ 226 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 227 228 #define perf_evsel__reset_sample_bit(evsel, bit) \ 229 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 230 231 void perf_evsel__set_sample_id(struct evsel *evsel, 232 bool use_sample_identifier); 233 234 int perf_evsel__set_filter(struct evsel *evsel, const char *filter); 235 int perf_evsel__append_tp_filter(struct evsel *evsel, const char *filter); 236 int perf_evsel__append_addr_filter(struct evsel *evsel, 237 const char *filter); 238 int evsel__enable_cpu(struct evsel *evsel, int cpu); 239 int evsel__enable(struct evsel *evsel); 240 int evsel__disable(struct evsel *evsel); 241 int evsel__disable_cpu(struct evsel *evsel, int cpu); 242 243 int perf_evsel__open_per_cpu(struct evsel *evsel, 244 struct perf_cpu_map *cpus, 245 int cpu); 246 int perf_evsel__open_per_thread(struct evsel *evsel, 247 struct perf_thread_map *threads); 248 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus, 249 struct perf_thread_map *threads); 250 void evsel__close(struct evsel *evsel); 251 252 struct perf_sample; 253 254 void *perf_evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, 255 const char *name); 256 u64 perf_evsel__intval(struct evsel *evsel, struct perf_sample *sample, 257 const char *name); 258 259 static inline char *perf_evsel__strval(struct evsel *evsel, 260 struct perf_sample *sample, 261 const char *name) 262 { 263 return perf_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 *perf_evsel__field(struct evsel *evsel, const char *name); 271 272 #define perf_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 perf_evsel__match2(struct evsel *e1, 277 struct evsel *e2) 278 { 279 return (e1->core.attr.type == e2->core.attr.type) && 280 (e1->core.attr.config == e2->core.attr.config); 281 } 282 283 #define perf_evsel__cmp(a, b) \ 284 ((a) && \ 285 (b) && \ 286 (a)->core.attr.type == (b)->core.attr.type && \ 287 (a)->core.attr.config == (b)->core.attr.config) 288 289 int perf_evsel__read_counter(struct evsel *evsel, int cpu, int thread); 290 291 int __perf_evsel__read_on_cpu(struct evsel *evsel, 292 int cpu, int thread, bool scale); 293 294 /** 295 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread 296 * 297 * @evsel - event selector to read value 298 * @cpu - CPU of interest 299 * @thread - thread of interest 300 */ 301 static inline int perf_evsel__read_on_cpu(struct evsel *evsel, 302 int cpu, int thread) 303 { 304 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false); 305 } 306 307 /** 308 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 309 * 310 * @evsel - event selector to read value 311 * @cpu - CPU of interest 312 * @thread - thread of interest 313 */ 314 static inline int perf_evsel__read_on_cpu_scaled(struct evsel *evsel, 315 int cpu, int thread) 316 { 317 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true); 318 } 319 320 int perf_evsel__parse_sample(struct evsel *evsel, union perf_event *event, 321 struct perf_sample *sample); 322 323 int perf_evsel__parse_sample_timestamp(struct evsel *evsel, 324 union perf_event *event, 325 u64 *timestamp); 326 327 static inline struct evsel *perf_evsel__next(struct evsel *evsel) 328 { 329 return list_entry(evsel->core.node.next, struct evsel, core.node); 330 } 331 332 static inline struct evsel *perf_evsel__prev(struct evsel *evsel) 333 { 334 return list_entry(evsel->core.node.prev, struct evsel, core.node); 335 } 336 337 /** 338 * perf_evsel__is_group_leader - Return whether given evsel is a leader event 339 * 340 * @evsel - evsel selector to be tested 341 * 342 * Return %true if @evsel is a group leader or a stand-alone event 343 */ 344 static inline bool perf_evsel__is_group_leader(const struct evsel *evsel) 345 { 346 return evsel->leader == evsel; 347 } 348 349 /** 350 * perf_evsel__is_group_event - Return whether given evsel is a group event 351 * 352 * @evsel - evsel selector to be tested 353 * 354 * Return %true iff event group view is enabled and @evsel is a actual group 355 * leader which has other members in the group 356 */ 357 static inline bool perf_evsel__is_group_event(struct evsel *evsel) 358 { 359 if (!symbol_conf.event_group) 360 return false; 361 362 return perf_evsel__is_group_leader(evsel) && evsel->core.nr_members > 1; 363 } 364 365 bool perf_evsel__is_function_event(struct evsel *evsel); 366 367 static inline bool perf_evsel__is_bpf_output(struct evsel *evsel) 368 { 369 return perf_evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT); 370 } 371 372 static inline bool perf_evsel__is_clock(struct evsel *evsel) 373 { 374 return perf_evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) || 375 perf_evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK); 376 } 377 378 bool perf_evsel__fallback(struct evsel *evsel, int err, 379 char *msg, size_t msgsize); 380 int perf_evsel__open_strerror(struct evsel *evsel, struct target *target, 381 int err, char *msg, size_t size); 382 383 static inline int perf_evsel__group_idx(struct evsel *evsel) 384 { 385 return evsel->idx - evsel->leader->idx; 386 } 387 388 /* Iterates group WITHOUT the leader. */ 389 #define for_each_group_member(_evsel, _leader) \ 390 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \ 391 (_evsel) && (_evsel)->leader == (_leader); \ 392 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 393 394 /* Iterates group WITH the leader. */ 395 #define for_each_group_evsel(_evsel, _leader) \ 396 for ((_evsel) = _leader; \ 397 (_evsel) && (_evsel)->leader == (_leader); \ 398 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 399 400 static inline bool perf_evsel__has_branch_callstack(const struct evsel *evsel) 401 { 402 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 403 } 404 405 static inline bool perf_evsel__has_branch_hw_idx(const struct evsel *evsel) 406 { 407 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX; 408 } 409 410 static inline bool evsel__has_callchain(const struct evsel *evsel) 411 { 412 /* 413 * For reporting purposes, an evsel sample can have a recorded callchain 414 * or a callchain synthesized from AUX area data. 415 */ 416 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN || 417 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN; 418 } 419 420 struct perf_env *perf_evsel__env(struct evsel *evsel); 421 422 int perf_evsel__store_ids(struct evsel *evsel, struct evlist *evlist); 423 #endif /* __PERF_EVSEL_H */ 424