/share/man/man9/pmap_object_init_pt.9

 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.\" $FreeBSD$
27.\"
28.Dd July 21, 2003
29.Dt PMAP_OBJECT_INIT_PT 9
30.Os
31.Sh NAME
32.Nm pmap_object_init_pt
33.Nd initialize page tables for a VM object
34.Sh SYNOPSIS
35.In sys/param.h
36.In vm/vm.h
37.In vm/pmap.h
38.Ft void
39.Fo pmap_object_init_pt
40.Fa "pmap_t pmap" "vm_offset_t addr" "vm_object_t object"
41.Fa "vm_pindex_t pindex" "vm_size_t size" "int limit"
42.Fc
43.Sh DESCRIPTION
44The
45.Fn pmap_object_init_pt
46function preloads the page table entries into the specified physical map
47.Fa pmap ,
48for the given
49.Fa object
50at the virtual address
51.Fa addr ,
52for
53.Fa size
54bytes, beginning at the page index
55.Fa pindex
56within the object.
57The map bits
58.Fa limit
59are heeded when creating the mapping.
60.Sh IMPLEMENTATION NOTES
61This function is not strictly required by an architecture's
62.Xr pmap 9
63implementation, but it does provide performance benefits if implemented.
64.Pp
65It is intended to eliminate the blast of soft faults on process
66startup, and immediately following a call to
67.Xr mmap 2 .
68.Sh SEE ALSO
69.Xr pmap 9 ,
70.Xr vm_map 9
71.Sh AUTHORS
72This manual page was written by
73.An Bruce M Simpson Aq bms@spc.org .