socketvar.h   [plain text]

/*
 * Copyright (c) 2000-2013 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*-
 * Copyright (c) 1982, 1986, 1990, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)socketvar.h	8.3 (Berkeley) 2/19/95
 * $FreeBSD: src/sys/sys/socketvar.h,v 1.46.2.6 2001/08/31 13:45:49 jlemon Exp $
 */
/*
 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
 * support for mandatory and extensible security protections.  This notice
 * is included in support of clause 2.2 (b) of the Apple Public License,
 * Version 2.0.
 */

#ifndef _SYS_SOCKETVAR_H_
#define	_SYS_SOCKETVAR_H_

#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
#ifdef KERNEL_PRIVATE
#include <sys/queue.h>			/* for TAILQ macros */
#include <sys/select.h>			/* for struct selinfo */
#include <net/kext_net.h>
#include <sys/ev.h>
#include <uuid/uuid.h>
#endif /* KERNEL_PRIVATE */

typedef	u_quad_t so_gen_t;

#ifdef KERNEL_PRIVATE
struct mbuf;
struct socket_filter_entry;
struct protosw;
struct sockif;
struct sockutil;

/* strings for sleep message: */
extern	char netio[], netcon[], netcls[];
#define	SOCKET_CACHE_ON
#define	SO_CACHE_FLUSH_INTERVAL 1	/* Seconds */
#define	SO_CACHE_TIME_LIMIT	(120/SO_CACHE_FLUSH_INTERVAL) /* Seconds */
#define	SO_CACHE_MAX_FREE_BATCH	50
#define	MAX_CACHED_SOCKETS	512
#define	TEMPDEBUG		0
#endif /* KERNEL_PRIVATE */

#ifdef PRIVATE
#define SO_TC_STATS_MAX 4

struct data_stats {
        u_int64_t       rxpackets;
        u_int64_t       rxbytes;
        u_int64_t       txpackets;
        u_int64_t       txbytes;
};

#define MSG_PRI_0 0	/* TCP message priority, lowest */
#define MSG_PRI_1 1
#define MSG_PRI_2 2
#define MSG_PRI_3 3	/* TCP message priority, highest */
#define MSG_PRI_MAX MSG_PRI_3
#define MSG_PRI_MIN MSG_PRI_0
#define MSG_PRI_COUNT 4
#define MSG_PRI_DEFAULT MSG_PRI_1
#endif /* PRIVATE */

#ifdef KERNEL_PRIVATE
/* State for TCP message send or receive */
struct msg_priq {
	struct mbuf *msgq_head; /* first mbuf in the queue */
	struct mbuf *msgq_tail; /* last mbuf in the queue */
	struct mbuf *msgq_lastmsg; /* last message in the queue */
	u_int32_t msgq_flags;	/* flags per priority queue */
#define MSGQ_MSG_NOTDONE 0x1	/* set when EOR of a msg is not seen */
	u_int32_t msgq_bytes;	/* data bytes in this queue */
};

struct msg_state {
	struct msg_priq msg_priq[MSG_PRI_COUNT]; /* priority queues */
	u_int32_t msg_serial_bytes; /* bytes moved to serial queue */
	u_int32_t msg_uno_bytes; /* out-of-order chars in rcv buffer */
};

/* mbuf flag used to indicate out of order data received */
#define M_UNORDERED_DATA M_PROTO1

/*
 * Kernel structure per socket.
 * Contains send and receive buffer queues,
 * handle on protocol and pointer to protocol
 * private data and error information.
 */
