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
  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
  42 /** struct perf_evsel - event selector
  43  *
  44  * @name - Can be set to retain the original event name passed by the user,
  45  *         so that when showing results in tools such as 'perf stat', we
  46  *         show the name used, not some alias.
  47  */
  48 struct perf_evsel {
  49         struct list_head        node;
  50         struct perf_event_attr  attr;
  51         char                    *filter;
  52         struct xyarray          *fd;
  53         struct xyarray          *sample_id;
  54         u64                     *id;
  55         struct perf_counts      *counts;
  56         struct perf_counts      *prev_raw_counts;
  57         int                     idx;
  58         u32                     ids;
  59         struct hists            hists;
  60         char                    *name;
  61         struct event_format     *tp_format;
  62         union {
  63                 void            *priv;
  64                 off_t           id_offset;
  65         };
  66         struct cgroup_sel       *cgrp;
  67         struct {
  68                 void            *func;
  69                 void            *data;
  70         } handler;
  71         struct cpu_map          *cpus;
  72         unsigned int            sample_size;
  73         bool                    supported;
  74         bool                    needs_swap;
  75         /* parse modifier helper */
  76         int                     exclude_GH;
  77         struct perf_evsel       *leader;
  78         char                    *group_name;
  79 };
  80
  81 struct cpu_map;
  82 struct thread_map;
  83 struct perf_evlist;
  84 struct perf_record_opts;
  85
  86 struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr, int idx);
  87 struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name, int idx);
  88
  89 struct event_format *event_format__new(const char *sys, const char *name);
  90
  91 void perf_evsel__init(struct perf_evsel *evsel,
  92                       struct perf_event_attr *attr, int idx);
  93 void perf_evsel__exit(struct perf_evsel *evsel);
  94 void perf_evsel__delete(struct perf_evsel *evsel);
  95
  96 void perf_evsel__config(struct perf_evsel *evsel,
  97                         struct perf_record_opts *opts);
  98
  99 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
 100
 101 #define PERF_EVSEL__MAX_ALIASES 8
 102
 103 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
 104                                        [PERF_EVSEL__MAX_ALIASES];
 105 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
 106                                           [PERF_EVSEL__MAX_ALIASES];
 107 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
 108                                               [PERF_EVSEL__MAX_ALIASES];
 109 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
 110 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
 111 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
 112                                             char *bf, size_t size);
 113 const char *perf_evsel__name(struct perf_evsel *evsel);
 114
 115 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
 116 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
 117 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
 118 void perf_evsel__free_fd(struct perf_evsel *evsel);
 119 void perf_evsel__free_id(struct perf_evsel *evsel);
 120 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
 121
 122 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
 123                                   enum perf_event_sample_format bit);
 124 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
 125                                     enum perf_event_sample_format bit);
 126
 127 #define perf_evsel__set_sample_bit(evsel, bit) \
 128         __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
 129
 130 #define perf_evsel__reset_sample_bit(evsel, bit) \
 131         __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
 132
 133 void perf_evsel__set_sample_id(struct perf_evsel *evsel);
 134
 135 int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
 136                            const char *filter);
 137
 138 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
 139                              struct cpu_map *cpus);
 140 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
 141                                 struct thread_map *threads);
 142 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
 143                      struct thread_map *threads);
 144 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
 145
 146 struct perf_sample;
 147
 148 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
 149                          const char *name);
 150 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
 151                        const char *name);
 152
 153 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
 154                                        struct perf_sample *sample,
 155                                        const char *name)
 156 {
 157         return perf_evsel__rawptr(evsel, sample, name);
 158 }
 159
 160 struct format_field;
 161
 162 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
 163
 164 #define perf_evsel__match(evsel, t, c)          \
 165         (evsel->attr.type == PERF_TYPE_##t &&   \
 166          evsel->attr.config == PERF_COUNT_##c)
 167
 168 static inline bool perf_evsel__match2(struct perf_evsel *e1,
 169                                       struct perf_evsel *e2)
 170 {
 171         return (e1->attr.type == e2->attr.type) &&
 172                (e1->attr.config == e2->attr.config);
 173 }
 174
 175 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 176                               int cpu, int thread, bool scale);
 177
 178 /**
 179  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
 180  *
 181  * @evsel - event selector to read value
 182  * @cpu - CPU of interest
 183  * @thread - thread of interest
 184  */
 185 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 186                                           int cpu, int thread)
 187 {
 188         return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
 189 }
 190
 191 /**
 192  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 193  *
 194  * @evsel - event selector to read value
 195  * @cpu - CPU of interest
 196  * @thread - thread of interest
 197  */
 198 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
 199                                                  int cpu, int thread)
 200 {
 201         return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
 202 }
 203
 204 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
 205                        bool scale);
 206
 207 /**
 208  * perf_evsel__read - Read the aggregate results on all CPUs
 209  *
 210  * @evsel - event selector to read value
 211  * @ncpus - Number of cpus affected, from zero
 212  * @nthreads - Number of threads affected, from zero
 213  */
 214 static inline int perf_evsel__read(struct perf_evsel *evsel,
 215                                     int ncpus, int nthreads)
 216 {
 217         return __perf_evsel__read(evsel, ncpus, nthreads, false);
 218 }
 219
 220 /**
 221  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
 222  *
 223  * @evsel - event selector to read value
 224  * @ncpus - Number of cpus affected, from zero
 225  * @nthreads - Number of threads affected, from zero
 226  */
 227 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
 228                                           int ncpus, int nthreads)
 229 {
 230         return __perf_evsel__read(evsel, ncpus, nthreads, true);
 231 }
 232
 233 void hists__init(struct hists *hists);
 234
 235 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
 236                              struct perf_sample *sample);
 237
 238 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
 239 {
 240         return list_entry(evsel->node.next, struct perf_evsel, node);
 241 }
 242
 243 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
 244 {
 245         return evsel->leader == evsel;
 246 }
 247
 248 struct perf_attr_details {
 249         bool freq;
 250         bool verbose;
 251 };
 252
 253 int perf_evsel__fprintf(struct perf_evsel *evsel,
 254                         struct perf_attr_details *details, FILE *fp);
 255
 256 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
 257                           char *msg, size_t msgsize);
 258 int perf_evsel__open_strerror(struct perf_evsel *evsel,
 259                               struct perf_target *target,
 260                               int err, char *msg, size_t size);
 261 #endif /* __PERF_EVSEL_H */