tools/perf/util/evsel.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __PERF_EVSEL_H
   3 #define __PERF_EVSEL_H 1
   4
   5 #include <linux/list.h>
   6 #include <stdbool.h>
   7 #include <sys/types.h>
   8 #include <linux/perf_event.h>
   9 #include <linux/types.h>
  10 #include <internal/evsel.h>
  11 #include <perf/evsel.h>
  12 #include "symbol_conf.h"
  13 #include <internal/cpumap.h>
  14
  15 /*
  16  * The 'struct perf_evsel_config_term' is used to pass event
  17  * specific configuration data to perf_evsel__config routine.
  18  * It is allocated within event parsing and attached to
  19  * perf_evsel::config_terms list head.
  20 */
  21 enum term_type {
  22         PERF_EVSEL__CONFIG_TERM_PERIOD,
  23         PERF_EVSEL__CONFIG_TERM_FREQ,
  24         PERF_EVSEL__CONFIG_TERM_TIME,
  25         PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
  26         PERF_EVSEL__CONFIG_TERM_STACK_USER,
  27         PERF_EVSEL__CONFIG_TERM_INHERIT,
  28         PERF_EVSEL__CONFIG_TERM_MAX_STACK,
  29         PERF_EVSEL__CONFIG_TERM_MAX_EVENTS,
  30         PERF_EVSEL__CONFIG_TERM_OVERWRITE,
  31         PERF_EVSEL__CONFIG_TERM_DRV_CFG,
  32         PERF_EVSEL__CONFIG_TERM_BRANCH,
  33         PERF_EVSEL__CONFIG_TERM_PERCORE,
  34         PERF_EVSEL__CONFIG_TERM_AUX_OUTPUT,
  35 };
  36
  37 struct perf_evsel_config_term {
  38         struct list_head        list;
  39         enum term_type  type;
  40         union {
  41                 u64     period;
  42                 u64     freq;
  43                 bool    time;
  44                 char    *callgraph;
  45                 char    *drv_cfg;
  46                 u64     stack_user;
  47                 int     max_stack;
  48                 bool    inherit;
  49                 bool    overwrite;
  50                 char    *branch;
  51                 unsigned long max_events;
  52                 bool    percore;
  53                 bool    aux_output;
  54         } val;
  55         bool weak;
  56 };
  57
  58 struct bpf_object;
  59 struct cgroup;
  60 struct perf_counts;
  61 struct perf_stat_evsel;
  62 union perf_event;
  63
  64 typedef int (perf_evsel__sb_cb_t)(union perf_event *event, void *data);
  65
  66 enum perf_tool_event {
  67         PERF_TOOL_NONE          = 0,
  68         PERF_TOOL_DURATION_TIME = 1,
  69 };
  70
  71 /** struct evsel - event selector
  72  *
  73  * @evlist - evlist this evsel is in, if it is in one.
  74  * @core - libperf evsel object
  75  * @name - Can be set to retain the original event name passed by the user,
  76  *         so that when showing results in tools such as 'perf stat', we
  77  *         show the name used, not some alias.
  78  * @id_pos: the position of the event id (PERF_SAMPLE_ID or
  79  *          PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
  80  *          struct perf_record_sample
  81  * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
  82  *          PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
  83  *          is used there is an id sample appended to non-sample events
  84  * @priv:   And what is in its containing unnamed union are tool specific
  85  */
  86 struct evsel {
  87         struct perf_evsel       core;
  88         struct evlist   *evlist;
  89         char                    *filter;
  90         struct perf_counts      *counts;
  91         struct perf_counts      *prev_raw_counts;
  92         int                     idx;
  93         unsigned long           max_events;
  94         unsigned long           nr_events_printed;
  95         char                    *name;
  96         double                  scale;
  97         const char              *unit;
  98         struct tep_event        *tp_format;
  99         off_t                   id_offset;
 100         struct perf_stat_evsel  *stats;
 101         void                    *priv;
 102         u64                     db_id;
 103         struct cgroup           *cgrp;
 104         void                    *handler;
 105         unsigned int            sample_size;
 106         int                     id_pos;
 107         int                     is_pos;
 108         enum perf_tool_event    tool_event;
 109         bool                    uniquified_name;
 110         bool                    snapshot;
 111         bool                    supported;
 112         bool                    needs_swap;
 113         bool                    disabled;
 114         bool                    no_aux_samples;
 115         bool                    immediate;
 116         bool                    tracking;
 117         bool                    per_pkg;
 118         bool                    precise_max;
 119         bool                    ignore_missing_thread;
 120         bool                    forced_leader;
 121         bool                    use_uncore_alias;
 122         /* parse modifier helper */
 123         int                     exclude_GH;
 124         int                     sample_read;
 125         unsigned long           *per_pkg_mask;
 126         struct evsel            *leader;
 127         char                    *group_name;
 128         bool                    cmdline_group_boundary;
 129         struct list_head        config_terms;
 130         struct bpf_object       *bpf_obj;
 131         int                     bpf_fd;
 132         bool                    auto_merge_stats;
 133         bool                    merged_stat;
 134         const char *            metric_expr;
 135         const char *            metric_name;
 136         struct evsel            **metric_events;
 137         struct evsel            *metric_leader;
 138         bool                    collect_stat;
 139         bool                    weak_group;
 140         bool                    percore;
 141         const char              *pmu_name;
 142         struct {
 143                 perf_evsel__sb_cb_t     *cb;
 144                 void                    *data;
 145         } side_band;
 146 };
 147
 148 struct perf_missing_features {
 149         bool sample_id_all;
 150         bool exclude_guest;
 151         bool mmap2;
 152         bool cloexec;
 153         bool clockid;
 154         bool clockid_wrong;
 155         bool lbr_flags;
 156         bool write_backward;
 157         bool group_read;
 158         bool ksymbol;
 159         bool bpf;
 160         bool aux_output;
 161 };
 162
 163 extern struct perf_missing_features perf_missing_features;
 164
 165 struct perf_cpu_map;
 166 struct target;
 167 struct thread_map;
 168 struct record_opts;
 169
 170 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
 171 {
 172         return perf_evsel__cpus(&evsel->core);
 173 }
 174
 175 static inline int perf_evsel__nr_cpus(struct evsel *evsel)
 176 {
 177         return evsel__cpus(evsel)->nr;
 178 }
 179
 180 void perf_counts_values__scale(struct perf_counts_values *count,
 181                                bool scale, s8 *pscaled);
 182
 183 void perf_evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
 184                                 struct perf_counts_values *count);
 185
 186 int perf_evsel__object_config(size_t object_size,
 187                               int (*init)(struct evsel *evsel),
 188                               void (*fini)(struct evsel *evsel));
 189
 190 struct evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
 191
 192 static inline struct evsel *evsel__new(struct perf_event_attr *attr)
 193 {
 194         return perf_evsel__new_idx(attr, 0);
 195 }
 196
 197 struct evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
 198
 199 /*
 200  * Returns pointer with encoded error via <linux/err.h> interface.
 201  */
 202 static inline struct evsel *perf_evsel__newtp(const char *sys, const char *name)
 203 {
 204         return perf_evsel__newtp_idx(sys, name, 0);
 205 }
 206
 207 struct evsel *perf_evsel__new_cycles(bool precise);
 208
 209 struct tep_event *event_format__new(const char *sys, const char *name);
 210
 211 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
 212 void perf_evsel__exit(struct evsel *evsel);
 213 void evsel__delete(struct evsel *evsel);
 214
 215 struct callchain_param;
 216
 217 void perf_evsel__config(struct evsel *evsel,
 218                         struct record_opts *opts,
 219                         struct callchain_param *callchain);
 220 void perf_evsel__config_callchain(struct evsel *evsel,
 221                                   struct record_opts *opts,
 222                                   struct callchain_param *callchain);
 223
 224 int __perf_evsel__sample_size(u64 sample_type);
 225 void perf_evsel__calc_id_pos(struct evsel *evsel);
 226
 227 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
 228
 229 #define PERF_EVSEL__MAX_ALIASES 8
 230
 231 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
 232                                        [PERF_EVSEL__MAX_ALIASES];
 233 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
 234                                           [PERF_EVSEL__MAX_ALIASES];
 235 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
 236                                               [PERF_EVSEL__MAX_ALIASES];
 237 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
 238 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
 239 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
 240                                             char *bf, size_t size);
 241 const char *perf_evsel__name(struct evsel *evsel);
 242
 243 const char *perf_evsel__group_name(struct evsel *evsel);
 244 int perf_evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
 245
 246 void __perf_evsel__set_sample_bit(struct evsel *evsel,
 247                                   enum perf_event_sample_format bit);
 248 void __perf_evsel__reset_sample_bit(struct evsel *evsel,
 249                                     enum perf_event_sample_format bit);
 250
 251 #define perf_evsel__set_sample_bit(evsel, bit) \
 252         __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
 253
 254 #define perf_evsel__reset_sample_bit(evsel, bit) \
 255         __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
 256
 257 void perf_evsel__set_sample_id(struct evsel *evsel,
 258                                bool use_sample_identifier);
 259
 260 int perf_evsel__set_filter(struct evsel *evsel, const char *filter);
 261 int perf_evsel__append_tp_filter(struct evsel *evsel, const char *filter);
 262 int perf_evsel__append_addr_filter(struct evsel *evsel,
 263                                    const char *filter);
 264 int evsel__enable(struct evsel *evsel);
 265 int evsel__disable(struct evsel *evsel);
 266
 267 int perf_evsel__open_per_cpu(struct evsel *evsel,
 268                              struct perf_cpu_map *cpus);
 269 int perf_evsel__open_per_thread(struct evsel *evsel,
 270                                 struct perf_thread_map *threads);
 271 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
 272                 struct perf_thread_map *threads);
 273 void evsel__close(struct evsel *evsel);
 274
 275 struct perf_sample;
 276
 277 void *perf_evsel__rawptr(struct evsel *evsel, struct perf_sample *sample,
 278                          const char *name);
 279 u64 perf_evsel__intval(struct evsel *evsel, struct perf_sample *sample,
 280                        const char *name);
 281
 282 static inline char *perf_evsel__strval(struct evsel *evsel,
 283                                        struct perf_sample *sample,
 284                                        const char *name)
 285 {
 286         return perf_evsel__rawptr(evsel, sample, name);
 287 }
 288
 289 struct tep_format_field;
 290
 291 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
 292
 293 struct tep_format_field *perf_evsel__field(struct evsel *evsel, const char *name);
 294
 295 #define perf_evsel__match(evsel, t, c)          \
 296         (evsel->core.attr.type == PERF_TYPE_##t &&      \
 297          evsel->core.attr.config == PERF_COUNT_##c)
 298
 299 static inline bool perf_evsel__match2(struct evsel *e1,
 300                                       struct evsel *e2)
 301 {
 302         return (e1->core.attr.type == e2->core.attr.type) &&
 303                (e1->core.attr.config == e2->core.attr.config);
 304 }
 305
 306 #define perf_evsel__cmp(a, b)                   \
 307         ((a) &&                                 \
 308          (b) &&                                 \
 309          (a)->core.attr.type == (b)->core.attr.type &&  \
 310          (a)->core.attr.config == (b)->core.attr.config)
 311
 312 int perf_evsel__read_counter(struct evsel *evsel, int cpu, int thread);
 313
 314 int __perf_evsel__read_on_cpu(struct evsel *evsel,
 315                               int cpu, int thread, bool scale);
 316
 317 /**
 318  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
 319  *
 320  * @evsel - event selector to read value
 321  * @cpu - CPU of interest
 322  * @thread - thread of interest
 323  */
 324 static inline int perf_evsel__read_on_cpu(struct evsel *evsel,
 325                                           int cpu, int thread)
 326 {
 327         return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
 328 }
 329
 330 /**
 331  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 332  *
 333  * @evsel - event selector to read value
 334  * @cpu - CPU of interest
 335  * @thread - thread of interest
 336  */
 337 static inline int perf_evsel__read_on_cpu_scaled(struct evsel *evsel,
 338                                                  int cpu, int thread)
 339 {
 340         return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
 341 }
 342
 343 int perf_evsel__parse_sample(struct evsel *evsel, union perf_event *event,
 344                              struct perf_sample *sample);
 345
 346 int perf_evsel__parse_sample_timestamp(struct evsel *evsel,
 347                                        union perf_event *event,
 348                                        u64 *timestamp);
 349
 350 static inline struct evsel *perf_evsel__next(struct evsel *evsel)
 351 {
 352         return list_entry(evsel->core.node.next, struct evsel, core.node);
 353 }
 354
 355 static inline struct evsel *perf_evsel__prev(struct evsel *evsel)
 356 {
 357         return list_entry(evsel->core.node.prev, struct evsel, core.node);
 358 }
 359
 360 /**
 361  * perf_evsel__is_group_leader - Return whether given evsel is a leader event
 362  *
 363  * @evsel - evsel selector to be tested
 364  *
 365  * Return %true if @evsel is a group leader or a stand-alone event
 366  */
 367 static inline bool perf_evsel__is_group_leader(const struct evsel *evsel)
 368 {
 369         return evsel->leader == evsel;
 370 }
 371
 372 /**
 373  * perf_evsel__is_group_event - Return whether given evsel is a group event
 374  *
 375  * @evsel - evsel selector to be tested
 376  *
 377  * Return %true iff event group view is enabled and @evsel is a actual group
 378  * leader which has other members in the group
 379  */
 380 static inline bool perf_evsel__is_group_event(struct evsel *evsel)
 381 {
 382         if (!symbol_conf.event_group)
 383                 return false;
 384
 385         return perf_evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
 386 }
 387
 388 bool perf_evsel__is_function_event(struct evsel *evsel);
 389
 390 static inline bool perf_evsel__is_bpf_output(struct evsel *evsel)
 391 {
 392         return perf_evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
 393 }
 394
 395 static inline bool perf_evsel__is_clock(struct evsel *evsel)
 396 {
 397         return perf_evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
 398                perf_evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
 399 }
 400
 401 bool perf_evsel__fallback(struct evsel *evsel, int err,
 402                           char *msg, size_t msgsize);
 403 int perf_evsel__open_strerror(struct evsel *evsel, struct target *target,
 404                               int err, char *msg, size_t size);
 405
 406 static inline int perf_evsel__group_idx(struct evsel *evsel)
 407 {
 408         return evsel->idx - evsel->leader->idx;
 409 }
 410
 411 /* Iterates group WITHOUT the leader. */
 412 #define for_each_group_member(_evsel, _leader)                                  \
 413 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \
 414      (_evsel) && (_evsel)->leader == (_leader);                                 \
 415      (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
 416
 417 /* Iterates group WITH the leader. */
 418 #define for_each_group_evsel(_evsel, _leader)                                   \
 419 for ((_evsel) = _leader;                                                        \
 420      (_evsel) && (_evsel)->leader == (_leader);                                 \
 421      (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
 422
 423 static inline bool perf_evsel__has_branch_callstack(const struct evsel *evsel)
 424 {
 425         return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
 426 }
 427
 428 static inline bool evsel__has_callchain(const struct evsel *evsel)
 429 {
 430         return (evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN) != 0;
 431 }
 432
 433 struct perf_env *perf_evsel__env(struct evsel *evsel);
 434
 435 int perf_evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
 436 #endif /* __PERF_EVSEL_H */