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