man2/getsockopt.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     $Id: getsockopt.2,v 1.1 1999/05/24 14:57:04 freitag Exp $
  35 .\"
  36 .\" Modified Sat Jul 24 16:19:32 1993 by Rik Faith (faith@cs.unc.edu)
  37 .\" Modified Mon Apr 22 02:29:06 1996 by Martin Schulze (joey@infodrom.north.de)
  38 .\" Modified Tue Aug 27 10:52:51 1996 by Andries Brouwer (aeb@cwi.nl)
  39 .\" Modified Thu Jan 23 13:29:34 1997 by Andries Brouwer (aeb@cwi.nl)
  40 .\" Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer (aeb@cwi.nl)
  41 .\" Modified 1999 by Andi Kleen <ak@muc.de>.
  42 .\"     Removed most stuff because it is in socket.7 now.
  43 .\"
  44 .TH GETSOCKOPT 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  45 .SH NAME
  46 getsockopt, setsockopt \- get and set options on sockets
  47 .SH SYNOPSIS
  48 .nf
  49 .B #include <sys/socket.h>
  50 .PP
  51 .BI "int getsockopt(int " sockfd ", int " level ", int " optname ,
  52 .BI "               void *restrict " optval ", socklen_t *restrict " optlen );
  53 .BI "int setsockopt(int " sockfd ", int " level ", int " optname ,
  54 .BI "               const void *" optval ", socklen_t " optlen );
  55 .fi
  56 .SH DESCRIPTION
  57 .BR getsockopt ()
  58 and
  59 .BR setsockopt ()
  60 manipulate options for the socket referred to by the file descriptor
  61 .IR sockfd .
  62 Options may exist at multiple
  63 protocol levels; they are always present at the uppermost
  64 socket level.
  65 .PP
  66 When manipulating socket options, the level at which the
  67 option resides and the name of the option must be specified.
  68 To manipulate options at the sockets API level,
  69 .I level
  70 is specified as
  71 .BR SOL_SOCKET .
  72 To manipulate options at any
  73 other level the protocol number of the appropriate protocol
  74 controlling the option is supplied.
  75 For example,
  76 to indicate that an option is to be interpreted by the
  77 .B TCP
  78 protocol,
  79 .I level
  80 should be set to the protocol number of
  81 .BR TCP ;
  82 see
  83 .BR getprotoent (3).
  84 .PP
  85 The arguments
  86 .I optval
  87 and
  88 .I optlen
  89 are used to access option values for
  90 .BR setsockopt ().
  91 For
  92 .BR getsockopt ()
  93 they identify a buffer in which the value for the
  94 requested option(s) are to be returned.
  95 For
  96 .BR getsockopt (),
  97 .I optlen
  98 is a value-result argument, initially containing the
  99 size of the buffer pointed to by
 100 .IR optval ,
 101 and modified on return to indicate the actual size of
 102 the value returned.
 103 If no option value is to be supplied or returned,
 104 .I optval
 105 may be NULL.
 106 .PP
 107 .I Optname
 108 and any specified options are passed uninterpreted to the appropriate
 109 protocol module for interpretation.
 110 The include file
 111 .I <sys/socket.h>
 112 contains definitions for socket level options, described below.
 113 Options at
 114 other protocol levels vary in format and name; consult the appropriate
 115 entries in section 4 of the manual.
 116 .PP
 117 Most socket-level options utilize an
 118 .I int
 119 argument for
 120 .IR optval .
 121 For
 122 .BR setsockopt (),
 123 the argument should be nonzero to enable a boolean option, or zero if the
 124 option is to be disabled.
 125 .PP
 126 For a description of the available socket options see
 127 .BR socket (7)
 128 and the appropriate protocol man pages.
 129 .SH RETURN VALUE
 130 On success, zero is returned for the standard options.
 131 On error, \-1 is returned, and
 132 .I errno
 133 is set to indicate the error.
 134 .PP
 135 Netfilter allows the programmer
 136 to define custom socket options with associated handlers; for such
 137 options, the return value on success is the value returned by the handler.
 138 .SH ERRORS
 139 .TP
 140 .B EBADF
 141 The argument
 142 .I sockfd
 143 is not a valid file descriptor.
 144 .TP
 145 .B EFAULT
 146 The address pointed to by
 147 .I optval
 148 is not in a valid part of the process address space.
 149 For
 150 .BR getsockopt (),
 151 this error may also be returned if
 152 .I optlen
 153 is not in a valid part of the process address space.
 154 .TP
 155 .B EINVAL
 156 .I optlen
 157 invalid in
 158 .BR setsockopt ().
 159 In some cases this error can also occur for an invalid value in
 160 .IR optval
 161 (e.g., for the
 162 .B IP_ADD_MEMBERSHIP
 163 option described in
 164 .BR ip (7)).
 165 .TP
 166 .B ENOPROTOOPT
 167 The option is unknown at the level indicated.
 168 .TP
 169 .B ENOTSOCK
 170 The file descriptor
 171 .I sockfd
 172 does not refer to a socket.
 173 .SH CONFORMING TO
 174 POSIX.1-2001, POSIX.1-2008,
 175 SVr4, 4.4BSD (these system calls first appeared in 4.2BSD).
 176 .\" SVr4 documents additional ENOMEM and ENOSR error codes, but does
 177 .\" not document the
 178 .\" .BR SO_SNDLOWAT ", " SO_RCVLOWAT ", " SO_SNDTIMEO ", " SO_RCVTIMEO
 179 .\" options
 180 .SH NOTES
 181 For background on the
 182 .I socklen_t
 183 type, see
 184 .BR accept (2).
 185 .SH BUGS
 186 Several of the socket options should be handled at lower levels of the
 187 system.
 188 .SH SEE ALSO
 189 .BR ioctl (2),
 190 .BR socket (2),
 191 .BR getprotoent (3),
 192 .BR protocols (5),
 193 .BR ip (7),
 194 .BR packet (7),
 195 .BR socket (7),
 196 .BR tcp (7),
 197 .BR udp (7),
 198 .BR unix (7)