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