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