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