send(2) - Add MSG_NOSIGNAL flag.
[dragonfly.git] / sys / sys / socket.h
CommitLineData
984263bc
MD
1/*
2 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
4 *
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 *
33 * @(#)socket.h 8.4 (Berkeley) 2/21/94
34 * $FreeBSD: src/sys/sys/socket.h,v 1.39.2.7 2001/07/03 11:02:01 ume Exp $
35 */
36
37#ifndef _SYS_SOCKET_H_
38#define _SYS_SOCKET_H_
39
c8b3626a
SW
40#include <sys/_iovec.h>
41
03d6a592
MD
42#ifndef _SYS_TYPES_H_
43#include <sys/types.h>
44#endif
e2565a42
MD
45#ifndef _MACHINE_STDINT_H_
46#include <machine/stdint.h>
47#endif
48
984263bc
MD
49#define _NO_NAMESPACE_POLLUTION
50#include <machine/param.h>
51#undef _NO_NAMESPACE_POLLUTION
52
53/*
54 * Definitions related to sockets: types, address families, options.
55 */
56
57/*
58 * Data types.
59 */
e2565a42
MD
60typedef __uint8_t sa_family_t;
61
a81b3ef3
JR
62#ifndef _SOCKLEN_T_DECLARED
63#define _SOCKLEN_T_DECLARED
e2565a42 64typedef __socklen_t socklen_t;
984263bc 65#endif
e2565a42 66
984263bc
MD
67
68/*
69 * Types
70 */
71#define SOCK_STREAM 1 /* stream socket */
72#define SOCK_DGRAM 2 /* datagram socket */
73#define SOCK_RAW 3 /* raw-protocol interface */
74#define SOCK_RDM 4 /* reliably-delivered message */
75#define SOCK_SEQPACKET 5 /* sequenced packet stream */
76
77/*
78 * Option flags per-socket.
79 */
80#define SO_DEBUG 0x0001 /* turn on debugging info recording */
81#define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
82#define SO_REUSEADDR 0x0004 /* allow local address reuse */
83#define SO_KEEPALIVE 0x0008 /* keep connections alive */
84#define SO_DONTROUTE 0x0010 /* just use interface addresses */
85#define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
86#define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
87#define SO_LINGER 0x0080 /* linger on close if data present */
88#define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
89#define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
90#define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
2a0c7c52 91#define SO_UNUSED0800 0x0800
984263bc
MD
92#define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */
93
94/*
95 * Additional options, not kept in so_options.
96 */
97#define SO_SNDBUF 0x1001 /* send buffer size */
98#define SO_RCVBUF 0x1002 /* receive buffer size */
99#define SO_SNDLOWAT 0x1003 /* send low-water mark */
100#define SO_RCVLOWAT 0x1004 /* receive low-water mark */
101#define SO_SNDTIMEO 0x1005 /* send timeout */
102#define SO_RCVTIMEO 0x1006 /* receive timeout */
103#define SO_ERROR 0x1007 /* get error status and clear */
104#define SO_TYPE 0x1008 /* get socket type */
105/*efine SO_PRIVSTATE 0x1009 get/deny privileged state */
106
107/*
108 * Structure used for manipulating linger option.
109 */
110struct linger {
111 int l_onoff; /* option on/off */
112 int l_linger; /* linger time */
113};
114
115struct accept_filter_arg {
116 char af_name[16];
117 char af_arg[256-16];
118};
119
120/*
121 * Level number for (get/set)sockopt() to apply to socket itself.
122 */
123#define SOL_SOCKET 0xffff /* options for socket level */
124
125/*
126 * Address families.
127 */
128#define AF_UNSPEC 0 /* unspecified */
129#define AF_LOCAL 1 /* local to host (pipes, portals) */
130#define AF_UNIX AF_LOCAL /* backward compatibility */
131#define AF_INET 2 /* internetwork: UDP, TCP, etc. */
132#define AF_IMPLINK 3 /* arpanet imp addresses */
133#define AF_PUP 4 /* pup protocols: e.g. BSP */
134#define AF_CHAOS 5 /* mit CHAOS protocols */
135#define AF_NS 6 /* XEROX NS protocols */
136#define AF_ISO 7 /* ISO protocols */
137#define AF_OSI AF_ISO
138#define AF_ECMA 8 /* European computer manufacturers */
139#define AF_DATAKIT 9 /* datakit protocols */
140#define AF_CCITT 10 /* CCITT protocols, X.25 etc */
141#define AF_SNA 11 /* IBM SNA */
142#define AF_DECnet 12 /* DECnet */
143#define AF_DLI 13 /* DEC Direct data link interface */
144#define AF_LAT 14 /* LAT */
145#define AF_HYLINK 15 /* NSC Hyperchannel */
146#define AF_APPLETALK 16 /* Apple Talk */
147#define AF_ROUTE 17 /* Internal Routing Protocol */
148#define AF_LINK 18 /* Link layer interface */
149#define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
150#define AF_COIP 20 /* connection-oriented IP, aka ST II */
151#define AF_CNT 21 /* Computer Network Technology */
152#define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
153#define AF_IPX 23 /* Novell Internet Protocol */
154#define AF_SIP 24 /* Simple Internet Protocol */
155#define pseudo_AF_PIP 25 /* Help Identify PIP packets */
156#define AF_ISDN 26 /* Integrated Services Digital Network*/
157#define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
158#define pseudo_AF_KEY 27 /* Internal key-management function */
159#define AF_INET6 28 /* IPv6 */
160#define AF_NATM 29 /* native ATM access */
161#define AF_ATM 30 /* ATM */
162#define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers
163 * in interface output routine
164 */
165#define AF_NETGRAPH 32 /* Netgraph sockets */
0a9108eb 166#define AF_BLUETOOTH 33 /* Bluetooth */
9b42cabe 167#define AF_MPLS 34 /* Multi-Protocol Label Switching */
c8f81b80 168#define AF_IEEE80211 35 /* IEEE 802.11 protocol */
984263bc 169
c8f81b80 170#define AF_MAX 36
984263bc
MD
171
172/*
173 * Structure used by kernel to store most
174 * addresses.
175 */
176struct sockaddr {
e2565a42 177 __uint8_t sa_len; /* total length */
984263bc
MD
178 sa_family_t sa_family; /* address family */
179 char sa_data[14]; /* actually longer; address value */
180};
181#define SOCK_MAXADDRLEN 255 /* longest possible addresses */
182
0c3c561c 183#ifdef _KERNEL
03d6a592
MD
184
185#ifndef _SYS_LIBKERN_H_
0c3c561c 186#include <sys/libkern.h> /* for bcmp() */
03d6a592 187#endif
0c3c561c
JH
188
189static __inline boolean_t
590b8cd4 190sa_equal(const struct sockaddr *a1, const struct sockaddr *a2)
0c3c561c
JH
191{
192 return (bcmp(a1, a2, a1->sa_len) == 0);
193}
194#endif
195
984263bc
MD
196/*
197 * Structure used by kernel to pass protocol
198 * information in raw sockets.
199 */
200struct sockproto {
e2565a42
MD
201 __uint16_t sp_family; /* address family */
202 __uint16_t sp_protocol; /* protocol */
984263bc
MD
203};
204
205/*
206 * RFC 2553: protocol-independent placeholder for socket addresses
207 */
208#define _SS_MAXSIZE 128
209#define _SS_ALIGNSIZE (sizeof(int64_t))
15ef8e32
JS
210#define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) - sizeof(sa_family_t))
211#define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) - sizeof(sa_family_t) - \
984263bc
MD
212 _SS_PAD1SIZE - _SS_ALIGNSIZE)
213
214struct sockaddr_storage {
e2565a42 215 __uint8_t ss_len; /* address length */
984263bc
MD
216 sa_family_t ss_family; /* address family */
217 char __ss_pad1[_SS_PAD1SIZE];
e2565a42 218 __int64_t __ss_align; /* force desired structure storage alignment */
984263bc
MD
219 char __ss_pad2[_SS_PAD2SIZE];
220};
221
222/*
223 * Protocol families, same as address families for now.
224 */
225#define PF_UNSPEC AF_UNSPEC
226#define PF_LOCAL AF_LOCAL
227#define PF_UNIX PF_LOCAL /* backward compatibility */
228#define PF_INET AF_INET
229#define PF_IMPLINK AF_IMPLINK
230#define PF_PUP AF_PUP
231#define PF_CHAOS AF_CHAOS
232#define PF_NS AF_NS
233#define PF_ISO AF_ISO
234#define PF_OSI AF_ISO
235#define PF_ECMA AF_ECMA
236#define PF_DATAKIT AF_DATAKIT
237#define PF_CCITT AF_CCITT
238#define PF_SNA AF_SNA
239#define PF_DECnet AF_DECnet
240#define PF_DLI AF_DLI
241#define PF_LAT AF_LAT
242#define PF_HYLINK AF_HYLINK
243#define PF_APPLETALK AF_APPLETALK
244#define PF_ROUTE AF_ROUTE
245#define PF_LINK AF_LINK
246#define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
247#define PF_COIP AF_COIP
248#define PF_CNT AF_CNT
249#define PF_SIP AF_SIP
250#define PF_IPX AF_IPX /* same format as AF_NS */
251#define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
252#define PF_PIP pseudo_AF_PIP
253#define PF_ISDN AF_ISDN
254#define PF_KEY pseudo_AF_KEY
255#define PF_INET6 AF_INET6
256#define PF_NATM AF_NATM
257#define PF_ATM AF_ATM
258#define PF_NETGRAPH AF_NETGRAPH
0a9108eb 259#define PF_BLUETOOTH AF_BLUETOOTH
984263bc
MD
260
261#define PF_MAX AF_MAX
262
263/*
264 * Definitions for network related sysctl, CTL_NET.
265 *
266 * Second level is protocol family.
267 * Third level is protocol number.
268 *
269 * Further levels are defined by the individual families below.
270 */
271#define NET_MAXID AF_MAX
272
273#define CTL_NET_NAMES { \
274 { 0, 0 }, \
275 { "unix", CTLTYPE_NODE }, \
276 { "inet", CTLTYPE_NODE }, \
277 { "implink", CTLTYPE_NODE }, \
278 { "pup", CTLTYPE_NODE }, \
279 { "chaos", CTLTYPE_NODE }, \
280 { "xerox_ns", CTLTYPE_NODE }, \
281 { "iso", CTLTYPE_NODE }, \
282 { "emca", CTLTYPE_NODE }, \
283 { "datakit", CTLTYPE_NODE }, \
284 { "ccitt", CTLTYPE_NODE }, \
285 { "ibm_sna", CTLTYPE_NODE }, \
286 { "decnet", CTLTYPE_NODE }, \
287 { "dec_dli", CTLTYPE_NODE }, \
288 { "lat", CTLTYPE_NODE }, \
289 { "hylink", CTLTYPE_NODE }, \
290 { "appletalk", CTLTYPE_NODE }, \
291 { "route", CTLTYPE_NODE }, \
292 { "link_layer", CTLTYPE_NODE }, \
293 { "xtp", CTLTYPE_NODE }, \
294 { "coip", CTLTYPE_NODE }, \
295 { "cnt", CTLTYPE_NODE }, \
296 { "rtip", CTLTYPE_NODE }, \
297 { "ipx", CTLTYPE_NODE }, \
298 { "sip", CTLTYPE_NODE }, \
299 { "pip", CTLTYPE_NODE }, \
300 { "isdn", CTLTYPE_NODE }, \
301 { "key", CTLTYPE_NODE }, \
302 { "inet6", CTLTYPE_NODE }, \
303 { "natm", CTLTYPE_NODE }, \
304 { "atm", CTLTYPE_NODE }, \
305 { "hdrcomplete", CTLTYPE_NODE }, \
306 { "netgraph", CTLTYPE_NODE }, \
0a9108eb 307 { "bluetooth", CTLTYPE_NODE}, \
984263bc
MD
308}
309
310/*
311 * PF_ROUTE - Routing table
312 *
313 * Three additional levels are defined:
314 * Fourth: address family, 0 is wildcard
315 * Fifth: type of info, defined below
316 * Sixth: flag(s) to mask with for NET_RT_FLAGS
317 */
318#define NET_RT_DUMP 1 /* dump; may limit to a.f. */
319#define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
320#define NET_RT_IFLIST 3 /* survey interface list */
321#define NET_RT_MAXID 4
322
323#define CTL_NET_RT_NAMES { \
324 { 0, 0 }, \
325 { "dump", CTLTYPE_STRUCT }, \
326 { "flags", CTLTYPE_STRUCT }, \
327 { "iflist", CTLTYPE_STRUCT }, \
328}
329
330/*
331 * Maximum queue length specifiable by listen.
332 */
333#define SOMAXCONN 128
334
b4354d10
MD
335/*
336 * Maximum setsockopt buffer size
337 */
338#define SOMAXOPT_SIZE 65536
339
984263bc
MD
340/*
341 * Message header for recvmsg and sendmsg calls.
342 * Used value-result for recvmsg, value only for sendmsg.
343 */
344struct msghdr {
345 void *msg_name; /* optional address */
346 socklen_t msg_namelen; /* size of address */
347 struct iovec *msg_iov; /* scatter/gather array */
348 int msg_iovlen; /* # elements in msg_iov */
349 void *msg_control; /* ancillary data, see below */
350 socklen_t msg_controllen; /* ancillary data buffer len */
351 int msg_flags; /* flags on received message */
352};
353
9ba76b73
MD
354#define MSG_OOB 0x00000001 /* process out-of-band data */
355#define MSG_PEEK 0x00000002 /* peek at incoming message */
356#define MSG_DONTROUTE 0x00000004 /* send without using routing tables */
357#define MSG_EOR 0x00000008 /* data completes record */
358#define MSG_TRUNC 0x00000010 /* data discarded before delivery */
359#define MSG_CTRUNC 0x00000020 /* control data lost before delivery */
360#define MSG_WAITALL 0x00000040 /* wait for full request or error */
361#define MSG_DONTWAIT 0x00000080 /* this message should be nonblocking */
362#define MSG_EOF 0x00000100 /* data completes connection */
363#define MSG_NOTIFICATION 0x00000200 /* notification message */
e2c70b77 364#define MSG_NOSIGNAL 0x00000400 /* No SIGPIPE to unconnected socket stream */
9ba76b73
MD
365
366/*
367 * These override FIONBIO. MSG_FNONBLOCKING is functionally equivalent to
368 * MSG_DONTWAIT.
369 */
370#define MSG_FBLOCKING 0x00010000 /* force blocking operation */
371#define MSG_FNONBLOCKING 0x00020000 /* force non-blocking operation */
372
373#define MSG_FMASK 0xFFFF0000 /* force mask */
984263bc
MD
374
375/*
376 * Header for ancillary data objects in msg_control buffer.
377 * Used for additional information with/about a datagram
378 * not expressible by flags. The format is a sequence
379 * of message elements headed by cmsghdr structures.
380 */
381struct cmsghdr {
382 socklen_t cmsg_len; /* data byte count, including hdr */
383 int cmsg_level; /* originating protocol */
384 int cmsg_type; /* protocol-specific type */
385/* followed by u_char cmsg_data[]; */
386};
387
388/*
389 * While we may have more groups than this, the cmsgcred struct must
390 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
391 * this.
392*/
393#define CMGROUP_MAX 16
394
395/*
396 * Credentials structure, used to verify the identity of a peer
397 * process that has sent us a message. This is allocated by the
398 * peer process but filled in by the kernel. This prevents the
399 * peer from lying about its identity. (Note that cmcred_groups[0]
400 * is the effective GID.)
401 */
402struct cmsgcred {
403 pid_t cmcred_pid; /* PID of sending process */
404 uid_t cmcred_uid; /* real UID of sending process */
405 uid_t cmcred_euid; /* effective UID of sending process */
406 gid_t cmcred_gid; /* real GID of sending process */
407 short cmcred_ngroups; /* number or groups */
408 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */
409};
410
411/* given pointer to struct cmsghdr, return pointer to data */
15ef8e32 412#define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + \
984263bc
MD
413 _ALIGN(sizeof(struct cmsghdr)))
414
415/* given pointer to struct cmsghdr, return pointer to next cmsghdr */
416#define CMSG_NXTHDR(mhdr, cmsg) \
417 (((caddr_t)(cmsg) + _ALIGN((cmsg)->cmsg_len) + \
418 _ALIGN(sizeof(struct cmsghdr)) > \
419 (caddr_t)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
2038fb68 420 NULL : \
984263bc
MD
421 (struct cmsghdr *)((caddr_t)(cmsg) + _ALIGN((cmsg)->cmsg_len)))
422
e4c3292d
SW
423/*
424 * RFC 2292 requires to check msg_controllen, in case that the kernel returns
425 * an empty list for some reasons.
426 */
427#define CMSG_FIRSTHDR(mhdr) \
428 ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
429 (struct cmsghdr *)(mhdr)->msg_control : \
2038fb68 430 NULL)
984263bc
MD
431
432/* RFC 2292 additions */
433
434#define CMSG_SPACE(l) (_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l))
435#define CMSG_LEN(l) (_ALIGN(sizeof(struct cmsghdr)) + (l))
436
437#ifdef _KERNEL
438#define CMSG_ALIGN(n) _ALIGN(n)
439#endif
440
441/* "Socket"-level control message types: */
442#define SCM_RIGHTS 0x01 /* access rights (array of int) */
443#define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
444#define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */
445
984263bc
MD
446/*
447 * howto arguments for shutdown(2), specified by Posix.1g.
448 */
449#define SHUT_RD 0 /* shut down the reading side */
450#define SHUT_WR 1 /* shut down the writing side */
451#define SHUT_RDWR 2 /* shut down both sides */
452
453/*
454 * sendfile(2) header/trailer struct
455 */
456struct sf_hdtr {
457 struct iovec *headers; /* pointer to an array of header struct iovec's */
458 int hdr_cnt; /* number of header iovec's */
459 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */
460 int trl_cnt; /* number of trailer iovec's */
461};
462
91be174d 463#if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
984263bc 464
03d6a592 465#ifndef _SYS_CDEFS_H_
984263bc 466#include <sys/cdefs.h>
03d6a592 467#endif
984263bc
MD
468
469__BEGIN_DECLS
b153f746 470int accept (int, struct sockaddr *, socklen_t *);
b09fd398 471int extaccept (int, int, struct sockaddr *, socklen_t *);
b153f746
RG
472int bind (int, const struct sockaddr *, socklen_t);
473int connect (int, const struct sockaddr *, socklen_t);
b09fd398 474int extconnect (int, int, struct sockaddr *, socklen_t);
b153f746
RG
475int getpeername (int, struct sockaddr *, socklen_t *);
476int getsockname (int, struct sockaddr *, socklen_t *);
477int getsockopt (int, int, int, void *, socklen_t *);
478int listen (int, int);
479ssize_t recv (int, void *, size_t, int);
480ssize_t recvfrom (int, void *, size_t, int, struct sockaddr *, socklen_t *);
481ssize_t recvmsg (int, struct msghdr *, int);
482ssize_t send (int, const void *, size_t, int);
483ssize_t sendto (int, const void *,
484 size_t, int, const struct sockaddr *, socklen_t);
485ssize_t sendmsg (int, const struct msghdr *, int);
486int sendfile (int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
487int setsockopt (int, int, int, const void *, socklen_t);
488int shutdown (int, int);
b153f746
RG
489int socketpair (int, int, int, int *);
490
491void pfctlinput (int, struct sockaddr *);
984263bc
MD
492__END_DECLS
493
494#endif /* !_KERNEL */
495
3f4985cd 496#if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
e0413f11
SZ
497#ifndef _SYS_CDEFS_H_
498#include <sys/cdefs.h>
499#endif
500
501__BEGIN_DECLS
3f4985cd 502int socket (int, int, int);
e0413f11 503__END_DECLS
3f4985cd
SZ
504#endif /* !_KERNEL || _KERNEL_VIRTUAL */
505
984263bc 506#endif /* !_SYS_SOCKET_H_ */