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