tools/perf/util/evsel.h

   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 "pmus.h"
  14
  15 struct bpf_object;
  16 struct cgroup;
  17 struct perf_counts;
  18 struct perf_stat_evsel;
  19 union perf_event;
  20 struct bpf_counter_ops;
  21 struct target;
  22 struct hashmap;
  23 struct bperf_leader_bpf;
  24 struct bperf_follower_bpf;
  25 struct perf_pmu;
  26
  27 typedef int (evsel__sb_cb_t)(union perf_event *event, void *data);
  28
  29 enum perf_tool_event {
  30         PERF_TOOL_NONE          = 0,
  31         PERF_TOOL_DURATION_TIME = 1,
  32         PERF_TOOL_USER_TIME = 2,
  33         PERF_TOOL_SYSTEM_TIME = 3,
  34
  35         PERF_TOOL_MAX,
  36 };
  37
  38 const char *perf_tool_event__to_str(enum perf_tool_event ev);
  39 enum perf_tool_event perf_tool_event__from_str(const char *str);
  40
  41 #define perf_tool_event__for_each_event(ev)             \
  42         for ((ev) = PERF_TOOL_DURATION_TIME; (ev) < PERF_TOOL_MAX; ev++)
  43
  44 /** struct evsel - event selector
  45  *
  46  * @evlist - evlist this evsel is in, if it is in one.
  47  * @core - libperf evsel object
  48  * @name - Can be set to retain the original event name passed by the user,
  49  *         so that when showing results in tools such as 'perf stat', we
  50  *         show the name used, not some alias.
  51  * @id_pos: the position of the event id (PERF_SAMPLE_ID or
  52  *          PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
  53  *          struct perf_record_sample
  54  * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
  55  *          PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
  56  *          is used there is an id sample appended to non-sample events
  57  * @priv:   And what is in its containing unnamed union are tool specific
  58  */
  59 struct evsel {
  60         struct perf_evsel       core;
  61         struct evlist           *evlist;
  62         off_t                   id_offset;
  63         int                     id_pos;
  64         int                     is_pos;
  65         unsigned int            sample_size;
  66
  67         /*
  68          * These fields can be set in the parse-events code or similar.
  69          * Please check evsel__clone() to copy them properly so that
  70          * they can be released properly.
  71          */
  72         struct {
  73                 char                    *name;
  74                 char                    *group_name;
  75                 const char              *pmu_name;
  76                 const char              *group_pmu_name;
  77 #ifdef HAVE_LIBTRACEEVENT
  78                 struct tep_event        *tp_format;
  79 #endif
  80                 char                    *filter;
  81                 unsigned long           max_events;
  82                 double                  scale;
  83                 const char              *unit;
  84                 struct cgroup           *cgrp;
  85                 const char              *metric_id;
  86                 enum perf_tool_event    tool_event;
  87                 /* parse modifier helper */
  88                 int                     exclude_GH;
  89                 int                     sample_read;
  90                 bool                    snapshot;
  91                 bool                    per_pkg;
  92                 bool                    percore;
  93                 bool                    precise_max;
  94                 bool                    is_libpfm_event;
  95                 bool                    auto_merge_stats;
  96                 bool                    collect_stat;
  97                 bool                    weak_group;
  98                 bool                    bpf_counter;
  99                 bool                    use_config_name;
 100                 bool                    skippable;
 101                 int                     bpf_fd;
 102                 struct bpf_object       *bpf_obj;
 103                 struct list_head        config_terms;
 104         };
 105
 106         /*
 107          * metric fields are similar, but needs more care as they can have
 108          * references to other metric (evsel).
 109          */
 110         struct evsel            **metric_events;
 111         struct evsel            *metric_leader;
 112
 113         void                    *handler;
 114         struct perf_counts      *counts;
 115         struct perf_counts      *prev_raw_counts;
 116         unsigned long           nr_events_printed;
 117         struct perf_stat_evsel  *stats;
 118         void                    *priv;
 119         u64                     db_id;
 120         bool                    uniquified_name;
 121         bool                    supported;
 122         bool                    needs_swap;
 123         bool                    disabled;
 124         bool                    no_aux_samples;
 125         bool                    immediate;
 126         bool                    tracking;
 127         bool                    ignore_missing_thread;
 128         bool                    forced_leader;
 129         bool                    cmdline_group_boundary;
 130         bool                    merged_stat;
 131         bool                    reset_group;
 132         bool                    errored;
 133         bool                    needs_auxtrace_mmap;
 134         bool                    default_metricgroup; /* A member of the Default metricgroup */
 135         struct hashmap          *per_pkg_mask;
 136         int                     err;
 137         struct {
 138                 evsel__sb_cb_t  *cb;
 139                 void            *data;
 140         } side_band;
 141         /*
 142          * For reporting purposes, an evsel sample can have a callchain
 143          * synthesized from AUX area data. Keep track of synthesized sample
 144          * types here. Note, the recorded sample_type cannot be changed because
 145          * it is needed to continue to parse events.
 146          * See also evsel__has_callchain().
 147          */
 148         __u64                   synth_sample_type;
 149
 150         /*
 151          * bpf_counter_ops serves two use cases:
 152          *   1. perf-stat -b          counting events used byBPF programs
 153          *   2. perf-stat --use-bpf   use BPF programs to aggregate counts
 154          */
 155         struct bpf_counter_ops  *bpf_counter_ops;
 156
 157         struct list_head        bpf_counter_list; /* for perf-stat -b */
 158         struct list_head        bpf_filters; /* for perf-record --filter */
 159
 160         /* for perf-stat --use-bpf */
 161         int                     bperf_leader_prog_fd;
 162         int                     bperf_leader_link_fd;
 163         union {
 164                 struct bperf_leader_bpf *leader_skel;
 165                 struct bperf_follower_bpf *follower_skel;
 166                 void *bpf_skel;
 167         };
 168         unsigned long           open_flags;
 169         int                     precise_ip_original;
 170
 171         /* for missing_features */
 172         struct perf_pmu         *pmu;
 173 };
 174
 175 struct perf_missing_features {
 176         bool sample_id_all;
 177         bool exclude_guest;
 178         bool mmap2;
 179         bool cloexec;
 180         bool clockid;
 181         bool clockid_wrong;
 182         bool lbr_flags;
 183         bool write_backward;
 184         bool group_read;
 185         bool ksymbol;
 186         bool bpf;
 187         bool aux_output;
 188         bool branch_hw_idx;
 189         bool cgroup;
 190         bool data_page_size;
 191         bool code_page_size;
 192         bool weight_struct;
 193         bool read_lost;
 194         bool branch_counters;
 195 };
 196
 197 extern struct perf_missing_features perf_missing_features;
 198
 199 struct perf_cpu_map;
 200 struct thread_map;
 201 struct record_opts;
 202
 203 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
 204 {
 205         return perf_evsel__cpus(&evsel->core);
 206 }
 207
 208 static inline int evsel__nr_cpus(struct evsel *evsel)
 209 {
 210         return perf_cpu_map__nr(evsel__cpus(evsel));
 211 }
 212
 213 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
 214                            struct perf_counts_values *count);
 215
 216 int evsel__object_config(size_t object_size,
 217                          int (*init)(struct evsel *evsel),
 218                          void (*fini)(struct evsel *evsel));
 219
 220 struct perf_pmu *evsel__find_pmu(const struct evsel *evsel);
 221 bool evsel__is_aux_event(const struct evsel *evsel);
 222
 223 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);
 224
 225 static inline struct evsel *evsel__new(struct perf_event_attr *attr)
 226 {
 227         return evsel__new_idx(attr, 0);
 228 }
 229
 230 struct evsel *evsel__clone(struct evsel *orig);
 231
 232 int copy_config_terms(struct list_head *dst, struct list_head *src);
 233 void free_config_terms(struct list_head *config_terms);
 234
 235
 236 #ifdef HAVE_LIBTRACEEVENT
 237 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx, bool format);
 238
 239 /*
 240  * Returns pointer with encoded error via <linux/err.h> interface.
 241  */
 242 static inline struct evsel *evsel__newtp(const char *sys, const char *name)
 243 {
 244         return evsel__newtp_idx(sys, name, 0, true);
 245 }
 246 #endif
 247
 248 #ifdef HAVE_LIBTRACEEVENT
 249 struct tep_event *event_format__new(const char *sys, const char *name);
 250 #endif
 251
 252 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
 253 void evsel__exit(struct evsel *evsel);
 254 void evsel__delete(struct evsel *evsel);
 255
 256 struct callchain_param;
 257
 258 void evsel__config(struct evsel *evsel, struct record_opts *opts,
 259                    struct callchain_param *callchain);
 260 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
 261                              struct callchain_param *callchain);
 262
 263 int __evsel__sample_size(u64 sample_type);
 264 void evsel__calc_id_pos(struct evsel *evsel);
 265
 266 bool evsel__is_cache_op_valid(u8 type, u8 op);
 267
 268 static inline bool evsel__is_bpf(struct evsel *evsel)
 269 {
 270         return evsel->bpf_counter_ops != NULL;
 271 }
 272
 273 static inline bool evsel__is_bperf(struct evsel *evsel)
 274 {
 275         return evsel->bpf_counter_ops != NULL && list_empty(&evsel->bpf_counter_list);
 276 }
 277
 278 #define EVSEL__MAX_ALIASES 8
 279
 280 extern const char *const evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES];
 281 extern const char *const evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES];
 282 extern const char *const evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES];
 283 extern const char *const evsel__hw_names[PERF_COUNT_HW_MAX];
 284 extern const char *const evsel__sw_names[PERF_COUNT_SW_MAX];
 285 extern char *evsel__bpf_counter_events;
 286 bool evsel__match_bpf_counter_events(const char *name);
 287 int arch_evsel__hw_name(struct evsel *evsel, char *bf, size_t size);
 288
 289 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size);
 290 const char *evsel__name(struct evsel *evsel);
 291 bool evsel__name_is(struct evsel *evsel, const char *name);
 292 const char *evsel__metric_id(const struct evsel *evsel);
 293
 294 static inline bool evsel__is_tool(const struct evsel *evsel)
 295 {
 296         return evsel->tool_event != PERF_TOOL_NONE;
 297 }
 298
 299 const char *evsel__group_name(struct evsel *evsel);
 300 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
 301
 302 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
 303 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
 304
 305 #define evsel__set_sample_bit(evsel, bit) \
 306         __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
 307
 308 #define evsel__reset_sample_bit(evsel, bit) \
 309         __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
 310
 311 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);
 312
 313 void arch_evsel__set_sample_weight(struct evsel *evsel);
 314 void arch__post_evsel_config(struct evsel *evsel, struct perf_event_attr *attr);
 315 int arch_evsel__open_strerror(struct evsel *evsel, char *msg, size_t size);
 316
 317 int evsel__set_filter(struct evsel *evsel, const char *filter);
 318 int evsel__append_tp_filter(struct evsel *evsel, const char *filter);
 319 int evsel__append_addr_filter(struct evsel *evsel, const char *filter);
 320 int evsel__enable_cpu(struct evsel *evsel, int cpu_map_idx);
 321 int evsel__enable(struct evsel *evsel);
 322 int evsel__disable(struct evsel *evsel);
 323 int evsel__disable_cpu(struct evsel *evsel, int cpu_map_idx);
 324
 325 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu_map_idx);
 326 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);
 327 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
 328                 struct perf_thread_map *threads);
 329 void evsel__close(struct evsel *evsel);
 330 int evsel__prepare_open(struct evsel *evsel, struct perf_cpu_map *cpus,
 331                 struct perf_thread_map *threads);
 332 bool evsel__detect_missing_features(struct evsel *evsel);
 333
 334 bool evsel__precise_ip_fallback(struct evsel *evsel);
 335
 336 struct perf_sample;
 337
 338 #ifdef HAVE_LIBTRACEEVENT
 339 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);
 340 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);
 341 u64 evsel__intval_common(struct evsel *evsel, struct perf_sample *sample, const char *name);
 342 char evsel__taskstate(struct evsel *evsel, struct perf_sample *sample, const char *name);
 343
 344 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)
 345 {
 346         return evsel__rawptr(evsel, sample, name);
 347 }
 348 #endif
 349
 350 struct tep_format_field;
 351
 352 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
 353
 354 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);
 355 struct tep_format_field *evsel__common_field(struct evsel *evsel, const char *name);
 356
 357 static inline bool __evsel__match(const struct evsel *evsel, u32 type, u64 config)
 358 {
 359         if (evsel->core.attr.type != type)
 360                 return false;
 361
 362         if ((type == PERF_TYPE_HARDWARE || type == PERF_TYPE_HW_CACHE)  &&
 363             perf_pmus__supports_extended_type())
 364                 return (evsel->core.attr.config & PERF_HW_EVENT_MASK) == config;
 365
 366         return evsel->core.attr.config == config;
 367 }
 368
 369 #define evsel__match(evsel, t, c) __evsel__match(evsel, PERF_TYPE_##t, PERF_COUNT_##c)
 370
 371 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2)
 372 {
 373         return (e1->core.attr.type == e2->core.attr.type) &&
 374                (e1->core.attr.config == e2->core.attr.config);
 375 }
 376
 377 int evsel__read_counter(struct evsel *evsel, int cpu_map_idx, int thread);
 378
 379 int __evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread, bool scale);
 380
 381 /**
 382  * evsel__read_on_cpu - Read out the results on a CPU and thread
 383  *
 384  * @evsel - event selector to read value
 385  * @cpu_map_idx - CPU of interest
 386  * @thread - thread of interest
 387  */
 388 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread)
 389 {
 390         return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, false);
 391 }
 392
 393 /**
 394  * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 395  *
 396  * @evsel - event selector to read value
 397  * @cpu_map_idx - CPU of interest
 398  * @thread - thread of interest
 399  */
 400 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu_map_idx, int thread)
 401 {
 402         return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, true);
 403 }
 404
 405 int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
 406                         struct perf_sample *sample);
 407
 408 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
 409                                   u64 *timestamp);
 410
 411 u16 evsel__id_hdr_size(struct evsel *evsel);
 412
 413 static inline struct evsel *evsel__next(struct evsel *evsel)
 414 {
 415         return list_entry(evsel->core.node.next, struct evsel, core.node);
 416 }
 417
 418 static inline struct evsel *evsel__prev(struct evsel *evsel)
 419 {
 420         return list_entry(evsel->core.node.prev, struct evsel, core.node);
 421 }
 422
 423 /**
 424  * evsel__is_group_leader - Return whether given evsel is a leader event
 425  *
 426  * @evsel - evsel selector to be tested
 427  *
 428  * Return %true if @evsel is a group leader or a stand-alone event
 429  */
 430 static inline bool evsel__is_group_leader(const struct evsel *evsel)
 431 {
 432         return evsel->core.leader == &evsel->core;
 433 }
 434
 435 /**
 436  * evsel__is_group_event - Return whether given evsel is a group event
 437  *
 438  * @evsel - evsel selector to be tested
 439  *
 440  * Return %true iff event group view is enabled and @evsel is a actual group
 441  * leader which has other members in the group
 442  */
 443 static inline bool evsel__is_group_event(struct evsel *evsel)
 444 {
 445         if (!symbol_conf.event_group)
 446                 return false;
 447
 448         return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
 449 }
 450
 451 bool evsel__is_function_event(struct evsel *evsel);
 452
 453 static inline bool evsel__is_bpf_output(struct evsel *evsel)
 454 {
 455         return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
 456 }
 457
 458 static inline bool evsel__is_clock(const struct evsel *evsel)
 459 {
 460         return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
 461                evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
 462 }
 463
 464 bool evsel__fallback(struct evsel *evsel, struct target *target, int err,
 465                      char *msg, size_t msgsize);
 466 int evsel__open_strerror(struct evsel *evsel, struct target *target,
 467                          int err, char *msg, size_t size);
 468
 469 static inline int evsel__group_idx(struct evsel *evsel)
 470 {
 471         return evsel->core.idx - evsel->core.leader->idx;
 472 }
 473
 474 /* Iterates group WITHOUT the leader. */
 475 #define for_each_group_member_head(_evsel, _leader, _head)                              \
 476 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node);         \
 477         (_evsel) && &(_evsel)->core.node != (_head) &&                                  \
 478         (_evsel)->core.leader == &(_leader)->core;                                      \
 479         (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
 480
 481 #define for_each_group_member(_evsel, _leader)                          \
 482         for_each_group_member_head(_evsel, _leader, &(_leader)->evlist->core.entries)
 483
 484 /* Iterates group WITH the leader. */
 485 #define for_each_group_evsel_head(_evsel, _leader, _head)                               \
 486 for ((_evsel) = _leader;                                                                \
 487         (_evsel) && &(_evsel)->core.node != (_head) &&                                  \
 488         (_evsel)->core.leader == &(_leader)->core;                                      \
 489         (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
 490
 491 #define for_each_group_evsel(_evsel, _leader)                           \
 492         for_each_group_evsel_head(_evsel, _leader, &(_leader)->evlist->core.entries)
 493
 494 static inline bool evsel__has_branch_callstack(const struct evsel *evsel)
 495 {
 496         return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
 497 }
 498
 499 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)
 500 {
 501         return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;
 502 }
 503
 504 static inline bool evsel__has_callchain(const struct evsel *evsel)
 505 {
 506         /*
 507          * For reporting purposes, an evsel sample can have a recorded callchain
 508          * or a callchain synthesized from AUX area data.
 509          */
 510         return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||
 511                evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;
 512 }
 513
 514 static inline bool evsel__has_br_stack(const struct evsel *evsel)
 515 {
 516         /*
 517          * For reporting purposes, an evsel sample can have a recorded branch
 518          * stack or a branch stack synthesized from AUX area data.
 519          */
 520         return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||
 521                evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;
 522 }
 523
 524 static inline bool evsel__is_dummy_event(struct evsel *evsel)
 525 {
 526         return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) &&
 527                (evsel->core.attr.config == PERF_COUNT_SW_DUMMY);
 528 }
 529
 530 struct perf_env *evsel__env(struct evsel *evsel);
 531
 532 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
 533
 534 void evsel__zero_per_pkg(struct evsel *evsel);
 535 bool evsel__is_hybrid(const struct evsel *evsel);
 536 struct evsel *evsel__leader(const struct evsel *evsel);
 537 bool evsel__has_leader(struct evsel *evsel, struct evsel *leader);
 538 bool evsel__is_leader(struct evsel *evsel);
 539 void evsel__set_leader(struct evsel *evsel, struct evsel *leader);
 540 int evsel__source_count(const struct evsel *evsel);
 541 void evsel__remove_from_group(struct evsel *evsel, struct evsel *leader);
 542
 543 bool arch_evsel__must_be_in_group(const struct evsel *evsel);
 544
 545 /*
 546  * Macro to swap the bit-field postition and size.
 547  * Used when,
 548  * - dont need to swap the entire u64 &&
 549  * - when u64 has variable bit-field sizes &&
 550  * - when presented in a host endian which is different
 551  *   than the source endian of the perf.data file
 552  */
 553 #define bitfield_swap(src, pos, size)   \
 554         ((((src) >> (pos)) & ((1ull << (size)) - 1)) << (63 - ((pos) + (size) - 1)))
 555
 556 u64 evsel__bitfield_swap_branch_flags(u64 value);
 557 void evsel__set_config_if_unset(struct perf_pmu *pmu, struct evsel *evsel,
 558                                 const char *config_name, u64 val);
 559
 560 #endif /* __PERF_EVSEL_H */