bsd/sys/socketvar.h

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