struct socket {
	int	so_zone;		/* zone we were allocated from */
	short	so_type;		/* generic type, see socket.h */
	u_int32_t so_options;		/* from socket call, see socket.h */
	short	so_linger;		/* time to linger while closing */
	short	so_state;		/* internal state flags SS_*, below */
	void	*so_pcb;		/* protocol control block */
	struct	protosw *so_proto;	/* protocol handle */
	/*
	 * Variables for connection queueing.
	 * Socket where accepts occur is so_head in all subsidiary sockets.
	 * If so_head is 0, socket is not related to an accept.
	 * For head socket so_incomp queues partially completed connections,
	 * while so_comp is a queue of connections ready to be accepted.
	 * If a connection is aborted and it has so_head set, then
	 * it has to be pulled out of either so_incomp or so_comp.
	 * We allow connections to queue up based on current queue lengths
	 * and limit on number of queued connections for this socket.
	 */
	struct	socket *so_head;	/* back pointer to accept socket */
	TAILQ_HEAD(, socket) so_incomp;	/* q of partially unaccepted conns */
	TAILQ_HEAD(, socket) so_comp;	/* q of complete unaccepted conns */
	TAILQ_ENTRY(socket) so_list;	/* list of unaccepted connections */
	short	so_qlen;		/* number of unaccepted connections */
	short	so_incqlen;		/* number of unaccepted incomplete
					   connections */
	short	so_qlimit;		/* max number queued connections */
	short	so_timeo;		/* connection timeout */
	u_short	so_error;		/* error affecting connection */
	pid_t	so_pgid;		/* pgid for signals */
	u_int32_t so_oobmark;		/* chars to oob mark */
	/*
	 * Variables for socket buffering.
	 */
	struct sockbuf {
		u_int32_t	sb_cc;		/* actual chars in buffer */
		u_int32_t	sb_hiwat;	/* max actual char count */
		u_int32_t	sb_mbcnt;	/* chars of mbufs used */
		u_int32_t	sb_mbmax;	/* max chars of mbufs to use */
		u_int32_t	sb_ctl;		/* non-data chars in buffer */
		u_int32_t	sb_lowat;	/* low water mark */
		struct mbuf	*sb_mb;		/* the mbuf chain */
		struct mbuf	*sb_mbtail;	/* the last mbuf in the chain */
		struct mbuf	*sb_lastrecord;	/* first mbuf of last record */
		struct socket	*sb_so;		/* socket back ptr for kexts */
		struct selinfo	sb_sel;		/* process selecting rd/wr */
		u_int32_t	sb_flags;	/* flags, see below */
		struct timeval	sb_timeo;	/* timeout for read/write */
		u_int32_t	sb_idealsize;	/* Ideal size for the sb based
						   on bandwidth and delay */
		void	(*sb_upcall)(struct socket *, void *arg, int waitf);
		void	*sb_upcallarg;		/* Arg for above */
		u_int32_t	sb_wantlock;	/* # of SB_LOCK waiters */
		u_int32_t	sb_waiters;	/* # of data/space waiters */
		u_int32_t	_reserved[2];	/* for future use */
	} so_rcv, so_snd;
#define	SB_MAX		(8192*1024)	/* default for max chars in sockbuf */
#define LOW_SB_MAX	(2*9*1024)	/* lower limit on max socket buffer
					   size, 2 max datagrams */
#define	SB_LOCK		0x1		/* lock on data queue */
#define	SB_NOINTR	0x2		/* operations not interruptible */
#define	SB_RECV		0x4		/* this is rcv sb */
#define	SB_SEL		0x8		/* someone is selecting */
#define	SB_ASYNC	0x10		/* ASYNC I/O, need signals */
#define	SB_UPCALL	0x20		/* someone wants an upcall */
#define	SB_KNOTE	0x40		/* kernel note attached */
#define	SB_DROP		0x80		/* does not accept any more data */
#define	SB_UNIX		0x100		/* UNIX domain socket buffer */
#define SB_USRSIZE	0x200		/* user specified sbreserve */
#define	SB_AUTOSIZE	0x400		/* automatically size socket buffer */
#define	SB_TRIM		0x800		/* Trim the socket buffer */
#define	SB_NOCOMPRESS	0x1000		/* do not compress socket buffer */

	caddr_t	so_tpcb;		/* Misc. protocol control block, used
					   by some kexts */

	void		(*so_event)(struct socket *, void *, u_int32_t);
	void		*so_eventarg;	/* Arg for above */
	kauth_cred_t	so_cred;	/* cred of who opened the socket */
	/* NB: generation count must not be first; easiest to make it last. */
	so_gen_t so_gencnt;		/* generation count */
	TAILQ_HEAD(, eventqelt) so_evlist;
	boolean_t	cached_in_sock_layer; /* bundled with inpcb and tcpcb */
	STAILQ_ENTRY(socket) so_cache_ent;	/* socache entry */
	u_int32_t	cache_timestamp;	/* time socket was cached */
	caddr_t		so_saved_pcb;	/* Saved pcb when cacheing */
	struct mbuf	*so_temp;	/* Holding area for outbound frags */
	/* Plug-in support - make the socket interface overridable */
	struct mbuf	*so_tail;
	struct socket_filter_entry *so_filt;	/* NKE hook */
	u_int32_t	so_flags;	/* Flags */
#define	SOF_NOSIGPIPE	0x1
#define	SOF_NOADDRAVAIL	0x2	/* EADDRNOTAVAIL if src addr is gone */
#define	SOF_PCBCLEARING	0x4	/* pru_disconnect done; don't call pru_detach */
#define	SOF_DEFUNCT	0x8	/* socket marked as inactive */
#define	SOF_CLOSEWAIT	0x10	/* blocked in close awaiting some events */
#define SOF_REUSESHAREUID 0x40	/* Allows SO_REUSEADDR/SO_REUSEPORT
				   for multiple so_uid */
#define	SOF_MULTIPAGES	0x80	/* jumbo clusters may be used for sosend */
#define SOF_ABORTED	0x100	/* soabort was already called once */
#define SOF_OVERFLOW	0x200	/* socket was dropped as overflow of listen q */
#ifdef __APPLE_API_PRIVATE
#define SOF_NOTIFYCONFLICT	0x400	/* notify that a bind was done on a
					   port already in use */
#endif
#define	SOF_UPCALLCLOSEWAIT	0x800	/* block close until upcall returns  */
#define SOF_BINDRANDOMPORT	0x1000	/* Randomized port number for bind */
#define SOF_NPX_SETOPTSHUT	0x2000	/* Non POSIX extension to allow
					   setsockopt(2) after shut down */
#define SOF_RECV_TRAFFIC_CLASS	0x4000	/* Receive TC as ancillary data */
#define	SOF_NODEFUNCT		0x8000	/* socket cannot be defunct'd */
#define	SOF_PRIVILEGED_TRAFFIC_CLASS 0x10000 /* traffic class is privileged */
#define SOF_SUSPENDED		0x20000 /* i/f output queue is suspended */
#define SOF_INCOMP_INPROGRESS	0x40000 /* incomp socket is being processed */
#define	SOF_NOTSENT_LOWAT	0x80000 /* A different lowat on not sent
					   data has been set */
#define SOF_KNOTE	0x100000	/* socket is on the EV_SOCK klist */
#define SOF_USELRO	0x200000	/* TCP must use LRO on these sockets */
#define SOF_ENABLE_MSGS 0x400000	/* TCP must enable message delivery */
#define SOF_FLOW_DIVERT	0x800000	/* Flow Divert is enabled */
#define	SOF_MP_SUBFLOW	0x1000000	/* is a multipath subflow socket */
#define SOF_MPTCP_TRUE  0x2000000 /* Established e2e MPTCP connection */
#define SOF_MPTCP_CLIENT        0x4000000 /* Only client starts addtnal flows */
#define SOF_MP_SEC_SUBFLOW      0x8000000 /* Set up secondary flow */
#define SOF_MP_TRYFAILOVER	0x10000000 /* Failing subflow */
#define	SOF_DELEGATED		0x20000000 /* on behalf of another process */
	uint32_t	so_upcallusecount; /* number of upcalls in progress */
	int		so_usecount;	/* refcounting of socket use */;
	int		so_retaincnt;
	u_int32_t	so_filteruse;	/* usecount for the socket filters */
	u_int32_t	so_traffic_mgt_flags;	/* traffic_mgt socket config */
	thread_t	so_send_filt_thread;
	u_int32_t	so_restrictions;

