[apple/xnu.git] / bsd / man / man9 / fetch.9

.\"	$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: src/share/man/man9/fetch.9,v 1.6.2.4 2001/12/17 11:30:18 ru Exp $
.\"
.Dd December 16, 2004
.Dt FETCH 9
.Os
.Sh NAME
.Nm fetch ,
.Nm fubyte ,
.Nm fuibyte ,
.Nm fuword ,
.Nm fuiword ,
.Nm fulong ,
.Nm fuulong
.Nd fetch data from user-space
.Sh SYNOPSIS
.In sys/types.h
.In sys/time.h
.In sys/systm.h
.In sys/resourcevar.h
.Ft int
.Fn fubyte "const user_addr_t addr"
.Ft int
.Fn fuibyte "const user_addr_t addr"
.Ft int
.Fn fuword "user_addr_t addr"
.Ft int
.Fn fuiword "user_addr_t addr"
.Ft int64_t
.Fn fulong "user_addr_t addr"
.Ft uint64_t
.Fn fuulong "user_addr_t addr"
.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 "fuiword()"
.It Fn fubyte
Fetches a byte of data from the user-space address
.Pa addr .
.It Fn fuibyte
Fetches a byte of data from the user-space address
.Pa addr .
This function is safe to call during an interrupt context.
.It Fn fuword
Fetches a word of data from the user-space address
.Pa addr .
.It Fn fuiword
Fetches a word of data from the user-space address
.Pa addr .
This function is safe to call during an interrupt context.
.It Fn fulong
Fetches a long word of data from the user-space address
.Pa addr .
.It Fn fuulong
Fetches a unsigned long word of data from the user-space address
.Pa addr .
.El
.Sh RETURN VALUES
The
.Nm
functions return the data fetched or -1 on failure.
.Sh SEE ALSO
.Xr copy 9 ,
.Xr store 9
Commit	Line	Data
9bccf70c A	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	.\"
91447636	37	.Dd December 16, 2004
9bccf70c A	38	.Dt FETCH 9
	39	.Os
	40	.Sh NAME
	41	.Nm fetch ,
	42	.Nm fubyte ,
91447636 A	43	.Nm fuibyte ,
	44	.Nm fuword ,
	45	.Nm fuiword ,
	46	.Nm fulong ,
	47	.Nm fuulong
9bccf70c A	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	.In sys/resourcevar.h
	54	.Ft int
91447636	55	.Fn fubyte "const user_addr_t addr"
9bccf70c	56	.Ft int
91447636	57	.Fn fuibyte "const user_addr_t addr"
9bccf70c	58	.Ft int
91447636 A	59	.Fn fuword "user_addr_t addr"
	60	.Ft int
	61	.Fn fuiword "user_addr_t addr"
	62	.Ft int64_t
	63	.Fn fulong "user_addr_t addr"
	64	.Ft uint64_t
	65	.Fn fuulong "user_addr_t addr"
9bccf70c A	66	.Sh DESCRIPTION
	67	The
	68	.Nm
	69	functions are designed to copy small amounts of data from user-space.
	70	.Pp
	71	The
	72	.Nm
	73	routines provide the following functionality:
91447636	74	.Bl -tag -width "fuiword()"
9bccf70c A	75	.It Fn fubyte
9bccf70c A	76	Fetches a byte of data from the user-space address
91447636 A	77	.Pa addr .
	78	.It Fn fuibyte
	79	Fetches a byte of data from the user-space address
	80	.Pa addr .
9bccf70c A	81	This function is safe to call during an interrupt context.
	82	.It Fn fuword
	83	Fetches a word of data from the user-space address
91447636 A	84	.Pa addr .
	85	.It Fn fuiword
	86	Fetches a word of data from the user-space address
	87	.Pa addr .
	88	This function is safe to call during an interrupt context.
	89	.It Fn fulong
	90	Fetches a long word of data from the user-space address
	91	.Pa addr .
	92	.It Fn fuulong
	93	Fetches a unsigned long word of data from the user-space address
	94	.Pa addr .
9bccf70c A	95	.El
	96	.Sh RETURN VALUES
	97	The
	98	.Nm
	99	functions return the data fetched or -1 on failure.
	100	.Sh SEE ALSO
	101	.Xr copy 9 ,
	102	.Xr store 9