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 struct bpf_object;
  16 struct cgroup;
  17 struct perf_counts;
  18 struct perf_stat_evsel;
  19 union perf_event;
  20 struct bpf_counter_ops;
  21 struct target;
  22 struct hashmap;
  23 struct bperf_leader_bpf;
  24 struct bperf_follower_bpf;
  25
  26 typedef int (evsel__sb_cb_t)(union perf_event *event, void *data);
  27
  28 enum perf_tool_event {
  29         PERF_TOOL_NONE          = 0,
  30         PERF_TOOL_DURATION_TIME = 1,
  31 };
  32
  33 /** struct evsel - event selector
  34  *
  35  * @evlist - evlist this evsel is in, if it is in one.
  36  * @core - libperf evsel object
  37  * @name - Can be set to retain the original event name passed by the user,
  38  *         so that when showing results in tools such as 'perf stat', we
  39  *         show the name used, not some alias.
  40  * @id_pos: the position of the event id (PERF_SAMPLE_ID or
  41  *          PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
  42  *          struct perf_record_sample
  43  * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
  44  *          PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
  45  *          is used there is an id sample appended to non-sample events
  46  * @priv:   And what is in its containing unnamed union are tool specific
  47  */
  48 struct evsel {
  49         struct perf_evsel       core;
  50         struct evlist           *evlist;
  51         off_t                   id_offset;
  52         int                     idx;
  53         int                     id_pos;
  54         int                     is_pos;
  55         unsigned int            sample_size;
  56
  57         /*
  58          * These fields can be set in the parse-events code or similar.
  59          * Please check evsel__clone() to copy them properly so that
  60          * they can be released properly.
  61          */
  62         struct {
  63                 char                    *name;
  64                 char                    *group_name;
  65                 const char              *pmu_name;
  66                 struct tep_event        *tp_format;
  67                 char                    *filter;
  68                 unsigned long           max_events;
  69                 double                  scale;
  70                 const char              *unit;
  71                 struct cgroup           *cgrp;
  72                 enum perf_tool_event    tool_event;
  73                 /* parse modifier helper */
  74                 int                     exclude_GH;
  75                 int                     sample_read;
  76                 bool                    snapshot;
  77                 bool                    per_pkg;
  78                 bool                    percore;
  79                 bool                    precise_max;
  80                 bool                    use_uncore_alias;
  81                 bool                    is_libpfm_event;
  82                 bool                    auto_merge_stats;
  83                 bool                    collect_stat;
  84                 bool                    weak_group;
  85                 bool                    bpf_counter;
  86                 bool                    use_config_name;
  87                 int                     bpf_fd;
  88                 struct bpf_object       *bpf_obj;
  89                 struct list_head        config_terms;
  90         };
  91
  92         /*
  93          * metric fields are similar, but needs more care as they can have
  94          * references to other metric (evsel).
  95          */
  96         const char *            metric_expr;
  97         const char *            metric_name;
  98         struct evsel            **metric_events;
  99         struct evsel            *metric_leader;
 100
 101         void                    *handler;
 102         struct perf_counts      *counts;
 103         struct perf_counts      *prev_raw_counts;
 104         unsigned long           nr_events_printed;
 105         struct perf_stat_evsel  *stats;
 106         void                    *priv;
 107         u64                     db_id;
 108         bool                    uniquified_name;
 109         bool                    supported;
 110         bool                    needs_swap;
 111         bool                    disabled;
 112         bool                    no_aux_samples;
 113         bool                    immediate;
 114         bool                    tracking;
 115         bool                    ignore_missing_thread;
 116         bool                    forced_leader;
 117         bool                    cmdline_group_boundary;
 118         bool                    merged_stat;
 119         bool                    reset_group;
 120         bool                    errored;
 121         struct hashmap          *per_pkg_mask;
 122         struct evsel            *leader;
 123         int                     err;
 124         int                     cpu_iter;
 125         struct {
 126                 evsel__sb_cb_t  *cb;
 127                 void            *data;
 128         } side_band;
 129         /*
 130          * For reporting purposes, an evsel sample can have a callchain
 131          * synthesized from AUX area data. Keep track of synthesized sample
 132          * types here. Note, the recorded sample_type cannot be changed because
 133          * it is needed to continue to parse events.
 134          * See also evsel__has_callchain().
 135          */
 136         __u64                   synth_sample_type;
 137
 138         /*
 139          * bpf_counter_ops serves two use cases:
 140          *   1. perf-stat -b          counting events used byBPF programs
 141          *   2. perf-stat --use-bpf   use BPF programs to aggregate counts
 142          */
 143         struct bpf_counter_ops  *bpf_counter_ops;
 144
 145         /* for perf-stat -b */
 146         struct list_head        bpf_counter_list;
 147
 148         /* for perf-stat --use-bpf */
 149         int                     bperf_leader_prog_fd;
 150         int                     bperf_leader_link_fd;
 151         union {
 152                 struct bperf_leader_bpf *leader_skel;
 153                 struct bperf_follower_bpf *follower_skel;
 154         };
 155 };
 156
 157 struct perf_missing_features {
 158         bool sample_id_all;
 159         bool exclude_guest;
 160         bool mmap2;
 161         bool cloexec;
 162         bool clockid;
 163         bool clockid_wrong;
 164         bool lbr_flags;
 165         bool write_backward;
 166         bool group_read;
 167         bool ksymbol;
 168         bool bpf;
 169         bool aux_output;
 170         bool branch_hw_idx;
 171         bool cgroup;
 172         bool data_page_size;
 173         bool code_page_size;
 174         bool weight_struct;
 175 };
 176
 177 extern struct perf_missing_features perf_missing_features;
 178
 179 struct perf_cpu_map;
 180 struct thread_map;
 181 struct record_opts;
 182
 183 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
 184 {
 185         return perf_evsel__cpus(&evsel->core);
 186 }
 187
 188 static inline int evsel__nr_cpus(struct evsel *evsel)
 189 {
 190         return evsel__cpus(evsel)->nr;
 191 }
 192
 193 void perf_counts_values__scale(struct perf_counts_values *count,
 194                                bool scale, s8 *pscaled);
 195
 196 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
 197                            struct perf_counts_values *count);
 198
 199 int evsel__object_config(size_t object_size,
 200                          int (*init)(struct evsel *evsel),
 201                          void (*fini)(struct evsel *evsel));
 202
 203 struct perf_pmu *evsel__find_pmu(struct evsel *evsel);
 204 bool evsel__is_aux_event(struct evsel *evsel);
 205
 206 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);
 207
 208 static inline struct evsel *evsel__new(struct perf_event_attr *attr)
 209 {
 210         return evsel__new_idx(attr, 0);
 211 }
 212
 213 struct evsel *evsel__clone(struct evsel *orig);
 214 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx);
 215
 216 /*
 217  * Returns pointer with encoded error via <linux/err.h> interface.
 218  */
 219 static inline struct evsel *evsel__newtp(const char *sys, const char *name)
 220 {
 221         return evsel__newtp_idx(sys, name, 0);
 222 }
 223
 224 struct evsel *evsel__new_cycles(bool precise, __u32 type, __u64 config);
 225
 226 struct tep_event *event_format__new(const char *sys, const char *name);
 227
 228 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
 229 void evsel__exit(struct evsel *evsel);
 230 void evsel__delete(struct evsel *evsel);
 231
 232 struct callchain_param;
 233
 234 void evsel__config(struct evsel *evsel, struct record_opts *opts,
 235                    struct callchain_param *callchain);
 236 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
 237                              struct callchain_param *callchain);
 238
 239 int __evsel__sample_size(u64 sample_type);
 240 void evsel__calc_id_pos(struct evsel *evsel);
 241
 242 bool evsel__is_cache_op_valid(u8 type, u8 op);
 243
 244 static inline bool evsel__is_bpf(struct evsel *evsel)
 245 {
 246         return evsel->bpf_counter_ops != NULL;
 247 }
 248
 249 #define EVSEL__MAX_ALIASES 8
 250
 251 extern const char *evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES];
 252 extern const char *evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES];
 253 extern const char *evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES];
 254 extern const char *evsel__hw_names[PERF_COUNT_HW_MAX];
 255 extern const char *evsel__sw_names[PERF_COUNT_SW_MAX];
 256 extern char *evsel__bpf_counter_events;
 257 bool evsel__match_bpf_counter_events(const char *name);
 258
 259 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size);
 260 const char *evsel__name(struct evsel *evsel);
 261
 262 const char *evsel__group_name(struct evsel *evsel);
 263 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
 264
 265 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
 266 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
 267
 268 #define evsel__set_sample_bit(evsel, bit) \
 269         __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
 270
 271 #define evsel__reset_sample_bit(evsel, bit) \
 272         __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
 273
 274 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);
 275
 276 void arch_evsel__set_sample_weight(struct evsel *evsel);
 277
 278 int evsel__set_filter(struct evsel *evsel, const char *filter);
 279 int evsel__append_tp_filter(struct evsel *evsel, const char *filter);
 280 int evsel__append_addr_filter(struct evsel *evsel, const char *filter);
 281 int evsel__enable_cpu(struct evsel *evsel, int cpu);
 282 int evsel__enable(struct evsel *evsel);
 283 int evsel__disable(struct evsel *evsel);
 284 int evsel__disable_cpu(struct evsel *evsel, int cpu);
 285
 286 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu);
 287 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);
 288 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
 289                 struct perf_thread_map *threads);
 290 void evsel__close(struct evsel *evsel);
 291
 292 struct perf_sample;
 293
 294 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);
 295 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);
 296
 297 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)
 298 {
 299         return evsel__rawptr(evsel, sample, name);
 300 }
 301
 302 struct tep_format_field;
 303
 304 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
 305
 306 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);
 307
 308 #define evsel__match(evsel, t, c)               \
 309         (evsel->core.attr.type == PERF_TYPE_##t &&      \
 310          evsel->core.attr.config == PERF_COUNT_##c)
 311
 312 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2)
 313 {
 314         return (e1->core.attr.type == e2->core.attr.type) &&
 315                (e1->core.attr.config == e2->core.attr.config);
 316 }
 317
 318 int evsel__read_counter(struct evsel *evsel, int cpu, int thread);
 319
 320 int __evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread, bool scale);
 321
 322 /**
 323  * evsel__read_on_cpu - Read out the results on a CPU and thread
 324  *
 325  * @evsel - event selector to read value
 326  * @cpu - CPU of interest
 327  * @thread - thread of interest
 328  */
 329 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread)
 330 {
 331         return __evsel__read_on_cpu(evsel, cpu, thread, false);
 332 }
 333
 334 /**
 335  * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 336  *
 337  * @evsel - event selector to read value
 338  * @cpu - CPU of interest
 339  * @thread - thread of interest
 340  */
 341 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu, int thread)
 342 {
 343         return __evsel__read_on_cpu(evsel, cpu, thread, true);
 344 }
 345
 346 int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
 347                         struct perf_sample *sample);
 348
 349 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
 350                                   u64 *timestamp);
 351
 352 static inline struct evsel *evsel__next(struct evsel *evsel)
 353 {
 354         return list_entry(evsel->core.node.next, struct evsel, core.node);
 355 }
 356
 357 static inline struct evsel *evsel__prev(struct evsel *evsel)
 358 {
 359         return list_entry(evsel->core.node.prev, struct evsel, core.node);
 360 }
 361
 362 /**
 363  * evsel__is_group_leader - Return whether given evsel is a leader event
 364  *
 365  * @evsel - evsel selector to be tested
 366  *
 367  * Return %true if @evsel is a group leader or a stand-alone event
 368  */
 369 static inline bool evsel__is_group_leader(const struct evsel *evsel)
 370 {
 371         return evsel->leader == evsel;
 372 }
 373
 374 /**
 375  * evsel__is_group_event - Return whether given evsel is a group event
 376  *
 377  * @evsel - evsel selector to be tested
 378  *
 379  * Return %true iff event group view is enabled and @evsel is a actual group
 380  * leader which has other members in the group
 381  */
 382 static inline bool evsel__is_group_event(struct evsel *evsel)
 383 {
 384         if (!symbol_conf.event_group)
 385                 return false;
 386
 387         return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
 388 }
 389
 390 bool evsel__is_function_event(struct evsel *evsel);
 391
 392 static inline bool evsel__is_bpf_output(struct evsel *evsel)
 393 {
 394         return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
 395 }
 396
 397 static inline bool evsel__is_clock(struct evsel *evsel)
 398 {
 399         return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
 400                evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
 401 }
 402
 403 bool evsel__fallback(struct evsel *evsel, int err, char *msg, size_t msgsize);
 404 int evsel__open_strerror(struct evsel *evsel, struct target *target,
 405                          int err, char *msg, size_t size);
 406
 407 static inline int evsel__group_idx(struct evsel *evsel)
 408 {
 409         return evsel->idx - evsel->leader->idx;
 410 }
 411
 412 /* Iterates group WITHOUT the leader. */
 413 #define for_each_group_member(_evsel, _leader)                                  \
 414 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \
 415      (_evsel) && (_evsel)->leader == (_leader);                                 \
 416      (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
 417
 418 /* Iterates group WITH the leader. */
 419 #define for_each_group_evsel(_evsel, _leader)                                   \
 420 for ((_evsel) = _leader;                                                        \
 421      (_evsel) && (_evsel)->leader == (_leader);                                 \
 422      (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
 423
 424 static inline bool evsel__has_branch_callstack(const struct evsel *evsel)
 425 {
 426         return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
 427 }
 428
 429 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)
 430 {
 431         return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;
 432 }
 433
 434 static inline bool evsel__has_callchain(const struct evsel *evsel)
 435 {
 436         /*
 437          * For reporting purposes, an evsel sample can have a recorded callchain
 438          * or a callchain synthesized from AUX area data.
 439          */
 440         return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||
 441                evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;
 442 }
 443
 444 static inline bool evsel__has_br_stack(const struct evsel *evsel)
 445 {
 446         /*
 447          * For reporting purposes, an evsel sample can have a recorded branch
 448          * stack or a branch stack synthesized from AUX area data.
 449          */
 450         return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||
 451                evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;
 452 }
 453
 454 static inline bool evsel__is_dummy_event(struct evsel *evsel)
 455 {
 456         return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) &&
 457                (evsel->core.attr.config == PERF_COUNT_SW_DUMMY);
 458 }
 459
 460 struct perf_env *evsel__env(struct evsel *evsel);
 461
 462 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
 463
 464 void evsel__zero_per_pkg(struct evsel *evsel);
 465 bool evsel__is_hybrid(struct evsel *evsel);
 466 #endif /* __PERF_EVSEL_H */