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