]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - lib/libc/sys/getsockopt.2
zfs: merge openzfs/zfs@f291fa658 (master) into main
[FreeBSD/FreeBSD.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 .\" 3. 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 February 8, 2021
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_REUSEPORT_LB Ta "enables duplicate address and port bindings with load balancing"
156 .It Dv SO_KEEPALIVE Ta "enables keep connections alive"
157 .It Dv SO_DONTROUTE Ta "enables routing bypass for outgoing messages"
158 .It Dv SO_LINGER  Ta "linger on close if data present"
159 .It Dv SO_BROADCAST Ta "enables permission to transmit broadcast messages"
160 .It Dv SO_OOBINLINE Ta "enables reception of out-of-band data in band"
161 .It Dv SO_SNDBUF Ta "set buffer size for output"
162 .It Dv SO_RCVBUF Ta "set buffer size for input"
163 .It Dv SO_SNDLOWAT Ta "set minimum count for output"
164 .It Dv SO_RCVLOWAT Ta "set minimum count for input"
165 .It Dv SO_SNDTIMEO Ta "set timeout value for output"
166 .It Dv SO_RCVTIMEO Ta "set timeout value for input"
167 .It Dv SO_ACCEPTFILTER Ta "set accept filter on listening socket"
168 .It Dv SO_NOSIGPIPE Ta
169 controls generation of
170 .Dv SIGPIPE
171 for the socket
172 .It Dv SO_TIMESTAMP Ta "enables reception of a timestamp with datagrams"
173 .It Dv SO_BINTIME Ta "enables reception of a timestamp with datagrams"
174 .It Dv SO_ACCEPTCONN Ta "get listening status of the socket (get only)"
175 .It Dv SO_DOMAIN Ta "get the domain of the socket (get only)"
176 .It Dv SO_TYPE Ta "get the type of the socket (get only)"
177 .It Dv SO_PROTOCOL Ta "get the protocol number for the socket (get only)"
178 .It Dv SO_PROTOTYPE Ta "SunOS alias for the Linux SO_PROTOCOL (get only)"
179 .It Dv SO_ERROR Ta "get and clear error on the socket (get only)"
180 .It Dv SO_RERROR Ta "enables receive error reporting"
181 .It Dv SO_SETFIB Ta "set the associated FIB (routing table) for the socket (set only)"
182 .El
183 .Pp
184 The following options are recognized in
185 .Fx :
186 .Bl -column SO_LISTENINCQLEN -offset indent
187 .It Dv SO_LABEL Ta "get MAC label of the socket (get only)"
188 .It Dv SO_PEERLABEL Ta "get socket's peer's MAC label (get only)"
189 .It Dv SO_LISTENQLIMIT Ta "get backlog limit of the socket (get only)"
190 .It Dv SO_LISTENQLEN Ta "get complete queue length of the socket (get only)"
191 .It Dv SO_LISTENINCQLEN Ta "get incomplete queue length of the socket (get only)"
192 .It Dv SO_USER_COOKIE Ta "set the 'so_user_cookie' value for the socket (uint32_t, set only)"
193 .It Dv SO_TS_CLOCK Ta "set specific format of timestamp returned by SO_TIMESTAMP"
194 .It Dv SO_MAX_PACING_RATE Ta "set the maximum transmit rate in bytes per second for the socket"
195 .It Dv SO_NO_OFFLOAD Ta "disables protocol offloads"
196 .It Dv SO_NO_DDP Ta "disables direct data placement offload"
197 .El
198 .Pp
199 .Dv SO_DEBUG
200 enables debugging in the underlying protocol modules.
201 .Pp
202 .Dv SO_REUSEADDR
203 indicates that the rules used in validating addresses supplied
204 in a
205 .Xr bind 2
206 system call should allow reuse of local addresses.
207 .Pp
208 .Dv SO_REUSEPORT
209 allows completely duplicate bindings by multiple processes
210 if they all set
211 .Dv SO_REUSEPORT
212 before binding the port.
213 This option permits multiple instances of a program to each
214 receive UDP/IP multicast or broadcast datagrams destined for the bound port.
215 .Pp
216 .Dv SO_REUSEPORT_LB
217 allows completely duplicate bindings by multiple processes
218 if they all set
219 .Dv SO_REUSEPORT_LB
220 before binding the port.
221 Incoming TCP and UDP connections are distributed among the sharing
222 processes based on a hash function of local port number, foreign IP
223 address and port number.
224 A maximum of 256 processes can share one socket.
225 .Pp
226 .Dv SO_KEEPALIVE
227 enables the
228 periodic transmission of messages on a connected socket.
229 Should the
230 connected party fail to respond to these messages, the connection is
231 considered broken and processes using the socket are notified via a
232 .Dv SIGPIPE
233 signal when attempting to send data.
234 .Pp
235 .Dv SO_DONTROUTE
236 indicates that outgoing messages should
237 bypass the standard routing facilities.
238 Instead, messages are directed
239 to the appropriate network interface according to the network portion
240 of the destination address.
241 .Pp
242 .Dv SO_LINGER
243 controls the action taken when unsent messages
244 are queued on socket and a
245 .Xr close 2
246 is performed.
247 If the socket promises reliable delivery of data and
248 .Dv SO_LINGER
249 is set,
250 the system will block the process on the
251 .Xr close 2
252 attempt until it is able to transmit the data or until it decides it
253 is unable to deliver the information (a timeout period, termed the
254 linger interval, is specified in seconds in the
255 .Fn setsockopt
256 system call when
257 .Dv SO_LINGER
258 is requested).
259 If
260 .Dv SO_LINGER
261 is disabled and a
262 .Xr close 2
263 is issued, the system will process the close in a manner that allows
264 the process to continue as quickly as possible.
265 .Pp
266 The option
267 .Dv SO_BROADCAST
268 requests permission to send broadcast datagrams
269 on the socket.
270 Broadcast was a privileged operation in earlier versions of the system.
271 .Pp
272 With protocols that support out-of-band data, the
273 .Dv SO_OOBINLINE
274 option
275 requests that out-of-band data be placed in the normal data input queue
276 as received; it will then be accessible with
277 .Xr recv 2
278 or
279 .Xr read 2
280 calls without the
281 .Dv MSG_OOB
282 flag.
283 Some protocols always behave as if this option is set.
284 .Pp
285 .Dv SO_SNDBUF
286 and
287 .Dv SO_RCVBUF
288 are options to adjust the normal
289 buffer sizes allocated for output and input buffers, respectively.
290 The buffer size may be increased for high-volume connections,
291 or may be decreased to limit the possible backlog of incoming data.
292 The system places an absolute maximum on these values, which is accessible
293 through the
294 .Xr sysctl 3
295 MIB variable
296 .Dq Li kern.ipc.maxsockbuf .
297 .Pp
298 .Dv SO_SNDLOWAT
299 is an option to set the minimum count for output operations.
300 Most output operations process all of the data supplied
301 by the call, delivering data to the protocol for transmission
302 and blocking as necessary for flow control.
303 Nonblocking output operations will process as much data as permitted
304 subject to flow control without blocking, but will process no data
305 if flow control does not allow the smaller of the low water mark value
306 or the entire request to be processed.
307 A
308 .Xr select 2
309 operation testing the ability to write to a socket will return true
310 only if the low water mark amount could be processed.
311 The default value for
312 .Dv SO_SNDLOWAT
313 is set to a convenient size for network efficiency, often 1024.
314 .Pp
315 .Dv SO_RCVLOWAT
316 is an option to set the minimum count for input operations.
317 In general, receive calls will block until any (non-zero) amount of data
318 is received, then return with the smaller of the amount available or the amount
319 requested.
320 The default value for
321 .Dv SO_RCVLOWAT
322 is 1.
323 If
324 .Dv SO_RCVLOWAT
325 is set to a larger value, blocking receive calls normally
326 wait until they have received the smaller of the low water mark value
327 or the requested amount.
328 Receive calls may still return less than the low water mark if an error
329 occurs, a signal is caught, or the type of data next in the receive queue
330 is different from that which was returned.
331 .Pp
332 .Dv SO_SNDTIMEO
333 is an option to set a timeout value for output operations.
334 It accepts a
335 .Vt "struct timeval"
336 argument with the number of seconds and microseconds
337 used to limit waits for output operations to complete.
338 If a send operation has blocked for this much time,
339 it returns with a partial count
340 or with the error
341 .Er EWOULDBLOCK
342 if no data were sent.
343 In the current implementation, this timer is restarted each time additional
344 data are delivered to the protocol,
345 implying that the limit applies to output portions ranging in size
346 from the low water mark to the high water mark for output.
347 .Pp
348 .Dv SO_RCVTIMEO
349 is an option to set a timeout value for input operations.
350 It accepts a
351 .Vt "struct timeval"
352 argument with the number of seconds and microseconds
353 used to limit waits for input operations to complete.
354 In the current implementation, this timer is restarted each time additional
355 data are received by the protocol,
356 and thus the limit is in effect an inactivity timer.
357 If a receive operation has been blocked for this much time without
358 receiving additional data, it returns with a short count
359 or with the error
360 .Er EWOULDBLOCK
361 if no data were received.
362 .Pp
363 .Dv SO_SETFIB
364 can be used to over-ride the default FIB (routing table) for the given socket.
365 The value must be from 0 to one less than the number returned from
366 the sysctl
367 .Em net.fibs .
368 .Pp
369 .Dv SO_USER_COOKIE
370 can be used to set the uint32_t so_user_cookie field in the socket.
371 The value is an uint32_t, and can be used in the kernel code that
372 manipulates traffic related to the socket.
373 The default value for the field is 0.
374 As an example, the value can be used as the skipto target or
375 pipe number in
376 .Nm ipfw/dummynet .
377 .Pp
378 .Dv SO_ACCEPTFILTER
379 places an
380 .Xr accept_filter 9
381 on the socket,
382 which will filter incoming connections
383 on a listening stream socket before being presented for
384 .Xr accept 2 .
385 Once more,
386 .Xr listen 2
387 must be called on the socket before
388 trying to install the filter on it,
389 or else the
390 .Fn setsockopt
391 system call will fail.
392 .Bd -literal
393 struct  accept_filter_arg {
394         char    af_name[16];
395         char    af_arg[256-16];
396 };
397 .Ed
398 .Pp
399 The
400 .Fa optval
401 argument
402 should point to a
403 .Fa struct accept_filter_arg
404 that will select and configure the
405 .Xr accept_filter 9 .
406 The
407 .Fa af_name
408 argument
409 should be filled with the name of the accept filter
410 that the application wishes to place on the listening socket.
411 The optional argument
412 .Fa af_arg
413 can be passed to the accept
414 filter specified by
415 .Fa af_name
416 to provide additional configuration options at attach time.
417 Passing in an
418 .Fa optval
419 of NULL will remove the filter.
420 .Pp
421 The
422 .Dv SO_NOSIGPIPE
423 option controls generation of the
424 .Dv SIGPIPE
425 signal normally sent
426 when writing to a connected socket where the other end has been
427 closed returns with the error
428 .Er EPIPE .
429 .Pp
430 If the
431 .Dv SO_TIMESTAMP
432 or
433 .Dv SO_BINTIME
434 option is enabled on a
435 .Dv SOCK_DGRAM
436 socket, the
437 .Xr recvmsg 2
438 call may return a timestamp corresponding to when the datagram was received.
439 However, it may not, for example due to a resource shortage.
440 The
441 .Va msg_control
442 field in the
443 .Vt msghdr
444 structure points to a buffer that contains a
445 .Vt cmsghdr
446 structure followed by a
447 .Vt "struct timeval"
448 for
449 .Dv SO_TIMESTAMP
450 and
451 .Vt "struct bintime"
452 for
453 .Dv SO_BINTIME .
454 The
455 .Vt cmsghdr
456 fields have the following values for TIMESTAMP by default:
457 .Bd -literal
458      cmsg_len = CMSG_LEN(sizeof(struct timeval));
459      cmsg_level = SOL_SOCKET;
460      cmsg_type = SCM_TIMESTAMP;
461 .Ed
462 .Pp
463 and for
464 .Dv SO_BINTIME :
465 .Bd -literal
466      cmsg_len = CMSG_LEN(sizeof(struct bintime));
467      cmsg_level = SOL_SOCKET;
468      cmsg_type = SCM_BINTIME;
469 .Ed
470 .Pp
471 Additional timestamp types are available by following
472 .Dv SO_TIMESTAMP
473 with
474 .Dv SO_TS_CLOCK ,
475 which requests a specific timestamp format to be returned instead of
476 .Dv SCM_TIMESTAMP when
477 .Dv SO_TIMESTAMP is enabled.
478 These
479 .Dv SO_TS_CLOCK
480 values are recognized in
481 .Fx :
482 .Bl -column SO_TS_CLOCK -offset indent
483 .It Dv SO_TS_REALTIME_MICRO Ta "realtime (SCM_TIMESTAMP, struct timeval), default"
484 .It Dv SO_TS_BINTIME Ta "realtime (SCM_BINTIME, struct bintime)"
485 .It Dv SO_TS_REALTIME Ta "realtime (SCM_REALTIME, struct timespec)"
486 .It Dv SO_TS_MONOTONIC Ta "monotonic time (SCM_MONOTONIC, struct timespec)"
487 .El
488 .Pp
489 .Dv SO_ACCEPTCONN ,
490 .Dv SO_TYPE ,
491 .Dv SO_PROTOCOL
492 (and its alias
493 .Dv SO_PROTOTYPE )
494 and
495 .Dv SO_ERROR
496 are options used only with
497 .Fn getsockopt .
498 .Dv SO_ACCEPTCONN
499 returns whether the socket is currently accepting connections,
500 that is, whether or not the
501 .Xr listen 2
502 system call was invoked on the socket.
503 .Dv SO_TYPE
504 returns the type of the socket, such as
505 .Dv SOCK_STREAM ;
506 it is useful for servers that inherit sockets on startup.
507 .Dv SO_PROTOCOL
508 returns the protocol number for the socket, for
509 .Dv AF_INET
510 and
511 .Dv AF_INET6
512 address families.
513 .Dv SO_ERROR
514 returns any pending error on the socket and clears
515 the error status.
516 It may be used to check for asynchronous errors on connected
517 datagram sockets or for other asynchronous errors.
518 .Dv SO_RERROR
519 indicates that receive buffer overflows should be handled as errors.
520 Historically receive buffer overflows have been ignored and programs
521 could not tell if they missed messages or messages had been truncated
522 because of overflows.
523 Since programs historically do not expect to get receive overflow errors,
524 this behavior is not the default.
525 .Pp
526 .Dv SO_LABEL
527 returns the MAC label of the socket.
528 .Dv SO_PEERLABEL
529 returns the MAC label of the socket's peer.
530 Note that your kernel must be compiled with MAC support.
531 See
532 .Xr mac 3
533 for more information.
534 .Pp
535 .Dv SO_LISTENQLIMIT
536 returns the maximal number of queued connections, as set by
537 .Xr listen 2 .
538 .Dv SO_LISTENQLEN
539 returns the number of unaccepted complete connections.
540 .Dv SO_LISTENINCQLEN
541 returns the number of unaccepted incomplete connections.
542 .Pp
543 .Dv SO_MAX_PACING_RATE
544 instruct the socket and underlying network adapter layers to limit the
545 transfer rate to the given unsigned 32-bit value in bytes per second.
546 .Pp
547 .Dv SO_NO_OFFLOAD
548 disables support for protocol offloads.
549 At present, this prevents TCP sockets from using TCP offload engines.
550 .Dv SO_NO_DDP
551 disables support for a specific TCP offload known as direct data
552 placement (DDP).
553 DDP is an offload supported by Chelsio network adapters that permits
554 reassembled TCP data streams to be received via zero-copy in
555 user-supplied buffers using
556 .Xr aio_read 2 .
557 .Sh RETURN VALUES
558 .Rv -std
559 .Sh ERRORS
560 The
561 .Fn getsockopt
562 and
563 .Fn setsockopt
564 system calls succeed unless:
565 .Bl -tag -width Er
566 .It Bq Er EBADF
567 The argument
568 .Fa s
569 is not a valid descriptor.
570 .It Bq Er ENOTSOCK
571 The argument
572 .Fa s
573 is a file, not a socket.
574 .It Bq Er ENOPROTOOPT
575 The option is unknown at the level indicated.
576 .It Bq Er EFAULT
577 The address pointed to by
578 .Fa optval
579 is not in a valid part of the process address space.
580 For
581 .Fn getsockopt ,
582 this error may also be returned if
583 .Fa optlen
584 is not in a valid part of the process address space.
585 .It Bq Er EINVAL
586 Installing an
587 .Xr accept_filter 9
588 on a non-listening socket was attempted.
589 .It Bq Er ENOMEM
590 A memory allocation failed that was required to service the request.
591 .El
592 .Pp
593 The
594 .Fn setsockopt
595 system call may also return the following error:
596 .Bl -tag -width Er
597 .It Bq Er ENOBUFS
598 Insufficient resources were available in the system
599 to perform the operation.
600 .El
601 .Sh SEE ALSO
602 .Xr ioctl 2 ,
603 .Xr listen 2 ,
604 .Xr recvmsg 2 ,
605 .Xr socket 2 ,
606 .Xr getprotoent 3 ,
607 .Xr mac 3 ,
608 .Xr sysctl 3 ,
609 .Xr ip 4 ,
610 .Xr ip6 4 ,
611 .Xr sctp 4 ,
612 .Xr tcp 4 ,
613 .Xr protocols 5 ,
614 .Xr sysctl 8 ,
615 .Xr accept_filter 9 ,
616 .Xr bintime 9
617 .Sh HISTORY
618 The
619 .Fn getsockopt
620 and
621 .Fn setsockopt
622 system calls appeared in
623 .Bx 4.2 .
624 .Sh BUGS
625 Several of the socket options should be handled at lower levels of the system.