Copyright (c) 2006, 2009, 2025 The NetBSD Foundation, Inc.
All rights reserved.
This code is derived from software contributed to The NetBSD Foundation
by Jason R. Thorpe.
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.
THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
``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 FOUNDATION OR CONTRIBUTORS
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.
.Dd April 20, 2025 .Dt PROP_COPYIN_IOCTL 9 .Os .Sh NAME .Nm prop_object_copyin , .Nm prop_object_copyin_size , .Nm prop_object_copyin_ioctl , .Nm prop_object_copyin_ioctl_size , .Nm prop_object_copyout , .Nm prop_object_copyout_ioctl .Nd Copy property lists to and from kernel space .Sh SYNOPSIS n prop/proplib.h .Ft int .Fn prop_object_copyin "const struct plistref *pref" \ "prop_object_t *arrayp" .Ft int .Fn prop_object_copyin_size "const struct plistref *pref" \ "prop_object_t *arrayp" "size_t lim" .Ft int .Fn prop_object_copyin_ioctl "const struct plistref *pref" \ "const u_long cmd" "prop_object_t *arrayp" .Ft int .Fn prop_object_copyin_ioctl_size "const struct plistref *pref" \ "const u_long cmd" "prop_object_t *arrayp" "size_t lim" .Ft int .Fn prop_object_copyout "struct plistref *pref" \ "prop_object_t array" .Ft int .Fn prop_object_copyout_ioctl "struct plistref *pref" \ "const u_long cmd" "prop_object_t array" .Sh DESCRIPTION The .Nm prop_object_copyin_ioctl , .Nm prop_object_copyin_ioctl_size , and .Nm prop_object_copyout_ioctl functions implement the kernel side of a protocol for copying property lists to and from the kernel using .Xr ioctl 2 . The functions .Nm prop_object_copyin , .Nm prop_object_copyin_size , and .Nm prop_object_copyout implement the kernel side of a protocol for copying property lists to the kernel as arguments of normal system calls.
p A kernel routine receiving or returning a property list will be passed a pointer to a .Vt struct plistref . This structure encapsulates the reference to the property list in externalized form.
p The functions .Nm prop_object_copyin_size and .Nm prop_object_copyin_ioctl_size take an explicit size limit argument .Ar lim while .Nm prop_object_copyin and .Nm prop_object_copyin_ioctl have an implicit size limit of 128KB. Attempts to transfer objects larger than the limit result in an .Er E2BIG return value.
p The functions .Fn prop_array_copyin , .Fn prop_array_copyin_size , .Fn prop_array_copyin_ioctl , .Fn prop_array_copyin_ioctl_size , .Fn prop_dictionary_copyin , .Fn prop_dictionary_copyin_size , .Fn prop_dictionary_copyin_ioctl , and .Fn prop_dictionary_copyin_ioctl_size are provided as wrappers around the corresponding generic object functions. They are provided for backwards compatibility and will fail if the object copied in is not of the specified type, preserving the previous behavior.
p The functions .Fn prop_array_copyout , .Fn prop_array_copyout_ioctl , .Fn prop_dictionary_copyout , and .Fn prop_dictionary_copyout_ioctl are also provided as backwards compatibility wrappers around the corresponding generic object functions, but impose no object type constraints. .Sh RETURN VALUES If successful, functions return zero. Otherwise, an error number will be returned to indicate the error. .Sh EXAMPLES The following
q simplified example demonstrates using .Fn prop_object_copyin_ioctl and .Fn prop_object_copyout_ioctl in an ioctl routine: d -literal extern prop_dictionary_t fooprops; int fooioctl(dev_t dev, u_long cmd, caddr_t data, int flag, struct lwp *l) { prop_dictionary_t dict, odict; int error; switch (cmd) { case FOOSETPROPS: { const struct plistref *pref = (const struct plistref *) data; error = prop_object_copyin_ioctl(pref, cmd, (prop_object_t *)\*[Am]dict); if (error) return (error); odict = fooprops; fooprops = dict; prop_object_release(odict); break; } case FOOGETPROPS: { struct plistref *pref = (struct plistref *) data; error = prop_object_copyout_ioctl(pref, cmd, fooprops); break; } default: return (EPASSTHROUGH); } return (error); } .Ed
p The following
q simplified example demonstrates using .Fn prop_object_copyin in a routine: d -literal int foocopyin(const struct plistref *pref)) { prop_array_t array; int error; error = prop_object_copyin(pref, (prop_object_t *)\*[Am]array); if (error) return (error); ... } .Ed .Sh ERRORS .Fn prop_object_copyin_ioctl will fail if: l -tag -width Er t Bq Er E2BIG The object being copied is larger than an arbitrarily established limit (currently set to 128Kbytes). t Bq Er EFAULT Bad address t Bq Er EIO Input/output error t Bq Er ENOMEM Cannot allocate memory .El
p .Fn prop_object_copyout_ioctl will fail if: l -tag -width Er t Bq Er EFAULT Bad address t Bq Er ENOMEM Cannot allocate memory .El .Sh SEE ALSO .Xr prop_array 3 , .Xr prop_dictionary 3 , .Xr prop_object 3 , .Xr prop_send_ioctl 3 , .Xr prop_send_syscall 3 , .Xr proplib 3 .Sh HISTORY The .Nm proplib property container object library first appeared in .Nx 4.0 .