1.\" $NetBSD: mincore.2,v 1.14 2002/02/08 01:28:19 ross Exp $ 2.\" 3.\" Copyright (c) 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)mincore.2 8.1 (Berkeley) 6/9/93 35.\" 36.Dd June 6, 1999 37.Dt MINCORE 2 38.Os 39.Sh NAME 40.Nm mincore 41.Nd determine residency of memory pages 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.Fd #include \*[Lt]sys/mman.h\*[Gt] 46.Ft int 47.Fn mincore "void *addr" "size_t len" "char *vec" 48.Sh DESCRIPTION 49The 50.Fn mincore 51system call 52allows a process to obtain information about whether pages are 53core resident. The status of the memory range is returned in the 54character-per-page array 55.Ar vec . 56If the page is resident, the least significant bit of the corresponding 57character in 58.Ar vec 59will be set. Other bits are reserved for additional information 60which future implementations may return. 61.Pp 62Note that the status of each page may change between the call to 63.Fn mincore 64and the return of the page status information. In order to guarantee 65that pages will remain in core, the address range must be locked with 66.Xr mlock 2 . 67.Sh RETURN VALUES 68.Fn mincore 69returns 0 on success, or -1 on failure and sets the variable 70.Va errno 71to indicate the error. 72.Sh ERRORS 73The 74.Fn mincore 75call will fail if: 76.Bl -tag -width Er 77.It Bq Er EFAULT 78.Ar vec 79points to an illegal address. 80.It Bq Er EINVAL 81.Ar addr 82is not a multiple of the system page size. 83.It Bq Er EINVAL 84.Ar len 85is equal to 0. 86.It Bq Er ENOMEM 87The address range specified is invalid for the calling process, 88or one or more of the pages specified in the range are not mapped. 89.El 90.Sh SEE ALSO 91.Xr madvise 2 , 92.Xr mlock 2 , 93.Xr mprotect 2 , 94.Xr msync 2 , 95.Xr munmap 2 , 96.Xr sysconf 3 97.Sh HISTORY 98The 99.Fn mincore 100function first appeared in 101.Bx 4.4 . 102