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 bool auto_merge_stats; 90 bool merged_stat; 91 const char * metric_expr; 92 const char * metric_name; 93 struct evsel **metric_events; 94 struct evsel *metric_leader; 95 bool collect_stat; 96 bool weak_group; 97 bool percore; 98 const char *pmu_name; 99 struct { 100 perf_evsel__sb_cb_t *cb; 101 void *data; 102 } side_band; 103 }; 104 105 struct perf_missing_features { 106 bool sample_id_all; 107 bool exclude_guest; 108 bool mmap2; 109 bool cloexec; 110 bool clockid; 111 bool clockid_wrong; 112 bool lbr_flags; 113 bool write_backward; 114 bool group_read; 115 bool ksymbol; 116 bool bpf; 117 bool aux_output; 118 }; 119 120 extern struct perf_missing_features perf_missing_features; 121 122 struct perf_cpu_map; 123 struct target; 124 struct thread_map; 125 struct record_opts; 126 127 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel) 128 { 129 return perf_evsel__cpus(&evsel->core); 130 } 131 132 static inline int perf_evsel__nr_cpus(struct evsel *evsel) 133 { 134 return evsel__cpus(evsel)->nr; 135 } 136 137 void perf_counts_values__scale(struct perf_counts_values *count, 138 bool scale, s8 *pscaled); 139 140 void perf_evsel__compute_deltas(struct evsel *evsel, int cpu, int thread, 141 struct perf_counts_values *count); 142 143 int perf_evsel__object_config(size_t object_size, 144 int (*init)(struct evsel *evsel), 145 void (*fini)(struct evsel *evsel)); 146 147 struct evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx); 148 149 static inline struct evsel *evsel__new(struct perf_event_attr *attr) 150 { 151 return perf_evsel__new_idx(attr, 0); 152 } 153 154 struct evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx); 155 156 /* 157 * Returns pointer with encoded error via <linux/err.h> interface. 158 */ 159 static inline struct evsel *perf_evsel__newtp(const char *sys, const char *name) 160 { 161 return perf_evsel__newtp_idx(sys, name, 0); 162 } 163 164 struct evsel *perf_evsel__new_cycles(bool precise); 165 166 struct tep_event *event_format__new(const char *sys, const char *name); 167 168 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx); 169 void perf_evsel__exit(struct evsel *evsel); 170 void evsel__delete(struct evsel *evsel); 171 172 struct callchain_param; 173 174 void perf_evsel__config(struct evsel *evsel, 175 struct record_opts *opts, 176 struct callchain_param *callchain); 177 void perf_evsel__config_callchain(struct evsel *evsel, 178 struct record_opts *opts, 179 struct callchain_param *callchain); 180 181 int __perf_evsel__sample_size(u64 sample_type); 182 void perf_evsel__calc_id_pos(struct evsel *evsel); 183 184 bool perf_evsel__is_cache_op_valid(u8 type, u8 op); 185 186 #define PERF_EVSEL__MAX_ALIASES 8 187 188 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX] 189 [PERF_EVSEL__MAX_ALIASES]; 190 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX] 191 [PERF_EVSEL__MAX_ALIASES]; 192 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX] 193 [PERF_EVSEL__MAX_ALIASES]; 194 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX]; 195 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX]; 196 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, 197 char *bf, size_t size); 198 const char *perf_evsel__name(struct evsel *evsel); 199 200 const char *perf_evsel__group_name(struct evsel *evsel); 201 int perf_evsel__group_desc(struct evsel *evsel, char *buf, size_t size); 202 203 void __perf_evsel__set_sample_bit(struct evsel *evsel, 204 enum perf_event_sample_format bit); 205 void __perf_evsel__reset_sample_bit(struct evsel *evsel, 206 enum perf_event_sample_format bit); 207 208 #define perf_evsel__set_sample_bit(evsel, bit) \ 209 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 210 211 #define perf_evsel__reset_sample_bit(evsel, bit) \ 212 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 213 214 void perf_evsel__set_sample_id(struct evsel *evsel, 215 bool use_sample_identifier); 216 217 int perf_evsel__set_filter(struct evsel *evsel, const char *filter); 218 int perf_evsel__append_tp_filter(struct evsel *evsel, const char *filter); 219 int perf_evsel__append_addr_filter(struct evsel *evsel, 220 const char *filter); 221 int evsel__enable(struct evsel *evsel); 222 int evsel__disable(struct evsel *evsel); 223 224 int perf_evsel__open_per_cpu(struct evsel *evsel, 225 struct perf_cpu_map *cpus); 226 int perf_evsel__open_per_thread(struct evsel *evsel, 227 struct perf_thread_map *threads); 228 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus, 229 struct perf_thread_map *threads); 230 void evsel__close(struct evsel *evsel); 231 232 struct perf_sample; 233 234 void *perf_evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, 235 const char *name); 236 u64 perf_evsel__intval(struct evsel *evsel, struct perf_sample *sample, 237 const char *name); 238 239 static inline char *perf_evsel__strval(struct evsel *evsel, 240 struct perf_sample *sample, 241 const char *name) 242 { 243 return perf_evsel__rawptr(evsel, sample, name); 244 } 245 246 struct tep_format_field; 247 248 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap); 249 250 struct tep_format_field *perf_evsel__field(struct evsel *evsel, const char *name); 251 252 #define perf_evsel__match(evsel, t, c) \ 253 (evsel->core.attr.type == PERF_TYPE_##t && \ 254 evsel->core.attr.config == PERF_COUNT_##c) 255 256 static inline bool perf_evsel__match2(struct evsel *e1, 257 struct evsel *e2) 258 { 259 return (e1->core.attr.type == e2->core.attr.type) && 260 (e1->core.attr.config == e2->core.attr.config); 261 } 262 263 #define perf_evsel__cmp(a, b) \ 264 ((a) && \ 265 (b) && \ 266 (a)->core.attr.type == (b)->core.attr.type && \ 267 (a)->core.attr.config == (b)->core.attr.config) 268 269 int perf_evsel__read_counter(struct evsel *evsel, int cpu, int thread); 270 271 int __perf_evsel__read_on_cpu(struct 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 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 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 evsel *evsel, union perf_event *event, 301 struct perf_sample *sample); 302 303 int perf_evsel__parse_sample_timestamp(struct evsel *evsel, 304 union perf_event *event, 305 u64 *timestamp); 306 307 static inline struct evsel *perf_evsel__next(struct evsel *evsel) 308 { 309 return list_entry(evsel->core.node.next, struct evsel, core.node); 310 } 311 312 static inline struct evsel *perf_evsel__prev(struct evsel *evsel) 313 { 314 return list_entry(evsel->core.node.prev, struct evsel, core.node); 315 } 316 317 /** 318 * perf_evsel__is_group_leader - Return whether given evsel is a leader event 319 * 320 * @evsel - evsel selector to be tested 321 * 322 * Return %true if @evsel is a group leader or a stand-alone event 323 */ 324 static inline bool perf_evsel__is_group_leader(const struct evsel *evsel) 325 { 326 return evsel->leader == evsel; 327 } 328 329 /** 330 * perf_evsel__is_group_event - Return whether given evsel is a group event 331 * 332 * @evsel - evsel selector to be tested 333 * 334 * Return %true iff event group view is enabled and @evsel is a actual group 335 * leader which has other members in the group 336 */ 337 static inline bool perf_evsel__is_group_event(struct evsel *evsel) 338 { 339 if (!symbol_conf.event_group) 340 return false; 341 342 return perf_evsel__is_group_leader(evsel) && evsel->core.nr_members > 1; 343 } 344 345 bool perf_evsel__is_function_event(struct evsel *evsel); 346 347 static inline bool perf_evsel__is_bpf_output(struct evsel *evsel) 348 { 349 return perf_evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT); 350 } 351 352 static inline bool perf_evsel__is_clock(struct evsel *evsel) 353 { 354 return perf_evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) || 355 perf_evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK); 356 } 357 358 bool perf_evsel__fallback(struct evsel *evsel, int err, 359 char *msg, size_t msgsize); 360 int perf_evsel__open_strerror(struct evsel *evsel, struct target *target, 361 int err, char *msg, size_t size); 362 363 static inline int perf_evsel__group_idx(struct evsel *evsel) 364 { 365 return evsel->idx - evsel->leader->idx; 366 } 367 368 /* Iterates group WITHOUT the leader. */ 369 #define for_each_group_member(_evsel, _leader) \ 370 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \ 371 (_evsel) && (_evsel)->leader == (_leader); \ 372 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 373 374 /* Iterates group WITH the leader. */ 375 #define for_each_group_evsel(_evsel, _leader) \ 376 for ((_evsel) = _leader; \ 377 (_evsel) && (_evsel)->leader == (_leader); \ 378 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 379 380 static inline bool perf_evsel__has_branch_callstack(const struct evsel *evsel) 381 { 382 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 383 } 384 385 static inline bool evsel__has_callchain(const struct evsel *evsel) 386 { 387 return (evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN) != 0; 388 } 389 390 struct perf_env *perf_evsel__env(struct evsel *evsel); 391 392 int perf_evsel__store_ids(struct evsel *evsel, struct evlist *evlist); 393 #endif /* __PERF_EVSEL_H */ 394