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