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