LXR linux/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
  18struct pollfd;
  19struct thread_map;
  20struct perf_cpu_map;
  21struct 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 */
  44enum bkw_mmap_state {
  45        BKW_MMAP_NOTREADY,
  46        BKW_MMAP_RUNNING,
  47        BKW_MMAP_DATA_PENDING,
  48        BKW_MMAP_EMPTY,
  49};
  50
  51struct 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
  84struct evsel_str_handler {
  85        const char *name;
  86        void       *handler;
  87};
  88
  89struct evlist *evlist__new(void);
  90struct evlist *evlist__new_default(void);
  91struct evlist *evlist__new_dummy(void);
  92void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus,
  93                  struct perf_thread_map *threads);
  94void evlist__exit(struct evlist *evlist);
  95void evlist__delete(struct evlist *evlist);
  96
  97void evlist__add(struct evlist *evlist, struct evsel *entry);
  98void evlist__remove(struct evlist *evlist, struct evsel *evsel);
  99
 100int __evlist__add_default(struct evlist *evlist, bool precise);
 101
 102static inline int evlist__add_default(struct evlist *evlist)
 103{
 104        return __evlist__add_default(evlist, true);
 105}
 106
 107int __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
 113int arch_evlist__add_default_attrs(struct evlist *evlist);
 114
 115int evlist__add_dummy(struct evlist *evlist);
 116
 117int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr,
 118                         evsel__sb_cb_t cb, void *data);
 119void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data);
 120int evlist__start_sb_thread(struct evlist *evlist, struct target *target);
 121void evlist__stop_sb_thread(struct evlist *evlist);
 122
 123int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler);
 124
 125int __evlist__set_tracepoints_handlers(struct evlist *evlist,
 126                                       const struct evsel_str_handler *assocs,
 127                                       size_t nr_assocs);
 128
 129#define evlist__set_tracepoints_handlers(evlist, array) \
 130        __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array))
 131
 132int evlist__set_tp_filter(struct evlist *evlist, const char *filter);
 133int evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid);
 134int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
 135
 136int evlist__append_tp_filter(struct evlist *evlist, const char *filter);
 137
 138int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid);
 139int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
 140
 141struct evsel *evlist__find_tracepoint_by_id(struct evlist *evlist, int id);
 142struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name);
 143
 144int evlist__add_pollfd(struct evlist *evlist, int fd);
 145int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
 146
 147#ifdef HAVE_EVENTFD_SUPPORT
 148int evlist__add_wakeup_eventfd(struct evlist *evlist, int fd);
 149#endif
 150
 151int evlist__poll(struct evlist *evlist, int timeout);
 152
 153struct evsel *evlist__id2evsel(struct evlist *evlist, u64 id);
 154struct evsel *evlist__id2evsel_strict(struct evlist *evlist, u64 id);
 155
 156struct perf_sample_id *evlist__id2sid(struct evlist *evlist, u64 id);
 157
 158void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
 159
 160void evlist__mmap_consume(struct evlist *evlist, int idx);
 161
 162int evlist__open(struct evlist *evlist);
 163void evlist__close(struct evlist *evlist);
 164
 165struct callchain_param;
 166
 167void evlist__set_id_pos(struct evlist *evlist);
 168void evlist__config(struct evlist *evlist, struct record_opts *opts, struct callchain_param *callchain);
 169int record_opts__config(struct record_opts *opts);
 170
 171int evlist__prepare_workload(struct evlist *evlist, struct target *target,
 172                             const char *argv[], bool pipe_output,
 173                             void (*exec_error)(int signo, siginfo_t *info, void *ucontext));
 174int evlist__start_workload(struct evlist *evlist);
 175
 176struct option;
 177
 178int __evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
 179int evlist__parse_mmap_pages(const struct option *opt, const char *str, int unset);
 180
 181unsigned long perf_event_mlock_kb_in_pages(void);
 182
 183int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
 184                         unsigned int auxtrace_pages,
 185                         bool auxtrace_overwrite, int nr_cblocks,
 186                         int affinity, int flush, int comp_level);
 187int evlist__mmap(struct evlist *evlist, unsigned int pages);
 188void evlist__munmap(struct evlist *evlist);
 189
 190size_t evlist__mmap_size(unsigned long pages);
 191
 192void evlist__disable(struct evlist *evlist);
 193void evlist__enable(struct evlist *evlist);
 194void evlist__toggle_enable(struct evlist *evlist);
 195void evlist__disable_evsel(struct evlist *evlist, char *evsel_name);
 196void evlist__enable_evsel(struct evlist *evlist, char *evsel_name);
 197
 198int evlist__enable_event_idx(struct evlist *evlist, struct evsel *evsel, int idx);
 199
 200void evlist__set_selected(struct evlist *evlist, struct evsel *evsel);
 201
 202int evlist__create_maps(struct evlist *evlist, struct target *target);
 203int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel);
 204
 205void __evlist__set_leader(struct list_head *list);
 206void evlist__set_leader(struct evlist *evlist);
 207
 208u64 __evlist__combined_sample_type(struct evlist *evlist);
 209u64 evlist__combined_sample_type(struct evlist *evlist);
 210u64 evlist__combined_branch_type(struct evlist *evlist);
 211bool evlist__sample_id_all(struct evlist *evlist);
 212u16 evlist__id_hdr_size(struct evlist *evlist);
 213
 214int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample);
 215int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp);
 216
 217bool evlist__valid_sample_type(struct evlist *evlist);
 218bool evlist__valid_sample_id_all(struct evlist *evlist);
 219bool evlist__valid_read_format(struct evlist *evlist);
 220
 221void evlist__splice_list_tail(struct evlist *evlist, struct list_head *list);
 222
 223static inline bool evlist__empty(struct evlist *evlist)
 224{
 225        return list_empty(&evlist->core.entries);
 226}
 227
 228static inline struct evsel *evlist__first(struct evlist *evlist)
 229{
 230        struct perf_evsel *evsel = perf_evlist__first(&evlist->core);
 231
 232        return container_of(evsel, struct evsel, core);
 233}
 234
 235static inline struct evsel *evlist__last(struct evlist *evlist)
 236{
 237        struct perf_evsel *evsel = perf_evlist__last(&evlist->core);
 238
 239        return container_of(evsel, struct evsel, core);
 240}
 241
 242int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
 243int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
 244
 245bool evlist__can_select_event(struct evlist *evlist, const char *str);
 246void evlist__to_front(struct evlist *evlist, struct evsel *move_evsel);
 247
 248/**
 249 * __evlist__for_each_entry - iterate thru all the evsels
 250 * @list: list_head instance to iterate
 251 * @evsel: struct evsel iterator
 252 */
 253#define __evlist__for_each_entry(list, evsel) \
 254        list_for_each_entry(evsel, list, core.node)
 255
 256/**
 257 * evlist__for_each_entry - iterate thru all the evsels
 258 * @evlist: evlist instance to iterate
 259 * @evsel: struct evsel iterator
 260 */
 261#define evlist__for_each_entry(evlist, evsel) \
 262        __evlist__for_each_entry(&(evlist)->core.entries, evsel)
 263
 264/**
 265 * __evlist__for_each_entry_continue - continue iteration thru all the evsels
 266 * @list: list_head instance to iterate
 267 * @evsel: struct evsel iterator
 268 */
 269#define __evlist__for_each_entry_continue(list, evsel) \
 270        list_for_each_entry_continue(evsel, list, core.node)
 271
 272/**
 273 * evlist__for_each_entry_continue - continue iteration thru all the evsels
 274 * @evlist: evlist instance to iterate
 275 * @evsel: struct evsel iterator
 276 */
 277#define evlist__for_each_entry_continue(evlist, evsel) \
 278        __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
 279
 280/**
 281 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 282 * @list: list_head instance to iterate
 283 * @evsel: struct evsel iterator
 284 */
 285#define __evlist__for_each_entry_reverse(list, evsel) \
 286        list_for_each_entry_reverse(evsel, list, core.node)
 287
 288/**
 289 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 290 * @evlist: evlist instance to iterate
 291 * @evsel: struct evsel iterator
 292 */
 293#define evlist__for_each_entry_reverse(evlist, evsel) \
 294        __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
 295
 296/**
 297 * __evlist__for_each_entry_safe - safely iterate thru all the evsels
 298 * @list: list_head instance to iterate
 299 * @tmp: struct evsel temp iterator
 300 * @evsel: struct evsel iterator
 301 */
 302#define __evlist__for_each_entry_safe(list, tmp, evsel) \
 303        list_for_each_entry_safe(evsel, tmp, list, core.node)
 304
 305/**
 306 * evlist__for_each_entry_safe - safely iterate thru all the evsels
 307 * @evlist: evlist instance to iterate
 308 * @evsel: struct evsel iterator
 309 * @tmp: struct evsel temp iterator
 310 */
 311#define evlist__for_each_entry_safe(evlist, tmp, evsel) \
 312        __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
 313
 314#define evlist__for_each_cpu(evlist, index, cpu)        \
 315        evlist__cpu_iter_start(evlist);                 \
 316        perf_cpu_map__for_each_cpu (cpu, index, (evlist)->core.all_cpus)
 317
 318struct evsel *evlist__get_tracking_event(struct evlist *evlist);
 319void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel);
 320
 321void evlist__cpu_iter_start(struct evlist *evlist);
 322bool evsel__cpu_iter_skip(struct evsel *ev, int cpu);
 323bool evsel__cpu_iter_skip_no_inc(struct evsel *ev, int cpu);
 324
 325struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
 326
 327struct evsel *evlist__event2evsel(struct evlist *evlist, union perf_event *event);
 328
 329bool evlist__exclude_kernel(struct evlist *evlist);
 330
 331void evlist__force_leader(struct evlist *evlist);
 332
 333struct evsel *evlist__reset_weak_group(struct evlist *evlist, struct evsel *evsel, bool close);
 334
 335#define EVLIST_CTL_CMD_ENABLE_TAG  "enable"
 336#define EVLIST_CTL_CMD_DISABLE_TAG "disable"
 337#define EVLIST_CTL_CMD_ACK_TAG     "ack\n"
 338#define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot"
 339#define EVLIST_CTL_CMD_EVLIST_TAG "evlist"
 340#define EVLIST_CTL_CMD_STOP_TAG "stop"
 341#define EVLIST_CTL_CMD_PING_TAG "ping"
 342
 343#define EVLIST_CTL_CMD_MAX_LEN 64
 344
 345enum evlist_ctl_cmd {
 346        EVLIST_CTL_CMD_UNSUPPORTED = 0,
 347        EVLIST_CTL_CMD_ENABLE,
 348        EVLIST_CTL_CMD_DISABLE,
 349        EVLIST_CTL_CMD_ACK,
 350        EVLIST_CTL_CMD_SNAPSHOT,
 351        EVLIST_CTL_CMD_EVLIST,
 352        EVLIST_CTL_CMD_STOP,
 353        EVLIST_CTL_CMD_PING,
 354};
 355
 356int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close);
 357void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close);
 358int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack);
 359int evlist__finalize_ctlfd(struct evlist *evlist);
 360bool evlist__ctlfd_initialized(struct evlist *evlist);
 361int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd);
 362int evlist__ctlfd_ack(struct evlist *evlist);
 363
 364#define EVLIST_ENABLED_MSG "Events enabled\n"
 365#define EVLIST_DISABLED_MSG "Events disabled\n"
 366
 367struct evsel *evlist__find_evsel(struct evlist *evlist, int idx);
 368
 369int evlist__scnprintf_evsels(struct evlist *evlist, size_t size, char *bf);
 370#endif /* __PERF_EVLIST_H */
 371