1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PERF_EVLIST_H 3 #define __PERF_EVLIST_H 1 4 5 #include <linux/compiler.h> 6 #include <linux/kernel.h> 7 #include <linux/refcount.h> 8 #include <linux/list.h> 9 #include <api/fd/array.h> 10 #include <internal/evlist.h> 11 #include <internal/evsel.h> 12 #include <perf/evlist.h> 13 #include "events_stats.h" 14 #include "evsel.h" 15 #include <pthread.h> 16 #include <signal.h> 17 #include <unistd.h> 18 19 struct pollfd; 20 struct thread_map; 21 struct perf_cpu_map; 22 struct record_opts; 23 struct target; 24 25 /* 26 * State machine of bkw_mmap_state: 27 * 28 * .________________(forbid)_____________. 29 * | V 30 * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY 31 * ^ ^ | ^ | 32 * | |__(forbid)____/ |___(forbid)___/| 33 * | | 34 * \_________________(3)_______________/ 35 * 36 * NOTREADY : Backward ring buffers are not ready 37 * RUNNING : Backward ring buffers are recording 38 * DATA_PENDING : We are required to collect data from backward ring buffers 39 * EMPTY : We have collected data from backward ring buffers. 40 * 41 * (0): Setup backward ring buffer 42 * (1): Pause ring buffers for reading 43 * (2): Read from ring buffers 44 * (3): Resume ring buffers for recording 45 */ 46 enum bkw_mmap_state { 47 BKW_MMAP_NOTREADY, 48 BKW_MMAP_RUNNING, 49 BKW_MMAP_DATA_PENDING, 50 BKW_MMAP_EMPTY, 51 }; 52 53 struct event_enable_timer; 54 55 struct evlist { 56 struct perf_evlist core; 57 bool enabled; 58 int id_pos; 59 int is_pos; 60 int nr_br_cntr; 61 u64 combined_sample_type; 62 enum bkw_mmap_state bkw_mmap_state; 63 struct { 64 int cork_fd; 65 pid_t pid; 66 } workload; 67 struct mmap *mmap; 68 struct mmap *overwrite_mmap; 69 struct evsel *selected; 70 struct events_stats stats; 71 struct perf_env *env; 72 void (*trace_event_sample_raw)(struct evlist *evlist, 73 union perf_event *event, 74 struct perf_sample *sample); 75 u64 first_sample_time; 76 u64 last_sample_time; 77 struct { 78 pthread_t th; 79 volatile int done; 80 } thread; 81 struct { 82 int fd; /* control file descriptor */ 83 int ack; /* ack file descriptor for control commands */ 84 int pos; /* index at evlist core object to check signals */ 85 } ctl_fd; 86 struct event_enable_timer *eet; 87 }; 88 89 struct evsel_str_handler { 90 const char *name; 91 void *handler; 92 }; 93 94 struct evlist *evlist__new(void); 95 struct evlist *evlist__new_default(void); 96 struct evlist *evlist__new_dummy(void); 97 void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus, 98 struct perf_thread_map *threads); 99 void evlist__exit(struct evlist *evlist); 100 void evlist__delete(struct evlist *evlist); 101 102 void evlist__add(struct evlist *evlist, struct evsel *entry); 103 void evlist__remove(struct evlist *evlist, struct evsel *evsel); 104 105 int evlist__add_attrs(struct evlist *evlist, struct perf_event_attr *attrs, size_t nr_attrs); 106 107 int __evlist__add_default_attrs(struct evlist *evlist, 108 struct perf_event_attr *attrs, size_t nr_attrs); 109 110 int arch_evlist__add_default_attrs(struct evlist *evlist, 111 struct perf_event_attr *attrs, 112 size_t nr_attrs); 113 114 #define evlist__add_default_attrs(evlist, array) \ 115 arch_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array)) 116 117 int arch_evlist__cmp(const struct evsel *lhs, const struct evsel *rhs); 118 119 int evlist__add_dummy(struct evlist *evlist); 120 struct evsel *evlist__add_aux_dummy(struct evlist *evlist, bool system_wide); evlist__add_dummy_on_all_cpus(struct evlist * evlist)121 static inline struct evsel *evlist__add_dummy_on_all_cpus(struct evlist *evlist) 122 { 123 return evlist__add_aux_dummy(evlist, true); 124 } 125 #ifdef HAVE_LIBTRACEEVENT 126 struct evsel *evlist__add_sched_switch(struct evlist *evlist, bool system_wide); 127 #endif 128 129 int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr, 130 evsel__sb_cb_t cb, void *data); 131 void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data); 132 int evlist__start_sb_thread(struct evlist *evlist, struct target *target); 133 void evlist__stop_sb_thread(struct evlist *evlist); 134 135 #ifdef HAVE_LIBTRACEEVENT 136 int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler); 137 #endif 138 139 int __evlist__set_tracepoints_handlers(struct evlist *evlist, 140 const struct evsel_str_handler *assocs, 141 size_t nr_assocs); 142 143 #define evlist__set_tracepoints_handlers(evlist, array) \ 144 __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array)) 145 146 int evlist__set_tp_filter(struct evlist *evlist, const char *filter); 147 int evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid); 148 int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 149 150 int evlist__append_tp_filter(struct evlist *evlist, const char *filter); 151 152 int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid); 153 int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 154 155 struct evsel *evlist__find_tracepoint_by_id(struct evlist *evlist, int id); 156 struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name); 157 158 int evlist__add_pollfd(struct evlist *evlist, int fd); 159 int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask); 160 161 #ifdef HAVE_EVENTFD_SUPPORT 162 int evlist__add_wakeup_eventfd(struct evlist *evlist, int fd); 163 #endif 164 165 int evlist__poll(struct evlist *evlist, int timeout); 166 167 struct evsel *evlist__id2evsel(struct evlist *evlist, u64 id); 168 struct evsel *evlist__id2evsel_strict(struct evlist *evlist, u64 id); 169 170 struct perf_sample_id *evlist__id2sid(struct evlist *evlist, u64 id); 171 172 void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state); 173 174 void evlist__mmap_consume(struct evlist *evlist, int idx); 175 176 int evlist__open(struct evlist *evlist); 177 void evlist__close(struct evlist *evlist); 178 179 struct callchain_param; 180 181 void evlist__set_id_pos(struct evlist *evlist); 182 void evlist__config(struct evlist *evlist, struct record_opts *opts, struct callchain_param *callchain); 183 int record_opts__config(struct record_opts *opts); 184 185 int evlist__prepare_workload(struct evlist *evlist, struct target *target, 186 const char *argv[], bool pipe_output, 187 void (*exec_error)(int signo, siginfo_t *info, void *ucontext)); 188 int evlist__start_workload(struct evlist *evlist); 189 190 struct option; 191 192 int __evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str); 193 int evlist__parse_mmap_pages(const struct option *opt, const char *str, int unset); 194 195 unsigned long perf_event_mlock_kb_in_pages(void); 196 197 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages, 198 unsigned int auxtrace_pages, 199 bool auxtrace_overwrite, int nr_cblocks, 200 int affinity, int flush, int comp_level); 201 int evlist__mmap(struct evlist *evlist, unsigned int pages); 202 void evlist__munmap(struct evlist *evlist); 203 204 size_t evlist__mmap_size(unsigned long pages); 205 206 void evlist__disable(struct evlist *evlist); 207 void evlist__enable(struct evlist *evlist); 208 void evlist__toggle_enable(struct evlist *evlist); 209 void evlist__disable_evsel(struct evlist *evlist, char *evsel_name); 210 void evlist__enable_evsel(struct evlist *evlist, char *evsel_name); 211 void evlist__disable_non_dummy(struct evlist *evlist); 212 void evlist__enable_non_dummy(struct evlist *evlist); 213 214 void evlist__set_selected(struct evlist *evlist, struct evsel *evsel); 215 216 int evlist__create_maps(struct evlist *evlist, struct target *target); 217 int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel, 218 struct target *target); 219 220 u64 __evlist__combined_sample_type(struct evlist *evlist); 221 u64 evlist__combined_sample_type(struct evlist *evlist); 222 u64 evlist__combined_branch_type(struct evlist *evlist); 223 void evlist__update_br_cntr(struct evlist *evlist); 224 bool evlist__sample_id_all(struct evlist *evlist); 225 u16 evlist__id_hdr_size(struct evlist *evlist); 226 227 int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample); 228 int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp); 229 230 bool evlist__valid_sample_type(struct evlist *evlist); 231 bool evlist__valid_sample_id_all(struct evlist *evlist); 232 bool evlist__valid_read_format(struct evlist *evlist); 233 234 void evlist__splice_list_tail(struct evlist *evlist, struct list_head *list); 235 evlist__empty(struct evlist * evlist)236 static inline bool evlist__empty(struct evlist *evlist) 237 { 238 return list_empty(&evlist->core.entries); 239 } 240 evlist__first(struct evlist * evlist)241 static inline struct evsel *evlist__first(struct evlist *evlist) 242 { 243 struct perf_evsel *evsel = perf_evlist__first(&evlist->core); 244 245 return container_of(evsel, struct evsel, core); 246 } 247 evlist__last(struct evlist * evlist)248 static inline struct evsel *evlist__last(struct evlist *evlist) 249 { 250 struct perf_evsel *evsel = perf_evlist__last(&evlist->core); 251 252 return container_of(evsel, struct evsel, core); 253 } 254 evlist__nr_groups(struct evlist * evlist)255 static inline int evlist__nr_groups(struct evlist *evlist) 256 { 257 return perf_evlist__nr_groups(&evlist->core); 258 } 259 260 int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size); 261 int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size); 262 263 bool evlist__can_select_event(struct evlist *evlist, const char *str); 264 void evlist__to_front(struct evlist *evlist, struct 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, core.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)->core.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, core.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)->core.entries, evsel) 297 298 /** 299 * __evlist__for_each_entry_from - continue iteration from @evsel (included) 300 * @list: list_head instance to iterate 301 * @evsel: struct evsel iterator 302 */ 303 #define __evlist__for_each_entry_from(list, evsel) \ 304 list_for_each_entry_from(evsel, list, core.node) 305 306 /** 307 * evlist__for_each_entry_from - continue iteration from @evsel (included) 308 * @evlist: evlist instance to iterate 309 * @evsel: struct evsel iterator 310 */ 311 #define evlist__for_each_entry_from(evlist, evsel) \ 312 __evlist__for_each_entry_from(&(evlist)->core.entries, evsel) 313 314 /** 315 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 316 * @list: list_head instance to iterate 317 * @evsel: struct evsel iterator 318 */ 319 #define __evlist__for_each_entry_reverse(list, evsel) \ 320 list_for_each_entry_reverse(evsel, list, core.node) 321 322 /** 323 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 324 * @evlist: evlist instance to iterate 325 * @evsel: struct evsel iterator 326 */ 327 #define evlist__for_each_entry_reverse(evlist, evsel) \ 328 __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel) 329 330 /** 331 * __evlist__for_each_entry_safe - safely iterate thru all the evsels 332 * @list: list_head instance to iterate 333 * @tmp: struct evsel temp iterator 334 * @evsel: struct evsel iterator 335 */ 336 #define __evlist__for_each_entry_safe(list, tmp, evsel) \ 337 list_for_each_entry_safe(evsel, tmp, list, core.node) 338 339 /** 340 * evlist__for_each_entry_safe - safely iterate thru all the evsels 341 * @evlist: evlist instance to iterate 342 * @evsel: struct evsel iterator 343 * @tmp: struct evsel temp iterator 344 */ 345 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \ 346 __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel) 347 348 /** Iterator state for evlist__for_each_cpu */ 349 struct evlist_cpu_iterator { 350 /** The list being iterated through. */ 351 struct evlist *container; 352 /** The current evsel of the iterator. */ 353 struct evsel *evsel; 354 /** The CPU map index corresponding to the evsel->core.cpus for the current CPU. */ 355 int cpu_map_idx; 356 /** 357 * The CPU map index corresponding to evlist->core.all_cpus for the 358 * current CPU. Distinct from cpu_map_idx as the evsel's cpu map may 359 * contain fewer entries. 360 */ 361 int evlist_cpu_map_idx; 362 /** The number of CPU map entries in evlist->core.all_cpus. */ 363 int evlist_cpu_map_nr; 364 /** The current CPU of the iterator. */ 365 struct perf_cpu cpu; 366 /** If present, used to set the affinity when switching between CPUs. */ 367 struct affinity *affinity; 368 }; 369 370 /** 371 * evlist__for_each_cpu - without affinity, iterate over the evlist. With 372 * affinity, iterate over all CPUs and then the evlist 373 * for each evsel on that CPU. When switching between 374 * CPUs the affinity is set to the CPU to avoid IPIs 375 * during syscalls. 376 * @evlist_cpu_itr: the iterator instance. 377 * @evlist: evlist instance to iterate. 378 * @affinity: NULL or used to set the affinity to the current CPU. 379 */ 380 #define evlist__for_each_cpu(evlist_cpu_itr, evlist, affinity) \ 381 for ((evlist_cpu_itr) = evlist__cpu_begin(evlist, affinity); \ 382 !evlist_cpu_iterator__end(&evlist_cpu_itr); \ 383 evlist_cpu_iterator__next(&evlist_cpu_itr)) 384 385 /** Returns an iterator set to the first CPU/evsel of evlist. */ 386 struct evlist_cpu_iterator evlist__cpu_begin(struct evlist *evlist, struct affinity *affinity); 387 /** Move to next element in iterator, updating CPU, evsel and the affinity. */ 388 void evlist_cpu_iterator__next(struct evlist_cpu_iterator *evlist_cpu_itr); 389 /** Returns true when iterator is at the end of the CPUs and evlist. */ 390 bool evlist_cpu_iterator__end(const struct evlist_cpu_iterator *evlist_cpu_itr); 391 392 struct evsel *evlist__get_tracking_event(struct evlist *evlist); 393 void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel); 394 struct evsel *evlist__findnew_tracking_event(struct evlist *evlist, bool system_wide); 395 396 struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str); 397 398 struct evsel *evlist__event2evsel(struct evlist *evlist, union perf_event *event); 399 400 bool evlist__exclude_kernel(struct evlist *evlist); 401 402 void evlist__force_leader(struct evlist *evlist); 403 404 struct evsel *evlist__reset_weak_group(struct evlist *evlist, struct evsel *evsel, bool close); 405 406 #define EVLIST_CTL_CMD_ENABLE_TAG "enable" 407 #define EVLIST_CTL_CMD_DISABLE_TAG "disable" 408 #define EVLIST_CTL_CMD_ACK_TAG "ack\n" 409 #define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot" 410 #define EVLIST_CTL_CMD_EVLIST_TAG "evlist" 411 #define EVLIST_CTL_CMD_STOP_TAG "stop" 412 #define EVLIST_CTL_CMD_PING_TAG "ping" 413 414 #define EVLIST_CTL_CMD_MAX_LEN 64 415 416 enum evlist_ctl_cmd { 417 EVLIST_CTL_CMD_UNSUPPORTED = 0, 418 EVLIST_CTL_CMD_ENABLE, 419 EVLIST_CTL_CMD_DISABLE, 420 EVLIST_CTL_CMD_ACK, 421 EVLIST_CTL_CMD_SNAPSHOT, 422 EVLIST_CTL_CMD_EVLIST, 423 EVLIST_CTL_CMD_STOP, 424 EVLIST_CTL_CMD_PING, 425 }; 426 427 int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close); 428 void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close); 429 int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack); 430 int evlist__finalize_ctlfd(struct evlist *evlist); 431 bool evlist__ctlfd_initialized(struct evlist *evlist); 432 int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd); 433 int evlist__ctlfd_ack(struct evlist *evlist); 434 435 #define EVLIST_ENABLED_MSG "Events enabled\n" 436 #define EVLIST_DISABLED_MSG "Events disabled\n" 437 438 int evlist__parse_event_enable_time(struct evlist *evlist, struct record_opts *opts, 439 const char *str, int unset); 440 int event_enable_timer__start(struct event_enable_timer *eet); 441 void event_enable_timer__exit(struct event_enable_timer **ep); 442 int event_enable_timer__process(struct event_enable_timer *eet); 443 444 struct evsel *evlist__find_evsel(struct evlist *evlist, int idx); 445 446 int evlist__scnprintf_evsels(struct evlist *evlist, size_t size, char *bf); 447 void evlist__check_mem_load_aux(struct evlist *evlist); 448 void evlist__warn_user_requested_cpus(struct evlist *evlist, const char *cpu_list); 449 void evlist__uniquify_name(struct evlist *evlist); 450 bool evlist__has_bpf_output(struct evlist *evlist); 451 452 #endif /* __PERF_EVLIST_H */ 453