xref: /freebsd/share/man/man9/pmap_is_prefaultable.9 (revision 02e9120893770924227138ba49df1edb3896112a)
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_IS_PREFAULTABLE 9
28.Os
29.Sh NAME
30.Nm pmap_is_prefaultable
31.Nd determine if a page may be prefaulted
32.Sh SYNOPSIS
33.In sys/param.h
34.In vm/vm.h
35.In vm/pmap.h
36.Ft boolean_t
37.Fn pmap_is_prefaultable "pmap_t pmap" "vm_offset_t va"
38.Sh DESCRIPTION
39The
40.Fn pmap_is_prefaultable
41function provides a means of determining if the page residing at
42virtual address
43.Fa va
44in the physical map
45.Fa pmap
46may be pre-faulted into main memory.
47.Pp
48This is a helper function which is called by
49.Xr vm_fault_prefault 9 .
50.Sh SEE ALSO
51.Xr pmap 9 ,
52.Xr vm_fault_prefault 9
53.Sh AUTHORS
54This manual page was written by
55.An Bruce M Simpson Aq Mt bms@spc.org .
56