]> git.saurik.com Git - apple/xnu.git/blame - bsd/man/man9/store.9
xnu-3789.70.16.tar.gz
[apple/xnu.git] / bsd / man / man9 / store.9
CommitLineData
9bccf70c
A
1.\" $NetBSD: store.9,v 1.2 1996/01/09 21:59:27 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/store.9,v 1.7.2.4 2001/12/17 11:30:19 ru Exp $
36.\"
91447636 37.Dd December 16, 2004
9bccf70c
A
38.Dt STORE 9
39.Os
40.Sh NAME
41.Nm store ,
42.Nm subyte ,
91447636 43.Nm suibyte ,
91447636
A
44.Nm suiword ,
45.Nm sulong ,
2d21ac55
A
46.Nm suulong ,
47.Nm suword
9bccf70c
A
48.Nd store data to 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
2d21ac55
A
55.Fo subyte
56.Fa "user_addr_t addr"
57.Fa "int byte"
58.Fc
9bccf70c 59.Ft int
2d21ac55
A
60.Fo suibyte
61.Fa "user_addr_t addr"
62.Fa "int byte"
63.Fc
9bccf70c 64.Ft int
2d21ac55
A
65.Fo suiword
66.Fa "user_addr_t addr"
67.Fa "int word"
68.Fc
9bccf70c 69.Ft int
2d21ac55
A
70.Fo sulong
71.Fa "user_addr_t addr"
72.Fa "int64_t longword"
73.Fc
91447636 74.Ft int
2d21ac55
A
75.Fo suulong
76.Fa "user_addr_t addr"
77.Fa "uint64_t longword"
78.Fc
91447636 79.Ft int
2d21ac55
A
80.Fo suword
81.Fa "user_addr_t addr"
82.Fa "int word"
83.Fc
9bccf70c
A
84.Sh DESCRIPTION
85The
86.Nm
87functions are designed to copy small amounts of data to user-space.
88.Pp
89The
90.Nm
91routines provide the following functionality:
91447636 92.Bl -tag -width "suibyte()"
2d21ac55 93.\" ========
9bccf70c
A
94.It Fn subyte
95Stores a byte of data to the user-space address
91447636 96.Pa addr .
2d21ac55 97.\" ========
91447636
A
98.It Fn suibyte
99Stores a byte of data to the user-space address
100.Pa addr .
9bccf70c 101This function is safe to call during an interrupt context.
2d21ac55 102.\" ========
91447636
A
103.It Fn suiword
104Stores a word of data to the user-space address
105.Pa addr .
106This function is safe to call during an interrupt context.
2d21ac55 107.\" ========
91447636
A
108.It Fn sulong
109Stores a long word of data to the user-space address
110.Pa addr .
2d21ac55 111.\" ========
91447636
A
112.It Fn suulong
113Stores a unsigned long word of data to the user-space address
114.Pa addr .
2d21ac55
A
115.\" ========
116.It Fn suword
117Stores a word of data to the user-space address
118.Pa addr .
9bccf70c
A
119.El
120.Sh RETURN VALUES
121The
122.Nm
123functions return 0 on success or -1 on failure.
124.Sh SEE ALSO
125.Xr copy 9 ,
126.Xr fetch 9