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