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 <stdio.h>
  11 #include <internal/evlist.h>
  12 #include <internal/evsel.h>
  13 #include "events_stats.h"
  14 #include "evsel.h"
  15 #include <pthread.h>
  16 #include <signal.h>
  17 #include <unistd.h>
  18
  19 struct pollfd;
  20 struct thread_map;
  21 struct perf_cpu_map;
  22 struct record_opts;
  23
  24 /*
  25  * State machine of bkw_mmap_state:
  26  *
  27  *                     .________________(forbid)_____________.
  28  *                     |                                     V
  29  * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
  30  *                     ^  ^              |   ^               |
  31  *                     |  |__(forbid)____/   |___(forbid)___/|
  32  *                     |                                     |
  33  *                      \_________________(3)_______________/
  34  *
  35  * NOTREADY     : Backward ring buffers are not ready
  36  * RUNNING      : Backward ring buffers are recording
  37  * DATA_PENDING : We are required to collect data from backward ring buffers
  38  * EMPTY        : We have collected data from backward ring buffers.
  39  *
  40  * (0): Setup backward ring buffer
  41  * (1): Pause ring buffers for reading
  42  * (2): Read from ring buffers
  43  * (3): Resume ring buffers for recording
  44  */
  45 enum bkw_mmap_state {
  46         BKW_MMAP_NOTREADY,
  47         BKW_MMAP_RUNNING,
  48         BKW_MMAP_DATA_PENDING,
  49         BKW_MMAP_EMPTY,
  50 };
  51
  52 struct evlist {
  53         struct perf_evlist core;
  54         int              nr_groups;
  55         bool             enabled;
  56         int              id_pos;
  57         int              is_pos;
  58         u64              combined_sample_type;
  59         enum bkw_mmap_state bkw_mmap_state;
  60         struct {
  61                 int     cork_fd;
  62                 pid_t   pid;
  63         } workload;
  64         struct mmap *mmap;
  65         struct mmap *overwrite_mmap;
  66         struct evsel *selected;
  67         struct events_stats stats;
  68         struct perf_env *env;
  69         void (*trace_event_sample_raw)(struct evlist *evlist,
  70                                        union perf_event *event,
  71                                        struct perf_sample *sample);
  72         u64             first_sample_time;
  73         u64             last_sample_time;
  74         struct {
  75                 pthread_t               th;
  76                 volatile int            done;
  77         } thread;
  78 };
  79
  80 struct evsel_str_handler {
  81         const char *name;
  82         void       *handler;
  83 };
  84
  85 struct evlist *evlist__new(void);
  86 struct evlist *perf_evlist__new_default(void);
  87 struct evlist *perf_evlist__new_dummy(void);
  88 void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus,
  89                   struct perf_thread_map *threads);
  90 void evlist__exit(struct evlist *evlist);
  91 void evlist__delete(struct evlist *evlist);
  92
  93 void evlist__add(struct evlist *evlist, struct evsel *entry);
  94 void evlist__remove(struct evlist *evlist, struct evsel *evsel);
  95
  96 int __perf_evlist__add_default(struct evlist *evlist, bool precise);
  97
  98 static inline int perf_evlist__add_default(struct evlist *evlist)
  99 {
 100         return __perf_evlist__add_default(evlist, true);
 101 }
 102
 103 int __perf_evlist__add_default_attrs(struct evlist *evlist,
 104                                      struct perf_event_attr *attrs, size_t nr_attrs);
 105
 106 #define perf_evlist__add_default_attrs(evlist, array) \
 107         __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
 108
 109 int perf_evlist__add_dummy(struct evlist *evlist);
 110
 111 int perf_evlist__add_sb_event(struct evlist **evlist,
 112                               struct perf_event_attr *attr,
 113                               perf_evsel__sb_cb_t cb,
 114                               void *data);
 115 int perf_evlist__start_sb_thread(struct evlist *evlist,
 116                                  struct target *target);
 117 void perf_evlist__stop_sb_thread(struct evlist *evlist);
 118
 119 int perf_evlist__add_newtp(struct evlist *evlist,
 120                            const char *sys, const char *name, void *handler);
 121
 122 void __perf_evlist__set_sample_bit(struct evlist *evlist,
 123                                    enum perf_event_sample_format bit);
 124 void __perf_evlist__reset_sample_bit(struct evlist *evlist,
 125                                      enum perf_event_sample_format bit);
 126
 127 #define perf_evlist__set_sample_bit(evlist, bit) \
 128         __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
 129
 130 #define perf_evlist__reset_sample_bit(evlist, bit) \
 131         __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
 132
 133 int perf_evlist__set_tp_filter(struct evlist *evlist, const char *filter);
 134 int perf_evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid);
 135 int perf_evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
 136
 137 struct evsel *
 138 perf_evlist__find_tracepoint_by_id(struct evlist *evlist, int id);
 139
 140 struct evsel *
 141 perf_evlist__find_tracepoint_by_name(struct evlist *evlist,
 142                                      const char *name);
 143
 144 int evlist__add_pollfd(struct evlist *evlist, int fd);
 145 int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
 146
 147 int evlist__poll(struct evlist *evlist, int timeout);
 148
 149 struct evsel *perf_evlist__id2evsel(struct evlist *evlist, u64 id);
 150 struct evsel *perf_evlist__id2evsel_strict(struct evlist *evlist,
 151                                                 u64 id);
 152
 153 struct perf_sample_id *perf_evlist__id2sid(struct evlist *evlist, u64 id);
 154
 155 void perf_evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
 156
 157 void evlist__mmap_consume(struct evlist *evlist, int idx);
 158
 159 int evlist__open(struct evlist *evlist);
 160 void evlist__close(struct evlist *evlist);
 161
 162 struct callchain_param;
 163
 164 void perf_evlist__set_id_pos(struct evlist *evlist);
 165 bool perf_can_sample_identifier(void);
 166 bool perf_can_record_switch_events(void);
 167 bool perf_can_record_cpu_wide(void);
 168 void perf_evlist__config(struct evlist *evlist, struct record_opts *opts,
 169                          struct callchain_param *callchain);
 170 int record_opts__config(struct record_opts *opts);
 171
 172 int perf_evlist__prepare_workload(struct evlist *evlist,
 173                                   struct target *target,
 174                                   const char *argv[], bool pipe_output,
 175                                   void (*exec_error)(int signo, siginfo_t *info,
 176                                                      void *ucontext));
 177 int perf_evlist__start_workload(struct evlist *evlist);
 178
 179 struct option;
 180
 181 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
 182 int perf_evlist__parse_mmap_pages(const struct option *opt,
 183                                   const char *str,
 184                                   int unset);
 185
 186 unsigned long perf_event_mlock_kb_in_pages(void);
 187
 188 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
 189                          unsigned int auxtrace_pages,
 190                          bool auxtrace_overwrite, int nr_cblocks,
 191                          int affinity, int flush, int comp_level);
 192 int evlist__mmap(struct evlist *evlist, unsigned int pages);
 193 void evlist__munmap(struct evlist *evlist);
 194
 195 size_t evlist__mmap_size(unsigned long pages);
 196
 197 void evlist__disable(struct evlist *evlist);
 198 void evlist__enable(struct evlist *evlist);
 199 void perf_evlist__toggle_enable(struct evlist *evlist);
 200
 201 int perf_evlist__enable_event_idx(struct evlist *evlist,
 202                                   struct evsel *evsel, int idx);
 203
 204 void perf_evlist__set_selected(struct evlist *evlist,
 205                                struct evsel *evsel);
 206
 207 int perf_evlist__create_maps(struct evlist *evlist, struct target *target);
 208 int perf_evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel);
 209
 210 void __perf_evlist__set_leader(struct list_head *list);
 211 void perf_evlist__set_leader(struct evlist *evlist);
 212
 213 u64 __perf_evlist__combined_sample_type(struct evlist *evlist);
 214 u64 perf_evlist__combined_sample_type(struct evlist *evlist);
 215 u64 perf_evlist__combined_branch_type(struct evlist *evlist);
 216 bool perf_evlist__sample_id_all(struct evlist *evlist);
 217 u16 perf_evlist__id_hdr_size(struct evlist *evlist);
 218
 219 int perf_evlist__parse_sample(struct evlist *evlist, union perf_event *event,
 220                               struct perf_sample *sample);
 221
 222 int perf_evlist__parse_sample_timestamp(struct evlist *evlist,
 223                                         union perf_event *event,
 224                                         u64 *timestamp);
 225
 226 bool perf_evlist__valid_sample_type(struct evlist *evlist);
 227 bool perf_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 size_t perf_evlist__fprintf(struct evlist *evlist, FILE *fp);
 253
 254 int perf_evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
 255 int perf_evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
 256
 257 bool perf_evlist__can_select_event(struct evlist *evlist, const char *str);
 258 void perf_evlist__to_front(struct evlist *evlist,
 259                            struct evsel *move_evsel);
 260
 261 /**
 262  * __evlist__for_each_entry - iterate thru all the evsels
 263  * @list: list_head instance to iterate
 264  * @evsel: struct evsel iterator
 265  */
 266 #define __evlist__for_each_entry(list, evsel) \
 267         list_for_each_entry(evsel, list, core.node)
 268
 269 /**
 270  * evlist__for_each_entry - iterate thru all the evsels
 271  * @evlist: evlist instance to iterate
 272  * @evsel: struct evsel iterator
 273  */
 274 #define evlist__for_each_entry(evlist, evsel) \
 275         __evlist__for_each_entry(&(evlist)->core.entries, evsel)
 276
 277 /**
 278  * __evlist__for_each_entry_continue - continue iteration thru all the evsels
 279  * @list: list_head instance to iterate
 280  * @evsel: struct evsel iterator
 281  */
 282 #define __evlist__for_each_entry_continue(list, evsel) \
 283         list_for_each_entry_continue(evsel, list, core.node)
 284
 285 /**
 286  * evlist__for_each_entry_continue - continue iteration thru all the evsels
 287  * @evlist: evlist instance to iterate
 288  * @evsel: struct evsel iterator
 289  */
 290 #define evlist__for_each_entry_continue(evlist, evsel) \
 291         __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
 292
 293 /**
 294  * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 295  * @list: list_head instance to iterate
 296  * @evsel: struct evsel iterator
 297  */
 298 #define __evlist__for_each_entry_reverse(list, evsel) \
 299         list_for_each_entry_reverse(evsel, list, core.node)
 300
 301 /**
 302  * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 303  * @evlist: evlist instance to iterate
 304  * @evsel: struct evsel iterator
 305  */
 306 #define evlist__for_each_entry_reverse(evlist, evsel) \
 307         __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
 308
 309 /**
 310  * __evlist__for_each_entry_safe - safely iterate thru all the evsels
 311  * @list: list_head instance to iterate
 312  * @tmp: struct evsel temp iterator
 313  * @evsel: struct evsel iterator
 314  */
 315 #define __evlist__for_each_entry_safe(list, tmp, evsel) \
 316         list_for_each_entry_safe(evsel, tmp, list, core.node)
 317
 318 /**
 319  * evlist__for_each_entry_safe - safely iterate thru all the evsels
 320  * @evlist: evlist instance to iterate
 321  * @evsel: struct evsel iterator
 322  * @tmp: struct evsel temp iterator
 323  */
 324 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
 325         __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
 326
 327 void perf_evlist__set_tracking_event(struct evlist *evlist,
 328                                      struct evsel *tracking_evsel);
 329
 330 struct evsel *
 331 perf_evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
 332
 333 struct evsel *perf_evlist__event2evsel(struct evlist *evlist,
 334                                             union perf_event *event);
 335
 336 bool perf_evlist__exclude_kernel(struct evlist *evlist);
 337
 338 void perf_evlist__force_leader(struct evlist *evlist);
 339
 340 struct evsel *perf_evlist__reset_weak_group(struct evlist *evlist,
 341                                                  struct evsel *evsel);
 342 #endif /* __PERF_EVLIST_H */