Merge branch 'vendor/OPENSSH'
[dragonfly.git] / lib / libprop / prop_send_ioctl.3
1 .\"     $NetBSD: prop_send_ioctl.3,v 1.6 2011/01/20 10:44:42 wiz 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 21, 2008
31 .Dt PROP_SEND_IOCTL 3
32 .Os
33 .Sh NAME
34 .Nm prop_array_send_ioctl ,
35 .Nm prop_array_recv_ioctl ,
36 .Nm prop_dictionary_send_ioctl ,
37 .Nm prop_dictionary_recv_ioctl ,
38 .Nm prop_dictionary_sendrecv_ioctl
39 .Nd Send and receive propertly lists to and from the kernel using ioctl
40 .Sh LIBRARY
41 .Lb libprop
42 .Sh SYNOPSIS
43 .In libprop/proplib.h
44 .Ft int
45 .Fn prop_array_send_ioctl "prop_array_t array" "int fd" "unsigned long cmd"
46 .Ft int
47 .Fn prop_array_recv_ioctl "int fd" "unsigned long cmd" "prop_array_t *arrayp"
48 .Ft int
49 .Fn prop_dictionary_send_ioctl "prop_dictionary_t dict" "int fd" \
50     "unsigned long cmd"
51 .Ft int
52 .Fn prop_dictionary_recv_ioctl "int fd" "unsigned long cmd" \
53     "prop_dictionary_t *dictp"
54 .Fn prop_dictionary_sendrecv_ioctl "prop_dictionary_t dict" "int fd" \
55     "unsigned long cmd" "prop_dictionary_t *dictp"
56 .Sh DESCRIPTION
57 The
58 .Nm prop_array_send_ioctl ,
59 .Nm prop_array_recv_ioctl ,
60 .Nm prop_dictionary_send_ioctl ,
61 .Nm prop_dictionary_recv_ioctl ,
62 and
63 .Nm prop_dictionary_sendrecv_ioctl
64 functions implement the user space side of a protocol for sending property
65 lists to and from the kernel using
66 .Xr ioctl 2 .
67 .Sh RETURN VALUES
68 If successful, functions return zero.
69 Otherwise, an error number is returned to indicate the error.
70 .Sh EXAMPLES
71 The following
72 .Pq simplified
73 example demonstrates using
74 .Fn prop_dictionary_send_ioctl
75 and
76 .Fn prop_dictionary_recv_ioctl
77 in an application:
78 .Bd -literal
79 void
80 foo_setprops(prop_dictionary_t dict)
81 {
82     int fd;
83
84     fd = open("/dev/foo", O_RDWR, 0640);
85     if (fd == -1)
86         return;
87
88     (void) prop_dictionary_send_ioctl(dict, fd, FOOSETPROPS);
89
90     (void) close(fd);
91 }
92
93 prop_dictionary_t
94 foo_getprops(void)
95 {
96     prop_dictionary_t dict;
97     int fd;
98
99     fd = open("/dev/foo", O_RDONLY, 0640);
100     if (fd == -1)
101         return (NULL);
102
103     if (prop_dictionary_recv_ioctl(fd, FOOGETPROPS, \*[Am]dict) != 0)
104         return (NULL);
105
106     (void) close(fd);
107
108     return (dict);
109 }
110 .Ed
111 .Pp
112 The
113 .Nm prop_dictionary_sendrecv_ioctl
114 function combines the send and receive functionality, allowing for
115 ioctls that require two-way communication
116 .Pq for example to specify arguments for the ioctl operation .
117 .Sh ERRORS
118 .Fn prop_array_send_ioctl
119 and
120 .Fn prop_dictionary_send_ioctl
121 will fail if:
122 .Bl -tag -width Er
123 .It Bq Er ENOMEM
124 Cannot allocate memory
125 .It Bq Er ENOTSUP
126 Not supported
127 .El
128 .Pp
129 .Fn prop_array_recv_ioctl
130 and
131 .Fn prop_dictionary_recv_ioctl
132 will fail if:
133 .Bl -tag -width Er
134 .It Bq Er EIO
135 Input/output error
136 .It Bq Er ENOTSUP
137 Not supported
138 .El
139 .Pp
140 In addition to these,
141 .Xr ioctl 2
142 errors may be returned.
143 .Sh SEE ALSO
144 .Xr prop_array 3 ,
145 .Xr prop_dictionary 3 ,
146 .Xr proplib 3 ,
147 .Xr prop_copyin_ioctl 9
148 .Sh HISTORY
149 The
150 .Nm proplib
151 property container object library first appeared in
152 .Nx 4.0 .