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