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