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