1.\" $NetBSD: copy.9,v 1.13 2002/10/14 13:43:18 wiz Exp $ 2.\" 3.\" Copyright (c) 1996, 2002 Jason R. Thorpe. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed by Kenneth Stailey. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. All advertising materials mentioning features or use of this software 17.\" must display the following acknowledgement: 18.\" This product includes software developed for the NetBSD Project 19.\" by Jason R. Thorpe. 20.\" 4. The name of the author may not be used to endorse or promote products 21.\" derived from this software without specific prior written permission. 22.\" 23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 24.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 25.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 26.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 27.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 28.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 29.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 30.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 31.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.Dd July 19, 2002 36.Dt COPY 9 37.Os 38.Sh NAME 39.Nm copy , 40.Nm copyin , 41.Nm copyout , 42.Nm copystr , 43.Nm copyinstr , 44.Nm copyoutstr 45.Nd kernel space to/from user space copy functions 46.Sh SYNOPSIS 47.Fd #include \*[Lt]sys/types.h\*[Gt] 48.Fd #include \*[Lt]sys/systm.h\*[Gt] 49.Ft int 50.Fn copyin "const void *uaddr" "void *kaddr" "size_t len" 51.Ft int 52.Fn copyout "const void *kaddr" "void *uaddr" "size_t len" 53.Ft int 54.Fn copystr "const void *kfaddr" "void *kdaddr" "size_t len" "size_t *done" 55.Ft int 56.Fn copyinstr "const void *uaddr" "void *kaddr" "size_t len" "size_t *done" 57.Ft int 58.Fn copyoutstr "const void *kaddr" "void *uaddr" "size_t len" "size_t *done" 59.Ft int 60.Fn copyin_proc "struct proc *p" "const void *uaddr" "void *kaddr" "size_t len" 61.Ft int 62.Fn copyout_proc "struct proc *p" "const void *kaddr" "void *uaddr" "size_t len" 63.Sh DESCRIPTION 64The 65.Nm 66functions are designed to copy contiguous data from one address 67to another. 68All but 69.Fn copystr 70copy data from user-space to kernel-space or vice-versa. 71.Pp 72The 73.Nm 74routines provide the following functionality: 75.Bl -tag -width "copyout_proc()" 76.It Fn copyin 77Copies 78.Fa len 79bytes of data from the user-space address 80.Fa uaddr 81in the current process to the kernel-space address 82.Fa kaddr . 83.It Fn copyout 84Copies 85.Fa len 86bytes of data from the kernel-space address 87.Fa kaddr 88to the user-space address 89.Fa uaddr 90in the current process. 91.It Fn copystr 92Copies a NUL-terminated string, at most 93.Fa len 94bytes long, from kernel-space address 95.Fa kfaddr 96to kernel-space address 97.Fa kdaddr . 98If the 99.Fa done 100argument is non-NULL, 101the number of bytes actually copied, including the terminating 102NUL, is returned in 103.Fa *done . 104.It Fn copyinstr 105Copies a NUL-terminated string, at most 106.Fa len 107bytes long, from user-space address 108.Fa uaddr 109in the current process to kernel-space address 110.Fa kaddr . 111If the 112.Fa done 113argument is non-NULL, 114the number of bytes actually copied, including the terminating 115NUL, is returned in 116.Fa *done . 117.It Fn copyoutstr 118Copies a NUL-terminated string, at most 119.Fa len 120bytes long, from kernel-space address 121.Fa kaddr 122to user-space address 123.Fa uaddr 124in the current process. 125If the 126.Fa done 127argument is non-NULL, 128the number of bytes actually copied, including the terminating 129NUL, is returned in 130.Fa *done . 131.It Fn copyin_proc 132Like 133.Fn copyin , 134except it operates on the address space of the process 135.Fa p . 136.It Fn copyout_proc 137Like 138.Fn copyout , 139except it operates on the address space of the process 140.Fa p . 141.El 142.Sh RETURN VALUES 143The 144.Nm 145functions return 0 on success or EFAULT if a bad address is encountered. 146In addition, the 147.Fn copystr , 148.Fn copyinstr , 149and 150.Fn copyoutstr 151functions return ENAMETOOLONG if the string is longer than 152.Fa len 153bytes. 154.Sh SEE ALSO 155.Xr fetch 9 , 156.Xr store 9 157