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.\" 37.Dd January 26, 2017 38.Dt STORE 9 39.Os 40.Sh NAME 41.Nm store , 42.Nm casu32 , 43.Nm casu64 , 44.Nm subyte , 45.Nm suword32 , 46.Nm suword64 47.Nd store data to user-space 48.Sh SYNOPSIS 49.In sys/types.h 50.In sys/time.h 51.In sys/systm.h 52.In sys/resourcevar.h 53.Ft uint32_t 54.Fn casu32 "volatile uint32_t *p" "uint32_t oldval" "uint32_t newval" 55.Ft uint64_t 56.Fn casu64 "volatile uint64_t *p" "uint64_t oldval" "uint64_t newval" 57.Ft int 58.Fn subyte "uint8_t *base" "uint8_t byte" 59.Ft int 60.Fn suword32 "uint32_t *base" "int word" 61.Ft int 62.Fn suword64 "uint64_t *base" "uint64_t word" 63.Sh DESCRIPTION 64The 65.Nm 66functions are designed to copy small amounts of data to user-space. 67.Pp 68The 69.Nm 70routines provide the following functionality: 71.Bl -tag -width ".Fn suword32" 72.It Fn casu32 73Compares the 32 bit 74.Fa oldval 75with the 32 bits at 76.Fa base , 77and if equal, 78.Fa base 79is set to 80.Fa newval . 81The old value at 82.Fa base 83is then returned. 84.It Fn casu64 85Compares the 64 bit 86.Fa oldval 87with the 64 bits at 88.Fa base , 89and if equal, 90.Fa base 91is set to 92.Fa newval . 93The old value at 94.Fa base 95is then returned. 96.It Fn subyte 97Stores a byte of data to the user-space address 98.Fa base . 99.It Fn suword32 100Stores 32 bits of data to the user-space address 101.Fa base . 102.It Fn suword64 103Stores 64 bits of data to the user-space address 104.Fa base . 105.El 106.Sh RETURN VALUES 107The 108.Nm 109functions return 0 on success or -1 on failure. 110.Sh SEE ALSO 111.Xr copy 9 , 112.Xr fetch 9 113