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