1.\" $NetBSD: copy.9,v 1.2 1996/01/09 03:23:04 thorpej 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.\" $FreeBSD$ 36.\" 37.Dd January 7, 1996 38.Dt COPY 9 39.Os 40.Sh NAME 41.Nm copy , 42.Nm copyin , 43.Nm copyout , 44.Nm copystr , 45.Nm copyinstr 46.Nd kernel copy functions 47.Sh SYNOPSIS 48.In sys/types.h 49.In sys/systm.h 50.Ft int 51.Fn copyin "const void *uaddr" "void *kaddr" "size_t len" 52.Ft int 53.Fn copyout "const void *kaddr" "void *uaddr" "size_t len" 54.Ft int 55.Fn copystr "const void *kfaddr" "void *kdaddr" "size_t len" "size_t *done" 56.Ft int 57.Fn copyinstr "const void *uaddr" "void *kaddr" "size_t len" "size_t *done" 58.\" .Ft int 59.\" .Fn copyoutstr "const void *kaddr" "void *uaddr" "size_t len" "size_t *done" 60.Sh DESCRIPTION 61The 62.Nm 63functions are designed to copy contiguous data from one address 64to another. 65All but 66.Fn copystr 67copy data from user-space to kernel-space or vice-versa. 68.Pp 69The 70.Nm 71routines provide the following functionality: 72.Bl -tag -width "copyoutstr()" 73.It Fn copyin 74Copies 75.Fa len 76bytes of data from the user-space address 77.Fa uaddr 78to the kernel-space address 79.Fa kaddr . 80.It Fn copyout 81Copies 82.Fa len 83bytes of data from the kernel-space address 84.Fa kaddr 85to the user-space address 86.Fa uaddr . 87.It Fn copystr 88Copies a NUL-terminated string, at most 89.Fa len 90bytes long, from kernel-space address 91.Fa kfaddr 92to kernel-space address 93.Fa kdaddr . 94The number of bytes actually copied, including the terminating 95NUL, is returned in 96.Fa *done 97(if 98.Fa done 99is 100.No non- Ns Dv NULL ) . 101.It Fn copyinstr 102Copies a NUL-terminated string, at most 103.Fa len 104bytes long, from user-space address 105.Fa uaddr 106to kernel-space address 107.Fa kaddr . 108The number of bytes actually copied, including the terminating 109NUL, is returned in 110.Fa *done 111(if 112.Fa done 113is 114.No non- Ns Dv NULL ) . 115.\" .It Fn copyoutstr 116.\" Copies a NUL-terminated string, at most 117.\" bytes long, from kernel-space address 118.\" .Fa kaddr 119.\" to user-space address 120.\" .Fa uaddr . 121.\" The number of bytes actually copied, including the terminating 122.\" NUL, is returned in 123.\" .Fa *done . 124.El 125.Sh RETURN VALUES 126The 127.Nm 128functions return 0 on success or 129.Er EFAULT 130if a bad address is encountered. 131In addition, the 132.Fn copystr , 133and 134.Fn copyinstr 135.\" .Fn copyinstr , 136.\" and 137.\" .Fn copyoutstr 138functions return 139.Er ENAMETOOLONG 140if the string is longer than 141.Fa len 142bytes. 143.Sh SEE ALSO 144.Xr fetch 9 , 145.Xr store 9 146