xref: /freebsd/sys/netinet6/in6_var.h (revision 5bf5ca772c6de2d53344a78cf461447cc322ccea)
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_var.h,v 1.56 2001/03/29 05:34:31 itojun Exp $
32  */
33 
34 /*-
35  * Copyright (c) 1985, 1986, 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_var.h	8.1 (Berkeley) 6/10/93
63  * $FreeBSD$
64  */
65 
66 #ifndef _NETINET6_IN6_VAR_H_
67 #define _NETINET6_IN6_VAR_H_
68 
69 #include <sys/tree.h>
70 #include <sys/counter.h>
71 
72 #ifdef _KERNEL
73 #include <sys/fnv_hash.h>
74 #include <sys/libkern.h>
75 #endif
76 
77 /*
78  * Interface address, Internet version.  One of these structures
79  * is allocated for each interface with an Internet address.
80  * The ifaddr structure contains the protocol-independent part
81  * of the structure and is assumed to be first.
82  */
83 
84 /*
85  * pltime/vltime are just for future reference (required to implements 2
86  * hour rule for hosts).  they should never be modified by nd6_timeout or
87  * anywhere else.
88  *	userland -> kernel: accept pltime/vltime
89  *	kernel -> userland: throw up everything
90  *	in kernel: modify preferred/expire only
91  */
92 struct in6_addrlifetime {
93 	time_t ia6t_expire;	/* valid lifetime expiration time */
94 	time_t ia6t_preferred;	/* preferred lifetime expiration time */
95 	u_int32_t ia6t_vltime;	/* valid lifetime */
96 	u_int32_t ia6t_pltime;	/* prefix lifetime */
97 };
98 
99 struct nd_ifinfo;
100 struct scope6_id;
101 struct lltable;
102 struct mld_ifsoftc;
103 
104 struct in6_ifextra {
105 	counter_u64_t *in6_ifstat;
106 	counter_u64_t *icmp6_ifstat;
107 	struct nd_ifinfo *nd_ifinfo;
108 	struct scope6_id *scope6_id;
109 	struct lltable *lltable;
110 	struct mld_ifsoftc *mld_ifinfo;
111 };
112 
113 #define	LLTABLE6(ifp)	(((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->lltable)
114 
115 #ifdef _KERNEL
116 struct	in6_ifaddr {
117 	struct	ifaddr ia_ifa;		/* protocol-independent info */
118 #define	ia_ifp		ia_ifa.ifa_ifp
119 #define ia_flags	ia_ifa.ifa_flags
120 	struct	sockaddr_in6 ia_addr;	/* interface address */
121 	struct	sockaddr_in6 ia_net;	/* network number of interface */
122 	struct	sockaddr_in6 ia_dstaddr; /* space for destination addr */
123 	struct	sockaddr_in6 ia_prefixmask; /* prefix mask */
124 	u_int32_t ia_plen;		/* prefix length */
125 	TAILQ_ENTRY(in6_ifaddr)	ia_link;	/* list of IPv6 addresses */
126 	int	ia6_flags;
127 
128 	struct in6_addrlifetime ia6_lifetime;
129 	time_t	ia6_createtime; /* the creation time of this address, which is
130 				 * currently used for temporary addresses only.
131 				 */
132 	time_t	ia6_updatetime;
133 
134 	/* back pointer to the ND prefix (for autoconfigured addresses only) */
135 	struct nd_prefix *ia6_ndpr;
136 
137 	/* multicast addresses joined from the kernel */
138 	LIST_HEAD(, in6_multi_mship) ia6_memberships;
139 	/* entry in bucket of inet6 addresses */
140 	LIST_ENTRY(in6_ifaddr) ia6_hash;
141 };
142 
143 /* List of in6_ifaddr's. */
144 TAILQ_HEAD(in6_ifaddrhead, in6_ifaddr);
145 LIST_HEAD(in6_ifaddrlisthead, in6_ifaddr);
146 #endif	/* _KERNEL */
147 
148 /* control structure to manage address selection policy */
149 struct in6_addrpolicy {
150 	struct sockaddr_in6 addr; /* prefix address */
151 	struct sockaddr_in6 addrmask; /* prefix mask */
152 	int preced;		/* precedence */
153 	int label;		/* matching label */
154 	u_quad_t use;		/* statistics */
155 };
156 
157 /*
158  * IPv6 interface statistics, as defined in RFC2465 Ipv6IfStatsEntry (p12).
159  */
160 struct in6_ifstat {
161 	uint64_t ifs6_in_receive;	/* # of total input datagram */
162 	uint64_t ifs6_in_hdrerr;	/* # of datagrams with invalid hdr */
163 	uint64_t ifs6_in_toobig;	/* # of datagrams exceeded MTU */
164 	uint64_t ifs6_in_noroute;	/* # of datagrams with no route */
165 	uint64_t ifs6_in_addrerr;	/* # of datagrams with invalid dst */
166 	uint64_t ifs6_in_protounknown;	/* # of datagrams with unknown proto */
167 					/* NOTE: increment on final dst if */
168 	uint64_t ifs6_in_truncated;	/* # of truncated datagrams */
169 	uint64_t ifs6_in_discard;	/* # of discarded datagrams */
170 					/* NOTE: fragment timeout is not here */
171 	uint64_t ifs6_in_deliver;	/* # of datagrams delivered to ULP */
172 					/* NOTE: increment on final dst if */
173 	uint64_t ifs6_out_forward;	/* # of datagrams forwarded */
174 					/* NOTE: increment on outgoing if */
175 	uint64_t ifs6_out_request;	/* # of outgoing datagrams from ULP */
176 					/* NOTE: does not include forwrads */
177 	uint64_t ifs6_out_discard;	/* # of discarded datagrams */
178 	uint64_t ifs6_out_fragok;	/* # of datagrams fragmented */
179 	uint64_t ifs6_out_fragfail;	/* # of datagrams failed on fragment */
180 	uint64_t ifs6_out_fragcreat;	/* # of fragment datagrams */
181 					/* NOTE: this is # after fragment */
182 	uint64_t ifs6_reass_reqd;	/* # of incoming fragmented packets */
183 					/* NOTE: increment on final dst if */
184 	uint64_t ifs6_reass_ok;		/* # of reassembled packets */
185 					/* NOTE: this is # after reass */
186 					/* NOTE: increment on final dst if */
187 	uint64_t ifs6_reass_fail;	/* # of reass failures */
188 					/* NOTE: may not be packet count */
189 					/* NOTE: increment on final dst if */
190 	uint64_t ifs6_in_mcast;		/* # of inbound multicast datagrams */
191 	uint64_t ifs6_out_mcast;	/* # of outbound multicast datagrams */
192 };
193 
194 /*
195  * ICMPv6 interface statistics, as defined in RFC2466 Ipv6IfIcmpEntry.
196  * XXX: I'm not sure if this file is the right place for this structure...
197  */
198 struct icmp6_ifstat {
199 	/*
200 	 * Input statistics
201 	 */
202 	/* ipv6IfIcmpInMsgs, total # of input messages */
203 	uint64_t ifs6_in_msg;
204 	/* ipv6IfIcmpInErrors, # of input error messages */
205 	uint64_t ifs6_in_error;
206 	/* ipv6IfIcmpInDestUnreachs, # of input dest unreach errors */
207 	uint64_t ifs6_in_dstunreach;
208 	/* ipv6IfIcmpInAdminProhibs, # of input administratively prohibited errs */
209 	uint64_t ifs6_in_adminprohib;
210 	/* ipv6IfIcmpInTimeExcds, # of input time exceeded errors */
211 	uint64_t ifs6_in_timeexceed;
212 	/* ipv6IfIcmpInParmProblems, # of input parameter problem errors */
213 	uint64_t ifs6_in_paramprob;
214 	/* ipv6IfIcmpInPktTooBigs, # of input packet too big errors */
215 	uint64_t ifs6_in_pkttoobig;
216 	/* ipv6IfIcmpInEchos, # of input echo requests */
217 	uint64_t ifs6_in_echo;
218 	/* ipv6IfIcmpInEchoReplies, # of input echo replies */
219 	uint64_t ifs6_in_echoreply;
220 	/* ipv6IfIcmpInRouterSolicits, # of input router solicitations */
221 	uint64_t ifs6_in_routersolicit;
222 	/* ipv6IfIcmpInRouterAdvertisements, # of input router advertisements */
223 	uint64_t ifs6_in_routeradvert;
224 	/* ipv6IfIcmpInNeighborSolicits, # of input neighbor solicitations */
225 	uint64_t ifs6_in_neighborsolicit;
226 	/* ipv6IfIcmpInNeighborAdvertisements, # of input neighbor advertisements */
227 	uint64_t ifs6_in_neighboradvert;
228 	/* ipv6IfIcmpInRedirects, # of input redirects */
229 	uint64_t ifs6_in_redirect;
230 	/* ipv6IfIcmpInGroupMembQueries, # of input MLD queries */
231 	uint64_t ifs6_in_mldquery;
232 	/* ipv6IfIcmpInGroupMembResponses, # of input MLD reports */
233 	uint64_t ifs6_in_mldreport;
234 	/* ipv6IfIcmpInGroupMembReductions, # of input MLD done */
235 	uint64_t ifs6_in_mlddone;
236 
237 	/*
238 	 * Output statistics. We should solve unresolved routing problem...
239 	 */
240 	/* ipv6IfIcmpOutMsgs, total # of output messages */
241 	uint64_t ifs6_out_msg;
242 	/* ipv6IfIcmpOutErrors, # of output error messages */
243 	uint64_t ifs6_out_error;
244 	/* ipv6IfIcmpOutDestUnreachs, # of output dest unreach errors */
245 	uint64_t ifs6_out_dstunreach;
246 	/* ipv6IfIcmpOutAdminProhibs, # of output administratively prohibited errs */
247 	uint64_t ifs6_out_adminprohib;
248 	/* ipv6IfIcmpOutTimeExcds, # of output time exceeded errors */
249 	uint64_t ifs6_out_timeexceed;
250 	/* ipv6IfIcmpOutParmProblems, # of output parameter problem errors */
251 	uint64_t ifs6_out_paramprob;
252 	/* ipv6IfIcmpOutPktTooBigs, # of output packet too big errors */
253 	uint64_t ifs6_out_pkttoobig;
254 	/* ipv6IfIcmpOutEchos, # of output echo requests */
255 	uint64_t ifs6_out_echo;
256 	/* ipv6IfIcmpOutEchoReplies, # of output echo replies */
257 	uint64_t ifs6_out_echoreply;
258 	/* ipv6IfIcmpOutRouterSolicits, # of output router solicitations */
259 	uint64_t ifs6_out_routersolicit;
260 	/* ipv6IfIcmpOutRouterAdvertisements, # of output router advertisements */
261 	uint64_t ifs6_out_routeradvert;
262 	/* ipv6IfIcmpOutNeighborSolicits, # of output neighbor solicitations */
263 	uint64_t ifs6_out_neighborsolicit;
264 	/* ipv6IfIcmpOutNeighborAdvertisements, # of output neighbor advertisements */
265 	uint64_t ifs6_out_neighboradvert;
266 	/* ipv6IfIcmpOutRedirects, # of output redirects */
267 	uint64_t ifs6_out_redirect;
268 	/* ipv6IfIcmpOutGroupMembQueries, # of output MLD queries */
269 	uint64_t ifs6_out_mldquery;
270 	/* ipv6IfIcmpOutGroupMembResponses, # of output MLD reports */
271 	uint64_t ifs6_out_mldreport;
272 	/* ipv6IfIcmpOutGroupMembReductions, # of output MLD done */
273 	uint64_t ifs6_out_mlddone;
274 };
275 
276 struct	in6_ifreq {
277 	char	ifr_name[IFNAMSIZ];
278 	union {
279 		struct	sockaddr_in6 ifru_addr;
280 		struct	sockaddr_in6 ifru_dstaddr;
281 		int	ifru_flags;
282 		int	ifru_flags6;
283 		int	ifru_metric;
284 		caddr_t	ifru_data;
285 		struct in6_addrlifetime ifru_lifetime;
286 		struct in6_ifstat ifru_stat;
287 		struct icmp6_ifstat ifru_icmp6stat;
288 		u_int32_t ifru_scope_id[16];
289 	} ifr_ifru;
290 };
291 
292 struct	in6_aliasreq {
293 	char	ifra_name[IFNAMSIZ];
294 	struct	sockaddr_in6 ifra_addr;
295 	struct	sockaddr_in6 ifra_dstaddr;
296 	struct	sockaddr_in6 ifra_prefixmask;
297 	int	ifra_flags;
298 	struct in6_addrlifetime ifra_lifetime;
299 	int	ifra_vhid;
300 };
301 
302 /* pre-10.x compat */
303 struct	oin6_aliasreq {
304 	char	ifra_name[IFNAMSIZ];
305 	struct	sockaddr_in6 ifra_addr;
306 	struct	sockaddr_in6 ifra_dstaddr;
307 	struct	sockaddr_in6 ifra_prefixmask;
308 	int	ifra_flags;
309 	struct in6_addrlifetime ifra_lifetime;
310 };
311 
312 /* prefix type macro */
313 #define IN6_PREFIX_ND	1
314 #define IN6_PREFIX_RR	2
315 
316 /*
317  * prefix related flags passed between kernel(NDP related part) and
318  * user land command(ifconfig) and daemon(rtadvd).
319  */
320 struct in6_prflags {
321 	struct prf_ra {
322 		u_char onlink : 1;
323 		u_char autonomous : 1;
324 		u_char reserved : 6;
325 	} prf_ra;
326 	u_char prf_reserved1;
327 	u_short prf_reserved2;
328 	/* want to put this on 4byte offset */
329 	struct prf_rr {
330 		u_char decrvalid : 1;
331 		u_char decrprefd : 1;
332 		u_char reserved : 6;
333 	} prf_rr;
334 	u_char prf_reserved3;
335 	u_short prf_reserved4;
336 };
337 
338 struct  in6_prefixreq {
339 	char	ipr_name[IFNAMSIZ];
340 	u_char	ipr_origin;
341 	u_char	ipr_plen;
342 	u_int32_t ipr_vltime;
343 	u_int32_t ipr_pltime;
344 	struct in6_prflags ipr_flags;
345 	struct	sockaddr_in6 ipr_prefix;
346 };
347 
348 #define PR_ORIG_RA	0
349 #define PR_ORIG_RR	1
350 #define PR_ORIG_STATIC	2
351 #define PR_ORIG_KERNEL	3
352 
353 #define ipr_raf_onlink		ipr_flags.prf_ra.onlink
354 #define ipr_raf_auto		ipr_flags.prf_ra.autonomous
355 
356 #define ipr_statef_onlink	ipr_flags.prf_state.onlink
357 
358 #define ipr_rrf_decrvalid	ipr_flags.prf_rr.decrvalid
359 #define ipr_rrf_decrprefd	ipr_flags.prf_rr.decrprefd
360 
361 struct	in6_rrenumreq {
362 	char	irr_name[IFNAMSIZ];
363 	u_char	irr_origin;
364 	u_char	irr_m_len;	/* match len for matchprefix */
365 	u_char	irr_m_minlen;	/* minlen for matching prefix */
366 	u_char	irr_m_maxlen;	/* maxlen for matching prefix */
367 	u_char	irr_u_uselen;	/* uselen for adding prefix */
368 	u_char	irr_u_keeplen;	/* keeplen from matching prefix */
369 	struct irr_raflagmask {
370 		u_char onlink : 1;
371 		u_char autonomous : 1;
372 		u_char reserved : 6;
373 	} irr_raflagmask;
374 	u_int32_t irr_vltime;
375 	u_int32_t irr_pltime;
376 	struct in6_prflags irr_flags;
377 	struct	sockaddr_in6 irr_matchprefix;
378 	struct	sockaddr_in6 irr_useprefix;
379 };
380 
381 #define irr_raf_mask_onlink	irr_raflagmask.onlink
382 #define irr_raf_mask_auto	irr_raflagmask.autonomous
383 #define irr_raf_mask_reserved	irr_raflagmask.reserved
384 
385 #define irr_raf_onlink		irr_flags.prf_ra.onlink
386 #define irr_raf_auto		irr_flags.prf_ra.autonomous
387 
388 #define irr_statef_onlink	irr_flags.prf_state.onlink
389 
390 #define irr_rrf			irr_flags.prf_rr
391 #define irr_rrf_decrvalid	irr_flags.prf_rr.decrvalid
392 #define irr_rrf_decrprefd	irr_flags.prf_rr.decrprefd
393 
394 /*
395  * Given a pointer to an in6_ifaddr (ifaddr),
396  * return a pointer to the addr as a sockaddr_in6
397  */
398 #define IA6_IN6(ia)	(&((ia)->ia_addr.sin6_addr))
399 #define IA6_DSTIN6(ia)	(&((ia)->ia_dstaddr.sin6_addr))
400 #define IA6_MASKIN6(ia)	(&((ia)->ia_prefixmask.sin6_addr))
401 #define IA6_SIN6(ia)	(&((ia)->ia_addr))
402 #define IA6_DSTSIN6(ia)	(&((ia)->ia_dstaddr))
403 #define IFA_IN6(x)	(&((struct sockaddr_in6 *)((x)->ifa_addr))->sin6_addr)
404 #define IFA_DSTIN6(x)	(&((struct sockaddr_in6 *)((x)->ifa_dstaddr))->sin6_addr)
405 
406 #define IFPR_IN6(x)	(&((struct sockaddr_in6 *)((x)->ifpr_prefix))->sin6_addr)
407 
408 #ifdef _KERNEL
409 #define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m)	(	\
410 	(((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \
411 	(((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \
412 	(((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \
413 	(((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0 )
414 #define IN6_MASK_ADDR(a, m)	do { \
415 	(a)->s6_addr32[0] &= (m)->s6_addr32[0]; \
416 	(a)->s6_addr32[1] &= (m)->s6_addr32[1]; \
417 	(a)->s6_addr32[2] &= (m)->s6_addr32[2]; \
418 	(a)->s6_addr32[3] &= (m)->s6_addr32[3]; \
419 } while (0)
420 #endif
421 
422 #define SIOCSIFADDR_IN6		 _IOW('i', 12, struct in6_ifreq)
423 #define SIOCGIFADDR_IN6		_IOWR('i', 33, struct in6_ifreq)
424 
425 #ifdef _KERNEL
426 /*
427  * SIOCSxxx ioctls should be unused (see comments in in6.c), but
428  * we do not shift numbers for binary compatibility.
429  */
430 #define SIOCSIFDSTADDR_IN6	 _IOW('i', 14, struct in6_ifreq)
431 #define SIOCSIFNETMASK_IN6	 _IOW('i', 22, struct in6_ifreq)
432 #endif
433 
434 #define SIOCGIFDSTADDR_IN6	_IOWR('i', 34, struct in6_ifreq)
435 #define SIOCGIFNETMASK_IN6	_IOWR('i', 37, struct in6_ifreq)
436 
437 #define SIOCDIFADDR_IN6		 _IOW('i', 25, struct in6_ifreq)
438 #define OSIOCAIFADDR_IN6	 _IOW('i', 26, struct oin6_aliasreq)
439 #define SIOCAIFADDR_IN6		 _IOW('i', 27, struct in6_aliasreq)
440 
441 #define SIOCSIFPHYADDR_IN6       _IOW('i', 70, struct in6_aliasreq)
442 #define	SIOCGIFPSRCADDR_IN6	_IOWR('i', 71, struct in6_ifreq)
443 #define	SIOCGIFPDSTADDR_IN6	_IOWR('i', 72, struct in6_ifreq)
444 
445 #define SIOCGIFAFLAG_IN6	_IOWR('i', 73, struct in6_ifreq)
446 
447 #ifdef _KERNEL
448 #define OSIOCGIFINFO_IN6	_IOWR('i', 76, struct in6_ondireq)
449 #endif
450 #define SIOCGIFINFO_IN6		_IOWR('i', 108, struct in6_ndireq)
451 #define SIOCSIFINFO_IN6		_IOWR('i', 109, struct in6_ndireq)
452 #define SIOCSNDFLUSH_IN6	_IOWR('i', 77, struct in6_ifreq)
453 #define SIOCGNBRINFO_IN6	_IOWR('i', 78, struct in6_nbrinfo)
454 #define SIOCSPFXFLUSH_IN6	_IOWR('i', 79, struct in6_ifreq)
455 #define SIOCSRTRFLUSH_IN6	_IOWR('i', 80, struct in6_ifreq)
456 
457 #define SIOCGIFALIFETIME_IN6	_IOWR('i', 81, struct in6_ifreq)
458 #define SIOCGIFSTAT_IN6		_IOWR('i', 83, struct in6_ifreq)
459 #define SIOCGIFSTAT_ICMP6	_IOWR('i', 84, struct in6_ifreq)
460 
461 #define SIOCSDEFIFACE_IN6	_IOWR('i', 85, struct in6_ndifreq)
462 #define SIOCGDEFIFACE_IN6	_IOWR('i', 86, struct in6_ndifreq)
463 
464 #define SIOCSIFINFO_FLAGS	_IOWR('i', 87, struct in6_ndireq) /* XXX */
465 
466 #define SIOCSSCOPE6		_IOW('i', 88, struct in6_ifreq)
467 #define SIOCGSCOPE6		_IOWR('i', 89, struct in6_ifreq)
468 #define SIOCGSCOPE6DEF		_IOWR('i', 90, struct in6_ifreq)
469 
470 #define SIOCSIFPREFIX_IN6	_IOW('i', 100, struct in6_prefixreq) /* set */
471 #define SIOCGIFPREFIX_IN6	_IOWR('i', 101, struct in6_prefixreq) /* get */
472 #define SIOCDIFPREFIX_IN6	_IOW('i', 102, struct in6_prefixreq) /* del */
473 #define SIOCAIFPREFIX_IN6	_IOW('i', 103, struct in6_rrenumreq) /* add */
474 #define SIOCCIFPREFIX_IN6	_IOW('i', 104, \
475 				     struct in6_rrenumreq) /* change */
476 #define SIOCSGIFPREFIX_IN6	_IOW('i', 105, \
477 				     struct in6_rrenumreq) /* set global */
478 
479 #define SIOCGETSGCNT_IN6	_IOWR('u', 106, \
480 				      struct sioc_sg_req6) /* get s,g pkt cnt */
481 #define SIOCGETMIFCNT_IN6	_IOWR('u', 107, \
482 				      struct sioc_mif_req6) /* get pkt cnt per if */
483 
484 #define SIOCAADDRCTL_POLICY	_IOW('u', 108, struct in6_addrpolicy)
485 #define SIOCDADDRCTL_POLICY	_IOW('u', 109, struct in6_addrpolicy)
486 
487 #define IN6_IFF_ANYCAST		0x01	/* anycast address */
488 #define IN6_IFF_TENTATIVE	0x02	/* tentative address */
489 #define IN6_IFF_DUPLICATED	0x04	/* DAD detected duplicate */
490 #define IN6_IFF_DETACHED	0x08	/* may be detached from the link */
491 #define IN6_IFF_DEPRECATED	0x10	/* deprecated address */
492 #define IN6_IFF_NODAD		0x20	/* don't perform DAD on this address
493 					 * (obsolete)
494 					 */
495 #define IN6_IFF_AUTOCONF	0x40	/* autoconfigurable address. */
496 #define IN6_IFF_TEMPORARY	0x80	/* temporary (anonymous) address. */
497 #define	IN6_IFF_PREFER_SOURCE	0x0100	/* preferred address for SAS */
498 
499 /* do not input/output */
500 #define IN6_IFF_NOTREADY (IN6_IFF_TENTATIVE|IN6_IFF_DUPLICATED)
501 
502 #ifdef _KERNEL
503 #define IN6_ARE_SCOPE_CMP(a,b) ((a)-(b))
504 #define IN6_ARE_SCOPE_EQUAL(a,b) ((a)==(b))
505 #endif
506 
507 #ifdef _KERNEL
508 VNET_DECLARE(struct in6_ifaddrhead, in6_ifaddrhead);
509 VNET_DECLARE(struct in6_ifaddrlisthead *, in6_ifaddrhashtbl);
510 VNET_DECLARE(u_long, in6_ifaddrhmask);
511 #define	V_in6_ifaddrhead		VNET(in6_ifaddrhead)
512 #define	V_in6_ifaddrhashtbl		VNET(in6_ifaddrhashtbl)
513 #define	V_in6_ifaddrhmask		VNET(in6_ifaddrhmask)
514 
515 #define	IN6ADDR_NHASH_LOG2		8
516 #define	IN6ADDR_NHASH			(1 << IN6ADDR_NHASH_LOG2)
517 #define	IN6ADDR_HASHVAL(x)		(in6_addrhash(x))
518 #define	IN6ADDR_HASH(x) \
519     (&V_in6_ifaddrhashtbl[IN6ADDR_HASHVAL(x) & V_in6_ifaddrhmask])
520 
521 static __inline uint32_t
522 in6_addrhash(const struct in6_addr *in6)
523 {
524 	uint32_t x;
525 
526 	x = in6->s6_addr32[0] ^ in6->s6_addr32[1] ^ in6->s6_addr32[2] ^
527 	    in6->s6_addr32[3];
528 	return (fnv_32_buf(&x, sizeof(x), FNV1_32_INIT));
529 }
530 
531 extern struct rmlock in6_ifaddr_lock;
532 #define	IN6_IFADDR_LOCK_ASSERT()	rm_assert(&in6_ifaddr_lock, RA_LOCKED)
533 #define	IN6_IFADDR_RLOCK(t)		rm_rlock(&in6_ifaddr_lock, (t))
534 #define	IN6_IFADDR_RLOCK_ASSERT()	rm_assert(&in6_ifaddr_lock, RA_RLOCKED)
535 #define	IN6_IFADDR_RUNLOCK(t)		rm_runlock(&in6_ifaddr_lock, (t))
536 #define	IN6_IFADDR_WLOCK()		rm_wlock(&in6_ifaddr_lock)
537 #define	IN6_IFADDR_WLOCK_ASSERT()	rm_assert(&in6_ifaddr_lock, RA_WLOCKED)
538 #define	IN6_IFADDR_WUNLOCK()		rm_wunlock(&in6_ifaddr_lock)
539 
540 #define in6_ifstat_inc(ifp, tag) \
541 do {								\
542 	if (ifp)						\
543 		counter_u64_add(((struct in6_ifextra *)		\
544 		    ((ifp)->if_afdata[AF_INET6]))->in6_ifstat[	\
545 		    offsetof(struct in6_ifstat, tag) / sizeof(uint64_t)], 1);\
546 } while (/*CONSTCOND*/ 0)
547 
548 extern u_char inet6ctlerrmap[];
549 VNET_DECLARE(unsigned long, in6_maxmtu);
550 #define	V_in6_maxmtu			VNET(in6_maxmtu)
551 #endif /* _KERNEL */
552 
553 /*
554  * IPv6 multicast MLD-layer source entry.
555  */
556 struct ip6_msource {
557 	RB_ENTRY(ip6_msource)	im6s_link;	/* RB tree links */
558 	struct in6_addr		im6s_addr;
559 	struct im6s_st {
560 		uint16_t	ex;		/* # of exclusive members */
561 		uint16_t	in;		/* # of inclusive members */
562 	}			im6s_st[2];	/* state at t0, t1 */
563 	uint8_t			im6s_stp;	/* pending query */
564 };
565 RB_HEAD(ip6_msource_tree, ip6_msource);
566 
567 /*
568  * IPv6 multicast PCB-layer source entry.
569  *
570  * NOTE: overlapping use of struct ip6_msource fields at start.
571  */
572 struct in6_msource {
573 	RB_ENTRY(ip6_msource)	im6s_link;	/* Common field */
574 	struct in6_addr		im6s_addr;	/* Common field */
575 	uint8_t			im6sl_st[2];	/* state before/at commit */
576 };
577 
578 #ifdef _KERNEL
579 /*
580  * IPv6 source tree comparison function.
581  *
582  * An ordered predicate is necessary; bcmp() is not documented to return
583  * an indication of order, memcmp() is, and is an ISO C99 requirement.
584  */
585 static __inline int
586 ip6_msource_cmp(const struct ip6_msource *a, const struct ip6_msource *b)
587 {
588 
589 	return (memcmp(&a->im6s_addr, &b->im6s_addr, sizeof(struct in6_addr)));
590 }
591 RB_PROTOTYPE(ip6_msource_tree, ip6_msource, im6s_link, ip6_msource_cmp);
592 
593 /*
594  * IPv6 multicast PCB-layer group filter descriptor.
595  */
596 struct in6_mfilter {
597 	struct ip6_msource_tree	im6f_sources; /* source list for (S,G) */
598 	u_long			im6f_nsrc;    /* # of source entries */
599 	uint8_t			im6f_st[2];   /* state before/at commit */
600 };
601 
602 /*
603  * Legacy KAME IPv6 multicast membership descriptor.
604  */
605 struct in6_multi_mship {
606 	struct	in6_multi *i6mm_maddr;
607 	LIST_ENTRY(in6_multi_mship) i6mm_chain;
608 };
609 
610 /*
611  * IPv6 group descriptor.
612  *
613  * For every entry on an ifnet's if_multiaddrs list which represents
614  * an IP multicast group, there is one of these structures.
615  *
616  * If any source filters are present, then a node will exist in the RB-tree
617  * to permit fast lookup by source whenever an operation takes place.
618  * This permits pre-order traversal when we issue reports.
619  * Source filter trees are kept separately from the socket layer to
620  * greatly simplify locking.
621  *
622  * When MLDv2 is active, in6m_timer is the response to group query timer.
623  * The state-change timer in6m_sctimer is separate; whenever state changes
624  * for the group the state change record is generated and transmitted,
625  * and kept if retransmissions are necessary.
626  *
627  * FUTURE: in6m_link is now only used when groups are being purged
628  * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but
629  * because it is at the very start of the struct, we can't do this
630  * w/o breaking the ABI for ifmcstat.
631  */
632 struct in6_multi {
633 	LIST_ENTRY(in6_multi) in6m_entry; /* list glue */
634 	struct	in6_addr in6m_addr;	/* IPv6 multicast address */
635 	struct	ifnet *in6m_ifp;	/* back pointer to ifnet */
636 	struct	ifmultiaddr *in6m_ifma;	/* back pointer to ifmultiaddr */
637 	u_int	in6m_refcount;		/* reference count */
638 	u_int	in6m_state;		/* state of the membership */
639 	u_int	in6m_timer;		/* MLD6 listener report timer */
640 
641 	/* New fields for MLDv2 follow. */
642 	struct mld_ifsoftc	*in6m_mli;	/* MLD info */
643 	SLIST_ENTRY(in6_multi)	 in6m_nrele;	/* to-be-released by MLD */
644 	struct ip6_msource_tree	 in6m_srcs;	/* tree of sources */
645 	u_long			 in6m_nsrc;	/* # of tree entries */
646 
647 	struct mbufq		 in6m_scq;	/* queue of pending
648 						 * state-change packets */
649 	struct timeval		 in6m_lastgsrtv;	/* last G-S-R query */
650 	uint16_t		 in6m_sctimer;	/* state-change timer */
651 	uint16_t		 in6m_scrv;	/* state-change rexmit count */
652 
653 	/*
654 	 * SSM state counters which track state at T0 (the time the last
655 	 * state-change report's RV timer went to zero) and T1
656 	 * (time of pending report, i.e. now).
657 	 * Used for computing MLDv2 state-change reports. Several refcounts
658 	 * are maintained here to optimize for common use-cases.
659 	 */
660 	struct in6m_st {
661 		uint16_t	iss_fmode;	/* MLD filter mode */
662 		uint16_t	iss_asm;	/* # of ASM listeners */
663 		uint16_t	iss_ex;		/* # of exclusive members */
664 		uint16_t	iss_in;		/* # of inclusive members */
665 		uint16_t	iss_rec;	/* # of recorded sources */
666 	}			in6m_st[2];	/* state at t0, t1 */
667 };
668 
669 /*
670  * Helper function to derive the filter mode on a source entry
671  * from its internal counters. Predicates are:
672  *  A source is only excluded if all listeners exclude it.
673  *  A source is only included if no listeners exclude it,
674  *  and at least one listener includes it.
675  * May be used by ifmcstat(8).
676  */
677 static __inline uint8_t
678 im6s_get_mode(const struct in6_multi *inm, const struct ip6_msource *ims,
679     uint8_t t)
680 {
681 
682 	t = !!t;
683 	if (inm->in6m_st[t].iss_ex > 0 &&
684 	    inm->in6m_st[t].iss_ex == ims->im6s_st[t].ex)
685 		return (MCAST_EXCLUDE);
686 	else if (ims->im6s_st[t].in > 0 && ims->im6s_st[t].ex == 0)
687 		return (MCAST_INCLUDE);
688 	return (MCAST_UNDEFINED);
689 }
690 
691 /*
692  * Lock macros for IPv6 layer multicast address lists.  IPv6 lock goes
693  * before link layer multicast locks in the lock order.  In most cases,
694  * consumers of IN_*_MULTI() macros should acquire the locks before
695  * calling them; users of the in_{add,del}multi() functions should not.
696  */
697 extern struct mtx in6_multi_mtx;
698 #define	IN6_MULTI_LOCK()		mtx_lock(&in6_multi_mtx)
699 #define	IN6_MULTI_UNLOCK()		mtx_unlock(&in6_multi_mtx)
700 #define	IN6_MULTI_LOCK_ASSERT()		mtx_assert(&in6_multi_mtx, MA_OWNED)
701 #define	IN6_MULTI_UNLOCK_ASSERT()	mtx_assert(&in6_multi_mtx, MA_NOTOWNED)
702 
703 /*
704  * Look up an in6_multi record for an IPv6 multicast address
705  * on the interface ifp.
706  * If no record found, return NULL.
707  *
708  * SMPng: The IN6_MULTI_LOCK and IF_ADDR_LOCK on ifp must be held.
709  */
710 static __inline struct in6_multi *
711 in6m_lookup_locked(struct ifnet *ifp, const struct in6_addr *mcaddr)
712 {
713 	struct ifmultiaddr *ifma;
714 	struct in6_multi *inm;
715 
716 	IN6_MULTI_LOCK_ASSERT();
717 	IF_ADDR_LOCK_ASSERT(ifp);
718 
719 	inm = NULL;
720 	TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) {
721 		if (ifma->ifma_addr->sa_family == AF_INET6) {
722 			inm = (struct in6_multi *)ifma->ifma_protospec;
723 			if (IN6_ARE_ADDR_EQUAL(&inm->in6m_addr, mcaddr))
724 				break;
725 			inm = NULL;
726 		}
727 	}
728 	return (inm);
729 }
730 
731 /*
732  * Wrapper for in6m_lookup_locked().
733  *
734  * SMPng: Assumes that neithr the IN6_MULTI_LOCK() or IF_ADDR_LOCK() are held.
735  */
736 static __inline struct in6_multi *
737 in6m_lookup(struct ifnet *ifp, const struct in6_addr *mcaddr)
738 {
739 	struct in6_multi *inm;
740 
741 	IN6_MULTI_LOCK();
742 	IF_ADDR_RLOCK(ifp);
743 	inm = in6m_lookup_locked(ifp, mcaddr);
744 	IF_ADDR_RUNLOCK(ifp);
745 	IN6_MULTI_UNLOCK();
746 
747 	return (inm);
748 }
749 
750 /* Acquire an in6_multi record. */
751 static __inline void
752 in6m_acquire_locked(struct in6_multi *inm)
753 {
754 
755 	IN6_MULTI_LOCK_ASSERT();
756 	++inm->in6m_refcount;
757 }
758 
759 struct ip6_moptions;
760 struct sockopt;
761 
762 /* Multicast KPIs. */
763 int	im6o_mc_filter(const struct ip6_moptions *, const struct ifnet *,
764 	    const struct sockaddr *, const struct sockaddr *);
765 int	in6_mc_join(struct ifnet *, const struct in6_addr *,
766 	    struct in6_mfilter *, struct in6_multi **, int);
767 int	in6_mc_join_locked(struct ifnet *, const struct in6_addr *,
768 	    struct in6_mfilter *, struct in6_multi **, int);
769 int	in6_mc_leave(struct in6_multi *, struct in6_mfilter *);
770 int	in6_mc_leave_locked(struct in6_multi *, struct in6_mfilter *);
771 void	in6m_clear_recorded(struct in6_multi *);
772 void	in6m_commit(struct in6_multi *);
773 void	in6m_print(const struct in6_multi *);
774 int	in6m_record_source(struct in6_multi *, const struct in6_addr *);
775 void	in6m_release_locked(struct in6_multi *);
776 void	ip6_freemoptions(struct ip6_moptions *);
777 int	ip6_getmoptions(struct inpcb *, struct sockopt *);
778 int	ip6_setmoptions(struct inpcb *, struct sockopt *);
779 
780 /* Legacy KAME multicast KPIs. */
781 struct in6_multi_mship *
782 	in6_joingroup(struct ifnet *, struct in6_addr *, int *, int);
783 int	in6_leavegroup(struct in6_multi_mship *);
784 
785 /* flags to in6_update_ifa */
786 #define IN6_IFAUPDATE_DADDELAY	0x1 /* first time to configure an address */
787 
788 int	in6_mask2len(struct in6_addr *, u_char *);
789 int	in6_control(struct socket *, u_long, caddr_t, struct ifnet *,
790 	struct thread *);
791 int	in6_update_ifa(struct ifnet *, struct in6_aliasreq *,
792 	struct in6_ifaddr *, int);
793 void	in6_prepare_ifra(struct in6_aliasreq *, const struct in6_addr *,
794 	const struct in6_addr *);
795 void	in6_purgeaddr(struct ifaddr *);
796 int	in6if_do_dad(struct ifnet *);
797 void	in6_savemkludge(struct in6_ifaddr *);
798 void	*in6_domifattach(struct ifnet *);
799 void	in6_domifdetach(struct ifnet *, void *);
800 int	in6_domifmtu(struct ifnet *);
801 void	in6_setmaxmtu(void);
802 int	in6_if2idlen(struct ifnet *);
803 struct in6_ifaddr *in6ifa_ifpforlinklocal(struct ifnet *, int);
804 struct in6_ifaddr *in6ifa_ifpwithaddr(struct ifnet *, const struct in6_addr *);
805 struct in6_ifaddr *in6ifa_ifwithaddr(const struct in6_addr *, uint32_t);
806 struct in6_ifaddr *in6ifa_llaonifp(struct ifnet *);
807 int	in6_addr2zoneid(struct ifnet *, struct in6_addr *, u_int32_t *);
808 int	in6_matchlen(struct in6_addr *, struct in6_addr *);
809 int	in6_are_prefix_equal(struct in6_addr *, struct in6_addr *, int);
810 void	in6_prefixlen2mask(struct in6_addr *, int);
811 int	in6_prefix_ioctl(struct socket *, u_long, caddr_t,
812 	struct ifnet *);
813 int	in6_prefix_add_ifid(int, struct in6_ifaddr *);
814 void	in6_prefix_remove_ifid(int, struct in6_ifaddr *);
815 void	in6_purgeprefix(struct ifnet *);
816 
817 int	in6_is_addr_deprecated(struct sockaddr_in6 *);
818 int	in6_src_ioctl(u_long, caddr_t);
819 
820 void	in6_newaddrmsg(struct in6_ifaddr *, int);
821 /*
822  * Extended API for IPv6 FIB support.
823  */
824 struct mbuf *ip6_tryforward(struct mbuf *);
825 void	in6_rtredirect(struct sockaddr *, struct sockaddr *, struct sockaddr *,
826 	    int, struct sockaddr *, u_int);
827 int	in6_rtrequest(int, struct sockaddr *, struct sockaddr *,
828 	    struct sockaddr *, int, struct rtentry **, u_int);
829 void	in6_rtalloc(struct route_in6 *, u_int);
830 void	in6_rtalloc_ign(struct route_in6 *, u_long, u_int);
831 struct rtentry *in6_rtalloc1(struct sockaddr *, int, u_long, u_int);
832 #endif /* _KERNEL */
833 
834 #endif /* _NETINET6_IN6_VAR_H_ */
835