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 "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         /* parse modifier helper */
  87         int                     exclude_GH;
  88         int                     nr_members;
  89         int                     sample_read;
  90         struct perf_evsel       *leader;
  91         char                    *group_name;
  92 };
  93
  94 #define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)
  95
  96 struct cpu_map;
  97 struct thread_map;
  98 struct perf_evlist;
  99 struct record_opts;
 100
 101 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
 102
 103 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
 104 {
 105         return perf_evsel__new_idx(attr, 0);
 106 }
 107
 108 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
 109
 110 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
 111 {
 112         return perf_evsel__newtp_idx(sys, name, 0);
 113 }
 114
 115 struct event_format *event_format__new(const char *sys, const char *name);
 116
 117 void perf_evsel__init(struct perf_evsel *evsel,
 118                       struct perf_event_attr *attr, int idx);
 119 void perf_evsel__exit(struct perf_evsel *evsel);
 120 void perf_evsel__delete(struct perf_evsel *evsel);
 121
 122 void perf_evsel__config(struct perf_evsel *evsel,
 123                         struct record_opts *opts);
 124
 125 int __perf_evsel__sample_size(u64 sample_type);
 126 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
 127
 128 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
 129
 130 #define PERF_EVSEL__MAX_ALIASES 8
 131
 132 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
 133                                        [PERF_EVSEL__MAX_ALIASES];
 134 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
 135                                           [PERF_EVSEL__MAX_ALIASES];
 136 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
 137                                               [PERF_EVSEL__MAX_ALIASES];
 138 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
 139 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
 140 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
 141                                             char *bf, size_t size);
 142 const char *perf_evsel__name(struct perf_evsel *evsel);
 143
 144 const char *perf_evsel__group_name(struct perf_evsel *evsel);
 145 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
 146
 147 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
 148 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
 149 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
 150 void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
 151 void perf_evsel__free_fd(struct perf_evsel *evsel);
 152 void perf_evsel__free_id(struct perf_evsel *evsel);
 153 void perf_evsel__free_counts(struct perf_evsel *evsel);
 154 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
 155
 156 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
 157                                   enum perf_event_sample_format bit);
 158 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
 159                                     enum perf_event_sample_format bit);
 160
 161 #define perf_evsel__set_sample_bit(evsel, bit) \
 162         __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
 163
 164 #define perf_evsel__reset_sample_bit(evsel, bit) \
 165         __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
 166
 167 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
 168                                bool use_sample_identifier);
 169
 170 int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
 171                            const char *filter);
 172 int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
 173
 174 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
 175                              struct cpu_map *cpus);
 176 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
 177                                 struct thread_map *threads);
 178 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
 179                      struct thread_map *threads);
 180 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
 181
 182 struct perf_sample;
 183
 184 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
 185                          const char *name);
 186 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
 187                        const char *name);
 188
 189 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
 190                                        struct perf_sample *sample,
 191                                        const char *name)
 192 {
 193         return perf_evsel__rawptr(evsel, sample, name);
 194 }
 195
 196 struct format_field;
 197
 198 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
 199
 200 #define perf_evsel__match(evsel, t, c)          \
 201         (evsel->attr.type == PERF_TYPE_##t &&   \
 202          evsel->attr.config == PERF_COUNT_##c)
 203
 204 static inline bool perf_evsel__match2(struct perf_evsel *e1,
 205                                       struct perf_evsel *e2)
 206 {
 207         return (e1->attr.type == e2->attr.type) &&
 208                (e1->attr.config == e2->attr.config);
 209 }
 210
 211 #define perf_evsel__cmp(a, b)                   \
 212         ((a) &&                                 \
 213          (b) &&                                 \
 214          (a)->attr.type == (b)->attr.type &&    \
 215          (a)->attr.config == (b)->attr.config)
 216
 217 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 218                               int cpu, int thread, bool scale);
 219
 220 /**
 221  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
 222  *
 223  * @evsel - event selector to read value
 224  * @cpu - CPU of interest
 225  * @thread - thread of interest
 226  */
 227 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 228                                           int cpu, int thread)
 229 {
 230         return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
 231 }
 232
 233 /**
 234  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 235  *
 236  * @evsel - event selector to read value
 237  * @cpu - CPU of interest
 238  * @thread - thread of interest
 239  */
 240 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
 241                                                  int cpu, int thread)
 242 {
 243         return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
 244 }
 245
 246 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
 247                        bool scale);
 248
 249 /**
 250  * perf_evsel__read - Read the aggregate results on all CPUs
 251  *
 252  * @evsel - event selector to read value
 253  * @ncpus - Number of cpus affected, from zero
 254  * @nthreads - Number of threads affected, from zero
 255  */
 256 static inline int perf_evsel__read(struct perf_evsel *evsel,
 257                                     int ncpus, int nthreads)
 258 {
 259         return __perf_evsel__read(evsel, ncpus, nthreads, false);
 260 }
 261
 262 /**
 263  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
 264  *
 265  * @evsel - event selector to read value
 266  * @ncpus - Number of cpus affected, from zero
 267  * @nthreads - Number of threads affected, from zero
 268  */
 269 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
 270                                           int ncpus, int nthreads)
 271 {
 272         return __perf_evsel__read(evsel, ncpus, nthreads, true);
 273 }
 274
 275 void hists__init(struct hists *hists);
 276
 277 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
 278                              struct perf_sample *sample);
 279
 280 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
 281 {
 282         return list_entry(evsel->node.next, struct perf_evsel, node);
 283 }
 284
 285 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
 286 {
 287         return list_entry(evsel->node.prev, struct perf_evsel, node);
 288 }
 289
 290 /**
 291  * perf_evsel__is_group_leader - Return whether given evsel is a leader event
 292  *
 293  * @evsel - evsel selector to be tested
 294  *
 295  * Return %true if @evsel is a group leader or a stand-alone event
 296  */
 297 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
 298 {
 299         return evsel->leader == evsel;
 300 }
 301
 302 /**
 303  * perf_evsel__is_group_event - Return whether given evsel is a group event
 304  *
 305  * @evsel - evsel selector to be tested
 306  *
 307  * Return %true iff event group view is enabled and @evsel is a actual group
 308  * leader which has other members in the group
 309  */
 310 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
 311 {
 312         if (!symbol_conf.event_group)
 313                 return false;
 314
 315         return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
 316 }
 317
 318 struct perf_attr_details {
 319         bool freq;
 320         bool verbose;
 321         bool event_group;
 322 };
 323
 324 int perf_evsel__fprintf(struct perf_evsel *evsel,
 325                         struct perf_attr_details *details, FILE *fp);
 326
 327 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
 328                           char *msg, size_t msgsize);
 329 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
 330                               int err, char *msg, size_t size);
 331
 332 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
 333 {
 334         return evsel->idx - evsel->leader->idx;
 335 }
 336
 337 #define for_each_group_member(_evsel, _leader)                                  \
 338 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node);      \
 339      (_evsel) && (_evsel)->leader == (_leader);                                 \
 340      (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
 341
 342 #endif /* __PERF_EVSEL_H */