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