1.\" $NetBSD: prop_send_syscall.3,v 1.5 2011/09/30 22:08:18 jym Exp $ 2.\" 3.\" Copyright (c) 2006 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Jason R. Thorpe. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd January 17, 2011 31.Dt PROP_SEND_SYCALL 3 32.Os 33.Sh NAME 34.Nm prop_array_send_syscall , 35.Nm prop_array_recv_syscall , 36.Nm prop_dictionary_send_syscall , 37.Nm prop_dictionary_recv_syscall 38.Nd send and receive property lists to and from the kernel using syscalls 39.Sh LIBRARY 40.Lb libprop 41.Sh SYNOPSIS 42.In libprop/proplib.h 43.Ft int 44.Fn prop_array_send_syscall "prop_array_t array" "struct plistref *prefp" 45.Ft int 46.Fn prop_array_recv_syscall "const struct plistref *prefp" \ 47 "prop_array_t *arrayp" 48.Ft int 49.Fn prop_dictionary_send_syscall "prop_dictionary_t dict" \ 50 "struct plistref *prefp" 51.Ft int 52.Fn prop_dictionary_recv_syscall "const struct plistref *prefp" \ 53 "prop_dictionary_t *dictp" 54.Sh DESCRIPTION 55The 56.Nm prop_array_send_syscall , 57.Nm prop_array_recv_syscall , 58.Nm prop_dictionary_send_syscall , 59and 60.Nm prop_dictionary_recv_syscall 61functions implement the user space side of a protocol for sending property 62lists to and from the kernel using 63.Xr syscall 2 . 64.Sh RETURN VALUES 65If successful, functions return zero. 66Otherwise, an error number is returned to indicate the error. 67.Sh EXAMPLES 68The following 69.Pq simplified 70example demonstrates using 71.Fn prop_dictionary_send_syscall 72and 73.Fn prop_dictionary_recv_syscall 74in an application: 75.Bd -literal 76void 77foo_setprops(prop_dictionary_t dict) 78{ 79 struct pref pref; 80 81 (void) prop_dictionary_send_syscall(dict, \*[Am]pref); 82 (void) my_syscall_set(\*[Am]pref); 83 84} 85 86prop_dictionary_t 87foo_getprops(void) 88{ 89 prop_dictionary_t dict; 90 struct pref pref; 91 92 (void) my_syscall_get(\*[Am]pref); 93 if (prop_dictionary_recv_syscall(\*[Am]pref, \*[Am]dict) != 0) 94 return (NULL); 95 96 return (dict); 97} 98.Ed 99.Sh ERRORS 100.Fn prop_array_send_syscall 101and 102.Fn prop_dictionary_send_syscall 103will fail if: 104.Bl -tag -width Er 105.It Bq Er ENOMEM 106Cannot allocate memory 107.It Bq Er ENOTSUP 108Not supported 109.El 110.Pp 111.Fn prop_array_recv_syscall 112and 113.Fn prop_dictionary_recv_syscall 114will fail if: 115.Bl -tag -width Er 116.It Bq Er EIO 117Input/output error 118.It Bq Er ENOTSUP 119Not supported 120.El 121.Sh SEE ALSO 122.Xr prop_array 3 , 123.Xr prop_dictionary 3 , 124.Xr proplib 3 , 125.Xr prop_copyin_ioctl 9 126.Sh HISTORY 127The 128.Nm proplib 129property container object library first appeared in 130.Nx 4.0 . 131