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 };
  78
  79 struct evsel_str_handler {
  80         const char *name;
  81         void       *handler;
  82 };
  83
  84 struct evlist *evlist__new(void);
  85 struct evlist *perf_evlist__new_default(void);
  86 struct evlist *perf_evlist__new_dummy(void);
  87 void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus,
  88                   struct perf_thread_map *threads);
  89 void evlist__exit(struct evlist *evlist);
  90 void evlist__delete(struct evlist *evlist);
  91
  92 void evlist__add(struct evlist *evlist, struct evsel *entry);
  93 void evlist__remove(struct evlist *evlist, struct evsel *evsel);
  94
  95 int __perf_evlist__add_default(struct evlist *evlist, bool precise);
  96
  97 static inline int perf_evlist__add_default(struct evlist *evlist)
  98 {
  99         return __perf_evlist__add_default(evlist, true);
 100 }
 101
 102 int __perf_evlist__add_default_attrs(struct evlist *evlist,
 103                                      struct perf_event_attr *attrs, size_t nr_attrs);
 104
 105 #define perf_evlist__add_default_attrs(evlist, array) \
 106         __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
 107
 108 int perf_evlist__add_dummy(struct evlist *evlist);
 109
 110 int perf_evlist__add_sb_event(struct evlist **evlist,
 111                               struct perf_event_attr *attr,
 112                               perf_evsel__sb_cb_t cb,
 113                               void *data);
 114 int perf_evlist__start_sb_thread(struct evlist *evlist,
 115                                  struct target *target);
 116 void perf_evlist__stop_sb_thread(struct evlist *evlist);
 117
 118 int perf_evlist__add_newtp(struct evlist *evlist,
 119                            const char *sys, const char *name, void *handler);
 120
 121 int __evlist__set_tracepoints_handlers(struct evlist *evlist,
 122                                        const struct evsel_str_handler *assocs,
 123                                        size_t nr_assocs);
 124
 125 #define evlist__set_tracepoints_handlers(evlist, array) \
 126         __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array))
 127
 128 void __perf_evlist__set_sample_bit(struct evlist *evlist,
 129                                    enum perf_event_sample_format bit);
 130 void __perf_evlist__reset_sample_bit(struct evlist *evlist,
 131                                      enum perf_event_sample_format bit);
 132
 133 #define perf_evlist__set_sample_bit(evlist, bit) \
 134         __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
 135
 136 #define perf_evlist__reset_sample_bit(evlist, bit) \
 137         __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
 138
 139 int perf_evlist__set_tp_filter(struct evlist *evlist, const char *filter);
 140 int perf_evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid);
 141 int perf_evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
 142
 143 int perf_evlist__append_tp_filter(struct evlist *evlist, const char *filter);
 144
 145 int perf_evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid);
 146 int perf_evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
 147
 148 struct evsel *
 149 perf_evlist__find_tracepoint_by_id(struct evlist *evlist, int id);
 150
 151 struct evsel *
 152 perf_evlist__find_tracepoint_by_name(struct evlist *evlist,
 153                                      const char *name);
 154
 155 int evlist__add_pollfd(struct evlist *evlist, int fd);
 156 int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
 157
 158 int evlist__poll(struct evlist *evlist, int timeout);
 159
 160 struct evsel *perf_evlist__id2evsel(struct evlist *evlist, u64 id);
 161 struct evsel *perf_evlist__id2evsel_strict(struct evlist *evlist,
 162                                                 u64 id);
 163
 164 struct perf_sample_id *perf_evlist__id2sid(struct evlist *evlist, u64 id);
 165
 166 void perf_evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
 167
 168 void evlist__mmap_consume(struct evlist *evlist, int idx);
 169
 170 int evlist__open(struct evlist *evlist);
 171 void evlist__close(struct evlist *evlist);
 172
 173 struct callchain_param;
 174
 175 void perf_evlist__set_id_pos(struct evlist *evlist);
 176 bool perf_can_sample_identifier(void);
 177 bool perf_can_record_switch_events(void);
 178 bool perf_can_record_cpu_wide(void);
 179 bool perf_can_aux_sample(void);
 180 void perf_evlist__config(struct evlist *evlist, struct record_opts *opts,
 181                          struct callchain_param *callchain);
 182 int record_opts__config(struct record_opts *opts);
 183
 184 int perf_evlist__prepare_workload(struct evlist *evlist,
 185                                   struct target *target,
 186                                   const char *argv[], bool pipe_output,
 187                                   void (*exec_error)(int signo, siginfo_t *info,
 188                                                      void *ucontext));
 189 int perf_evlist__start_workload(struct evlist *evlist);
 190
 191 struct option;
 192
 193 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
 194 int perf_evlist__parse_mmap_pages(const struct option *opt,
 195                                   const char *str,
 196                                   int unset);
 197
 198 unsigned long perf_event_mlock_kb_in_pages(void);
 199
 200 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
 201                          unsigned int auxtrace_pages,
 202                          bool auxtrace_overwrite, int nr_cblocks,
 203                          int affinity, int flush, int comp_level);
 204 int evlist__mmap(struct evlist *evlist, unsigned int pages);
 205 void evlist__munmap(struct evlist *evlist);
 206
 207 size_t evlist__mmap_size(unsigned long pages);
 208
 209 void evlist__disable(struct evlist *evlist);
 210 void evlist__enable(struct evlist *evlist);
 211 void perf_evlist__toggle_enable(struct evlist *evlist);
 212
 213 int perf_evlist__enable_event_idx(struct evlist *evlist,
 214                                   struct evsel *evsel, int idx);
 215
 216 void perf_evlist__set_selected(struct evlist *evlist,
 217                                struct evsel *evsel);
 218
 219 int perf_evlist__create_maps(struct evlist *evlist, struct target *target);
 220 int perf_evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel);
 221
 222 void __perf_evlist__set_leader(struct list_head *list);
 223 void perf_evlist__set_leader(struct evlist *evlist);
 224
 225 u64 __perf_evlist__combined_sample_type(struct evlist *evlist);
 226 u64 perf_evlist__combined_sample_type(struct evlist *evlist);
 227 u64 perf_evlist__combined_branch_type(struct evlist *evlist);
 228 bool perf_evlist__sample_id_all(struct evlist *evlist);
 229 u16 perf_evlist__id_hdr_size(struct evlist *evlist);
 230
 231 int perf_evlist__parse_sample(struct evlist *evlist, union perf_event *event,
 232                               struct perf_sample *sample);
 233
 234 int perf_evlist__parse_sample_timestamp(struct evlist *evlist,
 235                                         union perf_event *event,
 236                                         u64 *timestamp);
 237
 238 bool perf_evlist__valid_sample_type(struct evlist *evlist);
 239 bool perf_evlist__valid_sample_id_all(struct evlist *evlist);
 240 bool perf_evlist__valid_read_format(struct evlist *evlist);
 241
 242 void perf_evlist__splice_list_tail(struct evlist *evlist,
 243                                    struct list_head *list);
 244
 245 static inline bool perf_evlist__empty(struct evlist *evlist)
 246 {
 247         return list_empty(&evlist->core.entries);
 248 }
 249
 250 static inline struct evsel *evlist__first(struct evlist *evlist)
 251 {
 252         struct perf_evsel *evsel = perf_evlist__first(&evlist->core);
 253
 254         return container_of(evsel, struct evsel, core);
 255 }
 256
 257 static inline struct evsel *evlist__last(struct evlist *evlist)
 258 {
 259         struct perf_evsel *evsel = perf_evlist__last(&evlist->core);
 260
 261         return container_of(evsel, struct evsel, core);
 262 }
 263
 264 int perf_evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
 265 int perf_evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
 266
 267 bool perf_evlist__can_select_event(struct evlist *evlist, const char *str);
 268 void perf_evlist__to_front(struct evlist *evlist,
 269                            struct evsel *move_evsel);
 270
 271 /**
 272  * __evlist__for_each_entry - iterate thru all the evsels
 273  * @list: list_head instance to iterate
 274  * @evsel: struct evsel iterator
 275  */
 276 #define __evlist__for_each_entry(list, evsel) \
 277         list_for_each_entry(evsel, list, core.node)
 278
 279 /**
 280  * evlist__for_each_entry - iterate thru all the evsels
 281  * @evlist: evlist instance to iterate
 282  * @evsel: struct evsel iterator
 283  */
 284 #define evlist__for_each_entry(evlist, evsel) \
 285         __evlist__for_each_entry(&(evlist)->core.entries, evsel)
 286
 287 /**
 288  * __evlist__for_each_entry_continue - continue iteration thru all the evsels
 289  * @list: list_head instance to iterate
 290  * @evsel: struct evsel iterator
 291  */
 292 #define __evlist__for_each_entry_continue(list, evsel) \
 293         list_for_each_entry_continue(evsel, list, core.node)
 294
 295 /**
 296  * evlist__for_each_entry_continue - continue iteration thru all the evsels
 297  * @evlist: evlist instance to iterate
 298  * @evsel: struct evsel iterator
 299  */
 300 #define evlist__for_each_entry_continue(evlist, evsel) \
 301         __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
 302
 303 /**
 304  * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 305  * @list: list_head instance to iterate
 306  * @evsel: struct evsel iterator
 307  */
 308 #define __evlist__for_each_entry_reverse(list, evsel) \
 309         list_for_each_entry_reverse(evsel, list, core.node)
 310
 311 /**
 312  * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 313  * @evlist: evlist instance to iterate
 314  * @evsel: struct evsel iterator
 315  */
 316 #define evlist__for_each_entry_reverse(evlist, evsel) \
 317         __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
 318
 319 /**
 320  * __evlist__for_each_entry_safe - safely iterate thru all the evsels
 321  * @list: list_head instance to iterate
 322  * @tmp: struct evsel temp iterator
 323  * @evsel: struct evsel iterator
 324  */
 325 #define __evlist__for_each_entry_safe(list, tmp, evsel) \
 326         list_for_each_entry_safe(evsel, tmp, list, core.node)
 327
 328 /**
 329  * evlist__for_each_entry_safe - safely iterate thru all the evsels
 330  * @evlist: evlist instance to iterate
 331  * @evsel: struct evsel iterator
 332  * @tmp: struct evsel temp iterator
 333  */
 334 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
 335         __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
 336
 337 void perf_evlist__set_tracking_event(struct evlist *evlist,
 338                                      struct evsel *tracking_evsel);
 339
 340 struct evsel *
 341 perf_evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
 342
 343 struct evsel *perf_evlist__event2evsel(struct evlist *evlist,
 344                                             union perf_event *event);
 345
 346 bool perf_evlist__exclude_kernel(struct evlist *evlist);
 347
 348 void perf_evlist__force_leader(struct evlist *evlist);
 349
 350 struct evsel *perf_evlist__reset_weak_group(struct evlist *evlist,
 351                                                  struct evsel *evsel);
 352 #endif /* __PERF_EVLIST_H */