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