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