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