d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
freebsd-skq/share/man/man9/store.9

94 lines
3.0 KiB
Groff
Raw Permalink Normal View History

Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.\" $NetBSD: store.9,v 1.2 1996/01/09 21:59:27 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.
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
Add $Id$, to make it simpler for members of the translation teams to track. The $Id$ line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde
1999-07-12 21:02:10 +00:00
.\"
Remove the unused fuwintr() and suiwintr() functions. Half of implementations always failed (returned (-1)) and they were previously used in only one place. Reviewed by: kib, andrew Obtained from: CheriBSD Sponsored by: DARPA, AFRL Differential Revision: https://reviews.freebsd.org/D15102
2018-04-17 18:04:28 +00:00
.Dd April 17, 2018
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.Dt STORE 9
mdoc(7) police: removed HISTORY info from the .Os call.
2001-07-10 15:31:11 +00:00
.Os
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.Sh NAME
.Nm store ,
.Nm subyte ,
.Nm suword
.Nd store data to user-space
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In sys/types.h
.In sys/time.h
.In sys/systm.h
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.Ft int
Add type qualifier volatile to the base (userspace) address argument of fuword(9) and suword(9). This makes the functions type-compatible with volatile objects and does not require devolatile force, e.g. in kern_umtx.c. Requested by: bde Reviewed by: jhb Sponsored by: The FreeBSD Foundation MFC after: 3 weeks
2014-10-31 17:43:21 +00:00
.Fn subyte "volatile void *base" "int byte"
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.Ft int
Add type qualifier volatile to the base (userspace) address argument of fuword(9) and suword(9). This makes the functions type-compatible with volatile objects and does not require devolatile force, e.g. in kern_umtx.c. Requested by: bde Reviewed by: jhb Sponsored by: The FreeBSD Foundation MFC after: 3 weeks
2014-10-31 17:43:21 +00:00
.Fn suword "volatile void *base" "long word"
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.Ft int
Add type qualifier volatile to the base (userspace) address argument of fuword(9) and suword(9). This makes the functions type-compatible with volatile objects and does not require devolatile force, e.g. in kern_umtx.c. Requested by: bde Reviewed by: jhb Sponsored by: The FreeBSD Foundation MFC after: 3 weeks
2014-10-31 17:43:21 +00:00
.Fn suword16 "volatile void *base" "int word"
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.Ft int
Add type qualifier volatile to the base (userspace) address argument of fuword(9) and suword(9). This makes the functions type-compatible with volatile objects and does not require devolatile force, e.g. in kern_umtx.c. Requested by: bde Reviewed by: jhb Sponsored by: The FreeBSD Foundation MFC after: 3 weeks
2014-10-31 17:43:21 +00:00
.Fn suword32 "volatile void *base" "int32_t word"
Make fetch(9) and store(9) manual pages closer to reality.
2009-10-05 15:16:28 +00:00
.Ft int
Add type qualifier volatile to the base (userspace) address argument of fuword(9) and suword(9). This makes the functions type-compatible with volatile objects and does not require devolatile force, e.g. in kern_umtx.c. Requested by: bde Reviewed by: jhb Sponsored by: The FreeBSD Foundation MFC after: 3 weeks
2014-10-31 17:43:21 +00:00
.Fn suword64 "volatile void *base" "int64_t word"
Make fetch(9) and store(9) manual pages closer to reality.
2009-10-05 15:16:28 +00:00
.In sys/resourcevar.h
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.Sh DESCRIPTION
The
.Nm
functions are designed to copy small amounts of data to user-space.
Add type qualifier volatile to the base (userspace) address argument of fuword(9) and suword(9). This makes the functions type-compatible with volatile objects and does not require devolatile force, e.g. in kern_umtx.c. Requested by: bde Reviewed by: jhb Sponsored by: The FreeBSD Foundation MFC after: 3 weeks
2014-10-31 17:43:21 +00:00
If write is successful, it is performed atomically.
The data written must be naturally aligned.
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.Pp
The
.Nm
routines provide the following functionality:
Remove the unused fuwintr() and suiwintr() functions. Half of implementations always failed (returned (-1)) and they were previously used in only one place. Reviewed by: kib, andrew Obtained from: CheriBSD Sponsored by: DARPA, AFRL Differential Revision: https://reviews.freebsd.org/D15102
2018-04-17 18:04:28 +00:00
.Bl -tag -width "suword64()"
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.It Fn subyte
Stores a byte of data to the user-space address
.Pa base .
Make fetch(9) and store(9) manual pages closer to reality.
2009-10-05 15:16:28 +00:00
.It Fn suword
Stores a word of data to the user-space address
.Pa base .
.It Fn suword16
Remove duplicate words in mdoc(7) pages. PR: 167810 Submitted by: Bryan Drewery {bryan!shatow%net} (hackers lounge) Found with: textproc/igor MFC after: 3 days
2012-05-12 03:46:43 +00:00
Stores 16 bits of data to the user-space address
Make fetch(9) and store(9) manual pages closer to reality.
2009-10-05 15:16:28 +00:00
.Pa base .
.It Fn suword32
Remove duplicate words in mdoc(7) pages. PR: 167810 Submitted by: Bryan Drewery {bryan!shatow%net} (hackers lounge) Found with: textproc/igor MFC after: 3 days
2012-05-12 03:46:43 +00:00
Stores 32 bits of data to the user-space address
Make fetch(9) and store(9) manual pages closer to reality.
2009-10-05 15:16:28 +00:00
.Pa base .
.It Fn suword64
Remove duplicate words in mdoc(7) pages. PR: 167810 Submitted by: Bryan Drewery {bryan!shatow%net} (hackers lounge) Found with: textproc/igor MFC after: 3 days
2012-05-12 03:46:43 +00:00
Stores 64 bits of data to the user-space address
Add man pages for the copy*, fetch*, and store* families of kernel functions. Also added timeout(9) to the makefile. Reviewed by: joerg Obtained from: NetBSD
1996-04-15 21:37:07 +00:00
.Pa base .
.El
.Sh RETURN VALUES
The
.Nm
functions return 0 on success or -1 on failure.
.Sh SEE ALSO
.Xr copy 9 ,
remove fullstops from the end of .Xr lines in SEE ALSO sections.
2000-11-15 16:00:07 +00:00
.Xr fetch 9
Reference in New Issue Copy Permalink