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