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