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