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