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 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 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 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 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 *evsel__find_pmu(struct evsel *evsel); 162 bool 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 evsel__exit(struct evsel *evsel); 187 void evsel__delete(struct evsel *evsel); 188 189 struct callchain_param; 190 191 void evsel__config(struct evsel *evsel, struct record_opts *opts, 192 struct callchain_param *callchain); 193 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts, 194 struct callchain_param *callchain); 195 196 int __evsel__sample_size(u64 sample_type); 197 void evsel__calc_id_pos(struct evsel *evsel); 198 199 bool evsel__is_cache_op_valid(u8 type, u8 op); 200 201 #define PERF_EVSEL__MAX_ALIASES 8 202 203 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX] 204 [PERF_EVSEL__MAX_ALIASES]; 205 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX] 206 [PERF_EVSEL__MAX_ALIASES]; 207 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX] 208 [PERF_EVSEL__MAX_ALIASES]; 209 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX]; 210 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX]; 211 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size); 212 const char *evsel__name(struct evsel *evsel); 213 214 const char *evsel__group_name(struct evsel *evsel); 215 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size); 216 217 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 218 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit); 219 220 #define evsel__set_sample_bit(evsel, bit) \ 221 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 222 223 #define evsel__reset_sample_bit(evsel, bit) \ 224 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 225 226 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier); 227 228 int evsel__set_filter(struct evsel *evsel, const char *filter); 229 int evsel__append_tp_filter(struct evsel *evsel, const char *filter); 230 int evsel__append_addr_filter(struct evsel *evsel, const char *filter); 231 int evsel__enable_cpu(struct evsel *evsel, int cpu); 232 int evsel__enable(struct evsel *evsel); 233 int evsel__disable(struct evsel *evsel); 234 int evsel__disable_cpu(struct evsel *evsel, int cpu); 235 236 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu); 237 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads); 238 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus, 239 struct perf_thread_map *threads); 240 void evsel__close(struct evsel *evsel); 241 242 struct perf_sample; 243 244 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name); 245 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name); 246 247 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name) 248 { 249 return evsel__rawptr(evsel, sample, name); 250 } 251 252 struct tep_format_field; 253 254 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap); 255 256 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name); 257 258 #define evsel__match(evsel, t, c) \ 259 (evsel->core.attr.type == PERF_TYPE_##t && \ 260 evsel->core.attr.config == PERF_COUNT_##c) 261 262 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2) 263 { 264 return (e1->core.attr.type == e2->core.attr.type) && 265 (e1->core.attr.config == e2->core.attr.config); 266 } 267 268 int evsel__read_counter(struct evsel *evsel, int cpu, int thread); 269 270 int __evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread, bool scale); 271 272 /** 273 * evsel__read_on_cpu - Read out the results on a CPU and thread 274 * 275 * @evsel - event selector to read value 276 * @cpu - CPU of interest 277 * @thread - thread of interest 278 */ 279 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread) 280 { 281 return __evsel__read_on_cpu(evsel, cpu, thread, false); 282 } 283 284 /** 285 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 286 * 287 * @evsel - event selector to read value 288 * @cpu - CPU of interest 289 * @thread - thread of interest 290 */ 291 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu, int thread) 292 { 293 return __evsel__read_on_cpu(evsel, cpu, thread, true); 294 } 295 296 int evsel__parse_sample(struct evsel *evsel, union perf_event *event, 297 struct perf_sample *sample); 298 299 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event, 300 u64 *timestamp); 301 302 static inline struct evsel *evsel__next(struct evsel *evsel) 303 { 304 return list_entry(evsel->core.node.next, struct evsel, core.node); 305 } 306 307 static inline struct evsel *evsel__prev(struct evsel *evsel) 308 { 309 return list_entry(evsel->core.node.prev, struct evsel, core.node); 310 } 311 312 /** 313 * evsel__is_group_leader - Return whether given evsel is a leader event 314 * 315 * @evsel - evsel selector to be tested 316 * 317 * Return %true if @evsel is a group leader or a stand-alone event 318 */ 319 static inline bool evsel__is_group_leader(const struct evsel *evsel) 320 { 321 return evsel->leader == evsel; 322 } 323 324 /** 325 * evsel__is_group_event - Return whether given evsel is a group event 326 * 327 * @evsel - evsel selector to be tested 328 * 329 * Return %true iff event group view is enabled and @evsel is a actual group 330 * leader which has other members in the group 331 */ 332 static inline bool evsel__is_group_event(struct evsel *evsel) 333 { 334 if (!symbol_conf.event_group) 335 return false; 336 337 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1; 338 } 339 340 bool evsel__is_function_event(struct evsel *evsel); 341 342 static inline bool evsel__is_bpf_output(struct evsel *evsel) 343 { 344 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT); 345 } 346 347 static inline bool evsel__is_clock(struct evsel *evsel) 348 { 349 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) || 350 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK); 351 } 352 353 bool evsel__fallback(struct evsel *evsel, int err, char *msg, size_t msgsize); 354 int evsel__open_strerror(struct evsel *evsel, struct target *target, 355 int err, char *msg, size_t size); 356 357 static inline int evsel__group_idx(struct evsel *evsel) 358 { 359 return evsel->idx - evsel->leader->idx; 360 } 361 362 /* Iterates group WITHOUT the leader. */ 363 #define for_each_group_member(_evsel, _leader) \ 364 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \ 365 (_evsel) && (_evsel)->leader == (_leader); \ 366 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 367 368 /* Iterates group WITH the leader. */ 369 #define for_each_group_evsel(_evsel, _leader) \ 370 for ((_evsel) = _leader; \ 371 (_evsel) && (_evsel)->leader == (_leader); \ 372 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 373 374 static inline bool evsel__has_branch_callstack(const struct evsel *evsel) 375 { 376 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 377 } 378 379 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel) 380 { 381 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX; 382 } 383 384 static inline bool evsel__has_callchain(const struct evsel *evsel) 385 { 386 /* 387 * For reporting purposes, an evsel sample can have a recorded callchain 388 * or a callchain synthesized from AUX area data. 389 */ 390 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN || 391 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN; 392 } 393 394 static inline bool evsel__has_br_stack(const struct evsel *evsel) 395 { 396 /* 397 * For reporting purposes, an evsel sample can have a recorded branch 398 * stack or a branch stack synthesized from AUX area data. 399 */ 400 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK || 401 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK; 402 } 403 404 struct perf_env *evsel__env(struct evsel *evsel); 405 406 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist); 407 #endif /* __PERF_EVSEL_H */ 408