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