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