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$ 36.\" 37.Dd October 5, 2009 38.Dt FETCH 9 39.Os 40.Sh NAME 41.Nm fetch , 42.Nm fubyte , 43.Nm fuswintr , 44.Nm fuword , 45.Nm fuword16 , 46.Nm fuword32 , 47.Nm fuword64 48.Nd fetch data from user-space 49.Sh SYNOPSIS 50.In sys/types.h 51.In sys/time.h 52.In sys/systm.h 53.Ft int 54.Fn fubyte "const void *base" 55.Ft long 56.Fn fuword "const void *base" 57.Ft int 58.Fn fuword16 "void *base" 59.Ft int32_t 60.Fn fuword32 "const void *base" 61.Ft int64_t 62.Fn fuword64 "const void *base" 63.In sys/resourcevar.h 64.Ft int 65.Fn fuswintr "void *base" 66.Sh DESCRIPTION 67The 68.Nm 69functions are designed to copy small amounts of data from user-space. 70.Pp 71The 72.Nm 73routines provide the following functionality: 74.Bl -tag -width "fuswintr()" 75.It Fn fubyte 76Fetches a byte of data from the user-space address 77.Pa base . 78.It Fn fuword 79Fetches a word of data from the user-space address 80.Pa base . 81.It Fn fuword16 82Fetches 16 bits of data from the user-space address 83.Pa base . 84.It Fn fuword32 85Fetches 32 bits of data from the user-space address 86.Pa base . 87.It Fn fuword64 88Fetches 64 bits of data from the user-space address 89.Pa base . 90.It Fn fuswintr 91Fetches a short word of data from the user-space address 92.Pa base . 93This function is safe to call during an interrupt context. 94.El 95.Sh RETURN VALUES 96The 97.Nm 98functions return the data fetched or -1 on failure. 99.Sh SEE ALSO 100.Xr copy 9 , 101.Xr store 9 102