1 #ifndef __PERF_EVLIST_H 2 #define __PERF_EVLIST_H 1 3 4 #include <linux/compiler.h> 5 #include <linux/kernel.h> 6 #include <linux/refcount.h> 7 #include <linux/list.h> 8 #include <api/fd/array.h> 9 #include <stdio.h> 10 #include "../perf.h" 11 #include "event.h" 12 #include "evsel.h" 13 #include "util.h" 14 #include "auxtrace.h" 15 #include <signal.h> 16 #include <unistd.h> 17 18 struct pollfd; 19 struct thread_map; 20 struct cpu_map; 21 struct record_opts; 22 23 #define PERF_EVLIST__HLIST_BITS 8 24 #define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS) 25 26 /** 27 * struct perf_mmap - perf's ring buffer mmap details 28 * 29 * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this 30 */ 31 struct perf_mmap { 32 void *base; 33 int mask; 34 int fd; 35 refcount_t refcnt; 36 u64 prev; 37 struct auxtrace_mmap auxtrace_mmap; 38 char event_copy[PERF_SAMPLE_MAX_SIZE] __aligned(8); 39 }; 40 41 static inline size_t 42 perf_mmap__mmap_len(struct perf_mmap *map) 43 { 44 return map->mask + 1 + page_size; 45 } 46 47 /* 48 * State machine of bkw_mmap_state: 49 * 50 * .________________(forbid)_____________. 51 * | V 52 * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY 53 * ^ ^ | ^ | 54 * | |__(forbid)____/ |___(forbid)___/| 55 * | | 56 * \_________________(3)_______________/ 57 * 58 * NOTREADY : Backward ring buffers are not ready 59 * RUNNING : Backward ring buffers are recording 60 * DATA_PENDING : We are required to collect data from backward ring buffers 61 * EMPTY : We have collected data from backward ring buffers. 62 * 63 * (0): Setup backward ring buffer 64 * (1): Pause ring buffers for reading 65 * (2): Read from ring buffers 66 * (3): Resume ring buffers for recording 67 */ 68 enum bkw_mmap_state { 69 BKW_MMAP_NOTREADY, 70 BKW_MMAP_RUNNING, 71 BKW_MMAP_DATA_PENDING, 72 BKW_MMAP_EMPTY, 73 }; 74 75 struct perf_evlist { 76 struct list_head entries; 77 struct hlist_head heads[PERF_EVLIST__HLIST_SIZE]; 78 int nr_entries; 79 int nr_groups; 80 int nr_mmaps; 81 bool overwrite; 82 bool enabled; 83 bool has_user_cpus; 84 size_t mmap_len; 85 int id_pos; 86 int is_pos; 87 u64 combined_sample_type; 88 enum bkw_mmap_state bkw_mmap_state; 89 struct { 90 int cork_fd; 91 pid_t pid; 92 } workload; 93 struct fdarray pollfd; 94 struct perf_mmap *mmap; 95 struct perf_mmap *backward_mmap; 96 struct thread_map *threads; 97 struct cpu_map *cpus; 98 struct perf_evsel *selected; 99 struct events_stats stats; 100 struct perf_env *env; 101 }; 102 103 struct perf_evsel_str_handler { 104 const char *name; 105 void *handler; 106 }; 107 108 struct perf_evlist *perf_evlist__new(void); 109 struct perf_evlist *perf_evlist__new_default(void); 110 struct perf_evlist *perf_evlist__new_dummy(void); 111 void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus, 112 struct thread_map *threads); 113 void perf_evlist__exit(struct perf_evlist *evlist); 114 void perf_evlist__delete(struct perf_evlist *evlist); 115 116 void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry); 117 void perf_evlist__remove(struct perf_evlist *evlist, struct perf_evsel *evsel); 118 119 int __perf_evlist__add_default(struct perf_evlist *evlist, bool precise); 120 121 static inline int perf_evlist__add_default(struct perf_evlist *evlist) 122 { 123 return __perf_evlist__add_default(evlist, true); 124 } 125 126 int __perf_evlist__add_default_attrs(struct perf_evlist *evlist, 127 struct perf_event_attr *attrs, size_t nr_attrs); 128 129 #define perf_evlist__add_default_attrs(evlist, array) \ 130 __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array)) 131 132 int perf_evlist__add_dummy(struct perf_evlist *evlist); 133 134 int perf_evlist__add_newtp(struct perf_evlist *evlist, 135 const char *sys, const char *name, void *handler); 136 137 void __perf_evlist__set_sample_bit(struct perf_evlist *evlist, 138 enum perf_event_sample_format bit); 139 void __perf_evlist__reset_sample_bit(struct perf_evlist *evlist, 140 enum perf_event_sample_format bit); 141 142 #define perf_evlist__set_sample_bit(evlist, bit) \ 143 __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit) 144 145 #define perf_evlist__reset_sample_bit(evlist, bit) \ 146 __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit) 147 148 int perf_evlist__set_filter(struct perf_evlist *evlist, const char *filter); 149 int perf_evlist__set_filter_pid(struct perf_evlist *evlist, pid_t pid); 150 int perf_evlist__set_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids); 151 152 struct perf_evsel * 153 perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id); 154 155 struct perf_evsel * 156 perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist, 157 const char *name); 158 159 void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel, 160 int cpu, int thread, u64 id); 161 int perf_evlist__id_add_fd(struct perf_evlist *evlist, 162 struct perf_evsel *evsel, 163 int cpu, int thread, int fd); 164 165 int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd); 166 int perf_evlist__alloc_pollfd(struct perf_evlist *evlist); 167 int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask); 168 169 int perf_evlist__poll(struct perf_evlist *evlist, int timeout); 170 171 struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id); 172 struct perf_evsel *perf_evlist__id2evsel_strict(struct perf_evlist *evlist, 173 u64 id); 174 175 struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id); 176 177 void perf_evlist__toggle_bkw_mmap(struct perf_evlist *evlist, enum bkw_mmap_state state); 178 179 union perf_event *perf_mmap__read_forward(struct perf_mmap *map, bool check_messup); 180 union perf_event *perf_mmap__read_backward(struct perf_mmap *map); 181 182 void perf_mmap__read_catchup(struct perf_mmap *md); 183 void perf_mmap__consume(struct perf_mmap *md, bool overwrite); 184 185 union perf_event *perf_evlist__mmap_read(struct perf_evlist *evlist, int idx); 186 187 union perf_event *perf_evlist__mmap_read_forward(struct perf_evlist *evlist, 188 int idx); 189 union perf_event *perf_evlist__mmap_read_backward(struct perf_evlist *evlist, 190 int idx); 191 void perf_evlist__mmap_read_catchup(struct perf_evlist *evlist, int idx); 192 193 void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx); 194 195 int perf_evlist__open(struct perf_evlist *evlist); 196 void perf_evlist__close(struct perf_evlist *evlist); 197 198 struct callchain_param; 199 200 void perf_evlist__set_id_pos(struct perf_evlist *evlist); 201 bool perf_can_sample_identifier(void); 202 bool perf_can_record_switch_events(void); 203 bool perf_can_record_cpu_wide(void); 204 void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts, 205 struct callchain_param *callchain); 206 int record_opts__config(struct record_opts *opts); 207 208 int perf_evlist__prepare_workload(struct perf_evlist *evlist, 209 struct target *target, 210 const char *argv[], bool pipe_output, 211 void (*exec_error)(int signo, siginfo_t *info, 212 void *ucontext)); 213 int perf_evlist__start_workload(struct perf_evlist *evlist); 214 215 struct option; 216 217 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str); 218 int perf_evlist__parse_mmap_pages(const struct option *opt, 219 const char *str, 220 int unset); 221 222 unsigned long perf_event_mlock_kb_in_pages(void); 223 224 int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages, 225 bool overwrite, unsigned int auxtrace_pages, 226 bool auxtrace_overwrite); 227 int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages, 228 bool overwrite); 229 void perf_evlist__munmap(struct perf_evlist *evlist); 230 231 size_t perf_evlist__mmap_size(unsigned long pages); 232 233 void perf_evlist__disable(struct perf_evlist *evlist); 234 void perf_evlist__enable(struct perf_evlist *evlist); 235 void perf_evlist__toggle_enable(struct perf_evlist *evlist); 236 237 int perf_evlist__enable_event_idx(struct perf_evlist *evlist, 238 struct perf_evsel *evsel, int idx); 239 240 void perf_evlist__set_selected(struct perf_evlist *evlist, 241 struct perf_evsel *evsel); 242 243 void perf_evlist__set_maps(struct perf_evlist *evlist, struct cpu_map *cpus, 244 struct thread_map *threads); 245 int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target); 246 int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel); 247 248 void __perf_evlist__set_leader(struct list_head *list); 249 void perf_evlist__set_leader(struct perf_evlist *evlist); 250 251 u64 perf_evlist__read_format(struct perf_evlist *evlist); 252 u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist); 253 u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist); 254 u64 perf_evlist__combined_branch_type(struct perf_evlist *evlist); 255 bool perf_evlist__sample_id_all(struct perf_evlist *evlist); 256 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist); 257 258 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event, 259 struct perf_sample *sample); 260 261 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist); 262 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist); 263 bool perf_evlist__valid_read_format(struct perf_evlist *evlist); 264 265 void perf_evlist__splice_list_tail(struct perf_evlist *evlist, 266 struct list_head *list); 267 268 static inline bool perf_evlist__empty(struct perf_evlist *evlist) 269 { 270 return list_empty(&evlist->entries); 271 } 272 273 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist) 274 { 275 return list_entry(evlist->entries.next, struct perf_evsel, node); 276 } 277 278 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist) 279 { 280 return list_entry(evlist->entries.prev, struct perf_evsel, node); 281 } 282 283 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp); 284 285 int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size); 286 int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size); 287 288 static inline u64 perf_mmap__read_head(struct perf_mmap *mm) 289 { 290 struct perf_event_mmap_page *pc = mm->base; 291 u64 head = ACCESS_ONCE(pc->data_head); 292 rmb(); 293 return head; 294 } 295 296 static inline void perf_mmap__write_tail(struct perf_mmap *md, u64 tail) 297 { 298 struct perf_event_mmap_page *pc = md->base; 299 300 /* 301 * ensure all reads are done before we write the tail out. 302 */ 303 mb(); 304 pc->data_tail = tail; 305 } 306 307 bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str); 308 void perf_evlist__to_front(struct perf_evlist *evlist, 309 struct perf_evsel *move_evsel); 310 311 /** 312 * __evlist__for_each_entry - iterate thru all the evsels 313 * @list: list_head instance to iterate 314 * @evsel: struct evsel iterator 315 */ 316 #define __evlist__for_each_entry(list, evsel) \ 317 list_for_each_entry(evsel, list, node) 318 319 /** 320 * evlist__for_each_entry - iterate thru all the evsels 321 * @evlist: evlist instance to iterate 322 * @evsel: struct evsel iterator 323 */ 324 #define evlist__for_each_entry(evlist, evsel) \ 325 __evlist__for_each_entry(&(evlist)->entries, evsel) 326 327 /** 328 * __evlist__for_each_entry_continue - continue iteration thru all the evsels 329 * @list: list_head instance to iterate 330 * @evsel: struct evsel iterator 331 */ 332 #define __evlist__for_each_entry_continue(list, evsel) \ 333 list_for_each_entry_continue(evsel, list, node) 334 335 /** 336 * evlist__for_each_entry_continue - continue iteration thru all the evsels 337 * @evlist: evlist instance to iterate 338 * @evsel: struct evsel iterator 339 */ 340 #define evlist__for_each_entry_continue(evlist, evsel) \ 341 __evlist__for_each_entry_continue(&(evlist)->entries, evsel) 342 343 /** 344 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 345 * @list: list_head instance to iterate 346 * @evsel: struct evsel iterator 347 */ 348 #define __evlist__for_each_entry_reverse(list, evsel) \ 349 list_for_each_entry_reverse(evsel, list, node) 350 351 /** 352 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 353 * @evlist: evlist instance to iterate 354 * @evsel: struct evsel iterator 355 */ 356 #define evlist__for_each_entry_reverse(evlist, evsel) \ 357 __evlist__for_each_entry_reverse(&(evlist)->entries, evsel) 358 359 /** 360 * __evlist__for_each_entry_safe - safely iterate thru all the evsels 361 * @list: list_head instance to iterate 362 * @tmp: struct evsel temp iterator 363 * @evsel: struct evsel iterator 364 */ 365 #define __evlist__for_each_entry_safe(list, tmp, evsel) \ 366 list_for_each_entry_safe(evsel, tmp, list, node) 367 368 /** 369 * evlist__for_each_entry_safe - safely iterate thru all the evsels 370 * @evlist: evlist instance to iterate 371 * @evsel: struct evsel iterator 372 * @tmp: struct evsel temp iterator 373 */ 374 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \ 375 __evlist__for_each_entry_safe(&(evlist)->entries, tmp, evsel) 376 377 void perf_evlist__set_tracking_event(struct perf_evlist *evlist, 378 struct perf_evsel *tracking_evsel); 379 380 void perf_event_attr__set_max_precise_ip(struct perf_event_attr *attr); 381 382 struct perf_evsel * 383 perf_evlist__find_evsel_by_str(struct perf_evlist *evlist, const char *str); 384 385 struct perf_evsel *perf_evlist__event2evsel(struct perf_evlist *evlist, 386 union perf_event *event); 387 #endif /* __PERF_EVLIST_H */ 388