1/*
2 * Copyright (c) 2000-2018 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, 1985, 1986, 1988, 1993, 1994
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 * @(#)socket.h 8.4 (Berkeley) 2/21/94
63 * $FreeBSD: src/sys/sys/socket.h,v 1.39.2.7 2001/07/03 11:02:01 ume 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_SOCKET_H_
73#define _SYS_SOCKET_H_
74
75#include <sys/types.h>
76#include <sys/cdefs.h>
77#include <machine/_param.h>
78#include <net/net_kev.h>
79
80#ifdef PRIVATE
81#include <sys/param.h>
82#include <uuid/uuid.h>
83#endif /* PRIVATE */
84
85#ifndef KERNEL
86#include <Availability.h>
87#endif
88
89/*
90 * Definitions related to sockets: types, address families, options.
91 */
92
93/*
94 * Data types.
95 */
96
97#include <sys/_types/_gid_t.h>
98#include <sys/_types/_off_t.h>
99#include <sys/_types/_pid_t.h>
100#include <sys/_types/_sa_family_t.h>
101#include <sys/_types/_socklen_t.h>
102
103/* XXX Not explicitly defined by POSIX, but function return types are */
104#include <sys/_types/_size_t.h>
105
106/* XXX Not explicitly defined by POSIX, but function return types are */
107#include <sys/_types/_ssize_t.h>
108
109/*
110 * [XSI] The iovec structure shall be defined as described in <sys/uio.h>.
111 */
112#include <sys/_types/_iovec_t.h>
113
114/*
115 * Types
116 */
117#define SOCK_STREAM 1 /* stream socket */
118#define SOCK_DGRAM 2 /* datagram socket */
119#define SOCK_RAW 3 /* raw-protocol interface */
120#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
121#define SOCK_RDM 4 /* reliably-delivered message */
122#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
123#define SOCK_SEQPACKET 5 /* sequenced packet stream */
124
125/*
126 * Option flags per-socket.
127 */
128#define SO_DEBUG 0x0001 /* turn on debugging info recording */
129#define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
130#define SO_REUSEADDR 0x0004 /* allow local address reuse */
131#define SO_KEEPALIVE 0x0008 /* keep connections alive */
132#define SO_DONTROUTE 0x0010 /* just use interface addresses */
133#define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
134#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
135#define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
136#define SO_LINGER 0x0080 /* linger on close if data present (in ticks) */
137#else
138#define SO_LINGER 0x1080 /* linger on close if data present (in seconds) */
139#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
140#define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
141#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
142#define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
143#define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
144#define SO_TIMESTAMP_MONOTONIC 0x0800 /* Monotonically increasing timestamp on rcvd dgram */
145#ifndef __APPLE__
146#define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */
147#else
148#define SO_DONTTRUNC 0x2000 /* APPLE: Retain unread data */
149 /* (ATOMIC proto) */
150#define SO_WANTMORE 0x4000 /* APPLE: Give hint when more data ready */
151#define SO_WANTOOBFLAG 0x8000 /* APPLE: Want OOB in MSG_FLAG on receive */
152
153#ifdef PRIVATE
154#define SO_NOWAKEFROMSLEEP 0x10000 /* Don't wake for traffic to this socket */
155#define SO_NOAPNFALLBK 0x20000 /* Don't attempt APN fallback for the socket */
156#define SO_TIMESTAMP_CONTINUOUS 0x40000 /* Continuous monotonic timestamp on rcvd dgram */
157#endif
158
159#endif /* (!__APPLE__) */
160#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
161
162/*
163 * Additional options, not kept in so_options.
164 */
165#define SO_SNDBUF 0x1001 /* send buffer size */
166#define SO_RCVBUF 0x1002 /* receive buffer size */
167#define SO_SNDLOWAT 0x1003 /* send low-water mark */
168#define SO_RCVLOWAT 0x1004 /* receive low-water mark */
169#define SO_SNDTIMEO 0x1005 /* send timeout */
170#define SO_RCVTIMEO 0x1006 /* receive timeout */
171#define SO_ERROR 0x1007 /* get error status and clear */
172#define SO_TYPE 0x1008 /* get socket type */
173#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
174#define SO_LABEL 0x1010 /* socket's MAC label */
175#define SO_PEERLABEL 0x1011 /* socket's peer MAC label */
176#ifdef __APPLE__
177#define SO_NREAD 0x1020 /* APPLE: get 1st-packet byte count */
178#define SO_NKE 0x1021 /* APPLE: Install socket-level NKE */
179#define SO_NOSIGPIPE 0x1022 /* APPLE: No SIGPIPE on EPIPE */
180#define SO_NOADDRERR 0x1023 /* APPLE: Returns EADDRNOTAVAIL when src is not available anymore */
181#define SO_NWRITE 0x1024 /* APPLE: Get number of bytes currently in send socket buffer */
182#define SO_REUSESHAREUID 0x1025 /* APPLE: Allow reuse of port/socket by different userids */
183#ifdef __APPLE_API_PRIVATE
184#define SO_NOTIFYCONFLICT 0x1026 /* APPLE: send notification if there is a bind on a port which is already in use */
185#define SO_UPCALLCLOSEWAIT 0x1027 /* APPLE: block on close until an upcall returns */
186#endif
187#define SO_LINGER_SEC 0x1080 /* linger on close if data present (in seconds) */
188#ifdef PRIVATE
189#define SO_RESTRICTIONS 0x1081 /* APPLE: deny flag set */
190#define SO_RESTRICT_DENY_IN 0x1 /* deny inbound (trapdoor) */
191#define SO_RESTRICT_DENY_OUT 0x2 /* deny outbound (trapdoor) */
192#define SO_RESTRICT_DENY_CELLULAR 0x4 /* deny use of cellular (trapdoor) */
193#define SO_RESTRICT_DENY_EXPENSIVE 0x8 /* deny use of expensive if (trapdoor) */
194#endif /* PRIVATE */
195#define SO_RANDOMPORT 0x1082 /* APPLE: request local port randomization */
196#define SO_NP_EXTENSIONS 0x1083 /* To turn off some POSIX behavior */
197#endif
198
199#ifdef PRIVATE
200#define SO_EXECPATH 0x1085 /* Application Firewall Socket option */
201
202/*
203 * Traffic service class definitions (lowest to highest):
204 *
205 * SO_TC_BK_SYS
206 * "Background System-Initiated", high delay tolerant, high loss
207 * tolerant, elastic flow, variable size & long-lived. E.g: system-
208 * initiated iCloud synching or Time Capsule backup, for which there
209 * is no progress feedbacks.
210 *
211 * SO_TC_BK
212 * "Background", user-initiated, high delay tolerant, high loss tolerant,
213 * elastic flow, variable size. E.g. user-initiated iCloud synching or
214 * Time Capsule backup; or traffics of background applications, for which
215 * there is some progress feedbacks.
216 *
217 * SO_TC_BE
218 * "Best Effort", unclassified/standard. This is the default service
219 * class; pretty much a mix of everything.
220 *
221 * SO_TC_RD
222 * "Responsive Data", a notch higher than "Best Effort", medium delay
223 * tolerant, elastic & inelastic flow, bursty, long-lived. E.g. email,
224 * instant messaging, for which there is a sense of interactivity and
225 * urgency (user waiting for output).
226 *
227 * SO_TC_OAM
228 * "Operations, Administration, and Management", medium delay tolerant,
229 * low-medium loss tolerant, elastic & inelastic flows, variable size.
230 * E.g. VPN tunnels.
231 *
232 * SO_TC_AV
233 * "Multimedia Audio/Video Streaming", medium delay tolerant, low-medium
234 * loss tolerant, elastic flow, constant packet interval, variable rate &
235 * size. E.g. AirPlay playback (both video and audio).
236 *
237 * SO_TC_RV
238 * "Responsive Multimedia Audio/Video", low delay tolerant, low-medium
239 * loss tolerant, elastic flow, variable packet interval, rate and size.
240 * E.g. AirPlay mirroring, screen sharing.
241 *
242 * SO_TC_VI
243 * "Interactive Video", low delay tolerant, low-medium loss tolerant,
244 * elastic flow, constant packet interval, variable rate & size. E.g.
245 * FaceTime video.
246 *
247 * SO_TC_VO
248 * "Interactive Voice", low delay tolerant, low loss tolerant, inelastic
249 * flow, constant packet rate, somewhat fixed size. E.g. VoIP including
250 * FaceTime audio.
251 *
252 * SO_TC_CTL
253 * "Network Control", low delay tolerant, low loss tolerant, inelastic
254 * flow, rate is bursty but short, variable size. E.g. DNS queries;
255 * certain types of locally-originated ICMP, ICMPv6; IGMP/MLD join/leave,
256 * ARP.
257 */
258#define SO_TRAFFIC_CLASS 0x1086 /* Traffic service class (int) */
259#define SO_TC_BK_SYS 100 /* lowest class */
260#define SO_TC_BK 200
261#define SO_TC_BE 0
262#define SO_TC_RD 300
263#define SO_TC_OAM 400
264#define SO_TC_AV 500
265#define SO_TC_RV 600
266#define SO_TC_VI 700
267#define SO_TC_VO 800
268#define SO_TC_CTL 900 /* highest class */
269#define SO_TC_MAX 10 /* Total # of traffic classes */
270#ifdef XNU_KERNEL_PRIVATE
271#define _SO_TC_BK 1 /* deprecated */
272#define _SO_TC_VI 2 /* deprecated */
273#define _SO_TC_VO 3 /* deprecated */
274#define _SO_TC_MAX 4 /* deprecated */
275
276#define SO_VALID_TC(c) \
277 (c == SO_TC_BK_SYS || c == SO_TC_BK || c == SO_TC_BE || \
278 c == SO_TC_RD || c == SO_TC_OAM || c == SO_TC_AV || \
279 c == SO_TC_RV || c == SO_TC_VI || c == SO_TC_VO || \
280 c == SO_TC_CTL || c == SO_TC_NETSVC_SIG)
281
282#define SO_TC_UNSPEC ((int)-1) /* Traffic class not specified */
283
284#define SO_TC_SIG SO_TC_VI /* to be removed XXX */
285
286#define SOTCIX_BK_SYS 0
287#define SOTCIX_BK 1
288#define SOTCIX_BE 2
289#define SOTCIX_RD 3
290#define SOTCIX_OAM 4
291#define SOTCIX_AV 5
292#define SOTCIX_RV 6
293#define SOTCIX_VI 7
294#define SOTCIX_VO 8
295#define SOTCIX_CTL 9
296#endif /* XNU_KERNEL_PRIVATE */
297
298/* Background socket configuration flags */
299#define TRAFFIC_MGT_SO_BACKGROUND 0x0001 /* background socket */
300#define TRAFFIC_MGT_TCP_RECVBG 0x0002 /* Only TCP sockets, receiver throttling */
301
302#define SO_RECV_TRAFFIC_CLASS 0x1087 /* Receive traffic class (bool) */
303#define SO_TRAFFIC_CLASS_DBG 0x1088 /* Debug traffic class (struct so_tcdbg) */
304#define SO_TRAFFIC_CLASS_STATS 0x1089 /* Traffic class statistics */
305#define SO_PRIVILEGED_TRAFFIC_CLASS 0x1090 /* Privileged traffic class (bool) */
306#define SO_DEFUNCTIT 0x1091 /* Defunct a socket (only in internal builds) */
307#define SO_DEFUNCTOK 0x1100 /* can be defunct'd */
308#define SO_ISDEFUNCT 0x1101 /* get defunct status */
309
310#define SO_OPPORTUNISTIC 0x1102 /* deprecated; use SO_TRAFFIC_CLASS */
311
312/*
313 * SO_FLUSH flushes any unsent data generated by a given socket. It takes
314 * an integer parameter, which can be any of the SO_TC traffic class values,
315 * or the special SO_TC_ALL value.
316 */
317#define SO_FLUSH 0x1103 /* flush unsent data (int) */
318#define SO_TC_ALL (-1)
319
320#define SO_RECV_ANYIF 0x1104 /* unrestricted inbound processing */
321#define SO_TRAFFIC_MGT_BACKGROUND 0x1105 /* Background traffic management */
322
323#define SO_FLOW_DIVERT_TOKEN 0x1106 /* flow divert token */
324
325#define SO_DELEGATED 0x1107 /* set socket as delegate (pid_t) */
326#define SO_DELEGATED_UUID 0x1108 /* set socket as delegate (uuid_t) */
327#define SO_NECP_ATTRIBUTES 0x1109 /* NECP socket attributes (domain, account, etc.) */
328#define SO_CFIL_SOCK_ID 0x1110 /* get content filter socket ID (cfil_sock_id_t) */
329#define SO_NECP_CLIENTUUID 0x1111 /* NECP Client uuid */
330#endif /* PRIVATE */
331#define SO_NUMRCVPKT 0x1112 /* number of datagrams in receive socket buffer */
332#ifdef PRIVATE
333#define SO_AWDL_UNRESTRICTED 0x1113 /* try to use AWDL in restricted mode */
334#define SO_EXTENDED_BK_IDLE 0x1114 /* extended time to keep socket idle after app is suspended (int) */
335#define SO_MARK_CELLFALLBACK 0x1115 /* Mark as initiated by cell fallback */
336#endif /* PRIVATE */
337
338/*
339 * Network Service Type for option SO_NET_SERVICE_TYPE
340 *
341 * The vast majority of sockets should use Best Effort that is the default
342 * Network Service Type. Other Network Service Types have to be used only if
343 * the traffic actually matches the description of the Network Service Type.
344 *
345 * Network Service Types do not represent priorities but rather describe
346 * different categories of delay, jitter and loss parameters.
347 * Those parameters may influence protocols from layer 4 protocols like TCP
348 * to layer 2 protocols like Wi-Fi. The Network Service Type can determine
349 * how the traffic is queued and scheduled by the host networking stack and
350 * by other entities on the network like switches and routers. For example
351 * for Wi-Fi, the Network Service Type can select the marking of the
352 * layer 2 packet with the appropriate WMM Access Category.
353 *
354 * There is no point in attempting to game the system and use
355 * a Network Service Type that does not correspond to the actual
356 * traffic characteristic but one that seems to have a higher precedence.
357 * The reason is that for service classes that have lower tolerance
358 * for delay and jitter, the queues size is lower than for service
359 * classes that are more tolerant to delay and jitter.
360 *
361 * For example using a voice service type for bulk data transfer will lead
362 * to disastrous results as soon as congestion happens because the voice
363 * queue overflows and packets get dropped. This is not only bad for the bulk
364 * data transfer but it is also bad for VoIP apps that legitimately are using
365 * the voice service type.
366 *
367 * The characteristics of the Network Service Types are based on the service
368 * classes defined in RFC 4594 "Configuration Guidelines for DiffServ Service
369 * Classes"
370 *
371 * When system detects the outgoing interface belongs to a DiffServ domain
372 * that follows the recommendation of the IETF draft "Guidelines for DiffServ to
373 * IEEE 802.11 Mapping", the packet will marked at layer 3 with a DSCP value
374 * that corresponds to Network Service Type.
375 *
376 * NET_SERVICE_TYPE_BE
377 * "Best Effort", unclassified/standard. This is the default service
378 * class and cover the majority of the traffic.
379 *
380 * NET_SERVICE_TYPE_BK
381 * "Background", high delay tolerant, loss tolerant. elastic flow,
382 * variable size & long-lived. E.g: non-interactive network bulk transfer
383 * like synching or backup.
384 *
385 * NET_SERVICE_TYPE_RD
386 * "Responsive Data", a notch higher than "Best Effort", medium delay
387 * tolerant, elastic & inelastic flow, bursty, long-lived. E.g. email,
388 * instant messaging, for which there is a sense of interactivity and
389 * urgency (user waiting for output).
390 *
391 * NET_SERVICE_TYPE_OAM
392 * "Operations, Administration, and Management", medium delay tolerant,
393 * low-medium loss tolerant, elastic & inelastic flows, variable size.
394 * E.g. VPN tunnels.
395 *
396 * NET_SERVICE_TYPE_AV
397 * "Multimedia Audio/Video Streaming", medium delay tolerant, low-medium
398 * loss tolerant, elastic flow, constant packet interval, variable rate
399 * and size. E.g. video and audio playback with buffering.
400 *
401 * NET_SERVICE_TYPE_RV
402 * "Responsive Multimedia Audio/Video", low delay tolerant, low-medium
403 * loss tolerant, elastic flow, variable packet interval, rate and size.
404 * E.g. screen sharing.
405 *
406 * NET_SERVICE_TYPE_VI
407 * "Interactive Video", low delay tolerant, low-medium loss tolerant,
408 * elastic flow, constant packet interval, variable rate & size. E.g.
409 * video telephony.
410 *
411 * NET_SERVICE_TYPE_SIG
412 * "Signaling", low delay tolerant, low loss tolerant, inelastic flow,
413 * jitter tolerant, rate is bursty but short, variable size. E.g. SIP.
414 *
415 * NET_SERVICE_TYPE_VO
416 * "Interactive Voice", very low delay tolerant, very low loss tolerant,
417 * inelastic flow, constant packet rate, somewhat fixed size.
418 * E.g. VoIP.
419 */
420#define SO_NET_SERVICE_TYPE 0x1116 /* Network service type */
421
422#define NET_SERVICE_TYPE_BE 0 /* Best effort */
423#define NET_SERVICE_TYPE_BK 1 /* Background system initiated */
424#define NET_SERVICE_TYPE_SIG 2 /* Signaling */
425#define NET_SERVICE_TYPE_VI 3 /* Interactive Video */
426#define NET_SERVICE_TYPE_VO 4 /* Interactive Voice */
427#define NET_SERVICE_TYPE_RV 5 /* Responsive Multimedia Audio/Video */
428#define NET_SERVICE_TYPE_AV 6 /* Multimedia Audio/Video Streaming */
429#define NET_SERVICE_TYPE_OAM 7 /* Operations, Administration, and Management */
430#define NET_SERVICE_TYPE_RD 8 /* Responsive Data */
431
432#if PRIVATE
433#define SO_QOSMARKING_POLICY_OVERRIDE 0x1117 /* int */
434#define SO_INTCOPROC_ALLOW 0x1118 /* Try to use internal co-processor interfaces. */
435
436#define _NET_SERVICE_TYPE_COUNT 9
437#define _NET_SERVICE_TYPE_UNSPEC ((int)-1)
438
439#define IS_VALID_NET_SERVICE_TYPE(c) \
440 (c >= NET_SERVICE_TYPE_BE && c <= NET_SERVICE_TYPE_RD)
441
442extern const int sotc_by_netservicetype[_NET_SERVICE_TYPE_COUNT];
443
444/*
445 * Facility to pass Network Service Type values using SO_TRAFFIC_CLASS
446 * Mostly useful to simplify implementation of frameworks to adopt the new
447 * Network Service Type values for Signaling.
448 */
449#define SO_TC_NET_SERVICE_OFFSET 10000
450#define SO_TC_NETSVC_SIG (SO_TC_NET_SERVICE_OFFSET + NET_SERVICE_TYPE_SIG)
451#endif /* PRIVATE */
452
453#define SO_NETSVC_MARKING_LEVEL 0x1119 /* Get QoS marking in effect for socket */
454
455#define NETSVC_MRKNG_UNKNOWN 0 /* The outgoing network interface is not known */
456#define NETSVC_MRKNG_LVL_L2 1 /* Default marking at layer 2 (for example Wi-Fi WMM) */
457#define NETSVC_MRKNG_LVL_L3L2_ALL 2 /* Layer 3 DSCP marking and layer 2 marking for all Network Service Types */
458#define NETSVC_MRKNG_LVL_L3L2_BK 3 /* The system policy limits layer 3 DSCP marking and layer 2 marking
459 * to background Network Service Types */
460
461typedef __uint32_t sae_associd_t;
462#define SAE_ASSOCID_ANY 0
463#define SAE_ASSOCID_ALL ((sae_associd_t)(-1ULL))
464
465typedef __uint32_t sae_connid_t;
466#define SAE_CONNID_ANY 0
467#define SAE_CONNID_ALL ((sae_connid_t)(-1ULL))
468
469/* connectx() flag parameters */
470#define CONNECT_RESUME_ON_READ_WRITE 0x1 /* resume connect() on read/write */
471#define CONNECT_DATA_IDEMPOTENT 0x2 /* data is idempotent */
472#define CONNECT_DATA_AUTHENTICATED 0x4 /* data includes security that replaces the TFO-cookie */
473
474/* sockaddr endpoints */
475typedef struct sa_endpoints {
476 unsigned int sae_srcif; /* optional source interface */
477 const struct sockaddr *sae_srcaddr; /* optional source address */
478 socklen_t sae_srcaddrlen; /* size of source address */
479 const struct sockaddr *sae_dstaddr; /* destination address */
480 socklen_t sae_dstaddrlen; /* size of destination address */
481} sa_endpoints_t;
482#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
483
484/*
485 * Structure used for manipulating linger option.
486 */
487struct linger {
488 int l_onoff; /* option on/off */
489 int l_linger; /* linger time */
490};
491
492#ifndef __APPLE__
493struct accept_filter_arg {
494 char af_name[16];
495 char af_arg[256-16];
496};
497#endif
498
499#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
500#ifdef __APPLE__
501
502/*
503 * Structure to control non-portable Sockets extension to POSIX
504 */
505struct so_np_extensions {
506 u_int32_t npx_flags;
507 u_int32_t npx_mask;
508};
509
510#define SONPX_SETOPTSHUT 0x000000001 /* flag for allowing setsockopt after shutdown */
511
512
513#ifdef KERNEL_PRIVATE
514#define SONPX_MASK_VALID (SONPX_SETOPTSHUT)
515#define IS_SO_TC_BACKGROUND(_tc_) ((_tc_) == SO_TC_BK || (_tc_) == SO_TC_BK_SYS)
516#define IS_SO_TC_BACKGROUNDSYSTEM(_tc_) ((_tc_) == SO_TC_BK_SYS)
517#endif /* KERNEL_PRIVATE */
518
519#endif
520#endif
521
522/*
523 * Level number for (get/set)sockopt() to apply to socket itself.
524 */
525#define SOL_SOCKET 0xffff /* options for socket level */
526
527
528/*
529 * Address families.
530 */
531#define AF_UNSPEC 0 /* unspecified */
532#define AF_UNIX 1 /* local to host (pipes) */
533#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
534#define AF_LOCAL AF_UNIX /* backward compatibility */
535#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
536#define AF_INET 2 /* internetwork: UDP, TCP, etc. */
537#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
538#define AF_IMPLINK 3 /* arpanet imp addresses */
539#define AF_PUP 4 /* pup protocols: e.g. BSP */
540#define AF_CHAOS 5 /* mit CHAOS protocols */
541#define AF_NS 6 /* XEROX NS protocols */
542#define AF_ISO 7 /* ISO protocols */
543#define AF_OSI AF_ISO
544#define AF_ECMA 8 /* European computer manufacturers */
545#define AF_DATAKIT 9 /* datakit protocols */
546#define AF_CCITT 10 /* CCITT protocols, X.25 etc */
547#define AF_SNA 11 /* IBM SNA */
548#define AF_DECnet 12 /* DECnet */
549#define AF_DLI 13 /* DEC Direct data link interface */
550#define AF_LAT 14 /* LAT */
551#define AF_HYLINK 15 /* NSC Hyperchannel */
552#define AF_APPLETALK 16 /* Apple Talk */
553#define AF_ROUTE 17 /* Internal Routing Protocol */
554#define AF_LINK 18 /* Link layer interface */
555#define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
556#define AF_COIP 20 /* connection-oriented IP, aka ST II */
557#define AF_CNT 21 /* Computer Network Technology */
558#define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
559#define AF_IPX 23 /* Novell Internet Protocol */
560#define AF_SIP 24 /* Simple Internet Protocol */
561#define pseudo_AF_PIP 25 /* Help Identify PIP packets */
562#define AF_NDRV 27 /* Network Driver 'raw' access */
563#define AF_ISDN 28 /* Integrated Services Digital Network */
564#define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
565#define pseudo_AF_KEY 29 /* Internal key-management function */
566#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
567#define AF_INET6 30 /* IPv6 */
568#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
569#define AF_NATM 31 /* native ATM access */
570#define AF_SYSTEM 32 /* Kernel event messages */
571#define AF_NETBIOS 33 /* NetBIOS */
572#define AF_PPP 34 /* PPP communication protocol */
573#define pseudo_AF_HDRCMPLT 35 /* Used by BPF to not rewrite headers
574 in interface output routine */
575#ifdef PRIVATE
576#define AF_AFP 36 /* Used by AFP */
577#else
578#define AF_RESERVED_36 36 /* Reserved for internal usage */
579#endif
580#define AF_IEEE80211 37 /* IEEE 802.11 protocol */
581#define AF_UTUN 38
582#ifdef PRIVATE
583#define AF_MULTIPATH 39
584#endif /* PRIVATE */
585#define AF_MAX 40
586#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
587
588/*
589 * [XSI] Structure used by kernel to store most addresses.
590 */
591struct sockaddr {
592 __uint8_t sa_len; /* total length */
593 sa_family_t sa_family; /* [XSI] address family */
594 char sa_data[14]; /* [XSI] addr value (actually larger) */
595};
596
597#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
598#define SOCK_MAXADDRLEN 255 /* longest possible addresses */
599
600/*
601 * Structure used by kernel to pass protocol
602 * information in raw sockets.
603 */
604struct sockproto {
605 __uint16_t sp_family; /* address family */
606 __uint16_t sp_protocol; /* protocol */
607};
608#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
609
610/*
611 * RFC 2553: protocol-independent placeholder for socket addresses
612 */
613#define _SS_MAXSIZE 128
614#define _SS_ALIGNSIZE (sizeof(__int64_t))
615#define _SS_PAD1SIZE \
616 (_SS_ALIGNSIZE - sizeof(__uint8_t) - sizeof(sa_family_t))
617#define _SS_PAD2SIZE \
618 (_SS_MAXSIZE - sizeof(__uint8_t) - sizeof(sa_family_t) - \
619 _SS_PAD1SIZE - _SS_ALIGNSIZE)
620
621/*
622 * [XSI] sockaddr_storage
623 */
624struct sockaddr_storage {
625 __uint8_t ss_len; /* address length */
626 sa_family_t ss_family; /* [XSI] address family */
627 char __ss_pad1[_SS_PAD1SIZE];
628 __int64_t __ss_align; /* force structure storage alignment */
629 char __ss_pad2[_SS_PAD2SIZE];
630};
631
632/*
633 * Protocol families, same as address families for now.
634 */
635#define PF_UNSPEC AF_UNSPEC
636#define PF_LOCAL AF_LOCAL
637#define PF_UNIX PF_LOCAL /* backward compatibility */
638#define PF_INET AF_INET
639#define PF_IMPLINK AF_IMPLINK
640#define PF_PUP AF_PUP
641#define PF_CHAOS AF_CHAOS
642#define PF_NS AF_NS
643#define PF_ISO AF_ISO
644#define PF_OSI AF_ISO
645#define PF_ECMA AF_ECMA
646#define PF_DATAKIT AF_DATAKIT
647#define PF_CCITT AF_CCITT
648#define PF_SNA AF_SNA
649#define PF_DECnet AF_DECnet
650#define PF_DLI AF_DLI
651#define PF_LAT AF_LAT
652#define PF_HYLINK AF_HYLINK
653#define PF_APPLETALK AF_APPLETALK
654#define PF_ROUTE AF_ROUTE
655#define PF_LINK AF_LINK
656#define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
657#define PF_COIP AF_COIP
658#define PF_CNT AF_CNT
659#define PF_SIP AF_SIP
660#define PF_IPX AF_IPX /* same format as AF_NS */
661#define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
662#define PF_PIP pseudo_AF_PIP
663#define PF_NDRV AF_NDRV
664#define PF_ISDN AF_ISDN
665#define PF_KEY pseudo_AF_KEY
666#define PF_INET6 AF_INET6
667#define PF_NATM AF_NATM
668#define PF_SYSTEM AF_SYSTEM
669#define PF_NETBIOS AF_NETBIOS
670#define PF_PPP AF_PPP
671#ifdef PRIVATE
672#define PF_AFP AF_AFP
673#else
674#define PF_RESERVED_36 AF_RESERVED_36
675#endif
676#define PF_UTUN AF_UTUN
677#ifdef PRIVATE
678#define PF_MULTIPATH AF_MULTIPATH
679#endif /* PRIVATE */
680#define PF_MAX AF_MAX
681
682/*
683 * These do not have socket-layer support:
684 */
685#define PF_VLAN ((uint32_t)0x766c616e) /* 'vlan' */
686#define PF_BOND ((uint32_t)0x626f6e64) /* 'bond' */
687#ifdef KERNEL_PRIVATE
688#define PF_BRIDGE ((uint32_t)0x62726467) /* 'brdg' */
689#endif /* KERNEL_PRIVATE */
690
691/*
692 * Definitions for network related sysctl, CTL_NET.
693 *
694 * Second level is protocol family.
695 * Third level is protocol number.
696 *
697 * Further levels are defined by the individual families below.
698 */
699#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
700#define NET_MAXID AF_MAX
701#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
702
703#ifdef KERNEL_PRIVATE
704#define CTL_NET_NAMES { \
705 { 0, 0 }, \
706 { "local", CTLTYPE_NODE }, \
707 { "inet", CTLTYPE_NODE }, \
708 { "implink", CTLTYPE_NODE }, \
709 { "pup", CTLTYPE_NODE }, \
710 { "chaos", CTLTYPE_NODE }, \
711 { "xerox_ns", CTLTYPE_NODE }, \
712 { "iso", CTLTYPE_NODE }, \
713 { "emca", CTLTYPE_NODE }, \
714 { "datakit", CTLTYPE_NODE }, \
715 { "ccitt", CTLTYPE_NODE }, \
716 { "ibm_sna", CTLTYPE_NODE }, \
717 { "decnet", CTLTYPE_NODE }, \
718 { "dec_dli", CTLTYPE_NODE }, \
719 { "lat", CTLTYPE_NODE }, \
720 { "hylink", CTLTYPE_NODE }, \
721 { "appletalk", CTLTYPE_NODE }, \
722 { "route", CTLTYPE_NODE }, \
723 { "link_layer", CTLTYPE_NODE }, \
724 { "xtp", CTLTYPE_NODE }, \
725 { "coip", CTLTYPE_NODE }, \
726 { "cnt", CTLTYPE_NODE }, \
727 { "rtip", CTLTYPE_NODE }, \
728 { "ipx", CTLTYPE_NODE }, \
729 { "sip", CTLTYPE_NODE }, \
730 { "pip", CTLTYPE_NODE }, \
731 { 0, 0 }, \
732 { "ndrv", CTLTYPE_NODE }, \
733 { "isdn", CTLTYPE_NODE }, \
734 { "key", CTLTYPE_NODE }, \
735 { "inet6", CTLTYPE_NODE }, \
736 { "natm", CTLTYPE_NODE }, \
737 { "sys", CTLTYPE_NODE }, \
738 { "netbios", CTLTYPE_NODE }, \
739 { "ppp", CTLTYPE_NODE }, \
740 { "hdrcomplete", CTLTYPE_NODE }, \
741}
742#endif /* KERNEL_PRIVATE */
743
744#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
745/*
746 * PF_ROUTE - Routing table
747 *
748 * Three additional levels are defined:
749 * Fourth: address family, 0 is wildcard
750 * Fifth: type of info, defined below
751 * Sixth: flag(s) to mask with for NET_RT_FLAGS
752 */
753#define NET_RT_DUMP 1 /* dump; may limit to a.f. */
754#define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
755#define NET_RT_IFLIST 3 /* survey interface list */
756#define NET_RT_STAT 4 /* routing statistics */
757#define NET_RT_TRASH 5 /* routes not in table but not freed */
758#define NET_RT_IFLIST2 6 /* interface list with addresses */
759#define NET_RT_DUMP2 7 /* dump; may limit to a.f. */
760#ifdef PRIVATE
761#define NET_RT_DUMPX 8 /* private */
762#define NET_RT_DUMPX_FLAGS 9 /* private */
763#endif /* PRIVATE */
764/*
765 * Allows read access non-local host's MAC address
766 * if the process has neighbor cache entitlement.
767 */
768#define NET_RT_FLAGS_PRIV 10
769#define NET_RT_MAXID 11
770#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
771
772#ifdef KERNEL_PRIVATE
773#define CTL_NET_RT_NAMES { \
774 { 0, 0 }, \
775 { "dump", CTLTYPE_STRUCT }, \
776 { "flags", CTLTYPE_STRUCT }, \
777 { "iflist", CTLTYPE_STRUCT }, \
778 { "stat", CTLTYPE_STRUCT }, \
779 { "trash", CTLTYPE_INT }, \
780 { "iflist2", CTLTYPE_STRUCT }, \
781 { "dump2", CTLTYPE_STRUCT }, \
782 { "dumpx", CTLTYPE_STRUCT }, \
783 { "dumpx_flags", CTLTYPE_STRUCT }, \
784}
785
786#endif /* KERNEL_PRIVATE */
787
788/*
789 * Maximum queue length specifiable by listen.
790 */
791#define SOMAXCONN 128
792
793/*
794 * [XSI] Message header for recvmsg and sendmsg calls.
795 * Used value-result for recvmsg, value only for sendmsg.
796 */
797struct msghdr {
798 void *msg_name; /* [XSI] optional address */
799 socklen_t msg_namelen; /* [XSI] size of address */
800 struct iovec *msg_iov; /* [XSI] scatter/gather array */
801 int msg_iovlen; /* [XSI] # elements in msg_iov */
802 void *msg_control; /* [XSI] ancillary data, see below */
803 socklen_t msg_controllen; /* [XSI] ancillary data buffer len */
804 int msg_flags; /* [XSI] flags on received message */
805};
806
807#ifdef PRIVATE
808/*
809 * Extended version for sendmsg_x() and recvmsg_x() calls
810 *
811 * For recvmsg_x(), the size of the data received is given by the field
812 * msg_datalen.
813 *
814 * For sendmsg_x(), the size of the data to send is given by the length of
815 * the iovec array -- like sendmsg(). The field msg_datalen is ignored.
816 */
817struct msghdr_x {
818 void *msg_name; /* optional address */
819 socklen_t msg_namelen; /* size of address */
820 struct iovec *msg_iov; /* scatter/gather array */
821 int msg_iovlen; /* # elements in msg_iov */
822 void *msg_control; /* ancillary data, see below */
823 socklen_t msg_controllen; /* ancillary data buffer len */
824 int msg_flags; /* flags on received message */
825 size_t msg_datalen; /* byte length of buffer in msg_iov */
826};
827#endif /* PRIVATE */
828
829#ifdef XNU_KERNEL_PRIVATE
830/*
831 * In-kernel representation of "struct msghdr" from
832 * userspace. Has enough precision for 32-bit or
833 * 64-bit clients, but does not need to be packed.
834 */
835
836struct user_msghdr {
837 user_addr_t msg_name; /* optional address */
838 socklen_t msg_namelen; /* size of address */
839 user_addr_t msg_iov; /* scatter/gather array */
840 int msg_iovlen; /* # elements in msg_iov */
841 user_addr_t msg_control; /* ancillary data, see below */
842 socklen_t msg_controllen; /* ancillary data buffer len */
843 int msg_flags; /* flags on received message */
844};
845
846/*
847 * LP64 user version of struct msghdr.
848 * WARNING - keep in sync with struct msghdr
849 */
850
851struct user64_msghdr {
852 user64_addr_t msg_name; /* optional address */
853 socklen_t msg_namelen; /* size of address */
854 user64_addr_t msg_iov; /* scatter/gather array */
855 int msg_iovlen; /* # elements in msg_iov */
856 user64_addr_t msg_control; /* ancillary data, see below */
857 socklen_t msg_controllen; /* ancillary data buffer len */
858 int msg_flags; /* flags on received message */
859};
860
861/*
862 * ILP32 user version of struct msghdr.
863 * WARNING - keep in sync with struct msghdr
864 */
865
866struct user32_msghdr {
867 user32_addr_t msg_name; /* optional address */
868 socklen_t msg_namelen; /* size of address */
869 user32_addr_t msg_iov; /* scatter/gather array */
870 int msg_iovlen; /* # elements in msg_iov */
871 user32_addr_t msg_control; /* ancillary data, see below */
872 socklen_t msg_controllen; /* ancillary data buffer len */
873 int msg_flags; /* flags on received message */
874};
875
876/*
877 * In-kernel representation of "struct msghdr_x" from
878 * userspace. Has enough precision for 32-bit or
879 * 64-bit clients, but does not need to be packed.
880 */
881
882struct user_msghdr_x {
883 user_addr_t msg_name; /* optional address */
884 socklen_t msg_namelen; /* size of address */
885 user_addr_t msg_iov; /* scatter/gather array */
886 int msg_iovlen; /* # elements in msg_iov */
887 user_addr_t msg_control; /* ancillary data, see below */
888 socklen_t msg_controllen; /* ancillary data buffer len */
889 int msg_flags; /* flags on received message */
890 size_t msg_datalen; /* byte length of buffer in msg_iov */
891};
892
893/*
894 * LP64 user version of struct msghdr_x
895 * WARNING - keep in sync with struct msghdr_x
896 */
897
898struct user64_msghdr_x {
899 user64_addr_t msg_name; /* optional address */
900 socklen_t msg_namelen; /* size of address */
901 user64_addr_t msg_iov; /* scatter/gather array */
902 int msg_iovlen; /* # elements in msg_iov */
903 user64_addr_t msg_control; /* ancillary data, see below */
904 socklen_t msg_controllen; /* ancillary data buffer len */
905 int msg_flags; /* flags on received message */
906 user64_size_t msg_datalen; /* byte length of buffer in msg_iov */
907};
908
909/*
910 * ILP32 user version of struct msghdr_x
911 * WARNING - keep in sync with struct msghdr_x
912 */
913
914struct user32_msghdr_x {
915 user32_addr_t msg_name; /* optional address */
916 socklen_t msg_namelen; /* size of address */
917 user32_addr_t msg_iov; /* scatter/gather array */
918 int msg_iovlen; /* # elements in msg_iov */
919 user32_addr_t msg_control; /* ancillary data, see below */
920 socklen_t msg_controllen; /* ancillary data buffer len */
921 int msg_flags; /* flags on received message */
922 user32_size_t msg_datalen; /* byte length of buffer in msg_iov */
923};
924
925/*
926 * In-kernel representation of "struct sa_endpoints" from
927 * userspace. Has enough precision for 32-bit or
928 * 64-bit clients, but does not need to be packed.
929 */
930
931struct user_sa_endpoints {
932 unsigned int sae_srcif; /* optional source interface */
933 user_addr_t sae_srcaddr; /* optional source address */
934 socklen_t sae_srcaddrlen; /* size of source address */
935 user_addr_t sae_dstaddr; /* destination address */
936 socklen_t sae_dstaddrlen; /* size of destination address */
937};
938
939/*
940 * LP64 user version of struct sa_endpoints
941 * WARNING - keep in sync with struct sa_endpoints
942 */
943
944struct user64_sa_endpoints {
945 unsigned int sae_srcif; /* optional source interface */
946 user64_addr_t sae_srcaddr; /* optional source address */
947 socklen_t sae_srcaddrlen; /* size of source address */
948 user64_addr_t sae_dstaddr; /* destination address */
949 socklen_t sae_dstaddrlen; /* size of destination address */
950};
951
952/*
953 * ILP32 user version of struct sa_endpoints
954 * WARNING - keep in sync with struct sa_endpoints
955 */
956
957struct user32_sa_endpoints {
958 unsigned int sae_srcif; /* optional source interface */
959 user32_addr_t sae_srcaddr; /* optional source address */
960 socklen_t sae_srcaddrlen; /* size of source address */
961 user32_addr_t sae_dstaddr; /* destination address */
962 socklen_t sae_dstaddrlen; /* size of destination address */
963};
964
965#endif /* XNU_KERNEL_PRIVATE */
966
967#define MSG_OOB 0x1 /* process out-of-band data */
968#define MSG_PEEK 0x2 /* peek at incoming message */
969#define MSG_DONTROUTE 0x4 /* send without using routing tables */
970#define MSG_EOR 0x8 /* data completes record */
971#define MSG_TRUNC 0x10 /* data discarded before delivery */
972#define MSG_CTRUNC 0x20 /* control data lost before delivery */
973#define MSG_WAITALL 0x40 /* wait for full request or error */
974#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
975#define MSG_DONTWAIT 0x80 /* this message should be nonblocking */
976#define MSG_EOF 0x100 /* data completes connection */
977#ifdef __APPLE__
978#ifndef PRIVATE
979#ifdef __APPLE_API_OBSOLETE
980#define MSG_WAITSTREAM 0x200 /* wait up to full request.. may return partial */
981#endif
982#else
983#define MSG_WAITSTREAM 0x200 /* wait up to full request.. may return partial */
984#endif
985#define MSG_FLUSH 0x400 /* Start of 'hold' seq; dump so_temp */
986#define MSG_HOLD 0x800 /* Hold frag in so_temp */
987#define MSG_SEND 0x1000 /* Send the packet in so_temp */
988#define MSG_HAVEMORE 0x2000 /* Data ready to be read */
989#define MSG_RCVMORE 0x4000 /* Data remains in current pkt */
990#endif
991#ifdef KERNEL_PRIVATE
992#define MSG_COMPAT 0x8000 /* deprecated */
993#endif /* KERNEL_PRIVATE */
994#define MSG_NEEDSA 0x10000 /* Fail receive if socket address cannot be allocated */
995#ifdef KERNEL_PRIVATE
996#define MSG_NBIO 0x20000 /* FIONBIO mode, used by fifofs */
997#define MSG_SKIPCFIL 0x40000 /* skip pass content filter */
998#endif
999#ifdef KERNEL
1000#define MSG_USEUPCALL 0x80000000 /* Inherit upcall in sock_accept */
1001#endif
1002#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1003
1004/*
1005 * Header for ancillary data objects in msg_control buffer.
1006 * Used for additional information with/about a datagram
1007 * not expressible by flags. The format is a sequence
1008 * of message elements headed by cmsghdr structures.
1009 */
1010struct cmsghdr {
1011 socklen_t cmsg_len; /* [XSI] data byte count, including hdr */
1012 int cmsg_level; /* [XSI] originating protocol */
1013 int cmsg_type; /* [XSI] protocol-specific type */
1014/* followed by unsigned char cmsg_data[]; */
1015};
1016
1017#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1018#ifndef __APPLE__
1019/*
1020 * While we may have more groups than this, the cmsgcred struct must
1021 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
1022 * this.
1023 */
1024#define CMGROUP_MAX 16
1025
1026/*
1027 * Credentials structure, used to verify the identity of a peer
1028 * process that has sent us a message. This is allocated by the
1029 * peer process but filled in by the kernel. This prevents the
1030 * peer from lying about its identity. (Note that cmcred_groups[0]
1031 * is the effective GID.)
1032 */
1033struct cmsgcred {
1034 pid_t cmcred_pid; /* PID of sending process */
1035 uid_t cmcred_uid; /* real UID of sending process */
1036 uid_t cmcred_euid; /* effective UID of sending process */
1037 gid_t cmcred_gid; /* real GID of sending process */
1038 short cmcred_ngroups; /* number or groups */
1039 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */
1040};
1041#endif
1042#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1043
1044/* given pointer to struct cmsghdr, return pointer to data */
1045#define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + \
1046 __DARWIN_ALIGN32(sizeof(struct cmsghdr)))
1047
1048/*
1049 * RFC 2292 requires to check msg_controllen, in case that the kernel returns
1050 * an empty list for some reasons.
1051 */
1052#define CMSG_FIRSTHDR(mhdr) \
1053 ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
1054 (struct cmsghdr *)(mhdr)->msg_control : \
1055 (struct cmsghdr *)0L)
1056
1057
1058/*
1059 * Given pointer to struct cmsghdr, return pointer to next cmsghdr
1060 * RFC 2292 says that CMSG_NXTHDR(mhdr, NULL) is equivalent to CMSG_FIRSTHDR(mhdr)
1061 */
1062#define CMSG_NXTHDR(mhdr, cmsg) \
1063 ((char *)(cmsg) == (char *)0L ? CMSG_FIRSTHDR(mhdr) : \
1064 ((((unsigned char *)(cmsg) + \
1065 __DARWIN_ALIGN32((__uint32_t)(cmsg)->cmsg_len) + \
1066 __DARWIN_ALIGN32(sizeof(struct cmsghdr))) > \
1067 ((unsigned char *)(mhdr)->msg_control + \
1068 (mhdr)->msg_controllen)) ? \
1069 (struct cmsghdr *)0L /* NULL */ : \
1070 (struct cmsghdr *)(void *)((unsigned char *)(cmsg) + \
1071 __DARWIN_ALIGN32((__uint32_t)(cmsg)->cmsg_len))))
1072
1073#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1074/* RFC 2292 additions */
1075#define CMSG_SPACE(l) (__DARWIN_ALIGN32(sizeof(struct cmsghdr)) + __DARWIN_ALIGN32(l))
1076#define CMSG_LEN(l) (__DARWIN_ALIGN32(sizeof(struct cmsghdr)) + (l))
1077
1078#ifdef KERNEL
1079#define CMSG_ALIGN(n) __DARWIN_ALIGN32(n)
1080#endif
1081#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1082
1083/* "Socket"-level control message types: */
1084#define SCM_RIGHTS 0x01 /* access rights (array of int) */
1085#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1086#define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
1087#define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */
1088#define SCM_TIMESTAMP_MONOTONIC 0x04 /* timestamp (uint64_t) */
1089
1090#ifdef PRIVATE
1091#define SCM_SEQNUM 0x05 /* TCP unordered recv seq no */
1092#define SCM_MSG_PRIORITY 0x06 /* TCP unordered snd priority */
1093#define SCM_TIMESTAMP_CONTINUOUS 0x07 /* timestamp (uint64_t) */
1094#endif /* PRIVATE */
1095
1096#ifdef KERNEL_PRIVATE
1097/*
1098 * 4.3 compat sockaddr (deprecated)
1099 */
1100struct osockaddr {
1101 __uint16_t sa_family; /* address family */
1102 char sa_data[14]; /* up to 14 bytes of direct address */
1103};
1104
1105/*
1106 * 4.3-compat message header (deprecated)
1107 */
1108struct omsghdr {
1109 void *msg_name; /* optional address */
1110 socklen_t msg_namelen; /* size of address */
1111 struct iovec *msg_iov; /* scatter/gather array */
1112 int msg_iovlen; /* # elements in msg_iov */
1113 void *msg_accrights; /* access rights sent/rcvd */
1114 int msg_accrightslen;
1115};
1116
1117#define SA(s) ((struct sockaddr *)(void *)(s))
1118#endif /* KERNEL_PRIVATE */
1119#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1120
1121/*
1122 * howto arguments for shutdown(2), specified by Posix.1g.
1123 */
1124#define SHUT_RD 0 /* shut down the reading side */
1125#define SHUT_WR 1 /* shut down the writing side */
1126#define SHUT_RDWR 2 /* shut down both sides */
1127
1128#if !defined(_POSIX_C_SOURCE)
1129/*
1130 * sendfile(2) header/trailer struct
1131 */
1132struct sf_hdtr {
1133 struct iovec *headers; /* pointer to an array of header struct iovec's */
1134 int hdr_cnt; /* number of header iovec's */
1135 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */
1136 int trl_cnt; /* number of trailer iovec's */
1137};
1138
1139#ifdef KERNEL
1140
1141/* In-kernel representation */
1142struct user_sf_hdtr {
1143 user_addr_t headers; /* pointer to an array of header struct iovec's */
1144 int hdr_cnt; /* number of header iovec's */
1145 user_addr_t trailers; /* pointer to an array of trailer struct iovec's */
1146 int trl_cnt; /* number of trailer iovec's */
1147};
1148
1149/* LP64 user version of struct sf_hdtr */
1150struct user64_sf_hdtr {
1151 user64_addr_t headers; /* pointer to an array of header struct iovec's */
1152 int hdr_cnt; /* number of header iovec's */
1153 user64_addr_t trailers; /* pointer to an array of trailer struct iovec's */
1154 int trl_cnt; /* number of trailer iovec's */
1155};
1156
1157/* ILP32 user version of struct sf_hdtr */
1158struct user32_sf_hdtr {
1159 user32_addr_t headers; /* pointer to an array of header struct iovec's */
1160 int hdr_cnt; /* number of header iovec's */
1161 user32_addr_t trailers; /* pointer to an array of trailer struct iovec's */
1162 int trl_cnt; /* number of trailer iovec's */
1163};
1164
1165#endif /* KERNEL */
1166
1167#endif /* !_POSIX_C_SOURCE */
1168
1169#ifdef PRIVATE
1170#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1171
1172/*
1173 * Structure for SIOCGASSOCIDS
1174 */
1175struct so_aidreq {
1176 __uint32_t sar_cnt; /* number of associations */
1177 sae_associd_t *sar_aidp; /* array of association IDs */
1178};
1179
1180#ifdef BSD_KERNEL_PRIVATE
1181struct so_aidreq32 {
1182 __uint32_t sar_cnt;
1183 user32_addr_t sar_aidp;
1184};
1185
1186struct so_aidreq64 {
1187 __uint32_t sar_cnt;
1188 user64_addr_t sar_aidp __attribute__((aligned(8)));
1189};
1190#endif /* BSD_KERNEL_PRIVATE */
1191
1192/*
1193 * Structure for SIOCGCONNIDS
1194 */
1195struct so_cidreq {
1196 sae_associd_t scr_aid; /* association ID */
1197 __uint32_t scr_cnt; /* number of connections */
1198 sae_connid_t *scr_cidp; /* array of connection IDs */
1199};
1200
1201#ifdef BSD_KERNEL_PRIVATE
1202struct so_cidreq32 {
1203 sae_associd_t scr_aid;
1204 __uint32_t scr_cnt;
1205 user32_addr_t scr_cidp;
1206};
1207
1208struct so_cidreq64 {
1209 sae_associd_t scr_aid;
1210 __uint32_t scr_cnt;
1211 user64_addr_t scr_cidp __attribute__((aligned(8)));
1212};
1213#endif /* BSD_KERNEL_PRIVATE */
1214
1215/*
1216 * Structure for SIOCGCONNINFO
1217 */
1218struct so_cinforeq {
1219 sae_connid_t scir_cid; /* connection ID */
1220 __uint32_t scir_flags; /* see flags below */
1221 __uint32_t scir_ifindex; /* (last) outbound interface */
1222 __int32_t scir_error; /* most recent error */
1223 struct sockaddr *scir_src; /* source address */
1224 socklen_t scir_src_len; /* source address len */
1225 struct sockaddr *scir_dst; /* destination address */
1226 socklen_t scir_dst_len; /* destination address len */
1227 __uint32_t scir_aux_type; /* aux data type (CIAUX) */
1228 void *scir_aux_data; /* aux data */
1229 __uint32_t scir_aux_len; /* aux data len */
1230};
1231
1232#ifdef BSD_KERNEL_PRIVATE
1233struct so_cinforeq32 {
1234 sae_connid_t scir_cid;
1235 __uint32_t scir_flags;
1236 __uint32_t scir_ifindex;
1237 __int32_t scir_error;
1238 user32_addr_t scir_src;
1239 socklen_t scir_src_len;
1240 user32_addr_t scir_dst;
1241 socklen_t scir_dst_len;
1242 __uint32_t scir_aux_type;
1243 user32_addr_t scir_aux_data;
1244 __uint32_t scir_aux_len;
1245};
1246
1247struct so_cinforeq64 {
1248 sae_connid_t scir_cid;
1249 __uint32_t scir_flags;
1250 __uint32_t scir_ifindex;
1251 __int32_t scir_error;
1252 user64_addr_t scir_src __attribute__((aligned(8)));
1253 socklen_t scir_src_len;
1254 user64_addr_t scir_dst __attribute__((aligned(8)));
1255 socklen_t scir_dst_len;
1256 __uint32_t scir_aux_type;
1257 user64_addr_t scir_aux_data __attribute__((aligned(8)));
1258 __uint32_t scir_aux_len;
1259};
1260#endif /* BSD_KERNEL_PRIVATE */
1261
1262/* valid connection info flags */
1263#define CIF_CONNECTING 0x1 /* connection was attempted */
1264#define CIF_CONNECTED 0x2 /* connection is established */
1265#define CIF_DISCONNECTING 0x4 /* disconnection was attempted */
1266#define CIF_DISCONNECTED 0x8 /* has been disconnected */
1267#define CIF_BOUND_IF 0x10 /* bound to an interface */
1268#define CIF_BOUND_IP 0x20 /* bound to a src address */
1269#define CIF_BOUND_PORT 0x40 /* bound to a src port */
1270#define CIF_PREFERRED 0x80 /* connection is primary/preferred */
1271#define CIF_MP_CAPABLE 0x100 /* supports multipath protocol */
1272#define CIF_MP_READY 0x200 /* multipath protocol confirmed */
1273#define CIF_MP_DEGRADED 0x400 /* has lost its multipath capability */
1274#define CIF_MP_ACTIVE 0x800 /* this is the active subflow */
1275
1276/* valid connection info auxiliary data types */
1277#define CIAUX_TCP 0x1 /* TCP auxiliary data (conninfo_tcp_t) */
1278#define CIAUX_MPTCP 0x2 /* MPTCP auxiliary data (conninfo_mptcp_t) */
1279
1280/*
1281 * Structure for SIOC{S,G}CONNORDER
1282 */
1283struct so_cordreq {
1284 sae_connid_t sco_cid; /* connection ID */
1285 __uint32_t sco_rank; /* rank (0 means unspecified) */
1286};
1287
1288/*
1289 * Common structure for KEV_NETPOLICY_SUBCLASS
1290 */
1291struct netpolicy_event_data {
1292 __uint64_t eupid; /* effective unique PID */
1293 pid_t epid; /* effective PID */
1294#if !defined(__LP64__)
1295 __uint32_t pad;
1296#endif /* __LP64__ */
1297 uuid_t euuid; /* effective UUID */
1298};
1299
1300/*
1301 * NETPOLICY_IFDENIED event structure
1302 */
1303struct kev_netpolicy_ifdenied {
1304 struct netpolicy_event_data ev_data;
1305 __uint32_t ev_if_functional_type;
1306};
1307
1308/*
1309 * Common structure for KEV_SOCKET_SUBCLASS
1310 */
1311struct kev_socket_event_data {
1312 struct sockaddr_storage kev_sockname;
1313 struct sockaddr_storage kev_peername;
1314};
1315
1316struct kev_socket_closed {
1317 struct kev_socket_event_data ev_data;
1318};
1319
1320/*
1321 * Network Service Type to DiffServ Code Point mapping
1322 */
1323struct netsvctype_dscp_map {
1324 int netsvctype;
1325 u_int8_t dscp; /* 6 bits diffserv code point */
1326};
1327
1328#ifndef KERNEL
1329__BEGIN_DECLS
1330
1331extern int peeloff(int s, sae_associd_t);
1332extern int socket_delegate(int, int, int, pid_t);
1333
1334/*
1335 * recvmsg_x() is a system call similar to recvmsg(2) to receive
1336 * several datagrams at once in the array of message headers "msgp".
1337 *
1338 * recvmsg_x() can be used only with protocols handlers that have been specially
1339 * modified to support sending and receiving several datagrams at once.
1340 *
1341 * The size of the array "msgp" is given by the argument "cnt".
1342 *
1343 * The "flags" arguments supports only the value MSG_DONTWAIT.
1344 *
1345 * Each member of "msgp" array is of type "struct msghdr_x".
1346 *
1347 * The "msg_iov" and "msg_iovlen" are input parameters that describe where to
1348 * store a datagram in a scatter gather locations of buffers -- see recvmsg(2).
1349 * On output the field "msg_datalen" gives the length of the received datagram.
1350 *
1351 * The field "msg_flags" must be set to zero on input. On output, "msg_flags"
1352 * may have MSG_TRUNC set to indicate the trailing portion of the datagram was
1353 * discarded because the datagram was larger than the buffer supplied.
1354 * recvmsg_x() returns as soon as a datagram is truncated.
1355 *
1356 * recvmsg_x() may return with less than "cnt" datagrams received based on
1357 * the low water mark and the amount of data pending in the socket buffer.
1358 *
1359 * recvmsg_x() returns the number of datagrams that have been received,
1360 * or -1 if an error occurred.
1361 *
1362 * NOTE: This a private system call, the API is subject to change.
1363 */
1364ssize_t recvmsg_x(int s, const struct msghdr_x *msgp, u_int cnt, int flags);
1365
1366/*
1367 * sendmsg_x() is a system call similar to send(2) to send
1368 * several datagrams at once in the array of message headers "msgp".
1369 *
1370 * sendmsg_x() can be used only with protocols handlers that have been specially
1371 * modified to support sending and receiving several datagrams at once.
1372 *
1373 * The size of the array "msgp" is given by the argument "cnt".
1374 *
1375 * The "flags" arguments supports only the value MSG_DONTWAIT.
1376 *
1377 * Each member of "msgp" array is of type "struct msghdr_x".
1378 *
1379 * The "msg_iov" and "msg_iovlen" are input parameters that specify the
1380 * data to be sent in a scatter gather locations of buffers -- see sendmsg(2).
1381 *
1382 * sendmsg_x() fails with EMSGSIZE if the sum of the length of the datagrams
1383 * is greater than the high water mark.
1384 *
1385 * Address and ancillary data are not supported so the following fields
1386 * must be set to zero on input:
1387 * "msg_name", "msg_namelen", "msg_control" and "msg_controllen".
1388 *
1389 * The field "msg_flags" and "msg_datalen" must be set to zero on input.
1390 *
1391 * sendmsg_x() returns the number of datagrams that have been sent,
1392 * or -1 if an error occurred.
1393 *
1394 * NOTE: This a private system call, the API is subject to change.
1395 */
1396ssize_t sendmsg_x(int s, const struct msghdr_x *msgp, u_int cnt, int flags);
1397__END_DECLS
1398#endif /* !KERNEL */
1399#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1400#endif /* PRIVATE */
1401
1402#ifndef KERNEL
1403__BEGIN_DECLS
1404
1405int accept(int, struct sockaddr * __restrict, socklen_t * __restrict)
1406 __DARWIN_ALIAS_C(accept);
1407int bind(int, const struct sockaddr *, socklen_t) __DARWIN_ALIAS(bind);
1408int connect(int, const struct sockaddr *, socklen_t) __DARWIN_ALIAS_C(connect);
1409int getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict)
1410 __DARWIN_ALIAS(getpeername);
1411int getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict)
1412 __DARWIN_ALIAS(getsockname);
1413int getsockopt(int, int, int, void * __restrict, socklen_t * __restrict);
1414int listen(int, int) __DARWIN_ALIAS(listen);
1415ssize_t recv(int, void *, size_t, int) __DARWIN_ALIAS_C(recv);
1416ssize_t recvfrom(int, void *, size_t, int, struct sockaddr * __restrict,
1417 socklen_t * __restrict) __DARWIN_ALIAS_C(recvfrom);
1418ssize_t recvmsg(int, struct msghdr *, int) __DARWIN_ALIAS_C(recvmsg);
1419ssize_t send(int, const void *, size_t, int) __DARWIN_ALIAS_C(send);
1420ssize_t sendmsg(int, const struct msghdr *, int) __DARWIN_ALIAS_C(sendmsg);
1421ssize_t sendto(int, const void *, size_t,
1422 int, const struct sockaddr *, socklen_t) __DARWIN_ALIAS_C(sendto);
1423int setsockopt(int, int, int, const void *, socklen_t);
1424int shutdown(int, int);
1425int sockatmark(int) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_2_0);
1426int socket(int, int, int);
1427int socketpair(int, int, int, int *) __DARWIN_ALIAS(socketpair);
1428
1429#if !defined(_POSIX_C_SOURCE)
1430int sendfile(int, int, off_t, off_t *, struct sf_hdtr *, int);
1431#endif /* !_POSIX_C_SOURCE */
1432
1433#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1434void pfctlinput(int, struct sockaddr *);
1435
1436__API_AVAILABLE(macosx(10.11), ios(9.0), tvos(9.0), watchos(2.0))
1437int connectx(int, const sa_endpoints_t *, sae_associd_t, unsigned int,
1438 const struct iovec *, unsigned int, size_t *, sae_connid_t *);
1439
1440__API_AVAILABLE(macosx(10.11), ios(9.0), tvos(9.0), watchos(2.0))
1441int disconnectx(int, sae_associd_t, sae_connid_t);
1442#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
1443__END_DECLS
1444#endif /* !KERNEL */
1445
1446#ifdef KERNEL
1447#include <sys/kpi_socket.h>
1448#endif
1449
1450#endif /* !_SYS_SOCKET_H_ */
1451