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