freebsd-nq/lib/libc/sys/mincore.2

.\" 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. 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
.\" $FreeBSD$
.\"
.Dd January 17, 2003
.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 "const void *addr" "size_t len" "char *vec"
.Sh DESCRIPTION
The
.Fn mincore
system call determines whether each of the pages in the region beginning at
.Fa addr
and continuing for
.Fa len
bytes is resident.
.\"The beginning address,
.\".Fa addr ,
.\"is first rounded down to a multiple of the page size (see
.\".Xr getpagesize 3 ) .
.\"The end address,
.\".Fa addr No + Fa len ,
.\"is rounded up to a multiple of the page size.
The status is returned in the
.Fa vec
array, one character per page.
Each character is either 0 if the page is not resident, or a combination of
the following flags (defined in
.Aq Pa sys/mman.h ) :
.Bl -tag -width ".Dv MINCORE_REFERENCED_OTHER"
.It Dv MINCORE_INCORE
Page is in core (resident).
.It Dv MINCORE_REFERENCED
Page has been referenced by us.
.It Dv MINCORE_MODIFIED
Page has been modified by us.
.It Dv MINCORE_REFERENCED_OTHER
Page has been referenced.
.It Dv MINCORE_MODIFIED_OTHER
Page has been modified.
.El
.Pp
The information returned by
.Fn mincore
may be out of date by the time the system call returns.
The only way to ensure that a page is resident is to lock it into memory
with the
.Xr mlock 2
system call.
.Sh RETURN VALUES
.Rv -std mincore
.Sh ERRORS
The
.Fn mincore
system call will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The virtual address range specified by the
.Fa addr
and
.Fa len
arguments is not valid.
.It Bq Er EFAULT
The
.Fa vec
argument points to an illegal address.
.El
.Sh SEE ALSO
.Xr madvise 2 ,
.Xr mlock 2 ,
.Xr mprotect 2 ,
.Xr msync 2 ,
.Xr munmap 2 ,
.Xr getpagesize 3
.Sh HISTORY
The
.Fn mincore
system call first appeared in
.Bx 4.4 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" 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. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. 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`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Do a better job of documenting mincore(2), esp. the MINCORE_* flags. 2003-01-17 04:06:57 +00:00			`.Dd January 17, 2003`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt MINCORE 2`
			`.Os`
			`.Sh NAME`
			`.Nm mincore`
Do a better job of documenting mincore(2), esp. the MINCORE_* flags. 2003-01-17 04:06:57 +00:00			`.Nd determine residency of memory pages`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/mman.h`
Minor mdoc fixes in msync.2 and munmap.2. Add RETURN VALUES and ERRORS sections to mincore. Closes PR# 1493. 1997-01-11 23:33:18 +00:00			`.Ft int`
Convert caddr_t --> void * for sys/mman.h functions. mlock, mmap, mprotect, msync, munlock, and munmap are defined by POSIX as taking void . The const modifier has been added to mlock, munlock, and mprotect as the standard dictates. minherit comes from OpenBSD and has been updated to conform with their recent change to void . madvise and mincore are not defined by POSIX, but their arguments have been modified to be consistent with the POSIX-defined functions. mincore takes a const pointer, but madvise does not due to the MADV_FREE case. Discussed with: bde 1997-12-31 01:22:01 +00:00			`.Fn mincore "const void addr" "size_t len" "char vec"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Fn mincore`
Do a better job of documenting mincore(2), esp. the MINCORE_* flags. 2003-01-17 04:06:57 +00:00			`system call determines whether each of the pages in the region beginning at`
			`.Fa addr`
			`and continuing for`
			`.Fa len`
			`bytes is resident.`
			`.\"The beginning address,`
			`.\".Fa addr ,`
			`.\"is first rounded down to a multiple of the page size (see`
mdoc(7) police: markup laundry. 2003-02-23 01:47:49 +00:00			`.\".Xr getpagesize 3 ) .`
Do a better job of documenting mincore(2), esp. the MINCORE_* flags. 2003-01-17 04:06:57 +00:00			`.\"The end address,`
			`.\".Fa addr No + Fa len ,`
			`.\"is rounded up to a multiple of the page size.`
			`The status is returned in the`
			`.Fa vec`
			`array, one character per page.`
			`Each character is either 0 if the page is not resident, or a combination of`
			`the following flags (defined in`
