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 int nr_groups; 54 bool enabled; 55 int id_pos; 56 int is_pos; 57 u64 combined_sample_type; 58 enum bkw_mmap_state bkw_mmap_state; 59 struct { 60 int cork_fd; 61 pid_t pid; 62 } workload; 63 struct mmap *mmap; 64 struct mmap *overwrite_mmap; 65 struct evsel *selected; 66 struct events_stats stats; 67 struct perf_env *env; 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 evlist__add_dummy(struct evlist *evlist); 114 115 int evlist__add_sb_event(struct evlist *evlist, struct perf_event_attr *attr, 116 evsel__sb_cb_t cb, void *data); 117 void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data); 118 int evlist__start_sb_thread(struct evlist *evlist, struct target *target); 119 void evlist__stop_sb_thread(struct evlist *evlist); 120 121 int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler); 122 123 int __evlist__set_tracepoints_handlers(struct evlist *evlist, 124 const struct evsel_str_handler *assocs, 125 size_t nr_assocs); 126 127 #define evlist__set_tracepoints_handlers(evlist, array) \ 128 __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array)) 129 130 int evlist__set_tp_filter(struct evlist *evlist, const char *filter); 131 int evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid); 132 int evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 133 134 int evlist__append_tp_filter(struct evlist *evlist, const char *filter); 135 136 int evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid); 137 int evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 138 139 struct evsel *evlist__find_tracepoint_by_id(struct evlist *evlist, int id); 140 struct evsel *evlist__find_tracepoint_by_name(struct evlist *evlist, const char *name); 141 142 int evlist__add_pollfd(struct evlist *evlist, int fd); 143 int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask); 144 145 int evlist__poll(struct evlist *evlist, int timeout); 146 147 struct evsel *evlist__id2evsel(struct evlist *evlist, u64 id); 148 struct evsel *evlist__id2evsel_strict(struct evlist *evlist, u64 id); 149 150 struct perf_sample_id *evlist__id2sid(struct evlist *evlist, u64 id); 151 152 void evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state); 153 154 void evlist__mmap_consume(struct evlist *evlist, int idx); 155 156 int evlist__open(struct evlist *evlist); 157 void evlist__close(struct evlist *evlist); 158 159 struct callchain_param; 160 161 void evlist__set_id_pos(struct evlist *evlist); 162 void evlist__config(struct evlist *evlist, struct record_opts *opts, struct callchain_param *callchain); 163 int record_opts__config(struct record_opts *opts); 164 165 int evlist__prepare_workload(struct evlist *evlist, struct target *target, 166 const char *argv[], bool pipe_output, 167 void (*exec_error)(int signo, siginfo_t *info, void *ucontext)); 168 int evlist__start_workload(struct evlist *evlist); 169 170 struct option; 171 172 int __evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str); 173 int evlist__parse_mmap_pages(const struct option *opt, const char *str, int unset); 174 175 unsigned long perf_event_mlock_kb_in_pages(void); 176 177 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages, 178 unsigned int auxtrace_pages, 179 bool auxtrace_overwrite, int nr_cblocks, 180 int affinity, int flush, int comp_level); 181 int evlist__mmap(struct evlist *evlist, unsigned int pages); 182 void evlist__munmap(struct evlist *evlist); 183 184 size_t evlist__mmap_size(unsigned long pages); 185 186 void evlist__disable(struct evlist *evlist); 187 void evlist__enable(struct evlist *evlist); 188 void evlist__toggle_enable(struct evlist *evlist); 189 void evlist__disable_evsel(struct evlist *evlist, char *evsel_name); 190 void evlist__enable_evsel(struct evlist *evlist, char *evsel_name); 191 192 int evlist__enable_event_idx(struct evlist *evlist, struct evsel *evsel, int idx); 193 194 void evlist__set_selected(struct evlist *evlist, struct evsel *evsel); 195 196 int evlist__create_maps(struct evlist *evlist, struct target *target); 197 int evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel); 198 199 void __evlist__set_leader(struct list_head *list); 200 void evlist__set_leader(struct evlist *evlist); 201 202 u64 __evlist__combined_sample_type(struct evlist *evlist); 203 u64 evlist__combined_sample_type(struct evlist *evlist); 204 u64 evlist__combined_branch_type(struct evlist *evlist); 205 bool evlist__sample_id_all(struct evlist *evlist); 206 u16 evlist__id_hdr_size(struct evlist *evlist); 207 208 int evlist__parse_sample(struct evlist *evlist, union perf_event *event, struct perf_sample *sample); 209 int evlist__parse_sample_timestamp(struct evlist *evlist, union perf_event *event, u64 *timestamp); 210 211 bool evlist__valid_sample_type(struct evlist *evlist); 212 bool evlist__valid_sample_id_all(struct evlist *evlist); 213 bool evlist__valid_read_format(struct evlist *evlist); 214 215 void evlist__splice_list_tail(struct evlist *evlist, struct list_head *list); 216 217 static inline bool evlist__empty(struct evlist *evlist) 218 { 219 return list_empty(&evlist->core.entries); 220 } 221 222 static inline struct evsel *evlist__first(struct evlist *evlist) 223 { 224 struct perf_evsel *evsel = perf_evlist__first(&evlist->core); 225 226 return container_of(evsel, struct evsel, core); 227 } 228 229 static inline struct evsel *evlist__last(struct evlist *evlist) 230 { 231 struct perf_evsel *evsel = perf_evlist__last(&evlist->core); 232 233 return container_of(evsel, struct evsel, core); 234 } 235 236 int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size); 237 int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size); 238 239 bool evlist__can_select_event(struct evlist *evlist, const char *str); 240 void evlist__to_front(struct evlist *evlist, struct evsel *move_evsel); 241 242 /** 243 * __evlist__for_each_entry - iterate thru all the evsels 244 * @list: list_head instance to iterate 245 * @evsel: struct evsel iterator 246 */ 247 #define __evlist__for_each_entry(list, evsel) \ 248 list_for_each_entry(evsel, list, core.node) 249 250 /** 251 * evlist__for_each_entry - iterate thru all the evsels 252 * @evlist: evlist instance to iterate 253 * @evsel: struct evsel iterator 254 */ 255 #define evlist__for_each_entry(evlist, evsel) \ 256 __evlist__for_each_entry(&(evlist)->core.entries, evsel) 257 258 /** 259 * __evlist__for_each_entry_continue - continue iteration thru all the evsels 260 * @list: list_head instance to iterate 261 * @evsel: struct evsel iterator 262 */ 263 #define __evlist__for_each_entry_continue(list, evsel) \ 264 list_for_each_entry_continue(evsel, list, core.node) 265 266 /** 267 * evlist__for_each_entry_continue - continue iteration thru all the evsels 268 * @evlist: evlist instance to iterate 269 * @evsel: struct evsel iterator 270 */ 271 #define evlist__for_each_entry_continue(evlist, evsel) \ 272 __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel) 273 274 /** 275 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 276 * @list: list_head instance to iterate 277 * @evsel: struct evsel iterator 278 */ 279 #define __evlist__for_each_entry_reverse(list, evsel) \ 280 list_for_each_entry_reverse(evsel, list, core.node) 281 282 /** 283 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 284 * @evlist: evlist instance to iterate 285 * @evsel: struct evsel iterator 286 */ 287 #define evlist__for_each_entry_reverse(evlist, evsel) \ 288 __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel) 289 290 /** 291 * __evlist__for_each_entry_safe - safely iterate thru all the evsels 292 * @list: list_head instance to iterate 293 * @tmp: struct evsel temp iterator 294 * @evsel: struct evsel iterator 295 */ 296 #define __evlist__for_each_entry_safe(list, tmp, evsel) \ 297 list_for_each_entry_safe(evsel, tmp, list, core.node) 298 299 /** 300 * evlist__for_each_entry_safe - safely iterate thru all the evsels 301 * @evlist: evlist instance to iterate 302 * @evsel: struct evsel iterator 303 * @tmp: struct evsel temp iterator 304 */ 305 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \ 306 __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel) 307 308 #define evlist__for_each_cpu(evlist, index, cpu) \ 309 evlist__cpu_iter_start(evlist); \ 310 perf_cpu_map__for_each_cpu (cpu, index, (evlist)->core.all_cpus) 311 312 struct evsel *evlist__get_tracking_event(struct evlist *evlist); 313 void evlist__set_tracking_event(struct evlist *evlist, struct evsel *tracking_evsel); 314 315 void evlist__cpu_iter_start(struct evlist *evlist); 316 bool evsel__cpu_iter_skip(struct evsel *ev, int cpu); 317 bool evsel__cpu_iter_skip_no_inc(struct evsel *ev, int cpu); 318 319 struct evsel *evlist__find_evsel_by_str(struct evlist *evlist, const char *str); 320 321 struct evsel *evlist__event2evsel(struct evlist *evlist, union perf_event *event); 322 323 bool evlist__exclude_kernel(struct evlist *evlist); 324 325 void evlist__force_leader(struct evlist *evlist); 326 327 struct evsel *evlist__reset_weak_group(struct evlist *evlist, struct evsel *evsel, bool close); 328 329 #define EVLIST_CTL_CMD_ENABLE_TAG "enable" 330 #define EVLIST_CTL_CMD_DISABLE_TAG "disable" 331 #define EVLIST_CTL_CMD_ACK_TAG "ack\n" 332 #define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot" 333 334 #define EVLIST_CTL_CMD_MAX_LEN 64 335 336 enum evlist_ctl_cmd { 337 EVLIST_CTL_CMD_UNSUPPORTED = 0, 338 EVLIST_CTL_CMD_ENABLE, 339 EVLIST_CTL_CMD_DISABLE, 340 EVLIST_CTL_CMD_ACK, 341 EVLIST_CTL_CMD_SNAPSHOT, 342 }; 343 344 int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close); 345 void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close); 346 int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack); 347 int evlist__finalize_ctlfd(struct evlist *evlist); 348 bool evlist__ctlfd_initialized(struct evlist *evlist); 349 int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd); 350 int evlist__ctlfd_ack(struct evlist *evlist); 351 352 #define EVLIST_ENABLED_MSG "Events enabled\n" 353 #define EVLIST_DISABLED_MSG "Events disabled\n" 354 355 struct evsel *evlist__find_evsel(struct evlist *evlist, int idx); 356 #endif /* __PERF_EVLIST_H */ 357