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 (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         bool                    is_libpfm_event;
  80         /* parse modifier helper */
  81         int                     exclude_GH;
  82         int                     sample_read;
  83         unsigned long           *per_pkg_mask;
  84         struct evsel            *leader;
  85         char                    *group_name;
  86         bool                    cmdline_group_boundary;
  87         struct list_head        config_terms;
  88         struct bpf_object       *bpf_obj;
  89         int                     bpf_fd;
  90         int                     err;
  91         bool                    auto_merge_stats;
  92         bool                    merged_stat;
  93         const char *            metric_expr;
  94         const char *            metric_name;
  95         struct evsel            **metric_events;
  96         struct evsel            *metric_leader;
  97         bool                    collect_stat;
  98         bool                    weak_group;
  99         bool                    reset_group;
 100         bool                    errored;
 101         bool                    percore;
 102         int                     cpu_iter;
 103         const char              *pmu_name;
 104         struct {
 105                 evsel__sb_cb_t  *cb;
 106                 void            *data;
 107         } side_band;
 108         /*
 109          * For reporting purposes, an evsel sample can have a callchain
 110          * synthesized from AUX area data. Keep track of synthesized sample
 111          * types here. Note, the recorded sample_type cannot be changed because
 112          * it is needed to continue to parse events.
 113          * See also evsel__has_callchain().
 114          */
 115         __u64                   synth_sample_type;
 116 };
 117
 118 struct perf_missing_features {
 119         bool sample_id_all;
 120         bool exclude_guest;
 121         bool mmap2;
 122         bool cloexec;
 123         bool clockid;
 124         bool clockid_wrong;
 125         bool lbr_flags;
 126         bool write_backward;
 127         bool group_read;
 128         bool ksymbol;
 129         bool bpf;
 130         bool aux_output;
 131         bool branch_hw_idx;
 132         bool cgroup;
 133 };
 134
 135 extern struct perf_missing_features perf_missing_features;
 136
 137 struct perf_cpu_map;
 138 struct target;
 139 struct thread_map;
 140 struct record_opts;
 141
 142 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
 143 {
 144         return perf_evsel__cpus(&evsel->core);
 145 }
 146
 147 static inline int evsel__nr_cpus(struct evsel *evsel)
 148 {
 149         return evsel__cpus(evsel)->nr;
 150 }
 151
 152 void perf_counts_values__scale(struct perf_counts_values *count,
 153                                bool scale, s8 *pscaled);
 154
 155 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
 156                            struct perf_counts_values *count);
 157
 158 int evsel__object_config(size_t object_size,
 159                          int (*init)(struct evsel *evsel),
 160                          void (*fini)(struct evsel *evsel));
 161
 162 struct perf_pmu *evsel__find_pmu(struct evsel *evsel);
 163 bool evsel__is_aux_event(struct evsel *evsel);
 164
 165 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);
 166
 167 static inline struct evsel *evsel__new(struct perf_event_attr *attr)
 168 {
 169         return evsel__new_idx(attr, 0);
 170 }
 171
 172 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx);
 173
 174 /*
 175  * Returns pointer with encoded error via <linux/err.h> interface.
 176  */
 177 static inline struct evsel *evsel__newtp(const char *sys, const char *name)
 178 {
 179         return evsel__newtp_idx(sys, name, 0);
 180 }
 181
 182 struct evsel *evsel__new_cycles(bool precise);
 183
 184 struct tep_event *event_format__new(const char *sys, const char *name);
 185
 186 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
 187 void evsel__exit(struct evsel *evsel);
 188 void evsel__delete(struct evsel *evsel);
 189
 190 struct callchain_param;
 191
 192 void evsel__config(struct evsel *evsel, struct record_opts *opts,
 193                    struct callchain_param *callchain);
 194 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
 195                              struct callchain_param *callchain);
 196
 197 int __evsel__sample_size(u64 sample_type);
 198 void evsel__calc_id_pos(struct evsel *evsel);
 199
 200 bool evsel__is_cache_op_valid(u8 type, u8 op);
 201
 202 #define EVSEL__MAX_ALIASES 8
 203
 204 extern const char *evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES];
 205 extern const char *evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES];
 206 extern const char *evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES];
 207 extern const char *evsel__hw_names[PERF_COUNT_HW_MAX];
 208 extern const char *evsel__sw_names[PERF_COUNT_SW_MAX];
 209 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size);
 210 const char *evsel__name(struct evsel *evsel);
 211
 212 const char *evsel__group_name(struct evsel *evsel);
 213 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
 214
 215 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
 216 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
 217
 218 #define evsel__set_sample_bit(evsel, bit) \
 219         __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
 220
 221 #define evsel__reset_sample_bit(evsel, bit) \
 222         __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
 223
 224 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);
 225
 226 int evsel__set_filter(struct evsel *evsel, const char *filter);
 227 int evsel__append_tp_filter(struct evsel *evsel, const char *filter);
 228 int evsel__append_addr_filter(struct evsel *evsel, const char *filter);
 229 int evsel__enable_cpu(struct evsel *evsel, int cpu);
 230 int evsel__enable(struct evsel *evsel);
 231 int evsel__disable(struct evsel *evsel);
 232 int evsel__disable_cpu(struct evsel *evsel, int cpu);
 233
 234 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu);
 235 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);
 236 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
 237                 struct perf_thread_map *threads);
 238 void evsel__close(struct evsel *evsel);
 239
 240 struct perf_sample;
 241
 242 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);
 243 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);
 244
 245 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)
 246 {
 247         return evsel__rawptr(evsel, sample, name);
 248 }
 249
 250 struct tep_format_field;
 251
 252 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
 253
 254 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);
 255
 256 #define evsel__match(evsel, t, c)               \
 257         (evsel->core.attr.type == PERF_TYPE_##t &&      \
 258          evsel->core.attr.config == PERF_COUNT_##c)
 259
 260 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2)
 261 {
 262         return (e1->core.attr.type == e2->core.attr.type) &&
 263                (e1->core.attr.config == e2->core.attr.config);
 264 }
 265
 266 int evsel__read_counter(struct evsel *evsel, int cpu, int thread);
 267
 268 int __evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread, bool scale);
 269
 270 /**
 271  * evsel__read_on_cpu - Read out the results on a CPU and thread
 272  *
 273  * @evsel - event selector to read value
 274  * @cpu - CPU of interest
 275  * @thread - thread of interest
 276  */
 277 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread)
 278 {
 279         return __evsel__read_on_cpu(evsel, cpu, thread, false);
 280 }
 281
 282 /**
 283  * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
 284  *
 285  * @evsel - event selector to read value
 286  * @cpu - CPU of interest
 287  * @thread - thread of interest
 288  */
 289 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu, int thread)
 290 {
 291         return __evsel__read_on_cpu(evsel, cpu, thread, true);
 292 }
 293
 294 int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
 295                         struct perf_sample *sample);
 296
 297 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
 298                                   u64 *timestamp);
 299
 300 static inline struct evsel *evsel__next(struct evsel *evsel)
 301 {
 302         return list_entry(evsel->core.node.next, struct evsel, core.node);
 303 }
 304
 305 static inline struct evsel *evsel__prev(struct evsel *evsel)
 306 {
 307         return list_entry(evsel->core.node.prev, struct evsel, core.node);
 308 }
 309
 310 /**
 311  * evsel__is_group_leader - Return whether given evsel is a leader event
 312  *
 313  * @evsel - evsel selector to be tested
 314  *
 315  * Return %true if @evsel is a group leader or a stand-alone event
 316  */
 317 static inline bool evsel__is_group_leader(const struct evsel *evsel)
 318 {
 319         return evsel->leader == evsel;
 320 }
 321
 322 /**
 323  * evsel__is_group_event - Return whether given evsel is a group event
 324  *
 325  * @evsel - evsel selector to be tested
 326  *
 327  * Return %true iff event group view is enabled and @evsel is a actual group
 328  * leader which has other members in the group
 329  */
 330 static inline bool evsel__is_group_event(struct evsel *evsel)
 331 {
 332         if (!symbol_conf.event_group)
 333                 return false;
 334
 335         return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
 336 }
 337
 338 bool evsel__is_function_event(struct evsel *evsel);
 339
 340 static inline bool evsel__is_bpf_output(struct evsel *evsel)
 341 {
 342         return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
 343 }
 344
 345 static inline bool evsel__is_clock(struct evsel *evsel)
 346 {
 347         return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
 348                evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
 349 }
 350
 351 bool evsel__fallback(struct evsel *evsel, int err, char *msg, size_t msgsize);
 352 int evsel__open_strerror(struct evsel *evsel, struct target *target,
 353                          int err, char *msg, size_t size);
 354
 355 static inline int evsel__group_idx(struct evsel *evsel)
 356 {
 357         return evsel->idx - evsel->leader->idx;
 358 }
 359
 360 /* Iterates group WITHOUT the leader. */
 361 #define for_each_group_member(_evsel, _leader)                                  \
 362 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \
 363      (_evsel) && (_evsel)->leader == (_leader);                                 \
 364      (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
 365
 366 /* Iterates group WITH the leader. */
 367 #define for_each_group_evsel(_evsel, _leader)                                   \
 368 for ((_evsel) = _leader;                                                        \
 369      (_evsel) && (_evsel)->leader == (_leader);                                 \
 370      (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
 371
 372 static inline bool evsel__has_branch_callstack(const struct evsel *evsel)
 373 {
 374         return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
 375 }
 376
 377 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)
 378 {
 379         return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;
 380 }
 381
 382 static inline bool evsel__has_callchain(const struct evsel *evsel)
 383 {
 384         /*
 385          * For reporting purposes, an evsel sample can have a recorded callchain
 386          * or a callchain synthesized from AUX area data.
 387          */
 388         return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||
 389                evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;
 390 }
 391
 392 static inline bool evsel__has_br_stack(const struct evsel *evsel)
 393 {
 394         /*
 395          * For reporting purposes, an evsel sample can have a recorded branch
 396          * stack or a branch stack synthesized from AUX area data.
 397          */
 398         return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||
 399                evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;
 400 }
 401
 402 static inline bool evsel__is_dummy_event(struct evsel *evsel)
 403 {
 404         return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) &&
 405                (evsel->core.attr.config == PERF_COUNT_SW_DUMMY);
 406 }
 407
 408 struct perf_env *evsel__env(struct evsel *evsel);
 409
 410 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
 411 #endif /* __PERF_EVSEL_H */