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