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