1.\" $NetBSD: copy.9,v 1.11 2002/02/13 08:18:39 ross Exp $ 2.\" 3.\" Copyright (c) 1996 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 February 22, 1998 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.Sh DESCRIPTION 60The 61.Nm 62functions are designed to copy contiguous data from one address 63to another. All but 64.Fn copystr 65copy data from user-space to kernel-space or vice-versa. 66.Pp 67The 68.Nm 69routines provide the following functionality: 70.Bl -tag -width "copyoutstr()" 71.It Fn copyin 72Copies 73.Fa len 74bytes of data from the user-space address 75.Fa uaddr 76to the kernel-space address 77.Fa kaddr . 78.It Fn copyout 79Copies 80.Fa len 81bytes of data from the kernel-space address 82.Fa kaddr 83to the user-space address 84.Fa uaddr . 85.It Fn copystr 86Copies a NUL-terminated string, at most 87.Fa len 88bytes long, from kernel-space address 89.Fa kfaddr 90to kernel-space address 91.Fa kdaddr . 92If the 93.Fa done 94argument is non-NULL, 95the number of bytes actually copied, including the terminating 96NUL, is returned in 97.Fa *done . 98.It Fn copyinstr 99Copies a NUL-terminated string, at most 100.Fa len 101bytes long, from user-space address 102.Fa uaddr 103to kernel-space address 104.Fa kaddr . 105If the 106.Fa done 107argument is non-NULL, 108the number of bytes actually copied, including the terminating 109NUL, is returned in 110.Fa *done . 111.It Fn copyoutstr 112Copies a NUL-terminated string, at most 113.Fa len 114bytes long, from kernel-space address 115.Fa kaddr 116to user-space address 117.Fa uaddr . 118If the 119.Fa done 120argument is non-NULL, 121the number of bytes actually copied, including the terminating 122NUL, is returned in 123.Fa *done . 124.El 125.Sh RETURN VALUES 126The 127.Nm 128functions return 0 on success or EFAULT if a bad address is encountered. 129In addition, the 130.Fn copystr , 131.Fn copyinstr , 132and 133.Fn copyoutstr 134functions return ENAMETOOLONG if the string is longer than 135.Fa len 136bytes. 137.Sh SEE ALSO 138.Xr fetch 9 , 139.Xr store 9 140