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