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 <stddef.h>
   8 #include <linux/perf_event.h>
   9 #include <linux/types.h>
  10 #include "xyarray.h"
  11 #include "symbol_conf.h"
  12 #include "cpumap.h"
  13 #include "counts.h"
  14
  15 struct perf_evsel;
  16
  17 /*
  18  * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
  19  * more than one entry in the evlist.
  20  */
  21 struct perf_sample_id {
  22         struct hlist_node       node;
  23         u64                     id;
  24         struct perf_evsel       *evsel;
  25         int                     idx;
  26         int                     cpu;
  27         pid_t                   tid;
  28
  29         /* Holds total ID period value for PERF_SAMPLE_READ processing. */
  30         u64                     period;
  31 };
  32
  33 struct cgroup;
  34
  35 /*
  36  * The 'struct perf_evsel_config_term' is used to pass event
  37  * specific configuration data to perf_evsel__config routine.
  38  * It is allocated within event parsing and attached to
  39  * perf_evsel::config_terms list head.
  40 */
  41 enum term_type {
  42         PERF_EVSEL__CONFIG_TERM_PERIOD,
  43         PERF_EVSEL__CONFIG_TERM_FREQ,
  44         PERF_EVSEL__CONFIG_TERM_TIME,
  45         PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
  46         PERF_EVSEL__CONFIG_TERM_STACK_USER,
  47         PERF_EVSEL__CONFIG_TERM_INHERIT,
  48         PERF_EVSEL__CONFIG_TERM_MAX_STACK,
  49         PERF_EVSEL__CONFIG_TERM_MAX_EVENTS,
  50         PERF_EVSEL__CONFIG_TERM_OVERWRITE,
  51         PERF_EVSEL__CONFIG_TERM_DRV_CFG,
  52         PERF_EVSEL__CONFIG_TERM_BRANCH,
  53 };
  54
  55 struct perf_evsel_config_term {
  56         struct list_head        list;
  57         enum term_type  type;
  58         union {
  59                 u64     period;
  60                 u64     freq;
  61                 bool    time;
  62                 char    *callgraph;
  63                 char    *drv_cfg;
  64                 u64     stack_user;
  65                 int     max_stack;
  66                 bool    inherit;
  67                 bool    overwrite;
  68                 char    *branch;
  69                 unsigned long max_events;
  70         } val;
  71         bool weak;
  72 };
  73
  74 struct perf_stat_evsel;
  75
  76 typedef int (perf_evsel__sb_cb_t)(union perf_event *event, void *data);
  77
  78 /** struct perf_evsel - event selector
  79  *
  80  * @evlist - evlist this evsel is in, if it is in one.
  81  * @node - To insert it into evlist->entries or in other list_heads, say in
  82  *         the event parsing routines.
  83  * @name - Can be set to retain the original event name passed by the user,
  84  *         so that when showing results in tools such as 'perf stat', we
  85  *         show the name used, not some alias.
  86  * @id_pos: the position of the event id (PERF_SAMPLE_ID or
  87  *          PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
  88  *          struct sample_event
  89  * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
  90  *          PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
  91  *          is used there is an id sample appended to non-sample events
  92  * @priv:   And what is in its containing unnamed union are tool specific
  93  */
  94 struct perf_evsel {
  95         struct list_head        node;
  96         struct perf_evlist      *evlist;
  97         struct perf_event_attr  attr;
  98         char                    *filter;
  99         struct xyarray          *fd;
 100         struct xyarray          *sample_id;
 101         u64                     *id;
 102         struct perf_counts      *counts;
 103         struct perf_counts      *prev_raw_counts;
 104         int                     idx;
 105         u32                     ids;
 106         unsigned long           max_events;
 107         unsigned long           nr_events_printed;
 108         char                    *name;
 109         double                  scale;
 110         const char              *unit;
 111         struct tep_event        *tp_format;
 112         off_t                   id_offset;
 113         struct perf_stat_evsel  *stats;
 114         void                    *priv;
 115         u64                     db_id;
 116         struct cgroup           *cgrp;
 117         void                    *handler;
 118         struct cpu_map          *cpus;
 119         struct cpu_map          *own_cpus;
 120         struct thread_map       *threads;
 121         unsigned int            sample_size;
 122         int                     id_pos;
 123         int                     is_pos;
 124         bool                    uniquified_name;
 125         bool                    snapshot;
 126         bool                    supported;
 127         bool                    needs_swap;
 128         bool                    disabled;
 129         bool                    no_aux_samples;
 130         bool                    immediate;
 131         bool                    system_wide;
 132         bool                    tracking;
 133         bool                    per_pkg;
 134         bool                    precise_max;
 135         bool                    ignore_missing_thread;
 136         bool                    forced_leader;
 137         bool                    use_uncore_alias;
 138         /* parse modifier helper */
 139         int                     exclude_GH;
 140         int                     nr_members;
 141         int                     sample_read;
 142         unsigned long           *per_pkg_mask;
 143         struct perf_evsel       *leader;
 144         char                    *group_name;
 145         bool                    cmdline_group_boundary;
 146         struct list_head        config_terms;
 147         int                     bpf_fd;
 148         bool                    auto_merge_stats;
 149         bool                    merged_stat;
 150         const char *            metric_expr;
 151         const char *            metric_name;
 152         struct perf_evsel       **metric_events;
 153         bool                    collect_stat;
 154         bool                    weak_group;
 155         const char              *pmu_name;
 156         struct {
 157                 perf_evsel__sb_cb_t     *cb;
 158                 void                    *data;
 159         } side_band;
 160 };
 161
 162 union u64_swap {
 163         u64 val64;
 164         u32 val32[2];
 165 };
 166
 167 struct perf_missing_features {
 168         bool sample_id_all;
 169         bool exclude_guest;
 170         bool mmap2;
 171         bool cloexec;
 172         bool clockid;
 173         bool clockid_wrong;
 174         bool lbr_flags;
 175         bool write_backward;
 176         bool group_read;
 177         bool ksymbol;
 178         bool bpf_event;
 179 };
 180
 181 extern struct perf_missing_features perf_missing_features;
 182
 183 struct cpu_map;
 184 struct target;
 185 struct thread_map;
 186 struct record_opts;
 187
 188 static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
 189 {
 190         return evsel->cpus;
 191 }
 192
 193 static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
 194 {
 195         return perf_evsel__cpus(evsel)->nr;
 196 }
 197
 198 void perf_counts_values__scale(struct perf_counts_values *count,
 199                                bool scale, s8 *pscaled);
 200
 201 void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
 202                                 struct perf_counts_values *count);
 203
 204 int perf_evsel__object_config(size_t object_size,
 205                               int (*init)(struct perf_evsel *evsel),
 206                               void (*fini)(struct perf_evsel *evsel));
 207
 208 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
 209
 210 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
 211 {
 212         return perf_evsel__new_idx(attr, 0);
 213 }
 214
 215 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
 216
 217 /*
 218  * Returns pointer with encoded error via <linux/err.h> interface.
 219  */
 220 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
 221 {
 222         return perf_evsel__newtp_idx(sys, name, 0);
 223 }
 224
 225 struct perf_evsel *perf_evsel__new_cycles(bool precise);
 226
 227 struct tep_event *event_format__new(const char *sys, const char *name);
 228
 229 void perf_evsel__init(struct perf_evsel *evsel,
 230                       struct perf_event_attr *attr, int idx);
 231 void perf_evsel__exit(struct perf_evsel *evsel);
 232 void perf_evsel__delete(struct perf_evsel *evsel);
 233
 234 struct callchain_param;
 235
 236 void perf_evsel__config(struct perf_evsel *evsel,
 237                         struct record_opts *opts,
 238                         struct callchain_param *callchain);
 239 void perf_evsel__config_callchain(struct perf_evsel *evsel,
 240                                   struct record_opts *opts,
 241                                   struct callchain_param *callchain);
 242
 243 int __perf_evsel__sample_size(u64 sample_type);
 244 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
 245
 246 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
 247
 248 #define PERF_EVSEL__MAX_ALIASES 8
 249
 250 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
 251                                        [PERF_EVSEL__MAX_ALIASES];
 252 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
 253                                           [PERF_EVSEL__MAX_ALIASES];
 254 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
 255                                               [PERF_EVSEL__MAX_ALIASES];
 256 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
 257 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
 258 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
 259                                             char *bf, size_t size);
 260 const char *perf_evsel__name(struct perf_evsel *evsel);
 261
 262 const char *perf_evsel__group_name(struct perf_evsel *evsel);
 263 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
 264
 265 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
 266 void perf_evsel__close_fd(struct perf_evsel *evsel);
 267
 268 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
 269                                   enum perf_event_sample_format bit);
 270 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
 271                                     enum perf_event_sample_format bit);
 272
 273 #define perf_evsel__set_sample_bit(evsel, bit) \
 274         __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
 275
 276 #define perf_evsel__reset_sample_bit(evsel, bit) \
 277         __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
 278
 279 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
 280                                bool use_sample_identifier);
 281
 282 int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
 283 int perf_evsel__append_tp_filter(struct perf_evsel *evsel, const char *filter);
 284 int perf_evsel__append_addr_filter(struct perf_evsel *evsel,
 285                                    const char *filter);
 286 int perf_evsel__apply_filter(struct perf_evsel *evsel, const char *filter);
 287 int perf_evsel__enable(struct perf_evsel *evsel);
 288 int perf_evsel__disable(struct perf_evsel *evsel);
 289
 290 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
 291                              struct cpu_map *cpus);
 292 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
 293                                 struct thread_map *threads);
 294 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
 295                      struct thread_map *threads);
 296 void perf_evsel__close(struct perf_evsel *evsel);
 297
 298 struct perf_sample;
 299
 300 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
 301                          const char *name);
 302 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
 303                        const char *name);
 304
 305 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
 306                                        struct perf_sample *sample,
 307                                        const char *name)
 308 {
 309         return perf_evsel__rawptr(evsel, sample, name);
 310 }
 311
 312 struct tep_format_field;
 313
 314 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
 315
 316 struct tep_format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
 317
 318 #define perf_evsel__match(evsel, t, c)          \
 319         (evsel->attr.type == PERF_TYPE_##t &&   \
 320          evsel->attr.config == PERF_COUNT_##c)
 321
 322 static inline bool perf_evsel__match2(struct perf_evsel *e1,
 323                                       struct perf_evsel *e2)
 324 {
 325         return (e1->attr.type == e2->attr.type) &&
 326                (e1->attr.config == e2->attr.config);
 327 }
 328
 329 #define perf_evsel__cmp(a, b)                   \
 330         ((a) &&                                 \
 331          (b) &&                                 \
 332          (a)->attr.type == (b)->attr.type &&    \
 333          (a)->attr.config == (b)->attr.config)
 334
 335 int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
 336                      struct perf_counts_values *count);
 337
 338 int perf_evsel__read_counter(struct perf_evsel *evsel, int cpu, int thread);
 339
 340 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 341                               int cpu, int thread, bool scale);
 342
 343 /**
 344  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
 345  *
 346  * @evsel - event selector to read value
 347  * @cpu - CPU of interest
 348  * @thread - thread of interest
 349  */
 350 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 351                                           int cpu, int thread)
 352 {
 353         return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
 354 }
 355
 356 /**
 357  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 358  *
 359  * @evsel - event selector to read value
 360  * @cpu - CPU of interest
 361  * @thread - thread of interest
 362  */
 363 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
 364                                                  int cpu, int thread)
 365 {
 366         return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
 367 }
 368
 369 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
 370                              struct perf_sample *sample);
 371
 372 int perf_evsel__parse_sample_timestamp(struct perf_evsel *evsel,
 373                                        union perf_event *event,
 374                                        u64 *timestamp);
 375
 376 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
 377 {
 378         return list_entry(evsel->node.next, struct perf_evsel, node);
 379 }
 380
 381 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
 382 {
 383         return list_entry(evsel->node.prev, struct perf_evsel, node);
 384 }
 385
 386 /**
 387  * perf_evsel__is_group_leader - Return whether given evsel is a leader event
 388  *
 389  * @evsel - evsel selector to be tested
 390  *
 391  * Return %true if @evsel is a group leader or a stand-alone event
 392  */
 393 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
 394 {
 395         return evsel->leader == evsel;
 396 }
 397
 398 /**
 399  * perf_evsel__is_group_event - Return whether given evsel is a group event
 400  *
 401  * @evsel - evsel selector to be tested
 402  *
 403  * Return %true iff event group view is enabled and @evsel is a actual group
 404  * leader which has other members in the group
 405  */
 406 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
 407 {
 408         if (!symbol_conf.event_group)
 409                 return false;
 410
 411         return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
 412 }
 413
 414 bool perf_evsel__is_function_event(struct perf_evsel *evsel);
 415
 416 static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
 417 {
 418         return perf_evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
 419 }
 420
 421 static inline bool perf_evsel__is_clock(struct perf_evsel *evsel)
 422 {
 423         return perf_evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
 424                perf_evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
 425 }
 426
 427 struct perf_attr_details {
 428         bool freq;
 429         bool verbose;
 430         bool event_group;
 431         bool force;
 432         bool trace_fields;
 433 };
 434
 435 int perf_evsel__fprintf(struct perf_evsel *evsel,
 436                         struct perf_attr_details *details, FILE *fp);
 437
 438 #define EVSEL__PRINT_IP                 (1<<0)
 439 #define EVSEL__PRINT_SYM                (1<<1)
 440 #define EVSEL__PRINT_DSO                (1<<2)
 441 #define EVSEL__PRINT_SYMOFFSET          (1<<3)
 442 #define EVSEL__PRINT_ONELINE            (1<<4)
 443 #define EVSEL__PRINT_SRCLINE            (1<<5)
 444 #define EVSEL__PRINT_UNKNOWN_AS_ADDR    (1<<6)
 445 #define EVSEL__PRINT_CALLCHAIN_ARROW    (1<<7)
 446 #define EVSEL__PRINT_SKIP_IGNORED       (1<<8)
 447
 448 struct callchain_cursor;
 449
 450 int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
 451                               unsigned int print_opts,
 452                               struct callchain_cursor *cursor, FILE *fp);
 453
 454 int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
 455                         int left_alignment, unsigned int print_opts,
 456                         struct callchain_cursor *cursor, FILE *fp);
 457
 458 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
 459                           char *msg, size_t msgsize);
 460 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
 461                               int err, char *msg, size_t size);
 462
 463 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
 464 {
 465         return evsel->idx - evsel->leader->idx;
 466 }
 467
 468 /* Iterates group WITHOUT the leader. */
 469 #define for_each_group_member(_evsel, _leader)                                  \
 470 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node);      \
 471      (_evsel) && (_evsel)->leader == (_leader);                                 \
 472      (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
 473
 474 /* Iterates group WITH the leader. */
 475 #define for_each_group_evsel(_evsel, _leader)                                   \
 476 for ((_evsel) = _leader;                                                        \
 477      (_evsel) && (_evsel)->leader == (_leader);                                 \
 478      (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
 479
 480 static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
 481 {
 482         return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
 483 }
 484
 485 static inline bool evsel__has_callchain(const struct perf_evsel *evsel)
 486 {
 487         return (evsel->attr.sample_type & PERF_SAMPLE_CALLCHAIN) != 0;
 488 }
 489
 490 typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
 491
 492 int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
 493                              attr__fprintf_f attr__fprintf, void *priv);
 494
 495 struct perf_env *perf_evsel__env(struct perf_evsel *evsel);
 496
 497 int perf_evsel__store_ids(struct perf_evsel *evsel, struct perf_evlist *evlist);
 498 #endif /* __PERF_EVSEL_H */