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