share/man/man9/fetch.9

   1 .\"     $NetBSD: fetch.9,v 1.2 1996/01/09 21:59:24 perry 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/fetch.9,v 1.6.2.4 2001/12/17 11:30:18 ru Exp $
  36 .\" $DragonFly: src/share/man/man9/fetch.9,v 1.4 2007/04/07 19:29:52 swildner Exp $
  37 .\"
  38 .Dd March 14, 2010
  39 .Dt FETCH 9
  40 .Os
  41 .Sh NAME
  42 .Nm fetch ,
  43 .Nm casuword ,
  44 .Nm fubyte ,
  45 .Nm fusword ,
  46 .Nm fuword
  47 .Nd fetch data from user-space
  48 .Sh SYNOPSIS
  49 .In sys/types.h
  50 .In sys/time.h
  51 .In sys/systm.h
  52 .In sys/resourcevar.h
  53 .Ft u_long
  54 .Fn casuword "u_long *base" "u_long oldval" "u_long newval"
  55 .Ft int
  56 .Fn fubyte "const void *base"
  57 .Ft int
  58 .Fn fusword "void *base"
  59 .Ft long
  60 .Fn fuword "const void *base"
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 functions are designed to copy small amounts of data from user-space.
  65 .Pp
  66 The
  67 .Nm
  68 routines provide the following functionality:
  69 .Bl -tag -width ".Fn fusword"
  70 .It Fn casuword
  71 Compares
  72 .Fa oldval
  73 with the word at
  74 .Fa base
  75 , and if equal,
  76 .Fa base
  77 is set to
  78 .Fa newval .
  79 The old value at
  80 .Fa base
  81 is then returned.
  82 .It Fn fubyte
  83 Fetches a byte of data from the user-space address
  84 .Fa base .
  85 .It Fn fusword
  86 Fetches a short word of data from the user-space address
  87 .Fa base .
  88 .It Fn fuword
  89 Fetches a word of data from the user-space address
  90 .Fa base .
  91 .El
  92 .Sh RETURN VALUES
  93 The
  94 .Nm
  95 functions return the data fetched or -1 on failure.
  96 .Sh SEE ALSO
  97 .Xr copy 9 ,
  98 .Xr store 9