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