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