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