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