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