git.saurik.com Git - apple/xnu.git/blame_incremental

... / ...

Commit	Line	Data
	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 December 16, 2004
	38	.Dt FETCH 9
	39	.Os
	40	.Sh NAME
	41	.Nm fetch ,
	42	.Nm fubyte ,
	43	.Nm fuibyte ,
	44	.Nm fuiword ,
	45	.Nm fulong ,
	46	.Nm fuulong ,
	47	.Nm fuword
	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	.\"
	55	.Ft int
	56	.Fo fubyte
	57	.Fa "const user_addr_t addr"
	58	.Fc
	59	.Ft int
	60	.Fo fuibyte
	61	.Fa "const user_addr_t addr"
	62	.Fc
	63	.Ft int
	64	.Fo fuiword
	65	.Fa "user_addr_t addr"
	66	.Fc
	67	.Ft int64_t
	68	.Fo fulong
	69	.Fa "user_addr_t addr"
	70	.Fc
	71	.Ft uint64_t
	72	.Fo fuulong
	73	.Fa "user_addr_t addr"
	74	.Fc
	75	.Ft int
	76	.Fo fuword
	77	.Fa "user_addr_t addr"
	78	.Fc
	79	.Sh DESCRIPTION
	80	The
	81	.Nm
	82	functions are designed to copy small amounts of data from user-space.
	83	.Pp
	84	The
	85	.Nm
	86	routines provide the following functionality:
	87	.Bl -tag -width "fuiword()"
	88	.\" ==========
	89	.It Fn fubyte
	90	Fetches a byte of data from the user-space address
	91	.Pa addr .
	92	.\" ==========
	93	.It Fn fuibyte
	94	Fetches a byte of data from the user-space address
	95	.Pa addr .
	96	This function is safe to call during an interrupt context.
	97	.\" ==========
	98	.It Fn fuiword
	99	Fetches a word of data from the user-space address
	100	.Pa addr .
	101	This function is safe to call during an interrupt context.
	102	.\" ==========
	103	.It Fn fulong
	104	Fetches a long word of data from the user-space address
	105	.Pa addr .
	106	.\" ==========
	107	.It Fn fuulong
	108	Fetches a unsigned long word of data from the user-space address
	109	.Pa addr .
	110	.\" ==========
	111	.It Fn fuword
	112	Fetches a word of data from the user-space address
	113	.Pa addr .
	114	.El
	115	.Sh RETURN VALUES
	116	The
	117	.Nm
	118	functions return the data fetched or -1 on failure.
	119	.Sh SEE ALSO
	120	.Xr copy 9 ,
	121	.Xr store 9