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