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 <stdio.h> 11 #include "../perf.h" 12 #include "event.h" 13 #include "evsel.h" 14 #include "mmap.h" 15 #include "util.h" 16 #include <signal.h> 17 #include <unistd.h> 18 19 struct pollfd; 20 struct thread_map; 21 struct cpu_map; 22 struct record_opts; 23 24 #define PERF_EVLIST__HLIST_BITS 8 25 #define PERF_EVLIST__HLIST_SIZE (1 << PERF_EVLIST__HLIST_BITS) 26 27 struct perf_evlist { 28 struct list_head entries; 29 struct hlist_head heads[PERF_EVLIST__HLIST_SIZE]; 30 int nr_entries; 31 int nr_groups; 32 int nr_mmaps; 33 bool enabled; 34 bool has_user_cpus; 35 size_t mmap_len; 36 int id_pos; 37 int is_pos; 38 u64 combined_sample_type; 39 enum bkw_mmap_state bkw_mmap_state; 40 struct { 41 int cork_fd; 42 pid_t pid; 43 } workload; 44 struct fdarray pollfd; 45 struct perf_mmap *mmap; 46 struct perf_mmap *overwrite_mmap; 47 struct thread_map *threads; 48 struct cpu_map *cpus; 49 struct perf_evsel *selected; 50 struct events_stats stats; 51 struct perf_env *env; 52 void (*trace_event_sample_raw)(struct perf_evlist *evlist, 53 union perf_event *event, 54 struct perf_sample *sample); 55 u64 first_sample_time; 56 u64 last_sample_time; 57 }; 58 59 struct perf_evsel_str_handler { 60 const char *name; 61 void *handler; 62 }; 63 64 struct perf_evlist *perf_evlist__new(void); 65 struct perf_evlist *perf_evlist__new_default(void); 66 struct perf_evlist *perf_evlist__new_dummy(void); 67 void perf_evlist__init(struct perf_evlist *evlist, struct cpu_map *cpus, 68 struct thread_map *threads); 69 void perf_evlist__exit(struct perf_evlist *evlist); 70 void perf_evlist__delete(struct perf_evlist *evlist); 71 72 void perf_evlist__add(struct perf_evlist *evlist, struct perf_evsel *entry); 73 void perf_evlist__remove(struct perf_evlist *evlist, struct perf_evsel *evsel); 74 75 int __perf_evlist__add_default(struct perf_evlist *evlist, bool precise); 76 77 static inline int perf_evlist__add_default(struct perf_evlist *evlist) 78 { 79 return __perf_evlist__add_default(evlist, true); 80 } 81 82 int __perf_evlist__add_default_attrs(struct perf_evlist *evlist, 83 struct perf_event_attr *attrs, size_t nr_attrs); 84 85 #define perf_evlist__add_default_attrs(evlist, array) \ 86 __perf_evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array)) 87 88 int perf_evlist__add_dummy(struct perf_evlist *evlist); 89 90 int perf_evlist__add_newtp(struct perf_evlist *evlist, 91 const char *sys, const char *name, void *handler); 92 93 void __perf_evlist__set_sample_bit(struct perf_evlist *evlist, 94 enum perf_event_sample_format bit); 95 void __perf_evlist__reset_sample_bit(struct perf_evlist *evlist, 96 enum perf_event_sample_format bit); 97 98 #define perf_evlist__set_sample_bit(evlist, bit) \ 99 __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit) 100 101 #define perf_evlist__reset_sample_bit(evlist, bit) \ 102 __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit) 103 104 int perf_evlist__set_tp_filter(struct perf_evlist *evlist, const char *filter); 105 int perf_evlist__set_tp_filter_pid(struct perf_evlist *evlist, pid_t pid); 106 int perf_evlist__set_tp_filter_pids(struct perf_evlist *evlist, size_t npids, pid_t *pids); 107 108 struct perf_evsel * 109 perf_evlist__find_tracepoint_by_id(struct perf_evlist *evlist, int id); 110 111 struct perf_evsel * 112 perf_evlist__find_tracepoint_by_name(struct perf_evlist *evlist, 113 const char *name); 114 115 void perf_evlist__id_add(struct perf_evlist *evlist, struct perf_evsel *evsel, 116 int cpu, int thread, u64 id); 117 int perf_evlist__id_add_fd(struct perf_evlist *evlist, 118 struct perf_evsel *evsel, 119 int cpu, int thread, int fd); 120 121 int perf_evlist__add_pollfd(struct perf_evlist *evlist, int fd); 122 int perf_evlist__alloc_pollfd(struct perf_evlist *evlist); 123 int perf_evlist__filter_pollfd(struct perf_evlist *evlist, short revents_and_mask); 124 125 int perf_evlist__poll(struct perf_evlist *evlist, int timeout); 126 127 struct perf_evsel *perf_evlist__id2evsel(struct perf_evlist *evlist, u64 id); 128 struct perf_evsel *perf_evlist__id2evsel_strict(struct perf_evlist *evlist, 129 u64 id); 130 131 struct perf_sample_id *perf_evlist__id2sid(struct perf_evlist *evlist, u64 id); 132 133 void perf_evlist__toggle_bkw_mmap(struct perf_evlist *evlist, enum bkw_mmap_state state); 134 135 void perf_evlist__mmap_consume(struct perf_evlist *evlist, int idx); 136 137 int perf_evlist__open(struct perf_evlist *evlist); 138 void perf_evlist__close(struct perf_evlist *evlist); 139 140 struct callchain_param; 141 142 void perf_evlist__set_id_pos(struct perf_evlist *evlist); 143 bool perf_can_sample_identifier(void); 144 bool perf_can_record_switch_events(void); 145 bool perf_can_record_cpu_wide(void); 146 void perf_evlist__config(struct perf_evlist *evlist, struct record_opts *opts, 147 struct callchain_param *callchain); 148 int record_opts__config(struct record_opts *opts); 149 150 int perf_evlist__prepare_workload(struct perf_evlist *evlist, 151 struct target *target, 152 const char *argv[], bool pipe_output, 153 void (*exec_error)(int signo, siginfo_t *info, 154 void *ucontext)); 155 int perf_evlist__start_workload(struct perf_evlist *evlist); 156 157 struct option; 158 159 int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str); 160 int perf_evlist__parse_mmap_pages(const struct option *opt, 161 const char *str, 162 int unset); 163 164 unsigned long perf_event_mlock_kb_in_pages(void); 165 166 int perf_evlist__mmap_ex(struct perf_evlist *evlist, unsigned int pages, 167 unsigned int auxtrace_pages, 168 bool auxtrace_overwrite, int nr_cblocks, int affinity); 169 int perf_evlist__mmap(struct perf_evlist *evlist, unsigned int pages); 170 void perf_evlist__munmap(struct perf_evlist *evlist); 171 172 size_t perf_evlist__mmap_size(unsigned long pages); 173 174 void perf_evlist__disable(struct perf_evlist *evlist); 175 void perf_evlist__enable(struct perf_evlist *evlist); 176 void perf_evlist__toggle_enable(struct perf_evlist *evlist); 177 178 int perf_evlist__enable_event_idx(struct perf_evlist *evlist, 179 struct perf_evsel *evsel, int idx); 180 181 void perf_evlist__set_selected(struct perf_evlist *evlist, 182 struct perf_evsel *evsel); 183 184 void perf_evlist__set_maps(struct perf_evlist *evlist, struct cpu_map *cpus, 185 struct thread_map *threads); 186 int perf_evlist__create_maps(struct perf_evlist *evlist, struct target *target); 187 int perf_evlist__apply_filters(struct perf_evlist *evlist, struct perf_evsel **err_evsel); 188 189 void __perf_evlist__set_leader(struct list_head *list); 190 void perf_evlist__set_leader(struct perf_evlist *evlist); 191 192 u64 perf_evlist__read_format(struct perf_evlist *evlist); 193 u64 __perf_evlist__combined_sample_type(struct perf_evlist *evlist); 194 u64 perf_evlist__combined_sample_type(struct perf_evlist *evlist); 195 u64 perf_evlist__combined_branch_type(struct perf_evlist *evlist); 196 bool perf_evlist__sample_id_all(struct perf_evlist *evlist); 197 u16 perf_evlist__id_hdr_size(struct perf_evlist *evlist); 198 199 int perf_evlist__parse_sample(struct perf_evlist *evlist, union perf_event *event, 200 struct perf_sample *sample); 201 202 int perf_evlist__parse_sample_timestamp(struct perf_evlist *evlist, 203 union perf_event *event, 204 u64 *timestamp); 205 206 bool perf_evlist__valid_sample_type(struct perf_evlist *evlist); 207 bool perf_evlist__valid_sample_id_all(struct perf_evlist *evlist); 208 bool perf_evlist__valid_read_format(struct perf_evlist *evlist); 209 210 void perf_evlist__splice_list_tail(struct perf_evlist *evlist, 211 struct list_head *list); 212 213 static inline bool perf_evlist__empty(struct perf_evlist *evlist) 214 { 215 return list_empty(&evlist->entries); 216 } 217 218 static inline struct perf_evsel *perf_evlist__first(struct perf_evlist *evlist) 219 { 220 return list_entry(evlist->entries.next, struct perf_evsel, node); 221 } 222 223 static inline struct perf_evsel *perf_evlist__last(struct perf_evlist *evlist) 224 { 225 return list_entry(evlist->entries.prev, struct perf_evsel, node); 226 } 227 228 size_t perf_evlist__fprintf(struct perf_evlist *evlist, FILE *fp); 229 230 int perf_evlist__strerror_open(struct perf_evlist *evlist, int err, char *buf, size_t size); 231 int perf_evlist__strerror_mmap(struct perf_evlist *evlist, int err, char *buf, size_t size); 232 233 bool perf_evlist__can_select_event(struct perf_evlist *evlist, const char *str); 234 void perf_evlist__to_front(struct perf_evlist *evlist, 235 struct perf_evsel *move_evsel); 236 237 /** 238 * __evlist__for_each_entry - iterate thru all the evsels 239 * @list: list_head instance to iterate 240 * @evsel: struct evsel iterator 241 */ 242 #define __evlist__for_each_entry(list, evsel) \ 243 list_for_each_entry(evsel, list, node) 244 245 /** 246 * evlist__for_each_entry - iterate thru all the evsels 247 * @evlist: evlist instance to iterate 248 * @evsel: struct evsel iterator 249 */ 250 #define evlist__for_each_entry(evlist, evsel) \ 251 __evlist__for_each_entry(&(evlist)->entries, evsel) 252 253 /** 254 * __evlist__for_each_entry_continue - continue iteration thru all the evsels 255 * @list: list_head instance to iterate 256 * @evsel: struct evsel iterator 257 */ 258 #define __evlist__for_each_entry_continue(list, evsel) \ 259 list_for_each_entry_continue(evsel, list, node) 260 261 /** 262 * evlist__for_each_entry_continue - continue iteration thru all the evsels 263 * @evlist: evlist instance to iterate 264 * @evsel: struct evsel iterator 265 */ 266 #define evlist__for_each_entry_continue(evlist, evsel) \ 267 __evlist__for_each_entry_continue(&(evlist)->entries, evsel) 268 269 /** 270 * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 271 * @list: list_head instance to iterate 272 * @evsel: struct evsel iterator 273 */ 274 #define __evlist__for_each_entry_reverse(list, evsel) \ 275 list_for_each_entry_reverse(evsel, list, node) 276 277 /** 278 * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order 279 * @evlist: evlist instance to iterate 280 * @evsel: struct evsel iterator 281 */ 282 #define evlist__for_each_entry_reverse(evlist, evsel) \ 283 __evlist__for_each_entry_reverse(&(evlist)->entries, evsel) 284 285 /** 286 * __evlist__for_each_entry_safe - safely iterate thru all the evsels 287 * @list: list_head instance to iterate 288 * @tmp: struct evsel temp iterator 289 * @evsel: struct evsel iterator 290 */ 291 #define __evlist__for_each_entry_safe(list, tmp, evsel) \ 292 list_for_each_entry_safe(evsel, tmp, list, node) 293 294 /** 295 * evlist__for_each_entry_safe - safely iterate thru all the evsels 296 * @evlist: evlist instance to iterate 297 * @evsel: struct evsel iterator 298 * @tmp: struct evsel temp iterator 299 */ 300 #define evlist__for_each_entry_safe(evlist, tmp, evsel) \ 301 __evlist__for_each_entry_safe(&(evlist)->entries, tmp, evsel) 302 303 void perf_evlist__set_tracking_event(struct perf_evlist *evlist, 304 struct perf_evsel *tracking_evsel); 305 306 void perf_event_attr__set_max_precise_ip(struct perf_event_attr *attr); 307 308 struct perf_evsel * 309 perf_evlist__find_evsel_by_str(struct perf_evlist *evlist, const char *str); 310 311 struct perf_evsel *perf_evlist__event2evsel(struct perf_evlist *evlist, 312 union perf_event *event); 313 314 bool perf_evlist__exclude_kernel(struct perf_evlist *evlist); 315 316 void perf_evlist__force_leader(struct perf_evlist *evlist); 317 318 struct perf_evsel *perf_evlist__reset_weak_group(struct perf_evlist *evlist, 319 struct perf_evsel *evsel); 320 #endif /* __PERF_EVLIST_H */ 321