tools/perf/util/evsel.h

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