1 .\" $NetBSD: copy.9,v 1.2 1996/01/09 03:23:04 thorpej Exp $
3 .\" Copyright (c) 1996 Jason R. Thorpe.
4 .\" All rights reserved.
6 .\" This code is derived from software contributed by Kenneth Stailey.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
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.
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
35 .\" $FreeBSD: src/share/man/man9/copy.9,v 1.6.2.5 2001/12/17 11:30:18 ru Exp $
36 .\" $DragonFly: src/share/man/man9/copy.9,v 1.3 2007/04/07 19:29:52 swildner Exp $
47 .Nd kernel copy functions
52 .Fn copyin "const void *uaddr" "void *kaddr" "size_t len"
54 .Fn copyout "const void *kaddr" "void *uaddr" "size_t len"
56 .Fn copystr "const void *kfaddr" "void *kdaddr" "size_t len" "size_t *done"
58 .Fn copyinstr "const void *uaddr" "void *kaddr" "size_t len" "size_t *done"
60 .\" .Fn copyoutstr "const void *kaddr" "void *uaddr" "size_t len" "size_t *done"
64 functions are designed to copy contiguous data from one address
67 copy data from user-space to kernel-space or vice-versa.
71 routines provide the following functionality:
72 .Bl -tag -width "copyoutstr()"
76 bytes of data from the user-space address
78 to the kernel-space address
83 bytes of data from the kernel-space address
85 to the user-space address
88 Copies a NUL-terminated string, at most
90 bytes long, from kernel-space address
92 to kernel-space address
94 The number of bytes actually copied, including the terminating
98 Copies a NUL-terminated string, at most
100 bytes long, from user-space address
102 to kernel-space address
104 The number of bytes actually copied, including the terminating
107 .\" .It Fn copyoutstr
108 .\" Copies a NUL-terminated string, at most
109 .\" bytes long, from kernel-space address
111 .\" to user-space address
113 .\" The number of bytes actually copied, including the terminating
114 .\" NUL, is returned in
120 functions return 0 on success or
122 if a bad address is encountered.
132 if the string is longer than