1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LIBPERF_INTERNAL_MMAP_H
3 #define __LIBPERF_INTERNAL_MMAP_H
4 
5 #include <linux/compiler.h>
6 #include <linux/refcount.h>
7 #include <linux/types.h>
8 #include <stdbool.h>
9 
10 /* perf sample has 16 bits size limit */
11 #define PERF_SAMPLE_MAX_SIZE (1 << 16)
12 
13 struct perf_mmap;
14 
15 typedef void (*libperf_unmap_cb_t)(struct perf_mmap *map);
16 
17 /**
18  * struct perf_mmap - perf's ring buffer mmap details
19  *
20  * @refcnt - e.g. code using PERF_EVENT_IOC_SET_OUTPUT to share this
21  */
22 struct perf_mmap {
23 	void			*base;
24 	int			 mask;
25 	int			 fd;
26 	int			 cpu;
27 	refcount_t		 refcnt;
28 	u64			 prev;
29 	u64			 start;
30 	u64			 end;
31 	bool			 overwrite;
32 	u64			 flush;
33 	libperf_unmap_cb_t	 unmap_cb;
34 	char			 event_copy[PERF_SAMPLE_MAX_SIZE] __aligned(8);
35 	struct perf_mmap	*next;
36 };
37 
38 struct perf_mmap_param {
39 	int	prot;
40 	int	mask;
41 };
42 
43 size_t perf_mmap__mmap_len(struct perf_mmap *map);
44 
45 void perf_mmap__init(struct perf_mmap *map, struct perf_mmap *prev,
46 		     bool overwrite, libperf_unmap_cb_t unmap_cb);
47 int perf_mmap__mmap(struct perf_mmap *map, struct perf_mmap_param *mp,
48 		    int fd, int cpu);
49 void perf_mmap__munmap(struct perf_mmap *map);
50 void perf_mmap__get(struct perf_mmap *map);
51 void perf_mmap__put(struct perf_mmap *map);
52 
53 u64 perf_mmap__read_head(struct perf_mmap *map);
54 
55 #endif /* __LIBPERF_INTERNAL_MMAP_H */
56