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