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