xref: /freebsd-src/contrib/netbsd-tests/lib/libc/sys/t_mincore.c (revision 6144b07f9b424836f6810e06048cbb35a9ce2f34)
1 /* $NetBSD: t_mincore.c,v 1.8 2012/06/08 07:18:58 martin 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.8 2012/06/08 07:18:58 martin Exp $");
63 
64 #include <sys/mman.h>
65 #include <sys/shm.h>
66 
67 #include <atf-c.h>
68 #include <errno.h>
69 #include <fcntl.h>
70 #include <kvm.h>
71 #include <stdio.h>
72 #include <stdlib.h>
73 #include <string.h>
74 #include <unistd.h>
75 #include <sys/resource.h>
76 
77 #ifdef __FreeBSD__
78 #include <sys/stat.h>
79 #endif
80 
81 static long		page = 0;
82 static const char	path[] = "mincore";
83 static size_t		check_residency(void *, size_t);
84 
85 static size_t
86 check_residency(void *addr, size_t npgs)
87 {
88 	size_t i, resident;
89 	char *vec;
90 
91 	vec = malloc(npgs);
92 
93 	ATF_REQUIRE(vec != NULL);
94 	ATF_REQUIRE(mincore(addr, npgs * page, vec) == 0);
95 
96 	for (i = resident = 0; i < npgs; i++) {
97 
98 		if (vec[i] != 0)
99 			resident++;
100 
101 #if 0
102 		(void)fprintf(stderr, "page 0x%p is %sresident\n",
103 		    (char *)addr + (i * page), vec[i] ? "" : "not ");
104 #endif
105 	}
106 
107 	free(vec);
108 
109 	return resident;
110 }
111 
112 ATF_TC(mincore_err);
113 ATF_TC_HEAD(mincore_err, tc)
114 {
115 	atf_tc_set_md_var(tc, "descr", "Test errors from mincore(2)");
116 }
117 
118 ATF_TC_BODY(mincore_err, tc)
119 {
120 	char *map, *vec;
121 
122 	map = mmap(NULL, page, PROT_WRITE, MAP_ANON | MAP_PRIVATE, -1, 0);
123 	vec = malloc(page);
124 
125 	ATF_REQUIRE(vec != NULL);
126 	ATF_REQUIRE(map != MAP_FAILED);
127 
128 #ifdef __NetBSD__
129 	errno = 0;
130 	ATF_REQUIRE_ERRNO(EINVAL, mincore(map, 0, vec) == -1);
131 #endif
132 
133 	errno = 0;
134 	ATF_REQUIRE_ERRNO(ENOMEM, mincore(0, page, vec) == -1);
135 
136 	errno = 0;
137 	ATF_REQUIRE_ERRNO(EFAULT, mincore(map, page, (void *)-1) == -1);
138 
139 	free(vec);
140 	ATF_REQUIRE(munmap(map, page) == 0);
141 }
142 
143 ATF_TC_WITH_CLEANUP(mincore_resid);
144 ATF_TC_HEAD(mincore_resid, tc)
145 {
146 	atf_tc_set_md_var(tc, "descr", "Test page residency with mincore(2)");
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 	rlim.rlim_cur = rlim.rlim_max;
159 	ATF_REQUIRE(setrlimit(RLIMIT_MEMLOCK, &rlim) == 0);
160 
161 	(void)memset(&st, 0, sizeof(struct stat));
162 
163 	fd = open(path, O_RDWR | O_CREAT, 0700);
164 	buf = malloc(page * 5);
165 
166 	ATF_REQUIRE(fd >= 0);
167 	ATF_REQUIRE(buf != NULL);
168 
169 	rv = write(fd, buf, page * 5);
170 	ATF_REQUIRE(rv >= 0);
171 
172 	ATF_REQUIRE(fd >= 0);
173 	ATF_REQUIRE(fstat(fd, &st) == 0);
174 
175 	addr = mmap(NULL, (size_t)st.st_size, PROT_READ,
176 	    MAP_FILE | MAP_SHARED, fd, (off_t) 0);
177 
178 	ATF_REQUIRE(addr != MAP_FAILED);
179 
180 	(void)close(fd);
181 
182 	npgs = st.st_size / page;
183 
184 	if (st.st_size % page != 0)
185 		npgs++;
186 
187 	(void)check_residency(addr, npgs);
188 
189 	rv = mlock(addr, npgs * page);
190 	if (rv == -1 && errno == EAGAIN)
191 		atf_tc_skip("hit process resource limits");
192 	ATF_REQUIRE(munmap(addr, st.st_size) == 0);
193 
194 	npgs = 128;
195 
196 #ifdef __FreeBSD__
197 	addr = mmap(NULL, npgs * page, PROT_READ | PROT_WRITE,
198 	    MAP_ANON | MAP_PRIVATE, -1, (off_t)0);
199 #else
200 	addr = mmap(NULL, npgs * page, PROT_READ | PROT_WRITE,
201 	    MAP_ANON | MAP_PRIVATE | MAP_WIRED, -1, (off_t)0);
202 #endif
203 
204 	if (addr == MAP_FAILED)
205 		atf_tc_skip("could not mmap wired anonymous test area, system "
206 		    "might be low on memory");
207 
208 #ifdef __FreeBSD__
209 	ATF_REQUIRE_MSG(mlock(addr, npgs * page) == 0, "mlock failed: %s",
210 	    strerror(errno));
211 #endif
212 	ATF_REQUIRE(check_residency(addr, npgs) == npgs);
213 	ATF_REQUIRE(munmap(addr, npgs * page) == 0);
214 
215 	npgs = 128;
216 
217 	addr = mmap(NULL, npgs * page, PROT_READ | PROT_WRITE,
218 	    MAP_ANON | MAP_PRIVATE, -1, (off_t)0);
219 
220 	ATF_REQUIRE(addr != MAP_FAILED);
221 
222 	/*
223 	 * Check that the in-core pages match the locked pages.
224 	 */
225 	ATF_REQUIRE(check_residency(addr, npgs) == 0);
226 
227 	errno = 0;
228 	if (mlockall(MCL_CURRENT|MCL_FUTURE) != 0 && errno != ENOMEM)
229 		atf_tc_fail("mlockall(2) failed");
230 	if (errno == ENOMEM)
231 		atf_tc_skip("mlockall() exceeded process resource limits");
232 
233 	resident = check_residency(addr, npgs);
234 	if (resident < npgs)
235 		atf_tc_fail("mlockall(MCL_FUTURE) succeeded, still only "
236 		    "%zu pages of the newly mapped %zu pages are resident",
237 		    resident, npgs);
238 
239 	addr2 = mmap(NULL, npgs * page, PROT_READ, MAP_ANON, -1, (off_t)0);
240 	addr3 = mmap(NULL, npgs * page, PROT_NONE, MAP_ANON, -1, (off_t)0);
241 
242 	if (addr2 == MAP_FAILED || addr3 == MAP_FAILED)
243 		atf_tc_skip("could not mmap more anonymous test pages with "
244 		    "mlockall(MCL_FUTURE) in effect, system "
245 		    "might be low on memory");
246 
247 	ATF_REQUIRE(check_residency(addr2, npgs) == npgs);
248 	ATF_REQUIRE(check_residency(addr3, npgs) == 0);
249 	ATF_REQUIRE(mprotect(addr3, npgs * page, PROT_READ) == 0);
250 	ATF_REQUIRE(check_residency(addr, npgs) == npgs);
251 	ATF_REQUIRE(check_residency(addr2, npgs) == npgs);
252 
253 	(void)munlockall();
254 
255 	ATF_REQUIRE(madvise(addr2, npgs * page, MADV_FREE) == 0);
256 #ifdef __NetBSD__
257 	ATF_REQUIRE(check_residency(addr2, npgs) == 0);
258 #endif
259 
260 	(void)memset(addr, 0, npgs * page);
261 
262 	ATF_REQUIRE(madvise(addr, npgs * page, MADV_FREE) == 0);
263 #ifdef __NetBSD__
264 	ATF_REQUIRE(check_residency(addr, npgs) == 0);
265 #endif
266 
267 	(void)munmap(addr, npgs * page);
268 	(void)munmap(addr2, npgs * page);
269 	(void)munmap(addr3, npgs * page);
270 	(void)unlink(path);
271 }
272 
273 ATF_TC_CLEANUP(mincore_resid, tc)
274 {
275 	(void)unlink(path);
276 }
277 
278 ATF_TC(mincore_shmseg);
279 ATF_TC_HEAD(mincore_shmseg, tc)
280 {
281 	atf_tc_set_md_var(tc, "descr", "residency of shared memory");
282 }
283 
284 ATF_TC_BODY(mincore_shmseg, tc)
285 {
286 	size_t npgs = 128;
287 	void *addr = NULL;
288 	int shmid;
289 
290 	shmid = shmget(IPC_PRIVATE, npgs * page,
291 	    IPC_CREAT | S_IRUSR | S_IWUSR);
292 
293 	ATF_REQUIRE(shmid != -1);
294 
295 	addr = shmat(shmid, NULL, 0);
296 
297 	ATF_REQUIRE(addr != NULL);
298 	ATF_REQUIRE(check_residency(addr, npgs) == 0);
299 
300 	(void)memset(addr, 0xff, npgs * page);
301 
302 	ATF_REQUIRE(check_residency(addr, npgs) == npgs);
303 	ATF_REQUIRE(madvise(addr, npgs * page, MADV_FREE) == 0);
304 
305 	/*
306 	 * NOTE!  Even though we have MADV_FREE'd the range,
307 	 * there is another reference (the kernel's) to the
308 	 * object which owns the pages.  In this case, the
309 	 * kernel does not simply free the pages, as haphazardly
310 	 * freeing pages when there are still references to
311 	 * an object can cause data corruption (say, the other
312 	 * referencer doesn't expect the pages to be freed,
313 	 * and is surprised by the subsequent ZFOD).
314 	 *
315 	 * Because of this, we simply report the number of
316 	 * pages still resident, for information only.
317 	 */
318 	npgs = check_residency(addr, npgs);
319 
320 	(void)fprintf(stderr, "%zu pages still resident\n", npgs);
321 
322 	ATF_REQUIRE(shmdt(addr) == 0);
323 	ATF_REQUIRE(shmctl(shmid, IPC_RMID, NULL) == 0);
324 }
325 
326 ATF_TP_ADD_TCS(tp)
327 {
328 
329 	page = sysconf(_SC_PAGESIZE);
330 	ATF_REQUIRE(page >= 0);
331 
332 	ATF_TP_ADD_TC(tp, mincore_err);
333 	ATF_TP_ADD_TC(tp, mincore_resid);
334 	ATF_TP_ADD_TC(tp, mincore_shmseg);
335 
336 	return atf_no_error();
337 }
338