summaryrefslogtreecommitdiffstats
path: root/share/man/man9/fetch.9
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/man9/fetch.9')
-rw-r--r--share/man/man9/fetch.9101
1 files changed, 101 insertions, 0 deletions
diff --git a/share/man/man9/fetch.9 b/share/man/man9/fetch.9
new file mode 100644
index 0000000..ccf6866
--- /dev/null
+++ b/share/man/man9/fetch.9
@@ -0,0 +1,101 @@
+.\" $NetBSD: fetch.9,v 1.2 1996/01/09 21:59:24 perry Exp $
+.\"
+.\" Copyright (c) 1996 Jason R. Thorpe.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed by Kenneth Stailey.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\" must display the following acknowledgement:
+.\" This product includes software developed for the NetBSD Project
+.\" by Jason R. Thorpe.
+.\" 4. The name of the author may not be used to endorse or promote products
+.\" derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd October 5, 2009
+.Dt FETCH 9
+.Os
+.Sh NAME
+.Nm fetch ,
+.Nm fubyte ,
+.Nm fuswintr ,
+.Nm fuword ,
+.Nm fuword16 ,
+.Nm fuword32 ,
+.Nm fuword64
+.Nd fetch data from user-space
+.Sh SYNOPSIS
+.In sys/types.h
+.In sys/time.h
+.In sys/systm.h
+.Ft int
+.Fn fubyte "const void *base"
+.Ft long
+.Fn fuword "const void *base"
+.Ft int
+.Fn fuword16 "void *base"
+.Ft int32_t
+.Fn fuword32 "const void *base"
+.Ft int64_t
+.Fn fuword64 "const void *base"
+.In sys/resourcevar.h
+.Ft int
+.Fn fuswintr "void *base"
+.Sh DESCRIPTION
+The
+.Nm
+functions are designed to copy small amounts of data from user-space.
+.Pp
+The
+.Nm
+routines provide the following functionality:
+.Bl -tag -width "fuswintr()"
+.It Fn fubyte
+Fetches a byte of data from the user-space address
+.Pa base .
+.It Fn fuword
+Fetches a word of data from the user-space address
+.Pa base .
+.It Fn fuword16
+Fetches 16 bits of data from the user-space address
+.Pa base .
+.It Fn fuword32
+Fetches 32 bits of data from the user-space address
+.Pa base .
+.It Fn fuword64
+Fetches 64 bits of data from the user-space address
+.Pa base .
+.It Fn fuswintr
+Fetches a short word of data from the user-space address
+.Pa base .
+This function is safe to call during an interrupt context.
+.El
+.Sh RETURN VALUES
+The
+.Nm
+functions return the data fetched or -1 on failure.
+.Sh SEE ALSO
+.Xr copy 9 ,
+.Xr store 9
OpenPOWER on IntegriCloud