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