	/* for debug pruposes */
#define	SO_LCKDBG_MAX 4	/* number of debug locking Link Registers recorded */
	void	*lock_lr[SO_LCKDBG_MAX];	/* locking calling history */
	int	next_lock_lr;
	void	*unlock_lr[SO_LCKDBG_MAX];	/* unlocking caller history */
	int	next_unlock_lr;
	void *reserved; /* reserved for future use */

	struct label	*so_label;	/* MAC label for socket */
	struct label	*so_peerlabel;	/* cached MAC label for socket peer */
	thread_t	so_background_thread;	/* thread that marked
						   this socket background */
	int		so_traffic_class;

	u_int64_t	last_upid;	/* upid of most recent accessor */
	pid_t		last_pid;	/* pid of most recent accessor */
	struct data_stats so_tc_stats[SO_TC_STATS_MAX];
	struct klist	so_klist;		/* klist for EV_SOCK events */

	struct msg_state *so_msg_state;		/* unordered snd/rcv state */
	struct flow_divert_pcb	*so_fd_pcb;	/* Flow Divert control block */
	u_int32_t	so_eventmask;		/* event mask */

	u_int64_t	e_upid;		/* upid of the effective owner */
	pid_t		e_pid;		/* pid of the effective owner */

	uuid_t		last_uuid;	/* uuid of most recent accessor */
	uuid_t		e_uuid;		/* uuid of effective owner */

	int32_t		so_policy_gencnt; /* UUID policy gencnt */
	u_int32_t	so_ifdenied_notifies; /* # of notifications generated */
};

/* Control message accessor in mbufs */

#define _MIN_NXT_CMSGHDR_PTR(cmsg)					\
	((char *)(cmsg) +						\
	    __DARWIN_ALIGN32((__uint32_t)(cmsg)->cmsg_len) +		\
	    __DARWIN_ALIGN32(sizeof(struct cmsghdr)))

#define M_FIRST_CMSGHDR(m)						\
        ((char *)(m) != (char *)0L &&					\
	(size_t)(m)->m_len >= sizeof (struct cmsghdr) &&		\
	(socklen_t)(m)->m_len >=					\
	__DARWIN_ALIGN32(((struct cmsghdr *)(void *)(m)->m_data)->cmsg_len) ? \
	(struct cmsghdr *)(void *)(m)->m_data :	(struct cmsghdr *)0L)

#define M_NXT_CMSGHDR(m, cmsg)						\
        ((char *)(cmsg) == (char *)0L ? M_FIRST_CMSGHDR(m) :		\
	_MIN_NXT_CMSGHDR_PTR(cmsg) > ((char *)(m)->m_data) + (m)->m_len ||  \
	_MIN_NXT_CMSGHDR_PTR(cmsg) < (char *)(m)->m_data ?		\
	(struct cmsghdr *)0L /* NULL */ :				\
	(struct cmsghdr *)(void *)((unsigned char *)(cmsg) +		\
	__DARWIN_ALIGN32((__uint32_t)(cmsg)->cmsg_len)))

/*
 * Socket state bits.
 */
#define	SS_NOFDREF		0x0001	/* no file table ref any more */
#define	SS_ISCONNECTED		0x0002	/* socket connected to a peer */
#define	SS_ISCONNECTING		0x0004	/* in process of connecting to peer */
#define	SS_ISDISCONNECTING	0x0008	/* in process of disconnecting */
#define	SS_CANTSENDMORE		0x0010	/* can't send more data to peer */
#define	SS_CANTRCVMORE		0x0020	/* can't receive more data from peer */
#define	SS_RCVATMARK		0x0040	/* at mark on input */

