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