xref: /freebsd/share/man/man9/pmap_copy.9 (revision 4543ef516683042d46f3bd3bb8a4f3f746e00499)
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_COPY 9
28.Os
29.Sh NAME
30.Nm pmap_copy ,
31.Nm pmap_copy_page
32.Nd copy physical memory pages
33.Sh SYNOPSIS
34.In sys/param.h
35.In vm/vm.h
36.In vm/pmap.h
37.Ft void
38.Fo pmap_copy
39.Fa "pmap_t dst_pmap" "pmap_t src_pmap" "vm_offset_t dst_addr"
40.Fa "vm_size_t len" "vm_offset_t src_addr"
41.Fc
42.Ft void
43.Fn pmap_copy_page "vm_page_t src" "vm_page_t dst"
44.Sh DESCRIPTION
45The
46.Fn pmap_copy
47function copies the range specified by
48.Fa src_addr
49and
50.Fa len
51from the source physical map
52.Fa src_pmap
53to the destination physical map
54.Fa dst_pmap
55at the address
56.Fa dst_addr .
57.Pp
58The
59.Fn pmap_copy_page
60function
61copies the physical page
62.Fa src
63to the physical page
64.Fa dst ,
65by mapping the page into kernel virtual address space (KVA), and using
66.Fn bcopy
67to copy the page.
68.Sh IMPLEMENTATION NOTES
69The
70.Fn pmap_copy
71routine is only advisory and need not do anything.
72Actually implementing it may seriously reduce system performance.
73.Pp
74The
75.Fn pmap_copy_page
76routine only operates upon a single page.
77.Sh SEE ALSO
78.Xr bcopy 3 ,
79.Xr pmap 9
80.Sh AUTHORS
81This manual page was written by
82.An Bruce M Simpson Aq Mt bms@spc.org .
83