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         int                     ids;
  57         struct hists            hists;
  58         char                    *name;
  59         union {
  60                 void            *priv;
  61                 off_t           id_offset;
  62         };
  63         struct cgroup_sel       *cgrp;
  64         struct {
  65                 void            *func;
  66                 void            *data;
  67         } handler;
  68         bool                    supported;
  69 };
  70
  71 struct cpu_map;
  72 struct thread_map;
  73 struct perf_evlist;
  74 struct perf_record_opts;
  75
  76 struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr, int idx);
  77 void perf_evsel__init(struct perf_evsel *evsel,
  78                       struct perf_event_attr *attr, int idx);
  79 void perf_evsel__exit(struct perf_evsel *evsel);
  80 void perf_evsel__delete(struct perf_evsel *evsel);
  81
  82 void perf_evsel__config(struct perf_evsel *evsel,
  83                         struct perf_record_opts *opts,
  84                         struct perf_evsel *first);
  85
  86 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
  87
  88 #define PERF_EVSEL__MAX_ALIASES 8
  89
  90 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
  91                                        [PERF_EVSEL__MAX_ALIASES];
  92 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
  93                                           [PERF_EVSEL__MAX_ALIASES];
  94 const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
  95                                        [PERF_EVSEL__MAX_ALIASES];
  96 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
  97                                             char *bf, size_t size);
  98 const char *perf_evsel__name(struct perf_evsel *evsel);
  99
 100 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
 101 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
 102 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
 103 void perf_evsel__free_fd(struct perf_evsel *evsel);
 104 void perf_evsel__free_id(struct perf_evsel *evsel);
 105 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
 106
 107 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
 108                              struct cpu_map *cpus, bool group,
 109                              struct xyarray *group_fds);
 110 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
 111                                 struct thread_map *threads, bool group,
 112                                 struct xyarray *group_fds);
 113 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
 114                      struct thread_map *threads, bool group,
 115                      struct xyarray *group_fds);
 116 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
 117
 118 #define perf_evsel__match(evsel, t, c)          \
 119         (evsel->attr.type == PERF_TYPE_##t &&   \
 120          evsel->attr.config == PERF_COUNT_##c)
 121
 122 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 123                               int cpu, int thread, bool scale);
 124
 125 /**
 126  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
 127  *
 128  * @evsel - event selector to read value
 129  * @cpu - CPU of interest
 130  * @thread - thread of interest
 131  */
 132 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 133                                           int cpu, int thread)
 134 {
 135         return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
 136 }
 137
 138 /**
 139  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 140  *
 141  * @evsel - event selector to read value
 142  * @cpu - CPU of interest
 143  * @thread - thread of interest
 144  */
 145 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
 146                                                  int cpu, int thread)
 147 {
 148         return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
 149 }
 150
 151 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
 152                        bool scale);
 153
 154 /**
 155  * perf_evsel__read - Read the aggregate results on all CPUs
 156  *
 157  * @evsel - event selector to read value
 158  * @ncpus - Number of cpus affected, from zero
 159  * @nthreads - Number of threads affected, from zero
 160  */
 161 static inline int perf_evsel__read(struct perf_evsel *evsel,
 162                                     int ncpus, int nthreads)
 163 {
 164         return __perf_evsel__read(evsel, ncpus, nthreads, false);
 165 }
 166
 167 /**
 168  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
 169  *
 170  * @evsel - event selector to read value
 171  * @ncpus - Number of cpus affected, from zero
 172  * @nthreads - Number of threads affected, from zero
 173  */
 174 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
 175                                           int ncpus, int nthreads)
 176 {
 177         return __perf_evsel__read(evsel, ncpus, nthreads, true);
 178 }
 179
 180 int __perf_evsel__sample_size(u64 sample_type);
 181
 182 static inline int perf_evsel__sample_size(struct perf_evsel *evsel)
 183 {
 184         return __perf_evsel__sample_size(evsel->attr.sample_type);
 185 }
 186
 187 void hists__init(struct hists *hists);
 188
 189 #endif /* __PERF_EVSEL_H */