#define	SS_PRIV			0x0080	/* privileged for broadcast, raw... */
#define	SS_NBIO			0x0100	/* non-blocking ops */
#define	SS_ASYNC		0x0200	/* async i/o notify */
#define	SS_ISCONFIRMING		0x0400	/* deciding to accept connection req */
#define	SS_INCOMP		0x0800	/* Unaccepted, incomplete connection */
#define	SS_COMP			0x1000	/* unaccepted, complete connection */
#define	SS_ISDISCONNECTED	0x2000	/* socket disconnected from peer */
#define	SS_DRAINING		0x4000	/* close waiting for blocked system
					   calls to drain */
#define	SS_DEFUNCT		0x8000	/* has been fully defunct'd */
#endif /* KERNEL_PRIVATE */

#if defined(__LP64__)
#define	_XSOCKET_PTR(x)		u_int32_t
#else
#define	_XSOCKET_PTR(x)		x
#endif

#ifdef PRIVATE
/* Flags returned in data field for EVFILT_SOCK events. */
#define SOCKEV_CONNECTED	0x00000001 /* connected */
#define SOCKEV_DISCONNECTED	0x00000002 /* disconnected */
#endif /* PRIVATE */

#pragma pack(4)

struct xsockbuf {
	u_int32_t	sb_cc;
	u_int32_t	sb_hiwat;
	u_int32_t	sb_mbcnt;
	u_int32_t	sb_mbmax;
	int32_t		sb_lowat;
	short		sb_flags;
	short		sb_timeo;
};

/*
 * Externalized form of struct socket used by the sysctl(3) interface.
 */
struct	xsocket {
	u_int32_t		xso_len;	/* length of this structure */
	_XSOCKET_PTR(struct socket *) xso_so;	/* makes a convenient handle */
	short			so_type;
	short			so_options;
	short			so_linger;
	short			so_state;
	_XSOCKET_PTR(caddr_t)	so_pcb;		/* another convenient handle */
	int				xso_protocol;
	int				xso_family;
	short			so_qlen;
	short			so_incqlen;
	short			so_qlimit;
	short			so_timeo;
	u_short			so_error;
	pid_t			so_pgid;
	u_int32_t		so_oobmark;
	struct xsockbuf	so_rcv;
	struct xsockbuf	so_snd;
	uid_t			so_uid;		/* XXX */
};

struct	xsocket64 {
	u_int32_t		xso_len;	/* length of this structure */
	u_int64_t		xso_so;		/* makes a convenient handle */
	short			so_type;
	short			so_options;
	short			so_linger;
	short			so_state;
	u_int64_t		so_pcb;		/* another convenient handle */
	int			xso_protocol;
	int			xso_family;
	short			so_qlen;
	short			so_incqlen;
	short			so_qlimit;
	short			so_timeo;
	u_short			so_error;
	pid_t			so_pgid;
	u_int32_t		so_oobmark;
	struct xsockbuf		so_rcv;
	struct xsockbuf		so_snd;
	uid_t			so_uid;		/* XXX */
};

#ifdef PRIVATE
#define XSO_SOCKET	0x001
#define XSO_RCVBUF	0x002
#define XSO_SNDBUF	0x004
#define XSO_STATS	0x008
#define XSO_INPCB	0x010
#define XSO_TCPCB	0x020

struct	xsocket_n {
	u_int32_t		xso_len;	/* length of this structure */
	u_int32_t		xso_kind;	/* XSO_SOCKET */
	u_int64_t		xso_so;		/* makes a convenient handle */
	short			so_type;
	u_int32_t		so_options;
	short			so_linger;
	short			so_state;
	u_int64_t		so_pcb;		/* another convenient handle */
	int				xso_protocol;
	int				xso_family;
	short			so_qlen;
	short			so_incqlen;
	short			so_qlimit;
	short			so_timeo;
	u_short			so_error;
	pid_t			so_pgid;
	u_int32_t		so_oobmark;
	uid_t			so_uid;		/* XXX */
};

struct xsockbuf_n {
	u_int32_t		xsb_len;	/* length of this structure */
	u_int32_t		xsb_kind;	/* XSO_RCVBUF or XSO_SNDBUF */
	u_int32_t		sb_cc;
	u_int32_t		sb_hiwat;
	u_int32_t		sb_mbcnt;
	u_int32_t		sb_mbmax;
	int32_t			sb_lowat;
	short			sb_flags;
	short			sb_timeo;
};

struct xsockstat_n {
	u_int32_t		xst_len;	/* length of this structure */
	u_int32_t		xst_kind;	/* XSO_STATS */
	struct data_stats	xst_tc_stats[SO_TC_STATS_MAX];
};
#endif /* PRIVATE */

#pragma pack()

#ifdef KERNEL_PRIVATE
#include <sys/kpi_mbuf.h>

/*
 * Argument structure for sosetopt et seq.  This is in the KERNEL
 * section because it will never be visible to user code.
 */
