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 <linux/types.h>
   9 #include "xyarray.h"
  10 #include "symbol.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         int                     idx;
  40         int                     cpu;
  41         pid_t                   tid;
  42
  43         /* Holds total ID period value for PERF_SAMPLE_READ processing. */
  44         u64                     period;
  45 };
  46
  47 struct cgroup_sel;
  48
  49 /** struct perf_evsel - event selector
  50  *
  51  * @name - Can be set to retain the original event name passed by the user,
  52  *         so that when showing results in tools such as 'perf stat', we
  53  *         show the name used, not some alias.
  54  * @id_pos: the position of the event id (PERF_SAMPLE_ID or
  55  *          PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
  56  *          struct sample_event
  57  * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
  58  *          PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
  59  *          is used there is an id sample appended to non-sample events
  60  * @priv:   And what is in its containing unnamed union are tool specific
  61  */
  62 struct perf_evsel {
  63         struct list_head        node;
  64         struct perf_event_attr  attr;
  65         char                    *filter;
  66         struct xyarray          *fd;
  67         struct xyarray          *sample_id;
  68         u64                     *id;
  69         struct perf_counts      *counts;
  70         struct perf_counts      *prev_raw_counts;
  71         int                     idx;
  72         u32                     ids;
  73         char                    *name;
  74         double                  scale;
  75         const char              *unit;
  76         bool                    snapshot;
  77         struct event_format     *tp_format;
  78         union {
  79                 void            *priv;
  80                 off_t           id_offset;
  81                 u64             db_id;
  82         };
  83         struct cgroup_sel       *cgrp;
  84         void                    *handler;
  85         struct cpu_map          *cpus;
  86         unsigned int            sample_size;
  87         int                     id_pos;
  88         int                     is_pos;
  89         bool                    supported;
  90         bool                    needs_swap;
  91         bool                    no_aux_samples;
  92         bool                    immediate;
  93         bool                    system_wide;
  94         bool                    tracking;
  95         bool                    per_pkg;
  96         unsigned long           *per_pkg_mask;
  97         /* parse modifier helper */
  98         int                     exclude_GH;
  99         int                     nr_members;
 100         int                     sample_read;
 101         struct perf_evsel       *leader;
 102         char                    *group_name;
 103 };
 104
 105 union u64_swap {
 106         u64 val64;
 107         u32 val32[2];
 108 };
 109
 110 struct cpu_map;
 111 struct target;
 112 struct thread_map;
 113 struct perf_evlist;
 114 struct record_opts;
 115
 116 void perf_counts_values__scale(struct perf_counts_values *count,
 117                                bool scale, s8 *pscaled);
 118
 119 void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu,
 120                                 struct perf_counts_values *count);
 121
 122 int perf_evsel__object_config(size_t object_size,
 123                               int (*init)(struct perf_evsel *evsel),
 124                               void (*fini)(struct perf_evsel *evsel));
 125
 126 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
 127
 128 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
 129 {
 130         return perf_evsel__new_idx(attr, 0);
 131 }
 132
 133 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
 134
 135 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
 136 {
 137         return perf_evsel__newtp_idx(sys, name, 0);
 138 }
 139
 140 struct event_format *event_format__new(const char *sys, const char *name);
 141
 142 void perf_evsel__init(struct perf_evsel *evsel,
 143                       struct perf_event_attr *attr, int idx);
 144 void perf_evsel__exit(struct perf_evsel *evsel);
 145 void perf_evsel__delete(struct perf_evsel *evsel);
 146
 147 void perf_evsel__config(struct perf_evsel *evsel,
 148                         struct record_opts *opts);
 149
 150 int __perf_evsel__sample_size(u64 sample_type);
 151 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
 152
 153 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
 154
 155 #define PERF_EVSEL__MAX_ALIASES 8
 156
 157 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
 158                                        [PERF_EVSEL__MAX_ALIASES];
 159 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
 160                                           [PERF_EVSEL__MAX_ALIASES];
 161 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
 162                                               [PERF_EVSEL__MAX_ALIASES];
 163 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
 164 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
 165 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
 166                                             char *bf, size_t size);
 167 const char *perf_evsel__name(struct perf_evsel *evsel);
 168
 169 const char *perf_evsel__group_name(struct perf_evsel *evsel);
 170 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
 171
 172 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
 173 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
 174 void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
 175 void perf_evsel__free_counts(struct perf_evsel *evsel);
 176 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
 177
 178 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
 179                                   enum perf_event_sample_format bit);
 180 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
 181                                     enum perf_event_sample_format bit);
 182
 183 #define perf_evsel__set_sample_bit(evsel, bit) \
 184         __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
 185
 186 #define perf_evsel__reset_sample_bit(evsel, bit) \
 187         __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
 188
 189 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
 190                                bool use_sample_identifier);
 191
 192 int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
 193                            const char *filter);
 194 int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
 195
 196 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
 197                              struct cpu_map *cpus);
 198 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
 199                                 struct thread_map *threads);
 200 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
 201                      struct thread_map *threads);
 202 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
 203
 204 struct perf_sample;
 205
 206 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
 207                          const char *name);
 208 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
 209                        const char *name);
 210
 211 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
 212                                        struct perf_sample *sample,
 213                                        const char *name)
 214 {
 215         return perf_evsel__rawptr(evsel, sample, name);
 216 }
 217
 218 struct format_field;
 219
 220 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
 221
 222 #define perf_evsel__match(evsel, t, c)          \
 223         (evsel->attr.type == PERF_TYPE_##t &&   \
 224          evsel->attr.config == PERF_COUNT_##c)
 225
 226 static inline bool perf_evsel__match2(struct perf_evsel *e1,
 227                                       struct perf_evsel *e2)
 228 {
 229         return (e1->attr.type == e2->attr.type) &&
 230                (e1->attr.config == e2->attr.config);
 231 }
 232
 233 #define perf_evsel__cmp(a, b)                   \
 234         ((a) &&                                 \
 235          (b) &&                                 \
 236          (a)->attr.type == (b)->attr.type &&    \
 237          (a)->attr.config == (b)->attr.config)
 238
 239 typedef int (perf_evsel__read_cb_t)(struct perf_evsel *evsel,
 240                                     int cpu, int thread,
 241                                     struct perf_counts_values *count);
 242
 243 int perf_evsel__read_cb(struct perf_evsel *evsel, int cpu, int thread,
 244                         perf_evsel__read_cb_t cb);
 245
 246 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 247                               int cpu, int thread, bool scale);
 248
 249 /**
 250  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
 251  *
 252  * @evsel - event selector to read value
 253  * @cpu - CPU of interest
 254  * @thread - thread of interest
 255  */
 256 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
 257                                           int cpu, int thread)
 258 {
 259         return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
 260 }
 261
 262 /**
 263  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 264  *
 265  * @evsel - event selector to read value
 266  * @cpu - CPU of interest
 267  * @thread - thread of interest
 268  */
 269 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
 270                                                  int cpu, int thread)
 271 {
 272         return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
 273 }
 274
 275 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
 276                              struct perf_sample *sample);
 277
 278 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
 279 {
 280         return list_entry(evsel->node.next, struct perf_evsel, node);
 281 }
 282
 283 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
 284 {
 285         return list_entry(evsel->node.prev, struct perf_evsel, node);
 286 }
 287
 288 /**
 289  * perf_evsel__is_group_leader - Return whether given evsel is a leader event
 290  *
 291  * @evsel - evsel selector to be tested
 292  *
 293  * Return %true if @evsel is a group leader or a stand-alone event
 294  */
 295 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
 296 {
 297         return evsel->leader == evsel;
 298 }
 299
 300 /**
 301  * perf_evsel__is_group_event - Return whether given evsel is a group event
 302  *
 303  * @evsel - evsel selector to be tested
 304  *
 305  * Return %true iff event group view is enabled and @evsel is a actual group
 306  * leader which has other members in the group
 307  */
 308 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
 309 {
 310         if (!symbol_conf.event_group)
 311                 return false;
 312
 313         return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
 314 }
 315
 316 /**
 317  * perf_evsel__is_function_event - Return whether given evsel is a function
 318  * trace event
 319  *
 320  * @evsel - evsel selector to be tested
 321  *
 322  * Return %true if event is function trace event
 323  */
 324 static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel)
 325 {
 326 #define FUNCTION_EVENT "ftrace:function"
 327
 328         return evsel->name &&
 329                !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
 330
 331 #undef FUNCTION_EVENT
 332 }
 333
 334 struct perf_attr_details {
 335         bool freq;
 336         bool verbose;
 337         bool event_group;
 338 };
 339
 340 int perf_evsel__fprintf(struct perf_evsel *evsel,
 341                         struct perf_attr_details *details, FILE *fp);
 342
 343 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
 344                           char *msg, size_t msgsize);
 345 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
 346                               int err, char *msg, size_t size);
 347
 348 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
 349 {
 350         return evsel->idx - evsel->leader->idx;
 351 }
 352
 353 #define for_each_group_member(_evsel, _leader)                                  \
 354 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node);      \
 355      (_evsel) && (_evsel)->leader == (_leader);                                 \
 356      (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
 357
 358 #endif /* __PERF_EVSEL_H */