share/man/man9/copy.9

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