enum sopt_dir { SOPT_GET, SOPT_SET };
struct sockopt {
	enum	sopt_dir sopt_dir; /* is this a get or a set? */
	int	sopt_level;	/* second arg of [gs]etsockopt */
	int	sopt_name;	/* third arg of [gs]etsockopt */
	user_addr_t sopt_val;	/* fourth arg of [gs]etsockopt */
	size_t	sopt_valsize;	/* (almost) fifth arg of [gs]etsockopt */
	struct	proc *sopt_p;	/* calling process or null if kernel */
};

#ifdef MALLOC_DECLARE
MALLOC_DECLARE(M_PCB);
MALLOC_DECLARE(M_SONAME);
#endif /* MALLOC_DECLARE */

#ifdef BSD_KERNEL_PRIVATE
/*
 * Socket extension mechanism: control block hooks:
 * This is the "head" of any control block for an extenstion
 * Note: we separate intercept function dispatch vectors from
 *  the NFDescriptor to permit selective replacement during
 *  operation, e.g., to disable some functions.
 */
struct kextcb {
	struct kextcb *e_next;		/* Next kext control block */
	void *e_fcb;			/* Real filter control block */
	struct NFDescriptor *e_nfd;	/* NKE Descriptor */
	/* Plug-in support - intercept functions */
	struct sockif *e_soif;		/* Socket functions */
	struct sockutil *e_sout;	/* Sockbuf utility functions */
};
#define	EXT_NULL	0x0		/* STATE: Not in use */

/* Hints for socket event processing */
#define SO_FILT_HINT_LOCKED      0x00000001	/* socket is already locked */
#define SO_FILT_HINT_CONNRESET   0x00000002	/* Reset is received */
#define SO_FILT_HINT_CANTRCVMORE 0x00000004	/* No more data to read */
#define SO_FILT_HINT_CANTSENDMORE 0x00000008	/* Can't write more data */
#define SO_FILT_HINT_TIMEOUT     0x00000010	/* timeout */
#define SO_FILT_HINT_NOSRCADDR   0x00000020	/* No src address available */
#define SO_FILT_HINT_IFDENIED    0x00000040	/* interface denied access */
#define SO_FILT_HINT_SUSPEND     0x00000080	/* output queue suspended */
#define SO_FILT_HINT_RESUME      0x00000100	/* output queue resumed */
#define SO_FILT_HINT_KEEPALIVE	 0x00000200	/* TCP Keepalive received */
#define SO_FILT_HINT_ADAPTIVE_WTIMO 0x00000400 /* TCP adaptive write timeout */
#define SO_FILT_HINT_ADAPTIVE_RTIMO 0x00000800 /* TCP adaptive read timeout */
#define	SO_FILT_HINT_CONNECTED	  0x00001000	/* socket is connected */
#define	SO_FILT_HINT_DISCONNECTED 0x00002000	/* socket is disconnected */
#define	SO_FILT_HINT_CONNINFO_UPDATED 0x00004000 /* updated conninfo avail. */
#define	SO_FILT_HINT_MPFAILOVER	0x00008000	/* multipath failover */
#define	SO_FILT_HINT_MPSTATUS	0x00010000	/* multipath status */
#define SO_FILT_HINT_MUSTRST	0x00020000	/* must send RST and close */

#define	SO_FILT_HINT_BITS \
	"\020\1LOCKED\2CONNRESET\3CANTRCVMORE\4CANTSENDMORE\5TIMEOUT"	\
	"\6NOSRCADDR\7IFDENIED\10SUSPEND\11RESUME\12KEEPALIVE\13AWTIMO"	\
	"\14ARTIMO\15CONNECTED\16DISCONNECTED\17CONNINFO_UPDATED" \
	"\20MPFAILOVER\21MPSTATUS\22MUSTRST"

/* Mask for hints that have corresponding kqueue events */
#define SO_FILT_HINT_EV							\
	(SO_FILT_HINT_CONNRESET | SO_FILT_HINT_CANTRCVMORE |		\
	SO_FILT_HINT_CANTSENDMORE | SO_FILT_HINT_TIMEOUT |		\
	SO_FILT_HINT_NOSRCADDR | SO_FILT_HINT_IFDENIED |		\
	SO_FILT_HINT_SUSPEND | SO_FILT_HINT_RESUME |			\
	SO_FILT_HINT_KEEPALIVE | SO_FILT_HINT_ADAPTIVE_WTIMO |		\
	SO_FILT_HINT_ADAPTIVE_RTIMO | SO_FILT_HINT_CONNECTED |		\
	SO_FILT_HINT_DISCONNECTED | SO_FILT_HINT_CONNINFO_UPDATED)

#if SENDFILE
struct sf_buf {
	SLIST_ENTRY(sf_buf) free_list;	/* list of free buffer slots */
	int		refcnt;		/* reference count */
	struct		vm_page *m;	/* currently mapped page */
	vm_offset_t	kva;		/* va of mapping */
};
#endif /* SENDFILE */

#define	SBLASTRECORDCHK(sb, s)						\
	if (socket_debug) sblastrecordchk(sb, s);

#define	SBLASTMBUFCHK(sb, s)						\
	if (socket_debug) sblastmbufchk(sb, s);

