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 .\"
  37 .Dd January 26, 2017
  38 .Dt FETCH 9
  39 .Os
  40 .Sh NAME
  41 .Nm fetch ,
  42 .Nm fubyte ,
  43 .Nm fuword32 ,
  44 .Nm fuword64
  45 .Nd fetch data from user-space
  46 .Sh SYNOPSIS
  47 .In sys/types.h
  48 .In sys/time.h
  49 .In sys/systm.h
  50 .In sys/resourcevar.h
  51 .Ft int
  52 .Fn fubyte "const uint8_t *base"
  53 .Ft int32_t
  54 .Fn fuword32 "const uint32_t *base"
  55 .Ft int64_t
  56 .Fn fuword64 "const uint64_t *base"
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 functions are designed to copy small amounts of data from user-space.
  61 .Pp
  62 The
  63 .Nm
  64 routines provide the following functionality:
  65 .Bl -tag -width ".Fn fuword32"
  66 .It Fn fubyte
  67 Fetches a byte of data from the user-space address
  68 .Fa base .
  69 .It Fn fuword32
  70 Fetches 32 bits of data from the user-space address
  71 .Fa base .
  72 .It Fn fuword64
  73 Fetches 64 bits of data from the user-space address
  74 .Fa base .
  75 .El
  76 .Sh RETURN VALUES
  77 The
  78 .Nm
  79 functions return the data fetched or -1 on failure.
  80 .Sh SEE ALSO
  81 .Xr copy 9 ,
  82 .Xr store 9