bsd/sys/socketvar.h

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