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