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