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