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