tools/perf/util/evlist.h

   1 #ifndef __PERF_EVLIST_H
   2 #define __PERF_EVLIST_H 1
   3
   4 #include <linux/atomic.h>
   5 #include <linux/list.h>
   6 #include <api/fd/array.h>
   7 #include <stdio.h>
   8 #include "../perf.h"
   9 #include "event.h"
  10 #include "evsel.h"
  11 #include "util.h"
  12 #include "auxtrace.h"
  13 #include <unistd.h>
  14
  15 struct pollfd;
  16 struct thread_map;
  17 struct cpu_map;
  18 struct record_opts;
  19
  20 #define PERF_EVLIST__HLIST_BITS 8
  21 #define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS)
  22
  23 /**
  24  * struct perf_mmap - perf's ring buffer mmap details
  25  *
  26  * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
  27  */
  28 struct perf_mmap {
  29         void             *base;
  30         int              mask;
  31         int              fd;
  32         atomic_t         refcnt;
  33         u64              prev;
  34         struct auxtrace_mmap auxtrace_mmap;
  35         char             event_copy[PERF_SAMPLE_MAX_SIZE] __attribute__((aligned(8)));
  36 };
  37
  38 static inline size_t
  39 perf_mmap__mmap_len(struct perf_mmap *map)
  40 {
  41         return map->mask + 1 + page_size;
  42 }
  43
  44 /*
  45  * State machine of bkw_mmap_state:
  46  *
  47  *                     .________________(forbid)_____________.
  48  *                     |                                     V
  49  * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
  50  *                     ^  ^              |   ^               |
  51  *                     |  |__(forbid)____/   |___(forbid)___/|
  52  *                     |                                     |
  53  *                      \_________________(3)_______________/
  54  *
  55  * NOTREADY     : Backward ring buffers are not ready
  56  * RUNNING      : Backward ring buffers are recording
  57  * DATA_PENDING : We are required to collect data from backward ring buffers
  58  * EMPTY        : We have collected data from backward ring buffers.
  59  *
  60  * (0): Setup backward ring buffer
  61  * (1): Pause ring buffers for reading
  62  * (2): Read from ring buffers
  63  * (3): Resume ring buffers for recording
  64  */
  65 enum bkw_mmap_state {
  66         BKW_MMAP_NOTREADY,
  67         BKW_MMAP_RUNNING,
  68         BKW_MMAP_DATA_PENDING,
  69         BKW_MMAP_EMPTY,
  70 };
  71
  72 struct perf_evlist {
  73         struct list_head entries;
  74         struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
  75         int              nr_entries;
  76         int              nr_groups;
  77         int              nr_mmaps;
  78         bool             overwrite;
  79         bool             enabled;
  80         bool             has_user_cpus;
  81         size_t           mmap_len;
  82         int              id_pos;
  83         int              is_pos;
  84         u64              combined_sample_type;
  85         enum bkw_mmap_state bkw_mmap_state;
  86         struct {
  87                 int     cork_fd;
  88                 pid_t   pid;
  89         } workload;
  90         struct fdarray   pollfd;
  91         struct perf_mmap *mmap;
  92         struct perf_mmap *backward_mmap;
  93         struct thread_map *threads;
  94         struct cpu_map    *cpus;
  95         struct perf_evsel *selected;
  96         struct events_stats stats;
  97         struct perf_env *env;
  98 };
  99
 100 struct perf_evsel_str_handler {
 101         const char *name;
 102         void       *handler;
 103 };
 104
 105 struct perf_evlist *perf_evlist__new(void);
 106 struct perf_evlist *perf_evlist__new_default(void);
 107 struct perf_evlist *perf_evlist__new_dummy(void);
 108 void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
 109                        struct thread_map *threads);
 110 void perf_evlist__exit(struct perf_evlist *evlist);
 111 void perf_evlist__delete(struct perf_evlist *evlist);
 112
 113 void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
 114 void perf_evlist__remove(struct perf_evlist *evlist, struct perf_evsel *evsel);
 115 int perf_evlist__add_default(struct perf_evlist *evlist);
 116 int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
 117                                      struct perf_event_attr *attrs, size_t nr_attrs);
 118
 119 #define perf_evlist__add_default_attrs(evlist, array) \
 120         __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
 121
 122 int perf_evlist__add_dummy(struct perf_evlist *evlist);
 123
 124 int perf_evlist__add_newtp(struct perf_evlist *evlist,
 125                            const char *sys, const char *name, void *handler);
 126
 127 void __perf_evlist__set_sample_bit(struct perf_evlist *evlist,
 128                                    enum perf_event_sample_format bit);
 129 void __perf_evlist__reset_sample_bit(struct perf_evlist *evlist,
 130                                      enum perf_event_sample_format bit);
 131
 132 #define perf_evlist__set_sample_bit(evlist, bit) \
 133         __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
 134
 135 #define perf_evlist__reset_sample_bit(evlist, bit) \
 136         __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
 137
 138 int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
 139 int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid);
 140 int perf_evlist__set_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids);
 141
 142 struct perf_evsel *
 143 perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
 144
 145 struct perf_evsel *
 146 perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
 147                                      const char *name);
 148
 149 void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
 150                          int cpu, int thread, u64 id);
 151 int perf_evlist__id_add_fd(struct perf_evlist *evlist,
 152                            struct perf_evsel *evsel,
 153                            int cpu, int thread, int fd);
 154
 155 int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
 156 int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
 157 int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);
 158
 159 int perf_evlist__poll(struct perf_evlist *evlist, int timeout);
 160
 161 struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
 162 struct perf_evsel *perf_evlist__id2evsel_strict(struct perf_evlist *evlist,
 163                                                 u64 id);
 164
 165 struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);
 166
 167 void perf_evlist__toggle_bkw_mmap(struct perf_evlist *evlist, enum bkw_mmap_state state);
 168
 169 union perf_event *perf_mmap__read_forward(struct perf_mmap *map, bool check_messup);
 170 union perf_event *perf_mmap__read_backward(struct perf_mmap *map);
 171
 172 void perf_mmap__read_catchup(struct perf_mmap *md);
 173 void perf_mmap__consume(struct perf_mmap *md, bool overwrite);
 174
 175 union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx);
 176
 177 union perf_event *perf_evlist__mmap_read_forward(struct perf_evlist *evlist,
 178                                                  int idx);
 179 union perf_event *perf_evlist__mmap_read_backward(struct perf_evlist *evlist,
 180                                                   int idx);
 181 void perf_evlist__mmap_read_catchup(struct perf_evlist *evlist, int idx);
 182
 183 void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);
 184
 185 int perf_evlist__open(struct perf_evlist *evlist);
 186 void perf_evlist__close(struct perf_evlist *evlist);
 187
 188 struct callchain_param;
 189
 190 void perf_evlist__set_id_pos(struct perf_evlist *evlist);
 191 bool perf_can_sample_identifier(void);
 192 bool perf_can_record_switch_events(void);
 193 bool perf_can_record_cpu_wide(void);
 194 void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts,
 195                          struct callchain_param *callchain);
 196 int record_opts__config(struct record_opts *opts);
 197
 198 int perf_evlist__prepare_workload(struct perf_evlist *evlist,
 199                                   struct target *target,
 200                                   const char *argv[], bool pipe_output,
 201                                   void (*exec_error)(int signo, siginfo_t *info,
 202                                                      void *ucontext));
 203 int perf_evlist__start_workload(struct perf_evlist *evlist);
 204
 205 struct option;
 206
 207 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
 208 int perf_evlist__parse_mmap_pages(const struct option *opt,
 209                                   const char *str,
 210                                   int unset);
 211
 212 unsigned long perf_event_mlock_kb_in_pages(void);
 213
 214 int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,
 215                          bool overwrite, unsigned int auxtrace_pages,
 216                          bool auxtrace_overwrite);
 217 int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
 218                       bool overwrite);
 219 void perf_evlist__munmap(struct perf_evlist *evlist);
 220
 221 size_t perf_evlist__mmap_size(unsigned long pages);
 222
 223 void perf_evlist__disable(struct perf_evlist *evlist);
 224 void perf_evlist__enable(struct perf_evlist *evlist);
 225 void perf_evlist__toggle_enable(struct perf_evlist *evlist);
 226
 227 int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
 228                                   struct perf_evsel *evsel, int idx);
 229
 230 void perf_evlist__set_selected(struct perf_evlist *evlist,
 231                                struct perf_evsel *evsel);
 232
 233 void perf_evlist__set_maps(struct perf_evlist *evlist, struct cpu_map *cpus,
 234                            struct thread_map *threads);
 235 int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
 236 int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel);
 237
 238 void __perf_evlist__set_leader(struct list_head *list);
 239 void perf_evlist__set_leader(struct perf_evlist *evlist);
 240
 241 u64 perf_evlist__read_format(struct perf_evlist *evlist);
 242 u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
 243 u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
 244 u64 perf_evlist__combined_branch_type(struct perf_evlist *evlist);
 245 bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
 246 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
 247
 248 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
 249                               struct perf_sample *sample);
 250
 251 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
 252 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
 253 bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
 254
 255 void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
 256                                    struct list_head *list);
 257
 258 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
 259 {
 260         return list_entry(evlist->entries.next, struct perf_evsel, node);
 261 }
 262
 263 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
 264 {
 265         return list_entry(evlist->entries.prev, struct perf_evsel, node);
 266 }
 267
 268 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
 269
 270 int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
 271 int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size);
 272
 273 static inline u64 perf_mmap__read_head(struct perf_mmap *mm)
 274 {
 275         struct perf_event_mmap_page *pc = mm->base;
 276         u64 head = ACCESS_ONCE(pc->data_head);
 277         rmb();
 278         return head;
 279 }
 280
 281 static inline void perf_mmap__write_tail(struct perf_mmap *md, u64 tail)
 282 {
 283         struct perf_event_mmap_page *pc = md->base;
 284
 285         /*
 286          * ensure all reads are done before we write the tail out.
 287          */
 288         mb();
 289         pc->data_tail = tail;
 290 }
 291
 292 bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
 293 void perf_evlist__to_front(struct perf_evlist *evlist,
 294                            struct perf_evsel *move_evsel);
 295
 296 /**
 297  * __evlist__for_each_entry - iterate thru all the evsels
 298  * @list: list_head instance to iterate
 299  * @evsel: struct evsel iterator
 300  */
 301 #define __evlist__for_each_entry(list, evsel) \
 302         list_for_each_entry(evsel, list, node)
 303
 304 /**
 305  * evlist__for_each_entry - iterate thru all the evsels
 306  * @evlist: evlist instance to iterate
 307  * @evsel: struct evsel iterator
 308  */
 309 #define evlist__for_each_entry(evlist, evsel) \
 310         __evlist__for_each_entry(&(evlist)->entries, evsel)
 311
 312 /**
 313  * __evlist__for_each_entry_continue - continue iteration thru all the evsels
 314  * @list: list_head instance to iterate
 315  * @evsel: struct evsel iterator
 316  */
 317 #define __evlist__for_each_entry_continue(list, evsel) \
 318         list_for_each_entry_continue(evsel, list, node)
 319
 320 /**
 321  * evlist__for_each_entry_continue - continue iteration thru all the evsels
 322  * @evlist: evlist instance to iterate
 323  * @evsel: struct evsel iterator
 324  */
 325 #define evlist__for_each_entry_continue(evlist, evsel) \
 326         __evlist__for_each_entry_continue(&(evlist)->entries, evsel)
 327
 328 /**
 329  * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 330  * @list: list_head instance to iterate
 331  * @evsel: struct evsel iterator
 332  */
 333 #define __evlist__for_each_entry_reverse(list, evsel) \
 334         list_for_each_entry_reverse(evsel, list, node)
 335
 336 /**
 337  * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
 338  * @evlist: evlist instance to iterate
 339  * @evsel: struct evsel iterator
 340  */
 341 #define evlist__for_each_entry_reverse(evlist, evsel) \
 342         __evlist__for_each_entry_reverse(&(evlist)->entries, evsel)
 343
 344 /**
 345  * __evlist__for_each_entry_safe - safely iterate thru all the evsels
 346  * @list: list_head instance to iterate
 347  * @tmp: struct evsel temp iterator
 348  * @evsel: struct evsel iterator
 349  */
 350 #define __evlist__for_each_entry_safe(list, tmp, evsel) \
 351         list_for_each_entry_safe(evsel, tmp, list, node)
 352
 353 /**
 354  * evlist__for_each_entry_safe - safely iterate thru all the evsels
 355  * @evlist: evlist instance to iterate
 356  * @evsel: struct evsel iterator
 357  * @tmp: struct evsel temp iterator
 358  */
 359 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
 360         __evlist__for_each_entry_safe(&(evlist)->entries, tmp, evsel)
 361
 362 void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
 363                                      struct perf_evsel *tracking_evsel);
 364
 365 void perf_event_attr__set_max_precise_ip(struct perf_event_attr *attr);
 366
 367 struct perf_evsel *
 368 perf_evlist__find_evsel_by_str(struct perf_evlist *evlist, const char *str);
 369
 370 struct perf_evsel *perf_evlist__event2evsel(struct perf_evlist *evlist,
 371                                             union perf_event *event);
 372 #endif /* __PERF_EVLIST_H */