socket/socketpair: Add SOCK_{NONBLOCK,CLOEXEC} support.
[dragonfly.git] / 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 .\" $FreeBSD: src/lib/libc/sys/socket.2,v 1.12.2.11 2002/12/29 16:35:34 schweikh Exp $
30 .\"
31 .Dd October 28, 2015
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 .Fn Socket
46 creates an endpoint for communication and returns a descriptor.
47 .Pp
48 The
49 .Fa domain
50 parameter 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, formerly called PF_UNIX,
59 PF_UNIX         Host-internal protocols, deprecated, use PF_LOCAL,
60 PF_INET         Internet version 4 protocols,
61 PF_IMPLINK      ARPAnet IMP addresses,
62 PF_PUP          PUP protocols, like BSP,
63 PF_CHAOS        MIT CHAOS protocols,
64 PF_NS           Xerox Network Systems protocols,
65 PF_ISO          ISO protocols,
66 PF_OSI          Open Systems Interconnection protocols,
67 PF_ECMA         European Computer Manufacturers,
68 PF_DATAKIT      Datakit protocols,
69 PF_CCITT        ITU-T protocols, like X.25,
70 PF_SNA          IBM SNA,
71 PF_DECnet       DECnet,
72 PF_DLI          DEC Direct Data Link Interface protocol,
73 PF_LAT          LAT protocol,
74 PF_HYLINK       NSC Hyperchannel,
75 PF_ROUTE        Internal Routing protocol,
76 PF_LINK         Link layer interface,
77 PF_XTP          eXpress Transfer Protocol,
78 PF_COIP         Connection-Oriented IP, aka ST II,
79 PF_CNT          Computer Network Technology,
80 PF_SIP          Simple Internet Protocol,
81 PF_IPX          Novell Internet Packet eXchange protocol,
82 PF_RTIP         Help Identify RTIP packets,
83 PF_PIP          Help Identify PIP packets,
84 PF_ISDN         Integrated Services Digital Network,
85 PF_KEY          Internal key-management function,
86 PF_INET6        Internet version 6 protocols,
87 PF_NATM         Native ATM access,
88 PF_ATM          ATM,
89 PF_NETGRAPH     Netgraph sockets
90 .Ed
91 .Pp
92 The socket has the indicated
93 .Fa type ,
94 which specifies the semantics of communication.  Currently
95 defined types are:
96 .Pp
97 .Bd -literal -offset indent -compact
98 SOCK_STREAM     Stream socket,
99 SOCK_DGRAM      Datagram socket,
100 SOCK_RAW        Raw-protocol interface,
101 SOCK_RDM        Reliably-delivered packet,
102 SOCK_SEQPACKET  Sequenced packet stream
103 .Ed
104 .Pp
105 A
106 .Dv SOCK_STREAM
107 type provides sequenced, reliable,
108 two-way connection based byte streams.
109 An out-of-band data transmission mechanism may be supported.
110 A
111 .Dv SOCK_DGRAM
112 socket supports
113 datagrams (connectionless, unreliable messages of
114 a fixed (typically small) maximum length).
115 A
116 .Dv SOCK_SEQPACKET
117 socket may provide a sequenced, reliable,
118 two-way connection-based data transmission path for datagrams
119 of fixed maximum length; a consumer may be required to read
120 an entire packet with each read system call.
121 This facility is protocol specific, and presently implemented
122 only for
123 .Dv PF_NS
124 and
125 .Dv PF_UNIX .
126 .Dv SOCK_RAW
127 sockets provide access to internal network protocols and interfaces.
128 The types
129 .Dv SOCK_RAW ,
130 which is available only to the super-user, and
131 .Dv SOCK_RDM ,
132 which is planned,
133 but not yet implemented, are not described here.
134 .Pp
135 Additionally, the following flags are allowed in the
136 .Fa type
137 argument:
138 .Pp
139 .Bd -literal -offset indent -compact
140 SOCK_CLOEXEC   Set close-on-exec on the new descriptor,
141 SOCK_NONBLOCK  Set non-blocking mode on the new socket
142 .Ed
143 .Pp
144 The
145 .Fa protocol
146 specifies a particular protocol to be used with the socket.
147 Normally only a single protocol exists to support a particular
148 socket type within a given protocol family.  However, it is possible
149 that many protocols may exist, in which case a particular protocol
150 must be specified in this manner.  The protocol number to use is
151 particular to the
152 .Dq "communication domain"
153 in which communication
154 is to take place; see
155 .Xr protocols 5 .
156 .Pp
157 Sockets of type
158 .Dv SOCK_STREAM
159 are full-duplex byte streams, similar
160 to pipes.  A stream socket must be in a
161 .Em connected
162 state before any data may be sent or received
163 on it.  A connection to another socket is created with a
164 .Xr connect 2
165 call.
166 Once connected, data may be transferred using
167 .Xr read 2
168 and
169 .Xr write 2
170 calls or some variant of the
171 .Xr send 2
172 and
173 .Xr recv 2
174 calls.
175 (Some protocol families, such as the Internet family,
176 support the notion of an
177 .Dq implied connect ,
178 which permits data to be sent piggybacked onto a connect operation by
179 using the
180 .Xr sendto 2
181 call.)
182 When a session has been completed a
183 .Xr close 2
184 may be performed.
185 Out-of-band data may also be transmitted as described in
186 .Xr send 2
187 and received as described in
188 .Xr recv 2 .
189 .Pp
190 The communications protocols used to implement a
191 .Dv SOCK_STREAM
192 insure that data
193 is not lost or duplicated.  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 A
211 .Dv SIGPIPE
212 signal is raised if a process sends
213 on a broken stream; this causes naive processes,
214 which do not handle the signal, to exit.
215 .Pp
216 .Dv SOCK_SEQPACKET
217 sockets employ the same system calls
218 as
219 .Dv SOCK_STREAM
220 sockets.  The only difference
221 is that
222 .Xr read 2
223 calls will return only the amount of data requested,
224 and any remaining in the arriving packet will be discarded.
225 .Pp
226 .Dv SOCK_DGRAM
227 and
228 .Dv SOCK_RAW
229 sockets allow sending of datagrams to correspondents
230 named in
231 .Xr send 2
232 calls.  Datagrams are generally received with
233 .Xr recvfrom 2 ,
234 which returns the next datagram with its return address.
235 .Pp
236 An
237 .Xr fcntl 2
238 call can be used to specify a process group to receive
239 a
240 .Dv SIGURG
241 signal when the out-of-band data arrives.
242 It may also enable non-blocking I/O
243 and asynchronous notification of I/O events
244 via
245 .Dv SIGIO .
246 .Pp
247 The operation of sockets is controlled by socket level
248 .Em options .
249 These options are defined in the file
250 .In sys/socket.h .
251 .Xr Setsockopt 2
252 and
253 .Xr getsockopt 2
254 are used to set and get options, respectively.
255 .Sh RETURN VALUES
256 Upon successful completion
257 .Fn socket
258 returns a descriptor referencing the socket.
259 Otherwise, -1 is returned and the global variable
260 .Va errno
261 is set to indicate the error.
262 .Sh ERRORS
263 The
264 .Fn socket
265 call fails if:
266 .Bl -tag -width Er
267 .It Bq Er EPROTONOSUPPORT
268 The protocol type or the specified protocol is not supported
269 within this domain.
270 .It Bq Er EMFILE
271 The per-process descriptor table is full.
272 .It Bq Er ENFILE
273 The system file table is full.
274 .It Bq Er EACCES
275 Permission to create a socket of the specified type and/or protocol
276 is denied.
277 .It Bq Er ENOBUFS
278 Insufficient buffer space is available.
279 The socket cannot be created until sufficient resources are freed.
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 function call appeared in
314 .Bx 4.2 .