bsd/sys/socketvar.h

   1 /*
   2  * Copyright (c) 2000-2019 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
  29 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  30 /*
  31  * Copyright (c) 1982, 1986, 1990, 1993
  32  *      The Regents of the University of California.  All rights reserved.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  * 3. All advertising materials mentioning features or use of this software
  43  *    must display the following acknowledgement:
  44  *      This product includes software developed by the University of
  45  *      California, Berkeley and its contributors.
  46  * 4. Neither the name of the University nor the names of its contributors
  47  *    may be used to endorse or promote products derived from this software
  48  *    without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  60  * SUCH DAMAGE.
  61  *
  62  *      @(#)socketvar.h 8.3 (Berkeley) 2/19/95
  63  * $FreeBSD: src/sys/sys/socketvar.h,v 1.46.2.6 2001/08/31 13:45:49 jlemon Exp $
  64  */
  65 /*
  66  * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
  67  * support for mandatory and extensible security protections.  This notice
  68  * is included in support of clause 2.2 (b) of the Apple Public License,
  69  * Version 2.0.
  70  */
  71
  72 #ifndef _SYS_SOCKETVAR_H_
  73 #define _SYS_SOCKETVAR_H_
  74
  75 #include <sys/appleapiopts.h>
  76 #include <sys/cdefs.h>
  77 #include <sys/types.h> /* u_quad_t */
  78 #ifdef KERNEL_PRIVATE
  79 #include <sys/queue.h>                  /* for TAILQ macros */
  80 #include <sys/select.h>                 /* for struct selinfo */
  81 #include <net/kext_net.h>
  82 #include <sys/ev.h>
  83 #include <uuid/uuid.h>
  84 #ifdef BSD_KERNEL_PRIVATE
  85 #include <sys/eventhandler.h>
  86 #endif /* BSD_KERNEL_PRIVATE */
  87 #endif /* KERNEL_PRIVATE */
  88
  89 typedef u_quad_t so_gen_t;
  90
  91 #ifdef KERNEL_PRIVATE
  92 struct mbuf;
  93 struct socket_filter_entry;
  94 struct protosw;
  95 struct sockif;
  96 struct sockutil;
  97
  98 /* strings for sleep message: */
  99 extern  char netio[], netcon[], netcls[];
 100 #define SOCKET_CACHE_ON
 101 #define SO_CACHE_FLUSH_INTERVAL 1       /* Seconds */
 102 #define SO_CACHE_TIME_LIMIT     (120/SO_CACHE_FLUSH_INTERVAL) /* Seconds */
 103 #define SO_CACHE_MAX_FREE_BATCH 50
 104 #define MAX_CACHED_SOCKETS      512
 105 #define TEMPDEBUG               0
 106 #endif /* KERNEL_PRIVATE */
 107
 108 #ifdef PRIVATE
 109 #define SO_TC_STATS_MAX 4
 110
 111 struct data_stats {
 112         u_int64_t       rxpackets;
 113         u_int64_t       rxbytes;
 114         u_int64_t       txpackets;
 115         u_int64_t       txbytes;
 116 };
 117
 118 #define MSG_PRI_0 0     /* TCP message priority, lowest */
 119 #define MSG_PRI_1 1
 120 #define MSG_PRI_2 2
 121 #define MSG_PRI_3 3     /* TCP message priority, highest */
 122 #define MSG_PRI_MAX MSG_PRI_3
 123 #define MSG_PRI_MIN MSG_PRI_0
 124 #define MSG_PRI_COUNT 4
 125 #define MSG_PRI_DEFAULT MSG_PRI_1
 126 #endif /* PRIVATE */
 127
 128 #ifdef KERNEL_PRIVATE
 129 /* State for TCP message send or receive */
 130 struct msg_priq {
 131         struct mbuf *msgq_head; /* first mbuf in the queue */
 132         struct mbuf *msgq_tail; /* last mbuf in the queue */
 133         struct mbuf *msgq_lastmsg; /* last message in the queue */
 134         u_int32_t msgq_flags;   /* flags per priority queue */
 135 #define MSGQ_MSG_NOTDONE 0x1    /* set when EOR of a msg is not seen */
 136         u_int32_t msgq_bytes;   /* data bytes in this queue */
 137 };
 138
 139 struct msg_state {
 140         struct msg_priq msg_priq[MSG_PRI_COUNT]; /* priority queues */
 141         u_int32_t msg_serial_bytes; /* bytes moved to serial queue */
 142         u_int32_t msg_uno_bytes; /* out-of-order chars in rcv buffer */
 143 };
 144
 145 /* mbuf flag used to indicate out of order data received */
 146 #define M_UNORDERED_DATA M_PROTO1
 147
 148 /*
 149  * Kernel structure per socket.
 150  * Contains send and receive buffer queues,
 151  * handle on protocol and pointer to protocol
 152  * private data and error information.
 153  */
 154 struct socket {
 155         int     so_zone;                /* zone we were allocated from */
 156         short   so_type;                /* generic type, see socket.h */
 157         u_short so_error;               /* error affecting connection */
 158         u_int32_t so_options;           /* from socket call, see socket.h */
 159         short   so_linger;              /* time to linger while closing */
 160         short   so_state;               /* internal state flags SS_*, below */
 161         void    *so_pcb;                /* protocol control block */
 162         struct  protosw *so_proto;      /* protocol handle */
 163         /*
 164          * Variables for connection queueing.
 165          * Socket where accepts occur is so_head in all subsidiary sockets.
 166          * If so_head is 0, socket is not related to an accept.
 167          * For head socket so_incomp queues partially completed connections,
 168          * while so_comp is a queue of connections ready to be accepted.
 169          * If a connection is aborted and it has so_head set, then
 170          * it has to be pulled out of either so_incomp or so_comp.
 171          * We allow connections to queue up based on current queue lengths
 172          * and limit on number of queued connections for this socket.
 173          */
 174         struct  socket *so_head;        /* back pointer to accept socket */
 175         TAILQ_HEAD(, socket) so_incomp; /* q of partially unaccepted conns */
 176         TAILQ_HEAD(, socket) so_comp;   /* q of complete unaccepted conns */
 177         TAILQ_ENTRY(socket) so_list;    /* list of unaccepted connections */
 178         short   so_qlen;                /* number of unaccepted connections */
 179         short   so_incqlen;             /* number of unaccepted incomplete
 180                                          *  connections */
 181         short   so_qlimit;              /* max number queued connections */
 182         short   so_timeo;               /* connection timeout */
 183         pid_t   so_pgid;                /* pgid for signals */
 184         u_int32_t so_oobmark;           /* chars to oob mark */
 185         /*
 186          * Variables for socket buffering.
 187          */
 188         struct sockbuf {
 189                 u_int32_t       sb_cc;          /* actual chars in buffer */
 190                 u_int32_t       sb_hiwat;       /* max actual char count */
 191                 u_int32_t       sb_mbcnt;       /* chars of mbufs used */
 192                 u_int32_t       sb_mbmax;       /* max chars of mbufs to use */
 193                 u_int32_t       sb_ctl;         /* non-data chars in buffer */
 194                 u_int32_t       sb_lowat;       /* low water mark */
 195                 struct mbuf     *sb_mb;         /* the mbuf chain */
 196                 struct mbuf     *sb_mbtail;     /* the last mbuf in the chain */
 197                 struct mbuf     *sb_lastrecord; /* first mbuf of last record */
 198                 struct socket   *sb_so;         /* socket back ptr for kexts */
 199                 struct selinfo  sb_sel;         /* process selecting rd/wr */
 200                 struct timeval  sb_timeo;       /* timeout for read/write */
 201                 u_int32_t       sb_flags;       /* flags, see below */
 202                 u_int32_t       sb_idealsize;   /* Ideal size for the sb based
 203                                                  *  on bandwidth and delay */
 204                 void    (*sb_upcall)(struct socket *, void *arg, int waitf);
 205                 void    *sb_upcallarg;          /* Arg for above */
 206                 u_int32_t       sb_wantlock;    /* # of SB_LOCK waiters */
 207                 u_int32_t       sb_waiters;     /* # of data/space waiters */
 208                 thread_t        sb_cfil_thread; /* content filter thread */
 209                 u_int32_t       sb_cfil_refs;   /* # of nested calls */
 210                 u_int32_t       sb_preconn_hiwat; /* preconnect hiwat mark */
 211         } so_rcv, so_snd;
 212 #define SB_MAX          (8192*1024)     /* default for max chars in sockbuf */
 213 #define LOW_SB_MAX      (2*9*1024)      /* lower limit on max socket buffer
 214                                          *  size, 2 max datagrams */
 215 #define SB_LOCK         0x1             /* lock on data queue */
 216 #define SB_NOINTR       0x2             /* operations not interruptible */
 217 #define SB_RECV         0x4             /* this is rcv sb */
 218 #define SB_SEL          0x8             /* someone is selecting */
 219 #define SB_ASYNC        0x10            /* ASYNC I/O, need signals */
 220 #define SB_UPCALL       0x20            /* someone wants an upcall */
 221 #define SB_KNOTE        0x40            /* kernel note attached */
 222 #define SB_DROP         0x80            /* does not accept any more data */
 223 #define SB_UNIX         0x100           /* UNIX domain socket buffer */
 224 #define SB_USRSIZE      0x200           /* user specified sbreserve */
 225 #define SB_AUTOSIZE     0x400           /* automatically size socket buffer */
 226 #define SB_TRIM         0x800           /* Trim the socket buffer */
 227 #define SB_NOCOMPRESS   0x1000          /* do not compress socket buffer */
 228 #define SB_SNDBYTE_CNT  0x2000          /* keep track of snd bytes per interface */
 229 #define SB_UPCALL_LOCK  0x4000          /* Keep socket locked when doing the upcall */
 230         caddr_t so_tpcb;                /* Misc. protocol control block, used
 231                                          *  by some kexts */
 232
 233         void            (*so_event)(struct socket *, void *, u_int32_t);
 234         void            *so_eventarg;   /* Arg for above */
 235         kauth_cred_t    so_cred;        /* cred of who opened the socket */
 236         /* NB: generation count must not be first; easiest to make it last. */
 237         so_gen_t so_gencnt;             /* generation count */
 238         TAILQ_HEAD(, eventqelt) so_evlist;
 239         STAILQ_ENTRY(socket) so_cache_ent;      /* socache entry */
 240         caddr_t         so_saved_pcb;           /* Saved pcb when cacheing */
 241         u_int32_t       cache_timestamp;        /* time socket was cached */
 242
 243         pid_t           last_pid;       /* pid of most recent accessor */
 244         u_int64_t       last_upid;      /* upid of most recent accessor */
 245
 246         struct socket_filter_entry *so_filt;    /* NKE hook */
 247         u_int32_t       so_flags;               /* Flags */
 248 #define SOF_NOSIGPIPE           0x00000001
 249 #define SOF_NOADDRAVAIL         0x00000002 /* EADDRNOTAVAIL if src addr is gone */
 250 #define SOF_PCBCLEARING         0x00000004 /* pru_disconnect done; don't
 251                                             *    call pru_detach */
 252 #define SOF_DEFUNCT             0x00000008 /* socket marked as inactive */
 253 #define SOF_CLOSEWAIT           0x00000010 /* blocked in close awaiting some events */
 254 #define SOF_REUSESHAREUID       0x00000040 /* Allows SO_REUSEADDR/SO_REUSEPORT
 255                                             *    for multiple so_uid */
 256 #define SOF_MULTIPAGES          0x00000080 /* jumbo clusters may be used for sosend */
 257 #define SOF_ABORTED             0x00000100 /* soabort was already called once */
 258 #define SOF_OVERFLOW            0x00000200 /* socket was dropped as overflow of
 259                                             *    listen q */
 260 #define SOF_NOTIFYCONFLICT      0x00000400 /* notify that a bind was done on a
 261                                             *    port already in use */
 262 #define SOF_UPCALLCLOSEWAIT     0x00000800 /* block close until upcall returns */
 263 #define SOF_BINDRANDOMPORT      0x00001000 /* Randomized port number for bind */
 264 #define SOF_NPX_SETOPTSHUT      0x00002000 /* Non POSIX extension to allow
 265                                             *    setsockopt(2) after shut down */
 266 #define SOF_RECV_TRAFFIC_CLASS  0x00004000 /* Receive TC as ancillary data */
 267 #define SOF_NODEFUNCT           0x00008000 /* socket cannot be defunct'd */
 268 #define SOF_PRIVILEGED_TRAFFIC_CLASS 0x00010000 /* traffic class is privileged */
 269 #define SOF_SUSPENDED           0x00020000 /* i/f output queue is suspended */
 270 #define SOF_INCOMP_INPROGRESS   0x00040000 /* incomp socket is being processed */
 271 #define SOF_NOTSENT_LOWAT       0x00080000 /* A different lowat on not sent
 272                                             *    data has been set */
 273 #define SOF_KNOTE               0x00100000 /* socket is on the EV_SOCK klist */
 274 #define SOF_USELRO              0x00200000 /* TCP must use LRO on these sockets */
 275 #define SOF_ENABLE_MSGS         0x00400000 /* TCP must enable message delivery */
 276 #define SOF_FLOW_DIVERT         0x00800000 /* Flow Divert is enabled */
 277 #define SOF_MP_SUBFLOW          0x01000000 /* is a multipath subflow socket */
 278 #define SOF_MP_SEC_SUBFLOW      0x04000000 /* Set up secondary flow */
 279 #define SOF_MP_TRYFAILOVER      0x08000000 /* Failing subflow */
 280 #define SOF_DELEGATED           0x10000000 /* on behalf of another process */
 281 #define SOF_CONTENT_FILTER      0x20000000 /* Content filter enabled */
 282
 283         uint32_t        so_upcallusecount; /* number of upcalls in progress */
 284         int             so_usecount;    /* refcounting of socket use */
 285         int             so_retaincnt;
 286         u_int32_t       so_filteruse;   /* usecount for the socket filters */
 287         u_int16_t       so_traffic_class;
 288         int8_t          so_netsvctype;
 289         u_int8_t        so_restrictions;
 290         thread_t        so_send_filt_thread;
 291
 292         /* for debug pruposes */
 293 #define SO_LCKDBG_MAX 4 /* number of debug locking Link Registers recorded */
 294         void    *lock_lr[SO_LCKDBG_MAX];        /* locking calling history */
 295         void    *unlock_lr[SO_LCKDBG_MAX];      /* unlocking caller history */
 296         u_int8_t        next_lock_lr;
 297         u_int8_t        next_unlock_lr;
 298
 299         u_int16_t       so_pktheadroom; /* headroom before packet payload */
 300
 301         u_int32_t       so_ifdenied_notifies; /* # of notifications generated */
 302
 303         struct label    *so_label;      /* MAC label for socket */
 304         struct label    *so_peerlabel;  /* cached MAC label for socket peer */
 305         thread_t        so_background_thread;   /* thread that marked
 306                                                  *  this socket background */
 307         struct data_stats so_tc_stats[SO_TC_STATS_MAX];
 308         struct klist    so_klist;               /* klist for EV_SOCK events */
 309
 310         struct msg_state *so_msg_state;         /* unordered snd/rcv state */
 311         struct flow_divert_pcb  *so_fd_pcb;     /* Flow Divert control block */
 312
 313 #if CONTENT_FILTER
 314         struct cfil_info    *so_cfil;
 315         struct cfil_db      *so_cfil_db;
 316         u_int32_t           so_state_change_cnt; /* incr for each connect, disconnect */
 317 #endif
 318
 319         u_int32_t       so_eventmask;           /* event mask */
 320
 321         pid_t           e_pid;          /* pid of the effective owner */
 322         u_int64_t       e_upid;         /* upid of the effective owner */
 323
 324         uuid_t          last_uuid;      /* uuid of most recent accessor */
 325         uuid_t          e_uuid;         /* uuid of effective owner */
 326         uuid_t          so_vuuid;       /* UUID of the Voucher originator */
 327
 328         int32_t         so_policy_gencnt; /* UUID policy gencnt */
 329
 330         u_int32_t       so_flags1;
 331 #define SOF1_POST_FALLBACK_SYNC         0x00000001 /* fallback to TCP */
 332 #define SOF1_AWDL_PRIVILEGED            0x00000002 /* unused */
 333 #define SOF1_IF_2KCL                    0x00000004 /* interface prefers 2 KB clusters */
 334 #define SOF1_DEFUNCTINPROG              0x00000008
 335 #define SOF1_DATA_IDEMPOTENT            0x00000010 /* idempotent data for TFO */
 336 #define SOF1_PRECONNECT_DATA            0x00000020 /* request for preconnect data */
 337 #define SOF1_EXTEND_BK_IDLE_WANTED      0x00000040 /* option set */
 338 #define SOF1_EXTEND_BK_IDLE_INPROG      0x00000080 /* socket */
 339 #define SOF1_CACHED_IN_SOCK_LAYER       0x00000100 /* bundled with inpcb and
 340                                                     *  tcpcb */
 341 #define SOF1_TFO_REWIND                 0x00000200 /* rewind mptcp meta data */
 342 #define SOF1_CELLFALLBACK               0x00000400 /* Initiated by cell fallback */
 343 #define SOF1_QOSMARKING_ALLOWED         0x00000800 /* policy allows DSCP map */
 344 #define SOF1_TC_NET_SERV_TYPE           0x00001000 /* traffic class set by SO_NETWORK_SERVICE_TYPE */
 345 #define SOF1_TRAFFIC_MGT_SO_BACKGROUND  0x00002000 /* background socket */
 346 #define SOF1_TRAFFIC_MGT_TCP_RECVBG     0x00004000 /* Only TCP sockets, receiver throttling */
 347 #define SOF1_QOSMARKING_POLICY_OVERRIDE 0x00008000 /* Opt-out of QoS marking NECP policy */
 348 #define SOF1_DATA_AUTHENTICATED         0x00010000 /* idempotent data is authenticated */
 349 #define SOF1_ACCEPT_LIST_HELD           0x00020000 /* Another thread is accessing one of the accept lists */
 350 #define SOF1_CONTENT_FILTER_SKIP        0x00040000 /* Content filter should be skipped, socket is blessed */
 351 #define SOF1_HAS_NECP_CLIENT_UUID       0x00080000 /* NECP client UUID option set */
 352 #define SOF1_IN_KERNEL_SOCKET           0x00100000 /* Socket created in kernel via KPI */
 353 #define SOF1_CONNECT_COUNTED            0x00200000 /* connect() call was counted */
 354 #define SOF1_DNS_COUNTED                0x00400000 /* socket counted to send DNS queries */
 355 #define SOF1_MPKL_SEND_INFO             0x00800000 /* SO_MPKL_SEND_INFO option is set */
 356 #define SOF1_INBOUND                    0x01000000 /* Created via a passive listener */
 357
 358         u_int64_t       so_extended_bk_start;
 359
 360         u_int8_t        so_log_seqn;    /* Multi-layer Packet Logging rolling sequence number */
 361         uuid_t          so_mpkl_send_uuid;
 362         uint8_t         so_mpkl_send_proto;
 363 };
 364
 365 /* Control message accessor in mbufs */
 366
 367 #define _MIN_NXT_CMSGHDR_PTR(cmsg)                                      \
 368         ((char *)(cmsg) +                                               \
 369             __DARWIN_ALIGN32((__uint32_t)(cmsg)->cmsg_len) +            \
 370             __DARWIN_ALIGN32(sizeof(struct cmsghdr)))
 371
 372 #define M_FIRST_CMSGHDR(m)                                              \
 373         ((char *)(m) != (char *)0L &&                                   \
 374         (size_t)(m)->m_len >= sizeof (struct cmsghdr) &&                \
 375         (socklen_t)(m)->m_len >=                                        \
 376         __DARWIN_ALIGN32(((struct cmsghdr *)(void *)(m)->m_data)->cmsg_len) ? \
 377         (struct cmsghdr *)(void *)(m)->m_data : (struct cmsghdr *)0L)
 378
 379 #define M_NXT_CMSGHDR(m, cmsg)                                          \
 380         ((char *)(cmsg) == (char *)0L ? M_FIRST_CMSGHDR(m) :            \
 381         _MIN_NXT_CMSGHDR_PTR(cmsg) > ((char *)(m)->m_data) + (m)->m_len ||  \
 382         _MIN_NXT_CMSGHDR_PTR(cmsg) < (char *)(m)->m_data ?              \
 383         (struct cmsghdr *)0L /* NULL */ :                               \
 384         (struct cmsghdr *)(void *)((unsigned char *)(cmsg) +            \
 385         __DARWIN_ALIGN32((__uint32_t)(cmsg)->cmsg_len)))
 386
 387 /*
 388  * Socket state bits.
 389  */
 390 #define SS_NOFDREF              0x0001  /* no file table ref any more */
 391 #define SS_ISCONNECTED          0x0002  /* socket connected to a peer */
 392 #define SS_ISCONNECTING         0x0004  /* in process of connecting to peer */
 393 #define SS_ISDISCONNECTING      0x0008  /* in process of disconnecting */
 394 #define SS_CANTSENDMORE         0x0010  /* can't send more data to peer */
 395 #define SS_CANTRCVMORE          0x0020  /* can't receive more data from peer */
 396 #define SS_RCVATMARK            0x0040  /* at mark on input */
 397
 398 #define SS_PRIV                 0x0080  /* privileged for broadcast, raw... */
 399 #define SS_NBIO                 0x0100  /* non-blocking ops */
 400 #define SS_ASYNC                0x0200  /* async i/o notify */
 401 #define SS_ISCONFIRMING         0x0400  /* deciding to accept connection req */
 402 #define SS_INCOMP               0x0800  /* Unaccepted, incomplete connection */
 403 #define SS_COMP                 0x1000  /* unaccepted, complete connection */
 404 #define SS_ISDISCONNECTED       0x2000  /* socket disconnected from peer */
 405 #define SS_DRAINING             0x4000  /* close waiting for blocked system
 406                                          *       calls to drain */
 407 #define SS_DEFUNCT              0x8000  /* has been fully defunct'd */
 408 #endif /* KERNEL_PRIVATE */
 409
 410 #if defined(__LP64__)
 411 #define _XSOCKET_PTR(x)         u_int32_t
 412 #else
 413 #define _XSOCKET_PTR(x)         x
 414 #endif
 415
 416 #ifdef PRIVATE
 417 /* Flags returned in data field for EVFILT_SOCK events. */
 418 #define SOCKEV_CONNECTED        0x00000001 /* connected */
 419 #define SOCKEV_DISCONNECTED     0x00000002 /* disconnected */
 420 #endif /* PRIVATE */
 421
 422 #pragma pack(4)
 423
 424 struct xsockbuf {
 425         u_int32_t       sb_cc;
 426         u_int32_t       sb_hiwat;
 427         u_int32_t       sb_mbcnt;
 428         u_int32_t       sb_mbmax;
 429         int32_t         sb_lowat;
 430         short           sb_flags;
 431         short           sb_timeo;
 432 };
 433
 434 /*
 435  * Externalized form of struct socket used by the sysctl(3) interface.
 436  */
 437 struct  xsocket {
 438         u_int32_t               xso_len;        /* length of this structure */
 439         _XSOCKET_PTR(struct socket *) xso_so;   /* makes a convenient handle */
 440         short                   so_type;
 441         short                   so_options;
 442         short                   so_linger;
 443         short                   so_state;
 444         _XSOCKET_PTR(caddr_t)   so_pcb;         /* another convenient handle */
 445         int                     xso_protocol;
 446         int                     xso_family;
 447         short                   so_qlen;
 448         short                   so_incqlen;
 449         short                   so_qlimit;
 450         short                   so_timeo;
 451         u_short                 so_error;
 452         pid_t                   so_pgid;
 453         u_int32_t               so_oobmark;
 454         struct xsockbuf         so_rcv;
 455         struct xsockbuf         so_snd;
 456         uid_t                   so_uid;         /* XXX */
 457 };
 458
 459 #if !CONFIG_EMBEDDED
 460 struct  xsocket64 {
 461         u_int32_t               xso_len;        /* length of this structure */
 462         u_int64_t               xso_so;         /* makes a convenient handle */
 463         short                   so_type;
 464         short                   so_options;
 465         short                   so_linger;
 466         short                   so_state;
 467         u_int64_t               so_pcb;         /* another convenient handle */
 468         int                     xso_protocol;
 469         int                     xso_family;
 470         short                   so_qlen;
 471         short                   so_incqlen;
 472         short                   so_qlimit;
 473         short                   so_timeo;
 474         u_short                 so_error;
 475         pid_t                   so_pgid;
 476         u_int32_t               so_oobmark;
 477         struct xsockbuf         so_rcv;
 478         struct xsockbuf         so_snd;
 479         uid_t                   so_uid;         /* XXX */
 480 };
 481 #endif /* !CONFIG_EMBEDDED */
 482
 483 #ifdef PRIVATE
 484 #define XSO_SOCKET      0x001
 485 #define XSO_RCVBUF      0x002
 486 #define XSO_SNDBUF      0x004
 487 #define XSO_STATS       0x008
 488 #define XSO_INPCB       0x010
 489 #define XSO_TCPCB       0x020
 490 #define XSO_KCREG       0x040
 491 #define XSO_KCB         0x080
 492 #define XSO_EVT         0x100
 493
 494 struct  xsocket_n {
 495         u_int32_t               xso_len;        /* length of this structure */
 496         u_int32_t               xso_kind;       /* XSO_SOCKET */
 497         u_int64_t               xso_so;         /* makes a convenient handle */
 498         short                   so_type;
 499         u_int32_t               so_options;
 500         short                   so_linger;
 501         short                   so_state;
 502         u_int64_t               so_pcb;         /* another convenient handle */
 503         int                     xso_protocol;
 504         int                     xso_family;
 505         short                   so_qlen;
 506         short                   so_incqlen;
 507         short                   so_qlimit;
 508         short                   so_timeo;
 509         u_short                 so_error;
 510         pid_t                   so_pgid;
 511         u_int32_t               so_oobmark;
 512         uid_t                   so_uid;         /* XXX */
 513         pid_t                   so_last_pid;
 514         pid_t                   so_e_pid;
 515 };
 516
 517 struct xsockbuf_n {
 518         u_int32_t               xsb_len;        /* length of this structure */
 519         u_int32_t               xsb_kind;       /* XSO_RCVBUF or XSO_SNDBUF */
 520         u_int32_t               sb_cc;
 521         u_int32_t               sb_hiwat;
 522         u_int32_t               sb_mbcnt;
 523         u_int32_t               sb_mbmax;
 524         int32_t                 sb_lowat;
 525         short                   sb_flags;
 526         short                   sb_timeo;
 527 };
 528
 529 struct xsockstat_n {
 530         u_int32_t               xst_len;        /* length of this structure */
 531         u_int32_t               xst_kind;       /* XSO_STATS */
 532         struct data_stats       xst_tc_stats[SO_TC_STATS_MAX];
 533 };
 534
 535 /*
 536  * Global socket statistics
 537  */
 538 struct soextbkidlestat {
 539         u_int32_t       so_xbkidle_maxperproc;
 540         u_int32_t       so_xbkidle_time;
 541         u_int32_t       so_xbkidle_rcvhiwat;
 542         int32_t         so_xbkidle_notsupp;
 543         int32_t         so_xbkidle_toomany;
 544         int32_t         so_xbkidle_wantok;
 545         int32_t         so_xbkidle_active;
 546         int32_t         so_xbkidle_nocell;
 547         int32_t         so_xbkidle_notime;
 548         int32_t         so_xbkidle_forced;
 549         int32_t         so_xbkidle_resumed;
 550         int32_t         so_xbkidle_expired;
 551         int32_t         so_xbkidle_resched;
 552         int32_t         so_xbkidle_nodlgtd;
 553         int32_t         so_xbkidle_drained;
 554 };
 555 #endif /* PRIVATE */
 556
 557 #pragma pack()
 558
 559 #ifdef KERNEL_PRIVATE
 560 #include <sys/kpi_mbuf.h>
 561
 562 /*
 563  * Argument structure for sosetopt et seq.  This is in the KERNEL
 564  * section because it will never be visible to user code.
 565  */
 566 enum sopt_dir { SOPT_GET, SOPT_SET };
 567 struct sockopt {
 568         enum    sopt_dir sopt_dir; /* is this a get or a set? */
 569         int     sopt_level;     /* second arg of [gs]etsockopt */
 570         int     sopt_name;      /* third arg of [gs]etsockopt */
 571         user_addr_t sopt_val;   /* fourth arg of [gs]etsockopt */
 572         size_t  sopt_valsize;   /* (almost) fifth arg of [gs]etsockopt */
 573         struct  proc *sopt_p;   /* calling process or null if kernel */
 574 };
 575
 576 #ifdef MALLOC_DECLARE
 577 MALLOC_DECLARE(M_PCB);
 578 MALLOC_DECLARE(M_SONAME);
 579 #endif /* MALLOC_DECLARE */
 580
 581 #ifdef BSD_KERNEL_PRIVATE
 582 struct cmsghdr;
 583 extern boolean_t is_cmsg_valid(struct mbuf *control, struct cmsghdr *cmsg);
 584
 585 /*
 586  * Socket extension mechanism: control block hooks:
 587  * This is the "head" of any control block for an extenstion
 588  * Note: we separate intercept function dispatch vectors from
 589  *  the NFDescriptor to permit selective replacement during
 590  *  operation, e.g., to disable some functions.
 591  */
 592 struct kextcb {
 593         struct kextcb *e_next;          /* Next kext control block */
 594         void *e_fcb;                    /* Real filter control block */
 595         struct NFDescriptor *e_nfd;     /* NKE Descriptor */
 596         /* Plug-in support - intercept functions */
 597         struct sockif *e_soif;          /* Socket functions */
 598         struct sockutil *e_sout;        /* Sockbuf utility functions */
 599 };
 600 #define EXT_NULL        0x0             /* STATE: Not in use */
 601
 602 /* Hints for socket event processing */
 603 #define SO_FILT_HINT_LOCKED             0x00000001      /* socket is already locked */
 604 #define SO_FILT_HINT_CONNRESET          0x00000002      /* Reset is received */
 605 #define SO_FILT_HINT_CANTRCVMORE        0x00000004      /* No more data to read */
 606 #define SO_FILT_HINT_CANTSENDMORE       0x00000008      /* Can't write more data */
 607 #define SO_FILT_HINT_TIMEOUT            0x00000010      /* timeout */
 608 #define SO_FILT_HINT_NOSRCADDR          0x00000020      /* No src address available */
 609 #define SO_FILT_HINT_IFDENIED           0x00000040      /* interface denied access */
 610 #define SO_FILT_HINT_SUSPEND            0x00000080      /* output queue suspended */
 611 #define SO_FILT_HINT_RESUME             0x00000100      /* output queue resumed */
 612 #define SO_FILT_HINT_KEEPALIVE          0x00000200      /* TCP Keepalive received */
 613 #define SO_FILT_HINT_ADAPTIVE_WTIMO     0x00000400      /* TCP adaptive write timeout */
 614 #define SO_FILT_HINT_ADAPTIVE_RTIMO     0x00000800      /* TCP adaptive read timeout */
 615 #define SO_FILT_HINT_CONNECTED          0x00001000      /* socket is connected */
 616 #define SO_FILT_HINT_DISCONNECTED       0x00002000      /* socket is disconnected */
 617 #define SO_FILT_HINT_CONNINFO_UPDATED   0x00004000      /* updated conninfo avail. */
 618 #define SO_FILT_HINT_MPFAILOVER         0x00008000      /* multipath failover */
 619 #define SO_FILT_HINT_MPSTATUS           0x00010000      /* multipath status */
 620 #define SO_FILT_HINT_MUSTRST            0x00020000      /* must send RST and close */
 621 #define SO_FILT_HINT_MPCANTRCVMORE      0x00040000      /* MPTCP DFIN Received */
 622 #define SO_FILT_HINT_NOTIFY_ACK         0x00080000      /* Notify Acknowledgement */
 623 #define SO_FILT_HINT_MP_SUB_ERROR       0x00100000      /* Error happend on subflow */
 624
 625 #define SO_FILT_HINT_BITS \
 626         "\020\1LOCKED\2CONNRESET\3CANTRCVMORE\4CANTSENDMORE\5TIMEOUT"   \
 627         "\6NOSRCADDR\7IFDENIED\10SUSPEND\11RESUME\12KEEPALIVE\13AWTIMO" \
 628         "\14ARTIMO\15CONNECTED\16DISCONNECTED\17CONNINFO_UPDATED"       \
 629         "\20MPFAILOVER\21MPSTATUS\22MUSTRST\23MPCANTRCVMORE\24NOTIFYACK"\
 630         "\25MPSUBERROR"
 631
 632 /* Mask for hints that have corresponding kqueue events */
 633 #define SO_FILT_HINT_EV                                                 \
 634         (SO_FILT_HINT_CONNRESET | SO_FILT_HINT_CANTRCVMORE |            \
 635         SO_FILT_HINT_CANTSENDMORE | SO_FILT_HINT_TIMEOUT |              \
 636         SO_FILT_HINT_NOSRCADDR | SO_FILT_HINT_IFDENIED |                \
 637         SO_FILT_HINT_SUSPEND | SO_FILT_HINT_RESUME |                    \
 638         SO_FILT_HINT_KEEPALIVE | SO_FILT_HINT_ADAPTIVE_WTIMO |          \
 639         SO_FILT_HINT_ADAPTIVE_RTIMO | SO_FILT_HINT_CONNECTED |          \
 640         SO_FILT_HINT_DISCONNECTED | SO_FILT_HINT_CONNINFO_UPDATED |     \
 641         SO_FILT_HINT_NOTIFY_ACK)
 642
 643 #if SENDFILE
 644 struct sf_buf {
 645         SLIST_ENTRY(sf_buf) free_list;  /* list of free buffer slots */
 646         int             refcnt;         /* reference count */
 647         struct          vm_page *m;     /* currently mapped page */
 648         vm_offset_t     kva;            /* va of mapping */
 649 };
 650 #endif /* SENDFILE */
 651
 652 #define SBLASTRECORDCHK(sb, s)                                          \
 653         if (socket_debug) sblastrecordchk(sb, s);
 654
 655 #define SBLASTMBUFCHK(sb, s)                                            \
 656         if (socket_debug) sblastmbufchk(sb, s);
 657
 658 #define SB_EMPTY_FIXUP(sb) {                                            \
 659         if ((sb)->sb_mb == NULL) {                                      \
 660                 (sb)->sb_mbtail = NULL;                                 \
 661                 (sb)->sb_lastrecord = NULL;                             \
 662         }                                                               \
 663 }
 664
 665 #define SB_MB_CHECK(sb) do {                                            \
 666         if (((sb)->sb_mb != NULL &&                                     \
 667             (sb)->sb_cc == 0) ||                                        \
 668             ((sb)->sb_mb == NULL && (sb)->sb_cc > 0))                   \
 669                 panic("corrupt so_rcv: sb_mb %p sb_cc %d\n",            \
 670                     (sb)->sb_mb, (sb)->sb_cc);                          \
 671 } while (0)
 672
 673 #define SODEFUNCTLOG(fmt, ...)  do {            \
 674         if (sodefunctlog)                       \
 675                 printf(fmt, __VA_ARGS__);       \
 676 } while (0)
 677
 678 #define SOTHROTTLELOG(fmt, ...) do {            \
 679         if (sothrottlelog)                      \
 680                 printf(fmt, __VA_ARGS__);       \
 681 } while (0)
 682
 683 /*
 684  * For debugging traffic class behaviors
 685  */
 686 #define SOTCDB_RESERVED         0x01
 687 #define SOTCDB_NO_MTC           0x02    /* Do not set the mbuf traffic class */
 688 #define SOTCDB_NO_SENDTCPBG     0x04    /* Do not use background TCP CC algorithm for sender */
 689 #define SOTCDB_NO_LCLTST        0x08    /* Do not test for local destination for setting DSCP */
 690 #define SOTCDB_NO_DSCPTST       0x10    /* Overwritte any existing DSCP code */
 691 #define SOTCDB_NO_RECVTCPBG     0x20    /* Do not use throttling on receiver-side of TCP */
 692 #define SOTCDB_NO_PRIVILEGED    0x40    /* Do not set privileged traffic flag */
 693
 694 #define SOCK_DOM(so)                    ((so)->so_proto->pr_domain->dom_family)
 695 #define SOCK_TYPE(so)                   ((so)->so_proto->pr_type)
 696 #define SOCK_PROTO(so)                  ((so)->so_proto->pr_protocol)
 697
 698 #define SOCK_CHECK_DOM(so, dom)         (SOCK_DOM(so) == (dom))
 699 #define SOCK_CHECK_TYPE(so, type)       (SOCK_TYPE(so) == (type))
 700 #define SOCK_CHECK_PROTO(so, proto)     (SOCK_PROTO(so) == (proto))
 701
 702 /*
 703  * Socket process information
 704  */
 705 struct so_procinfo {
 706         pid_t           spi_pid;
 707         pid_t           spi_epid;
 708         uuid_t          spi_uuid;
 709         uuid_t          spi_euuid;
 710         int             spi_delegated;
 711         char            spi_proc_name[MAXCOMLEN + 1];
 712         char            spi_e_proc_name[MAXCOMLEN + 1];
 713 };
 714
 715 extern u_int32_t sb_max;
 716 extern so_gen_t so_gencnt;
 717 extern int socket_debug;
 718 extern int sosendjcl;
 719 extern int sosendjcl_ignore_capab;
 720 extern int sodefunctlog;
 721 extern int sothrottlelog;
 722 extern int sorestrictrecv;
 723 extern int sorestrictsend;
 724 extern int somaxconn;
 725 extern uint32_t tcp_do_autosendbuf;
 726 extern uint32_t tcp_autosndbuf_max;
 727 extern uint32_t tcp_autosndbuf_inc;
 728 extern u_int32_t sotcdb;
 729 extern u_int32_t net_io_policy_log;
 730 extern u_int32_t net_io_policy_throttle_best_effort;
 731 #if CONFIG_PROC_UUID_POLICY
 732 extern u_int32_t net_io_policy_uuid;
 733 #endif /* CONFIG_PROC_UUID_POLICY */
 734
 735 extern struct soextbkidlestat soextbkidlestat;
 736
 737 #endif /* BSD_KERNEL_PRIVATE */
 738
 739 struct mbuf;
 740 struct sockaddr;
 741 struct ucred;
 742 struct uio;
 743
 744 #define SOCK_MSG_SA 0x01
 745 #define SOCK_MSG_CONTROL 0x02
 746 #define SOCK_MSG_DATA 0x04
 747
 748 struct recv_msg_elem {
 749         struct uio *uio;
 750         struct sockaddr *psa;
 751         struct mbuf *controlp;
 752         int which;
 753         int flags;
 754 };
 755
 756 /*
 757  * From uipc_socket and friends
 758  */
 759 __BEGIN_DECLS
 760 /* Exported */
 761 extern int sbappendaddr(struct sockbuf *sb, struct sockaddr *asa,
 762     struct mbuf *m0, struct mbuf *control, int *error_out);
 763 extern int sbappendchain(struct sockbuf *sb, struct mbuf *m, int space);
 764 extern int sbappendrecord(struct sockbuf *sb, struct mbuf *m0);
 765 extern void sbflush(struct sockbuf *sb);
 766 extern int sbspace(struct sockbuf *sb);
 767 extern int soabort(struct socket *so);
 768 extern void socantrcvmore(struct socket *so);
 769 extern void socantsendmore(struct socket *so);
 770 extern int sodisconnect(struct socket *so);
 771 extern void sofree(struct socket *so);
 772 extern void sofreelastref(struct socket *, int);
 773 extern void soisconnected(struct socket *so);
 774 extern boolean_t socanwrite(struct socket *so);
 775 extern void soisconnecting(struct socket *so);
 776 extern void soisdisconnected(struct socket *so);
 777 extern void soisdisconnecting(struct socket *so);
 778 extern struct socket *sonewconn(struct socket *head, int connstatus,
 779     const struct sockaddr *from);
 780 extern int sopoll(struct socket *so, int events, struct ucred *cred, void *wql);
 781 extern int sooptcopyin(struct sockopt *sopt, void *data, size_t len,
 782     size_t minlen)
 783 __attribute__ ((warn_unused_result));
 784 extern int sooptcopyout(struct sockopt *sopt, void *data, size_t len)
 785 __attribute__ ((warn_unused_result));
 786 extern int soopt_cred_check(struct socket *so, int priv, boolean_t allow_root,
 787     boolean_t ignore_delegate);
 788 extern int soreceive(struct socket *so, struct sockaddr **paddr,
 789     struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, int *flagsp);
 790 extern int soreserve(struct socket *so, u_int32_t sndcc, u_int32_t rcvcc);
 791 extern void soreserve_preconnect(struct socket *so, unsigned int pre_cc);
 792 extern void sorwakeup(struct socket *so);
 793 extern int sosend(struct socket *so, struct sockaddr *addr, struct uio *uio,
 794     struct mbuf *top, struct mbuf *control, int flags);
 795 extern int sosend_reinject(struct socket *so, struct sockaddr *addr, struct mbuf *top,
 796     struct mbuf *control, uint32_t sendflags);
 797 extern int sosend_list(struct socket *so, struct uio **uio, u_int uiocnt,
 798     int flags);
 799 extern int soreceive_list(struct socket *so, struct recv_msg_elem *msgarray,
 800     u_int msgcnt, int *flags);
 801 extern void sonullevent(struct socket *so, void *arg, uint32_t hint);
 802 extern struct mbuf *sbconcat_mbufs(struct sockbuf *sb, struct sockaddr *asa, struct mbuf *m0,
 803     struct mbuf *control);
 804
 805
 806 __END_DECLS
 807
 808 #ifdef BSD_KERNEL_PRIVATE
 809 struct file;
 810 struct filedesc;
 811 struct so_tcdbg;
 812
 813 __BEGIN_DECLS
 814 /* Not exported */
 815 extern void socketinit(void);
 816 extern struct sockaddr *dup_sockaddr(struct sockaddr *sa, int canwait);
 817 extern int getsock(struct filedesc *fdp, int fd, struct file **fpp);
 818 extern int sockargs(struct mbuf **mp, user_addr_t data, int buflen, int type);
 819 extern void get_sockev_state(struct socket *, u_int32_t *);
 820 extern void so_update_last_owner_locked(struct socket *, struct proc *);
 821 extern void so_update_policy(struct socket *);
 822 extern void so_acquire_accept_list(struct socket *, struct socket *);
 823 extern void so_release_accept_list(struct socket *);
 824
 825 extern int sbappend(struct sockbuf *sb, struct mbuf *m);
 826 extern int sbappendstream(struct sockbuf *sb, struct mbuf *m);
 827 extern int sbappendcontrol(struct sockbuf *sb, struct mbuf *m0,
 828     struct mbuf *control, int *error_out);
 829 extern int sbappendmsgstream_rcv(struct sockbuf *sb, struct mbuf *m,
 830     uint32_t seqnum, int flags);
 831 extern int sbappendstream_rcvdemux(struct socket *so, struct mbuf *m,
 832     uint32_t seqnum, int flags);
 833 #if MPTCP
 834 extern int sbappendmptcpstream_rcv(struct sockbuf *sb, struct mbuf *m);
 835 #endif /* MPTCP */
 836 extern int sbappendmsg_snd(struct sockbuf *sb, struct mbuf *m);
 837 extern void sbpull_unordered_data(struct socket *, int32_t, int32_t);
 838 extern void sbcheck(struct sockbuf *sb);
 839 extern void sblastmbufchk(struct sockbuf *, const char *);
 840 extern void sblastrecordchk(struct sockbuf *, const char *);
 841 extern struct mbuf *sbcreatecontrol(caddr_t p, int size, int type, int level);
 842 extern struct mbuf **sbcreatecontrol_mbuf(caddr_t p, int size, int type,
 843     int level, struct mbuf **m);
 844 extern void sbdrop(struct sockbuf *sb, int len);
 845 extern void sbdroprecord(struct sockbuf *sb);
 846 extern void sbrelease(struct sockbuf *sb);
 847 extern int sbreserve(struct sockbuf *sb, u_int32_t cc);
 848 extern void sbtoxsockbuf(struct sockbuf *sb, struct xsockbuf *xsb);
 849 extern int sbwait(struct sockbuf *sb);
 850 extern void sbwakeup(struct sockbuf *sb);
 851 extern void sb_empty_assert(struct sockbuf *, const char *);
 852 extern int sb_notify(struct sockbuf *sb);
 853 extern void sballoc(struct sockbuf *sb, struct mbuf *m);
 854 extern void sbfree(struct sockbuf *sb, struct mbuf *m);
 855 extern void sbfree_chunk(struct sockbuf *sb, struct mbuf *m);
 856
 857 /*
 858  * Flags to sblock().
 859  */
 860 #define SBL_WAIT        0x00000001      /* Wait if not immediately available. */
 861 #define SBL_NOINTR      0x00000002      /* Force non-interruptible sleep. */
 862 #define SBL_IGNDEFUNCT  0x00000004      /* Ignore defunct'd state */
 863 #define SBL_VALID       (SBL_WAIT | SBL_NOINTR | SBL_IGNDEFUNCT)
 864 extern int sblock(struct sockbuf *sb, uint32_t flags);
 865 extern void sbunlock(struct sockbuf *sb, boolean_t keeplocked);
 866
 867 extern int soaccept(struct socket *so, struct sockaddr **nam);
 868 extern int soacceptlock(struct socket *so, struct sockaddr **nam, int dolock);
 869 extern int soacceptfilter(struct socket *so, struct socket *head);
 870 extern struct socket *soalloc(int waitok, int dom, int type);
 871 extern int sobindlock(struct socket *so, struct sockaddr *nam, int dolock);
 872 extern int soclose(struct socket *so);
 873 extern int soclose_locked(struct socket *so);
 874 extern void soclose_wait_locked(struct socket *so);
 875 extern int soconnect(struct socket *so, struct sockaddr *nam);
 876 extern int soconnectlock(struct socket *so, struct sockaddr *nam, int dolock);
 877 extern int soconnect2(struct socket *so1, struct socket *so2);
 878 extern int soconnectxlocked(struct socket *so, struct sockaddr *src,
 879     struct sockaddr *dst, struct proc *, uint32_t, sae_associd_t,
 880     sae_connid_t *, uint32_t, void *, u_int32_t, uio_t, user_ssize_t *);
 881 extern int sodisconnectx(struct socket *so, sae_associd_t, sae_connid_t);
 882 extern int sodisconnectxlocked(struct socket *so, sae_associd_t, sae_connid_t);
 883 extern void soevupcall(struct socket *, u_int32_t);
 884 /* flags for socreate_internal */
 885 #define SOCF_MPTCP      0x1     /* MPTCP-subflow */
 886 extern int socreate_internal(int dom, struct socket **aso, int type, int proto,
 887     struct proc *, uint32_t, struct proc *);
 888 extern int socreate(int dom, struct socket **aso, int type, int proto);
 889 extern int socreate_delegate(int dom, struct socket **aso, int type, int proto,
 890     pid_t epid);
 891 extern void sodealloc(struct socket *so);
 892 extern int sodisconnectlocked(struct socket *so);
 893 extern void soreference(struct socket *so);
 894 extern void sodereference(struct socket *so);
 895 extern void somultipages(struct socket *, boolean_t);
 896 extern void soif2kcl(struct socket *, boolean_t);
 897 extern int sosetdefunct(struct proc *, struct socket *, int level, boolean_t);
 898 extern int sodefunct(struct proc *, struct socket *, int level);
 899 extern int soresume(struct proc *, struct socket *, int);
 900 extern void resume_proc_sockets(proc_t);
 901 extern int so_check_extended_bk_idle_time(struct socket *);
 902 extern void so_drain_extended_bk_idle(struct socket *);
 903 extern void sohasoutofband(struct socket *so);
 904 extern void sodisconnectwakeup(struct socket *so);
 905 extern int soisthrottled(struct socket *so);
 906 extern int soisprivilegedtraffic(struct socket *so);
 907 extern int soissrcbackground(struct socket *so);
 908 extern int soissrcrealtime(struct socket *so);
 909 extern int soissrcbesteffort(struct socket *so);
 910 extern void soclearfastopen(struct socket *so);
 911 extern int solisten(struct socket *so, int backlog);
 912 extern struct socket *sodropablereq(struct socket *head);
 913 extern lck_mtx_t *socket_getlock(struct socket *so, int flags);
 914 extern void socket_lock(struct socket *so, int refcount);
 915 extern void socket_lock_assert_owned(struct socket *so);
 916 extern int socket_try_lock(struct socket *so);
 917 extern void socket_unlock(struct socket *so, int refcount);
 918 extern int sogetaddr_locked(struct socket *, struct sockaddr **, int);
 919 extern const char *solockhistory_nr(struct socket *);
 920 extern void soevent(struct socket *so, long hint);
 921 extern void sorflush(struct socket *so);
 922 extern void sowflush(struct socket *so);
 923 extern void sowakeup(struct socket *so, struct sockbuf *sb, struct socket *so2);
 924 extern int soioctl(struct socket *so, u_long cmd, caddr_t data, struct proc *p);
 925 extern int sogetoptlock(struct socket *so, struct sockopt *sopt, int);
 926 extern int sosetoptlock(struct socket *so, struct sockopt *sopt, int);
 927 extern int soshutdown(struct socket *so, int how);
 928 extern int soshutdownlock(struct socket *so, int how);
 929 extern int soshutdownlock_final(struct socket *so, int how);
 930 extern void sotoxsocket(struct socket *so, struct xsocket *xso);
 931 #if !CONFIG_EMBEDDED
 932 extern void sotoxsocket64(struct socket *so, struct xsocket64 *xso);
 933 #endif /* !CONFIG_EMBEDDED */
 934 extern int sosendallatonce(struct socket *so);
 935 extern int soreadable(struct socket *so);
 936 extern int sowriteable(struct socket *so);
 937 extern void sowwakeup(struct socket *so);
 938 extern int sosendcheck(struct socket *, struct sockaddr *, user_ssize_t,
 939     int32_t, int32_t, int, int *, struct mbuf *);
 940
 941 extern int soo_ioctl(struct fileproc *, u_long, caddr_t, vfs_context_t);
 942 extern int soo_stat(struct socket *, void *, int);
 943 extern int soo_select(struct fileproc *, int, void *, vfs_context_t);
 944 extern int soo_kqfilter(struct fileproc *, struct knote *, struct kevent_qos_s *);
 945
 946 /* Service class flags used for setting service class on a packet */
 947 #define PKT_SCF_IPV6            0x00000001      /* IPv6 packet */
 948 #define PKT_SCF_TCP_ACK         0x00000002      /* Pure TCP ACK */
 949 #define PKT_SCF_TCP_SYN         0x00000004      /* TCP SYN */
 950
 951 /*
 952  * Flags for connectx(2) user-protocol request routine.
 953  */
 954
 955 #define CONNREQF_MPTCP  0x1     /* called internally by MPTCP */
 956 #define CONNREQF_UIO    0x2     /* there's data */
 957 #define CONNREQF_IDEM   0x4     /* data is idempotent */
 958
 959 extern void set_packet_service_class(struct mbuf *, struct socket *,
 960     mbuf_svc_class_t, u_int32_t);
 961 extern void so_tc_update_stats(struct mbuf *, struct socket *,
 962     mbuf_svc_class_t);
 963 extern int so_tos_from_control(struct mbuf *);
 964 extern int so_tc_from_control(struct mbuf *, int *);
 965 extern mbuf_svc_class_t so_tc2msc(int);
 966 extern int so_svc2tc(mbuf_svc_class_t);
 967
 968 extern u_int8_t tcp_cansbgrow(struct sockbuf *sb);
 969 extern int tcp_get_msg_priority(struct mbuf *, uint32_t *);
 970 extern void set_tcp_stream_priority(struct socket *so);
 971
 972 extern int so_set_net_service_type(struct socket *, int);
 973 extern int so_set_traffic_class(struct socket *, int);
 974 extern void so_set_default_traffic_class(struct socket *);
 975 extern int so_set_opportunistic(struct socket *, int);
 976 extern int so_get_opportunistic(struct socket *);
 977 extern int so_set_recv_anyif(struct socket *, int);
 978 extern int so_get_recv_anyif(struct socket *);
 979 extern int so_set_effective_pid(struct socket *so, int epid, struct proc *p, boolean_t check_cred);
 980 extern int so_set_effective_uuid(struct socket *so, uuid_t euuid, struct proc *p, boolean_t check_cred);
 981 extern int so_set_restrictions(struct socket *, uint32_t);
 982 extern uint32_t so_get_restrictions(struct socket *);
 983 extern void socket_tclass_init(void);
 984 #if (DEVELOPMENT || DEBUG)
 985 extern int so_set_tcdbg(struct socket *, struct so_tcdbg *);
 986 extern int sogetopt_tcdbg(struct socket *, struct sockopt *);
 987 #endif /* (DEVELOPMENT || DEBUG) */
 988 extern void so_set_lro(struct socket *, int);
 989
 990 extern int so_isdstlocal(struct socket *);
 991 extern void so_recv_data_stat(struct socket *, struct mbuf *, size_t);
 992 extern void so_inc_recv_data_stat(struct socket *, size_t, size_t, uint32_t);
 993 extern int so_wait_for_if_feedback(struct socket *);
 994 extern int msgq_sbspace(struct socket *so, struct mbuf *control);
 995 extern int soopt_getm(struct sockopt *sopt, struct mbuf **mp);
 996 extern int soopt_mcopyin(struct sockopt *sopt, struct mbuf *m);
 997 extern int soopt_mcopyout(struct sockopt *sopt, struct mbuf *m);
 998 extern boolean_t so_cache_timer(void);
 999
