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