]> git.saurik.com Git - apple/xnu.git/blame_incremental - bsd/netinet/in.h
xnu-7195.101.1.tar.gz
[apple/xnu.git] / bsd / netinet / in.h
... / ...
CommitLineData
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/*
29 * Copyright (c) 1982, 1986, 1990, 1993
30 * The Regents of the University of California. All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. All advertising materials mentioning features or use of this software
41 * must display the following acknowledgement:
42 * This product includes software developed by the University of
43 * California, Berkeley and its contributors.
44 * 4. Neither the name of the University nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * SUCH DAMAGE.
59 *
60 * @(#)in.h 8.3 (Berkeley) 1/3/94
61 * $FreeBSD: src/sys/netinet/in.h,v 1.48.2.2 2001/04/21 14:53:06 ume Exp $
62 */
63
64#ifndef _NETINET_IN_H_
65#define _NETINET_IN_H_
66
67#ifndef DRIVERKIT
68#include <sys/appleapiopts.h>
69#include <stdint.h> /* uint(8|16|32)_t */
70
71#ifndef KERNEL
72#include <Availability.h>
73#endif
74
75#else
76#include <sys/_types.h>
77#include <sys/_types/_sa_family_t.h>
78#endif /* DRIVERKIT */
79
80#include <sys/_types/_in_addr_t.h>
81#include <sys/_types/_in_port_t.h>
82
83#ifndef DRIVERKIT
84/*
85 * POSIX 1003.1-2003
86 * "Inclusion of the <netinet/in.h> header may also make visible all
87 * symbols from <inttypes.h> and <sys/socket.h>".
88 */
89#include <sys/socket.h>
90#endif /* DRIVERKIT */
91
92/*
93 * The following two #includes insure htonl and family are defined
94 */
95#include <machine/endian.h>
96#include <sys/_endian.h>
97
98/*
99 * Constants and structures defined by the internet system,
100 * Per RFC 790, September 1981, and numerous additions.
101 */
102
103/*
104 * Protocols (RFC 1700)
105 */
106#define IPPROTO_IP 0 /* dummy for IP */
107#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
108#define IPPROTO_HOPOPTS 0 /* IP6 hop-by-hop options */
109#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
110#define IPPROTO_ICMP 1 /* control message protocol */
111#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
112#define IPPROTO_IGMP 2 /* group mgmt protocol */
113#define IPPROTO_GGP 3 /* gateway^2 (deprecated) */
114#define IPPROTO_IPV4 4 /* IPv4 encapsulation */
115#define IPPROTO_IPIP IPPROTO_IPV4 /* for compatibility */
116#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
117#define IPPROTO_TCP 6 /* tcp */
118#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
119#define IPPROTO_ST 7 /* Stream protocol II */
120#define IPPROTO_EGP 8 /* exterior gateway protocol */
121#define IPPROTO_PIGP 9 /* private interior gateway */
122#define IPPROTO_RCCMON 10 /* BBN RCC Monitoring */
123#define IPPROTO_NVPII 11 /* network voice protocol*/
124#define IPPROTO_PUP 12 /* pup */
125#define IPPROTO_ARGUS 13 /* Argus */
126#define IPPROTO_EMCON 14 /* EMCON */
127#define IPPROTO_XNET 15 /* Cross Net Debugger */
128#define IPPROTO_CHAOS 16 /* Chaos*/
129#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
130#define IPPROTO_UDP 17 /* user datagram protocol */
131#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
132#define IPPROTO_MUX 18 /* Multiplexing */
133#define IPPROTO_MEAS 19 /* DCN Measurement Subsystems */
134#define IPPROTO_HMP 20 /* Host Monitoring */
135#define IPPROTO_PRM 21 /* Packet Radio Measurement */
136#define IPPROTO_IDP 22 /* xns idp */
137#define IPPROTO_TRUNK1 23 /* Trunk-1 */
138#define IPPROTO_TRUNK2 24 /* Trunk-2 */
139#define IPPROTO_LEAF1 25 /* Leaf-1 */
140#define IPPROTO_LEAF2 26 /* Leaf-2 */
141#define IPPROTO_RDP 27 /* Reliable Data */
142#define IPPROTO_IRTP 28 /* Reliable Transaction */
143#define IPPROTO_TP 29 /* tp-4 w/ class negotiation */
144#define IPPROTO_BLT 30 /* Bulk Data Transfer */
145#define IPPROTO_NSP 31 /* Network Services */
146#define IPPROTO_INP 32 /* Merit Internodal */
147#define IPPROTO_SEP 33 /* Sequential Exchange */
148#define IPPROTO_3PC 34 /* Third Party Connect */
149#define IPPROTO_IDPR 35 /* InterDomain Policy Routing */
150#define IPPROTO_XTP 36 /* XTP */
151#define IPPROTO_DDP 37 /* Datagram Delivery */
152#define IPPROTO_CMTP 38 /* Control Message Transport */
153#define IPPROTO_TPXX 39 /* TP++ Transport */
154#define IPPROTO_IL 40 /* IL transport protocol */
155#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
156#define IPPROTO_IPV6 41 /* IP6 header */
157#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
158#define IPPROTO_SDRP 42 /* Source Demand Routing */
159#define IPPROTO_ROUTING 43 /* IP6 routing header */
160#define IPPROTO_FRAGMENT 44 /* IP6 fragmentation header */
161#define IPPROTO_IDRP 45 /* InterDomain Routing*/
162#define IPPROTO_RSVP 46 /* resource reservation */
163#define IPPROTO_GRE 47 /* General Routing Encap. */
164#define IPPROTO_MHRP 48 /* Mobile Host Routing */
165#define IPPROTO_BHA 49 /* BHA */
166#define IPPROTO_ESP 50 /* IP6 Encap Sec. Payload */
167#define IPPROTO_AH 51 /* IP6 Auth Header */
168#define IPPROTO_INLSP 52 /* Integ. Net Layer Security */
169#define IPPROTO_SWIPE 53 /* IP with encryption */
170#define IPPROTO_NHRP 54 /* Next Hop Resolution */
171/* 55-57: Unassigned */
172#define IPPROTO_ICMPV6 58 /* ICMP6 */
173#define IPPROTO_NONE 59 /* IP6 no next header */
174#define IPPROTO_DSTOPTS 60 /* IP6 destination option */
175#define IPPROTO_AHIP 61 /* any host internal protocol */
176#define IPPROTO_CFTP 62 /* CFTP */
177#define IPPROTO_HELLO 63 /* "hello" routing protocol */
178#define IPPROTO_SATEXPAK 64 /* SATNET/Backroom EXPAK */
179#define IPPROTO_KRYPTOLAN 65 /* Kryptolan */
180#define IPPROTO_RVD 66 /* Remote Virtual Disk */
181#define IPPROTO_IPPC 67 /* Pluribus Packet Core */
182#define IPPROTO_ADFS 68 /* Any distributed FS */
183#define IPPROTO_SATMON 69 /* Satnet Monitoring */
184#define IPPROTO_VISA 70 /* VISA Protocol */
185#define IPPROTO_IPCV 71 /* Packet Core Utility */
186#define IPPROTO_CPNX 72 /* Comp. Prot. Net. Executive */
187#define IPPROTO_CPHB 73 /* Comp. Prot. HeartBeat */
188#define IPPROTO_WSN 74 /* Wang Span Network */
189#define IPPROTO_PVP 75 /* Packet Video Protocol */
190#define IPPROTO_BRSATMON 76 /* BackRoom SATNET Monitoring */
191#define IPPROTO_ND 77 /* Sun net disk proto (temp.) */
192#define IPPROTO_WBMON 78 /* WIDEBAND Monitoring */
193#define IPPROTO_WBEXPAK 79 /* WIDEBAND EXPAK */
194#define IPPROTO_EON 80 /* ISO cnlp */
195#define IPPROTO_VMTP 81 /* VMTP */
196#define IPPROTO_SVMTP 82 /* Secure VMTP */
197#define IPPROTO_VINES 83 /* Banyon VINES */
198#define IPPROTO_TTP 84 /* TTP */
199#define IPPROTO_IGP 85 /* NSFNET-IGP */
200#define IPPROTO_DGP 86 /* dissimilar gateway prot. */
201#define IPPROTO_TCF 87 /* TCF */
202#define IPPROTO_IGRP 88 /* Cisco/GXS IGRP */
203#define IPPROTO_OSPFIGP 89 /* OSPFIGP */
204#define IPPROTO_SRPC 90 /* Strite RPC protocol */
205#define IPPROTO_LARP 91 /* Locus Address Resoloution */
206#define IPPROTO_MTP 92 /* Multicast Transport */
207#define IPPROTO_AX25 93 /* AX.25 Frames */
208#define IPPROTO_IPEIP 94 /* IP encapsulated in IP */
209#define IPPROTO_MICP 95 /* Mobile Int.ing control */
210#define IPPROTO_SCCSP 96 /* Semaphore Comm. security */
211#define IPPROTO_ETHERIP 97 /* Ethernet IP encapsulation */
212#define IPPROTO_ENCAP 98 /* encapsulation header */
213#define IPPROTO_APES 99 /* any private encr. scheme */
214#define IPPROTO_GMTP 100 /* GMTP*/
215/* 101-252: Partly Unassigned */
216#define IPPROTO_PIM 103 /* Protocol Independent Mcast */
217#define IPPROTO_IPCOMP 108 /* payload compression (IPComp) */
218#define IPPROTO_PGM 113 /* PGM */
219#define IPPROTO_SCTP 132 /* SCTP */
220/* 253-254: Experimentation and testing; 255: Reserved (RFC3692) */
221/* BSD Private, local use, namespace incursion */
222#ifdef PRIVATE
223#define IPPROTO_QUIC 253 /* QUIC protocol (Over UDP) */
224#endif /* PRIVATE */
225#define IPPROTO_DIVERT 254 /* divert pseudo-protocol */
226#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
227#define IPPROTO_RAW 255 /* raw IP packet */
228
229#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
230#define IPPROTO_MAX 256
231
232/* last return value of *_input(), meaning "all job for this pkt is done". */
233#define IPPROTO_DONE 257
234#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
235
236/*
237 * Local port number conventions:
238 *
239 * When a user does a bind(2) or connect(2) with a port number of zero,
240 * a non-conflicting local port address is chosen.
241 * The default range is IPPORT_RESERVED through
242 * IPPORT_USERRESERVED, although that is settable by sysctl.
243 *
244 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
245 * default assignment range.
246 *
247 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
248 *
249 * The value IP_PORTRANGE_HIGH changes the range of candidate port numbers
250 * into the "high" range. These are reserved for client outbound connections
251 * which do not want to be filtered by any firewalls.
252 *
253 * The value IP_PORTRANGE_LOW changes the range to the "low" are
254 * that is (by convention) restricted to privileged processes. This
255 * convention is based on "vouchsafe" principles only. It is only secure
256 * if you trust the remote host to restrict these ports.
257 *
258 * The default range of ports and the high range can be changed by
259 * sysctl(3). (net.inet.ip.port{hi,low}{first,last}_auto)
260 *
261 * Changing those values has bad security implications if you are
262 * using a a stateless firewall that is allowing packets outside of that
263 * range in order to allow transparent outgoing connections.
264 *
265 * Such a firewall configuration will generally depend on the use of these
266 * default values. If you change them, you may find your Security
267 * Administrator looking for you with a heavy object.
268 *
269 * For a slightly more orthodox text view on this:
270 *
271 * ftp://ftp.isi.edu/in-notes/iana/assignments/port-numbers
272 *
273 * port numbers are divided into three ranges:
274 *
275 * 0 - 1023 Well Known Ports
276 * 1024 - 49151 Registered Ports
277 * 49152 - 65535 Dynamic and/or Private Ports
278 *
279 */
280
281#define __DARWIN_IPPORT_RESERVED 1024
282
283#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
284/*
285 * Ports < IPPORT_RESERVED are reserved for
286 * privileged processes (e.g. root). (IP_PORTRANGE_LOW)
287 * Ports > IPPORT_USERRESERVED are reserved
288 * for servers, not necessarily privileged. (IP_PORTRANGE_DEFAULT)
289 */
290#ifndef IPPORT_RESERVED
291#define IPPORT_RESERVED __DARWIN_IPPORT_RESERVED
292#endif
293#define IPPORT_USERRESERVED 5000
294
295/*
296 * Default local port range to use by setting IP_PORTRANGE_HIGH
297 */
298#define IPPORT_HIFIRSTAUTO 49152
299#define IPPORT_HILASTAUTO 65535
300
301/*
302 * Scanning for a free reserved port return a value below IPPORT_RESERVED,
303 * but higher than IPPORT_RESERVEDSTART. Traditionally the start value was
304 * 512, but that conflicts with some well-known-services that firewalls may
305 * have a fit if we use.
306 */
307#define IPPORT_RESERVEDSTART 600
308#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
309
310/*
311 * Internet address (a structure for historical reasons)
312 */
313struct in_addr {
314 in_addr_t s_addr;
315};
316
317/*
318 * Definitions of bits in internet address integers.
319 * On subnets, the decomposition of addresses to host and net parts
320 * is done according to subnet mask, not the masks here.
321 */
322#define INADDR_ANY (u_int32_t)0x00000000
323#define INADDR_BROADCAST (u_int32_t)0xffffffff /* must be masked */
324
325#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
326#define IN_CLASSA(i) (((u_int32_t)(i) & 0x80000000) == 0)
327#define IN_CLASSA_NET 0xff000000
328#define IN_CLASSA_NSHIFT 24
329#define IN_CLASSA_HOST 0x00ffffff
330#define IN_CLASSA_MAX 128
331
332#define IN_CLASSB(i) (((u_int32_t)(i) & 0xc0000000) == 0x80000000)
333#define IN_CLASSB_NET 0xffff0000
334#define IN_CLASSB_NSHIFT 16
335#define IN_CLASSB_HOST 0x0000ffff
336#define IN_CLASSB_MAX 65536
337
338#define IN_CLASSC(i) (((u_int32_t)(i) & 0xe0000000) == 0xc0000000)
339#define IN_CLASSC_NET 0xffffff00
340#define IN_CLASSC_NSHIFT 8
341#define IN_CLASSC_HOST 0x000000ff
342
343#define IN_CLASSD(i) (((u_int32_t)(i) & 0xf0000000) == 0xe0000000)
344#define IN_CLASSD_NET 0xf0000000 /* These ones aren't really */
345#define IN_CLASSD_NSHIFT 28 /* net and host fields, but */
346#define IN_CLASSD_HOST 0x0fffffff /* routing needn't know. */
347#define IN_MULTICAST(i) IN_CLASSD(i)
348
349#define IN_EXPERIMENTAL(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
350#define IN_BADCLASS(i) (((u_int32_t)(i) & 0xf0000000) == 0xf0000000)
351
352#define INADDR_LOOPBACK (u_int32_t)0x7f000001
353
354#ifndef KERNEL
355#define INADDR_NONE 0xffffffff /* -1 return */
356#endif
357
358#define INADDR_UNSPEC_GROUP (u_int32_t)0xe0000000 /* 224.0.0.0 */
359#define INADDR_ALLHOSTS_GROUP (u_int32_t)0xe0000001 /* 224.0.0.1 */
360#define INADDR_ALLRTRS_GROUP (u_int32_t)0xe0000002 /* 224.0.0.2 */
361#define INADDR_ALLRPTS_GROUP (u_int32_t)0xe0000016 /* 224.0.0.22, IGMPv3 */
362#define INADDR_CARP_GROUP (u_int32_t)0xe0000012 /* 224.0.0.18 */
363#define INADDR_PFSYNC_GROUP (u_int32_t)0xe00000f0 /* 224.0.0.240 */
364#define INADDR_ALLMDNS_GROUP (u_int32_t)0xe00000fb /* 224.0.0.251 */
365#define INADDR_MAX_LOCAL_GROUP (u_int32_t)0xe00000ff /* 224.0.0.255 */
366
367#ifdef __APPLE__
368#define IN_LINKLOCALNETNUM (u_int32_t)0xA9FE0000 /* 169.254.0.0 */
369#define IN_LINKLOCAL(i) (((u_int32_t)(i) & IN_CLASSB_NET) == IN_LINKLOCALNETNUM)
370#define IN_LOOPBACK(i) (((u_int32_t)(i) & 0xff000000) == 0x7f000000)
371#define IN_ZERONET(i) (((u_int32_t)(i) & 0xff000000) == 0)
372
373#define IN_PRIVATE(i) ((((u_int32_t)(i) & 0xff000000) == 0x0a000000) || \
374 (((u_int32_t)(i) & 0xfff00000) == 0xac100000) || \
375 (((u_int32_t)(i) & 0xffff0000) == 0xc0a80000))
376
377#ifdef PRIVATE
378#define IN_SHARED_ADDRESS_SPACE(i) ((((u_int32_t)(i)) & (u_int32_t)0xffc00000) \
379 == (u_int32_t)0x64400000)
380
381#define IN_DS_LITE(i) ((((u_int32_t)(i)) & (u_int32_t)0xfffffff8) == (u_int32_t)0xc0000000)
382
383#define IN_6TO4_RELAY_ANYCAST(i) ((((u_int32_t)(i)) & (u_int32_t)IN_CLASSC_NET) == (u_int32_t)0xc0586300)
384#endif
385
386#define IN_LOCAL_GROUP(i) (((u_int32_t)(i) & 0xffffff00) == 0xe0000000)
387
388#define IN_ANY_LOCAL(i) (IN_LINKLOCAL(i) || IN_LOCAL_GROUP(i))
389#endif /* __APPLE__ */
390
391#define IN_LOOPBACKNET 127 /* official! */
392#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
393
394/*
395 * Socket address, internet style.
396 */
397struct sockaddr_in {
398 __uint8_t sin_len;
399 sa_family_t sin_family;
400 in_port_t sin_port;
401 struct in_addr sin_addr;
402 char sin_zero[8];
403};
404
405#define IN_ARE_ADDR_EQUAL(a, b) \
406 (bcmp(&(a)->s_addr, &(b)->s_addr, \
407 sizeof (struct in_addr)) == 0)
408
409#ifdef PRIVATE
410/*
411 * sockaddr_in with scope ID field; this is used internally to keep
412 * track of scoped route entries in the routing table. The fact that
413 * such a value is embedded in the structure is an artifact of the
414 * current implementation which could change in future.
415 */
416struct sockaddr_inifscope {
417 __uint8_t sin_len;
418 sa_family_t sin_family;
419 in_port_t sin_port;
420 struct in_addr sin_addr;
421 /*
422 * To avoid possible conflict with an overlaid sockaddr_inarp
423 * having sin_other set to SIN_PROXY, we use the first 4-bytes
424 * of sin_zero since sin_srcaddr is one of the unused fields
425 * in sockaddr_inarp.
426 */
427 union {
428 char sin_zero[8];
429 struct {
430 __uint32_t ifscope;
431 } _in_index;
432 } un;
433#define sin_scope_id un._in_index.ifscope
434};
435
436#endif /* PRIVATE */
437
438#define INET_ADDRSTRLEN 16
439
440#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
441/*
442 * Structure used to describe IP options.
443 * Used to store options internally, to pass them to a process,
444 * or to restore options retrieved earlier.
445 * The ip_dst is used for the first-hop gateway when using a source route
446 * (this gets put into the header proper).
447 */
448struct ip_opts {
449 struct in_addr ip_dst; /* first hop, 0 w/o src rt */
450 char ip_opts[40]; /* actually variable in size */
451};
452
453/*
454 * Options for use with [gs]etsockopt at the IP level.
455 * First word of comment is data type; bool is stored in int.
456 */
457#define IP_OPTIONS 1 /* buf/ip_opts; set/get IP options */
458#define IP_HDRINCL 2 /* int; header is included with data */
459#define IP_TOS 3 /* int; IP type of service and preced. */
460#define IP_TTL 4 /* int; IP time to live */
461#define IP_RECVOPTS 5 /* bool; receive all IP opts w/dgram */
462#define IP_RECVRETOPTS 6 /* bool; receive IP opts for response */
463#define IP_RECVDSTADDR 7 /* bool; receive IP dst addr w/dgram */
464#define IP_RETOPTS 8 /* ip_opts; set/get IP options */
465#define IP_MULTICAST_IF 9 /* u_char; set/get IP multicast i/f */
466#define IP_MULTICAST_TTL 10 /* u_char; set/get IP multicast ttl */
467#define IP_MULTICAST_LOOP 11 /* u_char; set/get IP multicast loopback */
468#define IP_ADD_MEMBERSHIP 12 /* ip_mreq; add an IP group membership */
469#define IP_DROP_MEMBERSHIP 13 /* ip_mreq; drop an IP group membership */
470#define IP_MULTICAST_VIF 14 /* set/get IP mcast virt. iface */
471#define IP_RSVP_ON 15 /* enable RSVP in kernel */
472#define IP_RSVP_OFF 16 /* disable RSVP in kernel */
473#define IP_RSVP_VIF_ON 17 /* set RSVP per-vif socket */
474#define IP_RSVP_VIF_OFF 18 /* unset RSVP per-vif socket */
475#define IP_PORTRANGE 19 /* int; range to choose for unspec port */
476#define IP_RECVIF 20 /* bool; receive reception if w/dgram */
477/* for IPSEC */
478#define IP_IPSEC_POLICY 21 /* int; set/get security policy */
479#define IP_FAITH 22 /* deprecated */
480#ifdef __APPLE__
481#define IP_STRIPHDR 23 /* bool: drop receive of raw IP header */
482#endif
483#define IP_RECVTTL 24 /* bool; receive reception TTL w/dgram */
484#define IP_BOUND_IF 25 /* int; set/get bound interface */
485#define IP_PKTINFO 26 /* get pktinfo on recv socket, set src on sent dgram */
486#define IP_RECVPKTINFO IP_PKTINFO /* receive pktinfo w/dgram */
487#define IP_RECVTOS 27 /* bool; receive IP TOS w/dgram */
488#define IP_DONTFRAG 28 /* don't fragment packet */
489
490#define IP_FW_ADD 40 /* add a firewall rule to chain */
491#define IP_FW_DEL 41 /* delete a firewall rule from chain */
492#define IP_FW_FLUSH 42 /* flush firewall rule chain */
493#define IP_FW_ZERO 43 /* clear single/all firewall counter(s) */
494#define IP_FW_GET 44 /* get entire firewall rule chain */
495#define IP_FW_RESETLOG 45 /* reset logging counters */
496
497/* These older firewall socket option codes are maintained for backward compatibility. */
498#define IP_OLD_FW_ADD 50 /* add a firewall rule to chain */
499#define IP_OLD_FW_DEL 51 /* delete a firewall rule from chain */
500#define IP_OLD_FW_FLUSH 52 /* flush firewall rule chain */
501#define IP_OLD_FW_ZERO 53 /* clear single/all firewall counter(s) */
502#define IP_OLD_FW_GET 54 /* get entire firewall rule chain */
503#define IP_NAT__XXX 55 /* set/get NAT opts XXX Deprecated, do not use */
504#define IP_OLD_FW_RESETLOG 56 /* reset logging counters */
505
506#define IP_DUMMYNET_CONFIGURE 60 /* add/configure a dummynet pipe */
507#define IP_DUMMYNET_DEL 61 /* delete a dummynet pipe from chain */
508#define IP_DUMMYNET_FLUSH 62 /* flush dummynet */
509#define IP_DUMMYNET_GET 64 /* get entire dummynet pipes */
510
511#define IP_TRAFFIC_MGT_BACKGROUND 65 /* int*; get background IO flags; set background IO */
512#define IP_MULTICAST_IFINDEX 66 /* int*; set/get IP multicast i/f index */
513
514/* IPv4 Source Filter Multicast API [RFC3678] */
515#define IP_ADD_SOURCE_MEMBERSHIP 70 /* join a source-specific group */
516#define IP_DROP_SOURCE_MEMBERSHIP 71 /* drop a single source */
517#define IP_BLOCK_SOURCE 72 /* block a source */
518#define IP_UNBLOCK_SOURCE 73 /* unblock a source */
519
520/* The following option is private; do not use it from user applications. */
521#define IP_MSFILTER 74 /* set/get filter list */
522
523/* Protocol Independent Multicast API [RFC3678] */
524#define MCAST_JOIN_GROUP 80 /* join an any-source group */
525#define MCAST_LEAVE_GROUP 81 /* leave all sources for group */
526#define MCAST_JOIN_SOURCE_GROUP 82 /* join a source-specific group */
527#define MCAST_LEAVE_SOURCE_GROUP 83 /* leave a single source */
528#define MCAST_BLOCK_SOURCE 84 /* block a source */
529#define MCAST_UNBLOCK_SOURCE 85 /* unblock a source */
530
531#ifdef PRIVATE
532#define IP_NO_IFT_CELLULAR 6969 /* for internal use only */
533#define IP_NO_IFT_PDP IP_NO_IFT_CELLULAR /* deprecated */
534#define IP_OUT_IF 9696 /* for internal use only */
535#endif /* PRIVATE */
536
537/*
538 * Defaults and limits for options
539 */
540#define IP_DEFAULT_MULTICAST_TTL 1 /* normally limit m'casts to 1 hop */
541#define IP_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
542
543/*
544 * The imo_membership vector for each socket is now dynamically allocated at
545 * run-time, bounded by USHRT_MAX, and is reallocated when needed, sized
546 * according to a power-of-two increment.
547 */
548#define IP_MIN_MEMBERSHIPS 31
549#define IP_MAX_MEMBERSHIPS 4095
550
551/*
552 * Default resource limits for IPv4 multicast source filtering.
553 * These may be modified by sysctl.
554 */
555#define IP_MAX_GROUP_SRC_FILTER 512 /* sources per group */
556#define IP_MAX_SOCK_SRC_FILTER 128 /* sources per socket/group */
557#define IP_MAX_SOCK_MUTE_FILTER 128 /* XXX no longer used */
558
559#ifndef PLATFORM_DriverKit
560/*
561 * Argument structure for IP_ADD_MEMBERSHIP and IP_DROP_MEMBERSHIP.
562 */
563struct ip_mreq {
564 struct in_addr imr_multiaddr; /* IP multicast address of group */
565 struct in_addr imr_interface; /* local IP address of interface */
566};
567
568/*
569 * Modified argument structure for IP_MULTICAST_IF, obtained from Linux.
570 * This is used to specify an interface index for multicast sends, as
571 * the IPv4 legacy APIs do not support this (unless IP_SENDIF is available).
572 */
573struct ip_mreqn {
574 struct in_addr imr_multiaddr; /* IP multicast address of group */
575 struct in_addr imr_address; /* local IP address of interface */
576 int imr_ifindex; /* Interface index; cast to uint32_t */
577};
578
579#pragma pack(4)
580/*
581 * Argument structure for IPv4 Multicast Source Filter APIs. [RFC3678]
582 */
583struct ip_mreq_source {
584 struct in_addr imr_multiaddr; /* IP multicast address of group */
585 struct in_addr imr_sourceaddr; /* IP address of source */
586 struct in_addr imr_interface; /* local IP address of interface */
587};
588
589/*
590 * Argument structures for Protocol-Independent Multicast Source
591 * Filter APIs. [RFC3678]
592 */
593struct group_req {
594 uint32_t gr_interface; /* interface index */
595 struct sockaddr_storage gr_group; /* group address */
596};
597
598struct group_source_req {
599 uint32_t gsr_interface; /* interface index */
600 struct sockaddr_storage gsr_group; /* group address */
601 struct sockaddr_storage gsr_source; /* source address */
602};
603
604#ifndef __MSFILTERREQ_DEFINED
605#define __MSFILTERREQ_DEFINED
606/*
607 * The following structure is private; do not use it from user applications.
608 * It is used to communicate IP_MSFILTER/IPV6_MSFILTER information between
609 * the RFC 3678 libc functions and the kernel.
610 */
611struct __msfilterreq {
612 uint32_t msfr_ifindex; /* interface index */
613 uint32_t msfr_fmode; /* filter mode for group */
614 uint32_t msfr_nsrcs; /* # of sources in msfr_srcs */
615 uint32_t __msfr_align;
616 struct sockaddr_storage msfr_group; /* group address */
617 struct sockaddr_storage *msfr_srcs;
618};
619
620#ifdef BSD_KERNEL_PRIVATE
621struct __msfilterreq32 {
622 uint32_t msfr_ifindex; /* interface index */
623 uint32_t msfr_fmode; /* filter mode for group */
624 uint32_t msfr_nsrcs; /* # of sources in msfr_srcs */
625 uint32_t __msfr_align;
626 struct sockaddr_storage msfr_group; /* group address */
627 user32_addr_t msfr_srcs;
628};
629
630struct __msfilterreq64 {
631 uint32_t msfr_ifindex; /* interface index */
632 uint32_t msfr_fmode; /* filter mode for group */
633 uint32_t msfr_nsrcs; /* # of sources in msfr_srcs */
634 uint32_t __msfr_align;
635 struct sockaddr_storage msfr_group; /* group address */
636 user64_addr_t msfr_srcs;
637};
638#endif /* BSD_KERNEL_PRIVATE */
639#endif /* __MSFILTERREQ_DEFINED */
640
641#pragma pack()
642struct sockaddr;
643
644#ifndef KERNEL
645/*
646 * Advanced (Full-state) APIs [RFC3678]
647 * The RFC specifies uint_t for the 6th argument to [sg]etsourcefilter().
648 * We use uint32_t here to be consistent.
649 */
650int setipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t,
651 uint32_t, struct in_addr *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
652int getipv4sourcefilter(int, struct in_addr, struct in_addr, uint32_t *,
653 uint32_t *, struct in_addr *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
654int setsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
655 uint32_t, uint32_t, struct sockaddr_storage *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
656int getsourcefilter(int, uint32_t, struct sockaddr *, socklen_t,
657 uint32_t *, uint32_t *, struct sockaddr_storage *) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
658#endif
659#endif /* PLATFORM_DriverKit */
660
661/*
662 * Filter modes; also used to represent per-socket filter mode internally.
663 */
664#define MCAST_UNDEFINED 0 /* fmode: not yet defined */
665#define MCAST_INCLUDE 1 /* fmode: include these source(s) */
666#define MCAST_EXCLUDE 2 /* fmode: exclude these source(s) */
667
668/*
669 * Argument for IP_PORTRANGE:
670 * - which range to search when port is unspecified at bind() or connect()
671 */
672#define IP_PORTRANGE_DEFAULT 0 /* default range */
673#define IP_PORTRANGE_HIGH 1 /* "high" - request firewall bypass */
674#define IP_PORTRANGE_LOW 2 /* "low" - vouchsafe security */
675
676
677/*
678 * IP_PKTINFO: Packet information (equivalent to RFC2292 sec 5 for IPv4)
679 * This structure is used for
680 *
681 * 1) Receiving ancilliary data about the datagram if IP_PKTINFO sockopt is
682 * set on the socket. In this case ipi_ifindex will contain the interface
683 * index the datagram was received on, ipi_addr is the IP address the
684 * datagram was received to.
685 *
686 * 2) Sending a datagram using a specific interface or IP source address.
687 * if ipi_ifindex is set to non-zero when in_pktinfo is passed as
688 * ancilliary data of type IP_PKTINFO, this will be used as the source
689 * interface to send the datagram from. If ipi_ifindex is null, ip_spec_dst
690 * will be used for the source address.
691 *
692 * Note: if IP_BOUND_IF is set on the socket, ipi_ifindex in the ancillary
693 * IP_PKTINFO option silently overrides the bound interface when it is
694 * specified during send time.
695 */
696struct in_pktinfo {
697 unsigned int ipi_ifindex; /* send/recv interface index */
698 struct in_addr ipi_spec_dst; /* Local address */
699 struct in_addr ipi_addr; /* IP Header dst address */
700};
701
702/*
703 * Definitions for inet sysctl operations.
704 *
705 * Third level is protocol number.
706 * Fourth level is desired variable within that protocol.
707 */
708#define IPPROTO_MAXID (IPPROTO_AH + 1) /* don't list to IPPROTO_MAX */
709
710#ifdef BSD_KERNEL_PRIVATE
711#define CTL_IPPROTO_NAMES { \
712 { "ip", CTLTYPE_NODE }, \
713 { "icmp", CTLTYPE_NODE }, \
714 { "igmp", CTLTYPE_NODE }, \
715 { "ggp", CTLTYPE_NODE }, \
716 { 0, 0 }, \
717 { 0, 0 }, \
718 { "tcp", CTLTYPE_NODE }, \
719 { 0, 0 }, \
720 { "egp", CTLTYPE_NODE }, \
721 { 0, 0 }, \
722 { 0, 0 }, \
723 { 0, 0 }, \
724 { "pup", CTLTYPE_NODE }, \
725 { 0, 0 }, \
726 { 0, 0 }, \
727 { 0, 0 }, \
728 { 0, 0 }, \
729 { "udp", CTLTYPE_NODE }, \
730 { 0, 0 }, \
731 { 0, 0 }, \
732 { 0, 0 }, \
733 { 0, 0 }, \
734 { "idp", CTLTYPE_NODE }, \
735 { 0, 0 }, \
736 { 0, 0 }, \
737 { 0, 0 }, \
738 { 0, 0 }, \
739 { 0, 0 }, \
740 { 0, 0 }, \
741 { 0, 0 }, \
742 { 0, 0 }, \
743 { 0, 0 }, \
744 { 0, 0 }, \
745 { 0, 0 }, \
746 { 0, 0 }, \
747 { 0, 0 }, \
748 { 0, 0 }, \
749 { 0, 0 }, \
750 { 0, 0 }, \
751 { 0, 0 }, \
752 { 0, 0 }, \
753 { 0, 0 }, \
754 { 0, 0 }, \
755 { 0, 0 }, \
756 { 0, 0 }, \
757 { 0, 0 }, \
758 { 0, 0 }, \
759 { 0, 0 }, \
760 { 0, 0 }, \
761 { 0, 0 }, \
762 { 0, 0 }, \
763 { "ipsec", CTLTYPE_NODE }, \
764}
765#endif /* BSD_KERNEL_PRIVATE */
766
767/*
768 * Names for IP sysctl objects
769 */
770#define IPCTL_FORWARDING 1 /* act as router */
771#define IPCTL_SENDREDIRECTS 2 /* may send redirects when forwarding */
772#define IPCTL_DEFTTL 3 /* default TTL */
773#ifdef notyet
774#define IPCTL_DEFMTU 4 /* default MTU */
775#endif
776#define IPCTL_RTEXPIRE 5 /* cloned route expiration time */
777#define IPCTL_RTMINEXPIRE 6 /* min value for expiration time */
778#define IPCTL_RTMAXCACHE 7 /* trigger level for dynamic expire */
779#define IPCTL_SOURCEROUTE 8 /* may perform source routes */
780#define IPCTL_DIRECTEDBROADCAST 9 /* may re-broadcast received packets */
781#define IPCTL_INTRQMAXLEN 10 /* max length of netisr queue */
782#define IPCTL_INTRQDROPS 11 /* number of netisr q drops */
783#define IPCTL_STATS 12 /* ipstat structure */
784#define IPCTL_ACCEPTSOURCEROUTE 13 /* may accept source routed packets */
785#define IPCTL_FASTFORWARDING 14 /* use fast IP forwarding code */
786#define IPCTL_KEEPFAITH 15 /* deprecated */
787#define IPCTL_GIF_TTL 16 /* default TTL for gif encap packet */
788#define IPCTL_MAXID 17
789
790#ifdef BSD_KERNEL_PRIVATE
791
792#define IPCTL_NAMES { \
793 { 0, 0 }, \
794 { "forwarding", CTLTYPE_INT }, \
795 { "redirect", CTLTYPE_INT }, \
796 { "ttl", CTLTYPE_INT }, \
797 { "mtu", CTLTYPE_INT }, \
798 { "rtexpire", CTLTYPE_INT }, \
799 { "rtminexpire", CTLTYPE_INT }, \
800 { "rtmaxcache", CTLTYPE_INT }, \
801 { "sourceroute", CTLTYPE_INT }, \
802 { "directed-broadcast", CTLTYPE_INT }, \
803 { "intr-queue-maxlen", CTLTYPE_INT }, \
804 { "intr-queue-drops", CTLTYPE_INT }, \
805 { "stats", CTLTYPE_STRUCT }, \
806 { "accept_sourceroute", CTLTYPE_INT }, \
807 { "fastforwarding", CTLTYPE_INT }, \
808 { "keepfaith", CTLTYPE_INT }, \
809 { "gifttl", CTLTYPE_INT }, \
810}
811#endif /* BSD_KERNEL_PRIVATE */
812#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
813
814/* INET6 stuff */
815#define __KAME_NETINET_IN_H_INCLUDED_
816#include <netinet6/in6.h>
817#undef __KAME_NETINET_IN_H_INCLUDED_
818
819#ifdef PRIVATE
820/*
821 * Minimal sized structure to hold an IPv4 or IPv6 socket address
822 * as sockaddr_storage can waste memory
823 */
824union sockaddr_in_4_6 {
825 struct sockaddr sa;
826 struct sockaddr_in sin;
827 struct sockaddr_in6 sin6;
828};
829#define CLAT46_HDR_EXPANSION_OVERHD (sizeof(struct ip6_hdr) - sizeof(struct ip))
830
831/*
832 * Recommended DiffServ Code Point values
833 */
834
835#define _DSCP_DF 0 /* RFC 2474 */
836
837#define _DSCP_CS0 0 /* RFC 2474 */
838#define _DSCP_CS1 8 /* RFC 2474 */
839#define _DSCP_CS2 16 /* RFC 2474 */
840#define _DSCP_CS3 24 /* RFC 2474 */
841#define _DSCP_CS4 32 /* RFC 2474 */
842#define _DSCP_CS5 40 /* RFC 2474 */
843#define _DSCP_CS6 48 /* RFC 2474 */
844#define _DSCP_CS7 56 /* RFC 2474 */
845
846#define _DSCP_EF 46 /* RFC 2474 */
847#define _DSCP_VA 44 /* RFC 5865 */
848
849#define _DSCP_AF11 10 /* RFC 2597 */
850#define _DSCP_AF12 12 /* RFC 2597 */
851#define _DSCP_AF13 14 /* RFC 2597 */
852#define _DSCP_AF21 18 /* RFC 2597 */
853#define _DSCP_AF22 20 /* RFC 2597 */
854#define _DSCP_AF23 22 /* RFC 2597 */
855#define _DSCP_AF31 26 /* RFC 2597 */
856#define _DSCP_AF32 28 /* RFC 2597 */
857#define _DSCP_AF33 30 /* RFC 2597 */
858#define _DSCP_AF41 34 /* RFC 2597 */
859#define _DSCP_AF42 36 /* RFC 2597 */
860#define _DSCP_AF43 38 /* RFC 2597 */
861
862#define _DSCP_52 52 /* Wi-Fi WMM Certification: Sigma */
863
864#define _MAX_DSCP 63 /* coded on 6 bits */
865
866#endif /* PRIVATE */
867
868#ifndef PLATFORM_DriverKit
869#ifdef KERNEL
870#ifdef BSD_KERNEL_PRIVATE
871#include <mach/boolean.h>
872
873struct ip;
874struct ifnet;
875struct mbuf;
876
877extern boolean_t in_broadcast(struct in_addr, struct ifnet *);
878extern boolean_t in_canforward(struct in_addr);
879extern u_int32_t in_netof(struct in_addr);
880
881extern uint32_t os_cpu_in_cksum_mbuf(struct mbuf *m, int len, int off,
882 uint32_t initial_sum);
883
884extern uint16_t inet_cksum(struct mbuf *, uint32_t, uint32_t, uint32_t);
885extern uint16_t inet_cksum_buffer(const void *, uint32_t, uint32_t, uint32_t);
886extern uint16_t in_addword(uint16_t, uint16_t);
887extern uint16_t in_pseudo(uint32_t, uint32_t, uint32_t);
888extern uint16_t in_pseudo64(uint64_t, uint64_t, uint64_t);
889extern uint16_t in_cksum_hdr_opt(const struct ip *);
890extern uint16_t ip_cksum_hdr_dir(struct mbuf *, uint32_t, int);
891extern uint16_t ip_cksum_hdr_dir_buffer(const void *, uint32_t, uint32_t, int);
892extern uint32_t in_finalize_cksum(struct mbuf *, uint32_t, uint32_t);
893extern uint16_t b_sum16(const void *buf, int len);
894#if DEBUG || DEVELOPMENT
895extern uint32_t in_cksum_mbuf_ref(struct mbuf *, int, int, uint32_t);
896#endif /* DEBUG || DEVELOPMENT */
897
898extern int in_getconninfo(struct socket *, sae_connid_t, uint32_t *,
899 uint32_t *, int32_t *, user_addr_t, socklen_t *, user_addr_t, socklen_t *,
900 uint32_t *, user_addr_t, uint32_t *);
901extern struct in_ifaddr * inifa_ifpwithflag(struct ifnet *, uint32_t);
902extern struct in_ifaddr * inifa_ifpclatv4(struct ifnet *);
903
904#define in_cksum(_m, _l) \
905 inet_cksum(_m, 0, 0, _l)
906#define in_cksum_buffer(_b, _l) \
907 inet_cksum_buffer(_b, 0, 0, _l)
908#define ip_cksum_hdr_in(_m, _l) \
909 ip_cksum_hdr_dir(_m, _l, 0)
910#define ip_cksum_hdr_out(_m, _l) \
911 ip_cksum_hdr_dir(_m, _l, 1)
912
913#define in_cksum_hdr(_ip) \
914 (~b_sum16(_ip, sizeof (struct ip)) & 0xffff)
915
916#define in_cksum_offset(_m, _o) \
917 ((void) in_finalize_cksum(_m, _o, CSUM_DELAY_IP))
918#define in_delayed_cksum(_m) \
919 ((void) in_finalize_cksum(_m, 0, CSUM_DELAY_DATA))
920#define in_delayed_cksum_offset(_m, _o) \
921 ((void) in_finalize_cksum(_m, _o, CSUM_DELAY_DATA))
922
923#define in_hosteq(s, t) ((s).s_addr == (t).s_addr)
924#define in_nullhost(x) ((x).s_addr == INADDR_ANY)
925#define in_allhosts(x) ((x).s_addr == htonl(INADDR_ALLHOSTS_GROUP))
926
927#define SIN(s) ((struct sockaddr_in *)(void *)s)
928#define satosin(sa) SIN(sa)
929#define sintosa(sin) ((struct sockaddr *)(void *)(sin))
930#define SINIFSCOPE(s) ((struct sockaddr_inifscope *)(void *)(s))
931
932#define IPTOS_UNSPEC (-1) /* TOS byte not set */
933#define IPTOS_MASK 0xFF /* TOS byte mask */
934#endif /* BSD_KERNEL_PRIVATE */
935
936#ifdef KERNEL_PRIVATE
937/* exported for ApplicationFirewall */
938extern int in_localaddr(struct in_addr);
939extern int inaddr_local(struct in_addr);
940
941extern char *inet_ntoa(struct in_addr);
942extern char *inet_ntoa_r(struct in_addr ina, char *buf,
943 size_t buflen);
944extern int inet_pton(int af, const char *, void *);
945#endif /* KERNEL_PRIVATE */
946
947#define MAX_IPv4_STR_LEN 16
948#define MAX_IPv6_STR_LEN 64
949
950extern int inet_aton(const char *, struct in_addr *); /* in libkern */
951extern const char *inet_ntop(int, const void *, char *, socklen_t); /* in libkern*/
952#endif /* KERNEL */
953
954#ifndef KERNEL
955#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
956__BEGIN_DECLS
957int bindresvport(int, struct sockaddr_in *);
958struct sockaddr;
959int bindresvport_sa(int, struct sockaddr *);
960__END_DECLS
961#endif
962#endif /* !KERNEL */
963#endif /* PLATFORM_DriverKit */
964#endif /* _NETINET_IN_H_ */