evlist.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef __PERF_EVLIST_H
  3. #define __PERF_EVLIST_H 1
  4. #include <linux/compiler.h>
  5. #include <linux/kernel.h>
  6. #include <linux/refcount.h>
  7. #include <linux/list.h>
  8. #include <api/fd/array.h>
  9. #include <internal/evlist.h>
  10. #include <internal/evsel.h>
  11. #include "events_stats.h"
  12. #include "evsel.h"
  13. #include <pthread.h>
  14. #include <signal.h>
  15. #include <unistd.h>
  16. struct pollfd;
  17. struct thread_map;
  18. struct perf_cpu_map;
  19. struct record_opts;
  20. /*
  21. * State machine of bkw_mmap_state:
  22. *
  23. * .________________(forbid)_____________.
  24. * | V
  25. * NOTREADY --(0)--> RUNNING --(1)--> DATA_PENDING --(2)--> EMPTY
  26. * ^ ^ | ^ |
  27. * | |__(forbid)____/ |___(forbid)___/|
  28. * | |
  29. * \_________________(3)_______________/
  30. *
  31. * NOTREADY : Backward ring buffers are not ready
  32. * RUNNING : Backward ring buffers are recording
  33. * DATA_PENDING : We are required to collect data from backward ring buffers
  34. * EMPTY : We have collected data from backward ring buffers.
  35. *
  36. * (0): Setup backward ring buffer
  37. * (1): Pause ring buffers for reading
  38. * (2): Read from ring buffers
  39. * (3): Resume ring buffers for recording
  40. */
  41. enum bkw_mmap_state {
  42. BKW_MMAP_NOTREADY,
  43. BKW_MMAP_RUNNING,
  44. BKW_MMAP_DATA_PENDING,
  45. BKW_MMAP_EMPTY,
  46. };
  47. struct evlist {
  48. struct perf_evlist core;
  49. int nr_groups;
  50. bool enabled;
  51. int id_pos;
  52. int is_pos;
  53. u64 combined_sample_type;
  54. enum bkw_mmap_state bkw_mmap_state;
  55. struct {
  56. int cork_fd;
  57. pid_t pid;
  58. } workload;
  59. struct mmap *mmap;
  60. struct mmap *overwrite_mmap;
  61. struct evsel *selected;
  62. struct events_stats stats;
  63. struct perf_env *env;
  64. void (*trace_event_sample_raw)(struct evlist *evlist,
  65. union perf_event *event,
  66. struct perf_sample *sample);
  67. u64 first_sample_time;
  68. u64 last_sample_time;
  69. struct {
  70. pthread_t th;
  71. volatile int done;
  72. } thread;
  73. struct {
  74. int fd; /* control file descriptor */
  75. int ack; /* ack file descriptor for control commands */
  76. int pos; /* index at evlist core object to check signals */
  77. } ctl_fd;
  78. };
  79. struct evsel_str_handler {
  80. const char *name;
  81. void *handler;
  82. };
  83. struct evlist *evlist__new(void);
  84. struct evlist *perf_evlist__new_default(void);
  85. struct evlist *perf_evlist__new_dummy(void);
  86. void evlist__init(struct evlist *evlist, struct perf_cpu_map *cpus,
  87. struct perf_thread_map *threads);
  88. void evlist__exit(struct evlist *evlist);
  89. void evlist__delete(struct evlist *evlist);
  90. void evlist__add(struct evlist *evlist, struct evsel *entry);
  91. void evlist__remove(struct evlist *evlist, struct evsel *evsel);
  92. int __evlist__add_default(struct evlist *evlist, bool precise);
  93. static inline int evlist__add_default(struct evlist *evlist)
  94. {
  95. return __evlist__add_default(evlist, true);
  96. }
  97. int __evlist__add_default_attrs(struct evlist *evlist,
  98. struct perf_event_attr *attrs, size_t nr_attrs);
  99. #define evlist__add_default_attrs(evlist, array) \
  100. __evlist__add_default_attrs(evlist, array, ARRAY_SIZE(array))
  101. int evlist__add_dummy(struct evlist *evlist);
  102. int perf_evlist__add_sb_event(struct evlist *evlist,
  103. struct perf_event_attr *attr,
  104. evsel__sb_cb_t cb,
  105. void *data);
  106. void evlist__set_cb(struct evlist *evlist, evsel__sb_cb_t cb, void *data);
  107. int perf_evlist__start_sb_thread(struct evlist *evlist,
  108. struct target *target);
  109. void perf_evlist__stop_sb_thread(struct evlist *evlist);
  110. int evlist__add_newtp(struct evlist *evlist, const char *sys, const char *name, void *handler);
  111. int __evlist__set_tracepoints_handlers(struct evlist *evlist,
  112. const struct evsel_str_handler *assocs,
  113. size_t nr_assocs);
  114. #define evlist__set_tracepoints_handlers(evlist, array) \
  115. __evlist__set_tracepoints_handlers(evlist, array, ARRAY_SIZE(array))
  116. void __perf_evlist__set_sample_bit(struct evlist *evlist,
  117. enum perf_event_sample_format bit);
  118. void __perf_evlist__reset_sample_bit(struct evlist *evlist,
  119. enum perf_event_sample_format bit);
  120. #define perf_evlist__set_sample_bit(evlist, bit) \
  121. __perf_evlist__set_sample_bit(evlist, PERF_SAMPLE_##bit)
  122. #define perf_evlist__reset_sample_bit(evlist, bit) \
  123. __perf_evlist__reset_sample_bit(evlist, PERF_SAMPLE_##bit)
  124. int perf_evlist__set_tp_filter(struct evlist *evlist, const char *filter);
  125. int perf_evlist__set_tp_filter_pid(struct evlist *evlist, pid_t pid);
  126. int perf_evlist__set_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
  127. int perf_evlist__append_tp_filter(struct evlist *evlist, const char *filter);
  128. int perf_evlist__append_tp_filter_pid(struct evlist *evlist, pid_t pid);
  129. int perf_evlist__append_tp_filter_pids(struct evlist *evlist, size_t npids, pid_t *pids);
  130. struct evsel *
  131. perf_evlist__find_tracepoint_by_id(struct evlist *evlist, int id);
  132. struct evsel *
  133. perf_evlist__find_tracepoint_by_name(struct evlist *evlist,
  134. const char *name);
  135. int evlist__add_pollfd(struct evlist *evlist, int fd);
  136. int evlist__filter_pollfd(struct evlist *evlist, short revents_and_mask);
  137. #ifdef HAVE_EVENTFD_SUPPORT
  138. int evlist__add_wakeup_eventfd(struct evlist *evlist, int fd);
  139. #endif
  140. int evlist__poll(struct evlist *evlist, int timeout);
  141. struct evsel *perf_evlist__id2evsel(struct evlist *evlist, u64 id);
  142. struct evsel *perf_evlist__id2evsel_strict(struct evlist *evlist,
  143. u64 id);
  144. struct perf_sample_id *perf_evlist__id2sid(struct evlist *evlist, u64 id);
  145. void perf_evlist__toggle_bkw_mmap(struct evlist *evlist, enum bkw_mmap_state state);
  146. void evlist__mmap_consume(struct evlist *evlist, int idx);
  147. int evlist__open(struct evlist *evlist);
  148. void evlist__close(struct evlist *evlist);
  149. struct callchain_param;
  150. void perf_evlist__set_id_pos(struct evlist *evlist);
  151. void perf_evlist__config(struct evlist *evlist, struct record_opts *opts,
  152. struct callchain_param *callchain);
  153. int record_opts__config(struct record_opts *opts);
  154. int perf_evlist__prepare_workload(struct evlist *evlist,
  155. struct target *target,
  156. const char *argv[], bool pipe_output,
  157. void (*exec_error)(int signo, siginfo_t *info,
  158. void *ucontext));
  159. int perf_evlist__start_workload(struct evlist *evlist);
  160. struct option;
  161. int __perf_evlist__parse_mmap_pages(unsigned int *mmap_pages, const char *str);
  162. int perf_evlist__parse_mmap_pages(const struct option *opt,
  163. const char *str,
  164. int unset);
  165. unsigned long perf_event_mlock_kb_in_pages(void);
  166. int evlist__mmap_ex(struct evlist *evlist, unsigned int pages,
  167. unsigned int auxtrace_pages,
  168. bool auxtrace_overwrite, int nr_cblocks,
  169. int affinity, int flush, int comp_level);
  170. int evlist__mmap(struct evlist *evlist, unsigned int pages);
  171. void evlist__munmap(struct evlist *evlist);
  172. size_t evlist__mmap_size(unsigned long pages);
  173. void evlist__disable(struct evlist *evlist);
  174. void evlist__enable(struct evlist *evlist);
  175. void perf_evlist__toggle_enable(struct evlist *evlist);
  176. int perf_evlist__enable_event_idx(struct evlist *evlist,
  177. struct evsel *evsel, int idx);
  178. void perf_evlist__set_selected(struct evlist *evlist,
  179. struct evsel *evsel);
  180. int perf_evlist__create_maps(struct evlist *evlist, struct target *target);
  181. int perf_evlist__apply_filters(struct evlist *evlist, struct evsel **err_evsel);
  182. void __perf_evlist__set_leader(struct list_head *list);
  183. void perf_evlist__set_leader(struct evlist *evlist);
  184. u64 __evlist__combined_sample_type(struct evlist *evlist);
  185. u64 evlist__combined_sample_type(struct evlist *evlist);
  186. u64 evlist__combined_branch_type(struct evlist *evlist);
  187. bool evlist__sample_id_all(struct evlist *evlist);
  188. u16 perf_evlist__id_hdr_size(struct evlist *evlist);
  189. int perf_evlist__parse_sample(struct evlist *evlist, union perf_event *event,
  190. struct perf_sample *sample);
  191. int perf_evlist__parse_sample_timestamp(struct evlist *evlist,
  192. union perf_event *event,
  193. u64 *timestamp);
  194. bool evlist__valid_sample_type(struct evlist *evlist);
  195. bool evlist__valid_sample_id_all(struct evlist *evlist);
  196. bool perf_evlist__valid_read_format(struct evlist *evlist);
  197. void perf_evlist__splice_list_tail(struct evlist *evlist,
  198. struct list_head *list);
  199. static inline bool perf_evlist__empty(struct evlist *evlist)
  200. {
  201. return list_empty(&evlist->core.entries);
  202. }
  203. static inline struct evsel *evlist__first(struct evlist *evlist)
  204. {
  205. struct perf_evsel *evsel = perf_evlist__first(&evlist->core);
  206. return container_of(evsel, struct evsel, core);
  207. }
  208. static inline struct evsel *evlist__last(struct evlist *evlist)
  209. {
  210. struct perf_evsel *evsel = perf_evlist__last(&evlist->core);
  211. return container_of(evsel, struct evsel, core);
  212. }
  213. int evlist__strerror_open(struct evlist *evlist, int err, char *buf, size_t size);
  214. int evlist__strerror_mmap(struct evlist *evlist, int err, char *buf, size_t size);
  215. bool perf_evlist__can_select_event(struct evlist *evlist, const char *str);
  216. void perf_evlist__to_front(struct evlist *evlist,
  217. struct evsel *move_evsel);
  218. /**
  219. * __evlist__for_each_entry - iterate thru all the evsels
  220. * @list: list_head instance to iterate
  221. * @evsel: struct evsel iterator
  222. */
  223. #define __evlist__for_each_entry(list, evsel) \
  224. list_for_each_entry(evsel, list, core.node)
  225. /**
  226. * evlist__for_each_entry - iterate thru all the evsels
  227. * @evlist: evlist instance to iterate
  228. * @evsel: struct evsel iterator
  229. */
  230. #define evlist__for_each_entry(evlist, evsel) \
  231. __evlist__for_each_entry(&(evlist)->core.entries, evsel)
  232. /**
  233. * __evlist__for_each_entry_continue - continue iteration thru all the evsels
  234. * @list: list_head instance to iterate
  235. * @evsel: struct evsel iterator
  236. */
  237. #define __evlist__for_each_entry_continue(list, evsel) \
  238. list_for_each_entry_continue(evsel, list, core.node)
  239. /**
  240. * evlist__for_each_entry_continue - continue iteration thru all the evsels
  241. * @evlist: evlist instance to iterate
  242. * @evsel: struct evsel iterator
  243. */
  244. #define evlist__for_each_entry_continue(evlist, evsel) \
  245. __evlist__for_each_entry_continue(&(evlist)->core.entries, evsel)
  246. /**
  247. * __evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
  248. * @list: list_head instance to iterate
  249. * @evsel: struct evsel iterator
  250. */
  251. #define __evlist__for_each_entry_reverse(list, evsel) \
  252. list_for_each_entry_reverse(evsel, list, core.node)
  253. /**
  254. * evlist__for_each_entry_reverse - iterate thru all the evsels in reverse order
  255. * @evlist: evlist instance to iterate
  256. * @evsel: struct evsel iterator
  257. */
  258. #define evlist__for_each_entry_reverse(evlist, evsel) \
  259. __evlist__for_each_entry_reverse(&(evlist)->core.entries, evsel)
  260. /**
  261. * __evlist__for_each_entry_safe - safely iterate thru all the evsels
  262. * @list: list_head instance to iterate
  263. * @tmp: struct evsel temp iterator
  264. * @evsel: struct evsel iterator
  265. */
  266. #define __evlist__for_each_entry_safe(list, tmp, evsel) \
  267. list_for_each_entry_safe(evsel, tmp, list, core.node)
  268. /**
  269. * evlist__for_each_entry_safe - safely iterate thru all the evsels
  270. * @evlist: evlist instance to iterate
  271. * @evsel: struct evsel iterator
  272. * @tmp: struct evsel temp iterator
  273. */
  274. #define evlist__for_each_entry_safe(evlist, tmp, evsel) \
  275. __evlist__for_each_entry_safe(&(evlist)->core.entries, tmp, evsel)
  276. #define evlist__for_each_cpu(evlist, index, cpu) \
  277. evlist__cpu_iter_start(evlist); \
  278. perf_cpu_map__for_each_cpu (cpu, index, (evlist)->core.all_cpus)
  279. struct evsel *perf_evlist__get_tracking_event(struct evlist *evlist);
  280. void perf_evlist__set_tracking_event(struct evlist *evlist,
  281. struct evsel *tracking_evsel);
  282. void evlist__cpu_iter_start(struct evlist *evlist);
  283. bool evsel__cpu_iter_skip(struct evsel *ev, int cpu);
  284. bool evsel__cpu_iter_skip_no_inc(struct evsel *ev, int cpu);
  285. struct evsel *
  286. perf_evlist__find_evsel_by_str(struct evlist *evlist, const char *str);
  287. struct evsel *perf_evlist__event2evsel(struct evlist *evlist,
  288. union perf_event *event);
  289. bool perf_evlist__exclude_kernel(struct evlist *evlist);
  290. void perf_evlist__force_leader(struct evlist *evlist);
  291. struct evsel *perf_evlist__reset_weak_group(struct evlist *evlist,
  292. struct evsel *evsel,
  293. bool close);
  294. #define EVLIST_CTL_CMD_ENABLE_TAG "enable"
  295. #define EVLIST_CTL_CMD_DISABLE_TAG "disable"
  296. #define EVLIST_CTL_CMD_ACK_TAG "ack\n"
  297. #define EVLIST_CTL_CMD_SNAPSHOT_TAG "snapshot"
  298. #define EVLIST_CTL_CMD_MAX_LEN 64
  299. enum evlist_ctl_cmd {
  300. EVLIST_CTL_CMD_UNSUPPORTED = 0,
  301. EVLIST_CTL_CMD_ENABLE,
  302. EVLIST_CTL_CMD_DISABLE,
  303. EVLIST_CTL_CMD_ACK,
  304. EVLIST_CTL_CMD_SNAPSHOT,
  305. };
  306. int evlist__parse_control(const char *str, int *ctl_fd, int *ctl_fd_ack, bool *ctl_fd_close);
  307. void evlist__close_control(int ctl_fd, int ctl_fd_ack, bool *ctl_fd_close);
  308. int evlist__initialize_ctlfd(struct evlist *evlist, int ctl_fd, int ctl_fd_ack);
  309. int evlist__finalize_ctlfd(struct evlist *evlist);
  310. bool evlist__ctlfd_initialized(struct evlist *evlist);
  311. int evlist__ctlfd_process(struct evlist *evlist, enum evlist_ctl_cmd *cmd);
  312. int evlist__ctlfd_ack(struct evlist *evlist);
  313. #define EVLIST_ENABLED_MSG "Events enabled\n"
  314. #define EVLIST_DISABLED_MSG "Events disabled\n"
  315. struct evsel *evlist__find_evsel(struct evlist *evlist, int idx);
  316. #endif /* __PERF_EVLIST_H */