xref: /freebsd-src/contrib/netbsd-tests/lib/libc/sys/t_mincore.c (revision ddba0402f443ad5f70ea315ede04aa7d6fa53691)
1 /* $NetBSD: t_mincore.c,v 1.9 2017/01/10 22:36:29 christos Exp $ */
2 
3 /*-
4  * Copyright (c) 2011 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jukka Ruohonen.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*-
33  * Copyright (c) 1999 The NetBSD Foundation, Inc.
34  * All rights reserved.
35  *
36  * This code is derived from software contributed to The NetBSD Foundation
37  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
38  * NASA Ames Research Center.
39  *
40  * Redistribution and use in source and binary forms, with or without
41  * modification, are permitted provided that the following conditions
42  * are met:
43  * 1. Redistributions of source code must retain the above copyright
44  *    notice, this list of conditions and the following disclaimer.
45  * 2. Redistributions in binary form must reproduce the above copyright
46  *    notice, this list of conditions and the following disclaimer in the
47  *    documentation and/or other materials provided with the distribution.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
50  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
51  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
52  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
53  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
54  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
55  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
56  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
57  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
58  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
59  * POSSIBILITY OF SUCH DAMAGE.
60  */
61 #include <sys/cdefs.h>
62 __RCSID("$NetBSD: t_mincore.c,v 1.9 2017/01/10 22:36:29 christos Exp $");
63 
64 #include <sys/mman.h>
65 #include <sys/stat.h>
66 #include <sys/shm.h>
67 
68 #include <atf-c.h>
69 #include <errno.h>
70 #include <fcntl.h>
71 #include <kvm.h>
72 #include <stdio.h>
73 #include <stdlib.h>
74 #include <string.h>
75 #include <unistd.h>
76 #include <sys/resource.h>
77 
78 static long		page = 0;
79 static const char	path[] = "mincore";
80 static size_t		check_residency(void *, size_t);
81 
82 static size_t
83 check_residency(void *addr, size_t npgs)
84 {
85 	size_t i, resident;
86 	char *vec;
87 
88 	vec = malloc(npgs);
89 
90 	ATF_REQUIRE(vec != NULL);
91 	ATF_REQUIRE(mincore(addr, npgs * page, vec) == 0);
92 
93 	for (i = resident = 0; i < npgs; i++) {
94 
95 		if (vec[i] != 0)
96 			resident++;
97 
98 #if 0
99 		(void)fprintf(stderr, "page 0x%p is %sresident\n",
100 		    (char *)addr + (i * page), vec[i] ? "" : "not ");
101 #endif
102 	}
103 
104 	free(vec);
105 
106 	return resident;
107 }
108 
109 ATF_TC(mincore_err);
110 ATF_TC_HEAD(mincore_err, tc)
111 {
112 	atf_tc_set_md_var(tc, "descr", "Test errors from mincore(2)");
113 }
114 
115 ATF_TC_BODY(mincore_err, tc)
116 {
117 	char *map, *vec;
118 
119 	map = mmap(NULL, page, PROT_WRITE, MAP_ANON | MAP_PRIVATE, -1, 0);
120 	vec = malloc(page);
121 
122 	ATF_REQUIRE(vec != NULL);
123 	ATF_REQUIRE(map != MAP_FAILED);
124 
125 #ifdef __NetBSD__
126 	errno = 0;
127 	ATF_REQUIRE_ERRNO(EINVAL, mincore(map, 0, vec) == -1);
128 #endif
129 
130 	errno = 0;
131 	ATF_REQUIRE_ERRNO(ENOMEM, mincore(0, page, vec) == -1);
132 
133 	errno = 0;
134 	ATF_REQUIRE_ERRNO(EFAULT, mincore(map, page, (void *)-1) == -1);
135 
136 	free(vec);
137 	ATF_REQUIRE(munmap(map, page) == 0);
138 }
139 
140 ATF_TC_WITH_CLEANUP(mincore_resid);
141 ATF_TC_HEAD(mincore_resid, tc)
142 {
143 	atf_tc_set_md_var(tc, "descr", "Test page residency with mincore(2)");
144 #ifdef __FreeBSD__
145 	atf_tc_set_md_var(tc, "require.user", "root");
146 #endif
147 }
148 
149 ATF_TC_BODY(mincore_resid, tc)
150 {
151 	void *addr, *addr2, *addr3, *buf;
152 	size_t npgs = 0, resident;
153 	struct stat st;
154 	int fd, rv;
155 	struct rlimit rlim;
156 
157 	ATF_REQUIRE(getrlimit(RLIMIT_MEMLOCK, &rlim) == 0);
158 #ifdef __FreeBSD__
159 	/*
160 	 * Bump the mlock limit to unlimited so the rest of the testcase
161 	 * passes instead of failing on the mlock call.
162 	 */
163 	rlim.rlim_max = RLIM_INFINITY;
164 #endif
165 	rlim.rlim_cur = rlim.rlim_max;
166 	ATF_REQUIRE(setrlimit(RLIMIT_MEMLOCK, &rlim) == 0);
167 
168 	(void)memset(&st, 0, sizeof(struct stat));
169 
170 	fd = open(path, O_RDWR | O_CREAT, 0700);
171 	buf = malloc(page * 5);
172 
173 	ATF_REQUIRE(fd >= 0);
174 	ATF_REQUIRE(buf != NULL);
175 
176 	rv = write(fd, buf, page * 5);
177 	ATF_REQUIRE(rv >= 0);
178 
179 	ATF_REQUIRE(fd >= 0);
180 	ATF_REQUIRE(fstat(fd, &st) == 0);
181 
182 	addr = mmap(NULL, (size_t)st.st_size, PROT_READ,
183 	    MAP_FILE | MAP_SHARED, fd, (off_t) 0);
184 
185 	ATF_REQUIRE(addr != MAP_FAILED);
186 
187 	(void)close(fd);
188 
189 	npgs = st.st_size / page;
190 
191 	if (st.st_size % page != 0)
192 		npgs++;
193 
194 	(void)check_residency(addr, npgs);
195 
196 	rv = mlock(addr, npgs * page);
197 	if (rv == -1 && errno == EAGAIN)
198 		atf_tc_skip("hit process resource limits");
199 	ATF_REQUIRE(munmap(addr, st.st_size) == 0);
200 
201 	npgs = 128;
202 
203 #ifdef __FreeBSD__
204 	addr = mmap(NULL, npgs * page, PROT_READ | PROT_WRITE,
205 	    MAP_ANON | MAP_PRIVATE, -1, (off_t)0);
206 #else
207 	addr = mmap(NULL, npgs * page, PROT_READ | PROT_WRITE,
208 	    MAP_ANON | MAP_PRIVATE | MAP_WIRED, -1, (off_t)0);
209 #endif
210 
211 	if (addr == MAP_FAILED)
212 		atf_tc_skip("could not mmap wired anonymous test area, system "
213 		    "might be low on memory");
214 
215 #ifdef __FreeBSD__
216 	if (mlock(addr, npgs * page) == -1 && errno != ENOMEM)
217 		atf_tc_skip("could not wire anonymous test area, system might "
218 		    "be low on memory");
219 #endif
220 	ATF_REQUIRE(check_residency(addr, npgs) == npgs);
221 	ATF_REQUIRE(munmap(addr, npgs * page) == 0);
222 
223 	npgs = 128;
224 
225 	addr = mmap(NULL, npgs * page, PROT_READ | PROT_WRITE,
226 	    MAP_ANON | MAP_PRIVATE, -1, (off_t)0);
227 
228 	ATF_REQUIRE(addr != MAP_FAILED);
229 
230 	/*
231 	 * Check that the in-core pages match the locked pages.
232 	 */
233 	ATF_REQUIRE(check_residency(addr, npgs) == 0);
234 
235 	errno = 0;
236 	if (mlockall(MCL_CURRENT|MCL_FUTURE) != 0 && errno != ENOMEM)
237 		atf_tc_fail("mlockall(2) failed");
238 	if (errno == ENOMEM)
239 		atf_tc_skip("mlockall() exceeded process resource limits");
240 
241 	resident = check_residency(addr, npgs);
242 	if (resident < npgs)
243 		atf_tc_fail("mlockall(MCL_FUTURE) succeeded, still only "
244 		    "%zu pages of the newly mapped %zu pages are resident",
245 		    resident, npgs);
246 
247 	addr2 = mmap(NULL, npgs * page, PROT_READ, MAP_ANON, -1, (off_t)0);
248 	addr3 = mmap(NULL, npgs * page, PROT_NONE, MAP_ANON, -1, (off_t)0);
249 
250 	if (addr2 == MAP_FAILED || addr3 == MAP_FAILED)
251 		atf_tc_skip("could not mmap more anonymous test pages with "
252 		    "mlockall(MCL_FUTURE) in effect, system "
253 		    "might be low on memory");
254 
255 	ATF_REQUIRE(check_residency(addr2, npgs) == npgs);
256 	ATF_REQUIRE(check_residency(addr3, npgs) == 0);
257 	ATF_REQUIRE(mprotect(addr3, npgs * page, PROT_READ) == 0);
258 	ATF_REQUIRE(check_residency(addr, npgs) == npgs);
259 	ATF_REQUIRE(check_residency(addr2, npgs) == npgs);
260 
261 	(void)munlockall();
262 
263 	ATF_REQUIRE(madvise(addr2, npgs * page, MADV_FREE) == 0);
264 #ifdef __NetBSD__
265 	ATF_REQUIRE(check_residency(addr2, npgs) == 0);
266 #endif
267 
268 	(void)memset(addr, 0, npgs * page);
269 
270 	ATF_REQUIRE(madvise(addr, npgs * page, MADV_FREE) == 0);
271 #ifdef __NetBSD__
272 	ATF_REQUIRE(check_residency(addr, npgs) == 0);
273 #endif
274 
275 	(void)munmap(addr, npgs * page);
276 	(void)munmap(addr2, npgs * page);
277 	(void)munmap(addr3, npgs * page);
278 	(void)unlink(path);
279 #ifdef	__FreeBSD__
280 	free(buf);
281 #endif
282 }
283 
284 ATF_TC_CLEANUP(mincore_resid, tc)
285 {
286 	(void)unlink(path);
287 }
288 
289 ATF_TC(mincore_shmseg);
290 ATF_TC_HEAD(mincore_shmseg, tc)
291 {
292 	atf_tc_set_md_var(tc, "descr", "residency of shared memory");
293 }
294 
295 ATF_TC_BODY(mincore_shmseg, tc)
296 {
297 	size_t npgs = 128;
298 	void *addr = NULL;
299 	int shmid;
300 
301 	shmid = shmget(IPC_PRIVATE, npgs * page,
302 	    IPC_CREAT | S_IRUSR | S_IWUSR);
303 
304 	ATF_REQUIRE(shmid != -1);
305 
306 	addr = shmat(shmid, NULL, 0);
307 
308 	ATF_REQUIRE(addr != NULL);
309 	ATF_REQUIRE(check_residency(addr, npgs) == 0);
310 
311 	(void)memset(addr, 0xff, npgs * page);
312 
313 	ATF_REQUIRE(check_residency(addr, npgs) == npgs);
314 	ATF_REQUIRE(madvise(addr, npgs * page, MADV_FREE) == 0);
315 
316 	/*
317 	 * NOTE!  Even though we have MADV_FREE'd the range,
318 	 * there is another reference (the kernel's) to the
319 	 * object which owns the pages.  In this case, the
320 	 * kernel does not simply free the pages, as haphazardly
321 	 * freeing pages when there are still references to
322 	 * an object can cause data corruption (say, the other
323 	 * referencer doesn't expect the pages to be freed,
324 	 * and is surprised by the subsequent ZFOD).
325 	 *
326 	 * Because of this, we simply report the number of
327 	 * pages still resident, for information only.
328 	 */
329 	npgs = check_residency(addr, npgs);
330 
331 	(void)fprintf(stderr, "%zu pages still resident\n", npgs);
332 
333 	ATF_REQUIRE(shmdt(addr) == 0);
334 	ATF_REQUIRE(shmctl(shmid, IPC_RMID, NULL) == 0);
335 }
336 
337 ATF_TP_ADD_TCS(tp)
338 {
339 
340 	page = sysconf(_SC_PAGESIZE);
341 	ATF_REQUIRE(page >= 0);
342 
343 	ATF_TP_ADD_TC(tp, mincore_err);
344 	ATF_TP_ADD_TC(tp, mincore_resid);
345 	ATF_TP_ADD_TC(tp, mincore_shmseg);
346 
347 	return atf_no_error();
348 }
349