xref: /freebsd/share/man/man9/pmap_mincore.9 (revision 4543ef516683042d46f3bd3bb8a4f3f746e00499)
1.\"
2.\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd July 21, 2003
27.Dt PMAP_MINCORE 9
28.Os
29.Sh NAME
30.Nm pmap_mincore
31.Nd determine if a virtual address is resident in physical memory
32.Sh SYNOPSIS
33.In sys/param.h
34.In vm/vm.h
35.In vm/pmap.h
36.Ft int
37.Fn pmap_mincore "pmap_t pmap" "vm_offset_t addr"
38.Sh DESCRIPTION
39The
40.Fn pmap_mincore
41function determines if the page at the virtual address
42.Fa addr
43in the physical map
44.Fa pmap
45is resident in physical memory.
46It is the machine-dependent interface used by the
47.Xr mincore 2
48system call.
49.Sh RETURN VALUES
50If the page is resident in physical memory,
51a mask of flags is returned,
52whose meaning is documented in
53.Xr mincore 2 ;
54otherwise,
550
56is returned.
57.Pp
58The
59.Fa pmap
60must exist and
61.Fa addr
62must be mapped into the
63.Fa pmap .
64If any error occurs, the machine-dependent implementation should
65return
660.
67.Sh SEE ALSO
68.Xr mincore 2 ,
69.Xr pmap 9
70.Sh AUTHORS
71This manual page was written by
72.An Bruce M Simpson Aq Mt bms@spc.org .
73