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