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 131 int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr, 132 evsel__sb_cb_t cb, void *data); 133 void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data); 134 int evlist__start_sb_thread(struct evlist *evlist, struct target *target); 135 void evlist__stop_sb_thread(struct evlist *evlist); 136 137 int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler); 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 219 void evlist__set_leader(struct evlist *evlist); 220 221 u64 __evlist__combined_sample_type(struct evlist *evlist); 222 u64 evlist__combined_sample_type(struct evlist *evlist); 223 u64 evlist__combined_branch_type(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 236 static inline bool evlist__empty(struct evlist *evlist) 237 { 238 return list_empty(&evlist->core.entries); 239 } 240 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 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 255 int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size); 256 int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size); 257 258 bool evlist__can_select_event(struct evlist *evlist, const char *str); 259 void evlist__to_front(struct evlist *evlist, struct evsel *move_evsel); 260 261 /** 262 * __evlist__for_each_entry - iterate thru all the evsels 263 * @list: list_head instance to iterate 264 * @evsel: struct evsel iterator 265 */ 266 #define __evlist__for_each_entry(list, evsel) \ 267 list_for_each_entry(evsel, list, core.node) 268 269 /** 270 * evlist__for_each_entry - iterate thru all the evsels 271 * @evlist: evlist instance to iterate 272 * @evsel: struct evsel iterator 273 */ 274 #define evlist__for_each_entry(evlist, evsel) \ 275 __evlist__for_each_entry(&(evlist)->core.entries, evsel) 276 277 /** 278 * __evlist__for_each_entry_continue - continue iteration thru all the evsels 279 * @list: list_head instance to iterate 280 * @evsel: struct evsel iterator 281 */ 282 #define __evlist__for_each_entry_continue(list, evsel) \ 283 list_for_each_entry_continue(evsel, list, core.node) 284 285 /** 286 * evlist__for_each_entry_continue - continue iteration thru all the evsels 287 * @evlist: evlist instance to iterate 288 * @evsel: struct evsel iterator 289 */ 290 #define evlist__for_each_entry_continue(evlist, evsel) \ 291 __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel) 292 293 /** 294 * __evlist__for_each_entry_from - continue iteration from @evsel (included) 295 * @list: list_head instance to iterate 296 * @evsel: struct evsel iterator 297 */ 298 #define __evlist__for_each_entry_from(list, evsel) \ 299 list_for_each_entry_from(evsel, list, core.node) 300 301 /** 302 * evlist__for_each_entry_from - continue iteration from @evsel (included) 303 * @evlist: evlist instance to iterate 304 * @evsel: struct evsel iterator 305 */ 306 #define evlist__for_each_entry_from(evlist, evsel) \ 307 __evlist__for_each_entry_from(&(evlist)->core.entries, evsel) 308 309 /** 310 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 311 * @list: list_head instance to iterate 312 * @evsel: struct evsel iterator 313 */ 314 #define __evlist__for_each_entry_reverse(list, evsel) \ 315 list_for_each_entry_reverse(evsel, list, core.node) 316 317 /** 318 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 319 * @evlist: evlist instance to iterate 320 * @evsel: struct evsel iterator 321 */ 322 #define evlist__for_each_entry_reverse(evlist, evsel) \ 323 __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel) 324 325 /** 326 * __evlist__for_each_entry_safe - safely iterate thru all the evsels 327 * @list: list_head instance to iterate 328 * @tmp: struct evsel temp iterator 329 * @evsel: struct evsel iterator 330 */ 331 #define __evlist__for_each_entry_safe(list, tmp, evsel) \ 332 list_for_each_entry_safe(evsel, tmp, list, core.node) 333 334 /** 335 * evlist__for_each_entry_safe - safely iterate thru all the evsels 336 * @evlist: evlist instance to iterate 337 * @evsel: struct evsel iterator 338 * @tmp: struct evsel temp iterator 339 */ 340 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \ 341 __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel) 342 343 /** Iterator state for evlist__for_each_cpu */ 344 struct evlist_cpu_iterator { 345 /** The list being iterated through. */ 346 struct evlist *container; 347 /** The current evsel of the iterator. */ 348 struct evsel *evsel; 349 /** The CPU map index corresponding to the evsel->core.cpus for the current CPU. */ 350 int cpu_map_idx; 351 /** 352 * The CPU map index corresponding to evlist->core.all_cpus for the 353 * current CPU. Distinct from cpu_map_idx as the evsel's cpu map may 354 * contain fewer entries. 355 */ 356 int evlist_cpu_map_idx; 357 /** The number of CPU map entries in evlist->core.all_cpus. */ 358 int evlist_cpu_map_nr; 359 /** The current CPU of the iterator. */ 360 struct perf_cpu cpu; 361 /** If present, used to set the affinity when switching between CPUs. */ 362 struct affinity *affinity; 363 }; 364 365 /** 366 * evlist__for_each_cpu - without affinity, iterate over the evlist. With 367 * affinity, iterate over all CPUs and then the evlist 368 * for each evsel on that CPU. When switching between 369 * CPUs the affinity is set to the CPU to avoid IPIs 370 * during syscalls. 371 * @evlist_cpu_itr: the iterator instance. 372 * @evlist: evlist instance to iterate. 373 * @affinity: NULL or used to set the affinity to the current CPU. 374 */ 375 #define evlist__for_each_cpu(evlist_cpu_itr, evlist, affinity) \ 376 for ((evlist_cpu_itr) = evlist__cpu_begin(evlist, affinity); \ 377 !evlist_cpu_iterator__end(&evlist_cpu_itr); \ 378 evlist_cpu_iterator__next(&evlist_cpu_itr)) 379 380 /** Returns an iterator set to the first CPU/evsel of evlist. */ 381 struct evlist_cpu_iterator evlist__cpu_begin(struct evlist *evlist, struct affinity *affinity); 382 /** Move to next element in iterator, updating CPU, evsel and the affinity. */ 383 void evlist_cpu_iterator__next(struct evlist_cpu_iterator *evlist_cpu_itr); 384 /** Returns true when iterator is at the end of the CPUs and evlist. */ 385 bool evlist_cpu_iterator__end(const struct evlist_cpu_iterator *evlist_cpu_itr); 386 387 struct evsel *evlist__get_tracking_event(struct evlist *evlist); 388 void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel); 389 390 struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str); 391 392 struct evsel *evlist__event2evsel(struct evlist *evlist, union perf_event *event); 393 394 bool evlist__exclude_kernel(struct evlist *evlist); 395 396 void evlist__force_leader(struct evlist *evlist); 397 398 struct evsel *evlist__reset_weak_group(struct evlist *evlist, struct evsel *evsel, bool close); 399 400 #define EVLIST_CTL_CMD_ENABLE_TAG "enable" 401 #define EVLIST_CTL_CMD_DISABLE_TAG "disable" 402 #define EVLIST_CTL_CMD_ACK_TAG "ack\n" 403 #define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot" 404 #define EVLIST_CTL_CMD_EVLIST_TAG "evlist" 405 #define EVLIST_CTL_CMD_STOP_TAG "stop" 406 #define EVLIST_CTL_CMD_PING_TAG "ping" 407 408 #define EVLIST_CTL_CMD_MAX_LEN 64 409 410 enum evlist_ctl_cmd { 411 EVLIST_CTL_CMD_UNSUPPORTED = 0, 412 EVLIST_CTL_CMD_ENABLE, 413 EVLIST_CTL_CMD_DISABLE, 414 EVLIST_CTL_CMD_ACK, 415 EVLIST_CTL_CMD_SNAPSHOT, 416 EVLIST_CTL_CMD_EVLIST, 417 EVLIST_CTL_CMD_STOP, 418 EVLIST_CTL_CMD_PING, 419 }; 420 421 int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close); 422 void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close); 423 int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack); 424 int evlist__finalize_ctlfd(struct evlist *evlist); 425 bool evlist__ctlfd_initialized(struct evlist *evlist); 426 int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd); 427 int evlist__ctlfd_ack(struct evlist *evlist); 428 429 #define EVLIST_ENABLED_MSG "Events enabled\n" 430 #define EVLIST_DISABLED_MSG "Events disabled\n" 431 432 int evlist__parse_event_enable_time(struct evlist *evlist, struct record_opts *opts, 433 const char *str, int unset); 434 int event_enable_timer__start(struct event_enable_timer *eet); 435 void event_enable_timer__exit(struct event_enable_timer **ep); 436 int event_enable_timer__process(struct event_enable_timer *eet); 437 438 struct evsel *evlist__find_evsel(struct evlist *evlist, int idx); 439 440 int evlist__scnprintf_evsels(struct evlist *evlist, size_t size, char *bf); 441 void evlist__check_mem_load_aux(struct evlist *evlist); 442 #endif /* __PERF_EVLIST_H */ 443