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