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