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_default_attrs(struct evlist *evlist, 108 struct perf_event_attr *attrs, size_t nr_attrs); 109 110 #define evlist__add_default_attrs(evlist, array) \ 111 __evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array)) 112 113 int arch_evlist__add_default_attrs(struct evlist *evlist); 114 struct evsel *arch_evlist__leader(struct list_head *list); 115 116 int evlist__add_dummy(struct evlist *evlist); 117 struct evsel *evlist__add_aux_dummy(struct evlist *evlist, bool system_wide); 118 static inline struct evsel *evlist__add_dummy_on_all_cpus(struct evlist *evlist) 119 { 120 return evlist__add_aux_dummy(evlist, true); 121 } 122 123 int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr, 124 evsel__sb_cb_t cb, void *data); 125 void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data); 126 int evlist__start_sb_thread(struct evlist *evlist, struct target *target); 127 void evlist__stop_sb_thread(struct evlist *evlist); 128 129 int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler); 130 131 int __evlist__set_tracepoints_handlers(struct evlist *evlist, 132 const struct evsel_str_handler *assocs, 133 size_t nr_assocs); 134 135 #define evlist__set_tracepoints_handlers(evlist, array) \ 136 __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array)) 137 138 int evlist__set_tp_filter(struct evlist *evlist, const char *filter); 139 int evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid); 140 int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 141 142 int evlist__append_tp_filter(struct evlist *evlist, const char *filter); 143 144 int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid); 145 int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 146 147 struct evsel *evlist__find_tracepoint_by_id(struct evlist *evlist, int id); 148 struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name); 149 150 int evlist__add_pollfd(struct evlist *evlist, int fd); 151 int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask); 152 153 #ifdef HAVE_EVENTFD_SUPPORT 154 int evlist__add_wakeup_eventfd(struct evlist *evlist, int fd); 155 #endif 156 157 int evlist__poll(struct evlist *evlist, int timeout); 158 159 struct evsel *evlist__id2evsel(struct evlist *evlist, u64 id); 160 struct evsel *evlist__id2evsel_strict(struct evlist *evlist, u64 id); 161 162 struct perf_sample_id *evlist__id2sid(struct evlist *evlist, u64 id); 163 164 void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state); 165 166 void evlist__mmap_consume(struct evlist *evlist, int idx); 167 168 int evlist__open(struct evlist *evlist); 169 void evlist__close(struct evlist *evlist); 170 171 struct callchain_param; 172 173 void evlist__set_id_pos(struct evlist *evlist); 174 void evlist__config(struct evlist *evlist, struct record_opts *opts, struct callchain_param *callchain); 175 int record_opts__config(struct record_opts *opts); 176 177 int evlist__prepare_workload(struct evlist *evlist, struct target *target, 178 const char *argv[], bool pipe_output, 179 void (*exec_error)(int signo, siginfo_t *info, void *ucontext)); 180 int evlist__start_workload(struct evlist *evlist); 181 182 struct option; 183 184 int __evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str); 185 int evlist__parse_mmap_pages(const struct option *opt, const char *str, int unset); 186 187 unsigned long perf_event_mlock_kb_in_pages(void); 188 189 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages, 190 unsigned int auxtrace_pages, 191 bool auxtrace_overwrite, int nr_cblocks, 192 int affinity, int flush, int comp_level); 193 int evlist__mmap(struct evlist *evlist, unsigned int pages); 194 void evlist__munmap(struct evlist *evlist); 195 196 size_t evlist__mmap_size(unsigned long pages); 197 198 void evlist__disable(struct evlist *evlist); 199 void evlist__enable(struct evlist *evlist); 200 void evlist__toggle_enable(struct evlist *evlist); 201 void evlist__disable_evsel(struct evlist *evlist, char *evsel_name); 202 void evlist__enable_evsel(struct evlist *evlist, char *evsel_name); 203 204 void evlist__set_selected(struct evlist *evlist, struct evsel *evsel); 205 206 int evlist__create_maps(struct evlist *evlist, struct target *target); 207 int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel); 208 209 void evlist__set_leader(struct evlist *evlist); 210 211 u64 __evlist__combined_sample_type(struct evlist *evlist); 212 u64 evlist__combined_sample_type(struct evlist *evlist); 213 u64 evlist__combined_branch_type(struct evlist *evlist); 214 bool evlist__sample_id_all(struct evlist *evlist); 215 u16 evlist__id_hdr_size(struct evlist *evlist); 216 217 int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample); 218 int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp); 219 220 bool evlist__valid_sample_type(struct evlist *evlist); 221 bool evlist__valid_sample_id_all(struct evlist *evlist); 222 bool evlist__valid_read_format(struct evlist *evlist); 223 224 void evlist__splice_list_tail(struct evlist *evlist, struct list_head *list); 225 226 static inline bool evlist__empty(struct evlist *evlist) 227 { 228 return list_empty(&evlist->core.entries); 229 } 230 231 static inline struct evsel *evlist__first(struct evlist *evlist) 232 { 233 struct perf_evsel *evsel = perf_evlist__first(&evlist->core); 234 235 return container_of(evsel, struct evsel, core); 236 } 237 238 static inline struct evsel *evlist__last(struct evlist *evlist) 239 { 240 struct perf_evsel *evsel = perf_evlist__last(&evlist->core); 241 242 return container_of(evsel, struct evsel, core); 243 } 244 245 int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size); 246 int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size); 247 248 bool evlist__can_select_event(struct evlist *evlist, const char *str); 249 void evlist__to_front(struct evlist *evlist, struct evsel *move_evsel); 250 251 /** 252 * __evlist__for_each_entry - iterate thru all the evsels 253 * @list: list_head instance to iterate 254 * @evsel: struct evsel iterator 255 */ 256 #define __evlist__for_each_entry(list, evsel) \ 257 list_for_each_entry(evsel, list, core.node) 258 259 /** 260 * evlist__for_each_entry - iterate thru all the evsels 261 * @evlist: evlist instance to iterate 262 * @evsel: struct evsel iterator 263 */ 264 #define evlist__for_each_entry(evlist, evsel) \ 265 __evlist__for_each_entry(&(evlist)->core.entries, evsel) 266 267 /** 268 * __evlist__for_each_entry_continue - continue iteration thru all the evsels 269 * @list: list_head instance to iterate 270 * @evsel: struct evsel iterator 271 */ 272 #define __evlist__for_each_entry_continue(list, evsel) \ 273 list_for_each_entry_continue(evsel, list, core.node) 274 275 /** 276 * evlist__for_each_entry_continue - continue iteration thru all the evsels 277 * @evlist: evlist instance to iterate 278 * @evsel: struct evsel iterator 279 */ 280 #define evlist__for_each_entry_continue(evlist, evsel) \ 281 __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel) 282 283 /** 284 * __evlist__for_each_entry_from - continue iteration from @evsel (included) 285 * @list: list_head instance to iterate 286 * @evsel: struct evsel iterator 287 */ 288 #define __evlist__for_each_entry_from(list, evsel) \ 289 list_for_each_entry_from(evsel, list, core.node) 290 291 /** 292 * evlist__for_each_entry_from - continue iteration from @evsel (included) 293 * @evlist: evlist instance to iterate 294 * @evsel: struct evsel iterator 295 */ 296 #define evlist__for_each_entry_from(evlist, evsel) \ 297 __evlist__for_each_entry_from(&(evlist)->core.entries, evsel) 298 299 /** 300 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 301 * @list: list_head instance to iterate 302 * @evsel: struct evsel iterator 303 */ 304 #define __evlist__for_each_entry_reverse(list, evsel) \ 305 list_for_each_entry_reverse(evsel, list, core.node) 306 307 /** 308 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 309 * @evlist: evlist instance to iterate 310 * @evsel: struct evsel iterator 311 */ 312 #define evlist__for_each_entry_reverse(evlist, evsel) \ 313 __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel) 314 315 /** 316 * __evlist__for_each_entry_safe - safely iterate thru all the evsels 317 * @list: list_head instance to iterate 318 * @tmp: struct evsel temp iterator 319 * @evsel: struct evsel iterator 320 */ 321 #define __evlist__for_each_entry_safe(list, tmp, evsel) \ 322 list_for_each_entry_safe(evsel, tmp, list, core.node) 323 324 /** 325 * evlist__for_each_entry_safe - safely iterate thru all the evsels 326 * @evlist: evlist instance to iterate 327 * @evsel: struct evsel iterator 328 * @tmp: struct evsel temp iterator 329 */ 330 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \ 331 __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel) 332 333 /** Iterator state for evlist__for_each_cpu */ 334 struct evlist_cpu_iterator { 335 /** The list being iterated through. */ 336 struct evlist *container; 337 /** The current evsel of the iterator. */ 338 struct evsel *evsel; 339 /** The CPU map index corresponding to the evsel->core.cpus for the current CPU. */ 340 int cpu_map_idx; 341 /** 342 * The CPU map index corresponding to evlist->core.all_cpus for the 343 * current CPU. Distinct from cpu_map_idx as the evsel's cpu map may 344 * contain fewer entries. 345 */ 346 int evlist_cpu_map_idx; 347 /** The number of CPU map entries in evlist->core.all_cpus. */ 348 int evlist_cpu_map_nr; 349 /** The current CPU of the iterator. */ 350 struct perf_cpu cpu; 351 /** If present, used to set the affinity when switching between CPUs. */ 352 struct affinity *affinity; 353 }; 354 355 /** 356 * evlist__for_each_cpu - without affinity, iterate over the evlist. With 357 * affinity, iterate over all CPUs and then the evlist 358 * for each evsel on that CPU. When switching between 359 * CPUs the affinity is set to the CPU to avoid IPIs 360 * during syscalls. 361 * @evlist_cpu_itr: the iterator instance. 362 * @evlist: evlist instance to iterate. 363 * @affinity: NULL or used to set the affinity to the current CPU. 364 */ 365 #define evlist__for_each_cpu(evlist_cpu_itr, evlist, affinity) \ 366 for ((evlist_cpu_itr) = evlist__cpu_begin(evlist, affinity); \ 367 !evlist_cpu_iterator__end(&evlist_cpu_itr); \ 368 evlist_cpu_iterator__next(&evlist_cpu_itr)) 369 370 /** Returns an iterator set to the first CPU/evsel of evlist. */ 371 struct evlist_cpu_iterator evlist__cpu_begin(struct evlist *evlist, struct affinity *affinity); 372 /** Move to next element in iterator, updating CPU, evsel and the affinity. */ 373 void evlist_cpu_iterator__next(struct evlist_cpu_iterator *evlist_cpu_itr); 374 /** Returns true when iterator is at the end of the CPUs and evlist. */ 375 bool evlist_cpu_iterator__end(const struct evlist_cpu_iterator *evlist_cpu_itr); 376 377 struct evsel *evlist__get_tracking_event(struct evlist *evlist); 378 void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel); 379 380 struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str); 381 382 struct evsel *evlist__event2evsel(struct evlist *evlist, union perf_event *event); 383 384 bool evlist__exclude_kernel(struct evlist *evlist); 385 386 void evlist__force_leader(struct evlist *evlist); 387 388 struct evsel *evlist__reset_weak_group(struct evlist *evlist, struct evsel *evsel, bool close); 389 390 #define EVLIST_CTL_CMD_ENABLE_TAG "enable" 391 #define EVLIST_CTL_CMD_DISABLE_TAG "disable" 392 #define EVLIST_CTL_CMD_ACK_TAG "ack\n" 393 #define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot" 394 #define EVLIST_CTL_CMD_EVLIST_TAG "evlist" 395 #define EVLIST_CTL_CMD_STOP_TAG "stop" 396 #define EVLIST_CTL_CMD_PING_TAG "ping" 397 398 #define EVLIST_CTL_CMD_MAX_LEN 64 399 400 enum evlist_ctl_cmd { 401 EVLIST_CTL_CMD_UNSUPPORTED = 0, 402 EVLIST_CTL_CMD_ENABLE, 403 EVLIST_CTL_CMD_DISABLE, 404 EVLIST_CTL_CMD_ACK, 405 EVLIST_CTL_CMD_SNAPSHOT, 406 EVLIST_CTL_CMD_EVLIST, 407 EVLIST_CTL_CMD_STOP, 408 EVLIST_CTL_CMD_PING, 409 }; 410 411 int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close); 412 void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close); 413 int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack); 414 int evlist__finalize_ctlfd(struct evlist *evlist); 415 bool evlist__ctlfd_initialized(struct evlist *evlist); 416 int evlist__ctlfd_update(struct evlist *evlist, struct pollfd *update); 417 int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd); 418 int evlist__ctlfd_ack(struct evlist *evlist); 419 420 #define EVLIST_ENABLED_MSG "Events enabled\n" 421 #define EVLIST_DISABLED_MSG "Events disabled\n" 422 423 struct evsel *evlist__find_evsel(struct evlist *evlist, int idx); 424 425 int evlist__scnprintf_evsels(struct evlist *evlist, size_t size, char *bf); 426 void evlist__check_mem_load_aux(struct evlist *evlist); 427 #endif /* __PERF_EVLIST_H */ 428