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$
  34 .\"
  35 .Dd May 2, 1995
  36 .Dt GETSOCKOPT 2
  37 .Os BSD 4.3r
  38 .Sh NAME
  39 .Nm getsockopt ,
  40 .Nm setsockopt
  41 .Nd get and set options on sockets
  42 .Sh SYNOPSIS
  43 .Fd #include <sys/types.h>
  44 .Fd #include <sys/socket.h>
  45 .Ft int
  46 .Fn getsockopt "int s" "int level" "int optname" "void *optval" "int *optlen"
  47 .Ft int
  48 .Fn setsockopt "int s" "int level" "int optname" "const void *optval" "int optlen"
  49 .Sh DESCRIPTION
  50 .Fn Getsockopt
  51 and
  52 .Fn setsockopt
  53 manipulate the
  54 .Em options
  55 associated with a socket.  Options may exist at multiple
  56 protocol levels; they are always present at the uppermost
  57 .Dq socket
  58 level.
  59 .Pp
  60 When manipulating socket options the level at which the
  61 option resides and the name of the option must be specified.
  62 To manipulate options at the socket level,
  63 .Fa level
  64 is specified as
  65 .Dv SOL_SOCKET .
  66 To manipulate options at any
  67 other level the protocol number of the appropriate protocol
  68 controlling the option is supplied.  For example,
  69 to indicate that an option is to be interpreted by the
  70 .Tn TCP
  71 protocol,
  72 .Fa level
  73 should be set to the protocol number of
  74 .Tn TCP ;
  75 see
  76 .Xr getprotoent 3 .
  77 .Pp
  78 The parameters
  79 .Fa optval
  80 and
  81 .Fa optlen
  82 are used to access option values for
  83 .Fn setsockopt .
  84 For
  85 .Fn getsockopt
  86 they identify a buffer in which the value for the
  87 requested option(s) are to be returned.  For
  88 .Fn getsockopt ,
  89 .Fa optlen
  90 is a value-result parameter, initially containing the
  91 size of the buffer pointed to by
  92 .Fa optval ,
  93 and modified on return to indicate the actual size of
  94 the value returned.  If no option value is
  95 to be supplied or returned,
  96 .Fa optval
  97 may be NULL.
  98 .Pp
  99 .Fa Optname
 100 and any specified options are passed uninterpreted to the appropriate
 101 protocol module for interpretation.
 102 The include file
 103 .Ao Pa sys/socket.h Ac
 104 contains definitions for
 105 socket level options, described below.
 106 Options at other protocol levels vary in format and
 107 name; consult the appropriate entries in
 108 section
 109 4 of the manual.
 110 .Pp
 111 Most socket-level options utilize an
 112 .Fa int
 113 parameter for
 114 .Fa optval .
 115 For
 116 .Fn setsockopt ,
 117 the parameter should be non-zero to enable a boolean option,
 118 or zero if the option is to be disabled.
 119 .Dv SO_LINGER
 120 uses a
 121 .Fa struct linger
 122 parameter, defined in
 123 .Ao Pa sys/socket.h Ac ,
 124 which specifies the desired state of the option and the
 125 linger interval (see below).
 126 .Dv SO_SNDTIMEO
 127 and
 128 .Dv SO_RCVTIMEO
 129 use a
 130 .Fa struct timeval
 131 parameter, defined in
 132 .Ao Pa sys/time.h Ac .
 133 .Pp
 134 The following options are recognized at the socket level.
 135 Except as noted, each may be examined with
 136 .Fn getsockopt
 137 and set with
 138 .Fn setsockopt .
 139 .Bl -column SO_OOBINLINE -offset indent
 140 .It Dv SO_DEBUG Ta "enables recording of debugging information"
 141 .It Dv SO_REUSEADDR Ta "enables local address reuse"
 142 .It Dv SO_REUSEPORT Ta "enables duplicate address and port bindings"
 143 .It Dv SO_KEEPALIVE Ta "enables keep connections alive"
 144 .It Dv SO_DONTROUTE Ta "enables routing bypass for outgoing messages"
 145 .It Dv SO_LINGER  Ta "linger on close if data present"
 146 .It Dv SO_BROADCAST Ta "enables permission to transmit broadcast messages"
 147 .It Dv SO_OOBINLINE Ta "enables reception of out-of-band data in band"
 148 .It Dv SO_SNDBUF Ta "set buffer size for output"
 149 .It Dv SO_RCVBUF Ta "set buffer size for input"
 150 .It Dv SO_SNDLOWAT Ta "set minimum count for output"
 151 .It Dv SO_RCVLOWAT Ta "set minimum count for input"
 152 .It Dv SO_SNDTIMEO Ta "set timeout value for output"
 153 .It Dv SO_RCVTIMEO Ta "set timeout value for input"
 154 .It Dv SO_TYPE Ta "get the type of the socket (get only)"
 155 .It Dv SO_ERROR Ta "get and clear error on the socket (get only)"
 156 .El
 157 .Pp
 158 .Dv SO_DEBUG
 159 enables debugging in the underlying protocol modules.
 160 .Dv SO_REUSEADDR
 161 indicates that the rules used in validating addresses supplied
 162 in a
 163 .Xr bind 2
 164 call should allow reuse of local addresses.
 165 .Dv SO_REUSEPORT
 166 allows completely duplicate bindings by multiple processes
 167 if they all set
 168 .Dv SO_REUSEPORT
 169 before binding the port.
 170 This option permits multiple instances of a program to each
 171 receive UDP/IP multicast or broadcast datagrams destined for the bound port.
 172 .Dv SO_KEEPALIVE
 173 enables the
 174 periodic transmission of messages on a connected socket.  Should the
 175 connected party fail to respond to these messages, the connection is
 176 considered broken and processes using the socket are notified via a
 177 .Dv SIGPIPE
 178 signal when attempting to send data.
 179 .Dv SO_DONTROUTE
 180 indicates that outgoing messages should
 181 bypass the standard routing facilities.  Instead, messages are directed
 182 to the appropriate network interface according to the network portion
 183 of the destination address.
 184 .Pp
 185 .Dv SO_LINGER
 186 controls the action taken when unsent messages
 187 are queued on socket and a
 188 .Xr close 2
 189 is performed.
 190 If the socket promises reliable delivery of data and
 191 .Dv SO_LINGER is set,
 192 the system will block the process on the
 193 .Xr close 2
 194 attempt until it is able to transmit the data or until it decides it
 195 is unable to deliver the information (a timeout period, termed the
 196 linger interval, is specified in seconds in the
 197 .Fn setsockopt
 198 call when
 199 .Dv SO_LINGER
 200 is requested).
 201 If
 202 .Dv SO_LINGER
 203 is disabled and a
 204 .Xr close 2
 205 is issued, the system will process the close in a manner that allows
 206 the process to continue as quickly as possible.
 207 .Pp
 208 The option
 209 .Dv SO_BROADCAST
 210 requests permission to send broadcast datagrams
 211 on the socket.
 212 Broadcast was a privileged operation in earlier versions of the system.
 213 With protocols that support out-of-band data, the
 214 .Dv SO_OOBINLINE
 215 option
 216 requests that out-of-band data be placed in the normal data input queue
 217 as received; it will then be accessible with
 218 .Xr recv 2
 219 or
 220 .Xr read 2
 221 calls without the
 222 .Dv MSG_OOB
 223 flag.
 224 Some protocols always behave as if this option is set.
 225 .Dv SO_SNDBUF
 226 and
 227 .Dv SO_RCVBUF
 228 are options to adjust the normal
 229 buffer sizes allocated for output and input buffers, respectively.
 230 The buffer size may be increased for high-volume connections,
 231 or may be decreased to limit the possible backlog of incoming data.
 232 The system places an absolute maximum on these values, which is accessible
 233 through the
 234 .Xr sysctl 3
 235 MIB variable
 236 .Dq Li kern.ipc.maxsockbuf .
 237 .Pp
 238 .Dv SO_SNDLOWAT
 239 is an option to set the minimum count for output operations.
 240 Most output operations process all of the data supplied
 241 by the call, delivering data to the protocol for transmission
 242 and blocking as necessary for flow control.
 243 Nonblocking output operations will process as much data as permitted
 244 subject to flow control without blocking, but will process no data
 245 if flow control does not allow the smaller of the low water mark value
 246 or the entire request to be processed.
 247 A
 248 .Xr select 2
 249 operation testing the ability to write to a socket will return true
 250 only if the low water mark amount could be processed.
 251 The default value for
 252 .Dv SO_SNDLOWAT
 253 is set to a convenient size for network efficiency, often 1024.
 254 .Dv SO_RCVLOWAT
 255 is an option to set the minimum count for input operations.
 256 In general, receive calls will block until any (non-zero) amount of data
 257 is received, then return with the smaller of the amount available or the amount
 258 requested.
 259 The default value for
 260 .Dv SO_RCVLOWAT
 261 is 1.
 262 If
 263 .Dv SO_RCVLOWAT
 264 is set to a larger value, blocking receive calls normally
 265 wait until they have received the smaller of the low water mark value
 266 or the requested amount.
 267 Receive calls may still return less than the low water mark if an error
 268 occurs, a signal is caught, or the type of data next in the receive queue
 269 is different from that which was returned.
 270 .Pp
 271 .Dv SO_SNDTIMEO
 272 is an option to set a timeout value for output operations.
 273 It accepts a
 274 .Fa struct timeval
 275 parameter with the number of seconds and microseconds
 276 used to limit waits for output operations to complete.
 277 If a send operation has blocked for this much time,
 278 it returns with a partial count
 279 or with the error
 280 .Er EWOULDBLOCK
 281 if no data were sent.
 282 In the current implementation, this timer is restarted each time additional
 283 data are delivered to the protocol,
 284 implying that the limit applies to output portions ranging in size
 285 from the low water mark to the high water mark for output.
 286 .Dv SO_RCVTIMEO
 287 is an option to set a timeout value for input operations.
 288 It accepts a
 289 .Fa struct timeval
 290 parameter with the number of seconds and microseconds
 291 used to limit waits for input operations to complete.
 292 In the current implementation, this timer is restarted each time additional
 293 data are received by the protocol,
 294 and thus the limit is in effect an inactivity timer.
 295 If a receive operation has been blocked for this much time without
 296 receiving additional data, it returns with a short count
 297 or with the error
 298 .Er EWOULDBLOCK
 299 if no data were received.
 300 .Pp
 301 Finally,
 302 .Dv SO_TYPE
 303 and
 304 .Dv SO_ERROR
 305 are options used only with
 306 .Fn getsockopt .
 307 .Dv SO_TYPE
 308 returns the type of the socket, such as
 309 .Dv SOCK_STREAM ;
 310 it is useful for servers that inherit sockets on startup.
 311 .Dv SO_ERROR
 312 returns any pending error on the socket and clears
 313 the error status.
 314 It may be used to check for asynchronous errors on connected
 315 datagram sockets or for other asynchronous errors.
 316 .Sh IMPLEMENTATION NOTES
 317 .Pp
 318 In the non-threaded library
 319 .Fn getsockopt
 320 is implemented as the
 321 .Va getsockopt
 322 syscall.
 323 .Pp
 324 In the threaded library, the
 325 .Va getsockopt
 326 syscall is assembled to
 327 .Fn _thread_sys_getsockopt
 328 and
 329 .Fn getsockopt
 330 is implemented as a function which locks
 331 .Va s
 332 for read and write, then calls
 333 .Fn _thread_sys_getsockopt .
 334 Before returning,
 335 .Fn getsockopt
 336 unlocks
 337 .Va s .
 338 .Pp
 339 In the non-threaded library
 340 .Fn setsockopt
 341 is implemented as the
 342 .Va setsockopt
 343 syscall.
 344 .Pp
 345 In the threaded library, the
 346 .Va setsockopt
 347 syscall is assembled to
 348 .Fn _thread_sys_setsockopt
 349 and
 350 .Fn setsockopt
 351 is implemented as a function which locks
 352 .Va s
 353 for read and write, then calls
 354 .Fn _thread_sys_setsockopt .
 355 Before returning,
 356 .Fn setsockopt
 357 unlocks
 358 .Va s .
 359 .Sh RETURN VALUES
 360 A 0 is returned if the call succeeds, -1 if it fails.
 361 .Sh ERRORS
 362 The call succeeds unless:
 363 .Bl -tag -width ENOPROTOOPTAA
 364 .It Bq Er EBADF
 365 The argument
 366 .Fa s
 367 is not a valid descriptor.
 368 .It Bq Er ENOTSOCK
 369 The argument
 370 .Fa s
 371 is a file, not a socket.
 372 .It Bq Er ENOPROTOOPT
 373 The option is unknown at the level indicated.
 374 .It Bq Er EFAULT
 375 The address pointed to by
 376 .Fa optval
 377 is not in a valid part of the process address space.
 378 For
 379 .Fn getsockopt ,
 380 this error may also be returned if
 381 .Fa optlen
 382 is not in a valid part of the process address space.
 383 .El
 384 .Sh SEE ALSO
 385 .Xr ioctl 2 ,
 386 .Xr socket 2 ,
 387 .Xr getprotoent 3 ,
 388 .Xr sysctl 3 ,
 389 .Xr protocols 5 ,
 390 .Xr sysctl 8
 391 .Sh BUGS
 392 Several of the socket options should be handled at lower levels of the system.
 393 .Sh HISTORY
 394 The
 395 .Fn getsockopt
 396 system call appeared in
 397 .Bx 4.2 .