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