tools/perf/util/evlist.h

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