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