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 109 struct perf_missing_features { 110 bool sample_id_all; 111 bool exclude_guest; 112 bool mmap2; 113 bool cloexec; 114 bool clockid; 115 bool clockid_wrong; 116 bool lbr_flags; 117 bool write_backward; 118 bool group_read; 119 bool ksymbol; 120 bool bpf; 121 bool aux_output; 122 bool branch_hw_idx; 123 bool cgroup; 124 }; 125 126 extern struct perf_missing_features perf_missing_features; 127 128 struct perf_cpu_map; 129 struct target; 130 struct thread_map; 131 struct record_opts; 132 133 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel) 134 { 135 return perf_evsel__cpus(&evsel->core); 136 } 137 138 static inline int perf_evsel__nr_cpus(struct evsel *evsel) 139 { 140 return evsel__cpus(evsel)->nr; 141 } 142 143 void perf_counts_values__scale(struct perf_counts_values *count, 144 bool scale, s8 *pscaled); 145 146 void perf_evsel__compute_deltas(struct evsel *evsel, int cpu, int thread, 147 struct perf_counts_values *count); 148 149 int perf_evsel__object_config(size_t object_size, 150 int (*init)(struct evsel *evsel), 151 void (*fini)(struct evsel *evsel)); 152 153 struct evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx); 154 155 static inline struct evsel *evsel__new(struct perf_event_attr *attr) 156 { 157 return perf_evsel__new_idx(attr, 0); 158 } 159 160 struct evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx); 161 162 /* 163 * Returns pointer with encoded error via <linux/err.h> interface. 164 */ 165 static inline struct evsel *perf_evsel__newtp(const char *sys, const char *name) 166 { 167 return perf_evsel__newtp_idx(sys, name, 0); 168 } 169 170 struct evsel *perf_evsel__new_cycles(bool precise); 171 172 struct tep_event *event_format__new(const char *sys, const char *name); 173 174 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx); 175 void perf_evsel__exit(struct evsel *evsel); 176 void evsel__delete(struct evsel *evsel); 177 178 struct callchain_param; 179 180 void perf_evsel__config(struct evsel *evsel, 181 struct record_opts *opts, 182 struct callchain_param *callchain); 183 void perf_evsel__config_callchain(struct evsel *evsel, 184 struct record_opts *opts, 185 struct callchain_param *callchain); 186 187 int __perf_evsel__sample_size(u64 sample_type); 188 void perf_evsel__calc_id_pos(struct evsel *evsel); 189 190 bool perf_evsel__is_cache_op_valid(u8 type, u8 op); 191 192 #define PERF_EVSEL__MAX_ALIASES 8 193 194 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX] 195 [PERF_EVSEL__MAX_ALIASES]; 196 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX] 197 [PERF_EVSEL__MAX_ALIASES]; 198 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX] 199 [PERF_EVSEL__MAX_ALIASES]; 200 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX]; 201 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX]; 202 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, 203 char *bf, size_t size); 204 const char *perf_evsel__name(struct evsel *evsel); 205 206 const char *perf_evsel__group_name(struct evsel *evsel); 207 int perf_evsel__group_desc(struct evsel *evsel, char *buf, size_t size); 208 209 void __perf_evsel__set_sample_bit(struct evsel *evsel, 210 enum perf_event_sample_format bit); 211 void __perf_evsel__reset_sample_bit(struct evsel *evsel, 212 enum perf_event_sample_format bit); 213 214 #define perf_evsel__set_sample_bit(evsel, bit) \ 215 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit) 216 217 #define perf_evsel__reset_sample_bit(evsel, bit) \ 218 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit) 219 220 void perf_evsel__set_sample_id(struct evsel *evsel, 221 bool use_sample_identifier); 222 223 int perf_evsel__set_filter(struct evsel *evsel, const char *filter); 224 int perf_evsel__append_tp_filter(struct evsel *evsel, const char *filter); 225 int perf_evsel__append_addr_filter(struct evsel *evsel, 226 const char *filter); 227 int evsel__enable_cpu(struct evsel *evsel, int cpu); 228 int evsel__enable(struct evsel *evsel); 229 int evsel__disable(struct evsel *evsel); 230 int evsel__disable_cpu(struct evsel *evsel, int cpu); 231 232 int perf_evsel__open_per_cpu(struct evsel *evsel, 233 struct perf_cpu_map *cpus, 234 int cpu); 235 int perf_evsel__open_per_thread(struct evsel *evsel, 236 struct perf_thread_map *threads); 237 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus, 238 struct perf_thread_map *threads); 239 void evsel__close(struct evsel *evsel); 240 241 struct perf_sample; 242 243 void *perf_evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, 244 const char *name); 245 u64 perf_evsel__intval(struct evsel *evsel, struct perf_sample *sample, 246 const char *name); 247 248 static inline char *perf_evsel__strval(struct evsel *evsel, 249 struct perf_sample *sample, 250 const char *name) 251 { 252 return perf_evsel__rawptr(evsel, sample, name); 253 } 254 255 struct tep_format_field; 256 257 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap); 258 259 struct tep_format_field *perf_evsel__field(struct evsel *evsel, const char *name); 260 261 #define perf_evsel__match(evsel, t, c) \ 262 (evsel->core.attr.type == PERF_TYPE_##t && \ 263 evsel->core.attr.config == PERF_COUNT_##c) 264 265 static inline bool perf_evsel__match2(struct evsel *e1, 266 struct evsel *e2) 267 { 268 return (e1->core.attr.type == e2->core.attr.type) && 269 (e1->core.attr.config == e2->core.attr.config); 270 } 271 272 #define perf_evsel__cmp(a, b) \ 273 ((a) && \ 274 (b) && \ 275 (a)->core.attr.type == (b)->core.attr.type && \ 276 (a)->core.attr.config == (b)->core.attr.config) 277 278 int perf_evsel__read_counter(struct evsel *evsel, int cpu, int thread); 279 280 int __perf_evsel__read_on_cpu(struct evsel *evsel, 281 int cpu, int thread, bool scale); 282 283 /** 284 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread 285 * 286 * @evsel - event selector to read value 287 * @cpu - CPU of interest 288 * @thread - thread of interest 289 */ 290 static inline int perf_evsel__read_on_cpu(struct evsel *evsel, 291 int cpu, int thread) 292 { 293 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false); 294 } 295 296 /** 297 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled 298 * 299 * @evsel - event selector to read value 300 * @cpu - CPU of interest 301 * @thread - thread of interest 302 */ 303 static inline int perf_evsel__read_on_cpu_scaled(struct evsel *evsel, 304 int cpu, int thread) 305 { 306 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true); 307 } 308 309 int perf_evsel__parse_sample(struct evsel *evsel, union perf_event *event, 310 struct perf_sample *sample); 311 312 int perf_evsel__parse_sample_timestamp(struct evsel *evsel, 313 union perf_event *event, 314 u64 *timestamp); 315 316 static inline struct evsel *perf_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 *perf_evsel__prev(struct evsel *evsel) 322 { 323 return list_entry(evsel->core.node.prev, struct evsel, core.node); 324 } 325 326 /** 327 * perf_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 perf_evsel__is_group_leader(const struct evsel *evsel) 334 { 335 return evsel->leader == evsel; 336 } 337 338 /** 339 * perf_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 perf_evsel__is_group_event(struct evsel *evsel) 347 { 348 if (!symbol_conf.event_group) 349 return false; 350 351 return perf_evsel__is_group_leader(evsel) && evsel->core.nr_members > 1; 352 } 353 354 bool perf_evsel__is_function_event(struct evsel *evsel); 355 356 static inline bool perf_evsel__is_bpf_output(struct evsel *evsel) 357 { 358 return perf_evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT); 359 } 360 361 static inline bool perf_evsel__is_clock(struct evsel *evsel) 362 { 363 return perf_evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) || 364 perf_evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK); 365 } 366 367 bool perf_evsel__fallback(struct evsel *evsel, int err, 368 char *msg, size_t msgsize); 369 int perf_evsel__open_strerror(struct evsel *evsel, struct target *target, 370 int err, char *msg, size_t size); 371 372 static inline int perf_evsel__group_idx(struct evsel *evsel) 373 { 374 return evsel->idx - evsel->leader->idx; 375 } 376 377 /* Iterates group WITHOUT the leader. */ 378 #define for_each_group_member(_evsel, _leader) \ 379 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \ 380 (_evsel) && (_evsel)->leader == (_leader); \ 381 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 382 383 /* Iterates group WITH the leader. */ 384 #define for_each_group_evsel(_evsel, _leader) \ 385 for ((_evsel) = _leader; \ 386 (_evsel) && (_evsel)->leader == (_leader); \ 387 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node)) 388 389 static inline bool perf_evsel__has_branch_callstack(const struct evsel *evsel) 390 { 391 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK; 392 } 393 394 static inline bool perf_evsel__has_branch_hw_idx(const struct evsel *evsel) 395 { 396 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX; 397 } 398 399 static inline bool evsel__has_callchain(const struct evsel *evsel) 400 { 401 return (evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN) != 0; 402 } 403 404 struct perf_env *perf_evsel__env(struct evsel *evsel); 405 406 int perf_evsel__store_ids(struct evsel *evsel, struct evlist *evlist); 407 #endif /* __PERF_EVSEL_H */ 408