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 November 17, 2018 38.Dt FETCH 9 39.Os 40.Sh NAME 41.Nm fetch , 42.Nm fubyte , 43.Nm fuword32 , 44.Nm fuwordadd32 , 45.Nm fuword64 , 46.Nm fuwordadd64 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 int 54.Fn fubyte "const uint8_t *base" 55.Ft int32_t 56.Fn fuword32 "const uint32_t *base" 57.Ft uint32_t 58.Fn fuwordadd32 "volatile uint32_t *p" "uint32_t val" 59.Ft int64_t 60.Fn fuword64 "const uint64_t *base" 61.Ft uint64_t 62.Fn fuwordadd64 "volatile uint64_t *p" "uint64_t val" 63.Sh DESCRIPTION 64The 65.Nm 66functions are designed to copy small amounts of data from user-space. 67.Pp 68The 69.Nm 70routines provide the following functionality: 71.Bl -tag -width ".Fn fuwordadd32" 72.It Fn fubyte 73Fetches a byte of data from the user-space address 74.Fa base . 75.It Fn fuword32 76Fetches 32 bits of data from the user-space address 77.Fa base . 78.It Fn fuwordadd32 79Fetches 32 bits of data from the user-space address 80.Fa p , 81adds 82.Fa val , 83and stores the result back to the user-space address 84.Fa p . 85.It Fn fuword64 86Fetches 64 bits of data from the user-space address 87.Fa base . 88.It Fn fuwordadd64 89Fetches 64 bits of data from the user-space address 90.Fa p , 91adds 92.Fa val , 93and stores the result back to the user-space address 94.Fa p . 95.El 96.Sh RETURN VALUES 97The 98.Nm 99functions return the data fetched or -1 on failure. 100.Sh SEE ALSO 101.Xr copy 9 , 102.Xr store 9 103