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