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         atomic_t         refcnt;
  32         u64              prev;
  33         struct auxtrace_mmap auxtrace_mmap;
  34         char             event_copy[PERF_SAMPLE_MAX_SIZE] __attribute__((aligned(8)));
  35 };
  36
  37 struct perf_evlist {
  38         struct list_head entries;
  39         struct hlist_head heads[PERF_EVLIST__HLIST_SIZE];
  40         int              nr_entries;
  41         int              nr_groups;
  42         int              nr_mmaps;
  43         bool             overwrite;
  44         bool             enabled;
  45         size_t           mmap_len;
  46         int              id_pos;
  47         int              is_pos;
  48         u64              combined_sample_type;
  49         struct {
  50                 int     cork_fd;
  51                 pid_t   pid;
  52         } workload;
  53         struct fdarray   pollfd;
  54         struct perf_mmap *mmap;
  55         struct thread_map *threads;
  56         struct cpu_map    *cpus;
  57         struct perf_evsel *selected;
  58         struct events_stats stats;
  59         struct perf_env *env;
  60 };
  61
  62 struct perf_evsel_str_handler {
  63         const char *name;
  64         void       *handler;
  65 };
  66
  67 struct perf_evlist *perf_evlist__new(void);
  68 struct perf_evlist *perf_evlist__new_default(void);
  69 void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus,
  70                        struct thread_map *threads);
  71 void perf_evlist__exit(struct perf_evlist *evlist);
  72 void perf_evlist__delete(struct perf_evlist *evlist);
  73
  74 void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry);
  75 int perf_evlist__add_default(struct perf_evlist *evlist);
  76 int __perf_evlist__add_default_attrs(struct perf_evlist *evlist,
  77                                      struct perf_event_attr *attrs, size_t nr_attrs);
  78
  79 #define perf_evlist__add_default_attrs(evlist, array) \
  80         __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
  81
  82 int perf_evlist__add_newtp(struct perf_evlist *evlist,
  83                            const char *sys, const char *name, void *handler);
  84
  85 int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter);
  86 int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid);
  87 int perf_evlist__set_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids);
  88
  89 struct perf_evsel *
  90 perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id);
  91
  92 struct perf_evsel *
  93 perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist,
  94                                      const char *name);
  95
  96 void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel,
  97                          int cpu, int thread, u64 id);
  98
  99 int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd);
 100 int perf_evlist__alloc_pollfd(struct perf_evlist *evlist);
 101 int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask);
 102
 103 int perf_evlist__poll(struct perf_evlist *evlist, int timeout);
 104
 105 struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id);
 106
 107 struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id);
 108
 109 union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx);
 110
 111 void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx);
 112
 113 int perf_evlist__open(struct perf_evlist *evlist);
 114 void perf_evlist__close(struct perf_evlist *evlist);
 115
 116 void perf_evlist__set_id_pos(struct perf_evlist *evlist);
 117 bool perf_can_sample_identifier(void);
 118 bool perf_can_record_switch_events(void);
 119 bool perf_can_record_cpu_wide(void);
 120 void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts);
 121 int record_opts__config(struct record_opts *opts);
 122
 123 int perf_evlist__prepare_workload(struct perf_evlist *evlist,
 124                                   struct target *target,
 125                                   const char *argv[], bool pipe_output,
 126                                   void (*exec_error)(int signo, siginfo_t *info,
 127                                                      void *ucontext));
 128 int perf_evlist__start_workload(struct perf_evlist *evlist);
 129
 130 struct option;
 131
 132 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
 133 int perf_evlist__parse_mmap_pages(const struct option *opt,
 134                                   const char *str,
 135                                   int unset);
 136
 137 int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages,
 138                          bool overwrite, unsigned int auxtrace_pages,
 139                          bool auxtrace_overwrite);
 140 int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages,
 141                       bool overwrite);
 142 void perf_evlist__munmap(struct perf_evlist *evlist);
 143
 144 void perf_evlist__disable(struct perf_evlist *evlist);
 145 void perf_evlist__enable(struct perf_evlist *evlist);
 146 void perf_evlist__toggle_enable(struct perf_evlist *evlist);
 147
 148 int perf_evlist__disable_event(struct perf_evlist *evlist,
 149                                struct perf_evsel *evsel);
 150 int perf_evlist__enable_event(struct perf_evlist *evlist,
 151                               struct perf_evsel *evsel);
 152 int perf_evlist__enable_event_idx(struct perf_evlist *evlist,
 153                                   struct perf_evsel *evsel, int idx);
 154
 155 void perf_evlist__set_selected(struct perf_evlist *evlist,
 156                                struct perf_evsel *evsel);
 157
 158 int perf_evlist__set_maps(struct perf_evlist *evlist,
 159                           struct cpu_map *cpus,
 160                           struct thread_map *threads);
 161 int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
 162 int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel);
 163
 164 void __perf_evlist__set_leader(struct list_head *list);
 165 void perf_evlist__set_leader(struct perf_evlist *evlist);
 166
 167 u64 perf_evlist__read_format(struct perf_evlist *evlist);
 168 u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
 169 u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
 170 u64 perf_evlist__combined_branch_type(struct perf_evlist *evlist);
 171 bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
 172 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
 173
 174 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
 175                               struct perf_sample *sample);
 176
 177 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
 178 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
 179 bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
 180
 181 void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
 182                                    struct list_head *list,
 183                                    int nr_entries);
 184
 185 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
 186 {
 187         return list_entry(evlist->entries.next, struct perf_evsel, node);
 188 }
 189
 190 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
 191 {
 192         return list_entry(evlist->entries.prev, struct perf_evsel, node);
 193 }
 194
 195 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
 196
 197 int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
 198 int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size);
 199
 200 static inline u64 perf_mmap__read_head(struct perf_mmap *mm)
 201 {
 202         struct perf_event_mmap_page *pc = mm->base;
 203         u64 head = ACCESS_ONCE(pc->data_head);
 204         rmb();
 205         return head;
 206 }
 207
 208 static inline void perf_mmap__write_tail(struct perf_mmap *md, u64 tail)
 209 {
 210         struct perf_event_mmap_page *pc = md->base;
 211
 212         /*
 213          * ensure all reads are done before we write the tail out.
 214          */
 215         mb();
 216         pc->data_tail = tail;
 217 }
 218
 219 bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
 220 void perf_evlist__to_front(struct perf_evlist *evlist,
 221                            struct perf_evsel *move_evsel);
 222
 223 /**
 224  * __evlist__for_each - iterate thru all the evsels
 225  * @list: list_head instance to iterate
 226  * @evsel: struct evsel iterator
 227  */
 228 #define __evlist__for_each(list, evsel) \
 229         list_for_each_entry(evsel, list, node)
 230
 231 /**
 232  * evlist__for_each - iterate thru all the evsels
 233  * @evlist: evlist instance to iterate
 234  * @evsel: struct evsel iterator
 235  */
 236 #define evlist__for_each(evlist, evsel) \
 237         __evlist__for_each(&(evlist)->entries, evsel)
 238
 239 /**
 240  * __evlist__for_each_continue - continue iteration thru all the evsels
 241  * @list: list_head instance to iterate
 242  * @evsel: struct evsel iterator
 243  */
 244 #define __evlist__for_each_continue(list, evsel) \
 245         list_for_each_entry_continue(evsel, list, node)
 246
 247 /**
 248  * evlist__for_each_continue - continue iteration thru all the evsels
 249  * @evlist: evlist instance to iterate
 250  * @evsel: struct evsel iterator
 251  */
 252 #define evlist__for_each_continue(evlist, evsel) \
 253         __evlist__for_each_continue(&(evlist)->entries, evsel)
 254
 255 /**
 256  * __evlist__for_each_reverse - iterate thru all the evsels in reverse order
 257  * @list: list_head instance to iterate
 258  * @evsel: struct evsel iterator
 259  */
 260 #define __evlist__for_each_reverse(list, evsel) \
 261         list_for_each_entry_reverse(evsel, list, node)
 262
 263 /**
 264  * evlist__for_each_reverse - iterate thru all the evsels in reverse order
 265  * @evlist: evlist instance to iterate
 266  * @evsel: struct evsel iterator
 267  */
 268 #define evlist__for_each_reverse(evlist, evsel) \
 269         __evlist__for_each_reverse(&(evlist)->entries, evsel)
 270
 271 /**
 272  * __evlist__for_each_safe - safely iterate thru all the evsels
 273  * @list: list_head instance to iterate
 274  * @tmp: struct evsel temp iterator
 275  * @evsel: struct evsel iterator
 276  */
 277 #define __evlist__for_each_safe(list, tmp, evsel) \
 278         list_for_each_entry_safe(evsel, tmp, list, node)
 279
 280 /**
 281  * evlist__for_each_safe - safely iterate thru all the evsels
 282  * @evlist: evlist instance to iterate
 283  * @evsel: struct evsel iterator
 284  * @tmp: struct evsel temp iterator
 285  */
 286 #define evlist__for_each_safe(evlist, tmp, evsel) \
 287         __evlist__for_each_safe(&(evlist)->entries, tmp, evsel)
 288
 289 void perf_evlist__set_tracking_event(struct perf_evlist *evlist,
 290                                      struct perf_evsel *tracking_evsel);
 291 #endif /* __PERF_EVLIST_H */