1.\"	$OpenBSD: mincore.2,v 1.9 2003/06/02 20:18:39 millert Exp $
2.\"	$NetBSD: mincore.2,v 1.7 1995/10/12 15:41:05 jtc Exp $
3.\"
4.\" Copyright (c) 1991, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"	@(#)mincore.2	8.1 (Berkeley) 6/9/93
32.\"
33.Dd June 9, 1993
34.Dt MINCORE 2
35.Os
36.Sh NAME
37.Nm mincore
38.Nd determine residency of memory pages
39.Sh SYNOPSIS
40.Fd #include <sys/types.h>
41.Fd #include <sys/mman.h>
42.Ft int
43.Fn mincore "void *addr" "size_t len" "char *vec"
44.Sh DESCRIPTION
45The
46.Fn mincore
47system call
48allows a process to obtain information about whether pages are
49core resident.
50Here the current core residency of the pages is returned
51in the character array
52.Fa vec ,
53with a value of 1 meaning that the page is in-core.
54.Sh RETURN VALUES
55Upon successful completion,
56a value of 0 is returned.
57Otherwise, a value of \-1 is returned and
58.Va errno
59is set to indicate the error.
60.Sh SEE ALSO
61.Xr madvise 2 ,
62.Xr minherit 2 ,
63.Xr mlock 2 ,
64.Xr mprotect 2 ,
65.Xr msync 2 ,
66.Xr munmap 2
67.Sh HISTORY
68The
69.Fn mincore
70function first appeared in
71.Bx 4.4 .
72