#define	SB_EMPTY_FIXUP(sb) {						\
	if ((sb)->sb_mb == NULL) {					\
		(sb)->sb_mbtail = NULL;					\
		(sb)->sb_lastrecord = NULL;				\
	}								\
}

#define SB_MB_CHECK(sb) do {						\
	if (((sb)->sb_mb != NULL &&					\
	    (sb)->sb_cc == 0) ||					\
	    ((sb)->sb_mb == NULL && (sb)->sb_cc > 0))			\
		panic("corrupt so_rcv: sb_mb %p sb_cc %d\n",		\
		    (sb)->sb_mb, (sb)->sb_cc);				\
} while(0)

#define	SODEFUNCTLOG(x)		do { if (sodefunctlog) printf x; } while (0)
#define	SOTHROTTLELOG(x)	do { if (sothrottlelog) printf x; } while (0)

/*
 * For debugging traffic class behaviors
 */
#define SOTCDB_NO_DSCP		0x01	/* Do not set DSCP code in IP header */
#define SOTCDB_NO_MTC		0x02	/* Do not set the mbuf traffic class */
#define SOTCDB_NO_SENDTCPBG	0x04	/* Do not use background TCP CC algorithm for sender */
#define SOTCDB_NO_LCLTST	0x08	/* Do not test for local destination for setting DSCP */
#define SOTCDB_NO_DSCPTST	0x10	/* Overwritte any existing DSCP code */
#define SOTCDB_NO_RECVTCPBG	0x20	/* Do not use throttling on receiver-side of TCP */
#define	SOTCDB_NO_PRIVILEGED	0x40	/* Do not set privileged traffic flag */

#define	SOCK_DOM(so)			((so)->so_proto->pr_domain->dom_family)
#define	SOCK_TYPE(so)			((so)->so_proto->pr_type)
#define	SOCK_PROTO(so)			((so)->so_proto->pr_protocol)

#define	SOCK_CHECK_DOM(so, dom)		(SOCK_DOM(so) == (dom))
#define	SOCK_CHECK_TYPE(so, type)	(SOCK_TYPE(so) == (type))
#define	SOCK_CHECK_PROTO(so, proto)	(SOCK_PROTO(so) == (proto))

/*
 * Socket process information
 */
struct so_procinfo {
	pid_t		spi_pid;
	pid_t		spi_epid;
};

extern int maxsockets;
extern u_int32_t sb_max;
extern so_gen_t so_gencnt;
extern int socket_debug;
extern int sosendjcl;
extern int sosendjcl_ignore_capab;
extern int sodefunctlog;
extern int sothrottlelog;
extern int sorestrictrecv;
extern int somaxconn;
extern uint32_t tcp_autosndbuf_max;
extern u_int32_t sotcdb;
extern u_int32_t net_io_policy_throttled;
extern u_int32_t net_io_policy_log;
#if CONFIG_PROC_UUID_POLICY
extern u_int32_t net_io_policy_uuid;
#endif /* CONFIG_PROC_UUID_POLICY */
#endif /* BSD_KERNEL_PRIVATE */

struct mbuf;
struct sockaddr;
struct ucred;
struct uio;

/*
 * From uipc_socket and friends
 */
__BEGIN_DECLS
/* Exported */
extern int sbappendaddr(struct sockbuf *sb, struct sockaddr *asa,
    struct mbuf *m0, struct mbuf *control, int *error_out);
extern int sbappendrecord(struct sockbuf *sb, struct mbuf *m0);
extern void sbflush(struct sockbuf *sb);
extern int sbspace(struct sockbuf *sb);
extern int soabort(struct socket *so);
extern void socantrcvmore(struct socket *so);
extern void socantsendmore(struct socket *so);
extern int sodisconnect(struct socket *so);
extern void sofree(struct socket *so);
extern void sofreelastref(struct socket *, int);
extern void soisconnected(struct socket *so);
extern void soisconnecting(struct socket *so);
extern void soisdisconnected(struct socket *so);
extern void soisdisconnecting(struct socket *so);
extern struct socket *sonewconn(struct socket *head, int connstatus,
    const struct sockaddr *from);
extern int sopoll(struct socket *so, int events, struct ucred *cred, void *wql);
extern int sooptcopyin(struct sockopt *sopt, void *data, size_t len,
    size_t minlen);
extern int sooptcopyout(struct sockopt *sopt, void *data, size_t len);
extern int soreceive(struct socket *so, struct sockaddr **paddr,
    struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, int *flagsp);
extern int soreserve(struct socket *so, u_int32_t sndcc, u_int32_t rcvcc);
extern void sorwakeup(struct socket *so);
extern int sosend(struct socket *so, struct sockaddr *addr, struct uio *uio,
    struct mbuf *top, struct mbuf *control, int flags);
__END_DECLS

#ifdef BSD_KERNEL_PRIVATE
struct file;
struct filedesc;
struct so_tcdbg;

__BEGIN_DECLS
/* Not exported */
extern void socketinit(void);
extern struct sockaddr *dup_sockaddr(struct sockaddr *sa, int canwait);
extern int getsock(struct filedesc *fdp, int fd, struct file **fpp);
extern int sockargs(struct mbuf **mp, user_addr_t data, int buflen, int type);
extern void get_sockev_state(struct socket *, u_int32_t *);
extern void so_update_last_owner_locked(struct socket *, struct proc *);
extern void so_update_policy(struct socket *);

