tools/perf/util/evlist.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __PERF_EVLIST_H
   3 #define __PERF_EVLIST_H 1
   4
   5 #include <linux/compiler.h>
   6 #include <linux/kernel.h>
   7 #include <linux/refcount.h>
   8 #include <linux/list.h>
   9 #include <api/fd/array.h>
  10 #include <internal/evlist.h>
  11 #include <internal/evsel.h>
  12 #include "events_stats.h"
  13 #include "evsel.h"
  14 #include <pthread.h>
  15 #include <signal.h>
  16 #include <unistd.h>
  17
  18 struct pollfd;
  19 struct thread_map;
  20 struct perf_cpu_map;
  21 struct record_opts;
  22
  23 /*
  24  * State machine of bkw_mmap_state:
  25  *
  26  *                     .________________(forbid)_____________.
  27  *                     |                                     V
  28  * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
  29  *                     ^  ^              |   ^               |
  30  *                     |  |__(forbid)____/   |___(forbid)___/|
  31  *                     |                                     |
  32  *                      \_________________(3)_______________/
  33  *
  34  * NOTREADY     : Backward ring buffers are not ready
  35  * RUNNING      : Backward ring buffers are recording
  36  * DATA_PENDING : We are required to collect data from backward ring buffers
  37  * EMPTY        : We have collected data from backward ring buffers.
  38  *
  39  * (0): Setup backward ring buffer
  40  * (1): Pause ring buffers for reading
  41  * (2): Read from ring buffers
  42  * (3): Resume ring buffers for recording
  43  */
  44 enum bkw_mmap_state {
  45         BKW_MMAP_NOTREADY,
  46         BKW_MMAP_RUNNING,
  47         BKW_MMAP_DATA_PENDING,
  48         BKW_MMAP_EMPTY,
  49 };
  50
  51 struct evlist {
  52         struct perf_evlist core;
  53         int              nr_groups;
  54         bool             enabled;
  55         int              id_pos;
  56         int              is_pos;
  57         u64              combined_sample_type;
  58         enum bkw_mmap_state bkw_mmap_state;
  59         struct {
  60                 int     cork_fd;
  61                 pid_t   pid;
  62         } workload;
  63         struct mmap *mmap;
  64         struct mmap *overwrite_mmap;
  65         struct evsel *selected;
  66         struct events_stats stats;
  67         struct perf_env *env;
  68         void (*trace_event_sample_raw)(struct evlist *evlist,
  69                                        union perf_event *event,
  70                                        struct perf_sample *sample);
  71         u64             first_sample_time;
  72         u64             last_sample_time;
  73         struct {
  74                 pthread_t               th;
  75                 volatile int            done;
  76         } thread;
  77         struct {
  78                 int     fd;     /* control file descriptor */
  79                 int     ack;    /* ack file descriptor for control commands */
  80                 int     pos;    /* index at evlist core object to check signals */
  81         } ctl_fd;
  82 };
  83
  84 struct evsel_str_handler {
  85         const char *name;
  86         void       *handler;
  87 };
  88
  89 struct evlist *evlist__new(void);
  90 struct evlist *perf_evlist__new_default(void);
  91 struct evlist *perf_evlist__new_dummy(void);
  92 void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus,
  93                   struct perf_thread_map *threads);
  94 void evlist__exit(struct evlist *evlist);
  95 void evlist__delete(struct evlist *evlist);
  96
  97 void evlist__add(struct evlist *evlist, struct evsel *entry);
  98 void evlist__remove(struct evlist *evlist, struct evsel *evsel);
  99
 100 int __evlist__add_default(struct evlist *evlist, bool precise);
 101
 102 static inline int evlist__add_default(struct evlist *evlist)
 103 {
 104         return __evlist__add_default(evlist, true);
 105 }
 106
 107 int __evlist__add_default_attrs(struct evlist *evlist,
 108                                      struct perf_event_attr *attrs, size_t nr_attrs);
 109
 110 #define evlist__add_default_attrs(evlist, array) \
 111         __evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
 112
 113 int evlist__add_dummy(struct evlist *evlist);
 114
 115 int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr,
 116                          evsel__sb_cb_t cb, void *data);
 117 void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data);
 118 int evlist__start_sb_thread(struct evlist *evlist, struct target *target);
 119 void evlist__stop_sb_thread(struct evlist *evlist);
 120
 121 int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler);
 122
 123 int __evlist__set_tracepoints_handlers(struct evlist *evlist,
 124                                        const struct evsel_str_handler *assocs,
 125                                        size_t nr_assocs);
 126
 127 #define evlist__set_tracepoints_handlers(evlist, array) \
 128         __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array))
 129
 130 void __perf_evlist__set_sample_bit(struct evlist *evlist,
 131                                    enum perf_event_sample_format bit);
 132 void __perf_evlist__reset_sample_bit(struct evlist *evlist,
 133                                      enum perf_event_sample_format bit);
 134
 135 #define perf_evlist__set_sample_bit(evlist, bit) \
 136         __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
 137
 138 #define perf_evlist__reset_sample_bit(evlist, bit) \
 139         __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
 140
 141 int evlist__set_tp_filter(struct evlist *evlist, const char *filter);
 142 int evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid);
 143 int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
 144
 145 int evlist__append_tp_filter(struct evlist *evlist, const char *filter);
 146
 147 int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid);
 148 int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
 149
 150 struct evsel *evlist__find_tracepoint_by_id(struct evlist *evlist, int id);
 151 struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name);
 152
 153 int evlist__add_pollfd(struct evlist *evlist, int fd);
 154 int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
 155
 156 int evlist__poll(struct evlist *evlist, int timeout);
 157
 158 struct evsel *perf_evlist__id2evsel(struct evlist *evlist, u64 id);
 159 struct evsel *perf_evlist__id2evsel_strict(struct evlist *evlist,
 160                                                 u64 id);
 161
 162 struct perf_sample_id *perf_evlist__id2sid(struct evlist *evlist, u64 id);
 163
 164 void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
 165
 166 void evlist__mmap_consume(struct evlist *evlist, int idx);
 167
 168 int evlist__open(struct evlist *evlist);
 169 void evlist__close(struct evlist *evlist);
 170
 171 struct callchain_param;
 172
 173 void perf_evlist__set_id_pos(struct evlist *evlist);
 174 void perf_evlist__config(struct evlist *evlist, struct record_opts *opts,
 175                          struct callchain_param *callchain);
 176 int record_opts__config(struct record_opts *opts);
 177
 178 int evlist__prepare_workload(struct evlist *evlist, struct target *target,
 179                              const char *argv[], bool pipe_output,
 180                              void (*exec_error)(int signo, siginfo_t *info, void *ucontext));
 181 int evlist__start_workload(struct evlist *evlist);
 182
 183 struct option;
 184
 185 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
 186 int perf_evlist__parse_mmap_pages(const struct option *opt,
 187                                   const char *str,
 188                                   int unset);
 189
 190 unsigned long perf_event_mlock_kb_in_pages(void);
 191
 192 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
 193                          unsigned int auxtrace_pages,
 194                          bool auxtrace_overwrite, int nr_cblocks,
 195                          int affinity, int flush, int comp_level);
 196 int evlist__mmap(struct evlist *evlist, unsigned int pages);
 197 void evlist__munmap(struct evlist *evlist);
 198
 199 size_t evlist__mmap_size(unsigned long pages);
 200
 201 void evlist__disable(struct evlist *evlist);
 202 void evlist__enable(struct evlist *evlist);
 203 void evlist__toggle_enable(struct evlist *evlist);
 204
 205 int perf_evlist__enable_event_idx(struct evlist *evlist,
 206                                   struct evsel *evsel, int idx);
 207
 208 void perf_evlist__set_selected(struct evlist *evlist,
 209                                struct evsel *evsel);
 210
 211 int perf_evlist__create_maps(struct evlist *evlist, struct target *target);
 212 int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel);
 213
 214 void __evlist__set_leader(struct list_head *list);
 215 void evlist__set_leader(struct evlist *evlist);
 216
 217 u64 __evlist__combined_sample_type(struct evlist *evlist);
 218 u64 evlist__combined_sample_type(struct evlist *evlist);
 219 u64 evlist__combined_branch_type(struct evlist *evlist);
 220 bool evlist__sample_id_all(struct evlist *evlist);
 221 u16 perf_evlist__id_hdr_size(struct evlist *evlist);
 222
 223 int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample);
 224 int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp);
 225
 226 bool evlist__valid_sample_type(struct evlist *evlist);
 227 bool evlist__valid_sample_id_all(struct evlist *evlist);
 228 bool perf_evlist__valid_read_format(struct evlist *evlist);
 229
 230 void perf_evlist__splice_list_tail(struct evlist *evlist,
 231                                    struct list_head *list);
 232
 233 static inline bool perf_evlist__empty(struct evlist *evlist)
 234 {
 235         return list_empty(&evlist->core.entries);
 236 }
 237
 238 static inline struct evsel *evlist__first(struct evlist *evlist)
 239 {
 240         struct perf_evsel *evsel = perf_evlist__first(&evlist->core);
 241
 242         return container_of(evsel, struct evsel, core);
 243 }
 244
 245 static inline struct evsel *evlist__last(struct evlist *evlist)
 246 {
 247         struct perf_evsel *evsel = perf_evlist__last(&evlist->core);
 248
 249         return container_of(evsel, struct evsel, core);
 250 }
 251
 252 int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
 253 int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
 254
 255 bool perf_evlist__can_select_event(struct evlist *evlist, const char *str);
 256 void perf_evlist__to_front(struct evlist *evlist,
 257                            struct evsel *move_evsel);
 258
 259 /**
 260  * __evlist__for_each_entry - iterate thru all the evsels
 261  * @list: list_head instance to iterate
 262  * @evsel: struct evsel iterator
 263  */
 264 #define __evlist__for_each_entry(list, evsel) \
 265         list_for_each_entry(evsel, list, core.node)
 266
 267 /**
 268  * evlist__for_each_entry - iterate thru all the evsels
 269  * @evlist: evlist instance to iterate
 270  * @evsel: struct evsel iterator
 271  */
 272 #define evlist__for_each_entry(evlist, evsel) \
 273         __evlist__for_each_entry(&(evlist)->core.entries, evsel)
 274
 275 /**
 276  * __evlist__for_each_entry_continue - continue iteration thru all the evsels
 277  * @list: list_head instance to iterate
 278  * @evsel: struct evsel iterator
 279  */
 280 #define __evlist__for_each_entry_continue(list, evsel) \
 281         list_for_each_entry_continue(evsel, list, core.node)
 282
 283 /**
 284  * evlist__for_each_entry_continue - continue iteration thru all the evsels
 285  * @evlist: evlist instance to iterate
 286  * @evsel: struct evsel iterator
 287  */
 288 #define evlist__for_each_entry_continue(evlist, evsel) \
 289         __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
 290
 291 /**
 292  * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 293  * @list: list_head instance to iterate
 294  * @evsel: struct evsel iterator
 295  */
 296 #define __evlist__for_each_entry_reverse(list, evsel) \
 297         list_for_each_entry_reverse(evsel, list, core.node)
 298
 299 /**
 300  * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 301  * @evlist: evlist instance to iterate
 302  * @evsel: struct evsel iterator
 303  */
 304 #define evlist__for_each_entry_reverse(evlist, evsel) \
 305         __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
 306
 307 /**
 308  * __evlist__for_each_entry_safe - safely iterate thru all the evsels
 309  * @list: list_head instance to iterate
 310  * @tmp: struct evsel temp iterator
 311  * @evsel: struct evsel iterator
 312  */
 313 #define __evlist__for_each_entry_safe(list, tmp, evsel) \
 314         list_for_each_entry_safe(evsel, tmp, list, core.node)
 315
 316 /**
 317  * evlist__for_each_entry_safe - safely iterate thru all the evsels
 318  * @evlist: evlist instance to iterate
 319  * @evsel: struct evsel iterator
 320  * @tmp: struct evsel temp iterator
 321  */
 322 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
 323         __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
 324
 325 #define evlist__for_each_cpu(evlist, index, cpu)        \
 326         evlist__cpu_iter_start(evlist);                 \
 327         perf_cpu_map__for_each_cpu (cpu, index, (evlist)->core.all_cpus)
 328
 329 struct evsel *perf_evlist__get_tracking_event(struct evlist *evlist);
 330 void perf_evlist__set_tracking_event(struct evlist *evlist,
 331                                      struct evsel *tracking_evsel);
 332
 333 void evlist__cpu_iter_start(struct evlist *evlist);
 334 bool evsel__cpu_iter_skip(struct evsel *ev, int cpu);
 335 bool evsel__cpu_iter_skip_no_inc(struct evsel *ev, int cpu);
 336
 337 struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
 338
 339 struct evsel *perf_evlist__event2evsel(struct evlist *evlist,
 340                                             union perf_event *event);
 341
 342 bool perf_evlist__exclude_kernel(struct evlist *evlist);
 343
 344 void perf_evlist__force_leader(struct evlist *evlist);
 345
 346 struct evsel *perf_evlist__reset_weak_group(struct evlist *evlist,
 347                                                  struct evsel *evsel,
 348                                                 bool close);
 349 #define EVLIST_CTL_CMD_ENABLE_TAG  "enable"
 350 #define EVLIST_CTL_CMD_DISABLE_TAG "disable"
 351 #define EVLIST_CTL_CMD_ACK_TAG     "ack\n"
 352 #define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot"
 353
 354 #define EVLIST_CTL_CMD_MAX_LEN 64
 355
 356 enum evlist_ctl_cmd {
 357         EVLIST_CTL_CMD_UNSUPPORTED = 0,
 358         EVLIST_CTL_CMD_ENABLE,
 359         EVLIST_CTL_CMD_DISABLE,
 360         EVLIST_CTL_CMD_ACK,
 361         EVLIST_CTL_CMD_SNAPSHOT,
 362 };
 363
 364 int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close);
 365 void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close);
 366 int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack);
 367 int evlist__finalize_ctlfd(struct evlist *evlist);
 368 bool evlist__ctlfd_initialized(struct evlist *evlist);
 369 int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd);
 370 int evlist__ctlfd_ack(struct evlist *evlist);
 371
 372 #define EVLIST_ENABLED_MSG "Events enabled\n"
 373 #define EVLIST_DISABLED_MSG "Events disabled\n"
 374
 375 struct evsel *evlist__find_evsel(struct evlist *evlist, int idx);
 376 #endif /* __PERF_EVLIST_H */