]> git.saurik.com Git - apple/xnu.git/blame - bsd/netinet6/in6.h
xnu-1504.15.3.tar.gz
[apple/xnu.git] / bsd / netinet6 / in6.h
CommitLineData
b0d623f7
A
1/*
2 * Copyright (c) 2008 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
9bccf70c
A
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 $ */
1c79356b
A
31
32/*
33 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
34 * All rights reserved.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
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.
47 *
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
58 * SUCH DAMAGE.
59 */
60
61/*
62 * Copyright (c) 1982, 1986, 1990, 1993
63 * The Regents of the University of California. All rights reserved.
64 *
65 * Redistribution and use in source and binary forms, with or without
66 * modification, are permitted provided that the following conditions
67 * are met:
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.
80 *
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
91 * SUCH DAMAGE.
92 *
93 * @(#)in.h 8.3 (Berkeley) 1/3/94
94 */
95
96#ifndef __KAME_NETINET_IN_H_INCLUDED_
9bccf70c 97#error "do not include netinet6/in6.h directly, include netinet/in.h. see RFC2553"
1c79356b
A
98#endif
99
100#ifndef _NETINET6_IN6_H_
101#define _NETINET6_IN6_H_
9bccf70c 102#include <sys/appleapiopts.h>
91447636
A
103#include <sys/_types.h>
104
105
106#ifndef _SA_FAMILY_T
107#define _SA_FAMILY_T
108typedef __uint8_t sa_family_t;
109#endif
1c79356b
A
110
111/*
112 * Identification of the network protocol stack
9bccf70c
A
113 * for *BSD-current/release: http://www.kame.net/dev/cvsweb.cgi/kame/COVERAGE
114 * has the table of implementation/integration differences.
1c79356b
A
115 */
116#define __KAME__
9bccf70c 117#define __KAME_VERSION "20010528/apple-darwin"
1c79356b 118
2d21ac55 119#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
120/*
121 * Local port number conventions:
122 *
123 * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root),
124 * unless a kernel is compiled with IPNOPRIVPORTS defined.
125 *
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.
128 *
9bccf70c 129 * The default range is IPPORT_ANONMIN to IPPORT_ANONMAX, although
1c79356b
A
130 * that is settable by sysctl(3); net.inet.ip.anonportmin and
131 * net.inet.ip.anonportmax respectively.
132 *
133 * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
134 * default assignment range.
135 *
136 * The value IP_PORTRANGE_DEFAULT causes the default behavior.
137 *
138 * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT,
139 * and exists only for FreeBSD compatibility purposes.
140 *
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.
146 */
147
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)
2d21ac55 153#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b
A
154
155/*
156 * IPv6 address
157 */
158struct in6_addr {
159 union {
91447636
A
160 __uint8_t __u6_addr8[16];
161 __uint16_t __u6_addr16[8];
162 __uint32_t __u6_addr32[4];
1c79356b
A
163 } __u6_addr; /* 128-bit IP6 address */
164};
165
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
171#endif
172
173#define INET6_ADDRSTRLEN 46
174
175/*
176 * Socket address for IPv6
177 */
2d21ac55 178#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b 179#define SIN6_LEN
2d21ac55 180#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b 181struct sockaddr_in6 {
91447636
A
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 */
1c79356b 186 struct in6_addr sin6_addr; /* IP6 address */
91447636 187 __uint32_t sin6_scope_id; /* scope zone index */
1c79356b
A
188};
189
b0d623f7 190#ifdef KERNEL /*XXX nonstandard*/
1c79356b
A
191/*
192 * Local definition for masks
193 */
1c79356b
A
194#define IN6MASK0 {{{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }}}
195#define IN6MASK32 {{{ 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, \
196 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
197#define IN6MASK64 {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
198 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
199#define IN6MASK96 {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
200 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00 }}}
201#define IN6MASK128 {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
202 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }}}
203#endif
204
91447636 205#ifdef KERNEL_PRIVATE
9bccf70c
A
206extern const struct sockaddr_in6 sa6_any;
207
1c79356b
A
208extern const struct in6_addr in6mask0;
209extern const struct in6_addr in6mask32;
210extern const struct in6_addr in6mask64;
211extern const struct in6_addr in6mask96;
212extern const struct in6_addr in6mask128;
0c530ab8
A
213#endif /* KERNEL_PRIVATE */
214
b0d623f7 215#ifdef KERNEL /*XXX nonstandard*/
1c79356b
A
216/*
217 * Macros started with IPV6_ADDR is KAME local
218 */
1c79356b
A
219#if BYTE_ORDER == BIG_ENDIAN
220#define IPV6_ADDR_INT32_ONE 1
221#define IPV6_ADDR_INT32_TWO 2
222#define IPV6_ADDR_INT32_MNL 0xff010000
223#define IPV6_ADDR_INT32_MLL 0xff020000
224#define IPV6_ADDR_INT32_SMP 0x0000ffff
225#define IPV6_ADDR_INT16_ULL 0xfe80
226#define IPV6_ADDR_INT16_USL 0xfec0
227#define IPV6_ADDR_INT16_MLL 0xff02
228#elif BYTE_ORDER == LITTLE_ENDIAN
229#define IPV6_ADDR_INT32_ONE 0x01000000
230#define IPV6_ADDR_INT32_TWO 0x02000000
231#define IPV6_ADDR_INT32_MNL 0x000001ff
232#define IPV6_ADDR_INT32_MLL 0x000002ff
233#define IPV6_ADDR_INT32_SMP 0xffff0000
234#define IPV6_ADDR_INT16_ULL 0x80fe
235#define IPV6_ADDR_INT16_USL 0xc0fe
236#define IPV6_ADDR_INT16_MLL 0x02ff
237#endif
238#endif
239
240/*
241 * Definition of some useful macros to handle IP6 addresses
242 */
243#define IN6ADDR_ANY_INIT \
244 {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
245 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
246#define IN6ADDR_LOOPBACK_INIT \
247 {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
248 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
2d21ac55 249#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
250#define IN6ADDR_NODELOCAL_ALLNODES_INIT \
251 {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
252 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
253#define IN6ADDR_LINKLOCAL_ALLNODES_INIT \
254 {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
255 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
256#define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT \
257 {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
258 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 }}}
2d21ac55 259#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b 260
1c79356b
A
261extern const struct in6_addr in6addr_any;
262extern const struct in6_addr in6addr_loopback;
2d21ac55 263#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
264extern const struct in6_addr in6addr_nodelocal_allnodes;
265extern const struct in6_addr in6addr_linklocal_allnodes;
266extern const struct in6_addr in6addr_linklocal_allrouters;
2d21ac55 267#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b
A
268
269/*
270 * Equality
271 * NOTE: Some of kernel programming environment (for example, openbsd/sparc)
272 * does not supply memcmp(). For userland memcmp() is preferred as it is
273 * in ANSI standard.
274 */
275#ifdef KERNEL
276#define IN6_ARE_ADDR_EQUAL(a, b) \
9bccf70c 277 (bcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof(struct in6_addr)) == 0)
1c79356b 278#else
2d21ac55 279#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b 280#define IN6_ARE_ADDR_EQUAL(a, b) \
9bccf70c 281 (memcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof(struct in6_addr)) == 0)
2d21ac55 282#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
9bccf70c
A
283#endif
284
285#ifdef KERNEL /* non standard */
286/* see if two addresses are equal in a scope-conscious manner. */
287#define SA6_ARE_ADDR_EQUAL(a, b) \
288 (((a)->sin6_scope_id == 0 || (b)->sin6_scope_id == 0 || \
289 ((a)->sin6_scope_id == (b)->sin6_scope_id)) && \
290 (bcmp(&(a)->sin6_addr, &(b)->sin6_addr, sizeof(struct in6_addr)) == 0))
1c79356b
A
291#endif
292
293/*
294 * Unspecified
295 */
296#define IN6_IS_ADDR_UNSPECIFIED(a) \
91447636
A
297 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
298 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
299 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
300 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) == 0))
1c79356b
A
301
302/*
303 * Loopback
304 */
305#define IN6_IS_ADDR_LOOPBACK(a) \
91447636
A
306 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
307 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
308 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
309 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) == ntohl(1)))
1c79356b
A
310
311/*
312 * IPv4 compatible
313 */
314#define IN6_IS_ADDR_V4COMPAT(a) \
91447636
A
315 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
316 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
317 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == 0) && \
318 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) != 0) && \
319 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[12]) != ntohl(1)))
1c79356b
A
320
321/*
322 * Mapped
323 */
324#define IN6_IS_ADDR_V4MAPPED(a) \
91447636
A
325 ((*(const __uint32_t *)(const void *)(&(a)->s6_addr[0]) == 0) && \
326 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[4]) == 0) && \
327 (*(const __uint32_t *)(const void *)(&(a)->s6_addr[8]) == ntohl(0x0000ffff)))
1c79356b
A
328
329/*
330 * KAME Scope Values
331 */
332
333#ifdef KERNEL /*XXX nonstandard*/
334#define IPV6_ADDR_SCOPE_NODELOCAL 0x01
b0d623f7 335#define IPV6_ADDR_SCOPE_INTFACELOCAL 0x01
1c79356b
A
336#define IPV6_ADDR_SCOPE_LINKLOCAL 0x02
337#define IPV6_ADDR_SCOPE_SITELOCAL 0x05
338#define IPV6_ADDR_SCOPE_ORGLOCAL 0x08 /* just used in this file */
339#define IPV6_ADDR_SCOPE_GLOBAL 0x0e
340#else
341#define __IPV6_ADDR_SCOPE_NODELOCAL 0x01
342#define __IPV6_ADDR_SCOPE_LINKLOCAL 0x02
343#define __IPV6_ADDR_SCOPE_SITELOCAL 0x05
344#define __IPV6_ADDR_SCOPE_ORGLOCAL 0x08 /* just used in this file */
345#define __IPV6_ADDR_SCOPE_GLOBAL 0x0e
346#endif
347
348/*
349 * Unicast Scope
350 * Note that we must check topmost 10 bits only, not 16 bits (see RFC2373).
351 */
352#define IN6_IS_ADDR_LINKLOCAL(a) \
353 (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0x80))
354#define IN6_IS_ADDR_SITELOCAL(a) \
355 (((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0xc0))
356
357/*
358 * Multicast
359 */
360#define IN6_IS_ADDR_MULTICAST(a) ((a)->s6_addr[0] == 0xff)
361
362#ifdef KERNEL /*XXX nonstandard*/
363#define IPV6_ADDR_MC_SCOPE(a) ((a)->s6_addr[1] & 0x0f)
364#else
365#define __IPV6_ADDR_MC_SCOPE(a) ((a)->s6_addr[1] & 0x0f)
366#endif
367
368/*
369 * Multicast Scope
370 */
371#ifdef KERNEL /*refers nonstandard items */
372#define IN6_IS_ADDR_MC_NODELOCAL(a) \
373 (IN6_IS_ADDR_MULTICAST(a) && \
374 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_NODELOCAL))
b0d623f7
A
375#define IN6_IS_ADDR_MC_INTFACELOCAL(a) \
376 (IN6_IS_ADDR_MULTICAST(a) && \
377 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_INTFACELOCAL))
1c79356b
A
378#define IN6_IS_ADDR_MC_LINKLOCAL(a) \
379 (IN6_IS_ADDR_MULTICAST(a) && \
380 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_LINKLOCAL))
381#define IN6_IS_ADDR_MC_SITELOCAL(a) \
382 (IN6_IS_ADDR_MULTICAST(a) && \
383 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_SITELOCAL))
384#define IN6_IS_ADDR_MC_ORGLOCAL(a) \
385 (IN6_IS_ADDR_MULTICAST(a) && \
386 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_ORGLOCAL))
387#define IN6_IS_ADDR_MC_GLOBAL(a) \
388 (IN6_IS_ADDR_MULTICAST(a) && \
389 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_GLOBAL))
390#else
391#define IN6_IS_ADDR_MC_NODELOCAL(a) \
392 (IN6_IS_ADDR_MULTICAST(a) && \
393 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_NODELOCAL))
394#define IN6_IS_ADDR_MC_LINKLOCAL(a) \
395 (IN6_IS_ADDR_MULTICAST(a) && \
396 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_LINKLOCAL))
397#define IN6_IS_ADDR_MC_SITELOCAL(a) \
398 (IN6_IS_ADDR_MULTICAST(a) && \
399 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_SITELOCAL))
400#define IN6_IS_ADDR_MC_ORGLOCAL(a) \
401 (IN6_IS_ADDR_MULTICAST(a) && \
402 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_ORGLOCAL))
403#define IN6_IS_ADDR_MC_GLOBAL(a) \
404 (IN6_IS_ADDR_MULTICAST(a) && \
405 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_GLOBAL))
406#endif
407
9bccf70c 408#ifdef KERNEL /*nonstandard*/
1c79356b
A
409/*
410 * KAME Scope
411 */
1c79356b
A
412#define IN6_IS_SCOPE_LINKLOCAL(a) \
413 ((IN6_IS_ADDR_LINKLOCAL(a)) || \
414 (IN6_IS_ADDR_MC_LINKLOCAL(a)))
9bccf70c 415
b0d623f7
A
416#define IN6_IS_SCOPE_EMBED(a) \
417 ((IN6_IS_ADDR_LINKLOCAL(a)) || \
418 (IN6_IS_ADDR_MC_LINKLOCAL(a)) || \
419 (IN6_IS_ADDR_MC_INTFACELOCAL(a)))
420
9bccf70c
A
421#define IFA6_IS_DEPRECATED(a) \
422 ((a)->ia6_lifetime.ia6t_preferred != 0 && \
91447636 423 (a)->ia6_lifetime.ia6t_preferred < timenow.tv_sec)
9bccf70c
A
424#define IFA6_IS_INVALID(a) \
425 ((a)->ia6_lifetime.ia6t_expire != 0 && \
91447636
A
426 (a)->ia6_lifetime.ia6t_expire < timenow.tv_sec)
427#endif /* KERNEL */
1c79356b
A
428
429/*
430 * IP6 route structure
431 */
2d21ac55 432#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
91447636 433#ifdef PRIVATE
1c79356b 434struct route_in6 {
b0d623f7
A
435 /*
436 * N.B: struct route_in6 must begin with ro_rt and ro_flags
437 * because the code does some casts of a 'struct route_in6 *'
438 * to a 'struct route *'.
439 */
440 struct rtentry *ro_rt;
441 __uint32_t ro_flags; /* route flags */
442 struct sockaddr_in6 ro_dst;
1c79356b 443};
91447636 444#endif /* PRIVATE */
2d21ac55 445#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b
A
446
447/*
448 * Options for use with [gs]etsockopt at the IPV6 level.
449 * First word of comment is data type; bool is stored in int.
450 */
451/* no hdrincl */
2d21ac55 452#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
453#if 0 /* the followings are relic in IPv4 and hence are disabled */
454#define IPV6_OPTIONS 1 /* buf/ip6_opts; set/get IP6 options */
455#define IPV6_RECVOPTS 5 /* bool; receive all IP6 opts w/dgram */
456#define IPV6_RECVRETOPTS 6 /* bool; receive IP6 opts for response */
457#define IPV6_RECVDSTADDR 7 /* bool; receive IP6 dst addr w/dgram */
458#define IPV6_RETOPTS 8 /* ip6_opts; set/get IP6 options */
0c530ab8 459#endif /* 0 */
1c79356b 460#define IPV6_SOCKOPT_RESERVED1 3 /* reserved for future use */
2d21ac55 461#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b 462#define IPV6_UNICAST_HOPS 4 /* int; IP6 hops */
91447636
A
463#define IPV6_MULTICAST_IF 9 /* __uint8_t; set/get IP6 multicast i/f */
464#define IPV6_MULTICAST_HOPS 10 /* __uint8_t; set/get IP6 multicast hops */
465#define IPV6_MULTICAST_LOOP 11 /* __uint8_t; set/get IP6 mcast loopback */
1c79356b
A
466#define IPV6_JOIN_GROUP 12 /* ip6_mreq; join a group membership */
467#define IPV6_LEAVE_GROUP 13 /* ip6_mreq; leave a group membership */
91447636 468
2d21ac55 469#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
1c79356b
A
470#define IPV6_PORTRANGE 14 /* int; range to choose for unspec port */
471#define ICMP6_FILTER 18 /* icmp6_filter; icmp6 filter */
9bccf70c
A
472/* RFC2292 options */
473#define IPV6_PKTINFO 19 /* bool; send/recv if, src/dst addr */
474#define IPV6_HOPLIMIT 20 /* bool; hop limit */
475#define IPV6_NEXTHOP 21 /* bool; next hop addr */
476#define IPV6_HOPOPTS 22 /* bool; hop-by-hop option */
477#define IPV6_DSTOPTS 23 /* bool; destination option */
478#define IPV6_RTHDR 24 /* bool; routing header */
1c79356b 479#define IPV6_PKTOPTIONS 25 /* buf/cmsghdr; set/get IPv6 options */
9bccf70c 480
1c79356b 481#define IPV6_CHECKSUM 26 /* int; checksum offset for raw socket */
2d21ac55 482#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
9bccf70c 483#define IPV6_V6ONLY 27 /* bool; only bind INET6 at wildcard bind */
2d21ac55 484#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
55e303ae 485#ifndef KERNEL
9bccf70c 486#define IPV6_BINDV6ONLY IPV6_V6ONLY
0c530ab8 487#endif /* KERNEL */
1c79356b 488
55e303ae 489
1c79356b
A
490#if 1 /*IPSEC*/
491#define IPV6_IPSEC_POLICY 28 /* struct; get/set security policy */
0c530ab8 492#endif /* 1 */
1c79356b
A
493#define IPV6_FAITH 29 /* bool; accept FAITH'ed connections */
494
495#if 1 /*IPV6FIREWALL*/
496#define IPV6_FW_ADD 30 /* add a firewall rule to chain */
497#define IPV6_FW_DEL 31 /* delete a firewall rule from chain */
498#define IPV6_FW_FLUSH 32 /* flush firewall rule chain */
499#define IPV6_FW_ZERO 33 /* clear single/all firewall counter(s) */
500#define IPV6_FW_GET 34 /* get entire firewall rule chain */
0c530ab8 501#endif /* 1 */
1c79356b 502
b0d623f7
A
503#define IPV6_RECVTCLASS 35 /* bool; recv traffic class values */
504#define IPV6_TCLASS 36 /* int; send traffic class value */
505
9bccf70c 506/* to define items, should talk with KAME guys first, for *BSD compatibility */
1c79356b
A
507
508#define IPV6_RTHDR_LOOSE 0 /* this hop need not be a neighbor. XXX old spec */
509#define IPV6_RTHDR_STRICT 1 /* this hop must be a neighbor. XXX old spec */
510#define IPV6_RTHDR_TYPE_0 0 /* IPv6 routing header type 0 */
511
512/*
513 * Defaults and limits for options
514 */
515#define IPV6_DEFAULT_MULTICAST_HOPS 1 /* normally limit m'casts to 1 hop */
516#define IPV6_DEFAULT_MULTICAST_LOOP 1 /* normally hear sends if a member */
517
518/*
519 * Argument structure for IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP.
520 */
521struct ipv6_mreq {
522 struct in6_addr ipv6mr_multiaddr;
9bccf70c 523 unsigned int ipv6mr_interface;
1c79356b
A
524};
525
526/*
527 * IPV6_PKTINFO: Packet information(RFC2292 sec 5)
528 */
529struct in6_pktinfo {
9bccf70c
A
530 struct in6_addr ipi6_addr; /* src/dst IPv6 address */
531 unsigned int ipi6_ifindex; /* send/recv interface index */
1c79356b
A
532};
533
534/*
535 * Argument for IPV6_PORTRANGE:
536 * - which range to search when port is unspecified at bind() or connect()
537 */
538#define IPV6_PORTRANGE_DEFAULT 0 /* default range */
539#define IPV6_PORTRANGE_HIGH 1 /* "high" - request firewall bypass */
540#define IPV6_PORTRANGE_LOW 2 /* "low" - vouchsafe security */
541
1c79356b
A
542/*
543 * Definitions for inet6 sysctl operations.
544 *
545 * Third level is protocol number.
546 * Fourth level is desired variable within that protocol.
547 */
548#define IPV6PROTO_MAXID (IPPROTO_PIM + 1) /* don't list to IPV6PROTO_MAX */
549
91447636
A
550/*
551 * Names for IP sysctl objects
552 */
553#define IPV6CTL_FORWARDING 1 /* act as router */
554#define IPV6CTL_SENDREDIRECTS 2 /* may send redirects when forwarding*/
555#define IPV6CTL_DEFHLIM 3 /* default Hop-Limit */
556#ifdef notyet
557#define IPV6CTL_DEFMTU 4 /* default MTU */
558#endif
559#define IPV6CTL_FORWSRCRT 5 /* forward source-routed dgrams */
560#define IPV6CTL_STATS 6 /* stats */
561#define IPV6CTL_MRTSTATS 7 /* multicast forwarding stats */
562#define IPV6CTL_MRTPROTO 8 /* multicast routing protocol */
563#define IPV6CTL_MAXFRAGPACKETS 9 /* max packets reassembly queue */
564#define IPV6CTL_SOURCECHECK 10 /* verify source route and intf */
565#define IPV6CTL_SOURCECHECK_LOGINT 11 /* minimume logging interval */
566#define IPV6CTL_ACCEPT_RTADV 12
567#define IPV6CTL_KEEPFAITH 13
568#define IPV6CTL_LOG_INTERVAL 14
569#define IPV6CTL_HDRNESTLIMIT 15
570#define IPV6CTL_DAD_COUNT 16
571#define IPV6CTL_AUTO_FLOWLABEL 17
572#define IPV6CTL_DEFMCASTHLIM 18
573#define IPV6CTL_GIF_HLIM 19 /* default HLIM for gif encap packet */
574#define IPV6CTL_KAME_VERSION 20
575#define IPV6CTL_USE_DEPRECATED 21 /* use deprecated addr (RFC2462 5.5.4) */
576#define IPV6CTL_RR_PRUNE 22 /* walk timer for router renumbering */
577#if 0 /*obsolete*/
578#define IPV6CTL_MAPPED_ADDR 23
579#endif
580#define IPV6CTL_V6ONLY 24
581#define IPV6CTL_RTEXPIRE 25 /* cloned route expiration time */
582#define IPV6CTL_RTMINEXPIRE 26 /* min value for expiration time */
583#define IPV6CTL_RTMAXCACHE 27 /* trigger level for dynamic expire */
584
585#define IPV6CTL_USETEMPADDR 32 /* use temporary addresses (RFC3041) */
586#define IPV6CTL_TEMPPLTIME 33 /* preferred lifetime for tmpaddrs */
587#define IPV6CTL_TEMPVLTIME 34 /* valid lifetime for tmpaddrs */
588#define IPV6CTL_AUTO_LINKLOCAL 35 /* automatic link-local addr assign */
589#define IPV6CTL_RIP6STATS 36 /* raw_ip6 stats */
590
591#define IPV6CTL_MAXFRAGS 41 /* max fragments */
592
e2fac8b1
A
593#define IPV6CTL_NEIGHBORGCTHRESH 46
594#define IPV6CTL_MAXIFPREFIXES 47
595#define IPV6CTL_MAXIFDEFROUTERS 48
596#define IPV6CTL_MAXDYNROUTES 49
597
91447636
A
598/* New entries should be added here from current IPV6CTL_MAXID value. */
599/* to define items, should talk with KAME guys first, for *BSD compatibility */
e2fac8b1 600#define IPV6CTL_MAXID 50
91447636
A
601
602#ifdef KERNEL_PRIVATE
1c79356b
A
603#define CTL_IPV6PROTO_NAMES { \
604 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
605 { 0, 0 }, \
606 { "tcp6", CTLTYPE_NODE }, \
607 { 0, 0 }, \
608 { 0, 0 }, \
609 { 0, 0 }, \
610 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
611 { 0, 0 }, \
612 { 0, 0 }, \
613 { "udp6", CTLTYPE_NODE }, \
614 { 0, 0 }, \
615 { 0, 0 }, \
616 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
617 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
618 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
619 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
620 { 0, 0 }, \
621 { "ip6", CTLTYPE_NODE }, \
622 { 0, 0 }, \
623 { 0, 0 }, \
624 { 0, 0 }, \
625 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
626 { 0, 0 }, \
627 { "ipsec6", CTLTYPE_NODE }, \
628 { 0, 0 }, \
629 { 0, 0 }, \
630 { 0, 0 }, \
631 { 0, 0 }, \
632 { 0, 0 }, \
633 { 0, 0 }, \
634 { "icmp6", CTLTYPE_NODE }, \
635 { 0, 0 }, \
636 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
637 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
638 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
639 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
640 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
641 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
642 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
643 { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, \
644 { 0, 0 }, \
645 { 0, 0 }, \
646 { 0, 0 }, \
647 { "pim6", CTLTYPE_NODE }, \
648}
9bccf70c
A
649/*
650 * Redefinition of mbuf flags
651 */
652#define M_AUTHIPHDR M_PROTO2
653#define M_DECRYPTED M_PROTO3
654#define M_LOOP M_PROTO4
655#define M_AUTHIPDGM M_PROTO5
656
1c79356b 657struct cmsghdr;
9bccf70c
A
658struct mbuf;
659struct ifnet;
55e303ae 660struct in6_aliasreq;
1c79356b 661
2d21ac55
A
662#define in6_cksum(m, n, o, l) inet6_cksum(m, n, o, l)
663
664extern u_int16_t inet6_cksum(struct mbuf *m, unsigned int proto,
665 unsigned int offset, unsigned int transport_len);
666
667extern int in6_localaddr(struct in6_addr *);
668extern int in6_addrscope(struct in6_addr *);
669extern struct in6_ifaddr *in6_ifawithscope(struct ifnet *, struct in6_addr *);
670extern struct in6_ifaddr *in6_ifawithifp(struct ifnet *, struct in6_addr *);
b0d623f7 671extern int in6_if_up(struct ifnet *, struct in6_aliasreq *);
1c79356b
A
672struct sockaddr;
673
2d21ac55
A
674extern void in6_sin6_2_sin(struct sockaddr_in *sin, struct sockaddr_in6 *sin6);
675extern void in6_sin_2_v4mapsin6(struct sockaddr_in *sin,
676 struct sockaddr_in6 *sin6);
677extern void in6_sin6_2_sin_in_sock(struct sockaddr *nam);
b0d623f7 678extern int in6_sin_2_v4mapsin6_in_sock(struct sockaddr **nam);
1c79356b
A
679
680#define satosin6(sa) ((struct sockaddr_in6 *)(sa))
681#define sin6tosa(sin6) ((struct sockaddr *)(sin6))
682#define ifatoia6(ifa) ((struct in6_ifaddr *)(ifa))
2d21ac55
A
683
684extern int in6addr_local(struct in6_addr *);
0c530ab8 685#endif /* KERNEL_PRIVATE */
1c79356b 686
91447636 687#ifndef KERNEL
1c79356b
A
688__BEGIN_DECLS
689struct cmsghdr;
690
91447636
A
691extern int inet6_option_space(int);
692extern int inet6_option_init(void *, struct cmsghdr **, int);
693extern int inet6_option_append(struct cmsghdr *, const __uint8_t *,
694 int, int);
695extern __uint8_t *inet6_option_alloc(struct cmsghdr *, int, int, int);
696extern int inet6_option_next(const struct cmsghdr *, __uint8_t **);
697extern int inet6_option_find(const struct cmsghdr *, __uint8_t **, int);
698
699extern size_t inet6_rthdr_space(int, int);
700extern struct cmsghdr *inet6_rthdr_init(void *, int);
701extern int inet6_rthdr_add(struct cmsghdr *, const struct in6_addr *,
702 unsigned int);
703extern int inet6_rthdr_lasthop(struct cmsghdr *, unsigned int);
1c79356b 704#if 0 /* not implemented yet */
91447636 705extern int inet6_rthdr_reverse(const struct cmsghdr *, struct cmsghdr *);
1c79356b 706#endif
91447636
A
707extern int inet6_rthdr_segments(const struct cmsghdr *);
708extern struct in6_addr *inet6_rthdr_getaddr(struct cmsghdr *, int);
709extern int inet6_rthdr_getflags(const struct cmsghdr *, int);
710
711extern int inet6_opt_init(void *, size_t);
712extern int inet6_opt_append(void *, size_t, int, __uint8_t,
713 size_t, __uint8_t, void **);
714extern int inet6_opt_finish(void *, size_t, int);
715extern int inet6_opt_set_val(void *, size_t, void *, int);
716
717extern int inet6_opt_next(void *, size_t, int, __uint8_t *,
718 size_t *, void **);
719extern int inet6_opt_find(void *, size_t, int, __uint8_t,
720 size_t *, void **);
721extern int inet6_opt_get_val(void *, size_t, void *, int);
722extern size_t inet6_rth_space(int, int);
723extern void *inet6_rth_init(void *, int, int, int);
724extern int inet6_rth_add(void *, const struct in6_addr *);
725extern int inet6_rth_reverse(const void *, void *);
726extern int inet6_rth_segments(const void *);
727extern struct in6_addr *inet6_rth_getaddr(const void *, int);
1c79356b 728__END_DECLS
0c530ab8 729#endif /* !KERNEL */
2d21ac55 730#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b 731#endif /* !_NETINET6_IN6_H_ */