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