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
 126 void perf_evlist__set_selected(struct perf_evlist *evlist,
 127                                struct perf_evsel *evsel);
 128
 129 static inline void perf_evlist__set_maps(struct perf_evlist *evlist,
 130                                          struct cpu_map *cpus,
 131                                          struct thread_map *threads)
 132 {
 133         evlist->cpus    = cpus;
 134         evlist->threads = threads;
 135 }
 136
 137 int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target);
 138 int perf_evlist__apply_filters(struct perf_evlist *evlist);
 139
 140 void __perf_evlist__set_leader(struct list_head *list);
 141 void perf_evlist__set_leader(struct perf_evlist *evlist);
 142
 143 u64 perf_evlist__read_format(struct perf_evlist *evlist);
 144 u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist);
 145 u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist);
 146 bool perf_evlist__sample_id_all(struct perf_evlist *evlist);
 147 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist);
 148
 149 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event,
 150                               struct perf_sample *sample);
 151
 152 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist);
 153 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist);
 154 bool perf_evlist__valid_read_format(struct perf_evlist *evlist);
 155
 156 void perf_evlist__splice_list_tail(struct perf_evlist *evlist,
 157                                    struct list_head *list,
 158                                    int nr_entries);
 159
 160 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist)
 161 {
 162         return list_entry(evlist->entries.next, struct perf_evsel, node);
 163 }
 164
 165 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist)
 166 {
 167         return list_entry(evlist->entries.prev, struct perf_evsel, node);
 168 }
 169
 170 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp);
 171
 172 int perf_evlist__strerror_tp(struct perf_evlist *evlist, int err, char *buf, size_t size);
 173 int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size);
 174
 175 static inline unsigned int perf_mmap__read_head(struct perf_mmap *mm)
 176 {
 177         struct perf_event_mmap_page *pc = mm->base;
 178         int head = ACCESS_ONCE(pc->data_head);
 179         rmb();
 180         return head;
 181 }
 182
 183 static inline void perf_mmap__write_tail(struct perf_mmap *md,
 184                                          unsigned long tail)
 185 {
 186         struct perf_event_mmap_page *pc = md->base;
 187
 188         /*
 189          * ensure all reads are done before we write the tail out.
 190          */
 191         mb();
 192         pc->data_tail = tail;
 193 }
 194
 195 bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str);
 196 void perf_evlist__to_front(struct perf_evlist *evlist,
 197                            struct perf_evsel *move_evsel);
 198
 199 /**
 200  * __evlist__for_each - iterate thru all the evsels
 201  * @list: list_head instance to iterate
 202  * @evsel: struct evsel iterator
 203  */
 204 #define __evlist__for_each(list, evsel) \
 205         list_for_each_entry(evsel, list, node)
 206
 207 /**
 208  * evlist__for_each - iterate thru all the evsels
 209  * @evlist: evlist instance to iterate
 210  * @evsel: struct evsel iterator
 211  */
 212 #define evlist__for_each(evlist, evsel) \
 213         __evlist__for_each(&(evlist)->entries, evsel)
 214
 215 /**
 216  * __evlist__for_each_continue - continue iteration thru all the evsels
 217  * @list: list_head instance to iterate
 218  * @evsel: struct evsel iterator
 219  */
 220 #define __evlist__for_each_continue(list, evsel) \
 221         list_for_each_entry_continue(evsel, list, node)
 222
 223 /**
 224  * evlist__for_each_continue - continue iteration thru all the evsels
 225  * @evlist: evlist instance to iterate
 226  * @evsel: struct evsel iterator
 227  */
 228 #define evlist__for_each_continue(evlist, evsel) \
 229         __evlist__for_each_continue(&(evlist)->entries, evsel)
 230
 231 /**
 232  * __evlist__for_each_reverse - iterate thru all the evsels in reverse order
 233  * @list: list_head instance to iterate
 234  * @evsel: struct evsel iterator
 235  */
 236 #define __evlist__for_each_reverse(list, evsel) \
 237         list_for_each_entry_reverse(evsel, list, node)
 238
 239 /**
 240  * evlist__for_each_reverse - iterate thru all the evsels in reverse order
 241  * @evlist: evlist instance to iterate
 242  * @evsel: struct evsel iterator
 243  */
 244 #define evlist__for_each_reverse(evlist, evsel) \
 245         __evlist__for_each_reverse(&(evlist)->entries, evsel)
 246
 247 /**
 248  * __evlist__for_each_safe - safely iterate thru all the evsels
 249  * @list: list_head instance to iterate
 250  * @tmp: struct evsel temp iterator
 251  * @evsel: struct evsel iterator
 252  */
 253 #define __evlist__for_each_safe(list, tmp, evsel) \
 254         list_for_each_entry_safe(evsel, tmp, list, node)
 255
 256 /**
 257  * evlist__for_each_safe - safely iterate thru all the evsels
 258  * @evlist: evlist instance to iterate
 259  * @evsel: struct evsel iterator
 260  * @tmp: struct evsel temp iterator
 261  */
 262 #define evlist__for_each_safe(evlist, tmp, evsel) \
 263         __evlist__for_each_safe(&(evlist)->entries, tmp, evsel)
 264
 265 #endif /* __PERF_EVLIST_H */