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