1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 *    may be used to endorse or promote products derived from this software
17 *    without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _SYS_SOCKET_H_
33#define	_SYS_SOCKET_H_
34
35#include <sys/cdefs.h>
36#include <sys/_types.h>
37#include <sys/_iovec.h>
38#include <machine/_align.h>
39
40/*
41 * Definitions related to sockets: types, address families, options.
42 */
43
44/*
45 * Data types.
46 */
47#if __BSD_VISIBLE
48#ifndef _GID_T_DECLARED
49typedef	__gid_t		gid_t;
50#define	_GID_T_DECLARED
51#endif
52
53#ifndef _OFF_T_DECLARED
54typedef	__off_t		off_t;
55#define	_OFF_T_DECLARED
56#endif
57
58#ifndef _PID_T_DECLARED
59typedef	__pid_t		pid_t;
60#define	_PID_T_DECLARED
61#endif
62#endif
63
64#ifndef _SA_FAMILY_T_DECLARED
65typedef	__sa_family_t	sa_family_t;
66#define	_SA_FAMILY_T_DECLARED
67#endif
68
69#ifndef _SOCKLEN_T_DECLARED
70typedef	__socklen_t	socklen_t;
71#define	_SOCKLEN_T_DECLARED
72#endif
73
74#ifndef _SSIZE_T_DECLARED
75typedef	__ssize_t	ssize_t;
76#define	_SSIZE_T_DECLARED
77#endif
78
79#if __BSD_VISIBLE
80#ifndef _UID_T_DECLARED
81typedef	__uid_t		uid_t;
82#define	_UID_T_DECLARED
83#endif
84#endif
85
86#ifndef _UINT32_T_DECLARED
87typedef	__uint32_t	uint32_t;
88#define	_UINT32_T_DECLARED
89#endif
90
91#ifndef _UINTPTR_T_DECLARED
92typedef	__uintptr_t	uintptr_t;
93#define	_UINTPTR_T_DECLARED
94#endif
95
96/*
97 * Types
98 */
99#define	SOCK_STREAM	1		/* stream socket */
100#define	SOCK_DGRAM	2		/* datagram socket */
101#define	SOCK_RAW	3		/* raw-protocol interface */
102#if __BSD_VISIBLE
103#define	SOCK_RDM	4		/* reliably-delivered message */
104#endif
105#define	SOCK_SEQPACKET	5		/* sequenced packet stream */
106
107#if __BSD_VISIBLE
108/*
109 * Creation flags, OR'ed into socket() and socketpair() type argument.
110 */
111#define	SOCK_CLOEXEC	0x10000000
112#define	SOCK_NONBLOCK	0x20000000
113#ifdef _KERNEL
114/*
115 * Flags for accept1(), kern_accept4() and solisten_dequeue, in addition
116 * to SOCK_CLOEXEC and SOCK_NONBLOCK.
117 */
118#define ACCEPT4_INHERIT 0x1
119#define ACCEPT4_COMPAT  0x2
120#endif	/* _KERNEL */
121#endif	/* __BSD_VISIBLE */
122
123/*
124 * Option flags per-socket.
125 */
126#define	SO_DEBUG	0x00000001	/* turn on debugging info recording */
127#define	SO_ACCEPTCONN	0x00000002	/* socket has had listen() */
128#define	SO_REUSEADDR	0x00000004	/* allow local address reuse */
129#define	SO_KEEPALIVE	0x00000008	/* keep connections alive */
130#define	SO_DONTROUTE	0x00000010	/* just use interface addresses */
131#define	SO_BROADCAST	0x00000020	/* permit sending of broadcast msgs */
132#if __BSD_VISIBLE
133#define	SO_USELOOPBACK	0x00000040	/* bypass hardware when possible */
134#endif
135#define	SO_LINGER	0x00000080	/* linger on close if data present */
136#define	SO_OOBINLINE	0x00000100	/* leave received OOB data in line */
137#if __BSD_VISIBLE
138#define	SO_REUSEPORT	0x00000200	/* allow local address & port reuse */
139#define	SO_TIMESTAMP	0x00000400	/* timestamp received dgram traffic */
140#define	SO_NOSIGPIPE	0x00000800	/* no SIGPIPE from EPIPE */
141#define	SO_ACCEPTFILTER	0x00001000	/* there is an accept filter */
142#define	SO_BINTIME	0x00002000	/* timestamp received dgram traffic */
143#endif
144#define	SO_NO_OFFLOAD	0x00004000	/* socket cannot be offloaded */
145#define	SO_NO_DDP	0x00008000	/* disable direct data placement */
146#define	SO_REUSEPORT_LB	0x00010000	/* reuse with load balancing */
147#define	SO_RERROR	0x00020000	/* keep track of receive errors */
148
149/*
150 * Additional options, not kept in so_options.
151 */
152#define	SO_SNDBUF	0x1001		/* send buffer size */
153#define	SO_RCVBUF	0x1002		/* receive buffer size */
154#define	SO_SNDLOWAT	0x1003		/* send low-water mark */
155#define	SO_RCVLOWAT	0x1004		/* receive low-water mark */
156#define	SO_SNDTIMEO	0x1005		/* send timeout */
157#define	SO_RCVTIMEO	0x1006		/* receive timeout */
158#define	SO_ERROR	0x1007		/* get error status and clear */
159#define	SO_TYPE		0x1008		/* get socket type */
160#if __BSD_VISIBLE
161#define	SO_LABEL	0x1009		/* socket's MAC label */
162#define	SO_PEERLABEL	0x1010		/* socket's peer's MAC label */
163#define	SO_LISTENQLIMIT	0x1011		/* socket's backlog limit */
164#define	SO_LISTENQLEN	0x1012		/* socket's complete queue length */
165#define	SO_LISTENINCQLEN	0x1013	/* socket's incomplete queue length */
166#define	SO_SETFIB	0x1014		/* use this FIB to route */
167#define	SO_USER_COOKIE	0x1015		/* user cookie (dummynet etc.) */
168#define	SO_PROTOCOL	0x1016		/* get socket protocol (Linux name) */
169#define	SO_PROTOTYPE	SO_PROTOCOL	/* alias for SO_PROTOCOL (SunOS name) */
170#define	SO_TS_CLOCK	0x1017		/* clock type used for SO_TIMESTAMP */
171#define	SO_MAX_PACING_RATE	0x1018	/* socket's max TX pacing rate (Linux name) */
172#define	SO_DOMAIN	0x1019		/* get socket domain */
173#endif
174
175#if __BSD_VISIBLE
176#define	SO_TS_REALTIME_MICRO	0	/* microsecond resolution, realtime */
177#define	SO_TS_BINTIME		1	/* sub-nanosecond resolution, realtime */
178#define	SO_TS_REALTIME		2	/* nanosecond resolution, realtime */
179#define	SO_TS_MONOTONIC		3	/* nanosecond resolution, monotonic */
180#define	SO_TS_DEFAULT		SO_TS_REALTIME_MICRO
181#define	SO_TS_CLOCK_MAX		SO_TS_MONOTONIC
182#endif
183
184/*
185 * Space reserved for new socket options added by third-party vendors.
186 * This range applies to all socket option levels.  New socket options
187 * in FreeBSD should always use an option value less than SO_VENDOR.
188 */
189#if __BSD_VISIBLE
190#define	SO_VENDOR	0x80000000
191#endif
192
193/*
194 * Structure used for manipulating linger option.
195 */
196struct linger {
197	int	l_onoff;		/* option on/off */
198	int	l_linger;		/* linger time */
199};
200
201#if __BSD_VISIBLE
202struct accept_filter_arg {
203	char	af_name[16];
204	char	af_arg[256-16];
205};
206#endif
207
208/*
209 * Level number for (get/set)sockopt() to apply to socket itself.
210 */
211#define	SOL_SOCKET	0xffff		/* options for socket level */
212
213/*
214 * Address families.
215 */
216#define	AF_UNSPEC	0		/* unspecified */
217#if __BSD_VISIBLE
218#define	AF_LOCAL	AF_UNIX		/* local to host (pipes, portals) */
219#endif
220#define	AF_UNIX		1		/* standardized name for AF_LOCAL */
221#define	AF_INET		2		/* internetwork: UDP, TCP, etc. */
222#if __BSD_VISIBLE
223#define	AF_IMPLINK	3		/* arpanet imp addresses */
224#define	AF_PUP		4		/* pup protocols: e.g. BSP */
225#define	AF_CHAOS	5		/* mit CHAOS protocols */
226#define	AF_NETBIOS	6		/* SMB protocols */
227#define	AF_ISO		7		/* ISO protocols */
228#define	AF_OSI		AF_ISO
229#define	AF_ECMA		8		/* European computer manufacturers */
230#define	AF_DATAKIT	9		/* datakit protocols */
231#define	AF_CCITT	10		/* CCITT protocols, X.25 etc */
232#define	AF_SNA		11		/* IBM SNA */
233#define AF_DECnet	12		/* DECnet */
234#define AF_DLI		13		/* DEC Direct data link interface */
235#define AF_LAT		14		/* LAT */
236#define	AF_HYLINK	15		/* NSC Hyperchannel */
237#define	AF_APPLETALK	16		/* Apple Talk */
238#define	AF_ROUTE	17		/* Internal Routing Protocol */
239#define	AF_LINK		18		/* Link layer interface */
240#define	pseudo_AF_XTP	19		/* eXpress Transfer Protocol (no AF) */
241#define	AF_COIP		20		/* connection-oriented IP, aka ST II */
242#define	AF_CNT		21		/* Computer Network Technology */
243#define pseudo_AF_RTIP	22		/* Help Identify RTIP packets */
244#define	AF_IPX		23		/* Novell Internet Protocol */
245#define	AF_SIP		24		/* Simple Internet Protocol */
246#define	pseudo_AF_PIP	25		/* Help Identify PIP packets */
247#define	AF_ISDN		26		/* Integrated Services Digital Network*/
248#define	AF_E164		AF_ISDN		/* CCITT E.164 recommendation */
249#define	pseudo_AF_KEY	27		/* Internal key-management function */
250#endif
251#define	AF_INET6	28		/* IPv6 */
252#if __BSD_VISIBLE
253#define	AF_NATM		29		/* native ATM access */
254#define	AF_ATM		30		/* ATM */
255#define pseudo_AF_HDRCMPLT 31		/* Used by BPF to not rewrite headers
256					 * in interface output routine
257					 */
258#define	AF_NETGRAPH	32		/* Netgraph sockets */
259#define	AF_SLOW		33		/* 802.3ad slow protocol */
260#define	AF_SCLUSTER	34		/* Sitara cluster protocol */
261#define	AF_ARP		35
262#define	AF_BLUETOOTH	36		/* Bluetooth sockets */
263#define	AF_IEEE80211	37		/* IEEE 802.11 protocol */
264#define	AF_NETLINK	38		/* Netlink protocol */
265#define	AF_INET_SDP	40		/* OFED Socket Direct Protocol ipv4 */
266#define	AF_INET6_SDP	42		/* OFED Socket Direct Protocol ipv6 */
267#define	AF_HYPERV	43		/* HyperV sockets */
268#define	AF_DIVERT	44		/* divert(4) */
269#define	AF_MAX		44
270/*
271 * When allocating a new AF_ constant, please only allocate
272 * even numbered constants for FreeBSD until 134 as odd numbered AF_
273 * constants 39-133 are now reserved for vendors.
274 */
275#define AF_VENDOR00 39
276#define AF_VENDOR01 41
277#define AF_VENDOR03 45
278#define AF_VENDOR04 47
279#define AF_VENDOR05 49
280#define AF_VENDOR06 51
281#define AF_VENDOR07 53
282#define AF_VENDOR08 55
283#define AF_VENDOR09 57
284#define AF_VENDOR10 59
285#define AF_VENDOR11 61
286#define AF_VENDOR12 63
287#define AF_VENDOR13 65
288#define AF_VENDOR14 67
289#define AF_VENDOR15 69
290#define AF_VENDOR16 71
291#define AF_VENDOR17 73
292#define AF_VENDOR18 75
293#define AF_VENDOR19 77
294#define AF_VENDOR20 79
295#define AF_VENDOR21 81
296#define AF_VENDOR22 83
297#define AF_VENDOR23 85
298#define AF_VENDOR24 87
299#define AF_VENDOR25 89
300#define AF_VENDOR26 91
301#define AF_VENDOR27 93
302#define AF_VENDOR28 95
303#define AF_VENDOR29 97
304#define AF_VENDOR30 99
305#define AF_VENDOR31 101
306#define AF_VENDOR32 103
307#define AF_VENDOR33 105
308#define AF_VENDOR34 107
309#define AF_VENDOR35 109
310#define AF_VENDOR36 111
311#define AF_VENDOR37 113
312#define AF_VENDOR38 115
313#define AF_VENDOR39 117
314#define AF_VENDOR40 119
315#define AF_VENDOR41 121
316#define AF_VENDOR42 123
317#define AF_VENDOR43 125
318#define AF_VENDOR44 127
319#define AF_VENDOR45 129
320#define AF_VENDOR46 131
321#define AF_VENDOR47 133
322#endif
323
324/*
325 * Structure used by kernel to store most
326 * addresses.
327 */
328struct sockaddr {
329	unsigned char	sa_len;		/* total length */
330	sa_family_t	sa_family;	/* address family */
331	char		sa_data[14];	/* actually longer; address value */
332};
333#if __BSD_VISIBLE
334#define	SOCK_MAXADDRLEN	255		/* longest possible addresses */
335
336/*
337 * Structure used by kernel to pass protocol
338 * information in raw sockets.
339 */
340struct sockproto {
341	unsigned short	sp_family;		/* address family */
342	unsigned short	sp_protocol;		/* protocol */
343};
344#endif
345
346#include <sys/_sockaddr_storage.h>
347
348#if __BSD_VISIBLE
349/*
350 * Protocol families, same as address families for now.
351 */
352#define	PF_UNSPEC	AF_UNSPEC
353#define	PF_LOCAL	AF_LOCAL
354#define	PF_UNIX		PF_LOCAL	/* backward compatibility */
355#define	PF_INET		AF_INET
356#define	PF_IMPLINK	AF_IMPLINK
357#define	PF_PUP		AF_PUP
358#define	PF_CHAOS	AF_CHAOS
359#define	PF_NETBIOS	AF_NETBIOS
360#define	PF_ISO		AF_ISO
361#define	PF_OSI		AF_ISO
362#define	PF_ECMA		AF_ECMA
363#define	PF_DATAKIT	AF_DATAKIT
364#define	PF_CCITT	AF_CCITT
365#define	PF_SNA		AF_SNA
366#define PF_DECnet	AF_DECnet
367#define PF_DLI		AF_DLI
368#define PF_LAT		AF_LAT
369#define	PF_HYLINK	AF_HYLINK
370#define	PF_APPLETALK	AF_APPLETALK
371#define	PF_ROUTE	AF_ROUTE
372#define	PF_LINK		AF_LINK
373#define	PF_XTP		pseudo_AF_XTP	/* really just proto family, no AF */
374#define	PF_COIP		AF_COIP
375#define	PF_CNT		AF_CNT
376#define	PF_SIP		AF_SIP
377#define	PF_IPX		AF_IPX
378#define PF_RTIP		pseudo_AF_RTIP	/* same format as AF_INET */
379#define PF_PIP		pseudo_AF_PIP
380#define	PF_ISDN		AF_ISDN
381#define	PF_KEY		pseudo_AF_KEY
382#define	PF_INET6	AF_INET6
383#define	PF_NATM		AF_NATM
384#define	PF_ATM		AF_ATM
385#define	PF_NETGRAPH	AF_NETGRAPH
386#define	PF_SLOW		AF_SLOW
387#define PF_SCLUSTER	AF_SCLUSTER
388#define	PF_ARP		AF_ARP
389#define	PF_BLUETOOTH	AF_BLUETOOTH
390#define	PF_IEEE80211	AF_IEEE80211
391#define	PF_NETLINK	AF_NETLINK
392#define	PF_INET_SDP	AF_INET_SDP
393#define	PF_INET6_SDP	AF_INET6_SDP
394#define	PF_DIVERT	AF_DIVERT
395
396#define	PF_MAX		AF_MAX
397
398/*
399 * Definitions for network related sysctl, CTL_NET.
400 *
401 * Second level is protocol family.
402 * Third level is protocol number.
403 *
404 * Further levels are defined by the individual families.
405 */
406
407/*
408 * PF_ROUTE - Routing table
409 *
410 * Three additional levels are defined:
411 *	Fourth: address family, 0 is wildcard
412 *	Fifth: type of info, defined below
413 *	Sixth: flag(s) to mask with for NET_RT_FLAGS
414 */
415#define NET_RT_DUMP	1		/* dump; may limit to a.f. */
416#define NET_RT_FLAGS	2		/* by flags, e.g. RESOLVING */
417#define NET_RT_IFLIST	3		/* survey interface list */
418#define	NET_RT_IFMALIST	4		/* return multicast address list */
419#define	NET_RT_IFLISTL	5		/* Survey interface list, using 'l'en
420					 * versions of msghdr structs. */
421#define NET_RT_NHOP	6		/* dump routing nexthops */
422#define NET_RT_NHGRP	7		/* dump routing nexthop groups */
423#endif /* __BSD_VISIBLE */
424
425/*
426 * Maximum queue length specifiable by listen.
427 */
428#define	SOMAXCONN	128
429
430/*
431 * Message header for recvmsg and sendmsg calls.
432 * Used value-result for recvmsg, value only for sendmsg.
433 */
434struct msghdr {
435	void		*msg_name;		/* optional address */
436	socklen_t	 msg_namelen;		/* size of address */
437	struct iovec	*msg_iov;		/* scatter/gather array */
438	int		 msg_iovlen;		/* # elements in msg_iov */
439	void		*msg_control;		/* ancillary data, see below */
440	socklen_t	 msg_controllen;	/* ancillary data buffer len */
441	int		 msg_flags;		/* flags on received message */
442};
443
444#define	MSG_OOB		 0x00000001	/* process out-of-band data */
445#define	MSG_PEEK	 0x00000002	/* peek at incoming message */
446#define	MSG_DONTROUTE	 0x00000004	/* send without using routing tables */
447#define	MSG_EOR		 0x00000008	/* data completes record */
448#define	MSG_TRUNC	 0x00000010	/* data discarded before delivery */
449#define	MSG_CTRUNC	 0x00000020	/* control data lost before delivery */
450#define	MSG_WAITALL	 0x00000040	/* wait for full request or error */
451#if __BSD_VISIBLE
452#define	MSG_DONTWAIT	 0x00000080	/* this message should be nonblocking */
453#define	MSG_EOF		 0x00000100	/* data completes connection */
454/*			 0x00000200	   unused */
455/*			 0x00000400	   unused */
456/*			 0x00000800	   unused */
457/*			 0x00001000	   unused */
458#define	MSG_NOTIFICATION 0x00002000	/* SCTP notification */
459#define	MSG_NBIO	 0x00004000	/* FIONBIO mode, used by fifofs */
460#define	MSG_COMPAT       0x00008000		/* used in sendit() */
461#endif
462#ifdef _KERNEL
463#define	MSG_SOCALLBCK    0x00010000	/* for use by socket callbacks - soreceive (TCP) */
464#endif
465#if __POSIX_VISIBLE >= 200809
466#define	MSG_NOSIGNAL	 0x00020000	/* do not generate SIGPIPE on EOF */
467#endif
468#if __BSD_VISIBLE
469#define	MSG_CMSG_CLOEXEC 0x00040000	/* make received fds close-on-exec */
470#define	MSG_WAITFORONE	 0x00080000	/* for recvmmsg() */
471#endif
472#ifdef _KERNEL
473#define	MSG_MORETOCOME	 0x00100000	/* additional data pending */
474#define	MSG_TLSAPPDATA	 0x00200000	/* do not soreceive() alert rec. (TLS) */
475#endif
476
477/*
478 * Header for ancillary data objects in msg_control buffer.
479 * Used for additional information with/about a datagram
480 * not expressible by flags.  The format is a sequence
481 * of message elements headed by cmsghdr structures.
482 */
483struct cmsghdr {
484	socklen_t	cmsg_len;		/* data byte count, including hdr */
485	int		cmsg_level;		/* originating protocol */
486	int		cmsg_type;		/* protocol-specific type */
487/* followed by	u_char  cmsg_data[]; */
488};
489
490#if __BSD_VISIBLE
491/*
492 * While we may have more groups than this, the cmsgcred struct must
493 * be able to fit in an mbuf and we have historically supported a
494 * maximum of 16 groups.
495*/
496#define CMGROUP_MAX 16
497
498/*
499 * Credentials structure, used to verify the identity of a peer
500 * process that has sent us a message. This is allocated by the
501 * peer process but filled in by the kernel. This prevents the
502 * peer from lying about its identity. (Note that cmcred_groups[0]
503 * is the effective GID.)
504 */
505struct cmsgcred {
506	pid_t	cmcred_pid;		/* PID of sending process */
507	uid_t	cmcred_uid;		/* real UID of sending process */
508	uid_t	cmcred_euid;		/* effective UID of sending process */
509	gid_t	cmcred_gid;		/* real GID of sending process */
510	short	cmcred_ngroups;		/* number or groups */
511	gid_t	cmcred_groups[CMGROUP_MAX];	/* groups */
512};
513
514/*
515 * Socket credentials (LOCAL_CREDS).
516 */
517struct sockcred {
518	uid_t	sc_uid;			/* real user id */
519	uid_t	sc_euid;		/* effective user id */
520	gid_t	sc_gid;			/* real group id */
521	gid_t	sc_egid;		/* effective group id */
522	int	sc_ngroups;		/* number of supplemental groups */
523	gid_t	sc_groups[1];		/* variable length */
524};
525
526/*
527 * Compute size of a sockcred structure with groups.
528 */
529#define	SOCKCREDSIZE(ngrps) \
530	(sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1)))
531
532/*
533 * Socket credentials (LOCAL_CREDS_PERSISTENT).
534 */
535struct sockcred2 {
536	int	sc_version;		/* version of this structure */
537	pid_t	sc_pid;			/* PID of sending process */
538	uid_t	sc_uid;			/* real user id */
539	uid_t	sc_euid;		/* effective user id */
540	gid_t	sc_gid;			/* real group id */
541	gid_t	sc_egid;		/* effective group id */
542	int	sc_ngroups;		/* number of supplemental groups */
543	gid_t	sc_groups[1];		/* variable length */
544};
545#define	SOCKCRED2SIZE(ngrps) \
546	(sizeof(struct sockcred2) + (sizeof(gid_t) * ((ngrps) - 1)))
547
548#endif /* __BSD_VISIBLE */
549
550/* given pointer to struct cmsghdr, return pointer to data */
551#define	CMSG_DATA(cmsg)		((unsigned char *)(cmsg) + \
552				 _ALIGN(sizeof(struct cmsghdr)))
553
554/* given pointer to struct cmsghdr, return pointer to next cmsghdr */
555#define	CMSG_NXTHDR(mhdr, cmsg)	\
556	((char *)(cmsg) == (char *)0 ? CMSG_FIRSTHDR(mhdr) : \
557	    ((char *)(cmsg) + _ALIGN(((struct cmsghdr *)(cmsg))->cmsg_len) + \
558	  _ALIGN(sizeof(struct cmsghdr)) > \
559	    (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
560	    (struct cmsghdr *)0 : \
561	    (struct cmsghdr *)(void *)((char *)(cmsg) + \
562	    _ALIGN(((struct cmsghdr *)(cmsg))->cmsg_len)))
563
564/*
565 * RFC 2292 requires to check msg_controllen, in case that the kernel returns
566 * an empty list for some reasons.
567 */
568#define	CMSG_FIRSTHDR(mhdr) \
569	((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
570	 (struct cmsghdr *)(mhdr)->msg_control : \
571	 (struct cmsghdr *)0)
572
573#if __BSD_VISIBLE
574/* RFC 2292 additions */
575#define	CMSG_SPACE(l)		(_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l))
576#define	CMSG_LEN(l)		(_ALIGN(sizeof(struct cmsghdr)) + (l))
577#endif
578
579#ifdef _KERNEL
580#define	CMSG_ALIGN(n)	_ALIGN(n)
581#endif
582
583/* "Socket"-level control message types: */
584#define	SCM_RIGHTS	0x01		/* access rights (array of int) */
585#if __BSD_VISIBLE
586#define	SCM_TIMESTAMP	0x02		/* timestamp (struct timeval) */
587#define	SCM_CREDS	0x03		/* process creds (struct cmsgcred) */
588#define	SCM_BINTIME	0x04		/* timestamp (struct bintime) */
589#define	SCM_REALTIME	0x05		/* timestamp (struct timespec) */
590#define	SCM_MONOTONIC	0x06		/* timestamp (struct timespec) */
591#define	SCM_TIME_INFO	0x07		/* timestamp info */
592#define	SCM_CREDS2	0x08		/* process creds (struct sockcred2) */
593
594struct sock_timestamp_info {
595	__uint32_t	st_info_flags;
596	__uint32_t	st_info_pad0;
597	__uint64_t	st_info_rsv[7];
598};
599
600#define	ST_INFO_HW		0x0001		/* SCM_TIMESTAMP was hw */
601#define	ST_INFO_HW_HPREC	0x0002		/* SCM_TIMESTAMP was hw-assisted
602						   on entrance */
603#endif
604
605#if __BSD_VISIBLE
606/*
607 * 4.3 compat sockaddr, move to compat file later
608 */
609struct osockaddr {
610	unsigned short sa_family;	/* address family */
611	char	sa_data[14];		/* up to 14 bytes of direct address */
612};
613
614/*
615 * 4.3-compat message header (move to compat file later).
616 */
617struct omsghdr {
618	char	*msg_name;		/* optional address */
619	int	msg_namelen;		/* size of address */
620	struct	iovec *msg_iov;		/* scatter/gather array */
621	int	msg_iovlen;		/* # elements in msg_iov */
622	char	*msg_accrights;		/* access rights sent/received */
623	int	msg_accrightslen;
624};
625#endif
626
627/*
628 * howto arguments for shutdown(2), specified by Posix.1g.
629 */
630enum shutdown_how {
631	SHUT_RD = 0,		/* shut down the reading side */
632#define	SHUT_RD		SHUT_RD
633	SHUT_WR,		/* shut down the writing side */
634#define	SHUT_WR		SHUT_WR
635	SHUT_RDWR		/* shut down both sides */
636#define	SHUT_RDWR	SHUT_RDWR
637};
638
639#if __BSD_VISIBLE
640/*
641 * sendfile(2) header/trailer struct
642 */
643struct sf_hdtr {
644	struct iovec *headers;	/* pointer to an array of header struct iovec's */
645	int hdr_cnt;		/* number of header iovec's */
646	struct iovec *trailers;	/* pointer to an array of trailer struct iovec's */
647	int trl_cnt;		/* number of trailer iovec's */
648};
649
650/*
651 * Sendfile-specific flag(s)
652 */
653#define	SF_NODISKIO     0x00000001
654#define	SF_MNOWAIT	0x00000002	/* obsolete */
655#define	SF_SYNC		0x00000004
656#define	SF_USER_READAHEAD	0x00000008
657#define	SF_NOCACHE	0x00000010
658#define	SF_FLAGS(rh, flags)	(((rh) << 16) | (flags))
659
660#ifdef _KERNEL
661#define	SF_READAHEAD(flags)	((flags) >> 16)
662#endif /* _KERNEL */
663
664/*
665 * Sendmmsg/recvmmsg specific structure(s)
666 */
667struct mmsghdr {
668	struct msghdr	msg_hdr;		/* message header */
669	ssize_t		msg_len;		/* message length */
670};
671#endif /* __BSD_VISIBLE */
672
673#ifndef	_KERNEL
674
675#include <sys/cdefs.h>
676
677__BEGIN_DECLS
678int	accept(int, struct sockaddr * __restrict, socklen_t * __restrict);
679int	bind(int, const struct sockaddr *, socklen_t);
680int	connect(int, const struct sockaddr *, socklen_t);
681#if __BSD_VISIBLE
682int	accept4(int, struct sockaddr * __restrict, socklen_t * __restrict, int);
683int	bindat(int, int, const struct sockaddr *, socklen_t);
684int	connectat(int, int, const struct sockaddr *, socklen_t);
685#endif
686int	getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict);
687int	getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict);
688int	getsockopt(int, int, int, void * __restrict, socklen_t * __restrict);
689int	listen(int, int);
690ssize_t	recv(int, void *, size_t, int);
691ssize_t	recvfrom(int, void *, size_t, int, struct sockaddr * __restrict, socklen_t * __restrict);
692ssize_t	recvmsg(int, struct msghdr *, int);
693#if __BSD_VISIBLE
694struct timespec;
695ssize_t	recvmmsg(int, struct mmsghdr * __restrict, size_t, int,
696    const struct timespec * __restrict);
697#endif
698ssize_t	send(int, const void *, size_t, int);
699ssize_t	sendto(int, const void *,
700	    size_t, int, const struct sockaddr *, socklen_t);
701ssize_t	sendmsg(int, const struct msghdr *, int);
702#if __BSD_VISIBLE
703int	sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
704ssize_t	sendmmsg(int, struct mmsghdr * __restrict, size_t, int);
705int	setfib(int);
706#endif
707int	setsockopt(int, int, int, const void *, socklen_t);
708int	shutdown(int, int);
709int	sockatmark(int);
710int	socket(int, int, int);
711int	socketpair(int, int, int, int *);
712__END_DECLS
713
714#endif /* !_KERNEL */
715
716#ifdef _KERNEL
717struct socket;
718
719int so_options_get(const struct socket *);
720void so_options_set(struct socket *, int);
721
722int so_error_get(const struct socket *);
723void so_error_set(struct socket *, int);
724#endif /* _KERNEL */
725#endif /* !_SYS_SOCKET_H_ */
726