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 evlist { 52 struct perf_evlist core; 53 bool enabled; 54 int id_pos; 55 int is_pos; 56 u64 combined_sample_type; 57 enum bkw_mmap_state bkw_mmap_state; 58 struct { 59 int cork_fd; 60 pid_t pid; 61 } workload; 62 struct mmap *mmap; 63 struct mmap *overwrite_mmap; 64 struct evsel *selected; 65 struct events_stats stats; 66 struct perf_env *env; 67 const char *hybrid_pmu_name; 68 void (*trace_event_sample_raw)(struct evlist *evlist, 69 union perf_event *event, 70 struct perf_sample *sample); 71 u64 first_sample_time; 72 u64 last_sample_time; 73 struct { 74 pthread_t th; 75 volatile int done; 76 } thread; 77 struct { 78 int fd; /* control file descriptor */ 79 int ack; /* ack file descriptor for control commands */ 80 int pos; /* index at evlist core object to check signals */ 81 } ctl_fd; 82 }; 83 84 struct evsel_str_handler { 85 const char *name; 86 void *handler; 87 }; 88 89 struct evlist *evlist__new(void); 90 struct evlist *evlist__new_default(void); 91 struct evlist *evlist__new_dummy(void); 92 void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus, 93 struct perf_thread_map *threads); 94 void evlist__exit(struct evlist *evlist); 95 void evlist__delete(struct evlist *evlist); 96 97 void evlist__add(struct evlist *evlist, struct evsel *entry); 98 void evlist__remove(struct evlist *evlist, struct evsel *evsel); 99 100 int __evlist__add_default(struct evlist *evlist, bool precise); 101 102 static inline int evlist__add_default(struct evlist *evlist) 103 { 104 return __evlist__add_default(evlist, true); 105 } 106 107 int evlist__add_attrs(struct evlist *evlist, struct perf_event_attr *attrs, size_t nr_attrs); 108 109 int __evlist__add_default_attrs(struct evlist *evlist, 110 struct perf_event_attr *attrs, size_t nr_attrs); 111 112 int arch_evlist__add_default_attrs(struct evlist *evlist, 113 struct perf_event_attr *attrs, 114 size_t nr_attrs); 115 116 #define evlist__add_default_attrs(evlist, array) \ 117 arch_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array)) 118 119 struct evsel *arch_evlist__leader(struct list_head *list); 120 121 int evlist__add_dummy(struct evlist *evlist); 122 struct evsel *evlist__add_aux_dummy(struct evlist *evlist, bool system_wide); 123 static inline struct evsel *evlist__add_dummy_on_all_cpus(struct evlist *evlist) 124 { 125 return evlist__add_aux_dummy(evlist, true); 126 } 127 128 int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr, 129 evsel__sb_cb_t cb, void *data); 130 void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data); 131 int evlist__start_sb_thread(struct evlist *evlist, struct target *target); 132 void evlist__stop_sb_thread(struct evlist *evlist); 133 134 int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler); 135 136 int __evlist__set_tracepoints_handlers(struct evlist *evlist, 137 const struct evsel_str_handler *assocs, 138 size_t nr_assocs); 139 140 #define evlist__set_tracepoints_handlers(evlist, array) \ 141 __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array)) 142 143 int evlist__set_tp_filter(struct evlist *evlist, const char *filter); 144 int evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid); 145 int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 146 147 int evlist__append_tp_filter(struct evlist *evlist, const char *filter); 148 149 int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid); 150 int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 151 152 struct evsel *evlist__find_tracepoint_by_id(struct evlist *evlist, int id); 153 struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name); 154 155 int evlist__add_pollfd(struct evlist *evlist, int fd); 156 int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask); 157 158 #ifdef HAVE_EVENTFD_SUPPORT 159 int evlist__add_wakeup_eventfd(struct evlist *evlist, int fd); 160 #endif 161 162 int evlist__poll(struct evlist *evlist, int timeout); 163 164 struct evsel *evlist__id2evsel(struct evlist *evlist, u64 id); 165 struct evsel *evlist__id2evsel_strict(struct evlist *evlist, u64 id); 166 167 struct perf_sample_id *evlist__id2sid(struct evlist *evlist, u64 id); 168 169 void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state); 170 171 void evlist__mmap_consume(struct evlist *evlist, int idx); 172 173 int evlist__open(struct evlist *evlist); 174 void evlist__close(struct evlist *evlist); 175 176 struct callchain_param; 177 178 void evlist__set_id_pos(struct evlist *evlist); 179 void evlist__config(struct evlist *evlist, struct record_opts *opts, struct callchain_param *callchain); 180 int record_opts__config(struct record_opts *opts); 181 182 int evlist__prepare_workload(struct evlist *evlist, struct target *target, 183 const char *argv[], bool pipe_output, 184 void (*exec_error)(int signo, siginfo_t *info, void *ucontext)); 185 int evlist__start_workload(struct evlist *evlist); 186 187 struct option; 188 189 int __evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str); 190 int evlist__parse_mmap_pages(const struct option *opt, const char *str, int unset); 191 192 unsigned long perf_event_mlock_kb_in_pages(void); 193 194 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages, 195 unsigned int auxtrace_pages, 196 bool auxtrace_overwrite, int nr_cblocks, 197 int affinity, int flush, int comp_level); 198 int evlist__mmap(struct evlist *evlist, unsigned int pages); 199 void evlist__munmap(struct evlist *evlist); 200 201 size_t evlist__mmap_size(unsigned long pages); 202 203 void evlist__disable(struct evlist *evlist); 204 void evlist__enable(struct evlist *evlist); 205 void evlist__toggle_enable(struct evlist *evlist); 206 void evlist__disable_evsel(struct evlist *evlist, char *evsel_name); 207 void evlist__enable_evsel(struct evlist *evlist, char *evsel_name); 208 209 void evlist__set_selected(struct evlist *evlist, struct evsel *evsel); 210 211 int evlist__create_maps(struct evlist *evlist, struct target *target); 212 int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel); 213 214 void evlist__set_leader(struct evlist *evlist); 215 216 u64 __evlist__combined_sample_type(struct evlist *evlist); 217 u64 evlist__combined_sample_type(struct evlist *evlist); 218 u64 evlist__combined_branch_type(struct evlist *evlist); 219 bool evlist__sample_id_all(struct evlist *evlist); 220 u16 evlist__id_hdr_size(struct evlist *evlist); 221 222 int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample); 223 int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp); 224 225 bool evlist__valid_sample_type(struct evlist *evlist); 226 bool evlist__valid_sample_id_all(struct evlist *evlist); 227 bool evlist__valid_read_format(struct evlist *evlist); 228 229 void evlist__splice_list_tail(struct evlist *evlist, struct list_head *list); 230 231 static inline bool evlist__empty(struct evlist *evlist) 232 { 233 return list_empty(&evlist->core.entries); 234 } 235 236 static inline struct evsel *evlist__first(struct evlist *evlist) 237 { 238 struct perf_evsel *evsel = perf_evlist__first(&evlist->core); 239 240 return container_of(evsel, struct evsel, core); 241 } 242 243 static inline struct evsel *evlist__last(struct evlist *evlist) 244 { 245 struct perf_evsel *evsel = perf_evlist__last(&evlist->core); 246 247 return container_of(evsel, struct evsel, core); 248 } 249 250 int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size); 251 int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size); 252 253 bool evlist__can_select_event(struct evlist *evlist, const char *str); 254 void evlist__to_front(struct evlist *evlist, struct evsel *move_evsel); 255 256 /** 257 * __evlist__for_each_entry - iterate thru all the evsels 258 * @list: list_head instance to iterate 259 * @evsel: struct evsel iterator 260 */ 261 #define __evlist__for_each_entry(list, evsel) \ 262 list_for_each_entry(evsel, list, core.node) 263 264 /** 265 * evlist__for_each_entry - iterate thru all the evsels 266 * @evlist: evlist instance to iterate 267 * @evsel: struct evsel iterator 268 */ 269 #define evlist__for_each_entry(evlist, evsel) \ 270 __evlist__for_each_entry(&(evlist)->core.entries, evsel) 271 272 /** 273 * __evlist__for_each_entry_continue - continue iteration thru all the evsels 274 * @list: list_head instance to iterate 275 * @evsel: struct evsel iterator 276 */ 277 #define __evlist__for_each_entry_continue(list, evsel) \ 278 list_for_each_entry_continue(evsel, list, core.node) 279 280 /** 281 * evlist__for_each_entry_continue - continue iteration thru all the evsels 282 * @evlist: evlist instance to iterate 283 * @evsel: struct evsel iterator 284 */ 285 #define evlist__for_each_entry_continue(evlist, evsel) \ 286 __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel) 287 288 /** 289 * __evlist__for_each_entry_from - continue iteration from @evsel (included) 290 * @list: list_head instance to iterate 291 * @evsel: struct evsel iterator 292 */ 293 #define __evlist__for_each_entry_from(list, evsel) \ 294 list_for_each_entry_from(evsel, list, core.node) 295 296 /** 297 * evlist__for_each_entry_from - continue iteration from @evsel (included) 298 * @evlist: evlist instance to iterate 299 * @evsel: struct evsel iterator 300 */ 301 #define evlist__for_each_entry_from(evlist, evsel) \ 302 __evlist__for_each_entry_from(&(evlist)->core.entries, evsel) 303 304 /** 305 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 306 * @list: list_head instance to iterate 307 * @evsel: struct evsel iterator 308 */ 309 #define __evlist__for_each_entry_reverse(list, evsel) \ 310 list_for_each_entry_reverse(evsel, list, core.node) 311 312 /** 313 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 314 * @evlist: evlist instance to iterate 315 * @evsel: struct evsel iterator 316 */ 317 #define evlist__for_each_entry_reverse(evlist, evsel) \ 318 __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel) 319 320 /** 321 * __evlist__for_each_entry_safe - safely iterate thru all the evsels 322 * @list: list_head instance to iterate 323 * @tmp: struct evsel temp iterator 324 * @evsel: struct evsel iterator 325 */ 326 #define __evlist__for_each_entry_safe(list, tmp, evsel) \ 327 list_for_each_entry_safe(evsel, tmp, list, core.node) 328 329 /** 330 * evlist__for_each_entry_safe - safely iterate thru all the evsels 331 * @evlist: evlist instance to iterate 332 * @evsel: struct evsel iterator 333 * @tmp: struct evsel temp iterator 334 */ 335 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \ 336 __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel) 337 338 /** Iterator state for evlist__for_each_cpu */ 339 struct evlist_cpu_iterator { 340 /** The list being iterated through. */ 341 struct evlist *container; 342 /** The current evsel of the iterator. */ 343 struct evsel *evsel; 344 /** The CPU map index corresponding to the evsel->core.cpus for the current CPU. */ 345 int cpu_map_idx; 346 /** 347 * The CPU map index corresponding to evlist->core.all_cpus for the 348 * current CPU. Distinct from cpu_map_idx as the evsel's cpu map may 349 * contain fewer entries. 350 */ 351 int evlist_cpu_map_idx; 352 /** The number of CPU map entries in evlist->core.all_cpus. */ 353 int evlist_cpu_map_nr; 354 /** The current CPU of the iterator. */ 355 struct perf_cpu cpu; 356 /** If present, used to set the affinity when switching between CPUs. */ 357 struct affinity *affinity; 358 }; 359 360 /** 361 * evlist__for_each_cpu - without affinity, iterate over the evlist. With 362 * affinity, iterate over all CPUs and then the evlist 363 * for each evsel on that CPU. When switching between 364 * CPUs the affinity is set to the CPU to avoid IPIs 365 * during syscalls. 366 * @evlist_cpu_itr: the iterator instance. 367 * @evlist: evlist instance to iterate. 368 * @affinity: NULL or used to set the affinity to the current CPU. 369 */ 370 #define evlist__for_each_cpu(evlist_cpu_itr, evlist, affinity) \ 371 for ((evlist_cpu_itr) = evlist__cpu_begin(evlist, affinity); \ 372 !evlist_cpu_iterator__end(&evlist_cpu_itr); \ 373 evlist_cpu_iterator__next(&evlist_cpu_itr)) 374 375 /** Returns an iterator set to the first CPU/evsel of evlist. */ 376 struct evlist_cpu_iterator evlist__cpu_begin(struct evlist *evlist, struct affinity *affinity); 377 /** Move to next element in iterator, updating CPU, evsel and the affinity. */ 378 void evlist_cpu_iterator__next(struct evlist_cpu_iterator *evlist_cpu_itr); 379 /** Returns true when iterator is at the end of the CPUs and evlist. */ 380 bool evlist_cpu_iterator__end(const struct evlist_cpu_iterator *evlist_cpu_itr); 381 382 struct evsel *evlist__get_tracking_event(struct evlist *evlist); 383 void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel); 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_update(struct evlist *evlist, struct pollfd *update); 422 int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd); 423 int evlist__ctlfd_ack(struct evlist *evlist); 424 425 #define EVLIST_ENABLED_MSG "Events enabled\n" 426 #define EVLIST_DISABLED_MSG "Events disabled\n" 427 428 struct evsel *evlist__find_evsel(struct evlist *evlist, int idx); 429 430 int evlist__scnprintf_evsels(struct evlist *evlist, size_t size, char *bf); 431 void evlist__check_mem_load_aux(struct evlist *evlist); 432 #endif /* __PERF_EVLIST_H */ 433