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