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 }; 78 79 struct evsel_str_handler { 80 const char *name; 81 void *handler; 82 }; 83 84 struct evlist *evlist__new(void); 85 struct evlist *perf_evlist__new_default(void); 86 struct evlist *perf_evlist__new_dummy(void); 87 void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus, 88 struct perf_thread_map *threads); 89 void evlist__exit(struct evlist *evlist); 90 void evlist__delete(struct evlist *evlist); 91 92 void evlist__add(struct evlist *evlist, struct evsel *entry); 93 void evlist__remove(struct evlist *evlist, struct evsel *evsel); 94 95 int __evlist__add_default(struct evlist *evlist, bool precise); 96 97 static inline int evlist__add_default(struct evlist *evlist) 98 { 99 return __evlist__add_default(evlist, true); 100 } 101 102 int __evlist__add_default_attrs(struct evlist *evlist, 103 struct perf_event_attr *attrs, size_t nr_attrs); 104 105 #define evlist__add_default_attrs(evlist, array) \ 106 __evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array)) 107 108 int evlist__add_dummy(struct evlist *evlist); 109 110 int perf_evlist__add_sb_event(struct evlist *evlist, 111 struct perf_event_attr *attr, 112 evsel__sb_cb_t cb, 113 void *data); 114 void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data); 115 int perf_evlist__start_sb_thread(struct evlist *evlist, 116 struct target *target); 117 void perf_evlist__stop_sb_thread(struct evlist *evlist); 118 119 int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler); 120 121 int __evlist__set_tracepoints_handlers(struct evlist *evlist, 122 const struct evsel_str_handler *assocs, 123 size_t nr_assocs); 124 125 #define evlist__set_tracepoints_handlers(evlist, array) \ 126 __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array)) 127 128 void __perf_evlist__set_sample_bit(struct evlist *evlist, 129 enum perf_event_sample_format bit); 130 void __perf_evlist__reset_sample_bit(struct evlist *evlist, 131 enum perf_event_sample_format bit); 132 133 #define perf_evlist__set_sample_bit(evlist, bit) \ 134 __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit) 135 136 #define perf_evlist__reset_sample_bit(evlist, bit) \ 137 __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit) 138 139 int perf_evlist__set_tp_filter(struct evlist *evlist, const char *filter); 140 int perf_evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid); 141 int perf_evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 142 143 int perf_evlist__append_tp_filter(struct evlist *evlist, const char *filter); 144 145 int perf_evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid); 146 int perf_evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids); 147 148 struct evsel * 149 perf_evlist__find_tracepoint_by_id(struct evlist *evlist, int id); 150 151 struct evsel * 152 perf_evlist__find_tracepoint_by_name(struct evlist *evlist, 153 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 int evlist__poll(struct evlist *evlist, int timeout); 159 160 struct evsel *perf_evlist__id2evsel(struct evlist *evlist, u64 id); 161 struct evsel *perf_evlist__id2evsel_strict(struct evlist *evlist, 162 u64 id); 163 164 struct perf_sample_id *perf_evlist__id2sid(struct evlist *evlist, u64 id); 165 166 void perf_evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state); 167 168 void evlist__mmap_consume(struct evlist *evlist, int idx); 169 170 int evlist__open(struct evlist *evlist); 171 void evlist__close(struct evlist *evlist); 172 173 struct callchain_param; 174 175 void perf_evlist__set_id_pos(struct evlist *evlist); 176 void perf_evlist__config(struct evlist *evlist, struct record_opts *opts, 177 struct callchain_param *callchain); 178 int record_opts__config(struct record_opts *opts); 179 180 int perf_evlist__prepare_workload(struct evlist *evlist, 181 struct target *target, 182 const char *argv[], bool pipe_output, 183 void (*exec_error)(int signo, siginfo_t *info, 184 void *ucontext)); 185 int perf_evlist__start_workload(struct evlist *evlist); 186 187 struct option; 188 189 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str); 190 int perf_evlist__parse_mmap_pages(const struct option *opt, 191 const char *str, 192 int unset); 193 194 unsigned long perf_event_mlock_kb_in_pages(void); 195 196 int evlist__mmap_ex(struct evlist *evlist, unsigned int pages, 197 unsigned int auxtrace_pages, 198 bool auxtrace_overwrite, int nr_cblocks, 199 int affinity, int flush, int comp_level); 200 int evlist__mmap(struct evlist *evlist, unsigned int pages); 201 void evlist__munmap(struct evlist *evlist); 202 203 size_t evlist__mmap_size(unsigned long pages); 204 205 void evlist__disable(struct evlist *evlist); 206 void evlist__enable(struct evlist *evlist); 207 void perf_evlist__toggle_enable(struct evlist *evlist); 208 209 int perf_evlist__enable_event_idx(struct evlist *evlist, 210 struct evsel *evsel, int idx); 211 212 void perf_evlist__set_selected(struct evlist *evlist, 213 struct evsel *evsel); 214 215 int perf_evlist__create_maps(struct evlist *evlist, struct target *target); 216 int perf_evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel); 217 218 void __perf_evlist__set_leader(struct list_head *list); 219 void perf_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 perf_evlist__id_hdr_size(struct evlist *evlist); 226 227 int perf_evlist__parse_sample(struct evlist *evlist, union perf_event *event, 228 struct perf_sample *sample); 229 230 int perf_evlist__parse_sample_timestamp(struct evlist *evlist, 231 union perf_event *event, 232 u64 *timestamp); 233 234 bool evlist__valid_sample_type(struct evlist *evlist); 235 bool evlist__valid_sample_id_all(struct evlist *evlist); 236 bool perf_evlist__valid_read_format(struct evlist *evlist); 237 238 void perf_evlist__splice_list_tail(struct evlist *evlist, 239 struct list_head *list); 240 241 static inline bool perf_evlist__empty(struct evlist *evlist) 242 { 243 return list_empty(&evlist->core.entries); 244 } 245 246 static inline struct evsel *evlist__first(struct evlist *evlist) 247 { 248 struct perf_evsel *evsel = perf_evlist__first(&evlist->core); 249 250 return container_of(evsel, struct evsel, core); 251 } 252 253 static inline struct evsel *evlist__last(struct evlist *evlist) 254 { 255 struct perf_evsel *evsel = perf_evlist__last(&evlist->core); 256 257 return container_of(evsel, struct evsel, core); 258 } 259 260 int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size); 261 int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size); 262 263 bool perf_evlist__can_select_event(struct evlist *evlist, const char *str); 264 void perf_evlist__to_front(struct evlist *evlist, 265 struct evsel *move_evsel); 266 267 /** 268 * __evlist__for_each_entry - iterate thru all the evsels 269 * @list: list_head instance to iterate 270 * @evsel: struct evsel iterator 271 */ 272 #define __evlist__for_each_entry(list, evsel) \ 273 list_for_each_entry(evsel, list, core.node) 274 275 /** 276 * evlist__for_each_entry - iterate thru all the evsels 277 * @evlist: evlist instance to iterate 278 * @evsel: struct evsel iterator 279 */ 280 #define evlist__for_each_entry(evlist, evsel) \ 281 __evlist__for_each_entry(&(evlist)->core.entries, evsel) 282 283 /** 284 * __evlist__for_each_entry_continue - continue iteration thru all the evsels 285 * @list: list_head instance to iterate 286 * @evsel: struct evsel iterator 287 */ 288 #define __evlist__for_each_entry_continue(list, evsel) \ 289 list_for_each_entry_continue(evsel, list, core.node) 290 291 /** 292 * evlist__for_each_entry_continue - continue iteration thru all the evsels 293 * @evlist: evlist instance to iterate 294 * @evsel: struct evsel iterator 295 */ 296 #define evlist__for_each_entry_continue(evlist, evsel) \ 297 __evlist__for_each_entry_continue(&(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 #define evlist__for_each_cpu(evlist, index, cpu) \ 334 evlist__cpu_iter_start(evlist); \ 335 perf_cpu_map__for_each_cpu (cpu, index, (evlist)->core.all_cpus) 336 337 struct evsel *perf_evlist__get_tracking_event(struct evlist *evlist); 338 void perf_evlist__set_tracking_event(struct evlist *evlist, 339 struct evsel *tracking_evsel); 340 341 void evlist__cpu_iter_start(struct evlist *evlist); 342 bool evsel__cpu_iter_skip(struct evsel *ev, int cpu); 343 bool evsel__cpu_iter_skip_no_inc(struct evsel *ev, int cpu); 344 345 struct evsel * 346 perf_evlist__find_evsel_by_str(struct evlist *evlist, const char *str); 347 348 struct evsel *perf_evlist__event2evsel(struct evlist *evlist, 349 union perf_event *event); 350 351 bool perf_evlist__exclude_kernel(struct evlist *evlist); 352 353 void perf_evlist__force_leader(struct evlist *evlist); 354 355 struct evsel *perf_evlist__reset_weak_group(struct evlist *evlist, 356 struct evsel *evsel, 357 bool close); 358 #endif /* __PERF_EVLIST_H */ 359