X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/5d5c5d0d5b79ade9a973d55186ffda2638ba2b6e..cb3231590a3c94ab4375e2228bd5e86b0cf1ad7e:/bsd/sys/socketvar.h diff --git a/bsd/sys/socketvar.h b/bsd/sys/socketvar.h index 9be87b630..f7e1e82ff 100644 --- a/bsd/sys/socketvar.h +++ b/bsd/sys/socketvar.h @@ -1,35 +1,33 @@ /* - * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved. + * Copyright (c) 2000-2019 Apple Inc. All rights reserved. * - * @APPLE_LICENSE_OSREFERENCE_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. + * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * - * Please obtain a copy of the License at - * http://www.opensource.apple.com/apsl/ and read it before using this - * file. + * 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. * - * 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 + * 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_LICENSE_OSREFERENCE_HEADER_END@ + * @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. * @@ -64,35 +62,88 @@ * @(#)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 -#include /* for TAILQ macros */ -#include /* for struct selinfo */ +#include +#include /* u_quad_t */ +#ifdef KERNEL_PRIVATE +#include /* for TAILQ macros */ +#include /* for struct selinfo */ #include #include -#include +#include +#ifdef BSD_KERNEL_PRIVATE +#include +#endif /* BSD_KERNEL_PRIVATE */ +#endif /* KERNEL_PRIVATE */ -/* - * Hacks to get around compiler complaints - */ +typedef u_quad_t so_gen_t; + +#ifdef KERNEL_PRIVATE struct mbuf; struct socket_filter_entry; struct protosw; struct sockif; struct sockutil; -#ifdef KERNEL_PRIVATE /* 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 60000 -#define TEMPDEBUG 0 +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. @@ -100,211 +151,436 @@ extern char netio[], netcon[], netcls[]; * handle on protocol and pointer to protocol * private data and error information. */ -#endif /* KERNEL_PRIVATE */ +struct socket { + int so_zone; /* zone we were allocated from */ + short so_type; /* generic type, see socket.h */ + u_short so_error; /* error affecting connection */ + 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 */ + 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 */ + struct timeval sb_timeo; /* timeout for read/write */ + u_int32_t sb_flags; /* flags, see below */ + 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 */ + thread_t sb_cfil_thread; /* content filter thread */ + u_int32_t sb_cfil_refs; /* # of nested calls */ + u_int32_t sb_preconn_hiwat; /* preconnect hiwat mark */ + } 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 */ +#define SB_SNDBYTE_CNT 0x2000 /* keep track of snd bytes per interface */ +#define SB_UPCALL_LOCK 0x4000 /* Keep socket locked when doing the upcall */ + caddr_t so_tpcb; /* Misc. protocol control block, used + * by some kexts */ -typedef u_quad_t so_gen_t; + 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; + STAILQ_ENTRY(socket) so_cache_ent; /* socache entry */ + caddr_t so_saved_pcb; /* Saved pcb when cacheing */ + u_int32_t cache_timestamp; /* time socket was cached */ -#ifdef KERNEL_PRIVATE -#ifndef __APPLE__ -/* We don't support BSD style socket filters */ -struct accept_filter; -#endif + pid_t last_pid; /* pid of most recent accessor */ + u_int64_t last_upid; /* upid of most recent accessor */ -struct socket { - int so_zone; /* zone we were allocated from */ - short so_type; /* generic type, see socket.h */ - short so_options; /* from socket call, see socket.h */ - short so_linger; /* time to linger while closing */ - short so_state; /* internal state flags SS_*, below */ - caddr_t so_pcb; /* protocol control block */ - struct protosw *so_proto; /* protocol handle */ -/* - * Variables for connection queuing. - * 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; /* queue of partial unaccepted connections */ - TAILQ_HEAD(, socket) so_comp; /* queue of complete unaccepted connections */ - 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_long so_oobmark; /* chars to oob mark */ -#ifndef __APPLE__ - /* We don't support AIO ops */ - TAILQ_HEAD(, aiocblist) so_aiojobq; /* AIO ops waiting on socket */ -#endif -/* - * Variables for socket buffering. - */ - struct sockbuf { - u_long sb_cc; /* actual chars in buffer */ - u_long sb_hiwat; /* max actual char count */ - u_long sb_mbcnt; /* chars of mbufs used */ - u_long sb_mbmax; /* max chars of mbufs to use */ - long sb_lowat; /* low water mark */ - struct mbuf *sb_mb; /* the mbuf chain */ -#if __APPLE__ - struct socket *sb_so; /* socket back ptr for kexts */ -#endif - struct selinfo sb_sel; /* process selecting read/write */ - short sb_flags; /* flags, see below */ - struct timeval sb_timeo; /* timeout for read/write */ - void *reserved1; /* for future use if needed */ - void *reserved2; - } so_rcv, so_snd; -#define SB_MAX (256*1024) /* default for max chars in sockbuf */ -#define SB_LOCK 0x01 /* lock on data queue */ -#define SB_WANT 0x02 /* someone is waiting to lock */ -#define SB_WAIT 0x04 /* someone is waiting for data/space */ -#define SB_SEL 0x08 /* someone is selecting */ -#define SB_ASYNC 0x10 /* ASYNC I/O, need signals */ -#define SB_UPCALL 0x20 /* someone wants an upcall */ -#define SB_NOINTR 0x40 /* operations not interruptible */ -#define SB_KNOTE 0x100 /* kernel note attached */ -#ifndef __APPLE__ -#define SB_AIO 0x80 /* AIO operations queued */ -#else -#define SB_NOTIFY (SB_WAIT|SB_SEL|SB_ASYNC) -#define SB_RECV 0x8000 /* this is rcv sb */ + struct socket_filter_entry *so_filt; /* NKE hook */ + u_int32_t so_flags; /* Flags */ +#define SOF_NOSIGPIPE 0x00000001 +#define SOF_NOADDRAVAIL 0x00000002 /* EADDRNOTAVAIL if src addr is gone */ +#define SOF_PCBCLEARING 0x00000004 /* pru_disconnect done; don't + * call pru_detach */ +#define SOF_DEFUNCT 0x00000008 /* socket marked as inactive */ +#define SOF_CLOSEWAIT 0x00000010 /* blocked in close awaiting some events */ +#define SOF_REUSESHAREUID 0x00000040 /* Allows SO_REUSEADDR/SO_REUSEPORT + * for multiple so_uid */ +#define SOF_MULTIPAGES 0x00000080 /* jumbo clusters may be used for sosend */ +#define SOF_ABORTED 0x00000100 /* soabort was already called once */ +#define SOF_OVERFLOW 0x00000200 /* socket was dropped as overflow of + * listen q */ +#define SOF_NOTIFYCONFLICT 0x00000400 /* notify that a bind was done on a + * port already in use */ +#define SOF_UPCALLCLOSEWAIT 0x00000800 /* block close until upcall returns */ +#define SOF_BINDRANDOMPORT 0x00001000 /* Randomized port number for bind */ +#define SOF_NPX_SETOPTSHUT 0x00002000 /* Non POSIX extension to allow + * setsockopt(2) after shut down */ +#define SOF_RECV_TRAFFIC_CLASS 0x00004000 /* Receive TC as ancillary data */ +#define SOF_NODEFUNCT 0x00008000 /* socket cannot be defunct'd */ +#define SOF_PRIVILEGED_TRAFFIC_CLASS 0x00010000 /* traffic class is privileged */ +#define SOF_SUSPENDED 0x00020000 /* i/f output queue is suspended */ +#define SOF_INCOMP_INPROGRESS 0x00040000 /* incomp socket is being processed */ +#define SOF_NOTSENT_LOWAT 0x00080000 /* A different lowat on not sent + * data has been set */ +#define SOF_KNOTE 0x00100000 /* socket is on the EV_SOCK klist */ +#define SOF_USELRO 0x00200000 /* TCP must use LRO on these sockets */ +#define SOF_ENABLE_MSGS 0x00400000 /* TCP must enable message delivery */ +#define SOF_FLOW_DIVERT 0x00800000 /* Flow Divert is enabled */ +#define SOF_MP_SUBFLOW 0x01000000 /* is a multipath subflow socket */ +#define SOF_MP_SEC_SUBFLOW 0x04000000 /* Set up secondary flow */ +#define SOF_MP_TRYFAILOVER 0x08000000 /* Failing subflow */ +#define SOF_DELEGATED 0x10000000 /* on behalf of another process */ +#define SOF_CONTENT_FILTER 0x20000000 /* Content filter enabled */ - caddr_t so_tpcb; /* Wisc. protocol control block - XXX unused? */ -#endif + 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_int16_t so_traffic_class; + int8_t so_netsvctype; + u_int8_t so_restrictions; + thread_t so_send_filt_thread; - void (*so_upcall)(struct socket *so, caddr_t arg, int waitf); - caddr_t so_upcallarg; /* Arg for above */ - uid_t so_uid; /* who opened the socket */ - /* NB: generation count must not be first; easiest to make it last. */ - so_gen_t so_gencnt; /* generation count */ -#ifndef __APPLE__ - void *so_emuldata; /* private data for emulators */ - struct so_accf { - struct accept_filter *so_accept_filter; - void *so_accept_filter_arg; /* saved filter args */ - char *so_accept_filter_str; /* saved user args */ - } *so_accf; -#else - TAILQ_HEAD(,eventqelt) so_evlist; - int cached_in_sock_layer; /* Is socket bundled with pcb/pcb.inp_ppcb? */ - struct socket *cache_next; - struct socket *cache_prev; - u_long cache_timestamp; - 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_long so_flags; /* Flags */ -#define SOF_NOSIGPIPE 0x00000001 -#define SOF_NOADDRAVAIL 0x00000002 /* returns EADDRNOTAVAIL if src address is gone */ -#define SOF_PCBCLEARING 0x00000004 /* pru_disconnect done, no need to call pru_detach */ - int so_usecount; /* refcounting of socket use */; - int so_retaincnt; - u_int32_t so_filteruse; /* usecount for the socket filters */ -/* for debug pruposes */ -#define SO_LCKDBG_MAX 4 /* number of debug locking Link Registers recorded */ - u_int32_t lock_lr[SO_LCKDBG_MAX]; /* socket locking calling history */ - int next_lock_lr; - u_int32_t unlock_lr[SO_LCKDBG_MAX]; /* socket unlocking caller history */ - int next_unlock_lr; - - - void *reserved3; /* Temporarily in use/debug: last socket lock LR */ - void *reserved4; /* Temporarily in use/debug: last socket unlock LR */ - thread_t so_send_filt_thread; + /* for debug pruposes */ +#define SO_LCKDBG_MAX 4 /* number of debug locking Link Registers recorded */ + void *lock_lr[SO_LCKDBG_MAX]; /* locking calling history */ + void *unlock_lr[SO_LCKDBG_MAX]; /* unlocking caller history */ + u_int8_t next_lock_lr; + u_int8_t next_unlock_lr; + + u_int16_t so_pktheadroom; /* headroom before packet payload */ + + u_int32_t so_ifdenied_notifies; /* # of notifications generated */ + + 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 */ + 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 */ + +#if CONTENT_FILTER + struct cfil_info *so_cfil; + struct cfil_db *so_cfil_db; + u_int32_t so_state_change_cnt; /* incr for each connect, disconnect */ #endif + + u_int32_t so_eventmask; /* event mask */ + + pid_t e_pid; /* pid of the effective owner */ + u_int64_t e_upid; /* upid of the effective owner */ + + uuid_t last_uuid; /* uuid of most recent accessor */ + uuid_t e_uuid; /* uuid of effective owner */ + uuid_t so_vuuid; /* UUID of the Voucher originator */ + + int32_t so_policy_gencnt; /* UUID policy gencnt */ + + u_int32_t so_flags1; +#define SOF1_POST_FALLBACK_SYNC 0x00000001 /* fallback to TCP */ +#define SOF1_AWDL_PRIVILEGED 0x00000002 /* unused */ +#define SOF1_IF_2KCL 0x00000004 /* interface prefers 2 KB clusters */ +#define SOF1_DEFUNCTINPROG 0x00000008 +#define SOF1_DATA_IDEMPOTENT 0x00000010 /* idempotent data for TFO */ +#define SOF1_PRECONNECT_DATA 0x00000020 /* request for preconnect data */ +#define SOF1_EXTEND_BK_IDLE_WANTED 0x00000040 /* option set */ +#define SOF1_EXTEND_BK_IDLE_INPROG 0x00000080 /* socket */ +#define SOF1_CACHED_IN_SOCK_LAYER 0x00000100 /* bundled with inpcb and + * tcpcb */ +#define SOF1_TFO_REWIND 0x00000200 /* rewind mptcp meta data */ +#define SOF1_CELLFALLBACK 0x00000400 /* Initiated by cell fallback */ +#define SOF1_QOSMARKING_ALLOWED 0x00000800 /* policy allows DSCP map */ +#define SOF1_TC_NET_SERV_TYPE 0x00001000 /* traffic class set by SO_NETWORK_SERVICE_TYPE */ +#define SOF1_TRAFFIC_MGT_SO_BACKGROUND 0x00002000 /* background socket */ +#define SOF1_TRAFFIC_MGT_TCP_RECVBG 0x00004000 /* Only TCP sockets, receiver throttling */ +#define SOF1_QOSMARKING_POLICY_OVERRIDE 0x00008000 /* Opt-out of QoS marking NECP policy */ +#define SOF1_DATA_AUTHENTICATED 0x00010000 /* idempotent data is authenticated */ +#define SOF1_ACCEPT_LIST_HELD 0x00020000 /* Another thread is accessing one of the accept lists */ +#define SOF1_CONTENT_FILTER_SKIP 0x00040000 /* Content filter should be skipped, socket is blessed */ +#define SOF1_HAS_NECP_CLIENT_UUID 0x00080000 /* NECP client UUID option set */ +#define SOF1_IN_KERNEL_SOCKET 0x00100000 /* Socket created in kernel via KPI */ +#define SOF1_CONNECT_COUNTED 0x00200000 /* connect() call was counted */ +#define SOF1_DNS_COUNTED 0x00400000 /* socket counted to send DNS queries */ +#define SOF1_MPKL_SEND_INFO 0x00800000 /* SO_MPKL_SEND_INFO option is set */ +#define SOF1_INBOUND 0x01000000 /* Created via a passive listener */ + + u_int64_t so_extended_bk_start; + + u_int8_t so_log_seqn; /* Multi-layer Packet Logging rolling sequence number */ + uuid_t so_mpkl_send_uuid; + uint8_t so_mpkl_send_proto; }; -#endif /* KERNEL_PRIVATE */ + +/* 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 0x001 /* no file table ref any more */ -#define SS_ISCONNECTED 0x002 /* socket connected to a peer */ -#define SS_ISCONNECTING 0x004 /* in process of connecting to peer */ -#define SS_ISDISCONNECTING 0x008 /* in process of disconnecting */ -#define SS_CANTSENDMORE 0x010 /* can't send more data to peer */ -#define SS_CANTRCVMORE 0x020 /* can't receive more data from peer */ -#define SS_RCVATMARK 0x040 /* at mark on input */ - -#define SS_PRIV 0x080 /* privileged for broadcast, raw... */ -#define SS_NBIO 0x100 /* non-blocking ops */ -#define SS_ASYNC 0x200 /* async i/o notify */ -#define SS_ISCONFIRMING 0x400 /* deciding to accept connection req */ -#define SS_INCOMP 0x800 /* 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_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 { - size_t xso_len; /* length of this structure */ - struct socket *xso_so; /* makes a convenient handle sometimes */ - short so_type; - short so_options; - short so_linger; - short so_state; - 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_long so_oobmark; - struct xsockbuf { - u_long sb_cc; - u_long sb_hiwat; - u_long sb_mbcnt; - u_long sb_mbmax; - long sb_lowat; - short sb_flags; - short sb_timeo; - } so_rcv, so_snd; - uid_t so_uid; /* XXX */ +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 */ +}; + +#if !CONFIG_EMBEDDED +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 */ +}; +#endif /* !CONFIG_EMBEDDED */ + +#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 +#define XSO_KCREG 0x040 +#define XSO_KCB 0x080 +#define XSO_EVT 0x100 + +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 */ + pid_t so_last_pid; + pid_t so_e_pid; +}; + +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]; }; -#ifdef KERNEL_PRIVATE /* - * Macros for sockets and socket buffering. + * Global socket statistics */ +struct soextbkidlestat { + u_int32_t so_xbkidle_maxperproc; + u_int32_t so_xbkidle_time; + u_int32_t so_xbkidle_rcvhiwat; + int32_t so_xbkidle_notsupp; + int32_t so_xbkidle_toomany; + int32_t so_xbkidle_wantok; + int32_t so_xbkidle_active; + int32_t so_xbkidle_nocell; + int32_t so_xbkidle_notime; + int32_t so_xbkidle_forced; + int32_t so_xbkidle_resumed; + int32_t so_xbkidle_expired; + int32_t so_xbkidle_resched; + int32_t so_xbkidle_nodlgtd; + int32_t so_xbkidle_drained; +}; +#endif /* PRIVATE */ -#define sbtoso(sb) (sb->sb_so) +#pragma pack() + +#ifdef KERNEL_PRIVATE +#include /* - * Functions for sockets and socket buffering. - * These are macros on FreeBSD. On Darwin the - * implementation is in bsd/kern/uipc_socket2.c + * 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 */ +}; -__BEGIN_DECLS -int sb_notify(struct sockbuf *sb); -long sbspace(struct sockbuf *sb); -int sosendallatonce(struct socket *so); -int soreadable(struct socket *so); -int sowriteable(struct socket *so); -void sballoc(struct sockbuf *sb, struct mbuf *m); -void sbfree(struct sockbuf *sb, struct mbuf *m); -int sblock(struct sockbuf *sb, int wf); -void sbunlock(struct sockbuf *sb, int locked); -void sorwakeup(struct socket * so); -void sowwakeup(struct socket * so); -__END_DECLS +#ifdef MALLOC_DECLARE +MALLOC_DECLARE(M_PCB); +MALLOC_DECLARE(M_SONAME); +#endif /* MALLOC_DECLARE */ + +#ifdef BSD_KERNEL_PRIVATE +struct cmsghdr; +extern boolean_t is_cmsg_valid(struct mbuf *control, struct cmsghdr *cmsg); /* * Socket extension mechanism: control block hooks: @@ -313,157 +589,440 @@ __END_DECLS * 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 */ +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 */ + struct sockif *e_soif; /* Socket functions */ + struct sockutil *e_sout; /* Sockbuf utility functions */ }; -#define EXT_NULL 0x0 /* STATE: Not in use */ -#define sotokextcb(so) (so ? so->so_ext : 0) +#define EXT_NULL 0x0 /* STATE: Not in use */ -#ifdef KERNEL +/* 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_MPCANTRCVMORE 0x00040000 /* MPTCP DFIN Received */ +#define SO_FILT_HINT_NOTIFY_ACK 0x00080000 /* Notify Acknowledgement */ +#define SO_FILT_HINT_MP_SUB_ERROR 0x00100000 /* Error happend on subflow */ -#define SO_FILT_HINT_LOCKED 0x1 +#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\23MPCANTRCVMORE\24NOTIFYACK"\ + "\25MPSUBERROR" -/* - * 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 */ -}; +/* 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 | \ + SO_FILT_HINT_NOTIFY_ACK) #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 */ + 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 +#endif /* SENDFILE */ -#ifdef MALLOC_DECLARE -MALLOC_DECLARE(M_PCB); -MALLOC_DECLARE(M_SONAME); -#endif +#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) -extern int maxsockets; -extern u_long sb_max; -extern int socket_zone; +#define SODEFUNCTLOG(fmt, ...) do { \ + if (sodefunctlog) \ + printf(fmt, __VA_ARGS__); \ +} while (0) + +#define SOTHROTTLELOG(fmt, ...) do { \ + if (sothrottlelog) \ + printf(fmt, __VA_ARGS__); \ +} while (0) + +/* + * For debugging traffic class behaviors + */ +#define SOTCDB_RESERVED 0x01 +#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; + uuid_t spi_uuid; + uuid_t spi_euuid; + int spi_delegated; + char spi_proc_name[MAXCOMLEN + 1]; + char spi_e_proc_name[MAXCOMLEN + 1]; +}; + +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 sorestrictsend; +extern int somaxconn; +extern uint32_t tcp_do_autosendbuf; +extern uint32_t tcp_autosndbuf_max; +extern uint32_t tcp_autosndbuf_inc; +extern u_int32_t sotcdb; +extern u_int32_t net_io_policy_log; +extern u_int32_t net_io_policy_throttle_best_effort; +#if CONFIG_PROC_UUID_POLICY +extern u_int32_t net_io_policy_uuid; +#endif /* CONFIG_PROC_UUID_POLICY */ + +extern struct soextbkidlestat soextbkidlestat; + +#endif /* BSD_KERNEL_PRIVATE */ -struct file; -struct filedesc; struct mbuf; struct sockaddr; -struct stat; struct ucred; struct uio; -struct knote; + +#define SOCK_MSG_SA 0x01 +#define SOCK_MSG_CONTROL 0x02 +#define SOCK_MSG_DATA 0x04 + +struct recv_msg_elem { + struct uio *uio; + struct sockaddr *psa; + struct mbuf *controlp; + int which; + int flags; +}; /* * From uipc_socket and friends */ __BEGIN_DECLS -struct sockaddr *dup_sockaddr(struct sockaddr *sa, int canwait); -int getsock(struct filedesc *fdp, int fd, struct file **fpp); -int sockargs(struct mbuf **mp, user_addr_t data, int buflen, int type); -int getsockaddr(struct sockaddr **namp, user_addr_t uaddr, size_t len); -int sbappend(struct sockbuf *sb, struct mbuf *m); -int sbappendaddr(struct sockbuf *sb, struct sockaddr *asa, - struct mbuf *m0, struct mbuf *control, int *error_out); -int sbappendcontrol(struct sockbuf *sb, struct mbuf *m0, - struct mbuf *control, int *error_out); -int sbappendrecord(struct sockbuf *sb, struct mbuf *m0); -void sbcheck(struct sockbuf *sb); -struct mbuf * - sbcreatecontrol(caddr_t p, int size, int type, int level); -void sbdrop(struct sockbuf *sb, int len); -void sbdroprecord(struct sockbuf *sb); -void sbflush(struct sockbuf *sb); -int sbinsertoob(struct sockbuf *sb, struct mbuf *m0); -void sbrelease(struct sockbuf *sb); -int sbreserve(struct sockbuf *sb, u_long cc); -void sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb); -int sbwait(struct sockbuf *sb); -int sb_lock(struct sockbuf *sb); -int soabort(struct socket *so); -int soaccept(struct socket *so, struct sockaddr **nam); -int soacceptlock (struct socket *so, struct sockaddr **nam, int dolock); -struct socket *soalloc(int waitok, int dom, int type); -int sobind(struct socket *so, struct sockaddr *nam); -void socantrcvmore(struct socket *so); -void socantsendmore(struct socket *so); -int soclose(struct socket *so); -int soconnect(struct socket *so, struct sockaddr *nam); -int soconnectlock (struct socket *so, struct sockaddr *nam, int dolock); -int soconnect2(struct socket *so1, struct socket *so2); -int socreate(int dom, struct socket **aso, int type, int proto); -void sodealloc(struct socket *so); -int sodisconnect(struct socket *so); -void sofree(struct socket *so); -int sogetopt(struct socket *so, struct sockopt *sopt); -void sohasoutofband(struct socket *so); -void soisconnected(struct socket *so); -void soisconnecting(struct socket *so); -void soisdisconnected(struct socket *so); -void soisdisconnecting(struct socket *so); -int solisten(struct socket *so, int backlog); -struct socket * - sodropablereq(struct socket *head); -struct socket * - sonewconn(struct socket *head, int connstatus, const struct sockaddr* from); -int sooptcopyin(struct sockopt *sopt, void *data, size_t len, size_t minlen); -int sooptcopyout(struct sockopt *sopt, void *data, size_t len); -int socket_lock(struct socket *so, int refcount); -int socket_unlock(struct socket *so, int refcount); +/* Exported */ +extern int sbappendaddr(struct sockbuf *sb, struct sockaddr *asa, + struct mbuf *m0, struct mbuf *control, int *error_out); +extern int sbappendchain(struct sockbuf *sb, struct mbuf *m, int space); +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 boolean_t socanwrite(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) +__attribute__ ((warn_unused_result)); +extern int sooptcopyout(struct sockopt *sopt, void *data, size_t len) +__attribute__ ((warn_unused_result)); +extern int soopt_cred_check(struct socket *so, int priv, boolean_t allow_root, + boolean_t ignore_delegate); +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 soreserve_preconnect(struct socket *so, unsigned int pre_cc); +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); +extern int sosend_reinject(struct socket *so, struct sockaddr *addr, struct mbuf *top, + struct mbuf *control, uint32_t sendflags); +extern int sosend_list(struct socket *so, struct uio **uio, u_int uiocnt, + int flags); +extern int soreceive_list(struct socket *so, struct recv_msg_elem *msgarray, + u_int msgcnt, int *flags); +extern void sonullevent(struct socket *so, void *arg, uint32_t hint); +extern struct mbuf *sbconcat_mbufs(struct sockbuf *sb, struct sockaddr *asa, struct mbuf *m0, + struct mbuf *control); + + +__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 void so_acquire_accept_list(struct socket *, struct socket *); +extern void so_release_accept_list(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 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); /* - * XXX; prepare mbuf for (__FreeBSD__ < 3) routines. - * Used primarily in IPSec and IPv6 code. + * Flags to sblock(). */ -int soopt_getm(struct sockopt *sopt, struct mbuf **mp); -int soopt_mcopyin(struct sockopt *sopt, struct mbuf *m); -int soopt_mcopyout(struct sockopt *sopt, struct mbuf *m); - -int sopoll(struct socket *so, int events, struct ucred *cred, void *wql); -int soreceive(struct socket *so, struct sockaddr **paddr, - struct uio *uio, struct mbuf **mp0, - struct mbuf **controlp, int *flagsp); -int soreserve(struct socket *so, u_long sndcc, u_long rcvcc); -void sorflush(struct socket *so); -int sosend(struct socket *so, struct sockaddr *addr, struct uio *uio, - struct mbuf *top, struct mbuf *control, int flags); - -int sosetopt(struct socket *so, struct sockopt *sopt); -int soshutdown(struct socket *so, int how); -void sotoxsocket(struct socket *so, struct xsocket *xso); -void sowakeup(struct socket *so, struct sockbuf *sb); -int soioctl(struct socket *so, u_long cmd, caddr_t data, struct proc *p); - -#ifndef __APPLE__ -/* accept filter functions */ -int accept_filt_add(struct accept_filter *filt); -int accept_filt_del(char *name); -struct accept_filter * accept_filt_get(char *name); -#ifdef ACCEPT_FILTER_MOD -int accept_filt_generic_mod_event(module_t mod, int event, void *data); -SYSCTL_DECL(_net_inet_accf); -#endif /* ACCEPT_FILTER_MOD */ -#endif /* !defined(__APPLE__) */ +#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); -__END_DECLS +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, struct socket *head); +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 *src, + struct sockaddr *dst, struct proc *, uint32_t, sae_associd_t, + sae_connid_t *, uint32_t, void *, u_int32_t, uio_t, user_ssize_t *); +extern int sodisconnectx(struct socket *so, sae_associd_t, sae_connid_t); +extern int sodisconnectxlocked(struct socket *so, sae_associd_t, sae_connid_t); +extern void soevupcall(struct socket *, u_int32_t); +/* flags for socreate_internal */ +#define SOCF_MPTCP 0x1 /* MPTCP-subflow */ +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 void soif2kcl(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 int soresume(struct proc *, struct socket *, int); +extern void resume_proc_sockets(proc_t); +extern int so_check_extended_bk_idle_time(struct socket *); +extern void so_drain_extended_bk_idle(struct socket *); +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 soissrcrealtime(struct socket *so); +extern int soissrcbesteffort(struct socket *so); +extern void soclearfastopen(struct socket *so); +extern int solisten(struct socket *so, int backlog); +extern struct socket *sodropablereq(struct socket *head); +extern lck_mtx_t *socket_getlock(struct socket *so, int flags); +extern void socket_lock(struct socket *so, int refcount); +extern void socket_lock_assert_owned(struct socket *so); +extern int socket_try_lock(struct socket *so); +extern void 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, struct socket *so2); +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 int soshutdownlock_final(struct socket *so, int how); +extern void sotoxsocket(struct socket *so, struct xsocket *xso); +#if !CONFIG_EMBEDDED +extern void sotoxsocket64(struct socket *so, struct xsocket64 *xso); +#endif /* !CONFIG_EMBEDDED */ +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 *); -#endif /* KERNEL */ -#endif /* KERNEL_PRIVATE */ +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 *, struct kevent_qos_s *); + +/* 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 */ +#define PKT_SCF_TCP_SYN 0x00000004 /* TCP SYN */ + +/* + * Flags for connectx(2) user-protocol request routine. + */ + +#define CONNREQF_MPTCP 0x1 /* called internally by MPTCP */ +#define CONNREQF_UIO 0x2 /* there's data */ +#define CONNREQF_IDEM 0x4 /* data is idempotent */ + +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 int so_tc_from_control(struct mbuf *, int *); +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_net_service_type(struct socket *, int); +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 *so, int epid, struct proc *p, boolean_t check_cred); +extern int so_set_effective_uuid(struct socket *so, uuid_t euuid, struct proc *p, boolean_t check_cred); +extern int so_set_restrictions(struct socket *, uint32_t); +extern uint32_t so_get_restrictions(struct socket *); +extern void socket_tclass_init(void); +#if (DEVELOPMENT || DEBUG) +extern int so_set_tcdbg(struct socket *, struct so_tcdbg *); +extern int sogetopt_tcdbg(struct socket *, struct sockopt *); +#endif /* (DEVELOPMENT || DEBUG) */ +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 void so_inc_recv_data_stat(struct socket *, size_t, size_t, uint32_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_fallback_sbdrop(struct socket *so, struct mbuf *m, int len); +extern void mptcp_preproc_sbdrop(struct socket *, struct mbuf *, unsigned int); +extern void mptcp_postproc_sbdrop(struct mbuf *, u_int64_t, u_int32_t, + u_int32_t); + +extern void netpolicy_post_msg(uint32_t, struct netpolicy_event_data *, + uint32_t); +/* + * Socket operation routines. + * These routines are called by the routines in + * sys_socket.c or from a system process, and + * implement the semantics of socket operations by + * switching out to the protocol specific routines. + */ +extern void postevent(struct socket *, struct sockbuf *, int); +extern void evsofree(struct socket *); + +extern int tcp_notsent_lowat_check(struct socket *so); + +extern user_ssize_t uio_array_resid(struct uio **, u_int); +extern user_ssize_t recv_msg_array_resid(struct recv_msg_elem *, u_int); + +void sotoxsocket_n(struct socket *, struct xsocket_n *); +void sbtoxsockbuf_n(struct sockbuf *, struct xsockbuf_n *); +void sbtoxsockstat_n(struct socket *, struct xsockstat_n *); + +__END_DECLS +#endif /* BSD_KERNEL_PRIVATE */ +#endif /* KERNEL_PRIVATE */ #endif /* !_SYS_SOCKETVAR_H_ */