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