2 * Copyright (c) 2008-2011 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 /* $FreeBSD: src/sys/netinet6/in6.h,v 1.7.2.4 2001/07/04 09:45:23 ume Exp $ */
30 /* $KAME: in6.h,v 1.89 2001/05/27 13:28:35 itojun Exp $ */
33 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 * 3. Neither the name of the project 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.
48 * THIS SOFTWARE IS PROVIDED BY THE PROJECT 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 PROJECT 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
62 * Copyright (c) 1982, 1986, 1990, 1993
63 * The Regents of the University of California. All rights reserved.
65 * Redistribution and use in source and binary forms, with or without
66 * modification, are permitted provided that the following conditions
68 * 1. Redistributions of source code must retain the above copyright
69 * notice, this list of conditions and the following disclaimer.
70 * 2. Redistributions in binary form must reproduce the above copyright
71 * notice, this list of conditions and the following disclaimer in the
72 * documentation and/or other materials provided with the distribution.
73 * 3. All advertising materials mentioning features or use of this software
74 * must display the following acknowledgement:
75 * This product includes software developed by the University of
76 * California, Berkeley and its contributors.
77 * 4. Neither the name of the University nor the names of its contributors
78 * may be used to endorse or promote products derived from this software
79 * without specific prior written permission.
81 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
82 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
83 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
84 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
85 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
86 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
87 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
88 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
89 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
90 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
93 * @(#)in.h 8.3 (Berkeley) 1/3/94
96 #ifndef __KAME_NETINET_IN_H_INCLUDED_
97 #error "do not include netinet6/in6.h directly, include netinet/in.h. see RFC2553"
100 #ifndef _NETINET6_IN6_H_
101 #define _NETINET6_IN6_H_
102 #include <sys/appleapiopts.h>
103 #include <sys/_types.h>
108 typedef __uint8_t sa_family_t
;
112 * Identification of the network protocol stack
113 * for *BSD-current/release: http://www.kame.net/dev/cvsweb.cgi/kame/COVERAGE
114 * has the table of implementation/integration differences.
117 #define __KAME_VERSION "2009/apple-darwin"
119 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
121 * Local port number conventions:
123 * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root),
124 * unless a kernel is compiled with IPNOPRIVPORTS defined.
126 * When a user does a bind(2) or connect(2) with a port number of zero,
127 * a non-conflicting local port address is chosen.
129 * The default range is IPPORT_ANONMIN to IPPORT_ANONMAX, although
130 * that is settable by sysctl(3); net.inet.ip.anonportmin and
131 * net.inet.ip.anonportmax respectively.
133 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
134 * default assignment range.
136 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
138 * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT,
139 * and exists only for FreeBSD compatibility purposes.
141 * The value IP_PORTRANGE_LOW changes the range to the "low" are
142 * that is (by convention) restricted to privileged processes.
143 * This convention is based on "vouchsafe" principles only.
144 * It is only secure if you trust the remote host to restrict these ports.
145 * The range is IPPORT_RESERVEDMIN to IPPORT_RESERVEDMAX.
148 #define IPV6PORT_RESERVED 1024
149 #define IPV6PORT_ANONMIN 49152
150 #define IPV6PORT_ANONMAX 65535
151 #define IPV6PORT_RESERVEDMIN 600
152 #define IPV6PORT_RESERVEDMAX (IPV6PORT_RESERVED-1)
153 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
160 __uint8_t __u6_addr8
[16];
161 __uint16_t __u6_addr16
[8];
162 __uint32_t __u6_addr32
[4];
163 } __u6_addr
; /* 128-bit IP6 address */
166 #define s6_addr __u6_addr.__u6_addr8
167 #ifdef KERNEL /*XXX nonstandard*/
168 #define s6_addr8 __u6_addr.__u6_addr8
169 #define s6_addr16 __u6_addr.__u6_addr16
170 #define s6_addr32 __u6_addr.__u6_addr32
173 #define INET6_ADDRSTRLEN 46
176 * Socket address for IPv6
178 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
180 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
181 struct sockaddr_in6
{
182 __uint8_t sin6_len
; /* length of this struct(sa_family_t)*/
183 sa_family_t sin6_family
; /* AF_INET6 (sa_family_t) */
184 in_port_t sin6_port
; /* Transport layer port # (in_port_t)*/
185 __uint32_t sin6_flowinfo
; /* IP6 flow information */
186 struct in6_addr sin6_addr
; /* IP6 address */
187 __uint32_t sin6_scope_id
; /* scope zone index */
190 #ifdef KERNEL /*XXX nonstandard*/
192 * Local definition for masks
194 #define IN6MASK0 {{{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }}}
195 #define IN6MASK7 {{{ 0xfe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
196 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
197 #define IN6MASK16 {{{ 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
198 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
199 #define IN6MASK32 {{{ 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, \
200 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
201 #define IN6MASK64 {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
202 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
203 #define IN6MASK96 {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
204 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00 }}}
205 #define IN6MASK128 {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
206 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }}}
209 #ifdef KERNEL_PRIVATE
210 extern const struct sockaddr_in6 sa6_any
;
212 extern const struct in6_addr in6mask0
;
213 extern const struct in6_addr in6mask7
;
214 extern const struct in6_addr in6mask16
;
215 extern const struct in6_addr in6mask32
;
216 extern const struct in6_addr in6mask64
;
217 extern const struct in6_addr in6mask96
;
218 extern const struct in6_addr in6mask128
;
219 #endif /* KERNEL_PRIVATE */
221 #ifdef KERNEL /*XXX nonstandard*/
223 * Macros started with IPV6_ADDR is KAME local
225 #if BYTE_ORDER == BIG_ENDIAN
226 #define IPV6_ADDR_INT32_ONE 1
227 #define IPV6_ADDR_INT32_TWO 2
228 #define IPV6_ADDR_INT32_MNL 0xff010000
229 #define IPV6_ADDR_INT32_MLL 0xff020000
230 #define IPV6_ADDR_INT32_SMP 0x0000ffff
231 #define IPV6_ADDR_INT16_ULL 0xfe80
232 #define IPV6_ADDR_INT16_USL 0xfec0
233 #define IPV6_ADDR_INT16_MLL 0xff02
234 #elif BYTE_ORDER == LITTLE_ENDIAN
235 #define IPV6_ADDR_INT32_ONE 0x01000000
236 #define IPV6_ADDR_INT32_TWO 0x02000000
237 #define IPV6_ADDR_INT32_MNL 0x000001ff
238 #define IPV6_ADDR_INT32_MLL 0x000002ff
239 #define IPV6_ADDR_INT32_SMP 0xffff0000
240 #define IPV6_ADDR_INT16_ULL 0x80fe
241 #define IPV6_ADDR_INT16_USL 0xc0fe
242 #define IPV6_ADDR_INT16_MLL 0x02ff
247 * Definition of some useful macros to handle IP6 addresses
249 #define IN6ADDR_ANY_INIT \
250 {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
251 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
252 #define IN6ADDR_LOOPBACK_INIT \
253 {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
254 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
255 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
256 #define IN6ADDR_NODELOCAL_ALLNODES_INIT \
257 {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
258 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
259 #define IN6ADDR_INTFACELOCAL_ALLNODES_INIT \
260 {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
261 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
262 #define IN6ADDR_LINKLOCAL_ALLNODES_INIT \
263 {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
264 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
265 #define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT \
266 {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
267 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 }}}
268 #define IN6ADDR_LINKLOCAL_ALLV2ROUTERS_INIT \
269 {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
270 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16 }}}
271 #define IN6ADDR_V4MAPPED_INIT \
272 {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
273 0x00, 0x00, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00 }}}
274 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
276 extern const struct in6_addr in6addr_any
;
277 extern const struct in6_addr in6addr_loopback
;
278 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
279 extern const struct in6_addr in6addr_nodelocal_allnodes
;
280 extern const struct in6_addr in6addr_linklocal_allnodes
;
281 extern const struct in6_addr in6addr_linklocal_allrouters
;
282 extern const struct in6_addr in6addr_linklocal_allv2routers
;
283 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
287 * NOTE: Some of kernel programming environment (for example, openbsd/sparc)
288 * does not supply memcmp(). For userland memcmp() is preferred as it is
292 #define IN6_ARE_ADDR_EQUAL(a, b) \
293 (bcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof(struct in6_addr)) == 0)
295 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
296 #define IN6_ARE_ADDR_EQUAL(a, b) \
297 (memcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof(struct in6_addr)) == 0)
298 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
301 #ifdef KERNEL /* non standard */
302 /* see if two addresses are equal in a scope-conscious manner. */
303 #define SA6_ARE_ADDR_EQUAL(a, b) \
304 (((a)->sin6_scope_id == 0 || (b)->sin6_scope_id == 0 || \
305 ((a)->sin6_scope_id == (b)->sin6_scope_id)) && \
306 (bcmp(&(a)->sin6_addr, &(b)->sin6_addr, sizeof(struct in6_addr)) == 0))
312 #define IN6_IS_ADDR_UNSPECIFIED(a) \
313 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
314 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
315 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
316 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) == 0))
321 #define IN6_IS_ADDR_LOOPBACK(a) \
322 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
323 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
324 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
325 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) == ntohl(1)))
330 #define IN6_IS_ADDR_V4COMPAT(a) \
331 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
332 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
333 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
334 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) != 0) && \
335 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) != ntohl(1)))
340 #define IN6_IS_ADDR_V4MAPPED(a) \
341 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
342 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
343 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == ntohl(0x0000ffff)))
348 #define IN6_IS_ADDR_6TO4(x) (ntohs((x)->s6_addr16[0]) == 0x2002)
354 #ifdef KERNEL /*XXX nonstandard*/
355 #define IPV6_ADDR_SCOPE_NODELOCAL 0x01
356 #define IPV6_ADDR_SCOPE_INTFACELOCAL 0x01
357 #define IPV6_ADDR_SCOPE_LINKLOCAL 0x02
358 #define IPV6_ADDR_SCOPE_SITELOCAL 0x05
359 #define IPV6_ADDR_SCOPE_ORGLOCAL 0x08 /* just used in this file */
360 #define IPV6_ADDR_SCOPE_GLOBAL 0x0e
362 #define __IPV6_ADDR_SCOPE_NODELOCAL 0x01
363 #define __IPV6_ADDR_SCOPE_INTFACELOCAL 0x01
364 #define __IPV6_ADDR_SCOPE_LINKLOCAL 0x02
365 #define __IPV6_ADDR_SCOPE_SITELOCAL 0x05
366 #define __IPV6_ADDR_SCOPE_ORGLOCAL 0x08 /* just used in this file */
367 #define __IPV6_ADDR_SCOPE_GLOBAL 0x0e
372 * Note that we must check topmost 10 bits only, not 16 bits (see RFC2373).
374 #define IN6_IS_ADDR_LINKLOCAL(a) \
375 (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0x80))
376 #define IN6_IS_ADDR_SITELOCAL(a) \
377 (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0xc0))
382 #define IN6_IS_ADDR_MULTICAST(a) ((a)->s6_addr[0] == 0xff)
385 * Unique Local IPv6 Unicast Addresses (per RFC 4193)
387 #define IN6_IS_ADDR_UNIQUE_LOCAL(a) (((a)->s6_addr[0] == 0xfc) || ((a)->s6_addr[0] == 0xfd))
389 #ifdef KERNEL /*XXX nonstandard*/
390 #define IPV6_ADDR_MC_SCOPE(a) ((a)->s6_addr[1] & 0x0f)
392 #define __IPV6_ADDR_MC_SCOPE(a) ((a)->s6_addr[1] & 0x0f)
398 #ifdef KERNEL /*refers nonstandard items */
399 #define IN6_IS_ADDR_MC_NODELOCAL(a) \
400 (IN6_IS_ADDR_MULTICAST(a) && \
401 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_NODELOCAL))
402 #define IN6_IS_ADDR_MC_INTFACELOCAL(a) \
403 (IN6_IS_ADDR_MULTICAST(a) && \
404 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_INTFACELOCAL))
405 #define IN6_IS_ADDR_MC_LINKLOCAL(a) \
406 (IN6_IS_ADDR_MULTICAST(a) && \
407 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_LINKLOCAL))
408 #define IN6_IS_ADDR_MC_SITELOCAL(a) \
409 (IN6_IS_ADDR_MULTICAST(a) && \
410 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_SITELOCAL))
411 #define IN6_IS_ADDR_MC_ORGLOCAL(a) \
412 (IN6_IS_ADDR_MULTICAST(a) && \
413 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_ORGLOCAL))
414 #define IN6_IS_ADDR_MC_GLOBAL(a) \
415 (IN6_IS_ADDR_MULTICAST(a) && \
416 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_GLOBAL))
418 #define IN6_IS_ADDR_MC_NODELOCAL(a) \
419 (IN6_IS_ADDR_MULTICAST(a) && \
420 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_NODELOCAL))
421 #define IN6_IS_ADDR_MC_LINKLOCAL(a) \
422 (IN6_IS_ADDR_MULTICAST(a) && \
423 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_LINKLOCAL))
424 #define IN6_IS_ADDR_MC_SITELOCAL(a) \
425 (IN6_IS_ADDR_MULTICAST(a) && \
426 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_SITELOCAL))
427 #define IN6_IS_ADDR_MC_ORGLOCAL(a) \
428 (IN6_IS_ADDR_MULTICAST(a) && \
429 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_ORGLOCAL))
430 #define IN6_IS_ADDR_MC_GLOBAL(a) \
431 (IN6_IS_ADDR_MULTICAST(a) && \
432 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_GLOBAL))
435 #ifdef KERNEL /*nonstandard*/
439 #define IN6_IS_SCOPE_LINKLOCAL(a) \
440 ((IN6_IS_ADDR_LINKLOCAL(a)) || \
441 (IN6_IS_ADDR_MC_LINKLOCAL(a)))
443 #define IN6_IS_SCOPE_EMBED(a) \
444 ((IN6_IS_ADDR_LINKLOCAL(a)) || \
445 (IN6_IS_ADDR_MC_LINKLOCAL(a)) || \
446 (IN6_IS_ADDR_MC_INTFACELOCAL(a)))
448 #define IFA6_IS_DEPRECATED(a) \
449 ((a)->ia6_lifetime.ia6t_preferred != 0 && \
450 (a)->ia6_lifetime.ia6t_preferred < timenow.tv_sec)
451 #define IFA6_IS_INVALID(a) \
452 ((a)->ia6_lifetime.ia6t_expire != 0 && \
453 (a)->ia6_lifetime.ia6t_expire < timenow.tv_sec)
457 * IP6 route structure
459 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
463 * N.B: struct route_in6 must begin with ro_rt and ro_flags
464 * because the code does some casts of a 'struct route_in6 *'
465 * to a 'struct route *'.
467 struct rtentry
*ro_rt
;
468 __uint32_t ro_flags
; /* route flags */
469 struct sockaddr_in6 ro_dst
;
472 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
475 * Options for use with [gs]etsockopt at the IPV6 level.
476 * First word of comment is data type; bool is stored in int.
479 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
481 * RFC 3542 define the following socket options in a manner incompatible
490 * To use the new IPv6 Sockets options introduced by RFC 3542
491 * the constant __APPLE_USE_RFC_3542 must be defined before
492 * including <netinet/in.h>
494 * To use the old IPv6 Sockets options from RFC 2292
495 * the constant __APPLE_USE_RFC_2292 must be defined before
496 * including <netinet/in.h>
498 * Note that eventually RFC 3542 is going to be the
499 * default and RFC 2292 will be obsolete.
501 #ifdef XNU_KERNEL_PRIVATE
502 #define __APPLE_USE_RFC_3542 1
503 #endif /* XNU_KERNEL_PRIVATE */
505 #if defined(__APPLE_USE_RFC_3542) && defined(__APPLE_USE_RFC_2292)
506 #error "__APPLE_USE_RFC_3542 and __APPLE_USE_RFC_2292 cannot be both defined"
509 #if 0 /* the followings are relic in IPv4 and hence are disabled */
510 #define IPV6_OPTIONS 1 /* buf/ip6_opts; set/get IP6 options */
511 #define IPV6_RECVOPTS 5 /* bool; receive all IP6 opts w/dgram */
512 #define IPV6_RECVRETOPTS 6 /* bool; receive IP6 opts for response */
513 #define IPV6_RECVDSTADDR 7 /* bool; receive IP6 dst addr w/dgram */
514 #define IPV6_RETOPTS 8 /* ip6_opts; set/get IP6 options */
516 #define IPV6_SOCKOPT_RESERVED1 3 /* reserved for future use */
517 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
518 #define IPV6_UNICAST_HOPS 4 /* int; IP6 hops */
519 #define IPV6_MULTICAST_IF 9 /* __uint8_t; set/get IP6 multicast i/f */
520 #define IPV6_MULTICAST_HOPS 10 /* __uint8_t; set/get IP6 multicast hops */
521 #define IPV6_MULTICAST_LOOP 11 /* __uint8_t; set/get IP6 mcast loopback */
522 #define IPV6_JOIN_GROUP 12 /* ip6_mreq; join a group membership */
523 #define IPV6_LEAVE_GROUP 13 /* ip6_mreq; leave a group membership */
525 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
526 #define IPV6_PORTRANGE 14 /* int; range to choose for unspec port */
527 #define ICMP6_FILTER 18 /* icmp6_filter; icmp6 filter */
528 #define IPV6_2292PKTINFO 19 /* bool; send/recv if, src/dst addr */
529 #define IPV6_2292HOPLIMIT 20 /* bool; hop limit */
530 #define IPV6_2292NEXTHOP 21 /* bool; next hop addr */
531 #define IPV6_2292HOPOPTS 22 /* bool; hop-by-hop option */
532 #define IPV6_2292DSTOPTS 23 /* bool; destinaion option */
533 #define IPV6_2292RTHDR 24 /* ip6_rthdr: routing header */
534 #define IPV6_2292PKTOPTIONS 25 /* buf/cmsghdr; set/get IPv6 options */
535 /* obsoleted by RFC3542 */
537 #ifdef __APPLE_USE_RFC_2292
538 #define IPV6_PKTINFO IPV6_2292PKTINFO
539 #define IPV6_HOPLIMIT IPV6_2292HOPLIMIT
540 #define IPV6_NEXTHOP IPV6_2292NEXTHOP
541 #define IPV6_HOPOPTS IPV6_2292HOPOPTS
542 #define IPV6_DSTOPTS IPV6_2292DSTOPTS
543 #define IPV6_RTHDR IPV6_2292RTHDR
544 #define IPV6_PKTOPTIONS IPV6_2292PKTOPTIONS
545 #endif /* __APPLE_USE_RFC_2292 */
547 #define IPV6_CHECKSUM 26 /* int; checksum offset for raw socket */
548 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
549 #define IPV6_V6ONLY 27 /* bool; only bind INET6 at wildcard bind */
550 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
552 #define IPV6_BINDV6ONLY IPV6_V6ONLY
557 #define IPV6_IPSEC_POLICY 28 /* struct; get/set security policy */
559 #define IPV6_FAITH 29 /* bool; accept FAITH'ed connections */
561 #if 1 /*IPV6FIREWALL*/
562 #define IPV6_FW_ADD 30 /* add a firewall rule to chain */
563 #define IPV6_FW_DEL 31 /* delete a firewall rule from chain */
564 #define IPV6_FW_FLUSH 32 /* flush firewall rule chain */
565 #define IPV6_FW_ZERO 33 /* clear single/all firewall counter(s) */
566 #define IPV6_FW_GET 34 /* get entire firewall rule chain */
569 /* APPLE: NOTE the value of those 2 options is kept unchanged from
570 * previous version of darwin/OS X for binary compatibility reasons
571 * and differ from FreeBSD (values 57 and 61). See below.
573 #define IPV6_RECVTCLASS 35 /* bool; recv traffic class values */
574 #define IPV6_TCLASS 36 /* int; send traffic class value */
576 #ifdef __APPLE_USE_RFC_3542
577 /* new socket options introduced in RFC3542 */
578 #define IPV6_RTHDRDSTOPTS 57 /* ip6_dest; send dst option before rthdr
579 * APPLE: Value purposely different than FreeBSD (35) to avoid
580 * collision with definition of IPV6_RECVTCLASS in previous
581 * darwin implementations */
583 #define IPV6_RECVPKTINFO 61 /* bool; recv if, dst addr
584 * APPLE: Value purposely different than FreeBSD (36) to avoid
585 * collision with definition of IPV6_TCLASS in previous
586 * darwin implementations */
588 #define IPV6_RECVHOPLIMIT 37 /* bool; recv hop limit */
589 #define IPV6_RECVRTHDR 38 /* bool; recv routing header */
590 #define IPV6_RECVHOPOPTS 39 /* bool; recv hop-by-hop option */
591 #define IPV6_RECVDSTOPTS 40 /* bool; recv dst option after rthdr */
593 #define IPV6_RECVRTHDRDSTOPTS 41 /* bool; recv dst option before rthdr */
596 #define IPV6_USE_MIN_MTU 42 /* bool; send packets at the minimum MTU */
597 #define IPV6_RECVPATHMTU 43 /* bool; notify an according MTU */
599 #define IPV6_PATHMTU 44 /* mtuinfo; get the current path MTU (sopt),
600 4 bytes int; MTU notification (cmsg) */
601 #if 0 /*obsoleted during 2292bis -> 3542*/
602 #define IPV6_REACHCONF 45 /* no data; ND reachability confirm
603 (cmsg only/not in of RFC3542) */
605 /* more new socket options introduced in RFC3542 */
606 #define IPV6_3542PKTINFO 46 /* in6_pktinfo; send if, src addr */
607 #define IPV6_3542HOPLIMIT 47 /* int; send hop limit */
608 #define IPV6_3542NEXTHOP 48 /* sockaddr; next hop addr */
609 #define IPV6_3542HOPOPTS 49 /* ip6_hbh; send hop-by-hop option */
610 #define IPV6_3542DSTOPTS 50 /* ip6_dest; send dst option befor rthdr */
611 #define IPV6_3542RTHDR 51 /* ip6_rthdr; send routing header */
613 #define IPV6_PKTINFO IPV6_3542PKTINFO
614 #define IPV6_HOPLIMIT IPV6_3542HOPLIMIT
615 #define IPV6_NEXTHOP IPV6_3542NEXTHOP
616 #define IPV6_HOPOPTS IPV6_3542HOPOPTS
617 #define IPV6_DSTOPTS IPV6_3542DSTOPTS
618 #define IPV6_RTHDR IPV6_3542RTHDR
620 #define IPV6_AUTOFLOWLABEL 59 /* bool; attach flowlabel automagically */
622 #define IPV6_DONTFRAG 62 /* bool; disable IPv6 fragmentation */
624 #define IPV6_PREFER_TEMPADDR 63 /* int; prefer temporary addresses as
625 * the source address.
629 * The following option is private; do not use it from user applications.
630 * It is deliberately defined to the same value as IP_MSFILTER.
632 #define IPV6_MSFILTER 74 /* struct __msfilterreq;
633 * set/get multicast source filter list.
635 #endif /* __APPLE_USE_RFC_3542 */
637 #define IPV6_BOUND_IF 125 /* int; set/get bound interface */
640 #define IPV6_NO_IFT_CELLULAR 6969 /* for internal use only */
641 #define IPV6_OUT_IF 9696 /* for internal use only */
644 /* to define items, should talk with KAME guys first, for *BSD compatibility */
646 #define IPV6_RTHDR_LOOSE 0 /* this hop need not be a neighbor. XXX old spec */
647 #define IPV6_RTHDR_STRICT 1 /* this hop must be a neighbor. XXX old spec */
648 #define IPV6_RTHDR_TYPE_0 0 /* IPv6 routing header type 0 */
651 * Defaults and limits for options
653 #define IPV6_DEFAULT_MULTICAST_HOPS 1 /* normally limit m'casts to 1 hop */
654 #define IPV6_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
657 * The im6o_membership vector for each socket is now dynamically allocated at
658 * run-time, bounded by USHRT_MAX, and is reallocated when needed, sized
659 * according to a power-of-two increment.
661 #define IPV6_MIN_MEMBERSHIPS 31
662 #define IPV6_MAX_MEMBERSHIPS 4095
665 * Default resource limits for IPv6 multicast source filtering.
666 * These may be modified by sysctl.
668 #define IPV6_MAX_GROUP_SRC_FILTER 512 /* sources per group */
669 #define IPV6_MAX_SOCK_SRC_FILTER 128 /* sources per socket/group */
672 * Argument structure for IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP.
675 struct in6_addr ipv6mr_multiaddr
;
676 unsigned int ipv6mr_interface
;
680 * IPV6_2292PKTINFO: Packet information(RFC2292 sec 5)
683 struct in6_addr ipi6_addr
; /* src/dst IPv6 address */
684 unsigned int ipi6_ifindex
; /* send/recv interface index */
688 * Control structure for IPV6_RECVPATHMTU socket option.
691 struct sockaddr_in6 ip6m_addr
; /* or sockaddr_storage? */
696 * Argument for IPV6_PORTRANGE:
697 * - which range to search when port is unspecified at bind() or connect()
699 #define IPV6_PORTRANGE_DEFAULT 0 /* default range */
700 #define IPV6_PORTRANGE_HIGH 1 /* "high" - request firewall bypass */
701 #define IPV6_PORTRANGE_LOW 2 /* "low" - vouchsafe security */
704 * Definitions for inet6 sysctl operations.
706 * Third level is protocol number.
707 * Fourth level is desired variable within that protocol.
709 #define IPV6PROTO_MAXID (IPPROTO_PIM + 1) /* don't list to IPV6PROTO_MAX */
712 * Names for IP sysctl objects
714 #define IPV6CTL_FORWARDING 1 /* act as router */
715 #define IPV6CTL_SENDREDIRECTS 2 /* may send redirects when forwarding*/
716 #define IPV6CTL_DEFHLIM 3 /* default Hop-Limit */
718 #define IPV6CTL_DEFMTU 4 /* default MTU */
720 #define IPV6CTL_FORWSRCRT 5 /* forward source-routed dgrams */
721 #define IPV6CTL_STATS 6 /* stats */
722 #define IPV6CTL_MRTSTATS 7 /* multicast forwarding stats */
723 #define IPV6CTL_MRTPROTO 8 /* multicast routing protocol */
724 #define IPV6CTL_MAXFRAGPACKETS 9 /* max packets reassembly queue */
725 #define IPV6CTL_SOURCECHECK 10 /* verify source route and intf */
726 #define IPV6CTL_SOURCECHECK_LOGINT 11 /* minimume logging interval */
727 #define IPV6CTL_ACCEPT_RTADV 12
728 #define IPV6CTL_KEEPFAITH 13
729 #define IPV6CTL_LOG_INTERVAL 14
730 #define IPV6CTL_HDRNESTLIMIT 15
731 #define IPV6CTL_DAD_COUNT 16
732 #define IPV6CTL_AUTO_FLOWLABEL 17
733 #define IPV6CTL_DEFMCASTHLIM 18
734 #define IPV6CTL_GIF_HLIM 19 /* default HLIM for gif encap packet */
735 #define IPV6CTL_KAME_VERSION 20
736 #define IPV6CTL_USE_DEPRECATED 21 /* use deprecated addr (RFC2462 5.5.4) */
737 #define IPV6CTL_RR_PRUNE 22 /* walk timer for router renumbering */
739 #define IPV6CTL_MAPPED_ADDR 23
741 #define IPV6CTL_V6ONLY 24
742 #define IPV6CTL_RTEXPIRE 25 /* cloned route expiration time */
743 #define IPV6CTL_RTMINEXPIRE 26 /* min value for expiration time */
744 #define IPV6CTL_RTMAXCACHE 27 /* trigger level for dynamic expire */
746 #define IPV6CTL_USETEMPADDR 32 /* use temporary addresses [RFC 4941] */
747 #define IPV6CTL_TEMPPLTIME 33 /* preferred lifetime for tmpaddrs */
748 #define IPV6CTL_TEMPVLTIME 34 /* valid lifetime for tmpaddrs */
749 #define IPV6CTL_AUTO_LINKLOCAL 35 /* automatic link-local addr assign */
750 #define IPV6CTL_RIP6STATS 36 /* raw_ip6 stats */
751 #define IPV6CTL_PREFER_TEMPADDR 37 /* prefer temporary addr as src */
752 #define IPV6CTL_ADDRCTLPOLICY 38 /* get/set address selection policy */
753 #define IPV6CTL_USE_DEFAULTZONE 39 /* use default scope zone */
755 #define IPV6CTL_MAXFRAGS 41 /* max fragments */
756 #define IPV6CTL_MCAST_PMTU 44 /* enable pMTU discovery for multicast? */
758 #define IPV6CTL_NEIGHBORGCTHRESH 46
759 #define IPV6CTL_MAXIFPREFIXES 47
760 #define IPV6CTL_MAXIFDEFROUTERS 48
761 #define IPV6CTL_MAXDYNROUTES 49
762 #define ICMPV6CTL_ND6_ONLINKNSRFC4861 50
764 /* New entries should be added here from current IPV6CTL_MAXID value. */
765 /* to define items, should talk with KAME guys first, for *BSD compatibility */
766 #define IPV6CTL_MAXID 51
768 #ifdef KERNEL_PRIVATE
769 #define CTL_IPV6PROTO_NAMES { \
770 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
772 { "tcp6", CTLTYPE_NODE }, \
776 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
779 { "udp6", CTLTYPE_NODE }, \
782 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
783 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
784 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
785 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
787 { "ip6", CTLTYPE_NODE }, \
791 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
793 { "ipsec6", CTLTYPE_NODE }, \
800 { "icmp6", CTLTYPE_NODE }, \
802 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
803 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
804 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
805 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
806 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
807 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
808 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
809 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
813 { "pim6", CTLTYPE_NODE }, \
816 * Redefinition of mbuf flags
818 #define M_AUTHIPHDR M_PROTO2
819 #define M_DECRYPTED M_PROTO3
820 #define M_AUTHIPDGM M_PROTO5
827 #define in6_cksum(m, n, o, l) inet6_cksum(m, n, o, l)
829 extern u_int16_t
inet6_cksum(struct mbuf
*m
, unsigned int proto
,
830 unsigned int offset
, unsigned int transport_len
);
832 extern int in6_localaddr(struct in6_addr
*);
833 extern int in6_addrscope(struct in6_addr
*);
834 extern struct in6_ifaddr
*in6_ifawithscope(struct ifnet
*, struct in6_addr
*);
835 extern struct in6_ifaddr
*in6_ifawithifp(struct ifnet
*, struct in6_addr
*);
836 extern int in6_if_up(struct ifnet
*, struct in6_aliasreq
*);
839 extern void in6_sin6_2_sin(struct sockaddr_in
*sin
, struct sockaddr_in6
*sin6
);
840 extern void in6_sin_2_v4mapsin6(struct sockaddr_in
*sin
,
841 struct sockaddr_in6
*sin6
);
842 extern void in6_sin6_2_sin_in_sock(struct sockaddr
*nam
);
843 extern int in6_sin_2_v4mapsin6_in_sock(struct sockaddr
**nam
);
844 extern void in6_delayed_cksum(struct mbuf
*, u_int16_t
);
846 #define satosin6(sa) ((struct sockaddr_in6 *)(sa))
847 #define sin6tosa(sin6) ((struct sockaddr *)(sin6))
848 #define ifatoia6(ifa) ((struct in6_ifaddr *)(ifa))
850 extern int in6addr_local(struct in6_addr
*);
852 #define DEBUG_HWCKSUM 1 /* IPv6 Hardware checksum on/off */
856 * Compute significant parts of the IPv6 checksum pseudo-header
857 * for use in a delayed TCP/UDP checksum calculation.
861 * src Source IPv6 address
862 * dst Destination IPv6 address
863 * len htonl(proto-hdr-len)
864 * nxt htonl(next-proto-number)
866 * NOTE: We expect the src and dst addresses to be 16-bit
869 static __inline u_int16_t __unused
870 in6_cksum_phdr(const struct in6_addr
*src
, const struct in6_addr
*dst
,
871 u_int32_t len
, u_int32_t nxt
)
877 w
= (const u_int16_t
*) src
;
879 if (!IN6_IS_SCOPE_LINKLOCAL(src
))
881 sum
+= w
[2]; sum
+= w
[3]; sum
+= w
[4]; sum
+= w
[5];
882 sum
+= w
[6]; sum
+= w
[7];
885 w
= (const u_int16_t
*) dst
;
887 if (!IN6_IS_SCOPE_LINKLOCAL(dst
))
889 sum
+= w
[2]; sum
+= w
[3]; sum
+= w
[4]; sum
+= w
[5];
890 sum
+= w
[6]; sum
+= w
[7];
892 sum
+= (u_int16_t
)(len
>> 16) + (u_int16_t
)(len
/*& 0xffff*/);
894 sum
+= (u_int16_t
)(nxt
>> 16) + (u_int16_t
)(nxt
/*& 0xffff*/);
896 sum
= (u_int16_t
)(sum
>> 16) + (u_int16_t
)(sum
/*& 0xffff*/);
903 #endif /* KERNEL_PRIVATE */
909 extern int inet6_option_space(int);
910 extern int inet6_option_init(void *, struct cmsghdr
**, int);
911 extern int inet6_option_append(struct cmsghdr
*, const __uint8_t
*,
913 extern __uint8_t
*inet6_option_alloc(struct cmsghdr
*, int, int, int);
914 extern int inet6_option_next(const struct cmsghdr
*, __uint8_t
**);
915 extern int inet6_option_find(const struct cmsghdr
*, __uint8_t
**, int);
917 extern size_t inet6_rthdr_space(int, int);
918 extern struct cmsghdr
*inet6_rthdr_init(void *, int);
919 extern int inet6_rthdr_add(struct cmsghdr
*, const struct in6_addr
*,
921 extern int inet6_rthdr_lasthop(struct cmsghdr
*, unsigned int);
922 #if 0 /* not implemented yet */
923 extern int inet6_rthdr_reverse(const struct cmsghdr
*, struct cmsghdr
*);
925 extern int inet6_rthdr_segments(const struct cmsghdr
*);
926 extern struct in6_addr
*inet6_rthdr_getaddr(struct cmsghdr
*, int);
927 extern int inet6_rthdr_getflags(const struct cmsghdr
*, int);
929 extern int inet6_opt_init(void *, socklen_t
);
930 extern int inet6_opt_append(void *, socklen_t
, int, __uint8_t
,
931 socklen_t
, __uint8_t
, void **);
932 extern int inet6_opt_finish(void *, socklen_t
, int);
933 extern int inet6_opt_set_val(void *, int, void *, socklen_t
);
935 extern int inet6_opt_next(void *, socklen_t
, int, __uint8_t
*,
936 socklen_t
*, void **);
937 extern int inet6_opt_find(void *, socklen_t
, int, __uint8_t
,
938 socklen_t
*, void **);
939 extern int inet6_opt_get_val(void *, int, void *, socklen_t
);
940 extern socklen_t
inet6_rth_space(int, int);
941 extern void *inet6_rth_init(void *, socklen_t
, int, int);
942 extern int inet6_rth_add(void *, const struct in6_addr
*);
943 extern int inet6_rth_reverse(const void *, void *);
944 extern int inet6_rth_segments(const void *);
945 extern struct in6_addr
*inet6_rth_getaddr(const void *, int);
946 extern void addrsel_policy_init(void);
949 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
950 #endif /* !_NETINET6_IN6_H_ */