extern int sbappend(struct sockbuf *sb, struct mbuf *m);
extern int sbappendstream(struct sockbuf *sb, struct mbuf *m);
extern int sbappendcontrol(struct sockbuf *sb, struct mbuf *m0,
    struct mbuf *control, int *error_out);
extern int sbappendmsgstream_rcv(struct sockbuf *sb, struct mbuf *m,
    uint32_t seqnum, int flags);
extern int sbappendstream_rcvdemux(struct socket *so, struct mbuf *m,
    uint32_t seqnum, int flags);
#if MPTCP
extern int sbappendmptcpstream_rcv(struct sockbuf *sb, struct mbuf *m);
#endif /* MPTCP */
extern int sbappendmsg_snd(struct sockbuf *sb, struct mbuf *m);
extern void sbpull_unordered_data(struct socket *, int32_t, int32_t);
extern void sbcheck(struct sockbuf *sb);
extern void sblastmbufchk(struct sockbuf *, const char *);
extern void sblastrecordchk(struct sockbuf *, const char *);
extern struct mbuf *sbcreatecontrol(caddr_t p, int size, int type, int level);
extern struct mbuf **sbcreatecontrol_mbuf(caddr_t p, int size, int type,
    int level, struct mbuf** m);
extern void sbdrop(struct sockbuf *sb, int len);
extern void sbdroprecord(struct sockbuf *sb);
extern int sbinsertoob(struct sockbuf *sb, struct mbuf *m0);
extern void sbrelease(struct sockbuf *sb);
extern int sbreserve(struct sockbuf *sb, u_int32_t cc);
extern void sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb);
extern int sbwait(struct sockbuf *sb);
extern void sbwakeup(struct sockbuf *sb);
extern void sb_empty_assert(struct sockbuf *, const char *);
extern int sb_notify(struct sockbuf *sb);
extern void sballoc(struct sockbuf *sb, struct mbuf *m);
extern void sbfree(struct sockbuf *sb, struct mbuf *m);
extern void sbfree_chunk(struct sockbuf *sb, struct mbuf *m);

/*
 * Flags to sblock().
 */
#define	SBL_WAIT	0x00000001	/* Wait if not immediately available. */
#define	SBL_NOINTR	0x00000002	/* Force non-interruptible sleep. */
#define	SBL_IGNDEFUNCT	0x00000004	/* Ignore defunct'd state */
#define	SBL_VALID	(SBL_WAIT | SBL_NOINTR | SBL_IGNDEFUNCT)
extern int sblock(struct sockbuf *sb, uint32_t flags);
extern void sbunlock(struct sockbuf *sb, boolean_t keeplocked);

extern int soaccept(struct socket *so, struct sockaddr **nam);
extern int soacceptlock(struct socket *so, struct sockaddr **nam, int dolock);
extern int soacceptfilter(struct socket *so);
extern struct socket *soalloc(int waitok, int dom, int type);
extern int sobindlock(struct socket *so, struct sockaddr *nam, int dolock);
extern int soclose(struct socket *so);
extern int soclose_locked(struct socket *so);
extern void soclose_wait_locked(struct socket *so);
extern int soconnect(struct socket *so, struct sockaddr *nam);
extern int soconnectlock(struct socket *so, struct sockaddr *nam, int dolock);
extern int soconnect2(struct socket *so1, struct socket *so2);
extern int soconnectxlocked(struct socket *so, struct sockaddr_list **src_sl,
    struct sockaddr_list **dst_sl, struct proc *, uint32_t, associd_t,
    connid_t *, uint32_t, void *, u_int32_t);
extern int sodisconnectx(struct socket *so, associd_t, connid_t);
extern int sodisconnectxlocked(struct socket *so, associd_t, connid_t);
extern int sopeelofflocked(struct socket *so, associd_t, struct socket **);
extern void soevupcall(struct socket *, u_int32_t);
/* flags for socreate_internal */
#define	SOCF_ASYNC	0x1	/* non-blocking socket */
#define	SOCF_MP_SUBFLOW	0x2	/* multipath subflow socket */
extern int socreate_internal(int dom, struct socket **aso, int type, int proto,
    struct proc *, uint32_t, struct proc *);
