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