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