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