share/man/man9/kcopy.9

   1 .\"     $NetBSD: kcopy.9,v 1.5 2006/04/04 20:48:21 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Gregory McGarry.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd April 4, 2006
  31 .Dt KCOPY 9
  32 .Os
  33 .Sh NAME
  34 .Nm kcopy
  35 .Nd copy data with abort on page fault
  36 .Sh SYNOPSIS
  37 .In sys/systm.h
  38 .Ft int
  39 .Fn kcopy "const void *src" "void *dst" "size_t len"
  40 .Sh DESCRIPTION
  41 .Fn kcopy
  42 copies
  43 .Fa len
  44 bytes from
  45 .Fa src
  46 to
  47 .Fa dst ,
  48 aborting if a fatal page fault is encountered.
  49 .Pp
  50 .Fn kcopy
  51 must save and restore the old fault handler since it is called by
  52 .Xr uiomove 9 ,
  53 which may be in the path of servicing a non-fatal page fault.
  54 .Fn kcopy
  55 returns 0 on success and an error number on failure.
  56 .Sh SEE ALSO
  57 .Xr errno 2 ,
  58 .Xr memcpy 9 ,
  59 .Xr uiomove 9