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