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