xref: /freebsd/sys/netinet6/in6.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the project nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	$KAME: in6.h,v 1.89 2001/05/27 13:28:35 itojun Exp $
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. Neither the name of the University nor the names of its contributors
47  *    may be used to endorse or promote products derived from this software
48  *    without specific prior written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60  * SUCH DAMAGE.
61  *
62  *	@(#)in.h	8.3 (Berkeley) 1/3/94
63  */
64 
65 #ifndef __KAME_NETINET_IN_H_INCLUDED_
66 #error "do not include netinet6/in6.h directly, include netinet/in.h.  see RFC2553"
67 #endif
68 
69 #ifndef _NETINET6_IN6_H_
70 #define _NETINET6_IN6_H_
71 
72 /*
73  * Identification of the network protocol stack
74  * for *BSD-current/release: http://www.kame.net/dev/cvsweb.cgi/kame/COVERAGE
75  * has the table of implementation/integration differences.
76  */
77 #define __KAME__
78 #define __KAME_VERSION		"FreeBSD"
79 
80 /*
81  * IPv6 port allocation rules should mirror the IPv4 rules and are controlled
82  * by the net.inet.ip.portrange sysctl tree. The following defines exist
83  * for compatibility with userland applications that need them.
84  */
85 #if __BSD_VISIBLE
86 #define	IPV6PORT_RESERVED	1024
87 #define	IPV6PORT_ANONMIN	49152
88 #define	IPV6PORT_ANONMAX	65535
89 #define	IPV6PORT_RESERVEDMIN	600
90 #define	IPV6PORT_RESERVEDMAX	(IPV6PORT_RESERVED-1)
91 #endif
92 
93 /*
94  * IPv6 address
95  */
96 struct in6_addr {
97 	union {
98 		uint8_t		__u6_addr8[16];
99 		uint16_t	__u6_addr16[8];
100 		uint32_t	__u6_addr32[4];
101 	} __u6_addr;			/* 128-bit IP6 address */
102 };
103 
104 #define s6_addr   __u6_addr.__u6_addr8
105 #if defined(_KERNEL) || defined(_STANDALONE) /* XXX nonstandard */
106 #define s6_addr8  __u6_addr.__u6_addr8
107 #define s6_addr16 __u6_addr.__u6_addr16
108 #define s6_addr32 __u6_addr.__u6_addr32
109 #endif
110 
111 #define INET6_ADDRSTRLEN	46
112 
113 /*
114  * XXX missing POSIX.1-2001 macro IPPROTO_IPV6.
115  */
116 
117 /*
118  * Socket address for IPv6
119  */
120 #if __BSD_VISIBLE
121 #define SIN6_LEN
122 #endif
123 
124 struct sockaddr_in6 {
125 	uint8_t		sin6_len;	/* length of this struct */
126 	sa_family_t	sin6_family;	/* AF_INET6 */
127 	in_port_t	sin6_port;	/* Transport layer port # */
128 	uint32_t	sin6_flowinfo;	/* IP6 flow information */
129 	struct in6_addr	sin6_addr;	/* IP6 address */
130 	uint32_t	sin6_scope_id;	/* scope zone index */
131 };
132 
133 /*
134  * Local definition for masks
135  */
136 #ifdef _KERNEL	/* XXX nonstandard */
137 #define IN6MASK0	{{{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }}}
138 #define IN6MASK32	{{{ 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, \
139 			    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
140 #define IN6MASK64	{{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
141 			    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
142 #define IN6MASK96	{{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
143 			    0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00 }}}
144 #define IN6MASK128	{{{ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
145 			    0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }}}
146 #endif
147 
148 #ifdef _KERNEL
149 extern const struct sockaddr_in6 sa6_any;
150 
151 extern const struct in6_addr in6mask0;
152 extern const struct in6_addr in6mask32;
153 extern const struct in6_addr in6mask64;
154 extern const struct in6_addr in6mask96;
155 extern const struct in6_addr in6mask128;
156 #endif /* _KERNEL */
157 
158 /*
159  * Macros started with IPV6_ADDR is KAME local
160  */
161 #ifdef _KERNEL	/* XXX nonstandard */
162 #if _BYTE_ORDER == _BIG_ENDIAN
163 #define IPV6_ADDR_INT32_ONE	1
164 #define IPV6_ADDR_INT32_TWO	2
165 #define IPV6_ADDR_INT32_MNL	0xff010000
166 #define IPV6_ADDR_INT32_MLL	0xff020000
167 #define IPV6_ADDR_INT32_SMP	0x0000ffff
168 #define IPV6_ADDR_INT16_ULL	0xfe80
169 #define IPV6_ADDR_INT16_USL	0xfec0
170 #define IPV6_ADDR_INT16_MLL	0xff02
171 #elif _BYTE_ORDER == _LITTLE_ENDIAN
172 #define IPV6_ADDR_INT32_ONE	0x01000000
173 #define IPV6_ADDR_INT32_TWO	0x02000000
174 #define IPV6_ADDR_INT32_MNL	0x000001ff
175 #define IPV6_ADDR_INT32_MLL	0x000002ff
176 #define IPV6_ADDR_INT32_SMP	0xffff0000
177 #define IPV6_ADDR_INT16_ULL	0x80fe
178 #define IPV6_ADDR_INT16_USL	0xc0fe
179 #define IPV6_ADDR_INT16_MLL	0x02ff
180 #endif
181 #endif
182 
183 /*
184  * Definition of some useful macros to handle IP6 addresses
185  */
186 #if __BSD_VISIBLE
187 #define IN6ADDR_ANY_INIT \
188 	{{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
189 	    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }}}
190 #define IN6ADDR_LOOPBACK_INIT \
191 	{{{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
192 	    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
193 #define IN6ADDR_NODELOCAL_ALLNODES_INIT \
194 	{{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
195 	    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
196 #define IN6ADDR_INTFACELOCAL_ALLNODES_INIT \
197 	{{{ 0xff, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
198 	    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
199 #define IN6ADDR_LINKLOCAL_ALLNODES_INIT \
200 	{{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
201 	    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01 }}}
202 #define IN6ADDR_LINKLOCAL_ALLROUTERS_INIT \
203 	{{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
204 	    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02 }}}
205 #define IN6ADDR_LINKLOCAL_ALLV2ROUTERS_INIT \
206 	{{{ 0xff, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
207 	    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16 }}}
208 #endif
209 
210 extern const struct in6_addr in6addr_any;
211 extern const struct in6_addr in6addr_loopback;
212 #if __BSD_VISIBLE
213 extern const struct in6_addr in6addr_nodelocal_allnodes;
214 extern const struct in6_addr in6addr_linklocal_allnodes;
215 extern const struct in6_addr in6addr_linklocal_allrouters;
216 extern const struct in6_addr in6addr_linklocal_allv2routers;
217 #endif
218 
219 /*
220  * Equality
221  */
222 #if __BSD_VISIBLE
223 #define IN6_ARE_ADDR_EQUAL(a, b)			\
224     (memcmp(&(a)->s6_addr[0], &(b)->s6_addr[0], sizeof(struct in6_addr)) == 0)
225 #endif
226 
227 /*
228  * Unspecified
229  */
230 #define IN6_IS_ADDR_UNSPECIFIED(a)	\
231 	((a)->__u6_addr.__u6_addr32[0] == 0 &&	\
232 	 (a)->__u6_addr.__u6_addr32[1] == 0 &&	\
233 	 (a)->__u6_addr.__u6_addr32[2] == 0 &&	\
234 	 (a)->__u6_addr.__u6_addr32[3] == 0)
235 
236 /*
237  * Loopback
238  */
239 #define IN6_IS_ADDR_LOOPBACK(a)		\
240 	((a)->__u6_addr.__u6_addr32[0] == 0 &&	\
241 	 (a)->__u6_addr.__u6_addr32[1] == 0 &&	\
242 	 (a)->__u6_addr.__u6_addr32[2] == 0 &&	\
243 	 (a)->__u6_addr.__u6_addr32[3] == ntohl(1))
244 
245 /*
246  * IPv4 compatible
247  */
248 #define IN6_IS_ADDR_V4COMPAT(a)		\
249 	((a)->__u6_addr.__u6_addr32[0] == 0 &&	\
250 	 (a)->__u6_addr.__u6_addr32[1] == 0 &&	\
251 	 (a)->__u6_addr.__u6_addr32[2] == 0 &&	\
252 	 (a)->__u6_addr.__u6_addr32[3] != 0 &&	\
253 	 (a)->__u6_addr.__u6_addr32[3] != ntohl(1))
254 
255 /*
256  * Mapped
257  */
258 #define IN6_IS_ADDR_V4MAPPED(a)		      \
259 	((a)->__u6_addr.__u6_addr32[0] == 0 &&	\
260 	 (a)->__u6_addr.__u6_addr32[1] == 0 &&	\
261 	 (a)->__u6_addr.__u6_addr32[2] == ntohl(0x0000ffff))
262 
263 /*
264  * KAME Scope Values
265  */
266 
267 #ifdef _KERNEL	/* XXX nonstandard */
268 #define IPV6_ADDR_SCOPE_NODELOCAL	0x01
269 #define IPV6_ADDR_SCOPE_INTFACELOCAL	0x01
270 #define IPV6_ADDR_SCOPE_LINKLOCAL	0x02
271 #define IPV6_ADDR_SCOPE_SITELOCAL	0x05
272 #define IPV6_ADDR_SCOPE_ORGLOCAL	0x08	/* just used in this file */
273 #define IPV6_ADDR_SCOPE_GLOBAL		0x0e
274 #else
275 #define __IPV6_ADDR_SCOPE_NODELOCAL	0x01
276 #define __IPV6_ADDR_SCOPE_INTFACELOCAL	0x01
277 #define __IPV6_ADDR_SCOPE_LINKLOCAL	0x02
278 #define __IPV6_ADDR_SCOPE_SITELOCAL	0x05
279 #define __IPV6_ADDR_SCOPE_ORGLOCAL	0x08	/* just used in this file */
280 #define __IPV6_ADDR_SCOPE_GLOBAL	0x0e
281 #endif
282 
283 /*
284  * Unicast Scope
285  * Note that we must check topmost 10 bits only, not 16 bits (see RFC2373).
286  */
287 #define IN6_IS_ADDR_LINKLOCAL(a)	\
288 	(((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0x80))
289 #define IN6_IS_ADDR_SITELOCAL(a)	\
290 	(((a)->s6_addr[0] == 0xfe) && (((a)->s6_addr[1] & 0xc0) == 0xc0))
291 
292 /*
293  * Multicast
294  */
295 #define IN6_IS_ADDR_MULTICAST(a)	((a)->s6_addr[0] == 0xff)
296 
297 #ifdef _KERNEL	/* XXX nonstandard */
298 #define IPV6_ADDR_MC_SCOPE(a)		((a)->s6_addr[1] & 0x0f)
299 #else
300 #define __IPV6_ADDR_MC_SCOPE(a)		((a)->s6_addr[1] & 0x0f)
301 #endif
302 
303 /*
304  * Multicast Scope
305  */
306 #ifdef _KERNEL	/* refers nonstandard items */
307 #define IN6_IS_ADDR_MC_NODELOCAL(a)	\
308 	(IN6_IS_ADDR_MULTICAST(a) &&	\
309 	 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_NODELOCAL))
310 #define IN6_IS_ADDR_MC_INTFACELOCAL(a)	\
311 	(IN6_IS_ADDR_MULTICAST(a) &&	\
312 	 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_INTFACELOCAL))
313 #define IN6_IS_ADDR_MC_LINKLOCAL(a)	\
314 	(IN6_IS_ADDR_MULTICAST(a) &&	\
315 	 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_LINKLOCAL))
316 #define IN6_IS_ADDR_MC_SITELOCAL(a)	\
317 	(IN6_IS_ADDR_MULTICAST(a) &&	\
318 	 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_SITELOCAL))
319 #define IN6_IS_ADDR_MC_ORGLOCAL(a)	\
320 	(IN6_IS_ADDR_MULTICAST(a) &&	\
321 	 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_ORGLOCAL))
322 #define IN6_IS_ADDR_MC_GLOBAL(a)	\
323 	(IN6_IS_ADDR_MULTICAST(a) &&	\
324 	 (IPV6_ADDR_MC_SCOPE(a) == IPV6_ADDR_SCOPE_GLOBAL))
325 #else
326 #define IN6_IS_ADDR_MC_NODELOCAL(a)	\
327 	(IN6_IS_ADDR_MULTICAST(a) &&	\
328 	 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_NODELOCAL))
329 #define IN6_IS_ADDR_MC_LINKLOCAL(a)	\
330 	(IN6_IS_ADDR_MULTICAST(a) &&	\
331 	 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_LINKLOCAL))
332 #define IN6_IS_ADDR_MC_SITELOCAL(a)	\
333 	(IN6_IS_ADDR_MULTICAST(a) &&	\
334 	 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_SITELOCAL))
335 #define IN6_IS_ADDR_MC_ORGLOCAL(a)	\
336 	(IN6_IS_ADDR_MULTICAST(a) &&	\
337 	 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_ORGLOCAL))
338 #define IN6_IS_ADDR_MC_GLOBAL(a)	\
339 	(IN6_IS_ADDR_MULTICAST(a) &&	\
340 	 (__IPV6_ADDR_MC_SCOPE(a) == __IPV6_ADDR_SCOPE_GLOBAL))
341 #endif
342 
343 #ifdef _KERNEL	/* nonstandard */
344 /*
345  * KAME Scope
346  */
347 #define IN6_IS_SCOPE_LINKLOCAL(a)	\
348 	((IN6_IS_ADDR_LINKLOCAL(a)) ||	\
349 	 (IN6_IS_ADDR_MC_LINKLOCAL(a)))
350 #define	IN6_IS_SCOPE_EMBED(a)			\
351 	((IN6_IS_ADDR_LINKLOCAL(a)) ||		\
352 	 (IN6_IS_ADDR_MC_LINKLOCAL(a)) ||	\
353 	 (IN6_IS_ADDR_MC_INTFACELOCAL(a)))
354 
355 #define IFA6_IS_DEPRECATED(a) \
356 	((a)->ia6_lifetime.ia6t_pltime != ND6_INFINITE_LIFETIME && \
357 	 (u_int32_t)((time_uptime - (a)->ia6_updatetime)) > \
358 	 (a)->ia6_lifetime.ia6t_pltime)
359 #define IFA6_IS_INVALID(a) \
360 	((a)->ia6_lifetime.ia6t_vltime != ND6_INFINITE_LIFETIME && \
361 	 (u_int32_t)((time_uptime - (a)->ia6_updatetime)) > \
362 	 (a)->ia6_lifetime.ia6t_vltime)
363 #endif /* _KERNEL */
364 
365 /*
366  * IP6 route structure
367  */
368 #if __BSD_VISIBLE
369 struct nhop_object;
370 struct route_in6 {
371 	struct nhop_object *ro_nh;
372 	struct	llentry *ro_lle;
373 	/*
374 	 * ro_prepend and ro_plen are only used for bpf to pass in a
375 	 * preformed header.  They are not cacheable.
376 	 */
377 	char		*ro_prepend;
378 	uint16_t	ro_plen;
379 	uint16_t	ro_flags;
380 	uint16_t	ro_mtu;	/* saved ro_rt mtu */
381 	uint16_t	spare;
382 	struct	sockaddr_in6 ro_dst;
383 };
384 #endif
385 
386 #ifdef _KERNEL
387 #define MTAG_ABI_IPV6		1444287380	/* IPv6 ABI */
388 #define IPV6_TAG_DIRECT		0		/* direct-dispatch IPv6 */
389 #endif /* _KERNEL */
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 /* ipv6_mreq; join a group membership */
409 #define IPV6_LEAVE_GROUP	13 /* ipv6_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; make AF_INET6 sockets v6 only */
425 #ifndef _KERNEL
426 #define IPV6_BINDV6ONLY		IPV6_V6ONLY
427 #endif
428 
429 #define IPV6_IPSEC_POLICY	28 /* struct; get/set security policy */
430 				   /* 29; unused; was IPV6_FAITH */
431 #if 1 /* IPV6FIREWALL */
432 #define IPV6_FW_ADD		30 /* add a firewall rule to chain */
433 #define IPV6_FW_DEL		31 /* delete a firewall rule from chain */
434 #define IPV6_FW_FLUSH		32 /* flush firewall rule chain */
435 #define IPV6_FW_ZERO		33 /* clear single/all firewall counter(s) */
436 #define IPV6_FW_GET		34 /* get entire firewall rule chain */
437 #endif
438 
439 /* new socket options introduced in RFC3542 */
440 #define IPV6_RTHDRDSTOPTS	35 /* ip6_dest; send dst option before rthdr */
441 
442 #define IPV6_RECVPKTINFO	36 /* bool; recv if, dst addr */
443 #define IPV6_RECVHOPLIMIT	37 /* bool; recv hop limit */
444 #define IPV6_RECVRTHDR		38 /* bool; recv routing header */
445 #define IPV6_RECVHOPOPTS	39 /* bool; recv hop-by-hop option */
446 #define IPV6_RECVDSTOPTS	40 /* bool; recv dst option after rthdr */
447 #ifdef _KERNEL
448 #define IPV6_RECVRTHDRDSTOPTS	41 /* bool; recv dst option before rthdr */
449 #endif
450 
451 #define IPV6_USE_MIN_MTU	42 /* bool; send packets at the minimum MTU */
452 #define IPV6_RECVPATHMTU	43 /* bool; notify an according MTU */
453 
454 #define IPV6_PATHMTU		44 /* mtuinfo; get the current path MTU (sopt),
455 				      4 bytes int; MTU notification (cmsg) */
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 
461 /* more new socket options introduced in RFC3542 */
462 #define IPV6_PKTINFO		46 /* in6_pktinfo; send if, src addr */
463 #define IPV6_HOPLIMIT		47 /* int; send hop limit */
464 #define IPV6_NEXTHOP		48 /* sockaddr; next hop addr */
465 #define IPV6_HOPOPTS		49 /* ip6_hbh; send hop-by-hop option */
466 #define IPV6_DSTOPTS		50 /* ip6_dest; send dst option befor rthdr */
467 #define IPV6_RTHDR		51 /* ip6_rthdr; send routing header */
468 #if 0
469 #define IPV6_PKTOPTIONS		52 /* buf/cmsghdr; set/get IPv6 options */
470 				   /* obsoleted by RFC3542 */
471 #endif
472 
473 #define IPV6_RECVTCLASS		57 /* bool; recv traffic class values */
474 
475 #define IPV6_AUTOFLOWLABEL	59 /* bool; attach flowlabel automagically */
476 
477 #define IPV6_TCLASS		61 /* int; send traffic class value */
478 #define IPV6_DONTFRAG		62 /* bool; disable IPv6 fragmentation */
479 
480 #define IPV6_PREFER_TEMPADDR	63 /* int; prefer temporary addresses as
481 				    * the source address.
482 				    */
483 
484 #define	IPV6_BINDANY		64 /* bool: allow bind to any address */
485 				   /* unused; was IPV6_BIND_MULTI */
486 				   /* unused; was IPV6_RSS_LISTEN_BUCKET */
487 #define	IPV6_FLOWID		67 /* int; flowid of given socket */
488 #define	IPV6_FLOWTYPE		68 /* int; flowtype of given socket */
489 #define	IPV6_RSSBUCKETID	69 /* int; RSS bucket ID of given socket */
490 #define	IPV6_RECVFLOWID		70 /* bool; receive IP6 flowid/flowtype w/ datagram */
491 #define	IPV6_RECVRSSBUCKETID	71 /* bool; receive IP6 RSS bucket id w/ datagram */
492 
493 #define	IPV6_ORIGDSTADDR	72 /* bool: allow getting dstaddr /port info */
494 #define	IPV6_RECVORIGDSTADDR	IPV6_ORIGDSTADDR
495 
496 /*
497  * The following option is private; do not use it from user applications.
498  * It is deliberately defined to the same value as IP_MSFILTER.
499  */
500 #define	IPV6_MSFILTER		74 /* struct __msfilterreq;
501 				    * set/get multicast source filter list.
502 				    */
503 
504 /* The following option deals with the 802.1Q Ethernet Priority Code Point */
505 #define	IPV6_VLAN_PCP		75  /* int; set/get PCP used for packet, */
506 				    /*      -1 use interface default */
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  * Limit for IPv6 multicast memberships
522  */
523 #define	IPV6_MAX_MEMBERSHIPS	4095
524 
525 /*
526  * Default resource limits for IPv6 multicast source filtering.
527  * These may be modified by sysctl.
528  */
529 #define	IPV6_MAX_GROUP_SRC_FILTER	512	/* sources per group */
530 #define	IPV6_MAX_SOCK_SRC_FILTER	128	/* sources per socket/group */
531 
532 /*
533  * Argument structure for IPV6_JOIN_GROUP and IPV6_LEAVE_GROUP.
534  */
535 struct ipv6_mreq {
536 	struct in6_addr	ipv6mr_multiaddr;
537 	unsigned int	ipv6mr_interface;
538 };
539 
540 /*
541  * IPV6_PKTINFO: Packet information(RFC2292 sec 5)
542  */
543 struct in6_pktinfo {
544 	struct in6_addr	ipi6_addr;	/* src/dst IPv6 address */
545 	unsigned int	ipi6_ifindex;	/* send/recv interface index */
546 };
547 
548 /*
549  * Control structure for IPV6_RECVPATHMTU socket option.
550  */
551 struct ip6_mtuinfo {
552 	struct sockaddr_in6 ip6m_addr;	/* or sockaddr_storage? */
553 	uint32_t ip6m_mtu;
554 };
555 
556 /*
557  * Argument for IPV6_PORTRANGE:
558  * - which range to search when port is unspecified at bind() or connect()
559  */
560 #define	IPV6_PORTRANGE_DEFAULT	0	/* default range */
561 #define	IPV6_PORTRANGE_HIGH	1	/* "high" - request firewall bypass */
562 #define	IPV6_PORTRANGE_LOW	2	/* "low" - vouchsafe security */
563 
564 #if __BSD_VISIBLE
565 /*
566  * Definitions for inet6 sysctl operations.
567  *
568  * Third level is protocol number.
569  * Fourth level is desired variable within that protocol.
570  */
571 #define IPV6PROTO_MAXID	(IPPROTO_PIM + 1)	/* don't list to IPV6PROTO_MAX */
572 
573 /*
574  * Names for IP sysctl objects
575  */
576 #define IPV6CTL_FORWARDING	1	/* act as router */
577 #define IPV6CTL_SENDREDIRECTS	2	/* may send redirects when forwarding*/
578 #define IPV6CTL_DEFHLIM		3	/* default Hop-Limit */
579 #ifdef notyet
580 #define IPV6CTL_DEFMTU		4	/* default MTU */
581 #endif
582 #define IPV6CTL_FORWSRCRT	5	/* forward source-routed dgrams */
583 #define IPV6CTL_STATS		6	/* stats */
584 #define IPV6CTL_MRTSTATS	7	/* multicast forwarding stats */
585 #define IPV6CTL_MRTPROTO	8	/* multicast routing protocol */
586 #define IPV6CTL_MAXFRAGPACKETS	9	/* max packets reassembly queue */
587 #define IPV6CTL_SOURCECHECK	10	/* verify source route and intf */
588 #define IPV6CTL_SOURCECHECK_LOGINT 11	/* minimume logging interval */
589 #define IPV6CTL_ACCEPT_RTADV	12
590 					/* 13; unused; was: IPV6CTL_KEEPFAITH */
591 #define IPV6CTL_LOG_INTERVAL	14
592 #define IPV6CTL_HDRNESTLIMIT	15
593 #define IPV6CTL_DAD_COUNT	16
594 #define IPV6CTL_AUTO_FLOWLABEL	17
595 #define IPV6CTL_DEFMCASTHLIM	18
596 #define IPV6CTL_GIF_HLIM	19	/* default HLIM for gif encap packet */
597 #define IPV6CTL_KAME_VERSION	20
598 #define IPV6CTL_USE_DEPRECATED	21	/* use deprecated addr (RFC2462 5.5.4) */
599 #define IPV6CTL_RR_PRUNE	22	/* walk timer for router renumbering */
600 #if 0	/* obsolete */
601 #define IPV6CTL_MAPPED_ADDR	23
602 #endif
603 #define IPV6CTL_V6ONLY		24
604 /*	IPV6CTL_RTEXPIRE	25	deprecated */
605 /*	IPV6CTL_RTMINEXPIRE	26	deprecated */
606 /*	IPV6CTL_RTMAXCACHE	27	deprecated */
607 
608 #define IPV6CTL_USETEMPADDR	32	/* use temporary addresses (RFC3041) */
609 #define IPV6CTL_TEMPPLTIME	33	/* preferred lifetime for tmpaddrs */
610 #define IPV6CTL_TEMPVLTIME	34	/* valid lifetime for tmpaddrs */
611 #define IPV6CTL_AUTO_LINKLOCAL	35	/* automatic link-local addr assign */
612 #define IPV6CTL_RIP6STATS	36	/* raw_ip6 stats */
613 #define IPV6CTL_PREFER_TEMPADDR	37	/* prefer temporary addr as src */
614 #define IPV6CTL_ADDRCTLPOLICY	38	/* get/set address selection policy */
615 #define IPV6CTL_USE_DEFAULTZONE	39	/* use default scope zone */
616 
617 #define IPV6CTL_MAXFRAGS	41	/* max fragments */
618 #if 0
619 #define IPV6CTL_IFQ		42	/* ip6intrq node */
620 #define IPV6CTL_ISATAPRTR	43	/* isatap router */
621 #endif
622 #define IPV6CTL_MCAST_PMTU	44	/* enable pMTU discovery for multicast? */
623 
624 /* New entries should be added here from current IPV6CTL_MAXID value. */
625 /* to define items, should talk with KAME guys first, for *BSD compatibility */
626 #define IPV6CTL_STEALTH		45
627 
628 #define	ICMPV6CTL_ND6_ONLINKNSRFC4861	47
629 #define	IPV6CTL_NO_RADR		48	/* No defroute from RA */
630 #define	IPV6CTL_NORBIT_RAIF	49	/* Disable R-bit in NA on RA
631 					 * receiving IF. */
632 #define	IPV6CTL_RFC6204W3	50	/* Accept defroute even when forwarding
633 					   enabled */
634 #define	IPV6CTL_INTRQMAXLEN	51	/* max length of IPv6 netisr queue */
635 #define	IPV6CTL_INTRDQMAXLEN	52	/* max length of direct IPv6 netisr
636 					 * queue */
637 #define	IPV6CTL_MAXFRAGSPERPACKET	53 /* Max fragments per packet */
638 #define	IPV6CTL_MAXFRAGBUCKETSIZE	54 /* Max reassembly queues per bucket */
639 #define	IPV6CTL_MAXID		55
640 #endif /* __BSD_VISIBLE */
641 
642 /*
643  * Since both netinet/ and netinet6/ call into netipsec/ and netpfil/,
644  * the protocol specific mbuf flags are shared between them.
645  */
646 #define	M_FASTFWD_OURS		M_PROTO1	/* changed dst to local */
647 #define	M_IP6_NEXTHOP		M_PROTO2	/* explicit ip nexthop */
648 #define	M_IP_NEXTHOP		M_PROTO2	/* explicit ip nexthop */
649 #define	M_SKIP_FIREWALL		M_PROTO3	/* skip firewall processing */
650 #define	M_AUTHIPHDR		M_PROTO4
651 #define	M_DECRYPTED		M_PROTO5
652 #define	M_LOOP			M_PROTO6
653 #define	M_AUTHIPDGM		M_PROTO7
654 #define	M_RTALERT_MLD		M_PROTO8
655 #define	M_FRAGMENTED		M_PROTO9	/* contained fragment header */
656 
657 #ifdef _KERNEL
658 struct cmsghdr;
659 struct ip6_hdr;
660 
661 int	in6_cksum(struct mbuf *, uint8_t, uint32_t, uint32_t);
662 int	in6_cksum_partial(struct mbuf *, uint8_t, uint32_t, uint32_t, uint32_t);
663 int	in6_cksum_pseudo(struct ip6_hdr *, uint32_t, uint8_t, uint16_t);
664 
665 int	in6_localaddr(struct in6_addr *);
666 int	in6_localip(struct in6_addr *);
667 bool	in6_localip_fib(struct in6_addr *, uint16_t);
668 int	in6_ifhasaddr(struct ifnet *, struct in6_addr *);
669 int	in6_addrscope(const struct in6_addr *);
670 char	*ip6_sprintf(char *, const struct in6_addr *);
671 struct	in6_ifaddr *in6_ifawithifp(struct ifnet *, struct in6_addr *);
672 extern void in6_if_up(struct ifnet *);
673 struct sockaddr;
674 
675 void	in6_sin6_2_sin(struct sockaddr_in *sin,
676 			    struct sockaddr_in6 *sin6);
677 void	in6_sin_2_v4mapsin6(struct sockaddr_in *sin,
678 				 struct sockaddr_in6 *sin6);
679 void	in6_sin6_2_sin_in_sock(struct sockaddr *nam);
680 void	in6_sin_2_v4mapsin6_in_sock(struct sockaddr **nam);
681 extern void addrsel_policy_init(void);
682 
683 #define	satosin6(sa)	((struct sockaddr_in6 *)(sa))
684 #define	sin6tosa(sin6)	((struct sockaddr *)(sin6))
685 #define	ifatoia6(ifa)	((struct in6_ifaddr *)(ifa))
686 
687 #endif /* _KERNEL */
688 
689 #ifndef _SIZE_T_DECLARED
690 typedef	__size_t	size_t;
691 #define	_SIZE_T_DECLARED
692 #endif
693 
694 #ifndef _SOCKLEN_T_DECLARED
695 typedef	__socklen_t	socklen_t;
696 #define	_SOCKLEN_T_DECLARED
697 #endif
698 
699 #if __BSD_VISIBLE
700 
701 __BEGIN_DECLS
702 struct cmsghdr;
703 
704 extern int inet6_option_space(int);
705 extern int inet6_option_init(void *, struct cmsghdr **, int);
706 extern int inet6_option_append(struct cmsghdr *, const uint8_t *,
707 	int, int);
708 extern uint8_t *inet6_option_alloc(struct cmsghdr *, int, int, int);
709 extern int inet6_option_next(const struct cmsghdr *, uint8_t **);
710 extern int inet6_option_find(const struct cmsghdr *, uint8_t **, int);
711 
712 extern size_t inet6_rthdr_space(int, int);
713 extern struct cmsghdr *inet6_rthdr_init(void *, int);
714 extern int inet6_rthdr_add(struct cmsghdr *, const struct in6_addr *,
715 	unsigned int);
716 extern int inet6_rthdr_lasthop(struct cmsghdr *, unsigned int);
717 #if 0 /* not implemented yet */
718 extern int inet6_rthdr_reverse(const struct cmsghdr *, struct cmsghdr *);
719 #endif
720 extern int inet6_rthdr_segments(const struct cmsghdr *);
721 extern struct in6_addr *inet6_rthdr_getaddr(struct cmsghdr *, int);
722 extern int inet6_rthdr_getflags(const struct cmsghdr *, int);
723 
724 extern int inet6_opt_init(void *, socklen_t);
725 extern int inet6_opt_append(void *, socklen_t, int, uint8_t, socklen_t,
726 	uint8_t, void **);
727 extern int inet6_opt_finish(void *, socklen_t, int);
728 extern int inet6_opt_set_val(void *, int, void *, socklen_t);
729 
730 extern int inet6_opt_next(void *, socklen_t, int, uint8_t *, socklen_t *,
731 	void **);
732 extern int inet6_opt_find(void *, socklen_t, int, uint8_t, socklen_t *,
733 	void **);
734 extern int inet6_opt_get_val(void *, int, void *, socklen_t);
735 extern socklen_t inet6_rth_space(int, int);
736 extern void *inet6_rth_init(void *, socklen_t, int, int);
737 extern int inet6_rth_add(void *, const struct in6_addr *);
738 extern int inet6_rth_reverse(const void *, void *);
739 extern int inet6_rth_segments(const void *);
740 extern struct in6_addr *inet6_rth_getaddr(const void *, int);
741 __END_DECLS
742 
743 #endif /* __BSD_VISIBLE */
744 
745 #endif /* !_NETINET6_IN6_H_ */
746