extern int socreate(int dom, struct socket **aso, int type, int proto);
extern int socreate_delegate(int dom, struct socket **aso, int type, int proto, pid_t epid);
extern void sodealloc(struct socket *so);
extern int sodisconnectlocked(struct socket *so);
extern void soreference(struct socket *so);
extern void sodereference(struct socket *so);
extern void somultipages(struct socket *, boolean_t);
extern int sosetdefunct(struct proc *, struct socket *, int level, boolean_t);
extern int sodefunct(struct proc *, struct socket *, int level);
extern void sohasoutofband(struct socket *so);
extern void sodisconnectwakeup(struct socket *so);
extern int soisthrottled(struct socket *so);
extern int soisprivilegedtraffic(struct socket *so);
extern int soissrcbackground(struct socket *so);
extern int solisten(struct socket *so, int backlog);
extern struct socket *sodropablereq(struct socket *head);
extern int socket_lock(struct socket *so, int refcount);
extern int socket_unlock(struct socket *so, int refcount);
extern int sogetaddr_locked(struct socket *, struct sockaddr **, int);
extern const char *solockhistory_nr(struct socket *);
extern void soevent(struct socket *so, long hint);
extern void sorflush(struct socket *so);
extern void sowflush(struct socket *so);
extern void sowakeup(struct socket *so, struct sockbuf *sb);
extern int soioctl(struct socket *so, u_long cmd, caddr_t data, struct proc *p);
extern int sogetoptlock(struct socket *so, struct sockopt *sopt, int);
extern int sosetoptlock(struct socket *so, struct sockopt *sopt, int);
extern int soshutdown(struct socket *so, int how);
extern int soshutdownlock(struct socket *so, int how);
extern void sotoxsocket(struct socket *so, struct xsocket *xso);
extern void sotoxsocket64(struct socket *so, struct xsocket64 *xso);
extern int sosendallatonce(struct socket *so);
extern int soreadable(struct socket *so);
extern int sowriteable(struct socket *so);
extern void sowwakeup(struct socket *so);
extern int sosendcheck(struct socket *, struct sockaddr *, user_ssize_t,
    int32_t, int32_t, int, int *, struct mbuf *);

extern int soo_ioctl(struct fileproc *, u_long, caddr_t, vfs_context_t);
extern int soo_stat(struct socket *, void *, int);
extern int soo_select(struct fileproc *, int, void *, vfs_context_t);
extern int soo_kqfilter(struct fileproc *, struct knote *, vfs_context_t);

extern struct sockaddr_entry *sockaddrentry_alloc(int);
extern void sockaddrentry_free(struct sockaddr_entry *);
extern struct sockaddr_entry *sockaddrentry_dup(const struct sockaddr_entry *,
    int);
extern struct sockaddr_list *sockaddrlist_alloc(int);
extern void sockaddrlist_free(struct sockaddr_list *);
extern void sockaddrlist_insert(struct sockaddr_list *,
    struct sockaddr_entry *);
extern void sockaddrlist_remove(struct sockaddr_list *,
    struct sockaddr_entry *);
extern struct sockaddr_list *sockaddrlist_dup(const struct sockaddr_list *,
    int);

/* Service class flags used for setting service class on a packet */
#define PKT_SCF_IPV6		0x00000001	/* IPv6 packet */
#define PKT_SCF_TCP_ACK		0x00000002	/* Pure TCP ACK */

extern void set_packet_service_class(struct mbuf *, struct socket *,
    mbuf_svc_class_t, u_int32_t);
extern void so_tc_update_stats(struct mbuf *, struct socket *,
    mbuf_svc_class_t);
extern mbuf_svc_class_t mbuf_service_class_from_control(struct mbuf *);
extern mbuf_svc_class_t so_tc2msc(int);
extern int so_svc2tc(mbuf_svc_class_t);

extern u_int8_t tcp_cansbgrow(struct sockbuf *sb);
extern int tcp_get_msg_priority(struct mbuf *, uint32_t *);
extern void set_tcp_stream_priority(struct socket *so);

extern int so_set_traffic_class(struct socket *, int);
extern void so_set_default_traffic_class(struct socket *);
extern int so_set_opportunistic(struct socket *, int);
extern int so_get_opportunistic(struct socket *);
extern int so_set_recv_anyif(struct socket *, int);
extern int so_get_recv_anyif(struct socket *);
extern int so_set_effective_pid(struct socket *, int, struct proc *);
extern int so_set_effective_uuid(struct socket *, uuid_t, struct proc *);
extern int so_set_restrictions(struct socket *, uint32_t);
extern uint32_t so_get_restrictions(struct socket *);
extern void socket_tclass_init(void);
extern int so_set_tcdbg(struct socket *, struct so_tcdbg *);
extern int sogetopt_tcdbg(struct socket *, struct sockopt *);
extern void so_set_lro(struct socket*, int);

extern int so_isdstlocal(struct socket *);
extern void so_recv_data_stat(struct socket *, struct mbuf *, size_t);
extern int so_wait_for_if_feedback(struct socket *);
extern int msgq_sbspace(struct socket *so, struct mbuf *control);
extern int soopt_getm(struct sockopt *sopt, struct mbuf **mp);
extern int soopt_mcopyin(struct sockopt *sopt, struct mbuf *m);
extern int soopt_mcopyout(struct sockopt *sopt, struct mbuf *m);
extern boolean_t so_cache_timer(void);

extern void mptcp_preproc_sbdrop(struct mbuf *, unsigned int);
extern void mptcp_postproc_sbdrop(struct mbuf *, u_int64_t, u_int32_t,
    u_int32_t);
extern void mptcp_adj_rmap(struct socket *, struct mbuf *);

extern void netpolicy_post_msg(uint32_t, struct netpolicy_event_data *,
    uint32_t);
__END_DECLS
#endif /* BSD_KERNEL_PRIVATE */
#endif /* KERNEL_PRIVATE */
#endif /* !_SYS_SOCKETVAR_H_ */