Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
NetBSD/share/man/man9/fetch.9

101 lines
3.4 KiB
Groff
Raw Normal View History

New sentence, new line.
2002-10-14 17:43:14 +04:00
.\" $NetBSD: fetch.9,v 1.15 2002/10/14 13:43:23 wiz Exp $
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.\"
.\" 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.
.\"
Add David Brownlee's new intro pages, with editing. (PR #534[23]) Also, while here, expand apparently incorrectly .Dd month abbreviations. (I thought about doing this in tmac/doc-common...heh...that would have allowed a possible reverse map back to abbreviations.)
1998-04-22 11:14:30 +04:00
.Dd January 7, 1996
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.Dt FETCH 9
More .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Many more to come.
1999-03-16 03:40:46 +03:00
.Os
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.Sh NAME
add missing .Nm sections
1997-11-11 13:06:37 +03:00
.Nm fetch ,
.Nm fubyte ,
.Nm fuibyte ,
.Nm fusword ,
.Nm fuswintr ,
.Nm fuword ,
.Nm fuiword
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.Nd fetch data from user-space
.Sh SYNOPSIS
Generate <>& symbolically. I'm avoiding .../dist/... directories for now.
2002-02-13 11:17:26 +03:00
.Fd #include \*[Lt]sys/types.h\*[Gt]
.Fd #include \*[Lt]sys/systm.h\*[Gt]
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.Ft int
systm.h says these take const void * parameters
2001-05-16 07:54:24 +04:00
.Fn fubyte "const void *base"
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.Ft int
systm.h says these take const void * parameters
2001-05-16 07:54:24 +04:00
.Fn fusword "const void *base"
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.Ft int
systm.h says these take const void * parameters
2001-05-16 07:54:24 +04:00
.Fn fuswintr "const void *base"
fuword returns a long, according to systm.h
2001-05-16 07:52:58 +04:00
.Ft long
systm.h says these take const void * parameters
2001-05-16 07:54:24 +04:00
.Fn fuword "const void *base"
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.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' => `.Fa'
1996-06-20 02:50:16 +04:00
.Fa base .
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.It Fn fusword
Fetches a short word of data from the user-space address
`.Pa' => `.Fa'
1996-06-20 02:50:16 +04:00
.Fa base .
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.It Fn fuswintr
Fetches a short word of data from the user-space address
`.Pa' => `.Fa'
1996-06-20 02:50:16 +04:00
.Fa base .
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
This function is safe to call during an interrupt context.
.It Fn fuword
Fetches a word of data from the user-space address
`.Pa' => `.Fa'
1996-06-20 02:50:16 +04:00
.Fa base .
Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word} functions. Cross-reference with each-other and copy(9).
1996-01-09 06:23:01 +03:00
.El
.Sh RETURN VALUES
The
.Nm
Fix typo: failire -> failure
1996-01-10 00:59:24 +03:00
functions return the data fetched or -1 on failure.
Clarify the description of return values, and add a BUGS section describing the ambiguity of -1 error return from fuword().
1996-10-17 18:27:06 +04:00
Note that these functions all do "unsigned" access, and
therefore will never sign extend byte or short values.
This prevents ambiguity with the error return value
for all functions except
.Fn fuword .
Sort sections.
2001-12-26 04:07:45 +03:00
.Sh SEE ALSO
.Xr copy 9 ,
.Xr store 9
Clarify the description of return values, and add a BUGS section describing the ambiguity of -1 error return from fuword().
1996-10-17 18:27:06 +04:00
.Sh BUGS
The function
.Fn fuword
has no way to unambiguously signal an error, because the
fix typo.
1998-07-07 02:57:33 +04:00
data it reads might legitimately be the same as the -1
New sentence, new line.
2002-10-14 17:43:14 +04:00
used to indicate an error.
The other functions do not have this problem because the unsigned
values returned by those can never match the -1 error return value.