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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)getsockopt.2        8.4 (Berkeley) 5/2/95
  33 .\" $FreeBSD: src/lib/libc/sys/getsockopt.2,v 1.12.2.11 2002/01/09 17:44:15 yar Exp $
  34 .\"
  35 .Dd May 2, 1995
  36 .Dt GETSOCKOPT 2
  37 .Os
  38 .Sh NAME
  39 .Nm getsockopt ,
  40 .Nm setsockopt
  41 .Nd get and set options on sockets
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In sys/socket.h
  47 .Ft int
  48 .Fn getsockopt "int s" "int level" "int optname" "void *optval" "socklen_t *optlen"
  49 .Ft int
  50 .Fn setsockopt "int s" "int level" "int optname" "const void *optval" "socklen_t optlen"
  51 .Sh DESCRIPTION
  52 .Fn Getsockopt
  53 and
  54 .Fn setsockopt
  55 manipulate the
  56 .Em options
  57 associated with a socket.  Options may exist at multiple
  58 protocol levels; they are always present at the uppermost
  59 .Dq socket
  60 level.
  61 .Pp
  62 When manipulating socket options the level at which the
  63 option resides and the name of the option must be specified.
  64 To manipulate options at the socket level,
  65 .Fa level
  66 is specified as
  67 .Dv SOL_SOCKET .
  68 To manipulate options at any
  69 other level the protocol number of the appropriate protocol
  70 controlling the option is supplied.  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 parameters
  81 .Fa optval
  82 and
  83 .Fa optlen
  84 are used to access option values for
  85 .Fn setsockopt .
  86 For
  87 .Fn getsockopt
  88 they identify a buffer in which the value for the
  89 requested option(s) are to be returned.  For
  90 .Fn getsockopt ,
  91 .Fa optlen
  92 is a value-result parameter, initially containing the
  93 size of the buffer pointed to by
  94 .Fa optval ,
  95 and modified on return to indicate the actual size of
  96 the value returned.  If no option value is
  97 to be supplied or returned,
  98 .Fa optval
  99 may be NULL.
 100 .Pp
 101 .Fa Optname
 102 and any specified options are passed uninterpreted to the appropriate
 103 protocol module for interpretation.
 104 The include file
 105 .Ao Pa sys/socket.h Ac
 106 contains definitions for
 107 socket level options, described below.
 108 Options at other protocol levels vary in format and
 109 name; consult the appropriate entries in
 110 section
 111 4 of the manual.
 112 .Pp
 113 Most socket-level options utilize an
 114 .Fa int
 115 parameter for
 116 .Fa optval .
 117 For
 118 .Fn setsockopt ,
 119 the parameter should be non-zero to enable a boolean option,
 120 or zero if the option is to be disabled.
 121 .Dv SO_LINGER
 122 uses a
 123 .Fa struct linger
 124 parameter, defined in
 125 .Ao Pa sys/socket.h Ac ,
 126 which specifies the desired state of the option and the
 127 linger interval (see below).
 128 .Dv SO_SNDTIMEO
 129 and
 130 .Dv SO_RCVTIMEO
 131 use a
 132 .Fa struct timeval
 133 parameter, defined in
 134 .Ao Pa sys/time.h Ac .
 135 .Pp
 136 The following options are recognized at the socket level.
 137 Except as noted, each may be examined with
 138 .Fn getsockopt
 139 and set with
 140 .Fn setsockopt .
 141 .Bl -column SO_ACCEPTFILTER -offset indent
 142 .It Dv SO_DEBUG Ta "enables recording of debugging information"
 143 .It Dv SO_REUSEADDR Ta "enables local address reuse"
 144 .It Dv SO_REUSEPORT Ta "enables duplicate address and port bindings"
 145 .It Dv SO_KEEPALIVE Ta "enables keep connections alive"
 146 .It Dv SO_DONTROUTE Ta "enables routing bypass for outgoing messages"
 147 .It Dv SO_LINGER  Ta "linger on close if data present"
 148 .It Dv SO_BROADCAST Ta "enables permission to transmit broadcast messages"
 149 .It Dv SO_OOBINLINE Ta "enables reception of out-of-band data in band"
 150 .It Dv SO_SNDBUF Ta "set buffer size for output"
 151 .It Dv SO_RCVBUF Ta "set buffer size for input"
 152 .It Dv SO_SNDLOWAT Ta "set minimum count for output"
 153 .It Dv SO_RCVLOWAT Ta "set minimum count for input"
 154 .It Dv SO_SNDTIMEO Ta "set timeout value for output"
 155 .It Dv SO_RCVTIMEO Ta "set timeout value for input"
 156 .It Dv SO_ACCEPTFILTER Ta "set accept filter on listening socket"
 157 .It Dv SO_TYPE Ta "get the type of the socket (get only)"
 158 .It Dv SO_ERROR Ta "get and clear error on the socket (get only)"
 159 .El
 160 .Pp
 161 .Dv SO_DEBUG
 162 enables debugging in the underlying protocol modules.
 163 .Dv SO_REUSEADDR
 164 indicates that the rules used in validating addresses supplied
 165 in a
 166 .Xr bind 2
 167 call should allow reuse of local addresses.
 168 .Dv SO_REUSEPORT
 169 allows completely duplicate bindings by multiple processes
 170 if they all set
 171 .Dv SO_REUSEPORT
 172 before binding the port.
 173 This option permits multiple instances of a program to each
 174 receive UDP/IP multicast or broadcast datagrams destined for the bound port.
 175 .Dv SO_KEEPALIVE
 176 enables the
 177 periodic transmission of messages on a connected socket.  Should the
 178 connected party fail to respond to these messages, the connection is
 179 considered broken and processes using the socket are notified via a
 180 .Dv SIGPIPE
 181 signal when attempting to send data.
 182 .Dv SO_DONTROUTE
 183 indicates that outgoing messages should
 184 bypass the standard routing facilities.  Instead, messages are directed
 185 to the appropriate network interface according to the network portion
 186 of the destination address.
 187 .Pp
 188 .Dv SO_LINGER
 189 controls the action taken when unsent messages
 190 are queued on socket and a
 191 .Xr close 2
 192 is performed.
 193 If the socket promises reliable delivery of data and
 194 .Dv SO_LINGER
 195 is set,
 196 the system will block the process on the
 197 .Xr close 2
 198 attempt until it is able to transmit the data or until it decides it
 199 is unable to deliver the information (a timeout period, termed the
 200 linger interval, is specified in seconds in the
 201 .Fn setsockopt
 202 call when
 203 .Dv SO_LINGER
 204 is requested).
 205 If
 206 .Dv SO_LINGER
 207 is disabled and a
 208 .Xr close 2
 209 is issued, the system will process the close in a manner that allows
 210 the process to continue as quickly as possible.
 211 .Pp
 212 The option
 213 .Dv SO_BROADCAST
 214 requests permission to send broadcast datagrams
 215 on the socket.
 216 Broadcast was a privileged operation in earlier versions of the system.
 217 With protocols that support out-of-band data, the
 218 .Dv SO_OOBINLINE
 219 option
 220 requests that out-of-band data be placed in the normal data input queue
 221 as received; it will then be accessible with
 222 .Xr recv 2
 223 or
 224 .Xr read 2
 225 calls without the
 226 .Dv MSG_OOB
 227 flag.
 228 Some protocols always behave as if this option is set.
 229 .Dv SO_SNDBUF
 230 and
 231 .Dv SO_RCVBUF
 232 are options to adjust the normal
 233 buffer sizes allocated for output and input buffers, respectively.
 234 The buffer size may be increased for high-volume connections,
 235 or may be decreased to limit the possible backlog of incoming data.
 236 The system places an absolute maximum on these values, which is accessible
 237 through the
 238 .Xr sysctl 3
 239 MIB variable
 240 .Dq Li kern.ipc.maxsockbuf .
 241 .Pp
 242 .Dv SO_SNDLOWAT
 243 is an option to set the minimum count for output operations.
 244 Most output operations process all of the data supplied
 245 by the call, delivering data to the protocol for transmission
 246 and blocking as necessary for flow control.
 247 Nonblocking output operations will process as much data as permitted
 248 subject to flow control without blocking, but will process no data
 249 if flow control does not allow the smaller of the low water mark value
 250 or the entire request to be processed.
 251 A
 252 .Xr select 2
 253 operation testing the ability to write to a socket will return true
 254 only if the low water mark amount could be processed.
 255 The default value for
 256 .Dv SO_SNDLOWAT
 257 is set to a convenient size for network efficiency, often 1024.
 258 .Dv SO_RCVLOWAT
 259 is an option to set the minimum count for input operations.
 260 In general, receive calls will block until any (non-zero) amount of data
 261 is received, then return with the smaller of the amount available or the amount
 262 requested.
 263 The default value for
 264 .Dv SO_RCVLOWAT
 265 is 1.
 266 If
 267 .Dv SO_RCVLOWAT
 268 is set to a larger value, blocking receive calls normally
 269 wait until they have received the smaller of the low water mark value
 270 or the requested amount.
 271 Receive calls may still return less than the low water mark if an error
 272 occurs, a signal is caught, or the type of data next in the receive queue
 273 is different from that which was returned.
 274 .Pp
 275 .Dv SO_SNDTIMEO
 276 is an option to set a timeout value for output operations.
 277 It accepts a
 278 .Fa struct timeval
 279 parameter with the number of seconds and microseconds
 280 used to limit waits for output operations to complete.
 281 If a send operation has blocked for this much time,
 282 it returns with a partial count
 283 or with the error
 284 .Er EWOULDBLOCK
 285 if no data were sent.
 286 In the current implementation, this timer is restarted each time additional
 287 data are delivered to the protocol,
 288 implying that the limit applies to output portions ranging in size
 289 from the low water mark to the high water mark for output.
 290 .Dv SO_RCVTIMEO
 291 is an option to set a timeout value for input operations.
 292 It accepts a
 293 .Fa struct timeval
 294 parameter with the number of seconds and microseconds
 295 used to limit waits for input operations to complete.
 296 In the current implementation, this timer is restarted each time additional
 297 data are received by the protocol,
 298 and thus the limit is in effect an inactivity timer.
 299 If a receive operation has been blocked for this much time without
 300 receiving additional data, it returns with a short count
 301 or with the error
 302 .Er EWOULDBLOCK
 303 if no data were received.
 304 .Pp
 305 .Dv SO_ACCEPTFILTER
 306 places an
 307 .Xr accept_filter 9
 308 on the socket,
 309 which will filter incoming connections
 310 on a listening stream socket before being presented for
 311 .Xr accept 2 .
 312 Once more,
 313 .Xr listen 2
 314 must be called on the socket before
 315 trying to install the filter on it,
 316 or else the
 317 .Fn setsockopt
 318 call will fail.
 319 .Bd -literal
 320 struct  accept_filter_arg {
 321         char    af_name[16];
 322         char    af_arg[256-16];
 323 };
 324 .Ed
 325 .Pp
 326 .Fa optval
 327 should point to a
 328 .Fa struct accept_filter_arg
 329 that will select and configure the
 330 .Xr accept_filter 9 .
 331 .Fa af_name
 332 should be filled with the name of the accept filter
 333 that the application wishes to place on the listening socket.
 334 .Fa af_arg
 335 is an optional parameter that can be passed to the accept
 336 filter specified by
 337 .Fa af_name
 338 to provide additional configuration options at attach time.
 339 Passing in an
 340 .Fa optval
 341 of NULL will remove the filter.
 342 .Pp
 343 Finally,
 344 .Dv SO_TYPE
 345 and
 346 .Dv SO_ERROR
 347 are options used only with
 348 .Fn getsockopt .
 349 .Dv SO_TYPE
 350 returns the type of the socket, such as
 351 .Dv SOCK_STREAM ;
 352 it is useful for servers that inherit sockets on startup.
 353 .Dv SO_ERROR
 354 returns any pending error on the socket and clears
 355 the error status.
 356 It may be used to check for asynchronous errors on connected
 357 datagram sockets or for other asynchronous errors.
 358 .Sh RETURN VALUES
 359 .Rv -std
 360 .Sh ERRORS
 361 The call succeeds unless:
 362 .Bl -tag -width Er
 363 .It Bq Er EBADF
 364 The argument
 365 .Fa s
 366 is not a valid descriptor.
 367 .It Bq Er ENOTSOCK
 368 The argument
 369 .Fa s
 370 is a file, not a socket.
 371 .It Bq Er ENOPROTOOPT
 372 The option is unknown at the level indicated.
 373 .It Bq Er EFAULT
 374 The address pointed to by
 375 .Fa optval
 376 is not in a valid part of the process address space.
 377 For
 378 .Fn getsockopt ,
 379 this error may also be returned if
 380 .Fa optlen
 381 is not in a valid part of the process address space.
 382 .It Bq Er EINVAL
 383 Installing an
 384 .Xr accept_filter 9
 385 on a non-listening socket was attempted.
 386 .El
 387 .Sh SEE ALSO
 388 .Xr ioctl 2 ,
 389 .Xr socket 2 ,
 390 .Xr getprotoent 3 ,
 391 .Xr sysctl 3 ,
 392 .Xr protocols 5 ,
 393 .Xr sysctl 8 ,
 394 .Xr accept_filter 9
 395 .Sh BUGS
 396 Several of the socket options should be handled at lower levels of the system.
 397 .Sh HISTORY
 398 The
 399 .Fn getsockopt
 400 system call appeared in
 401 .Bx 4.2 .