xref: /linux/tools/testing/selftests/mm/vm_util.h (revision 6aacab308a5dfd222b2d23662bbae60c11007cfb)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #include <stdint.h>
3 #include <stdbool.h>
4 #include <sys/mman.h>
5 #include <err.h>
6 #include <stdarg.h>
7 #include <strings.h> /* ffsl() */
8 #include <unistd.h> /* _SC_PAGESIZE */
9 #include "kselftest.h"
10 #include <linux/fs.h>
11 
12 #define BIT_ULL(nr)                   (1ULL << (nr))
13 #define PM_SOFT_DIRTY                 BIT_ULL(55)
14 #define PM_MMAP_EXCLUSIVE             BIT_ULL(56)
15 #define PM_UFFD_WP                    BIT_ULL(57)
16 #define PM_GUARD_REGION               BIT_ULL(58)
17 #define PM_FILE                       BIT_ULL(61)
18 #define PM_SWAP                       BIT_ULL(62)
19 #define PM_PRESENT                    BIT_ULL(63)
20 
21 #define KPF_COMPOUND_HEAD             BIT_ULL(15)
22 #define KPF_COMPOUND_TAIL             BIT_ULL(16)
23 #define KPF_THP                       BIT_ULL(22)
24 /*
25  * Ignore the checkpatch warning, we must read from x but don't want to do
26  * anything with it in order to trigger a read page fault. We therefore must use
27  * volatile to stop the compiler from optimising this away.
28  */
29 #define FORCE_READ(x) (*(const volatile typeof(x) *)&(x))
30 
31 extern unsigned int __page_size;
32 extern unsigned int __page_shift;
33 
34 /*
35  * Represents an open fd and PROCMAP_QUERY state for binary (via ioctl)
36  * /proc/$pid/[s]maps lookup.
37  */
38 struct procmap_fd {
39 	int fd;
40 	struct procmap_query query;
41 };
42 
43 static inline unsigned int psize(void)
44 {
45 	if (!__page_size)
46 		__page_size = sysconf(_SC_PAGESIZE);
47 	return __page_size;
48 }
49 
50 static inline unsigned int pshift(void)
51 {
52 	if (!__page_shift)
53 		__page_shift = (ffsl(psize()) - 1);
54 	return __page_shift;
55 }
56 
57 static inline void force_read_pages(char *addr, unsigned int nr_pages,
58 				    size_t pagesize)
59 {
60 	for (unsigned int i = 0; i < nr_pages; i++)
61 		FORCE_READ(addr[i * pagesize]);
62 }
63 
64 bool detect_huge_zeropage(void);
65 
66 /*
67  * Plan 9 FS has bugs (at least on QEMU) where certain operations fail with
68  * ENOENT on unlinked files. See
69  * https://gitlab.com/qemu-project/qemu/-/issues/103 for some info about such
70  * bugs. There are rumours of NFS implementations with similar bugs.
71  *
72  * Ideally, tests should just detect filesystems known to have such issues and
73  * bail early. But 9pfs has the additional "feature" that it causes fstatfs to
74  * pass through the f_type field from the host filesystem. To avoid having to
75  * scrape /proc/mounts or some other hackery, tests can call this function when
76  * it seems such a bug might have been encountered.
77  */
78 static inline void skip_test_dodgy_fs(const char *op_name)
79 {
80 	ksft_test_result_skip("%s failed with ENOENT. Filesystem might be buggy (9pfs?)\n", op_name);
81 }
82 
83 uint64_t pagemap_get_entry(int fd, char *start);
84 bool pagemap_is_softdirty(int fd, char *start);
85 bool pagemap_is_swapped(int fd, char *start);
86 bool pagemap_is_populated(int fd, char *start);
87 unsigned long pagemap_get_pfn(int fd, char *start);
88 void clear_softdirty(void);
89 bool check_for_pattern(FILE *fp, const char *pattern, char *buf, size_t len);
90 uint64_t read_pmd_pagesize(void);
91 unsigned long rss_anon(void);
92 bool check_huge_anon(void *addr, int nr_hpages, uint64_t hpage_size);
93 bool check_huge_file(void *addr, int nr_hpages, uint64_t hpage_size);
94 bool check_huge_shmem(void *addr, int nr_hpages, uint64_t hpage_size);
95 int64_t allocate_transhuge(void *ptr, int pagemap_fd);
96 unsigned long default_huge_page_size(void);
97 int detect_hugetlb_page_sizes(size_t sizes[], int max);
98 int pageflags_get(unsigned long pfn, int kpageflags_fd, uint64_t *flags);
99 
100 int uffd_register(int uffd, void *addr, uint64_t len,
101 		  bool miss, bool wp, bool minor);
102 int uffd_unregister(int uffd, void *addr, uint64_t len);
103 int uffd_register_with_ioctls(int uffd, void *addr, uint64_t len,
104 			      bool miss, bool wp, bool minor, uint64_t *ioctls);
105 unsigned long get_free_hugepages(void);
106 bool check_vmflag_io(void *addr);
107 bool check_vmflag_pfnmap(void *addr);
108 bool check_vmflag_guard(void *addr);
109 int open_procmap(pid_t pid, struct procmap_fd *procmap_out);
110 int query_procmap(struct procmap_fd *procmap);
111 bool find_vma_procmap(struct procmap_fd *procmap, void *address);
112 int close_procmap(struct procmap_fd *procmap);
113 int write_sysfs(const char *file_path, unsigned long val);
114 int read_sysfs(const char *file_path, unsigned long *val);
115 bool softdirty_supported(void);
116 
117 static inline int open_self_procmap(struct procmap_fd *procmap_out)
118 {
119 	pid_t pid = getpid();
120 
121 	return open_procmap(pid, procmap_out);
122 }
123 
124 /* These helpers need to be inline to match the kselftest.h idiom. */
125 static char test_name[1024];
126 
127 static inline void log_test_start(const char *name, ...)
128 {
129 	va_list args;
130 	va_start(args, name);
131 
132 	vsnprintf(test_name, sizeof(test_name), name, args);
133 	ksft_print_msg("[RUN] %s\n", test_name);
134 
135 	va_end(args);
136 }
137 
138 static inline void log_test_result(int result)
139 {
140 	ksft_test_result_report(result, "%s\n", test_name);
141 }
142 
143 static inline int sz2ord(size_t size, size_t pagesize)
144 {
145 	return __builtin_ctzll(size / pagesize);
146 }
147 
148 void *sys_mremap(void *old_address, unsigned long old_size,
149 		 unsigned long new_size, int flags, void *new_address);
150 
151 long ksm_get_self_zero_pages(void);
152 long ksm_get_self_merging_pages(void);
153 long ksm_get_full_scans(void);
154 int ksm_use_zero_pages(void);
155 int ksm_start(void);
156 int ksm_stop(void);
157 
158 /*
159  * On ppc64 this will only work with radix 2M hugepage size
160  */
161 #define HPAGE_SHIFT 21
162 #define HPAGE_SIZE (1 << HPAGE_SHIFT)
163 
164 #define PAGEMAP_PRESENT(ent)	(((ent) & (1ull << 63)) != 0)
165 #define PAGEMAP_PFN(ent)	((ent) & ((1ull << 55) - 1))
166