lib/libc/sys/socket.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. 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 .\"     From: @(#)socket.2      8.1 (Berkeley) 6/4/93
  29 .\"
  30 .Dd January 15, 2023
  31 .Dt SOCKET 2
  32 .Os
  33 .Sh NAME
  34 .Nm socket
  35 .Nd create an endpoint for communication
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/socket.h
  40 .Ft int
  41 .Fn socket "int domain" "int type" "int protocol"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn socket
  45 system call
  46 creates an endpoint for communication and returns a descriptor.
  47 .Pp
  48 The
  49 .Fa domain
  50 argument specifies a communications domain within which
  51 communication will take place; this selects the protocol family
  52 which should be used.
  53 These families are defined in the include file
  54 .In sys/socket.h .
  55 The currently understood formats are:
  56 .Pp
  57 .Bd -literal -offset indent -compact
  58 PF_LOCAL        Host-internal protocols (alias for PF_UNIX),
  59 PF_UNIX         Host-internal protocols,
  60 PF_INET         Internet version 4 protocols,
  61 PF_INET6        Internet version 6 protocols,
  62 PF_DIVERT       Firewall packet diversion/re-injection,
  63 PF_ROUTE        Internal routing protocol,
  64 PF_KEY          Internal key-management function,
  65 PF_NETGRAPH     Netgraph sockets,
  66 PF_NETLINK      Netlink protocols,
  67 PF_BLUETOOTH    Bluetooth protocols,
  68 PF_INET_SDP     OFED socket direct protocol (IPv4),
  69 AF_HYPERV       HyperV sockets
  70 .Ed
  71 .Pp
  72 Each protocol family is connected to an address family, which has the
  73 same name except that the prefix is
  74 .Dq Dv AF_
  75 in place of
  76 .Dq Dv PF_ .
  77 Other protocol families may be also defined, beginning with
  78 .Dq Dv PF_ ,
  79 with corresponding address families.
  80 .Pp
  81 The socket has the indicated
  82 .Fa type ,
  83 which specifies the semantics of communication.
  84 Currently
  85 defined types are:
  86 .Pp
  87 .Bd -literal -offset indent -compact
  88 SOCK_STREAM     Stream socket,
  89 SOCK_DGRAM      Datagram socket,
  90 SOCK_RAW        Raw-protocol interface,
  91 SOCK_SEQPACKET  Sequenced packet stream
  92 .Ed
  93 .Pp
  94 A
  95 .Dv SOCK_STREAM
  96 type provides sequenced, reliable,
  97 two-way connection based byte streams.
  98 An out-of-band data transmission mechanism may be supported.
  99 A
 100 .Dv SOCK_DGRAM
 101 socket supports
 102 datagrams (connectionless, unreliable messages of
 103 a fixed (typically small) maximum length).
 104 A
 105 .Dv SOCK_SEQPACKET
 106 socket may provide a sequenced, reliable,
 107 two-way connection-based data transmission path for datagrams
 108 of fixed maximum length; a consumer may be required to read
 109 an entire packet with each read system call.
 110 This facility may have protocol-specific properties.
 111 .Dv SOCK_RAW
 112 sockets provide access to internal network protocols and interfaces.
 113 The
 114 .Dv SOCK_RAW
 115 type is available only to the super-user and is described in
 116 .Xr ip 4
 117 and
 118 .Xr ip6 4 .
 119 .Pp
 120 Additionally, the following flags are allowed in the
 121 .Fa type
 122 argument:
 123 .Pp
 124 .Bd -literal -offset indent -compact
 125 SOCK_CLOEXEC    Set close-on-exec on the new descriptor,
 126 SOCK_NONBLOCK   Set non-blocking mode on the new socket
 127 .Ed
 128 .Pp
 129 The
 130 .Fa protocol
 131 argument
 132 specifies a particular protocol to be used with the socket.
 133 Normally only a single protocol exists to support a particular
 134 socket type within a given protocol family.
 135 However, it is possible
 136 that many protocols may exist, in which case a particular protocol
 137 must be specified in this manner.
 138 The protocol number to use is
 139 particular to the
 140 .Dq "communication domain"
 141 in which communication
 142 is to take place; see
 143 .Xr protocols 5 .
 144 .Pp
 145 The
 146 .Fa protocol
 147 argument may be set to zero (0) to request the default
 148 implementation of a socket type for the protocol, if any.
 149 .Pp
 150 Sockets of type
 151 .Dv SOCK_STREAM
 152 are full-duplex byte streams, similar
 153 to pipes.
 154 A stream socket must be in a
 155 .Em connected
 156 state before any data may be sent or received
 157 on it.
 158 A connection to another socket is created with a
 159 .Xr connect 2
 160 system call.
 161 Once connected, data may be transferred using
 162 .Xr read 2
 163 and
 164 .Xr write 2
 165 calls or some variant of the
 166 .Xr send 2
 167 and
 168 .Xr recv 2
 169 functions.
 170 (Some protocol families, such as the Internet family,
 171 support the notion of an
 172 .Dq implied connect ,
 173 which permits data to be sent piggybacked onto a connect operation by
 174 using the
 175 .Xr sendto 2
 176 system call.)
 177 When a session has been completed a
 178 .Xr close 2
 179 may be performed.
 180 Out-of-band data may also be transmitted as described in
 181 .Xr send 2
 182 and received as described in
 183 .Xr recv 2 .
 184 .Pp
 185 The communications protocols used to implement a
 186 .Dv SOCK_STREAM
 187 ensure that data
 188 is not lost or duplicated.
 189 If a piece of data for which the
 190 peer protocol has buffer space cannot be successfully transmitted
 191 within a reasonable length of time, then
 192 the connection is considered broken and calls
 193 will indicate an error with
 194 -1 returns and with
 195 .Er ETIMEDOUT
 196 as the specific code
 197 in the global variable
 198 .Va errno .
 199 The protocols optionally keep sockets
 200 .Dq warm
 201 by forcing transmissions
 202 roughly every minute in the absence of other activity.
 203 An error is then indicated if no response can be
 204 elicited on an otherwise
 205 idle connection for an extended period (e.g.\& 5 minutes).
 206 By default, a
 207 .Dv SIGPIPE
 208 signal is raised if a process sends
 209 on a broken stream, but this behavior may be inhibited via
 210 .Xr setsockopt 2 .
 211 .Pp
 212 .Dv SOCK_SEQPACKET
 213 sockets employ the same system calls
 214 as
 215 .Dv SOCK_STREAM
 216 sockets.
 217 The only difference
 218 is that
 219 .Xr read 2
 220 calls will return only the amount of data requested,
 221 and any remaining in the arriving packet will be discarded.
 222 .Pp
 223 .Dv SOCK_DGRAM
 224 and
 225 .Dv SOCK_RAW
 226 sockets allow sending of datagrams to correspondents
 227 named in
 228 .Xr send 2
 229 calls.
 230 Datagrams are generally received with
 231 .Xr recvfrom 2 ,
 232 which returns the next datagram with its return address.
 233 .Pp
 234 An
 235 .Xr fcntl 2
 236 system call can be used to specify a process group to receive
 237 a
 238 .Dv SIGURG
 239 signal when the out-of-band data arrives.
 240 It may also enable non-blocking I/O
 241 and asynchronous notification of I/O events
 242 via
 243 .Dv SIGIO .
 244 .Pp
 245 The operation of sockets is controlled by socket level
 246 .Em options .
 247 These options are defined in the file
 248 .In sys/socket.h .
 249 The
 250 .Xr setsockopt 2
 251 and
 252 .Xr getsockopt 2
 253 system calls are used to set and get options, respectively.
 254 .Sh RETURN VALUES
 255 A -1 is returned if an error occurs, otherwise the return
 256 value is a descriptor referencing the socket.
 257 .Sh ERRORS
 258 The
 259 .Fn socket
 260 system call fails if:
 261 .Bl -tag -width Er
 262 .It Bq Er EACCES
 263 Permission to create a socket of the specified type and/or protocol
 264 is denied.
 265 .It Bq Er EAFNOSUPPORT
 266 The address family (domain) is not supported or the
 267 specified domain is not supported by this protocol family.
 268 .It Bq Er EMFILE
 269 The per-process descriptor table is full.
 270 .It Bq Er ENFILE
 271 The system file table is full.
 272 .It Bq Er ENOBUFS
 273 Insufficient buffer space is available.
 274 The socket cannot be created until sufficient resources are freed.
 275 .It Bq Er EPERM
 276 User has insufficient privileges to carry out the requested operation.
 277 .It Bq Er EPROTONOSUPPORT
 278 The protocol type or the specified protocol is not supported
 279 within this domain.
 280 .It Bq Er EPROTOTYPE
 281 The socket type is not supported by the protocol.
 282 .El
 283 .Sh SEE ALSO
 284 .Xr accept 2 ,
 285 .Xr bind 2 ,
 286 .Xr connect 2 ,
 287 .Xr divert 4 ,
 288 .Xr getpeername 2 ,
 289 .Xr getsockname 2 ,
 290 .Xr getsockopt 2 ,
 291 .Xr ioctl 2 ,
 292 .Xr ip 4 ,
 293 .Xr ip6 4 ,
 294 .Xr listen 2 ,
 295 .Xr read 2 ,
 296 .Xr recv 2 ,
 297 .Xr select 2 ,
 298 .Xr send 2 ,
 299 .Xr shutdown 2 ,
 300 .Xr socketpair 2 ,
 301 .Xr write 2 ,
 302 .Xr CMSG_DATA 3 ,
 303 .Xr getprotoent 3 ,
 304 .Xr netgraph 4 ,
 305 .Xr protocols 5
 306 .Rs
 307 .%T "An Introductory 4.3 BSD Interprocess Communication Tutorial"
 308 .%B PS1
 309 .%N 7
 310 .Re
 311 .Rs
 312 .%T "BSD Interprocess Communication Tutorial"
 313 .%B PS1
 314 .%N 8
 315 .Re
 316 .Sh STANDARDS
 317 The
 318 .Fn socket
 319 function conforms to
 320 .St -p1003.1-2008 .
 321 The
 322 .Tn POSIX
 323 standard specifies only the
 324 .Dv AF_INET ,
 325 .Dv AF_INET6 ,
 326 and
 327 .Dv AF_UNIX
 328 constants for address families, and requires the use of
 329 .Dv AF_*
 330 constants for the
 331 .Fa domain
 332 argument of
 333 .Fn socket .
 334 The
 335 .Dv SOCK_CLOEXEC
 336 flag is expected to conform to the next revision of the
 337 .Tn POSIX
 338 standard.
 339 The
 340 .Dv SOCK_RDM
 341 .Fa type ,
 342 the
 343 .Dv PF_*
 344 constants, and other address families are
 345 .Fx
 346 extensions.
 347 .Sh HISTORY
 348 The
 349 .Fn socket
 350 system call appeared in
 351 .Bx 4.2 .