2 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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 * 4. 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.
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
29 * @(#)socket.h 8.4 (Berkeley) 2/21/94
33 #ifndef _SYS_SOCKET_H_
34 #define _SYS_SOCKET_H_
36 #include <sys/cdefs.h>
37 #include <sys/_types.h>
38 #include <sys/_iovec.h>
39 #define _NO_NAMESPACE_POLLUTION
40 #include <machine/param.h>
41 #undef _NO_NAMESPACE_POLLUTION
44 * Definitions related to sockets: types, address families, options.
51 #ifndef _GID_T_DECLARED
52 typedef __gid_t gid_t;
53 #define _GID_T_DECLARED
56 #ifndef _OFF_T_DECLARED
57 typedef __off_t off_t;
58 #define _OFF_T_DECLARED
61 #ifndef _PID_T_DECLARED
62 typedef __pid_t pid_t;
63 #define _PID_T_DECLARED
67 #ifndef _SA_FAMILY_T_DECLARED
68 typedef __sa_family_t sa_family_t;
69 #define _SA_FAMILY_T_DECLARED
72 #ifndef _SOCKLEN_T_DECLARED
73 typedef __socklen_t socklen_t;
74 #define _SOCKLEN_T_DECLARED
77 #ifndef _SSIZE_T_DECLARED
78 typedef __ssize_t ssize_t;
79 #define _SSIZE_T_DECLARED
83 #ifndef _UID_T_DECLARED
84 typedef __uid_t uid_t;
85 #define _UID_T_DECLARED
92 #define SOCK_STREAM 1 /* stream socket */
93 #define SOCK_DGRAM 2 /* datagram socket */
94 #define SOCK_RAW 3 /* raw-protocol interface */
96 #define SOCK_RDM 4 /* reliably-delivered message */
98 #define SOCK_SEQPACKET 5 /* sequenced packet stream */
101 * Option flags per-socket.
103 #define SO_DEBUG 0x0001 /* turn on debugging info recording */
104 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
105 #define SO_REUSEADDR 0x0004 /* allow local address reuse */
106 #define SO_KEEPALIVE 0x0008 /* keep connections alive */
107 #define SO_DONTROUTE 0x0010 /* just use interface addresses */
108 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
110 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
112 #define SO_LINGER 0x0080 /* linger on close if data present */
113 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
115 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
116 #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
117 #define SO_NOSIGPIPE 0x0800 /* no SIGPIPE from EPIPE */
118 #define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */
119 #define SO_BINTIME 0x2000 /* timestamp received dgram traffic */
123 * Additional options, not kept in so_options.
125 #define SO_SNDBUF 0x1001 /* send buffer size */
126 #define SO_RCVBUF 0x1002 /* receive buffer size */
127 #define SO_SNDLOWAT 0x1003 /* send low-water mark */
128 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
129 #define SO_SNDTIMEO 0x1005 /* send timeout */
130 #define SO_RCVTIMEO 0x1006 /* receive timeout */
131 #define SO_ERROR 0x1007 /* get error status and clear */
132 #define SO_TYPE 0x1008 /* get socket type */
134 #define SO_LABEL 0x1009 /* socket's MAC label */
135 #define SO_PEERLABEL 0x1010 /* socket's peer's MAC label */
136 #define SO_LISTENQLIMIT 0x1011 /* socket's backlog limit */
137 #define SO_LISTENQLEN 0x1012 /* socket's complete queue length */
138 #define SO_LISTENINCQLEN 0x1013 /* socket's incomplete queue length */
142 * Structure used for manipulating linger option.
145 int l_onoff; /* option on/off */
146 int l_linger; /* linger time */
150 struct accept_filter_arg {
157 * Level number for (get/set)sockopt() to apply to socket itself.
159 #define SOL_SOCKET 0xffff /* options for socket level */
164 #define AF_UNSPEC 0 /* unspecified */
166 #define AF_LOCAL AF_UNIX /* local to host (pipes, portals) */
168 #define AF_UNIX 1 /* standardized name for AF_LOCAL */
169 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
171 #define AF_IMPLINK 3 /* arpanet imp addresses */
172 #define AF_PUP 4 /* pup protocols: e.g. BSP */
173 #define AF_CHAOS 5 /* mit CHAOS protocols */
174 #define AF_NETBIOS 6 /* SMB protocols */
175 #define AF_ISO 7 /* ISO protocols */
176 #define AF_OSI AF_ISO
177 #define AF_ECMA 8 /* European computer manufacturers */
178 #define AF_DATAKIT 9 /* datakit protocols */
179 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
180 #define AF_SNA 11 /* IBM SNA */
181 #define AF_DECnet 12 /* DECnet */
182 #define AF_DLI 13 /* DEC Direct data link interface */
183 #define AF_LAT 14 /* LAT */
184 #define AF_HYLINK 15 /* NSC Hyperchannel */
185 #define AF_APPLETALK 16 /* Apple Talk */
186 #define AF_ROUTE 17 /* Internal Routing Protocol */
187 #define AF_LINK 18 /* Link layer interface */
188 #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
189 #define AF_COIP 20 /* connection-oriented IP, aka ST II */
190 #define AF_CNT 21 /* Computer Network Technology */
191 #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
192 #define AF_IPX 23 /* Novell Internet Protocol */
193 #define AF_SIP 24 /* Simple Internet Protocol */
194 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */
195 #define AF_ISDN 26 /* Integrated Services Digital Network*/
196 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
197 #define pseudo_AF_KEY 27 /* Internal key-management function */
199 #define AF_INET6 28 /* IPv6 */
201 #define AF_NATM 29 /* native ATM access */
202 #define AF_ATM 30 /* ATM */
203 #define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers
204 * in interface output routine
206 #define AF_NETGRAPH 32 /* Netgraph sockets */
207 #define AF_SLOW 33 /* 802.3ad slow protocol */
208 #define AF_SCLUSTER 34 /* Sitara cluster protocol */
210 #define AF_BLUETOOTH 36 /* Bluetooth sockets */
211 #define AF_IEEE80211 37 /* IEEE 802.11 protocol */
216 * Structure used by kernel to store most
220 unsigned char sa_len; /* total length */
221 sa_family_t sa_family; /* address family */
222 char sa_data[14]; /* actually longer; address value */
225 #define SOCK_MAXADDRLEN 255 /* longest possible addresses */
228 * Structure used by kernel to pass protocol
229 * information in raw sockets.
232 unsigned short sp_family; /* address family */
233 unsigned short sp_protocol; /* protocol */
238 * RFC 2553: protocol-independent placeholder for socket addresses
240 #define _SS_MAXSIZE 128U
241 #define _SS_ALIGNSIZE (sizeof(__int64_t))
242 #define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) - \
244 #define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) - \
245 sizeof(sa_family_t) - _SS_PAD1SIZE - _SS_ALIGNSIZE)
247 struct sockaddr_storage {
248 unsigned char ss_len; /* address length */
249 sa_family_t ss_family; /* address family */
250 char __ss_pad1[_SS_PAD1SIZE];
251 __int64_t __ss_align; /* force desired struct alignment */
252 char __ss_pad2[_SS_PAD2SIZE];
257 * Protocol families, same as address families for now.
259 #define PF_UNSPEC AF_UNSPEC
260 #define PF_LOCAL AF_LOCAL
261 #define PF_UNIX PF_LOCAL /* backward compatibility */
262 #define PF_INET AF_INET
263 #define PF_IMPLINK AF_IMPLINK
264 #define PF_PUP AF_PUP
265 #define PF_CHAOS AF_CHAOS
266 #define PF_NETBIOS AF_NETBIOS
267 #define PF_ISO AF_ISO
268 #define PF_OSI AF_ISO
269 #define PF_ECMA AF_ECMA
270 #define PF_DATAKIT AF_DATAKIT
271 #define PF_CCITT AF_CCITT
272 #define PF_SNA AF_SNA
273 #define PF_DECnet AF_DECnet
274 #define PF_DLI AF_DLI
275 #define PF_LAT AF_LAT
276 #define PF_HYLINK AF_HYLINK
277 #define PF_APPLETALK AF_APPLETALK
278 #define PF_ROUTE AF_ROUTE
279 #define PF_LINK AF_LINK
280 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
281 #define PF_COIP AF_COIP
282 #define PF_CNT AF_CNT
283 #define PF_SIP AF_SIP
284 #define PF_IPX AF_IPX
285 #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
286 #define PF_PIP pseudo_AF_PIP
287 #define PF_ISDN AF_ISDN
288 #define PF_KEY pseudo_AF_KEY
289 #define PF_INET6 AF_INET6
290 #define PF_NATM AF_NATM
291 #define PF_ATM AF_ATM
292 #define PF_NETGRAPH AF_NETGRAPH
293 #define PF_SLOW AF_SLOW
294 #define PF_SCLUSTER AF_SCLUSTER
295 #define PF_ARP AF_ARP
296 #define PF_BLUETOOTH AF_BLUETOOTH
298 #define PF_MAX AF_MAX
301 * Definitions for network related sysctl, CTL_NET.
303 * Second level is protocol family.
304 * Third level is protocol number.
306 * Further levels are defined by the individual families below.
308 #define NET_MAXID AF_MAX
310 #define CTL_NET_NAMES { \
312 { "unix", CTLTYPE_NODE }, \
313 { "inet", CTLTYPE_NODE }, \
314 { "implink", CTLTYPE_NODE }, \
315 { "pup", CTLTYPE_NODE }, \
316 { "chaos", CTLTYPE_NODE }, \
317 { "xerox_ns", CTLTYPE_NODE }, \
318 { "iso", CTLTYPE_NODE }, \
319 { "emca", CTLTYPE_NODE }, \
320 { "datakit", CTLTYPE_NODE }, \
321 { "ccitt", CTLTYPE_NODE }, \
322 { "ibm_sna", CTLTYPE_NODE }, \
323 { "decnet", CTLTYPE_NODE }, \
324 { "dec_dli", CTLTYPE_NODE }, \
325 { "lat", CTLTYPE_NODE }, \
326 { "hylink", CTLTYPE_NODE }, \
327 { "appletalk", CTLTYPE_NODE }, \
328 { "route", CTLTYPE_NODE }, \
329 { "link_layer", CTLTYPE_NODE }, \
330 { "xtp", CTLTYPE_NODE }, \
331 { "coip", CTLTYPE_NODE }, \
332 { "cnt", CTLTYPE_NODE }, \
333 { "rtip", CTLTYPE_NODE }, \
334 { "ipx", CTLTYPE_NODE }, \
335 { "sip", CTLTYPE_NODE }, \
336 { "pip", CTLTYPE_NODE }, \
337 { "isdn", CTLTYPE_NODE }, \
338 { "key", CTLTYPE_NODE }, \
339 { "inet6", CTLTYPE_NODE }, \
340 { "natm", CTLTYPE_NODE }, \
341 { "atm", CTLTYPE_NODE }, \
342 { "hdrcomplete", CTLTYPE_NODE }, \
343 { "netgraph", CTLTYPE_NODE }, \
344 { "snp", CTLTYPE_NODE }, \
345 { "scp", CTLTYPE_NODE }, \
349 * PF_ROUTE - Routing table
351 * Three additional levels are defined:
352 * Fourth: address family, 0 is wildcard
353 * Fifth: type of info, defined below
354 * Sixth: flag(s) to mask with for NET_RT_FLAGS
356 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */
357 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
358 #define NET_RT_IFLIST 3 /* survey interface list */
359 #define NET_RT_IFMALIST 4 /* return multicast address list */
360 #define NET_RT_MAXID 5
362 #define CTL_NET_RT_NAMES { \
364 { "dump", CTLTYPE_STRUCT }, \
365 { "flags", CTLTYPE_STRUCT }, \
366 { "iflist", CTLTYPE_STRUCT }, \
367 { "ifmalist", CTLTYPE_STRUCT }, \
369 #endif /* __BSD_VISIBLE */
372 * Maximum queue length specifiable by listen.
374 #define SOMAXCONN 128
377 * Message header for recvmsg and sendmsg calls.
378 * Used value-result for recvmsg, value only for sendmsg.
381 void *msg_name; /* optional address */
382 socklen_t msg_namelen; /* size of address */
383 struct iovec *msg_iov; /* scatter/gather array */
384 int msg_iovlen; /* # elements in msg_iov */
385 void *msg_control; /* ancillary data, see below */
386 socklen_t msg_controllen; /* ancillary data buffer len */
387 int msg_flags; /* flags on received message */
390 #define MSG_OOB 0x1 /* process out-of-band data */
391 #define MSG_PEEK 0x2 /* peek at incoming message */
392 #define MSG_DONTROUTE 0x4 /* send without using routing tables */
393 #define MSG_EOR 0x8 /* data completes record */
394 #define MSG_TRUNC 0x10 /* data discarded before delivery */
395 #define MSG_CTRUNC 0x20 /* control data lost before delivery */
396 #define MSG_WAITALL 0x40 /* wait for full request or error */
397 #define MSG_NOTIFICATION 0x2000 /* SCTP notification */
399 #define MSG_DONTWAIT 0x80 /* this message should be nonblocking */
400 #define MSG_EOF 0x100 /* data completes connection */
401 #define MSG_NBIO 0x4000 /* FIONBIO mode, used by fifofs */
402 #define MSG_COMPAT 0x8000 /* used in sendit() */
405 #define MSG_SOCALLBCK 0x10000 /* for use by socket callbacks - soreceive (TCP) */
408 #define MSG_NOSIGNAL 0x20000 /* do not generate SIGPIPE on EOF */
412 * Header for ancillary data objects in msg_control buffer.
413 * Used for additional information with/about a datagram
414 * not expressible by flags. The format is a sequence
415 * of message elements headed by cmsghdr structures.
418 socklen_t cmsg_len; /* data byte count, including hdr */
419 int cmsg_level; /* originating protocol */
420 int cmsg_type; /* protocol-specific type */
421 /* followed by u_char cmsg_data[]; */
426 * While we may have more groups than this, the cmsgcred struct must
427 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
430 #define CMGROUP_MAX 16
433 * Credentials structure, used to verify the identity of a peer
434 * process that has sent us a message. This is allocated by the
435 * peer process but filled in by the kernel. This prevents the
436 * peer from lying about its identity. (Note that cmcred_groups[0]
437 * is the effective GID.)
440 pid_t cmcred_pid; /* PID of sending process */
441 uid_t cmcred_uid; /* real UID of sending process */
442 uid_t cmcred_euid; /* effective UID of sending process */
443 gid_t cmcred_gid; /* real GID of sending process */
444 short cmcred_ngroups; /* number or groups */
445 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */
449 * Socket credentials.
452 uid_t sc_uid; /* real user id */
453 uid_t sc_euid; /* effective user id */
454 gid_t sc_gid; /* real group id */
455 gid_t sc_egid; /* effective group id */
456 int sc_ngroups; /* number of supplemental groups */
457 gid_t sc_groups[1]; /* variable length */
461 * Compute size of a sockcred structure with groups.
463 #define SOCKCREDSIZE(ngrps) \
464 (sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1)))
466 #endif /* __BSD_VISIBLE */
468 /* given pointer to struct cmsghdr, return pointer to data */
469 #define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + \
470 _ALIGN(sizeof(struct cmsghdr)))
472 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
473 #define CMSG_NXTHDR(mhdr, cmsg) \
474 (((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len) + \
475 _ALIGN(sizeof(struct cmsghdr)) > \
476 (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
477 (struct cmsghdr *)0 : \
478 (struct cmsghdr *)((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len)))
481 * RFC 2292 requires to check msg_controllen, in case that the kernel returns
482 * an empty list for some reasons.
484 #define CMSG_FIRSTHDR(mhdr) \
485 ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
486 (struct cmsghdr *)(mhdr)->msg_control : \
487 (struct cmsghdr *)NULL)
490 /* RFC 2292 additions */
491 #define CMSG_SPACE(l) (_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l))
492 #define CMSG_LEN(l) (_ALIGN(sizeof(struct cmsghdr)) + (l))
496 #define CMSG_ALIGN(n) _ALIGN(n)
499 /* "Socket"-level control message types: */
500 #define SCM_RIGHTS 0x01 /* access rights (array of int) */
502 #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
503 #define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */
504 #define SCM_BINTIME 0x04 /* timestamp (struct bintime) */
509 * 4.3 compat sockaddr, move to compat file later
512 unsigned short sa_family; /* address family */
513 char sa_data[14]; /* up to 14 bytes of direct address */
517 * 4.3-compat message header (move to compat file later).
520 char *msg_name; /* optional address */
521 int msg_namelen; /* size of address */
522 struct iovec *msg_iov; /* scatter/gather array */
523 int msg_iovlen; /* # elements in msg_iov */
524 char *msg_accrights; /* access rights sent/received */
525 int msg_accrightslen;
530 * howto arguments for shutdown(2), specified by Posix.1g.
532 #define SHUT_RD 0 /* shut down the reading side */
533 #define SHUT_WR 1 /* shut down the writing side */
534 #define SHUT_RDWR 2 /* shut down both sides */
538 * sendfile(2) header/trailer struct
541 struct iovec *headers; /* pointer to an array of header struct iovec's */
542 int hdr_cnt; /* number of header iovec's */
543 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */
544 int trl_cnt; /* number of trailer iovec's */
548 * Sendfile-specific flag(s)
550 #define SF_NODISKIO 0x00000001
551 #define SF_MNOWAIT 0x00000002
556 #include <sys/cdefs.h>
559 int accept(int, struct sockaddr * __restrict, socklen_t * __restrict);
560 int bind(int, const struct sockaddr *, socklen_t);
561 int connect(int, const struct sockaddr *, socklen_t);
562 int getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict);
563 int getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict);
564 int getsockopt(int, int, int, void * __restrict, socklen_t * __restrict);
565 int listen(int, int);
566 ssize_t recv(int, void *, size_t, int);
567 ssize_t recvfrom(int, void *, size_t, int, struct sockaddr * __restrict, socklen_t * __restrict);
568 ssize_t recvmsg(int, struct msghdr *, int);
569 ssize_t send(int, const void *, size_t, int);
570 ssize_t sendto(int, const void *,
571 size_t, int, const struct sockaddr *, socklen_t);
572 ssize_t sendmsg(int, const struct msghdr *, int);
574 int sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
576 int setsockopt(int, int, int, const void *, socklen_t);
577 int shutdown(int, int);
579 int socket(int, int, int);
580 int socketpair(int, int, int, int *);
583 #endif /* !_KERNEL */
585 #endif /* !_SYS_SOCKET_H_ */