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