1000 extern void mptcp_fallback_sbdrop(struct socket *so, struct mbuf *m, int len);
1001 extern void mptcp_preproc_sbdrop(struct socket *, struct mbuf *, unsigned int);
1002 extern void mptcp_postproc_sbdrop(struct mbuf *, u_int64_t, u_int32_t,
1003     u_int32_t);
1004
1005 extern void netpolicy_post_msg(uint32_t, struct netpolicy_event_data *,
1006     uint32_t);
1007 /*
1008  * Socket operation routines.
1009  * These routines are called by the routines in
1010  * sys_socket.c or from a system process, and
1011  * implement the semantics of socket operations by
1012  * switching out to the protocol specific routines.
1013  */
1014 extern void postevent(struct socket *, struct sockbuf *, int);
1015 extern void evsofree(struct socket *);
1016
1017 extern int tcp_notsent_lowat_check(struct socket *so);
1018
1019 extern user_ssize_t uio_array_resid(struct uio **, u_int);
1020 extern user_ssize_t recv_msg_array_resid(struct recv_msg_elem *, u_int);
1021
1022 void sotoxsocket_n(struct socket *, struct xsocket_n *);
1023 void sbtoxsockbuf_n(struct sockbuf *, struct xsockbuf_n *);
1024 void sbtoxsockstat_n(struct socket *, struct xsockstat_n *);
1025
1026 __END_DECLS
1027 #endif /* BSD_KERNEL_PRIVATE */
1028 #endif /* KERNEL_PRIVATE */
1029 #endif /* !_SYS_SOCKETVAR_H_ */