Home | History | Annotate | Line # | Download | only in sys
      1 /*	$NetBSD: socket.h,v 1.134 2025/07/25 23:24:46 kre Exp $	*/
      2 
      3 /*
      4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
      5  * 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 project 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 PROJECT 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 PROJECT 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 /*
     33  * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
     34  *	The Regents of the University of California.  All rights reserved.
     35  *
     36  * Redistribution and use in source and binary forms, with or without
     37  * modification, are permitted provided that the following conditions
     38  * are met:
     39  * 1. Redistributions of source code must retain the above copyright
     40  *    notice, this list of conditions and the following disclaimer.
     41  * 2. Redistributions in binary form must reproduce the above copyright
     42  *    notice, this list of conditions and the following disclaimer in the
     43  *    documentation and/or other materials provided with the distribution.
     44  * 3. Neither the name of the University nor the names of its contributors
     45  *    may be used to endorse or promote products derived from this software
     46  *    without specific prior written permission.
     47  *
     48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     58  * SUCH DAMAGE.
     59  *
     60  *	@(#)socket.h	8.6 (Berkeley) 5/3/95
     61  */
     62 
     63 #ifndef _SYS_SOCKET_H_
     64 #define	_SYS_SOCKET_H_
     65 
     66 #include <sys/featuretest.h>
     67 
     68 /*
     69  * Definitions related to sockets: types, address families, options.
     70  */
     71 
     72 /*
     73  * Data types.
     74  */
     75 #include <sys/ansi.h>
     76 
     77 #ifndef sa_family_t
     78 typedef __sa_family_t	sa_family_t;
     79 #define sa_family_t	__sa_family_t
     80 #endif
     81 
     82 #ifndef socklen_t
     83 typedef __socklen_t	socklen_t;
     84 #define socklen_t	__socklen_t
     85 #endif
     86 
     87 #include <machine/ansi.h>
     88 
     89 #ifdef	_BSD_SIZE_T_
     90 typedef	_BSD_SIZE_T_	size_t;
     91 #undef	_BSD_SIZE_T_
     92 #endif
     93 
     94 #ifdef	_BSD_SSIZE_T_
     95 typedef	_BSD_SSIZE_T_	ssize_t;
     96 #undef	_BSD_SSIZE_T_
     97 #endif
     98 
     99 #include <sys/uio.h>
    100 #include <sys/sigtypes.h>
    101 
    102 /*
    103  * Socket types.
    104  */
    105 #define	SOCK_STREAM	1		/* stream socket */
    106 #define	SOCK_DGRAM	2		/* datagram socket */
    107 #define	SOCK_RAW	3		/* raw-protocol interface */
    108 #define	SOCK_RDM	4		/* reliably-delivered message */
    109 #define	SOCK_SEQPACKET	5		/* sequenced packet stream */
    110 #define	SOCK_CONN_DGRAM	6		/* connection-orientated datagram */
    111 #define	SOCK_DCCP	SOCK_CONN_DGRAM
    112 
    113 #define	SOCK_CLOEXEC	0x10000000	/* set close on exec on socket */
    114 #define	SOCK_NONBLOCK	0x20000000	/* set non blocking i/o socket */
    115 #define	SOCK_NOSIGPIPE	0x40000000	/* don't send sigpipe */
    116 #define	SOCK_CLOFORK	0x80000000	/* set close on fork on socket */
    117 #define	SOCK_FLAGS_MASK	0xf0000000	/* flags mask */
    118 
    119 /*
    120  * Option flags per-socket.
    121  */
    122 #define	SO_DEBUG	0x0001		/* turn on debugging info recording */
    123 #define	SO_ACCEPTCONN	0x0002		/* socket has had listen() */
    124 #define	SO_REUSEADDR	0x0004		/* allow local address reuse */
    125 #define	SO_KEEPALIVE	0x0008		/* keep connections alive */
    126 #define	SO_DONTROUTE	0x0010		/* just use interface addresses */
    127 #define	SO_BROADCAST	0x0020		/* permit sending of broadcast msgs */
    128 #define	SO_USELOOPBACK	0x0040		/* bypass hardware when possible */
    129 #define	SO_LINGER	0x0080		/* linger on close if data present */
    130 #define	SO_OOBINLINE	0x0100		/* leave received OOB data in line */
    131 #define	SO_REUSEPORT	0x0200		/* allow local address & port reuse */
    132 /* 	SO_OTIMESTAMP	0x0400		*/
    133 #define	SO_NOSIGPIPE	0x0800		/* no SIGPIPE from EPIPE */
    134 #define	SO_ACCEPTFILTER	0x1000		/* there is an accept filter */
    135 #define	SO_TIMESTAMP	0x2000		/* timestamp received dgram traffic */
    136 #define	SO_RERROR	0x4000		/* Keep track of receive errors */
    137 
    138 /* Allowed default option flags */
    139 #define SO_DEFOPTS	(SO_DEBUG|SO_REUSEADDR|SO_KEEPALIVE|SO_DONTROUTE| \
    140     SO_BROADCAST|SO_USELOOPBACK|SO_LINGER|SO_OOBINLINE|SO_REUSEPORT| \
    141     SO_NOSIGPIPE|SO_TIMESTAMP|SO_RERROR)
    142 
    143 #define __SO_OPTION_BITS \
    144 	"\20" \
    145 	"\1SO_DEBUG" \
    146 	"\2SO_ACCEPTCONN" \
    147 	"\3SO_REUSEADDR" \
    148 	"\4SO_KEEPALIVE" \
    149 	"\5SO_DONTROUTE" \
    150 	"\6SO_BROADCAST" \
    151 	"\7SO_USELOOPBACK" \
    152 	"\10SO_LINGER" \
    153 	"\11SO_OOBINLINE" \
    154 	"\12SO_REUSEPORT" \
    155 	"\13SO_OTIMESTAMP" \
    156 	"\14SO_NOSIGPIPE" \
    157 	"\15SO_ACCEPTFILTER" \
    158 	"\16SO_TIMESTAMP" \
    159 	"\17SO_RERROR"
    160 
    161 /*
    162  * Additional options, not kept in so_options.
    163  */
    164 #define SO_SNDBUF	0x1001		/* send buffer size */
    165 #define SO_RCVBUF	0x1002		/* receive buffer size */
    166 #define SO_SNDLOWAT	0x1003		/* send low-water mark */
    167 #define SO_RCVLOWAT	0x1004		/* receive low-water mark */
    168 /* SO_OSNDTIMEO		0x1005 */
    169 /* SO_ORCVTIMEO		0x1006 */
    170 #define	SO_ERROR	0x1007		/* get error status and clear */
    171 #define	SO_TYPE		0x1008		/* get socket type */
    172 #define	SO_OVERFLOWED	0x1009		/* datagrams: return packets dropped */
    173 
    174 #define	SO_NOHEADER	0x100a		/* user supplies no header to kernel;
    175 					 * kernel removes header and supplies
    176 					 * payload
    177 					 */
    178 #define SO_SNDTIMEO	0x100b		/* send timeout */
    179 #define SO_RCVTIMEO	0x100c		/* receive timeout */
    180 /*
    181  * Structure used for manipulating linger option.
    182  */
    183 struct	linger {
    184 	int	l_onoff;		/* option on/off */
    185 	int	l_linger;		/* linger time in seconds */
    186 };
    187 
    188 struct	accept_filter_arg {
    189 	char	af_name[16];
    190 	char	af_arg[256-16];
    191 };
    192 
    193 /*
    194  * Level number for (get/set)sockopt() to apply to socket itself.
    195  */
    196 #define	SOL_SOCKET	0xffff		/* options for socket level */
    197 
    198 /*
    199  * Address families.
    200  */
    201 #define	AF_UNSPEC	0		/* unspecified */
    202 #define	AF_LOCAL	1		/* local to host */
    203 #define	AF_UNIX		AF_LOCAL	/* backward compatibility */
    204 #define	AF_INET		2		/* internetwork: UDP, TCP, etc. */
    205 #define	AF_IMPLINK	3		/* arpanet imp addresses */
    206 #define	AF_PUP		4		/* pup protocols: e.g. BSP */
    207 #define	AF_CHAOS	5		/* mit CHAOS protocols */
    208 #define	AF_NS		6		/* XEROX NS protocols */
    209 #define	AF_ISO		7		/* ISO protocols */
    210 #define	AF_OSI		AF_ISO
    211 #define	AF_ECMA		8		/* european computer manufacturers */
    212 #define	AF_DATAKIT	9		/* datakit protocols */
    213 #define	AF_CCITT	10		/* CCITT protocols, X.25 etc */
    214 #define	AF_SNA		11		/* IBM SNA */
    215 #define AF_DECnet	12		/* DECnet */
    216 #define AF_DLI		13		/* DEC Direct data link interface */
    217 #define AF_LAT		14		/* LAT */
    218 #define	AF_HYLINK	15		/* NSC Hyperchannel */
    219 #define	AF_APPLETALK	16		/* Apple Talk */
    220 #define	AF_OROUTE	17		/* Internal Routing Protocol */
    221 #define	AF_LINK		18		/* Link layer interface */
    222 #if defined(_NETBSD_SOURCE)
    223 #define	pseudo_AF_XTP	19		/* eXpress Transfer Protocol (no AF) */
    224 #endif
    225 #define	AF_COIP		20		/* connection-oriented IP, aka ST II */
    226 #define	AF_CNT		21		/* Computer Network Technology */
    227 #if defined(_NETBSD_SOURCE)
    228 #define pseudo_AF_RTIP	22		/* Help Identify RTIP packets */
    229 #endif
    230 #define	AF_IPX		23		/* Novell Internet Protocol */
    231 #define	AF_INET6	24		/* IP version 6 */
    232 #if defined(_NETBSD_SOURCE)
    233 #define pseudo_AF_PIP	25		/* Help Identify PIP packets */
    234 #endif
    235 #define AF_ISDN		26		/* Integrated Services Digital Network*/
    236 #define AF_E164		AF_ISDN		/* CCITT E.164 recommendation */
    237 #define AF_NATM		27		/* native ATM access */
    238 #define AF_ARP		28		/* (rev.) addr. res. prot. (RFC 826) */
    239 #if defined(_NETBSD_SOURCE)
    240 #define pseudo_AF_KEY	29		/* Internal key management protocol  */
    241 #define	pseudo_AF_HDRCMPLT 30		/* Used by BPF to not rewrite hdrs
    242 					   in interface output routine */
    243 #endif
    244 #define AF_BLUETOOTH	31		/* Bluetooth: HCI, SCO, L2CAP, RFCOMM */
    245 #define	AF_IEEE80211	32		/* IEEE80211 */
    246 #define	AF_MPLS		33		/* MultiProtocol Label Switching */
    247 #define	AF_ROUTE	34		/* Internal Routing Protocol */
    248 #define	AF_CAN		35
    249 #define	AF_ETHER	36
    250 #define	AF_MAX		37
    251 
    252 /*
    253  * Structure used by kernel to store most
    254  * addresses.
    255  */
    256 struct sockaddr {
    257 	__uint8_t	sa_len;		/* total length */
    258 	sa_family_t	sa_family;	/* address family */
    259 	char		sa_data[14];	/* actually longer; address value */
    260 };
    261 
    262 #if defined(_KERNEL)
    263 /*
    264  * Structure used by kernel to pass protocol
    265  * information in raw sockets.
    266  */
    267 struct sockproto {
    268 	u_short	sp_family;		/* address family */
    269 	u_short	sp_protocol;		/* protocol */
    270 };
    271 
    272 /*
    273  * we make the entire struct at least UCHAR_MAX + 1 in size since existing
    274  * use of sockaddr_un permits a path up to 253 bytes + '\0'.
    275  * sizeof(sb_len) + sizeof(sb_family) + 253 + '\0'
    276  */
    277 #define _SB_DATASIZE	254
    278 struct sockaddr_big {
    279     union {
    280 	struct {
    281 	    __uint8_t	sb_len;
    282 	    sa_family_t	sb_family;
    283 	    char	sb_data[_SB_DATASIZE];
    284 	};
    285 	uint64_t dummy; /* solicit natural alignment */
    286     };
    287 };
    288 
    289 #endif /* _KERNEL */
    290 
    291 /*
    292  * RFC 2553: protocol-independent placeholder for socket addresses
    293  */
    294 #define _SS_MAXSIZE	128
    295 #define _SS_ALIGNSIZE	(sizeof(__int64_t))
    296 #define _SS_PAD1SIZE	(_SS_ALIGNSIZE - 2)
    297 #define _SS_PAD2SIZE	(_SS_MAXSIZE - 2 - _SS_PAD1SIZE - _SS_ALIGNSIZE)
    298 
    299 struct sockaddr_storage {
    300 	__uint8_t	ss_len;		/* address length */
    301 	sa_family_t	ss_family;	/* address family */
    302 	char		__ss_pad1[_SS_PAD1SIZE];
    303 	__int64_t     __ss_align;/* force desired structure storage alignment */
    304 	char		__ss_pad2[_SS_PAD2SIZE];
    305 };
    306 
    307 #if defined(_NETBSD_SOURCE)
    308 #define	sstosa(__ss)	((struct sockaddr *)(__ss))
    309 #define	sstocsa(__ss)	((const struct sockaddr *)(__ss))
    310 #endif /* _NETBSD_SOURCE */
    311 
    312 /*
    313  * Protocol families, same as address families for now.
    314  */
    315 #define	PF_UNSPEC	AF_UNSPEC
    316 #define	PF_LOCAL	AF_LOCAL
    317 #define	PF_UNIX		PF_LOCAL	/* backward compatibility */
    318 #define	PF_INET		AF_INET
    319 #define	PF_IMPLINK	AF_IMPLINK
    320 #define	PF_PUP		AF_PUP
    321 #define	PF_CHAOS	AF_CHAOS
    322 #define	PF_NS		AF_NS
    323 #define	PF_ISO		AF_ISO
    324 #define	PF_OSI		AF_ISO
    325 #define	PF_ECMA		AF_ECMA
    326 #define	PF_DATAKIT	AF_DATAKIT
    327 #define	PF_CCITT	AF_CCITT
    328 #define	PF_SNA		AF_SNA
    329 #define PF_DECnet	AF_DECnet
    330 #define PF_DLI		AF_DLI
    331 #define PF_LAT		AF_LAT
    332 #define	PF_HYLINK	AF_HYLINK
    333 #define	PF_APPLETALK	AF_APPLETALK
    334 #define	PF_OROUTE	AF_OROUTE
    335 #define	PF_LINK		AF_LINK
    336 #if defined(_NETBSD_SOURCE)
    337 #define	PF_XTP		pseudo_AF_XTP	/* really just proto family, no AF */
    338 #endif
    339 #define	PF_COIP		AF_COIP
    340 #define	PF_CNT		AF_CNT
    341 #define	PF_INET6	AF_INET6
    342 #define	PF_IPX		AF_IPX		/* same format as AF_NS */
    343 #if defined(_NETBSD_SOURCE)
    344 #define PF_RTIP		pseudo_AF_RTIP	/* same format as AF_INET */
    345 #define PF_PIP		pseudo_AF_PIP
    346 #endif
    347 #define PF_ISDN		AF_ISDN		/* same as E164 */
    348 #define PF_E164		AF_E164
    349 #define PF_NATM		AF_NATM
    350 #define PF_ARP		AF_ARP
    351 #if defined(_NETBSD_SOURCE)
    352 #define PF_KEY 		pseudo_AF_KEY	/* like PF_ROUTE, only for key mgmt */
    353 #endif
    354 #define PF_BLUETOOTH	AF_BLUETOOTH
    355 #define	PF_MPLS		AF_MPLS
    356 #define	PF_ROUTE	AF_ROUTE
    357 #define	PF_CAN		AF_CAN
    358 #define	PF_ETHER	AF_ETHER
    359 
    360 #define	PF_MAX		AF_MAX
    361 
    362 #if defined(_NETBSD_SOURCE)
    363 
    364 #ifndef pid_t
    365 typedef __pid_t		pid_t;		/* process id */
    366 #define pid_t		__pid_t
    367 #endif
    368 
    369 #ifndef	gid_t
    370 typedef	__gid_t		gid_t;		/* group id */
    371 #define	gid_t		__gid_t
    372 #endif
    373 
    374 #ifndef	uid_t
    375 typedef	__uid_t		uid_t;		/* user id */
    376 #define	uid_t		__uid_t
    377 #endif
    378 
    379 /*
    380  * Socket credentials.
    381  */
    382 struct sockcred {
    383 	pid_t	sc_pid;			/* process id */
    384 	uid_t	sc_uid;			/* real user id */
    385 	uid_t	sc_euid;		/* effective user id */
    386 	gid_t	sc_gid;			/* real group id */
    387 	gid_t	sc_egid;		/* effective group id */
    388 	int	sc_ngroups;		/* number of supplemental groups */
    389 	gid_t	sc_groups[1];		/* variable length */
    390 };
    391 
    392 /*
    393  * Compute size of a sockcred structure with groups.
    394  *
    395  * The (ngrps - 1) is to account for struct sockcred being defined with
    396  * already one group member. This code works correctly when ngroups == 0
    397  * because of unsigned arithmetic wrap-around.
    398  */
    399 #define	SOCKCREDSIZE(ngrps) \
    400 	(/*LINTED*/sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1)))
    401 #endif /* _NETBSD_SOURCE */
    402 
    403 
    404 #if defined(_NETBSD_SOURCE)
    405 /* Definition for CTL_NET PCB fetching sysctls */
    406 struct kinfo_pcb {
    407 	__uint64_t	ki_pcbaddr;	/* PTR: pcb addr */
    408 	__uint64_t	ki_ppcbaddr;	/* PTR: ppcb addr */
    409 	__uint64_t	ki_sockaddr;	/* PTR: socket addr */
    410 
    411 	__uint32_t	ki_family;	/* INT: protocol family */
    412 	__uint32_t	ki_type;	/* INT: socket type */
    413 	__uint32_t	ki_protocol;	/* INT: protocol */
    414 	__uint32_t	ki_pflags;	/* INT: generic protocol flags */
    415 
    416 	__uint32_t	ki_sostate;	/* INT: socket state */
    417 	__uint32_t	ki_prstate;	/* INT: protocol state */
    418 	__int32_t	ki_tstate;	/* INT: tcp state */
    419 	__uint32_t	ki_tflags;	/* INT: tcp flags */
    420 
    421 	__uint64_t	ki_rcvq;	/* U_LONG: receive queue len */
    422 	__uint64_t	ki_sndq;	/* U_LONG: send queue len */
    423 
    424 	union {
    425 		struct sockaddr	_kis_src; /* STRUCT: local address */
    426 		char _kis_pad[256 + 8];		/* pad to max addr length */
    427 	} ki_s;
    428 	union {
    429 		struct sockaddr	_kid_dst; /* STRUCT: remote address */
    430 		char _kid_pad[256 + 8];		/* pad to max addr length */
    431 	} ki_d;
    432 
    433 	__uint64_t	ki_inode;	/* INO_T: fake inode number */
    434 	__uint64_t	ki_vnode;	/* PTR: if associated with file */
    435 	__uint64_t	ki_conn;	/* PTR: control block of peer */
    436 	__uint64_t	ki_refs;	/* PTR: referencing socket */
    437 	__uint64_t	ki_nextref;	/* PTR: link in refs list */
    438 };
    439 
    440 #define ki_src ki_s._kis_src
    441 #define ki_dst ki_d._kid_dst
    442 #define ki_spad ki_s._kis_pad
    443 #define ki_dpad ki_d._kid_pad
    444 
    445 #define PCB_SLOP		20
    446 #define PCB_ALL			0
    447 
    448 #endif /* _NETBSD_SOURCE */
    449 
    450 #if defined(_NETBSD_SOURCE)
    451 /*
    452  * PF_ROUTE - Routing table
    453  *
    454  * Three additional levels are defined:
    455  *	Fourth: address family, 0 is wildcard
    456  *	Fifth: type of info, defined below
    457  *	Sixth: flag(s) to mask with for NET_RT_FLAGS
    458  */
    459 #define	NET_RT_DUMP		1	/* dump; may limit to a.f. */
    460 #define	NET_RT_FLAGS		2	/* by flags, e.g. RESOLVING */
    461 #define	NET_RT_OOOIFLIST	3	/* old NET_RT_IFLIST (pre 1.5) */
    462 #define	NET_RT_OOIFLIST		4	/* old NET_RT_IFLIST (pre-64bit time) */
    463 #define	NET_RT_OIFLIST		5	/* old NET_RT_IFLIST (pre 8.0) */
    464 #define	NET_RT_IFLIST		6	/* survey interface list */
    465 
    466 #endif /* _NETBSD_SOURCE */
    467 
    468 /*
    469  * Maximum queue length specifiable by listen(2).
    470  */
    471 #ifndef SOMAXCONN
    472 #define	SOMAXCONN	128
    473 #endif
    474 
    475 #include <sys/cdefs.h>
    476 
    477 /*
    478  * Message header for recvmsg and sendmsg calls.
    479  * Used value-result for recvmsg, value only for sendmsg.
    480  */
    481 struct msghdr {
    482 	void		*msg_name;	/* optional address */
    483 	socklen_t	msg_namelen;	/* size of address */
    484 	struct iovec	*msg_iov;	/* scatter/gather array */
    485 	int		msg_iovlen;	/* # elements in msg_iov */
    486 	void		*msg_control;	/* ancillary data, see below */
    487 	socklen_t	msg_controllen;	/* ancillary data buffer len */
    488 	int		msg_flags;	/* flags on received message */
    489 };
    490 
    491 #define	MSG_OOB		0x0001		/* process out-of-band data */
    492 #define	MSG_PEEK	0x0002		/* peek at incoming message */
    493 #define	MSG_DONTROUTE	0x0004		/* send without using routing tables */
    494 #define	MSG_EOR		0x0008		/* data completes record */
    495 #define	MSG_TRUNC	0x0010		/* data discarded before delivery */
    496 #define	MSG_CTRUNC	0x0020		/* control data lost before delivery */
    497 #define	MSG_WAITALL	0x0040		/* wait for full request or error */
    498 #define	MSG_DONTWAIT	0x0080		/* this message should be nonblocking */
    499 #define	MSG_BCAST	0x0100		/* this message was rcvd using link-level brdcst */
    500 #define	MSG_MCAST	0x0200		/* this message was rcvd using link-level mcast */
    501 #define	MSG_NOSIGNAL	0x0400		/* do not generate SIGPIPE on EOF */
    502 #if defined(_NETBSD_SOURCE)
    503 #define	MSG_CMSG_CLOEXEC 0x0800		/* close on exec receiving fd */
    504 #define	MSG_NBIO	0x1000		/* use non-blocking I/O */
    505 #define	MSG_WAITFORONE	0x2000		/* recvmmsg() wait for one message */
    506 #define	MSG_NOTIFICATION 0x4000		/* SCTP notification */
    507 #define	MSG_CMSG_CLOFORK 0x8000		/* close on fork receiving fd */
    508 
    509 struct mmsghdr {
    510 	struct msghdr msg_hdr;
    511 	unsigned int msg_len;
    512 };
    513 #endif
    514 
    515 /* Extra flags used internally only */
    516 #define	MSG_USERFLAGS	0x0ffffff
    517 #define MSG_NAMEMBUF	0x1000000	/* msg_name is an mbuf */
    518 #define MSG_CONTROLMBUF	0x2000000	/* msg_control is an mbuf */
    519 #define MSG_IOVUSRSPACE	0x4000000	/* msg_iov is in user space */
    520 #define MSG_LENUSRSPACE	0x8000000	/* address length is in user space */
    521 
    522 /*
    523  * Header for ancillary data objects in msg_control buffer.
    524  * Used for additional information with/about a datagram
    525  * not expressible by flags.  The format is a sequence
    526  * of message elements headed by cmsghdr structures.
    527  */
    528 struct cmsghdr {
    529 	socklen_t	cmsg_len;	/* data byte count, including hdr */
    530 	int		cmsg_level;	/* originating protocol */
    531 	int		cmsg_type;	/* protocol-specific type */
    532 /* followed by unsigned char cmsg_data[]; */
    533 };
    534 
    535 /*
    536  * Alignment requirement for CMSG struct manipulation.
    537  * This basically behaves the same as ALIGN() ARCH/include/param.h.
    538  * We declare it separately for two reasons:
    539  * (1) avoid dependency between machine/param.h, and (2) to sync with kernel's
    540  * idea of ALIGNBYTES at runtime.
    541  * without (2), we can't guarantee binary compatibility in case of future
    542  * changes in ALIGNBYTES.
    543  */
    544 #define __CMSG_ALIGN(n)	(((n) + __ALIGNBYTES) & ~__ALIGNBYTES)
    545 
    546 #ifdef _KERNEL
    547 #define CMSG_ALIGN(n)	__CMSG_ALIGN(n)
    548 #endif
    549 
    550 #define __CMSG_ASIZE	__CMSG_ALIGN(sizeof(struct cmsghdr))
    551 #define __CMSG_MSGNEXT(cmsg) \
    552     (__CASTV(char *, cmsg) + __CMSG_ALIGN((cmsg)->cmsg_len))
    553 #define __CMSG_MSGEND(mhdr) \
    554     (__CASTV(char *, (mhdr)->msg_control) + (mhdr)->msg_controllen)
    555 
    556 /* given pointer to struct cmsghdr, return pointer to data */
    557 #define	CMSG_DATA(cmsg) (__CASTV(unsigned char *, cmsg) + __CMSG_ASIZE)
    558 #define	CCMSG_DATA(cmsg) (__CASTCV(const unsigned char *, cmsg) + __CMSG_ASIZE)
    559 
    560 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
    561 #define	CMSG_NXTHDR(mhdr, cmsg)	\
    562     __CASTV(struct cmsghdr *,  \
    563 	__CMSG_MSGNEXT(cmsg) + __CMSG_ASIZE > __CMSG_MSGEND(mhdr) ? 0 : \
    564 	__CMSG_MSGNEXT(cmsg))
    565 
    566 /*
    567  * RFC 2292 requires to check msg_controllen, in case that the kernel returns
    568  * an empty list for some reasons.
    569  */
    570 #define	CMSG_FIRSTHDR(mhdr) \
    571     __CASTV(struct cmsghdr *, \
    572 	(mhdr)->msg_controllen < sizeof(struct cmsghdr) ? 0 : \
    573 	(mhdr)->msg_control)
    574 
    575 #define CMSG_SPACE(l)	(__CMSG_ASIZE + __CMSG_ALIGN(l))
    576 #define CMSG_LEN(l)	(__CMSG_ASIZE + (l))
    577 
    578 /* "Socket"-level control message types: */
    579 #define	SCM_RIGHTS	0x01		/* access rights (array of int) */
    580 #if defined(_NETBSD_SOURCE)
    581 /*			0x02		   timestamp (struct timeval50) */
    582 /*			0x04		   credentials (struct sockcred70) */
    583 #define	SCM_TIMESTAMP	0x08		/* timestamp (struct timeval) */
    584 #define	SCM_CREDS	0x10		/* credentials (struct sockcred) */
    585 #endif
    586 
    587 /*
    588  * Types of socket shutdown(2).
    589  */
    590 #define	SHUT_RD		0		/* Disallow further receives. */
    591 #define	SHUT_WR		1		/* Disallow further sends. */
    592 #define	SHUT_RDWR	2		/* Disallow further sends/receives. */
    593 
    594 #ifdef	_KERNEL
    595 static __inline socklen_t
    596 sockaddr_getlen(const struct sockaddr *sa)
    597 {
    598 	return sa->sa_len;
    599 }
    600 
    601 __BEGIN_DECLS
    602 socklen_t sockaddr_getsize_by_family(sa_family_t);
    603 struct sockaddr *sockaddr_copy(struct sockaddr *, socklen_t,
    604     const struct sockaddr *);
    605 struct sockaddr *sockaddr_externalize(struct sockaddr *, socklen_t,
    606     const struct sockaddr *);
    607 struct sockaddr *sockaddr_alloc(sa_family_t, socklen_t, int);
    608 const void *sockaddr_const_addr(const struct sockaddr *, socklen_t *);
    609 void *sockaddr_addr(struct sockaddr *, socklen_t *);
    610 const struct sockaddr *sockaddr_any(const struct sockaddr *);
    611 const struct sockaddr *sockaddr_any_by_family(sa_family_t);
    612 const void *sockaddr_anyaddr(const struct sockaddr *, socklen_t *);
    613 int sockaddr_cmp(const struct sockaddr *, const struct sockaddr *);
    614 struct sockaddr *sockaddr_dup(const struct sockaddr *, int);
    615 int sockaddr_format(const struct sockaddr *, char *, size_t);
    616 void sockaddr_free(struct sockaddr *);
    617 __END_DECLS
    618 #endif /* _KERNEL */
    619 
    620 #ifndef	_KERNEL
    621 
    622 __BEGIN_DECLS
    623 int	accept(int, struct sockaddr * __restrict, socklen_t * __restrict);
    624 int	accept4(int, struct sockaddr * __restrict, socklen_t * __restrict, int);
    625 int	bind(int, const struct sockaddr *, socklen_t);
    626 int	connect(int, const struct sockaddr *, socklen_t);
    627 int	getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict);
    628 int	getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict);
    629 int	getsockopt(int, int, int, void *__restrict, socklen_t * __restrict);
    630 int	getsockopt2(int, int, int, void *__restrict, socklen_t * __restrict);
    631 int	listen(int, int);
    632 int	paccept(int, struct sockaddr * __restrict, socklen_t * __restrict,
    633 	const sigset_t * __restrict, int);
    634 ssize_t	recv(int, void *, size_t, int);
    635 ssize_t	recvfrom(int, void *__restrict, size_t, int,
    636 	    struct sockaddr * __restrict, socklen_t * __restrict);
    637 ssize_t	recvmsg(int, struct msghdr *, int);
    638 ssize_t	send(int, const void *, size_t, int);
    639 ssize_t	sendto(int, const void *,
    640 	    size_t, int, const struct sockaddr *, socklen_t);
    641 ssize_t	sendmsg(int, const struct msghdr *, int);
    642 int	setsockopt(int, int, int, const void *, socklen_t);
    643 int	shutdown(int, int);
    644 int	sockatmark(int);
    645 int	socket(int, int, int)
    646 #if !defined(__LIBC12_SOURCE__) && !defined(_STANDALONE)
    647 __RENAME(__socket30)
    648 #endif
    649 			     ;
    650 int	socketpair(int, int, int, int *);
    651 
    652 #if defined(_NETBSD_SOURCE)
    653 int	sendmmsg(int, struct mmsghdr *, unsigned int, unsigned int);
    654 struct timespec;
    655 int	recvmmsg(int, struct mmsghdr *, unsigned int, unsigned int,
    656     struct timespec *);
    657 #endif
    658 __END_DECLS
    659 #endif /* !_KERNEL */
    660 
    661 #endif /* !_SYS_SOCKET_H_ */
    662