bsd/sys/socketvar.h

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