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