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