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