xref: /dragonfly/sys/netinet6/in6.h (revision 555fb2fceeab7137a8d4a8cc8206ad3c2f0e4f31)
1 /*        $FreeBSD: src/sys/netinet6/in6.h,v 1.7.2.7 2002/08/01 19:38:50 ume Exp $        */
2 /*        $KAME: in6.h,v 1.89 2001/05/27 13:28:35 itojun Exp $        */
3 
4 /*
5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the project nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1982, 1986, 1990, 1993
35  *        The Regents of the University of California.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  *
61  *        @(#)in.h  8.3 (Berkeley) 1/3/94
62  */
63 
64 #ifndef __KAME_NETINET_IN_H_INCLUDED_
65 #error "do not include netinet6/in6.h directly, include netinet/in.h.  see RFC2553"
66 #endif
67 
68 #ifndef _NETINET6_IN6_H_
69 #define _NETINET6_IN6_H_
70 
71 #include <sys/cdefs.h>
72 
73 /*
74  * Identification of the network protocol stack
75  * for *BSD-current/release: http://www.kame.net/dev/cvsweb.cgi/kame/COVERAGE
76  * has the table of implementation/integration differences.
77  */
78 #define __KAME__
79 #define __KAME_VERSION                  "20010528/FreeBSD"
80 
81 #ifndef _SA_FAMILY_T_DECLARED
82 typedef   __uint8_t sa_family_t;
83 #define   _SA_FAMILY_T_DECLARED
84 #endif
85 
86 #ifndef _SIZE_T_DECLARED
87 typedef   __size_t  size_t;
88 #define   _SIZE_T_DECLARED
89 #endif
90 
91 #ifndef _SOCKLEN_T_DECLARED
92 #define _SOCKLEN_T_DECLARED
93 typedef __socklen_t socklen_t;
94 #endif
95 
96 #ifndef _UINT8_T_DECLARED
97 typedef   __uint8_t uint8_t;
98 #define   _UINT8_T_DECLARED
99 #endif
100 #ifndef _UINT16_T_DECLARED
101 typedef   __uint16_t          uint16_t;
102 #define   _UINT16_T_DECLARED
103 #endif
104 #ifndef _UINT32_T_DECLARED
105 typedef   __uint32_t          uint32_t;
106 #define   _UINT32_T_DECLARED
107 #endif
108 
109 /*
110  * Local port number conventions:
111  *
112  * Ports < IPPORT_RESERVED are reserved for privileged processes (e.g. root),
113  * unless a kernel is compiled with IPNOPRIVPORTS defined.
114  *
115  * When a user does a bind(2) or connect(2) with a port number of zero,
116  * a non-conflicting local port address is chosen.
117  *
118  * The default range is IPPORT_ANONMIN to IPPORT_ANONMAX, although
119  * that is settable by sysctl(3); net.inet.ip.anonportmin and
120  * net.inet.ip.anonportmax respectively.
121  *
122  * A user may set the IPPROTO_IP option IP_PORTRANGE to change this
123  * default assignment range.
124  *
125  * The value IP_PORTRANGE_DEFAULT causes the default behavior.
126  *
127  * The value IP_PORTRANGE_HIGH is the same as IP_PORTRANGE_DEFAULT,
128  * and exists only for FreeBSD compatibility purposes.
129  *
130  * The value IP_PORTRANGE_LOW changes the range to the "low" are
131  * that is (by convention) restricted to privileged processes.
132  * This convention is based on "vouchsafe" principles only.
133  * It is only secure if you trust the remote host to restrict these ports.
134  * The range is IPPORT_RESERVEDMIN to IPPORT_RESERVEDMAX.
135  */
136 
137 #if __BSD_VISIBLE
138 #define   IPV6PORT_RESERVED   1024
139 #define   IPV6PORT_ANONMIN    49152
140 #define   IPV6PORT_ANONMAX    65535
141 #define   IPV6PORT_RESERVEDMIN          600
142 #define   IPV6PORT_RESERVEDMAX          (IPV6PORT_RESERVED-1)
143 #endif
144 
145 /*
146  * IPv6 address
147  */
148 #ifndef _STRUCT_IN6_ADDR_DECLARED
149 struct in6_addr {
150           union {
151                     uint8_t   __u6_addr8[16];
152                     uint16_t  __u6_addr16[8];
153                     uint32_t  __u6_addr32[4];
154           } __u6_addr;                            /* 128-bit IP6 address */
155 };
156 #define _STRUCT_IN6_ADDR_DECLARED
157 #endif
158 
159 #define s6_addr               __u6_addr.__u6_addr8
160 #define _s6_addr16  __u6_addr.__u6_addr16                   /* internal use */
161 #define _s6_addr32  __u6_addr.__u6_addr32                   /* internal use */
162 #if __BSD_VISIBLE                                           /* XXX nonstandard */
163 #define s6_addr8    __u6_addr.__u6_addr8
164 #define s6_addr16   __u6_addr.__u6_addr16
165 #define s6_addr32   __u6_addr.__u6_addr32
166 #endif
167 
168 #define INET6_ADDRSTRLEN      46
169 
170 /*
171  * Socket address for IPv6
172  */
173 #if __BSD_VISIBLE
174 #define SIN6_LEN
175 #endif
176 
177 struct sockaddr_in6 {
178           uint8_t             sin6_len; /* length of this struct(sa_family_t)*/
179           sa_family_t         sin6_family;        /* AF_INET6 */
180           uint16_t  sin6_port;          /* Transport layer port # (in_port_t)*/
181           uint32_t  sin6_flowinfo;      /* IP6 flow information */
182           struct in6_addr     sin6_addr;          /* IP6 address */
183           uint32_t  sin6_scope_id;      /* scope zone index */
184 };
185 
186 /*
187  * Local definition for masks
188  */
189 #ifdef _KERNEL      /* XXX nonstandard */
190 #define IN6MASK0    {{{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }}}
191 #define IN6MASK32   {{{ 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, \
192                                   0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
193 #define IN6MASK64   {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
194                                   0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
195 #define IN6MASK96   {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
196                                   0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00 }}}
197 #define IN6MASK128  {{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
198                                   0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }}}
199 #endif
200 
201 #ifdef _KERNEL
202 extern const struct sockaddr_in6 sa6_any;
203 
204 extern const struct in6_addr in6mask0;
205 extern const struct in6_addr in6mask32;
206 extern const struct in6_addr in6mask64;
207 extern const struct in6_addr in6mask96;
208 extern const struct in6_addr in6mask128;
209 #endif /* _KERNEL */
210 
211 /*
212  * Macros started with IPV6_ADDR is KAME local
213  */
214 #if BYTE_ORDER == BIG_ENDIAN
215 #define _IPV6_ADDR_INT16_UL_MASK        0xffc0
216 #define _IPV6_ADDR_INT16_ULL            0xfe80
217 #define _IPV6_ADDR_INT16_USL            0xfec0
218 #else
219 #define _IPV6_ADDR_INT16_UL_MASK        0xc0ff
220 #define _IPV6_ADDR_INT16_ULL            0x80fe
221 #define _IPV6_ADDR_INT16_USL            0xc0fe
222 #endif
223 
224 #ifdef _KERNEL      /* XXX nonstandard */
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_MLL   0xff02
232 #elif BYTE_ORDER == LITTLE_ENDIAN
233 #define IPV6_ADDR_INT32_ONE   0x01000000
234 #define IPV6_ADDR_INT32_TWO   0x02000000
235 #define IPV6_ADDR_INT32_MNL   0x000001ff
236 #define IPV6_ADDR_INT32_MLL   0x000002ff
237 #define IPV6_ADDR_INT32_SMP   0xffff0000
238 #define IPV6_ADDR_INT16_MLL   0x02ff
239 #endif
240 #define IPV6_ADDR_INT16_ULL   _IPV6_ADDR_INT16_ULL
241 #define IPV6_ADDR_INT16_USL   _IPV6_ADDR_INT16_USL
242 #endif
243 
244 /*
245  * Definition of some useful macros to handle IP6 addresses
246  */
247 #define IN6ADDR_ANY_INIT                                                        \
248           {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,                   \
249               0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
250 #define IN6ADDR_LOOPBACK_INIT                                                   \
251           {{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,                   \
252               0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
253 #if __BSD_VISIBLE
254 #define IN6ADDR_NODELOCAL_ALLNODES_INIT                                         \
255           {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,                   \
256               0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
257 #define IN6ADDR_INTFACELOCAL_ALLNODES_INIT                                      \
258           {{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,                   \
259               0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
260 #define IN6ADDR_LINKLOCAL_ALLNODES_INIT                                         \
261           {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,                   \
262               0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
263 #define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT                                       \
264           {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,                   \
265               0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 }}}
266 #define IN6ADDR_LINKLOCAL_ALLMDNS_INIT                                          \
267           {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,                   \
268               0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xfb }}}
269 #endif
270 
271 #ifdef _KERNEL
272 extern const struct in6_addr kin6addr_any;
273 extern const struct in6_addr kin6addr_loopback;
274 extern const struct in6_addr kin6addr_nodelocal_allnodes;
275 extern const struct in6_addr kin6addr_linklocal_allnodes;
276 extern const struct in6_addr kin6addr_linklocal_allrouters;
277 #else
278 extern const struct in6_addr in6addr_any;
279 extern const struct in6_addr in6addr_loopback;
280 #if __BSD_VISIBLE
281 extern const struct in6_addr in6addr_nodelocal_allnodes;
282 extern const struct in6_addr in6addr_linklocal_allnodes;
283 #endif
284 #endif
285 
286 #if __BSD_VISIBLE || defined(_KERNEL)
287 #define IN6_ARE_ADDR_EQUAL(a, b)                                                \
288     (memcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof(struct in6_addr)) == 0)
289 #endif
290 
291 #ifdef _KERNEL                          /* non standard */
292 /* see if two addresses are equal in a scope-conscious manner. */
293 #define SA6_ARE_ADDR_EQUAL(a, b) \
294           (((a)->sin6_scope_id == 0 || (b)->sin6_scope_id == 0 ||               \
295             (a)->sin6_scope_id == (b)->sin6_scope_id) &&                        \
296            (bcmp(&(a)->sin6_addr, &(b)->sin6_addr, sizeof(struct in6_addr)) == 0))
297 #endif
298 
299 /*
300  * Unspecified
301  */
302 #define IN6_IS_ADDR_UNSPECIFIED(a)                                              \
303           ((a)->_s6_addr32[0] == 0 && (a)->_s6_addr32[1] == 0 &&                \
304            (a)->_s6_addr32[2] == 0 && (a)->_s6_addr32[3] == 0)
305 
306 /*
307  * Loopback
308  */
309 #define IN6_IS_ADDR_LOOPBACK(a)                                                           \
310           ((a)->_s6_addr32[0] == 0 && (a)->_s6_addr32[1] == 0 &&      \
311            (a)->_s6_addr32[2] == 0 && (a)->_s6_addr32[3] == ntohl(1))
312 
313 /*
314  * Mapped
315  */
316 #define IN6_IS_ADDR_V4MAPPED(a)                                                           \
317           ((a)->_s6_addr32[0] == 0 && (a)->_s6_addr32[1] == 0 &&                \
318            (a)->_s6_addr32[2] == ntohl(0x0000ffff))
319 
320 /*
321  * IPv4 compatible.  Deprecated by RFC4291.
322  */
323 #define IN6_IS_ADDR_V4COMPAT(a)                                                           \
324           ((a)->_s6_addr32[0] == 0 &&                                           \
325            (a)->_s6_addr32[1] == 0 &&                                           \
326            (a)->_s6_addr32[2] == 0 &&                                           \
327            (a)->_s6_addr32[3] != 0 && (a)->_s6_addr32[3] != ntohl(1))
328 
329 /*
330  * KAME Scope Values
331  */
332 
333 #ifdef _KERNEL                                              /* XXX nonstandard */
334 #define IPV6_ADDR_SCOPE_NODELOCAL       0x01
335 #define IPV6_ADDR_SCOPE_INTFACELOCAL    0x01
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_INTFACELOCAL  0x01
343 #define __IPV6_ADDR_SCOPE_LINKLOCAL     0x02
344 #define __IPV6_ADDR_SCOPE_SITELOCAL     0x05
345 #define __IPV6_ADDR_SCOPE_ORGLOCAL      0x08      /* just used in this file */
346 #define __IPV6_ADDR_SCOPE_GLOBAL        0x0e
347 #endif
348 
349 /*
350  * Unicast Scope
351  * Note that we must check topmost 10 bits only, not 16 bits (see RFC2373).
352  */
353 #define IN6_IS_ADDR_LINKLOCAL(a)                                                \
354     (((a)->_s6_addr16[0] & _IPV6_ADDR_INT16_UL_MASK) == _IPV6_ADDR_INT16_ULL)
355 #define IN6_IS_ADDR_SITELOCAL(a)                                                \
356     (((a)->_s6_addr16[0] & _IPV6_ADDR_INT16_UL_MASK) == _IPV6_ADDR_INT16_USL)
357 
358 /*
359  * Multicast
360  */
361 #define IN6_IS_ADDR_MULTICAST(a)        ((a)->s6_addr[0] == 0xff)
362 #define __IPV6_ADDR_MC_SCOPE(a)                   ((a)->s6_addr[1] & 0x0f)
363 #ifdef _KERNEL                                              /* XXX nonstandard */
364 #define IPV6_ADDR_MC_SCOPE(a)           __IPV6_ADDR_MC_SCOPE(a)
365 #endif
366 
367 /*
368  * Multicast Scope
369  */
370 #ifdef _KERNEL
371 #define IN6_IS_ADDR_MC_NODELOCAL(a)                                             \
372           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
373            (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_NODELOCAL))
374 
375 #define IN6_IS_ADDR_MC_INTFACELOCAL(a)                                          \
376           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
377            (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_INTFACELOCAL))
378 
379 #define IN6_IS_ADDR_MC_LINKLOCAL(a)                                             \
380           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
381            (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_LINKLOCAL))
382 
383 #define IN6_IS_ADDR_MC_SITELOCAL(a)                                             \
384           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
385            (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_SITELOCAL))
386 
387 #define IN6_IS_ADDR_MC_ORGLOCAL(a)                                              \
388           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
389            (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_ORGLOCAL))
390 
391 #define IN6_IS_ADDR_MC_GLOBAL(a)                                                \
392           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
393            (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_GLOBAL))
394 #else
395 #define IN6_IS_ADDR_MC_NODELOCAL(a)                                             \
396           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
397            (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_NODELOCAL))
398 
399 #define IN6_IS_ADDR_MC_LINKLOCAL(a)                                             \
400           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
401            (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_LINKLOCAL))
402 
403 #define IN6_IS_ADDR_MC_SITELOCAL(a)                                             \
404           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
405            (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_SITELOCAL))
406 
407 #define IN6_IS_ADDR_MC_ORGLOCAL(a)                                              \
408           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
409            (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_ORGLOCAL))
410 
411 #define IN6_IS_ADDR_MC_GLOBAL(a)                                                \
412           (IN6_IS_ADDR_MULTICAST(a) &&                                          \
413            (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_GLOBAL))
414 #endif
415 
416 #ifdef _KERNEL      /* nonstandard */
417 /*
418  * KAME Scope
419  */
420 #define IN6_IS_SCOPE_LINKLOCAL(a)                                               \
421           (IN6_IS_ADDR_LINKLOCAL(a) || IN6_IS_ADDR_MC_LINKLOCAL(a))
422 #define   IN6_IS_SCOPE_EMBED(a)                                                           \
423           ((IN6_IS_ADDR_LINKLOCAL(a)) ||                                                  \
424            (IN6_IS_ADDR_MC_LINKLOCAL(a)) ||                                     \
425            (IN6_IS_ADDR_MC_INTFACELOCAL(a)))
426 
427 
428 #define IFA6_IS_DEPRECATED(a)                                                   \
429           ((a)->ia6_lifetime.ia6t_preferred != 0 &&                             \
430            (a)->ia6_lifetime.ia6t_preferred < time_uptime)
431 
432 #define IFA6_IS_INVALID(a)                                                      \
433           ((a)->ia6_lifetime.ia6t_expire != 0 &&                                \
434            (a)->ia6_lifetime.ia6t_expire < time_uptime)
435 #endif
436 
437 /*
438  * IP6 route structure
439  */
440 #if __BSD_VISIBLE
441 struct route_in6 {
442           struct rtentry                *ro_rt;
443           struct sockaddr_in6 ro_dst;
444 };
445 #endif
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 */
452 #if 0 /* the followings are relic in IPv4 and hence are disabled */
453 #define IPV6_OPTIONS                    1  /* buf/ip6_opts; set/get IP6 options */
454 #define IPV6_RECVOPTS                   5  /* bool; receive all IP6 opts w/dgram */
455 #define IPV6_RECVRETOPTS      6  /* bool; receive IP6 opts for response */
456 #define IPV6_RECVDSTADDR      7  /* bool; receive IP6 dst addr w/dgram */
457 #define IPV6_RETOPTS                    8  /* ip6_opts; set/get IP6 options */
458 #endif
459 #if __BSD_VISIBLE
460 #define IPV6_SOCKOPT_RESERVED1          3  /* reserved for future use */
461 #endif
462 #define IPV6_UNICAST_HOPS     4  /* int; IP6 hops */
463 #define IPV6_MULTICAST_IF     9  /* u_int; set/get IP6 multicast i/f  */
464 #define IPV6_MULTICAST_HOPS   10 /* int; set/get IP6 multicast hops */
465 #define IPV6_MULTICAST_LOOP   11 /* u_int; set/get IP6 multicast loopback */
466 #define IPV6_JOIN_GROUP                 12 /* ip6_mreq; join a group membership */
467 #define IPV6_LEAVE_GROUP      13 /* ip6_mreq; leave a group membership */
468 #if __BSD_VISIBLE
469 #define IPV6_PORTRANGE                  14 /* int; range to choose for unspec port */
470 #define ICMP6_FILTER                    18 /* icmp6_filter; icmp6 filter */
471 #endif
472 /* RFC2292 options */
473 #ifdef _KERNEL
474 #define IPV6_2292PKTINFO      19 /* bool; send/recv if, src/dst addr */
475 #define IPV6_2292HOPLIMIT     20 /* bool; hop limit */
476 #define IPV6_2292NEXTHOP      21 /* bool; next hop addr */
477 #define IPV6_2292HOPOPTS      22 /* bool; hop-by-hop option */
478 #define IPV6_2292DSTOPTS      23 /* bool; destinaion option */
479 #define IPV6_2292RTHDR                  24 /* bool; routing header */
480 #define IPV6_2292PKTOPTIONS   25 /* buf/cmsghdr; set/get IPv6 options */
481 #endif
482 
483 #if __BSD_VISIBLE
484 #define IPV6_CHECKSUM                   26 /* int; checksum offset for raw socket */
485 #endif
486 #define IPV6_V6ONLY           27 /* bool; only bind INET6 at wildcard bind */
487 #ifndef _KERNEL
488 #define IPV6_BINDV6ONLY                 IPV6_V6ONLY
489 #endif
490 
491 #if __BSD_VISIBLE
492 #if 1 /* IPV6FIREWALL */
493 #define IPV6_FW_ADD           30 /* add a firewall rule to chain */
494 #define IPV6_FW_DEL           31 /* delete a firewall rule from chain */
495 #define IPV6_FW_FLUSH                   32 /* flush firewall rule chain */
496 #define IPV6_FW_ZERO                    33 /* clear single/all firewall counter(s) */
497 #define IPV6_FW_GET           34 /* get entire firewall rule chain */
498 #endif
499 
500 /*
501  * new socket options introduced in RFC3542
502  */
503 #define IPV6_RTHDRDSTOPTS     35 /* ip6_dest; send dst option before rthdr */
504 #define IPV6_RECVPKTINFO      36 /* bool; recv if, dst addr */
505 #define IPV6_RECVHOPLIMIT     37 /* bool; recv hop limit */
506 #define IPV6_RECVRTHDR                  38 /* bool; recv routing header */
507 #define IPV6_RECVHOPOPTS      39 /* bool; recv hop-by-hop option */
508 #define IPV6_RECVDSTOPTS      40 /* bool; recv dst option after rthdr */
509 #endif
510 #ifdef _KERNEL
511 #define IPV6_RECVRTHDRDSTOPTS 41 /* bool; recv dst option before rthdr */
512 #endif
513 #if __BSD_VISIBLE
514 #define IPV6_USE_MIN_MTU      42 /* bool; send packets at the minimum MTU */
515 #define IPV6_RECVPATHMTU      43 /* bool; notify an according MTU */
516 
517 /* mtuinfo; get the current path MTU (sopt),
518  * 4 bytes int; MTU notification (cmsg)
519  */
520 #define IPV6_PATHMTU                    44
521 #if 0 /*obsoleted during 2292bis -> 3542*/
522 #define IPV6_REACHCONF                  45 /* no data; ND reachability confirm
523                                               (cmsg only/not in of RFC3542) */
524 #endif
525 #define IPV6_PKTINFO                    46 /* in6_pktinfo; send if, src addr */
526 #define IPV6_HOPLIMIT                   47 /* int; send hop limit */
527 #define IPV6_NEXTHOP                    48 /* sockaddr; next hop addr */
528 #define IPV6_HOPOPTS                    49 /* ip6_hbh; send hop-by-hop option */
529 #define IPV6_DSTOPTS                    50 /* ip6_dest; send dst option befor rthdr */
530 #define IPV6_RTHDR            51 /* ip6_rthdr; send routing header */
531 #define IPV6_PKTOPTIONS                 52 /* buf/cmsghdr; set/get IPv6 options, this is obsoleted by RFC3542 */
532 
533 #define IPV6_RECVTCLASS                 57 /* bool; recv traffic class values */
534 
535 #define IPV6_AUTOFLOWLABEL    59 /* bool; attach flowlabel automagically */
536 
537 #define IPV6_TCLASS           61 /* int; send traffic class value */
538 #define IPV6_DONTFRAG                   62 /* bool; disable IPv6 fragmentation */
539 
540 #define IPV6_PREFER_TEMPADDR  63 /* int; prefer temporary addresses as
541                                             * the source address.
542                                             */
543 /*
544  * The following option is private; do not use it from user applications.
545  * It is deliberately defined to the same value as IP_MSFILTER.
546  */
547 #define   IPV6_MSFILTER                 74 /* struct __msfilterreq;
548                                             * set/get multicast source filter list.
549                                             */
550 /* to define items, should talk with KAME guys first, for *BSD compatibility */
551 
552 #define IPV6_RTHDR_LOOSE     0 /* this hop need not be a neighbor. XXX old spec */
553 #define IPV6_RTHDR_STRICT    1 /* this hop must be a neighbor. XXX old spec */
554 #define IPV6_RTHDR_TYPE_0    0 /* IPv6 routing header type 0 */
555 
556 /*
557  * Defaults and limits for options
558  */
559 #define IPV6_DEFAULT_MULTICAST_HOPS 1   /* normally limit m'casts to 1 hop */
560 #define IPV6_DEFAULT_MULTICAST_LOOP 1   /* normally hear sends if a member */
561 #endif /* __BSD_VISIBLE */
562 
563 /*
564  * Argument structure for IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP.
565  */
566 struct ipv6_mreq {
567           struct in6_addr     ipv6mr_multiaddr;
568           unsigned int        ipv6mr_interface;
569 };
570 
571 #if __BSD_VISIBLE
572 /*
573  * IPV6_PKTINFO: Packet information(RFC2292 sec 5)
574  */
575 struct in6_pktinfo {
576           struct in6_addr     ipi6_addr;          /* src/dst IPv6 address */
577           unsigned int        ipi6_ifindex;       /* send/recv interface index */
578 };
579 
580 /*
581  * New Control structure for IPV6_RECVPATHMTU socket option introduced in RFC3542.
582  */
583 struct ip6_mtuinfo {
584           struct sockaddr_in6 ip6m_addr;          /* or sockaddr_storage? */
585           uint32_t ip6m_mtu;
586 };
587 
588 /*
589  * Argument for IPV6_PORTRANGE:
590  * - which range to search when port is unspecified at bind() or connect()
591  */
592 #define   IPV6_PORTRANGE_DEFAULT        0         /* default range */
593 #define   IPV6_PORTRANGE_HIGH 1         /* "high" - request firewall bypass */
594 #define   IPV6_PORTRANGE_LOW  2         /* "low" - vouchsafe security */
595 
596 /*
597  * Definitions for inet6 sysctl operations.
598  *
599  * Third level is protocol number.
600  * Fourth level is desired variable within that protocol.
601  */
602 #define IPV6PROTO_MAXID       (IPPROTO_PIM + 1)   /* don't list to IPV6PROTO_MAX */
603 
604 /*
605  * Names for IP sysctl objects
606  */
607 #define IPV6CTL_FORWARDING    1         /* act as router */
608 #define IPV6CTL_SENDREDIRECTS 2         /* may send redirects when forwarding*/
609 #define IPV6CTL_DEFHLIM                 3         /* default Hop-Limit */
610 #ifdef notyet
611 #define IPV6CTL_DEFMTU                  4         /* default MTU */
612 #endif
613 #define IPV6CTL_FORWSRCRT     5         /* forward source-routed dgrams */
614 #define IPV6CTL_STATS                   6         /* stats */
615 #define IPV6CTL_MRTSTATS      7         /* multicast forwarding stats */
616 #define IPV6CTL_MRTPROTO      8         /* multicast routing protocol */
617 #define IPV6CTL_MAXFRAGPACKETS          9         /* max packets reassembly queue */
618 #define IPV6CTL_SOURCECHECK   10        /* verify source route and intf */
619 #define IPV6CTL_SOURCECHECK_LOGINT 11   /* minimume logging interval */
620 #define IPV6CTL_ACCEPT_RTADV  12
621 #define IPV6CTL_LOG_INTERVAL  14
622 #define IPV6CTL_HDRNESTLIMIT  15
623 #define IPV6CTL_DAD_COUNT     16
624 #define IPV6CTL_AUTO_FLOWLABEL          17
625 #define IPV6CTL_DEFMCASTHLIM  18
626 #define IPV6CTL_GIF_HLIM      19        /* default HLIM for gif encap packet */
627 #define IPV6CTL_KAME_VERSION  20
628 #define IPV6CTL_USE_DEPRECATED          21        /* use deprecated addr (RFC2462 5.5.4) */
629 #define IPV6CTL_RR_PRUNE      22        /* walk timer for router renumbering */
630 #if 0     /* obsolete */
631 #define IPV6CTL_MAPPED_ADDR   23
632 #define IPV6CTL_V6ONLY                  24
633 #endif
634 #define IPV6CTL_RTEXPIRE      25        /* cloned route expiration time */
635 #define IPV6CTL_RTMINEXPIRE   26        /* min value for expiration time */
636 #define IPV6CTL_RTMAXCACHE    27        /* trigger level for dynamic expire */
637 
638 #define IPV6CTL_USETEMPADDR   32        /* use temporary addresses (RFC3041) */
639 #define IPV6CTL_TEMPPLTIME    33        /* preferred lifetime for tmpaddrs */
640 #define IPV6CTL_TEMPVLTIME    34        /* valid lifetime for tmpaddrs */
641 #define IPV6CTL_AUTO_LINKLOCAL          35        /* automatic link-local addr assign */
642 #define IPV6CTL_RIP6STATS     36        /* raw_ip6 stats */
643 
644 #define IPV6CTL_ADDRCTLPOLICY 38        /* get/set address selection policy */
645 #define IPV6CTL_MINHLIM                 39        /* minimum Hop-Limit */
646 
647 #define IPV6CTL_MAXFRAGS      41        /* max fragments */
648 
649 /* New entries should be added here from current IPV6CTL_MAXID value. */
650 /* to define items, should talk with KAME guys first, for *BSD compatibility */
651 
652 #define   ICMPV6CTL_ND6_ONLINKNSRFC4861 47
653 #define IPV6CTL_MAXID                   48
654 
655 /*
656  * Redefinition of mbuf flags
657  */
658 #define   M_AUTHIPHDR         M_PROTO2
659 #define   M_DECRYPTED         M_PROTO3
660 #define   M_LOOP              M_PROTO4
661 #define   M_AUTHIPDGM         M_PROTO5
662 #endif /* __BSD_VISIBLE */
663 
664 #ifdef _KERNEL
665 
666 struct ifnet;
667 struct mbuf;
668 struct sockaddr;
669 struct sockaddr_in;
670 struct sockaddr_in6;
671 
672 int       in6_cksum (struct mbuf *, uint8_t, uint32_t, uint32_t);
673 int       in6_localaddr (struct in6_addr *);
674 int       in6_addrscope (struct in6_addr *);
675 struct    in6_ifaddr *in6_ifawithscope (struct ifnet *, struct in6_addr *, struct ucred *);
676 struct    in6_ifaddr *in6_ifawithifp (struct ifnet *, struct in6_addr *);
677 
678 void      addrsel_policy_init (void);
679 
680 #define   satosin6(sa)        ((struct sockaddr_in6 *)(sa))
681 #define   sin6tosa(sin6)      ((struct sockaddr *)(sin6))
682 #define   ifatoia6(ifa)       ((struct in6_ifaddr *)(ifa))
683 #endif /* _KERNEL */
684 
685 #if __BSD_VISIBLE
686 __BEGIN_DECLS
687 struct cmsghdr;
688 
689 uint8_t *inet6_option_alloc (struct cmsghdr *, int, int, int);
690 int inet6_option_append (struct cmsghdr *, const uint8_t *, int, int);
691 int inet6_option_find (const struct cmsghdr *, uint8_t **, int);
692 int inet6_option_init (void *, struct cmsghdr **, int);
693 int inet6_option_next (const struct cmsghdr *, uint8_t **);
694 int inet6_option_space (int);
695 
696 int inet6_opt_append (void *, socklen_t, int, uint8_t, socklen_t, uint8_t, void **);
697 int inet6_opt_find (void *, socklen_t, int, uint8_t, socklen_t *, void **);
698 int inet6_opt_finish (void *, socklen_t, int);
699 int inet6_opt_get_val (void *, int, void *, socklen_t);
700 int inet6_opt_init (void *, socklen_t);
701 int inet6_opt_next (void *, socklen_t, int, uint8_t *, socklen_t *, void **);
702 int inet6_opt_set_val (void *, int, void *, socklen_t);
703 
704 int                  inet6_rth_add (void *, const struct in6_addr *);
705 struct in6_addr *inet6_rth_getaddr (const void *, int);
706 void                *inet6_rth_init (void *, socklen_t, int, int);
707 int                  inet6_rth_reverse (const void *, void *);
708 int                  inet6_rth_segments (const void *);
709 socklen_t  inet6_rth_space (int, int);
710 
711 int                  inet6_rthdr_add (struct cmsghdr *, const struct in6_addr *,
712                                           unsigned int);
713 struct in6_addr *inet6_rthdr_getaddr (struct cmsghdr *, int);
714 int                  inet6_rthdr_getflags (const struct cmsghdr *, int);
715 struct cmsghdr      *inet6_rthdr_init (void *, int);
716 int                  inet6_rthdr_lasthop (struct cmsghdr *, unsigned int);
717 int                  inet6_rthdr_reverse (const struct cmsghdr *, struct cmsghdr *);
718 int                  inet6_rthdr_segments (const struct cmsghdr *);
719 size_t               inet6_rthdr_space (int, int);
720 __END_DECLS
721 #endif /* __BSD_VISIBLE */
722 
723 #endif /* !_NETINET6_IN6_H_ */
724