summaryrefslogtreecommitdiff
path: root/static/netbsd/man2/mincore.2
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
commit253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch)
treeadf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man2/mincore.2
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man2/mincore.2')
-rw-r--r--static/netbsd/man2/mincore.298
1 files changed, 98 insertions, 0 deletions
diff --git a/static/netbsd/man2/mincore.2 b/static/netbsd/man2/mincore.2
new file mode 100644
index 00000000..509b5237
--- /dev/null
+++ b/static/netbsd/man2/mincore.2
@@ -0,0 +1,98 @@
+.\" $NetBSD: mincore.2,v 1.21 2022/07/26 00:25:45 uwe Exp $
+.\"
+.\" Copyright (c) 1991, 1993
+.\" The Regents of the University of California. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. Neither the name of the University nor the names of its contributors
+.\" may be used to endorse or promote products derived from this software
+.\" without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" @(#)mincore.2 8.1 (Berkeley) 6/9/93
+.\"
+.Dd June 6, 1999
+.Dt MINCORE 2
+.Os
+.Sh NAME
+.Nm mincore
+.Nd determine residency of memory pages
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.In sys/mman.h
+.Ft int
+.Fn mincore "void *addr" "size_t len" "char *vec"
+.Sh DESCRIPTION
+The
+.Fn mincore
+system call tells whether the pages covering
+.Fa len
+bytes of data starting at
+.Fa addr
+are core resident in the process.
+The status of the memory range is returned in the character-per-page array
+.Fa vec .
+If the page is resident, the least significant bit of the corresponding
+character in
+.Fa vec
+will be set.
+Other bits are reserved for additional information
+which future implementations may return.
+.Pp
+Note that the status of each page may change between the call to
+.Fn mincore
+and the return of the page status information.
+In order to guarantee
+that pages will remain in core, the address range must be locked with
+.Xr mlock 2 .
+.Sh RETURN VALUES
+.Rv -std mincore
+.Sh ERRORS
+The
+.Fn mincore
+call will fail if:
+.Bl -tag -width Er
+.It Bq Er EFAULT
+.Fa vec
+points to an illegal address.
+.It Bq Er EINVAL
+.Fa addr
+is not a multiple of the system page size.
+.It Bq Er EINVAL
+.Fa len
+is equal to 0.
+.It Bq Er ENOMEM
+The address range specified is invalid for the calling process,
+or one or more of the pages specified in the range are not mapped.
+.El
+.Sh SEE ALSO
+.Xr madvise 2 ,
+.Xr mlock 2 ,
+.Xr mprotect 2 ,
+.Xr msync 2 ,
+.Xr munmap 2 ,
+.Xr sysconf 3
+.Sh HISTORY
+The
+.Fn mincore
+function first appeared in
+.Bx 4.4 .