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