Adjust for the removal of the net.inet6.ip6.v6only sysctl.
[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         uint8_t         sin6_family;    /* AF_INET6 (sa_family_t) */
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_LINKLOCAL_ALLNODES_INIT                                 \
233         {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,             \
234             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
235 #define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT                               \
236         {{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,             \
237             0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 }}}
238
239 #ifdef _KERNEL
240 extern const struct in6_addr kin6addr_any;
241 extern const struct in6_addr kin6addr_loopback;
242 extern const struct in6_addr kin6addr_nodelocal_allnodes;
243 extern const struct in6_addr kin6addr_linklocal_allnodes;
244 extern const struct in6_addr kin6addr_linklocal_allrouters;
245 #else
246 extern const struct in6_addr in6addr_any;
247 extern const struct in6_addr in6addr_loopback;
248 extern const struct in6_addr in6addr_nodelocal_allnodes;
249 extern const struct in6_addr in6addr_linklocal_allnodes;
250 #endif
251
252 #define IN6_ARE_ADDR_EQUAL(a, b)                                        \
253     (memcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof(struct in6_addr)) == 0)
254
255 #ifdef _KERNEL                  /* non standard */
256 /* see if two addresses are equal in a scope-conscious manner. */
257 #define SA6_ARE_ADDR_EQUAL(a, b) \
258         (((a)->sin6_scope_id == 0 || (b)->sin6_scope_id == 0 ||         \
259           (a)->sin6_scope_id == (b)->sin6_scope_id) &&                  \
260          (bcmp(&(a)->sin6_addr, &(b)->sin6_addr, sizeof(struct in6_addr)) == 0))
261 #endif
262
263 /*
264  * Unspecified
265  */
266 #define IN6_IS_ADDR_UNSPECIFIED(a)                                      \
267         ((a)->_s6_addr32[0] == 0 && (a)->_s6_addr32[1] == 0 &&          \
268          (a)->_s6_addr32[2] == 0 && (a)->_s6_addr32[3] == 0)
269
270 /*
271  * Loopback
272  */
273 #define IN6_IS_ADDR_LOOPBACK(a)                                         \
274         ((a)->_s6_addr32[0] == 0 && (a)->_s6_addr32[1] == 0 &&  \
275          (a)->_s6_addr32[2] == 0 && (a)->_s6_addr32[3] == ntohl(1))
276
277 /*
278  * Mapped
279  */
280 #define IN6_IS_ADDR_V4MAPPED(a)                                         \
281         ((a)->_s6_addr32[0] == 0 && (a)->_s6_addr32[1] == 0 &&          \
282          (a)->_s6_addr32[2] == ntohl(0x0000ffff))
283
284 /*
285  * IPv4 compatible.  Deprecated by RFC4291.
286  */
287 #define IN6_IS_ADDR_V4COMPAT(a)                                         \
288         ((a)->_s6_addr32[0] == 0 &&                                     \
289          (a)->_s6_addr32[1] == 0 &&                                     \
290          (a)->_s6_addr32[2] == 0 &&                                     \
291          (a)->_s6_addr32[3] != 0 && (a)->_s6_addr32[3] != ntohl(1))
292
293 /*
294  * KAME Scope Values
295  */
296
297 #define __IPV6_ADDR_SCOPE_NODELOCAL     0x01
298 #define __IPV6_ADDR_SCOPE_LINKLOCAL     0x02
299 #define __IPV6_ADDR_SCOPE_SITELOCAL     0x05
300 #define __IPV6_ADDR_SCOPE_ORGLOCAL      0x08    /* just used in this file */
301 #define __IPV6_ADDR_SCOPE_GLOBAL        0x0e
302
303 #ifdef _KERNEL                                  /* XXX nonstandard */
304 #define IPV6_ADDR_SCOPE_NODELOCAL       0x01
305 #define IPV6_ADDR_SCOPE_INTFACELOCAL    0x01
306 #define IPV6_ADDR_SCOPE_LINKLOCAL       0x02
307 #define IPV6_ADDR_SCOPE_SITELOCAL       0x05
308 #define IPV6_ADDR_SCOPE_ORGLOCAL        0x08    /* just used in this file */
309 #define IPV6_ADDR_SCOPE_GLOBAL          0x0e
310 #endif
311
312 /*
313  * Unicast Scope
314  * Note that we must check topmost 10 bits only, not 16 bits (see RFC2373).
315  */
316 #define IN6_IS_ADDR_LINKLOCAL(a)                                        \
317     (((a)->_s6_addr16[0] & _IPV6_ADDR_INT16_UL_MASK) == _IPV6_ADDR_INT16_ULL)
318 #define IN6_IS_ADDR_SITELOCAL(a)                                        \
319     (((a)->_s6_addr16[0] & _IPV6_ADDR_INT16_UL_MASK) == _IPV6_ADDR_INT16_USL)
320
321 /*
322  * Multicast
323  */
324 #define IN6_IS_ADDR_MULTICAST(a)        ((a)->s6_addr[0] == 0xff)
325 #define __IPV6_ADDR_MC_SCOPE(a)         ((a)->s6_addr[1] & 0x0f)
326 #ifdef _KERNEL                                  /* XXX nonstandard */
327 #define IPV6_ADDR_MC_SCOPE(a)           __IPV6_ADDR_MC_SCOPE(a)
328 #endif
329
330 /*
331  * Multicast Scope
332  */
333 #define IN6_IS_ADDR_MC_NODELOCAL(a)                                     \
334         (IN6_IS_ADDR_MULTICAST(a) &&                                    \
335          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_NODELOCAL))
336
337 #define IN6_IS_ADDR_MC_INTFACELOCAL(a)                                  \
338         (IN6_IS_ADDR_MULTICAST(a) &&                                    \
339          (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_INTFACELOCAL))
340
341 #define IN6_IS_ADDR_MC_LINKLOCAL(a)                                     \
342         (IN6_IS_ADDR_MULTICAST(a) &&                                    \
343          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_LINKLOCAL))
344
345 #define IN6_IS_ADDR_MC_SITELOCAL(a)                                     \
346         (IN6_IS_ADDR_MULTICAST(a) &&                                    \
347          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_SITELOCAL))
348
349 #define IN6_IS_ADDR_MC_ORGLOCAL(a)                                      \
350         (IN6_IS_ADDR_MULTICAST(a) &&                                    \
351          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_ORGLOCAL))
352
353 #define IN6_IS_ADDR_MC_GLOBAL(a)                                        \
354         (IN6_IS_ADDR_MULTICAST(a) &&                                    \
355          (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_GLOBAL))
356
357 #ifdef _KERNEL  /* nonstandard */
358 /*
359  * KAME Scope
360  */
361 #define IN6_IS_SCOPE_LINKLOCAL(a)                                       \
362         (IN6_IS_ADDR_LINKLOCAL(a) || IN6_IS_ADDR_MC_LINKLOCAL(a))
363 #define IN6_IS_SCOPE_EMBED(a)                                           \
364         ((IN6_IS_ADDR_LINKLOCAL(a)) ||                                  \
365          (IN6_IS_ADDR_MC_LINKLOCAL(a)) ||                               \
366          (IN6_IS_ADDR_MC_INTFACELOCAL(a)))
367
368
369 #define IFA6_IS_DEPRECATED(a)                                           \
370         ((a)->ia6_lifetime.ia6t_preferred != 0 &&                       \
371          (a)->ia6_lifetime.ia6t_preferred < time_uptime)
372
373 #define IFA6_IS_INVALID(a)                                              \
374         ((a)->ia6_lifetime.ia6t_expire != 0 &&                          \
375          (a)->ia6_lifetime.ia6t_expire < time_uptime)
376 #endif
377
378 /*
379  * IP6 route structure
380  */
381 #ifndef _XOPEN_SOURCE
382 struct route_in6 {
383         struct rtentry          *ro_rt;
384         struct sockaddr_in6     ro_dst;
385 };
386 #endif
387
388 /*
389  * Options for use with [gs]etsockopt at the IPV6 level.
390  * First word of comment is data type; bool is stored in int.
391  */
392 /* no hdrincl */
393 #if 0 /* the followings are relic in IPv4 and hence are disabled */
394 #define IPV6_OPTIONS            1  /* buf/ip6_opts; set/get IP6 options */
395 #define IPV6_RECVOPTS           5  /* bool; receive all IP6 opts w/dgram */
396 #define IPV6_RECVRETOPTS        6  /* bool; receive IP6 opts for response */
397 #define IPV6_RECVDSTADDR        7  /* bool; receive IP6 dst addr w/dgram */
398 #define IPV6_RETOPTS            8  /* ip6_opts; set/get IP6 options */
399 #endif
400 #define IPV6_SOCKOPT_RESERVED1  3  /* reserved for future use */
401 #define IPV6_UNICAST_HOPS       4  /* int; IP6 hops */
402 #define IPV6_MULTICAST_IF       9  /* u_int; set/get IP6 multicast i/f  */
403 #define IPV6_MULTICAST_HOPS     10 /* int; set/get IP6 multicast hops */
404 #define IPV6_MULTICAST_LOOP     11 /* u_int; set/get IP6 multicast loopback */
405 #define IPV6_JOIN_GROUP         12 /* ip6_mreq; join a group membership */
406 #define IPV6_LEAVE_GROUP        13 /* ip6_mreq; leave a group membership */
407 #define IPV6_PORTRANGE          14 /* int; range to choose for unspec port */
408 #define ICMP6_FILTER            18 /* icmp6_filter; icmp6 filter */
409 /* RFC2292 options */
410 #ifdef _KERNEL
411 #define IPV6_2292PKTINFO        19 /* bool; send/recv if, src/dst addr */
412 #define IPV6_2292HOPLIMIT       20 /* bool; hop limit */
413 #define IPV6_2292NEXTHOP        21 /* bool; next hop addr */
414 #define IPV6_2292HOPOPTS        22 /* bool; hop-by-hop option */
415 #define IPV6_2292DSTOPTS        23 /* bool; destinaion option */
416 #define IPV6_2292RTHDR          24 /* bool; routing header */
417 #define IPV6_2292PKTOPTIONS     25 /* buf/cmsghdr; set/get IPv6 options */
418 #endif
419
420 #define IPV6_CHECKSUM           26 /* int; checksum offset for raw socket */
421 #define IPV6_V6ONLY             27 /* bool; only bind INET6 at wildcard bind */
422 #ifndef _KERNEL
423 #define IPV6_BINDV6ONLY         IPV6_V6ONLY
424 #endif
425
426 #if 1 /* IPSEC */
427 #define IPV6_IPSEC_POLICY       28 /* struct; get/set security policy */
428 #endif
429 #define IPV6_FAITH              29 /* bool; accept FAITH'ed connections */
430
431 #if 1 /* IPV6FIREWALL */
432 #define IPV6_FW_ADD             30 /* add a firewall rule to chain */
433 #define IPV6_FW_DEL             31 /* delete a firewall rule from chain */
434 #define IPV6_FW_FLUSH           32 /* flush firewall rule chain */
435 #define IPV6_FW_ZERO            33 /* clear single/all firewall counter(s) */
436 #define IPV6_FW_GET             34 /* get entire firewall rule chain */
437 #endif
438
439 /* 
440  * new socket options introduced in RFC3542 
441  */
442 #define IPV6_RTHDRDSTOPTS       35 /* ip6_dest; send dst option before rthdr */
443 #define IPV6_RECVPKTINFO        36 /* bool; recv if, dst addr */
444 #define IPV6_RECVHOPLIMIT       37 /* bool; recv hop limit */
445 #define IPV6_RECVRTHDR          38 /* bool; recv routing header */
446 #define IPV6_RECVHOPOPTS        39 /* bool; recv hop-by-hop option */
447 #define IPV6_RECVDSTOPTS        40 /* bool; recv dst option after rthdr */
448 #ifdef _KERNEL
449 #define IPV6_RECVRTHDRDSTOPTS   41 /* bool; recv dst option before rthdr */
450 #endif
451 #define IPV6_USE_MIN_MTU        42 /* bool; send packets at the minimum MTU */
452 #define IPV6_RECVPATHMTU        43 /* bool; notify an according MTU */
453
454 /* mtuinfo; get the current path MTU (sopt),
455  * 4 bytes int; MTU notification (cmsg) 
456  */
457 #define IPV6_PATHMTU            44 
458 #if 0 /*obsoleted during 2292bis -> 3542*/
459 #define IPV6_REACHCONF          45 /* no data; ND reachability confirm
460                                       (cmsg only/not in of RFC3542) */
461 #endif
462 #define IPV6_PKTINFO            46 /* in6_pktinfo; send if, src addr */
463 #define IPV6_HOPLIMIT           47 /* int; send hop limit */
464 #define IPV6_NEXTHOP            48 /* sockaddr; next hop addr */
465 #define IPV6_HOPOPTS            49 /* ip6_hbh; send hop-by-hop option */
466 #define IPV6_DSTOPTS            50 /* ip6_dest; send dst option befor rthdr */
467 #define IPV6_RTHDR              51 /* ip6_rthdr; send routing header */
468 #define IPV6_PKTOPTIONS         52 /* buf/cmsghdr; set/get IPv6 options, this is obsoleted by RFC3542 */
469
470 #define IPV6_RECVTCLASS         57 /* bool; recv traffic class values */
471
472 #define IPV6_AUTOFLOWLABEL      59 /* bool; attach flowlabel automagically */
473
474 #define IPV6_TCLASS             61 /* int; send traffic class value */
475 #define IPV6_DONTFRAG           62 /* bool; disable IPv6 fragmentation */
476
477 #define IPV6_PREFER_TEMPADDR    63 /* int; prefer temporary addresses as
478                                     * the source address.
479                                     */
480 /*
481  * The following option is private; do not use it from user applications.
482  * It is deliberately defined to the same value as IP_MSFILTER.
483  */
484 #define IPV6_MSFILTER           74 /* struct __msfilterreq;
485                                     * set/get multicast source filter list.
486                                     */ 
487 /* to define items, should talk with KAME guys first, for *BSD compatibility */
488
489 #define IPV6_RTHDR_LOOSE     0 /* this hop need not be a neighbor. XXX old spec */
490 #define IPV6_RTHDR_STRICT    1 /* this hop must be a neighbor. XXX old spec */
491 #define IPV6_RTHDR_TYPE_0    0 /* IPv6 routing header type 0 */
492
493 /*
494  * Defaults and limits for options
495  */
496 #define IPV6_DEFAULT_MULTICAST_HOPS 1   /* normally limit m'casts to 1 hop */
497 #define IPV6_DEFAULT_MULTICAST_LOOP 1   /* normally hear sends if a member */
498
499 /*
500  * Argument structure for IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP.
501  */
502 struct ipv6_mreq {
503         struct in6_addr ipv6mr_multiaddr;
504         unsigned int    ipv6mr_interface;
505 };
506
507 /*
508  * IPV6_PKTINFO: Packet information(RFC2292 sec 5)
509  */
510 struct in6_pktinfo {
511         struct in6_addr ipi6_addr;      /* src/dst IPv6 address */
512         unsigned int    ipi6_ifindex;   /* send/recv interface index */
513 };
514
515 /*
516  * New Control structure for IPV6_RECVPATHMTU socket option introduced in RFC3542.
517  */
518 struct ip6_mtuinfo {
519         struct sockaddr_in6 ip6m_addr;  /* or sockaddr_storage? */
520         uint32_t ip6m_mtu;
521 };
522
523 /*
524  * Argument for IPV6_PORTRANGE:
525  * - which range to search when port is unspecified at bind() or connect()
526  */
527 #define IPV6_PORTRANGE_DEFAULT  0       /* default range */
528 #define IPV6_PORTRANGE_HIGH     1       /* "high" - request firewall bypass */
529 #define IPV6_PORTRANGE_LOW      2       /* "low" - vouchsafe security */
530
531 #ifndef _XOPEN_SOURCE
532 /*
533  * Definitions for inet6 sysctl operations.
534  *
535  * Third level is protocol number.
536  * Fourth level is desired variable within that protocol.
537  */
538 #define IPV6PROTO_MAXID (IPPROTO_PIM + 1)       /* don't list to IPV6PROTO_MAX */
539
540 #define CTL_IPV6PROTO_NAMES {                                   \
541         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
542         { 0, 0 },                                               \
543         { "tcp6", CTLTYPE_NODE },                               \
544         { 0, 0 },                                               \
545         { 0, 0 },                                               \
546         { 0, 0 },                                               \
547         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
548         { 0, 0 },                                               \
549         { 0, 0 },                                               \
550         { "udp6", CTLTYPE_NODE },                               \
551         { 0, 0 },                                               \
552         { 0, 0 },                                               \
553         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
554         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
555         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
556         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
557         { 0, 0 },                                               \
558         { "ip6", CTLTYPE_NODE },                                \
559         { 0, 0 },                                               \
560         { 0, 0 },                                               \
561         { 0, 0 },                                               \
562         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
563         { 0, 0 },                                               \
564         { "ipsec6", CTLTYPE_NODE },                             \
565         { 0, 0 },                                               \
566         { 0, 0 },                                               \
567         { 0, 0 },                                               \
568         { 0, 0 },                                               \
569         { 0, 0 },                                               \
570         { 0, 0 },                                               \
571         { "icmp6", CTLTYPE_NODE },                              \
572         { 0, 0 },                                               \
573         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
574         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
575         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
576         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
577         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
578         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
579         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
580         { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 }, { 0, 0 },       \
581         { 0, 0 },                                               \
582         { 0, 0 },                                               \
583         { 0, 0 },                                               \
584         { "pim6", CTLTYPE_NODE },                               \
585 }
586
587 /*
588  * Names for IP sysctl objects
589  */
590 #define IPV6CTL_FORWARDING      1       /* act as router */
591 #define IPV6CTL_SENDREDIRECTS   2       /* may send redirects when forwarding*/
592 #define IPV6CTL_DEFHLIM         3       /* default Hop-Limit */
593 #ifdef notyet
594 #define IPV6CTL_DEFMTU          4       /* default MTU */
595 #endif
596 #define IPV6CTL_FORWSRCRT       5       /* forward source-routed dgrams */
597 #define IPV6CTL_STATS           6       /* stats */
598 #define IPV6CTL_MRTSTATS        7       /* multicast forwarding stats */
599 #define IPV6CTL_MRTPROTO        8       /* multicast routing protocol */
600 #define IPV6CTL_MAXFRAGPACKETS  9       /* max packets reassembly queue */
601 #define IPV6CTL_SOURCECHECK     10      /* verify source route and intf */
602 #define IPV6CTL_SOURCECHECK_LOGINT 11   /* minimume logging interval */
603 #define IPV6CTL_ACCEPT_RTADV    12
604 #define IPV6CTL_KEEPFAITH       13
605 #define IPV6CTL_LOG_INTERVAL    14
606 #define IPV6CTL_HDRNESTLIMIT    15
607 #define IPV6CTL_DAD_COUNT       16
608 #define IPV6CTL_AUTO_FLOWLABEL  17
609 #define IPV6CTL_DEFMCASTHLIM    18
610 #define IPV6CTL_GIF_HLIM        19      /* default HLIM for gif encap packet */
611 #define IPV6CTL_KAME_VERSION    20
612 #define IPV6CTL_USE_DEPRECATED  21      /* use deprecated addr (RFC2462 5.5.4) */
613 #define IPV6CTL_RR_PRUNE        22      /* walk timer for router renumbering */
614 #if 0   /* obsolete */
615 #define IPV6CTL_MAPPED_ADDR     23
616 #define IPV6CTL_V6ONLY          24
617 #endif
618 #define IPV6CTL_RTEXPIRE        25      /* cloned route expiration time */
619 #define IPV6CTL_RTMINEXPIRE     26      /* min value for expiration time */
620 #define IPV6CTL_RTMAXCACHE      27      /* trigger level for dynamic expire */
621
622 #define IPV6CTL_USETEMPADDR     32      /* use temporary addresses (RFC3041) */
623 #define IPV6CTL_TEMPPLTIME      33      /* preferred lifetime for tmpaddrs */
624 #define IPV6CTL_TEMPVLTIME      34      /* valid lifetime for tmpaddrs */
625 #define IPV6CTL_AUTO_LINKLOCAL  35      /* automatic link-local addr assign */
626 #define IPV6CTL_RIP6STATS       36      /* raw_ip6 stats */
627
628 #define IPV6CTL_ADDRCTLPOLICY   38      /* get/set address selection policy */
629
630 /* New entries should be added here from current IPV6CTL_MAXID value. */
631 /* to define items, should talk with KAME guys first, for *BSD compatibility */
632 #define IPV6CTL_MAXID           42
633
634 #endif /* !_XOPEN_SOURCE */
635
636 /*
637  * Redefinition of mbuf flags
638  */
639 #define M_AUTHIPHDR     M_PROTO2
640 #define M_DECRYPTED     M_PROTO3
641 #define M_LOOP          M_PROTO4
642 #define M_AUTHIPDGM     M_PROTO5
643
644 #ifdef _KERNEL
645
646 struct ifnet;
647 struct mbuf;
648 struct sockaddr;
649 struct sockaddr_in;
650 struct sockaddr_in6;
651
652 int     in6_cksum (struct mbuf *, uint8_t, uint32_t, uint32_t);
653 int     in6_localaddr (struct in6_addr *);
654 int     in6_addrscope (struct in6_addr *);
655 struct  in6_ifaddr *in6_ifawithscope (struct ifnet *, struct in6_addr *, struct ucred *);
656 struct  in6_ifaddr *in6_ifawithifp (struct ifnet *, struct in6_addr *);
657 void    in6_if_up (struct ifnet *);
658
659 void    in6_sin6_2_sin (struct sockaddr_in *sin, struct sockaddr_in6 *sin6);
660 void    in6_sin_2_v4mapsin6(struct sockaddr_in *sin, struct sockaddr_in6 *sin6);
661 void    in6_sin6_2_sin_in_sock (struct sockaddr *nam);
662 void    in6_sin_2_v4mapsin6_in_sock (struct sockaddr **nam);
663 void    addrsel_policy_init (void);
664
665 #define satosin6(sa)    ((struct sockaddr_in6 *)(sa))
666 #define sin6tosa(sin6)  ((struct sockaddr *)(sin6))
667 #define ifatoia6(ifa)   ((struct in6_ifaddr *)(ifa))
668
669 extern int (*faithprefix_p)(struct in6_addr *);
670 #endif /* _KERNEL */
671
672 #include <sys/cdefs.h>          /* for __BEGIN_DECLS and __END_DECLS */
673
674 __BEGIN_DECLS
675 struct cmsghdr;
676
677 uint8_t *inet6_option_alloc (struct cmsghdr *, int, int, int);
678 int inet6_option_append (struct cmsghdr *, const uint8_t *, int, int);
679 int inet6_option_find (const struct cmsghdr *, uint8_t **, int);
680 int inet6_option_init (void *, struct cmsghdr **, int);
681 int inet6_option_next (const struct cmsghdr *, uint8_t **);
682 int inet6_option_space (int);
683
684 int inet6_opt_append (void *, socklen_t, int, uint8_t, socklen_t, uint8_t, void **);
685 int inet6_opt_find (void *, socklen_t, int, uint8_t, socklen_t *, void **);
686 int inet6_opt_finish (void *, socklen_t, int);
687 int inet6_opt_get_val (void *, int, void *, socklen_t);
688 int inet6_opt_init (void *, socklen_t);
689 int inet6_opt_next (void *, socklen_t, int, uint8_t *, socklen_t *, void **);
690 int inet6_opt_set_val (void *, int, void *, socklen_t);
691
692 int              inet6_rth_add (void *, const struct in6_addr *);
693 struct in6_addr *inet6_rth_getaddr (const void *, int);
694 void            *inet6_rth_init (void *, socklen_t, int, int);
695 int              inet6_rth_reverse (const void *, void *);
696 int              inet6_rth_segments (const void *);
697 socklen_t        inet6_rth_space (int, int);
698
699 int              inet6_rthdr_add (struct cmsghdr *, const struct in6_addr *,
700                                   unsigned int);
701 struct in6_addr *inet6_rthdr_getaddr (struct cmsghdr *, int);
702 int              inet6_rthdr_getflags (const struct cmsghdr *, int);
703 struct cmsghdr  *inet6_rthdr_init (void *, int);
704 int              inet6_rthdr_lasthop (struct cmsghdr *, unsigned int);
705 #if 0                                   /* not implemented yet */
706 int              inet6_rthdr_reverse (const struct cmsghdr *, struct cmsghdr *);
707 #endif
708 int              inet6_rthdr_segments (const struct cmsghdr *);
709 size_t           inet6_rthdr_space (int, int);
710 __END_DECLS
711
712 #endif /* !_NETINET6_IN6_H_ */