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