xref: /freebsd/share/man/man9/pmap_qenter.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_QENTER 9
30.Sh NAME
31.Nm pmap_qenter ,
32.Nm pmap_qremove
33.Nd manage temporary kernel space mappings
34.Sh SYNOPSIS
35.In sys/param.h
36.In vm/vm.h
37.In vm/pmap.h
38.Ft void
39.Fn pmap_qenter "vm_offset_t sva" "vm_page_t *m" "int count"
40.Ft void
41.Fn pmap_qremove "vm_offset_t sva" "int count"
42.Sh DESCRIPTION
43The
44.Fn pmap_qenter
45function accepts a linear array of
46.Fa count
47pointers to wired pages
48.Fa *m ,
49and enters each of these pages into the kernel virtual address (KVA) space,
50beginning at the address
51.Fa sva .
52.Pp
53The
54.Fn pmap_qremove
55function tears out a mapping from the kernel virtual address space,
56beginning at
57.Fa sva
58and for
59.Fa count
60pages.
61.Sh IMPLEMENTATION NOTES
62The
63.Fn pmap_qenter
64function is intended for temporary mappings that do not require page
65modification or reference counting.
66Old mappings are simply overwritten.
67The pages
68.Em must
69be wired into physical memory.
70.Pp
71The corresponding
72.Fn pmap_qremove
73function is intended to remove such temporary mappings.
74.Sh SEE ALSO
75.Xr pmap 9
76.Sh AUTHORS
77This manual page was written by
78.An Bruce M Simpson Aq bms@spc.org .
79