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