mdoc(7) police: markup laundry. 2003-02-23 01:47:49 +00:00			`.Aq Pa sys/mman.h ) :`
Do a better job of documenting mincore(2), esp. the MINCORE_* flags. 2003-01-17 04:06:57 +00:00			`.Bl -tag -width ".Dv MINCORE_REFERENCED_OTHER"`
			`.It Dv MINCORE_INCORE`
			`Page is in core (resident).`
			`.It Dv MINCORE_REFERENCED`
			`Page has been referenced by us.`
			`.It Dv MINCORE_MODIFIED`
			`Page has been modified by us.`
			`.It Dv MINCORE_REFERENCED_OTHER`
			`Page has been referenced.`
			`.It Dv MINCORE_MODIFIED_OTHER`
			`Page has been modified.`
			`.El`
			`.Pp`
			`The information returned by`
			`.Fn mincore`
mdoc(7) police: markup laundry. 2003-02-23 01:47:49 +00:00			`may be out of date by the time the system call returns.`
Do a better job of documenting mincore(2), esp. the MINCORE_* flags. 2003-01-17 04:06:57 +00:00			`The only way to ensure that a page is resident is to lock it into memory`
			`with the`
			`.Xr mlock 2`
mdoc(7) police: markup laundry. 2003-02-23 01:47:49 +00:00			`system call.`
Minor mdoc fixes in msync.2 and munmap.2. Add RETURN VALUES and ERRORS sections to mincore. Closes PR# 1493. 1997-01-11 23:33:18 +00:00			`.Sh RETURN VALUES`
Use the ".Rv" mdoc(7) macro where appropriate. Reviewed by: ru 2001-08-14 14:20:35 +00:00			`.Rv -std mincore`
Minor mdoc fixes in msync.2 and munmap.2. Add RETURN VALUES and ERRORS sections to mincore. Closes PR# 1493. 1997-01-11 23:33:18 +00:00			`.Sh ERRORS`
Do a better job of documenting mincore(2), esp. the MINCORE_* flags. 2003-01-17 04:06:57 +00:00			`The`
			`.Fn mincore`
mdoc(7) police: markup laundry. 2003-02-23 01:47:49 +00:00			`system call will fail if:`
Minor mdoc fixes in msync.2 and munmap.2. Add RETURN VALUES and ERRORS sections to mincore. Closes PR# 1493. 1997-01-11 23:33:18 +00:00			`.Bl -tag -width Er`
			`.It Bq Er EINVAL`
Correct a typo. Submitted by: peter.kusenda@accenture.com 2002-03-09 07:05:22 +00:00			`The virtual address range specified by the`
Minor mdoc fixes in msync.2 and munmap.2. Add RETURN VALUES and ERRORS sections to mincore. Closes PR# 1493. 1997-01-11 23:33:18 +00:00			`.Fa addr`
			`and`
			`.Fa len`
			`arguments is not valid.`
			`.It Bq Er EFAULT`
			`The`
			`.Fa vec`
			`argument points to an illegal address.`
			`.El`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
			`.Xr madvise 2 ,`
Do a better job of documenting mincore(2), esp. the MINCORE_* flags. 2003-01-17 04:06:57 +00:00			`.Xr mlock 2 ,`
comma typos 1996-12-23 23:09:55 +00:00			`.Xr mprotect 2 ,`
			`.Xr msync 2 ,`
Do a better job of documenting mincore(2), esp. the MINCORE_* flags. 2003-01-17 04:06:57 +00:00			`.Xr munmap 2 ,`
			`.Xr getpagesize 3`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh HISTORY`
			`The`
			`.Fn mincore`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call first appeared in`
Correctly use .Fn instead of .Nm to reference function names in a bunch of man pages. Use the correct .Bx (BSD UNIX) or .At (AT&T UNIX) macros instead of explicitly specifying the version in the text in a bunch of man pages. 1996-08-22 23:31:07 +00:00			`.Bx 4.4 .`