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