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