xref: /xnu-8019.80.24/bsd/man/man9/fetch.9 (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1*a325d9c4SApple OSS Distributions.\"	$NetBSD: fetch.9,v 1.2 1996/01/09 21:59:24 perry Exp $
2*a325d9c4SApple OSS Distributions.\"
3*a325d9c4SApple OSS Distributions.\" Copyright (c) 1996 Jason R. Thorpe.
4*a325d9c4SApple OSS Distributions.\" All rights reserved.
5*a325d9c4SApple OSS Distributions.\"
6*a325d9c4SApple OSS Distributions.\" This code is derived from software contributed by Kenneth Stailey.
7*a325d9c4SApple OSS Distributions.\"
8*a325d9c4SApple OSS Distributions.\" Redistribution and use in source and binary forms, with or without
9*a325d9c4SApple OSS Distributions.\" modification, are permitted provided that the following conditions
10*a325d9c4SApple OSS Distributions.\" are met:
11*a325d9c4SApple OSS Distributions.\" 1. Redistributions of source code must retain the above copyright
12*a325d9c4SApple OSS Distributions.\"    notice, this list of conditions and the following disclaimer.
13*a325d9c4SApple OSS Distributions.\" 2. Redistributions in binary form must reproduce the above copyright
14*a325d9c4SApple OSS Distributions.\"    notice, this list of conditions and the following disclaimer in the
15*a325d9c4SApple OSS Distributions.\"    documentation and/or other materials provided with the distribution.
16*a325d9c4SApple OSS Distributions.\" 3. All advertising materials mentioning features or use of this software
17*a325d9c4SApple OSS Distributions.\"    must display the following acknowledgement:
18*a325d9c4SApple OSS Distributions.\"	This product includes software developed for the NetBSD Project
19*a325d9c4SApple OSS Distributions.\"	by Jason R. Thorpe.
20*a325d9c4SApple OSS Distributions.\" 4. The name of the author may not be used to endorse or promote products
21*a325d9c4SApple OSS Distributions.\"    derived from this software without specific prior written permission.
22*a325d9c4SApple OSS Distributions.\"
23*a325d9c4SApple OSS Distributions.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24*a325d9c4SApple OSS Distributions.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25*a325d9c4SApple OSS Distributions.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26*a325d9c4SApple OSS Distributions.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27*a325d9c4SApple OSS Distributions.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28*a325d9c4SApple OSS Distributions.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29*a325d9c4SApple OSS Distributions.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30*a325d9c4SApple OSS Distributions.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31*a325d9c4SApple OSS Distributions.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32*a325d9c4SApple OSS Distributions.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33*a325d9c4SApple OSS Distributions.\" SUCH DAMAGE.
34*a325d9c4SApple OSS Distributions.\"
35*a325d9c4SApple OSS Distributions.\" $FreeBSD: src/share/man/man9/fetch.9,v 1.6.2.4 2001/12/17 11:30:18 ru Exp $
36*a325d9c4SApple OSS Distributions.\"
37*a325d9c4SApple OSS Distributions.Dd December 16, 2004
38*a325d9c4SApple OSS Distributions.Dt FETCH 9
39*a325d9c4SApple OSS Distributions.Os
40*a325d9c4SApple OSS Distributions.Sh NAME
41*a325d9c4SApple OSS Distributions.Nm fetch ,
42*a325d9c4SApple OSS Distributions.Nm fubyte ,
43*a325d9c4SApple OSS Distributions.Nm fuibyte ,
44*a325d9c4SApple OSS Distributions.Nm fuiword ,
45*a325d9c4SApple OSS Distributions.Nm fulong ,
46*a325d9c4SApple OSS Distributions.Nm fuulong ,
47*a325d9c4SApple OSS Distributions.Nm fuword
48*a325d9c4SApple OSS Distributions.Nd fetch data from user-space
49*a325d9c4SApple OSS Distributions.Sh SYNOPSIS
50*a325d9c4SApple OSS Distributions.In sys/types.h
51*a325d9c4SApple OSS Distributions.In sys/time.h
52*a325d9c4SApple OSS Distributions.In sys/systm.h
53*a325d9c4SApple OSS Distributions.In sys/resourcevar.h
54*a325d9c4SApple OSS Distributions.\"
55*a325d9c4SApple OSS Distributions.Ft int
56*a325d9c4SApple OSS Distributions.Fo fubyte
57*a325d9c4SApple OSS Distributions.Fa "const user_addr_t addr"
58*a325d9c4SApple OSS Distributions.Fc
59*a325d9c4SApple OSS Distributions.Ft int
60*a325d9c4SApple OSS Distributions.Fo fuibyte
61*a325d9c4SApple OSS Distributions.Fa "const user_addr_t addr"
62*a325d9c4SApple OSS Distributions.Fc
63*a325d9c4SApple OSS Distributions.Ft int
64*a325d9c4SApple OSS Distributions.Fo fuiword
65*a325d9c4SApple OSS Distributions.Fa "user_addr_t addr"
66*a325d9c4SApple OSS Distributions.Fc
67*a325d9c4SApple OSS Distributions.Ft int64_t
68*a325d9c4SApple OSS Distributions.Fo fulong
69*a325d9c4SApple OSS Distributions.Fa "user_addr_t addr"
70*a325d9c4SApple OSS Distributions.Fc
71*a325d9c4SApple OSS Distributions.Ft uint64_t
72*a325d9c4SApple OSS Distributions.Fo fuulong
73*a325d9c4SApple OSS Distributions.Fa "user_addr_t addr"
74*a325d9c4SApple OSS Distributions.Fc
75*a325d9c4SApple OSS Distributions.Ft int
76*a325d9c4SApple OSS Distributions.Fo fuword
77*a325d9c4SApple OSS Distributions.Fa "user_addr_t addr"
78*a325d9c4SApple OSS Distributions.Fc
79*a325d9c4SApple OSS Distributions.Sh DESCRIPTION
80*a325d9c4SApple OSS DistributionsThe
81*a325d9c4SApple OSS Distributions.Nm
82*a325d9c4SApple OSS Distributionsfunctions are designed to copy small amounts of data from user-space.
83*a325d9c4SApple OSS Distributions.Pp
84*a325d9c4SApple OSS DistributionsThe
85*a325d9c4SApple OSS Distributions.Nm
86*a325d9c4SApple OSS Distributionsroutines provide the following functionality:
87*a325d9c4SApple OSS Distributions.Bl -tag -width "fuiword()"
88*a325d9c4SApple OSS Distributions.\" ==========
89*a325d9c4SApple OSS Distributions.It Fn fubyte
90*a325d9c4SApple OSS DistributionsFetches a byte of data from the user-space address
91*a325d9c4SApple OSS Distributions.Pa addr .
92*a325d9c4SApple OSS Distributions.\" ==========
93*a325d9c4SApple OSS Distributions.It Fn fuibyte
94*a325d9c4SApple OSS DistributionsFetches a byte of data from the user-space address
95*a325d9c4SApple OSS Distributions.Pa addr .
96*a325d9c4SApple OSS DistributionsThis function is safe to call during an interrupt context.
97*a325d9c4SApple OSS Distributions.\" ==========
98*a325d9c4SApple OSS Distributions.It Fn fuiword
99*a325d9c4SApple OSS DistributionsFetches a word of data from the user-space address
100*a325d9c4SApple OSS Distributions.Pa addr .
101*a325d9c4SApple OSS DistributionsThis function is safe to call during an interrupt context.
102*a325d9c4SApple OSS Distributions.\" ==========
103*a325d9c4SApple OSS Distributions.It Fn fulong
104*a325d9c4SApple OSS DistributionsFetches a long word of data from the user-space address
105*a325d9c4SApple OSS Distributions.Pa addr .
106*a325d9c4SApple OSS Distributions.\" ==========
107*a325d9c4SApple OSS Distributions.It Fn fuulong
108*a325d9c4SApple OSS DistributionsFetches a unsigned long word of data from the user-space address
109*a325d9c4SApple OSS Distributions.Pa addr .
110*a325d9c4SApple OSS Distributions.\" ==========
111*a325d9c4SApple OSS Distributions.It Fn fuword
112*a325d9c4SApple OSS DistributionsFetches a word of data from the user-space address
113*a325d9c4SApple OSS Distributions.Pa addr .
114*a325d9c4SApple OSS Distributions.El
115*a325d9c4SApple OSS Distributions.Sh RETURN VALUES
116*a325d9c4SApple OSS DistributionsThe
117*a325d9c4SApple OSS Distributions.Nm
118*a325d9c4SApple OSS Distributionsfunctions return the data fetched or -1 on failure.
119*a325d9c4SApple OSS Distributions.Sh SEE ALSO
120*a325d9c4SApple OSS Distributions.Xr copy 9 ,
121*a325d9c4SApple OSS Distributions.Xr store 9
122