share/man/man9/fetch.9

   1 .\"     $NetBSD: fetch.9,v 1.15 2002/10/14 13:43:23 wiz 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 January 7, 1996
  36 .Dt FETCH 9
  37 .Os
  38 .Sh NAME
  39 .Nm fetch ,
  40 .Nm fubyte     ,
  41 .Nm fuibyte ,
  42 .Nm fusword ,
  43 .Nm fuswintr ,
  44 .Nm fuword ,
  45 .Nm fuiword
  46 .Nd fetch data from user-space
  47 .Sh SYNOPSIS
  48 .In sys/types.h
  49 .In sys/systm.h
  50 .Ft int
  51 .Fn fubyte "const void *base"
  52 .Ft int
  53 .Fn fusword "const void *base"
  54 .Ft int
  55 .Fn fuswintr "const void *base"
  56 .Ft long
  57 .Fn fuword "const void *base"
  58 .Sh DESCRIPTION
  59 The
  60 .Nm
  61 functions are designed to copy small amounts of data from user-space.
  62 .Pp
  63 The
  64 .Nm
  65 routines provide the following functionality:
  66 .Bl -tag -width "fuswintr()"
  67 .It Fn fubyte
  68 Fetches a byte of data from the user-space address
  69 .Fa base .
  70 .It Fn fusword
  71 Fetches a short word of data from the user-space address
  72 .Fa base .
  73 .It Fn fuswintr
  74 Fetches a short word of data from the user-space address
  75 .Fa base .
  76 This function is safe to call during an interrupt context.
  77 .It Fn fuword
  78 Fetches a word of data from the user-space address
  79 .Fa base .
  80 .El
  81 .Sh RETURN VALUES
  82 The
  83 .Nm
  84 functions return the data fetched or -1 on failure.
  85 Note that these functions all do "unsigned" access, and
  86 therefore will never sign extend byte or short values.
  87 This prevents ambiguity with the error return value
  88 for all functions except
  89 .Fn fuword .
  90 .Sh SEE ALSO
  91 .Xr copy 9 ,
  92 .Xr store 9
  93 .Sh BUGS
  94 The function
  95 .Fn fuword
  96 has no way to unambiguously signal an error, because the
  97 data it reads might legitimately be the same as the -1
  98 used to indicate an error.
  99 The other functions do not have this problem because the unsigned
 100 values returned by those can never match the -1 error return value.