xref: /netbsd-src/tests/lib/libc/sys/t_mincore.c (revision 501cd18a74d52bfcca7d9e7e3b0d472bbc870558)
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 	errno = 0;
126 	ATF_REQUIRE_ERRNO(EINVAL, mincore(map, 0, vec) == -1);
127 
128 	errno = 0;
129 	ATF_REQUIRE_ERRNO(ENOMEM, mincore(0, page, vec) == -1);
130 
131 	errno = 0;
132 	ATF_REQUIRE_ERRNO(EFAULT, mincore(map, page, (void *)-1) == -1);
133 
134 	free(vec);
135 	ATF_REQUIRE(munmap(map, page) == 0);
136 }
137 
138 ATF_TC_WITH_CLEANUP(mincore_resid);
139 ATF_TC_HEAD(mincore_resid, tc)
140 {
141 	atf_tc_set_md_var(tc, "descr", "Test page residency with mincore(2)");
142 }
143 
144 ATF_TC_BODY(mincore_resid, tc)
145 {
146 	void *addr, *addr2, *addr3, *buf;
147 	size_t npgs = 0, resident;
148 	struct stat st;
149 	int fd, rv;
150 	struct rlimit rlim;
151 
152 	ATF_REQUIRE(getrlimit(RLIMIT_MEMLOCK, &rlim) == 0);
153 	rlim.rlim_cur = rlim.rlim_max;
154 	ATF_REQUIRE(setrlimit(RLIMIT_MEMLOCK, &rlim) == 0);
155 
156 	(void)memset(&st, 0, sizeof(struct stat));
157 
158 	fd = open(path, O_RDWR | O_CREAT, 0700);
159 	buf = malloc(page * 5);
160 
161 	ATF_REQUIRE(fd >= 0);
162 	ATF_REQUIRE(buf != NULL);
163 
164 	rv = write(fd, buf, page * 5);
165 	ATF_REQUIRE(rv >= 0);
166 
167 	ATF_REQUIRE(fd >= 0);
168 	ATF_REQUIRE(fstat(fd, &st) == 0);
169 
170 	addr = mmap(NULL, (size_t)st.st_size, PROT_READ,
171 	    MAP_FILE | MAP_SHARED, fd, (off_t) 0);
172 
173 	ATF_REQUIRE(addr != MAP_FAILED);
174 
175 	(void)close(fd);
176 
177 	npgs = st.st_size / page;
178 
179 	if (st.st_size % page != 0)
180 		npgs++;
181 
182 	(void)check_residency(addr, npgs);
183 
184 	rv = mlock(addr, npgs * page);
185 	if (rv == -1 && errno == EAGAIN)
186 		atf_tc_skip("hit process resource limits");
187 	ATF_REQUIRE(munmap(addr, st.st_size) == 0);
188 
189 	npgs = 128;
190 
191 	addr = mmap(NULL, npgs * page, PROT_READ | PROT_WRITE,
192 	    MAP_ANON | MAP_PRIVATE | MAP_WIRED, -1, (off_t)0);
193 
194 	if (addr == MAP_FAILED)
195 		atf_tc_skip("could not mmap wired anonymous test area, system "
196 		    "might be low on memory");
197 
198 	ATF_REQUIRE(check_residency(addr, npgs) == npgs);
199 	ATF_REQUIRE(munmap(addr, npgs * page) == 0);
200 
201 	npgs = 128;
202 
203 	addr = mmap(NULL, npgs * page, PROT_READ | PROT_WRITE,
204 	    MAP_ANON | MAP_PRIVATE, -1, (off_t)0);
205 
206 	ATF_REQUIRE(addr != MAP_FAILED);
207 
208 	/*
209 	 * Check that the in-core pages match the locked pages.
210 	 */
211 	ATF_REQUIRE(check_residency(addr, npgs) == 0);
212 
213 	errno = 0;
214 	if (mlockall(MCL_CURRENT|MCL_FUTURE) != 0 && errno != ENOMEM)
215 		atf_tc_fail("mlockall(2) failed");
216 	if (errno == ENOMEM)
217 		atf_tc_skip("mlockall() exceeded process resource limits");
218 
219 	resident = check_residency(addr, npgs);
220 	if (resident < npgs)
221 		atf_tc_fail("mlockall(MCL_FUTURE) succeeded, still only "
222 		    "%zu pages of the newly mapped %zu pages are resident",
223 		    resident, npgs);
224 
225 	addr2 = mmap(NULL, npgs * page, PROT_READ, MAP_ANON, -1, (off_t)0);
226 	addr3 = mmap(NULL, npgs * page, PROT_NONE, MAP_ANON, -1, (off_t)0);
227 
228 	if (addr2 == MAP_FAILED || addr3 == MAP_FAILED)
229 		atf_tc_skip("could not mmap more anonymous test pages with "
230 		    "mlockall(MCL_FUTURE) in effect, system "
231 		    "might be low on memory");
232 
233 	ATF_REQUIRE(check_residency(addr2, npgs) == npgs);
234 	ATF_REQUIRE(check_residency(addr3, npgs) == 0);
235 	ATF_REQUIRE(mprotect(addr3, npgs * page, PROT_READ) == 0);
236 	ATF_REQUIRE(check_residency(addr, npgs) == npgs);
237 	ATF_REQUIRE(check_residency(addr2, npgs) == npgs);
238 
239 	(void)munlockall();
240 
241 	ATF_REQUIRE(madvise(addr2, npgs * page, MADV_FREE) == 0);
242 	ATF_REQUIRE(check_residency(addr2, npgs) == 0);
243 
244 	(void)memset(addr, 0, npgs * page);
245 
246 	ATF_REQUIRE(madvise(addr, npgs * page, MADV_FREE) == 0);
247 	ATF_REQUIRE(check_residency(addr, npgs) == 0);
248 
249 	(void)munmap(addr, npgs * page);
250 	(void)munmap(addr2, npgs * page);
251 	(void)munmap(addr3, npgs * page);
252 	(void)unlink(path);
253 }
254 
255 ATF_TC_CLEANUP(mincore_resid, tc)
256 {
257 	(void)unlink(path);
258 }
259 
260 ATF_TC(mincore_shmseg);
261 ATF_TC_HEAD(mincore_shmseg, tc)
262 {
263 	atf_tc_set_md_var(tc, "descr", "residency of shared memory");
264 }
265 
266 ATF_TC_BODY(mincore_shmseg, tc)
267 {
268 	size_t npgs = 128;
269 	void *addr = NULL;
270 	int shmid;
271 
272 	shmid = shmget(IPC_PRIVATE, npgs * page,
273 	    IPC_CREAT | S_IRUSR | S_IWUSR);
274 
275 	ATF_REQUIRE(shmid != -1);
276 
277 	addr = shmat(shmid, NULL, 0);
278 
279 	ATF_REQUIRE(addr != NULL);
280 	ATF_REQUIRE(check_residency(addr, npgs) == 0);
281 
282 	(void)memset(addr, 0xff, npgs * page);
283 
284 	ATF_REQUIRE(check_residency(addr, npgs) == npgs);
285 	ATF_REQUIRE(madvise(addr, npgs * page, MADV_FREE) == 0);
286 
287 	/*
288 	 * NOTE!  Even though we have MADV_FREE'd the range,
289 	 * there is another reference (the kernel's) to the
290 	 * object which owns the pages.  In this case, the
291 	 * kernel does not simply free the pages, as haphazardly
292 	 * freeing pages when there are still references to
293 	 * an object can cause data corruption (say, the other
294 	 * referencer doesn't expect the pages to be freed,
295 	 * and is surprised by the subsequent ZFOD).
296 	 *
297 	 * Because of this, we simply report the number of
298 	 * pages still resident, for information only.
299 	 */
300 	npgs = check_residency(addr, npgs);
301 
302 	(void)fprintf(stderr, "%zu pages still resident\n", npgs);
303 
304 	ATF_REQUIRE(shmdt(addr) == 0);
305 	ATF_REQUIRE(shmctl(shmid, IPC_RMID, NULL) == 0);
306 }
307 
308 ATF_TP_ADD_TCS(tp)
309 {
310 
311 	page = sysconf(_SC_PAGESIZE);
312 	ATF_REQUIRE(page >= 0);
313 
314 	ATF_TP_ADD_TC(tp, mincore_err);
315 	ATF_TP_ADD_TC(tp, mincore_resid);
316 	ATF_TP_ADD_TC(tp, mincore_shmseg);
317 
318 	return atf_no_error();
319 }
320