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