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