]> CyberLeo.Net >> Repos - FreeBSD/releng/8.1.git/blob - lib/libc/sys/getsockopt.2
Copy stable/8 to releng/8.1 in preparation for 8.1-RC1.
[FreeBSD/releng/8.1.git] / lib / libc / sys / getsockopt.2
1 .\" Copyright (c) 1983, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)getsockopt.2        8.4 (Berkeley) 5/2/95
29 .\" $FreeBSD$
30 .\"
31 .Dd June 13, 2008
32 .Dt GETSOCKOPT 2
33 .Os
34 .Sh NAME
35 .Nm getsockopt ,
36 .Nm setsockopt
37 .Nd get and set options on sockets
38 .Sh LIBRARY
39 .Lb libc
40 .Sh SYNOPSIS
41 .In sys/types.h
42 .In sys/socket.h
43 .Ft int
44 .Fn getsockopt "int s" "int level" "int optname" "void * restrict optval" "socklen_t * restrict optlen"
45 .Ft int
46 .Fn setsockopt "int s" "int level" "int optname" "const void *optval" "socklen_t optlen"
47 .Sh DESCRIPTION
48 The
49 .Fn getsockopt
50 and
51 .Fn setsockopt
52 system calls
53 manipulate the
54 .Em options
55 associated with a socket.
56 Options may exist at multiple
57 protocol levels; they are always present at the uppermost
58 .Dq socket
59 level.
60 .Pp
61 When manipulating socket options the level at which the
62 option resides and the name of the option must be specified.
63 To manipulate options at the socket level,
64 .Fa level
65 is specified as
66 .Dv SOL_SOCKET .
67 To manipulate options at any
68 other level the protocol number of the appropriate protocol
69 controlling the option is supplied.
70 For example,
71 to indicate that an option is to be interpreted by the
72 .Tn TCP
73 protocol,
74 .Fa level
75 should be set to the protocol number of
76 .Tn TCP ;
77 see
78 .Xr getprotoent 3 .
79 .Pp
80 The
81 .Fa optval
82 and
83 .Fa optlen
84 arguments
85 are used to access option values for
86 .Fn setsockopt .
87 For
88 .Fn getsockopt
89 they identify a buffer in which the value for the
90 requested option(s) are to be returned.
91 For
92 .Fn getsockopt ,
93 .Fa optlen
94 is a value-result argument, initially containing the
95 size of the buffer pointed to by
96 .Fa optval ,
97 and modified on return to indicate the actual size of
98 the value returned.
99 If no option value is
100 to be supplied or returned,
101 .Fa optval
102 may be NULL.
103 .Pp
104 The
105 .Fa optname
106 argument
107 and any specified options are passed uninterpreted to the appropriate
108 protocol module for interpretation.
109 The include file
110 .In sys/socket.h
111 contains definitions for
112 socket level options, described below.
113 Options at other protocol levels vary in format and
114 name; consult the appropriate entries in
115 section
116 4 of the manual.
117 .Pp
118 Most socket-level options utilize an
119 .Vt int
120 argument for
121 .Fa optval .
122 For
123 .Fn setsockopt ,
124 the argument should be non-zero to enable a boolean option,
125 or zero if the option is to be disabled.
126 .Dv SO_LINGER
127 uses a
128 .Vt "struct linger"
129 argument, defined in
130 .In sys/socket.h ,
131 which specifies the desired state of the option and the
132 linger interval (see below).
133 .Dv SO_SNDTIMEO
134 and
135 .Dv SO_RCVTIMEO
136 use a
137 .Vt "struct timeval"
138 argument, defined in
139 .In sys/time.h .
140 .Pp
141 The following options are recognized at the socket level.
142 For protocol-specific options, see protocol manual pages,
143 e.g.
144 .Xr ip 4
145 or
146 .Xr tcp 4 .
147 Except as noted, each may be examined with
148 .Fn getsockopt
149 and set with
150 .Fn setsockopt .
151 .Bl -column SO_ACCEPTFILTER -offset indent
152 .It Dv SO_DEBUG Ta "enables recording of debugging information"
153 .It Dv SO_REUSEADDR Ta "enables local address reuse"
154 .It Dv SO_REUSEPORT Ta "enables duplicate address and port bindings"
155 .It Dv SO_KEEPALIVE Ta "enables keep connections alive"
156 .It Dv SO_DONTROUTE Ta "enables routing bypass for outgoing messages"
157 .It Dv SO_LINGER  Ta "linger on close if data present"
158 .It Dv SO_BROADCAST Ta "enables permission to transmit broadcast messages"
159 .It Dv SO_OOBINLINE Ta "enables reception of out-of-band data in band"
160 .It Dv SO_SNDBUF Ta "set buffer size for output"
161 .It Dv SO_RCVBUF Ta "set buffer size for input"
162 .It Dv SO_SNDLOWAT Ta "set minimum count for output"
163 .It Dv SO_RCVLOWAT Ta "set minimum count for input"
164 .It Dv SO_SNDTIMEO Ta "set timeout value for output"
165 .It Dv SO_RCVTIMEO Ta "set timeout value for input"
166 .It Dv SO_ACCEPTFILTER Ta "set accept filter on listening socket"
167 .It Dv SO_NOSIGPIPE Ta
168 controls generation of
169 .Dv SIGPIPE
170 for the socket
171 .It Dv SO_TIMESTAMP Ta "enables reception of a timestamp with datagrams"
172 .It Dv SO_BINTIME Ta "enables reception of a timestamp with datagrams"
173 .It Dv SO_ACCEPTCONN Ta "get listening status of the socket (get only)"
174 .It Dv SO_TYPE Ta "get the type of the socket (get only)"
175 .It Dv SO_ERROR Ta "get and clear error on the socket (get only)"
176 .It Dv SO_SETFIB Ta "set the associated FIB (routing table) for the socket (set only)"
177 .El
178 .Pp
179 The following options are recognized in
180 .Fx :
181 .Bl -column SO_LISTENINCQLEN -offset indent
182 .It Dv SO_LABEL Ta "get MAC label of the socket (get only)"
183 .It Dv SO_PEERLABEL Ta "get socket's peer's MAC label (get only)"
184 .It Dv SO_LISTENQLIMIT Ta "get backlog limit of the socket (get only)"
185 .It Dv SO_LISTENQLEN Ta "get complete queue length of the socket (get only)"
186 .It Dv SO_LISTENINCQLEN Ta "get incomplete queue length of the socket (get only)"
187 .El
188 .Pp
189 .Dv SO_DEBUG
190 enables debugging in the underlying protocol modules.
191 .Dv SO_REUSEADDR
192 indicates that the rules used in validating addresses supplied
193 in a
194 .Xr bind 2
195 system call should allow reuse of local addresses.
196 .Dv SO_REUSEPORT
197 allows completely duplicate bindings by multiple processes
198 if they all set
199 .Dv SO_REUSEPORT
200 before binding the port.
201 This option permits multiple instances of a program to each
202 receive UDP/IP multicast or broadcast datagrams destined for the bound port.
203 .Dv SO_KEEPALIVE
204 enables the
205 periodic transmission of messages on a connected socket.
206 Should the
207 connected party fail to respond to these messages, the connection is
208 considered broken and processes using the socket are notified via a
209 .Dv SIGPIPE
210 signal when attempting to send data.
211 .Dv SO_DONTROUTE
212 indicates that outgoing messages should
213 bypass the standard routing facilities.
214 Instead, messages are directed
215 to the appropriate network interface according to the network portion
216 of the destination address.
217 .Pp
218 .Dv SO_LINGER
219 controls the action taken when unsent messages
220 are queued on socket and a
221 .Xr close 2
222 is performed.
223 If the socket promises reliable delivery of data and
224 .Dv SO_LINGER
225 is set,
226 the system will block the process on the
227 .Xr close 2
228 attempt until it is able to transmit the data or until it decides it
229 is unable to deliver the information (a timeout period, termed the
230 linger interval, is specified in seconds in the
231 .Fn setsockopt
232 system call when
233 .Dv SO_LINGER
234 is requested).
235 If
236 .Dv SO_LINGER
237 is disabled and a
238 .Xr close 2
239 is issued, the system will process the close in a manner that allows
240 the process to continue as quickly as possible.
241 .Pp
242 The option
243 .Dv SO_BROADCAST
244 requests permission to send broadcast datagrams
245 on the socket.
246 Broadcast was a privileged operation in earlier versions of the system.
247 With protocols that support out-of-band data, the
248 .Dv SO_OOBINLINE
249 option
250 requests that out-of-band data be placed in the normal data input queue
251 as received; it will then be accessible with
252 .Xr recv 2
253 or
254 .Xr read 2
255 calls without the
256 .Dv MSG_OOB
257 flag.
258 Some protocols always behave as if this option is set.
259 .Dv SO_SNDBUF
260 and
261 .Dv SO_RCVBUF
262 are options to adjust the normal
263 buffer sizes allocated for output and input buffers, respectively.
264 The buffer size may be increased for high-volume connections,
265 or may be decreased to limit the possible backlog of incoming data.
266 The system places an absolute maximum on these values, which is accessible
267 through the
268 .Xr sysctl 3
269 MIB variable
270 .Dq Li kern.ipc.maxsockbuf .
271 .Pp
272 .Dv SO_SNDLOWAT
273 is an option to set the minimum count for output operations.
274 Most output operations process all of the data supplied
275 by the call, delivering data to the protocol for transmission
276 and blocking as necessary for flow control.
277 Nonblocking output operations will process as much data as permitted
278 subject to flow control without blocking, but will process no data
279 if flow control does not allow the smaller of the low water mark value
280 or the entire request to be processed.
281 A
282 .Xr select 2
283 operation testing the ability to write to a socket will return true
284 only if the low water mark amount could be processed.
285 The default value for
286 .Dv SO_SNDLOWAT
287 is set to a convenient size for network efficiency, often 1024.
288 .Dv SO_RCVLOWAT
289 is an option to set the minimum count for input operations.
290 In general, receive calls will block until any (non-zero) amount of data
291 is received, then return with the smaller of the amount available or the amount
292 requested.
293 The default value for
294 .Dv SO_RCVLOWAT
295 is 1.
296 If
297 .Dv SO_RCVLOWAT
298 is set to a larger value, blocking receive calls normally
299 wait until they have received the smaller of the low water mark value
300 or the requested amount.
301 Receive calls may still return less than the low water mark if an error
302 occurs, a signal is caught, or the type of data next in the receive queue
303 is different from that which was returned.
304 .Pp
305 .Dv SO_SNDTIMEO
306 is an option to set a timeout value for output operations.
307 It accepts a
308 .Vt "struct timeval"
309 argument with the number of seconds and microseconds
310 used to limit waits for output operations to complete.
311 If a send operation has blocked for this much time,
312 it returns with a partial count
313 or with the error
314 .Er EWOULDBLOCK
315 if no data were sent.
316 In the current implementation, this timer is restarted each time additional
317 data are delivered to the protocol,
318 implying that the limit applies to output portions ranging in size
319 from the low water mark to the high water mark for output.
320 .Dv SO_RCVTIMEO
321 is an option to set a timeout value for input operations.
322 It accepts a
323 .Vt "struct timeval"
324 argument with the number of seconds and microseconds
325 used to limit waits for input operations to complete.
326 In the current implementation, this timer is restarted each time additional
327 data are received by the protocol,
328 and thus the limit is in effect an inactivity timer.
329 If a receive operation has been blocked for this much time without
330 receiving additional data, it returns with a short count
331 or with the error
332 .Er EWOULDBLOCK
333 if no data were received.
334 .Pp
335 .Dv SO_SETFIB
336 can be used to over-ride the default FIB (routing table) for the given socket.
337 The value must be from 0 to one less than the number returned from
338 the sysctl
339 .Em net.fibs .
340 .Pp
341 .Dv SO_ACCEPTFILTER
342 places an
343 .Xr accept_filter 9
344 on the socket,
345 which will filter incoming connections
346 on a listening stream socket before being presented for
347 .Xr accept 2 .
348 Once more,
349 .Xr listen 2
350 must be called on the socket before
351 trying to install the filter on it,
352 or else the
353 .Fn setsockopt
354 system call will fail.
355 .Bd -literal
356 struct  accept_filter_arg {
357         char    af_name[16];
358         char    af_arg[256-16];
359 };
360 .Ed
361 .Pp
362 The
363 .Fa optval
364 argument
365 should point to a
366 .Fa struct accept_filter_arg
367 that will select and configure the
368 .Xr accept_filter 9 .
369 The
370 .Fa af_name
371 argument
372 should be filled with the name of the accept filter
373 that the application wishes to place on the listening socket.
374 The optional argument
375 .Fa af_arg
376 can be passed to the accept
377 filter specified by
378 .Fa af_name
379 to provide additional configuration options at attach time.
380 Passing in an
381 .Fa optval
382 of NULL will remove the filter.
383 .Pp
384 The
385 .Dv SO_NOSIGPIPE
386 option controls generation of the
387 .Dv SIGPIPE
388 signal normally sent
389 when writing to a connected socket where the other end has been
390 closed returns with the error
391 .Er EPIPE .
392 .Pp
393 If the
394 .Dv SO_TIMESTAMP
395 or
396 .Dv SO_BINTIME
397 option is enabled on a
398 .Dv SOCK_DGRAM
399 socket, the
400 .Xr recvmsg 2
401 call will return a timestamp corresponding to when the datagram was received.
402 The
403 .Va msg_control
404 field in the
405 .Vt msghdr
406 structure points to a buffer that contains a
407 .Vt cmsghdr
408 structure followed by a
409 .Vt "struct timeval"
410 for
411 .Dv SO_TIMESTAMP
412 and
413 .Vt "struct bintime"
414 for
415 .Dv SO_BINTIME .
416 The
417 .Vt cmsghdr
418 fields have the following values for TIMESTAMP:
419 .Bd -literal
420      cmsg_len = sizeof(struct timeval);
421      cmsg_level = SOL_SOCKET;
422      cmsg_type = SCM_TIMESTAMP;
423 .Ed
424 .Pp
425 and for
426 .Dv SO_BINTIME :
427 .Bd -literal
428      cmsg_len = sizeof(struct bintime);
429      cmsg_level = SOL_SOCKET;
430      cmsg_type = SCM_BINTIME;
431 .Ed
432 .Pp
433 .Dv SO_ACCEPTCONN ,
434 .Dv SO_TYPE
435 and
436 .Dv SO_ERROR
437 are options used only with
438 .Fn getsockopt .
439 .Dv SO_ACCEPTCONN
440 returns whether the socket is currently accepting connections,
441 that is, whether or not the
442 .Xr listen 2
443 system call was invoked on the socket.
444 .Dv SO_TYPE
445 returns the type of the socket, such as
446 .Dv SOCK_STREAM ;
447 it is useful for servers that inherit sockets on startup.
448 .Dv SO_ERROR
449 returns any pending error on the socket and clears
450 the error status.
451 It may be used to check for asynchronous errors on connected
452 datagram sockets or for other asynchronous errors.
453 .Pp
454 Finally,
455 .Dv SO_LABEL
456 returns the MAC label of the socket.
457 .Dv SO_PEERLABEL
458 returns the MAC label of the socket's peer.
459 Note that your kernel must be compiled with MAC support.
460 See
461 .Xr mac 3
462 for more information.
463 .Dv SO_LISTENQLIMIT
464 returns the maximal number of queued connections, as set by
465 .Xr listen 2 .
466 .Dv SO_LISTENQLEN
467 returns the number of unaccepted complete connections.
468 .Dv SO_LISTENINCQLEN
469 returns the number of unaccepted incomplete connections.
470 .Sh RETURN VALUES
471 .Rv -std
472 .Sh ERRORS
473 The call succeeds unless:
474 .Bl -tag -width Er
475 .It Bq Er EBADF
476 The argument
477 .Fa s
478 is not a valid descriptor.
479 .It Bq Er ENOTSOCK
480 The argument
481 .Fa s
482 is a file, not a socket.
483 .It Bq Er ENOPROTOOPT
484 The option is unknown at the level indicated.
485 .It Bq Er EFAULT
486 The address pointed to by
487 .Fa optval
488 is not in a valid part of the process address space.
489 For
490 .Fn getsockopt ,
491 this error may also be returned if
492 .Fa optlen
493 is not in a valid part of the process address space.
494 .It Bq Er EINVAL
495 Installing an
496 .Xr accept_filter 9
497 on a non-listening socket was attempted.
498 .El
499 .Sh SEE ALSO
500 .Xr ioctl 2 ,
501 .Xr listen 2 ,
502 .Xr recvmsg 2 ,
503 .Xr socket 2 ,
504 .Xr getprotoent 3 ,
505 .Xr mac 3 ,
506 .Xr sysctl 3 ,
507 .Xr ip 4 ,
508 .Xr ip6 4 ,
509 .Xr sctp 4 ,
510 .Xr tcp 4 ,
511 .Xr protocols 5 ,
512 .Xr sysctl 8 ,
513 .Xr accept_filter 9 ,
514 .Xr bintime 9
515 .Sh HISTORY
516 The
517 .Fn getsockopt
518 system call appeared in
519 .Bx 4.2 .
520 .Sh BUGS
521 Several of the socket options should be handled at lower levels of the system.