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