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